JiwaAPI

<back to all web services

INV_PIQuery

Requires Authentication
INV_PIQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceNOquerystringNo
InvoiceNOStartsWithquerystringNo
InvoiceNOEndsWithquerystringNo
InvoiceNOContainsquerystringNo
InvoiceNOLikequerystringNo
InvoiceNOBetweenquerystring[]No
InvoiceNOInquerystring[]No
SuppPartquerystringNo
SuppPartStartsWithquerystringNo
SuppPartEndsWithquerystringNo
SuppPartContainsquerystringNo
SuppPartLikequerystringNo
SuppPartBetweenquerystring[]No
SuppPartInquerystring[]No
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
SerialNoquerystringNo
SerialNoStartsWithquerystringNo
SerialNoEndsWithquerystringNo
SerialNoContainsquerystringNo
SerialNoLikequerystringNo
SerialNoBetweenquerystring[]No
SerialNoInquerystring[]No
BinLocquerystringNo
BinLocStartsWithquerystringNo
BinLocEndsWithquerystringNo
BinLocContainsquerystringNo
BinLocLikequerystringNo
BinLocBetweenquerystring[]No
BinLocInquerystring[]No
PI_LinesDetailsIDquerystringNo
PI_LinesDetailsIDStartsWithquerystringNo
PI_LinesDetailsIDEndsWithquerystringNo
PI_LinesDetailsIDContainsquerystringNo
PI_LinesDetailsIDLikequerystringNo
PI_LinesDetailsIDBetweenquerystring[]No
PI_LinesDetailsIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_PI Parameters:
NameParameterData TypeRequiredDescription
InvoiceNOformstringNo
SuppPartformstringNo
AccountNoformstringNo
SerialNoformstringNo
BinLocformstringNo
PI_LinesDetailsIDformstringNo
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_PIQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<INV_PIQuery 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>
  <BinLoc>String</BinLoc>
  <BinLocBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BinLocBetween>
  <BinLocContains>String</BinLocContains>
  <BinLocEndsWith>String</BinLocEndsWith>
  <BinLocIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BinLocIn>
  <BinLocLike>String</BinLocLike>
  <BinLocStartsWith>String</BinLocStartsWith>
  <InvoiceNO>String</InvoiceNO>
  <InvoiceNOBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNOBetween>
  <InvoiceNOContains>String</InvoiceNOContains>
  <InvoiceNOEndsWith>String</InvoiceNOEndsWith>
  <InvoiceNOIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNOIn>
  <InvoiceNOLike>String</InvoiceNOLike>
  <InvoiceNOStartsWith>String</InvoiceNOStartsWith>
  <PI_LinesDetailsID>String</PI_LinesDetailsID>
  <PI_LinesDetailsIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_LinesDetailsIDBetween>
  <PI_LinesDetailsIDContains>String</PI_LinesDetailsIDContains>
  <PI_LinesDetailsIDEndsWith>String</PI_LinesDetailsIDEndsWith>
  <PI_LinesDetailsIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_LinesDetailsIDIn>
  <PI_LinesDetailsIDLike>String</PI_LinesDetailsIDLike>
  <PI_LinesDetailsIDStartsWith>String</PI_LinesDetailsIDStartsWith>
  <SerialNo>String</SerialNo>
  <SerialNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SerialNoBetween>
  <SerialNoContains>String</SerialNoContains>
  <SerialNoEndsWith>String</SerialNoEndsWith>
  <SerialNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SerialNoIn>
  <SerialNoLike>String</SerialNoLike>
  <SerialNoStartsWith>String</SerialNoStartsWith>
  <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_PIQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfINV_PI7kRqkrSv 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_PI>
      <d2p1:_x003C_AccountNo_x003E_k__BackingField>String</d2p1:_x003C_AccountNo_x003E_k__BackingField>
      <d2p1:_x003C_BinLoc_x003E_k__BackingField>String</d2p1:_x003C_BinLoc_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceNO_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNO_x003E_k__BackingField>
      <d2p1:_x003C_PI_LinesDetailsID_x003E_k__BackingField>String</d2p1:_x003C_PI_LinesDetailsID_x003E_k__BackingField>
      <d2p1:_x003C_SerialNo_x003E_k__BackingField>String</d2p1:_x003C_SerialNo_x003E_k__BackingField>
      <d2p1:_x003C_SuppPart_x003E_k__BackingField>String</d2p1:_x003C_SuppPart_x003E_k__BackingField>
    </d2p1:INV_PI>
  </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_PI7kRqkrSv>