HQ Rental Software
  1. Reservations
HQ Rental Software
  • Authorization
  • Introduction
  • Guides
    • Booking Engine
      • Reservation Creation Flow
      • Reservation Update Flow
    • Toll Integration
      • Toll Integration Flow
  • Car Rental
    • Comments
      • Show a list of all the comments for an item
      • Creates a new comment
      • Updates a comment
      • Delete comment
      • Get Reservation comments
      • Update Reservation comments
      • Deletes a comment
    • Currencies
      • Returns all the currencies
    • Emails
      • Show a list of all email templates
      • Trigger an email template
      • Send reservation confirmation email by id
      • Send reservation contract email by id
      • Show a list of all applicable email templates for a reservation
      • Trigger an email template for a reservation
      • Store a quote and sends an email
    • Addresses
      • Shows a list of addresses
      • Create address
      • Finds address by id
      • Updates address by id
      • Delete address
    • Fields
      • Show a list of all fields for specific item_type
      • Show details of specific field
      • Show details of specific field
      • Show a list of all fields applicable for the customers in the reservations process
    • Blocked Days
      • List all blocked days
    • Customer Credits
      • List all credit transactions
      • Create a customer credit
      • Delete a credit transaction
      • Update a customer credit
    • Daily Manifest
      • shows mine dashboard
    • Fines
      • List all fines
      • Create a fine
      • Retrieve a fine
      • Update a fine
      • Deletes a fine
    • Packages
      • Shows a list of available package items
      • find a package item
      • Shows a list of available packages
      • find a package
    • Quotes
      • Shows a list of the reservation quotes in the system
      • Find a quote that matches the given ID
    • Rate Types
      • List all rate types
      • Updates a rate type
      • Creates a rate type
      • Find a specific rate type
      • Deletes a rate type
    • Rates
      • List all rates
      • Updates a rate
      • Creates a rate
      • Find a specific rate
      • Deletes a rates
      • List all rates v2
    • Reservation Attempts
      • Shows a list of reservation attempts
      • Find the reservation attempts based on a given email
    • Extensions
      • Show a list of all the extensions for a reservation
      • Creates an extension for one reservation
      • Deletes an extension
    • External Charges
      • Show a list of all the external charges for a reservation
      • Creates an external charge for one reservation
      • Deletes an external charge for one reservation
    • Adjustments
      • Show a list of all the adjustments made to a reservation
      • Creates an adjustment for one reservation
      • Deletes and adjustment for one reservation
    • Payments
      • Show a list of all the payments for a reservation
      • Creates a payment for one reservation
      • Updates a payment for one reservation
      • Initiate a refund of security deposit
      • Charges a credit card from customer's reservation
    • Refunds
      • Show a list of all the refunds for a reservation
      • Creates a refund for a reservation
      • Updates a refund for a reservation
      • Deletes a refund for a reservation
    • Reservations
      • Updates the status of a reservation to Open
        POST
      • Updates the status of a reservation to Cancel
        POST
      • Updates the status of a reservation to Pending
        POST
      • Updates the status of a reservation to Quote
        POST
      • Updates the status of a reservation to No Show
        POST
      • Returns the details and validations required for the dates step
        GET
      • Validates the dates and return a list of available classes for that period with the respective prices for each vehicle class
        POST
      • Updates the vehicle class of a reservation (Only Existing Bookings)
        POST
      • Returns a list of applicable additional charges based on the selection of dates, brand and vehicle class
        GET
      • Returns the price for the selection of charges and vehicle class
        POST
      • Creates or updates a customer in the system
        POST
      • Confirms and create the reservation in the system
        POST
      • Updates a reservation
        POST
      • shows a list of reservations
        GET
      • show rental agreement of specific reservation
        GET
      • Set date of sign
        GET
      • Find a specific reservation
        GET
      • Assign vehicle
        POST
      • Detach vehicle
        POST
      • Available Vehicles
        GET
      • Upload primary driver signature
        POST
      • Returns the available cars for a given location and reservation date range
        GET
    • Vehicle Replacements
      • Shows all vehicle replacements from a reservation
      • Creates a reservation vehicle replacement
      • Updates a reservation vehicle replacement
      • Deletes vehicle replacements from a reservation
    • Reservation Agents
      • Shows a list of available agents
      • Assign primary agent
      • Assign return agent
    • Seasons
      • Shows a list of available seasons
      • Creates a season
      • Find a specific season
      • Updates a season
      • Deletes a season
    • Security Deposits
      • Shows a list of security deposits
      • Shows an specific security deposit
    • Webhooks
      • Register a webhook
  • Filters
    • Returns an example of the allowed filters to the API
  • Preferences
    • Show a list of all preferences per module
  • Contacts
    • List all contact categories
    • List a specific contact category
    • List all contacts of a specific contact category
    • Create a new contact in the application.
    • List a specific contact
    • Update a contact in the application.
    • Merge contacts
  • files
    • Shows a list of files
    • upload file
    • Delete file
  • Fleets
    • Additional Charges
      • Shows a list of the additional charges
      • Returns a single additional charge
    • Features
      • Shows a list of features
      • Returns a single feature
    • Locations
      • Shows a list of locations
    • Blocked Periods
      • Shows a list of blocked periods for a vehicle
      • Create a blocked period for a vehicle
      • Update a blocked period for a vehicle
      • Deletes a blocked period
    • Branches
      • Shows a list of Vehicle Brands
      • Returns a single vehicle brand
    • Damages
      • Shows a list of vehicle damages
      • Create a damage for a vehicle
      • Show the details of a specific vehicle damage
      • Update a damage for a vehicle
    • Vehicles
      • Models
        • Shows a list of Vehicle Models
        • Returns a single vehicle model
      • Types
        • Shows a list of Vehicle Types
        • Returns a single vehicle type
      • Shows a list of vehicles
      • Show the details of a specific vehicle
      • Update Vehicle
      • Reserve vehicle
      • Cancel Reserve
    • Relocations
      • Shows a list of relocations
      • Create a relocation for a vehicle
      • Deletes a relocation
    • Telematics
      • Shows a list of the OBD history records of the vehicle
      • Shows a list of the OBD history records for all vehicles, receives a paramter with the last ID retrie ved and it returns all the records after that one
      • Shows a list of vehicle trips for the specified vehicle
  • Payment Gateways
    • Shows a list of credit cards for one customer
    • Delete payment gateway
    • Shows a list of payment methods
    • Finds payment method by ID
    • Returns payment method button
    • Returns payment method form
    • Finds payment transaction by UUID
    • shows a list of payment transactions
    • Create payment transaction
    • Refunds a payment transaction
    • Shows a list of stripe locations per gateway
    • Returns a connection token for a given location
    • Returns a connection token for stripe terminal
  • Sheets
    • Show a list of all items for specific sheet
    • Show details of sheet item
    • Update sheet item in the application
    • Create a new sheet item in the application
    • Show a list of all sheets
    • Show a list of all sheets
  1. Reservations

