Pay Run programs: approve, pay, prepare, void

Reference for Pay Run, one group of Pay Run programs.

PayRun.approveCopy Anchor Link

Approve accepts a prepared Pay Run within the approver’s Mandate, books its cost, and schedules payment to land on the pay date. Verb page.

do: return await $.PayRun.approve(input)

Emits PayRun.approved.

Inputs

Returns

Refuses when

Example

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

PayRun.payCopy Anchor Link

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

do: return await $.PayRun.pay(input)

Emits PayRun.paid.

Inputs

Returns

Refuses when

Example

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

PayRun.prepareCopy Anchor Link

Prepare computes one pay period’s gross pay, withholding, deductions and employer taxes for each employee, and holds the Pay Run for approval. Verb page.

do: return await $.PayRun.prepare(input)

Emits PayRun.prepared.

Inputs

Returns

Refuses when

Example

{
  "name": "do",
  "arguments": {
    "code": "return await $.PayRun.prepare({ company: 'company_28zYNZEno0', periodStart: '2026-10-22', periodEnd: '2026-10-22', payDate: '2026-10-22' })"
  }
}

PayRun.voidCopy Anchor Link

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

do: return await $.PayRun.void(input)

Emits PayRun.voided.

Inputs

Returns

Refuses when

Example

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