Create a payment application
Finance module
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.
- Requires the capability finance.payment.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: PaymentApplicationCreate
| Field | Type | Required | Description |
|---|---|---|---|
| invoice_id | string (uuid) | Yes | Identifier of the invoice. |
| amount_minor | integer (int64) | Yes | Amount applied. Integer minor units of the document currency.Constraints: range 1 to any |
| payment_id | string (uuid) | Yes | Identifier of the payment applied. |
{
"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"amount_minor": 108000,
"payment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: PaymentApplication
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payment application. |
| 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. |
| invoice_id | string (uuid) | Yes | Identifier of the invoice. |
| paid_on | string (date) | Yes | Payment date. |
| amount_minor | integer (int64) | null | Yes | Amount applied. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| external_ref | string | null | Yes | Bank or card reference.Constraints: length 1 to 300 |
| payment_id | string (uuid) | Yes | 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"
}Code samples
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"}'