fattureincloud / fattureincloud-php-sdk
将您的软件与Fatture in Cloud连接,这是意大利超过50万家企业选择的发票平台。Fatture in Cloud API基于REST,并通过OAuth2协议允许在授权之前与用户相关数据交互。
v2.1.0
2024-06-17 13:40 UTC
Requires
- php: ^7.3 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.1.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.4
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-08-28 08:58:48 UTC
README
将您的软件与Fatture in Cloud连接,这是意大利超过50万家企业选择的发票平台。
Fatture in Cloud API基于REST,并通过OAuth2协议允许在授权之前与用户相关数据交互。
欲了解更多信息,请访问https://www.fattureincloud.it。
安装与使用
要求
PHP 7.3及更高版本。
Composer
要使用Composer安装绑定,请运行以下命令
$ composer require fattureincloud/fattureincloud-php-sdk
手动安装
有三种选择
- [推荐]下载fattureincloud-php-sdk的最新版本Phar存档并将其包含到您的项目中。
require_once('./fattureincloud-php-sdk.phar');
- 使用php-download下载我们的SDK并将其包含到您的项目中。
- 创建自己的自定义自动加载器并下载所有依赖项(包括传递依赖项),具体说明请参阅此处。
入门
请按照安装过程进行操作,然后运行以下命令
<?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 `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` 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; // \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端点
所有URI均相对于https://api-v2.fattureincloud.it
模型
- ArchiveDocument
- AttachmentData
- CashbookEntry
- CashbookEntryDocument
- CashbookEntryKind
- CashbookEntryType
- City
- Client
- ClientType
- Company
- CompanyInfo
- CompanyInfoAccessInfo
- CompanyInfoPlanInfo
- CompanyInfoPlanInfoFunctions
- CompanyInfoPlanInfoFunctionsStatus
- CompanyInfoPlanInfoLimits
- CompanyPlanUsage
- 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
- CreateWebhooksSubscriptionRequest
- CreateWebhooksSubscriptionResponse
- Currency
- DetailedCountry
- DocumentTemplate
- EInvoiceRejectionReason
- EmailAttachment
- EmailData
- EmailDataDefaultSenderEmail
- EmailRecipientStatus
- EmailSchedule
- EmailScheduleInclude
- EmailStatus
- Entity
- EntityType
- EventType
- F24
- F24Status
- FattureInCloudPlanType
- FunctionStatus
- GetArchiveDocumentResponse
- GetCashbookEntryResponse
- GetClientResponse
- GetCompanyInfoResponse
- GetCompanyPlanUsageResponse
- GetEInvoiceRejectionReasonResponse
- GetEmailDataResponse
- GetExistingIssuedDocumentTotalsRequest
- GetExistingIssuedDocumentTotalsResponse
- GetExistingReceivedDocumentTotalsRequest
- GetExistingReceivedDocumentTotalsResponse
- GetF24Response
- 获取已发行文档预创建信息响应
- 获取已发行文档响应
- 获取新发行文档总计请求
- 获取新发行文档总计响应
- 获取新收到的文档总计请求
- 获取新收到的文档总计响应
- 获取支付账户响应
- 获取支付方式响应
- 获取产品响应
- 获取收据预创建信息响应
- 获取收据响应
- 获取收据月度总计响应
- 获取收到的文档预创建信息响应
- 获取收到的文档响应
- 获取供应商响应
- 获取用户信息响应
- 获取用户信息响应电子邮件确认状态
- 获取用户信息响应信息
- 获取增值税类型响应
- 获取Webhooks订阅响应
- 发行文档
- 发行文档Ei数据
- 发行文档额外数据
- 发行文档项目列表项
- 发行文档选项
- 发行文档付款列表项
- 发行文档付款列表项付款条款
- 发行文档预创建信息
- 发行文档预创建信息默认值
- 发行文档预创建信息额外数据默认值
- 发行文档预创建信息项目默认值
- 发行文档状态
- 发行文档总计
- 发行文档类型
- 加入发行文档响应
- 语言
- 列出存档类别响应
- 列出存档文档响应
- 列出存档文档响应分页
- 列出现金簿条目响应
- 列出城市响应
- 列出客户响应
- 列出客户响应分页
- 列出成本中心响应
- 列出国家响应
- 列出货币响应
- 列出交货单默认原因响应
- 列出详细国家响应
- 列出电子邮件响应
- 列出电子邮件响应分页
- 列出F24响应
- 列出F24响应聚合数据
- 列出F24响应聚合
- 列出F24响应分页
- 列出发行文档响应
- 列出发行文档响应分页
- 列出语言响应
- 列出支付账户响应
- 列出支付方式响应
- 列出产品类别响应
- 列出产品响应
- 列出产品响应分页
- 列出收据响应
- 列出收据响应分页
- 列出收到的文档类别响应
- 列出收到的文档响应
- 列出收到的文档响应分页
- 列出收入中心响应
- 列出供应商响应
- 列出供应商响应分页
- 列出模板响应
- 列出计量单位响应
- 列出用户公司响应
- 列出用户公司响应数据
- 列出增值税类型响应
- 列出Webhooks订阅响应
- 修改存档文档请求
- 修改存档文档响应
- 修改现金簿条目请求
- 修改现金簿条目响应
- 修改客户请求
- 修改客户响应
- 修改F24请求
- 修改F24响应
- 修改发行文档请求
- 修改发行文档响应
- 修改支付账户请求
- 修改支付账户响应
- 修改支付方式请求
- 修改支付方式响应
- 修改产品请求
- 修改产品响应
- 修改收据请求
- 修改收据响应
- 修改收到的文档请求
- 修改收到的文档响应
- 修改供应商请求
- 修改供应商响应
- 修改增值税类型请求
- 修改增值税类型响应
- 修改Webhooks订阅请求
- 修改Webhooks订阅响应
- 月度总计
- 原始文档类型
- 分页
- 支付账户
- 支付账户类型
- 支付方式
- 支付方式详细信息
- 支付方式类型
- 付款条款类型
- 权限级别
- 权限
- 权限Fic发行文档详细
- 产品
- 收据
- 收据项目列表项
- 收据预创建信息
- 收据类型
- 收到的文档
- 收到的文档信息
- 收到的文档信息默认值
- 收到的文档信息项目默认值
- 收到的文档项目列表项
- 收到的文档付款列表项
- 收到的文档付款列表项付款条款
- 收到的文档总计
- 收到的文档类型
- 安排电子邮件请求
- 发送电子发票请求
- 发送电子发票请求数据
- 发送电子发票请求选项
- 发送电子发票响应
- 发送电子发票响应数据
- 发送者电子邮件
- 显示总计模式
- 供应商
- 供应商类型
- 转换发行文档响应
- 上传存档附件响应
- 上传F24附件响应
- 上传发行文档附件响应
- 上传收到的文档附件响应
- 用户
- 用户公司角色
- 增值税项目
- 增值税种类
- 增值税类型
- 验证电子发票XML错误响应
- 验证电子发票XML错误响应错误
- 验证电子发票XML错误响应错误验证结果
- 验证电子发票XML错误响应额外信息
- 验证电子发票XML响应
- 验证电子发票XML响应数据
- Webhooks订阅
- Webhooks订阅配置
- Webhooks订阅映射
授权
OAuth2身份验证代码流
- 类型:
OAuth
- 流程:
accessCode
- 授权URL:
https://api-v2.fattureincloud.it/oauth/authorize
- 作用域:
- entity.clients:r: 客户注册读取权限
- entity.clients:a: 客户注册写入权限
- entity.suppliers:r: 供应商注册读取权限
- entity.suppliers:a: 供应商注册写入权限
- products:r: 产品读取权限
- products:a: 产品写入权限
- issued_documents.invoices:r: 已发出发票读取权限
- issued_documents.credit_notes:r: 已发出信用凭证读取权限
- issued_documents.receipts:r: 已发出收据读取权限
- issued_documents.orders:r: 已发出订单读取权限
- issued_documents.quotes:r: 已发出报价读取权限
- issued_documents.proformas:r: 已发出形式发票读取权限
- issued_documents.delivery_notes:r: 已发出送货单读取权限
- issued_documents.work_reports:r: 已发出工作报告读取权限
- issued_documents.supplier_orders:r: 已发出供应商订单读取权限
- issued_documents.self_invoices:r: 已发出自开发票读取权限
- issued_documents.invoices:a: 已发出发票写入权限
- issued_documents.credit_notes:a: 已发出信用凭证写入权限
- issued_documents.receipts:a: 已发出收据写入权限
- issued_documents.orders:a: 已发出订单写入权限
- issued_documents.quotes:a: 已发出报价写入权限
- issued_documents.proformas:a: 已发出形式发票写入权限
- issued_documents.delivery_notes:a: 已发出送货单写入权限
- issued_documents.work_reports:a: 已发出工作报告写入权限
- issued_documents.supplier_orders:a: 已发出供应商订单写入权限
- issued_documents.self_invoices: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: 公司情况读取权限
测试
运行测试,使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包由OpenAPI Generator项目自动生成
- API版本:
2.1.0
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen