# Get the rated buy records

Get the rated buy records for a rental product inventory, site or customer in a given bill run

Endpoint: GET /rental-rated-buy-records
Version: 1.5
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"

  - `rentalProductInventoryId` (string)
    Return based on rental product inventory identifier - required unless the "siteId+billRunId" or "customerId+billRunId" filter combinations have been specified
    Example: "0"

  - `billRunId` (string)
    Filter based on bill run identifier
    Example: "0"

  - `customerId` (string)
    Filter based on customer identifier - required with "billRunId" unless the "rentalProductInventoryId" or "siteId+billRunId" filter combinations have been specified
    Example: "0"

  - `siteId` (string)
    Filter based on site identifier - required with "billRunId" unless the "rentalProductInventoryId" or "customerId+billRunId" filter combinations have been specified
    Example: "0"

## Response 200 fields (application/json):

  - `id` (integer)
    Rental rated buy identifier
    Example: 1

  - `rentalProductInventoryId` (integer, required)
    Rental product inventory identifier
    Example: 1

  - `customerId` (integer)
    Customer identifier

  - `siteId` (integer)
    Site identifier

  - `billRunId` (integer)
    Bill run identifier
    Example: 1

  - `billRunName` (string)
    Bill run friendly name

  - `billRunStatus` (string)
    Bill run status

  - `creationDate` (string)
    Created date

  - `chargeStartDate` (string)
    Charge start date

  - `chargeEndDate` (string)
    Charge end date

  - `buyPrice` (number)
    Rated buy price
    Example: 10.5

  - `priceType` (string)
    Price type
    Example: "Rental"

  - `qty` (number)
    Quantity
    Example: 1


## Response 400 fields

## Response 401 fields

## Response 403 fields