| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNo | query | string | No | |
| AccountNoStartsWith | query | string | No | |
| AccountNoEndsWith | query | string | No | |
| AccountNoContains | query | string | No | |
| AccountNoLike | query | string | No | |
| AccountNoBetween | query | string[] | No | |
| AccountNoIn | query | string[] | No | |
| 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 | |
| TransID | query | string | No | |
| TransIDStartsWith | query | string | No | |
| TransIDEndsWith | query | string | No | |
| TransIDContains | query | string | No | |
| TransIDLike | query | string | No | |
| TransIDBetween | query | string[] | No | |
| TransIDIn | query | string[] | No | |
| DebitCredit | query | bool? | No | |
| Ref | query | string | No | |
| RefStartsWith | query | string | No | |
| RefEndsWith | query | string | No | |
| RefContains | query | string | No | |
| RefLike | query | string | No | |
| RefBetween | query | string[] | No | |
| RefIn | query | string[] | No | |
| Remark | query | string | No | |
| RemarkStartsWith | query | string | No | |
| RemarkEndsWith | query | string | No | |
| RemarkContains | query | string | No | |
| RemarkLike | query | string | No | |
| RemarkBetween | query | string[] | No | |
| RemarkIn | query | string[] | No | |
| TranDate | query | DateTime? | No | |
| TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
| TranDateGreaterThan | query | DateTime? | No | |
| TranDateLessThan | query | DateTime? | No | |
| TranDateLessThanOrEqualTo | query | DateTime? | No | |
| TranDateNotEqualTo | query | DateTime? | No | |
| TranDateBetween | query | Nullable<DateTime>[] | No | |
| TranDateIn | query | Nullable<DateTime>[] | No | |
| InvRemitNo | query | string | No | |
| InvRemitNoStartsWith | query | string | No | |
| InvRemitNoEndsWith | query | string | No | |
| InvRemitNoContains | query | string | No | |
| InvRemitNoLike | query | string | No | |
| InvRemitNoBetween | query | string[] | No | |
| InvRemitNoIn | query | string[] | No | |
| DiscountedAmount | query | decimal? | No | |
| DiscountedAmountGreaterThanOrEqualTo | query | decimal? | No | |
| DiscountedAmountGreaterThan | query | decimal? | No | |
| DiscountedAmountLessThan | query | decimal? | No | |
| DiscountedAmountLessThanOrEqualTo | query | decimal? | No | |
| DiscountedAmountNotEqualTo | query | decimal? | No | |
| DiscountedAmountBetween | query | Nullable<Decimal>[] | No | |
| DiscountedAmountIn | query | Nullable<Decimal>[] | No | |
| AllocatedAmount | query | decimal? | No | |
| AllocatedAmountGreaterThanOrEqualTo | query | decimal? | No | |
| AllocatedAmountGreaterThan | query | decimal? | No | |
| AllocatedAmountLessThan | query | decimal? | No | |
| AllocatedAmountLessThanOrEqualTo | query | decimal? | No | |
| AllocatedAmountNotEqualTo | query | decimal? | No | |
| AllocatedAmountBetween | query | Nullable<Decimal>[] | No | |
| AllocatedAmountIn | query | Nullable<Decimal>[] | No | |
| SubType | query | short? | No | |
| SubTypeGreaterThanOrEqualTo | query | short? | No | |
| SubTypeGreaterThan | query | short? | No | |
| SubTypeLessThan | query | short? | No | |
| SubTypeLessThanOrEqualTo | query | short? | No | |
| SubTypeNotEqualTo | query | short? | No | |
| SubTypeBetween | query | Nullable<Int16>[] | No | |
| SubTypeIn | query | Nullable<Int16>[] | No | |
| AgedOut | 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 |
|---|---|---|---|---|
| AccountNo | form | string | No | |
| DebtorID | form | string | No | |
| TransID | form | string | No | |
| DebitCredit | form | bool? | No | |
| Ref | form | string | No | |
| Remark | form | string | No | |
| TranDate | form | DateTime? | No | |
| InvRemitNo | form | string | No | |
| DiscountedAmount | form | decimal? | No | |
| AllocatedAmount | form | decimal? | No | |
| SubType | form | short? | No | |
| AgedOut | 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/V_DBStatement_TransAsAtQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"TransID":"String","TransIDStartsWith":"String","TransIDEndsWith":"String","TransIDContains":"String","TransIDLike":"String","TransIDBetween":["String"],"TransIDIn":["String"],"DebitCredit":false,"Ref":"String","RefStartsWith":"String","RefEndsWith":"String","RefContains":"String","RefLike":"String","RefBetween":["String"],"RefIn":["String"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"TranDate":"0001-01-01T00:00:00.0000000","TranDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateGreaterThan":"0001-01-01T00:00:00.0000000","TranDateLessThan":"0001-01-01T00:00:00.0000000","TranDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateNotEqualTo":"0001-01-01T00:00:00.0000000","TranDateBetween":["0001-01-01T00:00:00.0000000"],"TranDateIn":["0001-01-01T00:00:00.0000000"],"InvRemitNo":"String","InvRemitNoStartsWith":"String","InvRemitNoEndsWith":"String","InvRemitNoContains":"String","InvRemitNoLike":"String","InvRemitNoBetween":["String"],"InvRemitNoIn":["String"],"DiscountedAmount":0,"DiscountedAmountGreaterThanOrEqualTo":0,"DiscountedAmountGreaterThan":0,"DiscountedAmountLessThan":0,"DiscountedAmountLessThanOrEqualTo":0,"DiscountedAmountNotEqualTo":0,"DiscountedAmountBetween":[0],"DiscountedAmountIn":[0],"AllocatedAmount":0,"AllocatedAmountGreaterThanOrEqualTo":0,"AllocatedAmountGreaterThan":0,"AllocatedAmountLessThan":0,"AllocatedAmountLessThanOrEqualTo":0,"AllocatedAmountNotEqualTo":0,"AllocatedAmountBetween":[0],"AllocatedAmountIn":[0],"SubType":0,"SubTypeGreaterThanOrEqualTo":0,"SubTypeGreaterThan":0,"SubTypeLessThan":0,"SubTypeLessThanOrEqualTo":0,"SubTypeNotEqualTo":0,"SubTypeBetween":[0],"SubTypeIn":[0],"AgedOut":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":[{"AccountNo":"String","DebtorID":"String","TransID":"String","DebitCredit":false,"Ref":"String","Remark":"String","TranDate":"0001-01-01T00:00:00.0000000","InvRemitNo":"String","DiscountedAmount":0,"AllocatedAmount":0,"SubType":0,"AgedOut":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}