# res:harmonics API The Res:Harmonics Public API provides seamless access to powerful tools for managing and automating property operations. Designed for developers and businesses, the API enables integration with Res:Harmonics’ platform to manage bookings, availability, rates, and guest experiences in real-time. With comprehensive documentation and robust endpoints, users can customise workflows, synchronise systems, and build tailored solutions to enhance operational efficiency. Whether you’re running serviced apartments, Build-to-Rent schemes, or co-living spaces, the Res:Harmonics API is your gateway to streamlined property management. Version: 3.0.22 License: License of API ## Servers Testing API ``` https://apiv3.resharmonics-dev.com ``` Production API ``` https://apiv3.rerumapp.uk ``` ## Security ### OAuth2 Testing API - OAuth2 security scheme for API access. Use client credentials to obtain a token. Type: oauth2 Scopes: - `api/read`: Read access - `api/write`: Write access ### X-Auth-Token Type: apiKey In: header Name: X-Auth-Token ## Download OpenAPI description - [res:harmonics API](https://apidocs.resharmonics.com/_bundle/apis/resharmonics-pms.yaml) ## Access Groups - [GET /api/v3/accessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/access-groups/listallaccessgroups.md): Retrieve list of Access Groups based on search parameters such as building ID and name. Supports pagination. - [POST /api/v3/accessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/access-groups/createaccessgroup.md): Create a new Access Group within the Property Management System (PMS). This endpoint allows you to add a new access group, which can be used to manage access control within buildings and facilities. - [GET /api/v3/accessGroups/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/access-groups/getunitaccessgroupbyid_1.md): Retrieve an Access Group by Id. This endpoint allows you to fetch detailed information about a specific Access Group using its unique identifier. The response includes all relevant details of the Acce - [PUT /api/v3/accessGroups/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/access-groups/updateaccessgroup.md): Update an Access Group within the Property Management System (PMS). The Access Group must exist to be updated. This endpoint allows you to modify the details of an existing access group, ensuring that ## Activities - [GET /api/v3/activities](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/getnewactivities.md) - [POST /api/v3/activities](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/createactivity.md): Creates a new activity record. Mandatory fields: subject, activityTypeId, exactly one of assignedUserId/assignedTeamId/assignedCompanyId, startDateTime, dueDate, unitId, and blockAvailability. Duratio - [GET /api/v3/activities/notes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/getactivitynote.md) - [GET /api/v3/activities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/retrieveactivity.md) - [PUT /api/v3/activities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/updateactivity.md): Updates an existing activity record identified by its ID. Accepts the same fields as the create endpoint except status, which is not updatable here — use PATCH /api/v3/activities/{id}/status instead. - [GET /api/v3/activities/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/getactivitynotes.md) - [POST /api/v3/activities/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/createactivitynotes.md) - [PATCH /api/v3/activities/{id}/status](https://apidocs.resharmonics.com/apis/resharmonics-pms/activities/updateactivitystatus_1.md) ## Area - [GET /api/v3/areas](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/listallareas.md): Retrieve a list of areas within the Property Management System (PMS). This endpoint allows you to fetch details about various geographical areas, including their hierarchical structure within cities a - [POST /api/v3/areas](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/createarea.md): Creates a new area within the Property Management System (PMS) with the provided details. Areas help in organizing properties, defining operational zones, and generating location-based insights. This - [GET /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/getareabyid.md): Retrieve the details of a specific area within the Property Management System (PMS) using its unique identifier. This endpoint allows you to fetch comprehensive information about a particular geograph - [PUT /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/updatearea.md): Updates an existing area within the Property Management System (PMS) with the provided details. Areas help in organizing properties, defining operational zones, and generating location-based insights. - [DELETE /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/deleteareabyid.md): Deletes a specific area within the Property Management System (PMS) using its unique ID. Areas help in organizing properties, defining operational zones, and generating location-based insights. This e ## Availabilities - [GET /api/v3/availabilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/availabilities/availabilitysearch.md): Retrieve real-time room availability and corresponding pricing based on specified criteria such as date range, room type, occupancy, and applicable rate plans - [GET /api/v3/availabilities/unit/{unitId}/intervals](https://apidocs.resharmonics.com/apis/resharmonics-pms/availabilities/findavailabilityintervalsperunit.md): Retrieve intervals of availability for a unit specified by unit id for a given date range. If no date range is specified, the next 365 days will be used. This endpoint is designed to provide a summary ## Billing Frequencies - [GET /api/v3/billingFrequencies](https://apidocs.resharmonics.com/apis/resharmonics-pms/billing-frequencies/getbillingfrequencies.md): Retrieve a list of all billing frequencies within the Property Management System (PMS). This endpoint allows you to fetch details about different billing intervals, which help in organizing and managi - [GET /api/v3/billingFrequencies/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/billing-frequencies/getbillingfrequencybyid.md): Retrieve the details of a specific billing frequency within the Property Management System (PMS) using its unique identifier. This endpoint allows you to fetch comprehensive information about a partic ## Booking Terms - [GET /api/v3/bookingTerms](https://apidocs.resharmonics.com/apis/resharmonics-pms/booking-terms/getbookingterms.md): Retrieve a list of all booking terms within the Property Management System (PMS). This endpoint allows you to fetch details about different booking terms, which help in defining payment and settlement - [GET /api/v3/bookingTerms/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/booking-terms/getbookingtermsbyid.md): Retrieve the details of specific booking terms within the Property Management System (PMS) using its unique identifier. This endpoint allows you to fetch comprehensive information about a particular s ## Booking Types - [GET /api/v3/bookingTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/booking-types/getbookingtypes.md): Retrieve a list of all booking types within the Property Management System (PMS). This endpoint allows you to fetch details about different booking categories, which help in organizing and managing va - [GET /api/v3/bookingTypes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/booking-types/getbookingtypebyid.md): Retrieve the details of a specific booking type within the Property Management System (PMS) using its unique identifier. This endpoint allows you to fetch comprehensive information about a particular ## Bookings - [GET /api/v3/bookings](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/listallbookings.md): Search for bookings via a variety of optional filters within the Property Management System (PMS). This endpoint allows you to filter bookings based on date ranges, statuses, unit IDs, booking contact - [POST /api/v3/bookings](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/createbooking.md): This endpoint is used to create a new booking with room stays in a ENQUIRY status. If 'reserveForMinutes' is specified the availability will be held for the number of minutes specified. Once the booki - [POST /api/v3/bookings/{bookingId}/payments](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/reconcilebookingpayments.md): Creates a payment record against a booking. The payment record will be reconciled against any outstanding invoices. Where necessary invoices will be auto posted. The payDueBefore parameter can be used - [PATCH /api/v3/bookings/{bookingId}/update](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/updatebookinggeneral.md): This endpoint allows update of various fields associated with a specific booking within the Property Management System (PMS). Please refer to the request body for list of fields which can be updated. - [PATCH /api/v3/bookings/{bookingId}/updateStatuses](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/updatebookingstatus.md): This endpoint allows you to update the statuses of room stays associated with a specific booking within the Property Management System (PMS). Room stay statuses can include various states such as CONF - [GET /api/v3/bookings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getbookingdtobyidentifier.md): Retrieve detailed information about a specific booking within the Property Management System (PMS). This includes all associated data such as room stays, invoices, notes, and tags. This endpoint ensur - [GET /api/v3/bookings/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getcustomfieldsforbooking.md): Retrieve all custom fields associated with a specific booking record in the booking module of the PMS. The response includes a list of custom fields, each containing details such as field name, type, - [GET /api/v3/bookings/{id}/financialSummary](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getbookingpricebreakdown.md): Retrieve a detailed financial summary for a specific booking within the Property Management System (PMS). This includes all charges, payments, and adjustments related to the booking, providing a compr - [GET /api/v3/bookings/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getnotesbybookingid.md): Retrieve a comprehensive list of all notes or a specific note associated with a specified booking within the Property Management System (PMS). Notes provide detailed information about the booking, inc - [POST /api/v3/bookings/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/createbookingnote.md): Record a note against a specified booking within the Property Management System (PMS). This endpoint allows you to add comments, updates, or additional information related to a booking. Notes provide - [GET /api/v3/bookings/{id}/pricing](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/retrievepricing.md): Retrieve price information about a specific booking within the Property Management System (PMS). This will provide the booking total and due prices with Gross, Net and Vat. - [GET /api/v3/bookings/{id}/roomStays](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getroomstaysbybookingid.md): Retrieve a comprehensive list of all room stays associated with a specific booking within the Property Management System (PMS). This endpoint provides detailed information about each room stay, includ - [GET /api/v3/bookings/{id}/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/getinvoicesbybookingid.md): Retrieve a comprehensive list of all invoices associated with a specific booking within the Property Management System (PMS). This endpoint provides detailed financial information related to the booki - [GET /api/v3/bookings/{id}/tags](https://apidocs.resharmonics.com/apis/resharmonics-pms/bookings/gettagsbybookingid.md): Retrieve a comprehensive list of all tags associated with a specific booking within the Property Management System (PMS). Tags provide additional metadata and categorization for bookings, allowing for ## Building - [GET /api/v3/buildings](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/listallbuildings.md): Retrieve a list of all buildings managed within the PMS. The response includes essential information for each building, such as its unique ID, name, address, facilities, and operational status. Option - [POST /api/v3/buildings](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/createbuilding.md): Create a new building record in the property module of the PMS. The request body should contain the necessary details for the building, such as name, address, facilities, and operational attributes. U - [GET /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getbuildingbyid.md): Fetch detailed information about a specific building within the PMS using its unique identifier. The response includes details such as the building's name, address, facilities, operational status, and - [PUT /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/updatebuilding.md): Update an existing building record in the property module of the PMS. The request body should contain the updated details for the building, such as name, address, facilities, and operational attribute - [DELETE /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/deletebuildingbyid.md): Delete a specific building record from the property module of the PMS using its unique identifier. This operation will remove the building and all associated data from the system. If the specified bui - [GET /api/v3/buildings/{id}/accessCodes](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getaccesscodeforbuilding.md): Retrieve all access codes associated with a specific building record in the property module of the PMS. - [GET /api/v3/buildings/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getcustomfieldsforbuilding.md): Retrieve all custom fields associated with a specific building record in the property module of the PMS. The response includes a list of custom fields, each containing details such as field name, type ## Channels - [GET /api/v3/channels](https://apidocs.resharmonics.com/apis/resharmonics-pms/channels/listchannels.md): Fetch a list of all channels within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about channels, including their names and descriptions. The respon - [GET /api/v3/channels/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/channels/getchannelbyid.md): Fetch a specific channel within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about a specific channel, including its name and description. If the c ## City - [GET /api/v3/cities](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/listallcities.md): Fetch a comprehensive list of cities available within the PMS. The response includes details for each city, such as its name, unique identifier, address, facilities, and operational status. Optional q - [POST /api/v3/cities](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/createcity.md): Creates a new city within the Property Management System (PMS) with the provided details. Cities help in organizing properties, defining operational zones, and generating location-based insights. This - [GET /api/v3/cities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/getcitybyid.md): Fetch detailed information about a specific city within the PMS using its unique identifier. The response includes the city's name, associated properties, and any relevant metadata. This endpoint is c - [PUT /api/v3/cities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/updatecity.md): Updates an existing city within the Property Management System (PMS) with the provided details. Cities help in organizing properties, defining operational zones, and generating location-based insights - [DELETE /api/v3/cities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/deletecitybyid.md): Deletes a specific city within the Property Management System (PMS) using its unique ID. Cities help in organizing properties, defining operational zones, and generating location-based insights. This ## Companies - [GET /api/v3/companies](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/listcompanies.md): Retrieve a paginated list of companies from the PMS based on specified search filters. Optional query parameters include company name, email address, telephone number, referrer, industry, market segme - [POST /api/v3/companies](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/createcompany.md): Create a new company record in the PMS by providing the company details in the request body. The input JSON payload should include information such as the company's name, contact details, industry, an - [POST /api/v3/companies/merge](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/mergecompanies.md): Merge the secondary company into the primary contact. Related records (e.g., activities, bookings, notes) are reassigned to the primary entity. Noop if any of the companies are null. Returns a success - [GET /api/v3/companies/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/getcompanybyid.md): Retrieve detailed information about a specific company in the PMS by providing its unique company ID. The response includes comprehensive data such as the company's name, contact information, address, - [PUT /api/v3/companies/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/updatecompany.md): Update an existing company record in the PMS by providing the company's unique ID and updated details in the request body. The input JSON payload should include the fields to be updated, such as the c - [DELETE /api/v3/companies/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/deletebyid.md) - [POST /api/v3/companies/{id}/addresses](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/addaddress_1.md): Creates a new address and associates it with the specified company. - [PUT /api/v3/companies/{id}/addresses/{addressId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/updateaddress_1.md): Updates an existing address associated with the specified company. - [DELETE /api/v3/companies/{id}/addresses/{addressId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/deleteaddress_1.md): Delete an address associated with a specified company from the PMS. - [PUT /api/v3/companies/{id}/addresses/{addressId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/setprimaryaddress_1.md) - [GET /api/v3/companies/{id}/contacts](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/getcontactsforcompany.md): Retrieve all contacts associated with a specific company record in the CRM module of the PMS. The response includes a list of contact summary records, each containing details such as id, first name an - [GET /api/v3/companies/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/getcustomfieldsforcompany.md): Retrieve all custom fields associated with a specific company record in the CRM module of the PMS. The response includes a list of custom fields, each containing details such as field name, type, and - [POST /api/v3/companies/{id}/emailAddresses](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/addemailaddress_1.md): Creates a new email address and associates it with the specified company. - [PUT /api/v3/companies/{id}/emailAddresses/{emailId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/updateemail_1.md): Updates an existing email address associated with the specified company. - [DELETE /api/v3/companies/{id}/emailAddresses/{emailId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/deleteemail_1.md): Delete an email address associated with a specified company from the PMS. - [PUT /api/v3/companies/{id}/emailAddresses/{emailId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/setprimaryemail_1.md) - [POST /api/v3/companies/{id}/telephones](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/addtelephonenumber_1.md): Creates a new telephone number and associates it with the specified company. - [PUT /api/v3/companies/{id}/telephones/{phoneId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/updatetelephone_1.md): Updates an existing telephone number associated with the specified company. - [DELETE /api/v3/companies/{id}/telephones/{phoneId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/deletetelephone_1.md): Delete a telephone number associated with a specified company from the PMS. - [PUT /api/v3/companies/{id}/telephones/{phoneId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/companies/setprimarytelephone_1.md) ## Contacts - [GET /api/v3/contacts](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/retrievecontacts.md): Retrieve a paginated list of contacts from the CRM module of the PMS. This endpoint supports optional query parameters to filter the results, including email address, first name, last name, telephone - [POST /api/v3/contacts](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/createcontact.md): Create a new contact record in the CRM module of the PMS. This endpoint accepts a JSON payload containing the contact's details, such as name, contact information (e.g., email, phone), role, and any r - [POST /api/v3/contacts/merge](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/mergecontacts.md): Merge the secondary contact into the primary contact. Related records (e.g., activities, bookings, notes, attachments, keys) are reassigned to the primary contact. Noop if any of the contacts are null - [GET /api/v3/contacts/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/getcontactbyid.md): Fetch detailed information about a specific contact in the CRM module of the PMS using their unique contact ID. The response includes key details such as the contact's name, contact information (e.g., - [PUT /api/v3/contacts/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/updatecontact.md): Update an existing contact record in the CRM module of the PMS. This endpoint requires the contact's unique ID as a path variable and a JSON payload containing the updated contact details, such as nam - [DELETE /api/v3/contacts/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/deletecontactbyid.md) - [POST /api/v3/contacts/{id}/addresses](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/addaddress.md): Creates a new address and associates it with the specified contact. - [PUT /api/v3/contacts/{id}/addresses/{addressId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/updateaddress.md): Updates an existing address associated with the specified contact. - [DELETE /api/v3/contacts/{id}/addresses/{addressId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/deleteaddress.md) - [PUT /api/v3/contacts/{id}/addresses/{addressId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/setprimaryaddress.md) - [GET /api/v3/contacts/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/getcustomfieldsforcontact.md): Retrieve all custom fields associated with a specific contact record in the CRM module of the PMS. The response includes a list of custom fields, each containing details such as field name, type, and - [POST /api/v3/contacts/{id}/emailAddresses](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/addemailaddress.md): Creates a new email address and associates it with the specified contact. - [PUT /api/v3/contacts/{id}/emailAddresses/{emailId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/updateemail.md): Updates an existing email address associated with the specified contact. - [DELETE /api/v3/contacts/{id}/emailAddresses/{emailId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/deleteemail.md) - [PUT /api/v3/contacts/{id}/emailAddresses/{emailId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/setprimaryemail.md) - [GET /api/v3/contacts/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/getcontactnotes.md): Retrieve all or a specified note associated with a specific contact record in the CRM module of the PMS. The response includes a list of notes, each containing details such as the note's content, crea - [POST /api/v3/contacts/{id}/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/createnote.md): Record a note against a specified contact within the Property Management System (PMS). This endpoint allows you to add comments, updates, or additional information related to a booking. Notes provide - [POST /api/v3/contacts/{id}/telephones](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/addtelephonenumber.md): Creates a new telephone number and associates it with the specified contact. - [PUT /api/v3/contacts/{id}/telephones/{phoneId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/updatetelephone.md): Updates an existing telephone number associated with the specified contact. - [DELETE /api/v3/contacts/{id}/telephones/{phoneId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/deletetelephone.md) - [PUT /api/v3/contacts/{id}/telephones/{phoneId}/primary](https://apidocs.resharmonics.com/apis/resharmonics-pms/contacts/setprimarytelephone.md) ## Cost Centres - [GET /api/v3/costCentres](https://apidocs.resharmonics.com/apis/resharmonics-pms/cost-centres/listallproducts_1.md): Fetch a comprehensive list of cost centres available within the PMS. The response includes details for each cost centre, such as its name, unique identifier, and operational status. This endpoint is u - [GET /api/v3/costCentres/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/cost-centres/getbyid_3.md): Fetch a specific cost centre by its unique identifier. The response includes details such as the name, code, and export name of the cost centre. This endpoint is useful for retrieving detailed informa ## Country - [GET /api/v3/countries](https://apidocs.resharmonics.com/apis/resharmonics-pms/country/listallcountries.md): Retrieve a paginated list of countries stored within the Property Management System (PMS). This endpoint supports optional filtering by country name using the `countryName` query parameter, which allo - [GET /api/v3/countries/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/country/getcountrybyid.md): Fetch detailed information about a specific country within the Property Management System (PMS) by providing its unique ID. The response includes essential country details such as the country's name, ## Currencies - [GET /api/v3/currencies](https://apidocs.resharmonics.com/apis/resharmonics-pms/currencies/listallcurrencies.md): Fetch a paginated list of all currencies configured in the Property Management System (PMS). Currencies represent the monetary units supported for financial transactions, including invoicing, payments ## CustomFieldTemplates - [GET /api/v3/customFieldTemplates/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/customfieldtemplates/getcustomfieldtemplatebyid.md): Retrieve information about a specific custom field template for an entity type within the Property Management System (PMS). This includes reference to the associated entity the custom field template i - [PATCH /api/v3/customFieldTemplates/{id}/updateCustomFieldTemplate](https://apidocs.resharmonics.com/apis/resharmonics-pms/customfieldtemplates/updatecustomfieldtemplate.md): This allows update of a specified custom field template within the Property Management System (PMS) identified by reference ID. NOTE: see request body for fields which may be updated. ## CustomFields - [GET /api/v3/customFields/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/customfields/getcustomfieldbyid.md): Retrieve information about a specific custom field for an entity type within the Property Management System (PMS). This includes reference to the associated entity the custom field is linked to, i.e., - [PATCH /api/v3/customFields/{id}/updateCustomField](https://apidocs.resharmonics.com/apis/resharmonics-pms/customfields/updatecustomfield.md): This allows update of a specified custom field within the Property Management System (PMS) identified by reference ID. ## Developments - [GET /api/v3/developments](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/listalldevelopments.md): Retrieve a paginated list of developments within the Property Management System (PMS). This endpoint supports optional filtering by development name, area ID, or area name, allowing flexible search cr - [POST /api/v3/developments](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/createdevelopment.md): Create a new development within the Property Management System (PMS). This endpoint allows you to add a new development with its associated properties, location, and other relevant details. The reques - [GET /api/v3/developments/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/getdevelopmentbyid.md): Fetch detailed information about a specific development within the Property Management System (PMS) using its unique ID. The response includes key details such as the development's name, associated bu - [PUT /api/v3/developments/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/updatedevelopment.md): Update the details of an existing development within the Property Management System (PMS). This endpoint allows you to modify the development's properties, location, and other relevant details. The re - [DELETE /api/v3/developments/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/deletedevelopmentbyid.md): Delete an existing development within the Property Management System (PMS) using its unique ID. This endpoint allows you to remove a development and all its associated data from the system. If the spe - [GET /api/v3/developments/{id}/featuresFacilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/getfeaturefacilities_1.md): Fetch a list of features and facilities associated with a specific development using its unique ID. This endpoint returns detailed information about amenities, facilities, and special features availab - [PUT /api/v3/developments/{id}/featuresFacilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/updatefeaturefacilities_1.md): Update the list of feature facilities associated with a specific development using its unique ID. This endpoint allows you to replace the existing feature facilities with a new set of facilities, upda - [POST /api/v3/developments/{id}/featuresFacilities/link](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/linkfacilitiestodevelopment.md): Link existing feature facilities to a specific development using its unique ID. This endpoint allows you to associate multiple feature facilities with a development, enhancing its amenities and servic - [POST /api/v3/developments/{id}/featuresFacilities/unlink](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/deletefeaturefacilities_1.md): Unlink existing feature facilities from a specific development using its unique ID. This endpoint allows you to remove multiple feature facilities from a development, updating its amenities and servic - [GET /api/v3/developments/{id}/images](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/getdevelopmentimages.md): Fetch a paginated list of images associated with a specific development using its unique ID. This endpoint allows you to retrieve images that are linked to the development, which can include photos of - [POST /api/v3/developments/{id}/images/upload](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/createnewdevelopmentimage.md): Upload a new image for a specific development using its unique ID. This endpoint allows you to add images that are linked to the development, which can include photos of the property, architectural de - [DELETE /api/v3/developments/{id}/images/{imageId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/developments/deletedevelopmentimage.md): Delete an existing image associated with a specific development using its unique ID. This endpoint allows you to remove an image that is linked to the development. If the specified development or imag ## Extensions - [GET /api/v3/confirmStay/{webReference}/{roomStayId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/extensions/getextensionconfirmationdetails.md) - [POST /api/v3/confirmStay/{webReference}/{roomStayId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/extensions/updateextensionconfirmationdetails.md) - [GET /api/v3/extension/detail/{webReference}](https://apidocs.resharmonics.com/apis/resharmonics-pms/extensions/getextensiondetails.md) - [POST /api/v3/extension/update/{webReference}](https://apidocs.resharmonics.com/apis/resharmonics-pms/extensions/updateapartmentextension.md) ## Extras - [GET /api/v3/extras](https://apidocs.resharmonics.com/apis/resharmonics-pms/extras/searchallextras.md): Retrieve a paginated list of chargeable extras within the Property Management System (PMS). Chargeable extras represent additional services or products that can be added to bookings, such as parking, - [GET /api/v3/extras/{rateId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/extras/retrievecompulsoryextrasforrateid.md): Fetch a list of compulsory chargeable extras associated with a specific rate code within the Property Management System (PMS). Compulsory extras are additional services or fees that must be included w - [POST /api/v3/extras/{roomStayExtraId}/payment](https://apidocs.resharmonics.com/apis/resharmonics-pms/extras/updateextrapayment.md): Registers a payment for a chargeable extra linked to a specific room stay within the Property Management System (PMS). This endpoint requires the `roomStayExtraId` as a path variable to identify the e ## Feature Facility - [GET /api/v3/featureFacilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/feature-facility/retrievefeaturefacilities.md): Fetch a comprehensive list of feature facilities available within the PMS. The response includes details for each feature facility, such as its name, unique identifier, and operational status. This en ## Fees - [GET /api/v3/fees/feeTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/fees/feetypes.md): Retrieves a paginated list of all available fee types in the system ## Finance Accounts - [GET /api/v3/financeAccounts](https://apidocs.resharmonics.com/apis/resharmonics-pms/finance-accounts/findfinanceaccountlistitems.md): Fetch a list of all finance accounts within the Property Management System (PMS). This endpoint is useful for retrieving basic information about finance accounts, including relation type (company or c - [GET /api/v3/financeAccounts/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/finance-accounts/findfinanceaccountlistitem.md): Fetch a list of all finance accounts within the Property Management System (PMS). If the specified sales invoice ID does not exist, a `404 Not Found` error will be returned. In case of an unexpected s - [PATCH /api/v3/financeAccounts/{id}/exportStatus](https://apidocs.resharmonics.com/apis/resharmonics-pms/finance-accounts/updatefinanceaccountexportstatus.md): Update the external identifier record linked to a specific finance account; the updatable fields are export status, external ID and exported date time. This operation is essential for synchronizing th ## Financial Allocations - [GET /api/v3/financialAllocations/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/financial-allocations/listallocationlistitems.md): Filtering can be performed by allocation created date range (inclusive), Organisation ID, Finance Account ID and export status of financial allocations. - [POST /api/v3/financialAllocations/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/financial-allocations/performsalescreditallocation.md): This effectively reconciles a sales credit against a sales invoice. - [GET /api/v3/financialAllocations/salesPayments](https://apidocs.resharmonics.com/apis/resharmonics-pms/financial-allocations/listpaymentallocations.md): In the PMS, these will be allocations for financials of types, sales receipts against sales invoices and sales refund against sales credits. Filtering can be performed by payment allocation date range - [PATCH /api/v3/financialAllocations/{id}/exportStatus](https://apidocs.resharmonics.com/apis/resharmonics-pms/financial-allocations/updateallocationexportstatus.md): Update the external identifier record linked to a specific financial allocation; the updatable fields are export status, external ID and exported date time. The request body should include the externa ## Financials - [GET /api/v3/financials](https://apidocs.resharmonics.com/apis/resharmonics-pms/financials/findfinancials.md): Fetch a list of all financials within the Property Management System (PMS). This endpoint is useful for retrieving basic information about financials, The response includes paginated results of financ - [GET /api/v3/financials/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/financials/findbyid.md): Fetch a financial within the Property Management System (PMS). If the specified financial does not exist, a `404 Not Found` error will be returned. In case of an unexpected system error, a `500 Intern ## Guest Stays - [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 - [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. - [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 - [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 /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. - [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 ## Industries - [GET /api/v3/industries](https://apidocs.resharmonics.com/apis/resharmonics-pms/industries/listindustries.md): Fetch a list of all industries stored within the Property Management System (PMS). Industries represent business sectors and are used for categorising corporate clients, segmenting accounts, and apply - [GET /api/v3/industries/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/industries/getindustrybyid.md): Fetch detailed information about a specific industry within the Property Management System (PMS) using its unique ID. Industries are used to categorise corporate clients, segment accounts, and manage ## 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 - [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 issu - [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 - [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, maintenanc - [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 servi - [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 issue - [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 - [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 s - [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 mai - [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 a - [PATCH /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 (`OPEN`, `STARTED`, `RESOLVED`, or `CLO - [POST /api/v3/issues/{id}/workOrders](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/createworkorder.md): Creates a new work order linked to the specified issue. The product must be configured as a valid work order item (must have a default unit price, VAT profile, and currency set, and the price cannot b - [POST /api/v3/issues/{id}/workOrders/salesInvoice](https://apidocs.resharmonics.com/apis/resharmonics-pms/issues/createsalesinvoiceitemforworkorders.md): Create a draft sales invoice for the work orders associated with a specific issue within the Property Management System (PMS). Work orders enable generation of invoices within the Property Management ## Leads - [POST /api/v3/leads](https://apidocs.resharmonics.com/apis/resharmonics-pms/leads/createfulllead.md): Creates a lead with all details provided in the request body. Returns a BookingSummaryDTO containing the ID and reference of the created lead. ## Market Segments - [GET /api/v3/marketSegments](https://apidocs.resharmonics.com/apis/resharmonics-pms/market-segments/listmarketsegments.md): Fetch a list of all available market segments within the Property Management System (PMS). Market segments categorise customer groups based on booking patterns, demographics, or business classificatio - [GET /api/v3/marketSegments/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/market-segments/getmarketsegmentbyid.md): Fetch detailed information about a specific market segment within the Property Management System (PMS) using its unique ID. Market segments categorise customer groups based on booking behaviors, demog ## Nationalities - [GET /api/v3/nationalities](https://apidocs.resharmonics.com/apis/resharmonics-pms/nationalities/getnationalities.md): Fetch a list of all available nationalities within the Property Management System (PMS). Nationality entities help categorise guests, customers, or corporate clients based on their country of national - [GET /api/v3/nationalities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/nationalities/getnationalitybyid.md): Fetch detailed information about a specific nationality within the Property Management System (PMS) using its unique ID. Nationality entities help categorise guests, customers, or corporate clients ba ## Notes - [GET /api/v3/notes](https://apidocs.resharmonics.com/apis/resharmonics-pms/notes/getnotes.md): Retrieve information about a specific note or list of notes for an entity type within the Property Management System (PMS). This includes reference to the associated entities the note is linked to, i. - [GET /api/v3/notes/categories](https://apidocs.resharmonics.com/apis/resharmonics-pms/notes/list.md): Retrieves a paginated list of all note categories available in the system - [GET /api/v3/notes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/notes/getnotebyid.md): Retrieve information about a specific note for an entity type within the Property Management System (PMS). This includes reference to the associated entity the note is linked to. ## Organisations - [GET /api/v3/organisations](https://apidocs.resharmonics.com/apis/resharmonics-pms/organisations/listallorganisations.md): Fetch a comprehensive list of organisations available within the PMS. The response includes details for each cost centre, such as its name, unique identifier, and operational status. This endpoint is - [GET /api/v3/organisations/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/organisations/getbyid_2.md): Fetch a specific organisation by its unique identifier. The response includes details such as the name, other details. This endpoint is useful for retrieving detailed information about a specific orga ## Payments - [GET /api/v3/payments](https://apidocs.resharmonics.com/apis/resharmonics-pms/payments/listreceiptsandrefunds.md): In the PMS, these will be financials of types, sales receipts paid against sales invoices and sales refunds paid against sales credits. Filtering can be performed by payment allocation date range, Fin - [POST /api/v3/payments/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/payments/createsalesinvoicespayments.md): Creates a payment record against a specified collection of sales invoices. The payment record will be reconciled against any outstanding invoices. Where necessary invoices will be auto posted. If ther - [GET /api/v3/payments/{id}/allocations](https://apidocs.resharmonics.com/apis/resharmonics-pms/payments/listallocationlistitemsbypaymentid.md): This will give a list of all financial allocations of type SALES RECEIPT against a specific sales invoice financial. - [GET /api/v3/payments/{id}/download](https://apidocs.resharmonics.com/apis/resharmonics-pms/payments/extractreceiptdocument.md): Fetch a Receipt PDF for a payment referenceThe request will specify the financial id to extract the PDF required - [PATCH /api/v3/payments/{id}/exportStatus](https://apidocs.resharmonics.com/apis/resharmonics-pms/payments/updatefinancialexportstatus.md): Update the external identifier record linked to a specific payment financial (Sales Receipt); the updatable fields are export status, external ID and exported date time. The request body should includ ## Products - [GET /api/v3/products](https://apidocs.resharmonics.com/apis/resharmonics-pms/products/listallproducts.md): Fetch a paginated list of all products available in the Property Management System (PMS). Products are billable items that can be included on sales invoices, such as accommodation charges, extras (par ## Rates - [GET /api/v3/rates](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getallratesindaterange.md): Retrieve a list of rates that match the specified criteria, such as date range, unit type, rate ID, company ID, or rate code. The optional parameters `dateFrom` and `dateTo` allow for filtering rates - [GET /api/v3/rates/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getrate.md): Retrieves a specific rate by its unique identifier. Returns basic rate information including rate code, type, and name. - [GET /api/v3/rates/{id}/rateSegments](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getratesegments.md): Retrieves a paginated list of rate segments for a specific rate within the given date range. Returns detailed information about each rate segment including pricing and availability. - [GET /api/v3/rates/{id}/unitTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getunittypes.md): Retrieves a paginated list of unit types associated with a specific rate. Returns summary information for each unit type including ID and name. - [GET /api/v3/rates/{rateId}/segments](https://apidocs.resharmonics.com/apis/resharmonics-pms/rates/getsnapshotofrate.md): Retrieve list of rate summaries for a rate specified by rate ID between two dates. This groupstogether rates with similar names and returns the rate segments for the specified date range. Allowing for ## Referrers - [GET /api/v3/referrers](https://apidocs.resharmonics.com/apis/resharmonics-pms/referrers/listreferrers.md): Fetch a list of all available referrers within the Property Management System (PMS). Referrers track sources of referrals for guests, bookings, or corporate clients, helping to identify the origin of - [GET /api/v3/referrers/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/referrers/getreferrerbyid.md): Fetch details of a specific referrer within the Property Management System (PMS) using its unique ID. This endpoint returns the referrer information, which includes metadata about the source of referr ## Region - [GET /api/v3/regions](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/listallregions.md): Fetch a paginated list of regions within the Property Management System (PMS). Regions help in organizing properties, defining operational zones, and generating location-based insights. The response i - [POST /api/v3/regions](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/createregion.md): Creates a new region within the Property Management System (PMS) with the provided details. Regions help in organizing properties, defining operational zones, and generating location-based insights. T - [GET /api/v3/regions/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/getregionbyid.md): Fetch detailed information about a specific region within the Property Management System (PMS) using its unique ID. Regions help in organizing properties, defining operational zones, and generating lo - [PUT /api/v3/regions/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/updateregion.md): Updates an existing region within the Property Management System (PMS) with the provided details. Regions help in organizing properties, defining operational zones, and generating location-based insig - [DELETE /api/v3/regions/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/deleteregionbyid.md): Deletes a specific region within the Property Management System (PMS) using its unique ID. Regions help in organizing properties, defining operational zones, and generating location-based insights. Th ## Room Stays - [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 erro - [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 spec - [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 - [PUT /api/v3/roomStays/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/updateroomstay.md): This endpoint is used to update a room stay with amended dates - [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 - [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 - [POST /api/v3/roomStays/{id}/chargeableExtras](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/createroomstayextra.md): This endpoint is used to create a new room stay extra. - [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 use - [POST /api/v3/roomStays/{id}/fees](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/createroomstayfee.md): Creates a new fee invoice item associated with a specific room stay. This endpoint allows you to apply various fees (such as late checkout fees, damage fees, etc.) to a room stay. The fee will be adde - [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 - [GET /api/v3/roomStays/{id}/guests](https://apidocs.resharmonics.com/apis/resharmonics-pms/room-stays/getguestsbyroomstayid.md): Fetch a list of all guests 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 exis - [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 addi ## Sales Invoices - [GET /api/v3/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/findsalesinvoices.md): Fetch a list of all sales invoices within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about sales transactions, including invoice dates, associate - [POST /api/v3/salesInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/createsalesinvoice.md): Create a new sales invoice within the Property Management System (PMS). This endpoint allows you to create a new sales invoice by providing the necessary invoice details in the request body. The invoi - [GET /api/v3/salesInvoices/salesInvoiceItems/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/findinvoiceitem.md): Fetch detailed information about a specific sales invoice item within the Property Management System (PMS) using its unique ID. Sales invoice items are essential for tracking individual components of - [GET /api/v3/salesInvoices/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/findinvoice.md): Fetch detailed information about a specific sales invoice within the Property Management System (PMS) using its unique ID. Sales invoices are essential for tracking sales transactions, generating fina - [GET /api/v3/salesInvoices/{id}/balanceInvoices](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/findbalanceinvoices.md): Fetch all balanced (related) sales invoices associated with a specific sales invoice using its unique ID. This endpoint reads the underlying comma-separated list of balanced invoice numbers attached t - [GET /api/v3/salesInvoices/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/getcustomfieldsforsalesinvoice.md): Retrieve all custom fields associated with a specific sales invoice record in the finance module of the PMS. The response includes a list of custom fields, each containing details such as field name, - [POST /api/v3/salesInvoices/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/upsertcustomfieldsforsalesinvoice.md): Creates or updates custom fields for a specific sales invoice. This endpoint accepts a list of custom fields and intelligently matches them by Custom Field ID, Template ID, or Template Name. If the fi - [GET /api/v3/salesInvoices/{id}/download](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/extractinvoicedocument.md): Fetch a PDF for the Invoice for a sales invoice. The request will specify the invoice id to extract PDF required - [PATCH /api/v3/salesInvoices/{id}/exportStatus](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/updatesalesinvoiceexportstatus.md): Update the external identifier record linked to a specific sales invoice; the updateable fields are export status, external ID and exported date time. This operation is essential for synchronizing the - [PATCH /api/v3/salesInvoices/{id}/exported](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/markasexported.md): Mark a specific sales invoice as exported to an external finance system using its unique ID. This operation is essential for synchronizing the invoice status with external financial systems, ensuring - [GET /api/v3/salesInvoices/{id}/integrationIdentifiers](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/getintegrationidentifiers.md): Retrieve all 3rd-party integration identifiers (e.g., KSeF) associated with a specific sales invoice. This returns a list of identifiers including their current sync status and any external IDs/values - [PUT /api/v3/salesInvoices/{id}/integrationIdentifiers/{systemName}](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/upsertintegrationidentifier.md): Creates or updates an external integration identifier for a given system name (e.g., 'KSeF'). This is heavily used by asynchronous microservices to report back processing success, external IDs, or fai - [POST /api/v3/salesInvoices/{id}/post](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/marksalesinvoiceposted.md): Mark a specific sales invoice as posted using its unique ID. This operation is essential for updating the invoice status to 'POSTED', indicating that the invoice has been finalized and is ready for fu - [GET /api/v3/salesInvoices/{id}/salesInvoiceItems](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/findinvoiceitems.md): Fetch all sales invoice items associated with a specific sales invoice using its unique ID. This endpoint is useful for retrieving detailed information about the items within a sales invoice, includin - [POST /api/v3/salesInvoices/{id}/void](https://apidocs.resharmonics.com/apis/resharmonics-pms/sales-invoices/marksalesinvoicevoid.md): Mark a specific sales invoice as void using its unique ID. This operation is essential for updating the invoice status to 'VOID', indicating that the invoice has been cancelled. If the specified sales ## Tags - [GET /api/v3/tags](https://apidocs.resharmonics.com/apis/resharmonics-pms/tags/listtags.md): Fetch a list of all tags within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about tags, including their names and descriptions. The response inclu - [GET /api/v3/tags/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/tags/gettagtbyid.md): Fetch detailed information about a specific tag within the Property Management System (PMS) using its unique ID. Tags are essential for categorizing and organizing various system entities, such as pro ## Tax Codes - [GET /api/v3/taxCodes](https://apidocs.resharmonics.com/apis/resharmonics-pms/tax-codes/listalltaxcodes.md): Fetch a paginated list of all tax codes configured in the Property Management System (PMS). Tax codes represent different tax rates and classifications that can be applied to invoice line items, such - [GET /api/v3/taxCodes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/tax-codes/getbyid_1.md): Fetch a specific tax code by its unique identifier. The response includes details such as the name, code, rate and other details. This endpoint is useful for retrieving detailed information about a sp ## Teams - [GET /api/v3/teams](https://apidocs.resharmonics.com/apis/resharmonics-pms/teams/searchteams.md): Retrieve a paginated list of teams within the Property Management System (PMS) based on optional search criteria. You can filter the results by team name using a query parameter (`teamName`), which su - [GET /api/v3/teams/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/teams/findteam.md): Fetch detailed information about a specific team within the Property Management System (PMS) by providing its unique ID. The response includes information such as the team's name, members, assigned ro ## Unit Access Groups - [GET /api/v3/unitAccessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-access-groups/listallunitaccessgroups.md): Fetch a list of all unit access groups within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about unit access groups, including their associated uni - [PUT /api/v3/unitAccessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-access-groups/updateunitaccessgroup.md): Update an existing unit access group within the Property Management System (PMS). This endpoint allows the modification of details for a specific unit access group, including its associated unit and a - [POST /api/v3/unitAccessGroups](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-access-groups/createunitaccessgroup.md): Create a new unit access group within the Property Management System (PMS). This endpoint allows the creation of a new unit access group, which links a unit to an access group. The request body must i - [GET /api/v3/unitAccessGroups/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-access-groups/getunitaccessgroupbyid.md): Fetch detailed information about a specific unit access group within the Property Management System (PMS) using its unique ID. Unit access groups are essential for managing access control and permissi ## Unit Contracts - [GET /api/v3/unitContracts](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-contracts/searchunitcontracts.md): Search for unit contracts with optional filtering by unit ID and building ID - [GET /api/v3/unitContracts/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-contracts/getunitcontract.md): Retrieve detailed information about a specific unit contract - [GET /api/v3/unitContracts/{id}/units](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-contracts/getunits.md): Retrieve all units associated with a specific unit contract ## Unit Locations - [GET /api/v3/unitLocations](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-locations/getunitlocations.md): Fetches a paginated list of unit locations within the Property Management System (PMS). This endpoint allows filtering by unit ID, building ID to retrieve specific unit locations and also, unit locati - [GET /api/v3/unitLocations/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-locations/getunitlocationbyid.md): Fetches a specific unit location by its unique identifier. This endpoint provides detailed information about a particular unit location, including its type, associated unit, and other relevant metadat ## Unit Types - [GET /api/v3/unitTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/getallunittypes.md): Fetch a list of all unit types within the Property Management System (PMS). This endpoint is useful for retrieving detailed information about unit types, including their classification and characteris - [POST /api/v3/unitTypes](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/createunittype.md): Create a new unit type within the Property Management System (PMS). This endpoint allows you to define a new unit type with its classification and characteristics such as size, layout, amenities, and - [GET /api/v3/unitTypes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/getunittypebyid.md): Fetch detailed information about a specific unit type within the Property Management System (PMS) using its unique ID. Unit types are essential for categorizing accommodations based on factors such as - [PUT /api/v3/unitTypes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/updateunittype.md): Update an existing unit type within the Property Management System (PMS). This endpoint allows you to modify the details of a unit type, including its classification and characteristics such as size, - [DELETE /api/v3/unitTypes/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/deleteunittypebyid.md): Delete a specific unit type within the Property Management System (PMS) using its unique ID. This endpoint allows you to remove a unit type, including all associated data. If the deletion is successfu - [GET /api/v3/unitTypes/{id}/featuresFacilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/getfeaturefacilities.md): Fetch the list of features and facilities associated with a specific unit type within the Property Management System (PMS). This endpoint provides detailed information about the amenities and characte - [PUT /api/v3/unitTypes/{id}/featuresFacilities](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/updatefeaturefacilities.md): Update the list of feature facilities associated with a specific unit type using its unique ID. This endpoint allows you to replace the existing feature facilities with a new set of facilities, updati - [POST /api/v3/unitTypes/{id}/featuresFacilities/link](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/linkfacilitiestounittype.md): Link existing feature facilities to a specific unit type using its unique ID. This endpoint allows you to associate multiple feature facilities with a unit type, enhancing its amenities and services. - [POST /api/v3/unitTypes/{id}/featuresFacilities/unlink](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/deletefeaturefacilities.md): Unlink existing feature facilities from a specific unit type using its unique ID. This endpoint allows you to remove multiple feature facilities from a unit type, updating its amenities and services. - [GET /api/v3/unitTypes/{id}/images](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/getimages.md): Fetch a paginated list of images associated with a specific unit type using its unique ID. This endpoint allows you to retrieve images that are linked to the unit type, which can include photos of the - [POST /api/v3/unitTypes/{id}/images/upload](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/createnewimage.md): Upload a new image for a specific unit type using its unique ID. This endpoint allows you to add images that are linked to the unit type, which can include photos of the property, architectural design - [DELETE /api/v3/unitTypes/{id}/images/{imageId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/unit-types/deleteimage.md): Delete an existing image associated with a specific unit type using its unique ID. This endpoint allows you to remove an image that is linked to the unit type. If the specified development or image ID ## 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 p - [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. Th - [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 availabil - [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, - [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 room - [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 - [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, an - [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 contr - [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 ## Users - [GET /api/v3/users](https://apidocs.resharmonics.com/apis/resharmonics-pms/users/searchusers.md): This endpoint allows searching for user entities based on various criteria such as username, first name, and last name. It returns a paginated list of user projections in JSON format. The search param - [GET /api/v3/users/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/users/finduser.md): This endpoint retrieves a user entity based on the provided user ID. It returns the user details in JSON format. The user ID must be specified in the URL path. ## VAT Profiles - [GET /api/v3/vatProfiles](https://apidocs.resharmonics.com/apis/resharmonics-pms/vat-profiles/listallvatprofiles.md): Fetch a paginated list of all VAT profiles configured in the Property Management System (PMS). VAT Profiles are sophisticated tax configuration structures that define how tax rates are applied based o - [GET /api/v3/vatProfiles/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/vat-profiles/getbyid.md): Fetch a specific vat profile by its unique identifier. The response includes details such as the name and other details. This endpoint is useful for retrieving detailed information about a specific va - [GET /api/v3/vatProfiles/{vatProfileId}/taxSeasons](https://apidocs.resharmonics.com/apis/resharmonics-pms/vat-profiles/gettaxseasonsbyvatprofileid.md): Fetch a list of tax seasons for a specific vat profile by its unique identifier. The tax seasons will be active for the start and end dates provided. ## WorkOrders - [GET /api/v3/workOrders](https://apidocs.resharmonics.com/apis/resharmonics-pms/workorders/retrieveworkorders.md): Search the work orders held in the PMS. All query parameters are optional and are combined, so supplying none returns every work order that has not been deleted, in any status. Use issueId to retrieve - [GET /api/v3/workOrders/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/workorders/retrieveworkorder.md): Fetch a single work order, including its full financial breakdown (net, VAT and gross amounts as stored against the record) and the accounting context needed for external financial mapping - the tax c ## Api - [GET /api/v3/bookings/config](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/getconfiguration.md) - [GET /api/v3/languages/languages](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/getpmslanguages.md) - [POST /api/v3/organisation/booking](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/getorganisationdetailsforbooking.md) - [GET /api/v3/organisation/building/{buildingId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/getorganisationdetailsforbuilding.md) - [GET /api/v3/organisation/{organisationId}](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/getorganisationdetails.md) - [POST /api/v3/verifications](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/recordverificationterm.md) - [POST /api/v3/verifications/checkin](https://apidocs.resharmonics.com/apis/resharmonics-pms/api/checkinroomstayforgueststay.md)