Skip to main content
GET
Get an invoice

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.

Path Parameters

id
integer<int64>
required

Invoice id

Response

Successful response

type
string
required

Entity type label, e.g. "Invoice". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object
required

Invoice in its external-API projection (InvoiceExternalAPI = full Invoice fields with buyerSupplierRelationship replaced by an external projection). Abridged - the full model carries approval-hierarchy, dispute and hydrated relation fields. For third-party suppliers responses are masked.

status
enum<string>
required

"ok" on success

Available options:
ok