Overview
The Settings screen groups the configuration that applies to a single tenant. It is reached from Configuration → Settings in the left navigation.
Settings are scoped to the tenant of the currently selected deployment. Switching deployments reloads the screen with that tenant’s values.
The Organization tab holds your company details and branding, and is described in full below. The remaining tabs expose Kill Bill per-tenant configuration properties.
Organization
The Organization tab defines who you are as a business. The values entered here apply by default to invoices, emails, and quotes, so that customer-facing documents carry consistent company details and branding.
Company Information
| Field | Description |
|---|---|
Company name |
The legal or trading name of your business. |
Company address |
Street address of your business. |
City, province, postal code |
Remainder of the postal address, entered as a single line. |
Company country |
Country of your business, selected from a list of ISO countries. |
Company URL |
Your company website. If no protocol is entered, |
Logo and Brand Color
The Organization tab also lets you upload a company logo and choose a primary brand color. The logo appears on invoice and email documents, and the brand color is used for styling elements such as invoice table headings.
How These Values Are Used
Organization settings act as the defaults for customer-facing documents. Individual invoice templates and email templates can define their own values, in which case those take precedence.
The resolution order is:
-
The template-level override, if one is defined.
-
The Organization setting.
-
The built-in default.
This means you can set your company details once on the Organization tab, and only override them where a specific template needs something different.
Saving Changes
Save becomes active as soon as you change a value. Company information, brand color, and logo are saved independently, so changing one does not rewrite the others. Use Reset to discard unsaved changes and restore the values currently stored.
|
Note
|
On the first save, values still at their defaults are written as well, so that the stored configuration matches what the screen shows. |
Configuration Tabs
The remaining tabs edit Kill Bill configuration properties for the selected tenant. Rather than repeating the property list here, each field on screen shows the underlying system key (for example org.killbill.invoice.maxNumberOfMonthsInFuture), which you can look up in the Kill Bill Configuration Guide for its meaning, default value, and how else it can be set.
Where a Value Comes From
Kill Bill resolves a property from several layers. Each field carries a badge showing the layer the value currently in effect came from:
| Badge | Meaning |
|---|---|
Default |
The built-in Kill Bill default; nothing has overridden it. |
Runtime |
The value comes from the runtime configuration. |
Environment |
The value comes from an environment variable. |
Tenant |
A per-tenant value has been set for this tenant. |
Saving a change on one of these tabs writes a per-tenant value, which takes precedence over the global configuration.
System-Level Properties
Not every Kill Bill property can be set per tenant. Properties that cannot are listed on the tab under System-Level Properties and are shown read-only: they are configured at the system level during deployment, through the Kill Bill properties file or environment variables.
Available Tabs
| Tab | Corresponding section of the Configuration Guide |
|---|---|
Invoices |
|
Payments |
|
Payment Retry |
Payment Properties (retry schedule) |
Push Notifications |
|
Events |
|
Subscriptions |
|
Catalog |
|
JAX-RS |
|
Server |
|
Database |
|
Read-Only Database |
|
OSGI |
|
OSGI Database |
|
Security |
Setting Per-Tenant Properties via the API
Per-tenant properties can also be set outside the UI, using the uploadPerTenantConfig endpoint. Refer to the Kill Bill Configuration Guide for details and for the full list of properties.
|
Note
|
Each call to that endpoint overwrites the previous per-tenant properties, so the full list must be supplied every time. |
Related
-
Getting Started with Aviate and Kaui - initial setup, including organization settings
-
Kill Bill Configuration Guide - all configuration properties and the ways they can be set