| 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 | |
| InvoiceNo | query | string | No | |
| InvoiceNoStartsWith | query | string | No | |
| InvoiceNoEndsWith | query | string | No | |
| InvoiceNoContains | query | string | No | |
| InvoiceNoLike | query | string | No | |
| InvoiceNoBetween | query | string[] | No | |
| InvoiceNoIn | query | string[] | No | |
| BillWhenComplete | query | short? | No | |
| BillWhenCompleteGreaterThanOrEqualTo | query | short? | No | |
| BillWhenCompleteGreaterThan | query | short? | No | |
| BillWhenCompleteLessThan | query | short? | No | |
| BillWhenCompleteLessThanOrEqualTo | query | short? | No | |
| BillWhenCompleteNotEqualTo | query | short? | No | |
| BillWhenCompleteBetween | query | short[] | No | |
| BillWhenCompleteIn | query | short[] | No | |
| OrderNo | query | string | No | |
| OrderNoStartsWith | query | string | No | |
| OrderNoEndsWith | query | string | No | |
| OrderNoContains | query | string | No | |
| OrderNoLike | query | string | No | |
| OrderNoBetween | query | string[] | No | |
| OrderNoIn | query | string[] | No | |
| CreditNote | query | bool? | No | |
| WholeSaleInvoice | query | bool? | No | |
| TaxExemptNo | query | string | No | |
| TaxExemptNoStartsWith | query | string | No | |
| TaxExemptNoEndsWith | query | string | No | |
| TaxExemptNoContains | query | string | No | |
| TaxExemptNoLike | query | string | No | |
| TaxExemptNoBetween | query | string[] | No | |
| TaxExemptNoIn | query | string[] | No | |
| InvoiceHistoryID | query | string | No | |
| InvoiceHistoryIDStartsWith | query | string | No | |
| InvoiceHistoryIDEndsWith | query | string | No | |
| InvoiceHistoryIDContains | query | string | No | |
| InvoiceHistoryIDLike | query | string | No | |
| InvoiceHistoryIDBetween | query | string[] | No | |
| InvoiceHistoryIDIn | query | string[] | No | |
| HistoryNo | query | short? | No | |
| HistoryNoGreaterThanOrEqualTo | query | short? | No | |
| HistoryNoGreaterThan | query | short? | No | |
| HistoryNoLessThan | query | short? | No | |
| HistoryNoLessThanOrEqualTo | query | short? | No | |
| HistoryNoNotEqualTo | query | short? | No | |
| HistoryNoBetween | query | Nullable<Int16>[] | No | |
| HistoryNoIn | query | Nullable<Int16>[] | No | |
| RunNo | query | string | No | |
| RunNoStartsWith | query | string | No | |
| RunNoEndsWith | query | string | No | |
| RunNoContains | query | string | No | |
| RunNoLike | query | string | No | |
| RunNoBetween | query | string[] | No | |
| RunNoIn | query | string[] | No | |
| RecordDate | query | DateTime? | No | |
| RecordDateGreaterThanOrEqualTo | query | DateTime? | No | |
| RecordDateGreaterThan | query | DateTime? | No | |
| RecordDateLessThan | query | DateTime? | No | |
| RecordDateLessThanOrEqualTo | query | DateTime? | No | |
| RecordDateNotEqualTo | query | DateTime? | No | |
| RecordDateBetween | query | DateTime[] | No | |
| RecordDateIn | query | DateTime[] | No | |
| InvoiceLineID | query | string | No | |
| InvoiceLineIDStartsWith | query | string | No | |
| InvoiceLineIDEndsWith | query | string | No | |
| InvoiceLineIDContains | query | string | No | |
| InvoiceLineIDLike | query | string | No | |
| InvoiceLineIDBetween | query | string[] | No | |
| InvoiceLineIDIn | query | string[] | No | |
| PartNo | query | string | No | |
| PartNoStartsWith | query | string | No | |
| PartNoEndsWith | query | string | No | |
| PartNoContains | query | string | No | |
| PartNoLike | query | string | No | |
| PartNoBetween | query | string[] | No | |
| PartNoIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| CostIn | query | decimal? | No | |
| CostInGreaterThanOrEqualTo | query | decimal? | No | |
| CostInGreaterThan | query | decimal? | No | |
| CostInLessThan | query | decimal? | No | |
| CostInLessThanOrEqualTo | query | decimal? | No | |
| CostInNotEqualTo | query | decimal? | No | |
| CostInBetween | query | Nullable<Decimal>[] | No | |
| CostInIn | query | Nullable<Decimal>[] | No | |
| QuantityThisDel | query | decimal? | No | |
| QuantityThisDelGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityThisDelGreaterThan | query | decimal? | No | |
| QuantityThisDelLessThan | query | decimal? | No | |
| QuantityThisDelLessThanOrEqualTo | query | decimal? | No | |
| QuantityThisDelNotEqualTo | query | decimal? | No | |
| QuantityThisDelBetween | query | Nullable<Decimal>[] | No | |
| QuantityThisDelIn | query | Nullable<Decimal>[] | No | |
| CurrentLineTotal | query | decimal? | No | |
| CurrentLineTotalGreaterThanOrEqualTo | query | decimal? | No | |
| CurrentLineTotalGreaterThan | query | decimal? | No | |
| CurrentLineTotalLessThan | query | decimal? | No | |
| CurrentLineTotalLessThanOrEqualTo | query | decimal? | No | |
| CurrentLineTotalNotEqualTo | query | decimal? | No | |
| CurrentLineTotalBetween | query | Nullable<Decimal>[] | No | |
| CurrentLineTotalIn | query | Nullable<Decimal>[] | No | |
| TaxToCharge | query | decimal? | No | |
| TaxToChargeGreaterThanOrEqualTo | query | decimal? | No | |
| TaxToChargeGreaterThan | query | decimal? | No | |
| TaxToChargeLessThan | query | decimal? | No | |
| TaxToChargeLessThanOrEqualTo | query | decimal? | No | |
| TaxToChargeNotEqualTo | query | decimal? | No | |
| TaxToChargeBetween | query | Nullable<Decimal>[] | No | |
| TaxToChargeIn | query | Nullable<Decimal>[] | No | |
| TaxPaid | query | decimal? | No | |
| TaxPaidGreaterThanOrEqualTo | query | decimal? | No | |
| TaxPaidGreaterThan | query | decimal? | No | |
| TaxPaidLessThan | query | decimal? | No | |
| TaxPaidLessThanOrEqualTo | query | decimal? | No | |
| TaxPaidNotEqualTo | query | decimal? | No | |
| TaxPaidBetween | query | Nullable<Decimal>[] | No | |
| TaxPaidIn | query | Nullable<Decimal>[] | No | |
| DecimalPlaces | query | short? | No | |
| DecimalPlacesGreaterThanOrEqualTo | query | short? | No | |
| DecimalPlacesGreaterThan | query | short? | No | |
| DecimalPlacesLessThan | query | short? | No | |
| DecimalPlacesLessThanOrEqualTo | query | short? | No | |
| DecimalPlacesNotEqualTo | query | short? | No | |
| DecimalPlacesBetween | query | Nullable<Int16>[] | No | |
| DecimalPlacesIn | query | Nullable<Int16>[] | No | |
| TaxID | query | string | No | |
| TaxIDStartsWith | query | string | No | |
| TaxIDEndsWith | query | string | No | |
| TaxIDContains | query | string | No | |
| TaxIDLike | query | string | No | |
| TaxIDBetween | query | string[] | No | |
| TaxIDIn | query | string[] | No | |
| PhysicalItem | query | short? | No | |
| PhysicalItemGreaterThanOrEqualTo | query | short? | No | |
| PhysicalItemGreaterThan | query | short? | No | |
| PhysicalItemLessThan | query | short? | No | |
| PhysicalItemLessThanOrEqualTo | query | short? | No | |
| PhysicalItemNotEqualTo | query | short? | No | |
| PhysicalItemBetween | query | Nullable<Int16>[] | No | |
| PhysicalItemIn | query | Nullable<Int16>[] | No | |
| NonStock | query | bool? | No | |
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| AccountNo | query | string | No | |
| AccountNoStartsWith | query | string | No | |
| AccountNoEndsWith | query | string | No | |
| AccountNoContains | query | string | No | |
| AccountNoLike | query | string | No | |
| AccountNoBetween | query | string[] | No | |
| AccountNoIn | 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 | |
| InventoryClassificationID | query | string | No | |
| InventoryClassificationIDStartsWith | query | string | No | |
| InventoryClassificationIDEndsWith | query | string | No | |
| InventoryClassificationIDContains | query | string | No | |
| InventoryClassificationIDLike | query | string | No | |
| InventoryClassificationIDBetween | query | string[] | No | |
| InventoryClassificationIDIn | query | string[] | No | |
| ClassDescription | query | string | No | |
| ClassDescriptionStartsWith | query | string | No | |
| ClassDescriptionEndsWith | query | string | No | |
| ClassDescriptionContains | query | string | No | |
| ClassDescriptionLike | query | string | No | |
| ClassDescriptionBetween | query | string[] | No | |
| ClassDescriptionIn | 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 |
|---|---|---|---|---|
| InvoiceID | form | string | No | |
| InvoiceNo | form | string | No | |
| BillWhenComplete | form | short | No | |
| OrderNo | form | string | No | |
| CreditNote | form | bool | No | |
| WholeSaleInvoice | form | bool | No | |
| TaxExemptNo | form | string | No | |
| InvoiceHistoryID | form | string | No | |
| HistoryNo | form | short? | No | |
| RunNo | form | string | No | |
| RecordDate | form | DateTime | No | |
| InvoiceLineID | form | string | No | |
| PartNo | form | string | No | |
| Description | form | string | No | |
| CostIn | form | decimal? | No | |
| QuantityThisDel | form | decimal? | No | |
| CurrentLineTotal | form | decimal? | No | |
| TaxToCharge | form | decimal? | No | |
| TaxPaid | form | decimal? | No | |
| DecimalPlaces | form | short? | No | |
| TaxID | form | string | No | |
| PhysicalItem | form | short? | No | |
| NonStock | form | bool? | No | |
| DebtorID | form | string | No | |
| AccountNo | form | string | No | |
| Name | form | string | No | |
| InventoryClassificationID | form | string | No | |
| ClassDescription | 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_ProfitQuery 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"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"BillWhenComplete":0,"BillWhenCompleteGreaterThanOrEqualTo":0,"BillWhenCompleteGreaterThan":0,"BillWhenCompleteLessThan":0,"BillWhenCompleteLessThanOrEqualTo":0,"BillWhenCompleteNotEqualTo":0,"BillWhenCompleteBetween":[0],"BillWhenCompleteIn":[0],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"CreditNote":false,"WholeSaleInvoice":false,"TaxExemptNo":"String","TaxExemptNoStartsWith":"String","TaxExemptNoEndsWith":"String","TaxExemptNoContains":"String","TaxExemptNoLike":"String","TaxExemptNoBetween":["String"],"TaxExemptNoIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"HistoryNo":0,"HistoryNoGreaterThanOrEqualTo":0,"HistoryNoGreaterThan":0,"HistoryNoLessThan":0,"HistoryNoLessThanOrEqualTo":0,"HistoryNoNotEqualTo":0,"HistoryNoBetween":[0],"HistoryNoIn":[0],"RunNo":"String","RunNoStartsWith":"String","RunNoEndsWith":"String","RunNoContains":"String","RunNoLike":"String","RunNoBetween":["String"],"RunNoIn":["String"],"RecordDate":"0001-01-01T00:00:00.0000000","RecordDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","RecordDateGreaterThan":"0001-01-01T00:00:00.0000000","RecordDateLessThan":"0001-01-01T00:00:00.0000000","RecordDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","RecordDateNotEqualTo":"0001-01-01T00:00:00.0000000","RecordDateBetween":["0001-01-01T00:00:00.0000000"],"RecordDateIn":["0001-01-01T00:00:00.0000000"],"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"CostIn":0,"CostInGreaterThanOrEqualTo":0,"CostInGreaterThan":0,"CostInLessThan":0,"CostInLessThanOrEqualTo":0,"CostInNotEqualTo":0,"CostInBetween":[0],"CostInIn":[0],"QuantityThisDel":0,"QuantityThisDelGreaterThanOrEqualTo":0,"QuantityThisDelGreaterThan":0,"QuantityThisDelLessThan":0,"QuantityThisDelLessThanOrEqualTo":0,"QuantityThisDelNotEqualTo":0,"QuantityThisDelBetween":[0],"QuantityThisDelIn":[0],"CurrentLineTotal":0,"CurrentLineTotalGreaterThanOrEqualTo":0,"CurrentLineTotalGreaterThan":0,"CurrentLineTotalLessThan":0,"CurrentLineTotalLessThanOrEqualTo":0,"CurrentLineTotalNotEqualTo":0,"CurrentLineTotalBetween":[0],"CurrentLineTotalIn":[0],"TaxToCharge":0,"TaxToChargeGreaterThanOrEqualTo":0,"TaxToChargeGreaterThan":0,"TaxToChargeLessThan":0,"TaxToChargeLessThanOrEqualTo":0,"TaxToChargeNotEqualTo":0,"TaxToChargeBetween":[0],"TaxToChargeIn":[0],"TaxPaid":0,"TaxPaidGreaterThanOrEqualTo":0,"TaxPaidGreaterThan":0,"TaxPaidLessThan":0,"TaxPaidLessThanOrEqualTo":0,"TaxPaidNotEqualTo":0,"TaxPaidBetween":[0],"TaxPaidIn":[0],"DecimalPlaces":0,"DecimalPlacesGreaterThanOrEqualTo":0,"DecimalPlacesGreaterThan":0,"DecimalPlacesLessThan":0,"DecimalPlacesLessThanOrEqualTo":0,"DecimalPlacesNotEqualTo":0,"DecimalPlacesBetween":[0],"DecimalPlacesIn":[0],"TaxID":"String","TaxIDStartsWith":"String","TaxIDEndsWith":"String","TaxIDContains":"String","TaxIDLike":"String","TaxIDBetween":["String"],"TaxIDIn":["String"],"PhysicalItem":0,"PhysicalItemGreaterThanOrEqualTo":0,"PhysicalItemGreaterThan":0,"PhysicalItemLessThan":0,"PhysicalItemLessThanOrEqualTo":0,"PhysicalItemNotEqualTo":0,"PhysicalItemBetween":[0],"PhysicalItemIn":[0],"NonStock":false,"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"InventoryClassificationID":"String","InventoryClassificationIDStartsWith":"String","InventoryClassificationIDEndsWith":"String","InventoryClassificationIDContains":"String","InventoryClassificationIDLike":"String","InventoryClassificationIDBetween":["String"],"InventoryClassificationIDIn":["String"],"ClassDescription":"String","ClassDescriptionStartsWith":"String","ClassDescriptionEndsWith":"String","ClassDescriptionContains":"String","ClassDescriptionLike":"String","ClassDescriptionBetween":["String"],"ClassDescriptionIn":["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":[{"InvoiceID":"String","InvoiceNo":"String","OrderNo":"String","TaxExemptNo":"String","InvoiceHistoryID":"String","HistoryNo":0,"RunNo":"String","InvoiceLineID":"String","PartNo":"String","Description":"String","CostIn":0,"QuantityThisDel":0,"CurrentLineTotal":0,"TaxToCharge":0,"TaxPaid":0,"DecimalPlaces":0,"TaxID":"String","PhysicalItem":0,"NonStock":false,"DebtorID":"String","AccountNo":"String","Name":"String","InventoryClassificationID":"String","ClassDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}