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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SO_EDIMainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_EDIMainQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <BuyerNumber>String</BuyerNumber>
  <BuyerNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BuyerNumberBetween>
  <BuyerNumberContains>String</BuyerNumberContains>
  <BuyerNumberEndsWith>String</BuyerNumberEndsWith>
  <BuyerNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BuyerNumberIn>
  <BuyerNumberLike>String</BuyerNumberLike>
  <BuyerNumberStartsWith>String</BuyerNumberStartsWith>
  <EDIAddress>String</EDIAddress>
  <EDIAddressBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIAddressBetween>
  <EDIAddressContains>String</EDIAddressContains>
  <EDIAddressEndsWith>String</EDIAddressEndsWith>
  <EDIAddressIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EDIAddressIn>
  <EDIAddressLike>String</EDIAddressLike>
  <EDIAddressStartsWith>String</EDIAddressStartsWith>
  <EDIDeliverNotAfterDate>0001-01-01T00:00:00</EDIDeliverNotAfterDate>
  <EDIDeliverNotAfterDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </EDIDeliverNotAfterDateBetween>
  <EDIDeliverNotAfterDateGreaterThan>0001-01-01T00:00:00</EDIDeliverNotAfterDateGreaterThan>
  <EDIDeliverNotAfterDateGreaterThanOrEqualTo>0001-01-01T00:00:00</EDIDeliverNotAfterDateGreaterThanOrEqualTo>
  <EDIDeliverNotAfterDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </EDIDeliverNotAfterDateIn>
  <EDIDeliverNotAfterDateLessThan>0001-01-01T00:00:00</EDIDeliverNotAfterDateLessThan>
  <EDIDeliverNotAfterDateLessThanOrEqualTo>0001-01-01T00:00:00</EDIDeliverNotAfterDateLessThanOrEqualTo>
  <EDIDeliverNotAfterDateNotEqualTo>0001-01-01T00:00:00</EDIDeliverNotAfterDateNotEqualTo>
  <EDIDeliverNotBeforeDate>0001-01-01T00:00:00</EDIDeliverNotBeforeDate>
  <EDIDeliverNotBeforeDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </EDIDeliverNotBeforeDateBetween>
  <EDIDeliverNotBeforeDateGreaterThan>0001-01-01T00:00:00</EDIDeliverNotBeforeDateGreaterThan>
  <EDIDeliverNotBeforeDateGreaterThanOrEqualTo>0001-01-01T00:00:00</EDIDeliverNotBeforeDateGreaterThanOrEqualTo>
  <EDIDeliverNotBeforeDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </EDIDeliverNotBeforeDateIn>
  <EDIDeliverNotBeforeDateLessThan>0001-01-01T00:00:00</EDIDeliverNotBeforeDateLessThan>
  <EDIDeliverNotBeforeDateLessThanOrEqualTo>0001-01-01T00:00:00</EDIDeliverNotBeforeDateLessThanOrEqualTo>
  <EDIDeliverNotBeforeDateNotEqualTo>0001-01-01T00:00:00</EDIDeliverNotBeforeDateNotEqualTo>
  <EDIOrderType>0</EDIOrderType>
  <EDIOrderTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </EDIOrderTypeBetween>
  <EDIOrderTypeGreaterThan>0</EDIOrderTypeGreaterThan>
  <EDIOrderTypeGreaterThanOrEqualTo>0</EDIOrderTypeGreaterThanOrEqualTo>
  <EDIOrderTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </EDIOrderTypeIn>
  <EDIOrderTypeLessThan>0</EDIOrderTypeLessThan>
  <EDIOrderTypeLessThanOrEqualTo>0</EDIOrderTypeLessThanOrEqualTo>
  <EDIOrderTypeNotEqualTo>0</EDIOrderTypeNotEqualTo>
  <InvoiceID>String</InvoiceID>
  <InvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDBetween>
  <InvoiceIDContains>String</InvoiceIDContains>
  <InvoiceIDEndsWith>String</InvoiceIDEndsWith>
  <InvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDIn>
  <InvoiceIDLike>String</InvoiceIDLike>
  <InvoiceIDStartsWith>String</InvoiceIDStartsWith>
  <ReceiverEDIAddress>String</ReceiverEDIAddress>
  <ReceiverEDIAddressBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReceiverEDIAddressBetween>
  <ReceiverEDIAddressContains>String</ReceiverEDIAddressContains>
  <ReceiverEDIAddressEndsWith>String</ReceiverEDIAddressEndsWith>
  <ReceiverEDIAddressIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReceiverEDIAddressIn>
  <ReceiverEDIAddressLike>String</ReceiverEDIAddressLike>
  <ReceiverEDIAddressStartsWith>String</ReceiverEDIAddressStartsWith>
  <VendorNumber>String</VendorNumber>
  <VendorNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VendorNumberBetween>
  <VendorNumberContains>String</VendorNumberContains>
  <VendorNumberEndsWith>String</VendorNumberEndsWith>
  <VendorNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </VendorNumberIn>
  <VendorNumberLike>String</VendorNumberLike>
  <VendorNumberStartsWith>String</VendorNumberStartsWith>
</SO_EDIMainQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_EDIMain7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:SO_EDIMain>
      <d2p1:_x003C_BuyerNumber_x003E_k__BackingField>String</d2p1:_x003C_BuyerNumber_x003E_k__BackingField>
      <d2p1:_x003C_EDIAddress_x003E_k__BackingField>String</d2p1:_x003C_EDIAddress_x003E_k__BackingField>
      <d2p1:_x003C_EDIDeliverNotAfterDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_EDIDeliverNotAfterDate_x003E_k__BackingField>
      <d2p1:_x003C_EDIDeliverNotBeforeDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_EDIDeliverNotBeforeDate_x003E_k__BackingField>
      <d2p1:_x003C_EDIOrderType_x003E_k__BackingField>0</d2p1:_x003C_EDIOrderType_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_ReceiverEDIAddress_x003E_k__BackingField>String</d2p1:_x003C_ReceiverEDIAddress_x003E_k__BackingField>
      <d2p1:_x003C_VendorNumber_x003E_k__BackingField>String</d2p1:_x003C_VendorNumber_x003E_k__BackingField>
    </d2p1:SO_EDIMain>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfSO_EDIMain7kRqkrSv>