mediabeastnz / craft-commerce-xero
Requires
- calcinai/xero-php: ^v1.8.6
- craftcms/cms: ^3.1.0
This package is auto-updated.
Last update: 2024-09-13 18:40:23 UTC
README
Craft Commerce 2 的 Xero 插件
警告:此插件已被弃用,转而使用支持 OAuth 2.0 的 Xero for Craft Commerce 2 & 3。
此插件不再维护,仅供仍在使用已弃用的 OAuth1.0a 方法连接到 Xero 的用户。
所有新的问题和拉取请求都应该在新的仓库中创建。
概览
注意:👨💻此插件稳定,可以用于生产环境,但由于它处于积极开发中,因此在新功能添加到 v1.0.0 之前,预计会有频繁的更新。
此插件允许您自动将 Commerce 发票发送到 Xero,包括联系人、付款甚至库存更新。
您需要在 Xero 中创建一个 私有应用程序,然后使用消费者密钥、消费者密钥和私有(自签名)证书通过 OAuth 连接。
您还需要一个证书存储库,可以从本仓库下载以方便使用。它是从 Firefox 的证书存储库生成的,并经常更新。见此处
连接后,插件允许您映射您的账目表(科目代码),包括
- 销售收入
- 应收账款
- 运输/交付
- 舍入
默认情况下,所有已全额付款的订单都将进入队列(您需要确保您经常处理队列),延迟 30 秒(这可以减少客户等待订单处理的时间),然后一旦队列派遣了工作,发票将被发送到 Xero。
如果您需要将现有订单发送到 Cero,可以通过查看订单来完成,您将看到一个“发送到 Xero”按钮,该按钮将立即将订单发送到 Xero。此按钮目前还充当检查订单是否已在 Xero 中的一种方式。
发送到 Xero 的字段
以下是一个发送到 Xero 的字段列表。在未来的版本中,如果需要发送更多信息,将提供钩子/事件。
联系人
- 名
- 姓
- 电子邮件
订单
- 状态(授权)
- 类型(ACCREC)
- 联系人(如上所述)
- 行金额类型(专用)(未来版本将是可配置的)
- 发票编号(订单参考)
- 发送到联系人(发票被标记为已发送)
- 到期日(现在)
行项目
- 科目代码(销售)
- 描述(产品标题)
- 数量
- 单位金额(项目总计)
- 项目代码(sku)(如果启用了库存)
运输调整
- 与上述内容相同,但账户设置为定义的运输账户。
付款
- 账户(应收账款)
- 参考(订单交易参考)
- 金额(支付总额)
- 日期(支付日期)
舍入
由于不同的系统计算舍入的方式不同,如果订单总额与 Xero 计算的结果不同,Xero 将添加一个额外的行项目以处理舍入。请确保您在设置中选择了此科目代码。
多环境设置
如果您需要针对不同环境设置不同的配置,插件附带了一个示例配置文件 xero-config.php
,您应该将其复制到您的配置文件夹中,并重命名为 xero.php
。一旦设置好了,您就可以为每个环境定义所有插件的设置。注意,如果此文件存在,所有设置都将从此文件中读取,而不是从Craft中读取。
更详细的文档即将推出。
功能请求 🙏
由于此插件仍在积极开发中,现在是提出新功能建议的好时机。请随时通过电子邮件或创建GitHub问题与我联系。
路线图 🚀
- 改进文档
- 配置Craft的新测试框架,以确保新功能不会引起意外问题。
- 添加多个钩子/事件,以便开发人员可以进一步扩展(如果需要)
- 退款支持
- 管理功能,如元素操作、小工具和不同的同步方法
安装
通过插件商店(搜索“Xero”)或通过composer进行。
"thejoshsmith/craft-commerce-xero": "^0.9.3"
要求
此插件需要Craft CMS 3.1.0或更高版本以及Craft Commerce 2.0或更高版本。