| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| PO_BatchHeader_RecID | query | string | No | |
| PO_BatchHeader_RecIDStartsWith | query | string | No | |
| PO_BatchHeader_RecIDEndsWith | query | string | No | |
| PO_BatchHeader_RecIDContains | query | string | No | |
| PO_BatchHeader_RecIDLike | query | string | No | |
| PO_BatchHeader_RecIDBetween | query | string[] | No | |
| PO_BatchHeader_RecIDIn | query | string[] | No | |
| PO_Main_RecID | query | string | No | |
| PO_Main_RecIDStartsWith | query | string | No | |
| PO_Main_RecIDEndsWith | query | string | No | |
| PO_Main_RecIDContains | query | string | No | |
| PO_Main_RecIDLike | query | string | No | |
| PO_Main_RecIDBetween | query | string[] | No | |
| PO_Main_RecIDIn | query | string[] | No | |
| CR_Main_RecID | query | string | No | |
| CR_Main_RecIDStartsWith | query | string | No | |
| CR_Main_RecIDEndsWith | query | string | No | |
| CR_Main_RecIDContains | query | string | No | |
| CR_Main_RecIDLike | query | string | No | |
| CR_Main_RecIDBetween | query | string[] | No | |
| CR_Main_RecIDIn | query | string[] | No | |
| FXCurrencyRate | query | decimal? | No | |
| FXCurrencyRateGreaterThanOrEqualTo | query | decimal? | No | |
| FXCurrencyRateGreaterThan | query | decimal? | No | |
| FXCurrencyRateLessThan | query | decimal? | No | |
| FXCurrencyRateLessThanOrEqualTo | query | decimal? | No | |
| FXCurrencyRateNotEqualTo | query | decimal? | No | |
| FXCurrencyRateBetween | query | decimal[] | No | |
| FXCurrencyRateIn | query | decimal[] | No | |
| RowHash | query | byte[] | 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 | string | No | |
| PO_BatchHeader_RecID | form | string | No | |
| PO_Main_RecID | form | string | No | |
| CR_Main_RecID | form | string | No | |
| FXCurrencyRate | form | decimal | No | |
| RowHash | form | byte[] | 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/PO_BatchPurchaseOrdersQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"PO_BatchHeader_RecID":"String","PO_BatchHeader_RecIDStartsWith":"String","PO_BatchHeader_RecIDEndsWith":"String","PO_BatchHeader_RecIDContains":"String","PO_BatchHeader_RecIDLike":"String","PO_BatchHeader_RecIDBetween":["String"],"PO_BatchHeader_RecIDIn":["String"],"PO_Main_RecID":"String","PO_Main_RecIDStartsWith":"String","PO_Main_RecIDEndsWith":"String","PO_Main_RecIDContains":"String","PO_Main_RecIDLike":"String","PO_Main_RecIDBetween":["String"],"PO_Main_RecIDIn":["String"],"CR_Main_RecID":"String","CR_Main_RecIDStartsWith":"String","CR_Main_RecIDEndsWith":"String","CR_Main_RecIDContains":"String","CR_Main_RecIDLike":"String","CR_Main_RecIDBetween":["String"],"CR_Main_RecIDIn":["String"],"FXCurrencyRate":0,"FXCurrencyRateGreaterThanOrEqualTo":0,"FXCurrencyRateGreaterThan":0,"FXCurrencyRateLessThan":0,"FXCurrencyRateLessThanOrEqualTo":0,"FXCurrencyRateNotEqualTo":0,"FXCurrencyRateBetween":[0],"FXCurrencyRateIn":[0],"RowHash":"AA==","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":[{"RecID":"String","PO_BatchHeader_RecID":"String","PO_Main_RecID":"String","CR_Main_RecID":"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"}}}