changes.get
One change order with its lines, totals, status, signature and invoice.
When to use it
One change order with its lines, totals, status, signature and invoice.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
change_order_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/change-orders/get?change_order_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
change_order_id | string (uuid) | yes |
shop_id | string (uuid) | yes |
job_id | string (uuid) | yes |
number | integer | yes |
title | string | yes |
description | ['string', 'null'] | yes |
currency | string | yes |
subtotal_minor | integer | yes |
taxable_minor | integer | yes |
tax_rate_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
tax_name | ['string', 'null'] | yes |
tax_rate_bps | ['integer', 'null'] | yes |
tax_minor | integer | yes |
total_minor | integer | yes |
status | string | yes |
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 |
invoiced | boolean | yes |
created_by | string (uuid) | yes |
created_at | string (date-time) | yes |
lines | array | yes |
lines[].position | integer | yes |
lines[].description | string | yes |
lines[].quantity | number | yes |
lines[].unit_price_minor | integer | yes |
lines[].kind | string | yes |
lines[].taxable | boolean | yes |
lines[].amount_minor | integer | yes |
{
"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
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |