| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| DebtorAccountnoAndName | query | string | No | |
| DebtorAccountnoAndNameStartsWith | query | string | No | |
| DebtorAccountnoAndNameEndsWith | query | string | No | |
| DebtorAccountnoAndNameContains | query | string | No | |
| DebtorAccountnoAndNameLike | query | string | No | |
| DebtorAccountnoAndNameBetween | query | string[] | No | |
| DebtorAccountnoAndNameIn | query | string[] | 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 |
| 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 |
|---|---|---|---|---|
| DebtorID | form | string | No | |
| DebtorAccountnoAndName | form | string | No | |
| ClassificationID | 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_DebtorsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DebtorAccountnoAndName":"String","DebtorAccountnoAndNameStartsWith":"String","DebtorAccountnoAndNameEndsWith":"String","DebtorAccountnoAndNameContains":"String","DebtorAccountnoAndNameLike":"String","DebtorAccountnoAndNameBetween":["String"],"DebtorAccountnoAndNameIn":["String"],"ClassificationID":"String","ClassificationIDStartsWith":"String","ClassificationIDEndsWith":"String","ClassificationIDContains":"String","ClassificationIDLike":"String","ClassificationIDBetween":["String"],"ClassificationIDIn":["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":[{"DebtorID":"String","DebtorAccountnoAndName":"String","ClassificationID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}