# Get a list of available rental rate cards

Endpoint: GET /rental-rate-cards
Version: 2.21
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `contractOwnerId` (string)
    Filter by contract owner
    Example: "0"

  - `name` (string)
    Filter by name
    Example: "xyz | in:x,y | like:xyz"

  - `availableFrom` (string)
    Filter by available from date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `availableTo` (string)
    Filter by available to date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `rentalRateCardType` (string)
    Filter by rate card type
    Example: "xyz | in:x,y | like:xyz"

  - `rentalProductCategoryId` (string)
    Filter by rental product category
    Example: "0"

## Header parameters:

  - `summary` (string)
    If true, returns a lightweight summary of each rental rate card instead of the full object. Use this to reduce payload size and improve performance when only basic information is needed.
    Example: "true | false"

## Response 200 fields (application/json):

  - `id` (integer)
    Rental rate card identifier
    Example: 1

  - `contractOwnerIds` (array)
    The billing entity or entities that are required for SELL/TEMPLATE rental rate card and have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
    Example: [1]

  - `name` (string, required)
    Rental rate card name

  - `rentalProductCategoryId` (integer, required)
    Rental product category identifier
    Example: 1

  - `rentalRateCardType` (string, required)
    Rental rate card type. Buy = used to price rental products purchased from the supplier, Sell = used to price rental products sold to customers, Template = is a rate card to which other rate cards can be linked
    Enum: "SELL", "TEMPLATE", "BUY"

  - `basedOnTemplateId` (integer)
    Based on rental rate card identifier. Sell rental rate cards can be linked to a template. Typically the template would contain the more obscure products that are less subject to price variations meaning the sell rate card can contain fewer products and be easier to maintain
    Example: 1

  - `availableFrom` (string, required)
    Available from

  - `availableTo` (string)
    Available to

  - `acceptOverridesFromParents` (boolean)
    Accept overrides from parents. Pricing can be assigned at customer, site or product inventory levels and could be a rate card assignment or override assignment. If selected, this property allows overrides assigned at a higher point in the hierarchy to override prices set within this rate card

  - `rentalRates` (array)

  - `rentalRates.id` (integer)
    Rental rate identifier
    Example: 1

  - `rentalRates.rentalProductId` (integer, required)
    Rental product identifier
    Example: 1

  - `rentalRates.price` (number, required)
    Price

  - `rentalRates.rentalRateType` (string)
    Rental rate type. Required when rentalRatePriceType is RENTAL
    Enum: "ADVANCE", "ARREARS"

  - `rentalRates.rentalRatePriceType` (string, required)
    Rental price type - recurring rental or one off?
    Enum: "RENTAL", "ONEOFF"

  - `rentalRates.periodsInAdvance` (string)
    Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
    Enum: "STANDARD", "ADVANCEDPLUSONEMONTH"

  - `rentalRates.rentalRateFrequency` (string, required)
    Frequency of rental. Required when rentalRatePriceType is RENTAL
    Enum: "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "QUARTERLY", "SIXMONTHS", "TWENTYFOURMONTHS"

  - `rentalRates.startDate` (string, required)
    Start date

  - `rentalRates.endDate` (string)
    End date

  - `rentalRates.showOnInvoice` (boolean)
    Show on invoice?

  - `supplierAccountId` (integer)
    The supplier account associated with BUY rate card only
    Example: 1


## Response 400 fields

## Response 401 fields

## Response 403 fields