| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllocLineID | query | string | No | |
| AllocLineIDStartsWith | query | string | No | |
| AllocLineIDEndsWith | query | string | No | |
| AllocLineIDContains | query | string | No | |
| AllocLineIDLike | query | string | No | |
| AllocLineIDBetween | query | string[] | No | |
| AllocLineIDIn | query | string[] | No | |
| AllocID | query | string | No | |
| AllocIDStartsWith | query | string | No | |
| AllocIDEndsWith | query | string | No | |
| AllocIDContains | query | string | No | |
| AllocIDLike | query | string | No | |
| AllocIDBetween | query | string[] | No | |
| AllocIDIn | query | string[] | No | |
| AllocDate | query | DateTime? | No | |
| AllocDateGreaterThanOrEqualTo | query | DateTime? | No | |
| AllocDateGreaterThan | query | DateTime? | No | |
| AllocDateLessThan | query | DateTime? | No | |
| AllocDateLessThanOrEqualTo | query | DateTime? | No | |
| AllocDateNotEqualTo | query | DateTime? | No | |
| AllocDateBetween | query | Nullable<DateTime>[] | No | |
| AllocDateIn | query | Nullable<DateTime>[] | 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 | |
| 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 | |
| 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 | |
| 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 | |
| Price | query | decimal? | No | |
| PriceGreaterThanOrEqualTo | query | decimal? | No | |
| PriceGreaterThan | query | decimal? | No | |
| PriceLessThan | query | decimal? | No | |
| PriceLessThanOrEqualTo | query | decimal? | No | |
| PriceNotEqualTo | query | decimal? | No | |
| PriceBetween | query | Nullable<Decimal>[] | No | |
| PriceIn | query | Nullable<Decimal>[] | No | |
| EstBOValue | query | decimal? | No | |
| EstBOValueGreaterThanOrEqualTo | query | decimal? | No | |
| EstBOValueGreaterThan | query | decimal? | No | |
| EstBOValueLessThan | query | decimal? | No | |
| EstBOValueLessThanOrEqualTo | query | decimal? | No | |
| EstBOValueNotEqualTo | query | decimal? | No | |
| EstBOValueBetween | query | Nullable<Decimal>[] | No | |
| EstBOValueIn | query | Nullable<Decimal>[] | No | |
| Priority | query | DateTime? | No | |
| PriorityGreaterThanOrEqualTo | query | DateTime? | No | |
| PriorityGreaterThan | query | DateTime? | No | |
| PriorityLessThan | query | DateTime? | No | |
| PriorityLessThanOrEqualTo | query | DateTime? | No | |
| PriorityNotEqualTo | query | DateTime? | No | |
| PriorityBetween | query | Nullable<DateTime>[] | No | |
| PriorityIn | query | Nullable<DateTime>[] | No | |
| BackOrderMode | query | short? | No | |
| BackOrderModeGreaterThanOrEqualTo | query | short? | No | |
| BackOrderModeGreaterThan | query | short? | No | |
| BackOrderModeLessThan | query | short? | No | |
| BackOrderModeLessThanOrEqualTo | query | short? | No | |
| BackOrderModeNotEqualTo | query | short? | No | |
| BackOrderModeBetween | query | short[] | No | |
| BackOrderModeIn | query | short[] | No | |
| SourceType | query | short? | No | |
| SourceTypeGreaterThanOrEqualTo | query | short? | No | |
| SourceTypeGreaterThan | query | short? | No | |
| SourceTypeLessThan | query | short? | No | |
| SourceTypeLessThanOrEqualTo | query | short? | No | |
| SourceTypeNotEqualTo | query | short? | No | |
| SourceTypeBetween | query | short[] | No | |
| SourceTypeIn | query | short[] | No | |
| PriorityWeight | query | int? | No | |
| PriorityWeightGreaterThanOrEqualTo | query | int? | No | |
| PriorityWeightGreaterThan | query | int? | No | |
| PriorityWeightLessThan | query | int? | No | |
| PriorityWeightLessThanOrEqualTo | query | int? | No | |
| PriorityWeightNotEqualTo | query | int? | No | |
| PriorityWeightBetween | query | Nullable<Int32>[] | No | |
| PriorityWeightIn | query | Nullable<Int32>[] | 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 |
|---|---|---|---|---|
| AllocLineID | form | string | No | |
| AllocID | form | string | No | |
| AllocDate | form | DateTime? | No | |
| InvoiceNo | form | string | No | |
| OrderNo | form | string | No | |
| DebtorID | form | string | No | |
| Quantity | form | decimal? | No | |
| Price | form | decimal? | No | |
| EstBOValue | form | decimal? | No | |
| Priority | form | DateTime? | No | |
| BackOrderMode | form | short | No | |
| SourceType | form | short | No | |
| PriorityWeight | form | int? | 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/IN_BackOrderAllocLinesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AllocLineID":"String","AllocLineIDStartsWith":"String","AllocLineIDEndsWith":"String","AllocLineIDContains":"String","AllocLineIDLike":"String","AllocLineIDBetween":["String"],"AllocLineIDIn":["String"],"AllocID":"String","AllocIDStartsWith":"String","AllocIDEndsWith":"String","AllocIDContains":"String","AllocIDLike":"String","AllocIDBetween":["String"],"AllocIDIn":["String"],"AllocDate":"0001-01-01T00:00:00.0000000","AllocDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","AllocDateGreaterThan":"0001-01-01T00:00:00.0000000","AllocDateLessThan":"0001-01-01T00:00:00.0000000","AllocDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","AllocDateNotEqualTo":"0001-01-01T00:00:00.0000000","AllocDateBetween":["0001-01-01T00:00:00.0000000"],"AllocDateIn":["0001-01-01T00:00:00.0000000"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"Price":0,"PriceGreaterThanOrEqualTo":0,"PriceGreaterThan":0,"PriceLessThan":0,"PriceLessThanOrEqualTo":0,"PriceNotEqualTo":0,"PriceBetween":[0],"PriceIn":[0],"EstBOValue":0,"EstBOValueGreaterThanOrEqualTo":0,"EstBOValueGreaterThan":0,"EstBOValueLessThan":0,"EstBOValueLessThanOrEqualTo":0,"EstBOValueNotEqualTo":0,"EstBOValueBetween":[0],"EstBOValueIn":[0],"Priority":"0001-01-01T00:00:00.0000000","PriorityGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","PriorityGreaterThan":"0001-01-01T00:00:00.0000000","PriorityLessThan":"0001-01-01T00:00:00.0000000","PriorityLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","PriorityNotEqualTo":"0001-01-01T00:00:00.0000000","PriorityBetween":["0001-01-01T00:00:00.0000000"],"PriorityIn":["0001-01-01T00:00:00.0000000"],"BackOrderMode":0,"BackOrderModeGreaterThanOrEqualTo":0,"BackOrderModeGreaterThan":0,"BackOrderModeLessThan":0,"BackOrderModeLessThanOrEqualTo":0,"BackOrderModeNotEqualTo":0,"BackOrderModeBetween":[0],"BackOrderModeIn":[0],"SourceType":0,"SourceTypeGreaterThanOrEqualTo":0,"SourceTypeGreaterThan":0,"SourceTypeLessThan":0,"SourceTypeLessThanOrEqualTo":0,"SourceTypeNotEqualTo":0,"SourceTypeBetween":[0],"SourceTypeIn":[0],"PriorityWeight":0,"PriorityWeightGreaterThanOrEqualTo":0,"PriorityWeightGreaterThan":0,"PriorityWeightLessThan":0,"PriorityWeightLessThanOrEqualTo":0,"PriorityWeightNotEqualTo":0,"PriorityWeightBetween":[0],"PriorityWeightIn":[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":[{"AllocLineID":"String","AllocID":"String","AllocDate":"0001-01-01T00:00:00.0000000","InvoiceNo":"String","OrderNo":"String","DebtorID":"String","Quantity":0,"Price":0,"EstBOValue":0,"Priority":"0001-01-01T00:00:00.0000000","PriorityWeight":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}