Cloudbeds
API integration

list_all_cloudbeds_accounting_settings

Get the accounting settings for a Cloudbeds property, such as the deposit consumption policy.

cloudbeds_accounting_settings_bulk_update

Update one or more accounting settings for a Cloudbeds property; only include the fields you want to change. If no settings exist for the property, they are created automatically.

list_all_cloudbeds_accounts_receivable_ledger_totals

Get aggregated totals across all accounts receivable (AR) ledgers for a Cloudbeds property. Optionally filter by status for open or closed ledgers.

list_all_cloudbeds_accounts_receivable_ledger_transactions

List transactions for a specific Cloudbeds accounts receivable ledger. Returns a paginated list of AR ledger transactions including their state (posted or pending), dates, and type. Required: accounts_receivable_ledger_id.

list_all_cloudbeds_accounts_receivable_ledgers

List accounts receivable ledgers for a Cloudbeds property. Returns: id, description. Supports filtering by status, date range, balance range, profile, and search query.

create_a_cloudbeds_accounts_receivable_ledger

Create a new accounts receivable ledger in Cloudbeds to track outstanding balances outside of a reservation, such as invoices sent to a corporate client. Returns: id, description. Required: name.

get_single_cloudbeds_accounts_receivable_ledger_by_id

Get a single accounts receivable ledger from Cloudbeds by id. Returns: id, description. Required: id.

update_a_cloudbeds_accounts_receivable_ledger_by_id

Update an existing accounts receivable ledger in Cloudbeds — change the name, description, linked profile, or status. Returns: id, description. A ledger can only be closed (status set to CLOSED) when its balance is zero.

list_all_cloudbeds_addons

List property add-ons in Cloudbeds with basic information for a specific property. Returns: id. Max 500 per page.

delete_a_cloudbeds_adjustment_by_id

Void an adjustment transaction on a Cloudbeds reservation by specifying the reservation and adjustment identifiers. Returns an empty 204 response on success.

create_a_cloudbeds_adjustment

Add an adjustment to a reservation in Cloudbeds. Returns: success, data, message. When type is product, fee, or tax, itemID identifies the specific item; itemID is not used for rate.

list_all_cloudbeds_allocation_summaries

Get a summary of payment allocations for fiscal documents in Cloudbeds, filtered by a specific source and optionally by folios or fiscal documents. Returns the AllocationsSummary response object. Required: sourceId, sourceKind.

list_all_cloudbeds_allocation_transactions

List available transactions for allocations in Cloudbeds, filtered by source and optionally by folio, document, or status. Returns: id, status, transactionDate, internalCode, sourceId. Required: sourceId, sourceKind. Max 100 results per page.

list_all_cloudbeds_allocations

List payment allocation transactions in Cloudbeds, with optional filters by source IDs, source identifiers, source kind, or receipt IDs. Returns allocation records with id and content-specific allocation attributes.

create_a_cloudbeds_allotment_block_note

Create a note on an allotment block in Cloudbeds. Returns: success, data.

list_all_cloudbeds_allotment_block_notes

List notes added to an allotment block in Cloudbeds. Returns each note's noteID, text, and status. PageSize must be between 1 and 100. Required: propertyID, allotmentBlockCode.

update_a_cloudbeds_allotment_block_note_by_id

Update a note on an allotment block in Cloudbeds by modifying its text or status. Returns: success, data.

create_a_cloudbeds_allotment_block

Create an allotment block in Cloudbeds associated with a group profile or event. Returns: resources. ratePlanId is required when rateType is rate_plan; resources are ignored when the spaces-allotment-blocks flag is off.

list_all_cloudbeds_allotment_blocks

List allotment blocks in Cloudbeds with optional filters by code, name, status, type, group, event, room type, and date interval. Returns: resources. Required: propertyID.

update_a_cloudbeds_allotment_block_by_id

Update an allotment block in Cloudbeds by its block code, modifying name, status, allotment type, intervals, auto-release settings, and space resource quotes. Returns: resources.

delete_a_cloudbeds_allotment_block_by_id

Delete allotment blocks in Cloudbeds by identifying the target block with its property and block code. Returns: success.

list_all_cloudbeds_amenities

List all amenities in the Cloudbeds amenity catalog filtered by scope (property or room), each with its code, translated name, and category code. Returns: name. Required: scope.

list_all_cloudbeds_amenity_categories

List Cloudbeds amenity categories for a specified scope (property or room), each with its code and translated name. Returns: name. Required: scope.

create_a_cloudbeds_app_error

Submit an application error received by a hybrid integration from the partner to Cloudbeds MFD. The request body is sent as application/x-www-form-urlencoded; specific request and response field names are not documented in the available source.

list_all_cloudbeds_app_property_settings

Get app property settings for a Cloudbeds property, optionally filtered by a specific key. Returns the app property settings. Required: propertyID.

create_a_cloudbeds_app_property_setting

Create or set app property settings for a Cloudbeds property by specifying a key-value pair scoped to an application client. Returns: success, data.

update_a_cloudbeds_app_property_setting_by_id

Create or update an app property setting in Cloudbeds by supplying a property ID, key, and value. Returns a 200 response; the response body schema is not documented with example fields in the source.

delete_a_cloudbeds_app_property_setting_by_id

Delete app property settings in Cloudbeds by submitting a form-encoded request with the property and key identifiers of the setting to remove. Returns a JSON response; the response field structure is not documented in the available API reference.

list_all_cloudbeds_app_settings

Get the current app settings for a property in Cloudbeds. Returns the app settings data object whose fields are integration-specific and depend on the app's configuration. Accepts an optional propertyID to target a specific property.

list_all_cloudbeds_app_states

Get the current Cloudbeds app integration state for a property. Only available for third-party integration partners, not property client IDs.

cloudbeds_app_states_bulk_update

Update the app integration state for a property in Cloudbeds. Setting the state to 'disabled' removes all active sessions for the app. Returns: success. Only available for third-party integration partners, not property client IDs.

list_all_cloudbeds_attribute_tags

List attribute tags for Cloudbeds entities. Returns: id. Filter by entityId and entityType individually, or use the filters parameter for bulk queries supporting up to 500 entities per request.

create_a_cloudbeds_attribute_tag

Attach attribute tags to a Cloudbeds entity. Returns an array of created tag objects including id, entityId, entityType, propertyId, attributeId, and a nested attribute object. Required: entityId, entityType, attributeIds.

delete_a_cloudbeds_attribute_tag_by_id

Delete a single attribute tag in Cloudbeds by id. Returns an empty 204 response on success. Required: id.

cloudbeds_attribute_tags_bulk_delete

Delete multiple attribute tags in Cloudbeds by providing a list of tag IDs. Returns an empty 204 response on success. Required: ids.

cloudbeds_attribute_tags_search

Bulk-lookup tags for a list of Cloudbeds entities grouped by type. Returns an array of tag objects including id, entityId, entityType, propertyId, attributeId, and a nested attribute object with id, label, description, entityTypes, and isEnabled. Required: entities. Total ids across all groups must not exceed 1000.

list_all_cloudbeds_attributes

List attribute tagging attributes in Cloudbeds. Returns: id, label, description, entityTypes, isEnabled. Supports filtering by entityTypes and sorting by label, createdAt, or updatedAt.

create_a_cloudbeds_attribute

Create a new attribute tagging attribute in Cloudbeds. Returns: id, label, description, entityTypes, isEnabled. Required: label, entityTypes.

update_a_cloudbeds_attribute_by_id

Update an existing attribute tagging attribute in Cloudbeds by id. Returns: id, label, description, entityTypes, isEnabled. Required: id.

delete_a_cloudbeds_attribute_by_id

Delete a Cloudbeds attribute tagging attribute by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_available_room_types

List available room types in Cloudbeds for a given date range and occupancy. Returns available room types with pricing and availability details for the specified stay period. Required: startDate, endDate, rooms, adults, children.

create_a_cloudbeds_card_token

Tokenize a card in Cloudbeds by submitting card data along with optional billing details; the tokenized payment method is securely stored for future transactions. Returns the tokenized card response object. Required: card_number, cvv, cardholder_name, expiration.

create_a_cloudbeds_charge

Process a payment using a payment method on a Cloudbeds reservation, group profile, accounts receivable ledger, or house account. Returns: success, data.

list_all_cloudbeds_charts

List Cloudbeds charts across all data sources with optional filtering by chart kind, datasource kind, tags, and datasets. Returns: id, created_at, updated_at. Max 100 per page.

cloudbeds_charts_search

Search Cloudbeds charts by text across title, datasource_title, and datasource_description fields, with all the same filters available on list. Returns: id, created_at, updated_at. Max 100 per page.

create_a_cloudbeds_check_gratuity

Post one or more guest tips to an existing Cloudbeds check by check_id. The gratuity entries inherit the check's folio target and checkNumber; POS context stays on the linked check. Returns: notice. Requires an Idempotency-Key header for request deduplication. Required: check_id, gratuities.

list_all_cloudbeds_connected_applications

List connected API clients (applications) for a Cloudbeds property, optionally filtered by OAuth scopes.

create_a_cloudbeds_credit_card

Post a credit card in Cloudbeds to store payment details. Accepts a form-encoded request body per the PostCardRequest schema and returns a JSON response per the PostCardResponse schema. Field definitions are available in the upstream OpenAPI specification.

create_a_cloudbeds_credit_note

Create a credit note fiscal document in Cloudbeds. Returns the created document summary including id, documentKind, and status. Requires a credit note request body (CreateCreditNoteRequest). Required: invoiceId, method.

cloudbeds_credit_notes_preview

Get a preview of a Cloudbeds fiscal document of type credit note. Returns a binary file download (application/octet-stream) with a Content-Disposition header indicating inline or attachment disposition. A JSON request body is required. Required: invoiceId, method.

list_all_cloudbeds_currency_settings

Get currency settings for a Cloudbeds property. Accepts an optional propertyID query parameter to target a specific property.

list_all_cloudbeds_custom_fields

List custom fields in Cloudbeds. Returns each field with customFieldID, name, shortcode, type, displayed, applyTo, required, maxCharacters, and isPersonal. The displayed array indicates where the field appears (booking engine, reservation folio, or registration cards). Filter by propertyID, customFieldID, or shortcode.

create_a_cloudbeds_custom_field

Create a custom field in Cloudbeds to add a new field definition to the system. Returns: success, data, message. The call should only be made once per field.

list_all_cloudbeds_custom_general_ledger_codes

List all custom general ledger (GL) codes configured for a Cloudbeds property, used to map Cloudbeds transaction categories to your own chart-of-accounts structure for reporting and export. Returns: id.

cloudbeds_custom_general_ledger_codes_bulk_update

Create or update custom general ledger (GL) codes for a Cloudbeds property by sending the full list of codes to persist; each code must have a unique name and code value, and can be assigned to a group or archived. Returns an empty 200 response on success.

cloudbeds_custom_items_append

Append one or more custom items and their associated payments to an existing item in a Cloudbeds reservation, house account, or group. Returns a response object whose fields are defined by the upstream PostAppendCustomItemResponse OpenAPI schema; the request body is sent as application/x-www-form-urlencoded per the upstream PostAppendCustomItemRequest schema.

list_all_cloudbeds_custom_items

List custom items for a specific Cloudbeds property. Returns a paginated list of custom item records with their id, name, and pricing details. Supports optional dynamic filters formatted as semicolon-separated field:value pairs. Max 500 items per page.

list_all_cloudbeds_custom_transaction_codes

List custom transaction code mappings for a Cloudbeds property. Custom transaction codes let you assign your own codes to each internal transaction type (e.g., room rate, tax, payment method). Returns: id. You must call the initialize endpoint before codes can be retrieved for the first time.

cloudbeds_custom_transaction_codes_bulk_update

Update custom transaction code mappings for a Cloudbeds property. For each mapping, provide the record ID and the new custom code value; a custom general ledger code can optionally be assigned. Only the mappings included in the request are updated; others remain unchanged. Returns an empty 200 response on success.

cloudbeds_custom_transaction_codes_initialize

Initialize custom transaction code records for a property in Cloudbeds. Must be called before retrieving or updating custom transaction codes; creates a record for each internal transaction type with an empty custom code mapping. Has no additional effect if codes have already been initialized. Returns an empty 200 response on success.

list_all_cloudbeds_dashboards

Get the Cloudbeds hotel dashboard for a given property and date. Returns the hotel dashboard object with basic state information; the exact field set is defined by the GetDashboardResponse schema upstream in Cloudbeds and is not enumerated in the integration's API documentation. Both propertyID and date are optional.

