alphaolomi/simplify-vfd

v0.1.0 2024-06-13 09:41 UTC

README

Latest Version on Packagist Tests Total Downloads codecov

简化 VFD 是一个用于与简化 VFD API 交互的 PHP 库。这个库提供了一个简单易用的接口,用于将 VFD 服务集成到您的 PHP 应用程序中。

特性

  • 用户认证:认证用户并获取访问令牌。
  • 发票管理:创建、检索和管理发票。
  • 环境配置:在实时和生产环境之间切换。
  • HTTP 客户端集成:使用 Guzzle HTTP 客户端进行 API 请求。
  • 自定义 GUID 生成:用于生成唯一标识符的实用函数。

安装

您可以通过 Composer 安装此包

composer require alphaolomi/simplify-vfd

配置

SimplifyVfd 类需要一个包含以下键的配置数组

  • environment:要使用的环境(livestage)。
  • username:您的 Simplify VFD 用户名。
  • password:您的 Simplify VFD 密码。

使用

初始化服务

use Alphaolomi\SimplifyVfd\SimplifyVfd;

$config = [
    'environment' => 'stage', // or 'live'
    'username' => 'your_username',
    'password' => 'your_password',
];
$service = new SimplifyVfd($config, $client);

用户登录

$data = [
    'username' => 'your_username',
    'password' => 'your_password'
];

$response = $service->userLogin($data);
print_r($response);

创建已开具发票

$data = [
    'dateTime' => date('Y-m-d'),
    'customer' => [
        'identificationType' => 'ID',
        'identificationNumber' => '1234567890',
        'vatRegistrationNumber' => '123456789',
        'name' => 'Customer Name',
        'mobileNumber' => '255123456789',
        'email' => 'customer@example.com',
    ],
    'invoiceAmountType' => 'GROSS',
    'items' => [
        [
            'itemName' => 'Product 1',
            'quantity' => 1,
            'price' => 100.00
        ]
    ],
    'payments' => [
        [
            'paymentType' => 'CASH',
            'amount' => 100.00
        ]
    ],
    'partnerInvoiceId' => 'unique-invoice-id'
];

$response = $service->createIssuedInvoice($data);
print_r($response);

根据合作伙伴发票 ID 获取发票

$partnerInvoiceId = 'unique-invoice-id';

$response = $service->getInvoiceByPartnerInvoiceId($partnerInvoiceId);
print_r($response);

测试

使用 PestPHP 进行测试,测试覆盖率由 PHPUnit 生成。Codecov 用于生成代码覆盖率报告和徽章。

composer test

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

安全漏洞

请查看我们如何报告安全漏洞的 安全策略

致谢

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件