| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditorID | query | string | No | |
| CreditorIDStartsWith | query | string | No | |
| CreditorIDEndsWith | query | string | No | |
| CreditorIDContains | query | string | No | |
| CreditorIDLike | query | string | No | |
| CreditorIDBetween | query | string[] | No | |
| CreditorIDIn | query | string[] | No | |
| CreditorTotal | query | decimal? | No | |
| CreditorTotalGreaterThanOrEqualTo | query | decimal? | No | |
| CreditorTotalGreaterThan | query | decimal? | No | |
| CreditorTotalLessThan | query | decimal? | No | |
| CreditorTotalLessThanOrEqualTo | query | decimal? | No | |
| CreditorTotalNotEqualTo | query | decimal? | No | |
| CreditorTotalBetween | query | Nullable<Decimal>[] | No | |
| CreditorTotalIn | query | Nullable<Decimal>[] | No | |
| ReportGroup | query | string | No | |
| ReportGroupStartsWith | query | string | No | |
| ReportGroupEndsWith | query | string | No | |
| ReportGroupContains | query | string | No | |
| ReportGroupLike | query | string | No | |
| ReportGroupBetween | query | string[] | No | |
| ReportGroupIn | 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 |
|---|---|---|---|---|
| CreditorID | form | string | No | |
| CreditorTotal | form | decimal? | No | |
| ReportGroup | 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/CR_AUDITQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"CreditorTotal":0,"CreditorTotalGreaterThanOrEqualTo":0,"CreditorTotalGreaterThan":0,"CreditorTotalLessThan":0,"CreditorTotalLessThanOrEqualTo":0,"CreditorTotalNotEqualTo":0,"CreditorTotalBetween":[0],"CreditorTotalIn":[0],"ReportGroup":"String","ReportGroupStartsWith":"String","ReportGroupEndsWith":"String","ReportGroupContains":"String","ReportGroupLike":"String","ReportGroupBetween":["String"],"ReportGroupIn":["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":[{"CreditorID":"String","CreditorTotal":0,"ReportGroup":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}