# Cloudbeds Developers Documentation

## Guides
- [Account Creation + How to get User and Account Info](https://developers.cloudbeds.com/docs/account-creation-how-to-get-user-and-account-info.md)
- [Alternative OAuth 2.0. authentication method](https://developers.cloudbeds.com/docs/alternative-oauth-20-authentication-method.md)
- [API Keys Authentication Guide for Technology Partners](https://developers.cloudbeds.com/docs/api-keys-authentication-guide-for-technology-partners.md): This API Keys Authentication Guide provides basic information on the API Keys Authentication required to access Cloudbeds API resources.  For the OAuth 2.0 authentication method please see the article Alternative OAuth 2.0. authentication method.
- [Authentication](https://developers.cloudbeds.com/docs/authentication-1.md): Cloudbeds API authentication is based on API keys, which is a straightforward method to get started quickly with some simple steps. The API key creation can be fully automated once the user authorizes the integration.
- [Migration from Oauth 2.0 to API Keys for Technology Partners (Optional)](https://developers.cloudbeds.com/docs/migration-from-oauth-20-to-api-keys-for-technology-partners-optional.md)
- [Quickstart Guide - API Authentication for self-service API users](https://developers.cloudbeds.com/docs/quickstart-guide-api-authentication-for-property-level-users.md): This Quickstart Guide provides basic information on the API key Authentication required to access [Cloudbeds API](https://hotels.cloudbeds.com/api/v1.2/docs/) resources. This guide will help you to quickly get an API key to start using with your authentication.
- [Cloudbeds reseller flow (optional)](https://developers.cloudbeds.com/docs/cloudbeds-reseller-flow-optional.md): Optional Cloudbeds Reseller Flow
- [Connecting & Disconnecting Apps](https://developers.cloudbeds.com/docs/connecting-disconnecting-apps.md)
- [Introduction to Cloudbeds Insights API](https://developers.cloudbeds.com/docs/introduction-to-cloudbeds-insights-api-1.md)
- [Introduction to Multi Island (January 2024)](https://developers.cloudbeds.com/docs/introduction-to-multi-island-january-2024.md)
- [Postman API collection](https://developers.cloudbeds.com/docs/postman-api-collection.md)
- [Supporting Group Accounts](https://developers.cloudbeds.com/docs/supporting-group-accounts.md): Cloudbeds accounts (properties) can be grouped under one group account (often referred as mygroup, organization or assoaciation). Group users have the highest level of user permissions in all of the grouped accounts (properties).   Calls that provide group account data have "Group account support" label in the API doc.
- [User Authorization Flow Options](https://developers.cloudbeds.com/docs/user-authorization-flow-options.md): Flow A is mandatory for all new apps starting 1. Nov 2020.
- [Webhooks](https://developers.cloudbeds.com/docs/webhooks-1.md): With webhooks, Cloudbeds can send notifications to your application every time an event occurs on a Cloudbeds property account.  You can register your own URL endpoint which will be notified on each event and will receive a payload of event data. You can set multiple URLs for a single event or have specific ones for each event you want to listen to.  You can, for example, listen for new reservations and import them into your system as they come. You can listen to changes to room assignments and update the new room names in your interface in a matter of seconds. Or you can listen for guest information so that if a guest contact changes you have the most recent phone and email you can contact them on.
- [About Cloudbeds APIs](https://developers.cloudbeds.com/docs/about-cloudbeds-api.md)
- [API Security Standards](https://developers.cloudbeds.com/docs/api-security-standards.md)
- [Build with LLMs](https://developers.cloudbeds.com/docs/build-with-llms.md): Build Cloudbeds Developers integrations with Large Language Models > (LLMs)
- [How to get Support](https://developers.cloudbeds.com/docs/how-to-report-an-api-bug.md)
- [Integration Guide](https://developers.cloudbeds.com/docs/integration-guide.md)
- [Request your sandbox](https://developers.cloudbeds.com/docs/request-your-sandbox.md)
- [Terms and Conditions](https://developers.cloudbeds.com/docs/terms-and-conditions.md)
- [Cloudbeds Brand Guidelines & Partner Status](https://developers.cloudbeds.com/docs/cloudbeds-brand-guidelines.md)
- [Partner Marketing Requirements](https://developers.cloudbeds.com/docs/partner-marketing-requirements.md): Development and certification have been done. Hard work is behind you, now the time is to reap the benefits!  Submit your high-quality Marketing Material Here and we'll use it to spread the word.  Note: Once you submit content, Cloudbeds reserves the right to modify it to comply with our listing guidelines.
- [Support Article requirements](https://developers.cloudbeds.com/docs/support-article-requirements.md): Congratulations! You've spent time and energy and built an amazing integration. Now make sure everybody knows how to use it correctly and admire your work!
- [Sandbox access](https://developers.cloudbeds.com/docs/can-i-have-access-to-a-sandbox.md)
- [Common API errors & How to handle](https://developers.cloudbeds.com/docs/common-api-errors-in-progress.md)
- [Getting started as a partner in 5 steps](https://developers.cloudbeds.com/docs/getting-started-as-a-partner-in-5-steps.md)
- [Documentation to support Cloudbeds API Transaction Termination](https://developers.cloudbeds.com/docs/documentation-to-support-cloudbeds-api-transaction-termination.md)
- [Example 1:  Update Room Price and Routed Transactions](https://developers.cloudbeds.com/docs/example-1-update-room-price-and-routed-transactions.md)
- [Example 2: Void Transactions](https://developers.cloudbeds.com/docs/example-2-void-transactions.md)
- [Example 3: Delete a Reservation](https://developers.cloudbeds.com/docs/example-3-delete-a-reservation.md)
- [Example 4:  Update Accommodation Type](https://developers.cloudbeds.com/docs/example-4-update-accommodation-type.md)
- [New Cloudbeds Accounting System and getTransactions changes](https://developers.cloudbeds.com/docs/gettransations-endpoint-new-cloudbeds-accounting-service.md)
- [Schema Mapping Accounting API & Cloudbeds API](https://developers.cloudbeds.com/docs/schema-mapping-accounting-api-cloudbeds-api.md)
- [Example 5: Void Adjustments](https://developers.cloudbeds.com/docs/void-adjustments.md)
- [How to Add Reservation Number to URL?](https://developers.cloudbeds.com/docs/how-to-add-reservation-number-to-url.md)
- [FAQ](https://developers.cloudbeds.com/docs/faq.md)
- [Multi Island & v1.2 FAQ](https://developers.cloudbeds.com/docs/multi-island-v12-faq.md)
- [Pass Stripe tokens to Cloudbeds](https://developers.cloudbeds.com/docs/pass-stripe-tokens-to-cloudbeds.md)
- [Reservation FAQs](https://developers.cloudbeds.com/docs/reservation-faqs.md): In this article, we will cover some common use cases and questions related to reservations.
- [Whistle and Cloudbeds API](https://developers.cloudbeds.com/docs/whistle-and-cloudbeds-api.md)
- [Accounting](https://developers.cloudbeds.com/docs/accounting.md): This blueprint outlines the essential architecture for building robust integrations that synchronize transactional data, automate financial reconciliation, and unlock deep operational insights. By leveraging Cloudbeds’ specialized APIs—specifically the Accounting API for real-time transactional accuracy —this framework empowers businesses to move beyond manual data entry and into an era of automated intelligence.
- [App Integration - PBX / Hotspot / TV (And other Systems)](https://developers.cloudbeds.com/docs/app-integration-pbx-hotspot-tv-and-other-systems.md)
- [Booking Engine Extensions](https://developers.cloudbeds.com/docs/booking-engine-extensions.md)
- [Booking Engine](https://developers.cloudbeds.com/docs/booking-engine.md)
- [Business Intelligence and reporting](https://developers.cloudbeds.com/docs/business-intelligence-and-reporting.md): In the modern hospitality landscape, data is more than just a record of the past—it is the roadmap for future growth. To stay competitive, hoteliers need to move beyond static spreadsheets and embrace real-time, actionable insights that drive revenue management, operational efficiency, and guest satisfaction. This blueprint provides a comprehensive framework for developers looking to build or integrate Business Intelligence tools with the Cloudbeds platform. Whether you are building a custom dashboard for a boutique hotel or a multi-property analytics suite for a global group, this guide outlines the optimal paths for data extraction and synchronization.
- [Check-in](https://developers.cloudbeds.com/docs/check-in-upsell-upgrade.md)
- [CRM / CRM - Upsell](https://developers.cloudbeds.com/docs/crm-crm-upsell.md)
- [Access Management & Door Locks](https://developers.cloudbeds.com/docs/doorlocks-via-api.md)
- [Event Management [What's Changing - Migration]](https://developers.cloudbeds.com/docs/event-management-whats-changing-migration.md)
- [Event Management](https://developers.cloudbeds.com/docs/event-management.md)
- [Government Invoicing and Fiscalization](https://developers.cloudbeds.com/docs/government-invoicing-and-fiscalization.md)
- [Government: Police Report](https://developers.cloudbeds.com/docs/government-police-report.md)
- [Guest Communication / Reputation management](https://developers.cloudbeds.com/docs/guest-communication-reputation-management.md)
- [Hospitality Insurance](https://developers.cloudbeds.com/docs/hospitality-insurance.md): Hospitality insurance **covers property owners and/or guests against property damage, personal injuries, and more.**
- [Housekeeping / Staff management](https://developers.cloudbeds.com/docs/housekeeping-staff-management.md)
- [Use Cases (Blueprints)](https://developers.cloudbeds.com/docs/use-cases-blueprints.md)
- [Payment by Booking Engine Redirection](https://developers.cloudbeds.com/docs/booking_engine_payment.md)
- [Gift card management](https://developers.cloudbeds.com/docs/gift-card-management.md)
- [Payment processing](https://developers.cloudbeds.com/docs/payment-processing.md)
- [Point of Sale](https://developers.cloudbeds.com/docs/point-of-sale.md)
- [Revenue Management System (RMS)](https://developers.cloudbeds.com/docs/revenue-management-system-rms.md)
- [Upsell / Tours & Activities](https://developers.cloudbeds.com/docs/upsell-tours-activities.md)
- [Property and Group Account API Access](https://developers.cloudbeds.com/docs/property-and-group-account-api-access.md)

## API Reference
- [/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer](https://developers.cloudbeds.com/reference/deleteaccountsreceivableledgerreservationbalancetransfer-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}](https://developers.cloudbeds.com/reference/getaccountsreceivableledgerbyid-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers/reservation/{reservationId}/balance-transfer](https://developers.cloudbeds.com/reference/getaccountsreceivableledgerreservationbalancetransfer-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers](https://developers.cloudbeds.com/reference/getaccountsreceivableledgers-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers/totals](https://developers.cloudbeds.com/reference/getaccountsreceivableledgertotals-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/transactions](https://developers.cloudbeds.com/reference/getaccountsreceivableledgertransactions-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers](https://developers.cloudbeds.com/reference/patchaccountsreceivableledger-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers](https://developers.cloudbeds.com/reference/postaccountsreceivableledger-1.md)
- [/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer](https://developers.cloudbeds.com/reference/postaccountsreceivableledgerreservationbalancetransfer-1.md)
- [/accounting/v1.0/custom-general-ledger-codes](https://developers.cloudbeds.com/reference/getcustomgeneralledgercodes-1.md)
- [/accounting/v1.0/custom-general-ledger-codes](https://developers.cloudbeds.com/reference/putcustomgeneralledgercodes-1.md): Create or update General Ledger Codes.
- [/accounting/v1.0/custom-transaction-codes](https://developers.cloudbeds.com/reference/getcustomtransactioncodes-1.md)
- [/accounting/v1.0/custom-transaction-codes/initialize](https://developers.cloudbeds.com/reference/initializecustomtransactioncodes-1.md): Before transaction custom codes can be retrieved and modified, they must be initialized. This process generates transaction custom code records without any mapping. Once the initialization is complete, the codes can be retrieved and modified.
- [/accounting/v1.0/custom-transaction-codes](https://developers.cloudbeds.com/reference/putcustomtransactioncodes-1.md): Update custom transaction code mappings. Optional custom general ledger code can also be assigned.
- [/accounting/v1.0/deposits/balance](https://developers.cloudbeds.com/reference/getdepositbalance-1.md): Get Deposit Balance For Source or Property
- [/accounting/v1.0/deposits/transactions](https://developers.cloudbeds.com/reference/getdeposittransactions-1.md): Get Deposit Transactions
- [/accounting/v1.0/deposits/transfer](https://developers.cloudbeds.com/reference/postdepositstransfer-1.md)
- [/accounting/v1.0/internal-transaction-codes](https://developers.cloudbeds.com/reference/getinternaltransactioncodes-1.md)
- [/accounting/v1.0/settings](https://developers.cloudbeds.com/reference/getsettings-1.md): Get property settings by its ID
- [/accounting/v1.0/settings](https://developers.cloudbeds.com/reference/patchsettings-1.md): Update partially or create settings
- [/accounting/v1.0/source-balances/{sourceKind}/{sourceId}](https://developers.cloudbeds.com/reference/getsourcebalancebysource.md): Get source balance information for a reservation / house account / group profile / accounts receivable ledger
- [/accounting/v1.0/pending-transactions](https://developers.cloudbeds.com/reference/listpendingtransactions.md): Supported fields for filtering:   - account_category   - chart_of_account_type   - created_at - Same as `transaction_datetime`   - customer_id   - custom_code   - external_relation_id   - external_relation_kind   - folio_id   - id   - internal_code   - origin_id   - parent_id   - routed_from   - source_id   - source_identifier   - source_kind   - transaction_datetime   - trial_balance_id   - service_date  Supported fields for sorting:   - created_at - Same as `transaction_datetime`   - id   - internal_code   - source_id   - transaction_datetime   - service_date  Example request: ```   {     "filters": {       "and": [         {           "operator": "greater_than_or_equal",           "value": "2019-01-11t08:59:00Z",           "field": "transaction_datetime"         },         {           "operator": "equals",           "value": "123",           "field": "source_id"         },         {           "operator": "equals",           "value": "RESERVATION",           "field": "source_kind"         },         {           "or": [             {               "operator": "in",               "value": ["1", "2", "3"],               "field": "customer_id"             },             {               "operator": "equals",               "value": "9000",               "field": "internal_code"             }           ]         }       ]     },     "pageToken": null,     "limit": 10,     "sort": [       {         "field": "transaction_datetime",         "direction": "asc"       }     ]   }  The API has certain constraints for filters so that the system is able to efficiently query the data. Filters must include on of the following:   - filter by 'id' with condition 'equals' or 'in'   - filter by both 'source_id' and 'source_kind'   - filter by both 'external_relation_id' and 'external_relation_kind'   - filter by transaction_datetime ```
- [/accounting/v1.0/transactions](https://developers.cloudbeds.com/reference/listtransactions-1.md): Supported fields for filtering:   - account_category   - chart_of_account_type   - created_at - Same as `transaction_datetime`   - customer_id   - custom_code   - external_relation_id   - external_relation_kind   - folio_id   - id   - internal_code   - origin_id   - parent_id   - routed_from   - source_id   - source_identifier   - source_kind   - transaction_datetime   - trial_balance_id   - service_date  Supported fields for sorting:   - created_at - Same as `transaction_datetime`   - id   - internal_code   - source_id   - transaction_datetime   - service_date  Example request: ```   {     "filters": {       "and": [         {           "operator": "greater_than_or_equal",           "value": "2019-01-11t08:59:00Z",           "field": "transaction_datetime"         },         {           "operator": "equals",           "value": "123",           "field": "source_id"         },         {           "operator": "equals",           "value": "RESERVATION",           "field": "source_kind"         },         {           "or": [             {               "operator": "in",               "value": ["1", "2", "3"],               "field": "customer_id"             },             {               "operator": "equals",               "value": "9000",               "field": "internal_code"             }           ]         }       ]     },     "pageToken": null,     "limit": 10,     "sort": [       {         "field": "transaction_datetime",         "direction": "asc"       }     ]   }  The API has certain constraints for filters so that the system is able to efficiently query the data. Filters must include on of the following:   - filter by 'id' with condition 'equals' or 'in'   - filter by both 'source_id' and 'source_kind'   - filter by both 'external_relation_id' and 'external_relation_kind'   - filter by transaction_datetime ```
- [/accounting/v1.0/trial-balance/configuration/calculate](https://developers.cloudbeds.com/reference/calculatetrialbalance-1.md): Get initial Trial Balance based transaction records (till end of yesterday in property time)
- [/accounting/v1.0/trial-balance/configuration](https://developers.cloudbeds.com/reference/gettrialbalanceconfiguration-1.md): Get configured trial balance.
- [/accounting/v1.0/trial-balance/report](https://developers.cloudbeds.com/reference/gettrialbalancereport-1.md): Get Trial Balance Report for specific date
- [/accounting/v1.0/trial-balance/configuration/status](https://developers.cloudbeds.com/reference/istrialbalanceconfigured-1.md): Returns information if property has configured trial balance report.
- [/accounting/v1.0/trial-balance/configuration](https://developers.cloudbeds.com/reference/settrialbalance-1.md): Configure trial balance for property by saving opening balances for today. Fail if trial balance configuration already exists.
- [Introduction](https://developers.cloudbeds.com/reference/about-pms-api.md)
- [Tech Specs](https://developers.cloudbeds.com/reference/tech-specs.md)
- [Retrieve property add-ons](https://developers.cloudbeds.com/reference/addoncontrollergetaddons.md): Fetches list of Add-ons with basic information for a specific property
- [Get amenity catalog](https://developers.cloudbeds.com/reference/amenitycatalogcontrollergetamenitycatalog.md): Returns the complete list of amenities available for the specified scope (property or room) with their translated names and category codes.
- [Get amenity category catalog](https://developers.cloudbeds.com/reference/amenitycatalogcontrollergetamenitycategorycatalog.md): Returns the complete list of amenity categories available for the specified scope (property or room) with their translated names.
- [Get property amenities](https://developers.cloudbeds.com/reference/propertyamenitycontrollergetpropertyamenities.md): Retrieve the complete set of active property amenities.
- [Update property amenities](https://developers.cloudbeds.com/reference/propertyamenitycontrollerupdatepropertyamenities.md): Replace the complete set of active property amenities in a single atomic transaction.
- [Get amenities for all rooms in a property](https://developers.cloudbeds.com/reference/roomamenitycontrollergetpropertyroomsamenities.md): Retrieve the complete set of active amenities for all rooms in a property.
- [Get room amenities](https://developers.cloudbeds.com/reference/roomamenitycontrollergetroomamenities.md): Retrieve the complete set of active room amenities.
- [Update amenities for multiple rooms](https://developers.cloudbeds.com/reference/roomamenitycontrollerupdatepropertyroomsamenities.md): Replace the complete set of active amenities for multiple rooms in a single atomic transaction.
- [Update room amenities](https://developers.cloudbeds.com/reference/roomamenitycontrollerupdateroomamenities.md): Replace the complete set of active room amenities in a single atomic transaction.
- [Get all connected API clients for a property](https://developers.cloudbeds.com/reference/apiclientcontrollerconnectedapiclients-1.md)
- [Delete a list of doorlock keys.](https://developers.cloudbeds.com/reference/doorlockkeycontrollerbatchdelete-1.md)
- [Create a new doorlock key.](https://developers.cloudbeds.com/reference/doorlockkeycontrollercreate-1.md)
- [Delete a doorlock key.](https://developers.cloudbeds.com/reference/doorlockkeycontrollerdelete-1.md)
- [Get a list of doorlock keys for a specific app client and property.](https://developers.cloudbeds.com/reference/doorlockkeycontrollerindex-1.md)
- [Update a doorlock key.](https://developers.cloudbeds.com/reference/doorlockkeycontrollerupdate-1.md)
- [Delete doorlock settings for property for specific application client.](https://developers.cloudbeds.com/reference/doorlocksettingscontrollerdelete-1.md)
- [Get doorlock settings for property for specific application client.](https://developers.cloudbeds.com/reference/doorlocksettingscontrollersingle-1.md)
- [Upsert doorlock settings for property for specific application client.](https://developers.cloudbeds.com/reference/doorlocksettingscontrollerupsert-1.md)
- [Create a new event](https://developers.cloudbeds.com/reference/eventcontrollercreate.md): Creates a new event associated with an existing group profile or without any profile association.
- [Delete an event](https://developers.cloudbeds.com/reference/eventcontrollerdestroy.md): Deletes an event by ID or event code. This is a soft delete.
- [List events for a property](https://developers.cloudbeds.com/reference/eventcontrollerlist.md): Returns a paginated list of events for a property. Events contain operational data and reference group profiles via profileId.
- [Get a single event](https://developers.cloudbeds.com/reference/eventcontrollershow.md): Returns detailed information about a specific event.
- [Update an existing event](https://developers.cloudbeds.com/reference/eventcontrollerupdate.md): Updates an event. Only provided fields are updated. For profileId: omit to keep, null to clear, string to replace.
- [Create a note for an event](https://developers.cloudbeds.com/reference/eventnotecontrollercreate.md): Creates a new note for a specific event.
- [List notes for an event](https://developers.cloudbeds.com/reference/eventnotecontrollerlist.md): Returns a paginated list of notes for a specific event.
- [Update an event note](https://developers.cloudbeds.com/reference/eventnotecontrollerupdate.md): Updates an existing note or archives it.
- [Housekeeping inspection list](https://developers.cloudbeds.com/reference/27abd48cb30106ec3251cf3baf34174c-1.md)
- [Create a new integration event.](https://developers.cloudbeds.com/reference/integrationeventcontrollercreate-1.md)
- [Get a list of integration events for a specific property.](https://developers.cloudbeds.com/reference/integrationeventcontrollerindex-1.md)
- [Retry an integration event.](https://developers.cloudbeds.com/reference/integrationeventcontrollerretry-1.md)
- [Update an integration event.](https://developers.cloudbeds.com/reference/integrationeventcontrollerupdate-1.md)
- [Get a list of custom items for a specific property.](https://developers.cloudbeds.com/reference/customitemcontrollerindex-1.md)
- [Post one or more items to a reservation, house account, or group profile](https://developers.cloudbeds.com/reference/itemcontrollercreateitems.md): Adds items to a reservation, house account, or group profile. This endpoint supports batch operations, allowing multiple items to be posted in a single request. Each item can have associated payments and custom pricing.
- [Create a new Market Segmentation Group.](https://developers.cloudbeds.com/reference/groupcontrollercreate-1.md)
- [Delete a Market Segmentation Group.](https://developers.cloudbeds.com/reference/groupcontrollerdelete-1.md)
- [Disable a Market Segmentation Group.](https://developers.cloudbeds.com/reference/groupcontrollerdisable-1.md)
- [Enable a Market Segmentation Group.](https://developers.cloudbeds.com/reference/groupcontrollerenable-1.md)
- [Get a list of Market Segmentation Groups.](https://developers.cloudbeds.com/reference/groupcontrollerindex-1.md)
- [Get Market Segmentation Group data.](https://developers.cloudbeds.com/reference/groupcontrollersingle-1.md)
- [Update a Market Segmentation Group.](https://developers.cloudbeds.com/reference/groupcontrollerupdate-1.md)
- [Create a new Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollercreate-1.md)
- [Set Market Segmentation Segment as Default.](https://developers.cloudbeds.com/reference/segmentcontrollerdefault-1.md)
- [Delete a Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollerdelete-1.md)
- [Disable a Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollerdisable-1.md)
- [Enable a Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollerenable-1.md)
- [Get a list of Market Segmentation Segments.](https://developers.cloudbeds.com/reference/segmentcontrollerindex-1.md)
- [Get a list of reservations linked to a Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollerreservations-1.md)
- [Get Market Segmentation Segment data.](https://developers.cloudbeds.com/reference/segmentcontrollersingle-1.md)
- [Update a Market Segmentation Segment.](https://developers.cloudbeds.com/reference/segmentcontrollerupdate-1.md)
- [Retrieves the property's system component versions](https://developers.cloudbeds.com/reference/systemcontrollergetsystem.md)
- [Room out of service](https://developers.cloudbeds.com/reference/outofservicecontrollermake-1.md)
- [deleteAdjustment](https://developers.cloudbeds.com/reference/delete_deleteadjustment-2.md): Voids the AdjustmentID transaction on the specified reservationID
- [postAdjustment](https://developers.cloudbeds.com/reference/post_postadjustment-2.md): Adds an adjustment to a reservation
- [getAllotmentBlocks](https://developers.cloudbeds.com/reference/get_getallotmentblocks-2.md): Retrieve allotment blocks
- [listAllotmentBlockNotes](https://developers.cloudbeds.com/reference/get_listallotmentblocknotes-2.md): List notes added to an allotment block
- [createAllotmentBlock](https://developers.cloudbeds.com/reference/post_createallotmentblock-2.md): Retreive allotment blocks @apiQuery {Integer} propertyID Property ID
- [createAllotmentBlockNotes](https://developers.cloudbeds.com/reference/post_createallotmentblocknotes-2.md): Add a note to an allotment block
- [deleteAllotmentBlock](https://developers.cloudbeds.com/reference/post_deleteallotmentblock-2.md): Delete allotment blocks
- [updateAllotmentBlock](https://developers.cloudbeds.com/reference/post_updateallotmentblock-2.md): Update an allotment block @apiQuery {Integer} propertyID Property ID
- [updateAllotmentBlockNotes](https://developers.cloudbeds.com/reference/post_updateallotmentblocknotes-2.md): Update a note on an allotment block
- [getAppPropertySettings](https://developers.cloudbeds.com/reference/get_getapppropertysettings-2.md): Returns the app property settings
- [deleteAppPropertySettings](https://developers.cloudbeds.com/reference/post_deleteapppropertysettings-2.md)
- [postAppPropertySettings](https://developers.cloudbeds.com/reference/post_postapppropertysettings-2.md)
- [putAppPropertySettings](https://developers.cloudbeds.com/reference/post_putapppropertysettings-2.md)
- [metadata](https://developers.cloudbeds.com/reference/get_oauth-metadata-2.md): In the context of properties being distributed across multiple localizations, this endpoint serves to retrieve the precise location of the property associated with the provided access token. Further information can be found in the [Authentication guide](https://integrations.cloudbeds.com/hc/en-us/sections/14731510501915-Authentication).
- [userinfo](https://developers.cloudbeds.com/reference/get_userinfo-2.md): Returns information on user who authorized connection
- [access_token](https://developers.cloudbeds.com/reference/post_access-token-2.md): Query the authorization server for an access token used to access property resources.</br> If the automatic delivery method for API keys is used, the grant type `urn:ietf:params:oauth:grant-type:api-key` needs to be used to request an API key. This grant type requires `grant_type=urn:ietf:params:oauth:grant-type:api-key`, `client_id`, `client_secret`, `redirect_uri` and `code`.</br> For OAuth 2.0., two different grant types (`authorization_code`, `refresh_token`) are supported. Authorization code grant type requires `grant_type=authorization_code`, `client_id`, `client_secret`, `redirect_uri`, `code`. Refresh token grant type requires `grant_type=refresh_token`, `client_id`, `client_secret`, `refresh_token`.</br> Read the [Authentication guide](https://integrations.cloudbeds.com/hc/en-us/sections/14731510501915-Authentication) for implementation tips, user flows and testing advice.
- [getCurrencySettings](https://developers.cloudbeds.com/reference/get_getcurrencysettings-2.md): Get currency settings
- [getCustomFields](https://developers.cloudbeds.com/reference/get_getcustomfields-2.md): Gets custom fields list<br /> ¹ data.displayed = "booking" - Display this field to guests on the booking engine.<br /> ¹ data.displayed = "reservation" - Add this field to the reservation folio for use by staff.<br /> ¹ data.displayed = "card" - Make this field available for registration cards.<br />
- [postCustomField](https://developers.cloudbeds.com/reference/post_postcustomfield-2.md): Sets custom fields. The call should only be made once to add the field to the system.
- [getDashboard](https://developers.cloudbeds.com/reference/get_getdashboard-2.md): Returns basic information about the current state of the hotel
- [getEmailSchedule](https://developers.cloudbeds.com/reference/get_getemailschedule-2.md): Returns a list of all existing email scheduling. This call is only available for third-party integration partners, and not for property client IDs.
- [getEmailTemplates](https://developers.cloudbeds.com/reference/get_getemailtemplates-2.md): Returns a list of all existing email templates. This call is only available for third-party integration partners, and not for property client IDs.
- [postEmailSchedule](https://developers.cloudbeds.com/reference/post_postemailschedule-2.md): Creates a new email schedule for existing email template. Email template can be scheduled based on two parameters: reservationStatusChange and reservationEvent. Only one of the parameters can be used. *reservationStatusChange* schedules email to be sent when reservation status transitions to a specific one, for instance: `confirmed`. *reservationEvent* schedules email to be sent number of days prior or after a specific event, for instance: `after_check_out` at a given time This call is only available for third-party integration partners, and not for property client IDs.
- [postEmailTemplate](https://developers.cloudbeds.com/reference/post_postemailtemplate-2.md): Creates a new email template. See the full list of available language parameters <a href="https://integrations.cloudbeds.com/hc/en-us/articles/360007144993-FAQ#methods-and-parameters">here</a>. This call is only available for third-party integration partners, and not for property client IDs.
- [getGroupNotes](https://developers.cloudbeds.com/reference/get_getgroupnotes-2.md): Returns group notes
- [getGroups](https://developers.cloudbeds.com/reference/get_getgroups-2.md): Returns the groups for a property
- [patchGroup](https://developers.cloudbeds.com/reference/post_patchgroup-2.md): Updates an existing group with information provided. At least one information field is required for this call.
- [postGroupNote](https://developers.cloudbeds.com/reference/post_postgroupnote-2.md): Adds a group note
- [putGroup](https://developers.cloudbeds.com/reference/post_putgroup-2.md): Adds a group to the property. Please note that the default setting for 'Route to Group Folio' will be 'No,' and the 'Reservation Folio Configuration' will be set as the default folio configuration. You can edit these settings through the user interface (UI).
- [deleteGuestNote](https://developers.cloudbeds.com/reference/delete_deleteguestnote-2.md): Archives an existing guest note.
- [getGuest](https://developers.cloudbeds.com/reference/get_getguest-2.md): Returns information on a guest specified by the Reservation ID parameter
- [getGuestList](https://developers.cloudbeds.com/reference/get_getguestlist-2.md): Returns a list of guests, ordered by modification date ### Group account support
- [getGuestNotes](https://developers.cloudbeds.com/reference/get_getguestnotes-2.md): Retrieves a guest notes
- [getGuestsByFilter](https://developers.cloudbeds.com/reference/get_getguestsbyfilter-2.md): Returns a list of guests matching the selected parameters ### Group account support
- [getGuestsByStatus](https://developers.cloudbeds.com/reference/get_getguestsbystatus-2.md): Returns a list of guests in the current status (Not Checked In, In House, Checked Out or Cancelled), sorted by modification date. If no date range is passed, it returns all guests with the selected status. ### Group account support
- [getGuestsModified](https://developers.cloudbeds.com/reference/get_getguestsmodified-2.md): Returns a list of guests based on their modification date. Note that when a guest checks in or checks out of a room, their record is modified at that time. If no date range is passed, only the records for the current day are returned. Also note that if the guest is assigned to multiple rooms, it will result in multiple records. ### Group account support
- [postGuest](https://developers.cloudbeds.com/reference/post_postguest-2.md): Adds a guest to reservation as an additional guest.
- [postGuestDocument](https://developers.cloudbeds.com/reference/post_postguestdocument-2.md): Attaches a document to a guest
- [postGuestNote](https://developers.cloudbeds.com/reference/post_postguestnote-2.md): Adds a guest note
- [postGuestPhoto](https://developers.cloudbeds.com/reference/post_postguestphoto-2.md): Attaches a photo to a guest
- [postGuestsToRoom](https://developers.cloudbeds.com/reference/post_postgueststoroom-2.md): Assigns guest(s) to a room in a reservation and adds these guests as additional guests.
- [putGuest](https://developers.cloudbeds.com/reference/put_putguest-2.md): Updates an existing guest with information provided. At least one information field is required for this call.
- [putGuestNote](https://developers.cloudbeds.com/reference/put_putguestnote-2.md): Updates an existing guest note.
- [getFiles](https://developers.cloudbeds.com/reference/get_getfiles-2.md): Returns a list of files attached to a hotel or group profile, ordered by creation date
- [getHotelDetails](https://developers.cloudbeds.com/reference/get_gethoteldetails-2.md): Returns the details of a specific hotel, identified by "propertyID"
- [getHotels](https://developers.cloudbeds.com/reference/get_gethotels-2.md): Returns a list of hotels, filtered by the parameters passed ### Group account support
- [postFile](https://developers.cloudbeds.com/reference/post_postfile-2.md): Attaches a file to a hotel
- [getHouseAccountList](https://developers.cloudbeds.com/reference/get_gethouseaccountlist-2.md): Pulls list of active house accounts
- [postNewHouseAccount](https://developers.cloudbeds.com/reference/post_postnewhouseaccount-2.md): Add a new House Account
- [putHouseAccountStatus](https://developers.cloudbeds.com/reference/put_puthouseaccountstatus-2.md): Change specific house account to either open or closed.
- [getHousekeepers](https://developers.cloudbeds.com/reference/get_gethousekeepers-2.md): Returns a list of housekeepers ### Group account support
- [getHousekeepingStatus](https://developers.cloudbeds.com/reference/get_gethousekeepingstatus-2.md): Returns the current date's housekeeping information The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true
- [postHousekeeper](https://developers.cloudbeds.com/reference/post_posthousekeeper-2.md): Add New Housekeeper
- [postHousekeepingAssignment](https://developers.cloudbeds.com/reference/post_posthousekeepingassignment-2.md): Assign rooms (single or multiple) to an existing housekeeper
- [postHousekeepingStatus](https://developers.cloudbeds.com/reference/post_posthousekeepingstatus-2.md): Switches the current date's housekeeping status for a specific room ID to either clean or dirty The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true
- [putHousekeeper](https://developers.cloudbeds.com/reference/put_puthousekeeper-2.md): Edit Housekeeper Details
- [deleteWebhook](https://developers.cloudbeds.com/reference/delete_deletewebhook-2.md): Remove subscription for webhook. Read the [Webhooks guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007612553-Webhooks) to see available objects, actions, payload info and more. ### Group account support
- [getAppSettings](https://developers.cloudbeds.com/reference/get_getappsettings-2.md): Get the current app settings for a property.<br />
- [getAppState](https://developers.cloudbeds.com/reference/get_getappstate-2.md): Get the current app integration state for a property.<br /> This call is only available for third-party integration partners, and not for property client IDs. Read the [Connecting/Disconnecting Apps guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007613213-Connecting-Disconnecting-Apps) to further understand the use cases.
- [getWebhooks](https://developers.cloudbeds.com/reference/get_getwebhooks-2.md): List webhooks for which the API client is subscribed to.
- [postAppError](https://developers.cloudbeds.com/reference/post_postapperror-2.md): Submit the error received by the hybrid integration from the partner to the MFD
- [postAppState](https://developers.cloudbeds.com/reference/post_postappstate-2.md): Update app integration state for a property ID. <br /> This call is only available for third-party integration partners, and not for property client IDs. <br /> If an app is set to 'disabled', it will remove all active sessions Read the [Connecting/Disconnecting Apps guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007613213-Connecting-Disconnecting-Apps) to further understand the use cases.
- [postGovernmentReceipt](https://developers.cloudbeds.com/reference/post_postgovernmentreceipt-2.md): Add a Government Receipt to a Reservation or House Account
- [postWebhook](https://developers.cloudbeds.com/reference/post_postwebhook-2.md): Subscribe a webhook for a specified event. Read the [Webhooks guide](https://integrations.cloudbeds.com/hc/en-us/articles/360007612553-Webhooks) to see available objects, actions, payload info and more.
- [getItem](https://developers.cloudbeds.com/reference/get_getitem-2.md): Gets the details for the one itemID<br /> <sup>1</sup> only if data.stockInventory = true<br> <sup>2</sup> Taxes, fees and totals will show up only if an item has assigned tax or fee.<br>
- [getItemCategories](https://developers.cloudbeds.com/reference/get_getitemcategories-2.md): Gets the item category list
- [getItems](https://developers.cloudbeds.com/reference/get_getitems-2.md): Gets all the items and their prices the hotel has created in myfrontdesk<br> <sup>1</sup> only if data.stockInventory = true<br> <sup>2</sup> Taxes, fees and totals will show up only if an item has assigned tax or fee.<br>
- [appendCustomItem](https://developers.cloudbeds.com/reference/post_appendcustomitem-2.md): Append single, or multiple, custom items and their associated payments to a existing one in a Reservation.
- [postCustomItem](https://developers.cloudbeds.com/reference/post_postcustomitem-2.md): Adds single, or multiple, custom items and their associated payments to a Reservation or House Account as a single transaction.
- [postItem](https://developers.cloudbeds.com/reference/post_postitem-2.md): Adds an item either to a reservation or to a house account.
- [postItemCategory](https://developers.cloudbeds.com/reference/post_postitemcategory-2.md): Adds new items category
- [postItemsToInventory](https://developers.cloudbeds.com/reference/post_postitemstoinventory-2.md): Adds new items batch<br /> ¹ only if item.stockInventory = true<br />
- [postVoidItem](https://developers.cloudbeds.com/reference/post_postvoiditem-2.md): Voids the itemID transaction on the specified Reservation ID, House Account ID, or Group. If payments were sent in calls [postItem](https://developers.cloudbeds.com/reference/post_postitem) or [postCustomItem](https://developers.cloudbeds.com/reference/post_postcustomitem), they will be deleted too.
- [putItemToInventory](https://developers.cloudbeds.com/reference/put_putitemtoinventory-2.md): Updates an item with information provided<br /> ¹ only if item.stockInventory = true<br />
- [getPackageNames](https://developers.cloudbeds.com/reference/get_getpackagenames-2.md): Return a list of billing package names for a property
- [getPackages](https://developers.cloudbeds.com/reference/get_getpackages-2.md): This efficient method allows you to retrieve the collection of packages associated with a property. Packages here define a group of features that a property has the ability to utilize or access. By invoking this API method, developers will get a comprehensive view of the feature sets that are available and active for a specific property. The getPackages method boasts a seamless execution that offers essential information, vital in enhancing property management, understanding available functionalities and ultimately, optimizing user experience.
- [getPaymentMethods](https://developers.cloudbeds.com/reference/get_getpaymentmethods-2.md): Get a list of active methods for a property, or list of properties
- [getPaymentsCapabilities](https://developers.cloudbeds.com/reference/get_getpaymentscapabilities-2.md): Lists the payment capabilities of a given property
- [postCharge](https://developers.cloudbeds.com/reference/post_postcharge-2.md): Use a payment method to process a payment on a reservation, group profile, accounts receivable ledger, or house account.
- [postCreditCard](https://developers.cloudbeds.com/reference/post_postcreditcard-2.md): Returns the rate of the room type selected, based on the provided parameters
- [postCustomPaymentMethod](https://developers.cloudbeds.com/reference/post_postcustompaymentmethod-2.md): Add a Custom Payment Method to a property. This call does not allow to add Payment Methods: credit cards, bank transfer or Pay Pal.
- [postPayment](https://developers.cloudbeds.com/reference/post_postpayment-2.md): Add a payment to a specified reservation, house account, or group. If multiple IDs are provided, precedence is reservationID, then houseAccountID, then groupCode.
- [postVoidPayment](https://developers.cloudbeds.com/reference/post_postvoidpayment-2.md): Voids a payment (using paymentID) to a specified reservation or house account.
- [getRate](https://developers.cloudbeds.com/reference/get_getrate-2.md): Returns the rate of the room type selected, based on the provided parameters
- [getRateJobs](https://developers.cloudbeds.com/reference/get_getratejobs-2.md): Returns a list of Rate Jobs. Rate jobs are only returned within 7 days of creation, after 7 days they will not be returned in the response. Requests which do not provide a jobReferenceID will be filtered by the client ID of the request's token.
- [getRatePlans](https://developers.cloudbeds.com/reference/get_getrateplans-2.md): Returns the rates of the room type or promo code selected, based on the provided parameters. If no parameters are provided, then the method will return all publicly available rate plans. ### Group account support
- [patchRate](https://developers.cloudbeds.com/reference/post_patchrate-2.md): Update the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a startDate and/or endDate will update rates only within the interval provided. Only non derived rates can be updated, requests to update a derived rate will return an error. This endpoint performs updates asynchronously,  rate updates are added to a queue and the endpoint returns a job reference ID. This job reference ID can be used to track job status notifications or to look up details of the update once it is completed. The API is limited to 30 interval per update, sending more than 30 will return an error.
- [putRate](https://developers.cloudbeds.com/reference/post_putrate-2.md): Update the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a startDate and/or endDate will update rates only within the interval provided. Only non derived rates can be updated, requests to update a derived rate will return an error. This endpoint performs updates asynchronously,  rate updates are added to a queue and the endpoint returns a job reference ID. This job reference ID can be used to track job status notifications or to look up details of the update once it is completed. The API is limited to 30 interval per update, sending more than 30 will return an error.
- [deleteReservationNote](https://developers.cloudbeds.com/reference/delete_deletereservationnote-2.md): Archives an existing reservation note.
- [getReservation](https://developers.cloudbeds.com/reference/get_getreservation-2.md): Returns information on a booking specified by the reservationID parameter
- [getReservationAssignments](https://developers.cloudbeds.com/reference/get_getreservationassignments-2.md): Returns a list of rooms/reservations assigned for a selected date.
- [getReservationNotes](https://developers.cloudbeds.com/reference/get_getreservationnotes-2.md): Retrieves reservation notes based on parameters
- [getReservations](https://developers.cloudbeds.com/reference/get_getreservations-2.md): Returns a list of reservations that matched the filters criteria.<br /> Please note that some reservations modification may not be reflected in this timestamp. ### Group account support
- [getReservationsWithRateDetails](https://developers.cloudbeds.com/reference/get_getreservationswithratedetails-2.md): Returns a list of reservations with added information regarding booked rates and sources.<br /> Please note that some reservations modification may not be reflected in this timestamp.
- [getSources](https://developers.cloudbeds.com/reference/get_getsources-2.md): Gets available property sources
- [postReservation](https://developers.cloudbeds.com/reference/post_postreservation-2.md): Adds a reservation to the selected property
- [postReservationDocument](https://developers.cloudbeds.com/reference/post_postreservationdocument-2.md): Attaches a document to a reservation
- [postReservationNote](https://developers.cloudbeds.com/reference/post_postreservationnote-2.md): Adds a reservation note
- [putReservation](https://developers.cloudbeds.com/reference/put_putreservation-2.md): Updates a reservation, such as custom fields, estimated arrival time, room configuration and reservation status.
- [putReservationNote](https://developers.cloudbeds.com/reference/put_putreservationnote-2.md): Updates an existing reservation note.
- [deleteRoomBlock](https://developers.cloudbeds.com/reference/delete_deleteroomblock-2.md): Deletes a room block
- [getAvailableRoomTypes](https://developers.cloudbeds.com/reference/get_getavailableroomtypes-2.md): Returns a list of room types with availability considering the informed parameters ### Group account support
- [getReservationRoomDetails](https://developers.cloudbeds.com/reference/get_getreservationroomdetails-2.md): Returns information about particular room in reservation by its subReservationID
- [getRoomBlocks](https://developers.cloudbeds.com/reference/get_getroomblocks-2.md): Returns a list of all room blocks considering the informed parameters.
- [getRooms](https://developers.cloudbeds.com/reference/get_getrooms-2.md): Returns a list of all rooms considering the informed parameters. If Check-in/out dates are sent, only unassigned rooms are returned. ### Group account support
- [getRoomsFeesAndTaxes](https://developers.cloudbeds.com/reference/get_getroomsfeesandtaxes-2.md): Get applicable fees and tax to a booking. This is meant to be used on checkout to display to the guest.
- [getRoomsUnassigned](https://developers.cloudbeds.com/reference/get_getroomsunassigned-2.md): Returns a list of unassigned rooms in the property. Call is alias of [getRooms](#api-Room-getRooms). Please check its documentation for parameters, response and example. ### Group account support
- [getRoomTypes](https://developers.cloudbeds.com/reference/get_getroomtypes-2.md): Returns a list of room types filtered by the selected parameters ### Group account support
- [postRoomAssign](https://developers.cloudbeds.com/reference/post_postroomassign-2.md): Assign/Reassign a room on a guest reservation
- [postRoomBlock](https://developers.cloudbeds.com/reference/post_postroomblock-2.md): Adds a room block to the selected property.
- [postRoomCheckIn](https://developers.cloudbeds.com/reference/post_postroomcheckin-2.md): Check-in a room already assigned for a guest
- [postRoomCheckOut](https://developers.cloudbeds.com/reference/post_postroomcheckout-2.md): Check-out a room already assigned for a guest. If all rooms are checked out, the reservation status will update accordingly to "Checked Out" as well.
- [putRoomBlock](https://developers.cloudbeds.com/reference/put_putroomblock-2.md): Updates a room block.
- [getTaxesAndFees](https://developers.cloudbeds.com/reference/get_gettaxesandfees-2.md): Returns the taxes and fees set for the property. Read the [Rate-Based tax (Dynamic Tax) guide](https://myfrontdesk.cloudbeds.com/hc/en-us/articles/360014103514-rate-based-tax-dynamic-tax) to understand its usage.
- [getUsers](https://developers.cloudbeds.com/reference/get_getusers-2.md): Returns information on the properties' users ### Group account support
- [Delete logo image for fiscal documents](https://developers.cloudbeds.com/reference/deletelogo.md): Delete the logo image used in fiscal document templates.
- [Get list of fiscal documents configs](https://developers.cloudbeds.com/reference/getconfigs.md): Retrieves a paginated list of fiscal documents filtered by optional criteria.
- [Get logo image for fiscal documents](https://developers.cloudbeds.com/reference/getlogo.md): Retrieve the logo image used in fiscal document templates as a presigned URL.
- [Get PDF document preview](https://developers.cloudbeds.com/reference/getpdfpreview.md): Build and return PDF document
- [Updates a config of a specific kind](https://developers.cloudbeds.com/reference/updateconfigs.md): Update document config.
- [Upload logo image for fiscal documents](https://developers.cloudbeds.com/reference/uploadlogo.md): Upload a logo image to be used in fiscal document templates.
- [Get folio list of transactions exported as PDF](https://developers.cloudbeds.com/reference/getfoliopdf.md): Get folio list of transactions exported as PDF
- [Get enabled features for the current user and property](https://developers.cloudbeds.com/reference/getpropertyfeatures.md): Returns a map of feature flags enabled for the authenticated user in the context of the current property.
- [Allocate payment associated with receipt to charge transactions.](https://developers.cloudbeds.com/reference/allocatereceiptpayment.md): Allocate payment associated with receipt to charge transactions. The amounts of all allocations must be equal to the payment amount. The transactions should not be fully allocated already   and the amount allocated should not be more than the remaining balance on the transaction. All transactions not part of an invoice will be added to newly created invoice.
- [Create a fiscal document of the type credit note](https://developers.cloudbeds.com/reference/createcreditnote.md): Create a fiscal document of the type credit note.
- [Create a fiscal document of the type invoice](https://developers.cloudbeds.com/reference/createinvoice.md): Create a fiscal document of the type invoice.
- [Create a fiscal document of the type pro forma invoice](https://developers.cloudbeds.com/reference/createproformainvoice.md): Create a fiscal document of the type pro forma invoice.  **Pro Forma Invoice Characteristics:** - Contains pending transactions that are subject to change - Includes payment information - Transactions are NOT locked (unlike regular invoices) - Can be converted to regular invoices later when transactions are posted - Has its own sequence numbering and settings
- [Create receipt for a payment.](https://developers.cloudbeds.com/reference/createreceipt.md): Create a receipt for a payment and optionally specify allocations per transaction. In case of no allocations, a 'Simple receipt' will be created that can later be allocated to charge transactions. The amounts of all allocations must be equal to the payment amount. The transactions should not be fully allocated already   and the amount allocated should not be more than the remaining balance on the transaction. All transactions not part of an invoice will be added to newly created invoice.
- [Create a fiscal document of the type rectify invoice](https://developers.cloudbeds.com/reference/createrectifyinvoice.md): Create a fiscal document of the type rectify invoice.  **Spanish Fiscal Regulations:** - Only available for properties in Spain - An invoice that has already been rectified cannot be rectified again - To make corrections to a rectified invoice, you must rectify the most recent invoice in the rectification chain  **Validation Rules:** - The target invoice must not have been previously rectified - If the invoice has been rectified, the API will return an error with details about which invoice should be rectified instead
- [Create simple receipts.](https://developers.cloudbeds.com/reference/createsimplereceipt.md): Create receipts for list of payments without allocations.
- [Download fiscal document](https://developers.cloudbeds.com/reference/downloadfiscaldocument.md): Initiates the download of the fiscal document file
- [Email a fiscal document](https://developers.cloudbeds.com/reference/emailfiscaldocument.md): Initiates the process to send the invoice to a customer
- [Get payment allocation transactions](https://developers.cloudbeds.com/reference/getallocations.md): Retrieves payment allocations.
- [Get allocations summary](https://developers.cloudbeds.com/reference/getallocationssummary.md): Retrieves allocations summary.
- [Get fiscal document preview of the type credit note](https://developers.cloudbeds.com/reference/getcreditnotepreview.md): Get fiscal document preview of the type credit note.
- [Get fiscal document preview of the type invoice](https://developers.cloudbeds.com/reference/getdocumentpreview.md): Get fiscal document preview of the type invoice.
- [Get list of recipients associated to the fiscal document](https://developers.cloudbeds.com/reference/getfiscaldocumentrecipientsbyid.md): Retrieves a list of recipients associated to the transaction.
- [Get list of fiscal documents](https://developers.cloudbeds.com/reference/getfiscaldocuments.md): Retrieves a paginated list of fiscal documents filtered by optional criteria.
- [Get available transactions for fiscal documents](https://developers.cloudbeds.com/reference/getfiscaldocumenttransactions.md): Retrieves a paginated list of available transactions for a source based on the document type. - For INVOICE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled - For CREDIT_NOTE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled - For PRO_FORMA_INVOICE: Returns both pending transactions and posted (paid) payments - Transactions already included in fiscal documents are excluded - Each transaction includes a status field (PENDING or POSTED)
- [Get list of transactions for a given fiscal document id](https://developers.cloudbeds.com/reference/getfiscaldocumenttransactionsbyid.md): Retrieves a paginated list of available transactions for fiscal document id.
- [Get available transactions for allocations](https://developers.cloudbeds.com/reference/getfiscaldocumenttransactionsforallocation.md): Retrieves a paginated list of available transactions for allocations.
- [Create a fiscal document of the type pro forma invoice](https://developers.cloudbeds.com/reference/getproformapreview.md): Create a fiscal document of the type pro forma invoice.  **Pro Forma Invoice Characteristics:** - Contains pending transactions that are subject to change - Includes payment information - Transactions are NOT locked (unlike regular invoices) - Can be converted to regular invoices later when transactions are posted - Has its own sequence numbering and settings
- [Get fiscal document preview of the type rectify invoice](https://developers.cloudbeds.com/reference/getrectifyinvoicepreview.md): Get fiscal document preview of the type rectify invoice. **Spanish Fiscal Regulations:** - Only available for properties in Spain - An invoice that has already been rectified cannot be rectified again - To make corrections to a rectified invoice, you must rectify the most recent invoice in the rectification chain **Validation Rules:** - The target invoice must not have been previously rectified - If the invoice has been rectified, the API will return an error with details about which invoice should be rectified instead
- [Get totals of selected available transactions for fiscal documents](https://developers.cloudbeds.com/reference/getselectedtransactionssummary.md): Get totals of selected available transactions for fiscal documents based on the document type.
- [Get totals of transactions for a given fiscal document id](https://developers.cloudbeds.com/reference/gettransactionssummarybydocumentid.md): Get totals of transactions for a given fiscal document id.
- [Update a fiscal document by id](https://developers.cloudbeds.com/reference/putfiscaldocument.md): Update a fiscal document status, government integration details, or failure reason. Used by integration partners to update document lifecycle and government processing status.  **Common Updates:** - Update status (PENDING_INTEGRATION, COMPLETED_INTEGRATION, FAILED, etc.) - Set government integration details (series, number, external ID, QR codes) - Record failure reasons for failed integrations  **Invoice Cancellation (Spanish Properties Only):** - Set status to CANCEL_REQUESTED to cancel invoices - Only invoices in OPEN, PAID, PARTIALLY_PAID or CORRECTION_NEEDED status can be canceled - Invoices with rectifying documents cannot be canceled - Integration partners must handle CANCEL_REQUESTED and update to CANCELED (success) or revert to previous status (failure)
- [Update pro forma invoice status](https://developers.cloudbeds.com/reference/updateproformainvoicestatus.md): Update the status of a pro forma invoice. Supported status transitions: - OPEN -> ACCEPTED, REJECTED, CANCELED - ACCEPTED -> CANCELED - REJECTED -> CANCELED
- [Void a receipt](https://developers.cloudbeds.com/reference/voidreceipt.md): Voids a receipt by updating its status to VOIDED. The receipt must be in OPEN status. For Italy, a refund receipt will be automatically created and linked to the voided receipt.
- [Add contact person to a profile (group, company, or travel agent)](https://developers.cloudbeds.com/reference/addprofilecontactperson.md)
- [Delete contact person from a profile (group, company, or travel agent)](https://developers.cloudbeds.com/reference/deleteprofilecontactperson.md)
- [Get contact person by ID](https://developers.cloudbeds.com/reference/getcontactpersonbyid.md)
- [Search contact persons of organization](https://developers.cloudbeds.com/reference/searchcontactpersons.md)
- [Update contact person for a profile (group, company, or travel agent)](https://developers.cloudbeds.com/reference/updateprofilecontactperson.md)
- [Create a new profile (any type)](https://developers.cloudbeds.com/reference/createprofile.md): Create a company, group, or travel agent profile based on the attributes provided in the request body
- [Delete profile (any type)](https://developers.cloudbeds.com/reference/deleteprofile.md): Delete a company, group, or travel agent profile. The profile type is automatically determined.
- [Get profile by ID (any type)](https://developers.cloudbeds.com/reference/getprofilebyid.md): Retrieve a company, group, or travel agent profile by its ID. The profile type is determined from the stored data.
- [List all profiles across all types](https://developers.cloudbeds.com/reference/listallprofiles.md)
- [Update profile (any type)](https://developers.cloudbeds.com/reference/updateprofile.md): Update a company, group, or travel agent profile. The profile type is determined from existing data and cannot be changed.
- [Delete profile document](https://developers.cloudbeds.com/reference/deleteprofiledocument.md): Delete a document from a profile
- [Get document download URL](https://developers.cloudbeds.com/reference/downloadprofiledocument.md): Get a pre-signed URL for downloading the document file (valid for 5 minutes)
- [Get profile document metadata by ID](https://developers.cloudbeds.com/reference/getprofiledocument.md): Get metadata for a specific document
- [List documents for a profile](https://developers.cloudbeds.com/reference/listprofiledocuments.md): Get all documents for a profile (group, company, or travel agent)
- [Upload document(s) to a profile](https://developers.cloudbeds.com/reference/uploadprofiledocuments.md): Upload one or more documents for a profile (group, company, or travel agent)
- [Add note to a profile](https://developers.cloudbeds.com/reference/addprofilenote.md): Create a new note for a profile (group, company, or travel agent)
- [Archive profile note](https://developers.cloudbeds.com/reference/archiveprofilenote.md): Archive a note by setting the archived_at timestamp. Archived notes can be restored later.
- [Delete profile note](https://developers.cloudbeds.com/reference/deleteprofilenote.md): Delete a note from a profile
- [Get profile note by ID](https://developers.cloudbeds.com/reference/getprofilenote.md): Get a specific note for a profile
- [List notes for a profile](https://developers.cloudbeds.com/reference/listprofilenotes.md): Get all notes for a profile (group, company, or travel agent)
- [Restore archived profile note](https://developers.cloudbeds.com/reference/restoreprofilenote.md): Restore an archived note by unsetting the archived_at timestamp.
- [Update profile note](https://developers.cloudbeds.com/reference/updateprofilenote.md): Update an existing note for a profile
- [Create a new person relationship for a profile](https://developers.cloudbeds.com/reference/createprofileperson.md): Create a relationship between this profile and a person/guest
- [Find by person ID](https://developers.cloudbeds.com/reference/findbypersonid.md): Get all profile where person is the target (reverse lookup)
- [List person for a profile](https://developers.cloudbeds.com/reference/listprofileperson.md): Get all person where this profile is linked to persons/guests
- [Unlink person from a profile](https://developers.cloudbeds.com/reference/unlinkprofileperson.md): Remove the relationship between this profile and a person/guest
- [Assign Tag to a profile](https://developers.cloudbeds.com/reference/addprofiletag.md)
- [Delete tag from profile](https://developers.cloudbeds.com/reference/deleteprofiletag.md)
- [List tags for profile](https://developers.cloudbeds.com/reference/listprofiletags.md)
- [Get all charts](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-charts-1.md)
- [Search for a chart](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-charts-search-1.md)
- [Get Datasets](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-1.md): Obtain all the available Cloudbeds Datasets   | Dataset                   | Dataset Name          | Description                                                                                                                                                                                       | | ------                    | ------                | ----------                                                                                                                                                                                        | | Financial                 | Financial             | Financial transactions that are made, including debits and credit and their attributes                                                                                                            | | Guest                     | Guests                | The details on each guest at the hotel, including the history if their stays, their contact information, document information, etc                                                                | | Reservations              | Reservations          | Booking or Reservation information include who booked, where the booking came from, when it occurs, the price, the rate plans, room types, etc                                                    | | Occupancy                 | Occupancy             | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Payments                  | Payment               | Payment processing information, including charges, fees, chargebacks, reversals, etc. | Invoices                  | Invoices              | Invoices information, including reservation level information etc and credit notes. | Occupancy (Beta)          | Occupancy (Beta)      | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Housekeeping              | Housekeeping          | ...
- [Get Dataset by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-1.md): Obtain all the CDF information related with each Dataset and the last time the dataset has been refreshed If categories is true, CDFs will be grouped by category  **CDF**: Cloudbeds Data field.  | Dataset                   | Dataset Id  | Description                                                                                                                                                                                       | | ------                    | ------      | ----------                                                                                                                                                                                        | | Financial                 | 1           | Financial transactions that are made, including debits and credit and their attributes                                                                                                            | | Guest                     | 2           | The details on each guest at the hotel, including the history if their stays, their contact information, document information, etc                                                                | | Reservations              | 3           | Booking or Reservation information include who booked, where the booking came from, when it occurs, the price, the rate plans, room types, etc                                                    | | Occupancy                 | 4           | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Payments                  | 5           | Payment processing information, including charges, fees, chargebacks, reversals, etc. | Invoices                  | 6           | Invoices information, including reservation level information etc and credit notes. | Occupancy (Beta)          | 7           | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Housekeeping              | 8           | ...               |
- [Get the CDF (Cloudbeds Data Field) picklist options](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-cdf-1.md)
- [List of multi-levels per dataset.](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-multi-levels-1.md): Obtain list of all multi-levels associated with particular datasets.  Some datasets might live alone without any levels associated with them.      Reservations (Dataset)     │     └───Room Reservation (Multi-level)         │         └─── Room Check-in (CDF)         │         └─── Room Check-out (CDF)         │         └─── Room Reservation Status (CDF)
- [List of multi-level CDFs associated by dataset.](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-multi-levels-multi-level-id-1.md): Obtain list of all CDFs (Part of multi-level) associated with particular dataset.  Some datasets might live alone without any levels associated with them.      Reservations (Dataset)     │     └───Room Reservation (Multi-level)         │         └─── Room Check-in (CDF)         │         └─── Room Check-out (CDF)         │         └─── Room Reservation Status (CDF)
- [Get the CDF (Cloudbeds Data Field) picklist options for Multi level](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-multi-levels-multi-level-id-cdf-1.md)
- [Get Dataset by id Updated At](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-datasets-dataset-id-updated-at-1.md): Obtain the last time your property receive an event based on the Dataset ID. For example if the Dataset ID is Reservation it will show the last time DI received a reservation. If you have a lag bigger than 5 minutes please raise a ZD Ticket.  **CDF**: Cloudbeds Data field.  | Dataset                   | Dataset Id  | Description                                                                                                                                                                                       | | ------                    | ------      | ----------                                                                                                                                                                                        | | Financial                 | 1           | Financial transactions that are made, including debits and credit and their attributes                                                                                                            | | Guest                     | 2           | The details on each guest at the hotel, including the history if their stays, their contact information, document information, etc                                                                | | Reservations              | 3           | Booking or Reservation information include who booked, where the booking came from, when it occurs, the price, the rate plans, room types, etc                                                    | | Occupancy                 | 4           | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Payments                  | 5           | Payment processing information, including charges, fees, chargebacks, reversals, etc. | Invoices                  | 6           | Invoices information, including reservation level information etc and credit notes. | Occupancy (Beta)          | 7           | The productivity information for the hotel, including metrics such as occupancy, room nights, Revpar, ADR, etc.  Used by revenue managers to set prices and distribution strategies               | | Housekeeping              | 8           | ...               |
- [/datainsights/v1.1/explore](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-explore-1.md)
- [Delete favorite](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-favorites-id-1.md): Delete a favorite that is not used anymore. Unfavorite action for a given report in a property for the user that is authorized
- [List of Favorites in a property for the user that is authorized](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-favorites-1.md): Get a list of all the created favorites for a user on a specific property.
- [Get a Favorite by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-favorites-id-1.md): Get a Favorite by id.
- [Update a rank](https://developers.cloudbeds.com/reference/patch_datainsights-v1-1-favorites-id-1.md): Update the rank of a favorite. If there is already a favorite in the new position, it will be updated with the current rank, swapping the position  **Notes** - There is not possible to have 2 ranks with the same value could not be duplicated. - The maximum numbers of reports to favorite is 12. - Example: If you want to update a favorite to the rank 1, being your favorite in the position 2. The rank in the position 1 will be moved to the 2 and the 2 to the 1
- [Create a favorite in a property for the user that is authorized](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-favorites-1.md): A favorite gives the ability to quick search their most wanted reports  **Notes** - There is not possible to have 2 ranks with the same value could not be duplicated. - The maximum numbers of reports to favorite is 12. - If a report is favorited in the rank 1 and there is already one report favorited in the rank 1, the latest one will be put in the desired and position and all the rest of the elements will be move one position
- [Delete folder by id](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-folders-id-1.md): Delete a folder that is not used anymore  **Notes** - To delete a folder, the folder should not have assigned a report - To delete a folder, the folder should not have a parent_id
- [/datainsights/v1.1/folders/{id}/reports/{report_id}](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-folders-id-reports-report-id-1.md)
- [List of Folders per property Id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-folders-1.md): Obtain a list of all the created folders under a property
- [Get Folder by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-folders-id-1.md): Obtain a folder created under a property.
- [Create a folder for a property](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-folders-1.md): Folders give the ability to the user to organize and find better their reports  **Notes** - A Folder can not have the same name - A Folder may have a parent or may not - The max level of nested folders is 3. Below there is an example of the max level allowed  ``` Financial │ └───Bar     │     └───Food  ```
- [Assign a report to a folder](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-folders-id-reports-1.md): Assing a report to a folder in order to organize your them.
- [Update Folder](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-folders-id-1.md): Folders give the ability to the user to organize and find better their reports.  **Notes** - A Folder can not have the same name. - A Folder may have a parent or may not. - A Folder can not have as parent_id himself. - The max level of nested folders is 3. Below there is an example of the max level allowed.  ``` Financial │ └───Bar     │     └───Food  ```
- [Get the health of the service](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-health-1.md): This method performs various checks, such as:  - The status of the connections to the infrastructure services used by the service instance - The status of the host, e.g. storage, - Application specific logic and direct dependencies
- [Delete a hub by id](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-hubs-hub-id-1.md)
- [Delete a card by id](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-hubs-hub-id-cards-card-id-1.md)
- [Get all hubs](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-hubs-1.md)
- [Get a hub by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-hubs-hub-id-1.md)
- [Get a card by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-hubs-hub-id-cards-card-id-1.md)
- [Get all hubs](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-hubs-search-1.md)
- [Create a hub](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-hubs-1.md)
- [Create a card linking a hub to a chart](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-hubs-hub-id-cards-1.md)
- [Update a hub by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-hubs-hub-id-1.md)
- [Update a card by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-hubs-hub-id-cards-card-id-1.md)
- [Get the liveness probe of the service](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-liveness-1.md)
- [Get profile data about the current user](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-me-1.md)
- [Get policies data about the current user](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-me-policies-1.md)
- [Get properties data about the current user](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-me-properties-1.md)
- [Get all the settings for an specific property](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-property-settings-1.md)
- [Get property settings with their options](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-property-settings-name-1.md)
- [Update property setting by name](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-property-settings-name-1.md)
- [Delete report by id](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-reports-report-id-1.md): Delete a single report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 204 NO CONTENT if the delete was successful.
- [/datainsights/v1.1/reports/{report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-reports-report-id-charts-chart-id-1.md)
- [Delete a custom cdf on a report](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-reports-report-id-custom-cdfs-custom-cdf-id-1.md): Delete a custom cdf on a report.
- [Delete an association between a Report and a tag](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-reports-report-id-tags-tag-id-1.md): It unassigns a created tag from a created report.
- [Get reports](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-1.md): Returns all the reports for a single property.
- [Get list of possible relative date entries](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-filters-relative-dates-1.md): Relative dates can either be a standalone keyword, or they can be a keyword with a duration separated by a semicolon `;`.  **Examples without duration:** - `"value": "yesterday"`  - `"value": "years_prior"` (In this case duration is 0 by default)  **Examples with duration:** - `"value": "days_later;42"`  - `"value": "years_prior;1"`
- [Get list of available report format types](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-formats-1.md)
- [Get list of options for a given format type](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-formats-format-type-id-1.md): **Date Format String Definitions:** The defined date format must contain the day, month, and year format strings, and a separator for the different units - `DD`: 0 padded, 2 digit day number - `MM`: 0 padded, 2 digit month number - `YYYY`: 4 digit year format *Date Separators:* - `/` - `-` - `.`
- [/datainsights/v1.1/reports/limits](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-limits-1.md)
- [Get report by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-1.md): Returns a single report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 200 OK if there is a report with given id.
- [/datainsights/v1.1/reports/{report_id}/charts](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-charts-1.md)
- [/datainsights/v1.1/reports/{report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-charts-chart-id-1.md)
- [Get custom cdfs on a report](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-custom-cdfs-1.md): Get a list of all the custom cdfs created on a report.
- [Get custom cdf on a report](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-custom-cdfs-custom-cdf-id-1.md): Get a created custom cdf on a report.
- [Get report data by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-data-1.md): Based on the report `type` generated while creating a report the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Get report export by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-export-1.md)
- [Get report properties by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-properties-1.md)
- [Get report summary by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-summary-1.md)
- [Get tags on report](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-report-id-tags-1.md): Get a list of tags that a report is associated with.
- [Get report based on search results](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-reports-search-1.md): Get reports filtered by different search criteria  **Notes**: - Rows are returned if title contains values (case-insensitive comparison) - The API returns 200 even if no results are found.
- [Create a new report](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-1.md): Create a single report.  *Note: Based on the *properties* defined while creating a report the `type` may have multiple formats.*  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |  The API returns a 201 CREATED if the creation was successful.
- [Queue task to export multiple reports by ids as single Excel workbook](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-export-async-1.md)
- [Query report data](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-query-data-1.md): Query report data from a report that is not created  Mode: - Preview: 100 Records - Run: 12000 Records  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Query report data and export to file](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-query-export-1.md): Request a file export of data from any report json that is not created  Query report data from a report that is not created  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  Mode: - Export: 100000 Records  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Query report data and export to file](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-query-export-async-1.md): Request a file export of data from any report json that is not created  Query report data from a report that is not created  Mode: - Export: 100000 Records  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Query report summary](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-query-summary-1.md): Query report summary from a report that is not created  Mode: - Preview: 100 Records - Run: 12000 Records  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [/datainsights/v1.1/reports/{report_id}/charts](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-report-id-charts-1.md)
- [Clone report by id](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-report-id-clone-1.md): Create a report cloning another report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 201 CREATED if the cloning was successful.
- [Create a custom cdf on a report](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-report-id-custom-cdfs-1.md): - A custom cdf gives the user the ability to create a new cdf based on existing cdf. - Column is generated over the name, only with alphanumerical values and lower case. Special characters are replaced with underscore(_)  **Note**: - A custom cdf should have a validate formula.
- [Queue task to export report by id](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-report-id-export-async-1.md)
- [Create an association between a Report and a tag](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-reports-report-id-tags-1.md): It associates a created tag with a created report.
- [Update report by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-reports-report-id-1.md): Update a single report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 200 OK if the update was successful.
- [/datainsights/v1.1/reports/{report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-reports-report-id-charts-chart-id-1.md)
- [Update a custom cdf on a report](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-reports-report-id-custom-cdfs-custom-cdf-id-1.md)
- [Validate a custom cdf for a report](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-reports-report-id-custom-cdfs-validate-1.md): In order to create a custom cdf the formula needs to be validated.  **Notes**: - Column is generated over the name, only with alphanumerical values and lower case. Special characters are replaced with underscore(_) - A valid formula could be a string concatenation. - A valid formula could be a math operation. - A valid formula is a list of objects that contains kind and value. - `kind`: cdf | separator | operator | operand | parenthesis. - `value`: It's the value of the cdf, separator, operator, operand or parenthesis. - Separator: Any value. - Operator: Valid operators. - Operand: Numeric values. - Parenthesis: ( or ).
- [Delete schedule on a report](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-schedules-schedule-id-1.md)
- [Get schedules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-schedules-1.md)
- [Get schedule](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-schedules-schedule-id-1.md)
- [Create a schedule for a report workbook](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-schedules-1.md)
- [Get report export by id](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-schedules-schedule-id-run-1.md)
- [Update a schedule by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-schedules-schedule-id-1.md)
- [Search cross different resources](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-search-1.md): Get paginated search result for each requested resource  **Notes**: - Filter values should be formatted column:value, e.g. title:res - Valid columns for report resource: title - Valid columns for stock_report resource: title - API Returns 400 if a column isn't searchable for any requested resource. - Rows are returned if column contains values (case-insensitive comparison) - The API returns 200 even if no results are found.
- [/datainsights/v1.1/stock_reports/folders/{folder_id}](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-stock-reports-folders-folder-id-1.md)
- [Remove a stock report from a folder](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-stock-reports-folders-folder-id-stock-report-id-1.md)
- [Unpublish stock report by id](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-stock-reports-stock-report-id-1.md): Unpblish a single stock report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 204 NO CONTENT if the delete was successful.
- [/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-stock-reports-stock-report-id-charts-chart-id-1.md)
- [Delete a custom cdf of a stock report](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-custom-cdf-id-1.md): Delete a custom cdf of a stock report.
- [/datainsights/v1.1/stock_reports](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-1.md)
- [List of stock report folders](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-folders-1.md): Get a list of all the stock report folders. This folders are managed by Cloudbeds
- [Get Stock report folder by Id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-folders-folder-id-1.md): Get a stock report folder by id
- [/datainsights/v1.1/stock_reports/limits](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-limits-1.md)
- [Get keys of supported rules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-rules-1.md)
- [Get keys of supported rules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-rules-country-codes-1.md)
- [Get keys of supported rules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-rules-feature-ids-1.md)
- [Get keys of supported rules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-rules-property-ids-1.md)
- [Get keys of supported rules](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-rules-property-types-1.md)
- [Get stock reports based on search results](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-search-1.md): Get stock reports filtered by different search criteria  **Notes**: - Rows are returned if title contains values (case-insensitive comparison) - The API returns 200 even if no results are found.
- [Get stock report by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-1.md): Get one stock report. Stock reports are the reports that Cloudbeds owns.  **Notes** - A stock report can not be edited, but can be copied. - Since a stock report doesn't belong to any property, it's mandatory to define it. - A copied stock report is the same as creating a new report where all the features are available.
- [/datainsights/v1.1/stock_reports/{stock_report_id}/charts](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-charts-1.md)
- [/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-charts-chart-id-1.md)
- [Get custom cdfs of a stock report](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-1.md): Get a list of all the custom cdfs created of a stock report.
- [Get custom cdf of a stock report](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-custom-cdf-id-1.md): Get a created custom cdf of a stock report.
- [Get stock report data by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-data-1.md): Based on the report `type` generated while creating a stock report the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Get stock report export by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-export-1.md)
- [/datainsights/v1.1/stock_reports/{stock_report_id}/revisions](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-revisions-1.md)
- [/datainsights/v1.1/stock_reports/{stock_report_id}/revisions/{revision_id}](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-revisions-revision-id-1.md)
- [Get stock report summary by id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-stock-reports-stock-report-id-summary-1.md)
- [Publish a new report](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-1.md): Publish a single report to a stock report with optional rules.  The API returns a 201 CREATED if the creation was successful.
- [Create a new stock report folder](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-folders-1.md): Create a new Stock Report folder in order to organize them.
- [Assign a stock report to a folder](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-folders-folder-id-1.md): Assign a stock report to a folder in order to organize your them.
- [/datainsights/v1.1/stock_reports/{stock_report_id}/charts](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-charts-1.md)
- [Clone stock report by id](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-clone-1.md): Create a stock report cloning another report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 201 CREATED if the cloning was successful.
- [Create a custom cdf for a stock report](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-1.md): - A custom cdf gives the user the ability to create a new cdf based on existing cdf. - Column is generated over the name, only with alphanumerical values and lower case. Special characters are replaced with underscore(_)  **Note**: - A custom cdf should have a validate formula.
- [Get stock report export by id](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-export-async-1.md)
- [Query stock report data](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-query-data-1.md): Mode: - Preview: 100 Records - Run: 12000 Records  Query stock report data from a stock report already created being able to change - Filters Operators and Values - Columns Order - Group Row Modifier - Group Columns Modifier - Sort - Settings
- [Query stock report data and export to file](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-query-export-1.md): Request a file export of data from any stock report json that is not created  Query stock report data from a stock report that is not created  Mode: - Export: 100000 Records  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Query stock report data and export to file](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-query-export-async-1.md): Request a file export of data from any stock report json that is not created  Query stock report data from a stock report that is not created  Mode: - Export: 100000 Records  Based on the report `type` sent in the request, the data structure returned may have multiple formats.  ## Types #### List ``` {     ...     "columns": ...     "settings": {         ...         "totals": false,         "transpose": false,     } } ```  #### List (Totals) ``` {     ...     "columns": ...     "settings": {         ...         "totals": true,         "transpose": false,      } } ``` #### PeriodList ``` {     ...     "columns": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Summary ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": false,         "transpose": true|false,      } } ```  #### Summary (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "settings": {         ...         "totals": true         "transpose: true|false,     } } ``` #### PeriodSummary ``` {     ...     "columns": ...     "group_rows": ...     "periods": ...     "settings": {         ...         "totals": false,         "transpose": true|false,     } } ```   #### Pivot ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": false,         "transpose": true|false     } } ```  #### Pivot (Totals) ``` {     ...     "columns": ...     "group_rows": ...     "group_columns": ...     "settings": {         ...         "totals": true,         "transpose": true|false,     } } ```  ## Data  | Type                  | Headers | Index  | Records | Group Rows | Group Columns | Totals | Periods | Transpose | | --------------------  | ------- | ------ | ------- | ---------- | ------------- | ------ | ------- | --------- | | **List**              | Yes     | No     | Yes     | No         | No            | No     | No      | No        | | **List (Totals)**     | Yes     | No     | Yes     | No         | No            | Yes    | No      | No        | | **PeriodList**        | Yes     | Yes    | Yes     | No         | No            | No     | Yes     | Yes       | | **Summary**           | Yes     | Yes    | Yes     | Yes        | No            | No     | No      | Yes       | | **Summary (Details)** | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | No        | | **Summary (Totals)**  | Yes     | Yes    | Yes     | Yes        | No            | Yes    | No      | Yes       | | **PeriodSummary**     | Yes     | Yes    | Yes     | Yes        | No            | No     | Yes     | Yes       | | **Pivot**             | Yes     | Yes    | Yes     | Yes        | Yes           | No     | No      | Yes       | | **Pivot (Totals)**    | Yes     | Yes    | Yes     | Yes        | Yes           | Yes    | No      | Yes       |
- [Query stock report summary](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-stock-reports-stock-report-id-query-summary-1.md): Mode: - Preview: 100 Records - Run: 12000 Records  Query stock report summary from a stock report already created being able to change - Filters Operators and Values - Columns Order - Group Row Modifier - Group Columns Modifier - Sort - Settings
- [Update report by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-stock-reports-stock-report-id-1.md): Update a single report.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 200 OK if the update was successful.
- [/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-stock-reports-stock-report-id-charts-chart-id-1.md)
- [Update a custom cdf on a report](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-custom-cdf-id-1.md)
- [Validate a custom cdf for a stock report](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-stock-reports-stock-report-id-custom-cdfs-validate-1.md): In order to create a custom cdf the formula needs to be validated.  **Notes**: - Column is generated over the name, only with alphanumerical values and lower case. Special characters are replaced with underscore(_) - A valid formula could be a string concatenation. - A valid formula could be a math operation. - A valid formula is a list of objects that contains kind and value. - `kind`: cdf | separator | operator | operand | parenthesis. - `value`: It's the value of the cdf, separator, operator, operand or parenthesis. - Separator: Any value. - Operator: Valid operators. - Operand: Numeric values. - Parenthesis: ( or ).
- [Update report rules by id](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-stock-reports-stock-report-id-rules-1.md): Update a single report's rules.  *Note: The API may throw a HTTP 404 if there are no reports found with a given id.*  The API returns a 200 OK if the update was successful.
- [Delete tag](https://developers.cloudbeds.com/reference/delete_datainsights-v1-1-tags-id-1.md): Delete a tag that is not used anymore.
- [List of Tags per property Id](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-tags-1.md): Obtain a list of all the created tags under a property.
- [Create a tag for a property](https://developers.cloudbeds.com/reference/post_datainsights-v1-1-tags-1.md): A tag gives the ability to the user to organize, and label their reports to a better seach and easy indentification.  **Notes** - A Tag could not be duplicated. - There is distincion with capital letters. So Financial and financial are 2 different tags.
- [Update a tag](https://developers.cloudbeds.com/reference/put_datainsights-v1-1-tags-id-1.md): Update a tag name. All the reports using it will be updated with the new name.  **Note** - A Tag could not be duplicated. - There is distincion with capital letters. So Financial and financial are 2 different tags.
- [Get tasks](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-tasks-1.md): Returns all the tasks for a single property.
- [/datainsights/v1.1/tasks/{id}](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-tasks-id-1.md)
- [/datainsights/v1.1/tasks/token/{token}](https://developers.cloudbeds.com/reference/get_datainsights-v1-1-tasks-token-token-1.md)
- [Create a Pay By Link](https://developers.cloudbeds.com/reference/create-1.md)
- [Retrieve a Pay By Link](https://developers.cloudbeds.com/reference/geturl-1.md)

## Recipes
- [PMS Authentication](https://developers.cloudbeds.com/recipes/pms-authentication.md)

## Pages
- [Main](https://developers.cloudbeds.com/home.md)

## Changelog
- [June 2025 - getTransactions and other API endpoints deprecation - Migration from Cloudbeds API to Accounting API by December 1st, 2025 Required](https://developers.cloudbeds.com/changelog/june-2025-gettransactions-and-other-api-endpoints-deprecation-migration-from-cloudbeds-api-to-accounting-api-by-december-1st-2025-required.md)
- [January 2025 - API v1.1 deprecated by March 31st, 2025](https://developers.cloudbeds.com/changelog/january-2025-action-required-cloudbeds-api-v11-deprecated-by-march-31st-2025.md)
- [January 2025 - New feature for Groups & Events & POS](https://developers.cloudbeds.com/changelog/january-2025-new-features-for-groups-events-pos.md)
- [January 2025 - New features for RMS integrations](https://developers.cloudbeds.com/changelog/january-2025-new-features-for-rms-integrations.md)
- [January 2025 - getTransactions Endpoint](https://developers.cloudbeds.com/changelog/january-2025.md)