Pay Types

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Query Pay Types

Retrieve all pay types configured for the company. Pay types represent specific categories of pay that result from pay rule calculations (e.g., ordinary hours, overtime, weekend rates).

Query Parameters:

This query takes no parameters and returns all pay types configured for the company.

Response Fields:

Field Description
id Unique identifier for the pay type
name Name of the pay type (e.g., "Ordinary - Standard")
description Description of the pay type
externalId External system identifier for integration purposes
modifiedAt Timestamp when the pay type was last modified
modifiedBy.fullName Name of the user who last modified the pay type

For the complete PayType type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

  • Pay types are used in timesheets and pay runs to categorize how hours are paid
  • Common pay type patterns include "Ordinary", "Overtime", "Weekend", "Public Holiday"
  • The externalId field is used for integration with external payroll systems
  • The modifiedBy field tracks audit information for compliance purposes

GraphQL Query

query PayTypes {
  payTypes {
    id
    name
    description
    externalId
    modifiedAt
    modifiedBy {
      fullName
    }
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "payTypes": [
      {
        "id": "793",
        "name": "Ordinary - Overtime",
        "description": null,
        "externalId": null,
        "modifiedAt": "2023-11-07T04:30:19.316Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        }
      },
      {
        "id": "790",
        "name": "Ordinary - Standard - Standard",
        "description": null,
        "externalId": null,
        "modifiedAt": "2023-11-07T04:30:19.320Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        }
      },
      {
        "id": "788",
        "name": "Overtime - Standard - Standard",
        "description": null,
        "externalId": null,
        "modifiedAt": "2023-11-07T04:30:19.320Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        }
      }
    ]
  }
}