JiwaAPI

<back to all web services

SH_PurchaseOrdersQuery

Requires Authentication
SH_PurchaseOrdersQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SH_Main_RecIDquerystringNo
SH_Main_RecIDStartsWithquerystringNo
SH_Main_RecIDEndsWithquerystringNo
SH_Main_RecIDContainsquerystringNo
SH_Main_RecIDLikequerystringNo
SH_Main_RecIDBetweenquerystring[]No
SH_Main_RecIDInquerystring[]No
PO_Main_RecIDquerystringNo
PO_Main_RecIDStartsWithquerystringNo
PO_Main_RecIDEndsWithquerystringNo
PO_Main_RecIDContainsquerystringNo
PO_Main_RecIDLikequerystringNo
PO_Main_RecIDBetweenquerystring[]No
PO_Main_RecIDInquerystring[]No
DisplayLinesquerybool?No
FXRatequerydecimal?No
FXRateGreaterThanOrEqualToquerydecimal?No
FXRateGreaterThanquerydecimal?No
FXRateLessThanquerydecimal?No
FXRateLessThanOrEqualToquerydecimal?No
FXRateNotEqualToquerydecimal?No
FXRateBetweenqueryNullable<Decimal>[]No
FXRateInqueryNullable<Decimal>[]No
UserField1querystringNo
UserField1StartsWithquerystringNo
UserField1EndsWithquerystringNo
UserField1ContainsquerystringNo
UserField1LikequerystringNo
UserField1Betweenquerystring[]No
UserField1Inquerystring[]No
UserField2querystringNo
UserField2StartsWithquerystringNo
UserField2EndsWithquerystringNo
UserField2ContainsquerystringNo
UserField2LikequerystringNo
UserField2Betweenquerystring[]No
UserField2Inquerystring[]No
UserField3querystringNo
UserField3StartsWithquerystringNo
UserField3EndsWithquerystringNo
UserField3ContainsquerystringNo
UserField3LikequerystringNo
UserField3Betweenquerystring[]No
UserField3Inquerystring[]No
UserField4querystringNo
UserField4StartsWithquerystringNo
UserField4EndsWithquerystringNo
UserField4ContainsquerystringNo
UserField4LikequerystringNo
UserField4Betweenquerystring[]No
UserField4Inquerystring[]No
UserField5querystringNo
UserField5StartsWithquerystringNo
UserField5EndsWithquerystringNo
UserField5ContainsquerystringNo
UserField5LikequerystringNo
UserField5Betweenquerystring[]No
UserField5Inquerystring[]No
UserField6querystringNo
UserField6StartsWithquerystringNo
UserField6EndsWithquerystringNo
UserField6ContainsquerystringNo
UserField6LikequerystringNo
UserField6Betweenquerystring[]No
UserField6Inquerystring[]No
UserField7querystringNo
UserField7StartsWithquerystringNo
UserField7EndsWithquerystringNo
UserField7ContainsquerystringNo
UserField7LikequerystringNo
UserField7Betweenquerystring[]No
UserField7Inquerystring[]No
UserField8querystringNo
UserField8StartsWithquerystringNo
UserField8EndsWithquerystringNo
UserField8ContainsquerystringNo
UserField8LikequerystringNo
UserField8Betweenquerystring[]No
UserField8Inquerystring[]No
UserField9querystringNo
UserField9StartsWithquerystringNo
UserField9EndsWithquerystringNo
UserField9ContainsquerystringNo
UserField9LikequerystringNo
UserField9Betweenquerystring[]No
UserField9Inquerystring[]No
UserField10querystringNo
UserField10StartsWithquerystringNo
UserField10EndsWithquerystringNo
UserField10ContainsquerystringNo
UserField10LikequerystringNo
UserField10Betweenquerystring[]No
UserField10Inquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_PurchaseOrders Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SH_Main_RecIDformstringNo
PO_Main_RecIDformstringNo
DisplayLinesformboolNo
FXRateformdecimal?No
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
ItemNoformintNo
RowHashformbyte[]No
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/SH_PurchaseOrdersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SH_PurchaseOrdersQuery 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>
  <DisplayLines>false</DisplayLines>
  <FXRate>0</FXRate>
  <FXRateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FXRateBetween>
  <FXRateGreaterThan>0</FXRateGreaterThan>
  <FXRateGreaterThanOrEqualTo>0</FXRateGreaterThanOrEqualTo>
  <FXRateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FXRateIn>
  <FXRateLessThan>0</FXRateLessThan>
  <FXRateLessThanOrEqualTo>0</FXRateLessThanOrEqualTo>
  <FXRateNotEqualTo>0</FXRateNotEqualTo>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <PO_Main_RecID>String</PO_Main_RecID>
  <PO_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_Main_RecIDBetween>
  <PO_Main_RecIDContains>String</PO_Main_RecIDContains>
  <PO_Main_RecIDEndsWith>String</PO_Main_RecIDEndsWith>
  <PO_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_Main_RecIDIn>
  <PO_Main_RecIDLike>String</PO_Main_RecIDLike>
  <PO_Main_RecIDStartsWith>String</PO_Main_RecIDStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <RowHash>AA==</RowHash>
  <SH_Main_RecID>String</SH_Main_RecID>
  <SH_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SH_Main_RecIDBetween>
  <SH_Main_RecIDContains>String</SH_Main_RecIDContains>
  <SH_Main_RecIDEndsWith>String</SH_Main_RecIDEndsWith>
  <SH_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SH_Main_RecIDIn>
  <SH_Main_RecIDLike>String</SH_Main_RecIDLike>
  <SH_Main_RecIDStartsWith>String</SH_Main_RecIDStartsWith>
  <UserField1>String</UserField1>
  <UserField10>String</UserField10>
  <UserField10Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField10Between>
  <UserField10Contains>String</UserField10Contains>
  <UserField10EndsWith>String</UserField10EndsWith>
  <UserField10In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField10In>
  <UserField10Like>String</UserField10Like>
  <UserField10StartsWith>String</UserField10StartsWith>
  <UserField1Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField1Between>
  <UserField1Contains>String</UserField1Contains>
  <UserField1EndsWith>String</UserField1EndsWith>
  <UserField1In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField1In>
  <UserField1Like>String</UserField1Like>
  <UserField1StartsWith>String</UserField1StartsWith>
  <UserField2>String</UserField2>
  <UserField2Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField2Between>
  <UserField2Contains>String</UserField2Contains>
  <UserField2EndsWith>String</UserField2EndsWith>
  <UserField2In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField2In>
  <UserField2Like>String</UserField2Like>
  <UserField2StartsWith>String</UserField2StartsWith>
  <UserField3>String</UserField3>
  <UserField3Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField3Between>
  <UserField3Contains>String</UserField3Contains>
  <UserField3EndsWith>String</UserField3EndsWith>
  <UserField3In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField3In>
  <UserField3Like>String</UserField3Like>
  <UserField3StartsWith>String</UserField3StartsWith>
  <UserField4>String</UserField4>
  <UserField4Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField4Between>
  <UserField4Contains>String</UserField4Contains>
  <UserField4EndsWith>String</UserField4EndsWith>
  <UserField4In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField4In>
  <UserField4Like>String</UserField4Like>
  <UserField4StartsWith>String</UserField4StartsWith>
  <UserField5>String</UserField5>
  <UserField5Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField5Between>
  <UserField5Contains>String</UserField5Contains>
  <UserField5EndsWith>String</UserField5EndsWith>
  <UserField5In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField5In>
  <UserField5Like>String</UserField5Like>
  <UserField5StartsWith>String</UserField5StartsWith>
  <UserField6>String</UserField6>
  <UserField6Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField6Between>
  <UserField6Contains>String</UserField6Contains>
  <UserField6EndsWith>String</UserField6EndsWith>
  <UserField6In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField6In>
  <UserField6Like>String</UserField6Like>
  <UserField6StartsWith>String</UserField6StartsWith>
  <UserField7>String</UserField7>
  <UserField7Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField7Between>
  <UserField7Contains>String</UserField7Contains>
  <UserField7EndsWith>String</UserField7EndsWith>
  <UserField7In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField7In>
  <UserField7Like>String</UserField7Like>
  <UserField7StartsWith>String</UserField7StartsWith>
  <UserField8>String</UserField8>
  <UserField8Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField8Between>
  <UserField8Contains>String</UserField8Contains>
  <UserField8EndsWith>String</UserField8EndsWith>
  <UserField8In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField8In>
  <UserField8Like>String</UserField8Like>
  <UserField8StartsWith>String</UserField8StartsWith>
  <UserField9>String</UserField9>
  <UserField9Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField9Between>
  <UserField9Contains>String</UserField9Contains>
  <UserField9EndsWith>String</UserField9EndsWith>
  <UserField9In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserField9In>
  <UserField9Like>String</UserField9Like>
  <UserField9StartsWith>String</UserField9StartsWith>
