Update an invoice

Módulo Finance

PATCH/invoices/{id}invoices.update

An invoice issued or received. A closed production refuses new invoices. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad finance.invoice.write.
Alcances de OAuth: finance.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

invoices.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the invoice.

Cuerpo de la solicitud: InvoiceUpdate

invoices.update: InvoiceUpdate
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	No	Identifier of the project.
invoice_number	string \| null	No	Invoice number.Restricciones: 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	No	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "invoice_number": "INV-2026-0042",
  "issued_on": "2026-10-08",
  "due_on": "2026-10-08",
  "currency_code": "USD"
}

Respuesta 200: Invoice

invoices.update: Invoice
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the invoice.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
direction	"Payable" \| "Receivable"	Sí	Whether the invoice is owed or owing.
invoice_number	string \| null	Sí	Invoice number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
issued_on	string (date) \| null	Sí	Issue date.
due_on	string (date) \| null	Sí	Due date.
currency_code	string	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
invoice_state	"Proposed" \| "Issued" \| "Approved" \| "Disputed" \| "Canceled"	Sí	Invoice state.
total	MoneyTotal	Sí	A money aggregate that never coerces unpriced inputs to zero.
counterparty_id	string (uuid) \| null	Sí	Identifier of the counterparty billed or billing; null for an individual payee.
payee_person_id	string (uuid) \| null	Sí	Identifier of the person billing as an individual.
engagement_id	string (uuid) \| null	Sí	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"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/invoices/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","invoice_number":"INV-2026-0042","issued_on":"2026-10-08","due_on":"2026-10-08","currency_code":"USD"}'

const { data, etag } = await xos.invoices.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "invoice_number": "INV-2026-0042",
    "issued_on": "2026-10-08",
    "due_on": "2026-10-08",
    "currency_code": "USD"
  }, { ifMatch: etag });

response = xos.invoices.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "invoice_number": "INV-2026-0042", "issued_on": "2026-10-08", "due_on": "2026-10-08", "currency_code": "USD"}, if_match=etag)

xos invoices update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","invoice_number":"INV-2026-0042","issued_on":"2026-10-08","due_on":"2026-10-08","currency_code":"USD"}' --if-match auto