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

# Update a PAYE payment for a specific tax year and payment ID

> Updates an existing PAYE payment for the current organisation, recalculating due dates, and payment status



## OpenAPI

````yaml /api-reference/specs/pay-api.yaml put /organisation/balances/paye-payments/{taxYear}/payment/{paymentId}
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:
  /organisation/balances/paye-payments/{taxYear}/payment/{paymentId}:
    put:
      tags:
        - Organisation
      summary: Update a PAYE payment for a specific tax year and payment ID
      description: >-
        Updates an existing PAYE payment for the current organisation,
        recalculating due dates, and payment status
      operationId: updatePayePayment
      parameters:
        - name: taxYear
          in: path
          required: true
          schema:
            type: integer
            minimum: 1800
            maximum: 3000
          description: The tax year for the payment
        - name: paymentId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the payment to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatablePayePaymentDto'
            example:
              paymentReference: PAYE_2024_001_UPDATED
              amountPaid: 2000
              paymentDate: '2024-05-25'
              notes: Updated payment amount and date
      responses:
        '200':
          description: Successfully updated PAYE payment
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ResponseBody'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PayePaymentDto'
        '400':
          description: Invalid request body, tax year, period, or payment ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
        '404':
          description: Payment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
components:
  schemas:
    UpdatablePayePaymentDto:
      type: object
      description: Request body for recording a PAYE payment
      required:
        - paymentReference
        - amountPaid
        - paymentDate
      properties:
        paymentReference:
          type: string
          description: The payment reference used
          example: PAYE_2024_001
        amountPaid:
          type: number
          format: decimal
          description: The amount paid to HMRC
          example: 1500
        paymentDate:
          type: string
          format: date
          description: The date the payment was made
          example: '2024-05-22'
        notes:
          type: string
          nullable: true
          description: Notes about the payment (e.g., how it was made, who made it)
          example: BACS payment via online banking
    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
    PayePaymentDto:
      type: object
      description: Response containing the recorded PAYE payment details
      allOf:
        - $ref: '#/components/schemas/UpdatablePayePaymentDto'
        - type: object
          required:
            - paymentId
            - organisationId
            - dueDate
            - isOnTime
            - period
            - taxYear
            - createdDate
            - createdBy
            - updatedDate
            - updatedBy
          properties:
            paymentId:
              type: string
              description: The unique identifier for the payment
              example: PAY_2024_001
            organisationId:
              type: string
              description: The organisation ID
              example: org_123
            dueDate:
              type: string
              format: date
              description: The due date for this payment (22nd of next tax month)
              example: '2024-05-22'
            isOnTime:
              type: boolean
              description: Whether the payment was made on time
              example: true
            period:
              type: integer
              description: The period of the payment (1-12 for monthly, 1-4 for quarterly)
              example: 5
            taxYear:
              type: integer
              description: The tax year this payment relates to
              example: 2024
            createdDate:
              type: string
              format: date-time
              description: The created date
              example: '2024-05-22T10:00:00Z'
            createdBy:
              type: string
              description: The created by
              example: user_123
            updatedDate:
              type: string
              format: date-time
              description: The updated date
              example: '2024-05-22T10:00:00Z'
            updatedBy:
              type: string
              description: The updated by
              example: user_123
    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).

````