| 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 | |
| JobNo | query | string | No | |
| JobNoStartsWith | query | string | No | |
| JobNoEndsWith | query | string | No | |
| JobNoContains | query | string | No | |
| JobNoLike | query | string | No | |
| JobNoBetween | query | string[] | No | |
| JobNoIn | query | string[] | No | |
| 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 | |
| CostEntryLineID | query | string | No | |
| CostEntryLineIDStartsWith | query | string | No | |
| CostEntryLineIDEndsWith | query | string | No | |
| CostEntryLineIDContains | query | string | No | |
| CostEntryLineIDLike | query | string | No | |
| CostEntryLineIDBetween | query | string[] | No | |
| CostEntryLineIDIn | query | string[] | No | |
| InvoiceType | query | short? | No | |
| InvoiceTypeGreaterThanOrEqualTo | query | short? | No | |
| InvoiceTypeGreaterThan | query | short? | No | |
| InvoiceTypeLessThan | query | short? | No | |
| InvoiceTypeLessThanOrEqualTo | query | short? | No | |
| InvoiceTypeNotEqualTo | query | short? | No | |
| InvoiceTypeBetween | query | short[] | No | |
| InvoiceTypeIn | query | short[] | No | |
| BillAmount | query | decimal? | No | |
| BillAmountGreaterThanOrEqualTo | query | decimal? | No | |
| BillAmountGreaterThan | query | decimal? | No | |
| BillAmountLessThan | query | decimal? | No | |
| BillAmountLessThanOrEqualTo | query | decimal? | No | |
| BillAmountNotEqualTo | query | decimal? | No | |
| BillAmountBetween | query | decimal[] | No | |
| BillAmountIn | query | decimal[] | No | |
| CostAmount | query | decimal? | No | |
| CostAmountGreaterThanOrEqualTo | query | decimal? | No | |
| CostAmountGreaterThan | query | decimal? | No | |
| CostAmountLessThan | query | decimal? | No | |
| CostAmountLessThanOrEqualTo | query | decimal? | No | |
| CostAmountNotEqualTo | query | decimal? | No | |
| CostAmountBetween | query | decimal[] | No | |
| CostAmountIn | query | decimal[] | No | |
| Status | query | short? | No | |
| StatusGreaterThanOrEqualTo | query | short? | No | |
| StatusGreaterThan | query | short? | No | |
| StatusLessThan | query | short? | No | |
| StatusLessThanOrEqualTo | query | short? | No | |
| StatusNotEqualTo | query | short? | No | |
| StatusBetween | query | short[] | No | |
| StatusIn | query | short[] | No | |
| WriteBill | query | decimal? | No | |
| WriteBillGreaterThanOrEqualTo | query | decimal? | No | |
| WriteBillGreaterThan | query | decimal? | No | |
| WriteBillLessThan | query | decimal? | No | |
| WriteBillLessThanOrEqualTo | query | decimal? | No | |
| WriteBillNotEqualTo | query | decimal? | No | |
| WriteBillBetween | query | decimal[] | No | |
| WriteBillIn | query | decimal[] | No | |
| WriteCost | query | decimal? | No | |
| WriteCostGreaterThanOrEqualTo | query | decimal? | No | |
| WriteCostGreaterThan | query | decimal? | No | |
| WriteCostLessThan | query | decimal? | No | |
| WriteCostLessThanOrEqualTo | query | decimal? | No | |
| WriteCostNotEqualTo | query | decimal? | No | |
| WriteCostBetween | query | decimal[] | No | |
| WriteCostIn | query | decimal[] | No | |
| LinkLineID | query | string | No | |
| LinkLineIDStartsWith | query | string | No | |
| LinkLineIDEndsWith | query | string | No | |
| LinkLineIDContains | query | string | No | |
| LinkLineIDLike | query | string | No | |
| LinkLineIDBetween | query | string[] | No | |
| LinkLineIDIn | 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 | |
| JobNo | form | string | No | |
| InvoiceID | form | string | No | |
| CostEntryLineID | form | string | No | |
| InvoiceType | form | short | No | |
| BillAmount | form | decimal | No | |
| CostAmount | form | decimal | No | |
| Status | form | short | No | |
| WriteBill | form | decimal | No | |
| WriteCost | form | decimal | No | |
| LinkLineID | 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/JB_PaymentDetailsQuery 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"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"CostEntryLineID":"String","CostEntryLineIDStartsWith":"String","CostEntryLineIDEndsWith":"String","CostEntryLineIDContains":"String","CostEntryLineIDLike":"String","CostEntryLineIDBetween":["String"],"CostEntryLineIDIn":["String"],"InvoiceType":0,"InvoiceTypeGreaterThanOrEqualTo":0,"InvoiceTypeGreaterThan":0,"InvoiceTypeLessThan":0,"InvoiceTypeLessThanOrEqualTo":0,"InvoiceTypeNotEqualTo":0,"InvoiceTypeBetween":[0],"InvoiceTypeIn":[0],"BillAmount":0,"BillAmountGreaterThanOrEqualTo":0,"BillAmountGreaterThan":0,"BillAmountLessThan":0,"BillAmountLessThanOrEqualTo":0,"BillAmountNotEqualTo":0,"BillAmountBetween":[0],"BillAmountIn":[0],"CostAmount":0,"CostAmountGreaterThanOrEqualTo":0,"CostAmountGreaterThan":0,"CostAmountLessThan":0,"CostAmountLessThanOrEqualTo":0,"CostAmountNotEqualTo":0,"CostAmountBetween":[0],"CostAmountIn":[0],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"WriteBill":0,"WriteBillGreaterThanOrEqualTo":0,"WriteBillGreaterThan":0,"WriteBillLessThan":0,"WriteBillLessThanOrEqualTo":0,"WriteBillNotEqualTo":0,"WriteBillBetween":[0],"WriteBillIn":[0],"WriteCost":0,"WriteCostGreaterThanOrEqualTo":0,"WriteCostGreaterThan":0,"WriteCostLessThan":0,"WriteCostLessThanOrEqualTo":0,"WriteCostNotEqualTo":0,"WriteCostBetween":[0],"WriteCostIn":[0],"LinkLineID":"String","LinkLineIDStartsWith":"String","LinkLineIDEndsWith":"String","LinkLineIDContains":"String","LinkLineIDLike":"String","LinkLineIDBetween":["String"],"LinkLineIDIn":["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","JobNo":"String","InvoiceID":"String","CostEntryLineID":"String","LinkLineID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}