Private preview of the new site. Not live.

changes.get

One change order with its lines, totals, status, signature and invoice.

WhoAgents can call this
RESTGET /v1/change-orders/get
MCP toolchanges_get
Writesno
AreaField work (checklists, forms, time, notes, change orders, subcontractors)

When to use it

A change order is a priced change to a job's scope: extra work, or a credit for work taken out. A worker writes the lines (changes.create; never fill prices in yourself).

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
change_order_idstring (uuid)yes

Example

GET https://doingwork.work/v1/change-orders/get?change_order_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
change_order_idstring (uuid)yes
shop_idstring (uuid)yes
job_idstring (uuid)yes
numberintegeryes
titlestringyes
description['string', 'null']yes
currencystringyes
subtotal_minorintegeryes
taxable_minorintegeryes
tax_rate_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
tax_name['string', 'null']yes
tax_rate_bps['integer', 'null']yes
tax_minorintegeryes
total_minorintegeryes
statusstringyes
signature_request_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
signature_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
sent_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
approved_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
cancelled_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
cancel_reason['string', 'null']yes
invoice_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
invoicedbooleanyes
created_bystring (uuid)yes
created_atstring (date-time)yes
linesarrayyes
lines[].positionintegeryes
lines[].descriptionstringyes
lines[].quantitynumberyes
lines[].unit_price_minorintegeryes
lines[].kindstringyes
lines[].taxablebooleanyes
lines[].amount_minorintegeryes
{
  "change_order_id": "00000000-0000-4000-8000-000000000000",
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "job_id": "00000000-0000-4000-8000-000000000000",
  "number": 1,
  "title": "...",
  "description": "40 gallon gas heater, installed",
  "currency": "...",
  "subtotal_minor": 50000,
  "taxable_minor": 50000,
  "tax_rate_id": "00000000-0000-4000-8000-000000000000",
  "tax_name": "...",
  "tax_rate_bps": "...",
  "tax_minor": 50000,
  "total_minor": 50000,
  "status": "...",
  "signature_request_id": "00000000-0000-4000-8000-000000000000",
  "signature_id": "00000000-0000-4000-8000-000000000000",
  "sent_at": "...",
  "approved_at": "...",
  "cancelled_at": "...",
  "cancel_reason": "...",
  "invoice_id": "00000000-0000-4000-8000-000000000000",
  "invoiced": true,
  "created_by": "00000000-0000-4000-8000-000000000000",
  "created_at": "...",
  "lines": [
    {
      "position": 1,
      "description": "40 gallon gas heater, installed",
      "quantity": "...",
      "unit_price_minor": 50000,
      "kind": "...",
      "taxable": true,
      "amount_minor": 50000
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.