Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | Guid? | No | |
RecIDIn | query | Guid[] | No | |
IN_Creditor_RecID | query | string | No | |
IN_Creditor_RecIDStartsWith | query | string | No | |
IN_Creditor_RecIDEndsWith | query | string | No | |
IN_Creditor_RecIDContains | query | string | No | |
IN_Creditor_RecIDLike | query | string | No | |
IN_Creditor_RecIDBetween | query | string[] | No | |
IN_Creditor_RecIDIn | 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 | |
RowHash | query | byte[] | No | |
QuantityBreak | query | decimal? | No | |
QuantityBreakGreaterThanOrEqualTo | query | decimal? | No | |
QuantityBreakGreaterThan | query | decimal? | No | |
QuantityBreakLessThan | query | decimal? | No | |
QuantityBreakLessThanOrEqualTo | query | decimal? | No | |
QuantityBreakNotEqualTo | query | decimal? | No | |
QuantityBreakBetween | query | decimal[] | No | |
QuantityBreakIn | query | decimal[] | No | |
Price | query | decimal? | No | |
PriceGreaterThanOrEqualTo | query | decimal? | No | |
PriceGreaterThan | query | decimal? | No | |
PriceLessThan | query | decimal? | No | |
PriceLessThanOrEqualTo | query | decimal? | No | |
PriceNotEqualTo | query | decimal? | No | |
PriceBetween | query | decimal[] | No | |
PriceIn | query | decimal[] | 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 |
---|---|---|---|---|
RecID | form | Guid | No | |
IN_Creditor_RecID | form | string | No | |
InventoryID | form | string | No | |
RowHash | form | byte[] | No | |
QuantityBreak | form | decimal | No | |
Price | form | decimal | 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_Creditor_QuantityPriceBreakQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"IN_Creditor_RecID":"String","IN_Creditor_RecIDStartsWith":"String","IN_Creditor_RecIDEndsWith":"String","IN_Creditor_RecIDContains":"String","IN_Creditor_RecIDLike":"String","IN_Creditor_RecIDBetween":["String"],"IN_Creditor_RecIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"RowHash":"AA==","QuantityBreak":0,"QuantityBreakGreaterThanOrEqualTo":0,"QuantityBreakGreaterThan":0,"QuantityBreakLessThan":0,"QuantityBreakLessThanOrEqualTo":0,"QuantityBreakNotEqualTo":0,"QuantityBreakBetween":[0],"QuantityBreakIn":[0],"Price":0,"PriceGreaterThanOrEqualTo":0,"PriceGreaterThan":0,"PriceLessThan":0,"PriceLessThanOrEqualTo":0,"PriceNotEqualTo":0,"PriceBetween":[0],"PriceIn":[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":[{"IN_Creditor_RecID":"String","InventoryID":"String","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"}}}