Update a refund - HQ Rental Software

Replaces the form values of a refund, with the same body as POST /car-rental/reservations/{reservation_id}/refunds.

Send every form field. A field left out of the body is cleared, and required fields left out fail. An id that does not exist creates a new refund on this reservation, with the side effects of POST (including the refund_created revision and the credit note).

The body is your Refunds form. Field IDs are different in every account: list them with GET /fields?item_type=car_rental.reservation_refunds and send each one as field_<id>. The default form has a refund method (refund_type), date (date), amount (amount) and reference (reference) field, all required. The IDs in the example are placeholders. Keys that are not fields of the form, such as amount, are ignored.

Side effects

Recalculates the reservation balance.

When customer credits are enabled and the refund method is one of your customer credit methods, the amount is added to the customer's credit balance.

The refund is returned under data.payment.

An unknown numeric reservation_id does not return 404. An unknown UUID returns 404.

Request

Authorization

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "field_69": "Cash",
    "field_70": "2026-12-06",
    "field_72": 50,
    "field_73": "Goodwill refund",
    "send_confirmation_email": 0,
    "property1": null,
    "property2": null
}

Responses

🟢200OK

application/json

The refund was updated, or a business error keyed by the form field: field_<id>, or field_<id>_year, field_<id>_month and field_<id>_day for a date field. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "reservation": {
            "id": 1052,
            "header": "Jane Doe - RA #1052",
            "pick_up_date": "2026-12-01 10:00:00",
            "return_date": "2026-12-05 10:00:00",
            "flight_arrival_date": "2026-12-01 10:00:00",
            "flight_departure_date": "2026-12-05 10:00:00",
            "flight_number": "AA1234",
            "flight_departure_number": "",
            "pick_up_location": {
                "id": 1,
                "name": "Miami Airport",
                "timezone": "America/New_York"
            },
            "return_location": {
                "id": 1,
                "name": "Miami Airport",
                "timezone": "America/New_York"
            },
            "vehicle_class_id": 3,
            "customer_id": 4821,
            "public_link": "",
            "comments": [
                {
                    "id": 0,
                    "comment": "string",
                    "created_by": "string",
                    "created_at": "string",
                    "created_at_diff_with_now": "2 hours ago"
                }
            ],
            "distance_limits": {
                "distance_allowed": 0,
                "distance_limit_per_day": 0,
                "distance_unit": "string",
                "distance_unlimited": true,
                "distance_extra_price": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "180.00",
                    "usd_amount": "180.00",
                    "amount_for_display": "$180.00"
                },
                "distance_extra_price_with_tax": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "180.00",
                    "usd_amount": "180.00",
                    "amount_for_display": "$180.00"
                }
            },
            "distance_driven": 0,
            "property1": "string",
            "property2": "string"
        },
        "payment": {
            "id": 233,
            "reservation_type": "car_rental.reservations",
            "reservation_id": 1052,
            "amount": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "180.00",
                "usd_amount": "180.00",
                "amount_for_display": "$180.00"
            },
            "label": "DEP-1052 - Cash",
            "reference": "DEP-1052",
            "refund_type": "Cash",
            "date": "2026-12-06",
            "created_by": "Alex Smith",
            "transaction": {}
        }
    }
}

🟠404Record Not Found