Hold statuses
A hold status names a protected state, such as debt review. The Hold Statuses page under Settings says what each hold stops. It also says who may instruct the account while the hold runs.
You place a hold on a customer. See hold. This page sets what that hold does.
What the page shows
| Column | What it tells you |
|---|---|
| Hold | The name people read on screen. An Inactive badge means it is not offered. |
| Key | The stable identity. It never changes. |
| Suppresses | What the hold stops, or Nothing |
| Authority | Who may instruct the account: Retained, Vacated or Substituted |
| Routes to | The collection pool that takes the customer’s cases |
What a hold can stop
Select Edit on a row. Tick each thing the hold stops.
| Choice | What stops |
|---|---|
| Outbound third-party payment | Debit orders, standing orders, card, withdrawals and payouts |
| Enforcement | Enforcement notices and the statutory default states |
| New business | New agreements for the customer |
| Monthly charging | Monthly service fees |
Money coming in never stops. A hold that stops nothing still routes cases and still shows on the customer.
Who may instruct the account
Stopping payments and holding authority are separate choices.
| Authority | What it means |
|---|---|
| Retained | The customer still instructs their own account |
| Vacated | Nobody may instruct, such as a deceased estate before an executor is appointed |
| Substituted | Somebody else instructs, such as a business rescue practitioner |
Editing a hold status
- Open Settings and select Hold Statuses.
- Select Edit on the row.
- Tick what the hold stops.
- Choose the authority.
- Select Save.
The page keeps the other settings on the row as they were. It does not change the name, the pool or whether the hold silences letters and messages. The key cannot change, because every hold and case already stores it.
A new hold status comes with the tenant setup. This page does not add or remove one.
A worked example
The South African retail template (za-retail, built on the retail-bank package) sets up four hold statuses.
| Hold | Suppresses | Authority | Routes to |
|---|---|---|---|
| Tracing | Outbound third-party payment, Enforcement | Retained | tracing |
| Legal | Outbound third-party payment, Enforcement | Retained | legal |
| Deceased | Outbound third-party payment, Enforcement | Vacated | deceased-estates |
| Debt review | Outbound third-party payment, Enforcement | Retained | debt-review |
Jordan’s customer dies and the Deceased hold applies. Payments out stop and enforcement stops. Nobody may instruct the account, so authority is vacated. The cases move to the deceased estates pool. Monthly charging carries on, because the template leaves it unticked.
What your organisation configures
- Which hold statuses exist.
- What each one stops, and who holds authority.
- The pool each one routes to, and whether it silences letters and messages.
The pools are on the Collection Pools tab. See collection pools.
From the LedgerTM product guide, as shipped with the software and written with it. Copied from the platform repository on 2026-11-11.