cloudbeds-fiscal-document 1.9.1

OpenAPI client for Cloudbeds Fiscal Document API.

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

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

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

# Defining the host is optional and defaults to http://localhost:8700
# See configuration.py for a list of all supported configuration parameters.
configuration = cloudbeds_fiscal_document.Configuration(
    host = "http://localhost:8700"
)

# 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_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

    try:
        # Get list of fiscal documents configs
        api_response = api_instance.get_configs(x_property_id)
        print("The response of ConfigsApi->get_configs:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConfigsApi->get_configs: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8700

Class	Method	HTTP request	Description
ConfigsApi	get_configs	GET /fiscal-document/v1/configs	Get list of fiscal documents configs
ConfigsApi	get_pdf_preview	GET /fiscal-document/v1/configs/preview	Get PDF document preview
ConfigsApi	update_configs	PUT /fiscal-document/v1/configs/{documentKind}	Updates a config of a specific kind
FeaturesApi	get_property_features	GET /fiscal-document/v1/property/features	Get enabled features for the current user and property
FiscalDocumentsApi	allocate_receipt_payment	POST /fiscal-document/v1/fiscal-documents/receipt/allocate-payment	Allocate payment associated with receipt to charge transactions.
FiscalDocumentsApi	create_credit_note	POST /fiscal-document/v1/fiscal-documents/credit-note	Create a fiscal document of the type credit note
FiscalDocumentsApi	create_invoice	POST /fiscal-document/v1/fiscal-documents/invoice	Create a fiscal document of the type invoice
FiscalDocumentsApi	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	POST /fiscal-document/v1/fiscal-documents/receipt	Create receipt for a payment.
FiscalDocumentsApi	create_rectify_invoice	POST /fiscal-document/v1/fiscal-documents/rectify-invoice	Create a fiscal document of the type rectify invoice
FiscalDocumentsApi	create_simple_receipt	POST /fiscal-document/v1/fiscal-documents/simple-receipt	Create simple receipts.
FiscalDocumentsApi	download_fiscal_document	GET /fiscal-document/v1/fiscal-documents/{id}/download	Download fiscal document
FiscalDocumentsApi	email_fiscal_document	POST /fiscal-document/v1/fiscal-documents/{id}/email	Email a fiscal document
FiscalDocumentsApi	get_allocations_summary	GET /fiscal-document/v1/fiscal-documents/allocations/summary	Get allocations summary
FiscalDocumentsApi	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	POST /fiscal-document/v1/fiscal-documents/invoice/preview	Get fiscal document preview of the type invoice
FiscalDocumentsApi	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	GET /fiscal-document/v1/fiscal-documents/transactions	Get available transactions for fiscal documents
FiscalDocumentsApi	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	GET /fiscal-document/v1/fiscal-documents/allocations/transactions	Get available transactions for allocations
FiscalDocumentsApi	get_fiscal_documents	GET /fiscal-document/v1/fiscal-documents	Get list of fiscal documents
FiscalDocumentsApi	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	POST /fiscal-document/v1/fiscal-documents/rectify-invoice/preview	Get fiscal document preview of the type rectify invoice
FiscalDocumentsApi	get_selected_transactions_summary	GET /fiscal-document/v1/fiscal-documents/transactions/summary	Get totals of selected available transactions for fiscal documents
FiscalDocumentsApi	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	put_fiscal_document	PUT /fiscal-document/v1/fiscal-documents/{id}	Update a fiscal document by id
FiscalDocumentsApi	update_pro_forma_invoice_status	PUT /fiscal-document/v1/fiscal-documents/pro-forma-invoice/{id}/status	Update pro forma invoice status

Documentation For Models

• Action
• AllocateReceiptPaymentRequest
• AllocationsSummary
• ApiError
• ConfigsResponse
• ConfigsUpdateRequest
• CreateCreditNoteRequest
• CreateInvoiceRequest
• CreateReceiptRequest
• CreateSimpleReceiptRequest
• CreationMethod
• DocumentAction
• DocumentTriggerEvent
• FiscalDocumentDetailedResponse
• FiscalDocumentEmailRequest
• FiscalDocumentFilters
• FiscalDocumentKind
• FiscalDocumentPaginated
• FiscalDocumentPatchRequest
• FiscalDocumentRecipient
• FiscalDocumentStatus
• FiscalDocumentSummaryResponse
• FiscalDocumentTransactionResponse
• FiscalDocumentTransactionsForAllocationPaginated
• FiscalDocumentTransactionsPaginated
• FiscalDocumentTransactionsSummary
• FiscalDocumentTransactionsSummaryTaxesInner
• GetCreditNotePreviewRequest
• GetInvoicePreviewRequest
• GetRectifyInvoiceNotePreviewRequest
• GovernmentIntegration
• GovernmentIntegrationQr
• LatestLinkedDocument
• LinkedDocument
• ProFormaInvoicePreviewRequest
• ProFormaInvoiceRequest
• ProFormaStatusUpdateRequest
• ReceiptTransactionAllocation
• RecipientAddress
• RecipientCompany
• RecipientContactDetails
• RecipientDetails
• RecipientDocument
• RecipientRequest
• RecipientTaxInfo
• RecipientType
• RectifyInvoiceNoteRequest
• SourceKind
• TransactionForAllocationResponse

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author