Cloudbeds

Voids the AdjustmentID transaction on the specified reservationID

Archives an existing guest note.

Archives an existing reservation note.

Remove subscription for webhook. Read the [Webhooks guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007612553-Webhooks) to see available objects, actions, payload info and more. ### Group account support

Retrieve allotment blocks

Returns the app property settings

Get the current app settings for a property.<br />

Get the current app integration state for a property.<br /> This call is only available for third-party integration partners, and not for property client IDs. Read the [Connecting/Disconnecting Apps guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007613213-Connecting-Disconnecting-Apps) to further understand the use cases.

Returns a list of room types with availability considering the informed parameters ### Group account support

Get currency settings

Gets custom fields list<br /> ¹ data.displayed = "booking" - Display this field to guests on the booking engine.<br /> ¹ data.displayed = "reservation" - Add this field to the reservation folio for use by staff.<br /> ¹ data.displayed = "card" - Make this field available for registration cards.<br />

Returns basic information about the current state of the hotel

Returns a list of all existing email scheduling. This call is only available for third-party integration partners, and not for property client IDs.

Returns a list of all existing email templates. This call is only available for third-party integration partners, and not for property client IDs.

Returns a list of files attached to a hotel or group profile, ordered by creation date

Returns group notes

Returns the groups for a property

Returns information on a guest specified by the Reservation ID parameter

Returns a list of guests, ordered by modification date ### Group account support

Retrieves a guest notes

Returns a list of guests matching the selected parameters ### Group account support

Returns a list of guests in the current status (Not Checked In, In House, Checked Out or Cancelled), sorted by modification date. If no date range is passed, it returns all guests with the selected status. ### Group account support

Returns a list of guests based on their modification date. Note that when a guest checks in or checks out of a room, their record is modified at that time. If no date range is passed, only the records for the current day are returned. Also note that if the guest is assigned to multiple rooms, it will result in multiple records. ### Group account support

Returns the details of a specific hotel, identified by "propertyID"

Returns a list of hotels, filtered by the parameters passed ### Group account support

Pulls list of active house accounts

Returns a list of housekeepers ### Group account support

Returns the current date's housekeeping information The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true

Gets the details for the one itemID<br /> ¹ only if data.stockInventory = true<br> ² Taxes, fees and totals will show up only if an item has assigned tax or fee.<br>

Gets the item category list

Gets all the items and their prices the hotel has created in myfrontdesk<br> ¹ only if data.stockInventory = true<br> ² Taxes, fees and totals will show up only if an item has assigned tax or fee.<br>

Return a list of billing package names for a property

This efficient method allows you to retrieve the collection of packages associated with a property. Packages here define a group of features that a property has the ability to utilize or access. By invoking this API method, developers will get a comprehensive view of the feature sets that are available and active for a specific property. The getPackages method boasts a seamless execution that offers essential information, vital in enhancing property management, understanding available functionalities and ultimately, optimizing user experience.

Get a list of active methods for a property, or list of properties

Lists the payment capabilities of a given property

Returns the rate of the room type selected, based on the provided parameters

Returns a list of Rate Jobs. Rate jobs are only returned within 7 days of creation, after 7 days they will not be returned in the response. Requests which do not provide a jobReferenceID will be filtered by the client ID of the request's token.

Returns the rates of the room type or promo code selected, based on the provided parameters. If no parameters are provided, then the method will return all publicly available rate plans. ### Group account support

Returns information on a booking specified by the reservationID parameter

Returns a list of rooms/reservations assigned for a selected date.

Retrieves reservation notes based on parameters

Returns information about particular room in reservation by its subReservationID

Returns a list of reservations that matched the filters criteria.<br /> Please note that some reservations modification may not be reflected in this timestamp. ### Group account support

Returns a list of reservations with added information regarding booked rates and sources.<br /> Please note that some reservations modification may not be reflected in this timestamp.

Returns a list of all room blocks considering the informed parameters.

Returns a list of room types filtered by the selected parameters ### Group account support

Returns a list of all rooms considering the informed parameters. If Check-in/out dates are sent, only unassigned rooms are returned. ### Group account support

Get applicable fees and tax to a booking. This is meant to be used on checkout to display to the guest.

