| 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 | |
| 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 | |
| DB_PricingGroups_RecID | query | string | No | |
| DB_PricingGroups_RecIDStartsWith | query | string | No | |
| DB_PricingGroups_RecIDEndsWith | query | string | No | |
| DB_PricingGroups_RecIDContains | query | string | No | |
| DB_PricingGroups_RecIDLike | query | string | No | |
| DB_PricingGroups_RecIDBetween | query | string[] | No | |
| DB_PricingGroups_RecIDIn | query | string[] | No | |
| Source | query | short? | No | |
| SourceGreaterThanOrEqualTo | query | short? | No | |
| SourceGreaterThan | query | short? | No | |
| SourceLessThan | query | short? | No | |
| SourceLessThanOrEqualTo | query | short? | No | |
| SourceNotEqualTo | query | short? | No | |
| SourceBetween | query | short[] | No | |
| SourceIn | query | short[] | No | |
| OPMode | query | short? | No | |
| OPModeGreaterThanOrEqualTo | query | short? | No | |
| OPModeGreaterThan | query | short? | No | |
| OPModeLessThan | query | short? | No | |
| OPModeLessThanOrEqualTo | query | short? | No | |
| OPModeNotEqualTo | query | short? | No | |
| OPModeBetween | query | short[] | No | |
| OPModeIn | query | short[] | No | |
| Amount | query | decimal? | No | |
| AmountGreaterThanOrEqualTo | query | decimal? | No | |
| AmountGreaterThan | query | decimal? | No | |
| AmountLessThan | query | decimal? | No | |
| AmountLessThanOrEqualTo | query | decimal? | No | |
| AmountNotEqualTo | query | decimal? | No | |
| AmountBetween | query | Nullable<Decimal>[] | No | |
| AmountIn | query | Nullable<Decimal>[] | No | |
| StartDate | query | DateTime? | No | |
| StartDateGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateGreaterThan | query | DateTime? | No | |
| StartDateLessThan | query | DateTime? | No | |
| StartDateLessThanOrEqualTo | query | DateTime? | No | |
| StartDateNotEqualTo | query | DateTime? | No | |
| StartDateBetween | query | Nullable<DateTime>[] | No | |
| StartDateIn | query | Nullable<DateTime>[] | No | |
| EndDate | query | DateTime? | No | |
| EndDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EndDateGreaterThan | query | DateTime? | No | |
| EndDateLessThan | query | DateTime? | No | |
| EndDateLessThanOrEqualTo | query | DateTime? | No | |
| EndDateNotEqualTo | query | DateTime? | No | |
| EndDateBetween | query | Nullable<DateTime>[] | No | |
| EndDateIn | query | Nullable<DateTime>[] | No | |
| UseQuantityBreak | query | bool? | No | |
| QuantityBreak | query | decimal? | No | |
| QuantityBreakGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityBreakGreaterThan | query | decimal? | No | |
| QuantityBreakLessThan | query | decimal? | No | |
| QuantityBreakLessThanOrEqualTo | query | decimal? | No | |
| QuantityBreakNotEqualTo | query | decimal? | No | |
| QuantityBreakBetween | query | Nullable<Decimal>[] | No | |
| QuantityBreakIn | query | Nullable<Decimal>[] | No | |
| Note | query | string | No | |
| NoteStartsWith | query | string | No | |
| NoteEndsWith | query | string | No | |
| NoteContains | query | string | No | |
| NoteLike | query | string | No | |
| NoteBetween | query | string[] | No | |
| NoteIn | query | string[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | No | |
| RowHash | query | byte[] | 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 | |
| InventoryID | form | string | No | |
| DB_PricingGroups_RecID | form | string | No | |
| Source | form | short | No | |
| OPMode | form | short | No | |
| Amount | form | decimal? | No | |
| StartDate | form | DateTime? | No | |
| EndDate | form | DateTime? | No | |
| UseQuantityBreak | form | bool | No | |
| QuantityBreak | form | decimal? | No | |
| Note | form | string | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | 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_DebtorPricingGroupSpecificPriceQuery 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"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"DB_PricingGroups_RecID":"String","DB_PricingGroups_RecIDStartsWith":"String","DB_PricingGroups_RecIDEndsWith":"String","DB_PricingGroups_RecIDContains":"String","DB_PricingGroups_RecIDLike":"String","DB_PricingGroups_RecIDBetween":["String"],"DB_PricingGroups_RecIDIn":["String"],"Source":0,"SourceGreaterThanOrEqualTo":0,"SourceGreaterThan":0,"SourceLessThan":0,"SourceLessThanOrEqualTo":0,"SourceNotEqualTo":0,"SourceBetween":[0],"SourceIn":[0],"OPMode":0,"OPModeGreaterThanOrEqualTo":0,"OPModeGreaterThan":0,"OPModeLessThan":0,"OPModeLessThanOrEqualTo":0,"OPModeNotEqualTo":0,"OPModeBetween":[0],"OPModeIn":[0],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"StartDate":"0001-01-01T00:00:00.0000000","StartDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateGreaterThan":"0001-01-01T00:00:00.0000000","StartDateLessThan":"0001-01-01T00:00:00.0000000","StartDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateBetween":["0001-01-01T00:00:00.0000000"],"StartDateIn":["0001-01-01T00:00:00.0000000"],"EndDate":"0001-01-01T00:00:00.0000000","EndDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateGreaterThan":"0001-01-01T00:00:00.0000000","EndDateLessThan":"0001-01-01T00:00:00.0000000","EndDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateBetween":["0001-01-01T00:00:00.0000000"],"EndDateIn":["0001-01-01T00:00:00.0000000"],"UseQuantityBreak":false,"QuantityBreak":0,"QuantityBreakGreaterThanOrEqualTo":0,"QuantityBreakGreaterThan":0,"QuantityBreakLessThan":0,"QuantityBreakLessThanOrEqualTo":0,"QuantityBreakNotEqualTo":0,"QuantityBreakBetween":[0],"QuantityBreakIn":[0],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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","InventoryID":"String","DB_PricingGroups_RecID":"String","Amount":0,"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","QuantityBreak":0,"Note":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}