Skip to content

fattureincloud/fattureincloud-ruby-sdk

BranchesTags

Repository files navigation

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:

# 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

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

  • 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

About

Fatture in Cloud SDK (Software Development Kit) for Ruby

Topics

ruby api ruby-library ruby-gem client oauth2 sdk rest-api api-client api-rest oauth2-client typhoeus sdk-ruby fattureincloud fatturazione-elettronica fatturazione fatture-in-cloud

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

13 stars

Watchers

4 watching

Forks

0 forks
Report repository

Releases

23 tags

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages