Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StockTakeDetailsID | query | string | No | |
StockTakeDetailsIDStartsWith | query | string | No | |
StockTakeDetailsIDEndsWith | query | string | No | |
StockTakeDetailsIDContains | query | string | No | |
StockTakeDetailsIDLike | query | string | No | |
StockTakeDetailsIDBetween | query | string[] | No | |
StockTakeDetailsIDIn | query | string[] | No | |
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 | |
SerialNumber | query | string | No | |
SerialNumberStartsWith | query | string | No | |
SerialNumberEndsWith | query | string | No | |
SerialNumberContains | query | string | No | |
SerialNumberLike | query | string | No | |
SerialNumberBetween | query | string[] | No | |
SerialNumberIn | query | string[] | No | |
LinkID | query | string | No | |
LinkIDStartsWith | query | string | No | |
LinkIDEndsWith | query | string | No | |
LinkIDContains | query | string | No | |
LinkIDLike | query | string | No | |
LinkIDBetween | query | string[] | No | |
LinkIDIn | query | string[] | 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 | |
Qty | query | decimal? | No | |
QtyGreaterThanOrEqualTo | query | decimal? | No | |
QtyGreaterThan | query | decimal? | No | |
QtyLessThan | query | decimal? | No | |
QtyLessThanOrEqualTo | query | decimal? | No | |
QtyNotEqualTo | query | decimal? | No | |
QtyBetween | query | Nullable<Decimal>[] | No | |
QtyIn | query | Nullable<Decimal>[] | No | |
Inc_Dec | query | int? | No | |
Inc_DecGreaterThanOrEqualTo | query | int? | No | |
Inc_DecGreaterThan | query | int? | No | |
Inc_DecLessThan | query | int? | No | |
Inc_DecLessThanOrEqualTo | query | int? | No | |
Inc_DecNotEqualTo | query | int? | No | |
Inc_DecBetween | query | int[] | No | |
Inc_DecIn | query | int[] | No | |
Cost | query | decimal? | No | |
CostGreaterThanOrEqualTo | query | decimal? | No | |
CostGreaterThan | query | decimal? | No | |
CostLessThan | query | decimal? | No | |
CostLessThanOrEqualTo | query | decimal? | No | |
CostNotEqualTo | query | decimal? | No | |
CostBetween | query | Nullable<Decimal>[] | No | |
CostIn | query | Nullable<Decimal>[] | No | |
ExpiryDate | query | DateTime? | No | |
ExpiryDateGreaterThanOrEqualTo | query | DateTime? | No | |
ExpiryDateGreaterThan | query | DateTime? | No | |
ExpiryDateLessThan | query | DateTime? | No | |
ExpiryDateLessThanOrEqualTo | query | DateTime? | No | |
ExpiryDateNotEqualTo | query | DateTime? | No | |
ExpiryDateBetween | query | Nullable<DateTime>[] | No | |
ExpiryDateIn | query | Nullable<DateTime>[] | 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 |
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 |
---|---|---|---|---|
StockTakeDetailsID | form | string | No | |
StockTakeLineID | form | string | No | |
SerialNumber | form | string | No | |
LinkID | form | string | No | |
QtyFound | form | decimal? | No | |
Qty | form | decimal? | No | |
Inc_Dec | form | int | No | |
Cost | form | decimal? | No | |
ExpiryDate | form | DateTime? | No | |
BinLocation | 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/V_STK_LineDetailsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"StockTakeDetailsID":"String","StockTakeDetailsIDStartsWith":"String","StockTakeDetailsIDEndsWith":"String","StockTakeDetailsIDContains":"String","StockTakeDetailsIDLike":"String","StockTakeDetailsIDBetween":["String"],"StockTakeDetailsIDIn":["String"],"StockTakeLineID":"String","StockTakeLineIDStartsWith":"String","StockTakeLineIDEndsWith":"String","StockTakeLineIDContains":"String","StockTakeLineIDLike":"String","StockTakeLineIDBetween":["String"],"StockTakeLineIDIn":["String"],"SerialNumber":"String","SerialNumberStartsWith":"String","SerialNumberEndsWith":"String","SerialNumberContains":"String","SerialNumberLike":"String","SerialNumberBetween":["String"],"SerialNumberIn":["String"],"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"QtyFound":0,"QtyFoundGreaterThanOrEqualTo":0,"QtyFoundGreaterThan":0,"QtyFoundLessThan":0,"QtyFoundLessThanOrEqualTo":0,"QtyFoundNotEqualTo":0,"QtyFoundBetween":[0],"QtyFoundIn":[0],"Qty":0,"QtyGreaterThanOrEqualTo":0,"QtyGreaterThan":0,"QtyLessThan":0,"QtyLessThanOrEqualTo":0,"QtyNotEqualTo":0,"QtyBetween":[0],"QtyIn":[0],"Inc_Dec":0,"Inc_DecGreaterThanOrEqualTo":0,"Inc_DecGreaterThan":0,"Inc_DecLessThan":0,"Inc_DecLessThanOrEqualTo":0,"Inc_DecNotEqualTo":0,"Inc_DecBetween":[0],"Inc_DecIn":[0],"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateIn":["0001-01-01T00:00:00.0000000"],"BinLocation":"String","BinLocationStartsWith":"String","BinLocationEndsWith":"String","BinLocationContains":"String","BinLocationLike":"String","BinLocationBetween":["String"],"BinLocationIn":["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":[{"StockTakeDetailsID":"String","StockTakeLineID":"String","SerialNumber":"String","LinkID":"String","QtyFound":0,"Qty":0,"Cost":0,"ExpiryDate":"0001-01-01T00:00:00.0000000","BinLocation":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}