| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookInLineID | query | string | No | |
| BookInLineIDStartsWith | query | string | No | |
| BookInLineIDEndsWith | query | string | No | |
| BookInLineIDContains | query | string | No | |
| BookInLineIDLike | query | string | No | |
| BookInLineIDBetween | query | string[] | No | |
| BookInLineIDIn | query | string[] | No | |
| BookInID | query | string | No | |
| BookInIDStartsWith | query | string | No | |
| BookInIDEndsWith | query | string | No | |
| BookInIDContains | query | string | No | |
| BookInIDLike | query | string | No | |
| BookInIDBetween | query | string[] | No | |
| BookInIDIn | query | string[] | No | |
| PartNo | query | string | No | |
| PartNoStartsWith | query | string | No | |
| PartNoEndsWith | query | string | No | |
| PartNoContains | query | string | No | |
| PartNoLike | query | string | No | |
| PartNoBetween | query | string[] | No | |
| PartNoIn | query | string[] | No | |
| InventoryID | query | string | No | |
| InventoryIDStartsWith | query | string | No | |
| InventoryIDEndsWith | query | string | No | |
| InventoryIDContains | query | string | No | |
| InventoryIDLike | query | string | No | |
| InventoryIDBetween | query | string[] | No | |
| InventoryIDIn | query | string[] | No | |
| Quantity | query | decimal? | No | |
| QuantityGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityGreaterThan | query | decimal? | No | |
| QuantityLessThan | query | decimal? | No | |
| QuantityLessThanOrEqualTo | query | decimal? | No | |
| QuantityNotEqualTo | query | decimal? | No | |
| QuantityBetween | query | Nullable<Decimal>[] | No | |
| QuantityIn | query | Nullable<Decimal>[] | No | |
| ShipmentLineID | query | string | No | |
| ShipmentLineIDStartsWith | query | string | No | |
| ShipmentLineIDEndsWith | query | string | No | |
| ShipmentLineIDContains | query | string | No | |
| ShipmentLineIDLike | query | string | No | |
| ShipmentLineIDBetween | query | string[] | No | |
| ShipmentLineIDIn | query | string[] | No | |
| UseSerialNo | query | bool? | No | |
| UseExpiry | query | bool? | No | |
| DecimalPlaces | query | short? | No | |
| DecimalPlacesGreaterThanOrEqualTo | query | short? | No | |
| DecimalPlacesGreaterThan | query | short? | No | |
| DecimalPlacesLessThan | query | short? | No | |
| DecimalPlacesLessThanOrEqualTo | query | short? | No | |
| DecimalPlacesNotEqualTo | query | short? | No | |
| DecimalPlacesBetween | query | Nullable<Int16>[] | No | |
| DecimalPlacesIn | query | Nullable<Int16>[] | No | |
| POClassID | query | string | No | |
| POClassIDStartsWith | query | string | No | |
| POClassIDEndsWith | query | string | No | |
| POClassIDContains | query | string | No | |
| POClassIDLike | query | string | No | |
| POClassIDBetween | query | string[] | No | |
| POClassIDIn | query | string[] | No | |
| DeliveryDays | query | short? | No | |
| DeliveryDaysGreaterThanOrEqualTo | query | short? | No | |
| DeliveryDaysGreaterThan | query | short? | No | |
| DeliveryDaysLessThan | query | short? | No | |
| DeliveryDaysLessThanOrEqualTo | query | short? | No | |
| DeliveryDaysNotEqualTo | query | short? | No | |
| DeliveryDaysBetween | query | Nullable<Int16>[] | No | |
| DeliveryDaysIn | query | Nullable<Int16>[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| OrderUnits | query | decimal? | No | |
| OrderUnitsGreaterThanOrEqualTo | query | decimal? | No | |
| OrderUnitsGreaterThan | query | decimal? | No | |
| OrderUnitsLessThan | query | decimal? | No | |
| OrderUnitsLessThanOrEqualTo | query | decimal? | No | |
| OrderUnitsNotEqualTo | query | decimal? | No | |
| OrderUnitsBetween | query | Nullable<Decimal>[] | No | |
| OrderUnitsIn | query | Nullable<Decimal>[] | No | |
| ClassificationID | query | string | No | |
| ClassificationIDStartsWith | query | string | No | |
| ClassificationIDEndsWith | query | string | No | |
| ClassificationIDContains | query | string | No | |
| ClassificationIDLike | query | string | No | |
| ClassificationIDBetween | query | string[] | No | |
| ClassificationIDIn | query | string[] | No | |
| SupplierPartNo | query | string | No | |
| SupplierPartNoStartsWith | query | string | No | |
| SupplierPartNoEndsWith | query | string | No | |
| SupplierPartNoContains | query | string | No | |
| SupplierPartNoLike | query | string | No | |
| SupplierPartNoBetween | query | string[] | No | |
| SupplierPartNoIn | query | string[] | No | |
| OrderedCost | query | decimal? | No | |
| OrderedCostGreaterThanOrEqualTo | query | decimal? | No | |
| OrderedCostGreaterThan | query | decimal? | No | |
| OrderedCostLessThan | query | decimal? | No | |
| OrderedCostLessThanOrEqualTo | query | decimal? | No | |
| OrderedCostNotEqualTo | query | decimal? | No | |
| OrderedCostBetween | query | Nullable<Decimal>[] | No | |
| OrderedCostIn | query | Nullable<Decimal>[] | No | |
| GSTRate | query | decimal? | No | |
| GSTRateGreaterThanOrEqualTo | query | decimal? | No | |
| GSTRateGreaterThan | query | decimal? | No | |
| GSTRateLessThan | query | decimal? | No | |
| GSTRateLessThanOrEqualTo | query | decimal? | No | |
| GSTRateNotEqualTo | query | decimal? | No | |
| GSTRateBetween | query | Nullable<Decimal>[] | No | |
| GSTRateIn | query | Nullable<Decimal>[] | No | |
| GSTAmount | query | decimal? | No | |
| GSTAmountGreaterThanOrEqualTo | query | decimal? | No | |
| GSTAmountGreaterThan | query | decimal? | No | |
| GSTAmountLessThan | query | decimal? | No | |
| GSTAmountLessThanOrEqualTo | query | decimal? | No | |
| GSTAmountNotEqualTo | query | decimal? | No | |
| GSTAmountBetween | query | Nullable<Decimal>[] | No | |
| GSTAmountIn | query | Nullable<Decimal>[] | No | |
| GSTID | query | string | No | |
| GSTIDStartsWith | query | string | No | |
| GSTIDEndsWith | query | string | No | |
| GSTIDContains | query | string | No | |
| GSTIDLike | query | string | No | |
| GSTIDBetween | query | string[] | No | |
| GSTIDIn | query | string[] | No | |
| JobCostID | query | string | No | |
| JobCostIDStartsWith | query | string | No | |
| JobCostIDEndsWith | query | string | No | |
| JobCostIDContains | query | string | No | |
| JobCostIDLike | query | string | No | |
| JobCostIDBetween | query | string[] | No | |
| JobCostIDIn | query | string[] | No | |
| CreditorID | query | string | No | |
| CreditorIDStartsWith | query | string | No | |
| CreditorIDEndsWith | query | string | No | |
| CreditorIDContains | query | string | No | |
| CreditorIDLike | query | string | No | |
| CreditorIDBetween | query | string[] | No | |
| CreditorIDIn | query | string[] | No | |
| FXRate | query | decimal? | No | |
| FXRateGreaterThanOrEqualTo | query | decimal? | No | |
| FXRateGreaterThan | query | decimal? | No | |
| FXRateLessThan | query | decimal? | No | |
| FXRateLessThanOrEqualTo | query | decimal? | No | |
| FXRateNotEqualTo | query | decimal? | No | |
| FXRateBetween | query | Nullable<Decimal>[] | No | |
| FXRateIn | query | Nullable<Decimal>[] | No | |
| UnitCost | query | decimal? | No | |
| UnitCostGreaterThanOrEqualTo | query | decimal? | No | |
| UnitCostGreaterThan | query | decimal? | No | |
| UnitCostLessThan | query | decimal? | No | |
| UnitCostLessThanOrEqualTo | query | decimal? | No | |
| UnitCostNotEqualTo | query | decimal? | No | |
| UnitCostBetween | query | Nullable<Decimal>[] | No | |
| UnitCostIn | query | Nullable<Decimal>[] | No | |
| Weight | query | decimal? | No | |
| WeightGreaterThanOrEqualTo | query | decimal? | No | |
| WeightGreaterThan | query | decimal? | No | |
| WeightLessThan | query | decimal? | No | |
| WeightLessThanOrEqualTo | query | decimal? | No | |
| WeightNotEqualTo | query | decimal? | No | |
| WeightBetween | query | Nullable<Decimal>[] | No | |
| WeightIn | query | Nullable<Decimal>[] | No | |
| Volume | query | decimal? | No | |
| VolumeGreaterThanOrEqualTo | query | decimal? | No | |
| VolumeGreaterThan | query | decimal? | No | |
| VolumeLessThan | query | decimal? | No | |
| VolumeLessThanOrEqualTo | query | decimal? | No | |
| VolumeNotEqualTo | query | decimal? | No | |
| VolumeBetween | query | Nullable<Decimal>[] | No | |
| VolumeIn | query | Nullable<Decimal>[] | No | |
| CurrencyID | query | string | No | |
| CurrencyIDStartsWith | query | string | No | |
| CurrencyIDEndsWith | query | string | No | |
| CurrencyIDContains | query | string | No | |
| CurrencyIDLike | query | string | No | |
| CurrencyIDBetween | query | string[] | No | |
| CurrencyIDIn | query | string[] | No | |
| PhysicalItem | query | bool? | No | |
| FXOrderedCost | query | decimal? | No | |
| FXOrderedCostGreaterThanOrEqualTo | query | decimal? | No | |
| FXOrderedCostGreaterThan | query | decimal? | No | |
| FXOrderedCostLessThan | query | decimal? | No | |
| FXOrderedCostLessThanOrEqualTo | query | decimal? | No | |
| FXOrderedCostNotEqualTo | query | decimal? | No | |
| FXOrderedCostBetween | query | Nullable<Decimal>[] | No | |
| FXOrderedCostIn | query | Nullable<Decimal>[] | No | |
| RowHash | query | byte[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookInLineID | form | string | No | |
| BookInID | form | string | No | |
| PartNo | form | string | No | |
| InventoryID | form | string | No | |
| Quantity | form | decimal? | No | |
| ShipmentLineID | form | string | No | |
| UseSerialNo | form | bool | No | |
| UseExpiry | form | bool | No | |
| DecimalPlaces | form | short? | No | |
| POClassID | form | string | No | |
| DeliveryDays | form | short? | No | |
| Description | form | string | No | |
| OrderUnits | form | decimal? | No | |
| ClassificationID | form | string | No | |
| SupplierPartNo | form | string | No | |
| OrderedCost | form | decimal? | No | |
| GSTRate | form | decimal? | No | |
| GSTAmount | form | decimal? | No | |
| GSTID | form | string | No | |
| JobCostID | form | string | No | |
| CreditorID | form | string | No | |
| FXRate | form | decimal? | No | |
| UnitCost | form | decimal? | No | |
| Weight | form | decimal? | No | |
| Volume | form | decimal? | No | |
| CurrencyID | form | string | No | |
| PhysicalItem | form | bool | No | |
| FXOrderedCost | form | decimal? | No | |
| RowHash | form | byte[] | No | |
| ItemNo | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SH_BookInLinesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"BookInLineID":"String","BookInLineIDStartsWith":"String","BookInLineIDEndsWith":"String","BookInLineIDContains":"String","BookInLineIDLike":"String","BookInLineIDBetween":["String"],"BookInLineIDIn":["String"],"BookInID":"String","BookInIDStartsWith":"String","BookInIDEndsWith":"String","BookInIDContains":"String","BookInIDLike":"String","BookInIDBetween":["String"],"BookInIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"ShipmentLineID":"String","ShipmentLineIDStartsWith":"String","ShipmentLineIDEndsWith":"String","ShipmentLineIDContains":"String","ShipmentLineIDLike":"String","ShipmentLineIDBetween":["String"],"ShipmentLineIDIn":["String"],"UseSerialNo":false,"UseExpiry":false,"DecimalPlaces":0,"DecimalPlacesGreaterThanOrEqualTo":0,"DecimalPlacesGreaterThan":0,"DecimalPlacesLessThan":0,"DecimalPlacesLessThanOrEqualTo":0,"DecimalPlacesNotEqualTo":0,"DecimalPlacesBetween":[0],"DecimalPlacesIn":[0],"POClassID":"String","POClassIDStartsWith":"String","POClassIDEndsWith":"String","POClassIDContains":"String","POClassIDLike":"String","POClassIDBetween":["String"],"POClassIDIn":["String"],"DeliveryDays":0,"DeliveryDaysGreaterThanOrEqualTo":0,"DeliveryDaysGreaterThan":0,"DeliveryDaysLessThan":0,"DeliveryDaysLessThanOrEqualTo":0,"DeliveryDaysNotEqualTo":0,"DeliveryDaysBetween":[0],"DeliveryDaysIn":[0],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"OrderUnits":0,"OrderUnitsGreaterThanOrEqualTo":0,"OrderUnitsGreaterThan":0,"OrderUnitsLessThan":0,"OrderUnitsLessThanOrEqualTo":0,"OrderUnitsNotEqualTo":0,"OrderUnitsBetween":[0],"OrderUnitsIn":[0],"ClassificationID":"String","ClassificationIDStartsWith":"String","ClassificationIDEndsWith":"String","ClassificationIDContains":"String","ClassificationIDLike":"String","ClassificationIDBetween":["String"],"ClassificationIDIn":["String"],"SupplierPartNo":"String","SupplierPartNoStartsWith":"String","SupplierPartNoEndsWith":"String","SupplierPartNoContains":"String","SupplierPartNoLike":"String","SupplierPartNoBetween":["String"],"SupplierPartNoIn":["String"],"OrderedCost":0,"OrderedCostGreaterThanOrEqualTo":0,"OrderedCostGreaterThan":0,"OrderedCostLessThan":0,"OrderedCostLessThanOrEqualTo":0,"OrderedCostNotEqualTo":0,"OrderedCostBetween":[0],"OrderedCostIn":[0],"GSTRate":0,"GSTRateGreaterThanOrEqualTo":0,"GSTRateGreaterThan":0,"GSTRateLessThan":0,"GSTRateLessThanOrEqualTo":0,"GSTRateNotEqualTo":0,"GSTRateBetween":[0],"GSTRateIn":[0],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"GSTID":"String","GSTIDStartsWith":"String","GSTIDEndsWith":"String","GSTIDContains":"String","GSTIDLike":"String","GSTIDBetween":["String"],"GSTIDIn":["String"],"JobCostID":"String","JobCostIDStartsWith":"String","JobCostIDEndsWith":"String","JobCostIDContains":"String","JobCostIDLike":"String","JobCostIDBetween":["String"],"JobCostIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"FXRate":0,"FXRateGreaterThanOrEqualTo":0,"FXRateGreaterThan":0,"FXRateLessThan":0,"FXRateLessThanOrEqualTo":0,"FXRateNotEqualTo":0,"FXRateBetween":[0],"FXRateIn":[0],"UnitCost":0,"UnitCostGreaterThanOrEqualTo":0,"UnitCostGreaterThan":0,"UnitCostLessThan":0,"UnitCostLessThanOrEqualTo":0,"UnitCostNotEqualTo":0,"UnitCostBetween":[0],"UnitCostIn":[0],"Weight":0,"WeightGreaterThanOrEqualTo":0,"WeightGreaterThan":0,"WeightLessThan":0,"WeightLessThanOrEqualTo":0,"WeightNotEqualTo":0,"WeightBetween":[0],"WeightIn":[0],"Volume":0,"VolumeGreaterThanOrEqualTo":0,"VolumeGreaterThan":0,"VolumeLessThan":0,"VolumeLessThanOrEqualTo":0,"VolumeNotEqualTo":0,"VolumeBetween":[0],"VolumeIn":[0],"CurrencyID":"String","CurrencyIDStartsWith":"String","CurrencyIDEndsWith":"String","CurrencyIDContains":"String","CurrencyIDLike":"String","CurrencyIDBetween":["String"],"CurrencyIDIn":["String"],"PhysicalItem":false,"FXOrderedCost":0,"FXOrderedCostGreaterThanOrEqualTo":0,"FXOrderedCostGreaterThan":0,"FXOrderedCostLessThan":0,"FXOrderedCostLessThanOrEqualTo":0,"FXOrderedCostNotEqualTo":0,"FXOrderedCostBetween":[0],"FXOrderedCostIn":[0],"RowHash":"AA==","ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"BookInLineID":"String","BookInID":"String","PartNo":"String","InventoryID":"String","Quantity":0,"ShipmentLineID":"String","DecimalPlaces":0,"POClassID":"String","DeliveryDays":0,"Description":"String","OrderUnits":0,"ClassificationID":"String","SupplierPartNo":"String","OrderedCost":0,"GSTRate":0,"GSTAmount":0,"GSTID":"String","JobCostID":"String","CreditorID":"String","FXRate":0,"UnitCost":0,"Weight":0,"Volume":0,"CurrencyID":"String","FXOrderedCost":0,"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}