JiwaAPI

<back to all web services

SO_EDIMainQuery

Requires Authentication
SO_EDIMainQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
EDIOrderTypequerybyte?No
EDIOrderTypeGreaterThanOrEqualToquerybyte?No
EDIOrderTypeGreaterThanquerybyte?No
EDIOrderTypeLessThanquerybyte?No
EDIOrderTypeLessThanOrEqualToquerybyte?No
EDIOrderTypeNotEqualToquerybyte?No
EDIOrderTypeBetweenqueryNullable<Byte>[]No
EDIOrderTypeInqueryNullable<Byte>[]No
EDIAddressquerystringNo
EDIAddressStartsWithquerystringNo
EDIAddressEndsWithquerystringNo
EDIAddressContainsquerystringNo
EDIAddressLikequerystringNo
EDIAddressBetweenquerystring[]No
EDIAddressInquerystring[]No
EDIDeliverNotBeforeDatequeryDateTime?No
EDIDeliverNotBeforeDateGreaterThanOrEqualToqueryDateTime?No
EDIDeliverNotBeforeDateGreaterThanqueryDateTime?No
EDIDeliverNotBeforeDateLessThanqueryDateTime?No
EDIDeliverNotBeforeDateLessThanOrEqualToqueryDateTime?No
EDIDeliverNotBeforeDateNotEqualToqueryDateTime?No
EDIDeliverNotBeforeDateBetweenqueryNullable<DateTime>[]No
EDIDeliverNotBeforeDateInqueryNullable<DateTime>[]No
EDIDeliverNotAfterDatequeryDateTime?No
EDIDeliverNotAfterDateGreaterThanOrEqualToqueryDateTime?No
EDIDeliverNotAfterDateGreaterThanqueryDateTime?No
EDIDeliverNotAfterDateLessThanqueryDateTime?No
EDIDeliverNotAfterDateLessThanOrEqualToqueryDateTime?No
EDIDeliverNotAfterDateNotEqualToqueryDateTime?No
EDIDeliverNotAfterDateBetweenqueryNullable<DateTime>[]No
EDIDeliverNotAfterDateInqueryNullable<DateTime>[]No
ReceiverEDIAddressquerystringNo
ReceiverEDIAddressStartsWithquerystringNo
ReceiverEDIAddressEndsWithquerystringNo
ReceiverEDIAddressContainsquerystringNo
ReceiverEDIAddressLikequerystringNo
ReceiverEDIAddressBetweenquerystring[]No
ReceiverEDIAddressInquerystring[]No
VendorNumberquerystringNo
VendorNumberStartsWithquerystringNo
VendorNumberEndsWithquerystringNo
VendorNumberContainsquerystringNo
VendorNumberLikequerystringNo
VendorNumberBetweenquerystring[]No
VendorNumberInquerystring[]No
BuyerNumberquerystringNo
BuyerNumberStartsWithquerystringNo
BuyerNumberEndsWithquerystringNo
BuyerNumberContainsquerystringNo
BuyerNumberLikequerystringNo
BuyerNumberBetweenquerystring[]No
BuyerNumberInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_EDIMain Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
EDIOrderTypeformbyte?No
EDIAddressformstringNo
EDIDeliverNotBeforeDateformDateTime?No
EDIDeliverNotAfterDateformDateTime?No
ReceiverEDIAddressformstringNo
VendorNumberformstringNo
BuyerNumberformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}