REremote-com
Pay Items

List Pay Codes

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 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.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • 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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage payroll runs (payroll)View pay items (pay_item:read)Manage pay items (pay_item:write)
Company-scoped access token (assertion)Manage payroll runs (payroll)View pay items (pay_item:read)Manage pay items (pay_item:write)
Client credentials access tokenManage payroll runs (payroll)--
Customer API tokenManage 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: /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: pay_item: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: pay_item: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 OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: payroll
    • 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

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

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