Billing system plugin method requirements

The following table lists properties that you might want to send to your billing system and other important information about IBillingSystemPlugin methods.

Action

Method name

Description

All actions

All methods

For each action, you typically need to send the following basic policy period data:

  • period.PeriodId.Value
  • period.PolicyNumber
  • period.EditEffectiveDate.toCalendar()
  • ChargeInfoUtil.getChargeInfos(period)

Policy change

issuePolicyChange

Issue a policy change in the billing system. PolicyCenter does not notify the billing system about all changes to the policy. PolicyCenter does notify the billing system about the following policy changes:

  • Premium changes
  • Base state changes
  • Primary insured changes

In addition to basic policy period data, you typically need to send the following policy period data:

  • period.PolicyChange.Description
  • period.BaseState.Code
  • period.PeriodStart.toCalendar()
  • period.PeriodEnd.toCalendar()
  • period.PrimaryNamedInsured.AccountContactRole.AccountContact .Contact (a Contact entity)

Issuance

issuePolicyChange

PolicyCenter calls the issuePolicyChange method for Issuance as well as policy changes. PolicyCenter does not call this method as part of the bind process, but calls it for issuance that happens as a separate action. If the user performs just a bind, PolicyCenter creates the new PolicyPeriod locally and then calls the billing system createPolicyPeriod method. If the user performs a bind and issue as one user interface action, PolicyCenter calls createPolicyPeriod only. If the user performs bind only, PolicyCenter calls createPolicyPeriod only. Any issuance request that occurs later results in PolicyCenter calling issuePolicyChange.

See the policy change row for properties you might want to send to your billing system.

Premium report

issuePremiumReport

Issue a Premium Report in the billing system

In addition to basic policy period data (see note before this table), you will probably need to send the following policy period data:

  • period.Audit.AuditInformation
  • period.Audit.AuditInformation.AuditPeriodEndDate.toCalendar()
  • period.Audit.AuditInformation.AuditPeriodStartDate.toCalendar()
  • period.Audit.PaymentReceived

Renew

renewPolicyPeriod

Renew a policy period in Billing System. This plugin only notifies the billing system. This plugin does not change the fundamental logic within PolicyCenter for how a policy renews.

In addition to basic policy period data (see note before this table), you will probably need to send the following policy period data:

See the Policy Change row for properties you might want to send to your billing system.

Term confirmation updatePolicyPeriodTermConfirmed Confirms a policy period term. This method differs from the others in this table in that it does not notify the billing system. Instead, the billing system notifies PolicyCenter that a specified policy period term has been confirmed by calling the PolicyRenewalAPI web service method confirmTerm. The web service method calls this plugin method which sets the policy period term's TermConfirmed field to true.

Final audit

issueFinalAudit

Issue a Final Audit in Billing System. You might need only the basic policy period data to send to the billing system. See the note before this table for the property list.

Schedule final audit

scheduleFinalAudit

Schedule a final audit on a policy period in your billing system.

In addition to basic policy period data (see note before this table), you will probably need to send the following policy period data:

  • period.PolicyNumber
  • period.PeriodId.Value

Waive final audit

waiveFinalAudit

Schedule a final audit on a policy period in your billing system. You might need only the basic policy period data to send to the billing system. See the note before this table for the property list.

In addition to basic policy period data (see note before this table), you will probably need to send the following policy period data:

  • period.PolicyNumber
  • period.PeriodId.Value

See also