Spread a payment over a contact's open invoices

Records one payment from a contact and spreads it over that contact's unpaid invoices (status draft, sent or partial). Unpaid credit notes and refund documents can also receive part of it. Each invoice receives up to its unpaid amount until the payment is used up, and one payment record is created per invoice. The order in which invoices are filled is not guaranteed. Any amount left after every open balance is covered is not recorded.

Each invoice that receives a payment is recalculated: its status changes and the matching webhook fires, as in "Create an invoice payment". No payment email is sent and the payment is not added to a linked reservation.

Responses

🟢200OK

application/json

The invoices that received part of the payment, under the invoices key, or [] when no invoice received anything. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "invoices": [
        {
            "id": 1024,
            "invoice_number": 1024,
            "prefix": "INV-",
            "full_number": "INV-001024",
            "uuid": "4b0d2f7e-8a51-4c3e-9f0a-2d6c1e9b7a35",
            "status": "paid",
            "type": "invoice",
            "issued_on": "2026-10-06T00:00:00.000000Z",
            "due_date": "2026-11-05T00:00:00.000000Z",
            "paid_on": "2026-10-06T00:00:00.000000Z",
            "po_number": "PO-7781",
            "currency": "usd",
            "contact_type": "contacts",
            "contact_id": 30,
            "label": "Jane Doe",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "tax_id": 2,
            "tax_name": "Sales tax",
            "subtotal": "250.0000",
            "total_tax": "17.5000",
            "total_discount": "0.0000",
            "total_amount": "267.5000",
            "total_paid": "267.5000",
            "notes": "Thank you for your business.",
            "terms": "Payment due within 30 days.",
            "item_type": "car_rental.reservations",
            "item_id": 1052,
            "created_at": "2026-10-06T14:02:11.000000Z",
            "updated_at": "2026-10-06T15:20:43.000000Z"
        }
    ]
}

🟠422Parameter Error

Spread a payment over a contact's open invoices

Request

Responses