get_single_cloudbeds_dataset_cdf_by_id

Get the picklist options for a specific Cloudbeds Data Field (CDF) within a dataset. Returns the available option values for the specified CDF column. reservation_status). Required: id, dataset_id.

get_single_cloudbeds_dataset_multi_level_cdf_by_id

Get the CDF (Cloudbeds Data Field) picklist options for a specific multi-level within a Cloudbeds dataset. Returns the CDFOptions object containing available picklist values for the requested CDF. Required: dataset_id, multi_level_id, id.

list_all_cloudbeds_dataset_multi_levels

List all multi-levels associated with a Cloudbeds dataset in the Data Insights API. Multi-levels are sub-groupings within a dataset (e.g., Room Reservation under Reservations) that organize associated CDFs. Some datasets may have no multi-levels. Returns: id. Required: dataset_id.

get_single_cloudbeds_dataset_multi_level_by_id

Get a single multi-level for a Cloudbeds dataset in the Data Insights API. The multi-level organizes associated CDFs (Cloudbeds Data Fields) within the dataset hierarchy. Returns: id. Required: dataset_id, id.

list_all_cloudbeds_dataset_update_times

Get the last time a Cloudbeds property received a Data Insights event for a specific dataset. Returns: updated_at. Required: dataset_id.

list_all_cloudbeds_datasets

List all available Cloudbeds Data Insights datasets such as Financial, Guest, Reservations, Occupancy, Payments, Invoices, and Housekeeping.

get_single_cloudbeds_dataset_by_id

Get a single Cloudbeds Data Insights dataset by id, including its CDF (Cloudbeds Data Field) information and the last time the dataset was refreshed. CDFs may be grouped by category. Returns: description. Required: id.

list_all_cloudbeds_deposit_balances

Get the deposit balance for a specific source or the entire Cloudbeds property. Returns: postedBalance. When sourceId is provided, sourceKind must also be supplied; omit both for the aggregate property-wide balance.

list_all_cloudbeds_deposit_transactions

List Cloudbeds deposit transactions for a property with filters for transaction state, reservation, date ranges, reservation status, and user. Returns: id.

create_a_cloudbeds_deposit_transfer

Transfer one or more Cloudbeds deposit transactions to the guest ledger by providing the transaction IDs of the deposits to transfer in the request body. The operation is processed asynchronously and returns an event ID you can use to track the result.

list_all_cloudbeds_door_lock_keys

List Cloudbeds doorlock keys for a specific property, optionally filtered by reservation, sub-reservation, or key IDs. Returns: keyId, propertyId, reservationId, startDateTime, endDateTime, keyType, rooms. Required: property_id.

create_a_cloudbeds_door_lock_key

Create a new Cloudbeds doorlock key. Returns the created key including keyId, propertyId, reservationId, subReservationId, issuerId, startDateTime, endDateTime, encoder, keyType, code, rooms, commonRooms, externalId, mobileId, and guestId. Required: propertyId, reservationId, subReservationId, issuerId, startDateTime, endDateTime, keyType.

update_a_cloudbeds_door_lock_key_by_id

Update a Cloudbeds doorlock key by id. Returns the updated key including keyId, propertyId, reservationId, startDateTime, endDateTime, keyType, and rooms. Required: id.

delete_a_cloudbeds_door_lock_key_by_id

Delete a Cloudbeds doorlock key by id. Returns an empty 204 response on success. Required: id.

cloudbeds_door_lock_keys_bulk_delete

Delete multiple Cloudbeds doorlock keys at once by specifying a comma-separated list of key IDs. Returns an empty 204 response on success. Required: keyIds.

get_single_cloudbeds_door_lock_setting_by_id

Get doorlock settings for a specific property and application client in Cloudbeds. Returns the doorlock settings object including its id. Required: id.

update_a_cloudbeds_door_lock_setting_by_id

Upsert doorlock settings for a specific property and application client in Cloudbeds. Returns an empty 201 response on success. Required: id, encoders, keyTypes, commonRooms.

delete_a_cloudbeds_door_lock_setting_by_id

Delete doorlock settings for a specific property and application client in Cloudbeds. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_email_schedules

List all existing email schedules in Cloudbeds. Returns email schedule records, each including an id and schedule-specific attributes. Only available for third-party integration partners, not for property client IDs.

create_a_cloudbeds_email_schedule

Create a new email schedule for an existing Cloudbeds email template, triggered by either a reservation status change (e.g., confirmed) or a reservation event offset (e.g., after_check_out). The response shape is not documented in the available source. Exactly one of reservationStatusChange or reservationEvent must be provided (mutually exclusive). Only available for third-party integration…

list_all_cloudbeds_email_templates

List all existing email templates in Cloudbeds. Returns: name, subject. Only available for third-party integration partners, not for property client IDs.

create_a_cloudbeds_email_template

Create a new email template in Cloudbeds. Returns the created email template object. This call is only available for third-party integration partners, not for property client IDs. See the Cloudbeds FAQ for the full list of available language parameters.

list_all_cloudbeds_event_notes

List notes for a Cloudbeds event. Returns: id, createdAt, updatedAt. Required: event_id. Set includeArchived to true to include archived notes.

create_a_cloudbeds_event_note

Create a new note for a Cloudbeds event. Returns: id, createdAt, updatedAt. Required: event_id, text.

update_a_cloudbeds_event_note_by_id

Update an existing note for a Cloudbeds event or archive it. Returns: id, createdAt, updatedAt. Required: event_id, id.

list_all_cloudbeds_events

List events for a property in Cloudbeds. Returns events with id, eventCode, profileId, status, startDate, endDate, and createdAt. Filter by eventCode, profileId, status, and date ranges. Max 100 per page.

create_a_cloudbeds_event

Create a new event in Cloudbeds, optionally associated with an existing group profile. Returns the created event including id, eventCode, profileId, status, startDate, endDate, and createdAt. Required: name, sourceId.

get_single_cloudbeds_event_by_id

Get a single Cloudbeds event by id. Returns event details including id, eventCode, profileId, status, startDate, endDate, and createdAt. Required: id.

update_a_cloudbeds_event_by_id

Update an existing Cloudbeds event by id. Only provided fields are updated; for profileId, omit to keep, null to clear, or provide a string to replace. Returns the updated event including id, eventCode, profileId, status, startDate, endDate, and createdAt. Required: id.

delete_a_cloudbeds_event_by_id

Delete a Cloudbeds event by id. This is a soft delete. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_favorites

List all Cloudbeds report favorites for the authorized user on a specific property. Returns: id.

create_a_cloudbeds_favorite

Create a Cloudbeds report favorite for the authorized user. Returns: id. Maximum of 12 favorites per property; duplicate rank values shift existing favorites. Required: rank.

get_single_cloudbeds_favorite_by_id

Get a single Cloudbeds report favorite by id. Returns: id. Required: id.

update_a_cloudbeds_favorite_by_id

Update the rank of a Cloudbeds report favorite by id. Returns: id. Required: id, rank. If the new rank is already occupied, the positions are swapped.

delete_a_cloudbeds_favorite_by_id

Delete a Cloudbeds report favorite by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_files

List files attached to a hotel or group profile in Cloudbeds, ordered by creation date. Returns each file's name, type, source, and date. Max 100 results per page.

create_a_cloudbeds_file

Attach a file to a hotel in Cloudbeds by uploading it as a multipart form body. Returns: success, message, data.

list_all_cloudbeds_fiscal_channels

List fiscal channels available for a specific country in Cloudbeds. Returns the available fiscal channels for the given country, each identified by a channel_code. Required: country_code.

list_all_cloudbeds_fiscal_countries

List supported countries available for Cloudbeds fiscalization. No required parameters.

list_all_cloudbeds_fiscal_document_configs

List fiscal document configs for a Cloudbeds property.

update_a_cloudbeds_fiscal_document_config_by_id

Update a fiscal document config for a specific document kind in Cloudbeds. Required: id, showDetailedTaxFee, chargeBreakdown, useGuestLang, showLegalCompanyName, includeRoomNumber, useDocumentNumber, isCompact.

cloudbeds_fiscal_document_configs_preview

Get a PDF document preview from Cloudbeds. Builds and returns the rendered PDF document as a binary file download (application/octet-stream). The response includes a Content-Disposition header indicating whether the file should be displayed inline or as an attachment.

list_all_cloudbeds_fiscal_document_discrepancy_summaries

Get the count of Cloudbeds fiscal documents that have discrepancies, filtered by a specific source. Required: sourceId, sourceKind.

list_all_cloudbeds_fiscal_document_logos

Get the logo image used in fiscal document templates in Cloudbeds, returned as a presigned URL. Returns: logoUrl.

create_a_cloudbeds_fiscal_document_logo

Upload a logo image file for fiscal document templates in Cloudbeds. Returns an empty 204 response on success. Required: file.

cloudbeds_fiscal_document_logos_crop

Crop a previously uploaded logo for fiscal document templates in Cloudbeds. The original image is preserved; output is stored as PNG and resized to at most 1000 px on the longest dimension. Returns a 200 response with no body on success. Required: crop_param.

cloudbeds_fiscal_document_logos_bulk_delete

Delete the logo image used in fiscal document templates in Cloudbeds. Returns an empty 204 response on success.

list_all_cloudbeds_fiscal_document_recipients

List recipients associated to a Cloudbeds fiscal document. Returns a list of FiscalDocumentRecipient objects including id. Required: fiscal_document_id.

list_all_cloudbeds_fiscal_document_rules

Get Cloudbeds fiscal document creation rules (field definitions) for a given document kind, describing the fields the UI must collect when creating a document of that kind. Required: documentKind.

list_all_cloudbeds_fiscal_document_transaction_summaries

Get totals of transactions for a given fiscal document in Cloudbeds. Returns a FiscalDocumentTransactionsSummary object with aggregated transaction totals for the specified document. Required: fiscal_document_id.

list_all_cloudbeds_fiscal_document_transactions

List transactions for a specific Cloudbeds fiscal document. Returns: id. Required: fiscal_document_id. Max 100 per page.

list_all_cloudbeds_fiscal_documents

List fiscal documents in Cloudbeds filtered by optional criteria. Returns: id, createdAt. Supports sorting by createdAt, dueDate, invoiceDate, kind, or status in ascending or descending order.

update_a_cloudbeds_fiscal_document_by_id

Update a Cloudbeds fiscal document's status, government integration details, or failure reason by id. Returns: id. Required: id. CANCEL_REQUESTED for invoice cancellation is available for Spanish properties only; only OPEN, PAID, PARTIALLY_PAID, or CORRECTION_NEEDED invoices can be canceled.

cloudbeds_fiscal_documents_download

Download a fiscal document file from Cloudbeds by its fiscal document id. Returns the fiscal document as a binary file (application/octet-stream) with a Content-Disposition header indicating whether the content should be displayed inline or as an attachment. Required: fiscal_document_id.

cloudbeds_fiscal_documents_email

Send a Cloudbeds fiscal document (invoice) to a customer by email, initiating the delivery process. Returns a generic success object (200 OK) whose fields are not documented in the spec. Required: fiscal_document_id, emails.

cloudbeds_fiscal_documents_set_require_attention

Update the requireAttention flag on a Cloudbeds fiscal document. Returns the updated fiscal document summary including id, documentKind, status, and requireAttention. Required: fiscal_document_id, requireAttention.

list_all_cloudbeds_fiscal_property_features

Get enabled feature flags for the current user and property in Cloudbeds. Returns a map of feature flag names to boolean values, e.g. INTEGRATION_INVOICING. The property context is supplied via the X-PROPERTY-ID header which Truto manages automatically.

list_all_cloudbeds_fiscal_providers

List fiscalization providers available for a given country and channel in Cloudbeds. Returns the list of providers available for the specified country and channel. Required: country_code, channel_code.

list_all_cloudbeds_fiscal_transaction_summaries

Get totals of selected available transactions for fiscal documents in Cloudbeds, with support for partial transaction amounts via transactionIdToAmount. Required: sourceId, sourceKind.

list_all_cloudbeds_fiscal_transactions

List available transactions for fiscal documents in Cloudbeds, filtered by source and document kind. Returns: id. Required: sourceId, sourceKind. forDocumentType is deprecated; use documentKind instead. Transactions already included in fiscal documents are excluded unless showInvoiced is true.

list_all_cloudbeds_fiscalization_connection_certificates

Get certificate status for a connection. Returns: verified, createdAt, updatedAt, expiresAt, providerValid, invalidReason. Required: connection_id.

