Skip to content

by Startups.Studio

Finance Pay Run

PayRun.pay

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

Pay funds an approved Pay Run: net pay to each employee’s bank on the pay date, taxes and deductions to the payroll provider.

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

You, to your agent

Pay the latest pay run.

curl -X POST https://api.sb/shiftnote.app/pay-runs/pay_run_1/pay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { payRun, transaction } = await $.PayRun.pay({ payRun: 'pay_run_1' })

npx startup-builder do PayRun.pay --json '{"payRun":"pay_run_1"}'

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

Inputs

Input	Type	Required	Description
`payRun`	Pay Run	required	The approved Pay Run.

Outputs

Output	Type	Required	Description
`payRun`	Pay Run	required	The paid Pay Run.
`transaction`	Transaction	required	The funding Transaction.

Effects

Emits PayRun.paid.
Performed by the Treasurer.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Pays from the operating account, so the money must be there before the pay date.
The payroll provider remits each withholding and files each employer return by its deadline.
A deposit the bank returns arrives as a failed Transaction and opens a Task to pay that employee off-cycle.

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.pay

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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.list

Previous Page

PayRun.prepare

Next Page