Skip to main content
POST
Mark the invoice for a work order as paid

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Body

application/json
workOrderId
string
required

Work order id or external work order id.

Response

Success.

type
string
required

Entity type marker, e.g. "Invoice".

data
object
required

Invoice (external API projection). Every invoice is anchored to exactly one of workOrderId or projectId; the other side (plus its hydrated object) is null. Project invoices skip work-order-anchored behaviour: NTE check, GL-code derivation, budget spend, WO status sync, asset spend mirror, WO-detail PDF, WO-anchored approval hierarchies and notifications, per-WO duplicate check, and tax-line currency validation. locationId and buyerFacilityId may be null on project invoices; when null, the invoice is excluded from cost-by-location and cost-by-facility analytics respectively. ABRIDGED: further fields (invoice type templates, custom field values, approval hierarchy, revision changes, AI-parse metadata, watermarked PDFs) may appear. On external responses buyerSupplierRelationship additionally carries vendorCode.

status
enum<string>
required
Available options:
ok