# Search for rates by specified criteria

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.

Endpoint: GET /api/v3/rates
Version: 3.0.9
Security: OAuth2

## Query parameters:

  - `dateFrom` (string, required)
    The start date for filtering rates

  - `dateTo` (string, required)
    The end date for filtering rates

  - `unitTypeId` (integer)
    The ID of the unit type

  - `rateId` (integer)
    The ID of the rate

  - `companyId` (integer)
    The ID of the company

  - `rateCode` (string)
    The code of the rate

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (integer)
    Unique identifier of the rate

  - `content.rateCode` (string)
    Code of the rate

  - `content.rateType` (string)
    Type of the rate
    Enum: "DAILY", "WEEKLY", "MONTHLY"

  - `content.name` (string)
    Name of the rate

  - `content.shortName` (string)
    Short name of the rate

  - `content.ratePlan` (object)
    Summary of the rate plan

  - `content.ratePlan.id` (integer)

  - `content.ratePlan.title` (string)

  - `content.ratePlan.description` (string)

  - `content.ratePlan.vatInclusive` (boolean)

  - `content.ratePlan.webDescription` (string)

  - `content.ratePlan.bookingTermsId` (integer)

  - `content.rates` (array)
    List of rate segments

  - `content.rates.id` (integer)
    Unique identifier of the rate segment

  - `content.rates.date` (string)
    Date of the rate segment

  - `content.rates.amount` (number)
    Amount for the rate segment

  - `content.rates.bookable` (boolean)
    Indicates if the rate segment is bookable

  - `content.rates.minStay` (integer)
    Minimum stay required for the rate segment

  - `content.rates.closedToArrival` (boolean)
    Indicates if the rate segment is closed to arrival

  - `content.rates.closedToDeparture` (boolean)
    Indicates if the rate segment is closed to departure

  - `content.startDate` (string)
    Start date of the rate

  - `content.endDate` (string)
    End date of the rate

  - `content.rateNote` (string)
    Note for the rate

  - `content.accommodationProduct` (object)
    Product associated with the room stay extra

  - `content.accommodationProduct.id` (integer)
    Unique identifier of the product
    Example: 1

  - `content.accommodationProduct.productCode` (string)
    Code of the product
    Example: "PROD-001"

  - `content.accommodationProduct.name` (string)
    Name of the product
    Example: "Product 1"

  - `content.depositProduct` (object)
    Product associated with the room stay extra

  - `content.advancePaymentProduct` (object)
    Product associated with the room stay extra

  - `content.occupancyCount` (integer)
    Occupancy count for the rate

  - `content.currency` (object)
    Base currency details of the invoice

  - `content.currency.id` (integer)
    Unique identifier of the currency
    Example: 1

  - `content.currency.name` (string)
    Name of the currency
    Example: "US Dollar"

  - `content.derivedRate` (object)
    Rate summary of the room stay

  - `content.derivedRateOption` (string)
    Option for the derived rate
    Enum: "FLAT", "PERCENTAGE"

  - `content.derivedValue` (number)
    Value of the derived rate

  - `content.bookingType` (object)
    Booking type of the building

  - `content.bookingType.id` (integer)
    The unique identifier of the booking type

  - `content.bookingType.name` (string)
    The name of the booking type

  - `content.bookingType.description` (string)
    The description of the booking type

  - `content.bookingType.shortCode` (string)
    The short code of the booking type

  - `content.bookingType.billingType` (string)
    The billing type of the booking
    Enum: "ON_ACCOUNT", "CREDIT_CARD", "CASH_PAYMENT", "BANK_PAYMENT", "VIRTUAL_CARD"

  - `content.bookingType.emailTo` (string)
    The email recipient of the booking
    Enum: "BOOKING_CONTACT", "BOOKING_GUESTS", "BOOKING_CONTACT_AND_GUESTS"

  - `content.bookingType.systemBookingType` (boolean)
    Indicates if it is a system booking type

  - `content.bookingType.systemName` (string)
    The system name of the booking type

  - `content.bookingType.uuid` (string)
    The unique identifier for the booking type

  - `content.bookingType.organisationSettings` (object)
    Organisation settings

  - `content.bookingType.organisationSettings.id` (integer)
    The unique identifier of the organisation settings
    Example: 1

  - `content.bookingType.organisationSettings.name` (string)
    The name of the organisation
    Example: "Resharmonics"

  - `content.bookingType.organisationSettings.currency` (object)
    The currency of the organisation

  - `content.bookingType.organisationSettings.currency.description` (string)
    Description of the currency

  - `content.bookingType.organisationSettings.currency.symbol` (string)
    Symbol of the currency

  - `content.bookingType.organisationSettings.currency.exchangeRate` (number)
    Exchange rate of the currency

  - `content.bookingType.organisationSettings.currency.baseRate` (number)
    Base rate of the currency

  - `content.bookingType.organisationSettings.currency.unit` (string)
    Unit of the currency

  - `content.bookingType.organisationSettings.currency.autoUpdate` (boolean)
    Indicates if the currency is auto-updated

  - `content.bookingType.organisationSettings.currency.primaryCurrency` (boolean)
    Indicates if this is the primary currency

  - `content.bookingType.organisationSettings.currency.htmlSafeSymbol` (string)
    HTML safe symbol of the currency

  - `content.bookingType.organisationSettings.country` (object)
    Data Transfer Object representing a Country entity in the Property Management System (PMS).

  - `content.bookingType.organisationSettings.country.id` (integer)
    Unique identifier of the country

  - `content.bookingType.organisationSettings.country.name` (string, required)
    Name of the country

  - `content.bookingType.organisationSettings.country.sortOrder` (integer, required)
    Sort order of the country

  - `content.bookingType.organisationSettings.country.countryCodeAlpha2` (string, required)
    Alpha-2 country code

  - `content.bookingType.organisationSettings.country.countryCodeAlpha3` (string, required)
    Alpha-3 country code

  - `content.bookingType.organisationSettings.country.countryCodeNumeric` (string, required)
    Numeric country code

  - `content.leadTime` (integer)
    Lead time for the rate

  - `content.closedToArrivalAfter` (integer)
    Closed to arrival after

  - `content.derivedDefaultMinLos` (number)
    Default minimum length of stay for the derived rate

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)