Retrieve a pay schedule

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pay_schedule

string

required

Query Parameters

expand

enum<string>[]

Available options:

business_entity,

payrolls

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Default · object

Default
With business_entity expanded
With payrolls expanded

Hide child attributes

data.business_entity

object

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.title

string

Maximum string length: 255

data.pay_frequency

enum<string>

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

Available options:

bi-weekly,

custom,

monthly,

semi-monthly,

weekly

data.anchor_pay_date

string<date> | null

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.

data.anchor_start_of_pay_period

string<date> | null

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.

data.anchor_end_of_pay_period

string<date> | null

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

data.generate_payrolls_from

string<date> | null

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.

data.day_1

integer | null

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.

data.day_2

integer | null

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

data.pay_day_movement_setting

enum<string>

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.

Available options:

inherit,

next_business_day,

previous_business_day

data.send_empty_pay_stubs

boolean

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

data.pay_stub_settings

object

Settings that control Pay Stub display. The show_vacation_pay_balance field, when true, causes the employee's current Vacation Pay balance to appear on Pay Stubs.

Hide child attributes

data.pay_stub_settings.show_vacation_pay_balance

boolean

data.custom_pay_periods_per_year

integer | null

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

data.is_editable

boolean

Whether the pay schedule's configuration can be edited. A pay schedule becomes non-editable once any of its Payrolls have been approved or paid. When false, only the title field may be updated.

data.is_deletable

boolean

Whether the pay schedule can be deleted. A pay schedule may not be deleted once any of its Payrolls have been approved or paid. In preview mode, any pay schedule may be deleted.

data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.