Pay component treatments
A rule that sets how a pay component affects the base of a tax.
- API name:
payrollcomponenttreatments - 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 | |
| Sequence | sequence | Whole Number | Yes | |
| Pay component | payrollcomponentId | Reference | Yes | |
| Treatment | treatment | Constant | Yes | How the tax code applies: taxable, exempt, out of scope, or reverse charge. |
| Cap type | capKind | Constant | ||
| Cap amount | amountCap | Currency | ||
| Tax | taxId | Reference | Yes | |
| 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 |
Relations
| Field | Points to | Kind |
|---|---|---|
Pay component payrollcomponentId | Pay components | reference |
Tax taxId | Company taxes | reference |
Actions
What you can do with a record. Every action also sends the webhook event payrollcomponenttreatments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a treatment for this pay component and tax. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this treatment. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this treatment. It leaves active lists and pickers, and most actions stop. The pay component and the tax themselves are kept. Unarchive to restore the treatment. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this treatment to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Remove this treatment. The pay component and the tax themselves are kept. 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 |