fattureincloud php sdk
v2.1.2
Conecte seu software com Fatture in Cloud, a plataforma de faturamento escolhida por mais de 500.000 empresas na Itália.
A API Fatture in Cloud é baseada em REST e possibilita interagir com os dados relacionados ao usuário mediante autorização prévia via protocolo OAuth2.
Para mais informações, visite https://www.fattureincloud.it.
PHP 7.3 e posterior.
Para instalar as ligações via Composer, execute o seguinte comando:
$ composer require fattureincloud/fattureincloud-php-sdkExistem três opções:
require_once ( ' ./fattureincloud-php-sdk.phar ' );Siga o procedimento de instalação e execute o seguinte:
<?php
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 `GuzzleHttpClientInterface`.
// This is optional, `GuzzleHttpClient` will be used as default.
new GuzzleHttp Client (),
$ config
);
$ company_id = 12345 ; // int | The ID of the company.
$ create_archive_document_request = new FattureInCloud Model CreateArchiveDocumentRequest ; // FattureInCloudModelCreateArchiveDocumentRequest | 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 ;
}Todos os URIs são relativos a https://api-v2.fattureincloud.it
| Aula | Método | Solicitação HTTP | Descrição |
|---|---|---|---|
| ArquivoApi | criarArquivoDocumento | POST /c/{company_id}/archive | Criar documento de arquivo |
| ArquivoApi | excluirArchiveDocument | DELETE /c/{company_id}/archive/{document_id} | Excluir documento arquivado |
| ArquivoApi | getArchiveDocument | OBTER /c/{company_id}/archive/{document_id} | Obter documento de arquivo |
| ArquivoApi | listaArquivoDocumentos | GET /c/{company_id}/archive | Listar documentos de arquivo |
| ArquivoApi | modificarArchiveDocument | PUT /c/{company_id}/archive/{document_id} | Modificar documento arquivado |
| ArquivoApi | uploadArchiveDocumentAttachment | POST /c/{company_id}/archive/attachment | Carregar anexo de documento arquivado |
| CashbookAPI | criarCashbookEntry | POST /c/{company_id}/cashbook | Criar entrada no livro caixa |
| CashbookAPI | excluirCashbookEntry | EXCLUIR /c/{company_id}/cashbook/{document_id} | Excluir entrada do livro caixa |
| CashbookAPI | getCashbookEntry | OBTER /c/{company_id}/cashbook/{document_id} | Obter entrada no livro caixa |
| CashbookAPI | listaCashbookEntradas | GET /c/{company_id}/cashbook | Listar entradas do livro caixa |
| CashbookAPI | modificarCashbookEntry | PUT /c/{company_id}/cashbook/{document_id} | Modificar entrada do livro caixa |
| API de clientes | criarCliente | POST /c/{company_id}/entidades/clientes | Criar cliente |
| API de clientes | deletarCliente | EXCLUIR /c/{company_id}/entidades/clientes/{client_id} | Excluir cliente |
| API de clientes | getCliente | GET /c/{company_id}/entidades/clientes/{client_id} | Obter cliente |
| API de clientes | listaClientes | GET /c/{company_id}/entidades/clientes | Listar clientes |
| API de clientes | modificarCliente | PUT /c/{company_id}/entidades/clientes/{client_id} | Modificar cliente |
| API de empresas | getCompanyInfo | GET /c/{company_id}/company/info | Obtenha informações da empresa |
| API de empresas | getCompanyPlanUsage | GET /c/{company_id}/company/plan_usage | Obtenha o uso do plano da empresa |
| API de e-mails | listaE-mails | OBTER /c/{company_id}/e-mails | Listar e-mails |
| InfoAPI | listaArquivoCategorias | OBTER /c/{company_id}/info/archive_categories | Listar categorias de arquivo |
| InfoAPI | listar cidades | OBTER /informações/cidades | Listar cidades |
| InfoAPI | listaCentrosdeCusto | OBTER /c/{company_id}/info/cost_centers | Listar centros de custo |
| InfoAPI | listaPaíses | OBTER /informações/países | Listar países |
| InfoAPI | listaMoedas | GET /informações/moedas | Listar moedas |
| InfoAPI | listDeliveryNotesDefaultCausals | OBTER /info/dn_causals | Listar causas padrão de notas de entrega |
| InfoAPI | listaDetalhadoPaíses | OBTER /info/países_detalhados | Listar países detalhados |
| InfoAPI | listaIdiomas | OBTER /informações/idiomas | Listar idiomas |
| InfoAPI | listaPaymentAccounts | GET /c/{company_id}/info/payment_accounts | Listar contas de pagamento |
| InfoAPI | listaPaymentMethods | GET /c/{company_id}/info/payment_methods | Listar métodos de pagamento |
| InfoAPI | listProductCategories | OBTER /c/{company_id}/info/product_categories | Listar categorias de produtos |
| InfoAPI | listaReceivedDocumentCategories | GET /c/{company_id}/info/received_document_categories | Listar categorias de documentos recebidos |
| InfoAPI | listaRevenueCenters | OBTER /c/{company_id}/info/revenue_centers | Listar centros de receita |
| InfoAPI | listaTemplates | OBTER /informações/modelos | Modelos de lista |
| InfoAPI | listaUnitsOfMeasure | GET /informações/medidas | Listar unidades de medida |
| InfoAPI | listaVatTypes | OBTER /c/{company_id}/info/vat_types | Listar tipos de IVA |
| IssuedDocumentsApi | createIssuedDocument | POST /c/{company_id}/documentos_emitidos | Criar documento emitido |
| IssuedDocumentsApi | excluirIssuedDocument | DELETE /c/{company_id}/issued_documents/{document_id} | Excluir documento emitido |
| IssuedDocumentsApi | excluirIssuedDocumentAttachment | DELETE /c/{company_id}/issued_documents/{document_id}/attachment | Excluir anexo de documento emitido |
| IssuedDocumentsApi | getEmailData | GET /c/{company_id}/issued_documents/{document_id}/email | Obtenha dados de e-mail |
| IssuedDocumentsApi | getExistingIssuedDocumentTotals | POST /c/{company_id}/issued_documents/{document_id}/totais | Obtenha totais de documentos emitidos existentes |
| IssuedDocumentsApi | getIssuedDocument | GET /c/{company_id}/issued_documents/{document_id} | Obter documento emitido |
| IssuedDocumentsApi | getIssuedDocumentPreCreateInfo | GET /c/{company_id}/issued_documents/info | Obtenha informações de pré-criação do documento emitido |
| IssuedDocumentsApi | getNewIssuedDocumentTotals | POST /c/{company_id}/issued_documents/totals | Obtenha novos totais de documentos emitidos |
| IssuedDocumentsApi | joinIssuedDocuments | GET /c/{company_id}/issued_documents/join | Junte-se aos documentos emitidos |
| IssuedDocumentsApi | listaIssuedDocuments | GET /c/{company_id}/documentos_emitidos | Listar documentos emitidos |
| IssuedDocumentsApi | modificarIssuedDocument | PUT /c/{company_id}/issued_documents/{document_id} | Modificar documento emitido |
| IssuedDocumentsApi | agendarE-mail | POST /c/{company_id}/issued_documents/{document_id}/email | Agendar e-mail |
| IssuedDocumentsApi | transformIssuedDocument | GET /c/{company_id}/issued_documents/transform | Transformar documento emitido |
| IssuedDocumentsApi | uploadIssuedDocumentAttachment | POST /c/{company_id}/issued_documents/attachment | Carregar anexo de documento emitido |
| EInvoicesApi emitida | getEInvoiceRejectionReason | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason | Obtenha o motivo da rejeição da fatura eletrônica |
| EInvoicesApi emitida | getEInvoiceXml | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml | Obtenha o XML da fatura eletrônica |
| EInvoicesApi emitida | enviarEInvoice | POST /c/{company_id}/issued_documents/{document_id}/e_invoice/send | Enviar fatura eletrônica |
| EInvoicesApi emitida | verificarEInvoiceXml | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify | Verifique o XML da fatura eletrônica |
| API de produtos | criarProduto | POST /c/{company_id}/produtos | Criar produto |
| API de produtos | excluirProduto | EXCLUIR /c/{company_id}/produtos/{product_id} | Excluir produto |
| API de produtos | obterProduto | OBTER /c/{company_id}/produtos/{product_id} | Obter produto |
| API de produtos | listaProdutos | OBTER /c/{company_id}/produtos | Listar produtos |
| API de produtos | modificarProduto | PUT /c/{company_id}/produtos/{product_id} | Modificar produto |
| API de recibos | criarRecibo | POST /c/{company_id}/recibos | Criar recibo |
| API de recibos | excluirRecibo | EXCLUIR /c/{company_id}/receipts/{document_id} | Excluir recibo |
| API de recibos | obterRecibo | GET /c/{company_id}/receipts/{document_id} | Obter recibo |
| API de recibos | getReceiptPreCreateInfo | GET /c/{company_id}/receipts/info | Obtenha informações de pré-criação de recibo |
| API de recibos | getReceiptsMonthlyTotals | GET /c/{company_id}/receipts/monthly_totals | Obtenha totais mensais de recibos |
| API de recibos | listaRecibos | GET /c/{company_id}/recibos | Listar recibos |
| API de recibos | modificarRecibo | PUT /c/{company_id}/receipts/{document_id} | Modificar recibo |
| API de documentos recebidos | createReceivedDocument | POST /c/{company_id}/received_documents | Criar documento recebido |
| API de documentos recebidos | excluir Documento Recebido | EXCLUIR /c/{company_id}/received_documents/{document_id} | Excluir documento recebido |
| API de documentos recebidos | excluirReceivedDocumentAttachment | DELETE /c/{company_id}/received_documents/{document_id}/attachment | Excluir anexo de documento recebido |
| API de documentos recebidos | getExistingReceivedDocumentTotals | POST /c/{company_id}/received_documents/{document_id}/totais | Obtenha totais de documentos recebidos existentes |
| API de documentos recebidos | getNewReceivedDocumentTotals | POST /c/{company_id}/received_documents/totals | Obtenha novos totais de documentos recebidos |
| API de documentos recebidos | getReceivedDocument | GET /c/{company_id}/received_documents/{document_id} | Obter documento recebido |
| API de documentos recebidos | getReceivedDocumentPreCreateInfo | GET /c/{company_id}/received_documents/info | Obtenha informações de pré-criação do documento recebido |
| API de documentos recebidos | listaRecebidosDocumentos | GET /c/{company_id}/received_documents | Listar documentos recebidos |
| API de documentos recebidos | modificarReceivedDocument | PUT /c/{company_id}/received_documents/{document_id} | Modificar documento recebido |
| API de documentos recebidos | uploadReceivedDocumentAttachment | POST /c/{company_id}/received_documents/attachment | Carregar anexo de documento recebido |
| API de configurações | criarPaymentAccount | POST /c/{company_id}/settings/payment_accounts | Criar conta de pagamento |
| API de configurações | createPaymentMethod | POST /c/{company_id}/settings/payment_methods | Criar forma de pagamento |
| API de configurações | criarVatType | POST /c/{company_id}/settings/vat_types | Criar tipo de IVA |
| API de configurações | excluirPaymentAccount | EXCLUIR /c/{company_id}/settings/payment_accounts/{payment_account_id} | Excluir conta de pagamento |
| API de configurações | deletePaymentMethod | EXCLUIR /c/{company_id}/settings/payment_methods/{payment_method_id} | Excluir forma de pagamento |
| API de configurações | excluirVatType | EXCLUIR /c/{company_id}/settings/vat_types/{vat_type_id} | Excluir tipo de IVA |
| API de configurações | getPaymentAccount | GET /c/{company_id}/settings/payment_accounts/{payment_account_id} | Obter conta de pagamento |
| API de configurações | getPaymentMethod | GET /c/{company_id}/settings/payment_methods/{payment_method_id} | Obtenha a forma de pagamento |
| API de configurações | getTaxProfile | GET /c/{company_id}/settings/tax_profile | Obtenha perfil fiscal |
| API de configurações | getVatType | OBTER /c/{company_id}/settings/vat_types/{vat_type_id} | Obtenha o tipo de IVA |
| API de configurações | modificarPaymentAccount | PUT /c/{company_id}/settings/payment_accounts/{payment_account_id} | Modificar conta de pagamento |
| API de configurações | modificarPaymentMethod | PUT /c/{company_id}/settings/payment_methods/{payment_method_id} | Modificar forma de pagamento |
| API de configurações | modificarVatType | PUT /c/{company_id}/settings/vat_types/{vat_type_id} | Modificar tipo de IVA |
| FornecedoresApi | criarFornecedor | POST /c/{company_id}/entidades/fornecedores | Criar fornecedor |
| FornecedoresApi | excluir fornecedor | DELETE /c/{company_id}/entities/suppliers/{supplier_id} | Excluir fornecedor |
| FornecedoresApi | obterFornecedor | GET /c/{company_id}/entities/suppliers/{supplier_id} | Obter fornecedor |
| FornecedoresApi | listaFornecedores | GET /c/{company_id}/entidades/fornecedores | Listar fornecedores |
| FornecedoresApi | modificarFornecedor | PUT /c/{company_id}/entities/suppliers/{supplier_id} | Modificar fornecedor |
| API de impostos | criarF24 | POST /c/{company_id}/impostos | Criar F24 |
| API de impostos | excluirF24 | EXCLUIR /c/{company_id}/impostos/{document_id} | Excluir F24 |
| API de impostos | excluirF24Anexo | DELETE /c/{company_id}/taxes/{document_id}/attachment | Excluir anexo F24 |
| API de impostos | obterF24 | GET /c/{company_id}/taxes/{document_id} | Obtenha F24 |
| API de impostos | listaF24 | GET /c/{company_id}/impostos | Lista F24 |
| API de impostos | modificarF24 | PUT /c/{company_id}/impostos/{document_id} | Modificar F24 |
| API de impostos | carregarF24Anexo | POST /c/{company_id}/impostos/anexo | Carregar anexo F24 |
| API do usuário | getUserInfo | OBTER /usuário/informações | Obtenha informações do usuário |
| API do usuário | listUserCompanies | GET /usuário/empresas | Listar empresas usuárias |
| API de webhooks | criarWebhooksSubscrição | POST /c/{company_id}/subscrições | Crie uma assinatura de webhook |
| API de webhooks | excluirWebhooksSubscrição | DELETE /c/{company_id}/subscriptions/{subscription_id} | Excluir assinatura de Webhooks |
| API de webhooks | getWebhooksSubscrição | GET /c/{company_id}/subscriptions/{subscription_id} | Obtenha assinatura de Webhooks |
| API de webhooks | listaWebhooksAssinaturas | GET /c/{company_id}/subscrições | Listar assinaturas de webhooks |
| API de webhooks | modificarWebhooksSubscription | PUT /c/{company_id}/subscrições/{subscription_id} | Modificar assinatura de Webhooks |
OAuthaccessCodehttps://api-v2.fattureincloud.it/oauth/authorizePara executar os testes, use:
composer install
vendor/bin/phpunitEste pacote PHP é gerado automaticamente pelo projeto OpenAPI Generator:
2.1.3org.openapitools.codegen.languages.PhpClientCodegen
