global with sharing class ProrationPlugin

This class contains classes and interfaces that can be used to provide a custom proration calculation method. To create a plugin, create a class which implements the ffbc.ProrationPlugin.IPolicy interface. The class ffbc.ProrationPlugin.Period will give your plugin details of the period being prorated, and the class ffbc.ProrationPlugin.BillingPeriods will give information about the whole schedule of periods for the line item being prorated.
To use your plugin, add a picklist entry matching the name of the plugin class to the ffbc__ProrationPolicy__c.ffbc__CalculationMethod__c picklist. Any proration policies where the calculation method matches that picklist entry will use your plugin.
The plugin will be called many times during billing, so we recommend not to run any SOQL or DML in the 'applyTo' method.
Also note that your plugin will only be applied to the first and last periods for any given line, and only if either of those periods are partial.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * A sample proration policy that attempts to calculate prorated price in terms of a daily rate that
 * is independent of which month is being billed.
 * To use this class, a new entry 'MyProrationPolicy' should be added to the
 * ffbc__ProrationPolicy__c.ffbc__CalculationMethod__c picklist.
 * Any proration policy that uses 'MyProrationPolicy' as its calculation method will use this plugin
 * to calculate proration.
 */
//Your plugin class must be global so that the Billing Central package can find it.
global class MyProrationPolicy implements ffbc.ProrationPlugin.IPolicy
{
    //This method will be called many times for different lines, so should not run any DML or SOQL.
    global Decimal applyTo(
        ffbc.ProrationPlugin.Period actualPeriod,
        ffbc.ProrationPlugin.BillingPeriods schedule,
        Decimal price)
    {
        return proratedPrice(actualPeriod, schedule, price);
    }

    private Decimal proratedPrice(
        ffbc.ProrationPlugin.Period actualPeriod,
        ffbc.ProrationPlugin.BillingPeriods schedule,
        Decimal price)
    {
        Integer numberOfMonths = schedule.getNumberOfMonthsPerPeriod();
        if (numberOfMonths == null)
        {
            //'getNumberOfMonthsPerPeriod' can return null for soft dates like '+50d' or 'WB' that
            //are not a constant number of months. How you handle this is up to you - you could try
            //a different calculation method, or (as in this case) just use the full price.
            return price;
        }

        /*
         * This is the code that actually calculates the price.
         * Note that this code is written to be understandable rather than to be correct -
         * in a real plugin you should not do any divisions until the very last step of the
         * calculation, to minimise rounding errors.
         */
        Decimal annualPrice = price * 12 / numberOfMonths;
        Decimal dailyPrice = annualPrice / 365;
        return dailyPrice * actualPeriod.getDays();
    }
}

global interface IPolicy

The interface for a particular calculation method. Your plugin must implement this interface.

Methods

global with sharing class Period

Represents a time period.

Properties

Methods

global with sharing class BillingPeriods

Represents a collection of all the periods for a line item that is being prorated, and the rules to determine those periods. Contains methods that are helpful when prorating a line item, such as getting the number of months per period.

Methods