> ## 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.

# Show effective

> Retrieves the effective time blocks (worked, absence, on-call, etc.) of the given resources over a time range, returned as-is (not aggregated by day) and sorted by time range. Resources the caller is not allowed to see are silently omitted from the response, and each block only carries the relation ids relevant to its kind.

<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/resources.show-effective
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/resources.show-effective:
    post:
      tags:
        - Balances
      summary: Show effective
      description: >-
        Retrieves the effective time blocks (worked, absence, on-call, etc.) of
        the given resources over a time range, returned as-is (not aggregated by
        day) and sorted by time range. Resources the caller is not allowed to
        see are silently omitted from the response, and each block only carries
        the relation ids relevant to its kind.
      operationId: post_app_ui_api_balances_resourcesummaryquery_showeffective
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShowEffectiveQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EffectiveTimeRangeView'
components:
  schemas:
    ShowEffectiveQuery:
      required:
        - resource_ids
        - time_range
      properties:
        resource_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
      type: object
    EffectiveTimeRangeView:
      required:
        - id
        - resource_id
        - team_id
        - kind
        - is_presence
        - time_range
        - duration
        - tag_ids
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        resource_id:
          $ref: '#/components/schemas/Snowflake'
        team_id:
          $ref: '#/components/schemas/Snowflake'
        kind:
          $ref: '#/components/schemas/EffectiveTimeRangeKind'
        is_presence:
          type: boolean
        time_range:
          $ref: '#/components/schemas/LocalDateTimeInterval'
        duration:
          $ref: '#/components/schemas/Duration'
        tag_ids:
          type: array
          items:
            $ref: '#/components/schemas/Snowflake'
        absence_type_id:
          $ref: '#/components/schemas/Snowflake'
        absence_id:
          $ref: '#/components/schemas/Snowflake'
        schedule_id:
          $ref: '#/components/schemas/Snowflake'
        schedule_template_id:
          $ref: '#/components/schemas/Snowflake'
        schedule_template_type_id:
          $ref: '#/components/schemas/Snowflake'
        timecheck_id:
          $ref: '#/components/schemas/Snowflake'
        on_call_id:
          $ref: '#/components/schemas/Snowflake'
        compensation_id:
          $ref: '#/components/schemas/Snowflake'
      type: object
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    LocalDateTimeInterval:
      type: string
      format: local-date-time-interval
      example: 2019-11-11T12:34:56/2019-12-12T23:59:59
    EffectiveTimeRangeKind:
      type: string
      example: compensation
      enum:
        - compensation
        - adjustment
        - absence
        - schedule
        - timecheck
        - on-call
        - paid-break
    Duration:
      description: '[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)'
      type: string
      format: duration
      example: PT1H30M20S

````