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

# Create a payroll run

> Builds a **draft** payroll run for the given month from the company's current roster. Approval and disbursement remain separate, deliberate steps. Requires the `payroll:write` scope; a test-mode key rosters only test employees.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json post /v1/payroll/runs
openapi: 3.1.1
info:
  title: Kua API
  description: >-
    The Kua developer API — payroll, wallets, and payments for your own company.


    Authenticate with an API key issued from **Settings → API keys** in the
    dashboard, sent in the `X-Api-Key` header. Every request is scoped to the
    company that owns the key. Base URL: `https://api.kuahr.com` (all endpoints
    are versioned under `/v1`).
  version: v1
servers:
  - url: https://api.kuahr.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Payroll
    description: List and create payroll runs.
  - name: Employees
    description: Add people to your company.
  - name: Events
    description: The company event timeline (also delivered via webhooks).
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Test data
    description: Manage sandbox (test-mode) data.
  - name: Leave
    description: >-
      Time-off types, requests, balances, and allocations (requires the Leave
      add-on).
  - name: Advances
    description: Salary advances (requires the Salary advance add-on).
  - name: Performance
    description: OKRs, appraisals, and promotions (requires the Performance add-on).
paths:
  /v1/payroll/runs:
    post:
      tags:
        - Payroll
      summary: Create a payroll run
      description: >-
        Builds a **draft** payroll run for the given month from the company's
        current roster. Approval and disbursement remain separate, deliberate
        steps. Requires the `payroll:write` scope; a test-mode key rosters only
        test employees.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreatePayrollRunRequest'
            example:
              year: 2026
              month: 7
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayrollRunCreated'
              example:
                id: 8ab1c2d3-0000-0000-0000-000000000002
                year: 2026
                month: 7
                status: Draft
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    V1CreatePayrollRunRequest:
      required:
        - year
        - month
      type: object
      properties:
        year:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        month:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
    PayrollRunCreated:
      required:
        - id
        - year
        - month
        - status
      type: object
      properties:
        id:
          type: string
          description: The new run's unique id.
          format: uuid
        year:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        month:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int32
        status:
          type: string
          description: Lifecycle status of the new run (starts at `Draft`).
      description: The draft payroll run that was created.
    ApiError:
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            A stable, machine-readable identifier you can branch on, e.g.
            `INSUFFICIENT_SCOPE`.
        message:
          type: string
          description: A human-readable explanation. May change; don't parse it.
      description: The standard error body returned for 4xx responses.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Your API key, e.g. `kua_live_…` (or `kua_test_…` in test mode).
      name: X-Api-Key
      in: header

````