create_a_cloudbeds_fiscalization_connection_certificate

Upload a certificate for a connection. Required: connection_id, file.

list_all_cloudbeds_fiscalization_connection_drafts

List in-progress fiscalization connection drafts for a property in Cloudbeds. Returns each draft's id and attributes containing registration data.

update_a_cloudbeds_fiscalization_connection_draft_by_id

Upsert a fiscalization connection registration draft in Cloudbeds by id (providerId). Accepts a JSON request body with registration draft data and returns the upserted draft including its id and attributes. Required: id, data.

delete_a_cloudbeds_fiscalization_connection_draft_by_id

Discard a fiscalization connection registration draft in Cloudbeds by id (providerId). Returns an empty 204 response on success. Required: id.

create_a_cloudbeds_fiscalization_connection_logo

Upload the branding logo for a connection. Returns: logoUrl, originalLogoUrl. Required: connection_id, file.

cloudbeds_fiscalization_connection_logos_bulk_delete

Delete the branding logo for a connection. Required: connection_id.

list_all_cloudbeds_fiscalization_connection_section_rules

Get section rules and schema. Required: connection_id, section_key.

get_single_cloudbeds_fiscalization_connection_section_by_id

Get section configuration. Required: id, connection_id.

update_a_cloudbeds_fiscalization_connection_section_by_id

Update section configuration. Returns: id, status, detail, label, taxId, connectedAt, pausedAt, authorization. Required: id, connection_id.

list_all_cloudbeds_fiscalization_connections

List fiscalization connections for a property in Cloudbeds. Returns each connection with its id, status, and providerId. The optional drafts parameter controls whether draft connections are included.

create_a_cloudbeds_fiscalization_connection

Create a fiscalization connection in Cloudbeds. Returns the created connection with id, status, and providerId. Returns 409 if the provider is already connected for the property. Required: providerId, data.

get_single_cloudbeds_fiscalization_connection_by_id

Get a single fiscalization connection by id in Cloudbeds. Returns: id. Required: id.

update_a_cloudbeds_fiscalization_connection_by_id

Update a fiscalization connection by id in Cloudbeds. Returns the updated connection with id, status, and providerId. Required: id.

delete_a_cloudbeds_fiscalization_connection_by_id

Disconnect a fiscalization connection by id in Cloudbeds. Returns an empty 204 response on success. Required: id.

cloudbeds_fiscalization_connections_activate

Activate a verifying fiscalization connection in Cloudbeds. Returns the updated FiscalConnection object including its id and provider-specific attributes. Required: connection_id.

cloudbeds_fiscalization_connections_pause

Pause an active fiscalization connection in Cloudbeds. Returns the updated FiscalConnection object including its id and provider-specific attributes. Required: connection_id.

cloudbeds_fiscalization_connections_resume

Resume a paused fiscalization connection in Cloudbeds. Returns the updated connection object including its id, status, and updated_at. Required: connection_id.

cloudbeds_fiscalization_connections_test

Test a Cloudbeds fiscalization connection to the tax authority. Returns the connection test result. Required: connection_id.

cloudbeds_fiscalization_connections_activate_series

Activate a series on a connection. Returns: series. Required: connection_id, seriesCode.

cloudbeds_fiscalization_connections_deactivate_series

Deactivate a series on a connection. Returns: series. Required: connection_id, seriesCode.

get_single_cloudbeds_fiscalization_report_by_id

Download a country-specific fiscalization report from Cloudbeds (e.g., SAF-T for Portugal). Returns a binary XML file with the download filename specified in the Content-Disposition header. "saft"), year. Period defaults to 0 (full year); use 1–12 for monthly reports. Required: id, year.

list_all_cloudbeds_fiscalization_routes

List all fiscalization routing rules for a Cloudbeds property. Returns each routing rule identified by country_code, channel_code, and flow_id.

cloudbeds_fiscalization_routes_bulk_update

Bulk-replace all fiscalization routing rules for a Cloudbeds property by submitting the full set of rules. Returns the updated routing rules with country_code, channel_code, and flow_id. Required: routing.

update_a_cloudbeds_fiscalization_route_by_id

Update a single fiscalization routing rule in Cloudbeds identified by country code, channel code, and flow id. Returns the updated rule with country_code, channel_code, and flow_id. Required: country_code, channel_code, id.

list_all_cloudbeds_fiscalization_status

Check whether a Cloudbeds property is ready to issue fiscal documents. Returns the fiscalization status response object whose attributes contain provider-specific readiness fields defined in the upstream FiscalizationStatusResponse schema.

create_a_cloudbeds_folder_report

Assign a report to a Cloudbeds Data Insights folder to organize reports. Returns the updated folder object including id and name. Required: folder_id, report_id.

delete_a_cloudbeds_folder_report_by_id

Remove a report assignment from a Cloudbeds Data Insights folder. Returns an empty 204 response on success. Required: id, folder_id.

list_all_cloudbeds_folders

List all report folders created under a Cloudbeds property. Returns: id, name, parent_id.

create_a_cloudbeds_folder

Create a report folder for a Cloudbeds property. Returns: id, name, parent_id. Folder names must be unique and maximum nesting depth is 3 levels. Required: name, parent_id.

get_single_cloudbeds_folder_by_id

Get a single Cloudbeds report folder by id. Returns: id, name, parent_id. Required: id.

update_a_cloudbeds_folder_by_id

Update a Cloudbeds report folder by id. Returns: id, name, parent_id. A folder cannot have itself as parent_id, names must be unique, and maximum nesting depth is 3 levels. Required: id, name, parent_id.

delete_a_cloudbeds_folder_by_id

Delete a Cloudbeds report folder by id. The folder must not have assigned reports or a parent_id. Returns an empty 204 response on success. Required: id.

create_a_cloudbeds_folio_check

Post a completed POS check (e.g., F&B) to a guest folio, house account, or group profile in Cloudbeds. Items are recorded as regular folio items tagged as POS-originated, not Custom Items. Returns: checkId, checkNumber, notice.

delete_a_cloudbeds_folio_check_by_id

Void a posted Cloudbeds check by id, reversing its ledger entries, payments, and linked gratuities end-to-end. Returns an empty 204 response on success. Idempotent — voiding an already-voided check also returns 204. Required: id.

list_all_cloudbeds_folio_configuration_sources

Get which folio configuration is assigned to a source in Cloudbeds. Returns: sourceId, sourceKind, folioConfigurationId. Required: sourceId, sourceKind.

cloudbeds_folio_configuration_sources_bulk_update

Assign a folio configuration to a source in Cloudbeds, replacing existing folios for that source. Returns the updated folio configuration to source assignment including sourceId, sourceKind, and folioConfigurationId. Requires a JSON request body with the assignment details. Required: configId, sourceId, sourceKind.

list_all_cloudbeds_folio_configurations

List all folio configurations for a property in Cloudbeds. Returns: id, description. The optional includeFolios parameter controls whether folios and their transaction types are included in the response.

get_single_cloudbeds_folio_configuration_by_id

Get a single folio configuration by id in Cloudbeds. Returns: id, description. Required: id. The optional includeFolios parameter controls whether folios and their transaction types are included.

cloudbeds_folio_configurations_bulk_update

Create or update a folio configuration in Cloudbeds. To update an existing configuration, include its id in the request body. Returns: id. The optional propagateDownstream parameter controls whether changes propagate to downstream reservation and group folios.

update_a_cloudbeds_folio_configuration_by_id

Partially update a folio configuration in Cloudbeds. Only provided fields are updated. Returns: id, name, description, isDefault, folios. Required: id.

delete_a_cloudbeds_folio_configuration_by_id

Delete a folio configuration by id in Cloudbeds. The default configuration cannot be deleted; set another configuration as default first. Existing folios created from this configuration are not affected. Returns an empty 204 response on success. Required: id.

create_a_cloudbeds_folio_gratuity

Post one or more guest tips to a folio, house account, or group profile in Cloudbeds. Returns: notice. The request body must specify a folio target and one or more gratuity entries; each entry may include a partner-supplied gratuityId, taxId, and recipient userId. Required: gratuities.

delete_a_cloudbeds_folio_gratuity_by_id

Void a posted gratuity by its gratuityId in Cloudbeds. Returns an empty 204 response on success. Required: id.

cloudbeds_folio_items_void

Void an item transaction in Cloudbeds by itemID on a specified reservation, house account, or group. Payments previously posted via postItem or postCustomItem for the voided item are also deleted. Returns: success, message. One of reservationID, houseAccountID, or groupID must also be provided.

create_a_cloudbeds_folio_item

Post one or more items to a reservation, house account, or group profile in Cloudbeds. Supports batch operations allowing multiple items in a single request, each with optional associated payments and custom pricing. Returns the successfully posted items. Required: items.

list_all_cloudbeds_folio_routing_rules

List Cloudbeds autorouting rules configured for a group profile. Returns an array of routing rules, each including id, sourceId, sourceKind, and subSourceId. Required: sourceId. The sourceKind parameter is deprecated and defaults to GROUP_PROFILE.

create_a_cloudbeds_folio_routing_rule

Create a new Cloudbeds autorouting rule for a group profile that defines which transaction types are automatically routed from reservations to a group profile folio. Returns the created rule including id, sourceId, sourceKind, and subSourceId. Required: sourceId, rules.

cloudbeds_folio_routing_rules_bulk_update

Update or create Cloudbeds autorouting rules for a group profile. Entries with an id are updated; entries without an id are created as new rules. Returns the updated rule including id, sourceId, sourceKind, and subSourceId. Required: rules.

list_all_cloudbeds_folio_summaries

List Cloudbeds folio balance summaries for a given source (reservation or group profile). Each entry contains the folio's ID and balance due, computed from posted and pending transactions assigned to the folio. Returns: folioId, balanceDue. Required: filter.

list_all_cloudbeds_folio_transaction_filters

Get the structured filter tree of routable transaction types for folio configuration in Cloudbeds. Labels are localized via the Accept-Language header.

list_all_cloudbeds_folio_transactions

Search posted and pending folio transactions for a Cloudbeds source (reservation, group profile, or house account) using POST-based filter and grouping criteria. Results are always wrapped in groups; groups at page boundaries may be partial. Required: sourceId, sourceKind.

cloudbeds_folio_transactions_move

Move transactions to a different folio within the same source in Cloudbeds. Accepts individual transaction IDs or transaction types (by origin ID and external relation kind) to move all matching transactions at once. Returns an empty 200 response on success. At least one of transactions or transactionTypes must be provided. Required: sourceKind, sourceId, targetFolioId.

cloudbeds_folio_transactions_route

Route Cloudbeds reservation transactions to a group profile folio, binding them to the group profile and assigning them to the specified folio. Specify individual transaction IDs via transactions or matching transaction types via transactionTypes (by origin ID and external relation kind); at least one of the two is required. Returns an empty 200 response on success. Required: reservationId, groupProfileId, targetFolioId.

cloudbeds_folio_transactions_unroute

Unroute transactions from a Cloudbeds group profile back to their original reservation, reversing a previous routing operation. Returns a 200 OK response with no response body on success. Only individual transaction IDs are accepted; transaction types are not supported. Required: transactions.

list_all_cloudbeds_folios

List all folios for a given source (reservation, group profile, or configuration) in Cloudbeds. Folios organize transactions into logical groups, such as separating room charges from incidentals. Returns: id, name. Both sourceId and sourceKind must be provided together to identify the source. Required: filter.

create_a_cloudbeds_folio

Create a new folio in Cloudbeds for a reservation, group profile, or configuration source. Returns the created folio including its id, name, source, and assigned transaction types. The optional propagateDownstream query parameter, when true with a CONFIG source, creates matching child folios for active reservations and…. Required: name, sourceId, sourceKind, transactionTypes.

update_a_cloudbeds_folio_by_id

Update an existing Cloudbeds folio by id, changing the folio name and the transaction types assigned to it. Returns an empty 204 response on success. Required: id. Only the name and transaction types can be modified; source and configuration cannot be changed after creation.

delete_a_cloudbeds_folio_by_id

Delete a Cloudbeds folio by id. The folio is soft-deleted and no longer appears in listings. Returns an empty 204 response on success. Required: id. Cannot delete a folio that still has transactions assigned to it; move or unroute all transactions first.

cloudbeds_folios_export_pdf

Export a folio's list of transactions as a PDF file in Cloudbeds. Returns a binary PDF file download. Required: sourceKind, sourceId.

cloudbeds_folios_download_pdf

