# void

URL: /business/nouns/pay-run/void · Id: `verb:PayRun.void` · Call: `await $.PayRun.void({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Void sets aside a prepared Pay Run that is wrong, so a corrected one can be prepared; the record stays.

Void sets aside a prepared [Pay Run](/business/nouns/pay-run) that is wrong, so a corrected one can be prepared; the record stays.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `payRun` | [Pay Run](/business/nouns/pay-run) | Yes | The prepared Pay Run. |
| `reason` | `text` | Yes | Why it was set aside. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `payRun` | [Pay Run](/business/nouns/pay-run) | Yes | The voided Pay Run. |

## Effects
- Emits [`PayRun.voided`](/business/events/PayRun.voided).
- Performed by the [Payroll Specialist](/agents/people/payroll-specialist).
- Two-way: it runs at once, in the `try`, `send` and `do` modes.
- An approved Pay Run cannot be voided; a mistake in it is corrected in the next run.

## Refuses when
| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | [PayRun.void](/business/nouns/pay-run/void) |

## When it waits
| Gate | Default |
| --- | --- |
| Decision class | Low: two-way, nothing at stake |
| [Delay window](/systems/trust-and-governance/controls/one-way-windows) | None: it runs once review passes. |
| Limit | The call [Limit](/business/nouns/limit) of the [Permission](/business/nouns/permission) it runs under. |
| Over the Limit | It waits `pending` for an [Approval](/business/nouns/approval) from the [Founder](/agents/founding/founder). Approved, it runs; refused, it ends `refused` with [`limit-exceeded`](/code/api/errors/limit-exceeded); unanswered by its deadline, it ends `canceled`. |

## Example

**Ask**

```text
Void the latest pay run.
```

**API**

```bash
curl -X POST https://api.sb/ledgerlark.com/pay-runs/pay_run_1/void \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
```

```json
{
  "api": "https://api.sb/ledgerlark.com",
  "payRun": {
    "$id": "https://api.sb/ledgerlark.com/pay-runs/pay_run_1",
    "$type": "PayRun",
    "company": "company_1",
    "periodStart": "2026-10-22",
    "periodEnd": "2026-10-22",
    "payDate": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/ledgerlark.com/actions/action_1",
    "operation": "PayRun.void",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ledgerlark.com/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const payRun = await $.PayRun.void({ payRun: 'pay_run_1', reason: 'Example reason' })
```

**CLI**

```bash
npx startup-builder do PayRun.void --json '{"payRun":"pay_run_1","reason":"Example reason"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.PayRun.void({ payRun: 'pay_run_1', reason: 'Example reason' })"
  }
}
```