search

fattureincloud / fattureincloud-python-sdk

MIT License
9 stars 2 forks source link

readme

FattureInCloud Python SDK

PyPI unit tests

fattureincloud-python-sdk

Connect your software with Fatture in Cloud, the invoicing platform chosen by more than 500.000 businesses in Italy.

The Fatture in Cloud API is based on REST, and makes possible to interact with the user related data prior authorization via OAuth2 protocol.

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python >= 3.7

Installation & Usage

pip install

You can install our python package directly using:

pip install fattureincloud-python-sdk

(you may need to run pip with root permission: sudo pip install fattureincloud-python-sdk)

Then import the package:

import fattureincloud_python_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import fattureincloud_python_sdk
from fattureincloud_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api-v2.fattureincloud.it
# See configuration.py for a list of all supported configuration parameters.
configuration = fattureincloud_python_sdk.Configuration(
    host = "https://api-v2.fattureincloud.it"
)

# 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 fattureincloud_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fattureincloud_python_sdk.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    create_archive_document_request = {"data":{"date":"2021-08-20","category":"Altri documenti","description":"spesa 1","attachment_token":"ibfjdbf94ey9w94g3w894qbasrga"}} # CreateArchiveDocumentRequest | The Archive Document. (optional)

    try:
        # Create Archive Document
        api_response = api_instance.create_archive_document(company_id, create_archive_document_request=create_archive_document_request)
        print("The response of ArchiveApi->create_archive_document:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ArchiveApi->create_archive_document: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api-v2.fattureincloud.it

Class Method HTTP request Description
ArchiveApi create_archive_document POST /c/{company_id}/archive Create Archive Document
ArchiveApi delete_archive_document DELETE /c/{company_id}/archive/{document_id} Delete Archive Document
ArchiveApi get_archive_document GET /c/{company_id}/archive/{document_id} Get Archive Document
ArchiveApi list_archive_documents GET /c/{company_id}/archive List Archive Documents
ArchiveApi modify_archive_document PUT /c/{company_id}/archive/{document_id} Modify Archive Document
ArchiveApi upload_archive_document_attachment POST /c/{company_id}/archive/attachment Upload Archive Document Attachment
CashbookApi create_cashbook_entry POST /c/{company_id}/cashbook Create Cashbook Entry
CashbookApi delete_cashbook_entry DELETE /c/{company_id}/cashbook/{document_id} Delete Cashbook Entry
CashbookApi get_cashbook_entry GET /c/{company_id}/cashbook/{document_id} Get Cashbook Entry
CashbookApi list_cashbook_entries GET /c/{company_id}/cashbook List Cashbook Entries
CashbookApi modify_cashbook_entry PUT /c/{company_id}/cashbook/{document_id} Modify Cashbook Entry
ClientsApi create_client POST /c/{company_id}/entities/clients Create Client
ClientsApi delete_client DELETE /c/{company_id}/entities/clients/{client_id} Delete Client
ClientsApi get_client GET /c/{company_id}/entities/clients/{client_id} Get Client
ClientsApi list_clients GET /c/{company_id}/entities/clients List Clients
ClientsApi modify_client PUT /c/{company_id}/entities/clients/{client_id} Modify Client
CompaniesApi get_company_info GET /c/{company_id}/company/info Get Company Info
CompaniesApi get_company_plan_usage GET /c/{company_id}/company/plan_usage Get Company Plan Usage
EmailsApi list_emails GET /c/{company_id}/emails List Emails
InfoApi list_archive_categories GET /c/{company_id}/info/archive_categories List Archive Categories
InfoApi list_cities GET /info/cities List Cities
InfoApi list_cost_centers GET /c/{company_id}/info/cost_centers List Cost Centers
InfoApi list_countries GET /info/countries List Countries
InfoApi list_currencies GET /info/currencies List Currencies
InfoApi list_delivery_notes_default_causals GET /info/dn_causals List Delivery Notes Default Causals
InfoApi list_detailed_countries GET /info/detailed_countries List Detailed Countries
InfoApi list_languages GET /info/languages List Languages
InfoApi list_payment_accounts GET /c/{company_id}/info/payment_accounts List Payment Accounts
InfoApi list_payment_methods GET /c/{company_id}/info/payment_methods List Payment Methods
InfoApi list_product_categories GET /c/{company_id}/info/product_categories List Product Categories
InfoApi list_received_document_categories GET /c/{company_id}/info/received_document_categories List Received Document Categories
InfoApi list_revenue_centers GET /c/{company_id}/info/revenue_centers List Revenue Centers
InfoApi list_templates GET /info/templates List Templates
InfoApi list_units_of_measure GET /info/measures List Units of Measure
InfoApi list_vat_types GET /c/{company_id}/info/vat_types List Vat Types
IssuedDocumentsApi create_issued_document POST /c/{company_id}/issued_documents Create Issued Document
IssuedDocumentsApi delete_issued_document DELETE /c/{company_id}/issued_documents/{document_id} Delete Issued Document
IssuedDocumentsApi delete_issued_document_attachment DELETE /c/{company_id}/issued_documents/{document_id}/attachment Delete Issued Document Attachment
IssuedDocumentsApi get_email_data GET /c/{company_id}/issued_documents/{document_id}/email Get Email Data
IssuedDocumentsApi get_existing_issued_document_totals POST /c/{company_id}/issued_documents/{document_id}/totals Get Existing Issued Document Totals
IssuedDocumentsApi get_issued_document GET /c/{company_id}/issued_documents/{document_id} Get Issued Document
IssuedDocumentsApi get_issued_document_pre_create_info GET /c/{company_id}/issued_documents/info Get Issued Document Pre-Create Info
IssuedDocumentsApi get_new_issued_document_totals POST /c/{company_id}/issued_documents/totals Get New Issued Document Totals
IssuedDocumentsApi join_issued_documents GET /c/{company_id}/issued_documents/join Join Issued Documents
IssuedDocumentsApi list_issued_documents GET /c/{company_id}/issued_documents List Issued Documents
IssuedDocumentsApi modify_issued_document PUT /c/{company_id}/issued_documents/{document_id} Modify Issued Document
IssuedDocumentsApi schedule_email POST /c/{company_id}/issued_documents/{document_id}/email Schedule Email
IssuedDocumentsApi transform_issued_document GET /c/{company_id}/issued_documents/transform Transform Issued Document
IssuedDocumentsApi upload_issued_document_attachment POST /c/{company_id}/issued_documents/attachment Upload Issued Document Attachment
IssuedEInvoicesApi get_e_invoice_rejection_reason GET /c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason Get E-Invoice Rejection Reason
IssuedEInvoicesApi get_e_invoice_xml GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml Get E-Invoice XML
IssuedEInvoicesApi send_e_invoice POST /c/{company_id}/issued_documents/{document_id}/e_invoice/send Send E-Invoice
IssuedEInvoicesApi verify_e_invoice_xml GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify Verify E-Invoice XML
ProductsApi create_product POST /c/{company_id}/products Create Product
ProductsApi delete_product DELETE /c/{company_id}/products/{product_id} Delete Product
ProductsApi get_product GET /c/{company_id}/products/{product_id} Get Product
ProductsApi list_products GET /c/{company_id}/products List Products
ProductsApi modify_product PUT /c/{company_id}/products/{product_id} Modify Product
ReceiptsApi create_receipt POST /c/{company_id}/receipts Create Receipt
ReceiptsApi delete_receipt DELETE /c/{company_id}/receipts/{document_id} Delete Receipt
ReceiptsApi get_receipt GET /c/{company_id}/receipts/{document_id} Get Receipt
ReceiptsApi get_receipt_pre_create_info GET /c/{company_id}/receipts/info Get Receipt Pre-Create Info
ReceiptsApi get_receipts_monthly_totals GET /c/{company_id}/receipts/monthly_totals Get Receipts Monthly Totals
ReceiptsApi list_receipts GET /c/{company_id}/receipts List Receipts
ReceiptsApi modify_receipt PUT /c/{company_id}/receipts/{document_id} Modify Receipt
ReceivedDocumentsApi create_received_document POST /c/{company_id}/received_documents Create Received Document
ReceivedDocumentsApi delete_received_document DELETE /c/{company_id}/received_documents/{document_id} Delete Received Document
ReceivedDocumentsApi delete_received_document_attachment DELETE /c/{company_id}/received_documents/{document_id}/attachment Delete Received Document Attachment
ReceivedDocumentsApi get_existing_received_document_totals POST /c/{company_id}/received_documents/{document_id}/totals Get Existing Received Document Totals
ReceivedDocumentsApi get_new_received_document_totals POST /c/{company_id}/received_documents/totals Get New Received Document Totals
ReceivedDocumentsApi get_received_document GET /c/{company_id}/received_documents/{document_id} Get Received Document
ReceivedDocumentsApi get_received_document_pre_create_info GET /c/{company_id}/received_documents/info Get Received Document Pre-Create Info
ReceivedDocumentsApi list_received_documents GET /c/{company_id}/received_documents List Received Documents
ReceivedDocumentsApi modify_received_document PUT /c/{company_id}/received_documents/{document_id} Modify Received Document
ReceivedDocumentsApi upload_received_document_attachment POST /c/{company_id}/received_documents/attachment Upload Received Document Attachment
SettingsApi create_payment_account POST /c/{company_id}/settings/payment_accounts Create Payment Account
SettingsApi create_payment_method POST /c/{company_id}/settings/payment_methods Create Payment Method
SettingsApi create_vat_type POST /c/{company_id}/settings/vat_types Create Vat Type
SettingsApi delete_payment_account DELETE /c/{company_id}/settings/payment_accounts/{payment_account_id} Delete Payment Account
SettingsApi delete_payment_method DELETE /c/{company_id}/settings/payment_methods/{payment_method_id} Delete Payment Method
SettingsApi delete_vat_type DELETE /c/{company_id}/settings/vat_types/{vat_type_id} Delete Vat Type
SettingsApi get_payment_account GET /c/{company_id}/settings/payment_accounts/{payment_account_id} Get Payment Account
SettingsApi get_payment_method GET /c/{company_id}/settings/payment_methods/{payment_method_id} Get Payment Method
SettingsApi get_tax_profile GET /c/{company_id}/settings/tax_profile Get Tax Profile
SettingsApi get_vat_type GET /c/{company_id}/settings/vat_types/{vat_type_id} Get Vat Type
SettingsApi modify_payment_account PUT /c/{company_id}/settings/payment_accounts/{payment_account_id} Modify Payment Account
SettingsApi modify_payment_method PUT /c/{company_id}/settings/payment_methods/{payment_method_id} Modify Payment Method
SettingsApi modify_vat_type PUT /c/{company_id}/settings/vat_types/{vat_type_id} Modify Vat Type
SuppliersApi create_supplier POST /c/{company_id}/entities/suppliers Create Supplier
SuppliersApi delete_supplier DELETE /c/{company_id}/entities/suppliers/{supplier_id} Delete Supplier
SuppliersApi get_supplier GET /c/{company_id}/entities/suppliers/{supplier_id} Get Supplier
SuppliersApi list_suppliers GET /c/{company_id}/entities/suppliers List Suppliers
SuppliersApi modify_supplier PUT /c/{company_id}/entities/suppliers/{supplier_id} Modify Supplier
TaxesApi create_f24 POST /c/{company_id}/taxes Create F24
TaxesApi delete_f24 DELETE /c/{company_id}/taxes/{document_id} Delete F24
TaxesApi delete_f24_attachment DELETE /c/{company_id}/taxes/{document_id}/attachment Delete F24 Attachment
TaxesApi get_f24 GET /c/{company_id}/taxes/{document_id} Get F24
TaxesApi list_f24 GET /c/{company_id}/taxes List F24
TaxesApi modify_f24 PUT /c/{company_id}/taxes/{document_id} Modify F24
TaxesApi upload_f24_attachment POST /c/{company_id}/taxes/attachment Upload F24 Attachment
UserApi get_user_info GET /user/info Get User Info
UserApi list_user_companies GET /user/companies List User Companies
WebhooksApi create_webhooks_subscription POST /c/{company_id}/subscriptions Create a Webhook Subscription
WebhooksApi delete_webhooks_subscription DELETE /c/{company_id}/subscriptions/{subscription_id} Delete Webhooks Subscription
WebhooksApi get_webhooks_subscription GET /c/{company_id}/subscriptions/{subscription_id} Get Webhooks Subscription
WebhooksApi list_webhooks_subscriptions GET /c/{company_id}/subscriptions List Webhooks Subscriptions
WebhooksApi modify_webhooks_subscription PUT /c/{company_id}/subscriptions/{subscription_id} Modify Webhooks Subscription

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2AuthenticationCodeFlow

Author

info@fattureincloud.it