> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toku.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Employee Compensation Data

> Returns compensation data for every employee in a token payroll.

Required scope: `compensation:read`

## OpenAPI

````yaml api-reference/openapi.json GET /stablecoin-payroll/get-employee-compensation-data
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /stablecoin-payroll/get-employee-compensation-data:
    get:
      operationId: getEmployeeCompensationData
      summary: Get Employee Compensation Data
      x-toku-required-scope: compensation:read
      description: |-
        Returns compensation data for every employee in a token payroll.

        Required scope: `compensation:read`
      parameters:
        - name: tokenPayrollID
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmployeeCompensationDataResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetEmployeeCompensationDataResponse:
      type: object
      properties:
        employees:
          type: array
          items:
            $ref: '#/components/schemas/PayrollTokenFirstReadCompensation'
      required:
        - employees
      description: Request regeneration does not infer response shapes.
    PayrollTokenFirstReadCompensation:
      type: object
      properties:
        employeeId:
          type: string
          format: uuid
          description: >-
            The source explicitly converts display amounts with Number: preserve
            its legacy numeric wire.
        employeeName:
          type: string
        totalCompensation:
          type: number
        totalDeduction:
          type: number
        netPayFiat:
          type: number
        currency:
          type: string
        hasTGAProfile:
          const: true
        hasValidWallet:
          const: true
        hasPayrollError:
          const: false
        hasMinimumWageError:
          const: false
        id:
          type: string
          format: uuid
      required:
        - employeeId
        - employeeName
        - totalCompensation
        - totalDeduction
        - netPayFiat
        - currency
        - hasTGAProfile
        - hasValidWallet
        - hasPayrollError
        - hasMinimumWageError
        - id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
