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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/V_Shipment_BOQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"RecordDate":"0001-01-01T00:00:00.0000000","RecordDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","RecordDateGreaterThan":"0001-01-01T00:00:00.0000000","RecordDateLessThan":"0001-01-01T00:00:00.0000000","RecordDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","RecordDateNotEqualTo":"0001-01-01T00:00:00.0000000","RecordDateBetween":["0001-01-01T00:00:00.0000000"],"RecordDateIn":["0001-01-01T00:00:00.0000000"],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"HistoryNo":0,"HistoryNoGreaterThanOrEqualTo":0,"HistoryNoGreaterThan":0,"HistoryNoLessThan":0,"HistoryNoLessThanOrEqualTo":0,"HistoryNoNotEqualTo":0,"HistoryNoBetween":[0],"HistoryNoIn":[0],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"QuantityOrdered":0,"QuantityOrderedGreaterThanOrEqualTo":0,"QuantityOrderedGreaterThan":0,"QuantityOrderedLessThan":0,"QuantityOrderedLessThanOrEqualTo":0,"QuantityOrderedNotEqualTo":0,"QuantityOrderedBetween":[0],"QuantityOrderedIn":[0],"QuantityThisDel":0,"QuantityThisDelGreaterThanOrEqualTo":0,"QuantityThisDelGreaterThan":0,"QuantityThisDelLessThan":0,"QuantityThisDelLessThanOrEqualTo":0,"QuantityThisDelNotEqualTo":0,"QuantityThisDelBetween":[0],"QuantityThisDelIn":[0],"QuantityBackord":0,"QuantityBackordGreaterThanOrEqualTo":0,"QuantityBackordGreaterThan":0,"QuantityBackordLessThan":0,"QuantityBackordLessThanOrEqualTo":0,"QuantityBackordNotEqualTo":0,"QuantityBackordBetween":[0],"QuantityBackordIn":[0],"QuantityPrevDel":0,"QuantityPrevDelGreaterThanOrEqualTo":0,"QuantityPrevDelGreaterThan":0,"QuantityPrevDelLessThan":0,"QuantityPrevDelLessThanOrEqualTo":0,"QuantityPrevDelNotEqualTo":0,"QuantityPrevDelBetween":[0],"QuantityPrevDelIn":[0],"ItemPrice":0,"ItemPriceGreaterThanOrEqualTo":0,"ItemPriceGreaterThan":0,"ItemPriceLessThan":0,"ItemPriceLessThanOrEqualTo":0,"ItemPriceNotEqualTo":0,"ItemPriceBetween":[0],"ItemPriceIn":[0],"TaxToCharge":0,"TaxToChargeGreaterThanOrEqualTo":0,"TaxToChargeGreaterThan":0,"TaxToChargeLessThan":0,"TaxToChargeLessThanOrEqualTo":0,"TaxToChargeNotEqualTo":0,"TaxToChargeBetween":[0],"TaxToChargeIn":[0],"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"RptType":"String","RptTypeStartsWith":"String","RptTypeEndsWith":"String","RptTypeContains":"String","RptTypeLike":"String","RptTypeBetween":["String"],"RptTypeIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"InvoiceNo":"String","RecordDate":"0001-01-01T00:00:00.0000000","OrderNo":"String","DebtorID":"String","HistoryNo":0,"PartNo":"String","Description":"String","QuantityOrdered":0,"QuantityThisDel":0,"QuantityBackord":0,"QuantityPrevDel":0,"ItemPrice":0,"TaxToCharge":0,"InvoiceLineID":"String","RptType":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}