Changelog

Update to the /unit_rentals endpoint documentation to clarify the fallback_rates parameter.
The parameter was previously documented as a boolean but has now been corrected to reflect its valid string enums:

Resolved an issue on the /unit_images endpoint where, in some rare cases, images were returned with an incorrect URL. The endpoint now consistently serves the correct image URLs.

Resolved an issue on the /unit_rental endpoint to correctly pass the system-configured multiplication factor in the API response ("management_company_rate_factor"), ensuring accurate traveler-facing pricing based on configured discounts or rate adjustments.

Update to the /reservations endpoint to remove the "amount_decimal_places" field from the "payments" object. This field was deprecated with the introduction of v2024.07.31 and has been removed to reduce redundancy in the response.

• Resolved an inconsistency between the REST API and the legacy XML API regarding the "allow_online_booking" setting. The REST API now correctly evaluates nullable states of internal flags to ensure alignment with partner-facing booking rules.
• Improved handling of orphaned units in the /units endpoint to match the behavior of the XML API. Orphaned units now reflect the following error.message: "Unit has been orphaned." where appropriate.
• Update to the /units endpoint to correct an issue where deleted properties were still being returned as active records.
• Update to the /unit_quotes endpoint to ensure Pool Heat matches internal quoting behavior.
• Added new active query parameter to the /suppliers endpoint to optionally filter for suppliers who are currently signed up as CiiRUS users.
• Refinements to the /reservations endpoint:
  • Removed amount_decimal_places from payments and payment_schedule objects.
  • Removed redundant total_amount; renamed total to total_value.
  • Renamed amount to value within payment_schedule objects.
  • Improved accuracy of required/optional field labeling in the schema.
• Removed the no_total query parameter from several GET endpoints where it was no longer applicable following updates made on April 14, 2025:
  • /reservations
  • /units
  • /unit_calendars
  • /unit_rental
  • /unit_quotes

• Update to resolve an issue affecting paginated API responses where next_page_url and prev_page_url referenced an incorrect endpoint and did not preserve the original query parameters.
• Update to /unit_quotes endpoint to address unhandled exceptions that could appear in the response.

• Update to /reservations endpoint to resolve an issue where cancellations returned an error despite successfully cancelling the reservation.

• Improved performance and consistency for /units, /reservations, and /unit_ based endpoints.
  • Updated pagination behavior for /reservations—"total_page_count" will just indicate if there is a next page, but in cases where a non-existent page is requested, it will return 1 as the "total_page_count".
• Update to /reservations endpoint to resolve an issue with guest counts in reservation records.

• Update to /reservations endpoint to address an issue where certain property-level tax settings were not being applied consistently during booking creation.

• Improved handling of time-based data in paginated requests to prevent internal errors when using higher "page_size" values.
• Corrected formatting in paginated response URLs to ensure consistency with versioned endpoint structures.