# Cancellation reasons

A cancellation reason is a sales configuration value assigned when sales work is
cancelled. Maintain these values in **Cancellation Reasons**.

## Overview

Use this page to review, add, edit, delete, filter, or reorder cancellation reasons.

| If you need to… | Go to |
|---|---|
| Prepare to maintain the list | [Before you start](#before-you-start) |
| Open the list | [Find the cancellation-reason list](#find-the-cancellation-reason-list) |
| Identify the field and popup | [Understand the list and form](#understand-the-list-and-form) |
| Choose a maintenance action | [Maintain cancellation reasons](#maintain-cancellation-reasons) |
| Add a reason | [Add a cancellation reason](#add-a-cancellation-reason) |
| Edit a reason | [Edit a cancellation reason](#edit-a-cancellation-reason) |
| Delete a reason | [Delete a cancellation reason](#delete-a-cancellation-reason) |
| Find or reorder a reason | [Search, filter, and use list tools](#search-filter-and-use-list-tools) |
| Check why a surface is absent | [Handle access and surface variations](#handle-access-and-surface-variations) |
| Respond to a message | [When an action does not work](#when-an-action-does-not-work) |

![Cancellation reasons list with the Name column and five rows](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/0add7deaf0e4f2a4a011f0ce168b35d8.png)

## Before you start

The cancellation-reason list requires a signed-in session. Have the reason name ready
before you add or change an entry, and confirm that your subscription and permissions
provide the action you need.

| Task | What you need first |
|---|---|
| Open the list | A signed-in session |
| Add a reason | The required subscription, visible **New**, and the reason name |
| Edit a reason | Edit permission and an existing row |
| Delete a reason | Delete permission and an existing row |
| Complete the form | A value for required **Name** |

> **Note:** This list is filtered for cancelled sales work.

## Find the cancellation-reason list

Prerequisites

- You are signed in.

Steps

1. Open **Sales**.
2. Select **Cancellation Reasons**.
3. Confirm that the list contains five rows when the same list composition is in use.

![Cancellation reasons list with New, Refresh, Settings, and the Name column](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/fe5cdbb64b7e472838008fd13afade4e.png)

**Result:** The **Cancellation Reasons** list is open.

## Understand the list and form

The list contains available cancellation reasons, and the form edits the selected
reason's **Name**.

Selecting a row opens its existing entry when editing is available.

| Surface | What you see |
|---|---|
| List | The visible column is **Name**. |
| Form | A required **Name** text box. |
| Popup | **New Cancellation Reason** with **OK**. |

Filtering is enabled for **Name**. The form shows **Name** when the popup is open, an
item is selected, and the field is available. Other record details are not shown as
list columns or form fields.

![New Cancellation Reason popup with the required empty Name field and OK](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/1bfe00330aae1a8880b719d7d3359b82.png)

## Maintain cancellation reasons

Choose the action that matches the change you need. The available actions depend on the
surface and permission conditions.

| Need | Control | Condition or result |
|---|---|---|
| Create a reason | **New** | Available when the subscription includes this list and the action is available. |
| Enter or change a reason | **Name** | Available in the new/edit popup. |
| Commit a new or changed reason | **Save** | Submits when required fields are valid. |
| Leave the popup | **Cancel** | Closes or cancels the popup. |
| Leave unsaved changes | **Don't Save** | Closes the unsaved-changes choice. |
| Edit a row | edit action in the row | Available when editing is allowed. |
| Open deletion | delete action in the row | Available when deletion is allowed. |
| Confirm deletion | **Delete** | Submits only when more than one item remains. |
| Change display order | Drag and drop | Saves the changed order when the configured list permits it. |

### Add a cancellation reason

Add a reason when cancelled sales work needs another selectable explanation.

Prerequisites

- The **Cancellation Reasons** list is open.
- **New** is visible.
- You have the reason name to enter.

Steps

1. Select **New**.
2. In **Name**, enter the cancellation reason.
3. Select **Save**.

The new reason is submitted after validation. A successful new record uses the message
`Data saved Successfully`.

**Result:** The new cancellation reason is submitted through the new-item popup.

### Edit a cancellation reason

Edit a reason when its wording needs to change.

Prerequisites

- The **Cancellation Reasons** list is open.
- An existing reason is available.
- The row exposes an edit action in the row.

Steps

1. Select the edit action in the row.
2. Change the value in **Name**.
3. Select **Save**.

The change is submitted after validation. A successful update uses the message
`Data updated Successfully`.

**Result:** The selected cancellation reason is submitted with its changed **Name**.

### Delete a cancellation reason

Delete a reason only when removing it is appropriate for the remaining choices. The
list must contain more than one item for deletion to be submitted.

Prerequisites

- The **Cancellation Reasons** list contains more than one item.
- The row exposes a delete action in the row.
- You have confirmed that removing the reason will not affect saved data.

Steps

1. Select the delete action in the row.
2. Select **Delete** in the confirmation menu.

| If | Then |
|---|---|
| The deletion succeeds | The message is `Data Deleted Successfully`. |
| Only one item remains | Keep the item; the message is `Must have at least one item`. |
| Saved data is related to the reason | Keep the reason; the message is `Related to Saved data, Can't be deleted`. |
| The deletion fails | Check the list before taking another deletion action; the message is `Failed to Delete`. |

**Result:** The selected reason is deleted only when more than one item remains and the request succeeds.

## Search, filter, and use list tools

| Tool or behaviour | Use |
|---|---|
| **Name** filtering | Filter by reason name. |
| **Refresh** | Refresh the list. |
| **Settings** | Open list settings. |
| **Export** | Available from **Settings** when **Export** is enabled. |
| Drag and drop | Reorder the list when the configured list permits it. |

## Handle access and surface variations

| Surface | What controls it |
|---|---|
| **New** | The subscription includes the list and the action is available. |
| edit action in the row | You are allowed to edit the selected row. |
| delete action in the row | You are allowed to delete the selected row. |
| **Name** in the form | The new/edit popup is open, an item is selected, and **Name** is available. |
| Entire page | You are signed in. |

The shared list can display a subscription-unavailable surface instead of the list when
the subscription does not include this configuration.

## When an action does not work

Use the message on screen to correct the entry before submitting the action again.

| Message | Safe next action |
|---|---|
| The **Name** field is required. | Enter a value in **Name**, then select **Save**. |
| `Forbidden characters detected. Please remove them and try again.` | Remove forbidden characters from **Name**, then select **Save**. |
| `Must have at least one item` | Keep at least one cancellation reason. |
| `Related to Saved data, Can't be deleted` | Keep the related reason. |
| `Failed to Delete` | Check the list before taking another deletion action. |

## Continue with related sales lists

Continue with the list that matches your next task:

- [Regret reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-regret-reasons)
- [Lost reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-lost-reasons)
- [Order cancellation reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-order-cancellation-reasons).
- [Payment methods](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-payments-methods)
- [Order chance](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-order-chance)
- [Inquiry status](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-inquiry-status)

For the broader sales-work context, see [Missed, regretted, and cancelled jobs](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/missed-regretted-and-cancelled-jobs)
and [Sales jobs lifecycle](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/sales-jobs-lifecycle).