Get a folio list of transactions exported as a PDF file in Cloudbeds. Returns a binary PDF file download (application/octet-stream) with a Content-Disposition header. Requires a JSON request body specifying the folio export criteria. Required: sourceKind, sourceId.

create_a_cloudbeds_government_receipt

Add a Government Receipt to a reservation or house account in Cloudbeds. Returns the created government receipt response.

list_all_cloudbeds_group_notes

List group notes for a specific group in Cloudbeds. Returns: success, code, data. Max 100 notes per page. Required: propertyID, eventCode, pageSize, pageNumber.

create_a_cloudbeds_group_note

Add a group note to a Cloudbeds group profile via a form-urlencoded request body. Returns: id, group_profile_id, text, created_by, created_at, updated_at, archived, archived_at.

create_a_cloudbeds_group_profile_balance_transfer

Transfer the outstanding balance of a Cloudbeds group profile to an accounts receivable (AR) ledger. Optionally specify a folio ID to transfer from a specific folio within the group profile. This operation is processed asynchronously. Returns: eventId. Required: accounts_receivable_ledger_id, group_profile_id.

list_all_cloudbeds_group_profile_contacts

List Cloudbeds group profile contact persons, optionally filtered by IDs, profile, name, or email. Returns: id, createdAt, updatedAt. Default sort: lastName:asc; valid sort fields include firstName, lastName, email, createdAt, and updatedAt.

create_a_cloudbeds_group_profile_contact

Create a new contact person in Cloudbeds and add it to a group, company, or travel agent profile. Returns: id, createdAt, updatedAt. Required: firstName, lastName, status.

get_single_cloudbeds_group_profile_contact_by_id

Get a single Cloudbeds contact person by id. Returns: id, createdAt, updatedAt. Required: id.

update_a_cloudbeds_group_profile_contact_by_id

Update a Cloudbeds contact person by id. Returns: id, createdAt, updatedAt. Required: id.

delete_a_cloudbeds_group_profile_contact_by_id

Delete a Cloudbeds contact person by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_group_profile_documents

List all documents for a Cloudbeds profile (group, company, or travel agent). Returns: id, fileName, createdAt, updatedAt. Required: profile_id. Default sort is createdAt:desc; valid sort fields are fileName, createdAt, and updatedAt.

create_a_cloudbeds_group_profile_document

Upload one or more documents to a Cloudbeds profile. Returns: id, fileName, createdAt, updatedAt. Required: profile_id, files, userId. Maximum 10MB per file; allowed types: .png, .doc, .docx, .xls, .xlsx, .pdf, .jpg, .jpeg, .gif, .csv.

get_single_cloudbeds_group_profile_document_by_id

Get metadata for a specific Cloudbeds profile document by id. Returns: id, fileName, createdAt, updatedAt. Required: profile_id, id.

delete_a_cloudbeds_group_profile_document_by_id

Delete a document from a Cloudbeds profile by id. Returns an empty 204 response on success. Required: profile_id, id.

cloudbeds_group_profile_documents_download

Get a pre-signed download URL for a Cloudbeds profile document file. Returns: downloadUrl. The URL is valid for 5 minutes. Required: profile_id, document_id.

list_all_cloudbeds_group_profile_notes

List notes for a Cloudbeds profile (group, company, or travel agent). Returns each note with id, profileId, userId, content, createdAt, and updatedAt. Required: profile_id. Defaults to returning only active notes unless the archived filter is set to ARCHIVED or ALL.

create_a_cloudbeds_group_profile_note

Create a new note for a Cloudbeds profile (group, company, or travel agent). Returns the created note including id, profileId, userId, content, createdAt, and updatedAt. Required: profile_id, userId, content.

get_single_cloudbeds_group_profile_note_by_id

Get a specific Cloudbeds profile note by id. Returns the note object including id, profileId, userId, content, createdAt, and updatedAt. Required: profile_id, id.

update_a_cloudbeds_group_profile_note_by_id

Update an existing note for a Cloudbeds profile. Returns the updated note including id, profileId, userId, content, createdAt, and updatedAt. Required: profile_id, id.

delete_a_cloudbeds_group_profile_note_by_id

Delete a note from a Cloudbeds profile. Returns an empty 204 response on success. Required: profile_id, id.

cloudbeds_group_profile_notes_archive

Archive a Cloudbeds profile note by setting the archived_at timestamp. Returns the archived note including id, profileId, userId, content, createdAt, and updatedAt. Archived notes can be restored later. Required: profile_id, note_id.

cloudbeds_group_profile_notes_restore

Restore an archived Cloudbeds profile note by unsetting the archived_at timestamp. Returns the restored note object including id, profileId, userId, content, createdAt, and updatedAt. Required: profile_id, note_id.

list_all_cloudbeds_group_profile_people

List all persons (contacts and guests) linked to a Cloudbeds profile. Required: profile_id. Default sort is createdAt:desc.

create_a_cloudbeds_group_profile_person

Create a new person relationship (contact or guest) for a Cloudbeds profile. Returns: profileId, personId, personType, role, startDate. Required: profile_id, personId, personType.

delete_a_cloudbeds_group_profile_person_by_id

Unlink a person from a Cloudbeds profile by id. Returns an empty 204 response on success. Required: id, profile_id, personType.

get_single_cloudbeds_group_profile_person_by_id

Find all Cloudbeds profile relationships where a person is the target (reverse lookup). Returns a list of profile-person relationships including profileId, personId, personType, role, startDate, createdAt, and updatedAt. Required: id, personType.

list_all_cloudbeds_group_profile_tags

List all tags assigned to a Cloudbeds group profile. Returns: id, profileId, tag. Required: profile_id.

create_a_cloudbeds_group_profile_tag

Assign a tag to a Cloudbeds group profile. Returns: id, profileId, tag. Required: profile_id, tag.

delete_a_cloudbeds_group_profile_tag_by_id

Delete a tag from a Cloudbeds group profile. Returns an empty 204 response on success. Required: profile_id, id.

list_all_cloudbeds_group_profiles

List all Cloudbeds group profiles across all types (company, group, or travel agent) with optional filters by status, profile type, name, or code. Returns: id, code, name, status, profileType, createdAt, updatedAt.

create_a_cloudbeds_group_profile

Create a new Cloudbeds group profile (company, group, or travel agent) based on the attributes provided in the request body. Returns the created profile including id, code, name, status, profileType, address, billing details, and type-specific attributes. Required: code, name, status.

get_single_cloudbeds_group_profile_by_id

Get a single Cloudbeds group profile by id. Returns the full profile object including id, code, name, status, profileType, address, billing details, and type-specific attributes. Required: id.

update_a_cloudbeds_group_profile_by_id

Update a Cloudbeds group profile by id. The profile type is determined from existing data and cannot be changed. Returns the updated profile including id, code, name, status, profileType, address, billing details, and type-specific attributes. Required: id, code, name, status.

delete_a_cloudbeds_group_profile_by_id

Delete a Cloudbeds group profile by id. The profile type is automatically determined. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_groups

List groups for a Cloudbeds property, with optional filters by group code, GPS profile ID, type, status, and creation date range. Returns: name, type, status, created, address1, address2, city, zip, state, contacts. Max 100 groups per page. Required: propertyID.

create_a_cloudbeds_group

Create a new group in Cloudbeds by adding it to the property. The default 'Route to Group Folio' setting is set to 'No' and 'Reservation Folio Configuration' uses the default folio configuration; both can be edited via the UI afterward. Returns a JSON response confirming the group was created.

update_a_cloudbeds_group_by_id

Update an existing group in Cloudbeds by providing new information. At least one information field must be supplied in the form-urlencoded request body. Returns: groupCode, name, type, status, created, sourceID, address1, address2, city, zip, state, id, property_id.

create_a_cloudbeds_guest_document

Attach a document to a guest in Cloudbeds by uploading a file via multipart form-data. Returns: success, message, data. Response field structure is defined in the upstream PostGuestDocumentResponse schema and is not fully enumerated in the available documentation.

list_all_cloudbeds_guest_notes

Retrieve all notes for a specific guest in Cloudbeds. Required: guestID.

create_a_cloudbeds_guest_note

Create a guest note in Cloudbeds for a specific guest. Returns: success, guestNoteID, message.

update_a_cloudbeds_guest_note_by_id

Update an existing guest note in Cloudbeds by providing the guest ID, note ID, and updated note text or status. Returns: success, message.

delete_a_cloudbeds_guest_note_by_id

Archive an existing guest note in Cloudbeds. Returns a 200 response on success. Required: guestID.

create_a_cloudbeds_guest_photo

Attach a photo to a guest in Cloudbeds. The request body is sent as multipart/form-data containing the guest identifier and photo file. Returns: success, message, data.

list_all_cloudbeds_guest_profile_custom_fields

List custom fields for a specific Cloudbeds profile. Returns: id, customFieldId, name, value, label, type, isPersonal, order, maxLen, required. Required: profile_id.

list_all_cloudbeds_guest_profile_filters

List available filter values for guest profiles in Cloudbeds. Returns: countries, guestStatuses.

list_all_cloudbeds_guest_profile_merge_suggestions

List suggested guest profile merges in Cloudbeds. Returns: suggestions. Filterable by profileId.

list_all_cloudbeds_guest_profile_merged_profiles

List profiles currently merged into a given Cloudbeds profile. Returns: profileId, mergeId, firstName, lastName, email, phone, isUnmergeEligible, mergedAt. Required: profile_id.

list_all_cloudbeds_guest_profile_merges

List guest profile merges in Cloudbeds. Returns: id. Filterable by mergedAt using colon-separated filter syntax (e.g. mergedAt:greater_than_or_equal:2024-07-17T14:00:00-08:00).

create_a_cloudbeds_guest_profile_merge

Merge guest profiles in Cloudbeds. Returns the created merge record including id, mergedAt, eventType, beforeMergeProfiles, and afterMergeProfiles. A JSON request body specifying the profiles to merge is required.

cloudbeds_guest_profile_merges_unmerge

Unmerge previously merged guest profiles in Cloudbeds by merge id. Returns the profile merge record including id, mergedAt, eventType, beforeMergeProfiles, and afterMergeProfiles with full guest profile details. Required: merge_id.

list_all_cloudbeds_guest_profile_pii_fields

Get the value of a personally identifiable information (PII) field for a specific Cloudbeds profile. Required: profile_id, fieldName.

list_all_cloudbeds_guest_profile_reservations

List reservations for a specific Cloudbeds guest profile. Returns: id. Required: profile_id.

list_all_cloudbeds_guest_profile_sources

List the sources of a Cloudbeds profile. Returns: name, date. Required: profile_id.

list_all_cloudbeds_guest_profile_stats

List Cloudbeds profile statistics for a given profile, optionally filtered by property. Returns: profileId, propertyId, reservations, nights, revenue, lastVisit. Required: profile_id.

list_all_cloudbeds_guest_profiles

List guest profiles in Cloudbeds. Returns: id, organizationId, photoId, taxId, companyTaxId, statusId, statusName, firstName, lastName, email, phone, cellPhone, birthday, gender, companyName, address1, address2, city, country, countryName, state, zip, documentType, documentNumber, documentIssueDate, documentIssuingCountry, documentExpirationDate, isOptIn, isMerged, isRepeatGuest.

create_a_cloudbeds_guest_profile

Create a new guest profile in Cloudbeds. Returns the created profile including id, firstName, lastName, email, phone, country, dateCreated, dateModified, and photo.

get_single_cloudbeds_guest_profile_by_id

Get a single guest profile by id in Cloudbeds. Returns: id, organizationId, photoId, taxId, companyTaxId, statusId, statusName, firstName, lastName, email, phone, cellPhone, birthday, gender, companyName, address1, address2, city, country, countryName, state, zip, documentType, documentNumber, documentIssueDate, documentIssuingCountry, documentExpirationDate, isOptIn, isMerged, isRepeatGuest. Required: id.

update_a_cloudbeds_guest_profile_by_id

Update a guest profile by id in Cloudbeds. Returns the updated profile including id, firstName, lastName, email, phone, country, dateCreated, dateModified, and photo. Required: id.

cloudbeds_guest_profiles_anonymize

Anonymize a Cloudbeds guest profile, replacing personally identifiable fields with masked or placeholder values. Returns the anonymized profile including id, firstName, lastName, email, dateCreated, dateModified, dateAnonymized. Required: profile_id. GDPR anonymization must be enabled for the organization's properties.

get_single_cloudbeds_guest_by_id

