indigit / invoicexpress
InvoiceXpress API的简单PHP封装
1.1.1
2020-06-05 18:57 UTC
Requires
- php: >=7.2.0
- ext-curl: *
- ext-json: *
- fortis/iso-currency: ^1.0
- guzzlehttp/guzzle: ~6.0
- illuminate/support: ~5.8.0|^6.0|^7.0
- laravel/helpers: ^1.1
- nesbot/carbon: ^1.26.3 || ^2.0
Requires (Dev)
- fzaninotto/faker: ^1.9
- orchestra/testbench: ^4.0
- phpunit/phpunit: 8.0
This package is auto-updated.
Last update: 2024-09-11 00:45:47 UTC
README
此包提供了一种使用InvoiceXpress API创建发票的简单方法。InvoiceXpress是葡萄牙和一些其他国家可用的计费/发票平台。在寻找一段时间后,我们没有找到任何符合我们需求的包,所以我们在这里!请注意,一些端点尚未实现,请随时推送PR。目前我们没有计划完成它们,因为我们不需要用于自己的用例。此插件包含一些Laravel依赖项和工具,但它应该可以在任何非Laravel项目上直接使用
工作端点
- 发票:通过电子邮件发送
- 发票:发送PDF
- 发票:获取/创建/更新/更改状态
- 发票:列出所有
- 发票:相关文档
- 发票:创建/取消付款收据
- 估算:尚未实现
- 指南:尚未实现
- 采购订单:尚未实现
- 客户:列出所有
- 客户:获取/创建/更新/发票
- 客户:按代码查找/按名称查找
- 项目:获取/创建/更新/删除/列出
- 序列:尚未实现
- 税项:获取/创建/更新/删除/列出
- 账户:获取/创建/更新/创建现有
安装
使用composer安装包:composer require indigit/invoicexpress
对于开发构建:composer require indigit/invoicexpress --dev
认证使用示例
每个请求都需要通过查询参数进行认证,我们已经以简单的方式做到了这一点。你应该创建一个InvoiceXpress\Auth,通过传递API密钥和账户用户名,这些可以在:账户 -> 集成 -> API找到
<?php use InvoiceXpress\Auth; use InvoiceXpress\Api\Invoice; use InvoiceXpress\Exceptions\Generic; use InvoiceXpress\Exceptions\InvalidResponse; $auth = new Auth('YOUR_ACCOUNT_NAME', 'YOUR_API_KEY'); try { # Create the base invoice Item $invoice = Invoice::get($auth, 123456, \InvoiceXpress\Entities\Invoice::DOCUMENT_TYPE_INVOICE); } catch (\Exception $e) { if ($e instanceof InvalidResponse) { dd($e->getBody(), $e->getBodyAsJson()); } elseif ($e instanceof Generic) { dd($e->getMessage(), $e->getContext()); } else { dd($e->getMessage()); } dd($e); }
使用示例
有关更多示例和了解其工作方式,请检查“示例”文件夹。
建议
1.:强烈建议使用.env文件将凭据和API密钥传递到认证对象中。永远不要在项目中以明文形式保存它。
2.:强烈建议创建某种数据库逻辑来跟踪发票类型和PK,因为InvoiceXpress API有很多文档类型。这可以通过仅在单个端点中实现一次“文档”来轻松完成
合作者
许可证
InvoiceXpress是一个开源的PHP包,根据MIT许可证授权,不能以任何方式出售或授权。