Create a payroll

The ID of the source regular payroll for off_cycle payrolls.

Only allowed when creating a Payroll of type off_cycle. The source payroll must be a regular payroll on the same pay-schedule.

The type of payroll. regular payrolls are generated automatically on the Pay Schedule. off_cycle Payrolls are created manually against a source regular payroll. historical and correction payrolls are used to record or correct prior periods.

An optional note on the payroll, visible to the partner.

The start date of the pay period.

When creating a payroll of type historical or correction, a period_start date is required. A period_start date is prohibited on a off_cycle payroll.

The end date of the pay period.

When creating a payroll of type historical or correction, a period_end date is required. A period_end date is prohibited on a off_cycle payroll.

For payrolls on a custom-frequency Pay Schedule, the pay frequency for this specific pay period.

Only allowed when creating a regular payroll on a custom frequency pay schedule where frequency is defined per payroll.

The date on which Employees and Contractors are paid.

For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment.

Only allowed when creating a regular payroll on a custom frequency pay schedule.

The unique identifier of the object in Nmbr.

The type of the object in Nmbr ("payroll").