diff --git a/userguide/tutorials/avatax-plugin.adoc b/userguide/tutorials/avatax-plugin.adoc index 3dc28c356..c43030451 100644 --- a/userguide/tutorials/avatax-plugin.adoc +++ b/userguide/tutorials/avatax-plugin.adoc @@ -67,6 +67,8 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou kpm install_java_plugin killbill-avatax --destination= ---- +You can also install the plugin via the https://aviate.killbill.io/home[Aviate UI] "Plugin Marketplace" tab. Refer to the <> section below for more details. + == Database Configuration The AvaTax plugin requires some additional database tables. To create these tables, please follow the steps given below: @@ -122,6 +124,22 @@ org.killbill.billing.plugin.avatax.licenseKey=ZZZ' \ ---- //TODO: Properties for TaxRatesAPI are not included as I can no longer find any documentation for this in the Avalara docs. Check if the TaxRates API works and if so include these properties +Alternatively, you can also configure these properties via the https://aviate.killbill.io/home[Aviate UI] "Plugin Configuration" tab. Refer to the <> section below for more details. + +[[aviate_integration]] +== Aviate Integration + +You can use the https://aviate.killbill.io/home[Aviate UI] to install/configure the plugin. Refer to the following demo: + +++++ +
+ +
+ +
+
+++++ + == Kaui Integration An https://github.com/killbill/killbill-avatax-ui[Avatax Rails Mountable Engine] is available. This allows you to configure the plugin, configure the product tax codes, and set account exemptions via Kaui. The UI becomes available in Kaui once the AvaTax plugin is installed and can be accessed by clicking the plug icon in Kaui. Refer to the https://docs.killbill.io/latest/userguide_kaui#avatax[Kaui Guide] for further details. @@ -154,6 +172,20 @@ geographic location. //TODO //As per readme, You can also specify a location code per invoice line item by passing the property locationCode_ as a plugin property. Find out how to do this and add documentation for this here +Refer to the following demo: + +NOTE: A demo is included for this section as tax calculation by zip code is the most common use case. For other features, follow the testing steps in each subsection. + + +++++ +
+ +
+ +
+
+++++ + === Tax Calculation by Product Tax Code **What:** @@ -205,7 +237,7 @@ https://knowledge.avalara.com/bundle/rpb1660904325464_rpb1660904325464/page/List 4. https://apidocs.killbill.io/invoice#create-external-charge-s[Create an external charge] on the account 5. https://apidocs.killbill.io/account#retrieve-account-invoices[Retrieve account invoices]. -✅ **Expected Result:** The invoice corresponding to the external charge created at step 4 includes a tax item. +✅ **Expected Result:** The invoice corresponding to the external charge created at step 4 is not taxed. **Alternative:** You can skip Step 3 and execute Step 4 with a plugin property as follows: