/payroll-runs/{id}

{
  "id": "37336947-b3d4-4a4c-a310-ab6ab510e079",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "run_state": "PAID",
  "run_type": "REGULAR",
  "start_date": "2020-11-08T00:00:00Z",
  "end_date": "2020-11-15T00:00:00Z",
  "check_date": "2020-11-15T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/payroll",
      "data": null
    }
  ]
}

Returns a PayrollRun object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

Allowed values:

Response

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. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=run_state to receive the integration’s own value instead.

Allowed values:

run_typeenum or nullOptional

The type of the payroll run. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=run_type to receive the integration’s own value instead.

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

/payroll-runs/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration