AI2Fin Bills & Recurring Payments API

openapi: 3.2.0
info:
  title: AI2Fin Financial Management Bills & Recurring Payments 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: Bills & Recurring Payments
  description: Bill management with pattern recognition and auto-linking
paths:
  /api/bills:
    get:
      tags:
      - Bills & Recurring Payments
      summary: List bills
      description: Retrieve all bills with filtering and pagination
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          default: 1
      - name: limit
        in: query
        schema:
          type: integer
          default: 50
      - name: paid
        in: query
        schema:
          type: boolean
      - name: fromDate
        in: query
        schema:
          type: string
          format: date
      - name: toDate
        in: query
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Bills retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  bills:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bill'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
      operationId: getApiBills
      x-operation-id-source: derived
    post:
      tags:
      - Bills & Recurring Payments
      summary: Create bill
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillInput'
      responses:
        '201':
          description: Bill created successfully
      operationId: postApiBills
      x-operation-id-source: derived
  /api/bills/patterns:
    get:
      tags:
      - Bills & Recurring Payments
      summary: List bill patterns
      description: Get all recurring bill patterns with automatic occurrence generation
      parameters:
      - name: includeInactive
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Bill patterns retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BillPattern'
      operationId: getApiBillsPatterns
      x-operation-id-source: derived
    post:
      tags:
      - Bills & Recurring Payments
      summary: Create bill pattern
      description: Create recurring bill pattern with automatic occurrence generation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillPatternInput'
      responses:
        '201':
          description: Pattern created with occurrences
      operationId: postApiBillsPatterns
      x-operation-id-source: derived
components:
  schemas:
    BillPatternInput:
      type: object
      required:
      - name
      - baseAmount
      - frequency
      - startDate
      properties:
        name:
          type: string
        baseAmount:
          type: number
        frequency:
          type: string
          enum:
          - daily
          - weekly
          - fortnightly
          - monthly
          - quarterly
          - yearly
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        categoryId:
          type: string
        dayOfMonth:
          type: integer
          minimum: 1
          maximum: 31
    Category:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        icon:
          type: string
        color:
          type: string
        isTaxDeductible:
          type: boolean
        taxCategory:
          type: string
        defaultGstRate:
          type: number
    BillInput:
      type: object
      required:
      - name
      - amount
      - dueDate
      properties:
        name:
          type: string
        amount:
          type: number
        dueDate:
          type: string
          format: date
        categoryId:
          type: string
        notes:
          type: string
    Bill:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        amount:
          type: number
        dueDate:
          type: string
          format: date
        paid:
          type: boolean
        categoryId:
          type: string
        category:
          $ref: '#/components/schemas/Category'
        recurring:
          type: boolean
    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        pages:
          type: integer
    BillPattern:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        baseAmount:
          type: number
        frequency:
          type: string
          enum:
          - daily
          - weekly
          - fortnightly
          - monthly
          - quarterly
          - yearly
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        isActive:
          type: boolean
        categoryId:
          type: string
        occurrences:
          type: array
          items:
            type: object
  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.'