| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| EDIOrderType | query | byte? | No | |
| EDIOrderTypeGreaterThanOrEqualTo | query | byte? | No | |
| EDIOrderTypeGreaterThan | query | byte? | No | |
| EDIOrderTypeLessThan | query | byte? | No | |
| EDIOrderTypeLessThanOrEqualTo | query | byte? | No | |
| EDIOrderTypeNotEqualTo | query | byte? | No | |
| EDIOrderTypeBetween | query | Nullable<Byte>[] | No | |
| EDIOrderTypeIn | query | Nullable<Byte>[] | No | |
| EDIAddress | query | string | No | |
| EDIAddressStartsWith | query | string | No | |
| EDIAddressEndsWith | query | string | No | |
| EDIAddressContains | query | string | No | |
| EDIAddressLike | query | string | No | |
| EDIAddressBetween | query | string[] | No | |
| EDIAddressIn | query | string[] | No | |
| EDIDeliverNotBeforeDate | query | DateTime? | No | |
| EDIDeliverNotBeforeDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EDIDeliverNotBeforeDateGreaterThan | query | DateTime? | No | |
| EDIDeliverNotBeforeDateLessThan | query | DateTime? | No | |
| EDIDeliverNotBeforeDateLessThanOrEqualTo | query | DateTime? | No | |
| EDIDeliverNotBeforeDateNotEqualTo | query | DateTime? | No | |
| EDIDeliverNotBeforeDateBetween | query | Nullable<DateTime>[] | No | |
| EDIDeliverNotBeforeDateIn | query | Nullable<DateTime>[] | No | |
| EDIDeliverNotAfterDate | query | DateTime? | No | |
| EDIDeliverNotAfterDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EDIDeliverNotAfterDateGreaterThan | query | DateTime? | No | |
| EDIDeliverNotAfterDateLessThan | query | DateTime? | No | |
| EDIDeliverNotAfterDateLessThanOrEqualTo | query | DateTime? | No | |
| EDIDeliverNotAfterDateNotEqualTo | query | DateTime? | No | |
| EDIDeliverNotAfterDateBetween | query | Nullable<DateTime>[] | No | |
| EDIDeliverNotAfterDateIn | query | Nullable<DateTime>[] | No | |
| ReceiverEDIAddress | query | string | No | |
| ReceiverEDIAddressStartsWith | query | string | No | |
| ReceiverEDIAddressEndsWith | query | string | No | |
| ReceiverEDIAddressContains | query | string | No | |
| ReceiverEDIAddressLike | query | string | No | |
| ReceiverEDIAddressBetween | query | string[] | No | |
| ReceiverEDIAddressIn | query | string[] | No | |
| VendorNumber | query | string | No | |
| VendorNumberStartsWith | query | string | No | |
| VendorNumberEndsWith | query | string | No | |
| VendorNumberContains | query | string | No | |
| VendorNumberLike | query | string | No | |
| VendorNumberBetween | query | string[] | No | |
| VendorNumberIn | query | string[] | No | |
| BuyerNumber | query | string | No | |
| BuyerNumberStartsWith | query | string | No | |
| BuyerNumberEndsWith | query | string | No | |
| BuyerNumberContains | query | string | No | |
| BuyerNumberLike | query | string | No | |
| BuyerNumberBetween | query | string[] | No | |
| BuyerNumberIn | 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 |
|---|---|---|---|---|
| InvoiceID | form | string | No | |
| EDIOrderType | form | byte? | No | |
| EDIAddress | form | string | No | |
| EDIDeliverNotBeforeDate | form | DateTime? | No | |
| EDIDeliverNotAfterDate | form | DateTime? | No | |
| ReceiverEDIAddress | form | string | No | |
| VendorNumber | form | string | No | |
| BuyerNumber | 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_EDIMainQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"EDIOrderType":0,"EDIOrderTypeGreaterThanOrEqualTo":0,"EDIOrderTypeGreaterThan":0,"EDIOrderTypeLessThan":0,"EDIOrderTypeLessThanOrEqualTo":0,"EDIOrderTypeNotEqualTo":0,"EDIOrderTypeBetween":[0],"EDIOrderTypeIn":[0],"EDIAddress":"String","EDIAddressStartsWith":"String","EDIAddressEndsWith":"String","EDIAddressContains":"String","EDIAddressLike":"String","EDIAddressBetween":["String"],"EDIAddressIn":["String"],"EDIDeliverNotBeforeDate":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateGreaterThan":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateLessThan":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateNotEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotBeforeDateBetween":["0001-01-01T00:00:00.0000000"],"EDIDeliverNotBeforeDateIn":["0001-01-01T00:00:00.0000000"],"EDIDeliverNotAfterDate":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateGreaterThan":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateLessThan":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateNotEqualTo":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDateBetween":["0001-01-01T00:00:00.0000000"],"EDIDeliverNotAfterDateIn":["0001-01-01T00:00:00.0000000"],"ReceiverEDIAddress":"String","ReceiverEDIAddressStartsWith":"String","ReceiverEDIAddressEndsWith":"String","ReceiverEDIAddressContains":"String","ReceiverEDIAddressLike":"String","ReceiverEDIAddressBetween":["String"],"ReceiverEDIAddressIn":["String"],"VendorNumber":"String","VendorNumberStartsWith":"String","VendorNumberEndsWith":"String","VendorNumberContains":"String","VendorNumberLike":"String","VendorNumberBetween":["String"],"VendorNumberIn":["String"],"BuyerNumber":"String","BuyerNumberStartsWith":"String","BuyerNumberEndsWith":"String","BuyerNumberContains":"String","BuyerNumberLike":"String","BuyerNumberBetween":["String"],"BuyerNumberIn":["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":[{"InvoiceID":"String","EDIOrderType":0,"EDIAddress":"String","EDIDeliverNotBeforeDate":"0001-01-01T00:00:00.0000000","EDIDeliverNotAfterDate":"0001-01-01T00:00:00.0000000","ReceiverEDIAddress":"String","VendorNumber":"String","BuyerNumber":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}