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/invoice/items

This action lists all active invoice items for which bids can be created.

Request

FieldDescriptionRequired
report_idUnique identifier for a work orderYes

Example:

{
  "report_id": 4064
}
curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -d '{"report_id": 4064}' \
     https://ppw.web/svc/bid/invoice/items

Response

FieldDescriptionType
report_idUnique identifier for a work ordernumber
invoice_itemsInvoice itemsarray

Each item in invoice_items is a JSON object; they’ll have the following fields:

FieldDescriptionType
invoice_item_idUnique identifier for the invoice itemnumber
descriptionName of the invoice itemstring
client_priceClient price for the itemnumber
contractor_priceContractor price for the itemnumber
uomDefault Unit of Measure (UOM)number

The client_price and contractor_price for a invoice item are specific to the work order specified in the request.

Example successful response:

{
  "report_id": 4064,
  "invoice_items": [{
    "invoice_item_id": "42921",
    "description": "Locks-Padlocks",
    "client_price": 3,
    "contractor_price": 2,
    "uom": 1
  }, {
    "invoice_item_id": "42922",
    "description": "J120\/INSP:  Exterior Inspection - Biweekly",
    "client_price": 2.9,
    "contractor_price": 3.4,
    "uom": 1
  }, {
    "invoice_item_id": "42923",
    "description": "Winterization (Dry)",
    "client_price": 30.0,
    "contractor_price": 40.0,
    "uom": 0
  }, {
    "invoice_item_id": "42924",
    "description": "Winterization (Wet)",
    "client_price": 15.0,
    "contractor_price": 30.20,
    "uom": 1
  }]
}

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403
wo_invalidWork order is invalid400