Get information about a specific guest in Cloudbeds by reservation ID or guest ID. Returns the guest record including its id and attributes containing guest profile and reservation information. Either reservationID or guestID must be provided.

list_all_cloudbeds_guests

List guests in Cloudbeds, ordered by modification date. Filterable by property, creation/modification date range, check-in/check-out date ranges, guest details (name, email, phone), and reservation status. Max 100 per page.

cloudbeds_guests_search

List guests in Cloudbeds matching the selected filter criteria such as status, reservation, room, name, and check-in/check-out date ranges. Returns: reservationID, roomID, guestName. Required: status.

create_a_cloudbeds_guest

Add an additional guest to an existing Cloudbeds reservation. Returns a JSON response confirming the guest was added to the reservation. The request body is form-encoded with guest and reservation details; see the Cloudbeds API reference for the full parameter list.

update_a_cloudbeds_guest_by_id

Update an existing guest in Cloudbeds with the information provided. At least one information field must be supplied in the request body. Returns: success, message.

cloudbeds_guests_assign

Assign guest(s) to a room in a Cloudbeds reservation, adding them as additional guests. Returns the guest-to-room assignment result. Request body is sent as form-urlencoded fields.

list_all_cloudbeds_guests_by_status

List Cloudbeds guests filtered by their current status — Not Checked In, In House, Checked Out, or Cancelled — sorted by modification date. Returns: guestID, reservationID, roomID. Max 100 per page. Required: status.

list_all_cloudbeds_hotels

List hotels in Cloudbeds, optionally filtered by property IDs, name, or city.

get_single_cloudbeds_hotel_by_id

Get the details of a specific Cloudbeds hotel (property) identified by propertyID. Returns: success, data.

list_all_cloudbeds_house_accounts

List active house accounts for a Cloudbeds property.

create_a_cloudbeds_house_account

Create a new house account in Cloudbeds by submitting form-encoded account data. Returns a JSON response confirming creation; the specific response fields are not documented in the available source.

update_a_cloudbeds_house_account_by_id

Update a specific Cloudbeds house account's status to either open or closed. Returns: success, message.

list_all_cloudbeds_housekeepers

List housekeepers for one or more Cloudbeds properties. Returns a list of housekeeper records with their identifiers and details per the GetHousekeepersResponse schema. Supports querying across multiple properties with comma-separated property IDs. Max 1000 results per page.

create_a_cloudbeds_housekeeper

Add a new housekeeper in Cloudbeds by submitting form-encoded data. Returns a JSON response with the result of the creation request. The request body is sent as application/x-www-form-urlencoded.

update_a_cloudbeds_housekeeper_by_id

Edit housekeeper details in Cloudbeds. Returns the updated housekeeper record with fields defined by the upstream PutHousekeeperResponse schema; the specific response fields are not enumerated in the available source — consult the Cloudbeds API reference for the complete field list. The request body uses form-urlencoded fields defined by the upstream PutHousekeeperRequest schema.

create_a_cloudbeds_housekeeping_assignment

Assign rooms (single or multiple) to an existing housekeeper in Cloudbeds. Returns a JSON response confirming the assignment; the specific response fields are not documented in the available source. The request body is sent as application/x-www-form-urlencoded.

list_all_cloudbeds_housekeeping_inspections

List housekeeping inspections for a Cloudbeds property. Required: property_id.

list_all_cloudbeds_housekeeping_statuses

List current-day housekeeping status for rooms in Cloudbeds. Returns per-room status including roomOccupied, roomCondition, roomBlocked, vacantPickup, refusedService, and doNotDisturb. Filter by property, room type, housekeeper, condition, or occupancy. Max page size 5000.

update_a_cloudbeds_housekeeping_status_by_id

PostHousekeepingStatus. Returns: success, data, message.

get_single_cloudbeds_hub_card_by_id

Get a Cloudbeds hub card by its card id within a hub. Returns the card object including its id, hub_id, chart_id, created_at, and updated_at. Required: id, hub_id.

create_a_cloudbeds_hub_card

Create a Cloudbeds hub card linking a hub to a chart. Returns the created card object including its id, hub_id, chart_id, created_at, and updated_at. Required: hub_id, chart_id.

update_a_cloudbeds_hub_card_by_id

Update a Cloudbeds hub card by id. Returns the updated card object including its id, hub_id, chart_id, created_at, and updated_at. Required: id, hub_id, chart_id.

delete_a_cloudbeds_hub_card_by_id

Delete a Cloudbeds hub card by id. Returns an empty 204 response on success. Required: hub_id, id.

list_all_cloudbeds_hubs

List all Cloudbeds data insights hubs. Returns: id, description, created_at, updated_at. Max 100 results per page.

create_a_cloudbeds_hub

Create a new Cloudbeds data insights hub. Returns: id, description, created_at, updated_at. Required: title.

get_single_cloudbeds_hub_by_id

Get a single Cloudbeds data insights hub by id. Returns: id, description, created_at, updated_at. Required: id.

update_a_cloudbeds_hub_by_id

Update a Cloudbeds data insights hub by id. Returns: id, description, created_at, updated_at. Required: id, title.

delete_a_cloudbeds_hub_by_id

Delete a Cloudbeds data insights hub by id. Returns an empty 204 response on success. Required: id.

cloudbeds_hubs_search

Search Cloudbeds Data Insights hubs by text term, title, description, or IDs. Returns hub records with id, title, description, created_at, and updated_at. Max 100 results per page.

cloudbeds_insights_search

Search across different Cloudbeds Data Insights resources (reports and stock reports). Required: filters, resources. Filters must be formatted as column:value (e.g. title:res); valid filter columns are title and description. Max…

list_all_cloudbeds_insights_explore

Ask a natural language question about a Cloudbeds Data Insights dataset and receive an AI-generated exploration result. Returns an Explore object with data content whose shape depends on the question and dataset queried. Required: question, dataset_id.

list_all_cloudbeds_insights_health

Check the health of the Cloudbeds Data Insights service, which performs checks on infrastructure service connections, host storage, application-specific logic, and direct dependencies.

list_all_cloudbeds_insights_liveness

Get the liveness probe of the Cloudbeds Data Insights service to verify the service is alive. Returns an opaque liveness response; the Liveness schema fields are not enumerated in the available source documentation.

list_all_cloudbeds_insights_me

Get profile data about the current Cloudbeds user from the Data Insights API.

list_all_cloudbeds_insights_me_policies

List policy data about the current user in Cloudbeds. Returns policy objects whose fields are defined in the upstream MePolicy schema; consult the Cloudbeds OpenAPI specification for the field-level breakdown.

list_all_cloudbeds_insights_me_properties

List Cloudbeds properties associated with the current user from the Data Insights API. Returns an array of property records, each containing an id and an attributes object with property-specific fields.

list_all_cloudbeds_insights_property_settings

List all property settings for a specific Cloudbeds property. Returns: name. Setting names include start_of_week and currency_cdf_rounding_precision.

get_single_cloudbeds_insights_property_setting_by_id

Get a specific Cloudbeds property setting by id. Returns: name, value. The setting name identifies the configuration option (e.g. start_of_week, currency_cdf_rounding_precision). Required: id.

update_a_cloudbeds_insights_property_setting_by_id

Update a Cloudbeds property setting by id. Valid setting names: start_of_week, currency_cdf_rounding_precision. Returns: name. Required: id, value.

list_all_cloudbeds_insights_tags

List all tags created under a Cloudbeds property. Returns: id, name.

create_a_cloudbeds_insights_tag

Create a new tag for a Cloudbeds property to organize and label reports. Returns: id, name. Required: name. Tags cannot be duplicated and are case-sensitive (Financial and financial are distinct tags).

update_a_cloudbeds_insights_tag_by_id

Update a Cloudbeds tag name by id; all reports using the tag will be updated with the new name. Returns: id, name. Required: id, name. Tags cannot be duplicated and are case-sensitive.

delete_a_cloudbeds_insights_tag_by_id

Delete a Cloudbeds tag by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_integration_events

List Cloudbeds integration event subscriptions for a specific property. Returns: id. Max 500 per page.

create_a_cloudbeds_integration_event

Create a new Cloudbeds integration event subscription. Returns: id. Required: objectType, system, status, result.

update_a_cloudbeds_integration_event_by_id

Update an existing integration event subscription in Cloudbeds by id. Returns the updated integration event including its id, key, event, subscriptionType, and subscriptionData. Required: id, status.

cloudbeds_integration_events_retry

Retry a Cloudbeds integration event by event_id, sending a request to re-process the event. Required: event_id.

list_all_cloudbeds_internal_transaction_codes

List all Cloudbeds internal transaction codes — system-defined codes that categorize each type of transaction such as room rate, tax, fee, and payment. These codes are read-only and can be mapped to custom codes via the custom transaction codes endpoints.

list_all_cloudbeds_invoice_allocations

List active receipt allocations for a specific Cloudbeds invoice, grouped by transaction ID. Returns allocations grouped by transactionId, including receipt and status details, with only those from receipts with active statuses included. Required: invoice_id.

create_a_cloudbeds_invoice

Create a fiscal document of type invoice in Cloudbeds. Returns the created fiscal document summary including id, kind, status, createdAt, invoiceDate, and dueDate. A JSON request body conforming to the CreateInvoiceRequest schema is required; use the fiscal documents rules endpoint to determine property-specific required fields. Required: transactionIds, sourceId, sourceKind.

cloudbeds_invoices_preview

Get a fiscal document preview of the type invoice in Cloudbeds. Returns the invoice preview as a binary PDF file download. A JSON request body is required. Required: transactionIds, sourceId, sourceKind.

list_all_cloudbeds_item_categories

List item categories in Cloudbeds.

create_a_cloudbeds_item_category

Create a new item category in Cloudbeds by submitting form-urlencoded data. Returns a 200 response on success.

list_all_cloudbeds_items

List all items and their prices created in Cloudbeds myfrontdesk. Returns: sku, name, description, price, taxes, fees. Taxes, fees, and totals appear only when items have assigned tax or fee.

get_single_cloudbeds_item_by_id

Get details for a single Cloudbeds item by itemID. Returns: success, data, message. Stock inventory fields appear only when data.stockInventory is true; taxes, fees, and totals appear only when the item has assigned tax or fee.

cloudbeds_items_bulk_create

Create a batch of new inventory items in Cloudbeds. Returns: success, data. Stock-related fields on the created items are populated only when the item's stockInventory flag is true.

update_a_cloudbeds_item_by_id

PutItemToInventory. Returns: success, message.

list_all_cloudbeds_market_segment_groups

List Cloudbeds market segmentation groups. Returns: id. Max 500 per page.

create_a_cloudbeds_market_segment_group

Create a new Cloudbeds market segmentation group. Returns: id. Required: name, code, description.

get_single_cloudbeds_market_segment_group_by_id

Get a single Cloudbeds market segmentation group by id. Returns: id. Required: id.

update_a_cloudbeds_market_segment_group_by_id

Update a Cloudbeds market segmentation group by id. Returns: id. Required: id, name, code, description.

delete_a_cloudbeds_market_segment_group_by_id

Delete a Cloudbeds market segmentation group by id. Returns an empty 204 response on success. Required: id.

cloudbeds_market_segment_groups_enable

Enable a Cloudbeds market segmentation group. Returns an empty 204 response on success. Required: group_id.

cloudbeds_market_segment_groups_disable

Disable a Cloudbeds market segmentation group. Returns an empty 204 response on success. Required: group_id.

list_all_cloudbeds_market_segment_reservations

List reservations linked to a Cloudbeds Market Segmentation Segment, filtered by active status. Required: segment_id, active.

list_all_cloudbeds_market_segments

List Cloudbeds market segmentation segments filtered by enabled status. Returns: id. Required: enabled.

create_a_cloudbeds_market_segment

Create a new market segmentation segment in Cloudbeds. Returns: id. Required: groupId, name, code, description, isEnabled, ratePlanIds.

update_a_cloudbeds_market_segment_by_id

Update a Cloudbeds market segmentation segment by id. Returns: id. Required: id, groupId, name, code, description, isEnabled, ratePlanIds.

delete_a_cloudbeds_market_segment_by_id

Delete a Cloudbeds market segmentation segment by id. Returns an empty 204 response on success. Required: id.

cloudbeds_market_segments_enable

Enable a Cloudbeds market segmentation segment by id. Returns an empty 204 response on success. Required: segment_id.

cloudbeds_market_segments_disable

Disable a Market Segmentation Segment in Cloudbeds. Returns an empty 204 response on success. Required: segment_id.

