ramlev/economic

经济API的包装器。

v0.6-alpha 2021-05-17 07:10 UTC

This package is auto-updated.

Last update: 2024-09-17 14:35:36 UTC


README

PHP包装器,用于E-conomic REST API

此E-conomic PHP包装器支持以下选项

  1. 客户 - 创建、显示、更新、删除,并可通过可筛选选项进行筛选。
  2. 货币 - 获取所有货币,或通过货币代码获取一个,例如 "DKK"。
  3. 单位 - 创建、显示、更新、删除。
  4. 产品 - 创建、显示、更新、删除。
  5. 付款类型 - 获取所有付款类型,或通过ID获取一个。
  6. 布局 - 获取所有布局,或通过ID获取一个。
  7. 发票(草稿) - 创建带有空发票行,创建带有分配了产品的发票行,您可以预订发票。

1. 开始使用

为了使用此E-conomic包装器,您需要提供AppSecretToken和AgreementGrantToken密钥 - 以下代码将帮助您了解如何开始。

请确保设置正确的命名空间。

$economic = new Economic(
    'AppSecretToken key',
    'AgreementGrantToken key'
); 

2. 客户

有两种不同的客户对象,以下列出。

  • 客户

  • 客户集合

    2.1. 客户

    读取 - 您可以使用此对象逐个检索客户,此对象也是您创建、更新和删除特定客户时使用的对象。

    $customer = $economic
                ->customer()
                ->get('ID'); // This will give you all information about this customer.
    

    创建 - 如果要创建客户,则在进行之前需要五个属性,它们是 名称、货币、付款条款、客户组、增值税区

    $customer = $economic
                ->customer()
                ->setCurrency('DKK') // You can retrive one list with all available currencies.
                ->setName('Test Company')
                ->setPaymentTermsNumber(1)
                ->setCustomerGroupNumber(1)
                ->setVatZoneNumber(1)
                ->create();
                ->getCustomerNumber(); After you have created this customer you can retrieve its ID by doing this.
    

    更新 - 更新客户的过程几乎相同,但是您不需要提供任何属性,您可以选择更新任何属性。

    $customer = $economic
                ->customer()
                ->setName('Test Company')
                ->setCustomerGroupNumber(2)
                ->setVatZoneNumber(1)
                ->update(); // Updates customer.
    

    删除 - 您可以使用简单的方法删除任何客户。

    $customer = $economic
                ->customer()
                ->get('ID')
                ->delete(); // Deletes customer.
    

    2.2. 客户集合

    读取 - 这将为您提供所有客户的完整列表,另一个选项是您可以根据客户名称进行筛选。

    $customer = $economic
                ->customerCollection()
                ->all();
    

    筛选 - 根据可筛选属性进行筛选,如果匹配,则返回包含有关给定客户信息的对象,请确保阅读文档以了解您可以在哪些属性上进行筛选,我还建议您阅读筛选文档以了解它们支持的运算符。

    可筛选属性: https://restdocs.e-conomic.com/#customers

    筛选运算符: https://restdocs.e-conomic.com/#filtering

    $customer = $economic
                ->customerCollection()
                ->all(new Filter(['name'], ['$like:'], ['Mikkel'])); // Bear in mind you can filter on more properties, you simply add                                                                           them to the array.