The pay schedule object

Represents a schedule on which a company pays its employees.

Use a pay schedule object to create a calendar of paydays specific to a company.

{
    "id": "psc_KpOEeeH3kWMrxyzffjcn",
    "company": "com_FeToKDOuUyvQrQADcY2u",
    "name": "Test Schedule",
    "pay_frequency": "biweekly",
    "first_payday": "2021-04-16",
    "second_payday": null,
    "first_period_end": "2021-04-12",
    "metadata": {}
}

Attribute

Description

id
string

Unique identifier for the pay schedule.

company
string

ID of the company that this pay schedule relates to.

name
string

Human-readable name of the pay schedule.

pay_frequency
string

Frequency by which employees get paid.

One of weekly, biweekly, semimonthly, monthly, quarterly, or annually.

first_payday
YYYY-MM-DD

The payday date of the first payroll the company will run on Check on this pay schedule.

second_payday
YYYY-MM-DD

The payday date of the the second payroll the company will run on Check on this pay schedule. This field should only be used with the semimonthly frequency to specify custom paydays besides the 15th and last day of the month. second_payday must be between one day and one month after first_payday.

first_period_end
YYYY-MM-DD

The period end date of the first payroll the company will run on Check on this pay schedule.

metadata
object

Additional loosely structured information to associate with the pay schedule.