Completing Optional Installment Setup

DE Ratenzahlung
FR versements échelonnés

A number of configuration tasks is not necessarily required to enable installments. Instead, they provide additional options to complete the experience.

Controlling Installment Display

Overwriting Titles for Individual Installments and Languages

You can create installment-specific and language-specific titles for individual installments.

When using fixed installments or service period-based installments, you add additional title fields to the installment custom setting. The field names must follow a specific syntax in order to be applied by JustOn Billing & Invoice Management, as illustrated in the following examples.

Overwrite Target	Field Name	Examples
Title for the first installment	`Title1__c`	`First Installment`
Title for the first installment on German invoices	`Title1_de__c`	`Erste Rate`
Title for the last installment	`TitleLast__c`	`Last Installment`
Title for the last installment on German invoices	`TitleLast_de__c`	`Schlussrate`
Title for the fifth installment	`Title5__c`	`Fifth Installment`

When using variable installments, you use the JSON key titles to define a data map like "index" : { "language" : "value" }.

"titles": {
    "1":{
        "default":"First Installment",
        "de":"Erste Rate"
    },
    "last":{
        "default":"Last Installment",
        "de":"Schlussrate"
    },
    "5":{
        "default":"Fifth Installment"
    }
}

The following example illustrates the behavior.

(1) Invoice

Field	Value
Grand Total	`100,00`
Payment Due Date	`2017-12-31`
Installment Type	`Five by Month`

(2) Installment custom setting

Field	Value
Name	`Five by Month`
Period	`1m(5)`
Rate
Amount
Title	`Installment [PosNo]`
Title1__c	`First Installment`
TitleLast__c	`Last Installment`

(2) Custom installment JSON configuration

{
    "period": "1m(5)",
    "titles": {
        "default":{
            "default":"Installment [PosNo]"
        },
        "1":{
            "default":"First Installment"
        },
        "last":{
            "default":"Last Installment"
        }
    }
}

Resulting payment plan

Title	Date	Amount
`First Installment`	`2017-12-31`	`20,00`
`Installment 1`	`2018-01-31`	`20,00`
`Installment 2`	`2018-02-28`	`20,00`
`Installment 3`	`2018-03-31`	`20,00`
`Last Installment`	`2018-04-30`	`20,00`

Configuring Installment Table on Invoices

With an applied installment configuration, JustOn automatically prints the payment plan to the invoice PDF. There are two template fields that control the display of the corresponding installment information:

Template Field	Description
Installment Columns	Defines the columns for the installment table. Must be a list of Payment field names separated by semicolons. Defaults to `Title__c;Date__c;Amount__c`.
Installments Text	Specifies text to be rendered above the installment table.

In addition, you can modify or translate the labels for the column headers.

Modifying Installment Table Columns

To configure the contents of the installment table:

Open the template to be edited.
In the Information section, click next to the Installment Columns field and specify the installment table configuration as required.

Alternatively, you can click Edit in the detail view to edit the field.

To display the service period for service period-based installments, for example, specify
```
Title__c;ServicePeriodStart__c;ServicePeriodEnd__c;Date__c;Amount__c
```
Click Save.

Modifying Installment Table Column Headers

The template field Override Labels allows to define new labels for the fields that are displayed in the installment table. The field value is in JSON notation. For details, see Configuring Override Labels.

To modify or translate the column header labels:

Open the template to be edited.
In the Overrides section, click next to the Override Labels field and specify the override definition in JSON as required.

Alternatively, you can click Edit in the detail view to edit the field.

To define new labels for the default fields, you can use, for example:
```
{
    "Payment__c": {
        "Title__c": "Installment Payment",
        "Date__c":"Due Date",
        "Amount__c":"Due Amount"
    }
}
```
Click Save.

Specifying Installment Note

To specify a text that introduces the payment plan:

Open the template to be edited.
In the Additional Content section, click next to the Installment Text field and type the text as required.

Alternatively, you can click Edit in the detail view to edit the field.
Click Save.

Enabling Installment Creation for Single Invoices

To enable the option for individually creating or modifying a payment plan for individual invoices, you may have to manually add the Installments button to the invoice record page.

Note

When upgrading JustOn Billing & Invoice Management from a pre-2.98 version, you must remove the deprecated installments button (labeled Deprecated installments) from the layout and add the new Installments button.

Open the Invoice record detail page in the Lightning App Builder.
1. Navigate to an invoice.
2. Click to open the Setup menu, then select Edit Page.
Select the top panel ("Highlights").
Click Add Action and select the action Installments.
Click Done on the action window, then Save in the Lightning App Builder.

For details on managing action buttons, see How to hide or add action buttons?