Common ModelsPayroll runs

The PayrollRun object

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

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
run_stateenum or nullOptional

The state of the payroll run

  • PAID - PAID
  • DRAFT - DRAFT
  • APPROVED - APPROVED
  • FAILED - FAILED
  • CLOSED - CLOSED
Allowed values:
run_typeenum or nullOptional

The type of the payroll run

  • REGULAR - REGULAR
  • OFF_CYCLE - OFF_CYCLE
  • CORRECTION - CORRECTION
  • TERMINATION - TERMINATION
  • SIGN_ON_BONUS - SIGN_ON_BONUS
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_deletedbooleanOptional

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 nullOptional
remote_datalist of objects or nullOptional