Pay Tags

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 Tags

Retrieve all pay tags configured for the company. Pay tags are used to categorize and label different types of pay for reporting purposes.

Query Parameters:

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

Response Fields:

Field Description
id Unique identifier for the pay tag
name Name of the pay tag (e.g., "Ordinary Hours", "Overtime")
description Description of the pay tag
externalId External system identifier for integration purposes
modifiedAt Timestamp when the pay tag was last modified
modifiedBy.fullName Name of the user who last modified the pay tag
deletedAt Timestamp when the pay tag was deleted (null if active)

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

Implementation Notes:

  • Pay tags are used to categorize pay items for reporting and payroll integration
  • Only active (non-deleted) pay tags are returned by default (deletedAt is null)
  • The externalId field is used for integration with external payroll systems
  • Pay tags help organize pay data by type (e.g., ordinary time, overtime, penalty rates)
  • Tags can be associated with pay types to provide additional categorization
  • The modifiedBy field tracks audit information for compliance purposes

GraphQL Query

query PayTags {
  payTags {
    id
    name
    description
    externalId
    modifiedAt
    modifiedBy {
      fullName
    }
    deletedAt
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "payTags": [
      {
        "id": "41",
        "name": "Ordinary Hours",
        "description": null,
        "externalId": null,
        "modifiedAt": "2024-06-06T03:29:32.500Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      },
      {
        "id": "42",
        "name": "Overtime x1.5",
        "description": null,
        "externalId": null,
        "modifiedAt": "2024-06-06T03:29:45.299Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      },
      {
        "id": "43",
        "name": "Overtime x2.0",
        "description": null,
        "externalId": null,
        "modifiedAt": "2024-06-06T03:29:50.979Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      }
    ]
  }
}