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 PayrollRun object
          • GET/payroll-runs
          • GET/payroll-runs/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsPayroll runs

The PayrollRun object

The PayrollRun 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  "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  "remote_data": [
14    {
15      "path": "string",
16      "data": {}
17    }
18  ]
19}
Was this page helpful?
Previous

/pay-groups/{id}

Next

/payroll-runs

Built with

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.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only