Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/bid/update

This action updates an existing bid associated with a work order.

Request

FieldDescriptionRequired
comp_note_idUnique identifier for the bidYes
qtyBid quantityNo
qty_completionCompletion quantityNo
uomUnique identifier for the Unit of Measure (UOM). See /bid/uomNo
contractor_priceContractor priceNo
client_priceClient priceNo
commentCommentNo
comp_commentCompletion commentNo

A bid is uniquely identified by comp_note_id; it can be retrieved through the /bid/list action.

Example:

{
  "comp_note_id": 42,
  "qty": 5,
  "qty_completion": 6,
  "contractor_price": 5.15,
  "client_price": 39.17,
  "comment": "lock padlock comment",
  "comp_comment": "lock completion comment"
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"comp_note_id":42,"qty":5,"qty_completion": 6,"contractor_price":5.15,"client_price":39.17,"comment":"lock padlock comment","comp_comment":"lock completion comment"}' \
     https://ppw.web/svc/bid/update

Response

FieldDescriptionType
resultBid update resultstring

Example successful response:

{
  "result": "Bid updated"
}

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403
comp_note_requiredcomp_note_id not in the request400
comp_note_invalidcomp_note_id is invalid400
qty_invalidBid quantity is invalid400
uom_invalidUnit of Measure (UOM) is invalid400
uom_not_allowedUnit of Measure (UOM) cannot be set400
contractor_price_invalidContractor price is invalid400
client_price_invalidClient price is invalid400
comment_invalidComment is invalid400
not_foundBid not found400