# Rates

Endpoints for managing and querying rates and pricing within the PMS. These endpoints enable the creation, updating, retrieval, and deletion of rate records associated with properties, room types, and booking policies. Rate management functionality includes support for dynamic pricing, seasonal adjustments, promotional offers, and rate plans (e.g., refundable, non-refundable). Additionally, these endpoints facilitate integration with revenue management systems, allowing for real-time updates and querying of rates based on availability, occupancy, and other parameters. This suite of endpoints is essential for optimising pricing strategies and ensuring accurate and efficient rate handling.

## Search for rates by specified criteria

 - [GET /api/v3/rates](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getallratesindaterange.md): Retrieve a list of rates that match the specified criteria, such as date range, unit type, rate ID, company ID, or rate code. The optional parameters dateFrom and dateTo allow for filtering rates within a specific date range, while unitTypeId, rateId, companyId, and rateCode can further narrow the search. Results are returned in a paginated format, making it easier to navigate through large datasets. This endpoint is useful for querying rates for specific units, validating pricing for bookings, or integrating rate information with external systems. If no filters are provided, the endpoint returns all rates within the default date range.

## Get rate by ID

 - [GET /api/v3/rates/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getrate.md): Retrieves a specific rate by its unique identifier. Returns basic rate information including rate code, type, and name.

## Get rate segments for a rate

 - [GET /api/v3/rates/{id}/rateSegments](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getratesegments.md): Retrieves a paginated list of rate segments for a specific rate within the given date range. Returns detailed information about each rate segment including pricing and availability.

## Get unit types for a rate

 - [GET /api/v3/rates/{id}/unitTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getunittypes.md): Retrieves a paginated list of unit types associated with a specific rate. Returns summary information for each unit type including ID and name.

## Retrieve rate segments for a specified rate ID and date range

 - [GET /api/v3/rates/{rateId}/segments](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getsnapshotofrate.md): Retrieve list of rate summaries for a rate specified by rate ID between two dates. This groupstogether rates with similar names and returns the rate segments for the specified date range. Allowing for easy comparison of rates with different lengths of stay and amounts.