Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

PayRun.prepared

Emitted each time a Pay Run is prepared.

PayRun.prepare emits PayRun.prepared when it completes on a Pay Run.

PropertyValue
Emitted byPayRun.prepare
NounPay Run
WakesNone.

Payload

Each delivery is an Event record. data holds what PayRun.prepare returns.

FieldTypeRequiredDescription
namestringrequiredPayRun.prepared.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.payRunPay RunrequiredThe prepared Pay Run, with every amount per employee.
data.payRun.companyCompanyrequiredThe employer of record for everyone it pays.
data.payRun.periodStartdaterequiredThe first day of the pay period.
data.payRun.periodEnddaterequiredThe last day of the pay period.
data.payRun.payDatedaterequiredThe day net pay reaches each employee’s bank.
data.payRun.kindstringrequiredA regular run on the pay schedule, or an offCycle run for a bonus, a correction or final pay.
data.payRun.humanslist of HumanThe employees it pays.
data.payRun.grossmoneyPay before withholding and deductions, for everyone in the run.
data.payRun.withheldmoneyIncome and payroll taxes withheld from employees’ pay.
data.payRun.deductionsmoneyBenefit and retirement deductions the employees elected.
data.payRun.employerTaxmoneyPayroll taxes the Company owes on top of gross pay.
data.payRun.netmoneyWhat reaches the employees’ banks: gross less withholding and deductions.
data.payRun.statusstringrequiredWhere the Pay Run stands; only an approved run is paid.

Example

JSON
{
  "$id": "https://api.sb/kilnbakery.com/events/event_1",
  "$type": "Event",
  "name": "PayRun.prepared",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "payRun": {
      "$id": "https://api.sb/kilnbakery.com/pay-runs/pay_run_1",
      "$type": "PayRun",
      "company": "company_1",
      "periodStart": "2026-10-22",
      "periodEnd": "2026-10-22",
      "payDate": "2026-10-22",
      "kind": "regular",
      "humans": [
        "human_1"
      ],
      "gross": {
        "amount": 9,
        "currency": "USD"
      },
      "withheld": {
        "amount": 9,
        "currency": "USD"
      },
      "deductions": {
        "amount": 9,
        "currency": "USD"
      },
      "employerTax": {
        "amount": 9,
        "currency": "USD"
      },
      "net": {
        "amount": 9,
        "currency": "USD"
      },
      "status": "prepared"
    }
  },
  "seq": 1
}