Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InvoiceNo | query | string | No | |
InvoiceNoStartsWith | query | string | No | |
InvoiceNoEndsWith | query | string | No | |
InvoiceNoContains | query | string | No | |
InvoiceNoLike | query | string | No | |
InvoiceNoBetween | query | string[] | No | |
InvoiceNoIn | query | string[] | No | |
RecordDate | query | DateTime? | No | |
RecordDateGreaterThanOrEqualTo | query | DateTime? | No | |
RecordDateGreaterThan | query | DateTime? | No | |
RecordDateLessThan | query | DateTime? | No | |
RecordDateLessThanOrEqualTo | query | DateTime? | No | |
RecordDateNotEqualTo | query | DateTime? | No | |
RecordDateBetween | query | Nullable<DateTime>[] | No | |
RecordDateIn | query | Nullable<DateTime>[] | No | |
OrderNo | query | string | No | |
OrderNoStartsWith | query | string | No | |
OrderNoEndsWith | query | string | No | |
OrderNoContains | query | string | No | |
OrderNoLike | query | string | No | |
OrderNoBetween | query | string[] | No | |
OrderNoIn | query | string[] | No | |
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
HistoryNo | query | short? | No | |
HistoryNoGreaterThanOrEqualTo | query | short? | No | |
HistoryNoGreaterThan | query | short? | No | |
HistoryNoLessThan | query | short? | No | |
HistoryNoLessThanOrEqualTo | query | short? | No | |
HistoryNoNotEqualTo | query | short? | No | |
HistoryNoBetween | query | Nullable<Int16>[] | No | |
HistoryNoIn | query | Nullable<Int16>[] | No | |
PartNo | query | string | No | |
PartNoStartsWith | query | string | No | |
PartNoEndsWith | query | string | No | |
PartNoContains | query | string | No | |
PartNoLike | query | string | No | |
PartNoBetween | query | string[] | No | |
PartNoIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
QuantityOrdered | query | decimal? | No | |
QuantityOrderedGreaterThanOrEqualTo | query | decimal? | No | |
QuantityOrderedGreaterThan | query | decimal? | No | |
QuantityOrderedLessThan | query | decimal? | No | |
QuantityOrderedLessThanOrEqualTo | query | decimal? | No | |
QuantityOrderedNotEqualTo | query | decimal? | No | |
QuantityOrderedBetween | query | Nullable<Decimal>[] | No | |
QuantityOrderedIn | query | Nullable<Decimal>[] | No | |
QuantityThisDel | query | decimal? | No | |
QuantityThisDelGreaterThanOrEqualTo | query | decimal? | No | |
QuantityThisDelGreaterThan | query | decimal? | No | |
QuantityThisDelLessThan | query | decimal? | No | |
QuantityThisDelLessThanOrEqualTo | query | decimal? | No | |
QuantityThisDelNotEqualTo | query | decimal? | No | |
QuantityThisDelBetween | query | Nullable<Decimal>[] | No | |
QuantityThisDelIn | query | Nullable<Decimal>[] | No | |
QuantityBackord | query | decimal? | No | |
QuantityBackordGreaterThanOrEqualTo | query | decimal? | No | |
QuantityBackordGreaterThan | query | decimal? | No | |
QuantityBackordLessThan | query | decimal? | No | |
QuantityBackordLessThanOrEqualTo | query | decimal? | No | |
QuantityBackordNotEqualTo | query | decimal? | No | |
QuantityBackordBetween | query | Nullable<Decimal>[] | No | |
QuantityBackordIn | query | Nullable<Decimal>[] | No | |
QuantityPrevDel | query | decimal? | No | |
QuantityPrevDelGreaterThanOrEqualTo | query | decimal? | No | |
QuantityPrevDelGreaterThan | query | decimal? | No | |
QuantityPrevDelLessThan | query | decimal? | No | |
QuantityPrevDelLessThanOrEqualTo | query | decimal? | No | |
QuantityPrevDelNotEqualTo | query | decimal? | No | |
QuantityPrevDelBetween | query | Nullable<Decimal>[] | No | |
QuantityPrevDelIn | query | Nullable<Decimal>[] | No | |
ItemPrice | query | decimal? | No | |
ItemPriceGreaterThanOrEqualTo | query | decimal? | No | |
ItemPriceGreaterThan | query | decimal? | No | |
ItemPriceLessThan | query | decimal? | No | |
ItemPriceLessThanOrEqualTo | query | decimal? | No | |
ItemPriceNotEqualTo | query | decimal? | No | |
ItemPriceBetween | query | Nullable<Decimal>[] | No | |
ItemPriceIn | query | Nullable<Decimal>[] | No | |
TaxToCharge | query | decimal? | No | |
TaxToChargeGreaterThanOrEqualTo | query | decimal? | No | |
TaxToChargeGreaterThan | query | decimal? | No | |
TaxToChargeLessThan | query | decimal? | No | |
TaxToChargeLessThanOrEqualTo | query | decimal? | No | |
TaxToChargeNotEqualTo | query | decimal? | No | |
TaxToChargeBetween | query | Nullable<Decimal>[] | No | |
TaxToChargeIn | query | Nullable<Decimal>[] | No | |
InvoiceLineID | query | string | No | |
InvoiceLineIDStartsWith | query | string | No | |
InvoiceLineIDEndsWith | query | string | No | |
InvoiceLineIDContains | query | string | No | |
InvoiceLineIDLike | query | string | No | |
InvoiceLineIDBetween | query | string[] | No | |
InvoiceLineIDIn | query | string[] | No | |
RptType | query | string | No | |
RptTypeStartsWith | query | string | No | |
RptTypeEndsWith | query | string | No | |
RptTypeContains | query | string | No | |
RptTypeLike | query | string | No | |
RptTypeBetween | query | string[] | No | |
RptTypeIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InvoiceNo | form | string | No | |
RecordDate | form | DateTime? | No | |
OrderNo | form | string | No | |
DebtorID | form | string | No | |
HistoryNo | form | short? | No | |
PartNo | form | string | No | |
Description | form | string | No | |
QuantityOrdered | form | decimal? | No | |
QuantityThisDel | form | decimal? | No | |
QuantityBackord | form | decimal? | No | |
QuantityPrevDel | form | decimal? | No | |
ItemPrice | form | decimal? | No | |
TaxToCharge | form | decimal? | No | |
InvoiceLineID | form | string | No | |
RptType | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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
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>