Employee salaries
The salary amount that an employee earns under a pay structure for a date range.
- API name:
employeesalaries - Domain: Employment
- 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 | |
| Employee | employeeId | Reference | Yes | |
| Pay structure | payrollstructureId | Reference | Yes | |
| Cost center | accountingcostcenterId | Reference | ||
| Amount | amount | Currency | Yes | |
| Currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Valid from | dateFrom | Date | 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 | |
| Started by | startedBy | User | ||
| Started at | startedAt | Date and Time | ||
| Ended by | endedBy | User | ||
| Ended at | endedAt | 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 |
|---|---|---|
Employee employeeId | Employees | grouped by |
Pay structure payrollstructureId | Pay structures | reference |
Cost center accountingcostcenterId | Cost centers | reference |
Actions
What you can do with a record. Every action also sends the webhook event employeesalaries.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new salary. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this salary. | App · WebMCP · API · MCP · CLI |
| Start | start | Start this salary and open the work. | App · WebMCP · API · MCP · CLI |
| End | end | End this action. The work stops. This cannot be undone. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this salary. 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 salary again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this salary 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 salary to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this salary 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.