README ¶
FattureInCloud Go SDK
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.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 2.0.20
- Package version: 2.0.1
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.fattureincloud.it
Installation
Install the following dependencies:
go get github.com/fattureincloud/fattureincloud-go-sdk
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 |
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 | 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 | 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 the 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 |
Documentation For Models
- ArchiveDocument
- AttachmentData
- CashbookEntry
- CashbookEntryDocument
- CashbookEntryKind
- CashbookEntryType
- City
- Client
- ClientType
- Company
- CompanyInfo
- CompanyInfoAccessInfo
- CompanyInfoPlanInfo
- CompanyInfoPlanInfoFunctions
- CompanyInfoPlanInfoFunctionsStatus
- CompanyInfoPlanInfoLimits
- CompanyType
- ControlledCompany
- CreateArchiveDocumentRequest
- CreateArchiveDocumentResponse
- CreateCashbookEntryRequest
- CreateCashbookEntryResponse
- CreateClientRequest
- CreateClientResponse
- CreateF24Request
- CreateF24Response
- CreateIssuedDocumentRequest
- CreateIssuedDocumentResponse
- CreatePaymentAccountRequest
- CreatePaymentAccountResponse
- CreatePaymentMethodRequest
- CreatePaymentMethodResponse
- CreateProductRequest
- CreateProductResponse
- CreateReceiptRequest
- CreateReceiptResponse
- CreateReceivedDocumentRequest
- CreateReceivedDocumentResponse
- CreateSupplierRequest
- CreateSupplierResponse
- CreateVatTypeRequest
- CreateVatTypeResponse
- Currency
- DetailedCountry
- DocumentTemplate
- EInvoiceRejectionReason
- EmailData
- EmailDataDefaultSenderEmail
- EmailSchedule
- EmailScheduleInclude
- Entity
- EntityType
- F24
- F24Status
- FunctionStatus
- GetArchiveDocumentResponse
- GetCashbookEntryResponse
- GetClientResponse
- GetCompanyInfoResponse
- GetEInvoiceRejectionReasonResponse
- GetEmailDataResponse
- GetExistingIssuedDocumentTotalsRequest
- GetExistingIssuedDocumentTotalsResponse
- GetExistingReceivedDocumentTotalsRequest
- GetExistingReceivedDocumentTotalsResponse
- GetF24Response
- GetIssuedDocumentPreCreateInfoResponse
- GetIssuedDocumentResponse
- GetNewIssuedDocumentTotalsRequest
- GetNewIssuedDocumentTotalsResponse
- GetNewReceivedDocumentTotalsRequest
- GetNewReceivedDocumentTotalsResponse
- GetPaymentAccountResponse
- GetPaymentMethodResponse
- GetProductResponse
- GetReceiptPreCreateInfoResponse
- GetReceiptResponse
- GetReceiptsMonthlyTotalsResponse
- GetReceivedDocumentPreCreateInfoResponse
- GetReceivedDocumentResponse
- GetSupplierResponse
- GetUserInfoResponse
- GetUserInfoResponseEmailConfirmationState
- GetUserInfoResponseInfo
- GetVatTypeResponse
- IssuedDocument
- IssuedDocumentEiData
- IssuedDocumentExtraData
- IssuedDocumentItemsListItem
- IssuedDocumentOptions
- IssuedDocumentPaymentsListItem
- IssuedDocumentPaymentsListItemPaymentTerms
- IssuedDocumentPreCreateInfo
- IssuedDocumentPreCreateInfoDefaultValues
- IssuedDocumentPreCreateInfoExtraDataDefaultValues
- IssuedDocumentPreCreateInfoItemsDefaultValues
- IssuedDocumentStatus
- IssuedDocumentTotals
- IssuedDocumentType
- Language
- ListArchiveCategoriesResponse
- ListArchiveDocumentsResponse
- ListArchiveDocumentsResponsePage
- ListCashbookEntriesResponse
- ListCitiesResponse
- ListClientsResponse
- ListClientsResponsePage
- ListCostCentersResponse
- ListCountriesResponse
- ListCurrenciesResponse
- ListDeliveryNotesDefaultCausalsResponse
- ListDetailedCountriesResponse
- ListF24Response
- ListF24ResponseAggregatedData
- ListF24ResponseAggregation
- ListF24ResponsePage
- ListIssuedDocumentsResponse
- ListIssuedDocumentsResponsePage
- ListLanguagesResponse
- ListPaymentAccountsResponse
- ListPaymentMethodsResponse
- ListProductCategoriesResponse
- ListProductsResponse
- ListProductsResponsePage
- ListReceiptsResponse
- ListReceiptsResponsePage
- ListReceivedDocumentCategoriesResponse
- ListReceivedDocumentsResponse
- ListReceivedDocumentsResponsePage
- ListRevenueCentersResponse
- ListSuppliersResponse
- ListSuppliersResponsePage
- ListTemplatesResponse
- ListUnitsOfMeasureResponse
- ListUserCompaniesResponse
- ListUserCompaniesResponseData
- ListVatTypesResponse
- ModifyArchiveDocumentRequest
- ModifyArchiveDocumentResponse
- ModifyCashbookEntryRequest
- ModifyCashbookEntryResponse
- ModifyClientRequest
- ModifyClientResponse
- ModifyF24Request
- ModifyF24Response
- ModifyIssuedDocumentRequest
- ModifyIssuedDocumentResponse
- ModifyPaymentAccountRequest
- ModifyPaymentAccountResponse
- ModifyPaymentMethodRequest
- ModifyPaymentMethodResponse
- ModifyProductRequest
- ModifyProductResponse
- ModifyReceiptRequest
- ModifyReceiptResponse
- ModifyReceivedDocumentRequest
- ModifyReceivedDocumentResponse
- ModifySupplierRequest
- ModifySupplierResponse
- ModifyVatTypeRequest
- ModifyVatTypeResponse
- MonthlyTotal
- OriginalDocumentType
- Pagination
- PaymentAccount
- PaymentAccountType
- PaymentMethod
- PaymentMethodDetails
- PaymentMethodType
- PaymentTermsType
- PermissionLevel
- Permissions
- PermissionsFicIssuedDocumentsDetailed
- Product
- Receipt
- ReceiptItemsListItem
- ReceiptPreCreateInfo
- ReceiptType
- ReceivedDocument
- ReceivedDocumentEntity
- ReceivedDocumentInfo
- ReceivedDocumentInfoDefaultValues
- ReceivedDocumentInfoItemsDefaultValues
- ReceivedDocumentItemsListItem
- ReceivedDocumentPaymentsListItem
- ReceivedDocumentPaymentsListItemPaymentTerms
- ReceivedDocumentTotals
- ReceivedDocumentType
- ScheduleEmailRequest
- SendEInvoiceRequest
- SendEInvoiceRequestData
- SendEInvoiceResponse
- SendEInvoiceResponseData
- SenderEmail
- ShowTotalsMode
- Supplier
- SupplierType
- UploadArchiveAttachmentResponse
- UploadF24AttachmentResponse
- UploadIssuedDocumentAttachmentResponse
- UploadReceivedDocumentAttachmentResponse
- User
- UserCompanyRole
- VatItem
- VatKind
- VatType
- VerifyEInvoiceXmlErrorResponse
- VerifyEInvoiceXmlErrorResponseError
- VerifyEInvoiceXmlErrorResponseExtra
- VerifyEInvoiceXmlResponse
- VerifyEInvoiceXmlResponseData
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
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime
Author
Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the OpenAPI operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
APIResponse stores the API response returned by the server.
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResponse object.
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.