| 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 | |
| DueDate | query | DateTime? | No | |
| DueDateGreaterThanOrEqualTo | query | DateTime? | No | |
| DueDateGreaterThan | query | DateTime? | No | |
| DueDateLessThan | query | DateTime? | No | |
| DueDateLessThanOrEqualTo | query | DateTime? | No | |
| DueDateNotEqualTo | query | DateTime? | No | |
| DueDateBetween | query | Nullable<DateTime>[] | No | |
| DueDateIn | query | Nullable<DateTime>[] | No | |
| Balance | query | decimal? | No | |
| BalanceGreaterThanOrEqualTo | query | decimal? | No | |
| BalanceGreaterThan | query | decimal? | No | |
| BalanceLessThan | query | decimal? | No | |
| BalanceLessThanOrEqualTo | query | decimal? | No | |
| BalanceNotEqualTo | query | decimal? | No | |
| BalanceBetween | query | Nullable<Decimal>[] | No | |
| BalanceIn | query | Nullable<Decimal>[] | No | |
| Source | query | string | No | |
| SourceStartsWith | query | string | No | |
| SourceEndsWith | query | string | No | |
| SourceContains | query | string | No | |
| SourceLike | query | string | No | |
| SourceBetween | query | string[] | No | |
| SourceIn | 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 | |
| DueDate | form | DateTime? | No | |
| Balance | form | decimal? | No | |
| Source | 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_DebtorBalanceInformationQuery 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"],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"Balance":0,"BalanceGreaterThanOrEqualTo":0,"BalanceGreaterThan":0,"BalanceLessThan":0,"BalanceLessThanOrEqualTo":0,"BalanceNotEqualTo":0,"BalanceBetween":[0],"BalanceIn":[0],"Source":"String","SourceStartsWith":"String","SourceEndsWith":"String","SourceContains":"String","SourceLike":"String","SourceBetween":["String"],"SourceIn":["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","DueDate":"0001-01-01T00:00:00.0000000","Balance":0,"Source":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}