Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
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 | |
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 | |
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 | |
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 | |
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 |
---|---|---|---|---|
TransID | form | string | No | |
CreditorID | form | string | No | |
DebitCredit | form | bool | No | |
Ref | form | string | No | |
Remark | form | string | No | |
TranDate | form | DateTime? | No | |
InvRemitNo | form | string | No | |
AllocatedAmount | form | decimal? | No | |
Source | 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/V_CR_AgedTransQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"TransID":"String","TransIDStartsWith":"String","TransIDEndsWith":"String","TransIDContains":"String","TransIDLike":"String","TransIDBetween":["String"],"TransIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["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"],"AllocatedAmount":0,"AllocatedAmountGreaterThanOrEqualTo":0,"AllocatedAmountGreaterThan":0,"AllocatedAmountLessThan":0,"AllocatedAmountLessThanOrEqualTo":0,"AllocatedAmountNotEqualTo":0,"AllocatedAmountBetween":[0],"AllocatedAmountIn":[0],"Source":"String","SourceStartsWith":"String","SourceEndsWith":"String","SourceContains":"String","SourceLike":"String","SourceBetween":["String"],"SourceIn":["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":[{"TransID":"String","CreditorID":"String","Ref":"String","Remark":"String","TranDate":"0001-01-01T00:00:00.0000000","InvRemitNo":"String","AllocatedAmount":0,"Source":"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"}}}