JiwaAPI

<back to all web services

V_Shipment_BOQuery

Requires Authentication
V_Shipment_BOQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
RecordDatequeryDateTime?No
RecordDateGreaterThanOrEqualToqueryDateTime?No
RecordDateGreaterThanqueryDateTime?No
RecordDateLessThanqueryDateTime?No
RecordDateLessThanOrEqualToqueryDateTime?No
RecordDateNotEqualToqueryDateTime?No
RecordDateBetweenqueryNullable<DateTime>[]No
RecordDateInqueryNullable<DateTime>[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
HistoryNoqueryshort?No
HistoryNoGreaterThanOrEqualToqueryshort?No
HistoryNoGreaterThanqueryshort?No
HistoryNoLessThanqueryshort?No
HistoryNoLessThanOrEqualToqueryshort?No
HistoryNoNotEqualToqueryshort?No
HistoryNoBetweenqueryNullable<Int16>[]No
HistoryNoInqueryNullable<Int16>[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
QuantityOrderedquerydecimal?No
QuantityOrderedGreaterThanOrEqualToquerydecimal?No
QuantityOrderedGreaterThanquerydecimal?No
QuantityOrderedLessThanquerydecimal?No
QuantityOrderedLessThanOrEqualToquerydecimal?No
QuantityOrderedNotEqualToquerydecimal?No
QuantityOrderedBetweenqueryNullable<Decimal>[]No
QuantityOrderedInqueryNullable<Decimal>[]No
QuantityThisDelquerydecimal?No
QuantityThisDelGreaterThanOrEqualToquerydecimal?No
QuantityThisDelGreaterThanquerydecimal?No
QuantityThisDelLessThanquerydecimal?No
QuantityThisDelLessThanOrEqualToquerydecimal?No
QuantityThisDelNotEqualToquerydecimal?No
QuantityThisDelBetweenqueryNullable<Decimal>[]No
QuantityThisDelInqueryNullable<Decimal>[]No
QuantityBackordquerydecimal?No
QuantityBackordGreaterThanOrEqualToquerydecimal?No
QuantityBackordGreaterThanquerydecimal?No
QuantityBackordLessThanquerydecimal?No
QuantityBackordLessThanOrEqualToquerydecimal?No
QuantityBackordNotEqualToquerydecimal?No
QuantityBackordBetweenqueryNullable<Decimal>[]No
QuantityBackordInqueryNullable<Decimal>[]No
QuantityPrevDelquerydecimal?No
QuantityPrevDelGreaterThanOrEqualToquerydecimal?No
QuantityPrevDelGreaterThanquerydecimal?No
QuantityPrevDelLessThanquerydecimal?No
QuantityPrevDelLessThanOrEqualToquerydecimal?No
QuantityPrevDelNotEqualToquerydecimal?No
QuantityPrevDelBetweenqueryNullable<Decimal>[]No
QuantityPrevDelInqueryNullable<Decimal>[]No
ItemPricequerydecimal?No
ItemPriceGreaterThanOrEqualToquerydecimal?No
ItemPriceGreaterThanquerydecimal?No
ItemPriceLessThanquerydecimal?No
ItemPriceLessThanOrEqualToquerydecimal?No
ItemPriceNotEqualToquerydecimal?No
ItemPriceBetweenqueryNullable<Decimal>[]No
ItemPriceInqueryNullable<Decimal>[]No
TaxToChargequerydecimal?No
TaxToChargeGreaterThanOrEqualToquerydecimal?No
TaxToChargeGreaterThanquerydecimal?No
TaxToChargeLessThanquerydecimal?No
TaxToChargeLessThanOrEqualToquerydecimal?No
TaxToChargeNotEqualToquerydecimal?No
TaxToChargeBetweenqueryNullable<Decimal>[]No
TaxToChargeInqueryNullable<Decimal>[]No
InvoiceLineIDquerystringNo
InvoiceLineIDStartsWithquerystringNo
InvoiceLineIDEndsWithquerystringNo
InvoiceLineIDContainsquerystringNo
InvoiceLineIDLikequerystringNo
InvoiceLineIDBetweenquerystring[]No
InvoiceLineIDInquerystring[]No
RptTypequerystringNo
RptTypeStartsWithquerystringNo
RptTypeEndsWithquerystringNo
RptTypeContainsquerystringNo
RptTypeLikequerystringNo
RptTypeBetweenquerystring[]No
RptTypeInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_Shipment_BO Parameters:
NameParameterData TypeRequiredDescription
InvoiceNoformstringNo
RecordDateformDateTime?No
OrderNoformstringNo
DebtorIDformstringNo
HistoryNoformshort?No
PartNoformstringNo
DescriptionformstringNo
QuantityOrderedformdecimal?No
QuantityThisDelformdecimal?No
QuantityBackordformdecimal?No
QuantityPrevDelformdecimal?No
ItemPriceformdecimal?No
TaxToChargeformdecimal?No
InvoiceLineIDformstringNo
RptTypeformstringNo
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_Shipment_BOQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<V_Shipment_BOQuery 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>
  <DebtorID>String</DebtorID>
  <DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDBetween>
  <DebtorIDContains>String</DebtorIDContains>
  <DebtorIDEndsWith>String</DebtorIDEndsWith>
  <DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDIn>
  <DebtorIDLike>String</DebtorIDLike>
  <DebtorIDStartsWith>String</DebtorIDStartsWith>
  <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>
  <HistoryNo>0</HistoryNo>
  <HistoryNoBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </HistoryNoBetween>
  <HistoryNoGreaterThan>0</HistoryNoGreaterThan>
  <HistoryNoGreaterThanOrEqualTo>0</HistoryNoGreaterThanOrEqualTo>
  <HistoryNoIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </HistoryNoIn>
  <HistoryNoLessThan>0</HistoryNoLessThan>
  <HistoryNoLessThanOrEqualTo>0</HistoryNoLessThanOrEqualTo>
  <HistoryNoNotEqualTo>0</HistoryNoNotEqualTo>
  <InvoiceLineID>String</InvoiceLineID>
  <InvoiceLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceLineIDBetween>
  <InvoiceLineIDContains>String</InvoiceLineIDContains>
  <InvoiceLineIDEndsWith>String</InvoiceLineIDEndsWith>
  <InvoiceLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceLineIDIn>
  <InvoiceLineIDLike>String</InvoiceLineIDLike>
  <InvoiceLineIDStartsWith>String</InvoiceLineIDStartsWith>
  <InvoiceNo>String</InvoiceNo>
  <InvoiceNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoBetween>
  <InvoiceNoContains>String</InvoiceNoContains>
  <InvoiceNoEndsWith>String</InvoiceNoEndsWith>
  <InvoiceNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoIn>
  <InvoiceNoLike>String</InvoiceNoLike>
  <InvoiceNoStartsWith>String</InvoiceNoStartsWith>
  <ItemPrice>0</ItemPrice>
  <ItemPriceBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemPriceBetween>
  <ItemPriceGreaterThan>0</ItemPriceGreaterThan>
  <ItemPriceGreaterThanOrEqualTo>0</ItemPriceGreaterThanOrEqualTo>
  <ItemPriceIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </ItemPriceIn>
  <ItemPriceLessThan>0</ItemPriceLessThan>
  <ItemPriceLessThanOrEqualTo>0</ItemPriceLessThanOrEqualTo>
  <ItemPriceNotEqualTo>0</ItemPriceNotEqualTo>
  <OrderNo>String</OrderNo>
  <OrderNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderNoBetween>
  <OrderNoContains>String</OrderNoContains>
  <OrderNoEndsWith>String</OrderNoEndsWith>
  <OrderNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderNoIn>
  <OrderNoLike>String</OrderNoLike>
  <OrderNoStartsWith>String</OrderNoStartsWith>
  <PartNo>String</PartNo>
  <PartNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoBetween>
  <PartNoContains>String</PartNoContains>
  <PartNoEndsWith>String</PartNoEndsWith>
  <PartNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoIn>
  <PartNoLike>String</PartNoLike>
  <PartNoStartsWith>String</PartNoStartsWith>
  <QuantityBackord>0</QuantityBackord>
  <QuantityBackordBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityBackordBetween>
  <QuantityBackordGreaterThan>0</QuantityBackordGreaterThan>
  <QuantityBackordGreaterThanOrEqualTo>0</QuantityBackordGreaterThanOrEqualTo>
  <QuantityBackordIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityBackordIn>
  <QuantityBackordLessThan>0</QuantityBackordLessThan>
  <QuantityBackordLessThanOrEqualTo>0</QuantityBackordLessThanOrEqualTo>
  <QuantityBackordNotEqualTo>0</QuantityBackordNotEqualTo>
  <QuantityOrdered>0</QuantityOrdered>
  <QuantityOrderedBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityOrderedBetween>
  <QuantityOrderedGreaterThan>0</QuantityOrderedGreaterThan>
  <QuantityOrderedGreaterThanOrEqualTo>0</QuantityOrderedGreaterThanOrEqualTo>
  <QuantityOrderedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityOrderedIn>
  <QuantityOrderedLessThan>0</QuantityOrderedLessThan>
  <QuantityOrderedLessThanOrEqualTo>0</QuantityOrderedLessThanOrEqualTo>
  <QuantityOrderedNotEqualTo>0</QuantityOrderedNotEqualTo>
  <QuantityPrevDel>0</QuantityPrevDel>
  <QuantityPrevDelBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityPrevDelBetween>
  <QuantityPrevDelGreaterThan>0</QuantityPrevDelGreaterThan>
  <QuantityPrevDelGreaterThanOrEqualTo>0</QuantityPrevDelGreaterThanOrEqualTo>
  <QuantityPrevDelIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityPrevDelIn>
  <QuantityPrevDelLessThan>0</QuantityPrevDelLessThan>
  <QuantityPrevDelLessThanOrEqualTo>0</QuantityPrevDelLessThanOrEqualTo>
  <QuantityPrevDelNotEqualTo>0</QuantityPrevDelNotEqualTo>
  <QuantityThisDel>0</QuantityThisDel>
  <QuantityThisDelBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityThisDelBetween>
  <QuantityThisDelGreaterThan>0</QuantityThisDelGreaterThan>
  <QuantityThisDelGreaterThanOrEqualTo>0</QuantityThisDelGreaterThanOrEqualTo>
  <QuantityThisDelIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityThisDelIn>
  <QuantityThisDelLessThan>0</QuantityThisDelLessThan>
  <QuantityThisDelLessThanOrEqualTo>0</QuantityThisDelLessThanOrEqualTo>
  <QuantityThisDelNotEqualTo>0</QuantityThisDelNotEqualTo>
  <RecordDate>0001-01-01T00:00:00</RecordDate>
  <RecordDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </RecordDateBetween>
  <RecordDateGreaterThan>0001-01-01T00:00:00</RecordDateGreaterThan>
  <RecordDateGreaterThanOrEqualTo>0001-01-01T00:00:00</RecordDateGreaterThanOrEqualTo>
  <RecordDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </RecordDateIn>
  <RecordDateLessThan>0001-01-01T00:00:00</RecordDateLessThan>
  <RecordDateLessThanOrEqualTo>0001-01-01T00:00:00</RecordDateLessThanOrEqualTo>
  <RecordDateNotEqualTo>0001-01-01T00:00:00</RecordDateNotEqualTo>
  <RptType>String</RptType>
  <RptTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RptTypeBetween>
  <RptTypeContains>String</RptTypeContains>
  <RptTypeEndsWith>String</RptTypeEndsWith>
  <RptTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RptTypeIn>
  <RptTypeLike>String</RptTypeLike>
  <RptTypeStartsWith>String</RptTypeStartsWith>
  <TaxToCharge>0</TaxToCharge>
  <TaxToChargeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TaxToChargeBetween>
  <TaxToChargeGreaterThan>0</TaxToChargeGreaterThan>
  <TaxToChargeGreaterThanOrEqualTo>0</TaxToChargeGreaterThanOrEqualTo>
  <TaxToChargeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </TaxToChargeIn>
  <TaxToChargeLessThan>0</TaxToChargeLessThan>
  <TaxToChargeLessThanOrEqualTo>0</TaxToChargeLessThanOrEqualTo>
  <TaxToChargeNotEqualTo>0</TaxToChargeNotEqualTo>
</V_Shipment_BOQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfV_Shipment_BO7kRqkrSv 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_Shipment_BO>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_HistoryNo_x003E_k__BackingField>0</d2p1:_x003C_HistoryNo_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceLineID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceLineID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField>
      <d2p1:_x003C_ItemPrice_x003E_k__BackingField>0</d2p1:_x003C_ItemPrice_x003E_k__BackingField>
      <d2p1:_x003C_OrderNo_x003E_k__BackingField>String</d2p1:_x003C_OrderNo_x003E_k__BackingField>
      <d2p1:_x003C_PartNo_x003E_k__BackingField>String</d2p1:_x003C_PartNo_x003E_k__BackingField>
      <d2p1:_x003C_QuantityBackord_x003E_k__BackingField>0</d2p1:_x003C_QuantityBackord_x003E_k__BackingField>
      <d2p1:_x003C_QuantityOrdered_x003E_k__BackingField>0</d2p1:_x003C_QuantityOrdered_x003E_k__BackingField>
      <d2p1:_x003C_QuantityPrevDel_x003E_k__BackingField>0</d2p1:_x003C_QuantityPrevDel_x003E_k__BackingField>
      <d2p1:_x003C_QuantityThisDel_x003E_k__BackingField>0</d2p1:_x003C_QuantityThisDel_x003E_k__BackingField>
      <d2p1:_x003C_RecordDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_RecordDate_x003E_k__BackingField>
      <d2p1:_x003C_RptType_x003E_k__BackingField>String</d2p1:_x003C_RptType_x003E_k__BackingField>
      <d2p1:_x003C_TaxToCharge_x003E_k__BackingField>0</d2p1:_x003C_TaxToCharge_x003E_k__BackingField>
    </d2p1:V_Shipment_BO>
  </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_Shipment_BO7kRqkrSv>