| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CR_PurchID | query | string | No | |
| CR_PurchIDStartsWith | query | string | No | |
| CR_PurchIDEndsWith | query | string | No | |
| CR_PurchIDContains | query | string | No | |
| CR_PurchIDLike | query | string | No | |
| CR_PurchIDBetween | query | string[] | No | |
| CR_PurchIDIn | query | string[] | No | |
| DateRun | query | DateTime? | No | |
| DateRunGreaterThanOrEqualTo | query | DateTime? | No | |
| DateRunGreaterThan | query | DateTime? | No | |
| DateRunLessThan | query | DateTime? | No | |
| DateRunLessThanOrEqualTo | query | DateTime? | No | |
| DateRunNotEqualTo | query | DateTime? | No | |
| DateRunBetween | query | Nullable<DateTime>[] | No | |
| DateRunIn | query | Nullable<DateTime>[] | No | |
| InvoiceDate | query | DateTime? | No | |
| InvoiceDateGreaterThanOrEqualTo | query | DateTime? | No | |
| InvoiceDateGreaterThan | query | DateTime? | No | |
| InvoiceDateLessThan | query | DateTime? | No | |
| InvoiceDateLessThanOrEqualTo | query | DateTime? | No | |
| InvoiceDateNotEqualTo | query | DateTime? | No | |
| InvoiceDateBetween | query | Nullable<DateTime>[] | No | |
| InvoiceDateIn | query | Nullable<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 | |
| 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 | |
| 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 | |
| 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 | |
| Quantity | query | decimal? | No | |
| QuantityGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityGreaterThan | query | decimal? | No | |
| QuantityLessThan | query | decimal? | No | |
| QuantityLessThanOrEqualTo | query | decimal? | No | |
| QuantityNotEqualTo | query | decimal? | No | |
| QuantityBetween | query | Nullable<Decimal>[] | No | |
| QuantityIn | query | Nullable<Decimal>[] | No | |
| UnitCost | query | decimal? | No | |
| UnitCostGreaterThanOrEqualTo | query | decimal? | No | |
| UnitCostGreaterThan | query | decimal? | No | |
| UnitCostLessThan | query | decimal? | No | |
| UnitCostLessThanOrEqualTo | query | decimal? | No | |
| UnitCostNotEqualTo | query | decimal? | No | |
| UnitCostBetween | query | Nullable<Decimal>[] | No | |
| UnitCostIn | query | Nullable<Decimal>[] | No | |
| LineTotal | query | decimal? | No | |
| LineTotalGreaterThanOrEqualTo | query | decimal? | No | |
| LineTotalGreaterThan | query | decimal? | No | |
| LineTotalLessThan | query | decimal? | No | |
| LineTotalLessThanOrEqualTo | query | decimal? | No | |
| LineTotalNotEqualTo | query | decimal? | No | |
| LineTotalBetween | query | Nullable<Decimal>[] | No | |
| LineTotalIn | query | Nullable<Decimal>[] | 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 | |
| InventoryID | query | string | No | |
| InventoryIDStartsWith | query | string | No | |
| InventoryIDEndsWith | query | string | No | |
| InventoryIDContains | query | string | No | |
| InventoryIDLike | query | string | No | |
| InventoryIDBetween | query | string[] | No | |
| InventoryIDIn | query | string[] | No | |
| MonthNo | query | short? | No | |
| MonthNoGreaterThanOrEqualTo | query | short? | No | |
| MonthNoGreaterThan | query | short? | No | |
| MonthNoLessThan | query | short? | No | |
| MonthNoLessThanOrEqualTo | query | short? | No | |
| MonthNoNotEqualTo | query | short? | No | |
| MonthNoBetween | query | Nullable<Int16>[] | No | |
| MonthNoIn | query | Nullable<Int16>[] | No | |
| YearNo | query | short? | No | |
| YearNoGreaterThanOrEqualTo | query | short? | No | |
| YearNoGreaterThan | query | short? | No | |
| YearNoLessThan | query | short? | No | |
| YearNoLessThanOrEqualTo | query | short? | No | |
| YearNoNotEqualTo | query | short? | No | |
| YearNoBetween | query | Nullable<Int16>[] | No | |
| YearNoIn | query | Nullable<Int16>[] | No | |
| IN_LogicalID | query | string | No | |
| IN_LogicalIDStartsWith | query | string | No | |
| IN_LogicalIDEndsWith | query | string | No | |
| IN_LogicalIDContains | query | string | No | |
| IN_LogicalIDLike | query | string | No | |
| IN_LogicalIDBetween | query | string[] | No | |
| IN_LogicalIDIn | 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 |
|---|---|---|---|---|
| CR_PurchID | form | string | No | |
| DateRun | form | DateTime? | No | |
| InvoiceDate | form | DateTime? | No | |
| CreditorID | form | string | No | |
| InvoiceNo | form | string | No | |
| PartNo | form | string | No | |
| Description | form | string | No | |
| ClassDescription | form | string | No | |
| Quantity | form | decimal? | No | |
| UnitCost | form | decimal? | No | |
| LineTotal | form | decimal? | No | |
| InvoiceID | form | string | No | |
| InventoryID | form | string | No | |
| MonthNo | form | short? | No | |
| YearNo | form | short? | No | |
| IN_LogicalID | 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/CR_PurchasesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CR_PurchID":"String","CR_PurchIDStartsWith":"String","CR_PurchIDEndsWith":"String","CR_PurchIDContains":"String","CR_PurchIDLike":"String","CR_PurchIDBetween":["String"],"CR_PurchIDIn":["String"],"DateRun":"0001-01-01T00:00:00.0000000","DateRunGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateRunGreaterThan":"0001-01-01T00:00:00.0000000","DateRunLessThan":"0001-01-01T00:00:00.0000000","DateRunLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateRunNotEqualTo":"0001-01-01T00:00:00.0000000","DateRunBetween":["0001-01-01T00:00:00.0000000"],"DateRunIn":["0001-01-01T00:00:00.0000000"],"InvoiceDate":"0001-01-01T00:00:00.0000000","InvoiceDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateGreaterThan":"0001-01-01T00:00:00.0000000","InvoiceDateLessThan":"0001-01-01T00:00:00.0000000","InvoiceDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateNotEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateBetween":["0001-01-01T00:00:00.0000000"],"InvoiceDateIn":["0001-01-01T00:00:00.0000000"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["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"],"ClassDescription":"String","ClassDescriptionStartsWith":"String","ClassDescriptionEndsWith":"String","ClassDescriptionContains":"String","ClassDescriptionLike":"String","ClassDescriptionBetween":["String"],"ClassDescriptionIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"UnitCost":0,"UnitCostGreaterThanOrEqualTo":0,"UnitCostGreaterThan":0,"UnitCostLessThan":0,"UnitCostLessThanOrEqualTo":0,"UnitCostNotEqualTo":0,"UnitCostBetween":[0],"UnitCostIn":[0],"LineTotal":0,"LineTotalGreaterThanOrEqualTo":0,"LineTotalGreaterThan":0,"LineTotalLessThan":0,"LineTotalLessThanOrEqualTo":0,"LineTotalNotEqualTo":0,"LineTotalBetween":[0],"LineTotalIn":[0],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"MonthNo":0,"MonthNoGreaterThanOrEqualTo":0,"MonthNoGreaterThan":0,"MonthNoLessThan":0,"MonthNoLessThanOrEqualTo":0,"MonthNoNotEqualTo":0,"MonthNoBetween":[0],"MonthNoIn":[0],"YearNo":0,"YearNoGreaterThanOrEqualTo":0,"YearNoGreaterThan":0,"YearNoLessThan":0,"YearNoLessThanOrEqualTo":0,"YearNoNotEqualTo":0,"YearNoBetween":[0],"YearNoIn":[0],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["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":[{"CR_PurchID":"String","DateRun":"0001-01-01T00:00:00.0000000","InvoiceDate":"0001-01-01T00:00:00.0000000","CreditorID":"String","InvoiceNo":"String","PartNo":"String","Description":"String","ClassDescription":"String","Quantity":0,"UnitCost":0,"LineTotal":0,"InvoiceID":"String","InventoryID":"String","MonthNo":0,"YearNo":0,"IN_LogicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}