Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreditorID | query | string | No | |
CreditorIDStartsWith | query | string | No | |
CreditorIDEndsWith | query | string | No | |
CreditorIDContains | query | string | No | |
CreditorIDLike | query | string | No | |
CreditorIDBetween | query | string[] | No | |
CreditorIDIn | query | string[] | No | |
Type | query | string | No | |
TypeStartsWith | query | string | No | |
TypeEndsWith | query | string | No | |
TypeContains | query | string | No | |
TypeLike | query | string | No | |
TypeBetween | query | string[] | No | |
TypeIn | query | string[] | No | |
TranDate | query | DateTime? | No | |
TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
TranDateGreaterThan | query | DateTime? | No | |
TranDateLessThan | query | DateTime? | No | |
TranDateLessThanOrEqualTo | query | DateTime? | No | |
TranDateNotEqualTo | query | DateTime? | No | |
TranDateBetween | query | Nullable<DateTime>[] | No | |
TranDateIn | query | Nullable<DateTime>[] | No | |
DueDate | query | DateTime? | No | |
DueDateGreaterThanOrEqualTo | query | DateTime? | No | |
DueDateGreaterThan | query | DateTime? | No | |
DueDateLessThan | query | DateTime? | No | |
DueDateLessThanOrEqualTo | query | DateTime? | No | |
DueDateNotEqualTo | query | DateTime? | No | |
DueDateBetween | query | Nullable<DateTime>[] | No | |
DueDateIn | query | Nullable<DateTime>[] | No | |
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 | |
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 | |
PartDescription | query | string | No | |
PartDescriptionStartsWith | query | string | No | |
PartDescriptionEndsWith | query | string | No | |
PartDescriptionContains | query | string | No | |
PartDescriptionLike | query | string | No | |
PartDescriptionBetween | query | string[] | No | |
PartDescriptionIn | query | string[] | No | |
Quantity | query | decimal? | No | |
QuantityGreaterThanOrEqualTo | query | decimal? | No | |
QuantityGreaterThan | query | decimal? | No | |
QuantityLessThan | query | decimal? | No | |
QuantityLessThanOrEqualTo | query | decimal? | No | |
QuantityNotEqualTo | query | decimal? | No | |
QuantityBetween | query | Nullable<Decimal>[] | No | |
QuantityIn | query | Nullable<Decimal>[] | No | |
UnitCost | query | decimal? | No | |
UnitCostGreaterThanOrEqualTo | query | decimal? | No | |
UnitCostGreaterThan | query | decimal? | No | |
UnitCostLessThan | query | decimal? | No | |
UnitCostLessThanOrEqualTo | query | decimal? | No | |
UnitCostNotEqualTo | query | decimal? | No | |
UnitCostBetween | query | Nullable<Decimal>[] | No | |
UnitCostIn | query | Nullable<Decimal>[] | No | |
TotalCost | query | decimal? | No | |
TotalCostGreaterThanOrEqualTo | query | decimal? | No | |
TotalCostGreaterThan | query | decimal? | No | |
TotalCostLessThan | query | decimal? | No | |
TotalCostLessThanOrEqualTo | query | decimal? | No | |
TotalCostNotEqualTo | query | decimal? | No | |
TotalCostBetween | query | Nullable<Decimal>[] | No | |
TotalCostIn | query | Nullable<Decimal>[] | No | |
TaxAmount | query | decimal? | No | |
TaxAmountGreaterThanOrEqualTo | query | decimal? | No | |
TaxAmountGreaterThan | query | decimal? | No | |
TaxAmountLessThan | query | decimal? | No | |
TaxAmountLessThanOrEqualTo | query | decimal? | No | |
TaxAmountNotEqualTo | query | decimal? | No | |
TaxAmountBetween | query | Nullable<Decimal>[] | No | |
TaxAmountIn | query | Nullable<Decimal>[] | No | |
IncTotal | query | decimal? | No | |
IncTotalGreaterThanOrEqualTo | query | decimal? | No | |
IncTotalGreaterThan | query | decimal? | No | |
IncTotalLessThan | query | decimal? | No | |
IncTotalLessThanOrEqualTo | query | decimal? | No | |
IncTotalNotEqualTo | query | decimal? | No | |
IncTotalBetween | query | Nullable<Decimal>[] | No | |
IncTotalIn | query | Nullable<Decimal>[] | No | |
CurrencyRate | query | decimal? | No | |
CurrencyRateGreaterThanOrEqualTo | query | decimal? | No | |
CurrencyRateGreaterThan | query | decimal? | No | |
CurrencyRateLessThan | query | decimal? | No | |
CurrencyRateLessThanOrEqualTo | query | decimal? | No | |
CurrencyRateNotEqualTo | query | decimal? | No | |
CurrencyRateBetween | query | Nullable<Decimal>[] | No | |
CurrencyRateIn | query | Nullable<Decimal>[] | No | |
FxUnitCost | query | decimal? | No | |
FxUnitCostGreaterThanOrEqualTo | query | decimal? | No | |
FxUnitCostGreaterThan | query | decimal? | No | |
FxUnitCostLessThan | query | decimal? | No | |
FxUnitCostLessThanOrEqualTo | query | decimal? | No | |
FxUnitCostNotEqualTo | query | decimal? | No | |
FxUnitCostBetween | query | Nullable<Decimal>[] | No | |
FxUnitCostIn | query | Nullable<Decimal>[] | No | |
FxTotalCost | query | decimal? | No | |
FxTotalCostGreaterThanOrEqualTo | query | decimal? | No | |
FxTotalCostGreaterThan | query | decimal? | No | |
FxTotalCostLessThan | query | decimal? | No | |
FxTotalCostLessThanOrEqualTo | query | decimal? | No | |
FxTotalCostNotEqualTo | query | decimal? | No | |
FxTotalCostBetween | query | Nullable<Decimal>[] | No | |
FxTotalCostIn | query | Nullable<Decimal>[] | 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 |
---|---|---|---|---|
CreditorID | form | string | No | |
Type | form | string | No | |
TranDate | form | DateTime? | No | |
DueDate | form | DateTime? | No | |
InvoiceNo | form | string | No | |
PartNo | form | string | No | |
PartDescription | form | string | No | |
Quantity | form | decimal? | No | |
UnitCost | form | decimal? | No | |
TotalCost | form | decimal? | No | |
TaxAmount | form | decimal? | No | |
IncTotal | form | decimal? | No | |
CurrencyRate | form | decimal? | No | |
FxUnitCost | form | decimal? | No | |
FxTotalCost | form | decimal? | 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_CR_PurchaseShipmentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<V_CR_PurchaseShipmentsQuery 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>
<CreditorID>String</CreditorID>
<CreditorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreditorIDBetween>
<CreditorIDContains>String</CreditorIDContains>
<CreditorIDEndsWith>String</CreditorIDEndsWith>
<CreditorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</CreditorIDIn>
<CreditorIDLike>String</CreditorIDLike>
<CreditorIDStartsWith>String</CreditorIDStartsWith>
<CurrencyRate>0</CurrencyRate>
<CurrencyRateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</CurrencyRateBetween>
<CurrencyRateGreaterThan>0</CurrencyRateGreaterThan>
<CurrencyRateGreaterThanOrEqualTo>0</CurrencyRateGreaterThanOrEqualTo>
<CurrencyRateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</CurrencyRateIn>
<CurrencyRateLessThan>0</CurrencyRateLessThan>
<CurrencyRateLessThanOrEqualTo>0</CurrencyRateLessThanOrEqualTo>
<CurrencyRateNotEqualTo>0</CurrencyRateNotEqualTo>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</DueDateBetween>
<DueDateGreaterThan>0001-01-01T00:00:00</DueDateGreaterThan>
<DueDateGreaterThanOrEqualTo>0001-01-01T00:00:00</DueDateGreaterThanOrEqualTo>
<DueDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</DueDateIn>
<DueDateLessThan>0001-01-01T00:00:00</DueDateLessThan>
<DueDateLessThanOrEqualTo>0001-01-01T00:00:00</DueDateLessThanOrEqualTo>
<DueDateNotEqualTo>0001-01-01T00:00:00</DueDateNotEqualTo>
<FxTotalCost>0</FxTotalCost>
<FxTotalCostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</FxTotalCostBetween>
<FxTotalCostGreaterThan>0</FxTotalCostGreaterThan>
<FxTotalCostGreaterThanOrEqualTo>0</FxTotalCostGreaterThanOrEqualTo>
<FxTotalCostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</FxTotalCostIn>
<FxTotalCostLessThan>0</FxTotalCostLessThan>
<FxTotalCostLessThanOrEqualTo>0</FxTotalCostLessThanOrEqualTo>
<FxTotalCostNotEqualTo>0</FxTotalCostNotEqualTo>
<FxUnitCost>0</FxUnitCost>
<FxUnitCostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</FxUnitCostBetween>
<FxUnitCostGreaterThan>0</FxUnitCostGreaterThan>
<FxUnitCostGreaterThanOrEqualTo>0</FxUnitCostGreaterThanOrEqualTo>
<FxUnitCostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</FxUnitCostIn>
<FxUnitCostLessThan>0</FxUnitCostLessThan>
<FxUnitCostLessThanOrEqualTo>0</FxUnitCostLessThanOrEqualTo>
<FxUnitCostNotEqualTo>0</FxUnitCostNotEqualTo>
<IncTotal>0</IncTotal>
<IncTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</IncTotalBetween>
<IncTotalGreaterThan>0</IncTotalGreaterThan>
<IncTotalGreaterThanOrEqualTo>0</IncTotalGreaterThanOrEqualTo>
<IncTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</IncTotalIn>
<IncTotalLessThan>0</IncTotalLessThan>
<IncTotalLessThanOrEqualTo>0</IncTotalLessThanOrEqualTo>
<IncTotalNotEqualTo>0</IncTotalNotEqualTo>
<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>
<PartDescription>String</PartDescription>
<PartDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PartDescriptionBetween>
<PartDescriptionContains>String</PartDescriptionContains>
<PartDescriptionEndsWith>String</PartDescriptionEndsWith>
<PartDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</PartDescriptionIn>
<PartDescriptionLike>String</PartDescriptionLike>
<PartDescriptionStartsWith>String</PartDescriptionStartsWith>
<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>
<Quantity>0</Quantity>
<QuantityBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</QuantityBetween>
<QuantityGreaterThan>0</QuantityGreaterThan>
<QuantityGreaterThanOrEqualTo>0</QuantityGreaterThanOrEqualTo>
<QuantityIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</QuantityIn>
<QuantityLessThan>0</QuantityLessThan>
<QuantityLessThanOrEqualTo>0</QuantityLessThanOrEqualTo>
<QuantityNotEqualTo>0</QuantityNotEqualTo>
<TaxAmount>0</TaxAmount>
<TaxAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</TaxAmountBetween>
<TaxAmountGreaterThan>0</TaxAmountGreaterThan>
<TaxAmountGreaterThanOrEqualTo>0</TaxAmountGreaterThanOrEqualTo>
<TaxAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</TaxAmountIn>
<TaxAmountLessThan>0</TaxAmountLessThan>
<TaxAmountLessThanOrEqualTo>0</TaxAmountLessThanOrEqualTo>
<TaxAmountNotEqualTo>0</TaxAmountNotEqualTo>
<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.datacontract.org/2004/07/System">
<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.datacontract.org/2004/07/System">
<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>
<Type>String</Type>
<TypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TypeBetween>
<TypeContains>String</TypeContains>
<TypeEndsWith>String</TypeEndsWith>
<TypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TypeIn>
<TypeLike>String</TypeLike>
<TypeStartsWith>String</TypeStartsWith>
<UnitCost>0</UnitCost>
<UnitCostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</UnitCostBetween>
<UnitCostGreaterThan>0</UnitCostGreaterThan>
<UnitCostGreaterThanOrEqualTo>0</UnitCostGreaterThanOrEqualTo>
<UnitCostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</UnitCostIn>
<UnitCostLessThan>0</UnitCostLessThan>
<UnitCostLessThanOrEqualTo>0</UnitCostLessThanOrEqualTo>
<UnitCostNotEqualTo>0</UnitCostNotEqualTo>
</V_CR_PurchaseShipmentsQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfV_CR_PurchaseShipments7kRqkrSv 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_CR_PurchaseShipments> <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField> <d2p1:_x003C_CurrencyRate_x003E_k__BackingField>0</d2p1:_x003C_CurrencyRate_x003E_k__BackingField> <d2p1:_x003C_DueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DueDate_x003E_k__BackingField> <d2p1:_x003C_FxTotalCost_x003E_k__BackingField>0</d2p1:_x003C_FxTotalCost_x003E_k__BackingField> <d2p1:_x003C_FxUnitCost_x003E_k__BackingField>0</d2p1:_x003C_FxUnitCost_x003E_k__BackingField> <d2p1:_x003C_IncTotal_x003E_k__BackingField>0</d2p1:_x003C_IncTotal_x003E_k__BackingField> <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField> <d2p1:_x003C_PartDescription_x003E_k__BackingField>String</d2p1:_x003C_PartDescription_x003E_k__BackingField> <d2p1:_x003C_PartNo_x003E_k__BackingField>String</d2p1:_x003C_PartNo_x003E_k__BackingField> <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField> <d2p1:_x003C_TaxAmount_x003E_k__BackingField>0</d2p1:_x003C_TaxAmount_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:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField> <d2p1:_x003C_UnitCost_x003E_k__BackingField>0</d2p1:_x003C_UnitCost_x003E_k__BackingField> </d2p1:V_CR_PurchaseShipments> </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_CR_PurchaseShipments7kRqkrSv>