> ## 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 payslip for a specific payroll period.



## OpenAPI

````yaml /api-reference/portal.v1.json get /api/v1/portal/employee/payslips/{period}
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/payslips/{period}:
    get:
      tags:
        - payslips
      summary: Get the caller's payslip for a specific payroll period.
      operationId: getPayslip
      parameters:
        - name: period
          in: path
          required: true
          description: Payroll period (YYYY-MM).
          schema:
            type: string
            pattern: ^\d{4}-\d{2}$
      responses:
        '200':
          description: The payslip for the requested period.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/PayslipDTO'
        '400':
          description: The period path parameter is not in YYYY-MM 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, or no payslip exists for
            the period.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
components:
  schemas:
    PayslipDTO:
      type: object
      properties:
        id:
          type: string
        period:
          type: string
          pattern: ^\d{4}-\d{2}$
          description: Payroll period as "YYYY-MM".
        grossSalary:
          type: string
          pattern: ^-?\d+\.\d{2}$
          description: >-
            Decimal amount as an exact 2-dp string (e.g. "4250.00") for monetary
            exactness.
        netSalary:
          type: string
          pattern: ^-?\d+\.\d{2}$
          description: >-
            Decimal amount as an exact 2-dp string (e.g. "4250.00") for monetary
            exactness.
        totalDeductions:
          type: string
          pattern: ^-?\d+\.\d{2}$
          description: >-
            Decimal amount as an exact 2-dp string (e.g. "4250.00") for monetary
            exactness.
        deductions:
          nullable: true
          type: object
          additionalProperties: {}
        paymentDate:
          nullable: true
          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))$
        pdfUrl:
          nullable: true
          type: string
      required:
        - id
        - period
        - grossSalary
        - netSalary
        - totalDeductions
        - deductions
        - paymentDate
        - pdfUrl
      additionalProperties: false

````