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

# List

> Lists the compensation types configured on the instance, to resolve the compensation ids referenced by other endpoints (e.g. the daily summary's `compensation_hours`). Expired compensations are included, as historical data may still reference them.

<Warning>This route is in preview: it may change without notice until it becomes part of a stable version.</Warning>


## OpenAPI

````yaml preview post /api/balances/compensations.list
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Schedule
    description: Schedule
  - name: Timeclock
    description: Timeclock
paths:
  /api/balances/compensations.list:
    post:
      tags:
        - Balances
      summary: List
      description: >-
        Lists the compensation types configured on the instance, to resolve the
        compensation ids referenced by other endpoints (e.g. the daily summary's
        `compensation_hours`). Expired compensations are included, as historical
        data may still reference them.
      operationId: post_app_ui_api_balances_compensationquery_listcompensations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCompensationsQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompensationView'
components:
  schemas:
    ListCompensationsQuery:
      type: object
    CompensationView:
      required:
        - id
        - name
        - rate
        - validity_date_range
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          type: string
        rate:
          $ref: '#/components/schemas/Percentage'
        validity_date_range:
          $ref: '#/components/schemas/LocalDateInterval'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    Percentage:
      type: number
      format: percentage
      example: 100
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12

````