Skip to content

by Startups.Studio

Finance Pay Run

PayRun.void

POST /{namespace}/pay-runs/{payRun}/void

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

Noun: Pay Run
Mode: do
Event: PayRun.voided

You, to your agent

Void the latest pay run.

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"}'

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`payRun`	Pay Run	required	The prepared Pay Run.
`reason`	`text`	required	Why it was set aside.

Outputs

Output	Type	Required	Description
`payRun`	Pay Run	required	The voided Pay Run.

Effects

Emits PayRun.voided.
Performed by the 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`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	PayRun.void

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

PayRun.prepare

Previous Page

Payment Source

Next Page