Skip to content

README.md

Latest commit

 

History

History
53 lines (38 loc) · 2.1 KB

README.md

File metadata and controls

53 lines (38 loc) · 2.1 KB

Vertex plugin

Kill Bill tax plugin for Vertex using Vertex Indirect Tax O Series REST APIs v2.

This integration delegates computation of sales taxes to Vertex, which will appear directly on Kill Bill invoices.

Release builds are available on Maven Central with coordinates org.kill-bill.billing.plugin.java:vertex-plugin.

Kill Bill compatibility

Plugin version Kill Bill version
0.1.y 0.22.z
0.2.y 0.24.z

Requirements

The plugin needs a database. The latest version of the schema can be found here.

Configuration

The following properties are required:

  • org.killbill.billing.plugin.vertex.url: Vertex api base url
  • org.killbill.billing.plugin.vertex.clientId: Vertex client id
  • org.killbill.billing.plugin.vertex.clientSecret: Vertex client secret

The following properties are optional:

  • org.killbill.billing.plugin.vertex.companyName: company name
  • org.killbill.billing.plugin.vertex.companyDivision: company division
  • org.killbill.billing.plugin.vertex.adjustments.lenientMode: when true, Vertex-plugin will skip adjustment items if previousInvoiceId is missing. Otherwise, an IllegalStateException is thrown, and invoice generation is aborted

These properties can be specified globally via System Properties or on a per tenant basis:

curl -v \
     -X POST \
     -u admin:password \
     -H 'X-Killbill-ApiKey: bob' \
     -H 'X-Killbill-ApiSecret: lazar' \
     -H 'X-Killbill-CreatedBy: admin' \
     -H 'Content-Type: text/plain' \
     -d 'org.killbill.billing.plugin.vertex.url=XXX
org.killbill.billing.plugin.vertex.clientId=YYY
org.killbill.billing.plugin.vertex.clientSecret=ZZZ' \
     http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-vertex