Payroll inputs
An instruction to include a pay component for an employee in a period or date range.
- API name:
payrollinputs - 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 | |
| Employee | employeeId | Reference | Yes | |
| Quantity | quantity | Decimal | Quantity in the catalog unit after any unit conversion on the line. | |
| Pay component | payrollcomponentId | Reference | Yes | |
| Pay period | payrollperiodId | Reference | ||
| Run revision | payrollrunrevisionId | Reference | ||
| Period start | dateStart | Date | ||
| Period end | dateEnd | Date | ||
| Amount | amount | Currency | ||
| Resolved amount | amountResolved | Currency | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | 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 component payrollcomponentId | Pay components | reference |
Pay period payrollperiodId | Payroll periods | reference |
Run revision payrollrunrevisionId | Payroll run revisions | reference |
Actions
What you can do with a record. Every action also sends the webhook event payrollinputs.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new payroll input. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this payroll input. | App · WebMCP · API · MCP · CLI |
| Approve | approve | Approve this payroll input so the next step can run. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this payroll input. 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 payroll input again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this payroll input 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 payroll input to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this payroll input 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.