Returns a list of unassigned rooms in the property. Call is alias of [getRooms](#api-Room-getRooms). Please check its documentation for parameters, response and example. ### Group account support

Gets available property sources

Returns the taxes and fees set for the property. Read the [Rate-Based tax (Dynamic Tax) guide](https://myfrontdesk.cloudbeds.com/hc/en-us/articles/360014103514-rate-based-tax-dynamic-tax) to understand its usage.

Returns information on the properties' users ### Group account support

List webhooks for which the API client is subscribed to.

List notes added to an allotment block

In the context of properties being distributed across multiple localizations, this endpoint serves to retrieve the precise location of the property associated with the provided access token. Further information can be found in the [Authentication guide](https://integrations.cloudbeds.com/hc/en-us/sections/14731510501915-Authentication).

Returns information on user who authorized connection

Query the authorization server for an access token used to access property resources.</br> If the automatic delivery method for API keys is used, the grant type `urn:ietf:params:oauth:grant-type:api-key` needs to be used to request an API key. This grant type requires `grant_type=urn:ietf:params:oauth:grant-type:api-key`, `client_id`, `client_secret`, `redirect_uri` and `code`.</br> For OAuth 2.0., two different grant types (`authorization_code`, `refresh_token`) are supported. Authorization code grant type requires `grant_type=authorization_code`, `client_id`, `client_secret`, `redirect_uri`, `code`. Refresh token grant type requires `grant_type=refresh_token`, `client_id`, `client_secret`, `refresh_token`.</br> Read the [Authentication guide](https://integrations.cloudbeds.com/hc/en-us/sections/14731510501915-Authentication) for implementation tips, user flows and testing advice.

Append single, or multiple, custom items and their associated payments to an existing one in a Reservation, House Account, or Group.

Retreive allotment blocks @apiQuery {Integer} propertyID Property ID

Add a note to an allotment block

Delete allotment blocks

deleteAppPropertySettings

Deletes a room block

Updates an existing group with information provided. At least one information field is required for this call.

Update the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a startDate and/or endDate will update rates only within the interval provided. Only non derived rates can be updated, requests to update a derived rate will return an error. This endpoint performs updates asynchronously, rate updates are added to a queue and the endpoint returns a job reference ID. This job reference ID can be used to track job status notifications or to look up details of the update once it is completed. The API is limited to 30 interval per update, sending more than 30 will return an error.

Adds an adjustment to a reservation

Submit the error received by the hybrid integration from the partner to the MFD

postAppPropertySettings

Update app integration state for a property ID. <br /> This call is only available for third-party integration partners, and not for property client IDs. <br /> If an app is set to 'disabled', it will remove all active sessions Read the [Connecting/Disconnecting Apps guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007613213-Connecting-Disconnecting-Apps) to further understand the use cases.

Use a payment method to process a payment on a reservation, group profile, accounts receivable ledger, or house account.

Returns the rate of the room type selected, based on the provided parameters

Sets custom fields. The call should only be made once to add the field to the system.

Adds single, or multiple, custom items and their associated payments to a Reservation or House Account as a single transaction.

Add a Custom Payment Method to a property. This call does not allow to add Payment Methods: credit cards, bank transfer or Pay Pal.

Creates a new email schedule for existing email template. Email template can be scheduled based on two parameters: reservationStatusChange and reservationEvent. Only one of the parameters can be used. *reservationStatusChange* schedules email to be sent when reservation status transitions to a specific one, for instance: `confirmed`. *reservationEvent* schedules email to be sent number of days prior or after a specific event, for instance: `after_check_out` at a given time This call is only available for third-party integration partners, and not for property client IDs.

Creates a new email template. See the full list of available language parameters <a href="https://integrations.cloudbeds.com/hc/en-us/articles/360007144993-FAQ#methods-and-parameters">here</a>. This call is only available for third-party integration partners, and not for property client IDs.

Attaches a file to a hotel

Add a Government Receipt to a Reservation or House Account

Adds a group note

Adds a guest to reservation as an additional guest.

Attaches a document to a guest

Adds a guest note

Attaches a photo to a guest

Assigns guest(s) to a room in a reservation and adds these guests as additional guests.

Add New Housekeeper

Assign rooms (single or multiple) to an existing housekeeper

Switches the current date's housekeeping status for a specific room ID to either clean or dirty The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true

Adds an item either to a reservation or to a house account.

Adds new items category

Adds new items batch<br /> ¹ only if item.stockInventory = true<br />

Add a new House Account

Add a payment to a specified reservation, house account, or group. If multiple IDs are provided, precedence is reservationID, then houseAccountID, then groupCode.

Adds a reservation to the selected property

Attaches a document to a reservation

Adds a reservation note

Assign/Reassign a room on a guest reservation

Adds a room block to the selected property.

Check-in a room already assigned for a guest

Check-out a room already assigned for a guest. If all rooms are checked out, the reservation status will update accordingly to "Checked Out" as well.

Voids the itemID transaction on the specified Reservation ID, House Account ID, or Group. If payments were sent in calls [postItem](https://developers.cloudbeds.com/reference/post_postitem) or [postCustomItem](https://developers.cloudbeds.com/reference/post_postcustomitem), they will be deleted too.

Voids a payment (using paymentID) to a specified reservation or house account.

Subscribe a webhook for a specified event. Read the [Webhooks guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007612553-Webhooks) to see available objects, actions, payload info and more.

putAppPropertySettings

Adds a group to the property. Please note that the default setting for 'Route to Group Folio' will be 'No,' and the 'Reservation Folio Configuration' will be set as the default folio configuration. You can edit these settings through the user interface (UI).

Update the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a startDate and/or endDate will update rates only within the interval provided. Only non derived rates can be updated, requests to update a derived rate will return an error. This endpoint performs updates asynchronously, rate updates are added to a queue and the endpoint returns a job reference ID. This job reference ID can be used to track job status notifications or to look up details of the update once it is completed. The API is limited to 30 interval per update, sending more than 30 will return an error.

Update an allotment block @apiQuery {Integer} propertyID Property ID

Update a note on an allotment block

Updates an existing guest with information provided. At least one information field is required for this call.

Updates an existing guest note.

Change specific house account to either open or closed.

Edit Housekeeper Details

Updates an item with information provided<br /> ¹ only if item.stockInventory = true<br />

Updates a reservation, such as custom fields, estimated arrival time, room configuration and reservation status.

Updates an existing reservation note.

Updates a room block.