cloudbeds_market_segments_set_default

Set a Cloudbeds Market Segmentation Segment as the default segment. Returns an empty 204 response on success. Required: segment_id.

list_all_cloudbeds_me

Get information about the Cloudbeds user who authorized the current API connection. Returns the user's attributes object including profile details and, when requested, role and ACL details. When role_details is set to true, property_id must also be provided.

list_all_cloudbeds_modified_guests

List Cloudbeds guests based on their modification date. Returns a list of guest records with guest, reservation, and room details. If no date range is passed, only the current day's records are returned. A guest assigned to multiple rooms produces multiple records. Max 100 results per page.

list_all_cloudbeds_oauth_metadata

Get Cloudbeds OAuth metadata to determine the precise location of the property associated with the provided access token, used for routing requests across multiple localizations.

list_all_cloudbeds_package_names

List billing package names for a Cloudbeds property. Returns a JSON response containing billing package names for the specified property; the exact response schema (GetPackagesResponse) is not fully documented in the available source.

list_all_cloudbeds_packages

List the packages associated with a Cloudbeds property, where each package defines a group of features the property can utilize or access. Returns the packages response object whose field structure is defined by the GetPackagesResponse schema; consult the Cloudbeds API reference for the field-level breakdown.

create_a_cloudbeds_pay_by_link

Create a Pay By Link in Cloudbeds. Returns the created pay by link object including its uuid. The request body schema is defined by the PblCreateRequest component in the Cloudbeds OpenAPI specification; consult the upstream spec for the full field-level breakdown. Required: paid, inventoryObject.

get_single_cloudbeds_pay_by_link_by_id

Retrieve a Pay By Link from Cloudbeds by id. Returns the pay by link object including its uuid. Required: id.

cloudbeds_payment_adjustments_preview

Preview how a folio adjustment (tax, fee, rate, or room-revenue) would affect Cloudbeds Smart Policy scheduled payments without actually applying the change. Returns the adjustment preview result object showing how the scheduled payments would be recalculated. Required: reservationId, adjustment.

list_all_cloudbeds_payment_capabilities

List the payment capabilities of a given Cloudbeds property. Returns the payment capabilities object with fields defined by the upstream GetPaymentsCapabilitiesResponse schema; the exact field set is not enumerated in the available source. The optional propertyID query parameter specifies the property to query.

list_all_cloudbeds_payment_element_keys

List Cloudbeds Payment Element API keys, optionally filtered by property or revocation status. Returns: identity, property_ids. The secret field is never included in list responses. Max 100 per page.

create_a_cloudbeds_payment_element_key

Issue a new Cloudbeds Payment Element API key scoped to one or more properties. Returns: identity, secret, property_ids. The secret is only returned once at creation time and cannot be retrieved later. Required: property_ids.

delete_a_cloudbeds_payment_element_key_by_id

Permanently revoke a Cloudbeds Payment Element API key by its identity. This action is irreversible. Required: id.

list_all_cloudbeds_payment_methods

List active payment methods for a Cloudbeds property or list of properties.

create_a_cloudbeds_payment_method

Add a custom payment method to a Cloudbeds property. This call does not support adding credit cards, bank transfer, or PayPal as payment methods. Returns a confirmation response for the created custom payment method.

create_a_cloudbeds_payment

Add a payment to a specified reservation, house account, or group in Cloudbeds. At least one of reservationID, houseAccountID, or groupCode must be provided; if multiple are given, precedence is reservationID, then houseAccountID, then groupCode. Returns a 200 response with the payment result (response schema not documented in the available source).

cloudbeds_payments_void

Void a payment in Cloudbeds by its paymentID, for a payment associated with a reservation or house account. Returns: success, message.

list_all_cloudbeds_pending_transactions

Search and retrieve pending (not yet posted) transactions for a Cloudbeds property using POST-based filter criteria. Returns a paginated list of transactions with id, transaction_datetime, service_date, customer_id, source_id, source_kind, and internal_code. Required: filters.

cloudbeds_policy_exception_eligible_rates_search

Search eligible rate plans and base rates with conflict info in Cloudbeds. Returns eligible rate plans and base rates with conflict information. Requires a search criteria request body. Required: startDate, endDate, intervals.

list_all_cloudbeds_policy_exceptions

List all Cloudbeds policy exceptions for a property. Returns: id. Supports dynamic filtering and multi-field sorting.

create_a_cloudbeds_policy_exception

Create a new Cloudbeds policy exception. Returns: id. A 409 conflict is returned if the exception overlaps with an existing one. Required: policyRootId, intervals, rates, name.

get_single_cloudbeds_policy_exception_by_id

Get a single Cloudbeds policy exception by id. Returns: id. Required: id.

update_a_cloudbeds_policy_exception_by_id

Update an existing Cloudbeds policy exception by id. Returns: id. A 409 conflict is returned if the updated exception overlaps with an existing one. Required: id, exceptionId, policyRootId, intervals, rates, name.

cloudbeds_policy_exceptions_partial_update

Partially update a Cloudbeds smart policy exception by id. Returns the updated policy exception including its exceptionId, checkin_date, and checkout_date. Required: exception_id, exceptionId.

delete_a_cloudbeds_policy_exception_by_id

Delete a Cloudbeds policy exception by id. Returns an empty 204 response on success. Required: id.

create_a_cloudbeds_pro_forma_invoice

Create a pro forma invoice fiscal document in Cloudbeds. Contains pending (unlocked) transactions with payment information and its own sequence numbering; can be converted to a regular invoice when transactions are posted. Returns: id, status. Required: transactionIds, sourceId, sourceKind, recipient.

cloudbeds_pro_forma_invoices_preview

Generate a preview PDF of a pro forma invoice fiscal document in Cloudbeds. Returns a binary file download (application/octet-stream) with a Content-Disposition header. Pro forma invoices contain pending, unlocked transactions that can be converted to regular invoices later. Required: transactionIds, sourceId, sourceKind, recipient.

cloudbeds_pro_forma_invoices_set_status

Update the status of a pro forma invoice in Cloudbeds. Returns the updated fiscal document summary including id, documentKind, status, and createdAt. Supported transitions: OPEN→ACCEPTED, REJECTED, CANCELED; ACCEPTED→CANCELED; REJECTED→CANCELED. Required: pro_forma_invoice_id, status.

list_all_cloudbeds_property_amenities

List the complete set of active property amenities in Cloudbeds. Returns the active amenity codes for the property. Required: property_id.

cloudbeds_property_amenities_bulk_update

Replace the complete set of active property amenities in Cloudbeds in a single atomic transaction. Returns the updated active amenity codes. Required: property_id.

list_all_cloudbeds_property_room_amenities

List active room amenities for all rooms in a Cloudbeds property. Returns: id. Required: property_id.

cloudbeds_property_room_amenities_bulk_update

Replace the complete set of active amenities for multiple rooms in a Cloudbeds property in a single atomic transaction. Returns the room amenities update result. Required: property_id, rooms.

list_all_cloudbeds_property_systems

List Cloudbeds property system component versions for the authenticated property context.

list_all_cloudbeds_rate_jobs

List rate jobs in Cloudbeds. Returns each rate job with its jobReferenceID and status. Rate jobs are only returned within 7 days of creation; without a jobReferenceID filter, results are scoped to the request token's client ID.

list_all_cloudbeds_rate_plans

List Cloudbeds rate plans for one or more properties. Returns: id. Max 500 items per page.

create_a_cloudbeds_rate_plan

Create a new Cloudbeds rate plan. Returns: id. Required: isActive, roomTypeId, name, description, namePrivate.

get_single_cloudbeds_rate_plan_by_id

Get a single Cloudbeds rate plan by id. Returns: id. Required: id.

update_a_cloudbeds_rate_plan_by_id

Update an existing Cloudbeds rate plan by id. Returns: id. Required: id.

delete_a_cloudbeds_rate_plan_by_id

Delete a Cloudbeds rate plan by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_rates

List Cloudbeds rate plans filtered by property, room type, rate IDs, or promo code for a given date range. Required: startDate, endDate.

cloudbeds_rates_bulk_update

Update room rates in Cloudbeds by rateID with optional date interval filtering. Returns: success, jobReferenceID, message. Only non-derived rates can be updated; max 30 intervals per call. Processing is asynchronous—use the returned jobReferenceID to track job status.

cloudbeds_rates_bulk_partial_update

Update room rates in Cloudbeds by rateID within an optional date interval. Supports multiple updates per call (max 30 intervals); only non-derived rates can be patched. Returns: success, jobReferenceID, message.

create_a_cloudbeds_receipt

Create a receipt for a payment in Cloudbeds, optionally specifying allocations per transaction. Without allocations a 'Simple receipt' is created that can later be allocated to charge transactions. Returns the created fiscal document summary including its id, documentKind, and status. Allocation amounts must equal the payment amount and transactions must not be fully allocated already. Required: userId, sourceId, sourceKind.

cloudbeds_receipts_void

Void a Cloudbeds receipt by updating its status to VOIDED. Returns an empty 204 response on success. Required: receipt_id. The receipt must be in OPEN status; for Italy, a refund receipt is automatically created and linked to the voided receipt.

cloudbeds_receipts_apply

Apply a receipt to an invoice in Cloudbeds. The receipt must not have existing allocations. Returns an empty 204 response on success. Required: receipt_id, invoiceId.

cloudbeds_receipts_allocate_payment

Allocate a receipt's payment to charge transactions in Cloudbeds. Returns the fiscal document summary including id, documentKind, status, and createdAt. Allocation amounts must sum to the payment amount and cannot exceed each transaction's remaining balance; transactions not on an invoice are added to a new invoice. Required: receiptId, allocations.

create_a_cloudbeds_rectifying_invoice

Create a rectify invoice fiscal document in Cloudbeds. Only available for properties in Spain; the target invoice must not have been previously rectified, otherwise the API returns an error indicating which invoice in the rectification chain to rectify instead. Returns: id. A request body is required. Required: invoiceId, method.

cloudbeds_rectifying_invoices_preview

Get a fiscal document preview of the type rectify invoice in Cloudbeds. Returns a binary file (PDF) download. Only available for properties in Spain; the target invoice must not have been previously rectified. A JSON request body is required. Required: invoiceId, method.

list_all_cloudbeds_report_charts

List all charts for a specific Cloudbeds report. Returns: id, created_at, updated_at. Required: report_id.

create_a_cloudbeds_report_chart

Create a new chart for a Cloudbeds report. Returns the created chart including its id, title, kind, datasource_kind, created_at, and updated_at. Required: report_id, title, kind.

get_single_cloudbeds_report_chart_by_id

Get a single Cloudbeds report chart by id. Returns the Chart object including its chart_id. Required: report_id, id.

update_a_cloudbeds_report_chart_by_id

Update an existing Cloudbeds report chart by id. Returns the updated chart including its id, title, kind, datasource_kind, created_at, and updated_at. Required: id, report_id, title, kind.

delete_a_cloudbeds_report_chart_by_id

Delete a Cloudbeds report chart by id. Returns an empty 204 response on success. Required: report_id, id.

list_all_cloudbeds_report_custom_cdfs

List all custom CDFs (Cloudbeds Data Fields) created on a Cloudbeds report. Returns each custom CDF with id, name, column, and formula. Required: report_id.

create_a_cloudbeds_report_custom_cdf

Create a custom CDF on a Cloudbeds report based on existing CDFs. The column name is auto-generated from the name. Returns: id, name. The formula must be validated before creation. Required: report_id, name, formula, kind.

get_single_cloudbeds_report_custom_cdf_by_id

Get a single custom CDF created on a Cloudbeds report by id. Returns: id, name, column, formula. Required: report_id, id.

update_a_cloudbeds_report_custom_cdf_by_id

Update an existing custom CDF on a Cloudbeds report. Returns: id, name. Required: id, report_id, name, formula, kind.

delete_a_cloudbeds_report_custom_cdf_by_id

Delete a custom CDF from a Cloudbeds report. Returns an empty 204 response on success. Required: report_id, id.

cloudbeds_report_custom_cdfs_validate

Validate a custom CDF formula for a Cloudbeds report before creation. Returns the validated formula as a list of objects, each containing kind and value. Formula kind must be one of cdf, separator, operator, operand, or parenthesis. Required: report_id, name, formula, kind.

list_all_cloudbeds_report_data

Get report data by report id from Cloudbeds Data Insights. The response structure varies by report type (List, Summary, Pivot, PeriodList, etc.). Returns: headers, records, index, group_rows, group_columns, periods. Required: report_id.

