Create a payment application

Módulo Finance

POST/payment-applicationspaymentApplications.create

A payment applied to an invoice. Billed-to-date counts each payment once. Creates a payment application. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PaymentApplicationCreate

paymentApplications.create: PaymentApplicationCreate
Campo	Tipo	Obligatorio	Descripción
invoice_id	string (uuid)	Sí	Identifier of the invoice.
amount_minor	integer (int64)	Sí	Amount applied. Integer minor units of the document currency.Restricciones: range 1 to any
payment_id	string (uuid)	Sí	Identifier of the payment applied.

{
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 108000,
  "payment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: PaymentApplication

paymentApplications.create: PaymentApplication
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payment application.
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.
invoice_id	string (uuid)	Sí	Identifier of the invoice.
paid_on	string (date)	Sí	Payment date.
amount_minor	integer (int64) \| null	Sí	Amount applied. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
external_ref	string \| null	Sí	Bank or card reference.Restricciones: length 1 to 300
payment_id	string (uuid)	Sí	Identifier of the payment applied.

{
  "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",
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "paid_on": "2026-10-08",
  "amount_minor": 108000,
  "currency_code": "USD",
  "external_ref": "ACH-77812",
  "payment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/payment-applications" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","amount_minor":108000,"payment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.paymentApplications.create({
    "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "amount_minor": 108000,
    "payment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.payment_applications.create({"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "amount_minor": 108000, "payment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos payment-applications create --data '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","amount_minor":108000,"payment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'