Use Cases

This section briefly describes the use cases the base product has supplied functionality to support.

Mass Cancellation of Tax Forms

The product provides algorithms to cater for an entity correction with a list of either Tax Form IDs or DLNs (document locator numbers) that should be canceled. The validation algorithm provided ensures that the Tax Form IDs or DLN values are valid. Once the process is approved, the tax forms are either canceled (if they were not yet posted) or they are reversed (if the status is posted). Rules plugged into the tax form type for cancelling or reversing may cause other tasks to occur.

When creating and approving an entity correction for this use case, no additional information needs to be provided by the user besides the correction reason.

Fastpath: Refer to Common Tax Form Procedures for more information on tax form cancellation and reversal.

Mass Cancellation of Payment Events

The product provides algorithms to cater for an entity correction with a list of payment event IDs that should be canceled. There is no external ID for a payment. The validation algorithm provided ensures that the payment event IDs are valid. Once the process is approved, the payment tenders and payments linked to each payment event are canceled.

When creating and approving an entity correction for this use case, no additional information needs to be provided by the user besides the correction reason.

Fastpath: Refer to Cancel a Tender for more information on payment cancellation.

Mass Correction of Overdue Processes

The product provides algorithms to cater for an entity correction with a list of overdue processes whose events should be canceled or reversed. There is no external ID for an overdue process. Additional information about how to perform the correction is required before validation. The validation algorithm provided ensures that the overdue processes are valid for the requested correction actions. Once the process is approved, events on the overdue process are canceled or reversed based on the input information. And if requested, some of the events are recreated to restart the process.

Fastpath: Refer to Overdue Correction for more information on this process.

Mass Suppression Creation for Taxpayers

The product provides algorithms to cater for an entity correction with a list of person ids for which to create suppression records. The person IDs supplied may be the internal Person ID or an ID in the person identifier collection. Additional information about how to create the suppression is required and can be supplied when approving the record. As such, a special business object is provided for this use case. The validation algorithm provided ensures that the person IDs are valid. Once the process is approved, suppression records are created for each person using input information on the entity correction.

Fastpath: Refer to Suppressions for more information on suppressions.

Mass Suppression Release for Taxpayers

The product provides algorithms to cater for an entity correction with a list of suppression ids that should be released. There is no external ID for a suppression. The user should supply the date that the suppression should be released and that information needs to be supplied before validation.

Fastpath: Refer to Suppressions for more information on suppressions.