TAG LINE
TAG LINE
SMALL TITLE

Package Status Screen

Last Updated: Wed Oct 18 2023

Package Statuses are configured in Setup / Product Catalog / Package / Package Status

Overview

This screen allows you to add, edit and delete the package statuses that you can set on account-packages. You can create as many statuses as you require (pre-active, active, suspended, etc.). The package statuses you create can be configured to be billable or non-billable, meaning recurring charges related to an account-package can be disabled or enabled based on the status that the account-package is set to. Statuses can also be set with the 'Prevent Changes' option, preventing account-packages from being modified while the account-package remains in the given status. A Canceled package status is configured by default in the system, any account-package switched to the Canceled status is permanently canceled and cannot be switched back to any other status.

Prerequisites

Account package statuses can be setup as needed, there are no prerequisite configuration steps.

Account Package Status Types Panel

The Account Package Status Types panel on the left of this screen allows you to select existing package statuses to view and edit on the Edit Account Package Status Type panel to the right. Actions are also available in this panel which are shown as icons above the Filter text box. The available actions are described below.

Actions

Info

Description

Deletes the selected account package status. Statuses that are in use cannot be deleted

Adds a new account package status

Edit Account Package Status Type Panel

The information in this panel reflects the currently selected status. From here you can change status details (note: fields with a magenta left border are required).

Edit Account Package Status Type Fields and Options:

  • Name: a unique name that describes the package status. This is the value that system users will see when changing an account's package status, e.g. Active, Suspended, Canceled

  • Prevent Changes: prevents account-package settings from being altered when an account-package is in a status configured with this option. The only setting that can be altered while an account-package is in an unchangeable status is the 'Status' field on the account-package. Account-packages that are in un-editable states may still be billable

  • Status: allows you to define the package status as a billable or non-billable status

    • Billable: If an account-package is in a billable state then recurring charges related to the account-services within the account-package will be applied as normal, provided the account-services within the account-package are not set to a non-billable service status

    • Non-Billable: An account-package set to a non-billable status will prevent recurring account-service charges from being applied. All other charges will still apply, such as one-time or transition charges that are configured on the package frequency
      Canceled: this is a non-billable status that is configured by default on the 'Canceled' account package status and cannot be configured on any user defined account package status. Account-packages in a canceled status cannot transition back to any other status. E.g. you cannot change a canceled package back to an active status, 'Canceled' is a permanent state

References tab

This section displays where the selected package status is used in the system. By default, the reference data is displayed in a summary format to indicate where the status is in use, however, the Entity drop down field can be used to view the exact system entities that the package status is configured on.


Guides

Adding an Account Package Status

  1. Under the Account Package Status Types heading on the left click the (emoji) icon

  2. Under the Add Account Package Status Type heading on the right specify the package status details

  3. Click Save


Editing an Account Package Status

  1. Under the Account Package Status Types heading on the left click the package status in the list that you wish to edit

  2. Under the Edit Account Package Status Type heading on the right modify the package status details

  3. Click Save to save your changes


Deleting an Account Package Status

Note: Package statuses that are configured on packages are in use and cannot be deleted. In order to delete a status that is in use, first determine which packages are configured with the status by checking the References tab and then edit those entities so that they no longer use the package status that you wish to delete.

  1. Under the Account Package Status Types heading on the left select the package status you wish to delete

  2. Under the same Account Package Status Type heading on the left click the (emoji) icon

  3. On the confirmation dialog that appears select Yes