Skip to content

Commit 7e87fcd

Browse files
Merge pull request killbill#638 from reshmabidikar/update-aviate-docs
Updated aviate tax document with Storylane demo
2 parents 4ec7eca + ee6fe49 commit 7e87fcd

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

userguide/aviate/aviate-tax.adoc

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ To use the tax feature provided by the Aviate plugin, ensure that KB is started
2727
com.killbill.billing.plugin.aviate.enableTax=true
2828
----
2929

30-
In addition, the Aviate Tax feature requires some tenant-level configuration. This can be done by executing the https://killbill.github.io/slate/tenant.html#add-a-per-tenant-configuration-for-a-plugin[per-tenant configuration] endpoint as follows:
30+
In addition, the Aviate Tax feature requires some tenant-level configuration. This can be done via the Aviate UI. See https://killbill.storylane.io/share/dmenqdn2zcoy[this demo].
31+
32+
Alternatively, you can also execute the https://killbill.github.io/slate/tenant.html#add-a-per-tenant-configuration-for-a-plugin[per-tenant configuration] endpoint as follows:
3133

3234
[source, bash]
3335
----
@@ -125,6 +127,39 @@ Once the plugin is installed and tax support is enabled and configured, you can
125127
In brief, you would need to do the following:
126128

127129
1. Ensure that the aviate plugin is installed and the tax feature is enabled and configured as explained above.
128-
2. Create an account.
129-
3. Create a billing account corresponding to the account. Ensure that the billing account includes tax registrations with the appropriate country code in the address.
130-
4. Create a subscription corresponding to a product configured in Step 1. The tax invoice item will automatically be generated. See https://docs.killbill.io/latest/aviate-tax-tutorial.html[Aviate Tax Tutorial] for further details.
130+
+
131+
2. Create an account via https://apidocs.killbill.io/account#create-an-account[API] or https://docs.killbill.io/latest/userguide_kaui#create_an_account[kaui].
132+
+
133+
3. Create a billing account corresponding to the account. You can use the following API call. Ensure that the billing account includes tax registrations with the appropriate country code in the address.
134+
+
135+
[source, bash]
136+
----
137+
curl -X POST \
138+
-H "Content-Type: application/json" \
139+
-H "X-killbill-apiKey: aviate" \
140+
-H "X-killbill-apisecret: aviate" \
141+
-d '{
142+
"kbAccountId": "a0df1865-9c75-45c5-876f-cf3147c50a41",
143+
"taxRegistrations": [
144+
{
145+
"name": "John Doe",
146+
"exempt": false,
147+
"trn": "TRN-987654",
148+
"address": {
149+
"addressLine1": "123 Main Street",
150+
"addressLine2": "Suite 4B",
151+
"city": "Springfield",
152+
"state": "Illinois",
153+
"country": "US",
154+
"postalCode": "62701"
155+
}
156+
}
157+
]
158+
}' \
159+
http://127.0.0.1:8080/plugins/aviate-plugin/v1/ba
160+
----
161+
+
162+
4. Create a subscription corresponding to a product configured in Step 1. You can use https://apidocs.killbill.io/subscription#create-a-subscription[API] or https://docs.killbill.io/latest/userguide_kaui#_add_a_subscription[kaui]. The tax invoice item will automatically be generated.
163+
164+
165+
Also refer to the https://docs.killbill.io/latest/aviate-tax-tutorial.html[Aviate Tax Tutorial] for further details.

0 commit comments

Comments
 (0)