FattureInCloud Ruby SDK

Ruby Gems unit tests

FattureInCloud_Ruby_Sdk - the Ruby gem for the Fatture in Cloud API v2 - API Reference

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 SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.1.3
  • Package version: 2.1.1
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

For more information, please visit https://www.fattureincloud.it

Installation

RubyGems

To install the gem via RubyGems, run the following command:

“ $ gem install fattureincloud_ruby_sdk

Getting Started

Please follow the installation procedure and then run the following code:

“by

Load the gem

require ‘fattureincloud_ruby_sdk’

Setup authorization

FattureInCloud_Ruby_Sdk.configure do |config| # Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow config.access_token = ‘YOUR ACCESS TOKEN’ # Configure a proc to get access tokens in lieu of the static access_token configuration config.access_token_getter = -> { ‘YOUR TOKEN GETTER PROC’ } end

api_instance = FattureInCloud_Ruby_Sdk::ArchiveApi.new company_id = 12345 # Integer | The ID of the company. opts = { create_archive_document_request: FattureInCloud_Ruby_Sdk::CreateArchiveDocumentRequest.new # CreateArchiveDocumentRequest | The Archive Document. }

begin #Create Archive Document result = api_instance.create_archive_document(company_id, opts) p result rescue FattureInCloud_Ruby_Sdk::ApiError => e puts “Exception when calling ArchiveApi->create_archive_document: #e” end

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
FattureInCloud_Ruby_Sdk::ArchiveApicreate_archive_documentPOST /c/company_id/archiveCreate Archive Document
FattureInCloud_Ruby_Sdk::ArchiveApidelete_archive_documentDELETE /c/company_id/archive/document_idDelete Archive Document
FattureInCloud_Ruby_Sdk::ArchiveApiget_archive_documentGET /c/company_id/archive/document_idGet Archive Document
FattureInCloud_Ruby_Sdk::ArchiveApilist_archive_documentsGET /c/company_id/archiveList Archive Documents
FattureInCloud_Ruby_Sdk::ArchiveApimodify_archive_documentPUT /c/company_id/archive/document_idModify Archive Document
FattureInCloud_Ruby_Sdk::ArchiveApiupload_archive_document_attachmentPOST /c/company_id/archive/attachmentUpload Archive Document Attachment
FattureInCloud_Ruby_Sdk::CashbookApicreate_cashbook_entryPOST /c/company_id/cashbookCreate Cashbook Entry
FattureInCloud_Ruby_Sdk::CashbookApidelete_cashbook_entryDELETE /c/company_id/cashbook/document_idDelete Cashbook Entry
FattureInCloud_Ruby_Sdk::CashbookApiget_cashbook_entryGET /c/company_id/cashbook/document_idGet Cashbook Entry
FattureInCloud_Ruby_Sdk::CashbookApilist_cashbook_entriesGET /c/company_id/cashbookList Cashbook Entries
FattureInCloud_Ruby_Sdk::CashbookApimodify_cashbook_entryPUT /c/company_id/cashbook/document_idModify Cashbook Entry
FattureInCloud_Ruby_Sdk::ClientsApicreate_clientPOST /c/company_id/entities/clientsCreate Client
FattureInCloud_Ruby_Sdk::ClientsApidelete_clientDELETE /c/company_id/entities/clients/client_idDelete Client
FattureInCloud_Ruby_Sdk::ClientsApiget_clientGET /c/company_id/entities/clients/client_idGet Client
FattureInCloud_Ruby_Sdk::ClientsApilist_clientsGET /c/company_id/entities/clientsList Clients
FattureInCloud_Ruby_Sdk::ClientsApimodify_clientPUT /c/company_id/entities/clients/client_idModify Client
FattureInCloud_Ruby_Sdk::CompaniesApiget_company_infoGET /c/company_id/company/infoGet Company Info
FattureInCloud_Ruby_Sdk::CompaniesApiget_company_plan_usageGET /c/company_id/company/plan_usageGet Company Plan Usage
FattureInCloud_Ruby_Sdk::EmailsApilist_emailsGET /c/company_id/emailsList Emails
FattureInCloud_Ruby_Sdk::InfoApilist_archive_categoriesGET /c/company_id/info/archive_categoriesList Archive Categories
FattureInCloud_Ruby_Sdk::InfoApilist_citiesGET /info/citiesList Cities
FattureInCloud_Ruby_Sdk::InfoApilist_cost_centersGET /c/company_id/info/cost_centersList Cost Centers
FattureInCloud_Ruby_Sdk::InfoApilist_countriesGET /info/countriesList Countries
FattureInCloud_Ruby_Sdk::InfoApilist_currenciesGET /info/currenciesList Currencies
FattureInCloud_Ruby_Sdk::InfoApilist_delivery_notes_default_causalsGET /info/dn_causalsList Delivery Notes Default Causals
FattureInCloud_Ruby_Sdk::InfoApilist_detailed_countriesGET /info/detailed_countriesList Detailed Countries
FattureInCloud_Ruby_Sdk::InfoApilist_languagesGET /info/languagesList Languages
FattureInCloud_Ruby_Sdk::InfoApilist_payment_accountsGET /c/company_id/info/payment_accountsList Payment Accounts
FattureInCloud_Ruby_Sdk::InfoApilist_payment_methodsGET /c/company_id/info/payment_methodsList Payment Methods
FattureInCloud_Ruby_Sdk::InfoApilist_product_categoriesGET /c/company_id/info/product_categoriesList Product Categories
FattureInCloud_Ruby_Sdk::InfoApilist_received_document_categoriesGET /c/company_id/info/received_document_categoriesList Received Document Categories
FattureInCloud_Ruby_Sdk::InfoApilist_revenue_centersGET /c/company_id/info/revenue_centersList Revenue Centers
FattureInCloud_Ruby_Sdk::InfoApilist_templatesGET /info/templatesList Templates
FattureInCloud_Ruby_Sdk::InfoApilist_units_of_measureGET /info/measuresList Units of Measure
FattureInCloud_Ruby_Sdk::InfoApilist_vat_typesGET /c/company_id/info/vat_typesList Vat Types
FattureInCloud_Ruby_Sdk::IssuedDocumentsApicreate_issued_documentPOST /c/company_id/issued_documentsCreate Issued Document
FattureInCloud_Ruby_Sdk::IssuedDocumentsApidelete_issued_documentDELETE /c/company_id/issued_documents/document_idDelete Issued Document
FattureInCloud_Ruby_Sdk::IssuedDocumentsApidelete_issued_document_attachmentDELETE /c/company_id/issued_documents/document_id/attachmentDelete Issued Document Attachment
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiget_email_dataGET /c/company_id/issued_documents/document_id/emailGet Email Data
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiget_existing_issued_document_totalsPOST /c/company_id/issued_documents/document_id/totalsGet Existing Issued Document Totals
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiget_issued_documentGET /c/company_id/issued_documents/document_idGet Issued Document
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiget_issued_document_pre_create_infoGET /c/company_id/issued_documents/infoGet Issued Document Pre-Create Info
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiget_new_issued_document_totalsPOST /c/company_id/issued_documents/totalsGet New Issued Document Totals
FattureInCloud_Ruby_Sdk::IssuedDocumentsApijoin_issued_documentsGET /c/company_id/issued_documents/joinJoin Issued Documents
FattureInCloud_Ruby_Sdk::IssuedDocumentsApilist_issued_documentsGET /c/company_id/issued_documentsList Issued Documents
FattureInCloud_Ruby_Sdk::IssuedDocumentsApimodify_issued_documentPUT /c/company_id/issued_documents/document_idModify Issued Document
FattureInCloud_Ruby_Sdk::IssuedDocumentsApischedule_emailPOST /c/company_id/issued_documents/document_id/emailSchedule Email
FattureInCloud_Ruby_Sdk::IssuedDocumentsApitransform_issued_documentGET /c/company_id/issued_documents/transformTransform Issued Document
FattureInCloud_Ruby_Sdk::IssuedDocumentsApiupload_issued_document_attachmentPOST /c/company_id/issued_documents/attachmentUpload Issued Document Attachment
FattureInCloud_Ruby_Sdk::IssuedEInvoicesApiget_e_invoice_rejection_reasonGET /c/company_id/issued_documents/document_id/e_invoice/error_reasonGet E-Invoice Rejection Reason
FattureInCloud_Ruby_Sdk::IssuedEInvoicesApiget_e_invoice_xmlGET /c/company_id/issued_documents/document_id/e_invoice/xmlGet E-Invoice XML
FattureInCloud_Ruby_Sdk::IssuedEInvoicesApisend_e_invoicePOST /c/company_id/issued_documents/document_id/e_invoice/sendSend E-Invoice
FattureInCloud_Ruby_Sdk::IssuedEInvoicesApiverify_e_invoice_xmlGET /c/company_id/issued_documents/document_id/e_invoice/xml_verifyVerify E-Invoice XML
FattureInCloud_Ruby_Sdk::ProductsApicreate_productPOST /c/company_id/productsCreate Product
FattureInCloud_Ruby_Sdk::ProductsApidelete_productDELETE /c/company_id/products/product_idDelete Product
FattureInCloud_Ruby_Sdk::ProductsApiget_productGET /c/company_id/products/product_idGet Product
FattureInCloud_Ruby_Sdk::ProductsApilist_productsGET /c/company_id/productsList Products
FattureInCloud_Ruby_Sdk::ProductsApimodify_productPUT /c/company_id/products/product_idModify Product
FattureInCloud_Ruby_Sdk::ReceiptsApicreate_receiptPOST /c/company_id/receiptsCreate Receipt
FattureInCloud_Ruby_Sdk::ReceiptsApidelete_receiptDELETE /c/company_id/receipts/document_idDelete Receipt
FattureInCloud_Ruby_Sdk::ReceiptsApiget_receiptGET /c/company_id/receipts/document_idGet Receipt
FattureInCloud_Ruby_Sdk::ReceiptsApiget_receipt_pre_create_infoGET /c/company_id/receipts/infoGet Receipt Pre-Create Info
FattureInCloud_Ruby_Sdk::ReceiptsApiget_receipts_monthly_totalsGET /c/company_id/receipts/monthly_totalsGet Receipts Monthly Totals
FattureInCloud_Ruby_Sdk::ReceiptsApilist_receiptsGET /c/company_id/receiptsList Receipts
FattureInCloud_Ruby_Sdk::ReceiptsApimodify_receiptPUT /c/company_id/receipts/document_idModify Receipt
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApicreate_received_documentPOST /c/company_id/received_documentsCreate Received Document
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApidelete_received_documentDELETE /c/company_id/received_documents/document_idDelete Received Document
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApidelete_received_document_attachmentDELETE /c/company_id/received_documents/document_id/attachmentDelete Received Document Attachment
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApiget_existing_received_document_totalsPOST /c/company_id/received_documents/document_id/totalsGet Existing Received Document Totals
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApiget_new_received_document_totalsPOST /c/company_id/received_documents/totalsGet New Received Document Totals
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApiget_received_documentGET /c/company_id/received_documents/document_idGet Received Document
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApiget_received_document_pre_create_infoGET /c/company_id/received_documents/infoGet Received Document Pre-Create Info
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApilist_received_documentsGET /c/company_id/received_documentsList Received Documents
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApimodify_received_documentPUT /c/company_id/received_documents/document_idModify Received Document
FattureInCloud_Ruby_Sdk::ReceivedDocumentsApiupload_received_document_attachmentPOST /c/company_id/received_documents/attachmentUpload Received Document Attachment
FattureInCloud_Ruby_Sdk::SettingsApicreate_payment_accountPOST /c/company_id/settings/payment_accountsCreate Payment Account
FattureInCloud_Ruby_Sdk::SettingsApicreate_payment_methodPOST /c/company_id/settings/payment_methodsCreate Payment Method
FattureInCloud_Ruby_Sdk::SettingsApicreate_vat_typePOST /c/company_id/settings/vat_typesCreate Vat Type
FattureInCloud_Ruby_Sdk::SettingsApidelete_payment_accountDELETE /c/company_id/settings/payment_accounts/payment_account_idDelete Payment Account
FattureInCloud_Ruby_Sdk::SettingsApidelete_payment_methodDELETE /c/company_id/settings/payment_methods/payment_method_idDelete Payment Method
FattureInCloud_Ruby_Sdk::SettingsApidelete_vat_typeDELETE /c/company_id/settings/vat_types/vat_type_idDelete Vat Type
FattureInCloud_Ruby_Sdk::SettingsApiget_payment_accountGET /c/company_id/settings/payment_accounts/payment_account_idGet Payment Account
FattureInCloud_Ruby_Sdk::SettingsApiget_payment_methodGET /c/company_id/settings/payment_methods/payment_method_idGet Payment Method
FattureInCloud_Ruby_Sdk::SettingsApiget_tax_profileGET /c/company_id/settings/tax_profileGet Tax Profile
FattureInCloud_Ruby_Sdk::SettingsApiget_vat_typeGET /c/company_id/settings/vat_types/vat_type_idGet Vat Type
FattureInCloud_Ruby_Sdk::SettingsApimodify_payment_accountPUT /c/company_id/settings/payment_accounts/payment_account_idModify Payment Account
FattureInCloud_Ruby_Sdk::SettingsApimodify_payment_methodPUT /c/company_id/settings/payment_methods/payment_method_idModify Payment Method
FattureInCloud_Ruby_Sdk::SettingsApimodify_vat_typePUT /c/company_id/settings/vat_types/vat_type_idModify Vat Type
FattureInCloud_Ruby_Sdk::SuppliersApicreate_supplierPOST /c/company_id/entities/suppliersCreate Supplier
FattureInCloud_Ruby_Sdk::SuppliersApidelete_supplierDELETE /c/company_id/entities/suppliers/supplier_idDelete Supplier
FattureInCloud_Ruby_Sdk::SuppliersApiget_supplierGET /c/company_id/entities/suppliers/supplier_idGet Supplier
FattureInCloud_Ruby_Sdk::SuppliersApilist_suppliersGET /c/company_id/entities/suppliersList Suppliers
FattureInCloud_Ruby_Sdk::SuppliersApimodify_supplierPUT /c/company_id/entities/suppliers/supplier_idModify Supplier
FattureInCloud_Ruby_Sdk::TaxesApicreate_f24POST /c/company_id/taxesCreate F24
FattureInCloud_Ruby_Sdk::TaxesApidelete_f24DELETE /c/company_id/taxes/document_idDelete F24
FattureInCloud_Ruby_Sdk::TaxesApidelete_f24_attachmentDELETE /c/company_id/taxes/document_id/attachmentDelete F24 Attachment
FattureInCloud_Ruby_Sdk::TaxesApiget_f24GET /c/company_id/taxes/document_idGet F24
FattureInCloud_Ruby_Sdk::TaxesApilist_f24GET /c/company_id/taxesList F24
FattureInCloud_Ruby_Sdk::TaxesApimodify_f24PUT /c/company_id/taxes/document_idModify F24
FattureInCloud_Ruby_Sdk::TaxesApiupload_f24_attachmentPOST /c/company_id/taxes/attachmentUpload F24 Attachment
FattureInCloud_Ruby_Sdk::UserApiget_user_infoGET /user/infoGet User Info
FattureInCloud_Ruby_Sdk::UserApilist_user_companiesGET /user/companiesList User Companies
FattureInCloud_Ruby_Sdk::WebhooksApicreate_webhooks_subscriptionPOST /c/company_id/subscriptionsCreate a Webhook Subscription
FattureInCloud_Ruby_Sdk::WebhooksApidelete_webhooks_subscriptionDELETE /c/company_id/subscriptions/subscription_idDelete Webhooks Subscription
FattureInCloud_Ruby_Sdk::WebhooksApiget_webhooks_subscriptionGET /c/company_id/subscriptions/subscription_idGet Webhooks Subscription
FattureInCloud_Ruby_Sdk::WebhooksApilist_webhooks_subscriptionsGET /c/company_id/subscriptionsList Webhooks Subscriptions
FattureInCloud_Ruby_Sdk::WebhooksApimodify_webhooks_subscriptionPUT /c/company_id/subscriptions/subscription_idModify Webhooks Subscription

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

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.work_reports:r: Read permission to the issued Work Reports
    • issued_documents.supplier_orders:r: Read permission to the issued Supplier Orders
    • issued_documents.self_invoices:r: Read permission to the issued Self Invoices
    • 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
    • issued_documents.work_reports:a: Write permission to the issued Work Reports
    • issued_documents.supplier_orders:a: Write permission to the issued Supplier Orders
    • issued_documents.self_invoices:a: Write permission to the issued Self Invoices
    • 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