Payroll calendar versions

A version of a payroll calendar that sets period boundaries and length from a start date.

API name: payrollcalendarversions
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
Payroll calendar	`payrollcalendarId`	Reference	Yes
Period boundary	`boundary`	Constant	Yes
Frequency	`frequency`	Constant	Yes
Days per period	`countDay`	Whole Number
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

Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.

Field	Points to	Kind
Payroll calendar `payrollcalendarId`	Payroll calendars	owned by

Actions

What you can do with a record. Every action also sends the webhook event payrollcalendarversions.<action>. Reads (find, get, count) work on every table.

Name	API name	Description	Where
Create	`create`	Add a new calendar version.	App · WebMCP · API · MCP · CLI
Edit	`update`	Save changes to this calendar version.	App · API · MCP · CLI
Generate periods	`generate`	Generate payroll periods from this published version.	App · API · MCP · CLI
Delete	`delete`	Delete this calendar version 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.

Action	API name
Publish	`publish`