JiwaAPI

<back to all web services

v_JB_PurchaseOrdersQuery

Requires Authentication
v_JB_PurchaseOrdersQuery Parameters:
NameParameterData TypeRequiredDescription
SourceTypequerystringNo
SourceTypeStartsWithquerystringNo
SourceTypeEndsWithquerystringNo
SourceTypeContainsquerystringNo
SourceTypeLikequerystringNo
SourceTypeBetweenquerystring[]No
SourceTypeInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
JobCostStagequerystringNo
JobCostStageStartsWithquerystringNo
JobCostStageEndsWithquerystringNo
JobCostStageContainsquerystringNo
JobCostStageLikequerystringNo
JobCostStageBetweenquerystring[]No
JobCostStageInquerystring[]No
ItemquerystringNo
ItemStartsWithquerystringNo
ItemEndsWithquerystringNo
ItemContainsquerystringNo
ItemLikequerystringNo
ItemBetweenquerystring[]No
ItemInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
TranDatequeryDateTime?No
TranDateGreaterThanOrEqualToqueryDateTime?No
TranDateGreaterThanqueryDateTime?No
TranDateLessThanqueryDateTime?No
TranDateLessThanOrEqualToqueryDateTime?No
TranDateNotEqualToqueryDateTime?No
TranDateBetweenqueryDateTime[]No
TranDateInqueryDateTime[]No
Qtyquerydecimal?No
QtyGreaterThanOrEqualToquerydecimal?No
QtyGreaterThanquerydecimal?No
QtyLessThanquerydecimal?No
QtyLessThanOrEqualToquerydecimal?No
QtyNotEqualToquerydecimal?No
QtyBetweenqueryNullable<Decimal>[]No
QtyInqueryNullable<Decimal>[]No
TotalCostquerydecimal?No
TotalCostGreaterThanOrEqualToquerydecimal?No
TotalCostGreaterThanquerydecimal?No
TotalCostLessThanquerydecimal?No
TotalCostLessThanOrEqualToquerydecimal?No
TotalCostNotEqualToquerydecimal?No
TotalCostBetweenqueryNullable<Decimal>[]No
TotalCostInqueryNullable<Decimal>[]No
TotalChargequerydecimal?No
TotalChargeGreaterThanOrEqualToquerydecimal?No
TotalChargeGreaterThanquerydecimal?No
TotalChargeLessThanquerydecimal?No
TotalChargeLessThanOrEqualToquerydecimal?No
TotalChargeNotEqualToquerydecimal?No
TotalChargeBetweenqueryNullable<Decimal>[]No
TotalChargeInqueryNullable<Decimal>[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
JobNoquerystringNo
JobNoStartsWithquerystringNo
JobNoEndsWithquerystringNo
JobNoContainsquerystringNo
JobNoLikequerystringNo
JobNoBetweenquerystring[]No
JobNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_JB_PurchaseOrders Parameters:
NameParameterData TypeRequiredDescription
SourceTypeformstringNo
BatchNoformstringNo
JobCostStageformstringNo
ItemformstringNo
DescriptionformstringNo
TranDateformDateTimeNo
Qtyformdecimal?No
TotalCostformdecimal?No
TotalChargeformdecimal?No
RemarkformstringNo
JobNoformstringNo
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/v_JB_PurchaseOrdersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<v_JB_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>
  <BatchNo>String</BatchNo>
  <BatchNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoBetween>
  <BatchNoContains>String</BatchNoContains>
  <BatchNoEndsWith>String</BatchNoEndsWith>
  <BatchNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoIn>
  <BatchNoLike>String</BatchNoLike>
  <BatchNoStartsWith>String</BatchNoStartsWith>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <Item>String</Item>
  <ItemBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ItemBetween>
  <ItemContains>String</ItemContains>
  <ItemEndsWith>String</ItemEndsWith>
  <ItemIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ItemIn>
  <ItemLike>String</ItemLike>
  <ItemStartsWith>String</ItemStartsWith>
  <JobCostStage>String</JobCostStage>
  <JobCostStageBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobCostStageBetween>
  <JobCostStageContains>String</JobCostStageContains>
  <JobCostStageEndsWith>String</JobCostStageEndsWith>
  <JobCostStageIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobCostStageIn>
  <JobCostStageLike>String</JobCostStageLike>
  <JobCostStageStartsWith>String</JobCostStageStartsWith>
  <JobNo>String</JobNo>
  <JobNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobNoBetween>
  <JobNoContains>String</JobNoContains>
  <JobNoEndsWith>String</JobNoEndsWith>
  <JobNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobNoIn>
  <JobNoLike>String</JobNoLike>
  <JobNoStartsWith>String</JobNoStartsWith>
  <Qty>0</Qty>
  <QtyBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QtyBetween>
  <QtyGreaterThan>0</QtyGreaterThan>
  <QtyGreaterThanOrEqualTo>0</QtyGreaterThanOrEqualTo>
  <QtyIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QtyIn>
  <QtyLessThan>0</QtyLessThan>
  <QtyLessThanOrEqualTo>0</QtyLessThanOrEqualTo>
  <QtyNotEqualTo>0</QtyNotEqualTo>
  <Remark>String</Remark>
  <RemarkBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkBetween>
  <RemarkContains>String</RemarkContains>
  <RemarkEndsWith>String</RemarkEndsWith>
  <RemarkIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkIn>
  <RemarkLike>String</RemarkLike>
  <RemarkStartsWith>String</RemarkStartsWith>
  <SourceType>String</SourceType>
  <SourceTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceTypeBetween>
  <SourceTypeContains>String</SourceTypeContains>
  <SourceTypeEndsWith>String</SourceTypeEndsWith>
  <SourceTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceTypeIn>
  <SourceTypeLike>String</SourceTypeLike>
  <SourceTypeStartsWith>String</SourceTypeStartsWith>
  <TotalCharge>0</TotalCharge>
  <TotalChargeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TotalChargeBetween>
  <TotalChargeGreaterThan>0</TotalChargeGreaterThan>
  <TotalChargeGreaterThanOrEqualTo>0</TotalChargeGreaterThanOrEqualTo>
  <TotalChargeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TotalChargeIn>
  <TotalChargeLessThan>0</TotalChargeLessThan>
  <TotalChargeLessThanOrEqualTo>0</TotalChargeLessThanOrEqualTo>
  <TotalChargeNotEqualTo>0</TotalChargeNotEqualTo>
  <TotalCost>0</TotalCost>
  <TotalCostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TotalCostBetween>
  <TotalCostGreaterThan>0</TotalCostGreaterThan>
  <TotalCostGreaterThanOrEqualTo>0</TotalCostGreaterThanOrEqualTo>
  <TotalCostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TotalCostIn>
  <TotalCostLessThan>0</TotalCostLessThan>
  <TotalCostLessThanOrEqualTo>0</TotalCostLessThanOrEqualTo>
  <TotalCostNotEqualTo>0</TotalCostNotEqualTo>
  <TranDate>0001-01-01T00:00:00</TranDate>
  <TranDateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </TranDateBetween>
  <TranDateGreaterThan>0001-01-01T00:00:00</TranDateGreaterThan>
  <TranDateGreaterThanOrEqualTo>0001-01-01T00:00:00</TranDateGreaterThanOrEqualTo>
  <TranDateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </TranDateIn>
  <TranDateLessThan>0001-01-01T00:00:00</TranDateLessThan>
  <TranDateLessThanOrEqualTo>0001-01-01T00:00:00</TranDateLessThanOrEqualTo>
  <TranDateNotEqualTo>0001-01-01T00:00:00</TranDateNotEqualTo>
</v_JB_PurchaseOrdersQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_JB_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:v_JB_PurchaseOrders>
      <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Item_x003E_k__BackingField>String</d2p1:_x003C_Item_x003E_k__BackingField>
      <d2p1:_x003C_JobCostStage_x003E_k__BackingField>String</d2p1:_x003C_JobCostStage_x003E_k__BackingField>
      <d2p1:_x003C_JobNo_x003E_k__BackingField>String</d2p1:_x003C_JobNo_x003E_k__BackingField>
      <d2p1:_x003C_Qty_x003E_k__BackingField>0</d2p1:_x003C_Qty_x003E_k__BackingField>
      <d2p1:_x003C_Remark_x003E_k__BackingField>String</d2p1:_x003C_Remark_x003E_k__BackingField>
      <d2p1:_x003C_SourceType_x003E_k__BackingField>String</d2p1:_x003C_SourceType_x003E_k__BackingField>
      <d2p1:_x003C_TotalCharge_x003E_k__BackingField>0</d2p1:_x003C_TotalCharge_x003E_k__BackingField>
      <d2p1:_x003C_TotalCost_x003E_k__BackingField>0</d2p1:_x003C_TotalCost_x003E_k__BackingField>
      <d2p1:_x003C_TranDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_TranDate_x003E_k__BackingField>
    </d2p1:v_JB_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>
</QueryResponseOfv_JB_PurchaseOrders7kRqkrSv>