Payroll Runs

Get Employee Details for a Payroll Run

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.
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.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See 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)	-

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
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: payroll_run:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: payroll_run:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

payroll_run_idstring required

Payroll run ID

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": {
    "employee_details": [
      {
        "base_salary": {
          "amount": 1000,
          "currency": "USD"
        },
        "benefits": {
          "amount": 100,
          "currency": "USD"
        },
        "deductions": {
          "amount": 200,
          "currency": "USD"
        },
        "employer_costs": {
          "amount": 100,
          "currency": "USD"
        },
        "expenses": {
          "amount": 100,
          "currency": "USD"
        },
        "full_name": "John Doe",
        "gross_pay": {
          "amount": 1000,
          "currency": "USD"
        },
        "incentives": {
          "amount": 100,
          "currency": "USD"
        },
        "net_pay": {
          "amount": 800,
          "currency": "USD"
        },
        "other": {
          "amount": 100,
          "currency": "USD"
        },
        "payslip_id": "123e4567-e89b-12d3-a456-426614174000",
        "total_cost": {
          "amount": 1000,
          "currency": "USD"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.