Skip to content

Commit c20c2d9

Browse files
authored
Merge pull request #665 from reshmabidikar/avatax-aviate-documentation
Aviate integration section added
2 parents 2618d0b + ff179c2 commit c20c2d9

2 files changed

Lines changed: 34 additions & 2 deletions

File tree

userguide/tutorials/avatax-plugin.adoc

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou
6767
kpm install_java_plugin killbill-avatax --destination=<path_to_install_plugin>
6868
----
6969

70+
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.
71+
7072
== Database Configuration
7173

7274
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' \
122124
----
123125
//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
124126
127+
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.
128+
129+
[[aviate_integration]]
130+
== Aviate Integration
131+
132+
You can use the https://aviate.killbill.io/home[Aviate UI] to install/configure the plugin. Refer to the following demo:
133+
134+
++++
135+
<div>
136+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
137+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
138+
<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>
139+
</div>
140+
</div>
141+
++++
142+
125143
== Kaui Integration
126144
127145
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.
154172
//TODO
155173
//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
156174
175+
Refer to the following demo:
176+
177+
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.
178+
179+
180+
++++
181+
<div>
182+
<script async src="https://js.storylane.io/js/v2/storylane.js"></script>
183+
<div class="sl-embed" style="position:relative;padding-bottom:calc(49.85% + 25px);width:100%;height:0;transform:scale(1)">
184+
<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>
185+
</div>
186+
</div>
187+
++++
188+
157189
=== Tax Calculation by Product Tax Code
158190
159191
**What:**
@@ -205,7 +237,7 @@ https://knowledge.avalara.com/bundle/rpb1660904325464_rpb1660904325464/page/List
205237
4. https://apidocs.killbill.io/invoice#create-external-charge-s[Create an external charge] on the account
206238
5. https://apidocs.killbill.io/account#retrieve-account-invoices[Retrieve account invoices].
207239
208-
✅ **Expected Result:** The invoice corresponding to the external charge created at step 4 includes a tax item.
240+
✅ **Expected Result:** The invoice corresponding to the external charge created at step 4 is not taxed.
209241
210242
**Alternative:** You can skip Step 3 and execute Step 4 with a plugin property as follows:
211243

userguide/tutorials/braintree-plugin.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For example, to install the plugin via https://github.com/killbill/killbill-clou
2020

2121
[source,bash]
2222
----
23-
kpm install_java_plugin braintree-plugin --destination=<path_to_install_plugin>
23+
kpm install_java_plugin braintree --destination=<path_to_install_plugin>
2424
----
2525

2626
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.

0 commit comments

Comments
 (0)