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

# Get the caller's weekly work-hours summary.



## OpenAPI

````yaml /api-reference/portal.v1.json get /api/v1/portal/employee/time-entries/weekly-summary
openapi: 3.0.3
info:
  title: Swiss HR Easy — Employee Portal API
  version: 1.0.0
  description: >-
    Versioned contract for the employee self-service portal endpoints consumed
    by the mobile app. Generated from Zod schemas — do not edit by hand (run
    `npm run gen:openapi`).
servers:
  - url: https://{tenantHost}
    description: >-
      Per-tenant deployment host. Swiss HR Easy is single-tenant, so each
      customer install serves this contract from its own host.
security: []
tags:
  - name: profile
    description: Employee profile overview and entitlements.
  - name: leave
    description: Employee leave balances and requests.
  - name: time
    description: Employee time tracking and weekly summaries.
  - name: sick-leave
    description: Employee sick-leave reports and summaries.
  - name: payslips
    description: Employee payslips and deduction breakdowns.
  - name: compensation
    description: The caller's compensation role, salary band and placement rationale.
  - name: auth
    description: Current-session retrieval and logout for the mobile app.
  - name: holidays
    description: >-
      The days behind the vacation day count that cost less than a full day:
      public holidays, school holidays, and Betriebsferien days the caller was
      approved to work through.
paths:
  /api/v1/portal/employee/time-entries/weekly-summary:
    get:
      tags:
        - time
      summary: Get the caller's weekly work-hours summary.
      operationId: getWeeklySummary
      parameters:
        - name: weekStart
          in: query
          required: false
          description: Monday (YYYY-MM-DD) of the week to summarise. Defaults to this week.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: The weekly work-hours summary.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/WeeklySummaryDTO'
        '400':
          description: The weekStart query parameter is not in YYYY-MM-DD format.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
        '401':
          description: The caller is not authenticated.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
        '404':
          description: No employee record is linked to the caller's account.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
components:
  schemas:
    WeeklySummaryDTO:
      type: object
      properties:
        weekStart:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        entries:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              date:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                description: >-
                  Entry day as an ISO-8601 timestamp; the time component is
                  always midnight UTC.
              startTime:
                nullable: true
                type: string
              endTime:
                nullable: true
                type: string
              breakMinutes:
                type: number
              totalHours:
                type: number
              type:
                type: string
                enum:
                  - REGULAR
                  - OVERTIME
                  - COMPENSATION
                  - WEITERBILDUNG
                  - VORBEREITUNG
              projectCode:
                nullable: true
                type: string
              description:
                nullable: true
                type: string
              status:
                type: string
                enum:
                  - DRAFT
                  - SUBMITTED
                  - APPROVED
                  - REJECTED
                  - CANCELLED
              rejectionNote:
                nullable: true
                type: string
              createdAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
            required:
              - id
              - date
              - startTime
              - endTime
              - breakMinutes
              - totalHours
              - type
              - projectCode
              - description
              - status
              - rejectionNote
              - createdAt
            additionalProperties: false
        totalHours:
          type: number
        targetHours:
          type: number
        overtimeHours:
          type: number
      required:
        - weekStart
        - entries
        - totalHours
        - targetHours
        - overtimeHours
      additionalProperties: false

````