JiwaAPI

<back to all web services

KitTaxQuery

Requires Authentication
KitTaxQuery Parameters:
NameParameterData TypeRequiredDescription
Taxquerydecimal?No
TaxGreaterThanOrEqualToquerydecimal?No
TaxGreaterThanquerydecimal?No
TaxLessThanquerydecimal?No
TaxLessThanOrEqualToquerydecimal?No
TaxNotEqualToquerydecimal?No
TaxBetweenqueryNullable<Decimal>[]No
TaxInqueryNullable<Decimal>[]No
LNqueryshort?No
LNGreaterThanOrEqualToqueryshort?No
LNGreaterThanqueryshort?No
LNLessThanqueryshort?No
LNLessThanOrEqualToqueryshort?No
LNNotEqualToqueryshort?No
LNBetweenqueryNullable<Int16>[]No
LNInqueryNullable<Int16>[]No
InvIDquerystringNo
InvIDStartsWithquerystringNo
InvIDEndsWithquerystringNo
InvIDContainsquerystringNo
InvIDLikequerystringNo
InvIDBetweenquerystring[]No
InvIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
KitTax Parameters:
NameParameterData TypeRequiredDescription
Taxformdecimal?No
LNformshort?No
InvIDformstringNo
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/KitTaxQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<KitTaxQuery 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>
  <InvID>String</InvID>
  <InvIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvIDBetween>
  <InvIDContains>String</InvIDContains>
  <InvIDEndsWith>String</InvIDEndsWith>
  <InvIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvIDIn>
  <InvIDLike>String</InvIDLike>
  <InvIDStartsWith>String</InvIDStartsWith>
  <LN>0</LN>
  <LNBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </LNBetween>
  <LNGreaterThan>0</LNGreaterThan>
  <LNGreaterThanOrEqualTo>0</LNGreaterThanOrEqualTo>
  <LNIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </LNIn>
  <LNLessThan>0</LNLessThan>
  <LNLessThanOrEqualTo>0</LNLessThanOrEqualTo>
  <LNNotEqualTo>0</LNNotEqualTo>
  <Tax>0</Tax>
  <TaxBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TaxBetween>
  <TaxGreaterThan>0</TaxGreaterThan>
  <TaxGreaterThanOrEqualTo>0</TaxGreaterThanOrEqualTo>
  <TaxIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TaxIn>
  <TaxLessThan>0</TaxLessThan>
  <TaxLessThanOrEqualTo>0</TaxLessThanOrEqualTo>
  <TaxNotEqualTo>0</TaxNotEqualTo>
</KitTaxQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfKitTax7kRqkrSv 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:KitTax>
      <d2p1:_x003C_InvID_x003E_k__BackingField>String</d2p1:_x003C_InvID_x003E_k__BackingField>
      <d2p1:_x003C_LN_x003E_k__BackingField>0</d2p1:_x003C_LN_x003E_k__BackingField>
      <d2p1:_x003C_Tax_x003E_k__BackingField>0</d2p1:_x003C_Tax_x003E_k__BackingField>
    </d2p1:KitTax>
  </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>
</QueryResponseOfKitTax7kRqkrSv>