# Retrieve Room Stays from defined parameters.

Fetch a paginated list of room stays based on various filters such as date, status, and booking details. The response includes a list of room stays with relevant metadata. If an unexpected system error occurs, a  will be triggered.

Endpoint: GET /api/v3/roomStays
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `dateFrom` (string)
    Start date for filtering room stays

  - `dateTo` (string)
    End date for filtering room stays

  - `lastUpdatedFrom` (string)
    Filter by last updated timestamp

  - `lastUpdatedTo` (string)
    Filter by last updated timestamp

  - `createFrom` (string)
    Filter by creation timestamp

  - `createdTo` (string)
    Filter by creation timestamp

  - `unitId` (integer)
    Filter by unit ID

  - `bookingContactId` (integer)
    Filter by booking contact ID

  - `bookingAccountId` (integer)
    Filter by booking account ID

  - `billingAccountId` (integer)
    Filter by billing account ID

  - `statuses` (array)
    Filter by statuses

  - `bookingReference` (string)
    Filter by booking reference

  - `channelId` (integer)
    Filter by channel ID

  - `bookingId` (integer)
    Filter by booking ID

  - `otaReference` (string)
    The ota reference is the booking reference provided by the online travel agent and should match the reference shown on the customer’s confirmation from the 3rd party

  - `customerReference` (string)
    Customer reference of booking

  - `organisationSettingsId` (integer)
    Filter by organisation settings ID

## Response 200 fields (application/json):

  - `content` (array)

  - `content.organisationSettingsName` (string)
    The name of the organisation for the room stay

  - `content.organisationSettingsId` (integer)
    The id of the organisation for the room stay

  - `content.roomStayId` (integer)
    The id of the room stay

  - `content.unit` (object)
    The unit of the room stay

  - `content.unit.name` (string)
    Unit Name

  - `content.unit.id` (integer)
    Unit ID

  - `content.unit.buildingName` (string)
    Unit Type ID

  - `content.startDate` (string)
    The start date of the room stay

  - `content.endDate` (string)
    The end date of the room stay

  - `content.netAmount` (number)
    The net amount of the room stay

  - `content.vatAmount` (number)
    The VAT amount of the room stay

  - `content.bookingId` (integer)
    The id of the booking

  - `content.channelId` (integer)
    The id of the channel for the booking

  - `content.channelName` (string)
    The name of the channel for the booking

  - `content.otaReference` (string)
    The ota reference for the booking

  - `content.bookingAccount` (object)
    The projected finance account

  - `content.bookingAccount.id` (integer)
    The unique identifier of the account

  - `content.bookingAccount.company` (object)
    The company of the account

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

  - `content.bookingAccount.company.companyName` (string)
    Name of the company

  - `content.bookingAccount.accountCode` (string)
    The code of the account

  - `content.bookingAccount.contact` (object)
    The name of the account

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

  - `content.bookingAccount.contact.firstName` (string)
    First name of the contact

  - `content.bookingAccount.contact.lastName` (string)
    Last name of the contact

  - `content.bookingAccount.contact.telephoneNumber` (string)
    Telephone number of the contact

  - `content.bookingAccount.contact.emailAddress` (string)
    Email address of the contact

  - `content.bookingReference` (string)
    The reference of the booking

  - `content.roomStayStatus` (string)
    The status of the room stay

  - `content.customerReference` (string)
    The customer reference for the booking

  - `content.bookingContact` (object)
    The name of the account

  - `content.billingAccount` (object)
    The projected finance account

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)