| 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 | |
| EDIEnabled | query | bool? | No | |
| EDIAddress | query | string | No | |
| EDIAddressStartsWith | query | string | No | |
| EDIAddressEndsWith | query | string | No | |
| EDIAddressContains | query | string | No | |
| EDIAddressLike | query | string | No | |
| EDIAddressBetween | query | string[] | No | |
| EDIAddressIn | query | string[] | No | |
| EDIOrderType | query | byte? | No | |
| EDIOrderTypeGreaterThanOrEqualTo | query | byte? | No | |
| EDIOrderTypeGreaterThan | query | byte? | No | |
| EDIOrderTypeLessThan | query | byte? | No | |
| EDIOrderTypeLessThanOrEqualTo | query | byte? | No | |
| EDIOrderTypeNotEqualTo | query | byte? | No | |
| EDIOrderTypeBetween | query | Nullable<Byte>[] | No | |
| EDIOrderTypeIn | query | Nullable<Byte>[] | No | |
| EDIPricesIncludeTax | query | bool? | 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 | |
| EDIEnabled | form | bool? | No | |
| EDIAddress | form | string | No | |
| EDIOrderType | form | byte? | No | |
| EDIPricesIncludeTax | form | bool? | 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/DB_EDIMainQuery 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"],"EDIEnabled":false,"EDIAddress":"String","EDIAddressStartsWith":"String","EDIAddressEndsWith":"String","EDIAddressContains":"String","EDIAddressLike":"String","EDIAddressBetween":["String"],"EDIAddressIn":["String"],"EDIOrderType":0,"EDIOrderTypeGreaterThanOrEqualTo":0,"EDIOrderTypeGreaterThan":0,"EDIOrderTypeLessThan":0,"EDIOrderTypeLessThanOrEqualTo":0,"EDIOrderTypeNotEqualTo":0,"EDIOrderTypeBetween":[0],"EDIOrderTypeIn":[0],"EDIPricesIncludeTax":false,"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","EDIEnabled":false,"EDIAddress":"String","EDIOrderType":0,"EDIPricesIncludeTax":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}