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

# Create or update payslip metadata such as notes and payment date overwrite

> Creates or updates data for a specific employee's payslip in a given year and period. The data is associated with the specific payroll configuration.



## OpenAPI

````yaml /api-reference/specs/pay-api.yaml post /payslip/data/{employeeId}/{year}/{period}
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: 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}:
    post:
      tags:
        - Payslip
      summary: >-
        Create or update payslip metadata such as notes and payment date
        overwrite
      description: >-
        Creates or updates data for a specific employee's payslip in a given
        year and period. The data is associated with the specific payroll
        configuration.
      operationId: UpdatePayslipData
      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: Year of the payslip
          example: 2024
        - name: period
          in: path
          required: true
          schema:
            type: integer
          description: Pay period number within the year
          example: 2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayslipMetadataDto'
            example:
              payslipMetadata:
                notes: Additional holiday pay included for this period
                paymentDateOverwrite: '2024-02-28'
      responses:
        '200':
          description: Payslip metadata created or updated successfully
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/ResponseBody'
                  - properties:
                      content:
                        type: object
              example:
                message:
                  text: Payslip metadata added or updated
                  token: payslipMetadataAddedOrUpdated
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Invalid payslip metadata
                  token: invalidPayslipMetadata
                  validationIssues:
                    - field: payslipMetadata
                      message: Payslip metadata cannot be empty
                      code: payslipMetadataRequired
        '404':
          description: Payroll config not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Payroll config not found
                  token: payrollConfigNotFound
        '500':
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
              example:
                message:
                  text: Failed to add or update payslip metadata
                  token: failedToAddOrUpdatePayslipMetadata
components:
  schemas:
    PayslipMetadataDto:
      type: object
      required:
        - notes
      properties:
        notes:
          type: string
          description: Notes to be added or updated for the payslip
          example: Additional holiday pay included for this period
          nullable: true
        paymentDateOverwrite:
          type: string
          description: Payment date overwrite for the payslip
          example: '2024-02-28'
          nullable: true
    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'
        messageToken:
          type: string
    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).

````