README

Craft Commerce 2 & 3 的 Xero 插件

寻找支持 OAuth 1.0a 的旧插件？ 您可以在这里找到。

概述

此插件允许您自动将 Commerce 发票发送到 Xero，包括联系人、付款甚至库存更新。

安装

composer require thejoshsmith/commerce-xero

入门

您需要注册一个免费的 Xero 账户并添加 OAuth 2.0 Xero 应用。您可以在这里查看 Xero 的入门指南。

一旦安装了插件，您需要从“设置”导航项配置 Xero 应用连接设置。只需输入您的 Xero 应用中的客户端 ID 和密钥，然后点击保存。

注意：建议将客户端 ID 和密钥设置为 .env 文件中的环境变量

最后，需要将 OAuth 回调 URL 添加到您的 Xero 应用中，包括任何测试或生产域名。

连接组织

从“组织”导航项，点击“连接到 Xero”按钮以启动与 Xero 的连接。

由于 Xero 现在是一个多租户系统，您可以链接多个组织，并通过下拉菜单选择它们。

您可以使用“连接到 Xero”按钮连接更多组织，并使用底部的“断开连接”按钮断开当前组织。

使用下拉菜单更改当前组织将自动重新加载页面，并带有相关设置。

注意：只有当前选定的组织将与 Commerce 同步

组织设置

一旦连接到组织，插件允许您映射您的会计科目表（科目代码），包括

• 销售收入
• 应收账款
• 运输/配送
• 舍入

默认情况下，所有全额支付的订单都将被推送到队列中（您需要确保您经常处理队列），延迟时间为 30 秒（这可以减少客户等待订单处理的时间），然后一旦队列已分配作业，发票将被发送到 Xero。

如果您需要将现有订单发送到 Cero，您可以通过查看订单来实现，您会看到一个“发送到 Xero”按钮，该按钮会立即将订单发送到 Xero。此按钮目前还充当检查订单是否已在 Xero 中的方式。

发送到 Xero 的字段

以下是要发送到 Xero 的字段列表。在未来版本中，如果需要发送更多信息，将提供挂钩/事件。

联系人

• 名
• 姓
• 电子邮件

订单

• 状态（授权）
• 类型（ACCREC）
• 联系人（如上所述）
• LineAmountType（专属）（未来版本将是可配置的）
• 发票编号（订单参考）
• SentToContact（发票被标记为已发送）
• 到期日期（现在）

行项目

• 科目代码（销售）
• 描述（产品标题）
• 数量
• 单位金额（项目总额）
• 商品代码（sku）（如果启用了库存）

运输调整

• 与上述相同，但账户设置为自定义运输账户。

支付

• 账户（应收账款账户）
• 参考（订单交易参考）
• 金额（总支付金额）
• 日期（支付日期）

舍入

由于不同的系统计算舍入的方式不同，如果订单总额与Xero计算的金额不同，Xero会额外添加一行项目以计算舍入。请确保您在设置中选择了此账户代码。

更多详细文档即将推出

功能请求 🙏

由于此插件仍在积极开发中，现在是建议新功能的好时机。请随时通过电子邮件联系我或创建GitHub问题。

路线图 🚀

• 改进文档
• 配置Craft的新测试框架，以确保新功能不会引发意外问题。
• 添加多个钩子/事件，以便开发者在需要时进一步扩展
• 退款支持
• 管理员功能，如元素操作、小工具和不同的同步方法

要求

此插件需要Craft CMS 3.1.0或更高版本以及Craft Commerce 2.0 & 3.0或更高版本。