Confirms and create the reservation in the system

POST
/car-rental/reservations/confirm
Car Rental/Reservations

Request

Query Params
tour_operator_id
optional
ID of commission partner
tour_operator_client_pay_to
optional
If the clients pays at the commission partner
skip_confirmation_email
optional
If sending of confirmation email should be skipped
pick_up_date
required
Pick up date of the reservation. Format: yyyy-mm-dd
return_date
required
Return date of the reservation. Format: yyyy-mm-dd
pick_up_time
required
Pick up time of the reservation. Format: HH:ii
return_time
required
Return time of the reservation. Format: HH:ii
walk_in_customer
optional
Walking customer?
brand_id
required
Company Brand ID where the booking will be made
pick_up_location
optional
Pick up location. Optional if pickup location custom is present
return_location
optional
Return location. Optional if return location custom is present
pick_up_location_custom
optional
Pick up location custom. Optional if pickup location is present
return_location_custom
optional
Return location custom. Optional if return location is present
vehicle_class_id
required
Vehicle class ID
customer_id
optional
Customer ID
customer_first_name
optional
Customer First Name
customer_last_name
optional
Customer Last Name
customer_full_name
optional
Customer Full Name (send only if the first name and last name is not specified)
customer_email
optional
Customer Email
customer_phone_number
optional
Customer Phone Number
customer_street
optional
Customer Street Address
customer_street2
optional
Customer Street Address 2
customer_city
optional
Customer City
customer_zip
optional
Customer Zip
customer_country
optional
Customer Country Code (ISO alpha-2)
customer_state
optional
Customer State
customer_birthdate
optional
Customer Birthdate. Format: yyyy-mm-dd
customer_driver_license_number
optional
Customer Driver License Number
customer_driver_license_issue_date
optional
Customer Driver License Issue Date. Format: yyyy-mm-dd
customer_driver_license_expiration_date
optional
Customer Driver License Expiration Date. Format: yyyy-mm-dd
return_payment_link
optional
Flag to set if a transaction should be initiated
payment_method_id
optional
Payment method to use in the transaction
additional_charges
array[integer]
required
Array of selected additional charges. If the additional charge has a quantity the format should be id_quantity
includes_selected_by_default_additional_charges
optional
Whether or not it includes selected by default additional charges. (true or false)
currency
optional
Currency
distance_limit
optional
Distance limit for the reservation
distance_limit_day
optional
Distance limit for the reservation
distance_limit_week
optional
Distance limit for the reservation
distance_limit_month
optional
Distance limit for the reservation
rate_type_id
optional
Rate type for the reservation
rate_code
optional
Rate type for the reservation, this can be used in-place of rate_type_id
Header Params
Authorization
string 
required
Default:
{{AUTHENTICATION_TOKEN}}

Responses

🟢200OK
successful operation. The system returns the calculated price for the selection of additional charges
This response does not have a body.
🟠422Parameter Error
🔴500Server Error
Modified at 2025-04-17 15:17:28
Previous
Creates or updates a customer in the system
Next
Updates a reservation
Built with