| 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 | |
| SearchField | query | string | No | |
| SearchFieldStartsWith | query | string | No | |
| SearchFieldEndsWith | query | string | No | |
| SearchFieldContains | query | string | No | |
| SearchFieldLike | query | string | No | |
| SearchFieldBetween | query | string[] | No | |
| SearchFieldIn | query | string[] | No | |
| AccountNo | query | string | No | |
| AccountNoStartsWith | query | string | No | |
| AccountNoEndsWith | query | string | No | |
| AccountNoContains | query | string | No | |
| AccountNoLike | query | string | No | |
| AccountNoBetween | query | string[] | No | |
| AccountNoIn | query | string[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| Phone | query | string | No | |
| PhoneStartsWith | query | string | No | |
| PhoneEndsWith | query | string | No | |
| PhoneContains | query | string | No | |
| PhoneLike | query | string | No | |
| PhoneBetween | query | string[] | No | |
| PhoneIn | query | string[] | No | |
| PostCode | query | string | No | |
| PostCodeStartsWith | query | string | No | |
| PostCodeEndsWith | query | string | No | |
| PostCodeContains | query | string | No | |
| PostCodeLike | query | string | No | |
| PostCodeBetween | query | string[] | No | |
| PostCodeIn | query | string[] | No | |
| Address3 | query | string | No | |
| Address3StartsWith | query | string | No | |
| Address3EndsWith | query | string | No | |
| Address3Contains | query | string | No | |
| Address3Like | query | string | No | |
| Address3Between | query | string[] | No | |
| Address3In | query | string[] | No | |
| Address2 | query | string | No | |
| Address2StartsWith | query | string | No | |
| Address2EndsWith | query | string | No | |
| Address2Contains | query | string | No | |
| Address2Like | query | string | No | |
| Address2Between | query | string[] | No | |
| Address2In | 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 | |
| SearchField | form | string | No | |
| AccountNo | form | string | No | |
| Name | form | string | No | |
| Phone | form | string | No | |
| PostCode | form | string | No | |
| Address3 | form | string | No | |
| Address2 | 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_JIWA_Debtor_ALLQuery 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"],"SearchField":"String","SearchFieldStartsWith":"String","SearchFieldEndsWith":"String","SearchFieldContains":"String","SearchFieldLike":"String","SearchFieldBetween":["String"],"SearchFieldIn":["String"],"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"PostCode":"String","PostCodeStartsWith":"String","PostCodeEndsWith":"String","PostCodeContains":"String","PostCodeLike":"String","PostCodeBetween":["String"],"PostCodeIn":["String"],"Address3":"String","Address3StartsWith":"String","Address3EndsWith":"String","Address3Contains":"String","Address3Like":"String","Address3Between":["String"],"Address3In":["String"],"Address2":"String","Address2StartsWith":"String","Address2EndsWith":"String","Address2Contains":"String","Address2Like":"String","Address2Between":["String"],"Address2In":["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","SearchField":"String","AccountNo":"String","Name":"String","Phone":"String","PostCode":"String","Address3":"String","Address2":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}