cloudbeds-accounting 1.6.0

OpenAPI client for Cloudbeds Accounting API.

Cloudbeds Accounting

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: v0
• Package version: 1.6.0
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

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 >= 1.25.3, < 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.

# Configure Bearer authorization (JWT): bearerAuth
configuration = cloudbeds_accounting.Configuration(
    access_token = os.environ["BEARER_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 | Property id
    accounts_receivable_ledger_id = 56 # int | Accounts Receivable ID
    reservation_id = 56 # int | Reservation ID

    try:
        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

Class	Method	HTTP request	Description
AccountsReceivableLedgerApi	delete_accounts_receivable_ledger_reservation_balance_transfer	DELETE /accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer
AccountsReceivableLedgerApi	get_accounts_receivable_ledger_by_id	GET /accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}
AccountsReceivableLedgerApi	get_accounts_receivable_ledger_reservation_balance_transfer	GET /accounting/v1.0/accounts-receivable-ledgers/reservation/{reservationId}/balance-transfer
AccountsReceivableLedgerApi	get_accounts_receivable_ledger_totals	GET /accounting/v1.0/accounts-receivable-ledgers/totals
AccountsReceivableLedgerApi	get_accounts_receivable_ledger_transactions	GET /accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/transactions
AccountsReceivableLedgerApi	get_accounts_receivable_ledgers	GET /accounting/v1.0/accounts-receivable-ledgers
AccountsReceivableLedgerApi	patch_accounts_receivable_ledger	PATCH /accounting/v1.0/accounts-receivable-ledgers
AccountsReceivableLedgerApi	post_accounts_receivable_ledger	POST /accounting/v1.0/accounts-receivable-ledgers
AccountsReceivableLedgerApi	post_accounts_receivable_ledger_group_balance_transfer	POST /accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/group-profile/{groupProfileId}/balance-transfer
AccountsReceivableLedgerApi	post_accounts_receivable_ledger_reservation_balance_transfer	POST /accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer
CustomGeneralLedgerCodesApi	get_custom_general_ledger_codes	GET /accounting/v1.0/custom-general-ledger-codes
CustomGeneralLedgerCodesApi	put_custom_general_ledger_codes	PUT /accounting/v1.0/custom-general-ledger-codes
CustomTransactionCodesApi	get_custom_transaction_codes	GET /accounting/v1.0/custom-transaction-codes
CustomTransactionCodesApi	initialize_custom_transaction_codes	POST /accounting/v1.0/custom-transaction-codes/initialize
CustomTransactionCodesApi	put_custom_transaction_codes	PUT /accounting/v1.0/custom-transaction-codes
DepositsApi	get_deposit_balance	GET /accounting/v1.0/deposits/balance
DepositsApi	get_deposit_transactions	GET /accounting/v1.0/deposits/transactions
DepositsApi	post_deposits_transfer	POST /accounting/v1.0/deposits/transfer
InternalTransactionCodesApi	get_internal_transaction_codes	GET /accounting/v1.0/internal-transaction-codes
SettingsApi	get_settings	GET /accounting/v1.0/settings
SettingsApi	patch_settings	PATCH /accounting/v1.0/settings
SourceBalanceApi	get_source_balance_by_source	GET /accounting/v1.0/source-balances/{sourceKind}/{sourceId}
TransactionsApi	list_pending_transactions	POST /accounting/v1.0/pending-transactions
TransactionsApi	list_transactions	POST /accounting/v1.0/transactions
TrialBalanceApi	calculate_trial_balance	POST /accounting/v1.0/trial-balance/configuration/calculate
TrialBalanceApi	get_trial_balance_configuration	GET /accounting/v1.0/trial-balance/configuration
TrialBalanceApi	get_trial_balance_report	GET /accounting/v1.0/trial-balance/report
TrialBalanceApi	is_trial_balance_configured	GET /accounting/v1.0/trial-balance/configuration/status
TrialBalanceApi	set_trial_balance	POST /accounting/v1.0/trial-balance/configuration

Documentation For Models

• Account
• AccountCategory
• AccountsReceivableLedgerPaginated
• AccountsReceivableLedgerPatchRequest
• AccountsReceivableLedgerPostRequest
• AccountsReceivableLedgerReservationBalanceTransferResponse
• AccountsReceivableLedgerReservationBalanceTransferResponseTransaction
• AccountsReceivableLedgerResponse
• AccountsReceivableLedgerStatus
• AccountsReceivableLedgerTotalsResponse
• AccountsReceivableTransactionPaginated
• AccountsReceivableTransactionResponse
• AccountsReceivableTransactionResponseTransferDetails
• Action
• AndOrGroup
• AndOrGroupAndInner
• ApiAccountingError
• ApiErrorCode
• AsyncEventResponse
• BalanceBreakdownItem
• ChartOfAccountType
• ConditionalOperator
• CustomGeneralLedgerCodeModel
• CustomGeneralLedgerCodesUpdateRequest
• CustomTransactionCodesModel
• CustomTransactionCodesUpdateModel
• CustomTransactionCodesUpdateRequest
• DepositBalanceResponse
• DepositConsumptionEnum
• ExtendedTransactionPaginated
• ExtendedTransactionResponse
• FieldFilter
• Filters
• GetAccountsReceivableLedgerTotalsFilterParameter
• GetAccountsReceivableLedgerTransactionsFilterParameter
• GetAccountsReceivableLedgersFilterParameter
• GetDepositTransactionsFilterParameter
• GroupProfileTransferDetails
• InternalTransactionCodeGroupEnum
• InternalTransactionCodeResponse
• InternalTransactionCodesListResponse
• ListPendingTransactionsPaginated
• ListPendingTransactionsRequest
• ListTransactionsPaginated
• ListTransactionsRequest
• LogicalOperator
• PageDetails
• PostGroupProfileBalanceTransferRequest
• ReservationStatus
• ReservationTransferDetails
• SettingPatchRequest
• SettingResponse
• SettingValues
• Sort
• SortDirection
• SourceBalanceResponse
• SourceKind
• TransactionItemGroup
• TransactionItemMappingModel
• TransactionItemMappingRequest
• TransactionItemMappingUpdateModel
• TransactionResponse
• TransactionState
• TransferDepositPostRequest
• TrialBalanceConfigurationStatusResponse
• TrialBalanceReportCodeInfo
• TrialBalanceReportGuestLedger
• TrialBalanceReportLedgerBalances
• TrialBalanceReportResponse
• TrialBalanceReportSummary
• TrialBalanceRequest
• TrialBalanceResponse
• UserModel

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author