Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GLTranAllocsID | query | string | No | |
GLTranAllocsIDStartsWith | query | string | No | |
GLTranAllocsIDEndsWith | query | string | No | |
GLTranAllocsIDContains | query | string | No | |
GLTranAllocsIDLike | query | string | No | |
GLTranAllocsIDBetween | query | string[] | No | |
GLTranAllocsIDIn | query | string[] | No | |
GLDebitTransID | query | string | No | |
GLDebitTransIDStartsWith | query | string | No | |
GLDebitTransIDEndsWith | query | string | No | |
GLDebitTransIDContains | query | string | No | |
GLDebitTransIDLike | query | string | No | |
GLDebitTransIDBetween | query | string[] | No | |
GLDebitTransIDIn | query | string[] | No | |
GLCreditTransID | query | string | No | |
GLCreditTransIDStartsWith | query | string | No | |
GLCreditTransIDEndsWith | query | string | No | |
GLCreditTransIDContains | query | string | No | |
GLCreditTransIDLike | query | string | No | |
GLCreditTransIDBetween | query | string[] | No | |
GLCreditTransIDIn | query | string[] | No | |
Amount | query | decimal? | No | |
AmountGreaterThanOrEqualTo | query | decimal? | No | |
AmountGreaterThan | query | decimal? | No | |
AmountLessThan | query | decimal? | No | |
AmountLessThanOrEqualTo | query | decimal? | No | |
AmountNotEqualTo | query | decimal? | No | |
AmountBetween | query | Nullable<Decimal>[] | No | |
AmountIn | query | Nullable<Decimal>[] | 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 |
---|---|---|---|---|
GLTranAllocsID | form | string | No | |
GLDebitTransID | form | string | No | |
GLCreditTransID | form | string | No | |
Amount | form | decimal? | 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/GL_TranAllocsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"GLTranAllocsID":"String","GLTranAllocsIDStartsWith":"String","GLTranAllocsIDEndsWith":"String","GLTranAllocsIDContains":"String","GLTranAllocsIDLike":"String","GLTranAllocsIDBetween":["String"],"GLTranAllocsIDIn":["String"],"GLDebitTransID":"String","GLDebitTransIDStartsWith":"String","GLDebitTransIDEndsWith":"String","GLDebitTransIDContains":"String","GLDebitTransIDLike":"String","GLDebitTransIDBetween":["String"],"GLDebitTransIDIn":["String"],"GLCreditTransID":"String","GLCreditTransIDStartsWith":"String","GLCreditTransIDEndsWith":"String","GLCreditTransIDContains":"String","GLCreditTransIDLike":"String","GLCreditTransIDBetween":["String"],"GLCreditTransIDIn":["String"],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[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":[{"GLTranAllocsID":"String","GLDebitTransID":"String","GLCreditTransID":"String","Amount":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}