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

# Download the payslip as a PDF

> Returns the employee's payslip for the given year and period as a PDF. The file is not password-protected; the copy emailed to the employee is, with their date of birth.



## OpenAPI

````yaml /api-reference/specs/pay-api.yaml get /payslip/data/{employeeId}/{year}/{period}/file
openapi: 3.0.3
info:
  title: FlowPayroll API
  description: >-
    API for payroll management, including payroll upload, lock, HMRC submission,
    employee management
  version: 0.1.0
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1
security:
  - XAuthToken: []
    XOrgId: []
tags:
  - name: Employees
    description: >-
      Create, retrieve, update, and delete employee records, and look them up by
      NI number or payroll ID.
  - name: Starters & leavers
    description: Set and clear starter and leaver details, individually or in bulk.
  - name: Tax codes
    description: >-
      Manage employee tax codes and query the effective tax code and NI category
      on a given date.
  - name: NI & identifiers
    description: Manage NI categories, National Insurance numbers, and payroll IDs.
  - name: Student loans
    description: Start and end student and postgraduate loans.
  - name: Payroll setup
    description: Assign an employee's payroll config and set opening balances.
  - name: Salary
    description: >-
      The employee's effective-dated annual salary history: read it, add or
      correct a version from a date, and remove one. The Salary API pro-rates
      this history onto each pay run.
  - name: Payroll
  - name: Payroll lines
  - name: PayrollConfig
  - name: Pay Elements
  - name: Calculator
  - name: Payslip
  - name: RTI
  - name: YearEnd
  - name: Organisation
paths:
  /payslip/data/{employeeId}/{year}/{period}/file:
    get:
      tags:
        - Payslip
      summary: Download the payslip as a PDF
      description: >-
        Returns the employee's payslip for the given year and period as a PDF.
        The file is not password-protected; the copy emailed to the employee is,
        with their date of birth.
      operationId: GetPayslipFile
      parameters:
        - name: employeeId
          in: path
          required: true
          schema:
            type: string
          description: ID of the employee
          example: EMP01JPW80Q2B7Q9RGGRY29VGC8WM
        - name: year
          in: path
          required: true
          schema:
            type: integer
          description: Tax year of the payslip
          example: 2024
        - name: period
          in: path
          required: true
          schema:
            type: integer
          description: Pay period number within the year
          example: 2
        - name: frequency
          in: query
          required: false
          schema:
            type: string
            enum:
              - Annual
              - Monthly
              - FourWeekly
              - Fortnightly
              - Weekly
              - Daily
              - Quarterly
              - BiAnnually
          description: >-
            Optional payment frequency override. When provided, overrides the
            frequency from the employee's payroll config.
          example: Monthly
      responses:
        '200':
          description: The payslip PDF
          headers:
            Content-Disposition:
              description: >-
                attachment;
                filename="Payslip-{year}-{period}-{LastName}-{FirstName}.pdf"
              schema:
                type: string
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Invalid frequency parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Invalid frequency parameter
                  token: invalidFrequencyParameter
        '404':
          description: No payslip exists for the employee in that period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Payslip Not Found
                  token: payslipNotFound
        '500':
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
components:
  schemas:
    ResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          type: object
          properties:
            data:
              type: object
              nullable: true
            metadata:
              type: object
              nullable: true
              properties:
                dateFormat:
                  type: string
                  default: yyyy-MM-dd
                dateTimeFormat:
                  type: string
                  default: yyyy-MM-ddTHH:mm:ss.fffZ
                paginationToken:
                  type: string
                  nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssue:
      type: object
      description: >
        Field validation item. `reasonToken` is a stable snake_case key for i18n
        or custom client messages; `reason` is the default English text from the
        API.
      properties:
        field:
          type: string
          description: Dot-path of the field (e.g. name.firstName, address.line1).
        reason:
          type: string
          description: Default human-readable message.
        reasonToken:
          type: string
          description: Machine-readable error identifier (snake_case).
        reasonTokenArguments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Access token obtained from OAuth2 client credentials flow
    XOrgId:
      type: apiKey
      in: header
      name: X-Org-Id
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).

````

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