# Issues

Represents Issues within the Property Management System (PMS), which track and manage property-related concerns, maintenance requests, and guest service requests. Issues can include general maintenance tasks, housekeeping requests, guest complaints, or operational incidents that require resolution. This functionality supports efficient task assignment, workflow automation, and real-time issue tracking to ensure prompt resolution and enhance guest satisfaction. Issues can be associated with properties, units, bookings, or specific guest stays, enabling seamless communication between staff and management.

## Retrieve a list of issues

 - [GET /api/v3/issues](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/retrieveissues.md): Fetch a paginated list of issues within the Property Management System (PMS), representing property management tasks, maintenance requests, or guest service concerns. This endpoint allows filtering by multiple parameters, including issue details (ID, subject, status, type, priority), assignment details (assignee user or team), date ranges (reported date, response target date, resolution target date, last updated date), and related entities (booking, unit, or building). The response includes key issue details, making it useful for tracking operational tasks, managing maintenance workflows, and ensuring efficient resolution. If no filters are applied, all available issues will be returned in a paginated format. In case of an unexpected system error, a  will be triggered.

## Create new issue

 - [POST /api/v3/issues](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/createentity.md): Create a new issue within the Property Management System (PMS) to track property-related concerns, maintenance requests, or guest service requests. This endpoint accepts a JSON payload containing issue details, including description, priority, category, associated property or unit, and reporter information. The created issue is linked to relevant entities such as a property, unit, booking, or guest stay to facilitate efficient resolution. The response returns the newly created issue with a unique identifier. If any referenced object IDs do not exist in the PMS, a  error will be returned due to data integrity violations. In case of an unexpected error, a  will be triggered.

## Retrieve a list of all issue priorities

 - [GET /api/v3/issues/issuePriorities](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/getissuepriority.md): Fetch a list of all available issue priorities within the Property Management System (PMS). Issue priorities help classify and manage the urgency of property-related concerns, maintenance requests, or guest service issues. Priorities can include different levels, such as 'Low', 'Medium', 'High', or custom-defined priority levels, ensuring that critical issues are addressed promptly. This endpoint provides structured priority data to facilitate efficient issue management, resource allocation, and response time tracking. The response includes a list of issue priorities along with relevant metadata. If an unexpected system error occurs, a  will be triggered.

## Retrieve an issue priority by ID

 - [GET /api/v3/issues/issuePriorities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/getissuepriority_1.md): Fetch detailed information about a specific issue priority within the Property Management System (PMS) using its unique ID. Issue priorities define the urgency of property-related concerns, maintenance requests, or guest service issues, ensuring efficient task management and resolution. The response includes key details such as the priority level and its associated metadata. If the specified priority ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve a list of all issue statuses

 - [GET /api/v3/issues/issueStatuses](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/getissuestatuses.md): Fetch a list of all possible issue statuses within the Property Management System (PMS). Issue statuses indicate the current progress of property-related concerns, maintenance requests, or guest service issues. Common statuses include , , , and , ensuring clear tracking of an issue's lifecycle. This endpoint provides structured status data to help streamline issue management, prioritisation, and resolution workflows. The response includes a list of predefined issue statuses. If an unexpected system error occurs, a  will be triggered.

## Retrieve a list of all issue types

 - [GET /api/v3/issues/issueTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/getissuetypes.md): Fetch a list of all available issue types within the Property Management System (PMS). Issue types categorise different kinds of property-related concerns, maintenance requests, or guest service issues, such as housekeeping, technical repairs, complaints, or general inquiries. This endpoint provides a structured way to classify and manage operational issues, ensuring efficient tracking and resolution. The response includes a list of issue types, each containing relevant metadata. If an unexpected system error occurs, a  will be triggered.

## Retrieve issue entity by ID

 - [GET /api/v3/issues/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/retrieveentity.md): Fetch detailed information about a specific issue within the Property Management System (PMS) using its unique ID. Issues represent property management concerns, maintenance requests, or guest service requests. The response includes key details such as issue type, description, status, priority, associated property or unit, and reporting details. This endpoint is useful for tracking ongoing issues, managing maintenance workflows, and ensuring timely resolution. If the specified issue ID does not exist, a  error will be returned.

## Update issue entity

 - [PUT /api/v3/issues/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/updateentity.md): Modify an existing issue within the Property Management System (PMS) by providing updated details in the request body. The update process requires a valid issue ID and allows modifications to fields such as issue status, priority, category, or resolution notes. Issues are typically associated with properties, units, bookings, or guest stays, ensuring efficient tracking and management. To prevent data conflicts, a locking mechanism is applied during updates. The response includes the updated issue details. If the issue ID does not exist, a  error will be returned. In case of an unexpected error, a  will be triggered.

## Retrieve a list of notes on an issue

 - [GET /api/v3/issues/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/getissuenotes.md): Fetch all notes associated with a specific issue within the Property Management System (PMS) using its unique ID. Issue notes provide a historical record of updates, comments, and actions taken on maintenance requests, guest concerns, or operational issues. The response includes details such as note content, author, timestamp, and any relevant metadata. This endpoint is useful for tracking communication, ensuring accountability, and maintaining an audit trail for issue resolution. If the issue ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Create an issue note

 - [POST /api/v3/issues/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/createissuenote.md): Add a new note to a specific issue within the Property Management System (PMS) using the issue's unique ID. Issue notes serve as a communication log, allowing users to document updates, comments, or actions taken on maintenance requests, guest concerns, or operational issues. The request body must contain the note details, including its content and any relevant metadata. If the specified issue ID does not exist, a  error will be returned. Upon successful creation, the response includes the newly added note. This endpoint ensures proper documentation of issue progress and facilitates collaboration between team members.

## Update the status of an issue by ID

 - [PUT /api/v3/issues/{id}/status](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/updateactivitystatus.md): Modify the status of a specific issue within the Property Management System (PMS) using its unique issue ID. The request body must include a valid status update (, , , or ). This endpoint ensures proper issue tracking and workflow management by allowing users to update the issue's progress. 

- : Marks the issue as newly created and pending action. 
- : Indicates work has begun on resolving the issue. 
- : Confirms the issue has been addressed but not yet closed. 
- : Marks the issue as fully completed and closed. 

The response includes the updated issue details. If the issue ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.