Payroll run policies
A set of rules that sets which components and inputs apply to a payroll run, by company, kind and pay date.
- API name:
payrollrunpolicies - 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 | |
| Kind | kind | Constant | Yes | |
| Event | event | Constant | Yes | |
| Include unconsumed inputs | includeUnconsumedInputs | Boolean | Yes | When enabled, the related rule or behavior applies to this record. |
| Absence deduction 020 | emitAbsenceDeduction | Boolean | Yes | When on, payroll shows deduction 020 while keeping the same ISR as salary reduction. |
| Included occurrences | occurrences | Text | Yes | Comma-separated list of component occurrence values allowed on the run. |
| Valid from | dateFrom | Date | Yes | First calendar date this record applies. |
| Valid to | dateTo | Date | Last calendar date this record applies, if any. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Actions
What you can do with a record. Every action also sends the webhook event payrollrunpolicies.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new run policy. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this run policy. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this run policy 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 policy to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this run policy 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 |
|---|---|
| Publish | publish |