list_all_cloudbeds_report_formats

List available report format types in Cloudbeds. Returns an array of format option objects, each with an id and format-specific attributes. Only the 'date' format type is currently documented.

get_single_cloudbeds_report_format_by_id

Get format options for a specific report format type in Cloudbeds. Returns an array of format option objects with id and format-specific attributes; for the 'date' type these are date format strings using DD, MM, YYYY tokens with /, -, or . separators. Required: id.

list_all_cloudbeds_report_limits

Get the report usage limits for the current property from Cloudbeds Data Insights.

list_all_cloudbeds_report_properties

List report properties for a specific Cloudbeds Data Insights report. Returns an array of report property objects, each with id and attributes whose fields are defined by the ReportProperty schema upstream. Required: report_id.

list_all_cloudbeds_report_relative_date_filters

List possible relative date entries available for Cloudbeds report filters. Returns: value. Each value is either a standalone keyword (e.g. 'yesterday', 'years_prior') or a keyword with a duration separated by a semicolon (e.g. 'days_later;42', 'years_prior;1').

list_all_cloudbeds_report_schedules

List Cloudbeds report workbook schedules with optional filtering by schedule ID, subject, cron frequency, and date match. Returns: id, created_at, updated_at. Max 100 results per page.

create_a_cloudbeds_report_schedule

Create a schedule for a Cloudbeds report workbook. Returns the created schedule including id, subject, view, format, frequency, created_at, and updated_at. Required: frequency, recipients.

get_single_cloudbeds_report_schedule_by_id

Get a single Cloudbeds schedule by id. Returns: id, created_at, updated_at. Required: id.

update_a_cloudbeds_report_schedule_by_id

Update a Cloudbeds schedule by id. Returns the updated schedule including id, subject, view, format, frequency, created_at, and updated_at. Required: id, frequency, recipients.

delete_a_cloudbeds_report_schedule_by_id

Delete a Cloudbeds schedule by id. Returns an empty 204 response on success. Required: id.

cloudbeds_report_schedules_run

Trigger a run of a scheduled Cloudbeds report export by schedule_id, queuing an async export task. Returns a queue task response that includes a token for tracking the run status via the tasks/token endpoint. Required: schedule_id.

list_all_cloudbeds_report_summaries

Get a Cloudbeds report summary by report id. The response structure varies by report type (Summary, PeriodSummary, Pivot, etc.) and includes columns, records, settings, headers, and optionally group_rows, group_columns, periods, and index. Required: report_id.

list_all_cloudbeds_report_tags

List all tags associated with a Cloudbeds report. Returns: id, name. Required: report_id.

create_a_cloudbeds_report_tag

Associate an existing Cloudbeds tag with a report by providing the tag id. Returns: id, name. Required: report_id, id.

delete_a_cloudbeds_report_tag_by_id

Delete the association between a Cloudbeds report and a tag by unassigning the tag from the report. Returns an empty 204 response on success. Required: report_id, id.

list_all_cloudbeds_reports

List Cloudbeds Data Insights reports for a single property. Returns: id, description, updated_at. Max 100 per page.

create_a_cloudbeds_report

Create a new Cloudbeds Data Insights report. Returns the created report including id, title, type, dataset_id, columns, settings, and updated_at. The report type (List, PeriodList, Summary, PeriodSummary, Pivot) determines which properties are included in the body. Required: title, dataset_id, columns, property_id, property_ids.

get_single_cloudbeds_report_by_id

Get a single Cloudbeds Data Insights report by id. Returns: id, description, type, updated_at. Required: id.

update_a_cloudbeds_report_by_id

Update a single Cloudbeds Data Insights report by id. Returns the updated report including id, title, type, dataset_id, columns, settings, and updated_at. Required: id, title, dataset_id, columns, property_id, property_ids.

delete_a_cloudbeds_report_by_id

Delete a Cloudbeds Data Insights report by id. Returns an empty 204 response on success. Required: id.

cloudbeds_reports_search

Search Cloudbeds Data Insights reports by title, description, dataset, folder, tag, or user filters. Returns: id, description, updated_at. Max 100 results per page. Title filtering is case-insensitive; returns 200 even with no results.

cloudbeds_reports_clone

Clone a Cloudbeds Data Insights report from an existing one. Returns: id, description, updated_at. A JSON request body is required. Required: report_id, title, columns, property_id, property_ids.

cloudbeds_reports_export

Export a Cloudbeds report by report_id in the requested format (xlsx, csv, or json). Returns the report export object including columns, settings, group_rows, group_columns, and periods, with structure varying by report type. Required: report_id, view, format.

cloudbeds_reports_export_async

Queue an async export task for a Cloudbeds report by id. Returns: status. Required: report_id, view, format. The export runs asynchronously; poll the returned task id via the tasks endpoints to check completion status.

cloudbeds_reports_bulk_export_async

Queue a task in Cloudbeds to export multiple reports by ids as a single Excel workbook. Returns a queue response with a token for tracking the async export task status. Required: report_ids. Supports 1–15 report ids per request; workbook name defaults to 'Workbook' and is limited to 32 characters.

cloudbeds_reports_query_data

Query report data in Cloudbeds without first creating a report. Returns: periods, group_rows. Preview mode returns up to 100 records; Run mode returns up to 12,000 records. Required: mode, property_ids, dataset_id, columns.

cloudbeds_reports_query_summary

Query a Cloudbeds report summary from a report definition without persisting it. A request body containing the report query definition must be supplied. Preview mode limits to 100 records; Run mode limits to 12,000 records. Required: mode, property_ids, dataset_id, columns.

cloudbeds_reports_query_export

Export Cloudbeds report data to xlsx, csv, or json from an ad-hoc report definition that has not been saved as a created report. Export mode supports up to 100000 records. Required: view, format, title, property_ids, dataset_id, columns.

cloudbeds_reports_query_export_async

Queue an async export task for report query data in Cloudbeds. Accepts a report query definition body specifying type, columns, settings, and optional group/period structures. Returns: status. Export mode supports up to 100000 records. Required: view, format, title, property_ids, dataset_id, columns.

list_all_cloudbeds_reservation_assignments

List rooms and reservations assigned for a selected date in Cloudbeds. Returns the assignments for the specified date, defaulting to the current day when no date is provided. Both propertyID and date are optional.

list_all_cloudbeds_reservation_balance_transfers

Get AR balance transfer details for a specific reservation in Cloudbeds. Returns: amount. Required: reservation_id.

create_a_cloudbeds_reservation_balance_transfer

Transfer a reservation's outstanding balance to an accounts receivable ledger in Cloudbeds. Returns an async event response with the event_id for tracking the result. Required: accounts_receivable_ledger_id, reservation_id. Processed asynchronously.

cloudbeds_reservation_balance_transfers_revert

Reverse a previously created reservation-to-AR balance transfer in Cloudbeds, moving the balance back to the original reservation. Returns an async event response with the event_id for tracking. Required: accounts_receivable_ledger_id, reservation_id. Processed asynchronously.

create_a_cloudbeds_reservation_document

Attach a document to a reservation in Cloudbeds by uploading a file as multipart form data. Returns a JSON response from the Cloudbeds API; the specific response fields are not documented in the available source.

list_all_cloudbeds_reservation_notes

List reservation notes for a specific reservation in Cloudbeds. Returns the notes associated with the reservation including each note's reservationNoteID and note content. Required: reservationID.

create_a_cloudbeds_reservation_note

Add a reservation note in Cloudbeds. Accepts a form-encoded request body. Returns a JSON response whose fields are not documented in the available API reference.

update_a_cloudbeds_reservation_note_by_id

Update an existing reservation note in Cloudbeds with new content. Returns: success, message.

delete_a_cloudbeds_reservation_note_by_id

Archive an existing reservation note in Cloudbeds by reservation and note identifier. The API returns a 200 response confirming the operation. Required: reservationID.

list_all_cloudbeds_reservation_policies

Get the rendered smart policy text and scheduled payments for a Cloudbeds reservation. Returns: policyText, policyTextSource. Required: reservation_id. Falls back to legacy cancellation policy text when no smart policy applies; returns null policyText when neither is available.

list_all_cloudbeds_reservation_rate_details

List Cloudbeds reservations with booked rate and source details. Returns: status, source, rooms, origin, total, balance. Max 100 results per page; includeGuestRequirements requires includeGuestsDetails=true.

get_single_cloudbeds_reservation_room_by_id

GetReservationRoomDetails. Returns: success, message, data.

list_all_cloudbeds_reservations

List Cloudbeds reservations matching filter criteria such as status, date ranges, room, guest, or source. Returns: status, adults, children, balance, rooms, origin. Max 100 per page.

get_single_cloudbeds_reservation_by_id

Get a single Cloudbeds reservation by reservationID. Returns: success, data, message.

create_a_cloudbeds_reservation

Create a new reservation in Cloudbeds for a selected property. Returns the created reservation's reservationID, startDate, endDate, and propertyID.

update_a_cloudbeds_reservation_by_id

Update a Cloudbeds reservation to modify custom fields, estimated arrival time, room configuration, or reservation status. Returns: success, message, data.

cloudbeds_reservations_check_in

Check-in a room already assigned for a guest in Cloudbeds. Submits form-urlencoded data to perform the room check-in and returns a JSON response confirming the operation.

cloudbeds_reservations_check_out

Check out a room already assigned to a guest in Cloudbeds. If all rooms on the reservation are checked out, the reservation status automatically updates to 'Checked Out' as well. Returns a JSON response confirming the check-out operation.

list_all_cloudbeds_room_blocks

List room blocks in Cloudbeds, filterable by property, room block, room type, room, or date range. The date range between startDate and endDate must be 35 days or less.

create_a_cloudbeds_room_block

Create a room block on a Cloudbeds property by specifying the block type, date range, and rooms to block. Returns: success, rooms, message.

update_a_cloudbeds_room_block_by_id

Update a room block in Cloudbeds. Returns the updated room block object including roomBlockID, propertyID, roomBlockType, roomBlockReason, startDate, endDate, and rooms.

delete_a_cloudbeds_room_block_by_id

Delete a room block in Cloudbeds by providing its room block ID. Returns: success, message.

list_all_cloudbeds_room_taxes_and_fees

Get applicable fees and taxes for a Cloudbeds booking, meant for checkout display to the guest. Returns the computed fees and taxes object whose field structure is defined by the GetRoomsFeesAndTaxesResponse schema in the Cloudbeds API. adultsPerRoom is needed for fixed_per_person taxes/fees to return non-zero amounts. Required: startDate, endDate, roomsTotal, roomsCount.

list_all_cloudbeds_room_type_amenities

List active room amenities for a specific room type in Cloudbeds. Required: property_id, room_type_id.

cloudbeds_room_type_amenities_bulk_update

Replace the complete set of active room amenities for a room type in Cloudbeds in a single atomic transaction. Required: property_id, room_type_id. The request body is a bare JSON array of amenity codes.

list_all_cloudbeds_room_type_rates

Get the rate for a specific Cloudbeds room type based on check-in/check-out dates and occupancy. Returns the rate response object with rate details for the selected room type and date range. The promoCode parameter is deprecated; use getRatePlans instead. Required: roomTypeID, startDate, endDate.

list_all_cloudbeds_room_types

List Cloudbeds room types with optional filters by property, dates, occupancy, and other criteria. Returns: roomTypeID, roomTypeName, maxGuests. Rates are only included when startDate, endDate, adults, and children are all provided.

cloudbeds_rooms_assign

Assign or reassign a room on a guest reservation in Cloudbeds. Returns: success, message.

list_all_cloudbeds_rooms

List rooms in Cloudbeds, optionally filtered by property, room type, and stay dates. Returns: rooms. If check-in/out dates are sent, only unassigned rooms are returned.

create_a_cloudbeds_settlement_invoice

Create a settlement invoice for an existing advance invoice in Cloudbeds, finalizing its billing cycle. Returns the created fiscal document summary including id, kind, status, and createdAt. The parent document must be an active ADVANCE_INVOICE with no existing active settlement. Required: advance_invoice_id, userId.

create_a_cloudbeds_simple_receipt

Create simple receipts in Cloudbeds for a list of payments without allocations. Returns an array of fiscal document summary objects including id, documentKind, and status for each created receipt. Required: transactionIds, userId, sourceId, sourceKind, recipient.

get_single_cloudbeds_source_balance_snapshot_by_id

