README

TaxJar for Craft Commerce

本插件提供 Craft Commerce 和 TaxJar 之间的税务集成。

它取代了 Craft Commerce 内置的税务引擎，将管理税率、税务区域和税务类别的任务卸载到 TaxJar。

要求

此插件需要 Craft Commerce 5.0 或更高版本。

安装

您可以从插件商店或使用 Composer 安装此插件。

从插件商店

前往项目控制面板中的插件商店，搜索“TaxJar”。然后在它的模态窗口中点击“安装”按钮。

使用 Composer

打开您的终端并运行以下命令

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require craftcms/commerce-taxjar

# tell Craft to install the plugin
php craft install/plugin commerce-taxjar

配置 & 设置

步骤 1：配置插件

插件有两个 TaxJar API 连接设置。要设置它们，请按照以下步骤操作

在您的 .env 文件（或您管理环境变量的地方）中定义新的 TAXJAR_API_KEY 和 TAXJAR_SANDBOX 环境变量。

# Set to your TaxJar API key
TAXJAR_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Set to 0 or 1 depending on whether the sandbox API endpoint should be used
TAXJAR_SANDBOX="1"

创建一个 config/commerce-taxjar.php 文件，其中包含 apiKey 和 useSandbox 设置，这些设置将从环境变量中获取。
```
<?php

return [
    'apiKey' => getenv('TAXJAR_API_KEY'),
    'useSandbox' => (bool)getenv('TAXJAR_SANDBOX'),
];
```

步骤 2：同步您的税务类别

要同步您的税务类别与 TaxJar，请转到控制面板中的 Commerce → Tax → Tax Categories，然后点击“同步”按钮。

同步完成后，您就可以自由编辑同步的税务类别，并将它们分配给产品，就像平常一样。

警告：不要更改税务类别的处理程序，因为这将在您下次同步时导致出现重复的税务类别。

步骤 4：检查您的商店位置

转到 Commerce → Store Settings → Store Location，并确保那里的一切设置正确。插件将使用此信息来填充从 TaxJar 获取税务信息时的 from 地址。

使用方法

一旦插件配置正确，税务调整将根据订单项的税务类别自动添加到新订单中。

当 TaxJar API 被查询以获取税务信息时，完整的 API 响应将被 JSON 编码并存储在税务调整的 sourceSnapshot 值中。

功能路线图

从 TaxJar 获取购物车的实时税率。
替换 Craft Commerce 内置的税务引擎。
与 TaxJar 同步税务类别。
为报告目的与 TaxJar 同步完成的订单。
为报告和税务豁免目的与 TaxJar 同步客户。

craftcms / commerce-taxjar

维护者

详细信息