| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| CreditNo | query | string | No | |
| CreditNoStartsWith | query | string | No | |
| CreditNoEndsWith | query | string | No | |
| CreditNoContains | query | string | No | |
| CreditNoLike | query | string | No | |
| CreditNoBetween | query | string[] | No | |
| CreditNoIn | query | string[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| WarehouseID | query | string | No | |
| WarehouseIDStartsWith | query | string | No | |
| WarehouseIDEndsWith | query | string | No | |
| WarehouseIDContains | query | string | No | |
| WarehouseIDLike | query | string | No | |
| WarehouseIDBetween | query | string[] | No | |
| WarehouseIDIn | query | string[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | byte[] | No | |
| StatusIn | query | byte[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| CreatedBy | query | string | No | |
| CreatedByStartsWith | query | string | No | |
| CreatedByEndsWith | query | string | No | |
| CreatedByContains | query | string | No | |
| CreatedByLike | query | string | No | |
| CreatedByBetween | query | string[] | No | |
| CreatedByIn | query | string[] | No | |
| CreditDate | query | DateTime? | No | |
| CreditDateGreaterThanOrEqualTo | query | DateTime? | No | |
| CreditDateGreaterThan | query | DateTime? | No | |
| CreditDateLessThan | query | DateTime? | No | |
| CreditDateLessThanOrEqualTo | query | DateTime? | No | |
| CreditDateNotEqualTo | query | DateTime? | No | |
| CreditDateBetween | query | DateTime[] | No | |
| CreditDateIn | query | DateTime[] | 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 | |
| CreditorRef | query | string | No | |
| CreditorRefStartsWith | query | string | No | |
| CreditorRefEndsWith | query | string | No | |
| CreditorRefContains | query | string | No | |
| CreditorRefLike | query | string | No | |
| CreditorRefBetween | query | string[] | No | |
| CreditorRefIn | query | string[] | No | |
| RowHash | query | byte[] | No | |
| ReturnCode | query | string | No | |
| ReturnCodeStartsWith | query | string | No | |
| ReturnCodeEndsWith | query | string | No | |
| ReturnCodeContains | query | string | No | |
| ReturnCodeLike | query | string | No | |
| ReturnCodeBetween | query | string[] | No | |
| ReturnCodeIn | query | string[] | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| CreditNo | form | string | No | |
| Reference | form | string | No | |
| WarehouseID | form | string | No | |
| Status | form | byte | No | |
| LastSavedDateTime | form | DateTime | No | |
| CreatedBy | form | string | No | |
| CreditDate | form | DateTime | No | |
| CreditorID | form | string | No | |
| CreditorRef | form | string | No | |
| RowHash | form | byte[] | No | |
| ReturnCode | form | string | 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/RA_CreditMainQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"CreditNo":"String","CreditNoStartsWith":"String","CreditNoEndsWith":"String","CreditNoContains":"String","CreditNoLike":"String","CreditNoBetween":["String"],"CreditNoIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"WarehouseID":"String","WarehouseIDStartsWith":"String","WarehouseIDEndsWith":"String","WarehouseIDContains":"String","WarehouseIDLike":"String","WarehouseIDBetween":["String"],"WarehouseIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"CreatedBy":"String","CreatedByStartsWith":"String","CreatedByEndsWith":"String","CreatedByContains":"String","CreatedByLike":"String","CreatedByBetween":["String"],"CreatedByIn":["String"],"CreditDate":"0001-01-01T00:00:00.0000000","CreditDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreditDateGreaterThan":"0001-01-01T00:00:00.0000000","CreditDateLessThan":"0001-01-01T00:00:00.0000000","CreditDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreditDateNotEqualTo":"0001-01-01T00:00:00.0000000","CreditDateBetween":["0001-01-01T00:00:00.0000000"],"CreditDateIn":["0001-01-01T00:00:00.0000000"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"CreditorRef":"String","CreditorRefStartsWith":"String","CreditorRefEndsWith":"String","CreditorRefContains":"String","CreditorRefLike":"String","CreditorRefBetween":["String"],"CreditorRefIn":["String"],"RowHash":"AA==","ReturnCode":"String","ReturnCodeStartsWith":"String","ReturnCodeEndsWith":"String","ReturnCodeContains":"String","ReturnCodeLike":"String","ReturnCodeBetween":["String"],"ReturnCodeIn":["String"],"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":[{"RecID":"String","CreditNo":"String","Reference":"String","WarehouseID":"String","CreatedBy":"String","CreditorID":"String","CreditorRef":"String","RowHash":"AA==","ReturnCode":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}