- Getting started
- Authentication
- Base URLs, regions and versioning
- Errors
- Responses and pagination
- HQ concepts and glossary
- Custom fields and item types
- Dates, time zones and money
- Filtering and incremental sync
- Guide: build a booking engine on your website
- Guide: connect an OTA or broker
- Guide: sync your fleet and prices to a website
- Guide: sync invoices and payments to accounting
- Guide: sync customers with a CRM
- Guide: take payments
- Guide: bill tolls and fines
- Rate limits and idempotency
- Webhooks
- Car Rental
- Comments
- Currencies
- Emails
- Addresses
- Fields
- Blocked Days
- Customer Credits
- Fines
- Packages
- Quotes
- Rate Types
- Rates
- Reservation Attempts
- Extensions
- External Charges
- Adjustments
- Payments
- Refunds
- Reservations
- Confirm a reservation
- Cancel a reservation
- Set a reservation to pending
- Set a reservation to quote
- Mark a reservation as no-show
- Mark a reservation as ready for pick-up
- Get the options for the dates step (booking step 1)
- Validate dates and list available vehicle classes (booking step 2)
- Change the vehicle class of a reservation
- List additional charges for a vehicle class (booking step 3)
- Price a vehicle class with selected charges (booking step 4)
- Create or update the booking customer (booking step 6)
- Create the reservation (booking step 8)
- Update a reservation
- List reservations
- Get the rental agreement link
- Mark the rental agreement as signed
- Get a reservation
- Assign a vehicle to a reservation
- Detach the vehicle from a reservation
- List the vehicles available for a reservation
- List the free vehicle class upgrades of a reservation
- Apply a free vehicle class upgrade
- Upload the driver signature
- Upload pick-up or return photos
- Search availability and prices for all vehicle classes
- List reservations (API v2)
- Vehicle Replacements
- Reservation Agents
- Seasons
- Security Deposits
- Availability
- Driver Licenses
- Filters
- Contacts
- Fleets
- Payment Gateways
- Sheets
- Files
- Inventory
- List inventory categories
- Get an inventory category
- Shows a list of inventory items
- Finds inventory item by id
- Finds inventory price by id
- shows a list of inventory purchase order
- Create purchase order
- Finds purchase order by id
- Returns report of purchase order
- Cancels purchase order by id
- Finds inventory stock by id
- Invoice
- List invoices available as e-invoices
- Download e-invoices
- Create invoice item
- List invoice payments
- Create an invoice payment
- Get an invoice payment
- Update an invoice payment
- Spread a payment over a contact's open invoices
- List invoices
- Create an invoice
- Get an invoice
- Email an invoice
- Void an invoice
- Download an invoice PDF
- Audit Logs
- Countries
- Taxes
- Users
- Products
- Schemas
- RequestBodies
- Money
- SaveRepairOrderLine
- ErrorBusinessRule
- SaveBlockedPeriod
- ErrorValidation
- SaveVehicleDamage
- ErrorNotFound
- ErrorUnauthorized
- ReservationSummary
- ReservationTotal
- AvailableVehicleClass
- AdditionalCharge
- ReservationOverview
- ReservationPayment
- FleetsPageInfo
- FleetsEmptySuccess
- VehicleDamage
- BillingAmount
- InvoiceLine
- ReservationRefund
- CustomField
- Comment
- PaginationFields
- Country
- CustomFieldAddress
- FilterDescriptor
- Tax
- VehicleClassAvailability
- CustomerCreditTransaction
- DriverLicenseData
- DriverLicenseResult
- Fine
- FineInput
- PackageItem
- Package
- Quote
- RateType
- RateTypeWrite
- RatePriceInterval
- RateRecord
- RateWrite
- ReservationAttempt
- ReservationExtension
- ReservationAdjustment
- ReservationStatusResult
- VehicleReplacement
- ReservationRecord
- ReservationListItem
- ReservationListPage
- ReservationDetail
- ReservationOverviewWithVehicles
- Season
- SeasonWrite
- SecurityDepositRule
- OtaVehicleClassAvailability
- RateV2
- ReservationDriverV2
- ReservationListItemV2
- ContactCategory
- Contact
- ContactInput
- AttachedFile
- FleetAdditionalCharge
- Branch
- VehicleFeature
- Location
- VehicleMaintenanceStatus
- RepairOrder
- ObdReading
- VehicleAlert
- VehicleTrip
- BlockedPeriod
- VehicleMake
- VehicleClassImage
- VehicleClassFeature
- VehicleClass
- VehicleRelocation
- VehicleType
- Vehicle
- InventoryCategory
- InvoicePayment
- Invoice
- InvoiceDetail
- SavedCreditCard
- PaymentGatewaySummary
- PaymentMethod
- PaymentTransaction
- ProductCategory
- Product
- SheetItem
- SheetItemInput
- Sheet
SecurityDepositRule
with_* flag set to true the rule applies only to the selected values; with false it applies to every other value.{
"id": 4,
"reservation_type": "car_rental.reservations",
"name": "Economy deposit",
"available": true,
"with_brand": true,
"brand_id": 1,
"with_pick_up_location": false,
"pick_up_location_id": null,
"with_return_location": false,
"return_location_id": null,
"with_vehicle_class": true,
"vehicle_classes": [
3
],
"with_additional_charge": false,
"additional_charges": null,
"with_tour_operator": false,
"tour_operators": null,
"with_rate_type": false,
"rate_types": null,
"amount": "string",
"currency": null,
"applicable_excess": "string",
"cumulative": false,
"effective_from": null,
"effective_until": null,
"label_for_website": {
"en": "Refundable security deposit"
},
"uuid": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
"created_at": "2026-01-10T15:00:00.000000Z",
"updated_at": "2026-01-10T15:00:00.000000Z"
}