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

# Import Financials Configuration

> Additively creates missing invoice types, line-item types, and
classifications through the application settings actions. Existing natural
keys are unchanged, and a key held only by a deprecated row is not
resurrected. Reporting frames are replaced only when the normalized document
differs. `?dryRun=true` reports the same validated plan without financials
configuration writes. No other query controls are accepted.

**Required permission:** `company.configuration:import`




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/financials/config/import
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/import:
    post:
      tags:
        - Financials
      summary: Import Financials Configuration
      description: >
        Additively creates missing invoice types, line-item types, and

        classifications through the application settings actions. Existing
        natural

        keys are unchanged, and a key held only by a deprecated row is not

        resurrected. Reporting frames are replaced only when the normalized
        document

        differs. `?dryRun=true` reports the same validated plan without
        financials

        configuration writes. No other query controls are accepted.


        **Required permission:** `company.configuration:import`
      operationId: importFinancialsConfig
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: dryRun
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
          description: Report the validated import plan without applying it.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialsConfigDocument'
            examples:
              empty:
                summary: Empty financials configuration
                value:
                  documentVersion: 1
                  eventFinancials:
                    invoiceTypes: []
                  policyFinancials:
                    invoiceTypes: []
                    classifications: []
                  reporting:
                    exportSurfaces: []
                    invoiceTypeOverrides: []
      responses:
        '200':
          description: Validated import plan, applied unless dryRun is true.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialsConfigImportResponse'
              examples:
                idempotent:
                  summary: Nothing needed to change
                  value:
                    dryRun: false
                    changes:
                      eventInvoiceTypesCreated: []
                      policyInvoiceTypesCreated: []
                      lineItemTypesCreated: []
                      classificationsCreated: []
                      deprecatedRowsCreated: []
                      reportingFrameConfigUpdated: false
                    skipped:
                      existingNaturalKeys: []
                      deprecatedNaturalKeys: []
        '400':
          description: Invalid document or query parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    FinancialsConfigDocument:
      type: object
      additionalProperties: false
      required:
        - documentVersion
        - eventFinancials
        - policyFinancials
        - reporting
      properties:
        documentVersion:
          type: integer
          enum:
            - 1
        eventFinancials:
          type: object
          additionalProperties: false
          required:
            - invoiceTypes
          properties:
            invoiceTypes:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - name
                  - kind
                  - expectedDirection
                  - deprecated
                  - lineItemTypes
                properties:
                  name:
                    type: string
                    minLength: 1
                  kind:
                    type: string
                    enum:
                      - reserved
                      - operating
                  expectedDirection:
                    type: string
                    enum:
                      - payable
                      - receivable
                  deprecated:
                    type: boolean
                  lineItemTypes:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - name
                        - direction
                        - deprecated
                      properties:
                        name:
                          type: string
                          minLength: 1
                        direction:
                          type: string
                          enum:
                            - payable
                            - receivable
                        deprecated:
                          type: boolean
        policyFinancials:
          type: object
          additionalProperties: false
          required:
            - invoiceTypes
            - classifications
          properties:
            invoiceTypes:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - name
                  - expectedDirection
                  - deprecated
                  - lineItemTypes
                properties:
                  name:
                    type: string
                    minLength: 1
                  expectedDirection:
                    type: string
                    enum:
                      - payable
                      - receivable
                  deprecated:
                    type: boolean
                  presets:
                    type: object
                    additionalProperties: false
                    required:
                      - paymentCount
                      - owedLeadTimeDays
                      - payeeRule
                    properties:
                      paymentCount:
                        type: integer
                        minimum: 1
                      owedLeadTimeDays:
                        type: integer
                        minimum: 0
                      payeeRule:
                        type: string
                        enum:
                          - primary-insured
                          - broker
                  lineItemTypes:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - name
                        - direction
                        - componentKind
                        - deprecated
                      properties:
                        name:
                          type: string
                          minLength: 1
                        direction:
                          type: string
                          enum:
                            - payable
                            - receivable
                        componentKind:
                          type: string
                          enum:
                            - Premium
                            - Taxes
                            - Fees
                            - BrokerCommission
                            - ProgramCommission
                            - Other
                        deprecated:
                          type: boolean
            classifications:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - key
                  - label
                  - rollup
                  - deprecated
                properties:
                  key:
                    type: string
                    minLength: 1
                  label:
                    type: string
                    minLength: 1
                  rollup:
                    type: string
                    enum:
                      - premium
                      - taxes
                      - fees
                  legacyMatch:
                    type: object
                    additionalProperties: false
                    required:
                      - kind
                      - label
                    properties:
                      kind:
                        type: string
                        enum:
                          - Premium
                          - Taxes
                          - Fees
                          - BrokerCommission
                          - ProgramCommission
                          - Other
                      label:
                        type: string
                        minLength: 1
                  deprecated:
                    type: boolean
        reporting:
          type: object
          additionalProperties: false
          required:
            - exportSurfaces
            - invoiceTypeOverrides
          properties:
            exportSurfaces:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - surface
                  - frame
                properties:
                  surface:
                    type: string
                    enum:
                      - transactions
                      - overview
                      - reserveUpdates
                      - eventExport
                      - smartTags
                  frame:
                    type: string
                    enum:
                      - flow
                      - category
            invoiceTypeOverrides:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - eventInvoiceType
                  - surface
                  - frame
                properties:
                  eventInvoiceType:
                    type: string
                    minLength: 1
                  surface:
                    type: string
                    enum:
                      - transactions
                      - overview
                      - reserveUpdates
                      - eventExport
                      - smartTags
                  frame:
                    type: string
                    enum:
                      - flow
                      - category
    FinancialsConfigImportResponse:
      type: object
      additionalProperties: false
      required:
        - dryRun
        - changes
        - skipped
      properties:
        dryRun:
          type: boolean
        changes:
          type: object
          additionalProperties: false
          required:
            - eventInvoiceTypesCreated
            - policyInvoiceTypesCreated
            - lineItemTypesCreated
            - classificationsCreated
            - deprecatedRowsCreated
            - reportingFrameConfigUpdated
          properties:
            eventInvoiceTypesCreated:
              type: array
              items:
                type: string
            policyInvoiceTypesCreated:
              type: array
              items:
                type: string
            lineItemTypesCreated:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - scope
                  - invoiceType
                  - lineItemType
                properties:
                  scope:
                    type: string
                    enum:
                      - event
                      - policy
                  invoiceType:
                    type: string
                  lineItemType:
                    type: string
            classificationsCreated:
              type: array
              items:
                type: string
            deprecatedRowsCreated:
              type: array
              items:
                type: string
            reportingFrameConfigUpdated:
              type: boolean
        skipped:
          type: object
          additionalProperties: false
          required:
            - existingNaturalKeys
            - deprecatedNaturalKeys
          properties:
            existingNaturalKeys:
              type: array
              items:
                type: string
            deprecatedNaturalKeys:
              type: array
              items:
                type: string
    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
  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.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0
        access token (audience = the app API audience) as `Authorization: Bearer
        <jwt>`. The request resolves to the user's identity and is authorized by
        their Role on the `{companyId}` in the path — the same role-based
        permissions the web app enforces. This is the path the MCP connector
        uses to act on a user's behalf; endpoints that accept it list both
        `BearerAuth` and `ApiKeyAuth`.

````