Cancellation integration

PolicyCenter integrates with many types of external systems and custom code through a diverse toolbox of services. This topic describes web services and events that the cancellation job uses.

A common integration is with a billing system to start a cancellation for non-payment or to rescind a cancellation after receiving payment.

Another common integration is with a rating engine to calculate the premium amount.

Cancellation web services

The Cancellation API is a web service for use by external systems to begin, reschedule, rescind, or find a cancellation.

Invoke the beginCancellation method to begin a cancellation job. This method does not attempt to automatically push the cancellation through to completion. The method throws an exception if the cancellation cannot be started for any reason.

The rescheduleCancellation method allows you to reschedule an cancellation. You must specify the new cancellation effective date. Optionally, you can provide a new reason description. The cancellation can be in draft, quoted, or canceling status.

The rescindCancellation method rescinds a cancellation job. The method throws an exception if the rescind cannot be performed for any reason.

See also

Cancellation plugins

The following plugins might be useful for cancellation.

Name

Description

IBillingPlugin

If you need to integrate with an external billing system, use this plugin to notify an external billing system about billing events.

MessageTransport

Use this plugin to send a message to an external/remote system by using any transport protocol.

IEffectiveTimePlugin

Determines the time of day (since midnight) for a job. Use to calculate the effective time.

IJobNumberGenPlugin

Generates a new, unique job number. Use to generate cancellation job numbers.

IPolicyPlugin

Lets PolicyCenter know whether, based on dynamic calculations on the policy, it is OK to start various jobs. Use to determine if a cancellation job can be started.

INotificationPlugin

Returns cancellation lead time.

See also

Account and policy plugins

Cancellation events

PolicyCenter generates events for changes in PolicyCenter that might be of interest to an external system. You can also programmatically generate an event. For example, in the CancellationProcess.gs class, the sendNotices method generates a SendCancellationNotices event.

The Cancellation entity has the following events:

  • CancellationAdded
  • CancellationChanged
  • CancellationRemoved

The PolicyPeriod entity has the following events pertaining to cancellation:

  • SendCancellationNotices – Message to an external system to send cancellation notices.
  • IssueCancellation – Message to an external System of Record (SOR) to send cancellation notices.
  • SendRescindNotices – Message to an external system to send rescind cancellation notices.

See also