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

# Patch paymentsemployees weeks



## OpenAPI

````yaml /api-reference/specs/statutory-pay.json patch /payments/employees/{employeeId}/{statutoryPayId}/weeks/{weekNumber}
openapi: 3.0.1
info:
  title: Statutory Service
  description: Statutory Pay API for FlowPayroll
  contact:
    name: FlowPayroll
    email: support@flowpayroll.com
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/statutory-pay
security:
  - X-Auth-Token: []
    X-Org-Id: []
tags:
  - name: Statutory payments
    description: >-
      Create, retrieve, update, and delete statutory payments, and list them for
      an employee or organisation.
  - name: Line items & schedule
    description: >-
      Inspect and adjust payment line items, weekly amounts, and export the
      schedule.
  - name: External payments
    description: Record payments already made outside the payroll.
  - name: Attachments
    description: Upload and manage supporting documents for a statutory payment.
  - name: Alabaster & earnings
    description: >-
      Average weekly earnings and Alabaster (pay-rise) detection and
      recalculation.
  - name: Import & reconcile
    description: Import statutory payments and reconcile against a pay run.
  - name: Statutory Calculations
  - name: Statutory Rates
paths:
  /payments/employees/{employeeId}/{statutoryPayId}/weeks/{weekNumber}:
    patch:
      tags:
        - Line items & schedule
      operationId: OverrideStatutoryWeekAmount
      parameters:
        - name: employeeId
          in: path
          required: true
          schema:
            type: string
        - name: statutoryPayId
          in: path
          required: true
          schema:
            type: string
        - name: weekNumber
          in: path
          required: true
          schema:
            type: integer
            format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverrideStatutoryAmountRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody_Boolean'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody_Object'
components:
  schemas:
    OverrideStatutoryAmountRequest:
      type: object
      properties:
        amount:
          type: number
          format: double
        reason:
          type: string
          nullable: true
      additionalProperties: false
    ResponseBody_Boolean:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ContentResponse_Boolean'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ResponseBody_Object:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ContentResponse_Object'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ContentResponse_Boolean:
      type: object
      properties:
        data:
          type: boolean
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ContentResponse_Object:
      type: object
      properties:
        data:
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: Authentication token for API access
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      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).
      name: X-Org-Id
      in: header

````