@fattureincloud/fattureincloud-ts-sdk NPM

FattureInCloud TypeScript SDK

@fattureincloud/fattureincloud-ts-sdk - TypeScript/JavaScript client for Fatture in Cloud API.

@fattureincloud/fattureincloud-ts-sdk@2.0.14

This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.0.32
Package version: 2.0.14

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

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

Installation

For Node.js

Using npm:

npm install @fattureincloud/fattureincloud-ts-sdk

Using yarn:

yarn add @fattureincloud/fattureincloud-ts-sdk

Getting Started

Please follow the installation instruction and execute the following TS code:

import { Configuration, ArchiveApi , CreateArchiveDocumentRequest } from '@fattureincloud/fattureincloud-ts-sdk';

// Configure OAuth2 access token for authorization: 
const apiConfig = new Configuration({
  accessToken: "YOUR ACCESS TOKEN"
});

let apiInstance = new ArchiveApi(apiConfig);
let companyId = 12345; // Number | The ID of the company.

let createArchiveDocumentRequest: CreateArchiveDocumentRequest = {"data":{"date":"2021-08-20","category":"Altri documenti","description":"spesa 1","attachment_token":"ibfjdbf94ey9w94g3w894qbasrga"}} // CreateArchiveDocumentRequest | The Archive Document.

