Skip to content

VOID_PRE_CANCELLATION

Voids a previously issued pre‑cancellation notice. It fetches the target policy event by eventId.

When and what fires this event?

  • Internally: Executed by the plugin engine. The plugin resolves the policy event and only returns a full payload when the event type is PRE_CANCELLATION_NOTICE_VOID. Otherwise it yields an empty response.
  • Typical usage: downstream UIs/flows invoke this plugin to present or propagate data related to a voided pre‑cancellation notice without re‑hydrating all policy data.
  • API: can fire this event externally on demand.

Request payload

The plugin expects an eventId of the policy event you want to void/represent as voided.

{
  "pluginId": "<UUID of this plugin execution>",
  "pluginIdentity": "VOID_PRE_CANCELLATION_EVENT",
  "payload": {
    "eventId": "<UUID of the PRE_CANCELLATION_NOTICE_VOID policy event>"
  }
}

Request fields

PropertyRequiredDescription
pluginIdtrueExecution correlation ID (echoed back in the response).
pluginIdentitytrueMust be VOID_PRE_CANCELLATION_EVENT.
payload.eventIdtruePolicy event ID to look up details for. If omitted, an empty response is returned.

Response json

{
  "pluginId": "<same as request>",
  "pluginIdentity": "VOID_PRE_CANCELLATION_EVENT",
  "payload": {
    "VOID_PRE_CANCELLATION_EVENT": {
      "voidPreCancellation": {
        "id": "<eventId>",
        "type": "PRE_CANCELLATION_NOTICE_VOID",
        "effectiveDate": "2025-10-28",
        "...": "..."
      },
      "effectiveDateDay": "28",
      "effectiveDateMonth": "October",
      "effectiveDateYear": "25"
    }
  }
}

Response fields

  • The effectiveDate* fields are derived from the event’s effectiveDate.
PropertyRequiredDescription
pluginIdtrueIdentifier of the plugin execution, expected to match the request’s pluginId.
pluginIdentitytrueIdentifier indicating the type of plugin or event being processed.
payloadtrueContains event-specific metadata generated by the plugin.