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 * `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_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](https://docs.merge.dev/integrations/hris/supported-features/).

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

1	{
2	"id": "string",
3	"remote_id": "string",
4	"created_at": "2023-01-01T00:00:00Z",
5	"modified_at": "2023-01-01T00:00:00Z",
6	"run_state": "PAID",
7	"run_type": "REGULAR",
8	"start_date": "2023-01-01T00:00:00Z",
9	"end_date": "2023-01-01T00:00:00Z",
10	"check_date": "2023-01-01T00:00:00Z",
11	"remote_was_deleted": true,
12	"field_mappings": {
13	"organization_defined_targets": {
14	"string": {}
15	},
16	"linked_account_defined_targets": {
17	"string": {}
18	}
19	},
20	"remote_data": [
21	{
22	"path": "string",
23	"data": {}
24	}
25	]
26	}