Saltar al contenido

Approve a invoice

Módulo Finance

POST/invoices/{id}/approveinvoices.approve

Records an approval decision on the invoice. Three-way match must pass, and a person who created the vendor or edited its bank details cannot approve payment to it. Spend authority and separation of duties are enforced in the approval RPC; a refusal returns 422 and names the rule. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad finance.invoice.approve.
  • Alcances de OAuth: finance.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

invoices.approve: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the invoice.

Respuesta 200: Invoice

invoices.approve: Invoice
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the invoice.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)SíIdentifier of the project.
direction"Payable" | "Receivable"SíWhether the invoice is owed or owing.
invoice_numberstring | nullSíInvoice number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
issued_onstring (date) | nullSíIssue date.
due_onstring (date) | nullSíDue date.
currency_codestringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
invoice_state"Proposed" | "Issued" | "Approved" | "Disputed" | "Canceled"SíInvoice state.
totalMoneyTotalSíA money aggregate that never coerces unpriced inputs to zero.
counterparty_idstring (uuid) | nullSíIdentifier of the counterparty billed or billing; null for an individual payee.
payee_person_idstring (uuid) | nullSíIdentifier of the person billing as an individual.
engagement_idstring (uuid) | nullSí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 POST "$XOS_BASE_URL/invoices/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/approve" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.invoices.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.invoices.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos invoices approve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f