AI2Fin Automation API

openapi: 3.2.0
info:
  title: AI2Fin Financial Management Automation API
  description: Financial management platform with AI-powered categorization, tax optimization, and bill management.
  version: 1.0.0
  contact:
    name: AI2Fin Support
    url: https://ai2fin.com
  license:
    name: Proprietary
servers:
- url: https://api.ai2fin.com
  description: Production
- url: http://localhost:3001
  description: Local Development
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Automation
  description: Custom rules engine for automated workflows
paths:
  /api/custom-rules:
    get:
      tags:
      - Automation
      summary: List custom rules
      description: Get all user-defined automation rules for transactions, bills, and expenses
      responses:
        '200':
          description: Rules retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomRule'
      operationId: getApiCustomRules
      x-operation-id-source: derived
    post:
      tags:
      - Automation
      summary: Create custom rule
      description: Create automation rule with conditions and actions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomRuleInput'
      responses:
        '201':
          description: Rule created successfully
      operationId: postApiCustomRules
      x-operation-id-source: derived
  /api/custom-rules/{id}/execute:
    post:
      tags:
      - Automation
      summary: Execute custom rule
      description: Manually execute a custom rule on matching transactions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Rule executed
          content:
            application/json:
              schema:
                type: object
                properties:
                  processed:
                    type: integer
                  updated:
                    type: integer
      operationId: postApiCustomRulesByIdExecute
      x-operation-id-source: derived
components:
  schemas:
    CustomRule:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        entityType:
          type: string
          enum:
          - transaction
          - bill
          - expense
          - billPattern
          - billOccurrence
        conditions:
          type: array
          items:
            type: object
        actions:
          type: array
          items:
            type: object
        isActive:
          type: boolean
        priority:
          type: integer
    CustomRuleInput:
      type: object
      required:
      - name
      - entityType
      - conditions
      - actions
      properties:
        name:
          type: string
        description:
          type: string
        entityType:
          type: string
          enum:
          - transaction
          - bill
          - expense
          - billPattern
          - billOccurrence
        conditions:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              operator:
                type: string
                enum:
                - equals
                - contains
                - starts_with
                - ends_with
                - greater_than
                - less_than
                - regex
              value:
                type: string
              caseSensitive:
                type: boolean
        actions:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - set_category
                - set_tax_deductible
                - set_business_percentage
                - set_merchant
              value:
                type: string
        priority:
          type: integer
          default: 0
        autoExecute:
          type: boolean
          default: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: First-party access token for your own signed-in session, obtained from the /api/enterprise-auth/login endpoint. The REST API returns your own account data to you — it is a first-party consumer surface, not a third-party integration channel. Data from connected bank feeds (open-banking / CDR data) is your own data, returned only to you in your own authenticated session.
    cookieAuth:
      type: apiKey
      in: cookie
      name: ai2_sess
      description: Session cookie for web applications
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for the MCP Inspector endpoint (/mcp/inspector) only. Generate your own key via /api/api-keys. Format: mcp_<64 hex characters>. API keys carry mcp:* scopes and authenticate MCP Inspector operations — they are not accepted on the REST API (/api/...) or the main MCP endpoint (/mcp), which use OAuth bearer tokens.'