Payroll runs
The calculation of employee pay for one pay period.
- API name:
payrollruns - Domain: Payroll
- Modules: Human resources
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| Run number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Accounting date | date | Date | Yes | Calendar date for this value. |
| User | userId | User | ||
| Pay period | payrollperiodId | Reference | Yes | |
| Tax registration | taxregistrationId | Reference | ||
| Kind | kind | Constant | Yes | |
| Net | net | Signed amount | Signed monetary amount; negative values are allowed. | |
| Statutory values | statutoryValueIds | JSON | ||
| Distributable amount (PTU) | amountDistributable | Currency | Distributable profit used as the PTU base in this run. | |
| Gross | gross | Currency | ||
| Tax withheld | taxWithheld | Currency | ||
| Employer contributions | employerContributions | Currency | ||
| Deductions | deductions | Currency | ||
| Other payments | otherPayments | Currency | ||
| Credits | credits | Currency | ||
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| Reopen reason | unapproveReason | Text Area | Required explanation when reversing approval. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Started by | startedBy | User | ||
| Started at | startedAt | Date and Time | ||
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Paid by | paidBy | User | ||
| Paid at | paidAt | Date and Time | ||
| Calculated by | calculatedBy | User | ||
| Calculated at | calculatedAt | Date and Time | ||
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Pay period payrollperiodId | Payroll periods | reference |
Tax registration taxregistrationId | Tax registrations | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event payrollruns.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new run. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this run. | App · WebMCP · API · MCP · CLI |
| Approve | approve | Approve this run so the next step can run. | App · WebMCP · API · MCP · CLI |
| Start | start | Marks the run as started before calculation. | App · WebMCP · API · MCP · CLI |
| Process | process | Post this run. You cannot undo it. | App · WebMCP · API · MCP · CLI |
| Cancel payroll | cancel | Reverse the posted effect of this run. | App · WebMCP · API · MCP · CLI |
| Calculate | calculate | Calculate earnings, deductions and taxes for every slip in the run. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this run. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this run again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this run from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this run to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this run and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.
| Action | API name |
|---|---|
| Approve | approve |
| Start | start |
| Cancel payroll | cancel |
| Remove approval | unapprove |
| Process | process |
| Calculate | calculate |