Python SDK for the Fatture in Cloud API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fattureincloud from gravatar.com fattureincloud

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT

Author: Fatture in Cloud

Tags fattureincloud, fatture in cloud, fatture, fic, fattureincloud sdk, fatture in cloud sdk

Requires: Python >=3.6

Project description

FattureInCloud Python SDK

PyPI unit tests

Connect your software with Fatture in Cloud, the invoicing platform chosen by more than 400.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:

  • API version: 2.0.20
  • Package version: 2.0.9
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.fattureincloud.it

Requirements.

Python >= 3.6

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

Getting Started

Please follow the installation procedure and then run the following:

import time
import fattureincloud_python_sdk
from pprint import pprint
from fattureincloud_python_sdk.api import archive_api
from fattureincloud_python_sdk.model.create_archive_document_request import CreateArchiveDocumentRequest
from fattureincloud_python_sdk.model.create_archive_document_response import CreateArchiveDocumentResponse
from fattureincloud_python_sdk.model.get_archive_document_response import GetArchiveDocumentResponse
from fattureincloud_python_sdk.model.list_archive_documents_response import ListArchiveDocumentsResponse
from fattureincloud_python_sdk.model.modify_archive_document_request import ModifyArchiveDocumentRequest
from fattureincloud_python_sdk.model.modify_archive_document_response import ModifyArchiveDocumentResponse
from fattureincloud_python_sdk.model.upload_archive_attachment_response import UploadArchiveAttachmentResponse
# 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.

# Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
configuration = fattureincloud_python_sdk.Configuration(
    access_token = "YOUR_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 = archive_api.ArchiveApi(api_client)
    company_id = 12345 # int | The ID of the company.
    create_archive_document_request = CreateArchiveDocumentRequest(
        data=ArchiveDocument(
            id=1,
            date=dateutil_parser('1970-01-01').date(),
            description="description_example",
            category="category_example",
            attachment_token="attachment_token_example",
        ),
    ) # 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)
        pprint(api_response)
    except fattureincloud_python_sdk.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
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 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 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 the 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_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

Documentation For Models

Documentation For Authorization

OAuth2AuthenticationCodeFlow

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://api-v2.fattureincloud.it/oauth/authorize
  • Scopes:
  • entity.clients:r: Read permission to the Clients registry
  • entity.clients:a: Write permission to the Clients registry
  • entity.suppliers:r: Read permission to the Suppliers registry
  • entity.suppliers:a: Write permission to the Suppliers registry
  • products:r: Read permission to the Products
  • products:a: Write permission to the Products
  • issued_documents.invoices:r: Read permission to the issued Invoices
  • issued_documents.credit_notes:r: Read permission to the issued Credit Notes
  • issued_documents.receipts:r: Read permission to the issued Receipts
  • issued_documents.orders:r: Read permission to the issued Orders
  • issued_documents.quotes:r: Read permission to the issued Quotes
  • issued_documents.proformas:r: Read permission to the issued Proformas
  • issued_documents.delivery_notes:r: Read permission to the issued Delivery Notes
  • issued_documents.invoices:a: Write permission to the issued Invoices
  • issued_documents.credit_notes:a: Write permission to the issued Credit Notes
  • issued_documents.receipts:a: Write permission to the issued issued Receipts
  • issued_documents.orders:a: Write permission to the issued Orders
  • issued_documents.quotes:a: Write permission to the issued Quotes
  • issued_documents.proformas:a: Write permission to the issued Proformas
  • issued_documents.delivery_notes:a: Write permission to the issued Delivery Notes
  • received_documents:r: Read permission to the Received Documents
  • received_documents:a: Write permission to the Received Documents
  • stock:r: Read permission to the Stock movements
  • stock:a: Write permission to the Stock movements
  • receipts:r: Read permission to the Receipts
  • receipts:a: Write permission to the Receipts
  • taxes:r: Read permission to the Taxes
  • taxes:a: Write permission to the Taxes
  • archive:r: Read permission to the Archive Documents
  • archive:a: Read permission to the Archive Documents
  • cashbook:r: Read permission to the Cashbook
  • cashbook:a: Write permission to the Cashbook
  • settings:r: Read permission to the Settings
  • settings:a: Write permission to the Settings
  • situation:r: Read permission to the company Situation

Author

info@fattureincloud.it

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fattureincloud_python_sdk.apis and fattureincloud_python_sdk.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from fattureincloud_python_sdk.api.default_api import DefaultApi
  • from fattureincloud_python_sdk.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fattureincloud_python_sdk
from fattureincloud_python_sdk.apis import *
from fattureincloud_python_sdk.models import *

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fattureincloud from gravatar.com fattureincloud

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT

Author: Fatture in Cloud

Tags fattureincloud, fatture in cloud, fatture, fic, fattureincloud sdk, fatture in cloud sdk

Requires: Python >=3.6


Release history Release notifications | RSS feed

2.0.18

2.0.17

2.0.16

2.0.15

2.0.14

2.0.13

2.0.12

2.0.11

2.0.10

This version

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fattureincloud-python-sdk-2.0.9.tar.gz (224.8 kB view hashes)

Uploaded Source

Built Distribution

fattureincloud_python_sdk-2.0.9-py3-none-any.whl (707.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page