Pay & Compensation
Pay Items

List Pay Codes

Changed on

Lists pay codes available for a legal entity. Pay codes represent the allowed pay element types that can be submitted via POST /v1/pay-items/bulk.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)View pay items (pay_item:read)Manage pay items (pay_item:write)
get/v1/companies/{company_id}/legal-entities/{legal_entity_id}/pay-codes

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/companies/{company_id}/legal-entities/{legal_entity_id}/pay-codes
  • Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, pay_item:read, pay_item:write, payroll, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, pay_item:read, pay_item:write, payroll, all:write, all:read)

Path parameters

company_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Company ID

legal_entity_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Legal entity ID

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "pay_codes": [
    {
      "category": "time_and_attendance",
      "code": "overtime",
      "custom_configuration": {
        "key": "gbr_hourly_flat_rate",
        "label": "UK Hourly Flat Rate",
        "required": false,
        "schema": {
          "properties": {
            "hourly_rate": {
              "minimum": 1,
              "type": "integer"
            }
          },
          "required": [
            "hourly_rate"
          ],
          "type": "object"
        }
      },
      "description": "Hours worked beyond standard schedule",
      "external_import_code": null,
      "name": "Overtime",
      "slug": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "type": "hours"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

  • 011e5a8b97f5Revision changes
    • info

      added the optional property /// to the response with the status

  • 80e3dace341eRevision changes
    • breaking

      the /// response's property type changed from no type to string, and format from no format to uuid for status

    • info

      removed from the /// response property allOf list for the response status