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

# List Transaction Categories

> Read-only discovery of the company's configured transaction categories
and their line item types (nested), with `kind` and direction so clients
know which fields apply — the ids invoice and reserve writes cite.

Live rows by default; `includeDeprecated=true` widens both levels to
deprecated rows (marked by `deprecatedAt`) so old references resolve.
Categories and line item types are configured in the app's settings —
this surface has no configuration writes.

**Required permission:** `company.payment:read`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/financials/config/categories
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/financials/config/categories:
    get:
      tags:
        - Financials
      summary: List Transaction Categories
      description: |
        Read-only discovery of the company's configured transaction categories
        and their line item types (nested), with `kind` and direction so clients
        know which fields apply — the ids invoice and reserve writes cite.

        Live rows by default; `includeDeprecated=true` widens both levels to
        deprecated rows (marked by `deprecatedAt`) so old references resolve.
        Categories and line item types are configured in the app's settings —
        this surface has no configuration writes.

        **Required permission:** `company.payment:read`
      operationId: listFinancialsCategories
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: includeDeprecated
          in: query
          schema:
            type: boolean
          description: >-
            `true` includes deprecated categories and line item types; default
            live rows only
      responses:
        '200':
          description: The configured categories with nested line item types
          content:
            application/json:
              schema:
                type: object
                required:
                  - categories
                properties:
                  categories:
                    type: array
                    items:
                      $ref: '#/components/schemas/FinancialsV2Category'
              examples:
                success:
                  summary: A reserved and an operating category
                  value:
                    categories:
                      - id: 550e8400-e29b-41d4-a716-446655440100
                        name: Indemnity
                        kind: reserved
                        expectedDirection: payable
                        deprecatedAt: null
                        lineItemTypes:
                          - id: 550e8400-e29b-41d4-a716-446655440110
                            name: Legal
                            direction: payable
                            deprecatedAt: null
                      - id: 550e8400-e29b-41d4-a716-446655440120
                        name: Administration
                        kind: operating
                        expectedDirection: payable
                        deprecatedAt: null
                        lineItemTypes:
                          - id: 550e8400-e29b-41d4-a716-446655440130
                            name: Fees
                            direction: payable
                            deprecatedAt: null
        '400':
          description: Bad Request — an unknown query field or a malformed parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                malformedIncludeDeprecated:
                  summary: includeDeprecated is not true/false
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        includeDeprecated: Invalid option: expected one of
                        "true"|"false"
                      userMessages:
                        - >-
                          includeDeprecated: Invalid option: expected one of
                          "true"|"false"
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Not Found — the company does not have this financials surface
            enabled (the endpoint behaves as if it does not exist)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Not found
                  value:
                    error:
                      code: NotFoundError
                      message: Not found
                      userMessages:
                        - Not found
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    FinancialsV2Category:
      type: object
      description: >-
        A configured transaction category with its line item types nested — the
        ids invoice and reserve writes cite.
      required:
        - id
        - name
        - kind
        - expectedDirection
        - deprecatedAt
        - lineItemTypes
      properties:
        id:
          type: string
          format: uuid
          description: The category's id
        name:
          type: string
          description: The category's name
        kind:
          type: string
          enum:
            - operating
            - reserved
          description: >-
            `reserved` categories carry an expected-total/reserve position;
            `operating` categories do not
        expectedDirection:
          type: string
          enum:
            - payable
            - receivable
          description: >-
            The direction the category's money is expected to flow — `payable`
            (expect to pay out) or `receivable` (expect to collect). Always
            present. On a `reserved` category it is the direction its expected
            totals accrue, and it orients the accounts minted for the category;
            on an `operating` category it is a display label that orients
            nothing
        deprecatedAt:
          type: string
          format: date-time
          nullable: true
          description: When the category was deprecated, or `null` while live
        lineItemTypes:
          type: array
          description: The category's line item types
          items:
            $ref: '#/components/schemas/FinancialsV2LineItemType'
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
    FinancialsV2LineItemType:
      type: object
      description: A configured line item type, as nested under its category.
      required:
        - id
        - name
        - direction
        - deprecatedAt
      properties:
        id:
          type: string
          format: uuid
          description: The line item type's id — cite it in invoice line items
        name:
          type: string
          description: The line item type's name
        direction:
          type: string
          enum:
            - payable
            - receivable
          description: The money-flow direction of items of this type
        deprecatedAt:
          type: string
          format: date-time
          nullable: true
          description: When the type was deprecated, or `null` while live
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````