# Guest Stays

Represents Guest Stay entities within the Property Management System (PMS), which track individual guest stays associated with a room stay. A Guest Stay captures key details such as guest information, check-in and check-out dates, separate to the booked room, and stay status. This entity is essential for managing guest experiences, tracking physical occupancy, and facilitating seamless accommodation operations. 

## Retrieve Guest Stays from defined parameters.

 - [GET /api/v3/guestStays](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/listallgueststays.md): Retrieve a paginated list of guest stays within the Property Management System (PMS) based on specified search criteria. This endpoint allows filtering by date range (dateFrom and dateTo), unit ID, contact ID, guest details (email, first name, last name), status (CONFIRMED, CHECKED_IN, CHECKED_OUT by default), and booking reference. Guest Stays represent individual guest reservations linked to a room stay and include key details such as guest identity, booking status, and associated property information. The response provides a paginated list of Guest Stay records, making it useful for tracking occupancy, managing guest check-ins and check-outs, and retrieving stay details for reporting or operational purposes. If no filters are provided, all guest stays within the default parameters will be returned.

## Create a Guest Stay for a Room Stay

 - [POST /api/v3/guestStays](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/creategueststay.md): This endpoint is used to create a new guest stay on a room stay.

## Retrieve Guest Stay by ID

 - [GET /api/v3/guestStays/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/getgueststaybyid.md): Fetch detailed information about a specific Guest Stay within the Property Management System (PMS) using its unique ID. A Guest Stay represents an individual guest's reservation linked to a room stay and includes key details such as check-in and check-out dates, assigned unit, guest information, booking reference, and stay status. This endpoint is useful for retrieving stay-specific data for guest management, reporting, or operational workflows. If the specified Guest Stay ID does not exist, a 404 Not Found error will be returned. In case of an unexpected system error, a 500 Internal Server Error will be triggered.

## Update a Guest Stay for a Room Stay

 - [PUT /api/v3/guestStays/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/updategueststay.md): This endpoint is used to update a guest stay on a room stay.

## Delete a Guest Stay

 - [DELETE /api/v3/guestStays/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/deletegueststay.md): This endpoint is used to delete a guest stay on a room stay.

## Update a Guest Stay status

 - [PATCH /api/v3/guestStays/{id}/updateStatus](https://apidocs.resharmonics.com/apis/resharmonics-pms/guest-stays/updategueststaystatus.md): This endpoint is used to update a guest stay status