Skip to content

SourceBalanceApi.md

Latest commit

 

History

History
173 lines (119 loc) · 8.38 KB

SourceBalanceApi.md

File metadata and controls

173 lines (119 loc) · 8.38 KB

cloudbeds_accounting.SourceBalanceApi

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

Method HTTP request Description
get_source_balance_by_source GET /accounting/v1.0/source-balances/{sourceKind}/{sourceId} Get source balance
get_source_balance_snapshot_by_source GET /accounting/v1.0/source-balances/snapshots/{reservationId}

get_source_balance_by_source

SourceBalanceResponse get_source_balance_by_source(x_property_id, source_kind, source_id, accept_language=accept_language)

Get source balance

Retrieve the financial balance summary for a specific source. The source can be a reservation, house account, group profile, or accounts receivable ledger, identified by the sourceKind and sourceId path parameters. The response includes a detailed breakdown of charges (subtotal, additional items, taxes, fees), payments, refunds, upcoming payments, and the overall balance due. Use the optional Accept-Language header to receive localized tax and fee names.

Example

  • OAuth Authentication (bearerAuth):
import cloudbeds_accounting
from cloudbeds_accounting.models.source_balance_response import SourceBalanceResponse
from cloudbeds_accounting.models.source_kind import SourceKind
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.SourceBalanceApi(api_client)
    x_property_id = 56 # int | Unique identifier of the property. Required for all requests to scope data to a specific property. 
    source_kind = cloudbeds_accounting.SourceKind() # SourceKind | The type of source entity. Determines how the sourceId is interpreted. 
    source_id = 56 # int | Unique identifier of the source entity. The meaning depends on the sourceKind parameter: a reservation ID, house account ID, group profile ID, or accounts receivable ledger ID. 
    accept_language = en-US # str | Language preference for localized tax/fee names. Supports: en-US (English US), es-ES (Spanish Spain), es-MX (Spanish Mexico),  fr-FR (French), de-DE (German), it-IT (Italian), pt-PT (Portuguese Portugal), pt-BR (Portuguese Brazil). Defaults to en-US if not provided or unsupported language is specified.  (optional) (default to en-US)

    try:
        # Get source balance
        api_response = api_instance.get_source_balance_by_source(x_property_id, source_kind, source_id, accept_language=accept_language)
        print("The response of SourceBalanceApi->get_source_balance_by_source:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SourceBalanceApi->get_source_balance_by_source: %s\n" % e)

Parameters

Name Type Description Notes
x_property_id int Unique identifier of the property. Required for all requests to scope data to a specific property.
source_kind SourceKind The type of source entity. Determines how the sourceId is interpreted.
source_id int Unique identifier of the source entity. The meaning depends on the sourceKind parameter: a reservation ID, house account ID, group profile ID, or accounts receivable ledger ID.
accept_language str Language preference for localized tax/fee names. Supports: en-US (English US), es-ES (Spanish Spain), es-MX (Spanish Mexico), fr-FR (French), de-DE (German), it-IT (Italian), pt-PT (Portuguese Portugal), pt-BR (Portuguese Brazil). Defaults to en-US if not provided or unsupported language is specified. [optional] [default to en-US]

Return type

SourceBalanceResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
404 Not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_source_balance_snapshot_by_source

SourceBalanceResponse get_source_balance_snapshot_by_source(x_property_id, reservation_id, accept_language=accept_language)

Get source balance snapshot information for a reservation

Example

  • OAuth Authentication (bearerAuth):
import cloudbeds_accounting
from cloudbeds_accounting.models.source_balance_response import SourceBalanceResponse
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.SourceBalanceApi(api_client)
    x_property_id = 56 # int | Unique identifier of the property. Required for all requests to scope data to a specific property. 
    reservation_id = 56 # int | Reservation ID
    accept_language = en-US # str | Language preference for localized tax/fee names. Supports: en-US (English US), es-ES (Spanish Spain), es-MX (Spanish Mexico),  fr-FR (French), de-DE (German), it-IT (Italian), pt-PT (Portuguese Portugal), pt-BR (Portuguese Brazil). Defaults to en-US if not provided or unsupported language is specified.  (optional) (default to en-US)

    try:
        api_response = api_instance.get_source_balance_snapshot_by_source(x_property_id, reservation_id, accept_language=accept_language)
        print("The response of SourceBalanceApi->get_source_balance_snapshot_by_source:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SourceBalanceApi->get_source_balance_snapshot_by_source: %s\n" % e)

Parameters

Name Type Description Notes
x_property_id int Unique identifier of the property. Required for all requests to scope data to a specific property.
reservation_id int Reservation ID
accept_language str Language preference for localized tax/fee names. Supports: en-US (English US), es-ES (Spanish Spain), es-MX (Spanish Mexico), fr-FR (French), de-DE (German), it-IT (Italian), pt-PT (Portuguese Portugal), pt-BR (Portuguese Brazil). Defaults to en-US if not provided or unsupported language is specified. [optional] [default to en-US]

Return type

SourceBalanceResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
404 Not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]