Invoice
/api/v1/finance/invoicesAn invoice issued by or to the org.
listgetcreateupdatepaySchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| number | string | Human-readable unique invoice number (e.g. 'INV-2026-0042'). |
| type | string | 'customer' = accounts receivable (AR); 'supplier' = accounts payable (AP). |
| status | string | Lifecycle status of the invoice. |
| account_id | uuid | UUID of the customer Account (used when type='customer'). |
| vendor_id | uuid | UUID of the Vendor (used when type='supplier'). |
| issue_date | date-time | ISO 8601 date the invoice was issued. |
| due_date | date-time | ISO 8601 date the payment is due. |
| paid_date | date-time | ISO 8601 date the invoice was fully paid. Null if unpaid. |
| currency | string | ISO 4217 three-character currency code. |
| subtotal | number | Sum of all line item amounts before tax and discounts. |
| tax_amount | number | Total tax amount applied to the invoice. |
| discount_amount | number | Total discount amount applied to the invoice. |
| total | number | Final total: subtotal + taxAmount - discountAmount. |
| line_items | json | Ordered list of line items that make up this invoice. |
| notes | string | Free-form notes or payment terms shown on the invoice. |
| project_id | uuid | UUID of the Project this invoice is billed against. |
| contract_id | uuid | UUID of the Contract that authorises this invoice. |
| document_ref | string | MinIO path or external URL of the invoice PDF or document. |
| created_by_id | uuid | UUID of the Person who created this invoice. |
| counterparty_id | uuid | Customer (AR) or vendor (AP) the invoice is with. |
| direction | enum | receivable | payableAR (we are owed) vs AP (we owe). |
| amount | number | Invoice total. |
| paid_at | date-time | ISO 8601 timestamp the invoice was paid. |
| po_id | uuid | Purchase order this invoice bills against. |
| tags | json | Free-form tags for grouping and filtering. |
API
client.finance.invoices.*Loading manifest…