Cloudbeds Accounting

The Cloudbeds Accounting Service API provides programmatic access to financial data and operations for hospitality properties. Use this API to manage transactions, folios, deposits, accounts receivable ledgers, trial balances, and related accounting configuration. Key concepts: - Transactions represent individual financial entries (charges, payments, taxes, fees) associated with a source such as a reservation, group profile, or house account. - Folios organize transactions into logical groups within a source. You can create custom folios and move or route transactions between them. - Source Balances provide a real-time financial summary (charges, payments, balance due, tax/fee breakdowns) for a reservation, group profile, house account, or accounts receivable ledger. - Accounts Receivable (AR) Ledgers track outstanding balances that have been transferred from reservations or group profiles for later collection. - Trial Balance is a daily financial reconciliation report that summarizes ledger activity across guest, deposit, and AR ledgers. - Custom Codes let you map Cloudbeds internal transaction codes to your own chart-of-accounts codes and general ledger codes. Authentication: All endpoints require a valid OAuth2 bearer token. Endpoints are protected by scopes: read:payment for read operations and write:payment for mutating operations. A few search endpoints use POST with a request body to support complex filter criteria; these require the read:payment scope. Base URL: Use https://api.cloudbeds.com for production and https://api.cloudbeds-stage.com for staging. All endpoint paths are prefixed with /accounting/v1.0. Property context: Every request must include the X-Property-ID header to identify which property the request applies to. Monetary amounts: Unless otherwise noted, monetary amounts are expressed in the smallest currency unit (e.g., cents for USD). Use the currencyScale field to determine the number of decimal places. Pagination: Paginated endpoints return a nextPageToken value. Pass this token in subsequent requests to retrieve the next page of results. When nextPageToken is null or absent, you have reached the last page.

The cloudbeds_accounting package is automatically generated by the OpenAPI Generator project:

• API version: v0
• Package version: 1.7.0
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 2.1.0, < 3.0.0
• python-dateutil >= 2.8.2
• pydantic >= 2
• typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with Cloudbeds Accounting, you can run the following:

import cloudbeds_accounting
from cloudbeds_accounting.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.cloudbeds-stage.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cloudbeds_accounting.Configuration(
    host = "https://api.cloudbeds-stage.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with cloudbeds_accounting.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cloudbeds_accounting.AccountsReceivableLedgerApi(api_client)
    x_property_id = 56 # int | Unique identifier of the property. Required for all requests to scope data to a specific property. 
    accounts_receivable_ledger_id = 56 # int | Unique identifier of the accounts receivable ledger.
    reservation_id = 56 # int | Reservation ID

    try:
        # Reverse a reservation-to-AR balance transfer
        api_response = api_instance.delete_accounts_receivable_ledger_reservation_balance_transfer(x_property_id, accounts_receivable_ledger_id, reservation_id)
        print("The response of AccountsReceivableLedgerApi->delete_accounts_receivable_ledger_reservation_balance_transfer:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsReceivableLedgerApi->delete_accounts_receivable_ledger_reservation_balance_transfer: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.cloudbeds-stage.com

Documentation For Models

• Account
• AccountCategory
• AccountsReceivableLedgerPaginated
• AccountsReceivableLedgerPatchRequest
• AccountsReceivableLedgerPostRequest
• AccountsReceivableLedgerReservationBalanceTransferResponse
• AccountsReceivableLedgerReservationBalanceTransferResponseTransaction
• AccountsReceivableLedgerResponse
• AccountsReceivableLedgerStatus
• AccountsReceivableLedgerTotalsResponse
• AccountsReceivableTransactionPaginated
• AccountsReceivableTransactionResponse
• AccountsReceivableTransactionResponseTransferDetails
• Action
• AndOrGroup
• AndOrGroupAndInner
• ApiAccountingError
• ApiErrorCode
• AssignFolioConfigurationRequest
• AsyncEventResponse
• BalanceBreakdownItem
• ChartOfAccountType
• ConditionalOperator
• CreateFolioRequest
• CreateFolioResponse
• CustomGeneralLedgerCodeModel
• CustomGeneralLedgerCodesUpdateRequest
• CustomTransactionCodesModel
• CustomTransactionCodesUpdateModel
• CustomTransactionCodesUpdateRequest
• DepositBalanceResponse
• DepositConsumptionEnum
• ExtendedTransactionPaginated
• ExtendedTransactionResponse
• ExternalRelationKind
• FieldFilter
• Filters
• FiscalDocumentSummary
• FolioConfigurationData
• FolioConfigurationFolioData
• FolioConfigurationFolioTransactionTypeData
• FolioConfigurationSaveResponse
• FolioConfigurationSaveResponseData
• FolioConfigurationSourceData
• FolioConfigurationToSourceResponse
• FolioPaymentAllocation
• FolioResponse
• FolioSourceKind
• FolioTransactionGroup
• FolioTransactionGroupByField
• FolioTransactionGroupTotals
• FolioTransactionResponse
• FolioTransactionTotals
• FolioTransactionTypeResponse
• ForeignCurrencyTotals
• GetAccountsReceivableLedgerTotalsFilterParameter
• GetAccountsReceivableLedgerTransactionsFilterParameter
• GetAccountsReceivableLedgersFilterParameter
• GetDepositTransactionsFilterParameter
• GetFoliosFilterParameter
• GroupProfileTransferDetails
• InternalTransactionCodeGroupEnum
• InternalTransactionCodeResponse
• InternalTransactionCodesListResponse
• ListFolioTransactionsPaginated
• ListFolioTransactionsRequest
• ListPendingTransactionsPaginated
• ListPendingTransactionsRequest
• ListTransactionsPaginated
• ListTransactionsRequest
• LogicalOperator
• MoveTransactionsRequest
• PageDetails
• PaymentDetails
• PostGroupProfileBalanceTransferRequest
• ReservationStatus
• ReservationTransferDetails
• RouteTransactionsRequest
• RoutingContext
• RoutingRuleResponse
• RoutingRuleTransactionTypeResponse
• SettingPatchRequest
• SettingResponse
• SettingValues
• Sort
• SortDirection
• SourceBalanceResponse
• SourceKind
• TransactionItemGroup
• TransactionItemMappingModel
• TransactionItemMappingRequest
• TransactionItemMappingUpdateModel
• TransactionResponse
• TransactionState
• TransactionTypeIdentifier
• TransferDepositPostRequest
• TrialBalanceConfigurationStatusResponse
• TrialBalanceReportCodeInfo
• TrialBalanceReportGuestLedger
• TrialBalanceReportLedgerBalances
• TrialBalanceReportResponse
• TrialBalanceReportSummary
• TrialBalanceRequest
• TrialBalanceResponse
• UnrouteTransactionsRequest
• UpdateFolioRequest
• UserModel

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: OAuth
• Flow: implicit
• Authorization URL: https://hotels.cloudbeds.com/api/v1.2/oauth
• Scopes:
• read:payment: Read payment and transaction information
• write:payment: Create, update, or delete payment and transaction data

Author