Create an invoice
Finance module
POST/invoicesinvoices.create
An invoice issued or received. A closed production refuses new invoices. Creates an invoice. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability finance.invoice.write.
- OAuth scopes: finance.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: InvoiceCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| direction | "Payable" | "Receivable" | Yes | Whether the invoice is owed or owing. |
| invoice_number | string | null | No | Invoice number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| issued_on | string (date) | null | No | Issue date. |
| due_on | string (date) | null | No | Due date. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| counterparty_id | string (uuid) | null | No | Identifier of the counterparty billed or billing; null for an individual payee. |
| engagement_id | string (uuid) | null | No | Identifier of the engagement the invoice bills. |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"direction": "Payable",
"invoice_number": "INV-2026-0042",
"issued_on": "2026-10-08",
"due_on": "2026-10-08",
"currency_code": "USD",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: Invoice
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the invoice. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| direction | "Payable" | "Receivable" | Yes | Whether the invoice is owed or owing. |
| invoice_number | string | null | Yes | Invoice number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| issued_on | string (date) | null | Yes | Issue date. |
| due_on | string (date) | null | Yes | Due date. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| invoice_state | "Proposed" | "Issued" | "Approved" | "Disputed" | "Canceled" | Yes | Invoice state. |
| total | MoneyTotal | Yes | A money aggregate that never coerces unpriced inputs to zero. |
| counterparty_id | string (uuid) | null | Yes | Identifier of the counterparty billed or billing; null for an individual payee. |
| payee_person_id | string (uuid) | null | Yes | Identifier of the person billing as an individual. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement the invoice bills. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"direction": "Payable",
"invoice_number": "INV-2026-0042",
"issued_on": "2026-10-08",
"due_on": "2026-10-08",
"currency_code": "USD",
"invoice_state": "Proposed",
"total": {
"total_minor": 1250000,
"currency": "USD",
"unpriced_count": 2
},
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"payee_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/invoices" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","direction":"Payable","invoice_number":"INV-2026-0042","issued_on":"2026-10-08","due_on":"2026-10-08","currency_code":"USD","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.invoices.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"direction": "Payable",
"invoice_number": "INV-2026-0042",
"issued_on": "2026-10-08",
"due_on": "2026-10-08",
"currency_code": "USD",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.invoices.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "direction": "Payable", "invoice_number": "INV-2026-0042", "issued_on": "2026-10-08", "due_on": "2026-10-08", "currency_code": "USD", "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos invoices create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","direction":"Payable","invoice_number":"INV-2026-0042","issued_on":"2026-10-08","due_on":"2026-10-08","currency_code":"USD","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'