Payroll Runs

Show Company Payroll Runs

Given an ID, shows a payroll run. employee_details field is deprecated in favour of the employee_details endpoint and will be removed in the future.

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}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/payroll-runs/{payroll_run_id}
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

Response

Success

Example response

{
  "payroll_run": {
    "approval_date": "2021-01-15",
    "benefits_total": 1000,
    "country": {
      "alpha_2_code": "PT",
      "code": "PRT",
      "contractor_products_available": [
        "standard",
        "plus",
        "cor"
      ],
      "country_subdivisions": [
        {
          "code": "PT-06",
          "name": "Coimbra",
          "subdivision_type": "District"
        },
        {
          "code": "PT-11",
          "name": "Lisboa",
          "subdivision_type": "District"
        }
      ],
      "employment_agreement_preview_available": true,
      "eor_onboarding": true,
      "global_payroll_supported": true,
      "locked_benefits": "after_first_hire",
      "name": "Portugal",
      "region": "Europe",
      "subregion": "Southern Europe",
      "supported_json_schemas": [
        "additional_documents",
        "address_details",
        "administrative_details",
        "employment-basic-information",
        "bank_account_details",
        "contract_details",
        "emergency_contact"
      ]
    },
    "currency_code": "USD",
    "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"
        }
      }
    ],
    "employer_contributions_total": 1000,
    "expected_payout_date": "2021-01-25",
    "expenses_total": 1000,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "incentives_total": 1000,
    "other_total": 1000,
    "period_end": "2021-01-31",
    "period_start": "2021-01-01",
    "salary_total": 1000,
    "status": "preparing",
    "total_payroll_cost": 1000
  }
}

Changes

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