The PayrollRun object

The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

run_stateenum or nullOptional

The state of the payroll run. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=run_state to receive the integration's own value instead.

Allowed values:

run_typeenum or nullOptional

The type of the payroll run. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=run_type to receive the integration's own value instead.

Allowed values:

start_datedatetime or nullOptional

The day and time the payroll run started.

end_datedatetime or nullOptional

The day and time the payroll run ended.

check_datedatetime or nullOptional

The day and time the payroll run was checked.

remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only