Pay Rules

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 Rules

Retrieve all pay rules configured for the company. Pay rules define how different types of work hours (ordinary, overtime, weekend, etc.) are calculated and paid. Like pay levels, pay rules can have multiple versions over time to track historical changes.

Query Parameters:

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

Response Fields:

Field	Description
`id`	Unique identifier for the pay rule
`name`	Name of the pay rule (e.g., "Standard", "Overtime")
`description`	Description of the pay rule
`versions`	Array of pay rule versions (historical configurations)
`versions[].id`	Unique identifier for the version
`versions[].name`	Name of the version
`versions[].description`	Description of the version
`versions[].commencedAt`	Date when this version became effective
`versions[].modifiedAt`	Timestamp when the version was last modified
`versions[].modifiedBy.fullName`	Name of the user who last modified the version
`modifiedAt`	Timestamp when the pay rule was last modified
`modifiedBy.fullName`	Name of the user who last modified the pay rule
`deletedAt`	Timestamp when the pay rule was deleted (null if active)

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

Implementation Notes:

Pay rules define the calculation logic for different types of work hours
Each pay rule can have multiple versions to track changes in calculation rules over time
Each version has a commencedAt date indicating when it becomes effective
The versions array may be empty if no versions have been created yet
Only active (non-deleted) pay rules are returned by default (deletedAt is null)
Pay rules are typically assigned to employees in conjunction with pay levels
The modifiedBy field tracks audit information for compliance purposes

GraphQL Query

query PayRules {
  payRules {
    id
    name
    description
    versions {
      id
      name
      description
      commencedAt
      modifiedAt
      modifiedBy {
        fullName
      }
    }
    modifiedAt
    modifiedBy {
      fullName
    }
    deletedAt
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "payRules": [
      {
        "id": "541",
        "name": "Overtime",
        "description": "Apply overtime rate to grouped timesheets",
        "versions": [
          {
            "id": "522",
            "name": "Overtime v1",
            "description": null,
            "commencedAt": "2023-07-24",
            "modifiedAt": "2023-11-07T04:30:19.319Z",
            "modifiedBy": {
              "fullName": "Roubler Support"
            }
          }
        ],
        "modifiedAt": "2023-11-07T04:30:19.306Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      },
      {
        "id": "538",
        "name": "Standard",
        "description": "Standard pay rules",
        "versions": [
          {
            "id": "521",
            "name": "Ordinary, overtime (8+) and weekend hours",
            "description": null,
            "commencedAt": "2021-01-01",
            "modifiedAt": "2023-11-07T04:30:19.324Z",
            "modifiedBy": {
              "fullName": "Roubler Support"
            }
          }
        ],
        "modifiedAt": "2023-11-07T04:30:19.304Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      }
    ]
  }
}