Replace the vehicle of a rental - HQ Rental Software

Swaps the vehicle of a rental that is already out (status rental), for example after a breakdown. The current vehicle assignment is closed and a new one is opened with replacement_vehicle_id until the return date.

Rules

The reservation must be in rental status.

replacement_vehicle_id must belong to new_vehicle_class_id, be in a status that can be rented out, and be different from the current vehicle.

new_vehicle_fuel_level, new_vehicle_odometer and replacement_comments are required when fuel tracking, odometer tracking or mandatory replacement comments are enabled in your settings (422 otherwise).

Side effects

With free_change false and a different class, the rest of the rental is repriced at the new class. With free_change true (default), the price does not change.

Saves a vehicle_replaced revision of the rental agreement.

Business errors are returned under errors.message, keyed by field. Send the numeric reservation ID: the UUID is not accepted here.

Request

Authorization

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "new_vehicle_class_id": 3,
    "replacement_vehicle_id": 52,
    "new_vehicle_fuel_level": 8,
    "new_vehicle_odometer": 20410,
    "replacement_comments": "Flat tire",
    "free_change": true,
    "include_commission": false
}

Responses

🟢200OK

application/json

The replacement that was created (directly in data), or a business error. 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": false,
    "status_code": 410,
    "errors": {
        "message": {
            "status": [
                "Replacement not allowed for this booking status"
            ]
        },
        "error_message": ""
    },
    "data": []
}

🟠404Record Not Found

🟠422Parameter Error