| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllocID | query | string | No | |
| AllocIDStartsWith | query | string | No | |
| AllocIDEndsWith | query | string | No | |
| AllocIDContains | query | string | No | |
| AllocIDLike | query | string | No | |
| AllocIDBetween | query | string[] | No | |
| AllocIDIn | query | string[] | No | |
| 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 | |
| DebitTransID | query | string | No | |
| DebitTransIDStartsWith | query | string | No | |
| DebitTransIDEndsWith | query | string | No | |
| DebitTransIDContains | query | string | No | |
| DebitTransIDLike | query | string | No | |
| DebitTransIDBetween | query | string[] | No | |
| DebitTransIDIn | query | string[] | No | |
| CreditTransID | query | string | No | |
| CreditTransIDStartsWith | query | string | No | |
| CreditTransIDEndsWith | query | string | No | |
| CreditTransIDContains | query | string | No | |
| CreditTransIDLike | query | string | No | |
| CreditTransIDBetween | query | string[] | No | |
| CreditTransIDIn | query | string[] | No | |
| FXAmount | query | decimal? | No | |
| FXAmountGreaterThanOrEqualTo | query | decimal? | No | |
| FXAmountGreaterThan | query | decimal? | No | |
| FXAmountLessThan | query | decimal? | No | |
| FXAmountLessThanOrEqualTo | query | decimal? | No | |
| FXAmountNotEqualTo | query | decimal? | No | |
| FXAmountBetween | query | Nullable<Decimal>[] | No | |
| FXAmountIn | query | Nullable<Decimal>[] | No | |
| DebitAmount | query | decimal? | No | |
| DebitAmountGreaterThanOrEqualTo | query | decimal? | No | |
| DebitAmountGreaterThan | query | decimal? | No | |
| DebitAmountLessThan | query | decimal? | No | |
| DebitAmountLessThanOrEqualTo | query | decimal? | No | |
| DebitAmountNotEqualTo | query | decimal? | No | |
| DebitAmountBetween | query | Nullable<Decimal>[] | No | |
| DebitAmountIn | query | Nullable<Decimal>[] | No | |
| CreditAmount | query | decimal? | No | |
| CreditAmountGreaterThanOrEqualTo | query | decimal? | No | |
| CreditAmountGreaterThan | query | decimal? | No | |
| CreditAmountLessThan | query | decimal? | No | |
| CreditAmountLessThanOrEqualTo | query | decimal? | No | |
| CreditAmountNotEqualTo | query | decimal? | No | |
| CreditAmountBetween | query | Nullable<Decimal>[] | No | |
| CreditAmountIn | query | Nullable<Decimal>[] | No | |
| DebitAged | query | bool? | No | |
| CreditAged | query | bool? | No | |
| DateAlloc | query | DateTime? | No | |
| DateAllocGreaterThanOrEqualTo | query | DateTime? | No | |
| DateAllocGreaterThan | query | DateTime? | No | |
| DateAllocLessThan | query | DateTime? | No | |
| DateAllocLessThanOrEqualTo | query | DateTime? | No | |
| DateAllocNotEqualTo | query | DateTime? | No | |
| DateAllocBetween | query | DateTime[] | No | |
| DateAllocIn | query | DateTime[] | No | |
| Version | query | int? | No | |
| VersionGreaterThanOrEqualTo | query | int? | No | |
| VersionGreaterThan | query | int? | No | |
| VersionLessThan | query | int? | No | |
| VersionLessThanOrEqualTo | query | int? | No | |
| VersionNotEqualTo | query | int? | No | |
| VersionBetween | query | Nullable<Int32>[] | No | |
| VersionIn | query | Nullable<Int32>[] | 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 |
|---|---|---|---|---|
| AllocID | form | string | No | |
| CreditorID | form | string | No | |
| DebitTransID | form | string | No | |
| CreditTransID | form | string | No | |
| FXAmount | form | decimal? | No | |
| DebitAmount | form | decimal? | No | |
| CreditAmount | form | decimal? | No | |
| DebitAged | form | bool? | No | |
| CreditAged | form | bool? | No | |
| DateAlloc | form | DateTime | No | |
| Version | form | int? | 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_TransAllocQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AllocID":"String","AllocIDStartsWith":"String","AllocIDEndsWith":"String","AllocIDContains":"String","AllocIDLike":"String","AllocIDBetween":["String"],"AllocIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DebitTransID":"String","DebitTransIDStartsWith":"String","DebitTransIDEndsWith":"String","DebitTransIDContains":"String","DebitTransIDLike":"String","DebitTransIDBetween":["String"],"DebitTransIDIn":["String"],"CreditTransID":"String","CreditTransIDStartsWith":"String","CreditTransIDEndsWith":"String","CreditTransIDContains":"String","CreditTransIDLike":"String","CreditTransIDBetween":["String"],"CreditTransIDIn":["String"],"FXAmount":0,"FXAmountGreaterThanOrEqualTo":0,"FXAmountGreaterThan":0,"FXAmountLessThan":0,"FXAmountLessThanOrEqualTo":0,"FXAmountNotEqualTo":0,"FXAmountBetween":[0],"FXAmountIn":[0],"DebitAmount":0,"DebitAmountGreaterThanOrEqualTo":0,"DebitAmountGreaterThan":0,"DebitAmountLessThan":0,"DebitAmountLessThanOrEqualTo":0,"DebitAmountNotEqualTo":0,"DebitAmountBetween":[0],"DebitAmountIn":[0],"CreditAmount":0,"CreditAmountGreaterThanOrEqualTo":0,"CreditAmountGreaterThan":0,"CreditAmountLessThan":0,"CreditAmountLessThanOrEqualTo":0,"CreditAmountNotEqualTo":0,"CreditAmountBetween":[0],"CreditAmountIn":[0],"DebitAged":false,"CreditAged":false,"DateAlloc":"0001-01-01T00:00:00.0000000","DateAllocGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateAllocGreaterThan":"0001-01-01T00:00:00.0000000","DateAllocLessThan":"0001-01-01T00:00:00.0000000","DateAllocLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateAllocNotEqualTo":"0001-01-01T00:00:00.0000000","DateAllocBetween":["0001-01-01T00:00:00.0000000"],"DateAllocIn":["0001-01-01T00:00:00.0000000"],"Version":0,"VersionGreaterThanOrEqualTo":0,"VersionGreaterThan":0,"VersionLessThan":0,"VersionLessThanOrEqualTo":0,"VersionNotEqualTo":0,"VersionBetween":[0],"VersionIn":[0],"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":[{"AllocID":"String","CreditorID":"String","DebitTransID":"String","CreditTransID":"String","FXAmount":0,"DebitAmount":0,"CreditAmount":0,"DebitAged":false,"CreditAged":false,"Version":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}