JiwaAPI

<back to all web services

PI_ReceiptsQuery

Requires Authentication
PI_ReceiptsQuery Parameters:
NameParameterData TypeRequiredDescription
PI_ReceiptsIDquerystringNo
PI_ReceiptsIDStartsWithquerystringNo
PI_ReceiptsIDEndsWithquerystringNo
PI_ReceiptsIDContainsquerystringNo
PI_ReceiptsIDLikequerystringNo
PI_ReceiptsIDBetweenquerystring[]No
PI_ReceiptsIDInquerystring[]No
PI_MainIDquerystringNo
PI_MainIDStartsWithquerystringNo
PI_MainIDEndsWithquerystringNo
PI_MainIDContainsquerystringNo
PI_MainIDLikequerystringNo
PI_MainIDBetweenquerystring[]No
PI_MainIDInquerystring[]No
RE_MainIDquerystringNo
RE_MainIDStartsWithquerystringNo
RE_MainIDEndsWithquerystringNo
RE_MainIDContainsquerystringNo
RE_MainIDLikequerystringNo
RE_MainIDBetweenquerystring[]No
RE_MainIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PI_Receipts Parameters:
NameParameterData TypeRequiredDescription
PI_ReceiptsIDformstringNo
PI_MainIDformstringNo
RE_MainIDformstringNo
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/PI_ReceiptsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PI_ReceiptsQuery 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>
  <PI_MainID>String</PI_MainID>
  <PI_MainIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_MainIDBetween>
  <PI_MainIDContains>String</PI_MainIDContains>
  <PI_MainIDEndsWith>String</PI_MainIDEndsWith>
  <PI_MainIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_MainIDIn>
  <PI_MainIDLike>String</PI_MainIDLike>
  <PI_MainIDStartsWith>String</PI_MainIDStartsWith>
  <PI_ReceiptsID>String</PI_ReceiptsID>
  <PI_ReceiptsIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_ReceiptsIDBetween>
  <PI_ReceiptsIDContains>String</PI_ReceiptsIDContains>
  <PI_ReceiptsIDEndsWith>String</PI_ReceiptsIDEndsWith>
  <PI_ReceiptsIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PI_ReceiptsIDIn>
  <PI_ReceiptsIDLike>String</PI_ReceiptsIDLike>
  <PI_ReceiptsIDStartsWith>String</PI_ReceiptsIDStartsWith>
  <RE_MainID>String</RE_MainID>
  <RE_MainIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RE_MainIDBetween>
  <RE_MainIDContains>String</RE_MainIDContains>
  <RE_MainIDEndsWith>String</RE_MainIDEndsWith>
  <RE_MainIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RE_MainIDIn>
  <RE_MainIDLike>String</RE_MainIDLike>
  <RE_MainIDStartsWith>String</RE_MainIDStartsWith>
</PI_ReceiptsQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPI_Receipts7kRqkrSv 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:PI_Receipts>
      <d2p1:_x003C_PI_MainID_x003E_k__BackingField>String</d2p1:_x003C_PI_MainID_x003E_k__BackingField>
      <d2p1:_x003C_PI_ReceiptsID_x003E_k__BackingField>String</d2p1:_x003C_PI_ReceiptsID_x003E_k__BackingField>
      <d2p1:_x003C_RE_MainID_x003E_k__BackingField>String</d2p1:_x003C_RE_MainID_x003E_k__BackingField>
    </d2p1:PI_Receipts>
  </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>
</QueryResponseOfPI_Receipts7kRqkrSv>