| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceID | query | string | No | |
| InvoiceIDStartsWith | query | string | No | |
| InvoiceIDEndsWith | query | string | No | |
| InvoiceIDContains | query | string | No | |
| InvoiceIDLike | query | string | No | |
| InvoiceIDBetween | query | string[] | No | |
| InvoiceIDIn | query | string[] | No | |
| InvoiceTotal | query | decimal? | No | |
| InvoiceTotalGreaterThanOrEqualTo | query | decimal? | No | |
| InvoiceTotalGreaterThan | query | decimal? | No | |
| InvoiceTotalLessThan | query | decimal? | No | |
| InvoiceTotalLessThanOrEqualTo | query | decimal? | No | |
| InvoiceTotalNotEqualTo | query | decimal? | No | |
| InvoiceTotalBetween | query | Nullable<Decimal>[] | No | |
| InvoiceTotalIn | query | Nullable<Decimal>[] | No | |
| Cartage1Total | query | decimal? | No | |
| Cartage1TotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage1TotalGreaterThan | query | decimal? | No | |
| Cartage1TotalLessThan | query | decimal? | No | |
| Cartage1TotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage1TotalNotEqualTo | query | decimal? | No | |
| Cartage1TotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage1TotalIn | query | Nullable<Decimal>[] | No | |
| Cartage1TaxTotal | query | decimal? | No | |
| Cartage1TaxTotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage1TaxTotalGreaterThan | query | decimal? | No | |
| Cartage1TaxTotalLessThan | query | decimal? | No | |
| Cartage1TaxTotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage1TaxTotalNotEqualTo | query | decimal? | No | |
| Cartage1TaxTotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage1TaxTotalIn | query | Nullable<Decimal>[] | No | |
| Cartage2Total | query | decimal? | No | |
| Cartage2TotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage2TotalGreaterThan | query | decimal? | No | |
| Cartage2TotalLessThan | query | decimal? | No | |
| Cartage2TotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage2TotalNotEqualTo | query | decimal? | No | |
| Cartage2TotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage2TotalIn | query | Nullable<Decimal>[] | No | |
| Cartage2TaxTotal | query | decimal? | No | |
| Cartage2TaxTotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage2TaxTotalGreaterThan | query | decimal? | No | |
| Cartage2TaxTotalLessThan | query | decimal? | No | |
| Cartage2TaxTotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage2TaxTotalNotEqualTo | query | decimal? | No | |
| Cartage2TaxTotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage2TaxTotalIn | query | Nullable<Decimal>[] | No | |
| Cartage3Total | query | decimal? | No | |
| Cartage3TotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage3TotalGreaterThan | query | decimal? | No | |
| Cartage3TotalLessThan | query | decimal? | No | |
| Cartage3TotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage3TotalNotEqualTo | query | decimal? | No | |
| Cartage3TotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage3TotalIn | query | Nullable<Decimal>[] | No | |
| Cartage3TaxTotal | query | decimal? | No | |
| Cartage3TaxTotalGreaterThanOrEqualTo | query | decimal? | No | |
| Cartage3TaxTotalGreaterThan | query | decimal? | No | |
| Cartage3TaxTotalLessThan | query | decimal? | No | |
| Cartage3TaxTotalLessThanOrEqualTo | query | decimal? | No | |
| Cartage3TaxTotalNotEqualTo | query | decimal? | No | |
| Cartage3TaxTotalBetween | query | Nullable<Decimal>[] | No | |
| Cartage3TaxTotalIn | 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 |
|---|---|---|---|---|
| InvoiceID | form | string | No | |
| InvoiceTotal | form | decimal? | No | |
| Cartage1Total | form | decimal? | No | |
| Cartage1TaxTotal | form | decimal? | No | |
| Cartage2Total | form | decimal? | No | |
| Cartage2TaxTotal | form | decimal? | No | |
| Cartage3Total | form | decimal? | No | |
| Cartage3TaxTotal | 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/SO_TotalsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InvoiceTotal":0,"InvoiceTotalGreaterThanOrEqualTo":0,"InvoiceTotalGreaterThan":0,"InvoiceTotalLessThan":0,"InvoiceTotalLessThanOrEqualTo":0,"InvoiceTotalNotEqualTo":0,"InvoiceTotalBetween":[0],"InvoiceTotalIn":[0],"Cartage1Total":0,"Cartage1TotalGreaterThanOrEqualTo":0,"Cartage1TotalGreaterThan":0,"Cartage1TotalLessThan":0,"Cartage1TotalLessThanOrEqualTo":0,"Cartage1TotalNotEqualTo":0,"Cartage1TotalBetween":[0],"Cartage1TotalIn":[0],"Cartage1TaxTotal":0,"Cartage1TaxTotalGreaterThanOrEqualTo":0,"Cartage1TaxTotalGreaterThan":0,"Cartage1TaxTotalLessThan":0,"Cartage1TaxTotalLessThanOrEqualTo":0,"Cartage1TaxTotalNotEqualTo":0,"Cartage1TaxTotalBetween":[0],"Cartage1TaxTotalIn":[0],"Cartage2Total":0,"Cartage2TotalGreaterThanOrEqualTo":0,"Cartage2TotalGreaterThan":0,"Cartage2TotalLessThan":0,"Cartage2TotalLessThanOrEqualTo":0,"Cartage2TotalNotEqualTo":0,"Cartage2TotalBetween":[0],"Cartage2TotalIn":[0],"Cartage2TaxTotal":0,"Cartage2TaxTotalGreaterThanOrEqualTo":0,"Cartage2TaxTotalGreaterThan":0,"Cartage2TaxTotalLessThan":0,"Cartage2TaxTotalLessThanOrEqualTo":0,"Cartage2TaxTotalNotEqualTo":0,"Cartage2TaxTotalBetween":[0],"Cartage2TaxTotalIn":[0],"Cartage3Total":0,"Cartage3TotalGreaterThanOrEqualTo":0,"Cartage3TotalGreaterThan":0,"Cartage3TotalLessThan":0,"Cartage3TotalLessThanOrEqualTo":0,"Cartage3TotalNotEqualTo":0,"Cartage3TotalBetween":[0],"Cartage3TotalIn":[0],"Cartage3TaxTotal":0,"Cartage3TaxTotalGreaterThanOrEqualTo":0,"Cartage3TaxTotalGreaterThan":0,"Cartage3TaxTotalLessThan":0,"Cartage3TaxTotalLessThanOrEqualTo":0,"Cartage3TaxTotalNotEqualTo":0,"Cartage3TaxTotalBetween":[0],"Cartage3TaxTotalIn":[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":[{"InvoiceID":"String","InvoiceTotal":0,"Cartage1Total":0,"Cartage1TaxTotal":0,"Cartage2Total":0,"Cartage2TaxTotal":0,"Cartage3Total":0,"Cartage3TaxTotal":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}