global static ffrr.CalculationService.Calculation calculateDeliverable(Decimal totalRevenue, Decimal prevRecognized)

Calculates revenue for a Deliverable recognition method using the supplied total revenue and previously recognized values.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//Call the method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateDeliverable(2000.00, 250.00);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateEqualSplit(Decimal totalRevenue, Decimal prevRecognized, Date startDate, Date endDate, Date recognitionDate)

Calculates revenue for an Equal Split recognition method and a calculation type of Months using the supplied values. The results are calculated on whole months.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//Setup the dates involved
Date startDate = Date.newInstance(2013, 01, 01);
Date endDate = Date.newInstance(2013, 12, 31);
Date recognitionDate = Date.newInstance(2013, 01, 05);

//Call the method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateEqualSplit(1200.00, 50.00, startDate, endDate, recognitionDate);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateEqualSplit445(Decimal totalRevenue, Decimal prevRecognized, Date startDate, Date endDate, Date recognitionDate)

Calculates revenue for an Equal Split recognition method and a 445 calculation type using the supplied values. The results are calculated using the 445 recognition periods and years defined in the system.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//This sample requires that Revenue Recognition years and periods exist within
//the system as, without them, calculations that rely on periods cannot be performed.

//Setup the dates involved
Date startDate = Date.newInstance(2013, 01, 01);
Date endDate = Date.newInstance(2013, 12, 31);
Date recognitionDate = Date.newInstance(2013, 01, 05);

//Actually call the calculateEqualSplit445 method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateEqualSplit445(1200.00, 50.00, startDate, endDate, recognitionDate);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateEqualSplitDays(Decimal totalRevenue, Decimal prevRecognized, Date startDate, Date endDate, Date recognitionDate)

Calculates revenue for an Equal Split recognition method and a calculation type of Days using the supplied values. The results are calculated according to the number of days between the specified start and recognition dates and the mean value per day between the specified start and end dates.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//This sample requires that Revenue Recognition years and periods exist within
//the system as, without them, calculations that rely on periods cannot be performed.

//Setup the dates involved
Date startDate = Date.newInstance(2013, 01, 01);
Date endDate = Date.newInstance(2013, 12, 31);
Date recognitionDate = Date.newInstance(2013, 01, 05);

//Call the method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateEqualSplitDays(1200.00, 50.00, startDate, endDate, recognitionDate);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateEqualSplitMonthsPartPeriods(Decimal totalRevenue, Decimal prevRecognized, Date startDate, Date endDate, Date recognitionDate)

Calculates revenue for an Equal Split recognition method and a calculation type of Months/Part Periods using the supplied values. The results are calculated using both whole and part months/periods.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//This sample requires that Revenue Recognition years and periods exist within
//the system as, without them, calculations that rely on periods cannot be performed.

//Setup the dates involved
Date startDate = Date.newInstance(2013, 01, 01);
Date endDate = Date.newInstance(2013, 12, 31);
Date recognitionDate = Date.newInstance(2013, 01, 05);

//Actually call the calculateEqualSplitMonthsPartPeriods method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateEqualSplitMonthsPartPeriods(1200.00, 50.00, startDate, endDate, recognitionDate);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateEqualSplitMonthsPartPeriodsWithProratedPartPeriods(Decimal totalRevenue, Decimal prevRecognized, Date startDate, Date endDate, Date recognitionDate)

Calculates revenue for an Equal Split Months / Actual Days in Part Periods recognition method and a calculation type of Months / Actual Days in Part Periods using the supplied values. The results are calculated using both whole and part months/periods.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//This sample requires that Revenue Recognition years and periods exist within
//the system as, without them, calculations that rely on periods cannot be performed.

//Setup the dates involved
Date startDate = Date.newInstance(2021, 01, 16);
Date endDate = Date.newInstance(2021, 09, 05);
Date recognitionDate = Date.newInstance(2021, 01, 31);

//Actually call the calculateEqualSplitMonthsPartPeriodsWithProratedPartPeriods method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateEqualSplitMonthsPartPeriodsWithProratedPartPeriods(1000.00, 50.00, startDate, endDate, recognitionDate);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculatePercentageComplete(Decimal totalRevenue, Decimal prevRecognized, Decimal percentageComplete)

Calculates revenue for a % Complete recognition method using the supplied values. The results are calculated as a percentage of the total revenue.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//Call the method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculatePercentageComplete(1200.00, 50.00, 50.00);

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Calculation calculateRevenue(SObject record, Date recognitionDate, String currencyFilter)

Calculates revenue based on the template associated with the supplied record. The method will automatically extract the required values based on the record's template, determine the calculation type involved, validate any needed data and perform the calculation.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Calculation object.

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.

//Note: This sample requires that a complete set of Recognition Settings, Recognition Templates, and Recognition
//Years and Periods (covering the year 2013) are available within the system. For the
//purposes of this example it is assumed that we are using an ffrr__PerformanceObligation__c record which is
//correctly connected to a valid Template. You can put any source record here.

//The item that we'll be calculating revenue for. You would use your SObject here.
SObject mySourceObject =
    [
        SELECT Id, Name, ffrr__ffrrTemplate__c, ffrr__StartDate__c, ffrr__EndDate__c, ffrr__Revenue__c
        FROM ffrr__PerformanceObligation__c LIMIT 1
    ];

//Note: The mySourceObject needs to be populated at this point. *How* it is populated,
//naturally, depends on the object type etc. but the extracted record must include the
//ffrrTemplate__c field and any required fields based on that template.
//For example, if the recognition template is of type '% Complete', then the 'Complete' field must be included

//Setup the recognition date that we'll be using
Date recognitionDate = Date.newInstance(2013, 01, 05);

//Call the method
ffrr.CalculationService.Calculation revenueRecord = ffrr.CalculationService.calculateRevenue(mySourceObject, recognitionDate, 'USD');

//Output the results that came back
System.debug('RecognizedToDate: ' + revenueRecord.recognizedToDate);
System.debug('PreviouslyRecognized: ' + revenueRecord.previouslyRecognized);
System.debug('ToRecognizeThisPeriod: ' + revenueRecord.toRecognizeThisPeriod);
System.debug('TotalRevenue: ' + revenueRecord.totalRevenue);
System.debug('CalculatedTotalRevenue: ' + revenueRecord.calculatedTotalRevenue);
System.debug('Errors: ' + revenueRecord.errors);

global static ffrr.CalculationService.Record retrieveRecordDetails(Id recordId)

Retrieves the detail of the specified record. The returned data will include the values used in calculations and high level details of the record.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Record object.

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.

//Note: This sample demonstrates how to call the retrieveRecordDetails method and
//therefore relies on there being data within the system (if no data is available,
//no data will be retrieved). Given the nature of this sample, setting the ID of the
//record to be retrieved isn't possible. If you wish to fully test the sample code
//you will need to configure your Recognition Settings, Recognition Templates etc. and populate recordID
//with the ID of one of your data records
ID recordID = null;

//Call the method
ffrr.CalculationService.Record recordDetails = ffrr.CalculationService.retrieveRecordDetails(recordID);

//Output the data that was returned
system.debug('RecordDetails: ' + recordDetails);

global static ffrr.CalculationService.Record retrieveRecordDetails(Id recordId, ffrr.ViewService.ViewType viewType)

Retrieves the detail of the specified record. The returned data will include the values used in calculations and high level details of the record.

Input Parameters

Return Value

This service returns a ffrr.CalculationService.Record object.

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.

//Note: This sample demonstrates how to call the retrieveRecordDetails method and
//therefore relies on there being data within the system (if no data is available,
//no data will be retrieved). Given the nature of this sample, setting the ID of the
//record to be retrieved isn't possible. If you wish to fully test the sample code
//you will need to configure your Recognition Settings, Recognition Templates etc. and populate recordID
//with the ID of one of your data records. The View Type determines the type ( e.g. Actual, Forecast) of the records
//to be retrieved.
ID recordID = null;

//Call the method (retrieve details for a record of type Forecast)
ffrr.CalculationService.Record recordDetails = ffrr.CalculationService.retrieveRecordDetails(recordID, ffrr.ViewService.ViewType.FORECAST);

//Output the data that was returned
system.debug('RecordDetails: ' + recordDetails);

global Calculation()

global CalculationResult()

global Template()

Contains the information of a template.

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.

//Create the recognition template
ffrr.CalculationService.Template tSample = new ffrr.CalculationService.Template();

//Populate the fields inherited from ffrr.ViewService.Reference
tSample.id = 'a0va00000059tb8';
tSample.name = 'My Template';

//Populate the fields specific for the ffrr.CalculationService.Template
tSample.templateType = 'Equal split';
tSample.revenueBasis = 'Total Revenue';
tSample.calculationType = 'Months';