--- title: "Get Employee Details for a Payroll Run" method: GET path: "/v1/payroll-runs/{payroll_run_id}/employee-details" tags: ["Payroll Runs"] --- # Get Employee Details for a Payroll Run `GET /v1/payroll-runs/{payroll_run_id}/employee-details` ## Request - Base URL: `https://gateway.remote.com` - URL: `https://gateway.remote.com/v1/payroll-runs/{payroll_run_id}/employee-details` - Auth: one of: - OAuth 2 - Authorization code: `/auth/oauth2/authorize` - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage` - OAuth 2 - Authorization code: `/auth/oauth2/authorize` - Token URL: `/auth/oauth2/token` scopes: `payroll_run:read` - OAuth 2 - Authorization code: `/auth/oauth2/authorize` - Token URL: `/auth/oauth2/token` scopes: `all:read` - OAuth 2 - Authorization code: `/auth/oauth2/authorize` - Token URL: `/auth/oauth2/token` scopes: `all:write` - OAuth 2 - Client credentials - Token URL: `/auth/oauth2/token` scopes: `payroll_run:read` - OAuth 2 - Client credentials - Token URL: `/auth/oauth2/token` scopes: `all:read` - OAuth 2 - Client credentials - Token URL: `/auth/oauth2/token` scopes: `all:write` - HTTP bearer Gets the employee details for a payroll run ## Authentication This endpoint accepts any one of the following token types: - **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners). - **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion). - **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers). ## Scopes Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too. | Token type | Category | Read only Scope | Write only Scope (read access implicit) | |---|---|---|---| | Company-scoped access token | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | | Company-scoped access token (assertion) | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | | Customer API token | Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - | ## Path parameters - `payroll_run_id` string, required ## Query parameters - `page` integer - `page_size` integer ## Response `200` Success - EmployeeDetailsResponse: Paginated response containing per-employee payroll cost breakdowns for a specific payroll run. - `data` object, required - `employee_details` EmployeeDetails[], required: List of per-employee cost breakdowns for the payroll run. - `base_salary` object, required: The employee's base salary component for this payroll period. When the payroll run is in `preparing` or `processing` status, this is an estimate that may change after final payroll calculations. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `benefits` object, required: Total cost of employee benefits (health insurance, pension, etc.) for this payroll run. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `deductions` object, required: Total deductions from the employee's gross pay, including taxes and social contributions. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `employer_costs` object, required: Total employer-side contributions and costs (employer social contributions, taxes, etc.) beyond the employee's gross pay. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `employment_id` string, uuid: The unique identifier of the employment record for this employee. - `expenses` object, required: Total approved expenses reimbursed to the employee in this payroll run. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `full_name` string, nullable, required: The full name of the employee. May be null if the employee's profile is incomplete. - `gross_pay` object, required: The employee's gross pay before any deductions. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `incentives` object, required: Total incentives (bonuses, commissions, etc.) paid to the employee in this payroll run. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `net_pay` object, required: The net amount paid to the employee after all deductions (taxes, social contributions, etc.). Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `other` object, required: Any other payroll components not categorized as salary, benefits, expenses, or incentives. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. - `payslip_id` string, uuid, nullable, required: The unique identifier of the employee's payslip for this payroll run. Null when the payroll run is still in `preparing` or `processing` status and payslips have not yet been generated. - `total_cost` object, required: The total cost to the employer for this employee in this payroll run, including salary, benefits, employer contributions, expenses, and incentives. Amount in cents. - `amount` integer: Amount in cents. - `currency` string: ISO 4217 currency code. ## Other responses - `401`: Unauthorized - `404`: Not Found - `422`: Unprocessable Entity --- [API](https://skmtc.dev/remote-com/apis/pay-compensation.md) - [All operations](https://skmtc.dev/remote-com/apis/pay-compensation/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/pay-compensation/revisions/ec29f1865c5e?raw)