HQ Rental Software
  1. Booking Engine
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
      • Updates the status of a reservation to Cancel
      • Updates the status of a reservation to Pending
      • Updates the status of a reservation to Quote
      • Updates the status of a reservation to No Show
      • Returns the details and validations required for the dates step
      • Validates the dates and return a list of available classes for that period with the respective prices for each vehicle class
      • Updates the vehicle class of a reservation (Only Existing Bookings)
      • Returns a list of applicable additional charges based on the selection of dates, brand and vehicle class
      • Returns the price for the selection of charges and vehicle class
      • Creates or updates a customer in the system
      • Confirms and create the reservation in the system
      • Updates a reservation
      • shows a list of reservations
      • show rental agreement of specific reservation
      • Set date of sign
      • Find a specific reservation
      • Assign vehicle
      • Detach vehicle
      • Available Vehicles
      • Upload primary driver signature
      • Returns the available cars for a given location and reservation date range
    • 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
  • 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 maintenance history records for a vehicle
      • 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 parameter with the last ID retrieved and it returns all the records after that one
      • Shows a list of the vehicle alerts
      • Shows a list of vehicle trips for the specified vehicle
    • Maintenance
    • Shows the list of repair orders
  • 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
  • Files
    • Shows a list of files
    • upload file
    • Delete file
  1. Booking Engine

Reservation Update Flow

Below are the updates you can make to a reservation, as well as how you can add an offline payment or charge an existing card.

Change Dates#

POST /car-rental/reservations/{id}/update
Update the dates of a reservation. Below is an example of the body params that can be sent:
pick_up_date: 2025-06-25
pick_up_time: 08:00:00
return_date: 2025-06-30
return_time: 08:00:00

Change Locations#

POST /car-rental/reservations/{id}/update
Update the pickup and return location of a reservation.
Send the location ID to update the location:
pick_up_location: 1
return_location: 1
If it is a custom location, pick_up_location and return_location should have the custom value, and the custom pickup/return location address can be passed in pick_up_location_custom and return_location_custom.
pick_up_location: custom
pick_up_location_custom: Custom Pickup Location Address
return_location: custom
return_location_custom: Custom Return Location Address

Change Vehicle Class#

POST /car-rental/reservations/{id}/update
Update the vehicle class of a reservation. Pass the vehicle_class_id, and if it is a free vehicle class upgrade, pass the free_upgrade key too.
vehicle_class_id: 2
free_upgrade: 1

Change Additional Charge#

POST /car-rental/reservations/{id}/update
Updates the additional charges of a reservation.
If the additional charge ID 5 was not selected, and you wish to add 2 quantities of this charge, you may add it this way:
additional_charges[]: 5_2
If the additional charge ID 4 was selected, and you wish to deselect it, you may deselect it by specifying the additional charge ID and the quantity 0. Make sure to also pass the additional charges that wish to remain being selected.
additional_charges[]: 4_0

Change Customer#

POST /car-rental/reservations/{id}/update
Change the customer of a reservation by passing the customer ID of the new customer.
customer_id: 25

Add Offline Payment#

POST /car-rental/reservations/{reservation_id}/payments
Creates an offline payment for a reservation.
These query params are supported in a default system:
field_29: Payment Type. Options: payment or authorization.
field_31: Payment Method. Default options: Credit Card, Bank Transfer, Maestro, Cash, Customer Credit.
field_32: Payment Date. Format: YYYY-MM-DD.
field_37: Payment Status. Default options: Approved, Denied.
field_34: Payment Amount.
field_35: Reference.
If your system has the Payments Form customized or modified, you can go to Settings > Car Rental > Forms > Payments Form, and review the form fields.
image.png
Go to Settings > Items > Fields, and search for form field label. The # column is the field ID. If you have issues finding the field_id , you can open a support ticket to ask for assistance.
image.png

Charge Existing Card#

POST /car-rental/reservations/{id}/payments/charge-credit-card
Charges the most recent saved card of the customer correlated to the reservation.
These query params are supported:
amount: charge amount
skip_payment_email: true
send_payment_request: true, flag for sending payment request if the payment fails
skip_payment_request_email:true
Modified at 2025-04-11 14:11:40
Previous
Reservation Creation Flow
Next
Toll Integration Flow
Built with