Record a payment

Módulo Finance

POST/invoices/{id}/record-paymentinvoices.recordPayment

Records that an approved payable (or issued receivable) was paid: a Proposed payment of the invoice's payee, its counterparty or the person engaged as an individual, applied to the invoice for the whole balance unless `amount_minor` says otherwise. Money moves on the org's own rails; XOS never holds funds. Another eligible person approves the payment. Refuses a Proposed, Disputed or Canceled invoice and an invoice with nothing left to pay (422). 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.payment.write.
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.recordPayment: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the invoice.

Cuerpo de la solicitud: InvoicePaymentRequest

invoices.recordPayment: InvoicePaymentRequest
Campo	Tipo	Obligatorio	Descripción
paid_on	string (date)	Sí	Date the money moved.
amount_minor	integer (int64) \| null	No	Amount paid; the whole balance when null or omitted. Integer minor units of the document currency.Restricciones: range 1 to any
reference	string	No	Remittance reference from the bank or payout provider.Restricciones: length 1 to 200

{
  "paid_on": "2026-10-08",
  "amount_minor": 349000,
  "reference": "ACH-2027-0042"
}

Respuesta 200: Invoice

invoices.recordPayment: 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 POST "$XOS_BASE_URL/invoices/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/record-payment" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"paid_on":"2026-10-08","amount_minor":349000,"reference":"ACH-2027-0042"}'

const { data } = await xos.invoices.recordPayment("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "paid_on": "2026-10-08",
    "amount_minor": 349000,
    "reference": "ACH-2027-0042"
  });

response = xos.invoices.record_payment("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"paid_on": "2026-10-08", "amount_minor": 349000, "reference": "ACH-2027-0042"})

xos invoices record-payment 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"paid_on":"2026-10-08","amount_minor":349000,"reference":"ACH-2027-0042"}'