For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The EmployeePayrollRun object
          • GET/employee-payroll-runs
          • GET/employee-payroll-runs/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEmployee payroll runs

The EmployeePayrollRun object

The EmployeePayrollRun Object
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  "employee": "string",
7  "payroll_run": "string",
8  "gross_pay": 1,
9  "net_pay": 1,
10  "start_date": "2023-01-01T00:00:00Z",
11  "end_date": "2023-01-01T00:00:00Z",
12  "check_date": "2023-01-01T00:00:00Z",
13  "earnings": [
14    {
15      "id": "string",
16      "remote_id": "string",
17      "created_at": "2023-01-01T00:00:00Z",
18      "modified_at": "2023-01-01T00:00:00Z",
19      "employee_payroll_run": "string",
20      "amount": 1,
21      "type": "SALARY",
22      "remote_was_deleted": true,
23      "field_mappings": {},
24      "remote_data": [
25        {
26          "path": "string",
27          "data": {}
28        }
29      ]
30    }
31  ],
32  "deductions": [
33    {
34      "id": "string",
35      "remote_id": "string",
36      "created_at": "2023-01-01T00:00:00Z",
37      "modified_at": "2023-01-01T00:00:00Z",
38      "employee_payroll_run": "string",
39      "name": "string",
40      "employee_deduction": 1,
41      "company_deduction": 1,
42      "remote_was_deleted": true,
43      "field_mappings": {},
44      "remote_data": [
45        {
46          "path": "string",
47          "data": {}
48        }
49      ]
50    }
51  ],
52  "taxes": [
53    {
54      "id": "string",
55      "remote_id": "string",
56      "created_at": "2023-01-01T00:00:00Z",
57      "modified_at": "2023-01-01T00:00:00Z",
58      "employee_payroll_run": "string",
59      "name": "string",
60      "amount": 1,
61      "employer_tax": true,
62      "remote_was_deleted": true,
63      "field_mappings": {},
64      "remote_data": [
65        {
66          "path": "string",
67          "data": {}
68        }
69      ]
70    }
71  ],
72  "remote_was_deleted": true,
73  "field_mappings": {},
74  "remote_data": [
75    {
76      "path": "string",
77      "data": {}
78    }
79  ]
80}
Was this page helpful?
Previous

/dependents/{id}

Next

/employee-payroll-runs

Built with

The EmployeePayrollRun object is used to represent an employee’s pay statement for a specific payroll run.

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.
employeestring or nullOptionalformat: "uuid"
The employee whose payroll is being run.
payroll_runstring or nullOptionalformat: "uuid"
The payroll being run.
gross_paydouble or nullOptional
The total earnings throughout a given period for an employee before any deductions are made.
net_paydouble or nullOptional

The take-home pay throughout a given period for an employee after deductions are made.

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.
earningslist of objectsOptionalRead-only
deductionslist of objectsOptionalRead-only
taxeslist of objectsOptionalRead-only
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