Skip to content

Aviate integration section added #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reshmabidikar wants to merge 1 commit into
base: v3
Choose a base branch
from
Open

Aviate integration section added #665

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion userguide/tutorials/avatax-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou
kpm install_java_plugin killbill-avatax --destination=<path_to_install_plugin>
----

You can also install the plugin via the https://aviate.killbill.io/home[Aviate UI] "Plugin Marketplace" tab. Refer to the <<aviate_integration, Aviate Integration>> 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:
Expand Down Expand Up @@ -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 <<aviate_integration, Aviate Integration>> 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:

++++
<div>
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/y7yketvc81ih?embed=inline" name="sl-embed" allow="fullscreen" allowfullscreen style="position:absolute;top:0;left:0;width:100%!important;height:100%!important;border:1px solid rgba(63,95,172,0.35);box-shadow: 0px 0px 18px rgba(26, 19, 72, 0.15);border-radius:10px;box-sizing:border-box;"></iframe>
</div>
</div>
++++

== 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.
Expand Down Expand Up @@ -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_<INVOICE_ITEM_ID> 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.


++++
<div>
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
<iframe loading="lazy" class="sl-demo" src="https://killbill.storylane.io/demo/ikqnmx0zqfe2?embed=inline" name="sl-embed" allow="fullscreen" allowfullscreen style="position:absolute;top:0;left:0;width:100%!important;height:100%!important;border:1px solid rgba(63,95,172,0.35);box-shadow: 0px 0px 18px rgba(26, 19, 72, 0.15);border-radius:10px;box-sizing:border-box;"></iframe>
</div>
</div>
++++

=== Tax Calculation by Product Tax Code

**What:**
Expand Down Expand Up @@ -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:

Expand Down
Loading