Generate PDF for a change order (async)

POST

/change-orders/{id}/pdf

• Production

Enqueues an async PDF generation job. Poll /api/v1/jobs/{id} for status; GET /api/v1/jobs/{id}/download for the signed URL.

Authorizations

• bearerAuth
  change_orders:read jobs:write

Parameters

Path Parameters

id

required

integer

Header Parameters

Idempotency-Key

string

Responses

202

Job enqueued

object

data

required

object

job_id

required

string

status_url

required

string

meta

required

object

request_id

Server-generated request identifier

string

pagination

object

cursor

required

Opaque cursor for the next page; null when no more results

string | null

has_more

required

Whether more pages are available after this one

boolean

count

required

Items in this page

integer

400

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string

403

Error

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string