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

# Create Payrun

> Create a DRAFT pay run and its payroll status.

A MAIN run is the period's regular run and pays on the pay calendar's pay date; a pay
calendar and pay group have one MAIN run unless it is cancelled. A SUPPLEMENTARY run is
an extra run in the same period, created once the MAIN run exists, and pays on
`payment_date`: not before today (UK time), Monday to Friday, in the tax month (tax
week for a weekly pay group) of the calendar's pay date and, for a pay group whose
pension pay reference period is the pay period (`pension_prp_method` `METHOD_A`), in
the pay period containing that date, not on the date of another run
of the calendar and pay group nor on the calendar's deposit date (the day the main
run's money reaches the bank), and not before the payment date of a run of the pay
group already approved, in any of its calendars: runs are approved in payment order.
A date outside these bounds is refused with 422 `VALUE_OUT_OF_RANGE` on `payment_date`,
whose `params.reason` is `IN_PAST`, `NOT_BANKING_DAY`, `OUTSIDE_TAX_PERIOD`,
`OUTSIDE_PAY_PERIOD` or `BEFORE_APPROVED_RUN`, with the allowed bound in
`params.min` and `params.max` where there is one. When the period has no date left at
all (every allowed weekday has passed, is before an approved run of the pay group, or
is taken by the calendar's runs), any date is refused with `params.reason`
`NO_DATE_LEFT`, the window in `params.min` and `params.max`: pay the
amount in the next period's runs. A second MAIN run, or a date another run of the
calendar and pay group pays on (the calendar's pay date or deposit date for the MAIN
run), is refused with 409 `DUPLICATE_DEFINING_ATTRIBUTES`.

Employees paid by a supplementary run keep their salary and statutory pay in the MAIN
run unless they are moved, with one exception: once the MAIN run is approved, the
first supplementary run that calculates an employee whose salary and statutory pay
the MAIN run did not calculate (it holds none of their standing or calculated pay
items, for instance a new starter, or an employee it paid only pay items while
another run held their salary) pays their salary and statutory pay for the period.
For a weekly pay group whose MAIN run pays on the last working day of its tax week, no
supplementary run can follow the approved MAIN run in that week (an earlier date pays
before it, a later one is in the next tax week). The next period's MAIN run pays only
its own period, so an employee the approved MAIN run did not pay needs a back-pay item
there for the missed week. Likewise, for a Method A pay group whose MAIN run pays on
the last working day of its pay period, no date is left once it is approved: a later
amount is paid in the next period's runs.



## OpenAPI

````yaml /api-reference/preview.json post /gb/organizations/{organization_id}/payruns
openapi: 3.2.0
info:
  description: Intermezzo's global payroll apis, organized by country
  summary: Global Payroll Platform
  title: Intermezzo Global Payroll
  version: '2026-11-18'
  x-logo:
    url: /static/icon.svg
servers:
  - description: Preview
    url: https://preview.intermezzo.ai
security: []
paths:
  /gb/organizations/{organization_id}/payruns:
    post:
      tags:
        - Great Britain
        - Pay Runs
      summary: Create Payrun
      description: >-
        Create a DRAFT pay run and its payroll status.


        A MAIN run is the period's regular run and pays on the pay calendar's
        pay date; a pay

        calendar and pay group have one MAIN run unless it is cancelled. A
        SUPPLEMENTARY run is

        an extra run in the same period, created once the MAIN run exists, and
        pays on

        `payment_date`: not before today (UK time), Monday to Friday, in the tax
        month (tax

        week for a weekly pay group) of the calendar's pay date and, for a pay
        group whose

        pension pay reference period is the pay period (`pension_prp_method`
        `METHOD_A`), in

        the pay period containing that date, not on the date of another run

        of the calendar and pay group nor on the calendar's deposit date (the
        day the main

        run's money reaches the bank), and not before the payment date of a run
        of the pay

        group already approved, in any of its calendars: runs are approved in
        payment order.

        A date outside these bounds is refused with 422 `VALUE_OUT_OF_RANGE` on
        `payment_date`,

        whose `params.reason` is `IN_PAST`, `NOT_BANKING_DAY`,
        `OUTSIDE_TAX_PERIOD`,

        `OUTSIDE_PAY_PERIOD` or `BEFORE_APPROVED_RUN`, with the allowed bound in

        `params.min` and `params.max` where there is one. When the period has no
        date left at

        all (every allowed weekday has passed, is before an approved run of the
        pay group, or

        is taken by the calendar's runs), any date is refused with
        `params.reason`

        `NO_DATE_LEFT`, the window in `params.min` and `params.max`: pay the

        amount in the next period's runs. A second MAIN run, or a date another
        run of the

        calendar and pay group pays on (the calendar's pay date or deposit date
        for the MAIN

        run), is refused with 409 `DUPLICATE_DEFINING_ATTRIBUTES`.


        Employees paid by a supplementary run keep their salary and statutory
        pay in the MAIN

        run unless they are moved, with one exception: once the MAIN run is
        approved, the

        first supplementary run that calculates an employee whose salary and
        statutory pay

        the MAIN run did not calculate (it holds none of their standing or
        calculated pay

        items, for instance a new starter, or an employee it paid only pay items
        while

        another run held their salary) pays their salary and statutory pay for
        the period.

        For a weekly pay group whose MAIN run pays on the last working day of
        its tax week, no

        supplementary run can follow the approved MAIN run in that week (an
        earlier date pays

        before it, a later one is in the next tax week). The next period's MAIN
        run pays only

        its own period, so an employee the approved MAIN run did not pay needs a
        back-pay item

        there for the missed week. Likewise, for a Method A pay group whose MAIN
        run pays on

        the last working day of its pay period, no date is left once it is
        approved: a later

        amount is paid in the next period's runs.
      operationId: create_payrun_gb_organizations__organization_id__payruns_post
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            title: Organization Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayrunCreateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayrunResponse'
          description: Successful Response
        '400':
          content:
            application/json:
              examples:
                ORG_BELONGS_TO_A_DIFFERENT_COUNTRY:
                  summary: >-
                    Raised when an organization belongs to a different country
                    than the one in the path.
                  value:
                    errors:
                      - code: ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                        message: >-
                          Raised when an organization belongs to a different
                          country than the one in the path.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - ORG_BELONGS_TO_A_DIFFERENT_COUNTRY
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `ORG_BELONGS_TO_A_DIFFERENT_COUNTRY`: Raised when an organization
            belongs to a different country than the one in the path.
        '404':
          content:
            application/json:
              examples:
                HUB_NOT_FOUND:
                  summary: >-
                    Raised when a hub does not exist under the parent named in
                    the path.
                  value:
                    errors:
                      - code: HUB_NOT_FOUND
                        message: >-
                          Raised when a hub does not exist under the parent
                          named in the path.
                PAY_CALENDAR_NOT_FOUND:
                  summary: Raised when a pay_calendar is not found.
                  value:
                    errors:
                      - code: PAY_CALENDAR_NOT_FOUND
                        message: Raised when a pay_calendar is not found.
                PAY_GROUP_NOT_FOUND:
                  summary: Raised when a pay_group is not found.
                  value:
                    errors:
                      - code: PAY_GROUP_NOT_FOUND
                        message: Raised when a pay_group is not found.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - HUB_NOT_FOUND
                            - PAY_CALENDAR_NOT_FOUND
                            - PAY_GROUP_NOT_FOUND
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `HUB_NOT_FOUND`: Raised when a hub does not exist under the parent
            named in the path.

            - `PAY_CALENDAR_NOT_FOUND`: Raised when a pay_calendar is not found.

            - `PAY_GROUP_NOT_FOUND`: Raised when a pay_group is not found.
        '409':
          content:
            application/json:
              examples:
                DUPLICATE_DEFINING_ATTRIBUTES:
                  summary: >-
                    Raised when a MAIN pay run is created for a pay calendar and
                    pay group that already have a live (not cancelled) MAIN run.
                  value:
                    errors:
                      - code: DUPLICATE_DEFINING_ATTRIBUTES
                        field: run_type
                        message: >-
                          Raised when a MAIN pay run is created for a pay
                          calendar and pay group that already have a live (not
                          cancelled) MAIN run.
                        params:
                          fields:
                            - run_type
                          id: run_01j0000000e008000000000001
                DUPLICATE_DEFINING_ATTRIBUTES (payment_date):
                  summary: >-
                    Raised when a pay run would take a payment date that another
                    live (not cancelled) run of the same pay calendar and pay
                    group already holds.
                  value:
                    errors:
                      - code: DUPLICATE_DEFINING_ATTRIBUTES
                        field: payment_date
                        message: >-
                          Raised when a pay run would take a payment date that
                          another live (not cancelled) run of the same pay
                          calendar and pay group already holds.
                        params:
                          fields:
                            - payment_date
                          id: run_01j0000000e008000000000001
                          payment_date: '2026-05-15'
                MAIN_RUN_REQUIRED:
                  summary: >-
                    Raised when a supplementary pay run is created for a pay
                    calendar and pay group with no live (not cancelled) MAIN
                    run.
                  value:
                    errors:
                      - code: MAIN_RUN_REQUIRED
                        message: >-
                          Raised when a supplementary pay run is created for a
                          pay calendar and pay group with no live (not
                          cancelled) MAIN run.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - DUPLICATE_DEFINING_ATTRIBUTES
                            - MAIN_RUN_REQUIRED
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `DUPLICATE_DEFINING_ATTRIBUTES`: Raised when a MAIN pay run is
            created for a pay calendar and pay group that already have a live
            (not cancelled) MAIN run.

            - `MAIN_RUN_REQUIRED`: Raised when a supplementary pay run is
            created for a pay calendar and pay group with no live (not
            cancelled) MAIN run.

            - `DUPLICATE_DEFINING_ATTRIBUTES`: Raised when a pay run would take
            a payment date that another live (not cancelled) run of the same pay
            calendar and pay group already holds.
        '422':
          content:
            application/json:
              examples:
                INVALID_FIELD_DEPENDENCY:
                  summary: >-
                    payment_date given run_type (params.depends_on run_type):
                    params.reason REQUIRED for a SUPPLEMENTARY run without one,
                    NOT_ALLOWED for a MAIN run with one
                  value:
                    errors:
                      - code: INVALID_FIELD_DEPENDENCY
                        message: >-
                          payment_date given run_type (params.depends_on
                          run_type): params.reason REQUIRED for a SUPPLEMENTARY
                          run without one, NOT_ALLOWED for a MAIN run with one
                PAY_PERIOD_UNRESOLVED:
                  summary: >-
                    Raised when a payrun's pay date and period type cannot be
                    mapped to a tax period — either the period type is one the
                    tax calendar does not support, or the pay date falls outside
                    the tax year.
                  value:
                    errors:
                      - code: PAY_PERIOD_UNRESOLVED
                        message: >-
                          Raised when a payrun's pay date and period type cannot
                          be mapped to a tax period — either the period type is
                          one the tax calendar does not support, or the pay date
                          falls outside the tax year.
                VALUE_OUT_OF_RANGE:
                  summary: >-
                    Raised when a supplementary pay run would pay before a run
                    of the same pay group, in any of its pay calendars, that is
                    already approved.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run would pay before a
                          run of the same pay group, in any of its pay
                          calendars, that is already approved.
                        params:
                          min: '2026-05-15'
                          payment_date: '2026-05-14'
                          reason: BEFORE_APPROVED_RUN
                          run_id: run_01j0000000e008000000000001
                VALUE_OUT_OF_RANGE (IN_PAST):
                  summary: >-
                    Raised when a supplementary pay run is created with a
                    payment date before today.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run is created with a
                          payment date before today.
                        params:
                          min: '2026-05-11'
                          payment_date: '2026-05-08'
                          reason: IN_PAST
                          today: '2026-05-11'
                VALUE_OUT_OF_RANGE (NOT_BANKING_DAY):
                  summary: >-
                    Raised when a supplementary pay run is created with a
                    payment date on a Saturday or Sunday.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run is created with a
                          payment date on a Saturday or Sunday.
                        params:
                          payment_date: '2026-05-16'
                          reason: NOT_BANKING_DAY
                VALUE_OUT_OF_RANGE (NO_DATE_LEFT):
                  summary: >-
                    Raised when a supplementary pay run is created for a period
                    with no date left to pay on, whatever `payment_date` asks
                    for.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run is created for a
                          period with no date left to pay on, whatever
                          `payment_date` asks for.
                        params:
                          approved_run_date: '2026-05-29'
                          approved_run_id: run_01j0000000e008000000000001
                          max: '2026-05-31'
                          min: '2026-05-06'
                          payment_date: '2026-06-01'
                          reason: NO_DATE_LEFT
                VALUE_OUT_OF_RANGE (OUTSIDE_PAY_PERIOD):
                  summary: >-
                    Raised when a supplementary pay run of a pay group whose
                    pension pay reference period is the pay period (Method A)
                    pays outside the pay period containing its pay calendar's
                    pay date (the main run's).
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run of a pay group
                          whose pension pay reference period is the pay period
                          (Method A) pays outside the pay period containing its
                          pay calendar's pay date (the main run's).
                        params:
                          max: '2026-05-31'
                          min: '2026-05-11'
                          pay_period_end: '2026-05-31'
                          pay_period_start: '2026-05-01'
                          payment_date: '2026-06-03'
                          reason: OUTSIDE_PAY_PERIOD
                VALUE_OUT_OF_RANGE (OUTSIDE_TAX_PERIOD):
                  summary: >-
                    Raised when a supplementary pay run's payment date falls in
                    another tax period (tax month, or tax week for a weekly pay
                    group) than its pay calendar's pay date.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        field: payment_date
                        message: >-
                          Raised when a supplementary pay run's payment date
                          falls in another tax period (tax month, or tax week
                          for a weekly pay group) than its pay calendar's pay
                          date.
                        params:
                          actual_period_number: 3
                          actual_tax_year: 2026
                          expected_period_number: 2
                          expected_tax_year: 2026
                          max: '2026-05-31'
                          min: '2026-05-11'
                          payment_date: '2026-06-08'
                          period_type: MONTH
                          reason: OUTSIDE_TAX_PERIOD
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - VALUE_OUT_OF_RANGE
                            - PAY_PERIOD_UNRESOLVED
                            - INVALID_FIELD_DEPENDENCY
                            - FIELD_REQUIRED
                            - FIELD_INVALID_TYPE_STRING
                            - FIELD_INVALID_TYPE_INT
                            - FIELD_INVALID_TYPE_FLOAT
                            - FIELD_INVALID_TYPE_BOOL
                            - FIELD_INVALID_TYPE_DICT
                            - FIELD_INVALID_TYPE_LIST
                            - FIELD_STRING_TOO_SHORT
                            - FIELD_STRING_TOO_LONG
                            - FIELD_STRING_PATTERN_MISMATCH
                            - FIELD_VALUE_TOO_SMALL
                            - FIELD_VALUE_TOO_LARGE
                            - FIELD_INVALID_DATE
                            - FIELD_INVALID_DATETIME
                            - FIELD_INVALID_TIME
                            - FIELD_INVALID_DATE_FORMAT
                            - FIELD_INVALID_DATETIME_FORMAT
                            - FIELD_INVALID_ENUM_VALUE
                            - FIELD_INVALID_EMAIL
                            - FIELD_INVALID_URL
                            - FIELD_LIST_TOO_SHORT
                            - FIELD_LIST_TOO_LONG
                            - FIELD_UNKNOWN
                            - FIELD_VALIDATION_ERROR
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            The request failed validation. Type and format errors use the
            generic FIELD_* codes.

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run would
            pay before a run of the same pay group, in any of its pay calendars,
            that is already approved.

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run is
            created with a payment date before today.

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run is
            created with a payment date on a Saturday or Sunday.

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run's
            payment date falls in another tax period (tax month, or tax week for
            a weekly pay group) than its pay calendar's pay date.

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run of a pay
            group whose pension pay reference period is the pay period (Method
            A) pays outside the pay period containing its pay calendar's pay
            date (the main run's).

            - `VALUE_OUT_OF_RANGE`: Raised when a supplementary pay run is
            created for a period with no date left to pay on, whatever
            `payment_date` asks for.

            - `PAY_PERIOD_UNRESOLVED`: Raised when a payrun's pay date and
            period type cannot be mapped to a tax period — either the period
            type is one the tax calendar does not support, or the pay date falls
            outside the tax year.

            - `INVALID_FIELD_DEPENDENCY`: payment_date given run_type
            (params.depends_on run_type): params.reason REQUIRED for a
            SUPPLEMENTARY run without one, NOT_ALLOWED for a MAIN run with one
      security:
        - BearerToken: []
components:
  schemas:
    PayrunCreateRequest:
      additionalProperties: false
      properties:
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        pay_calendar_id:
          title: Pay Calendar Id
          type: string
        pay_group_id:
          title: Pay Group Id
          type: string
        payment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: >-
            SUPPLEMENTARY only, and required for it: the date the run pays. Not
            before today, Monday to Friday, in the tax period (tax month, or tax
            week for a weekly pay group) of the pay calendar's pay date and, for
            a pay group whose pension pay reference period is the pay period
            (METHOD_A), in the pay period containing that date, not the date of
            another run of the pay calendar and pay group nor the calendar's
            deposit date (the day the main run's money reaches the bank), and
            not before the payment date of a run of the pay group already
            approved, in any of its calendars. A MAIN run pays on the calendar's
            pay date.
          title: Payment Date
        run_type:
          $ref: '#/components/schemas/PayRunType'
          description: >-
            MAIN is the period's regular run, paid on the pay calendar's pay
            date. SUPPLEMENTARY is an extra run in the same period, paid on
            `payment_date`.
      required:
        - run_type
        - pay_calendar_id
        - pay_group_id
      title: PayrunCreateRequest
      type: object
    PayrunResponse:
      additionalProperties: false
      properties:
        contractual_payday:
          description: 'The pay calendar''s pay date: the day the period''s pay is due.'
          format: date
          title: Contractual Payday
          type: string
        external_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: External Ref
        id:
          title: Id
          type: string
        pay_calendar_id:
          title: Pay Calendar Id
          type: string
        pay_group_id:
          title: Pay Group Id
          type: string
        payment_date:
          description: >-
            The day the run's BACS payment reaches employees' accounts: a
            SUPPLEMENTARY run's own date, the pay calendar's deposit date for a
            MAIN run (which moves off `contractual_payday` when that is not a
            banking day).
          format: date
          title: Payment Date
          type: string
        payroll_status_id:
          title: Payroll Status Id
          type: string
        reported_payment_date:
          description: >-
            The payment date the run reports to HMRC on the FPS:
            `contractual_payday` for a MAIN run, `payment_date` for a
            SUPPLEMENTARY run.
          format: date
          title: Reported Payment Date
          type: string
        run_type:
          $ref: '#/components/schemas/PayRunType'
        status:
          $ref: '#/components/schemas/PayrunStatus'
      required:
        - id
        - payroll_status_id
        - run_type
        - status
        - pay_calendar_id
        - pay_group_id
        - payment_date
        - contractual_payday
        - reported_payment_date
        - external_ref
      title: PayrunResponse
      type: object
    PayRunType:
      description: >-
        Kind of pay run: the period's main run, or a supplementary run in the
        same period
      enum:
        - MAIN
        - SUPPLEMENTARY
      title: PayRunType
      type: string
    PayrunStatus:
      description: Payrun status
      enum:
        - DRAFT
        - PROCESSING
        - APPROVED
        - PAID
        - CANCELLED
      title: PayrunStatus
      type: string
  securitySchemes:
    BearerToken:
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here
      scheme: bearer
      type: http

````

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