| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SalesID | query | string | No | |
| SalesIDStartsWith | query | string | No | |
| SalesIDEndsWith | query | string | No | |
| SalesIDContains | query | string | No | |
| SalesIDLike | query | string | No | |
| SalesIDBetween | query | string[] | No | |
| SalesIDIn | 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 | DateTime[] | No | |
| DateRunIn | query | 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 | DateTime[] | No | |
| InvoiceDateIn | query | DateTime[] | 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 | |
| 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 | |
| Cat1Description | query | string | No | |
| Cat1DescriptionStartsWith | query | string | No | |
| Cat1DescriptionEndsWith | query | string | No | |
| Cat1DescriptionContains | query | string | No | |
| Cat1DescriptionLike | query | string | No | |
| Cat1DescriptionBetween | query | string[] | No | |
| Cat1DescriptionIn | query | string[] | No | |
| Cat2Description | query | string | No | |
| Cat2DescriptionStartsWith | query | string | No | |
| Cat2DescriptionEndsWith | query | string | No | |
| Cat2DescriptionContains | query | string | No | |
| Cat2DescriptionLike | query | string | No | |
| Cat2DescriptionBetween | query | string[] | No | |
| Cat2DescriptionIn | query | string[] | No | |
| Cat3Description | query | string | No | |
| Cat3DescriptionStartsWith | query | string | No | |
| Cat3DescriptionEndsWith | query | string | No | |
| Cat3DescriptionContains | query | string | No | |
| Cat3DescriptionLike | query | string | No | |
| Cat3DescriptionBetween | query | string[] | No | |
| Cat3DescriptionIn | 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 | |
| UnitSellPrice | query | decimal? | No | |
| UnitSellPriceGreaterThanOrEqualTo | query | decimal? | No | |
| UnitSellPriceGreaterThan | query | decimal? | No | |
| UnitSellPriceLessThan | query | decimal? | No | |
| UnitSellPriceLessThanOrEqualTo | query | decimal? | No | |
| UnitSellPriceNotEqualTo | query | decimal? | No | |
| UnitSellPriceBetween | query | Nullable<Decimal>[] | No | |
| UnitSellPriceIn | query | Nullable<Decimal>[] | No | |
| LineTax | query | decimal? | No | |
| LineTaxGreaterThanOrEqualTo | query | decimal? | No | |
| LineTaxGreaterThan | query | decimal? | No | |
| LineTaxLessThan | query | decimal? | No | |
| LineTaxLessThanOrEqualTo | query | decimal? | No | |
| LineTaxNotEqualTo | query | decimal? | No | |
| LineTaxBetween | query | Nullable<Decimal>[] | No | |
| LineTaxIn | 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| Cat4Description | query | string | No | |
| Cat4DescriptionStartsWith | query | string | No | |
| Cat4DescriptionEndsWith | query | string | No | |
| Cat4DescriptionContains | query | string | No | |
| Cat4DescriptionLike | query | string | No | |
| Cat4DescriptionBetween | query | string[] | No | |
| Cat4DescriptionIn | query | string[] | No | |
| Cat5Description | query | string | No | |
| Cat5DescriptionStartsWith | query | string | No | |
| Cat5DescriptionEndsWith | query | string | No | |
| Cat5DescriptionContains | query | string | No | |
| Cat5DescriptionLike | query | string | No | |
| Cat5DescriptionBetween | query | string[] | No | |
| Cat5DescriptionIn | query | string[] | No | |
| KitStyle | query | short? | No | |
| KitStyleGreaterThanOrEqualTo | query | short? | No | |
| KitStyleGreaterThan | query | short? | No | |
| KitStyleLessThan | query | short? | No | |
| KitStyleLessThanOrEqualTo | query | short? | No | |
| KitStyleNotEqualTo | query | short? | No | |
| KitStyleBetween | query | Nullable<Int16>[] | No | |
| KitStyleIn | query | Nullable<Int16>[] | No | |
| KitStatus | query | short? | No | |
| KitStatusGreaterThanOrEqualTo | query | short? | No | |
| KitStatusGreaterThan | query | short? | No | |
| KitStatusLessThan | query | short? | No | |
| KitStatusLessThanOrEqualTo | query | short? | No | |
| KitStatusNotEqualTo | query | short? | No | |
| KitStatusBetween | query | Nullable<Int16>[] | No | |
| KitStatusIn | query | Nullable<Int16>[] | No | |
| SO_LinesID | query | string | No | |
| SO_LinesIDStartsWith | query | string | No | |
| SO_LinesIDEndsWith | query | string | No | |
| SO_LinesIDContains | query | string | No | |
| SO_LinesIDLike | query | string | No | |
| SO_LinesIDBetween | query | string[] | No | |
| SO_LinesIDIn | query | string[] | No | |
| LineCost | query | decimal? | No | |
| LineCostGreaterThanOrEqualTo | query | decimal? | No | |
| LineCostGreaterThan | query | decimal? | No | |
| LineCostLessThan | query | decimal? | No | |
| LineCostLessThanOrEqualTo | query | decimal? | No | |
| LineCostNotEqualTo | query | decimal? | No | |
| LineCostBetween | query | Nullable<Decimal>[] | No | |
| LineCostIn | query | Nullable<Decimal>[] | 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 |
| 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 |
|---|---|---|---|---|
| SalesID | form | string | No | |
| DateRun | form | DateTime | No | |
| InvoiceDate | form | DateTime | No | |
| DebtorID | form | string | No | |
| InvoiceNo | form | string | No | |
| PartNo | form | string | No | |
| Description | form | string | No | |
| ClassDescription | form | string | No | |
| Cat1Description | form | string | No | |
| Cat2Description | form | string | No | |
| Cat3Description | form | string | No | |
| Quantity | form | decimal? | No | |
| UnitCost | form | decimal? | No | |
| UnitSellPrice | form | decimal? | No | |
| LineTax | form | decimal? | No | |
| LineTotal | form | decimal? | No | |
| RunNo | form | string | No | |
| HistoryNo | form | short? | No | |
| InvoiceID | form | string | No | |
| InventoryID | form | string | No | |
| YearNo | form | short? | No | |
| MonthNo | form | short? | No | |
| IN_LogicalID | form | string | No | |
| Cat4Description | form | string | No | |
| Cat5Description | form | string | No | |
| KitStyle | form | short? | No | |
| KitStatus | form | short? | No | |
| SO_LinesID | form | string | No | |
| LineCost | form | decimal? | No | |
| InvoiceHistoryID | 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_SalesHistoryQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SalesID":"String","SalesIDStartsWith":"String","SalesIDEndsWith":"String","SalesIDContains":"String","SalesIDLike":"String","SalesIDBetween":["String"],"SalesIDIn":["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"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["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"],"Cat1Description":"String","Cat1DescriptionStartsWith":"String","Cat1DescriptionEndsWith":"String","Cat1DescriptionContains":"String","Cat1DescriptionLike":"String","Cat1DescriptionBetween":["String"],"Cat1DescriptionIn":["String"],"Cat2Description":"String","Cat2DescriptionStartsWith":"String","Cat2DescriptionEndsWith":"String","Cat2DescriptionContains":"String","Cat2DescriptionLike":"String","Cat2DescriptionBetween":["String"],"Cat2DescriptionIn":["String"],"Cat3Description":"String","Cat3DescriptionStartsWith":"String","Cat3DescriptionEndsWith":"String","Cat3DescriptionContains":"String","Cat3DescriptionLike":"String","Cat3DescriptionBetween":["String"],"Cat3DescriptionIn":["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],"UnitSellPrice":0,"UnitSellPriceGreaterThanOrEqualTo":0,"UnitSellPriceGreaterThan":0,"UnitSellPriceLessThan":0,"UnitSellPriceLessThanOrEqualTo":0,"UnitSellPriceNotEqualTo":0,"UnitSellPriceBetween":[0],"UnitSellPriceIn":[0],"LineTax":0,"LineTaxGreaterThanOrEqualTo":0,"LineTaxGreaterThan":0,"LineTaxLessThan":0,"LineTaxLessThanOrEqualTo":0,"LineTaxNotEqualTo":0,"LineTaxBetween":[0],"LineTaxIn":[0],"LineTotal":0,"LineTotalGreaterThanOrEqualTo":0,"LineTotalGreaterThan":0,"LineTotalLessThan":0,"LineTotalLessThanOrEqualTo":0,"LineTotalNotEqualTo":0,"LineTotalBetween":[0],"LineTotalIn":[0],"RunNo":"String","RunNoStartsWith":"String","RunNoEndsWith":"String","RunNoContains":"String","RunNoLike":"String","RunNoBetween":["String"],"RunNoIn":["String"],"HistoryNo":0,"HistoryNoGreaterThanOrEqualTo":0,"HistoryNoGreaterThan":0,"HistoryNoLessThan":0,"HistoryNoLessThanOrEqualTo":0,"HistoryNoNotEqualTo":0,"HistoryNoBetween":[0],"HistoryNoIn":[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"],"YearNo":0,"YearNoGreaterThanOrEqualTo":0,"YearNoGreaterThan":0,"YearNoLessThan":0,"YearNoLessThanOrEqualTo":0,"YearNoNotEqualTo":0,"YearNoBetween":[0],"YearNoIn":[0],"MonthNo":0,"MonthNoGreaterThanOrEqualTo":0,"MonthNoGreaterThan":0,"MonthNoLessThan":0,"MonthNoLessThanOrEqualTo":0,"MonthNoNotEqualTo":0,"MonthNoBetween":[0],"MonthNoIn":[0],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"Cat4Description":"String","Cat4DescriptionStartsWith":"String","Cat4DescriptionEndsWith":"String","Cat4DescriptionContains":"String","Cat4DescriptionLike":"String","Cat4DescriptionBetween":["String"],"Cat4DescriptionIn":["String"],"Cat5Description":"String","Cat5DescriptionStartsWith":"String","Cat5DescriptionEndsWith":"String","Cat5DescriptionContains":"String","Cat5DescriptionLike":"String","Cat5DescriptionBetween":["String"],"Cat5DescriptionIn":["String"],"KitStyle":0,"KitStyleGreaterThanOrEqualTo":0,"KitStyleGreaterThan":0,"KitStyleLessThan":0,"KitStyleLessThanOrEqualTo":0,"KitStyleNotEqualTo":0,"KitStyleBetween":[0],"KitStyleIn":[0],"KitStatus":0,"KitStatusGreaterThanOrEqualTo":0,"KitStatusGreaterThan":0,"KitStatusLessThan":0,"KitStatusLessThanOrEqualTo":0,"KitStatusNotEqualTo":0,"KitStatusBetween":[0],"KitStatusIn":[0],"SO_LinesID":"String","SO_LinesIDStartsWith":"String","SO_LinesIDEndsWith":"String","SO_LinesIDContains":"String","SO_LinesIDLike":"String","SO_LinesIDBetween":["String"],"SO_LinesIDIn":["String"],"LineCost":0,"LineCostGreaterThanOrEqualTo":0,"LineCostGreaterThan":0,"LineCostLessThan":0,"LineCostLessThanOrEqualTo":0,"LineCostNotEqualTo":0,"LineCostBetween":[0],"LineCostIn":[0],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["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":[{"SalesID":"String","DebtorID":"String","InvoiceNo":"String","PartNo":"String","Description":"String","ClassDescription":"String","Cat1Description":"String","Cat2Description":"String","Cat3Description":"String","Quantity":0,"UnitCost":0,"UnitSellPrice":0,"LineTax":0,"LineTotal":0,"RunNo":"String","HistoryNo":0,"InvoiceID":"String","InventoryID":"String","YearNo":0,"MonthNo":0,"IN_LogicalID":"String","Cat4Description":"String","Cat5Description":"String","KitStyle":0,"KitStatus":0,"SO_LinesID":"String","LineCost":0,"InvoiceHistoryID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}