Retrieving installment previews from a billing system

Similar to the requirements for payment plans, your billing plugin must be able to retrieve installment previews from your billing system. Installment previews are an accurate calculation of billing installments for a given policy period with a given payment plan. PolicyCenter uses this information when a user clicks the Schedule button in the Schedule column for a payment plan to show the user what installments to expect.

Implement the following plugin method:

  • retrieveInstallmentsPlanPreview – Retrieves previews of installments for a new policy, policy change, policy renewal, or policy rewrite job. This method takes a PolicyPeriod entity instance and returns an array of PaymentPreviewItem objects.

PolicyCenter always calls this method synchronously with respect to the user interface. This method takes a PolicyPeriod entity instance and returns an array of PaymentPreviewItem objects. The fully qualified class name of this class is gw.api.billing.PaymentPreviewItem.

Your implementation of this method must set the following properties on each PaymentPreviewItem object:

  • DueDate – The due date
  • Type – A String that represents the type of payment
  • Amount – The amount of money, as a MonetaryAmount value

The methods described in this topic get installment previews, not payment plans on a policy period. To get payment plans, you must retrieve the payment plans from the billing system.

See also