v4

latestOpenAPI 3.0.02026-07-314441026.8 MB

Pay Schedules

Update a pay schedule

Pay-Schedules with non-draft Payrolls (e.g approved or paid) may only have their title and title_translations fields updated.

put/pay_schedules/{pay_schedule}

Path parameters

pay_schedulestring required

Request body

titlestring

pay_frequency'bi-weekly' | 'custom' | 'monthly' | 'semi-monthly' | 'weekly'

The frequency at which Payrolls are processed. Use custom for non-standard schedules where the number of pay periods per year is specified manually.

Editing is prevented when is_editable is false

anchor_pay_datestring date

The pay date of the anchor pay period. Together with anchor_end_of_pay_period, this establishes the pattern from which all future pay dates are calculated.

Date must not be more than one year before the date the pay schedule is created.

Editing is prevented when is_editable is false

anchor_start_of_pay_periodstring date

The start date of the anchor pay period. Only required for semi-monthly pay schedules when anchor_end_of_pay_period is not the 15th or the last day of the month. For standard configurations it is derived automatically and does not need to be supplied.

Required for semi-monthly pay schedules when anchor_end_of_pay_period is not the 15th or the last day of the month.

Editing is prevented when is_editable is false

anchor_end_of_pay_periodstring date

The end date of the anchor pay period. Together with anchor_pay_date, this defines the length and pattern of all future pay periods.

Date must not be more than one year before the date the pay schedule is created.

Editing is prevented when is_editable is false

generate_payrolls_fromstring date

Only available in preview mode. When set, Payrolls are generated starting from this date rather than the default, allowing historical Payrolls to be created before the current date.

Available in Preview mode, allows for the creation of Payrolls from an arbitrary date before the current date. Must be on or after anchor_pay_date.

Editing is prevented when is_editable is false

day_1integer

For monthly pay schedules, the day of the month on which pay is issued. For semi-monthly pay schedules, the first of two pay days per month.

Day_1 is required for monthly and semi-monthly pay schedules. Otherwise, it must be null. On semi-monthly pay schedules, valid (day_1, day_2) pairs are (16, 1), (15, -1) or (15, 31).

Editing is prevented when is_editable is false

day_2integer

For semi-monthly pay schedules, the second of two pay days per month.

day_2 is required for semi-monthly pay schedules. Otherwise, it must be null. On semi-monthly pay schedules, valid (day_1, day_2) pairs are (16, 1), (15, -1) or (15, 31).

Editing is prevented when is_editable is false

pay_day_movement_setting'inherit' | 'next_business_day' | 'previous_business_day'

The pay schedule-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to inherit, the Business Entity's setting is used.

Editing is prevented when is_editable is false

send_empty_pay_stubsboolean

Whether Pay Stubs are generated for employees with no earnings in a given pay period.

custom_pay_periods_per_yearinteger

When pay_frequency is custom, the number of pay periods per year.

external_refstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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