JiwaAPI

<back to all web services

INV_ReceivalQuery

Requires Authentication
INV_ReceivalQuery Parameters:
NameParameterData TypeRequiredDescription
SlipNoquerystringNo
SlipNoStartsWithquerystringNo
SlipNoEndsWithquerystringNo
SlipNoContainsquerystringNo
SlipNoLikequerystringNo
SlipNoBetweenquerystring[]No
SlipNoInquerystring[]No
SuppPartquerystringNo
SuppPartStartsWithquerystringNo
SuppPartEndsWithquerystringNo
SuppPartContainsquerystringNo
SuppPartLikequerystringNo
SuppPartBetweenquerystring[]No
SuppPartInquerystring[]No
AccountNOquerystringNo
AccountNOStartsWithquerystringNo
AccountNOEndsWithquerystringNo
AccountNOContainsquerystringNo
AccountNOLikequerystringNo
AccountNOBetweenquerystring[]No
AccountNOInquerystring[]No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_Receival Parameters:
NameParameterData TypeRequiredDescription
SlipNoformstringNo
SuppPartformstringNo
AccountNOformstringNo
SourceIDformstringNo
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/INV_ReceivalQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<INV_ReceivalQuery 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>
  <AccountNO>String</AccountNO>
  <AccountNOBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNOBetween>
  <AccountNOContains>String</AccountNOContains>
  <AccountNOEndsWith>String</AccountNOEndsWith>
  <AccountNOIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNOIn>
  <AccountNOLike>String</AccountNOLike>
  <AccountNOStartsWith>String</AccountNOStartsWith>
  <SlipNo>String</SlipNo>
  <SlipNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SlipNoBetween>
  <SlipNoContains>String</SlipNoContains>
  <SlipNoEndsWith>String</SlipNoEndsWith>
  <SlipNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SlipNoIn>
  <SlipNoLike>String</SlipNoLike>
  <SlipNoStartsWith>String</SlipNoStartsWith>
  <SourceID>String</SourceID>
  <SourceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceIDBetween>
  <SourceIDContains>String</SourceIDContains>
  <SourceIDEndsWith>String</SourceIDEndsWith>
  <SourceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceIDIn>
  <SourceIDLike>String</SourceIDLike>
  <SourceIDStartsWith>String</SourceIDStartsWith>
  <SuppPart>String</SuppPart>
  <SuppPartBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SuppPartBetween>
  <SuppPartContains>String</SuppPartContains>
  <SuppPartEndsWith>String</SuppPartEndsWith>
  <SuppPartIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SuppPartIn>
  <SuppPartLike>String</SuppPartLike>
  <SuppPartStartsWith>String</SuppPartStartsWith>
</INV_ReceivalQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfINV_Receival7kRqkrSv 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:INV_Receival>
      <d2p1:_x003C_AccountNO_x003E_k__BackingField>String</d2p1:_x003C_AccountNO_x003E_k__BackingField>
      <d2p1:_x003C_SlipNo_x003E_k__BackingField>String</d2p1:_x003C_SlipNo_x003E_k__BackingField>
      <d2p1:_x003C_SourceID_x003E_k__BackingField>String</d2p1:_x003C_SourceID_x003E_k__BackingField>
      <d2p1:_x003C_SuppPart_x003E_k__BackingField>String</d2p1:_x003C_SuppPart_x003E_k__BackingField>
    </d2p1:INV_Receival>
  </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>
</QueryResponseOfINV_Receival7kRqkrSv>