HQ concepts and glossary
Fleet and locations
| Term | What it means | Endpoints |
|---|---|---|
| Branch | A business unit of your account with its own currency, taxes, locations, vehicle classes and seasons. HQ shows it as "Branch", but the API calls it brand, so records refer to it as brand_id. | brand_id on locations, seasons and reservations |
| Location | A pick-up and return place that belongs to one branch. With multiple time zones enabled, it can have its own time zone. | GET /fleets/locations |
| Vehicle class | The category customers book, for example "Compact SUV". Rates and availability are per class. A reservation is made for a class, and a vehicle is assigned later. | vehicle_class_id on vehicles, rates and reservations |
| Vehicle | A physical unit with plate, VIN and odometer, in one main vehicle class. | GET /fleets/vehicles |
| Vehicle type | The body type of a vehicle, such as car, van or motorcycle. It defines the damage diagram and fuel defaults, not the price. | GET /fleets/vehicle-types |
| Vehicle make and model | The manufacturer (for example Toyota) and the model of a vehicle. The API calls makes vehicle brands; do not confuse them with branches. | GET /fleets/vehicle-brands, GET /fleets/vehicle-models |
Pricing
| Term | What it means | Endpoints |
|---|---|---|
| Season | A date range of a branch with its own rates and rental period limits. | /car-rental/seasons |
| Rate type | A pricing plan with a rate code, such as a standard, prepaid or corporate rate. Rate types are optional. | /car-rental/rate-types |
| Rate | The price of one vehicle class in one season, for one rate type when rate types are used. | /car-rental/rates |
| Additional charge | Anything added to the base price: insurance, extras such as a child seat, fees and taxes. Some are mandatory. In the booking flow you select one as id or id_quantity, for example 8_2 for two units of charge 8. | GET /fleets/additional-charges |
| Security deposit | An amount held as a guarantee, with an optional excess. Rules decide the amount by branch, vehicle class, location, rate type and other conditions. | GET /car-rental/security-deposits |
Customers
| Term | What it means | Endpoints |
|---|---|---|
| Contact | A person or company in Contacts. A contact can belong to several contact categories. | /contacts/categories/{category_id}/contacts |
| Customer | The contact who books a reservation. Customers are contacts in the category your account uses for customers. | /contacts/categories/{category_id}/contacts |
| Driver | A contact who drives on a reservation: one primary driver and optional additional drivers. Unless your account allows a different primary driver, the customer is the primary driver. | POST /car-rental/reservations/confirm |
Reservation statuses
| Status | Meaning |
|---|---|
quote | A price indication for the customer; it does not hold availability. |
pending | Waiting for an action, for example an online payment. |
pending-reserved | An online booking made without payment; if no payment arrives in time, it moves to pending and the vehicle is no longer held. |
open | A confirmed booking waiting for pick-up, paid or unpaid. |
rental | The vehicle is out with the customer. |
completed | The vehicle is back and the reservation is closed. |
cancelled | Cancelled. |
cancelled-paid | Cancelled, and the balance including the cancellation fee is paid. |
no-show | The customer did not pick up the vehicle. |
no-show-paid | No show, and the balance including the no-show fee is paid. |
cancelled becomes cancelled-paid, and no-show becomes no-show-paid, when a payment or refund recorded in HQ or through the API leaves no outstanding balance.Pick-up (
rental) and return (completed) are done in HQ.Status changes through the API
| Endpoint | Allowed from | Result and side effects |
|---|---|---|
POST /car-rental/reservations/{reservation_id}/open | quote, pending, pending-reserved | Becomes open. The user needs the permission to put reservations on paid/open (HTTP 403 otherwise), and availability is checked again. Sends the Created webhook, not car_rental_reservation_confirmed. |
POST /car-rental/reservations/{reservation_id}/pending | open, quote, pending-reserved, cancelled, cancelled-paid, no-show, no-show-paid | Becomes pending. Open online payment transactions are cancelled and the vehicle is unassigned. |
POST /car-rental/reservations/{reservation_id}/quote | open, pending, cancelled, cancelled-paid, no-show, no-show-paid | Becomes quote. Cancellation and no-show fees are cleared and the vehicle is unassigned. |
POST /car-rental/reservations/{reservation_id}/cancelled | open, quote, pending, pending-reserved, no-show, no-show-paid, cancelled-paid | Becomes cancelled. HQ calculates the cancellation fee from your cancellation policy, unassigns the vehicle and sends the cancellation email according to your email settings. |
POST /car-rental/reservations/{reservation_id}/no-show | open | Becomes no-show. HQ calculates the no-show fee and unassigns the vehicle. From any other status nothing changes, but the response is still a success, so check status in the response. |
POST /car-rental/reservations/{reservation_id}/ready-for-pickup | open | Stays open and is marked ready for pick-up. |
no-show, a status change that is not allowed returns HTTP 200 with "success": false and status_code 410 (see Errors) and leaves the reservation unchanged.Every status change sends the
car_rental_reservation_status_updated webhook event (see Webhooks).Modified at 2026-10-29 13:56:40