</SH_PurchaseOrdersQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSH_PurchaseOrders7kRqkrSv 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:SH_PurchaseOrders>
      <d2p1:_x003C_DisplayLines_x003E_k__BackingField>false</d2p1:_x003C_DisplayLines_x003E_k__BackingField>
      <d2p1:_x003C_FXRate_x003E_k__BackingField>0</d2p1:_x003C_FXRate_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_PO_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_PO_Main_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_SH_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_SH_Main_RecID_x003E_k__BackingField>
      <d2p1:_x003C_UserField10_x003E_k__BackingField>String</d2p1:_x003C_UserField10_x003E_k__BackingField>
      <d2p1:_x003C_UserField1_x003E_k__BackingField>String</d2p1:_x003C_UserField1_x003E_k__BackingField>
      <d2p1:_x003C_UserField2_x003E_k__BackingField>String</d2p1:_x003C_UserField2_x003E_k__BackingField>
      <d2p1:_x003C_UserField3_x003E_k__BackingField>String</d2p1:_x003C_UserField3_x003E_k__BackingField>
      <d2p1:_x003C_UserField4_x003E_k__BackingField>String</d2p1:_x003C_UserField4_x003E_k__BackingField>
      <d2p1:_x003C_UserField5_x003E_k__BackingField>String</d2p1:_x003C_UserField5_x003E_k__BackingField>
      <d2p1:_x003C_UserField6_x003E_k__BackingField>String</d2p1:_x003C_UserField6_x003E_k__BackingField>
      <d2p1:_x003C_UserField7_x003E_k__BackingField>String</d2p1:_x003C_UserField7_x003E_k__BackingField>
      <d2p1:_x003C_UserField8_x003E_k__BackingField>String</d2p1:_x003C_UserField8_x003E_k__BackingField>
      <d2p1:_x003C_UserField9_x003E_k__BackingField>String</d2p1:_x003C_UserField9_x003E_k__BackingField>
    </d2p1:SH_PurchaseOrders>
  </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>
</QueryResponseOfSH_PurchaseOrders7kRqkrSv>