| 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 | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| IsEnabled | query | bool? | No | |
| IsDefault | query | bool? | No | |
| IsCreditCard | query | bool? | No | |
| GL_Main_RecID | query | string | No | |
| GL_Main_RecIDStartsWith | query | string | No | |
| GL_Main_RecIDEndsWith | query | string | No | |
| GL_Main_RecIDContains | query | string | No | |
| GL_Main_RecIDLike | query | string | No | |
| GL_Main_RecIDBetween | query | string[] | No | |
| GL_Main_RecIDIn | query | string[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | No | |
| RowHash | query | byte[] | No | |
| IsPOS | query | bool? | No | |
| Code | query | string | No | |
| CodeStartsWith | query | string | No | |
| CodeEndsWith | query | string | No | |
| CodeContains | query | string | No | |
| CodeLike | query | string | No | |
| CodeBetween | query | string[] | No | |
| CodeIn | 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 | |
| Name | form | string | No | |
| IsEnabled | form | bool | No | |
| IsDefault | form | bool | No | |
| IsCreditCard | form | bool | No | |
| GL_Main_RecID | form | string | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | No | |
| IsPOS | form | bool | No | |
| Code | 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/SO_PaymentTypesQuery 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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"IsEnabled":false,"IsDefault":false,"IsCreditCard":false,"GL_Main_RecID":"String","GL_Main_RecIDStartsWith":"String","GL_Main_RecIDEndsWith":"String","GL_Main_RecIDContains":"String","GL_Main_RecIDLike":"String","GL_Main_RecIDBetween":["String"],"GL_Main_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","IsPOS":false,"Code":"String","CodeStartsWith":"String","CodeEndsWith":"String","CodeContains":"String","CodeLike":"String","CodeBetween":["String"],"CodeIn":["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","Name":"String","GL_Main_RecID":"String","RowHash":"AA==","Code":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}