| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| Type | query | string | No | |
| TypeStartsWith | query | string | No | |
| TypeEndsWith | query | string | No | |
| TypeContains | query | string | No | |
| TypeLike | query | string | No | |
| TypeBetween | query | string[] | No | |
| TypeIn | query | string[] | No | |
| TranDate | query | DateTime? | No | |
| TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
| TranDateGreaterThan | query | DateTime? | No | |
| TranDateLessThan | query | DateTime? | No | |
| TranDateLessThanOrEqualTo | query | DateTime? | No | |
| TranDateNotEqualTo | query | DateTime? | No | |
| TranDateBetween | query | Nullable<DateTime>[] | No | |
| TranDateIn | query | Nullable<DateTime>[] | No | |
| DueDate | query | DateTime? | No | |
| DueDateGreaterThanOrEqualTo | query | DateTime? | No | |
| DueDateGreaterThan | query | DateTime? | No | |
| DueDateLessThan | query | DateTime? | No | |
| DueDateLessThanOrEqualTo | query | DateTime? | No | |
| DueDateNotEqualTo | query | DateTime? | No | |
| DueDateBetween | query | Nullable<DateTime>[] | No | |
| DueDateIn | 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 | |
| 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 | |
| PartDescription | query | string | No | |
| PartDescriptionStartsWith | query | string | No | |
| PartDescriptionEndsWith | query | string | No | |
| PartDescriptionContains | query | string | No | |
| PartDescriptionLike | query | string | No | |
| PartDescriptionBetween | query | string[] | No | |
| PartDescriptionIn | 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 | |
| TotalCost | query | decimal? | No | |
| TotalCostGreaterThanOrEqualTo | query | decimal? | No | |
| TotalCostGreaterThan | query | decimal? | No | |
| TotalCostLessThan | query | decimal? | No | |
| TotalCostLessThanOrEqualTo | query | decimal? | No | |
| TotalCostNotEqualTo | query | decimal? | No | |
| TotalCostBetween | query | Nullable<Decimal>[] | No | |
| TotalCostIn | query | Nullable<Decimal>[] | No | |
| TaxAmount | query | decimal? | No | |
| TaxAmountGreaterThanOrEqualTo | query | decimal? | No | |
| TaxAmountGreaterThan | query | decimal? | No | |
| TaxAmountLessThan | query | decimal? | No | |
| TaxAmountLessThanOrEqualTo | query | decimal? | No | |
| TaxAmountNotEqualTo | query | decimal? | No | |
| TaxAmountBetween | query | Nullable<Decimal>[] | No | |
| TaxAmountIn | query | Nullable<Decimal>[] | No | |
| IncTotal | query | decimal? | No | |
| IncTotalGreaterThanOrEqualTo | query | decimal? | No | |
| IncTotalGreaterThan | query | decimal? | No | |
| IncTotalLessThan | query | decimal? | No | |
| IncTotalLessThanOrEqualTo | query | decimal? | No | |
| IncTotalNotEqualTo | query | decimal? | No | |
| IncTotalBetween | query | Nullable<Decimal>[] | No | |
| IncTotalIn | query | Nullable<Decimal>[] | No | |
| CurrencyRate | query | decimal? | No | |
| CurrencyRateGreaterThanOrEqualTo | query | decimal? | No | |
| CurrencyRateGreaterThan | query | decimal? | No | |
| CurrencyRateLessThan | query | decimal? | No | |
| CurrencyRateLessThanOrEqualTo | query | decimal? | No | |
| CurrencyRateNotEqualTo | query | decimal? | No | |
| CurrencyRateBetween | query | Nullable<Decimal>[] | No | |
| CurrencyRateIn | query | Nullable<Decimal>[] | No | |
| FxUnitCost | query | decimal? | No | |
| FxUnitCostGreaterThanOrEqualTo | query | decimal? | No | |
| FxUnitCostGreaterThan | query | decimal? | No | |
| FxUnitCostLessThan | query | decimal? | No | |
| FxUnitCostLessThanOrEqualTo | query | decimal? | No | |
| FxUnitCostNotEqualTo | query | decimal? | No | |
| FxUnitCostBetween | query | Nullable<Decimal>[] | No | |
| FxUnitCostIn | query | Nullable<Decimal>[] | No | |
| FxTotalCost | query | decimal? | No | |
| FxTotalCostGreaterThanOrEqualTo | query | decimal? | No | |
| FxTotalCostGreaterThan | query | decimal? | No | |
| FxTotalCostLessThan | query | decimal? | No | |
| FxTotalCostLessThanOrEqualTo | query | decimal? | No | |
| FxTotalCostNotEqualTo | query | decimal? | No | |
| FxTotalCostBetween | query | Nullable<Decimal>[] | No | |
| FxTotalCostIn | query | Nullable<Decimal>[] | 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 |
|---|---|---|---|---|
| CreditorID | form | string | No | |
| Type | form | string | No | |
| TranDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| InvoiceNo | form | string | No | |
| PartNo | form | string | No | |
| PartDescription | form | string | No | |
| Quantity | form | decimal? | No | |
| UnitCost | form | decimal? | No | |
| TotalCost | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| IncTotal | form | decimal? | No | |
| CurrencyRate | form | decimal? | No | |
| FxUnitCost | form | decimal? | No | |
| FxTotalCost | form | decimal? | 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/V_CR_PurchaseShipmentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"Type":"String","TypeStartsWith":"String","TypeEndsWith":"String","TypeContains":"String","TypeLike":"String","TypeBetween":["String"],"TypeIn":["String"],"TranDate":"0001-01-01T00:00:00.0000000","TranDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateGreaterThan":"0001-01-01T00:00:00.0000000","TranDateLessThan":"0001-01-01T00:00:00.0000000","TranDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateNotEqualTo":"0001-01-01T00:00:00.0000000","TranDateBetween":["0001-01-01T00:00:00.0000000"],"TranDateIn":["0001-01-01T00:00:00.0000000"],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"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"],"PartDescription":"String","PartDescriptionStartsWith":"String","PartDescriptionEndsWith":"String","PartDescriptionContains":"String","PartDescriptionLike":"String","PartDescriptionBetween":["String"],"PartDescriptionIn":["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],"TotalCost":0,"TotalCostGreaterThanOrEqualTo":0,"TotalCostGreaterThan":0,"TotalCostLessThan":0,"TotalCostLessThanOrEqualTo":0,"TotalCostNotEqualTo":0,"TotalCostBetween":[0],"TotalCostIn":[0],"TaxAmount":0,"TaxAmountGreaterThanOrEqualTo":0,"TaxAmountGreaterThan":0,"TaxAmountLessThan":0,"TaxAmountLessThanOrEqualTo":0,"TaxAmountNotEqualTo":0,"TaxAmountBetween":[0],"TaxAmountIn":[0],"IncTotal":0,"IncTotalGreaterThanOrEqualTo":0,"IncTotalGreaterThan":0,"IncTotalLessThan":0,"IncTotalLessThanOrEqualTo":0,"IncTotalNotEqualTo":0,"IncTotalBetween":[0],"IncTotalIn":[0],"CurrencyRate":0,"CurrencyRateGreaterThanOrEqualTo":0,"CurrencyRateGreaterThan":0,"CurrencyRateLessThan":0,"CurrencyRateLessThanOrEqualTo":0,"CurrencyRateNotEqualTo":0,"CurrencyRateBetween":[0],"CurrencyRateIn":[0],"FxUnitCost":0,"FxUnitCostGreaterThanOrEqualTo":0,"FxUnitCostGreaterThan":0,"FxUnitCostLessThan":0,"FxUnitCostLessThanOrEqualTo":0,"FxUnitCostNotEqualTo":0,"FxUnitCostBetween":[0],"FxUnitCostIn":[0],"FxTotalCost":0,"FxTotalCostGreaterThanOrEqualTo":0,"FxTotalCostGreaterThan":0,"FxTotalCostLessThan":0,"FxTotalCostLessThanOrEqualTo":0,"FxTotalCostNotEqualTo":0,"FxTotalCostBetween":[0],"FxTotalCostIn":[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":[{"CreditorID":"String","Type":"String","TranDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","InvoiceNo":"String","PartNo":"String","PartDescription":"String","Quantity":0,"UnitCost":0,"TotalCost":0,"TaxAmount":0,"IncTotal":0,"CurrencyRate":0,"FxUnitCost":0,"FxTotalCost":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}