Metadata-Version: 2.4
Name: cloudbeds_fiscal_document
Version: 1.24.0
Summary: OpenAPI client for Cloudbeds Fiscal Document API.
Author: Cloudbeds
License: The MIT License
        
        Copyright (c) 2025 Cloudbeds (http://cloudbeds.com)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Documentation, https://github.com/cloudbeds/cloudbeds-fiscal-document-python#README
Project-URL: Repository, https://github.com/cloudbeds/cloudbeds-fiscal-document-python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=1.25.3
Requires-Dist: python-dateutil<3.0.0,>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: coverage; extra == "testing"
Dynamic: license-file

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

The `cloudbeds_fiscal_document` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.24.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 Fiscal Document,
you can run the following:

```python

import cloudbeds_fiscal_document
from cloudbeds_fiscal_document.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.cloudbeds.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cloudbeds_fiscal_document.Configuration(
    host = "https://api.cloudbeds.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"]

# Configure Bearer authorization (JWT): bearerAuth
configuration = cloudbeds_fiscal_document.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with cloudbeds_fiscal_document.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cloudbeds_fiscal_document.ConfigsApi(api_client)
    x_property_id = 56 # int | Property id
    crop_logo_request = cloudbeds_fiscal_document.CropLogoRequest() # CropLogoRequest | 

    try:
        # Crop logo image for fiscal documents
        api_instance.crop_logo(x_property_id, crop_logo_request)
    except ApiException as e:
        print("Exception when calling ConfigsApi->crop_logo: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConfigsApi* | [**crop_logo**](cloudbeds_fiscal_document/docs/ConfigsApi.md#crop_logo) | **PATCH** /fiscal-document/v1/configs/logo | Crop logo image for fiscal documents
*ConfigsApi* | [**delete_logo**](cloudbeds_fiscal_document/docs/ConfigsApi.md#delete_logo) | **DELETE** /fiscal-document/v1/configs/logo | Delete logo image for fiscal documents
*ConfigsApi* | [**get_configs**](cloudbeds_fiscal_document/docs/ConfigsApi.md#get_configs) | **GET** /fiscal-document/v1/configs | Get list of fiscal documents configs
*ConfigsApi* | [**get_logo**](cloudbeds_fiscal_document/docs/ConfigsApi.md#get_logo) | **GET** /fiscal-document/v1/configs/logo | Get logo image for fiscal documents
*ConfigsApi* | [**get_pdf_preview**](cloudbeds_fiscal_document/docs/ConfigsApi.md#get_pdf_preview) | **GET** /fiscal-document/v1/configs/preview | Get PDF document preview
*ConfigsApi* | [**get_property_settings**](cloudbeds_fiscal_document/docs/ConfigsApi.md#get_property_settings) | **GET** /fiscal-document/v1/configs/property-settings | Get property-level document settings
*ConfigsApi* | [**update_configs**](cloudbeds_fiscal_document/docs/ConfigsApi.md#update_configs) | **PUT** /fiscal-document/v1/configs/{documentKind} | Updates a config of a specific kind
*ConfigsApi* | [**update_property_settings**](cloudbeds_fiscal_document/docs/ConfigsApi.md#update_property_settings) | **PATCH** /fiscal-document/v1/configs/property-settings | Update property-level document settings
*ConfigsApi* | [**upload_logo**](cloudbeds_fiscal_document/docs/ConfigsApi.md#upload_logo) | **POST** /fiscal-document/v1/configs/logo | Upload logo image for fiscal documents
*ExportApi* | [**export_folio_pdf**](cloudbeds_fiscal_document/docs/ExportApi.md#export_folio_pdf) | **POST** /fiscal-document/v1/folios/export | Export folio transactions as PDF
*ExportApi* | [**get_folio_pdf**](cloudbeds_fiscal_document/docs/ExportApi.md#get_folio_pdf) | **POST** /fiscal-document/v1/folio-export/pdf | Get folio list of transactions exported as PDF
*FeaturesApi* | [**get_property_features**](cloudbeds_fiscal_document/docs/FeaturesApi.md#get_property_features) | **GET** /fiscal-document/v1/property/features | Get enabled features for the current user and property
*FiscalConnectionConfigApi* | [**activate_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#activate_fiscal_connection) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/activate | Activate a verifying connection
*FiscalConnectionConfigApi* | [**activate_fiscalization_series**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#activate_fiscalization_series) | **PUT** /fiscal-document/v1/fiscalization/connections/{connectionId}/series/activate | Activate a series on a connection
*FiscalConnectionConfigApi* | [**create_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#create_fiscal_connection) | **POST** /fiscal-document/v1/fiscalization/connections | Create a connection
*FiscalConnectionConfigApi* | [**deactivate_fiscalization_series**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#deactivate_fiscalization_series) | **PUT** /fiscal-document/v1/fiscalization/connections/{connectionId}/series/deactivate | Deactivate a series on a connection
*FiscalConnectionConfigApi* | [**delete_connection_logo**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#delete_connection_logo) | **DELETE** /fiscal-document/v1/fiscalization/connections/{connectionId}/customization/logo | Delete the branding logo for a connection
*FiscalConnectionConfigApi* | [**delete_fiscal_connection_draft**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#delete_fiscal_connection_draft) | **DELETE** /fiscal-document/v1/fiscalization/connections/drafts/{providerId} | Discard a registration draft
*FiscalConnectionConfigApi* | [**disconnect_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#disconnect_fiscal_connection) | **DELETE** /fiscal-document/v1/fiscalization/connections/{connectionId} | Disconnect a connection
*FiscalConnectionConfigApi* | [**get_connection_certificate**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#get_connection_certificate) | **GET** /fiscal-document/v1/fiscalization/connections/{connectionId}/certificate | Get certificate status for a connection
*FiscalConnectionConfigApi* | [**get_connection_section**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#get_connection_section) | **GET** /fiscal-document/v1/fiscalization/connections/{connectionId}/{sectionKey} | Get section configuration
*FiscalConnectionConfigApi* | [**get_connection_section_rules**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#get_connection_section_rules) | **GET** /fiscal-document/v1/fiscalization/connections/{connectionId}/{sectionKey}/rules | Get section rules and schema
*FiscalConnectionConfigApi* | [**get_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#get_fiscal_connection) | **GET** /fiscal-document/v1/fiscalization/connections/{connectionId} | Get a single connection
*FiscalConnectionConfigApi* | [**get_fiscalization_status**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#get_fiscalization_status) | **GET** /fiscal-document/v1/fiscalization/status | Check if the property is ready to issue fiscal documents
*FiscalConnectionConfigApi* | [**list_fiscal_channels**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_channels) | **GET** /fiscal-document/v1/fiscalization/catalogue/countries/{countryCode}/channels | List fiscal channels for a country
*FiscalConnectionConfigApi* | [**list_fiscal_connection_drafts**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_connection_drafts) | **GET** /fiscal-document/v1/fiscalization/connections/drafts | List in-progress connection drafts
*FiscalConnectionConfigApi* | [**list_fiscal_connections**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_connections) | **GET** /fiscal-document/v1/fiscalization/connections | List connections for a property
*FiscalConnectionConfigApi* | [**list_fiscal_countries**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_countries) | **GET** /fiscal-document/v1/fiscalization/catalogue/countries | List supported countries
*FiscalConnectionConfigApi* | [**list_fiscal_document_routing**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_document_routing) | **GET** /fiscal-document/v1/fiscalization/routing | List all routing rules for a property
*FiscalConnectionConfigApi* | [**list_fiscal_providers**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#list_fiscal_providers) | **GET** /fiscal-document/v1/fiscalization/catalogue/countries/{countryCode}/channels/{channelCode}/providers | List providers for a channel
*FiscalConnectionConfigApi* | [**patch_fiscal_document_routing**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#patch_fiscal_document_routing) | **PATCH** /fiscal-document/v1/fiscalization/routing/{countryCode}/{channelCode}/{flowId} | Update a single routing rule
*FiscalConnectionConfigApi* | [**pause_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#pause_fiscal_connection) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/pause | Pause a connection
*FiscalConnectionConfigApi* | [**replace_fiscal_document_routing**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#replace_fiscal_document_routing) | **PUT** /fiscal-document/v1/fiscalization/routing | Bulk-replace routing rules
*FiscalConnectionConfigApi* | [**replace_provider_section_options**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#replace_provider_section_options) | **PUT** /fiscal-document/v1/fiscalization/providers/{providerId}/{sectionKey}/options | Replace the options a provider offers for one of its sections
*FiscalConnectionConfigApi* | [**resume_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#resume_fiscal_connection) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/resume | Resume a paused connection
*FiscalConnectionConfigApi* | [**test_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#test_fiscal_connection) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/test | Test the connection to the tax authority
*FiscalConnectionConfigApi* | [**update_connection_section**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#update_connection_section) | **PUT** /fiscal-document/v1/fiscalization/connections/{connectionId}/{sectionKey} | Update section configuration
*FiscalConnectionConfigApi* | [**update_fiscal_connection**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#update_fiscal_connection) | **PUT** /fiscal-document/v1/fiscalization/connections/{connectionId} | Update a connection
*FiscalConnectionConfigApi* | [**upload_connection_certificate**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#upload_connection_certificate) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/certificate | Upload a certificate for a connection
*FiscalConnectionConfigApi* | [**upload_connection_logo**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#upload_connection_logo) | **POST** /fiscal-document/v1/fiscalization/connections/{connectionId}/customization/logo | Upload the branding logo for a connection
*FiscalConnectionConfigApi* | [**upsert_fiscal_connection_draft**](cloudbeds_fiscal_document/docs/FiscalConnectionConfigApi.md#upsert_fiscal_connection_draft) | **PUT** /fiscal-document/v1/fiscalization/connections/drafts/{providerId} | Upsert a registration draft
*FiscalDocumentsApi* | [**allocate_receipt_payment**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#allocate_receipt_payment) | **POST** /fiscal-document/v1/fiscal-documents/receipt/allocate-payment | Allocate payment associated with receipt to charge transactions.
*FiscalDocumentsApi* | [**apply_receipt**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#apply_receipt) | **POST** /fiscal-document/v1/fiscal-documents/receipts/{receiptId}/apply | Apply receipt to invoice
*FiscalDocumentsApi* | [**create_credit_note**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_credit_note) | **POST** /fiscal-document/v1/fiscal-documents/credit-note | Create a fiscal document of the type credit note
*FiscalDocumentsApi* | [**create_invoice**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_invoice) | **POST** /fiscal-document/v1/fiscal-documents/invoice | Create a fiscal document of the type invoice
*FiscalDocumentsApi* | [**create_pro_forma_invoice**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_pro_forma_invoice) | **POST** /fiscal-document/v1/fiscal-documents/pro-forma-invoice | Create a fiscal document of the type pro forma invoice
*FiscalDocumentsApi* | [**create_receipt**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_receipt) | **POST** /fiscal-document/v1/fiscal-documents/receipt | Create receipt for a payment.
*FiscalDocumentsApi* | [**create_rectify_invoice**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_rectify_invoice) | **POST** /fiscal-document/v1/fiscal-documents/rectify-invoice | Create a fiscal document of the type rectify invoice
*FiscalDocumentsApi* | [**create_settlement_invoice**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_settlement_invoice) | **POST** /fiscal-document/v1/fiscal-documents/{advance_invoice_id}/settlement | Create a settlement invoice for an advance invoice
*FiscalDocumentsApi* | [**create_simple_receipt**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#create_simple_receipt) | **POST** /fiscal-document/v1/fiscal-documents/simple-receipt | Create simple receipts.
*FiscalDocumentsApi* | [**download_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#download_fiscal_document) | **GET** /fiscal-document/v1/fiscal-documents/{id}/download | Download fiscal document
*FiscalDocumentsApi* | [**email_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#email_fiscal_document) | **POST** /fiscal-document/v1/fiscal-documents/{id}/email | Email a fiscal document
*FiscalDocumentsApi* | [**get_allocations**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_allocations) | **GET** /fiscal-document/v1/fiscal-documents/allocations | Get payment allocation transactions
*FiscalDocumentsApi* | [**get_allocations_summary**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_allocations_summary) | **GET** /fiscal-document/v1/fiscal-documents/allocations/summary | Get allocations summary
*FiscalDocumentsApi* | [**get_count_fiscal_documents_with_discrepancies**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_count_fiscal_documents_with_discrepancies) | **GET** /fiscal-document/v1/fiscal-documents/discrepancies/summary | Get count of fiscal documents with discrepancies
*FiscalDocumentsApi* | [**get_credit_note_preview**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_credit_note_preview) | **POST** /fiscal-document/v1/fiscal-documents/credit-note/preview | Get fiscal document preview of the type credit note
*FiscalDocumentsApi* | [**get_document_preview**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_document_preview) | **POST** /fiscal-document/v1/fiscal-documents/invoice/preview | Get fiscal document preview of the type invoice
*FiscalDocumentsApi* | [**get_document_rules**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_document_rules) | **GET** /fiscal-document/v1/fiscal-documents/rules | Get document creation rules for a given document kind
*FiscalDocumentsApi* | [**get_fiscal_document_email_subject**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_email_subject) | **GET** /fiscal-document/v1/fiscal-documents/email-subject | Resolve the email subject for a fiscal document
*FiscalDocumentsApi* | [**get_fiscal_document_recipients_by_id**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_recipients_by_id) | **GET** /fiscal-document/v1/fiscal-documents/{id}/recipients | Get list of recipients associated to the fiscal document
*FiscalDocumentsApi* | [**get_fiscal_document_transactions**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_transactions) | **GET** /fiscal-document/v1/fiscal-documents/transactions | Get available transactions for fiscal documents
*FiscalDocumentsApi* | [**get_fiscal_document_transactions_by_id**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_transactions_by_id) | **GET** /fiscal-document/v1/fiscal-documents/{id}/transactions | Get list of transactions for a given fiscal document id
*FiscalDocumentsApi* | [**get_fiscal_document_transactions_for_allocation**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_document_transactions_for_allocation) | **GET** /fiscal-document/v1/fiscal-documents/allocations/transactions | Get available transactions for allocations
*FiscalDocumentsApi* | [**get_fiscal_documents**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_fiscal_documents) | **GET** /fiscal-document/v1/fiscal-documents | Get list of fiscal documents
*FiscalDocumentsApi* | [**get_invoice_allocations**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_invoice_allocations) | **GET** /fiscal-document/v1/invoices/{id}/receipts/allocations | Get allocations for an invoice
*FiscalDocumentsApi* | [**get_pro_forma_preview**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_pro_forma_preview) | **POST** /fiscal-document/v1/fiscal-documents/pro-forma-invoice/preview | Create a fiscal document of the type pro forma invoice
*FiscalDocumentsApi* | [**get_rectify_invoice_preview**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_rectify_invoice_preview) | **POST** /fiscal-document/v1/fiscal-documents/rectify-invoice/preview | Get fiscal document preview of the type rectify invoice
*FiscalDocumentsApi* | [**get_selected_transactions_summary**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_selected_transactions_summary) | **GET** /fiscal-document/v1/fiscal-documents/transactions/summary | Get totals of selected available transactions for fiscal documents (deprecated)
*FiscalDocumentsApi* | [**get_transactions_summary_by_document_id**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#get_transactions_summary_by_document_id) | **GET** /fiscal-document/v1/fiscal-documents/{id}/transactions/summary | Get totals of transactions for a given fiscal document id
*FiscalDocumentsApi* | [**post_selected_transactions_summary**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#post_selected_transactions_summary) | **POST** /fiscal-document/v1/fiscal-documents/transactions/summary | Get totals of selected available transactions for fiscal documents
*FiscalDocumentsApi* | [**put_fiscal_document**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#put_fiscal_document) | **PUT** /fiscal-document/v1/fiscal-documents/{id} | Update a fiscal document by id
*FiscalDocumentsApi* | [**update_pro_forma_invoice_status**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#update_pro_forma_invoice_status) | **PUT** /fiscal-document/v1/fiscal-documents/pro-forma-invoice/{id}/status | Update pro forma invoice status
*FiscalDocumentsApi* | [**update_require_attention**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#update_require_attention) | **PATCH** /fiscal-document/v1/fiscal-documents/{id}/require-attention | Update require attention flag for a fiscal document
*FiscalDocumentsApi* | [**void_receipt**](cloudbeds_fiscal_document/docs/FiscalDocumentsApi.md#void_receipt) | **POST** /fiscal-document/v1/fiscal-documents/receipts/{receiptId}/void | Void a receipt
*FiscalizationApi* | [**get_connection_report**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_connection_report) | **GET** /fiscal-document/v1/fiscalization/connections/{connectionId}/reports/{reportId} | Generate and download a report for one connection
*FiscalizationApi* | [**get_fiscalization_item_extension_rules**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_item_extension_rules) | **GET** /fiscal-document/v1/fiscalization/items/rules | Get item extension mapping rules for a country
*FiscalizationApi* | [**get_fiscalization_payment_method_rules**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_payment_method_rules) | **GET** /fiscal-document/v1/fiscalization/payment-methods/rules | Get fiscalization payment method rules for a country
*FiscalizationApi* | [**get_fiscalization_registration_rules**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_registration_rules) | **GET** /fiscal-document/v1/fiscalization/registration/rules | Get fiscalization rules for a country
*FiscalizationApi* | [**get_fiscalization_report**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_report) | **GET** /fiscal-document/v1/fiscalization/reports/{reportId} | Generate and download a fiscalization report
*FiscalizationApi* | [**get_fiscalization_series_rules**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_series_rules) | **GET** /fiscal-document/v1/fiscalization/series/rules | Get available series rules for a country
*FiscalizationApi* | [**get_fiscalization_tax_rules**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_fiscalization_tax_rules) | **GET** /fiscal-document/v1/fiscalization/tax/rules | Get fiscalization tax rules for a country
*FiscalizationApi* | [**get_invoice_type_options**](cloudbeds_fiscal_document/docs/FiscalizationApi.md#get_invoice_type_options) | **GET** /fiscal-document/v1/fiscalization/invoice-type-options | Get invoicing options for a property


## Documentation For Models

 - [Action](cloudbeds_fiscal_document/docs/Action.md)
 - [ActivateSeriesRequest](cloudbeds_fiscal_document/docs/ActivateSeriesRequest.md)
 - [AllocateReceiptPaymentRequest](cloudbeds_fiscal_document/docs/AllocateReceiptPaymentRequest.md)
 - [AllocationsData](cloudbeds_fiscal_document/docs/AllocationsData.md)
 - [AllocationsSummary](cloudbeds_fiscal_document/docs/AllocationsSummary.md)
 - [ApiError](cloudbeds_fiscal_document/docs/ApiError.md)
 - [ApplyReceiptRequest](cloudbeds_fiscal_document/docs/ApplyReceiptRequest.md)
 - [ArrayItemDefinition](cloudbeds_fiscal_document/docs/ArrayItemDefinition.md)
 - [ConfigsResponse](cloudbeds_fiscal_document/docs/ConfigsResponse.md)
 - [ConfigsUpdateRequest](cloudbeds_fiscal_document/docs/ConfigsUpdateRequest.md)
 - [CountryInfo](cloudbeds_fiscal_document/docs/CountryInfo.md)
 - [CountryRequirements](cloudbeds_fiscal_document/docs/CountryRequirements.md)
 - [CreateCreditNoteRequest](cloudbeds_fiscal_document/docs/CreateCreditNoteRequest.md)
 - [CreateInvoiceRequest](cloudbeds_fiscal_document/docs/CreateInvoiceRequest.md)
 - [CreateReceiptRequest](cloudbeds_fiscal_document/docs/CreateReceiptRequest.md)
 - [CreateSettlementInvoiceRequest](cloudbeds_fiscal_document/docs/CreateSettlementInvoiceRequest.md)
 - [CreateSimpleReceiptRequest](cloudbeds_fiscal_document/docs/CreateSimpleReceiptRequest.md)
 - [CreationMethod](cloudbeds_fiscal_document/docs/CreationMethod.md)
 - [CropLogoRequest](cloudbeds_fiscal_document/docs/CropLogoRequest.md)
 - [CropParam](cloudbeds_fiscal_document/docs/CropParam.md)
 - [DateDisplay](cloudbeds_fiscal_document/docs/DateDisplay.md)
 - [DiscrepanciesCount](cloudbeds_fiscal_document/docs/DiscrepanciesCount.md)
 - [DocumentAction](cloudbeds_fiscal_document/docs/DocumentAction.md)
 - [DocumentTriggerEvent](cloudbeds_fiscal_document/docs/DocumentTriggerEvent.md)
 - [EmailSubjectRecipientType](cloudbeds_fiscal_document/docs/EmailSubjectRecipientType.md)
 - [EmailSubjectResponse](cloudbeds_fiscal_document/docs/EmailSubjectResponse.md)
 - [ExportFormat](cloudbeds_fiscal_document/docs/ExportFormat.md)
 - [FieldCondition](cloudbeds_fiscal_document/docs/FieldCondition.md)
 - [FieldData](cloudbeds_fiscal_document/docs/FieldData.md)
 - [FieldDefinition](cloudbeds_fiscal_document/docs/FieldDefinition.md)
 - [FieldDefinitionDefault](cloudbeds_fiscal_document/docs/FieldDefinitionDefault.md)
 - [FieldValidation](cloudbeds_fiscal_document/docs/FieldValidation.md)
 - [FiscalChannel](cloudbeds_fiscal_document/docs/FiscalChannel.md)
 - [FiscalChannelFlow](cloudbeds_fiscal_document/docs/FiscalChannelFlow.md)
 - [FiscalChannelListResponse](cloudbeds_fiscal_document/docs/FiscalChannelListResponse.md)
 - [FiscalConnection](cloudbeds_fiscal_document/docs/FiscalConnection.md)
 - [FiscalConnectionActivateRequest](cloudbeds_fiscal_document/docs/FiscalConnectionActivateRequest.md)
 - [FiscalConnectionAuthorization](cloudbeds_fiscal_document/docs/FiscalConnectionAuthorization.md)
 - [FiscalConnectionChannel](cloudbeds_fiscal_document/docs/FiscalConnectionChannel.md)
 - [FiscalConnectionCreateRequest](cloudbeds_fiscal_document/docs/FiscalConnectionCreateRequest.md)
 - [FiscalConnectionDraft](cloudbeds_fiscal_document/docs/FiscalConnectionDraft.md)
 - [FiscalConnectionDraftListResponse](cloudbeds_fiscal_document/docs/FiscalConnectionDraftListResponse.md)
 - [FiscalConnectionDraftUpsertRequest](cloudbeds_fiscal_document/docs/FiscalConnectionDraftUpsertRequest.md)
 - [FiscalConnectionListResponse](cloudbeds_fiscal_document/docs/FiscalConnectionListResponse.md)
 - [FiscalConnectionOnboarding](cloudbeds_fiscal_document/docs/FiscalConnectionOnboarding.md)
 - [FiscalConnectionOnboardingCurrent](cloudbeds_fiscal_document/docs/FiscalConnectionOnboardingCurrent.md)
 - [FiscalConnectionOnboardingFailed](cloudbeds_fiscal_document/docs/FiscalConnectionOnboardingFailed.md)
 - [FiscalConnectionProvider](cloudbeds_fiscal_document/docs/FiscalConnectionProvider.md)
 - [FiscalConnectionTestResult](cloudbeds_fiscal_document/docs/FiscalConnectionTestResult.md)
 - [FiscalConnectionUpdateRequest](cloudbeds_fiscal_document/docs/FiscalConnectionUpdateRequest.md)
 - [FiscalCountryListResponse](cloudbeds_fiscal_document/docs/FiscalCountryListResponse.md)
 - [FiscalDocumentDetailedResponse](cloudbeds_fiscal_document/docs/FiscalDocumentDetailedResponse.md)
 - [FiscalDocumentEmailRequest](cloudbeds_fiscal_document/docs/FiscalDocumentEmailRequest.md)
 - [FiscalDocumentFile](cloudbeds_fiscal_document/docs/FiscalDocumentFile.md)
 - [FiscalDocumentFileCategory](cloudbeds_fiscal_document/docs/FiscalDocumentFileCategory.md)
 - [FiscalDocumentFilters](cloudbeds_fiscal_document/docs/FiscalDocumentFilters.md)
 - [FiscalDocumentKind](cloudbeds_fiscal_document/docs/FiscalDocumentKind.md)
 - [FiscalDocumentPaginated](cloudbeds_fiscal_document/docs/FiscalDocumentPaginated.md)
 - [FiscalDocumentPatchRequest](cloudbeds_fiscal_document/docs/FiscalDocumentPatchRequest.md)
 - [FiscalDocumentRecipient](cloudbeds_fiscal_document/docs/FiscalDocumentRecipient.md)
 - [FiscalDocumentStatus](cloudbeds_fiscal_document/docs/FiscalDocumentStatus.md)
 - [FiscalDocumentSummaryResponse](cloudbeds_fiscal_document/docs/FiscalDocumentSummaryResponse.md)
 - [FiscalDocumentTransactionAllocation](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionAllocation.md)
 - [FiscalDocumentTransactionResponse](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionResponse.md)
 - [FiscalDocumentTransactionsForAllocationPaginated](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionsForAllocationPaginated.md)
 - [FiscalDocumentTransactionsPaginated](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionsPaginated.md)
 - [FiscalDocumentTransactionsSummary](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionsSummary.md)
 - [FiscalDocumentTransactionsSummaryTaxesInner](cloudbeds_fiscal_document/docs/FiscalDocumentTransactionsSummaryTaxesInner.md)
 - [FiscalProvider](cloudbeds_fiscal_document/docs/FiscalProvider.md)
 - [FiscalProviderChannel](cloudbeds_fiscal_document/docs/FiscalProviderChannel.md)
 - [FiscalProviderListResponse](cloudbeds_fiscal_document/docs/FiscalProviderListResponse.md)
 - [FiscalProviderOnboardingStep](cloudbeds_fiscal_document/docs/FiscalProviderOnboardingStep.md)
 - [FiscalProviderSection](cloudbeds_fiscal_document/docs/FiscalProviderSection.md)
 - [FiscalProviderVisual](cloudbeds_fiscal_document/docs/FiscalProviderVisual.md)
 - [FiscalRoutingListResponse](cloudbeds_fiscal_document/docs/FiscalRoutingListResponse.md)
 - [FiscalRoutingRule](cloudbeds_fiscal_document/docs/FiscalRoutingRule.md)
 - [FiscalRoutingRulePatch](cloudbeds_fiscal_document/docs/FiscalRoutingRulePatch.md)
 - [FiscalizationAddress](cloudbeds_fiscal_document/docs/FiscalizationAddress.md)
 - [FiscalizationCertificateStatus](cloudbeds_fiscal_document/docs/FiscalizationCertificateStatus.md)
 - [FiscalizationEmail](cloudbeds_fiscal_document/docs/FiscalizationEmail.md)
 - [FiscalizationFlowStatus](cloudbeds_fiscal_document/docs/FiscalizationFlowStatus.md)
 - [FiscalizationFlowStatusChannel](cloudbeds_fiscal_document/docs/FiscalizationFlowStatusChannel.md)
 - [FiscalizationFlowStatusConnection](cloudbeds_fiscal_document/docs/FiscalizationFlowStatusConnection.md)
 - [FiscalizationFlowStatusFlow](cloudbeds_fiscal_document/docs/FiscalizationFlowStatusFlow.md)
 - [FiscalizationOperatorRulesResponse](cloudbeds_fiscal_document/docs/FiscalizationOperatorRulesResponse.md)
 - [FiscalizationPhone](cloudbeds_fiscal_document/docs/FiscalizationPhone.md)
 - [FiscalizationRegistrationRequest](cloudbeds_fiscal_document/docs/FiscalizationRegistrationRequest.md)
 - [FiscalizationRegistrationResponse](cloudbeds_fiscal_document/docs/FiscalizationRegistrationResponse.md)
 - [FiscalizationRegistrationRulesResponse](cloudbeds_fiscal_document/docs/FiscalizationRegistrationRulesResponse.md)
 - [FiscalizationRegistrationStatus](cloudbeds_fiscal_document/docs/FiscalizationRegistrationStatus.md)
 - [FiscalizationSeriesResponse](cloudbeds_fiscal_document/docs/FiscalizationSeriesResponse.md)
 - [FiscalizationSeriesRulesResponse](cloudbeds_fiscal_document/docs/FiscalizationSeriesRulesResponse.md)
 - [FiscalizationStatusResponse](cloudbeds_fiscal_document/docs/FiscalizationStatusResponse.md)
 - [FiscalizationTaxRulesResponse](cloudbeds_fiscal_document/docs/FiscalizationTaxRulesResponse.md)
 - [FiscalizationValidationResult](cloudbeds_fiscal_document/docs/FiscalizationValidationResult.md)
 - [FolioExportSort](cloudbeds_fiscal_document/docs/FolioExportSort.md)
 - [GetCreditNotePreviewRequest](cloudbeds_fiscal_document/docs/GetCreditNotePreviewRequest.md)
 - [GetFolioExportRequest](cloudbeds_fiscal_document/docs/GetFolioExportRequest.md)
 - [GetInvoicePreviewRequest](cloudbeds_fiscal_document/docs/GetInvoicePreviewRequest.md)
 - [GetLogoResponse](cloudbeds_fiscal_document/docs/GetLogoResponse.md)
 - [GetRectifyInvoiceNotePreviewRequest](cloudbeds_fiscal_document/docs/GetRectifyInvoiceNotePreviewRequest.md)
 - [GovernmentDocumentType](cloudbeds_fiscal_document/docs/GovernmentDocumentType.md)
 - [GovernmentIntegration](cloudbeds_fiscal_document/docs/GovernmentIntegration.md)
 - [GovernmentIntegrationQr](cloudbeds_fiscal_document/docs/GovernmentIntegrationQr.md)
 - [GuestDocumentType](cloudbeds_fiscal_document/docs/GuestDocumentType.md)
 - [GuestGender](cloudbeds_fiscal_document/docs/GuestGender.md)
 - [IntegrationSignature](cloudbeds_fiscal_document/docs/IntegrationSignature.md)
 - [InvoiceAllocationsResponse](cloudbeds_fiscal_document/docs/InvoiceAllocationsResponse.md)
 - [InvoiceTransactionAllocation](cloudbeds_fiscal_document/docs/InvoiceTransactionAllocation.md)
 - [InvoiceTypeOptionsResponse](cloudbeds_fiscal_document/docs/InvoiceTypeOptionsResponse.md)
 - [InvoicedStatus](cloudbeds_fiscal_document/docs/InvoicedStatus.md)
 - [IssuerRegistryResponse](cloudbeds_fiscal_document/docs/IssuerRegistryResponse.md)
 - [IssuerRegistryUpdate](cloudbeds_fiscal_document/docs/IssuerRegistryUpdate.md)
 - [ItemCategoryRequirement](cloudbeds_fiscal_document/docs/ItemCategoryRequirement.md)
 - [ItemExtensionField](cloudbeds_fiscal_document/docs/ItemExtensionField.md)
 - [ItemExtensionRulesResponse](cloudbeds_fiscal_document/docs/ItemExtensionRulesResponse.md)
 - [LatestLinkedDocument](cloudbeds_fiscal_document/docs/LatestLinkedDocument.md)
 - [LinkedDocument](cloudbeds_fiscal_document/docs/LinkedDocument.md)
 - [ManualRecipientRequest](cloudbeds_fiscal_document/docs/ManualRecipientRequest.md)
 - [ManualRecipientRequestAddress](cloudbeds_fiscal_document/docs/ManualRecipientRequestAddress.md)
 - [ManualRecipientRequestDocument](cloudbeds_fiscal_document/docs/ManualRecipientRequestDocument.md)
 - [Origin](cloudbeds_fiscal_document/docs/Origin.md)
 - [PaymentMethodRule](cloudbeds_fiscal_document/docs/PaymentMethodRule.md)
 - [PaymentMethodRulesResponse](cloudbeds_fiscal_document/docs/PaymentMethodRulesResponse.md)
 - [PreviewRequest](cloudbeds_fiscal_document/docs/PreviewRequest.md)
 - [ProFormaInvoicePreviewRequest](cloudbeds_fiscal_document/docs/ProFormaInvoicePreviewRequest.md)
 - [ProFormaInvoiceRequest](cloudbeds_fiscal_document/docs/ProFormaInvoiceRequest.md)
 - [ProFormaStatusUpdateRequest](cloudbeds_fiscal_document/docs/ProFormaStatusUpdateRequest.md)
 - [PropertyConfigsResponse](cloudbeds_fiscal_document/docs/PropertyConfigsResponse.md)
 - [PropertySettingsResponse](cloudbeds_fiscal_document/docs/PropertySettingsResponse.md)
 - [PropertySettingsUpdateRequest](cloudbeds_fiscal_document/docs/PropertySettingsUpdateRequest.md)
 - [ProviderOption](cloudbeds_fiscal_document/docs/ProviderOption.md)
 - [ProviderOptionsReplaceRequest](cloudbeds_fiscal_document/docs/ProviderOptionsReplaceRequest.md)
 - [ProviderOptionsReplaceResponse](cloudbeds_fiscal_document/docs/ProviderOptionsReplaceResponse.md)
 - [ReceiptTransactionAllocation](cloudbeds_fiscal_document/docs/ReceiptTransactionAllocation.md)
 - [RecipientAddress](cloudbeds_fiscal_document/docs/RecipientAddress.md)
 - [RecipientCompany](cloudbeds_fiscal_document/docs/RecipientCompany.md)
 - [RecipientContactDetails](cloudbeds_fiscal_document/docs/RecipientContactDetails.md)
 - [RecipientDetails](cloudbeds_fiscal_document/docs/RecipientDetails.md)
 - [RecipientDocument](cloudbeds_fiscal_document/docs/RecipientDocument.md)
 - [RecipientRequest](cloudbeds_fiscal_document/docs/RecipientRequest.md)
 - [RecipientTaxInfo](cloudbeds_fiscal_document/docs/RecipientTaxInfo.md)
 - [RecipientType](cloudbeds_fiscal_document/docs/RecipientType.md)
 - [RectifyInvoiceNoteRequest](cloudbeds_fiscal_document/docs/RectifyInvoiceNoteRequest.md)
 - [ReportDefinition](cloudbeds_fiscal_document/docs/ReportDefinition.md)
 - [ReportParam](cloudbeds_fiscal_document/docs/ReportParam.md)
 - [Requirement](cloudbeds_fiscal_document/docs/Requirement.md)
 - [RequirementField](cloudbeds_fiscal_document/docs/RequirementField.md)
 - [RulesSection](cloudbeds_fiscal_document/docs/RulesSection.md)
 - [SelectOption](cloudbeds_fiscal_document/docs/SelectOption.md)
 - [SeriesDimensionGroup](cloudbeds_fiscal_document/docs/SeriesDimensionGroup.md)
 - [SeriesDocumentType](cloudbeds_fiscal_document/docs/SeriesDocumentType.md)
 - [SeriesMapping](cloudbeds_fiscal_document/docs/SeriesMapping.md)
 - [SeriesOptions](cloudbeds_fiscal_document/docs/SeriesOptions.md)
 - [SeriesType](cloudbeds_fiscal_document/docs/SeriesType.md)
 - [SingleAllocation](cloudbeds_fiscal_document/docs/SingleAllocation.md)
 - [SourceKind](cloudbeds_fiscal_document/docs/SourceKind.md)
 - [TaxRule](cloudbeds_fiscal_document/docs/TaxRule.md)
 - [TransactionForAllocationResponse](cloudbeds_fiscal_document/docs/TransactionForAllocationResponse.md)
 - [TransactionStatus](cloudbeds_fiscal_document/docs/TransactionStatus.md)
 - [TransactionsSummaryRequest](cloudbeds_fiscal_document/docs/TransactionsSummaryRequest.md)
 - [UpdateRequireAttentionRequest](cloudbeds_fiscal_document/docs/UpdateRequireAttentionRequest.md)
 - [UploadConnectionCertificate422Response](cloudbeds_fiscal_document/docs/UploadConnectionCertificate422Response.md)
 - [ValidationError](cloudbeds_fiscal_document/docs/ValidationError.md)
 - [VoidReceiptRequest](cloudbeds_fiscal_document/docs/VoidReceiptRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)

<a id="oauth2"></a>
### oauth2

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://api.cloudbeds.com/auth/oauth/authorize
- **Scopes**: 
 - **read:reservation**: Read fiscal documents and fiscalization configuration
 - **write:reservation**: Create, update, or void fiscal documents and fiscalization configuration


## Author




