/employee-payroll-runs/{id}

curl -G https://api.merge.dev/api/hris/v1/employee-payroll-runs/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     --data-urlencode expand=employee,payroll_run

{
  "id": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
  "gross_pay": 1342.67,
  "net_pay": 865.78,
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-09T00:00:00Z",
  "check_date": "2020-11-10T00:00:00Z",
  "earnings": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 1002.34,
      "type": "SALARY"
    },
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "amount": 8342.34,
      "type": "OVERTIME"
    }
  ],
  "deductions": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "Social Security",
      "employee_deduction": 34.54,
      "company_deduction": 78.78
    }
  ],
  "taxes": [
    {
      "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5",
      "name": "California State Income Tax",
      "amount": 100.25,
      "employer_tax": "False"
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/employee-payroll"
    }
  ]
}

Returns an EmployeePayrollRun object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

employeestring or nullformat: "uuid"

The employee whose payroll is being run.

payroll_runstring or nullformat: "uuid"

The payroll being run.

gross_paydouble or null

The total earnings throughout a given period for an employee before any deductions are made.

net_paydouble or null

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

start_datedatetime or null

The day and time the payroll run started.

end_datedatetime or null

The day and time the payroll run ended.

check_datedatetime or null

The day and time the payroll run was checked.

earningslist of objectsRead-only

deductionslist of objectsRead-only

taxeslist of objectsRead-only

remote_was_deletedbooleanRead-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 nullRead-only

remote_datalist of objects or nullRead-only

Authentication

Path parameters

Headers

Query parameters

Response