apiInstance.createArchiveDocument(companyId, createArchiveDocumentRequest).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ArchiveApi	createArchiveDocument	POST /c/{company_id}/archive	Create Archive Document
ArchiveApi	deleteArchiveDocument	DELETE /c/{company_id}/archive/{document_id}	Delete Archive Document
ArchiveApi	getArchiveDocument	GET /c/{company_id}/archive/{document_id}	Get Archive Document
ArchiveApi	listArchiveDocuments	GET /c/{company_id}/archive	List Archive Documents
ArchiveApi	modifyArchiveDocument	PUT /c/{company_id}/archive/{document_id}	Modify Archive Document
ArchiveApi	uploadArchiveDocumentAttachment	POST /c/{company_id}/archive/attachment	Upload Archive Document Attachment
CashbookApi	createCashbookEntry	POST /c/{company_id}/cashbook	Create Cashbook Entry
CashbookApi	deleteCashbookEntry	DELETE /c/{company_id}/cashbook/{document_id}	Delete Cashbook Entry
CashbookApi	getCashbookEntry	GET /c/{company_id}/cashbook/{document_id}	Get Cashbook Entry
CashbookApi	listCashbookEntries	GET /c/{company_id}/cashbook	List Cashbook Entries
CashbookApi	modifyCashbookEntry	PUT /c/{company_id}/cashbook/{document_id}	Modify Cashbook Entry
ClientsApi	createClient	POST /c/{company_id}/entities/clients	Create Client
ClientsApi	deleteClient	DELETE /c/{company_id}/entities/clients/{client_id}	Delete Client
ClientsApi	getClient	GET /c/{company_id}/entities/clients/{client_id}	Get Client
ClientsApi	listClients	GET /c/{company_id}/entities/clients	List Clients
ClientsApi	modifyClient	PUT /c/{company_id}/entities/clients/{client_id}	Modify Client
CompaniesApi	getCompanyInfo	GET /c/{company_id}/company/info	Get Company Info
CompaniesApi	getCompanyPlanUsage	GET /c/{company_id}/company/plan_usage	Get Company Plan Usage
EmailsApi	listEmails	GET /c/{company_id}/emails	List Emails
InfoApi	listArchiveCategories	GET /c/{company_id}/info/archive_categories	List Archive Categories
InfoApi	listCities	GET /info/cities	List Cities
InfoApi	listCostCenters	GET /c/{company_id}/info/cost_centers	List Cost Centers
InfoApi	listCountries	GET /info/countries	List Countries
InfoApi	listCurrencies	GET /info/currencies	List Currencies
InfoApi	listDeliveryNotesDefaultCausals	GET /info/dn_causals	List Delivery Notes Default Causals
InfoApi	listDetailedCountries	GET /info/detailed_countries	List Detailed Countries
InfoApi	listLanguages	GET /info/languages	List Languages
InfoApi	listPaymentAccounts	GET /c/{company_id}/info/payment_accounts	List Payment Accounts
InfoApi	listPaymentMethods	GET /c/{company_id}/info/payment_methods	List Payment Methods
InfoApi	listProductCategories	GET /c/{company_id}/info/product_categories	List Product Categories
InfoApi	listReceivedDocumentCategories	GET /c/{company_id}/info/received_document_categories	List Received Document Categories
InfoApi	listRevenueCenters	GET /c/{company_id}/info/revenue_centers	List Revenue Centers
InfoApi	listTemplates	GET /info/templates	List Templates
InfoApi	listUnitsOfMeasure	GET /info/measures	List Units of Measure
InfoApi	listVatTypes	GET /c/{company_id}/info/vat_types	List Vat Types
IssuedDocumentsApi	createIssuedDocument	POST /c/{company_id}/issued_documents	Create Issued Document
IssuedDocumentsApi	deleteIssuedDocument	DELETE /c/{company_id}/issued_documents/{document_id}	Delete Issued Document
IssuedDocumentsApi	deleteIssuedDocumentAttachment	DELETE /c/{company_id}/issued_documents/{document_id}/attachment	Delete Issued Document Attachment
IssuedDocumentsApi	getEmailData	GET /c/{company_id}/issued_documents/{document_id}/email	Get Email Data
IssuedDocumentsApi	getExistingIssuedDocumentTotals	POST /c/{company_id}/issued_documents/{document_id}/totals	Get Existing Issued Document Totals
IssuedDocumentsApi	getIssuedDocument	GET /c/{company_id}/issued_documents/{document_id}	Get Issued Document
IssuedDocumentsApi	getIssuedDocumentPreCreateInfo	GET /c/{company_id}/issued_documents/info	Get Issued Document Pre-Create Info
IssuedDocumentsApi	getNewIssuedDocumentTotals	POST /c/{company_id}/issued_documents/totals	Get New Issued Document Totals
IssuedDocumentsApi	joinIssuedDocuments	GET /c/{company_id}/issued_documents/join	Join Issued Documents
IssuedDocumentsApi	listIssuedDocuments	GET /c/{company_id}/issued_documents	List Issued Documents
IssuedDocumentsApi	modifyIssuedDocument	PUT /c/{company_id}/issued_documents/{document_id}	Modify Issued Document
IssuedDocumentsApi	scheduleEmail	POST /c/{company_id}/issued_documents/{document_id}/email	Schedule Email
IssuedDocumentsApi	transformIssuedDocument	GET /c/{company_id}/issued_documents/transform	Transform Issued Document
IssuedDocumentsApi	uploadIssuedDocumentAttachment	POST /c/{company_id}/issued_documents/attachment	Upload Issued Document Attachment
IssuedEInvoicesApi	getEInvoiceRejectionReason	GET /c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason	Get E-Invoice Rejection Reason
IssuedEInvoicesApi	getEInvoiceXml	GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml	Get E-Invoice XML
IssuedEInvoicesApi	sendEInvoice	POST /c/{company_id}/issued_documents/{document_id}/e_invoice/send	Send E-Invoice
IssuedEInvoicesApi	verifyEInvoiceXml	GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify	Verify E-Invoice XML
ProductsApi	createProduct	POST /c/{company_id}/products	Create Product
ProductsApi	deleteProduct	DELETE /c/{company_id}/products/{product_id}	Delete Product
ProductsApi	getProduct	GET /c/{company_id}/products/{product_id}	Get Product
ProductsApi	listProducts	GET /c/{company_id}/products	List Products
ProductsApi	modifyProduct	PUT /c/{company_id}/products/{product_id}	Modify Product
ReceiptsApi	createReceipt	POST /c/{company_id}/receipts	Create Receipt
ReceiptsApi	deleteReceipt	DELETE /c/{company_id}/receipts/{document_id}	Delete Receipt
ReceiptsApi	getReceipt	GET /c/{company_id}/receipts/{document_id}	Get Receipt
ReceiptsApi	getReceiptPreCreateInfo	GET /c/{company_id}/receipts/info	Get Receipt Pre-Create Info
ReceiptsApi	getReceiptsMonthlyTotals	GET /c/{company_id}/receipts/monthly_totals	Get Receipts Monthly Totals
ReceiptsApi	listReceipts	GET /c/{company_id}/receipts	List Receipts
ReceiptsApi	modifyReceipt	PUT /c/{company_id}/receipts/{document_id}	Modify Receipt
ReceivedDocumentsApi	createReceivedDocument	POST /c/{company_id}/received_documents	Create Received Document
ReceivedDocumentsApi	deleteReceivedDocument	DELETE /c/{company_id}/received_documents/{document_id}	Delete Received Document
ReceivedDocumentsApi	deleteReceivedDocumentAttachment	DELETE /c/{company_id}/received_documents/{document_id}/attachment	Delete Received Document Attachment
ReceivedDocumentsApi	getExistingReceivedDocumentTotals	POST /c/{company_id}/received_documents/{document_id}/totals	Get Existing Received Document Totals
ReceivedDocumentsApi	getNewReceivedDocumentTotals	POST /c/{company_id}/received_documents/totals	Get New Received Document Totals
ReceivedDocumentsApi	getReceivedDocument	GET /c/{company_id}/received_documents/{document_id}	Get Received Document
ReceivedDocumentsApi	getReceivedDocumentPreCreateInfo	GET /c/{company_id}/received_documents/info	Get Received Document Pre-Create Info
ReceivedDocumentsApi	listReceivedDocuments	GET /c/{company_id}/received_documents	List Received Documents
ReceivedDocumentsApi	modifyReceivedDocument	PUT /c/{company_id}/received_documents/{document_id}	Modify Received Document
ReceivedDocumentsApi	uploadReceivedDocumentAttachment	POST /c/{company_id}/received_documents/attachment	Upload Received Document Attachment
SettingsApi	createPaymentAccount	POST /c/{company_id}/settings/payment_accounts	Create Payment Account
SettingsApi	createPaymentMethod	POST /c/{company_id}/settings/payment_methods	Create Payment Method
SettingsApi	createVatType	POST /c/{company_id}/settings/vat_types	Create Vat Type
SettingsApi	deletePaymentAccount	DELETE /c/{company_id}/settings/payment_accounts/{payment_account_id}	Delete Payment Account
SettingsApi	deletePaymentMethod	DELETE /c/{company_id}/settings/payment_methods/{payment_method_id}	Delete Payment Method
SettingsApi	deleteVatType	DELETE /c/{company_id}/settings/vat_types/{vat_type_id}	Delete Vat Type
SettingsApi	getPaymentAccount	GET /c/{company_id}/settings/payment_accounts/{payment_account_id}	Get Payment Account
SettingsApi	getPaymentMethod	GET /c/{company_id}/settings/payment_methods/{payment_method_id}	Get Payment Method
SettingsApi	getVatType	GET /c/{company_id}/settings/vat_types/{vat_type_id}	Get Vat Type
SettingsApi	modifyPaymentAccount	PUT /c/{company_id}/settings/payment_accounts/{payment_account_id}	Modify Payment Account
SettingsApi	modifyPaymentMethod	PUT /c/{company_id}/settings/payment_methods/{payment_method_id}	Modify Payment Method
SettingsApi	modifyVatType	PUT /c/{company_id}/settings/vat_types/{vat_type_id}	Modify Vat Type
SuppliersApi	createSupplier	POST /c/{company_id}/entities/suppliers	Create Supplier
SuppliersApi	deleteSupplier	DELETE /c/{company_id}/entities/suppliers/{supplier_id}	Delete Supplier
SuppliersApi	getSupplier	GET /c/{company_id}/entities/suppliers/{supplier_id}	Get Supplier
SuppliersApi	listSuppliers	GET /c/{company_id}/entities/suppliers	List Suppliers
SuppliersApi	modifySupplier	PUT /c/{company_id}/entities/suppliers/{supplier_id}	Modify Supplier
TaxesApi	createF24	POST /c/{company_id}/taxes	Create F24
TaxesApi	deleteF24	DELETE /c/{company_id}/taxes/{document_id}	Delete F24
TaxesApi	deleteF24Attachment	DELETE /c/{company_id}/taxes/{document_id}/attachment	Delete F24 Attachment
TaxesApi	getF24	GET /c/{company_id}/taxes/{document_id}	Get F24
TaxesApi	listF24	GET /c/{company_id}/taxes	List F24
TaxesApi	modifyF24	PUT /c/{company_id}/taxes/{document_id}	Modify F24
TaxesApi	uploadF24Attachment	POST /c/{company_id}/taxes/attachment	Upload F24 Attachment
UserApi	getUserInfo	GET /user/info	Get User Info
UserApi	listUserCompanies	GET /user/companies	List User Companies
WebhooksApi	createWebhooksSubscription	POST /c/{company_id}/subscriptions	Create a Webhook Subscription
WebhooksApi	deleteWebhooksSubscription	DELETE /c/{company_id}/subscriptions/{subscription_id}	Delete Webhooks Subscription
WebhooksApi	getWebhooksSubscription	GET /c/{company_id}/subscriptions/{subscription_id}	Get Webhooks Subscription
WebhooksApi	listWebhooksSubscriptions	GET /c/{company_id}/subscriptions	List Webhooks Subscriptions
WebhooksApi	modifyWebhooksSubscription	PUT /c/{company_id}/subscriptions/{subscription_id}	Modify Webhooks Subscription

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.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