Pay structure lines
A pay component assigned to a pay structure, with rules for calculating its amount.
- API name:
payrollstructurecomponents - 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 | |
| Pay structure | payrollstructureId | Reference | Yes | |
| Sequence | sequence | Whole Number | Yes | |
| Pay component | payrollcomponentId | Reference | Yes | |
| Method | method | Constant | Yes | |
| Amount | amount | Currency | ||
| Rate | rate | Percent | Percent or per-unit rate the engine applied, per the component unit source. | |
| Unit rate | unitRate | Decimal | Decimal quantity or amount for this line. | |
| Unit source | unitSource | Constant | ||
| Weekly threshold (minutes) | weeklyThresholdMinutes | Whole Number | Only weekly overtime above this threshold counts. | |
| 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 |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Pay structure payrollstructureId | Pay structures | owned by |
Pay component payrollcomponentId | Pay components | reference |
Actions
What you can do with a record. Every action also sends the webhook event payrollstructurecomponents.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new structure line. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this structure line. | App · API · MCP · CLI |
| Delete | delete | Delete this structure line and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |