JiwaAPI

<back to all web services

JB_BudgetQuery

Requires Authentication
JB_BudgetQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
JB_JobStages_RecIDquerystringNo
JB_JobStages_RecIDStartsWithquerystringNo
JB_JobStages_RecIDEndsWithquerystringNo
JB_JobStages_RecIDContainsquerystringNo
JB_JobStages_RecIDLikequerystringNo
JB_JobStages_RecIDBetweenquerystring[]No
JB_JobStages_RecIDInquerystring[]No
PurchaseQtyquerydecimal?No
PurchaseQtyGreaterThanOrEqualToquerydecimal?No
PurchaseQtyGreaterThanquerydecimal?No
PurchaseQtyLessThanquerydecimal?No
PurchaseQtyLessThanOrEqualToquerydecimal?No
PurchaseQtyNotEqualToquerydecimal?No
PurchaseQtyBetweenquerydecimal[]No
PurchaseQtyInquerydecimal[]No
PurchaseCostquerydecimal?No
PurchaseCostGreaterThanOrEqualToquerydecimal?No
PurchaseCostGreaterThanquerydecimal?No
PurchaseCostLessThanquerydecimal?No
PurchaseCostLessThanOrEqualToquerydecimal?No
PurchaseCostNotEqualToquerydecimal?No
PurchaseCostBetweenquerydecimal[]No
PurchaseCostInquerydecimal[]No
PurchaseChargequerydecimal?No
PurchaseChargeGreaterThanOrEqualToquerydecimal?No
PurchaseChargeGreaterThanquerydecimal?No
PurchaseChargeLessThanquerydecimal?No
PurchaseChargeLessThanOrEqualToquerydecimal?No
PurchaseChargeNotEqualToquerydecimal?No
PurchaseChargeBetweenquerydecimal[]No
PurchaseChargeInquerydecimal[]No
PurchaseNotequerystringNo
PurchaseNoteStartsWithquerystringNo
PurchaseNoteEndsWithquerystringNo
PurchaseNoteContainsquerystringNo
PurchaseNoteLikequerystringNo
PurchaseNoteBetweenquerystring[]No
PurchaseNoteInquerystring[]No
MaterialQtyquerydecimal?No
MaterialQtyGreaterThanOrEqualToquerydecimal?No
MaterialQtyGreaterThanquerydecimal?No
MaterialQtyLessThanquerydecimal?No
MaterialQtyLessThanOrEqualToquerydecimal?No
MaterialQtyNotEqualToquerydecimal?No
MaterialQtyBetweenquerydecimal[]No
MaterialQtyInquerydecimal[]No
MaterialCostquerydecimal?No
MaterialCostGreaterThanOrEqualToquerydecimal?No
MaterialCostGreaterThanquerydecimal?No
MaterialCostLessThanquerydecimal?No
MaterialCostLessThanOrEqualToquerydecimal?No
MaterialCostNotEqualToquerydecimal?No
MaterialCostBetweenquerydecimal[]No
MaterialCostInquerydecimal[]No
MaterialChargequerydecimal?No
MaterialChargeGreaterThanOrEqualToquerydecimal?No
MaterialChargeGreaterThanquerydecimal?No
MaterialChargeLessThanquerydecimal?No
MaterialChargeLessThanOrEqualToquerydecimal?No
MaterialChargeNotEqualToquerydecimal?No
MaterialChargeBetweenquerydecimal[]No
MaterialChargeInquerydecimal[]No
MaterialNotequerystringNo
MaterialNoteStartsWithquerystringNo
MaterialNoteEndsWithquerystringNo
MaterialNoteContainsquerystringNo
MaterialNoteLikequerystringNo
MaterialNoteBetweenquerystring[]No
MaterialNoteInquerystring[]No
LabourQtyquerydecimal?No
LabourQtyGreaterThanOrEqualToquerydecimal?No
LabourQtyGreaterThanquerydecimal?No
LabourQtyLessThanquerydecimal?No
LabourQtyLessThanOrEqualToquerydecimal?No
LabourQtyNotEqualToquerydecimal?No
LabourQtyBetweenquerydecimal[]No
LabourQtyInquerydecimal[]No
LabourCostquerydecimal?No
LabourCostGreaterThanOrEqualToquerydecimal?No
LabourCostGreaterThanquerydecimal?No
LabourCostLessThanquerydecimal?No
LabourCostLessThanOrEqualToquerydecimal?No
LabourCostNotEqualToquerydecimal?No
LabourCostBetweenquerydecimal[]No
LabourCostInquerydecimal[]No
LabourChargequerydecimal?No
LabourChargeGreaterThanOrEqualToquerydecimal?No
LabourChargeGreaterThanquerydecimal?No
LabourChargeLessThanquerydecimal?No
LabourChargeLessThanOrEqualToquerydecimal?No
LabourChargeNotEqualToquerydecimal?No
LabourChargeBetweenquerydecimal[]No
LabourChargeInquerydecimal[]No
LabourNotequerystringNo
LabourNoteStartsWithquerystringNo
LabourNoteEndsWithquerystringNo
LabourNoteContainsquerystringNo
LabourNoteLikequerystringNo
LabourNoteBetweenquerystring[]No
LabourNoteInquerystring[]No
CashBookQtyquerydecimal?No
CashBookQtyGreaterThanOrEqualToquerydecimal?No
CashBookQtyGreaterThanquerydecimal?No
CashBookQtyLessThanquerydecimal?No
CashBookQtyLessThanOrEqualToquerydecimal?No
CashBookQtyNotEqualToquerydecimal?No
CashBookQtyBetweenquerydecimal[]No
CashBookQtyInquerydecimal[]No
CashBookCostquerydecimal?No
CashBookCostGreaterThanOrEqualToquerydecimal?No
CashBookCostGreaterThanquerydecimal?No
CashBookCostLessThanquerydecimal?No
CashBookCostLessThanOrEqualToquerydecimal?No
CashBookCostNotEqualToquerydecimal?No
CashBookCostBetweenquerydecimal[]No
CashBookCostInquerydecimal[]No
CashBookChargequerydecimal?No
CashBookChargeGreaterThanOrEqualToquerydecimal?No
CashBookChargeGreaterThanquerydecimal?No
CashBookChargeLessThanquerydecimal?No
CashBookChargeLessThanOrEqualToquerydecimal?No
CashBookChargeNotEqualToquerydecimal?No
CashBookChargeBetweenquerydecimal[]No
CashBookChargeInquerydecimal[]No
CashBookNotequerystringNo
CashBookNoteStartsWithquerystringNo
CashBookNoteEndsWithquerystringNo
CashBookNoteContainsquerystringNo
CashBookNoteLikequerystringNo
CashBookNoteBetweenquerystring[]No
CashBookNoteInquerystring[]No
ResourceQtyquerydecimal?No
ResourceQtyGreaterThanOrEqualToquerydecimal?No
ResourceQtyGreaterThanquerydecimal?No
ResourceQtyLessThanquerydecimal?No
ResourceQtyLessThanOrEqualToquerydecimal?No
ResourceQtyNotEqualToquerydecimal?No
ResourceQtyBetweenquerydecimal[]No
ResourceQtyInquerydecimal[]No
ResourceCostquerydecimal?No
ResourceCostGreaterThanOrEqualToquerydecimal?No
ResourceCostGreaterThanquerydecimal?No
ResourceCostLessThanquerydecimal?No
ResourceCostLessThanOrEqualToquerydecimal?No
ResourceCostNotEqualToquerydecimal?No
ResourceCostBetweenquerydecimal[]No
ResourceCostInquerydecimal[]No
ResourceChargequerydecimal?No
ResourceChargeGreaterThanOrEqualToquerydecimal?No
ResourceChargeGreaterThanquerydecimal?No
ResourceChargeLessThanquerydecimal?No
ResourceChargeLessThanOrEqualToquerydecimal?No
ResourceChargeNotEqualToquerydecimal?No
ResourceChargeBetweenquerydecimal[]No
ResourceChargeInquerydecimal[]No
ResourceNotequerystringNo
ResourceNoteStartsWithquerystringNo
ResourceNoteEndsWithquerystringNo
ResourceNoteContainsquerystringNo
ResourceNoteLikequerystringNo
ResourceNoteBetweenquerystring[]No
ResourceNoteInquerystring[]No
JournalQtyquerydecimal?No
JournalQtyGreaterThanOrEqualToquerydecimal?No
JournalQtyGreaterThanquerydecimal?No
JournalQtyLessThanquerydecimal?No
JournalQtyLessThanOrEqualToquerydecimal?No
JournalQtyNotEqualToquerydecimal?No
JournalQtyBetweenquerydecimal[]No
JournalQtyInquerydecimal[]No
JournalCostquerydecimal?No
JournalCostGreaterThanOrEqualToquerydecimal?No
JournalCostGreaterThanquerydecimal?No
JournalCostLessThanquerydecimal?No
JournalCostLessThanOrEqualToquerydecimal?No
JournalCostNotEqualToquerydecimal?No
JournalCostBetweenquerydecimal[]No
JournalCostInquerydecimal[]No
JournalChargequerydecimal?No
JournalChargeGreaterThanOrEqualToquerydecimal?No
JournalChargeGreaterThanquerydecimal?No
JournalChargeLessThanquerydecimal?No
JournalChargeLessThanOrEqualToquerydecimal?No
JournalChargeNotEqualToquerydecimal?No
JournalChargeBetweenquerydecimal[]No
JournalChargeInquerydecimal[]No
JournalNotequerystringNo
JournalNoteStartsWithquerystringNo
JournalNoteEndsWithquerystringNo
JournalNoteContainsquerystringNo
JournalNoteLikequerystringNo
JournalNoteBetweenquerystring[]No
JournalNoteInquerystring[]No
MaterialCreditorQtyquerydecimal?No
MaterialCreditorQtyGreaterThanOrEqualToquerydecimal?No
MaterialCreditorQtyGreaterThanquerydecimal?No
MaterialCreditorQtyLessThanquerydecimal?No
MaterialCreditorQtyLessThanOrEqualToquerydecimal?No
MaterialCreditorQtyNotEqualToquerydecimal?No
MaterialCreditorQtyBetweenquerydecimal[]No
MaterialCreditorQtyInquerydecimal[]No
MaterialCreditorCostquerydecimal?No
MaterialCreditorCostGreaterThanOrEqualToquerydecimal?No
MaterialCreditorCostGreaterThanquerydecimal?No
MaterialCreditorCostLessThanquerydecimal?No
MaterialCreditorCostLessThanOrEqualToquerydecimal?No
MaterialCreditorCostNotEqualToquerydecimal?No
MaterialCreditorCostBetweenquerydecimal[]No
MaterialCreditorCostInquerydecimal[]No
MaterialCreditorChargequerydecimal?No
MaterialCreditorChargeGreaterThanOrEqualToquerydecimal?No
MaterialCreditorChargeGreaterThanquerydecimal?No
MaterialCreditorChargeLessThanquerydecimal?No
MaterialCreditorChargeLessThanOrEqualToquerydecimal?No
MaterialCreditorChargeNotEqualToquerydecimal?No
MaterialCreditorChargeBetweenquerydecimal[]No
MaterialCreditorChargeInquerydecimal[]No
MaterialCreditorNotequerystringNo
MaterialCreditorNoteStartsWithquerystringNo
MaterialCreditorNoteEndsWithquerystringNo
MaterialCreditorNoteContainsquerystringNo
MaterialCreditorNoteLikequerystringNo
MaterialCreditorNoteBetweenquerystring[]No
MaterialCreditorNoteInquerystring[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Budget Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
JB_JobStages_RecIDformstringNo
PurchaseQtyformdecimalNo
PurchaseCostformdecimalNo
PurchaseChargeformdecimalNo
PurchaseNoteformstringNo
MaterialQtyformdecimalNo
MaterialCostformdecimalNo
MaterialChargeformdecimalNo
MaterialNoteformstringNo
LabourQtyformdecimalNo
LabourCostformdecimalNo
LabourChargeformdecimalNo
LabourNoteformstringNo
CashBookQtyformdecimalNo
CashBookCostformdecimalNo
CashBookChargeformdecimalNo
CashBookNoteformstringNo
ResourceQtyformdecimalNo
ResourceCostformdecimalNo
ResourceChargeformdecimalNo
ResourceNoteformstringNo
JournalQtyformdecimalNo
JournalCostformdecimalNo
JournalChargeformdecimalNo
JournalNoteformstringNo
MaterialCreditorQtyformdecimalNo
MaterialCreditorCostformdecimalNo
MaterialCreditorChargeformdecimalNo
MaterialCreditorNoteformstringNo
RowHashformbyte[]No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/JB_BudgetQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"JB_JobStages_RecID":"String","JB_JobStages_RecIDStartsWith":"String","JB_JobStages_RecIDEndsWith":"String","JB_JobStages_RecIDContains":"String","JB_JobStages_RecIDLike":"String","JB_JobStages_RecIDBetween":["String"],"JB_JobStages_RecIDIn":["String"],"PurchaseQty":0,"PurchaseQtyGreaterThanOrEqualTo":0,"PurchaseQtyGreaterThan":0,"PurchaseQtyLessThan":0,"PurchaseQtyLessThanOrEqualTo":0,"PurchaseQtyNotEqualTo":0,"PurchaseQtyBetween":[0],"PurchaseQtyIn":[0],"PurchaseCost":0,"PurchaseCostGreaterThanOrEqualTo":0,"PurchaseCostGreaterThan":0,"PurchaseCostLessThan":0,"PurchaseCostLessThanOrEqualTo":0,"PurchaseCostNotEqualTo":0,"PurchaseCostBetween":[0],"PurchaseCostIn":[0],"PurchaseCharge":0,"PurchaseChargeGreaterThanOrEqualTo":0,"PurchaseChargeGreaterThan":0,"PurchaseChargeLessThan":0,"PurchaseChargeLessThanOrEqualTo":0,"PurchaseChargeNotEqualTo":0,"PurchaseChargeBetween":[0],"PurchaseChargeIn":[0],"PurchaseNote":"String","PurchaseNoteStartsWith":"String","PurchaseNoteEndsWith":"String","PurchaseNoteContains":"String","PurchaseNoteLike":"String","PurchaseNoteBetween":["String"],"PurchaseNoteIn":["String"],"MaterialQty":0,"MaterialQtyGreaterThanOrEqualTo":0,"MaterialQtyGreaterThan":0,"MaterialQtyLessThan":0,"MaterialQtyLessThanOrEqualTo":0,"MaterialQtyNotEqualTo":0,"MaterialQtyBetween":[0],"MaterialQtyIn":[0],"MaterialCost":0,"MaterialCostGreaterThanOrEqualTo":0,"MaterialCostGreaterThan":0,"MaterialCostLessThan":0,"MaterialCostLessThanOrEqualTo":0,"MaterialCostNotEqualTo":0,"MaterialCostBetween":[0],"MaterialCostIn":[0],"MaterialCharge":0,"MaterialChargeGreaterThanOrEqualTo":0,"MaterialChargeGreaterThan":0,"MaterialChargeLessThan":0,"MaterialChargeLessThanOrEqualTo":0,"MaterialChargeNotEqualTo":0,"MaterialChargeBetween":[0],"MaterialChargeIn":[0],"MaterialNote":"String","MaterialNoteStartsWith":"String","MaterialNoteEndsWith":"String","MaterialNoteContains":"String","MaterialNoteLike":"String","MaterialNoteBetween":["String"],"MaterialNoteIn":["String"],"LabourQty":0,"LabourQtyGreaterThanOrEqualTo":0,"LabourQtyGreaterThan":0,"LabourQtyLessThan":0,"LabourQtyLessThanOrEqualTo":0,"LabourQtyNotEqualTo":0,"LabourQtyBetween":[0],"LabourQtyIn":[0],"LabourCost":0,"LabourCostGreaterThanOrEqualTo":0,"LabourCostGreaterThan":0,"LabourCostLessThan":0,"LabourCostLessThanOrEqualTo":0,"LabourCostNotEqualTo":0,"LabourCostBetween":[0],"LabourCostIn":[0],"LabourCharge":0,"LabourChargeGreaterThanOrEqualTo":0,"LabourChargeGreaterThan":0,"LabourChargeLessThan":0,"LabourChargeLessThanOrEqualTo":0,"LabourChargeNotEqualTo":0,"LabourChargeBetween":[0],"LabourChargeIn":[0],"LabourNote":"String","LabourNoteStartsWith":"String","LabourNoteEndsWith":"String","LabourNoteContains":"String","LabourNoteLike":"String","LabourNoteBetween":["String"],"LabourNoteIn":["String"],"CashBookQty":0,"CashBookQtyGreaterThanOrEqualTo":0,"CashBookQtyGreaterThan":0,"CashBookQtyLessThan":0,"CashBookQtyLessThanOrEqualTo":0,"CashBookQtyNotEqualTo":0,"CashBookQtyBetween":[0],"CashBookQtyIn":[0],"CashBookCost":0,"CashBookCostGreaterThanOrEqualTo":0,"CashBookCostGreaterThan":0,"CashBookCostLessThan":0,"CashBookCostLessThanOrEqualTo":0,"CashBookCostNotEqualTo":0,"CashBookCostBetween":[0],"CashBookCostIn":[0],"CashBookCharge":0,"CashBookChargeGreaterThanOrEqualTo":0,"CashBookChargeGreaterThan":0,"CashBookChargeLessThan":0,"CashBookChargeLessThanOrEqualTo":0,"CashBookChargeNotEqualTo":0,"CashBookChargeBetween":[0],"CashBookChargeIn":[0],"CashBookNote":"String","CashBookNoteStartsWith":"String","CashBookNoteEndsWith":"String","CashBookNoteContains":"String","CashBookNoteLike":"String","CashBookNoteBetween":["String"],"CashBookNoteIn":["String"],"ResourceQty":0,"ResourceQtyGreaterThanOrEqualTo":0,"ResourceQtyGreaterThan":0,"ResourceQtyLessThan":0,"ResourceQtyLessThanOrEqualTo":0,"ResourceQtyNotEqualTo":0,"ResourceQtyBetween":[0],"ResourceQtyIn":[0],"ResourceCost":0,"ResourceCostGreaterThanOrEqualTo":0,"ResourceCostGreaterThan":0,"ResourceCostLessThan":0,"ResourceCostLessThanOrEqualTo":0,"ResourceCostNotEqualTo":0,"ResourceCostBetween":[0],"ResourceCostIn":[0],"ResourceCharge":0,"ResourceChargeGreaterThanOrEqualTo":0,"ResourceChargeGreaterThan":0,"ResourceChargeLessThan":0,"ResourceChargeLessThanOrEqualTo":0,"ResourceChargeNotEqualTo":0,"ResourceChargeBetween":[0],"ResourceChargeIn":[0],"ResourceNote":"String","ResourceNoteStartsWith":"String","ResourceNoteEndsWith":"String","ResourceNoteContains":"String","ResourceNoteLike":"String","ResourceNoteBetween":["String"],"ResourceNoteIn":["String"],"JournalQty":0,"JournalQtyGreaterThanOrEqualTo":0,"JournalQtyGreaterThan":0,"JournalQtyLessThan":0,"JournalQtyLessThanOrEqualTo":0,"JournalQtyNotEqualTo":0,"JournalQtyBetween":[0],"JournalQtyIn":[0],"JournalCost":0,"JournalCostGreaterThanOrEqualTo":0,"JournalCostGreaterThan":0,"JournalCostLessThan":0,"JournalCostLessThanOrEqualTo":0,"JournalCostNotEqualTo":0,"JournalCostBetween":[0],"JournalCostIn":[0],"JournalCharge":0,"JournalChargeGreaterThanOrEqualTo":0,"JournalChargeGreaterThan":0,"JournalChargeLessThan":0,"JournalChargeLessThanOrEqualTo":0,"JournalChargeNotEqualTo":0,"JournalChargeBetween":[0],"JournalChargeIn":[0],"JournalNote":"String","JournalNoteStartsWith":"String","JournalNoteEndsWith":"String","JournalNoteContains":"String","JournalNoteLike":"String","JournalNoteBetween":["String"],"JournalNoteIn":["String"],"MaterialCreditorQty":0,"MaterialCreditorQtyGreaterThanOrEqualTo":0,"MaterialCreditorQtyGreaterThan":0,"MaterialCreditorQtyLessThan":0,"MaterialCreditorQtyLessThanOrEqualTo":0,"MaterialCreditorQtyNotEqualTo":0,"MaterialCreditorQtyBetween":[0],"MaterialCreditorQtyIn":[0],"MaterialCreditorCost":0,"MaterialCreditorCostGreaterThanOrEqualTo":0,"MaterialCreditorCostGreaterThan":0,"MaterialCreditorCostLessThan":0,"MaterialCreditorCostLessThanOrEqualTo":0,"MaterialCreditorCostNotEqualTo":0,"MaterialCreditorCostBetween":[0],"MaterialCreditorCostIn":[0],"MaterialCreditorCharge":0,"MaterialCreditorChargeGreaterThanOrEqualTo":0,"MaterialCreditorChargeGreaterThan":0,"MaterialCreditorChargeLessThan":0,"MaterialCreditorChargeLessThanOrEqualTo":0,"MaterialCreditorChargeNotEqualTo":0,"MaterialCreditorChargeBetween":[0],"MaterialCreditorChargeIn":[0],"MaterialCreditorNote":"String","MaterialCreditorNoteStartsWith":"String","MaterialCreditorNoteEndsWith":"String","MaterialCreditorNoteContains":"String","MaterialCreditorNoteLike":"String","MaterialCreditorNoteBetween":["String"],"MaterialCreditorNoteIn":["String"],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"RecID":"String","JB_JobStages_RecID":"String","PurchaseNote":"String","MaterialNote":"String","LabourNote":"String","CashBookNote":"String","ResourceNote":"String","JournalNote":"String","MaterialCreditorNote":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}