JiwaAPI

<back to all web services

INV_SOH1Query

Requires Authentication
INV_SOH1Query Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
SOHquerydecimal?No
SOHGreaterThanOrEqualToquerydecimal?No
SOHGreaterThanquerydecimal?No
SOHLessThanquerydecimal?No
SOHLessThanOrEqualToquerydecimal?No
SOHNotEqualToquerydecimal?No
SOHBetweenqueryNullable<Decimal>[]No
SOHInqueryNullable<Decimal>[]No
Taxquerydecimal?No
TaxGreaterThanOrEqualToquerydecimal?No
TaxGreaterThanquerydecimal?No
TaxLessThanquerydecimal?No
TaxLessThanOrEqualToquerydecimal?No
TaxNotEqualToquerydecimal?No
TaxBetweenqueryNullable<Decimal>[]No
TaxInqueryNullable<Decimal>[]No
VOHquerydecimal?No
VOHGreaterThanOrEqualToquerydecimal?No
VOHGreaterThanquerydecimal?No
VOHLessThanquerydecimal?No
VOHLessThanOrEqualToquerydecimal?No
VOHNotEqualToquerydecimal?No
VOHBetweenqueryNullable<Decimal>[]No
VOHInqueryNullable<Decimal>[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_SOH1 Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
SOHformdecimal?No
Taxformdecimal?No
VOHformdecimal?No
IN_LogicalIDformstringNo
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_SOH1Query HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<INV_SOH1Query 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>
  <IN_LogicalID>String</IN_LogicalID>
  <IN_LogicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDBetween>
  <IN_LogicalIDContains>String</IN_LogicalIDContains>
  <IN_LogicalIDEndsWith>String</IN_LogicalIDEndsWith>
  <IN_LogicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDIn>
  <IN_LogicalIDLike>String</IN_LogicalIDLike>
  <IN_LogicalIDStartsWith>String</IN_LogicalIDStartsWith>
  <InventoryID>String</InventoryID>
  <InventoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryIDBetween>
  <InventoryIDContains>String</InventoryIDContains>
  <InventoryIDEndsWith>String</InventoryIDEndsWith>
  <InventoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryIDIn>
  <InventoryIDLike>String</InventoryIDLike>
  <InventoryIDStartsWith>String</InventoryIDStartsWith>
  <SOH>0</SOH>
  <SOHBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </SOHBetween>
  <SOHGreaterThan>0</SOHGreaterThan>
  <SOHGreaterThanOrEqualTo>0</SOHGreaterThanOrEqualTo>
  <SOHIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </SOHIn>
  <SOHLessThan>0</SOHLessThan>
  <SOHLessThanOrEqualTo>0</SOHLessThanOrEqualTo>
  <SOHNotEqualTo>0</SOHNotEqualTo>
  <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>
  <VOH>0</VOH>
  <VOHBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </VOHBetween>
  <VOHGreaterThan>0</VOHGreaterThan>
  <VOHGreaterThanOrEqualTo>0</VOHGreaterThanOrEqualTo>
  <VOHIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </VOHIn>
  <VOHLessThan>0</VOHLessThan>
  <VOHLessThanOrEqualTo>0</VOHLessThanOrEqualTo>
  <VOHNotEqualTo>0</VOHNotEqualTo>
</INV_SOH1Query>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfINV_SOH17kRqkrSv 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_SOH1>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField>
      <d2p1:_x003C_SOH_x003E_k__BackingField>0</d2p1:_x003C_SOH_x003E_k__BackingField>
      <d2p1:_x003C_Tax_x003E_k__BackingField>0</d2p1:_x003C_Tax_x003E_k__BackingField>
      <d2p1:_x003C_VOH_x003E_k__BackingField>0</d2p1:_x003C_VOH_x003E_k__BackingField>
    </d2p1:INV_SOH1>
  </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_SOH17kRqkrSv>