fattureincloud php sdk
v2.1.2
Подключите свое программное обеспечение к Fatture in Cloud, платформе для выставления счетов, которую выбирают более 500 000 компаний в Италии.
API Fatture in Cloud основан на REST и позволяет взаимодействовать с пользовательскими данными после предварительной авторизации по протоколу OAuth2.
Для получения дополнительной информации посетите https://www.fattureincloud.it.
PHP 7.3 и более поздние версии.
Чтобы установить привязки через Composer, выполните следующую команду:
$ composer require fattureincloud/fattureincloud-php-sdkЕсть три варианта:
require_once ( ' ./fattureincloud-php-sdk.phar ' );Пожалуйста, следуйте процедуре установки, а затем запустите следующее:
<?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 ;
}Все URI относятся к https://api-v2.fattureincloud.it.
| Сорт | Метод | HTTP-запрос | Описание |
|---|---|---|---|
| АрхивApi | СоздатьАрхивДокумент | POST /c/{company_id}/архив | Создать архивный документ |
| АрхивApi | удалитьАрхивДокумент | УДАЛИТЬ /c/{company_id}/archive/{document_id} | Удалить архивный документ |
| АрхивApi | Получить архивный документ | ПОЛУЧИТЬ /c/{company_id}/archive/{document_id} | Получить архивный документ |
| АрхивApi | списокАрхивДокументы | ПОЛУЧИТЬ /c/{company_id}/архив | Список архивных документов |
| АрхивApi | изменитьАрхивДокумент | PUT /c/{company_id}/archive/{document_id} | Изменить архивный документ |
| АрхивApi | загрузитьАрхивДокументВложение | POST /c/{company_id}/архив/вложение | Загрузить вложение архивного документа |
| CashbookApi | создатьCashbookEntry | POST /c/{company_id}/cashbook | Создать запись в кассовой книге |
| CashbookApi | удалить запись в кассовой книге | УДАЛИТЬ /c/{company_id}/cashbook/{document_id} | Удалить запись в кассовой книге |
| CashbookApi | getCashbookEntry | ПОЛУЧИТЬ /c/{company_id}/cashbook/{document_id} | Получить запись в кассовой книге |
| CashbookApi | списокКассовая книгаЗаписи | ПОЛУЧИТЬ /c/{company_id}/cashbook | Получение списка записей кассовой книги |
| CashbookApi | изменитьCashbookEntry | PUT /c/{company_id}/cashbook/{document_id} | Изменить запись в кассовой книге |
| КлиентыApi | создатьклиент | POST /c/{company_id}/entities/clients | Создать клиента |
| КлиентыApi | удалитьклиент | УДАЛИТЬ /c/{company_id}/entities/clients/{client_id} | Удалить клиента |
| КлиентыApi | getClient | GET /c/{company_id}/entities/clients/{client_id} | Получить клиента |
| КлиентыApi | списокКлиенты | ПОЛУЧИТЕ /c/{company_id}/entities/clients | Получение списка клиентов |
| КлиентыApi | изменитьКлиент | PUT /c/{company_id}/entities/clients/{client_id} | Изменить клиента |
| КомпанииApi | Получить информацию о компании | ПОЛУЧИТЬ /c/{company_id}/company/info | Получить информацию о компании |
| КомпанииApi | getCompanyPlanUsage | ПОЛУЧИТЬ /c/{company_id}/company/plan_usage | Получить использование плана компании |
| Электронная почтаApi | listEmails | ПОЛУЧИТЕ /c/{company_id}/emails | Список адресов электронной почты |
| ИнфоАпи | списокАрхивКатегории | ПОЛУЧИТЬ /c/{company_id}/info/archive_categories | Получение списка категорий архива |
| ИнфоАпи | списокГорода | ПОЛУЧИТЬ /info/cities | Список городов |
| ИнфоАпи | listCostCenters | ПОЛУЧИТЬ /c/{company_id}/info/cost_centers | Получение списка центров затрат |
| ИнфоАпи | списокСтраны | ПОЛУЧИТЬ /info/countries | Список стран |
| ИнфоАпи | списокВалюты | ПОЛУЧИТЬ /info/валюты | Список валют |
| ИнфоАпи | listDeliveryNotesDefaultCausals | ПОЛУЧИТЬ /info/dn_causals | Список причин по умолчанию для накладных |
| ИнфоАпи | списокПодробные страны | ПОЛУЧИТЬ /info/detailed_countries | Список подробных стран |
| ИнфоАпи | списокЯзыки | ПОЛУЧИТЬ /info/языки | Список языков |
| ИнфоАпи | listPaymentAccounts | ПОЛУЧИТЬ /c/{company_id}/info/pay_accounts | Получение списка платежных счетов |
| ИнфоАпи | списокПлатежные методы | ПОЛУЧИТЬ /c/{company_id}/info/pay_methods | Список способов оплаты |
| ИнфоАпи | списокКатегорииПродуктов | ПОЛУЧИТЬ /c/{company_id}/info/product_categories | Список категорий продуктов |
| ИнфоАпи | listReceivedDocumentCategories | ПОЛУЧИТЬ /c/{company_id}/info/received_document_categories | Список категорий полученных документов |
| ИнфоАпи | listRevenueCenters | ПОЛУЧИТЬ /c/{company_id}/info/revenue_centers | Список центров доходов |
| ИнфоАпи | списокШаблоны | ПОЛУЧИТЬ /информацию/шаблоны | Шаблоны списков |
| ИнфоАпи | списокUnitsOfMeasure | ПОЛУЧИТЬ /информация/меры | Список единиц измерения |
| ИнфоАпи | список типов НДС | ПОЛУЧИТЬ /c/{company_id}/info/vat_types | Перечислить типы НДС |
| Выпущенные документыApi | СоздатьIssuedDocument | POST /c/{company_id}/issued_documents | Создать выданный документ |
| Выпущенные документыApi | удалитьIssuedDocument | УДАЛИТЬ /c/{company_id}/issued_documents/{document_id} | Удалить выданный документ |
| Выпущенные документыApi | удалитьIssuedDocumentAttachment | УДАЛИТЬ /c/{company_id}/issued_documents/{document_id}/attachment | Удалить вложение выданного документа |
| Выпущенные документыApi | получить данные электронной почты | GET /c/{company_id}/issued_documents/{document_id}/email | Получить данные электронной почты |
| Выпущенные документыApi | getExistingIssuedDocumentTotals | POST /c/{company_id}/issued_documents/{document_id}/totals | Получить общее количество существующих выпущенных документов |
| Выпущенные документыApi | getIssuedDocument | GET /c/{company_id}/issued_documents/{document_id} | Получить выданный документ |
| Выпущенные документыApi | getIssuedDocumentPreCreateInfo | ПОЛУЧИТЬ /c/{company_id}/issued_documents/info | Получить информацию о предварительном создании выданного документа |
| Выпущенные документыApi | getNewIssuedDocumentTotals | POST /c/{company_id}/issued_documents/totals | Получить итоги новых выданных документов |
| Выпущенные документыApi | присоединиться к выпущенным документам | ПОЛУЧИТЬ /c/{company_id}/issued_documents/join | Присоединиться к выданным документам |
| Выпущенные документыApi | список выданных документов | ПОЛУЧИТЬ /c/{company_id}/issued_documents | Список выданных документов |
| Выпущенные документыApi | модифицироватьиссуеддокумент | PUT /c/{company_id}/issued_documents/{document_id} | Изменить выданный документ |
| Выпущенные документыApi | расписаниеЭлектронная почта | POST /c/{company_id}/issued_documents/{document_id}/email | Расписание электронной почты |
| Выпущенные документыApi | TransformIssuedDocument | GET /c/{company_id}/issued_documents/transform | Преобразование выданного документа |
| Выпущенные документыApi | загрузитьIssuedDocumentAttachment | POST /c/{company_id}/issued_documents/attachment | Загрузить вложение к выданному документу |
| ВыданоEInvoicesApi | getEInvoiceRejectionReason | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/error_reason | Получить причину отклонения э-счета |
| ВыданоEInvoicesApi | getEInvoiceXml | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml | Получить XML-счет э-счета |
| ВыданоEInvoicesApi | ОтправитьEInvoice | POST /c/{company_id}/issued_documents/{document_id}/e_invoice/send | Отправить э-счет |
| ВыданоEInvoicesApi | проверитьEInvoiceXml | GET /c/{company_id}/issued_documents/{document_id}/e_invoice/xml_verify | Проверить XML э-счета |
| ПродуктыApi | создатьпродукт | POST /c/{company_id}/products | Создать продукт |
| ПродуктыApi | удалитьпродукт | УДАЛИТЬ /c/{company_id}/products/{product_id} | Удалить продукт |
| ПродуктыApi | получить продукт | GET /c/{company_id}/products/{product_id} | Получить продукт |
| ПродуктыApi | списокПродукты | ПОЛУЧИТЬ /c/{company_id}/products | Список продуктов |
| ПродуктыApi | изменитьПродукт | PUT /c/{company_id}/products/{product_id} | Изменить продукт |
| ReceiptsApi | создать квитанцию | POST /c/{company_id}/квитанции | Создать квитанцию |
| ReceiptsApi | удалить квитанцию | УДАЛИТЬ /c/{company_id}/receipts/{document_id} | Удалить квитанцию |
| ReceiptsApi | получить квитанцию | GET /c/{company_id}/receipts/{document_id} | Получить квитанцию |
| ReceiptsApi | getReceiptPreCreateInfo | ПОЛУЧИТЬ /c/{company_id}/receipts/info | Получить информацию о предварительном создании квитанции |
| ReceiptsApi | getReceiptsMonthlyTotals | ПОЛУЧИТЬ /c/{company_id}/receipts/monthly_totals | Получайте квитанции по итогам месяца |
| ReceiptsApi | списокКвитанции | ПОЛУЧИТЬ /c/{company_id}/квитанции | Список квитанций |
| ReceiptsApi | изменить квитанцию | PUT /c/{company_id}/receipts/{document_id} | Изменить квитанцию |
| ПолученныеДокументыApi | создатьReceivedDocument | POST /c/{company_id}/received_documents | Создать полученный документ |
| ПолученныеДокументыApi | удалитьReceivedDocument | УДАЛИТЬ /c/{company_id}/received_documents/{document_id} | Удалить полученный документ |
| ПолученныеДокументыApi | удалитьReceivedDocumentAttachment | УДАЛИТЬ /c/{company_id}/received_documents/{document_id}/attachment | Удалить вложение полученного документа |
| ПолученныеДокументыApi | getExistingReceivedDocumentTotals | POST /c/{company_id}/received_documents/{document_id}/totals | Получить существующие итоговые суммы полученных документов |
| ПолученныеДокументыApi | getNewReceivedDocumentTotals | POST /c/{company_id}/received_documents/totals | Получить общее количество новых полученных документов |
| ПолученныеДокументыApi | Получить полученный документ | GET /c/{company_id}/received_documents/{document_id} | Получить полученный документ |
| ПолученныеДокументыApi | getReceivedDocumentPreCreateInfo | ПОЛУЧИТЬ /c/{company_id}/received_documents/info | Получить информацию о предварительном создании полученного документа |
| ПолученныеДокументыApi | списокПолученныхДокументов | ПОЛУЧИТЬ /c/{company_id}/received_documents | Список полученных документов |
| ПолученныеДокументыApi | изменитьReceivedDocument | PUT /c/{company_id}/received_documents/{document_id} | Изменить полученный документ |
| ПолученныеДокументыApi | загрузитьReceivedDocumentAttachment | POST /c/{company_id}/received_documents/attachment | Загрузите вложение полученного документа |
| НастройкиApi | создатьPaymentAccount | POST /c/{company_id}/settings/pay_accounts | Создать платежный счет |
| НастройкиApi | создать метод оплаты | POST /c/{company_id}/settings/pay_methods | Создать способ оплаты |
| НастройкиApi | создатьВатТип | POST /c/{company_id}/settings/vat_types | Создать тип НДС |
| НастройкиApi | удалитьPaymentAccount | УДАЛИТЬ /c/{company_id}/settings/Payment_accounts/{Payment_account_id} | Удалить платежный аккаунт |
| НастройкиApi | удалить метод оплаты | УДАЛИТЬ /c/{company_id}/settings/Payment_methods/{Payment_method_id} | Удалить способ оплаты |
| НастройкиApi | удалитьВатТип | УДАЛИТЬ /c/{company_id}/settings/vat_types/{vat_type_id} | Удалить тип НДС |
| НастройкиApi | GetPaymentAccount | GET /c/{company_id}/settings/Payment_accounts/{Payment_account_id} | Получить платежный счет |
| НастройкиApi | getPaymentMethod | GET /c/{company_id}/settings/Payment_methods/{Payment_method_id} | Получить способ оплаты |
| НастройкиApi | getTaxProfile | ПОЛУЧИТЬ /c/{company_id}/settings/tax_profile | Получить налоговый профиль |
| НастройкиApi | getVatType | ПОЛУЧИТЬ /c/{company_id}/settings/vat_types/{vat_type_id} | Получить тип НДС |
| НастройкиApi | изменитьPaymentAccount | PUT /c/{company_id}/settings/Payment_accounts/{Payment_account_id} | Изменить платежный счет |
| НастройкиApi | изменить метод оплаты | PUT /c/{company_id}/settings/Payment_methods/{Payment_method_id} | Изменить способ оплаты |
| НастройкиApi | модифицироватьВатТип | PUT /c/{company_id}/settings/vat_types/{vat_type_id} | Изменить тип НДС |
| ПоставщикиApi | создатьПоставщик | POST /c/{company_id}/entities/suppliers | Создать поставщика |
| ПоставщикиApi | удалитьПоставщик | УДАЛИТЬ /c/{company_id}/entities/suppliers/{supplier_id} | Удалить поставщика |
| ПоставщикиApi | getSupplier | GET /c/{company_id}/entities/suppliers/{supplier_id} | Получить поставщика |
| ПоставщикиApi | списокПоставщики | ПОЛУЧИТЬ /c/{company_id}/entities/suppliers | Список поставщиков |
| ПоставщикиApi | изменитьПоставщик | PUT /c/{company_id}/entities/suppliers/{supplier_id} | Изменить поставщика |
| НалогиApi | создатьF24 | POST /c/{company_id}/taxes | Создать F24 |
| НалогиApi | удалитьF24 | УДАЛИТЬ /c/{company_id}/taxes/{document_id} | Удалить F24 |
| НалогиApi | удалитьF24Вложение | УДАЛИТЬ /c/{company_id}/taxes/{document_id}/attachment | Удалить вложение F24 |
| НалогиApi | получитьF24 | GET /c/{company_id}/taxes/{document_id} | Получить F24 |
| НалогиApi | списокF24 | ПОЛУЧИТЬ /c/{company_id}/taxes | Список F24 |
| НалогиApi | изменитьF24 | PUT /c/{company_id}/taxes/{document_id} | Изменить F24 |
| НалогиApi | загрузитьF24Вложение | POST /c/{company_id}/taxes/attachment | Загрузить вложение F24 |
| Пользовательское API | getUserInfo | ПОЛУЧИТЬ /пользователь/информацию | Получить информацию о пользователе |
| Пользовательское API | список компаний-пользователей | ПОЛУЧИТЬ /пользователь/компании | Получение списка компаний-пользователей |
| ВебхуксАпи | createWebhooksподписка | POST /c/{company_id}/подписки | Создать подписку на вебхук |
| ВебхуксАпи | удалитьВебхукиПодписка | УДАЛИТЬ /c/{company_id}/subscriptions/{subscription_id} | Удалить подписку на вебхуки |
| ВебхуксАпи | getWebhooksподписка | GET /c/{company_id}/subscriptions/{subscription_id} | Получить подписку на вебхуки |
| ВебхуксАпи | listВебхукиПодписки | ПОЛУЧИТЕ /c/{company_id}/subscriptions | Получение списка подписок на вебхуки |
| ВебхуксАпи | изменитьWebhooksподписка | PUT /c/{company_id}/subscriptions/{subscription_id} | Изменить подписку на вебхуки |
OAuthaccessCodehttps://api-v2.fattureincloud.it/oauth/authorizeДля запуска тестов используйте:
composer install
vendor/bin/phpunitЭтот пакет PHP автоматически генерируется проектом OpenAPI Generator:
2.1.3org.openapitools.codegen.languages.PhpClientCodegen
