Pay components
An item used to calculate employee pay, such as an earning, deduction or other payment.
- API name:
payrollcomponents - 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 | ||
| Code | code | Text | Yes | |
| Ledger account | accountingledgeraccountId | Reference | ||
| Kind | kind | Constant | Yes | |
| Occurrence | occurrence | Constant | Yes | |
| Timing | timing | Constant | ||
| Tags | tagIds | Tags | ||
| 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 | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | 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 |
|---|---|---|
Ledger account accountingledgeraccountId | Chart of accounts | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event payrollcomponents.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new pay component. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this pay component. | App · WebMCP · API · MCP · CLI |
| Disable | disable | Turn this pay component off for new use. Existing references stay. Enable it again to use it. | App · WebMCP · API · MCP · CLI |
| Enable | undisable | Turn this pay component back on for new use. | App · WebMCP · API · MCP · CLI |
| Publish | publish | Make this pay component available for use. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this pay component. 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 component again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this pay component 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 component to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this pay component 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.