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

# Amend Absence

> Amend by appending an edition (whole-shape payload, design 09 §7).



## OpenAPI

````yaml /api-reference/preview.json patch /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}
openapi: 3.2.0
info:
  title: Intermezzo Global Payroll
  summary: Global Payroll Platform
  description: Intermezzo's global payroll apis, organized by country
  version: '2026-10-07'
  x-logo:
    url: /static/icon.svg
servers:
  - url: https://preview.intermezzo.ai
    description: Preview
security: []
paths:
  /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}:
    patch:
      tags:
        - Core
        - Employees
        - Absences
      summary: Amend Absence
      description: Amend by appending an edition (whole-shape payload, design 09 §7).
      operationId: >-
        amend_absence_organizations__organization_id__employees__employee_id__absences__absence_id__patch
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: employee_id
          in: path
          required: true
          schema:
            type: string
            title: Employee Id
        - name: absence_id
          in: path
          required: true
          schema:
            type: string
            title: Absence Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GBAbsenceRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GBAbsenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerToken: []
components:
  schemas:
    GBAbsenceRequest:
      properties:
        country_code:
          type: string
          const: GB
          title: Country Code
          default: GB
        start_date:
          type: string
          format: date
          title: Start Date
          description: First day of leave (inclusive)
        end_date:
          type: string
          format: date
          title: End Date
          description: Last day of leave (inclusive); return to work is the next day
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: AMS correlation reference
        content:
          $ref: '#/components/schemas/GBMaternityAbsence-Input'
      additionalProperties: false
      type: object
      required:
        - start_date
        - end_date
        - content
      title: GBAbsenceRequest
      description: |-
        Create/amend payload: structural facts + typed content.
        PATCH (amend) uses the same whole-shape payload and appends an edition.
    GBAbsenceResponse:
      properties:
        country_code:
          type: string
          const: GB
          title: Country Code
          default: GB
        start_date:
          type: string
          format: date
          title: Start Date
          description: First day of leave (inclusive)
        end_date:
          type: string
          format: date
          title: End Date
          description: Last day of leave (inclusive); return to work is the next day
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
          description: AMS correlation reference
        content:
          $ref: '#/components/schemas/GBMaternityAbsence-Output'
        absence_id:
          type: string
          title: Absence Id
        employee_id:
          type: string
          title: Employee Id
        is_cancelled:
          type: boolean
          title: Is Cancelled
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
      additionalProperties: false
      type: object
      required:
        - start_date
        - end_date
        - content
        - absence_id
        - employee_id
        - created_at
      title: GBAbsenceResponse
      description: One edition, as stored. `created_at` is the edition's transaction time.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GBMaternityAbsence-Input:
      properties:
        content_schema_version:
          type: integer
          const: 1
          title: Content Schema Version
          description: Version of the stored content shape; see the class comment
          default: 1
        absence_type:
          type: string
          const: MATERNITY
          title: Absence Type
          default: MATERNITY
        ewc:
          type: string
          format: date
          title: Ewc
          description: Sunday starting the expected week of childbirth
        actual_birth_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Actual Birth Date
          description: >-
            Actual date of birth; supplied after the fact via the birth
            sub-resource
        stillbirth:
          type: boolean
          title: Stillbirth
          description: Stillbirth from week 24 retains SMP entitlement
          default: false
        evidence_received:
          type: boolean
          title: Evidence Received
          description: MAT B1 or recognised medical evidence has been received
          default: false
        evidence_received_at:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Evidence Received At
          description: Date the MAT B1 / medical evidence was received
        planned_start_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Planned Start Date
          description: >-
            Planned leave start for planned-vs-actual reporting; does not affect
            the calculation
        kit_days:
          items:
            $ref: '#/components/schemas/KITDay-Input'
          type: array
          title: Kit Days
      additionalProperties: false
      type: object
      required:
        - ewc
      title: GBMaternityAbsence
      description: >-
        GB maternity content payload. `ewc` anchors the qualifying-week and MPP

        derivations, so it must be the SUNDAY the expected week of childbirth

        starts on (HMRC weeks run Sunday to Saturday); rejecting anything else
        is

        correct-by-policy rather than silently normalising a caller bug.
    GBMaternityAbsence-Output:
      properties:
        content_schema_version:
          type: integer
          const: 1
          title: Content Schema Version
          description: Version of the stored content shape; see the class comment
          default: 1
        absence_type:
          type: string
          const: MATERNITY
          title: Absence Type
          default: MATERNITY
        ewc:
          type: string
          format: date
          title: Ewc
          description: Sunday starting the expected week of childbirth
        actual_birth_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Actual Birth Date
          description: >-
            Actual date of birth; supplied after the fact via the birth
            sub-resource
        stillbirth:
          type: boolean
          title: Stillbirth
          description: Stillbirth from week 24 retains SMP entitlement
          default: false
        evidence_received:
          type: boolean
          title: Evidence Received
          description: MAT B1 or recognised medical evidence has been received
          default: false
        evidence_received_at:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Evidence Received At
          description: Date the MAT B1 / medical evidence was received
        planned_start_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Planned Start Date
          description: >-
            Planned leave start for planned-vs-actual reporting; does not affect
            the calculation
        kit_days:
          items:
            $ref: '#/components/schemas/KITDay-Output'
          type: array
          title: Kit Days
      additionalProperties: false
      type: object
      required:
        - ewc
      title: GBMaternityAbsence
      description: >-
        GB maternity content payload. `ewc` anchors the qualifying-week and MPP

        derivations, so it must be the SUNDAY the expected week of childbirth

        starts on (HMRC weeks run Sunday to Saturday); rejecting anything else
        is

        correct-by-policy rather than silently normalising a caller bug.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    KITDay-Input:
      properties:
        day:
          type: string
          format: date
          title: Day
        hours:
          anyOf:
            - type: number
              maximum: 24
              exclusiveMinimum: 0
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Hours
          description: Optional part-day hours
      additionalProperties: false
      type: object
      required:
        - day
      title: KITDay
      description: |-
        One keeping-in-touch day. Valuation consequences (forfeiture past
        10, paying the worked day) are phase 2; the store records facts.
    KITDay-Output:
      properties:
        day:
          type: string
          format: date
          title: Day
        hours:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Hours
          description: Optional part-day hours
      additionalProperties: false
      type: object
      required:
        - day
      title: KITDay
      description: |-
        One keeping-in-touch day. Valuation consequences (forfeiture past
        10, paying the worked day) are phase 2; the store records facts.
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here

````

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