FattureInCloud PHP SDK
Request informations
In every request description you will be able to find some additional informations about context, permissions and supported functionality:
Parameter | Description |
---|---|
|
Indicate the subject of the request. Can be company , user or accountant . |
|
If present, indicates the required scope to fulfill the request. |
|
If present, indicates which fields support the filtering feature. |
|
If present, indicates which fields support the sorting feature. |
|
If present, indicate that the results are paginated. |
|
If present, indicate that you can use field or fieldset to customize the response body. |
For example the request GET /entities/{entityRole}
have tis informations: \ entity.clients:r
or entity.suppliers:r
(depending on entityRole
) \ id
, name
\ id
, name
\
Keep in mind that if you are making company realted requests, you will need to specify the company id in the requests:
GET /c/{company_id}/issued_documents
For more information, please visit https://www.fattureincloud.it.
Installation & Usage
Requirements
PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"require": {
"fattureincloud/fattureincloud-php-sdk": "2.0.1"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/FattureInCloud PHP SDK/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: OAuth2AuthenticationCodeFlow
$config = FattureInCloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new FattureInCloud\Api\ArchiveApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$company_id = 12345; // int | The Referred Company Id.
$create_archive_document_request = {"data":{"date":"2021-08-20","category":"Altri documenti","description":"spesa 1","attachment_token":"ibfjdbf94ey9w94g3w894qbasrga"}}; // \FattureInCloud\Model\CreateArchiveDocumentRequest | The Archive Document.
try {
$result = $apiInstance->createArchiveDocument($company_id, $create_archive_document_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ArchiveApi->createArchiveDocument: ', $e->getMessage(), PHP_EOL;
}
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 | 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 | 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 |
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 | Get User Companies |
Models
- ArchiveDocument
- CashbookEntry
- CashbookEntryData
- CashbookEntryDataDocument
- CashbookEntryIn
- CashbookEntryInData
- CashbookEntryInOut
- CashbookEntryOut
- CashbookEntryOutData
- City
- Client
- Company
- CompanyInfo
- CompanyInfoAccessInfo
- CompanyInfoPlanInfo
- CompanyInfoPlanInfoFunctions
- CompanyInfoPlanInfoFunctionsStatus
- CompanyInfoPlanInfoLimits
- CreateArchiveDocumentRequest
- CreateArchiveDocumentResponse
- CreateCashbookEntryRequest
- CreateCashbookEntryResponse
- CreateClientRequest
- CreateClientResponse
- CreateF24Request
- CreateF24Response
- CreateIssuedDocumentRequest
- CreateIssuedDocumentResponse
- CreateProductRequest
- CreateProductResponse
- CreateReceiptRequest
- CreateReceiptResponse
- CreateReceivedDocumentRequest
- CreateReceivedDocumentResponse
- CreateSupplierRequest
- CreateSupplierResponse
- Currency
- DocumentTemplate
- EmailData
- EmailDataDefaultSenderEmail
- EmailDataSenderEmailsList
- EmailSchedule
- EmailScheduleInclude
- Entity
- EntityOptions
- F24
- FunctionStatus
- GetArchiveDocumentResponse
- GetCashbookEntryResponse
- GetClientResponse
- GetCompanyInfoResponse
- GetEmailDataResponse
- GetExistingIssuedDocumentTotalsRequest
- GetExistingIssuedDocumentTotalsResponse
- GetExistingReceivedDocumentTotalsRequest
- GetExistingReceivedDocumentTotalsResponse
- GetF24Response
- GetIssuedDocumentPreCreateInfoResponse
- GetIssuedDocumentResponse
- GetNewIssuedDocumentTotalsRequest
- GetNewIssuedDocumentTotalsResponse
- GetNewReceivedDocumentTotalsRequest
- GetNewReceivedDocumentTotalsResponse
- GetProductResponse
- GetReceiptPreCreateInfoResponse
- GetReceiptResponse
- GetReceiptsMonthlyTotalsResponse
- GetReceivedDocumentPreCreateInfoResponse
- GetReceivedDocumentResponse
- GetSupplierResponse
- GetUserInfoResponse
- GetUserInfoResponseEmailConfirmationState
- GetUserInfoResponseInfo
- IssuedDocument
- IssuedDocumentEiData
- IssuedDocumentExtraData
- IssuedDocumentItemsList
- IssuedDocumentPaymentsList
- IssuedDocumentPreCreateInfo
- IssuedDocumentPreCreateInfoDefaultValues
- IssuedDocumentPreCreateInfoExtraDataDefaultValues
- IssuedDocumentPreCreateInfoItemsDefaultValues
- IssuedDocumentRefersTo
- IssuedDocumentTotals
- IssuedDocumentTotalsVatList
- IssuedDocumentTotalsVatListVatItem
- IssuedDocumentType
- Language
- ListArchiveCategoriesResponse
- ListArchiveDocumentsResponse
- ListArchiveDocumentsResponsePage
- ListCashbookEntriesResponse
- ListCitiesResponse
- ListClientsResponse
- ListClientsResponsePage
- ListCostCentersResponse
- ListCountriesResponse
- ListCurrenciesResponse
- ListDeliveryNotesDefaultCausalsResponse
- ListF24Response
- ListF24ResponseAggregatedData
- ListF24ResponseAggregatedDataAggregatedData
- 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
- ModifyProductRequest
- ModifyProductResponse
- ModifyReceiptRequest
- ModifyReceiptResponse
- ModifyReceivedDocumentRequest
- ModifyReceivedDocumentResponse
- ModifySupplierRequest
- ModifySupplierResponse
- MonthlyTotal
- Pagination
- PaymentAccount
- PaymentMethod
- PaymentMethodDetails
- PermissionLevel
- Permissions
- PermissionsFicIssuedDocumentsDetailed
- Product
- Receipt
- ReceiptItemsListItem
- ReceiptPreCreateInfo
- ReceiptType
- ReceivedDocument
- ReceivedDocumentEntity
- ReceivedDocumentInfo
- ReceivedDocumentInfoDefaultValues
- ReceivedDocumentInfoItemsDefaultValues
- ReceivedDocumentItemsList
- ReceivedDocumentPaymentTerms
- ReceivedDocumentPaymentsList
- ReceivedDocumentTotals
- ReceivedDocumentType
- ScheduleEmailRequest
- SendEInvoiceRequest
- SendEInvoiceRequestData
- SendEInvoiceResponse
- SendEInvoiceResponseData
- Supplier
- UploadArchiveAttachmentResponse
- UploadF24AttachmentResponse
- UploadIssuedDocumentAttachmentResponse
- UploadIssuedDocumentAttachmentResponseData
- UploadReceivedDocumentAttachmentResponse
- UploadReceivedDocumentAttachmentResponseData
- User
- VatType
- VerifyEInvoiceXmlErrorResponse
- VerifyEInvoiceXmlErrorResponseError
- VerifyEInvoiceXmlErrorResponseExtra
- VerifyEInvoiceXmlResponse
- VerifyEInvoiceXmlSuccessResponse
- VerifyEInvoiceXmlSuccessResponseData
Authorization
OAuth2AuthenticationCodeFlow
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://api-v2.fattureincloud.it/oauth/authorize
- Scopes:
- entity.clients:r:
- entity.clients:a:
- entity.suppliers:r:
- entity.suppliers:a:
- products:r:
- products:a:
- issued_documents.invoice:r:
- issued_documents.credit_note:r:
- issued_documents.receipt:r:
- issued_documents.order:r:
- issued_documents.quote:r:
- issued_documents.proforma:r:
- issued_documents.delivery_note:r:
- issued_documents.invoice:a:
- issued_documents.credit_note:a:
- issued_documents.receipt:a:
- issued_documents.order:a:
- issued_documents.quote:a:
- issued_documents.proforma:a:
- issued_documents.delivery_note:a:
- received_documents:r:
- received_documents:a:
- stock:r:
- stock:a:
- receipts:r:
- receipts:a:
- taxes:r:
- taxes:a:
- archive:r:
- archive:a:
- cashbook:r:
- cashbook:a:
- settings:r:
- settings:a:
- situation:r:
Tests
To run the tests, use:
composer install
vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
2.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen