InsPolicyBillingService:generateBillingAccountStatements

We don't recommend that you invoke this service directly. It was created to be invoked by the Generate Billing Account Statements Vlocity Scheduled Job.

Class: InsPolicyBillingService

Method: generateBillingAccountStatements

How It Works

1. The service takes in a list of billing accounts from a Vlocity Scheduled Job.

2. Groups billing accounts by accounts.

3. Retrieves policies associated with the Billing Accounts.

4. Creates a statement for each account:

   1. Sets RecordType__c to Statement.

   2. Sets AccountId__c to the Id of the account.

   3. Sets DueDate__c to the value of BillDueDate__c of the first billing account in the group.

   4. Sets StatementDate__c to the value of BillDueDate__c.

   5. Sets StatementEndDate__c to the value of BillDueDate__c.

   6. Sets StatementStartDate__c to the furthest date back specified by the BillingFrequency__c values in the billing accounts.

   7. Sets BalanceDue__c to the sum of the AutomaticPaymentAmounts__c values on the policies associated with the billing accounts.

   8. Sets PreviousBalance__c to the sum of the PastDue__c values on the policies associated with the billing accounts.

5. For all policies associated with a specific statement, retrieves all transactions associated with the specified policies that have a TransactionDate__c within the statement period start and end date.

   If the transaction does not have a value for the StatementId__c, set the StatementId__c to the Id of the specified Statement.

6. For each billing account:

   1. Sets AutomaticPaymentAmount__c to the sum of the NextPaymentAmountDue__c values on the policies associated with the billing account.

   2. Sets the new BillDueDate__c based on the current BillDueDate__c and BillingFrequency__c.

7. For each policy associated with a specific billing account:

   1. Sets the AutomaticPaymentAmountDue__c to the NextPaymentAmountDue__c.

   2. Sets BillDueDate__c to the billing account’s updated BillDueDate__c.

Remote Options

This service doesn't take any remote options.

Calculating StatementStartDate__c

An account can have multiple policies with direct billing. Each policy may have a different billing frequency (annual, quarterly, monthly, or semi-monthly). StatementStartDate__c is determined using the policy’s bill due date and billing frequency to calculate the start date for each policy. then choosing the start date that' furthest back in time.

For example, if an Account has two policies, both with a bill due date of ‘2018-03-31’. Policy 1 has a billing frequency of ‘Monthly’ and Policy 2 has a billing frequency of ‘Quarterly’. Using the bill due date and billing frequency, the start date of Policy 1 would be ‘2018-02-28’ and the start date of Policy 2 would be ‘2018-01-01’. Since the start date of Policy 2 is further back in time, the StatementStartDate__c is set to ‘2018-01-01’.

Calculating the new BillDueDate__c

A new BillDueDate__c is calculated based on the current BillDueDate__c and the BillingFrequency__c. Here are the billing frequencies and calculations for the new BillDueDate__c:

• Annually

  Current BillDueDate__c plus 1 year

• Quarterly

  BillDueDate__c can only be 1 of 4 dates: March 31st, June 30th, September 30th, or December 31st. Set BillDueDate__c to the next date in the sequence. For example, if it is currently set to currently March 31st, set it to June 30th.

• Monthly

  Current BillDueDate__c plus 1 month

• Semi-Monthly

  • If current BillDueDate__c is the end of the month, set it to the middle of the next month (14th if February, 15th if any other month)

  • If current BillDueDate__c is the middle of the month, set it to the end of the month

Input JSON

This service expects an input JSON generated by a Vlocity Scheduled Job. This scheduled job will include the following key and their values:

• records: A list of billing accounts selected by the scheduled job

{
	"records": [{
			"Id": "a3h5A000000Xz7l",
			"AccountId": "0015A000025MuenQAC",
			"BillDueDate__c": "2018-03-31",
			"BillingFrequency__c": "Monthly"
		},
		{
			"Id": "a3h5A000000Xz7m",
			"AccountId": "0015A000025MuenQAC"
			"BillDueDate__c": "2018-03-31",
			"BillingFrequency__c": "Quarterly"
		}
	]
}

Output JSON

The service doesn't return any output JSON.