Payroll periods
A period for which employee pay is calculated and paid.
- API name:
payrollperiods - 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 | ||
| Frequency | frequency | Constant | Yes | |
| Period start | dateStart | Date | Yes | |
| Period end | dateEnd | Date | Yes | |
| Pay date | datePay | Date | Yes | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Closed by | closedBy | User | ||
| Closed at | closedAt | 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 payrollperiods.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Edit | update | Save changes to this pay period. | App · WebMCP · API · MCP · CLI |
| Close | close | Stop new references to this pay period. It stays, and existing documents stay. Unclose to allow new references again. | App · WebMCP · API · MCP · CLI |
| Reopen | unclose | Allow new references to this pay period again. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this pay period. 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 pay period again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this pay period 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 pay period to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this pay period 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.