HQ Rental Software
    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 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 the vehicle alerts
        • Shows a list of vehicle trips for the specified vehicle
      • 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

    Introduction

    HQ Rental Software is a complete fleet management software system, which incorporates real time availability, online reservation system and online payments.

    How to get an API key#

    API access is available for Professional or Enterprise subscriptions. For more details, visit our pricing page.
    If you already have a Professional or Enterprise subscription, you can enable API integration using an administrator account by following these steps:
    1- Ensure you are signed in as an administrator user. Then, navigate to Settings > Car Rental > Integrations:
    image-1.png
    2- In the Other Integrations table, find the row labeled “Custom Integration”:
    image-2.png
    3- Click the “Enable” button. A modal will appear with a brief explanation of what the system will do after enabling the integration. Confirm the action by clicking “Enable” again:
    image-3.png
    4- Once you click Enable, the system will:
    Create a new user called “Custom Integration.”
    Send an email to your administrator email address with the following information:
    The password for the “Custom Integration” user.
    The encoded token for the “Custom Integration” user.
    The base API URL.
    A Postman collection with sample requests (you'll need to include the encoded token for authorization).

    Time related fields#

    Time related fields return in the tenant system timezone. If you wish to return time in UTC, please open a support ticket, and our team will assist you to enable Users for UTC Dates on API.
    Modified at 2025-07-18 12:54:06
    Previous
    Authorization
    Next
    Reservation Creation Flow
    Built with