| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReceiptID | query | string | No | |
| ReceiptIDStartsWith | query | string | No | |
| ReceiptIDEndsWith | query | string | No | |
| ReceiptIDContains | query | string | No | |
| ReceiptIDLike | query | string | No | |
| ReceiptIDBetween | query | string[] | No | |
| ReceiptIDIn | query | string[] | No | |
| AccountID | query | string | No | |
| AccountIDStartsWith | query | string | No | |
| AccountIDEndsWith | query | string | No | |
| AccountIDContains | query | string | No | |
| AccountIDLike | query | string | No | |
| AccountIDBetween | query | string[] | No | |
| AccountIDIn | query | string[] | No | |
| DBAccountNo | query | string | No | |
| DBAccountNoStartsWith | query | string | No | |
| DBAccountNoEndsWith | query | string | No | |
| DBAccountNoContains | query | string | No | |
| DBAccountNoLike | query | string | No | |
| DBAccountNoBetween | query | string[] | No | |
| DBAccountNoIn | query | string[] | No | |
| RemitNo | query | string | No | |
| RemitNoStartsWith | query | string | No | |
| RemitNoEndsWith | query | string | No | |
| RemitNoContains | query | string | No | |
| RemitNoLike | query | string | No | |
| RemitNoBetween | query | string[] | No | |
| RemitNoIn | query | string[] | No | |
| ReceiptDate | query | DateTime? | No | |
| ReceiptDateGreaterThanOrEqualTo | query | DateTime? | No | |
| ReceiptDateGreaterThan | query | DateTime? | No | |
| ReceiptDateLessThan | query | DateTime? | No | |
| ReceiptDateLessThanOrEqualTo | query | DateTime? | No | |
| ReceiptDateNotEqualTo | query | DateTime? | No | |
| ReceiptDateBetween | query | Nullable<DateTime>[] | No | |
| ReceiptDateIn | query | Nullable<DateTime>[] | 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 | |
| SourceID | query | string | No | |
| SourceIDStartsWith | query | string | No | |
| SourceIDEndsWith | query | string | No | |
| SourceIDContains | query | string | No | |
| SourceIDLike | query | string | No | |
| SourceIDBetween | query | string[] | No | |
| SourceIDIn | query | string[] | No | |
| SetType | query | short? | No | |
| SetTypeGreaterThanOrEqualTo | query | short? | No | |
| SetTypeGreaterThan | query | short? | No | |
| SetTypeLessThan | query | short? | No | |
| SetTypeLessThanOrEqualTo | query | short? | No | |
| SetTypeNotEqualTo | query | short? | No | |
| SetTypeBetween | query | Nullable<Int16>[] | No | |
| SetTypeIn | query | Nullable<Int16>[] | No | |
| GLSetID | query | string | No | |
| GLSetIDStartsWith | query | string | No | |
| GLSetIDEndsWith | query | string | No | |
| GLSetIDContains | query | string | No | |
| GLSetIDLike | query | string | No | |
| GLSetIDBetween | query | string[] | No | |
| GLSetIDIn | query | string[] | No | |
| GLAccountNo | query | string | No | |
| GLAccountNoStartsWith | query | string | No | |
| GLAccountNoEndsWith | query | string | No | |
| GLAccountNoContains | query | string | No | |
| GLAccountNoLike | query | string | No | |
| GLAccountNoBetween | query | string[] | No | |
| GLAccountNoIn | query | string[] | 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 | |
| GLTransAmount | query | decimal? | No | |
| GLTransAmountGreaterThanOrEqualTo | query | decimal? | No | |
| GLTransAmountGreaterThan | query | decimal? | No | |
| GLTransAmountLessThan | query | decimal? | No | |
| GLTransAmountLessThanOrEqualTo | query | decimal? | No | |
| GLTransAmountNotEqualTo | query | decimal? | No | |
| GLTransAmountBetween | query | Nullable<Decimal>[] | No | |
| GLTransAmountIn | 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 |
|---|---|---|---|---|
| ReceiptID | form | string | No | |
| AccountID | form | string | No | |
| DBAccountNo | form | string | No | |
| RemitNo | form | string | No | |
| ReceiptDate | form | DateTime? | No | |
| Amount | form | decimal? | No | |
| SourceID | form | string | No | |
| SetType | form | short? | No | |
| GLSetID | form | string | No | |
| GLAccountNo | form | string | No | |
| Ref | form | string | No | |
| GLTransAmount | 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/DB_DetailedGLAuditQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ReceiptID":"String","ReceiptIDStartsWith":"String","ReceiptIDEndsWith":"String","ReceiptIDContains":"String","ReceiptIDLike":"String","ReceiptIDBetween":["String"],"ReceiptIDIn":["String"],"AccountID":"String","AccountIDStartsWith":"String","AccountIDEndsWith":"String","AccountIDContains":"String","AccountIDLike":"String","AccountIDBetween":["String"],"AccountIDIn":["String"],"DBAccountNo":"String","DBAccountNoStartsWith":"String","DBAccountNoEndsWith":"String","DBAccountNoContains":"String","DBAccountNoLike":"String","DBAccountNoBetween":["String"],"DBAccountNoIn":["String"],"RemitNo":"String","RemitNoStartsWith":"String","RemitNoEndsWith":"String","RemitNoContains":"String","RemitNoLike":"String","RemitNoBetween":["String"],"RemitNoIn":["String"],"ReceiptDate":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateNotEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateBetween":["0001-01-01T00:00:00.0000000"],"ReceiptDateIn":["0001-01-01T00:00:00.0000000"],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"SetType":0,"SetTypeGreaterThanOrEqualTo":0,"SetTypeGreaterThan":0,"SetTypeLessThan":0,"SetTypeLessThanOrEqualTo":0,"SetTypeNotEqualTo":0,"SetTypeBetween":[0],"SetTypeIn":[0],"GLSetID":"String","GLSetIDStartsWith":"String","GLSetIDEndsWith":"String","GLSetIDContains":"String","GLSetIDLike":"String","GLSetIDBetween":["String"],"GLSetIDIn":["String"],"GLAccountNo":"String","GLAccountNoStartsWith":"String","GLAccountNoEndsWith":"String","GLAccountNoContains":"String","GLAccountNoLike":"String","GLAccountNoBetween":["String"],"GLAccountNoIn":["String"],"Ref":"String","RefStartsWith":"String","RefEndsWith":"String","RefContains":"String","RefLike":"String","RefBetween":["String"],"RefIn":["String"],"GLTransAmount":0,"GLTransAmountGreaterThanOrEqualTo":0,"GLTransAmountGreaterThan":0,"GLTransAmountLessThan":0,"GLTransAmountLessThanOrEqualTo":0,"GLTransAmountNotEqualTo":0,"GLTransAmountBetween":[0],"GLTransAmountIn":[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":[{"ReceiptID":"String","AccountID":"String","DBAccountNo":"String","RemitNo":"String","ReceiptDate":"0001-01-01T00:00:00.0000000","Amount":0,"SourceID":"String","SetType":0,"GLSetID":"String","GLAccountNo":"String","Ref":"String","GLTransAmount":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}