# Units Represents Unit entities within the Property Management System (PMS), which are individual accommodations available for booking within a property. Units can include apartments, hotel rooms, serviced residences, or other types of rentable spaces. Each Unit is associated with a Unit Type, property, and relevant metadata such as availability, capacity, amenities, and pricing. This functionality supports efficient inventory management, booking operations, and property administration, enabling property managers to track occupancy, apply pricing strategies, and manage unit-specific details. Units are integral to availability searches, booking workflows, and reporting analytics within the PMS. ## Retrieve list of units - [GET /api/v3/units](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/listallproperties.md): Fetch a list of all units within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about units, including their availability, capacity, amenities, and pricing. The response includes a paginated list of units, which can be used for inventory management, booking operations, and property administration. If no units are found, an empty list will be returned. In case of an unexpected system error, a will be triggered. ## Create a new unit - [POST /api/v3/units](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/createunit.md): Create a new unit within the Property Management System (PMS). This endpoint allows property managers to add new units, which can include apartments, hotel rooms, or other types of rentable spaces. The request body should contain the necessary details for the unit, such as its type, capacity, amenities, and pricing. Upon successful creation, the response will include the details of the newly created unit. In case of an unexpected system error, a will be triggered. ## Retrieve a unit by Id - [GET /api/v3/units/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/getunitbyid.md): Fetch detailed information about a specific unit within the Property Management System (PMS) using its unique ID. Units are essential for categorizing accommodations based on factors such as availability, capacity, amenities, and pricing. This endpoint is useful for retrieving unit-specific data for inventory management, booking operations, and property administration. The response includes details about the unit, including its classification and characteristics. If the specified unit ID does not exist, a error will be returned. In case of an unexpected system error, a will be triggered. ## Update a unit by Id - [PUT /api/v3/units/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/updateunit.md): Update the details of a specific unit within the Property Management System (PMS) using its unique ID. This endpoint allows property managers to modify unit attributes such as availability, capacity, amenities, and pricing. The request body should contain the updated details for the unit. Upon successful update, the response will include the updated unit information. If the specified unit ID does not exist, a error will be returned. In case of an unexpected system error, a will be triggered. ## Delete a unit by Id - [DELETE /api/v3/units/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/deleteunitbyid.md): Delete a specific unit within the Property Management System (PMS) using its unique ID. This endpoint allows property managers to remove units that are no longer needed, such as apartments, hotel rooms, or other types of rentable spaces. Upon successful deletion, a response will be returned. If the specified unit ID does not exist, a error will be returned. In case of an unexpected system error, a will be triggered. ## Retrieve list of unit access groups - [GET /api/v3/units/{id}/accessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/getunitunitaccessgroups.md): Fetch a list of all access groups associated with a specific unit within the Property Management System (PMS) using its unique ID. Access groups define the permissions and access levels for different users or roles within the unit. This endpoint is useful for retrieving detailed information about the access groups assigned to a unit, including their names, descriptions, and associated permissions. The response includes a list of access groups, which can be used for managing user access, security settings, and role-based permissions. If no access groups are found for the specified unit ID, an empty list will be returned. In case of an unexpected system error, a will be triggered. ## Get custom fields for a unit - [GET /api/v3/units/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/getcustomfieldsforunt.md): Retrieve all custom fields associated with a specific unit record in the property module of the PMS. 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 unit attributes. ## Retrieve contracts for a specific unit - [GET /api/v3/units/{unitId}/unitContracts](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/getunitcontracts.md): Fetch a paginated list of contracts associated with a specific unit within the Property Management System (PMS). This endpoint allows property managers to retrieve detailed information about the contracts related to a unit, including contract terms, start and end dates, and associated parties. If no contracts are found for the specified unit ID, an empty page will be returned. Results are paginated to handle large datasets efficiently. ## Retrieve internal locations for a specific unit - [GET /api/v3/units/{unitId}/unitLocations](https://apidocs.resharmonics.com/apis/resharmonics-pms/units/getunitinternallocations.md): Fetch a paginated list of internal locations associated with a specific unit within the Property Management System (PMS). Internal locations represent different areas or spaces within a unit, such as bathrooms, living spaces, etc. This endpoint allows property managers to retrieve detailed information about the internal locations of a unit, including their types, descriptions, and associated metadata. If no internal locations are found for the specified unit ID, an empty page will be returned. Results are paginated to handle large datasets efficiently.