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 .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_JB_PurchaseOrdersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SourceType":"String","SourceTypeStartsWith":"String","SourceTypeEndsWith":"String","SourceTypeContains":"String","SourceTypeLike":"String","SourceTypeBetween":["String"],"SourceTypeIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"JobCostStage":"String","JobCostStageStartsWith":"String","JobCostStageEndsWith":"String","JobCostStageContains":"String","JobCostStageLike":"String","JobCostStageBetween":["String"],"JobCostStageIn":["String"],"Item":"String","ItemStartsWith":"String","ItemEndsWith":"String","ItemContains":"String","ItemLike":"String","ItemBetween":["String"],"ItemIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"TranDate":"0001-01-01T00:00:00.0000000","TranDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateGreaterThan":"0001-01-01T00:00:00.0000000","TranDateLessThan":"0001-01-01T00:00:00.0000000","TranDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateNotEqualTo":"0001-01-01T00:00:00.0000000","TranDateBetween":["0001-01-01T00:00:00.0000000"],"TranDateIn":["0001-01-01T00:00:00.0000000"],"Qty":0,"QtyGreaterThanOrEqualTo":0,"QtyGreaterThan":0,"QtyLessThan":0,"QtyLessThanOrEqualTo":0,"QtyNotEqualTo":0,"QtyBetween":[0],"QtyIn":[0],"TotalCost":0,"TotalCostGreaterThanOrEqualTo":0,"TotalCostGreaterThan":0,"TotalCostLessThan":0,"TotalCostLessThanOrEqualTo":0,"TotalCostNotEqualTo":0,"TotalCostBetween":[0],"TotalCostIn":[0],"TotalCharge":0,"TotalChargeGreaterThanOrEqualTo":0,"TotalChargeGreaterThan":0,"TotalChargeLessThan":0,"TotalChargeLessThanOrEqualTo":0,"TotalChargeNotEqualTo":0,"TotalChargeBetween":[0],"TotalChargeIn":[0],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["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":[{"SourceType":"String","BatchNo":"String","JobCostStage":"String","Item":"String","Description":"String","Qty":0,"TotalCost":0,"TotalCharge":0,"Remark":"String","JobNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}