# Room Stays

Room stays are the specific stays in rooms under a booking, linking pricing, room, guests, and rates. This entity is part of the Property Management System (PMS) and is used to manage and track the details of each stay, including the duration, associated guests, and any additional services or charges. Room stays help in organizing bookings, ensuring accurate billing, and enhancing the overall guest experience.

## Retrieve Room Stays from defined parameters.

 - [GET /api/v3/roomStays](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/listallroomstays.md): 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.

## Lock a specified roomstay

 - [PATCH /api/v3/roomStays/roomStays/{id}/lock](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/roomstayapilockroomstay.md): Locks the room stay identified by the given ID, preventing further modifications. This operation is useful for ensuring that the details of a room stay are finalized and cannot be altered. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve Room Stay by id

 - [GET /api/v3/roomStays/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getroomstaybyid.md): Fetch detailed information about a specific room stay within the Property Management System (PMS) using its unique ID. Room stays help in organizing bookings, ensuring accurate billing, and enhancing the overall guest experience. This endpoint is useful for retrieving room stay-specific data for reporting, resource allocation, and strategic decision-making. The response includes details about the room stay, including its duration, associated guests, and any additional services or charges. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve activities for specified room stay

 - [GET /api/v3/roomStays/{id}/activities](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getactivitiesbyroomstayid.md): Fetch a list of all activities associated with a specific room stay. This endpoint is useful for retrieving detailed information about activities related to a room stay. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve extras for specified room stay

 - [GET /api/v3/roomStays/{id}/chargeableExtras](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getroomstayextrasbyroomstayid.md): Fetch a list of all chargeable extras associated with a specific room stay. This endpoint is useful for retrieving detailed information about additional services or charges applied to a room stay. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Get custom fields for a room stay

 - [GET /api/v3/roomStays/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getcustomfieldsforroomstay.md): Retrieve all custom fields associated with a specific room stay record. The response includes a list of custom fields, each containing details such as field name, type, and value. This endpoint is useful for accessing additional information stored in custom fields that are not part of the standard room stay attributes.

## Retrieve guest stays for specified room stay

 - [GET /api/v3/roomStays/{id}/guestStays](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getgueststaysbyroomstayid.md): Fetch a list of all guest stays associated with a specific room stay. This endpoint is useful for retrieving detailed information about guests staying in a room. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve list of all invoice items for specified room stay

 - [GET /api/v3/roomStays/{id}/salesInvoiceItems](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getinvoicesbyroomstayid.md): Fetch a list of all invoice items associated with a specific room stay. This endpoint is useful for retrieving detailed billing information for a room stay, including charges for services and any additional fees. If the specified room stay ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.