> ## 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 indemnity values of resources over a date range, one entry per indemnity and resource it is computed for. The number of distinct resources multiplied by the number of days in the date range must not exceed 10,000, whatever the number of indemnities.

> [!WARNING]
>
> This endpoint is in preview: it may change without notice until it becomes part of a stable version.


## OpenAPI

````yaml preview post /api/balances/indemnity-values.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: Document
    description: Document
  - name: Expenses
    description: Expenses
  - name: Instance
    description: Instance
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/balances/indemnity-values.list:
    post:
      tags:
        - Balances
      summary: List
      description: >-
        Lists the indemnity values of resources over a date range, one entry per
        indemnity and resource it is computed for. The number of distinct
        resources multiplied by the number of days in the date range must not
        exceed 10,000, whatever the number of indemnities.
      operationId: post_app_ui_api_balances_indemnities_indemnityquery_listindemnityvalues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListIndemnityValuesQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndemnityValueView'
components:
  schemas:
    ListIndemnityValuesQuery:
      required:
        - indemnity_ids
        - resource_ids
        - date_range
      properties:
        indemnity_ids:
          description: >-
            The indemnities disabled, not valid over the date range, or
            restricted to teams that are not reported on are left out.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        resource_ids:
          description: >-
            The resources the caller cannot view the indemnities of over the
            date range are left out.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        date_range:
          $ref: '#/components/schemas/LocalDateInterval'
        team_ids:
          description: >-
            Defaults to, and is limited to, every team the caller can view the
            indemnities of. The indemnities and resources outside these teams
            are left out, but the values count every team of the indemnity, even
            on an instance that scopes indemnities by team in the indemnity
            report.
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
      type: object
      additionalProperties: false
    IndemnityValueView:
      required:
        - indemnity_id
        - resource_id
        - total
        - daily_values
      properties:
        indemnity_id:
          $ref: '#/components/schemas/Snowflake'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        total:
          description: Null when no value could be computed over the date range.
          oneOf:
            - $ref: '#/components/schemas/BalanceValue'
            - type: 'null'
        daily_values:
          description: Only the days the indemnity was computed on, without zero filling.
          type: array
          items:
            $ref: '#/components/schemas/IndemnityDailyValueView'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateInterval:
      type: string
      format: local-date-interval
      example: 2019-11-11/2019-12-12
    BalanceValue:
      required:
        - value
        - output_format
        - error
      properties:
        value:
          type:
            - number
            - 'null'
          format: float
        output_format:
          $ref: '#/components/schemas/OutputFormat'
        error:
          type:
            - string
            - 'null'
      type: object
    IndemnityDailyValueView:
      required:
        - date
        - value
      properties:
        date:
          $ref: '#/components/schemas/LocalDate'
        value:
          $ref: '#/components/schemas/BalanceValue'
          description: >-
            When the day could not be computed, `value.value` is null and
            `value.error` tells why, as free text that is not translated and may
            change.
      type: object
    OutputFormat:
      type: string
      example: days
      enum:
        - days
        - hours
        - units
    LocalDate:
      type: string
      format: local-date
      example: '2019-11-11'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.