JiwaAPI

SO_TotalsQuery

**SO_TotalsQuery** Parameters:
Name	Parameter	Data Type	Required
InvoiceID	query	string	No
InvoiceIDStartsWith	query	string	No
InvoiceIDEndsWith	query	string	No
InvoiceIDContains	query	string	No
InvoiceIDLike	query	string	No
InvoiceIDBetween	query	string[]	No
InvoiceIDIn	query	string[]	No
InvoiceTotal	query	decimal?	No
InvoiceTotalGreaterThanOrEqualTo	query	decimal?	No
InvoiceTotalGreaterThan	query	decimal?	No
InvoiceTotalLessThan	query	decimal?	No
InvoiceTotalLessThanOrEqualTo	query	decimal?	No
InvoiceTotalNotEqualTo	query	decimal?	No
InvoiceTotalBetween	query	Nullable<Decimal>[]	No
InvoiceTotalIn	query	Nullable<Decimal>[]	No
Cartage1Total	query	decimal?	No
Cartage1TotalGreaterThanOrEqualTo	query	decimal?	No
Cartage1TotalGreaterThan	query	decimal?	No
Cartage1TotalLessThan	query	decimal?	No
Cartage1TotalLessThanOrEqualTo	query	decimal?	No
Cartage1TotalNotEqualTo	query	decimal?	No
Cartage1TotalBetween	query	Nullable<Decimal>[]	No
Cartage1TotalIn	query	Nullable<Decimal>[]	No
Cartage1TaxTotal	query	decimal?	No
Cartage1TaxTotalGreaterThanOrEqualTo	query	decimal?	No
Cartage1TaxTotalGreaterThan	query	decimal?	No
Cartage1TaxTotalLessThan	query	decimal?	No
Cartage1TaxTotalLessThanOrEqualTo	query	decimal?	No
Cartage1TaxTotalNotEqualTo	query	decimal?	No
Cartage1TaxTotalBetween	query	Nullable<Decimal>[]	No
Cartage1TaxTotalIn	query	Nullable<Decimal>[]	No
Cartage2Total	query	decimal?	No
Cartage2TotalGreaterThanOrEqualTo	query	decimal?	No
Cartage2TotalGreaterThan	query	decimal?	No
Cartage2TotalLessThan	query	decimal?	No
Cartage2TotalLessThanOrEqualTo	query	decimal?	No
Cartage2TotalNotEqualTo	query	decimal?	No
Cartage2TotalBetween	query	Nullable<Decimal>[]	No
Cartage2TotalIn	query	Nullable<Decimal>[]	No
Cartage2TaxTotal	query	decimal?	No
Cartage2TaxTotalGreaterThanOrEqualTo	query	decimal?	No
Cartage2TaxTotalGreaterThan	query	decimal?	No
Cartage2TaxTotalLessThan	query	decimal?	No
Cartage2TaxTotalLessThanOrEqualTo	query	decimal?	No
Cartage2TaxTotalNotEqualTo	query	decimal?	No
Cartage2TaxTotalBetween	query	Nullable<Decimal>[]	No
Cartage2TaxTotalIn	query	Nullable<Decimal>[]	No
Cartage3Total	query	decimal?	No
Cartage3TotalGreaterThanOrEqualTo	query	decimal?	No
Cartage3TotalGreaterThan	query	decimal?	No
Cartage3TotalLessThan	query	decimal?	No
Cartage3TotalLessThanOrEqualTo	query	decimal?	No
Cartage3TotalNotEqualTo	query	decimal?	No
Cartage3TotalBetween	query	Nullable<Decimal>[]	No
Cartage3TotalIn	query	Nullable<Decimal>[]	No
Cartage3TaxTotal	query	decimal?	No
Cartage3TaxTotalGreaterThanOrEqualTo	query	decimal?	No
Cartage3TaxTotalGreaterThan	query	decimal?	No
Cartage3TaxTotalLessThan	query	decimal?	No
Cartage3TaxTotalLessThanOrEqualTo	query	decimal?	No
Cartage3TaxTotalNotEqualTo	query	decimal?	No
Cartage3TaxTotalBetween	query	Nullable<Decimal>[]	No
Cartage3TaxTotalIn	query	Nullable<Decimal>[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**SO_Totals** Parameters:
Name	Parameter	Data Type	Required
InvoiceID	form	string	No
InvoiceTotal	form	decimal?	No
Cartage1Total	form	decimal?	No
Cartage1TaxTotal	form	decimal?	No
Cartage2Total	form	decimal?	No
Cartage2TaxTotal	form	decimal?	No
Cartage3Total	form	decimal?	No
Cartage3TaxTotal	form	decimal?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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_TotalsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_TotalsQuery 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>
  <Cartage1TaxTotal>0</Cartage1TaxTotal>
  <Cartage1TaxTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage1TaxTotalBetween>
  <Cartage1TaxTotalGreaterThan>0</Cartage1TaxTotalGreaterThan>
  <Cartage1TaxTotalGreaterThanOrEqualTo>0</Cartage1TaxTotalGreaterThanOrEqualTo>
  <Cartage1TaxTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage1TaxTotalIn>
  <Cartage1TaxTotalLessThan>0</Cartage1TaxTotalLessThan>
  <Cartage1TaxTotalLessThanOrEqualTo>0</Cartage1TaxTotalLessThanOrEqualTo>
  <Cartage1TaxTotalNotEqualTo>0</Cartage1TaxTotalNotEqualTo>
  <Cartage1Total>0</Cartage1Total>
  <Cartage1TotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage1TotalBetween>
  <Cartage1TotalGreaterThan>0</Cartage1TotalGreaterThan>
  <Cartage1TotalGreaterThanOrEqualTo>0</Cartage1TotalGreaterThanOrEqualTo>
  <Cartage1TotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage1TotalIn>
  <Cartage1TotalLessThan>0</Cartage1TotalLessThan>
  <Cartage1TotalLessThanOrEqualTo>0</Cartage1TotalLessThanOrEqualTo>
  <Cartage1TotalNotEqualTo>0</Cartage1TotalNotEqualTo>
  <Cartage2TaxTotal>0</Cartage2TaxTotal>
  <Cartage2TaxTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage2TaxTotalBetween>
  <Cartage2TaxTotalGreaterThan>0</Cartage2TaxTotalGreaterThan>
  <Cartage2TaxTotalGreaterThanOrEqualTo>0</Cartage2TaxTotalGreaterThanOrEqualTo>
  <Cartage2TaxTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage2TaxTotalIn>
  <Cartage2TaxTotalLessThan>0</Cartage2TaxTotalLessThan>
  <Cartage2TaxTotalLessThanOrEqualTo>0</Cartage2TaxTotalLessThanOrEqualTo>
  <Cartage2TaxTotalNotEqualTo>0</Cartage2TaxTotalNotEqualTo>
  <Cartage2Total>0</Cartage2Total>
  <Cartage2TotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage2TotalBetween>
  <Cartage2TotalGreaterThan>0</Cartage2TotalGreaterThan>
  <Cartage2TotalGreaterThanOrEqualTo>0</Cartage2TotalGreaterThanOrEqualTo>
  <Cartage2TotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage2TotalIn>
  <Cartage2TotalLessThan>0</Cartage2TotalLessThan>
  <Cartage2TotalLessThanOrEqualTo>0</Cartage2TotalLessThanOrEqualTo>
  <Cartage2TotalNotEqualTo>0</Cartage2TotalNotEqualTo>
  <Cartage3TaxTotal>0</Cartage3TaxTotal>
  <Cartage3TaxTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage3TaxTotalBetween>
  <Cartage3TaxTotalGreaterThan>0</Cartage3TaxTotalGreaterThan>
  <Cartage3TaxTotalGreaterThanOrEqualTo>0</Cartage3TaxTotalGreaterThanOrEqualTo>
  <Cartage3TaxTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage3TaxTotalIn>
  <Cartage3TaxTotalLessThan>0</Cartage3TaxTotalLessThan>
  <Cartage3TaxTotalLessThanOrEqualTo>0</Cartage3TaxTotalLessThanOrEqualTo>
  <Cartage3TaxTotalNotEqualTo>0</Cartage3TaxTotalNotEqualTo>
  <Cartage3Total>0</Cartage3Total>
  <Cartage3TotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage3TotalBetween>
  <Cartage3TotalGreaterThan>0</Cartage3TotalGreaterThan>
  <Cartage3TotalGreaterThanOrEqualTo>0</Cartage3TotalGreaterThanOrEqualTo>
  <Cartage3TotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </Cartage3TotalIn>
  <Cartage3TotalLessThan>0</Cartage3TotalLessThan>
  <Cartage3TotalLessThanOrEqualTo>0</Cartage3TotalLessThanOrEqualTo>
  <Cartage3TotalNotEqualTo>0</Cartage3TotalNotEqualTo>
  <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>
  <InvoiceTotal>0</InvoiceTotal>
  <InvoiceTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </InvoiceTotalBetween>
  <InvoiceTotalGreaterThan>0</InvoiceTotalGreaterThan>
  <InvoiceTotalGreaterThanOrEqualTo>0</InvoiceTotalGreaterThanOrEqualTo>
  <InvoiceTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </InvoiceTotalIn>
  <InvoiceTotalLessThan>0</InvoiceTotalLessThan>
  <InvoiceTotalLessThanOrEqualTo>0</InvoiceTotalLessThanOrEqualTo>
  <InvoiceTotalNotEqualTo>0</InvoiceTotalNotEqualTo>
</SO_TotalsQuery>

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

<QueryResponseOfSO_Totals7kRqkrSv 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_Totals>
      <d2p1:_x003C_Cartage1TaxTotal_x003E_k__BackingField>0</d2p1:_x003C_Cartage1TaxTotal_x003E_k__BackingField>
      <d2p1:_x003C_Cartage1Total_x003E_k__BackingField>0</d2p1:_x003C_Cartage1Total_x003E_k__BackingField>
      <d2p1:_x003C_Cartage2TaxTotal_x003E_k__BackingField>0</d2p1:_x003C_Cartage2TaxTotal_x003E_k__BackingField>
      <d2p1:_x003C_Cartage2Total_x003E_k__BackingField>0</d2p1:_x003C_Cartage2Total_x003E_k__BackingField>
      <d2p1:_x003C_Cartage3TaxTotal_x003E_k__BackingField>0</d2p1:_x003C_Cartage3TaxTotal_x003E_k__BackingField>
      <d2p1:_x003C_Cartage3Total_x003E_k__BackingField>0</d2p1:_x003C_Cartage3Total_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceTotal_x003E_k__BackingField>0</d2p1:_x003C_InvoiceTotal_x003E_k__BackingField>
    </d2p1:SO_Totals>
  </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_Totals7kRqkrSv>