PayPeriod

Indicates the fixed time span of employee’s work hours and earnings that are recorded and calculated for payroll. This object is available in API version 66.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Name

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The name of the pay period.

ExternalId

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The external ID of the pay period.

StartDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The start date of the pay period.

EndDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The end date of the pay period.

PayDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The payment date for the employees.

PayGroup

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The group of employees that get paid during the same pay periods. This field is a relationship field.
Relationship Name: PayGroup
Refers To: PayGroup