Get a source balance snapshot for a specific reservation in Cloudbeds. Returns a financial balance summary including charges, payments, refunds, upcoming_payments, and balance_due. Required: id.

list_all_cloudbeds_source_balances

Get the financial balance summary for a specific Cloudbeds source (reservation, house account, group profile, or accounts receivable ledger). Returns a detailed breakdown including charges, payments, refunds, upcoming payments, and balance due. Required: source_kind, source_id.

list_all_cloudbeds_sources

List available property sources in Cloudbeds, optionally filtered by one or more property IDs. Returns the available property sources for the queried properties. The propertyIDs parameter accepts a comma-separated list of property IDs (e.g. 37,345,89). The response field structure is defined in the GetSourcesResponse schema; consult the Cloudbeds API reference for field-level details.

list_all_cloudbeds_stock_report_charts

List Cloudbeds stock report charts for a given stock report. Returns: id, title, kind, created_at, updated_at. Required: stock_report_id.

create_a_cloudbeds_stock_report_chart

Create a new chart for a Cloudbeds stock report. Returns the created chart object including id, title, kind, created_at, updated_at. Required: stock_report_id, title, kind.

get_single_cloudbeds_stock_report_chart_by_id

Get a single Cloudbeds stock report chart by id. Returns: id, title, kind, created_at, updated_at. Required: stock_report_id, id.

update_a_cloudbeds_stock_report_chart_by_id

Update a Cloudbeds stock report chart by id. Returns the updated chart object including id, title, kind, created_at, updated_at. Required: id, stock_report_id, title, kind.

delete_a_cloudbeds_stock_report_chart_by_id

Delete a Cloudbeds stock report chart by id. Returns an empty 204 response on success. Required: stock_report_id, id.

list_all_cloudbeds_stock_report_custom_cdfs

List all custom cdfs (Cloudbeds Data Fields) created for a stock report in Cloudbeds. Returns: id, name. Required: stock_report_id.

create_a_cloudbeds_stock_report_custom_cdf

Create a custom cdf for a stock report in Cloudbeds. A custom cdf builds a new column from an existing cdf using a validated formula; the column name is derived from the provided name in lowercase alphanumeric form. Returns: id, name. Required: stock_report_id, name, formula, kind.

get_single_cloudbeds_stock_report_custom_cdf_by_id

Get a single custom cdf of a stock report in Cloudbeds. Returns: id, name, formula. Required: stock_report_id, id.

update_a_cloudbeds_stock_report_custom_cdf_by_id

Update an existing custom cdf on a stock report in Cloudbeds. Returns: id, name. Required: id, stock_report_id, name, formula, kind.

delete_a_cloudbeds_stock_report_custom_cdf_by_id

Delete a custom cdf from a stock report in Cloudbeds. Returns an empty 204 response on success. Required: stock_report_id, id.

cloudbeds_stock_report_custom_cdfs_validate

Validate a custom CDF formula for a Cloudbeds stock report before creation. The formula is a list of objects each containing kind (cdf, separator, operator, operand, parenthesis) and value. Returns: name, formula. Required: stock_report_id, name, formula, kind.

list_all_cloudbeds_stock_report_data

Get stock report data by id from Cloudbeds. Returns: headers, records, index, group_rows, group_columns, periods. The response structure varies by report type and may also include index, group_rows, group_columns, and periods. Required: stock_report_id, property_ids.

create_a_cloudbeds_stock_report_folder_report

Assign a stock report to a stock report folder in Cloudbeds to organize reports. Returns an empty 201 response on success. Required: folder_id, stock_report_id.

delete_a_cloudbeds_stock_report_folder_report_by_id

Remove a stock report from a stock report folder. Returns an empty 204 response on success. Required: id, folder_id.

list_all_cloudbeds_stock_report_folders

List all stock report folders managed by Cloudbeds for a property. Returns: id, name. Max 100 results per page (default 25).

create_a_cloudbeds_stock_report_folder

Create a new stock report folder in Cloudbeds to organize stock reports. Returns: id, name. Required: name.

get_single_cloudbeds_stock_report_folder_by_id

Get a single stock report folder by id in Cloudbeds. Returns: id, name. Required: id.

delete_a_cloudbeds_stock_report_folder_by_id

Delete a stock report folder by id. Returns an empty 204 response on success. Required: id.

list_all_cloudbeds_stock_report_limits

Get stock report generation limits in Cloudbeds. Returns the data object containing stock report generation limits and quotas as defined by the upstream Cloudbeds ReportLimit schema. No required parameters.

list_all_cloudbeds_stock_report_revisions

List revisions for a Cloudbeds stock report. Required: stock_report_id.

get_single_cloudbeds_stock_report_revision_by_id

Get a specific revision of a Cloudbeds stock report. Returns the revision object including its id, created_at, and updated_at. Required: stock_report_id, id.

list_all_cloudbeds_stock_report_rule_country_codes

List supported country code rule keys for Cloudbeds stock reports. Returns an array of rule objects, each containing a key identifier for a supported country code.

list_all_cloudbeds_stock_report_rule_feature_ids

List supported feature ID rule keys for Cloudbeds stock reports. Returns an array of FeatureIdRules objects with id and rule-specific attributes.

list_all_cloudbeds_stock_report_rule_options

List supported rule keys available for Cloudbeds stock reports in the Data Insights API. No additional parameters required.

list_all_cloudbeds_stock_report_rule_property_ids

List supported property ID rule keys for Cloudbeds stock reports.

list_all_cloudbeds_stock_report_rule_property_types

List supported property type rule keys for Cloudbeds stock reports. Returns an array of supported property type rule key objects. No caller-supplied parameters required; the property context is determined automatically.

cloudbeds_stock_report_rules_bulk_update

Update the rules of a specific Cloudbeds stock report by stock_report_id. Returns the updated rules object including property_ids, feature_ids, country_codes, and property_types. Required: stock_report_id. The API returns 404 if no report is found with the given id.

list_all_cloudbeds_stock_report_summaries

Get a Cloudbeds stock report summary by id. Required: stock_report_id, property_ids.

list_all_cloudbeds_stock_reports

List Cloudbeds stock reports with filtering and sorting. Returns each report with id, title, description, dataset_id, updated_at, and published. Max 100 per page. The include_cloudbeds and property_country_only parameters are mutually exclusive.

create_a_cloudbeds_stock_report

Publish a new stock report in Cloudbeds with optional rules. Returns the created report with id, title, description, dataset_id, type, updated_at, and published. Required: report_id.

get_single_cloudbeds_stock_report_by_id

Get a single Cloudbeds stock report by id. Stock reports are reports owned by Cloudbeds and cannot be edited, only copied. Returns: id, description, type, updated_at, created_at. Required: id.

update_a_cloudbeds_stock_report_by_id

Update a Cloudbeds stock report by id. Returns the updated report with id, title, description, dataset_id, type, updated_at, and published. Required: id, title, dataset_id, columns.

delete_a_cloudbeds_stock_report_by_id

Unpublish a Cloudbeds stock report by id. Returns an empty 204 response on success. Required: id.

cloudbeds_stock_reports_search

Search Cloudbeds stock reports by title, description, dataset, folder, published status, or free-text term. Returns: id, description, updated_at. The API returns 200 even when no results are found; title matching is case-insensitive. Max 100 results per page. The include_cloudbeds and property_country_only filters are mutually exclusive.

cloudbeds_stock_reports_clone

Clone a Cloudbeds stock report by id, creating a new report that copies the original's configuration and charts. Returns the created report including id, title, description, dataset_id, updated_at, and published. Returns 201 on success; 404 if no report is found with the given id. Required: stock_report_id, title, columns.

cloudbeds_stock_reports_export

Export a Cloudbeds stock report by id in xlsx, csv, or json format. Required: stock_report_id, format, property_ids, view.

cloudbeds_stock_reports_export_async

Queue an asynchronous export task for a Cloudbeds stock report by id, producing a file in the requested format. Returns a QueueResponse with queueTaskId, queueTaskId_str, and status for tracking the export job. Required: stock_report_id, format, property_ids, view.

cloudbeds_stock_reports_query_data

Query stock report data from an existing Cloudbeds stock report, allowing overrides to filters, columns, group rows, group columns, sort, and settings. Returns: headers, records, index, group_rows, group_columns, periods. Preview mode is limited to 100 records and Run mode to 12,000 records. Required: stock_report_id, mode, property_ids.

cloudbeds_stock_reports_query_summary

Query a Cloudbeds stock report summary from an existing stock report with custom filters, columns, group rows, group columns, sort, and settings overrides. Preview mode limits to 100 records; Run mode limits to 12,000 records. Required: stock_report_id, mode, property_ids.

cloudbeds_stock_reports_query_export

Create a file export of queried stock report data from a Cloudbeds stock report that has not been created yet. Returns the exported data structure including columns, settings, group_rows, group_columns, and periods, with format varying by report type. Supports up to 100000 records in export mode. Required: stock_report_id, view, format, property_ids, columns, title, dataset_id.

cloudbeds_stock_reports_query_export_async

Create an asynchronous stock report query export in Cloudbeds by submitting a stock report query specification. Queues a file export of up to 100,000 records; the report type in the body determines the data structure. Returns: id, status. Required: stock_report_id, view, format, property_ids, columns, title, dataset_id.

get_single_cloudbeds_task_token_by_id

Get the status of a queued Cloudbeds Data Insights task by its token. Returns the queue task response object. Required: id.

list_all_cloudbeds_tasks

List all Data Insights tasks for a single Cloudbeds property. Returns: id. Max 100 results per page. Required: offset.

get_single_cloudbeds_task_by_id

Get a Cloudbeds Data Insights task by id. Returns the queue task response object including its id and additional task attributes. Required: id.

list_all_cloudbeds_taxes_and_fees

List the taxes and fees configured for a property in Cloudbeds. Returns: type, name, code, kind, amount, createdAt. All parameters are optional. When sourceId is supplied, isRootSource and isHotelCollectBooking must also be provided; productId and addonId are mutually exclusive.

list_all_cloudbeds_transactions

Search posted transactions in Cloudbeds with complex AND/OR filter criteria, sorting, and cursor-based pagination. Returns: id. Required: filters. Every request must include at least one base filter (id with equals/in, source_id with source_kind, transaction_datetime, service_date, or trial_balance_id).

list_all_cloudbeds_trial_balance_configuration_status

Check whether a property has configured its trial balance in Cloudbeds. The trial balance must be configured before daily reports can be generated.

list_all_cloudbeds_trial_balance_configurations

Retrieve the saved trial balance configuration for a Cloudbeds property, including opening balances for the deposit, accounts receivable, and guest ledgers.

create_a_cloudbeds_trial_balance_configuration

Configure the trial balance for a Cloudbeds property by saving opening balances as of today. Can only be performed once per property; returns an error if a configuration already exists. Required: depositsLedgerOpeningBalance, accountsReceivableLedgerOpeningBalance, guestLedgerOpeningBalance.

cloudbeds_trial_balance_configurations_calculate

Calculate the initial trial balance for a Cloudbeds property based on all historical transactions through the end of yesterday (property local time). Returns the computed opening balances for the deposit ledger, accounts receivable ledger, and guest ledger, plus the configuration date. Use this endpoint to preview opening balances before committing the trial balance configuration.

list_all_cloudbeds_trial_balance_reports

Retrieve the trial balance report for a specific date in Cloudbeds. Returns the report data including opening and closing balances, ledger activity, deposit and AR transfers, and a detailed breakdown of guest ledger charges, taxes, and payments by transaction code. Required: date. The property must have a configured trial balance before reports can be generated.

list_all_cloudbeds_unassigned_rooms

List unassigned rooms in a Cloudbeds property. This endpoint is an alias of getRooms; the response shape follows that endpoint. Returns: rooms.

list_all_cloudbeds_users

List users for Cloudbeds properties, optionally filtered by one or more property IDs. The upstream GetUsersResponse schema is referenced but not documented in the available API source.

list_all_cloudbeds_webhooks

List webhook subscriptions the API client is subscribed to in Cloudbeds. Returns: id, key, event, owner, subscriptionType, subscriptionData. Optional: propertyID.

create_a_cloudbeds_webhook

Subscribe a webhook to a specified Cloudbeds event so your endpoint URL receives notifications when the event occurs. Returns: success, data. You must subscribe to a specific action; Cloudbeds does not support subscribing to all actions on a given object.

delete_a_cloudbeds_webhook_by_id

Delete a webhook subscription in Cloudbeds by its subscription ID, which can be obtained by listing existing webhooks via getWebhooks. Returns: success.