Automating Online Reservation Flows with HQ Rental Software’s API

Manual bookings slow teams down, create pricing inconsistencies, and leave customers guessing. Automating Online Reservation Flows with HQ Rental Software’s API lets you deliver real-time availability, accurate pricing, instant confirmations, and seamless payments—without extra admin work.

In this guide, you’ll learn how to design an end-to-end online reservation experience with HQ’s API, from authentication and availability to pricing, confirmation emails, contracts, assignments, payments, and refunds.

What you can automate with HQ Rental Software’s API

HQ Rental Software provides a comprehensive set of endpoints to power a modern booking experience. You can automate:

• Availability and pricing
  • Return the details and validations for the dates step.
  • Validate dates to list available vehicle classes with respective prices.
  • Return applicable additional charges based on dates, brand, and class.
  • Return the price for selected charges and vehicle class.
• Customer and reservation lifecycle
  • Create or update a customer.
  • Confirm and create the reservation.
  • Update a reservation and manage statuses: Open, Cancel, Pending, Quote, No Show.
  • Show the rental agreement for a specific reservation and set date of sign.
  • Upload the primary driver signature.
• Vehicle assignment and readiness
  • Assign or detach a vehicle.
  • Mark the reservation as ready for pickup.
  • Return available cars for a given location and date range.
  • List classes for free upgrades and apply a free vehicle class upgrade.
  • Handle vehicle replacements (create, update, delete).
• Payments, invoices, and deposits
  • Show and create payments for a reservation; update a payment.
  • Charge a credit card from the customer’s reservation.
  • Initiate and refund online security deposits.
  • Manage refunds (list, create, update, delete).
  • Create and update invoices; attach payments; send email; void a sent invoice.
• Communications and quotes
  • Show email templates; trigger templates.
  • Send reservation confirmation email by ID.
  • Send reservation contract email by ID.
  • Show applicable templates for a reservation.
  • Trigger templates for a reservation.
  • Store a quote and send an email.
• Operational context
  • Work with locations.
  • Show available agents and assign primary/return agents.
  • Manage seasons.
  • Use extensions, external charges, adjustments, fines, and packages where needed.
  • Register a webhook for event-driven integrations.

Beyond the API, HQ helps you run a connected operation: Accept Online Reservations & Payments, Go Paperless with digital agreements and mobile photo uploads, leverage Integrated Bookkeeping, and manage anywhere with a Cloud-based Solution and Mobile Access. It also offers 30+ integrations and is supported by the technology of Stripe, Global Payments, QuickBooks, E‑ZPass, and Xero.

Quick start: Authentication and regional base URLs

Before calling any endpoints, authenticate each request.

How authentication works

• Get a Tenant Token (Settings > Integrations > Api Token).
• Generate a User Token (Settings > Users > open the user > Generate new token).
• Create a base64 string from tenant_token:user_token.
• Send an Authorization header with the resulting token.

Example header:

Authorization: Basic {AUTHENTICATION_TOKEN}

Regional base URLs

Use the base URL that matches where your system is hosted:

• America: https://api.caagcrm.com/api/
• America 3: https://api-america-3.caagcrm.com/api-america-3/
• America West: https://api-america-west.caagcrm.com/api-america-west/
• America Miami: https://api-america-miami.caagcrm.com/api-america-miami/
• Europe: https://api-europe.caagcrm.com/api-europe/
• Asia: https://api-asia.caagcrm.com/api-asia/

Blueprint: Reservation Creation Flow (step-by-step)

Use the following sequence to automate bookings from your website or app.

1. Validate travel dates and constraints

   • Call the endpoint that returns the details and validations for the dates step.
   • If valid, proceed; otherwise, prompt the user to adjust dates.

2. Fetch availability with class-level pricing

   • Validate dates to return available vehicle classes with respective prices for the period.
   • Display options, including classes and price breakdowns.

3. Offer add-ons and extras confidently

   • Return applicable additional charges based on selected dates, brand, and class.
   • Allow customers to pick extras (e.g., add-ons) and reflect the impact on price.

4. Calculate an accurate quote

   • Return the price for the selected combination of charges and vehicle class.
   • Present a clear summary so customers can confirm with confidence.

5. Capture or match customer details

   • Create or update the customer record.
   • Associate the customer with the pending reservation.

6. Confirm and create the reservation

   • Commit the reservation in the system.
   • Persist the reservation ID for follow-up actions.

7. Send confirmations and contracts

   • Send the reservation confirmation email by ID.
   • Send the reservation contract email by ID or trigger applicable templates.
   • If the customer isn’t ready, store a quote and send an email.

8. Get agreement signed and documented

   • Show the rental agreement for the reservation.
   • Set date of sign and upload the primary driver’s signature.

9. Assign the vehicle and prepare pickup

   • Return available cars for the location and date range.
   • Assign the selected vehicle and mark the reservation as ready for pickup.
   • Where relevant, list free upgrade classes and apply a free upgrade.
   • If plans change, detach or replace the vehicle with vehicle replacement actions.

