Merge pull request #537 from reshmabidikar/update-for-invoice-formatter

Doc changes for InvoiceFormatterFactory

userguide/platform/includes/killbill-configuration-properties-table.adoc

@@ -1038,3 +1038,33 @@ KB_org_killbill_cache_config_redis_password   |Redis Password   |Null   |Config
 
 KB_org_killbill_subscription_align_effectiveDateForExistingSubscriptions   |Whether to align the per-plan effectiveDateForExistingSubscriptions with the next per-subscription BCD   |false   |Per-Tenant/Config File/Environment Variable
 |===
+
+=== Translation Properties
+
+[NOTE]
+The Per-tenant properties mentioned below can be set by invoking the corresponding endpoints in the https://killbill.github.io/slate/invoice.html#translation[translation] and https://killbill.github.io/slate/invoice.html#template[template] sections in the API docs.
+
+[options="header",cols="1,1,1,1"]
+|===
+|Property Name/Environment Variable Name   |Description   |Default Value | Configuration Method
+//-------------------------------------------------
+|org.killbill.default.locale/
+
+KB_org_killbill_default_locale   |Default Killbill locale  |en_US   |Config File/Environment Variable
+|org.killbill.catalog.bundlePath/
+
+KB_org_killbill_catalog_bundlePath   |Path to the catalog translation bundle   |org/killbill/billing/util/template/translation/CatalogTranslation   |Per-tenant/Config File/Environment Variable
+|org.killbill.template.bundlePath/
+
+KB_org_killbill_template_bundlePath   |Path to the invoice template translation bundle   |org/killbill/billing/util/invoice/translation/InvoiceTranslation   |Per-tenant/Config File/Environment Variable
+|org.killbill.template.name/
+
+KB_org_killbill_template_name   |Path to the HTML invoice template   |org/killbill/billing/util/invoice/templates/HtmlInvoiceTemplate.mustache   |Per-tenant/Config File/Environment Variable
+|org.killbill.manualPayTemplate.name/
+
+KB_org_killbill_manualPayTemplate_name   |Path to the invoice template for accounts with MANUAL_PAY tag   |org/killbill/billing/util/email/templates/HtmlInvoiceTemplate.mustache   |Per-tenant/Config File/Environment Variable
+|org.killbill.template.invoiceFormatterFactoryPluginName/
+
+KB_org_killbill_template_invoiceFormatterFactoryPluginName   |Invoice formatter factory plugin name   |null   |Config File/Environment Variable
+|===
+

userguide/tutorials/invoice_templates.adoc

@@ -305,6 +305,9 @@ curl -v \
 
 image::https://github.com/killbill/killbill-docs/raw/v3/userguide/assets/img/invoice_templates/view_html_invoice.png[align=center]
 
+== Customizing Invoice Data
+
+Sometimes, you may need to customize the data in the invoice (add additional fields, custom logic for existing fields, etc.). For this, you will need to create a custom invoice formatter plugin. We have a sample plugin https://github.com/killbill/killbill-custom-invoice-formatter[here].
 
 == Further Information