Skip to content

Commit 49e4052

Browse files
Merge pull request killbill#621 from reshmabidikar/work-for-ts-109
Avatax Userguide - First Draft
2 parents 8978517 + 9024f95 commit 49e4052

12 files changed

+879
-1
lines changed

html5/_main_toc.html.slim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ nav.sidebar-nav
7777
li
7878
a.nav-link href="/latest/userguide_analytics.html"
7979
| Analytics Plugin
80+
li
81+
a.nav-link href="/latest/avatax-plugin.html"
82+
| AvaTax Plugin
8083
li
8184
a.nav-link href="/latest/userguide_configuration.html"
8285
| Kill Bill 
18.7 KB
Loading
56.6 KB
Loading
23.6 KB
Loading
70.3 KB
Loading
25.4 KB
Loading
19.5 KB
Loading
163 KB
Loading
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
=== Overview
2+
3+
The AvaTax UI is only available after the https://github.com/killbill/killbill-avatax-plugin[AvaTax Plugin] has been deployed.
4+
5+
The UI allows you to configure the plugin, configure the product tax codes, and set account exemptions via Kaui.
6+
7+
=== Accessing the UI
8+
9+
The AvaTax UI can be accessed by clicking the plug icon in Kaui.
10+
11+
image::../assets/img/kaui/avatax-link.png[width=850,align="center"]
12+
13+
This displays the AvaTax UI:
14+
15+
image::../assets/img/kaui/avatax-ui.png[width=850,align="center"]
16+
17+
=== Plugin Configuration
18+
19+
The AvaTax UI allows configuring the AvaTax Plugin.
20+
21+
1. Open the AvaTax UI and click on the "Plugin Configuration" link.
22+
Kaui opens the AvaTax Plugin Configuration UI:
23+
+
24+
image::../assets/img/kaui/avatax-plugin-configuration.png[width=850,align="center"]
25+
+
26+
2. Enter appropriate values and click the "Save" button.
27+
28+
=== Configuring Product Codes
29+
30+
The AvaTax UI allows configuring product https://developer.avalara.com/avatax/dev-guide/product-taxability[tax codes].
31+
32+
1. Open the AvaTax UI and click on the "+" symbol next to "Configured Products".
33+
Kaui opens the "Configure Product" UI:
34+
+
35+
image::../assets/img/kaui/avatax-product-configuration.png[width=850,align="center"]
36+
+
37+
2. Select the desired product from the catalog and enter the appropriate https://developer.avalara.com/avatax/dev-guide/product-taxability[Avalara tax code].(The complete list of Avalara Tax Codes is available https://taxcode.avatax.avalara.com/[here].)
38+
3. Click on the "Save" button.
39+
4. To delete a tax code, click the "x" next to the appropriate item.
40+
+
41+
image::../assets/img/kaui/avatax-delete-product-code.png[width=850,align="center"]
42+
43+
=== Account Exemptions
44+
45+
The AvaTax UI allows configuring account exemptions.
46+
47+
1. Open the AvaTax UI and click on the "+" symbol next to "Exempt Accounts".
48+
Kaui opens the "Account Exemption" UI:
49+
+
50+
image::../assets/img/kaui/avatax-account-exemption.png[width=850,align="center"]
51+
+
52+
2. Enter the desired account id and the appropriate Avalara exemption code (A full list of exemption codes is available
53+
https://knowledge.avalara.com/bundle/rpb1660904325464_rpb1660904325464/page/List_of_entity_use_codes.html[here]).
54+
3. Click on the "Save" button.
55+
4. To delete an account exemption, click the "x" next to the appropriate item.
56+
+
57+
image::../assets/img/kaui/avatax-delete-account-exemption.png[width=850,align="center"]

userguide/kaui/userguide_kaui.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,8 @@ include::{sourcedir}/kaui/includes/analytics.adoc[]
199199
//include::includes/faqs.adoc[]
200200
201201
//________________________________________________//
202+
203+
[[analytics]]
204+
== AvaTax
205+
206+
include::{sourcedir}/kaui/includes/avatax.adoc[]

0 commit comments

Comments
 (0)