---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Get employee rates by contract

Get employee rates by contract.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "EmployeeRateGetEmployeeRateByContractResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "totalCount": {
            "type": "integer",
            "format": "int64"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/v2modelEmployeeRate"
            }
          }
        }
      },
      "modelRateDetail": {
        "type": "object",
        "properties": {
          "agreementId": {
            "type": "integer",
            "format": "int64",
            "title": "The agreement id of the rate"
          },
          "contractId": {
            "type": "integer",
            "format": "int64",
            "title": "the contract the base rate belongs to"
          },
          "locationName": {
            "type": "string",
            "title": "Name of the location to which the rate belongs"
          },
          "areaRateId": {
            "type": "integer",
            "format": "int64",
            "title": "The area rate id of the rate. Only set when this is area rate"
          },
          "areaName": {
            "type": "string",
            "title": "The name of the area to which the rate belongs. Only set when this is area rate"
          },
          "areaId": {
            "type": "integer",
            "format": "int64",
            "title": "The area id (i.e. operationalUnitId). Only set when this is area rate"
          },
          "rate": {
            "type": "number",
            "format": "double",
            "title": "The rate value.\nWhen retrieving rate details, if was main rate, then this is `agreement.base_rate`, or basePayRule.hourlyRate as fallback; If was area rate, then this is `area_rate.base_rate`\nWhen updating rate details, this is the new rate value"
          }
        },
        "title": "Rate represents the details of the employee rate, either main rate or area rate, and related location and area"
      },
      "v2modelEmployeeRate": {
        "type": "object",
        "properties": {
          "employeeId": {
            "type": "integer",
            "format": "int64"
          },
          "employeeName": {
            "type": "string"
          },
          "rates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/modelRateDetail"
            }
          }
        },
        "title": "EmployeeRate represents the rates of an employee linked to a specific contract, contains a list of rate details"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/management/v2/compliance/employee-rates": {
      "get": {
        "operationId": "ComplianceV2Controller_getEmployeeRatesByContract",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmployeeRateGetEmployeeRateByContractResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "contractId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "pageToken",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "tags": [
          "Compliance"
        ],
        "summary": "Get employee rates by contract",
        "description": "Get employee rates by contract."
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```