Simulating a sweep
A sweep simulation shows the legs a sweep would move, before any money moves. It uses the same calculation as the sweep run itself. A simulation never posts, holds or changes anything.
Open a simulation
In the client app, open Accounts → Liquidity and select a structure. In the bank app, open the counterparty’s Liquidity panel and select a structure. The Sweep simulation section sits below the tree.
If a pending change waits for your side’s approval, the simulation opens on that change. You see its effect on the money before you select Approve or Reject.
Choose what to simulate
- Enter a Position date. Leave it empty for today.
- Choose a Slot if the structure sweeps more than once a day. Next slot is the next one still to run.
- Choose a Shape:
- In force uses the structure as approved.
- As on a date uses the structure as it stood on a Shape date you enter.
- Pending change uses the structure with the pending change applied.
You can combine a shape with any position date. For example, you can try a proposed structure on last month’s money.
Read the result
The header says what the simulation read.
| Line | What it tells you |
|---|---|
| Positions | Where the balances came from. See the table below. |
| Shape | Which version of the structure was used, and from which date. |
| Totals | Money collected up, money funded down, legs that move, and legs that fall short. |
| Run | Shown only when this slot has already run. |
Every leg is a book transfer between accounts in the structure.
The Accounts table shows each account’s balance before and after the sweep. The Legs table shows each leg: from, to, direction, method, the amount asked, and the amount moved. The Why column says what stopped the leg moving more.
| Why | What it means |
|---|---|
| Target reached | The child keeps the method’s target. |
| Inside the band | The balance sits between the triggers, so nothing moves. |
| Child held | The child had less than the method asked for. |
| Parent could fund | The parent had less than the child needed, and the leg moved what the parent had. |
| Short, and this pair does not sweep partially | The parent was short, so the leg moved nothing. |
| Nothing to move | The balance was already where the method wants it. |
A pair skipped because an account is closed, or outside the liquidity service agreement, is listed under the tables.
Which positions a simulation reads
flowchart TD
D{Position date} -->|today, slot not yet run| L[Positions as read now]
D -->|slot has run| R[The run's own recorded positions]
D -->|past date, no run| C[Ledger at close. Holds not included.]
| Positions label | When you see it |
|---|---|
| Positions as read at 14:30 | Today, before the slot runs. Balances keep moving until the run. |
| As run at 18:04, 9 Nov 2026 | The slot has run. The legs show each outcome. |
| Ledger at close, 6 Nov 2026. Holds not included. | A past date with no run. The closing balance is used. Holds and claims on that day are not known. |
| Mixed | The run’s recorded positions, plus accounts added to the structure since the run. |
A simulation cannot look ahead. If you enter a future position date, the simulation is refused, because future balances are a forecast. If you choose a past intraday slot that never ran, the simulation is refused, because intraday balances are not kept.
A worked example
Treasury is the header account, with no overdraft facility. Cape Town and Durban are its children, and every pair sweeps at day-end. Durban has an overdraft facility of 20,000.00.
- Cape Town keeps a target of 5,000.00, one way.
- Durban sweeps to a zero balance, both ways, and does not sweep partially.
| Leg | Asked | Moved | Why |
|---|---|---|---|
| Cape Town → Treasury | 7,000.00 | 7,000.00 | Target reached: leaves 5,000.00. |
| Treasury → Durban | 15,000.00 | 0.00 | Short by 4,000.00, and this pair does not sweep partially. |
| Account | Before | After |
|---|---|---|
| Treasury | 4,000.00 | 11,000.00 |
| Cape Town | 12,000.00 | 5,000.00 |
| Durban | −15,000.00 | −15,000.00 |
Treasury can fund 4,000.00 + 7,000.00 = 11,000.00. That is 4,000.00 short of Durban’s 15,000.00.
Now the client proposes that Durban may sweep partially. The bank opens the pending change, and the simulation shows its effect.
| Leg | Asked | Moved | Why |
|---|---|---|---|
| Treasury → Durban | 15,000.00 | 11,000.00 | Parent could fund 11,000.00 of 15,000.00. |
Treasury ends at 0.00.
If the simulation is refused
| Message | What to do |
|---|---|
| You cannot view account 1234, so you cannot preview this structure. | Ask your administrator for access to every account in the structure. |
| Positions for 12 Nov 2026 do not exist yet. | Choose today or an earlier date. |
| The 12:00 slot did not run on 6 Nov 2026. | Choose day-end for that date. Only closing balances are kept. |
| The structure had no shape on 1 Oct 2026. | Choose a shape date on or after the structure started. |
| This change is no longer pending on this structure. | Refresh the tree. The change was approved, rejected or withdrawn. |
In the client app, a simulation needs access to every account in the structure. This stops a simulation showing balances you could not otherwise see.
What your organisation configures
- Who may simulate a sweep. In the client app this is a channel operation granted through the agreement. In the bank app it is a permission.
- Each pair’s method, targets, direction and partial-sweep setting.
- Each pair’s sweep slots and day-end sweep.
- The trading calendar that decides today’s date and day-end.
From the LedgerTM product guide, as shipped with the software and written with it. Copied from the platform repository on 2026-11-11.