10. Take payment and handle deposits

    • Create a payment for the reservation.
    • Charge a credit card from the reservation securely.
    • Manage security deposits: initiate a refund and process the online refund when due.
    • If needed, create or update refunds and send or void invoices as policy dictates.

11. Keep downstream systems in sync

    • Register a webhook to receive updates.
    • Use invoice and payment endpoints to keep accounting aligned with your internal or integrated tools.

Flow at a glance

Automating the Reservation Update Flow

Once a booking exists, your system should keep it current and consistent.

• Status management: Update to Open, Cancel, Pending, Quote, or No Show explicitly.
• Adjustments and extras: Create adjustments, apply external charges, or add extensions as plans change.
• Vehicle logistics: Detach, assign, or replace vehicles to handle maintenance or customer requests.
• Agents and operations: Show available agents and assign primary/return agents to streamline handoffs.
• Seasonal pricing windows: Create or update seasons as needed for pricing cadence and availability.

These operations let your online experience stay aligned with real-world fleet conditions and policies.

Emails and customer communications

Use built-in messaging capabilities to reduce manual follow-ups and ensure consistent branding.

• Show all email templates and trigger them programmatically.
• Send the reservation confirmation email by ID.
• Send the reservation contract email by ID.
• For each reservation, list applicable templates and trigger the right one.
• Store a quote and send an email for leads not ready to book now.

This approach keeps customers informed and helps your team go paperless. HQ generates a rental agreement you can customize, and you can upload vehicle photos from the mobile app and capture digital signatures.

Payments, invoices, and terminals

Modern renters expect frictionless checkout. With HQ:

• Create and update payments and attach them to invoices.
• Charge a credit card from the customer’s reservation.
• Initiate and refund online security deposits.
• Send invoices by email and void sent invoices if needed.
• Return a connection token for Stripe Terminal when you need in-person card acceptance.

HQ is supported by the technology of Stripe and Global Payments, and integrates with QuickBooks and Xero to streamline bookkeeping.

Locations, availability, and upgrades

Enhance your UI with granular operational data:

• Show a list of locations.
• Return the available cars for a given location and reservation date range.
• List vehicle classes for free upgrades and apply a free class upgrade where appropriate.

These capabilities make it easier to maintain accurate inventory promises and delight customers when upgrades are available.

Tolls, telematics, and paperless operations

For fleets that rely on connected operations:

• Use the Toll Integration and Toll Integration Flow to incorporate tolls into your processes.
• Go paperless with customizable rental agreements and digital signatures.
• Manage on-the-go with HQ’s mobile access to upload photos and handle checkout steps.

HQ also supports E‑ZPass among its integrations, helping align toll handling with your reservations and billing.

Practical implementation tips

• Validate early and often: run the dates validation and class pricing checks before collecting payment details.
• Keep pricing transparent: use the additional charges and pricing endpoints to show an all-in total.
• Treat statuses as an explicit workflow: Open, Cancel, Pending, Quote, and No Show should be deliberate transitions.
• Automate communications: trigger confirmation and contract emails immediately after key milestones.
• Streamline pickups: assign vehicles programmatically and mark reservations as ready for pickup to reduce counter time.
• Close the loop financially: attach payments to invoices and process security deposit refunds promptly.
• Monitor operations: register webhooks for updates and keep an eye on System Status to plan maintenance windows.

FAQ: Fast, direct answers

How do I authenticate with HQ Rental Software’s API?

Encode tenant_token:user_token in base64 and send it as a header:

Authorization: Basic {AUTHENTICATION_TOKEN}

Tenant and User tokens are generated in Settings.

Which regional base URLs are available?

• America: https://api.caagcrm.com/api/
• America 3: https://api-america-3.caagcrm.com/api-america-3/
• America West: https://api-america-west.caagcrm.com/api-america-west/
• America Miami: https://api-america-miami.caagcrm.com/api-america-miami/
• Europe: https://api-europe.caagcrm.com/api-europe/
• Asia: https://api-asia.caagcrm.com/api-asia/

Can I send reservation confirmations and contracts automatically?

Yes. Use the endpoints to send the reservation confirmation email by ID, send the reservation contract email by ID, or trigger applicable templates for a reservation.

How do I handle security deposits?

Use the payments and security deposits endpoints to initiate a refund and process the online security deposit refund for a reservation.

Can I check availability by location and dates?

Yes. Validate dates to get available classes with prices and return the available cars for a specific location and date range.

Conclusion

Automating Online Reservation Flows with HQ Rental Software’s API unifies availability, pricing, contracts, vehicles, payments, and communications into a seamless customer journey. With integrated payments and bookkeeping, mobile access, cloud reliability, and excellent customer support, you can scale bookings and improve margins without adding complexity.

Ready to streamline your bookings? Start your free 7-day trial—no credit card required. Or explore Online Reservations, Fleet Management, Integrations, and the API Documentation to go deeper.