| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StockTakeLineID | query | string | No | |
| StockTakeLineIDStartsWith | query | string | No | |
| StockTakeLineIDEndsWith | query | string | No | |
| StockTakeLineIDContains | query | string | No | |
| StockTakeLineIDLike | query | string | No | |
| StockTakeLineIDBetween | query | string[] | No | |
| StockTakeLineIDIn | query | string[] | No | |
| StockTakeID | query | string | No | |
| StockTakeIDStartsWith | query | string | No | |
| StockTakeIDEndsWith | query | string | No | |
| StockTakeIDContains | query | string | No | |
| StockTakeIDLike | query | string | No | |
| StockTakeIDBetween | query | string[] | No | |
| StockTakeIDIn | 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 | |
| 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 | |
| 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 | |
| QtyOnHand | query | decimal? | No | |
| QtyOnHandGreaterThanOrEqualTo | query | decimal? | No | |
| QtyOnHandGreaterThan | query | decimal? | No | |
| QtyOnHandLessThan | query | decimal? | No | |
| QtyOnHandLessThanOrEqualTo | query | decimal? | No | |
| QtyOnHandNotEqualTo | query | decimal? | No | |
| QtyOnHandBetween | query | Nullable<Decimal>[] | No | |
| QtyOnHandIn | query | Nullable<Decimal>[] | No | |
| QtyFound | query | decimal? | No | |
| QtyFoundGreaterThanOrEqualTo | query | decimal? | No | |
| QtyFoundGreaterThan | query | decimal? | No | |
| QtyFoundLessThan | query | decimal? | No | |
| QtyFoundLessThanOrEqualTo | query | decimal? | No | |
| QtyFoundNotEqualTo | query | decimal? | No | |
| QtyFoundBetween | query | Nullable<Decimal>[] | No | |
| QtyFoundIn | query | Nullable<Decimal>[] | No | |
| AmountVar | query | decimal? | No | |
| AmountVarGreaterThanOrEqualTo | query | decimal? | No | |
| AmountVarGreaterThan | query | decimal? | No | |
| AmountVarLessThan | query | decimal? | No | |
| AmountVarLessThanOrEqualTo | query | decimal? | No | |
| AmountVarNotEqualTo | query | decimal? | No | |
| AmountVarBetween | query | Nullable<Decimal>[] | No | |
| AmountVarIn | query | Nullable<Decimal>[] | No | |
| BinLocation | query | string | No | |
| BinLocationStartsWith | query | string | No | |
| BinLocationEndsWith | query | string | No | |
| BinLocationContains | query | string | No | |
| BinLocationLike | query | string | No | |
| BinLocationBetween | query | string[] | No | |
| BinLocationIn | query | string[] | No | |
| LineNum | query | int? | No | |
| LineNumGreaterThanOrEqualTo | query | int? | No | |
| LineNumGreaterThan | query | int? | No | |
| LineNumLessThan | query | int? | No | |
| LineNumLessThanOrEqualTo | query | int? | No | |
| LineNumNotEqualTo | query | int? | No | |
| LineNumBetween | query | Nullable<Int32>[] | No | |
| LineNumIn | query | Nullable<Int32>[] | No | |
| DefaultBin | query | string | No | |
| DefaultBinStartsWith | query | string | No | |
| DefaultBinEndsWith | query | string | No | |
| DefaultBinContains | query | string | No | |
| DefaultBinLike | query | string | No | |
| DefaultBinBetween | query | string[] | No | |
| DefaultBinIn | query | string[] | No | |
| Comment | query | string | No | |
| CommentStartsWith | query | string | No | |
| CommentEndsWith | query | string | No | |
| CommentContains | query | string | No | |
| CommentLike | query | string | No | |
| CommentBetween | query | string[] | No | |
| CommentIn | query | string[] | 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 |
|---|---|---|---|---|
| StockTakeLineID | form | string | No | |
| StockTakeID | form | string | No | |
| InventoryID | form | string | No | |
| PartNo | form | string | No | |
| Description | form | string | No | |
| QtyOnHand | form | decimal? | No | |
| QtyFound | form | decimal? | No | |
| AmountVar | form | decimal? | No | |
| BinLocation | form | string | No | |
| LineNum | form | int? | No | |
| DefaultBin | form | string | No | |
| Comment | form | string | 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/IN_StockTakeLinesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"StockTakeLineID":"String","StockTakeLineIDStartsWith":"String","StockTakeLineIDEndsWith":"String","StockTakeLineIDContains":"String","StockTakeLineIDLike":"String","StockTakeLineIDBetween":["String"],"StockTakeLineIDIn":["String"],"StockTakeID":"String","StockTakeIDStartsWith":"String","StockTakeIDEndsWith":"String","StockTakeIDContains":"String","StockTakeIDLike":"String","StockTakeIDBetween":["String"],"StockTakeIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"QtyOnHand":0,"QtyOnHandGreaterThanOrEqualTo":0,"QtyOnHandGreaterThan":0,"QtyOnHandLessThan":0,"QtyOnHandLessThanOrEqualTo":0,"QtyOnHandNotEqualTo":0,"QtyOnHandBetween":[0],"QtyOnHandIn":[0],"QtyFound":0,"QtyFoundGreaterThanOrEqualTo":0,"QtyFoundGreaterThan":0,"QtyFoundLessThan":0,"QtyFoundLessThanOrEqualTo":0,"QtyFoundNotEqualTo":0,"QtyFoundBetween":[0],"QtyFoundIn":[0],"AmountVar":0,"AmountVarGreaterThanOrEqualTo":0,"AmountVarGreaterThan":0,"AmountVarLessThan":0,"AmountVarLessThanOrEqualTo":0,"AmountVarNotEqualTo":0,"AmountVarBetween":[0],"AmountVarIn":[0],"BinLocation":"String","BinLocationStartsWith":"String","BinLocationEndsWith":"String","BinLocationContains":"String","BinLocationLike":"String","BinLocationBetween":["String"],"BinLocationIn":["String"],"LineNum":0,"LineNumGreaterThanOrEqualTo":0,"LineNumGreaterThan":0,"LineNumLessThan":0,"LineNumLessThanOrEqualTo":0,"LineNumNotEqualTo":0,"LineNumBetween":[0],"LineNumIn":[0],"DefaultBin":"String","DefaultBinStartsWith":"String","DefaultBinEndsWith":"String","DefaultBinContains":"String","DefaultBinLike":"String","DefaultBinBetween":["String"],"DefaultBinIn":["String"],"Comment":"String","CommentStartsWith":"String","CommentEndsWith":"String","CommentContains":"String","CommentLike":"String","CommentBetween":["String"],"CommentIn":["String"],"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":[{"StockTakeLineID":"String","StockTakeID":"String","InventoryID":"String","PartNo":"String","Description":"String","QtyOnHand":0,"QtyFound":0,"AmountVar":0,"BinLocation":"String","LineNum":0,"DefaultBin":"String","Comment":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}