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

# List salary advances

> The company's salary advances. Filter with `employeeId`. Requires the `advances:read` scope.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json get /v1/advances
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/advances:
    get:
      tags:
        - Advances
      summary: List salary advances
      description: >-
        The company's salary advances. Filter with `employeeId`. Requires the
        `advances:read` scope.
      parameters:
        - name: employeeId
          in: query
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdvanceDto'
              example:
                - id: 9f8e7d6c-0000-0000-0000-000000000001
                  employeeId: b2c3d4e5-0000-0000-0000-000000000001
                  amountMinor: 5000000
                  totalRepayableMinor: 5000000
                  currencyIsoCode: NGN
                  termMonths: 3
                  status: Active
                  disbursedAt: '2026-07-20T12:00:00+00:00'
                  createdAt: '2026-07-20T11:00:00+00:00'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    AdvanceDto:
      required:
        - id
        - employeeId
        - amountMinor
        - totalRepayableMinor
        - currencyIsoCode
        - termMonths
        - status
        - disbursedAt
        - createdAt
      type: object
      properties:
        id:
          type: string
          description: The advance's unique id.
          format: uuid
        employeeId:
          type: string
          description: The employee who took the advance.
          format: uuid
        amountMinor:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Principal advanced, in minor units (e.g. kobo).
          format: int64
        totalRepayableMinor:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Total to repay (equals principal — no interest).
          format: int64
        currencyIsoCode:
          type: string
          description: ISO-4217 currency code, e.g. `NGN`.
        termMonths:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of months to repay over.
          format: int32
        status:
          type: string
          description: One of `Pending`, `Active`, `Repaid`, `Defaulted`, `Cancelled`.
        disbursedAt:
          type:
            - 'null'
            - string
          description: When funds landed (null until approved).
          format: date-time
        createdAt:
          type: string
          description: When the advance was requested.
          format: date-time
      description: A salary advance and its lifecycle.
    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

````