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

# Get Time Off Balance By Id

> Returns a TimeOffBalance object with the given id.



## OpenAPI

````yaml get /api/hris/v1/time-off-balances/{id}
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/hris/v1/time-off-balances/{id}:
    get:
      tags:
        - Time Off Balance
      summary: Get Time Off Balance By Id
      description: Returns a TimeOffBalance object with the given id.
      operationId: get_time_off_balance_by_id_api_hris_v1_time_off_balances__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Id
        - name: include_raw_data
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Whether to include the original data Bindbee fetched from the
              third-party to produce these models.
            examples:
              - false
            default: false
            title: Include Raw Data
          description: >-
            Whether to include the original data Bindbee fetched from the
            third-party to produce these models.
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            examples:
              - false
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
        - name: expand
          in: query
          required: false
          schema:
            type: string
            description: >-
              Which relations should be returned in expanded form. Multiple
              relation names should be comma separated without spaces. You can
              also specify required fields in [] for each relation name.
            examples:
              - manager[first_name,last_name]
            title: Expand
          description: >-
            Which relations should be returned in expanded form. Multiple
            relation names should be comma separated without spaces. You can
            also specify required fields in [] for each relation name.
        - name: x-connector-token
          in: header
          required: true
          schema:
            type: string
            title: X-Connector-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrisTimeOffBalance'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HrisTimeOffBalance:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          examples:
            - 018b18ef-c487-703c-afd9-0ca478ccd9d6
        remote_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Id
          description: The third-party API ID of the matching object.
          examples:
            - '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          examples:
            - '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          examples:
            - key_1: Platform dependent data 1
              key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          examples:
            - category_group: REG
              disability_type: ASBERG
              hire_date: '1991-03-16T00:00:00'
              hire_source: REFER
              nationality: USA
              original_hire_date: '1991-03-16T00:00:00'
        employee:
          anyOf:
            - {}
            - type: 'null'
          title: Employee
          description: The employee the balance belongs to.
          examples:
            - 018b48d5-79f8-7deb-8813-3e47b375067e
        balance:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Balance
          description: >-
            The current remaining PTO balance, always measured in terms of
            hours.
          examples:
            - 12
        used:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Used
          description: The amount of PTO used in terms of hours.
          examples:
            - 7
        policy_type:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - VACATION
            - SICK
            - PERSONAL
            - JURY_DUTY
            - VOLUNTEER
            - BEREAVEMENT
            - MATERNITY
            - ANNUAL_LEAVE
            - EMERGENCY_LEAVE
            - LEAVE_OF_ABSENCE
            - PATERNITY
            - PAID_TIME_OFF
            - LONG_TERM_DISABILITY
            - SHORT_TERM_DISABILITY
            - COMP_OFF
            - WORK_FROM_HOME
            - COMPASSIONATE
            - TIME_OFF
            - FMLA
          title: Policy Type
          description: >-
            The policy type of this time off balance. If the value is not one of
            the defined enum values, the original value passed through will be
            returned.
          examples:
            - VACATION
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
        - employee
        - balance
        - used
        - policy_type
      title: HrisTimeOffBalance
      description: >-
        The TimeOffBalance object is used to represent current balances for an
        employee's Time Off plan.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````