/bid/list
This action lists bids associated with a work order.
Request
| Field | Description | Required |
|---|---|---|
report_id | Unique identifier for a work order | Yes |
Example:
{
"report_id": 4064
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"report_id": 4064}' \
https://ppw.web/svc/bid/list
Response
| Field | Description | Type |
|---|---|---|
report_id | Unique identifier for the work order | number |
bids | Bids associated with work order | array |
Each item in bids is a JSON object; they’ll have the following fields:
| Field | Description | Type |
|---|---|---|
comp_note_id | Unique identifier for the bid | number |
invoice_item_id | Unique identifier for the invoice item | number |
description | Name of invoice item | string |
qty | Bid quantity | number |
uom | Unique identifier for the Unit of Measure (UOM) | number |
contractor_price | Contractor price for the bid | number |
client_price | Client price for the bid | number |
comment | Bid comment | string |
completion_comment | Completion comment | string |
Example successful response:
{
"report_id": 4064,
"bids": [{
"comp_note_id": 42,
"invoice_item_id": 42933,
"description": "Locks",
"qty": 1,
"uom": 0,
"contractor_price": 3,
"client_price": 4,
"comment": "lock comment",
"completion_comment": "completion lock comment"
}, {
"comp_note_id": 43,
"invoice_item_id": 42923,
"description": "Winterization (Dry)",
"qty": 2,
"uom": 1,
"contractor_price": 2,
"client_price": 0,
"comment": "winterization",
"completion_comment": "completion winterization"
}]
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
access_denied | Access token is invalid or expired | 401 |
scope_invalid | Client app does not have the required OAuth scope | 403 |
wo_invalid | Work order is invalid | 400 |