Create an invoice payment

Records a payment received for an invoice, for example a bank transfer. This does not charge the customer: to take a card payment, use the Payment Gateways endpoints.

Side effects. HQ recalculates the invoice: it becomes paid when the payments cover the total, partial when they cover part of it, and sent when nothing is paid (a voided invoice keeps its status, and a draft with no payments stays a draft). When the status changes, the account's invoice_paid, invoice_partially_paid or invoice_sent webhook fires. When the invoice is paid or partial afterwards, every call queues a payment email to the invoice contact if the account has set up the email for that status. A payment on an invoice raised for a reservation is also recorded on the reservation, and can confirm a quote or pending reservation, which can send its confirmation email and fire its confirmed webhook. Unless payment emails are disabled in the car rental settings, the renter is also emailed a payment receipt.

Responses

🟢200OK

application/json

The payment under the invoices_payment key. 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_payment": {
        "id": 88,
        "invoice_id": 1024,
        "contact_id": 30,
        "type": "payment",
        "paid_on": "2026-10-06T00:00:00.000000Z",
        "method": "bank",
        "notes": "Wire ref 4471",
        "amount_paid": "100.0000",
        "currency": "usd",
        "uuid": "0c5e2a71-3d4f-4b8a-9e6c-7f1b2a9d8e40"
    }
}

🟠404Record Not Found

🟠422Parameter Error

Request

Responses