Conecta Media LLC Year Overview API

openapi: 3.2.0
info:
  title: Document Extraction Year Overview API
  version: 1.0.0
  description: 'Email sign-up at /app/api/auth/sign-up/email requires an x-turnstile-token

    header in production. Failed or unavailable bot verification returns 403

    with code BOT_CHECK_REQUIRED. Social sign-up is unaffected.

    Documents in. Verified data out.


    The public REST API (v1) turns documents (invoices, receipts, purchase

    orders, bank statements, delivery notes, or custom schemas) into

    structured, verified data. Every document reaches an explicit terminal

    state. Every extracted table row is accounted for. Money fields are

    cross-checked (crossfooting). Bank statements are balance-checked.

    Every field links back to its source in the document.


    Unsupported methods on registered API paths return an empty

    405 Method Not Allowed response with an Allow header listing supported

    methods. HEAD is supported wherever GET is registered; OPTIONS keeps its

    existing preflight behavior. Unknown paths remain 404. Maintenance and

    canonical-host redirects still take precedence.'
  contact:
    email: support@arkrel.com
servers:
- url: https://arkrel.com
  description: Production, one Worker, one domain, same origin as the site itself (no separate api.<domain> host)
security:
- ApiKeyAuth: []
tags:
- name: year-overview
paths:
  /v1/year-overview:
    get:
      tags:
      - year-overview
      operationId: getYearOverview
      summary: 'My year: per-account month coverage, income vs. spending, next step'
      description: 'Groups this org''s `bank_statement` documents by account (as

        extracted, never a stored client/firm concept, this API has no

        notion of clients), and for the given calendar year reports which

        months are covered vs. missing per account (reusing the same

        continuity engine `POST /v1/statement-sets` uses), income vs.

        spending by Schedule C category (see `GET /v1/tax-report`), how

        many documents/transactions need attention, and one suggested

        next step. Nothing here is persisted. Recomputed from each

        document''s stored result on every call.'
      parameters:
      - name: year
        in: query
        required: false
        description: Defaults to the current calendar year.
        schema:
          type: integer
          minimum: 2000
          maximum: 2100
      responses:
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '200':
          description: Year overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YearOverview'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    AccountOverview:
      type: object
      required:
      - account_number
      - label
      - months
      - months_covered
      - months_expected
      - document_ids
      - findings
      properties:
        account_number:
          type: string
          nullable: true
          description: As extracted from the statement (masked if the statement itself was masked). Never a stored client identity.
        label:
          type: string
          description: '"Checking ending 4471", "Credit card ending 9902", or the generic "Account ending 4471" when the statement''s account_type could not be determined. Matches BalanceSheetLine''s own label for the same account, on the tax report.'
          example: Checking ending 4471
        months:
          type: array
          items:
            $ref: '#/components/schemas/MonthCoverage'
        months_covered:
          type: integer
        months_expected:
          type: integer
        document_ids:
          type: array
          items:
            type: string
        findings:
          type: array
          items:
            $ref: '#/components/schemas/StatementSetFinding'
          description: Reuses the same continuity engine as POST /v1/statement-sets (GAP/BREAK/OVERLAP/...).
    TaxReportCategory:
      type: string
      enum:
      - business_income
      - transfer_excluded
      - balance_sheet_excluded
      - advertising
      - car_and_truck
      - commissions_and_fees
      - contract_labor
      - depletion
      - depreciation
      - employee_benefit_programs
      - mortgage_interest
      - pension_and_profit_sharing
      - rent_or_lease_vehicles_equipment
      - insurance
      - interest
      - legal_and_professional
      - office_expense
      - rent_or_lease
      - repairs_and_maintenance
      - supplies
      - taxes_and_licenses
      - travel
      - meals
      - utilities
      - wages
      - other_expenses
      - personal_not_deductible
      - uncategorized
      - equipment_needs_review
    YearOverview:
      type: object
      required:
      - year
      - accounts
      - months_covered
      - months_expected
      - income_total
      - spending_total
      - spending_by_category
      - needs_review_documents
      - failed_documents
      - processing_documents
      - uncategorized_transactions
      - open_items
      - next_step
      properties:
        year:
          type: integer
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountOverview'
        months_covered:
          type: integer
        months_expected:
          type: integer
        income_total:
          type: number
        spending_total:
          type: number
        spending_by_category:
          type: array
          items:
            $ref: '#/components/schemas/CategoryTotal'
        needs_review_documents:
          type: integer
        failed_documents:
          type: integer
        processing_documents:
          type: integer
        uncategorized_transactions:
          type: integer
        open_items:
          type: integer
        next_step:
          type: object
          nullable: true
          required:
          - message
          - action
          - document_id
          - account_number
          - month
          properties:
            message:
              type: string
            action:
              type: string
              enum:
              - upload
              - review_document
              - categorize
              - none
            document_id:
              type: string
              nullable: true
            account_number:
              type: string
              nullable: true
              description: 'Only set for action "upload": the account the missing statement belongs to, so a client can carry it into the upload flow.'
            month:
              type: string
              nullable: true
              description: 'Only set for action "upload": the missing month, "YYYY-MM".'
      example:
        year: 2026
        accounts:
        - account_number: '4471'
          label: Checking ending 4471
          months:
          - month: 2026-01
            label: Jan 2026
            covered: true
            document_id: doc_01HXYZ0000000000000001
          - month: 2026-02
            label: Feb 2026
            covered: false
            document_id: null
          months_covered: 8
          months_expected: 9
          document_ids:
          - doc_01HXYZ0000000000000001
          findings: []
        months_covered: 8
        months_expected: 9
        income_total: 5000
        spending_total: 1200
        spending_by_category:
        - category: office_expense
          label: Office expense
          total: 300
        needs_review_documents: 1
        failed_documents: 0
        processing_documents: 0
        uncategorized_transactions: 3
        open_items: 4
        next_step:
          message: Upload the missing statement for checking ending 4471, February 2026
          action: upload
          document_id: null
          account_number: '4471'
          month: 2026-02
    CategoryTotal:
      type: object
      required:
      - category
      - label
      - total
      properties:
        category:
          $ref: '#/components/schemas/TaxReportCategory'
        label:
          type: string
        total:
          type: number
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
    StatementSetFinding:
      type: object
      required:
      - type
      - message
      - document_ids
      properties:
        type:
          type: string
          enum:
          - GAP
          - BREAK
          - OVERLAP
          - POSSIBLE_DUPLICATE
          - DUPLICATE_UPLOAD
          - DUPLICATE_UPLOAD_CONFLICT
          - UNIDENTIFIED_MEMBER
          - ACCOUNT_UNPROVEN
          - MIXED_ACCOUNTS
          - CURRENCY_MISMATCH
          - FAILED_CHECKS
          - MISSING_PERIOD
          - DATE_UNRESOLVED
          - AMOUNT_UNRESOLVED
          - RESULT_UNAVAILABLE
        message:
          type: string
          description: Plain-language, ready to show a bookkeeper directly.
        document_ids:
          type: array
          items:
            type: string
    MonthCoverage:
      type: object
      required:
      - month
      - label
      - covered
      - document_id
      properties:
        month:
          type: string
          description: YYYY-MM
        label:
          type: string
          example: Jan 2026
        covered:
          type: boolean
        document_id:
          type: string
          nullable: true
  responses:
    PaymentRequired:
      description: 'This org''s current plan does not include the requested feature.

        `error.code` is `TAX_REPORT_LOCKED` for the tax report, its

        export, a shared tax report or export, or a 1099 entry (unlocked by an active Catch-Up purchase

        for the exact tax year asked about, or a live Autopilot/Business

        subscription for the current calendar year), or `EXPORT_LOCKED`

        for a categorized statement-set export (unlocked by any of the

        same). A purchased Catch-Up year whose 12-month access term has ended

        also returns TAX_REPORT_LOCKED for My year, document reads, uploads

        targeting that year, edits, categorization, rules and downloads.

        Page packs and purchases of other years cannot reopen it. Raw extraction

        for other years remains priced per page.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BusinessSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Better Auth session cookie. Mutations also require a same-origin Origin header.
    EngineToken:
      type: apiKey
      in: header
      name: X-Engine-Token
      description: Shared operator token for internal maintenance.
    SessionCookie:
      type: apiKey
      in: cookie
      name: __Host-arkrel_session
      description: Signed-in app session. Mutations also require a same-origin request. Sensitive actions by accounts with a password without completed protection receive 403 TWO_FACTOR_SETUP_REQUIRED as described in x-app-account-protection. The free first look and account deletion remain available.
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'API key shown once at creation, e.g. `sk_live_...` / `sk_test_...`.

        Stored server-side as a salted hash; only the prefix is retrievable

        afterward.

        API keys and MCP credentials are checked against their creating user on every request. If that user has a password without enabled TOTP, requests return HTTP 403 TWO_FACTOR_SETUP_REQUIRED. Organization/service keys with no creating user keep their existing behavior.

        '
x-webhook-delivery-payload:
  $ref: '#/components/schemas/WebhookDeliveryPayload'
x-app-email-signup:
  path: /app/api/auth/sign-up/email
  method: POST
  header: x-turnstile-token
  status: 403
  code: BOT_CHECK_REQUIRED
  description: A fresh single-use Turnstile token with action signup and hostname matching APP_BASE_URL is required in production. Missing, invalid, expired, or unavailable verification fails closed. Reset the widget after each submission. Google sign-up is unaffected. Local development without a configured secret does not require a challenge. This route is served by the mounted Better Auth handler.
x-app-account-protection:
  status: 403
  code: TWO_FACTOR_SETUP_REQUIRED
  response:
    $ref: '#/components/responses/TwoFactorSetupRequired'
  description: 'Password accounts require verified TOTP before checkout or billing changes, reports and exports (PDF, CSV, accountant CSV, QuickBooks, Xero, OFX, JSON downloads, statement exports and data ZIP), share creation and use, API keys and MCP, bank or ledger connections, team changes, email/password changes, inbound sender allowlist changes, callback secrets, and uploads with webhook_url. Uploads that would consume paid page credits or record billable overage also return TWO_FACTOR_SETUP_REQUIRED before storage. Included monthly and purchased Catch-Up allowances remain available. Admission reserves pending pages, and settlement rechecks live protection against actual processed pages. Chart-of-accounts sync and all chart writes require protection; stored chart and categorization-settings reads do not contact a ledger provider. Session uploads with a callback return TWO_FACTOR_SETUP_REQUIRED before storing or scheduling the document when the password account needs setup. The same refusal applies when the business has an active saved outbound webhook, even if webhook_url is omitted. Queued webhook dispatch checks live creator and document-uploader protection before sending, including retries. Existing role, entitlement and step-up requirements remain. Linked passkeys or providers do not exempt password accounts. Passwordless accounts keep existing rules. Email verification remains required. Sign-up and sign-in do not redirect to setup. The free first look stays open: one statement upload or email-in, processing, merchant review, rules, My year and locked report previews, billing/pricing views, profile and business name, sign-out, and account deletion with its existing step-up. Sensitive actions prompt inline and resume after setup. Direct /protect-account links remain supported. Other app routes default to protection. Exemptions use explicit methods and complete route patterns; business settings changes other than name-only renames, session revocation, provider linking and token access require protection. Implicit same-email provider linking is disabled: sign in with the password first, protect the account and pass step-up, then link explicitly. Explicit linking and passkey registration require fresh step-up and recheck at credential creation or verification. Already-linked provider sign-in and first-time provider signup remain available. Authentication, recovery and TOTP enrollment ceremonies remain available. Credential mutation routes require protection, including passkey registration options and verification. OAuth and passkey removal also require fresh step-up (401 STEP_UP_REQUIRED). Password credential unlinking is refused with 403 PASSWORD_REMOVAL_NOT_ALLOWED even after enrollment and step-up, preserving the password account protection requirement. The server reads live enrollment. API keys and MCP credentials retain their creator check; creatorless service keys retain existing behavior. Share links created by an unprotected password account remain unavailable.'
  open_workflows:
  - Free first look and locked report preview
  - Billing and pricing views
  - Profile name and sign-out
  - Account deletion with existing step-up
  - Authentication and protection enrollment
  session_status:
    path: /app/api/auth/me
    rate_limits:
      window_seconds: 60
      per_session: 180
      per_ip: 600
      status: 429
      retry_header: Retry-After
      description: Independent read budgets. The IP budget precedes session resolution; the session budget uses the resolved session ID before membership and protection reads. These reads do not consume credential budgets.
    field: two_factor_setup_required
    schema:
      type: boolean
    description: Present on authenticated responses. True means sensitive actions require enrollment; it does not block the free first look or redirect sign-in. Absent when user is null.
x-app-account-deletion:
  description: An account deletion intent (pending, processing, or failed) ends access immediately, including while financial obligations delay purge. All user sessions are revoked atomically with the intent, along with user-created API keys, share links, invitations, webhooks and inbound email addresses across every business. Better Auth lookups hide retained identities and their credentials. Validation, reset, verification and challenge errors follow the native unknown-user or unknown-token behavior, including validation order and password work. Anonymous sign-up uses the generic duplicate response without sending mail or creating credentials. OAuth cannot recreate a reserved identity. Credential inserts, updates and deletes are fenced against deletion at SQL execution time. Old session and two-factor challenge cookies are ignored on the request. Deletion never sends cookie expirations, so delayed responses cannot erase another login. Auth revocation expires sessions that anchor Plaid compensation operations and retains their rows until those operations are removed by their own lifecycle. Step-up and invite acceptance return the existing unauthenticated HTTP 401 response. Removed magic-link endpoints remain HTTP 404 for everyone. The email is reserved until purge completes. Business-only deletion retains the login and other businesses, but hides and blocks the deleting business immediately, including while billing leases drain. API keys for deleting businesses return unauthenticated HTTP 401.
x-app-step-up:
  window_seconds: 600
  description: 'Sensitive app actions require fresh identity verification. GET /app/api/auth/step-up returns password, code, email, passkey, google, microsoft and fresh booleans. POST /app/api/auth/step-up accepts exactly one of password, code (TOTP/backup), or emailCode. POST /app/api/auth/step-up/email sends a six-digit code to the verified email of a passwordless account, at most three times per ten minutes per user. Codes are hashed, single-use, expire after ten minutes, permit five attempts, and are bound to the initiating live session, user, email and step-up purpose. Resending invalidates the previous code. Verification is rate-limited. Passkey ceremonies require x-arkrel-step-up: 1 on both challenge issuance and verification, biometric/PIN user verification, and a server-side purpose, user and session binding that expires after five minutes. Consumption requires the exact initiating live session. Provider users call sign-in/social with a linked google provider and additionalData.stepUp=true. The server rejects idToken shortcuts and binds OAuth state to the original user/session for five minutes. Google cannot force reauthentication and is opportunistic only. It requires a back-channel auth_time between initiation and completion; token issuance time never counts. Missing, stale or future auth_time is rejected. Passwordless users can use an email code or a registered passkey when Google cannot verify freshness. Successful passkey/provider verification rotates and elevates only the returning bound session. Password, TOTP and email checks elevate the initiating session. These app-only auth surfaces are not exposed by integrations or MCP.'
x-consumer-statement-admission:
  description: App uploads and inbound email share one Free statement allowance per account. Additional app uploads return 402 FREE_STATEMENT_USED. Inbound attachments wait for an upgrade. Retries recover the original admitted attachment. Developer API per-page pricing is unchanged.
x-maintenance-bridge:
  description: 'During the production cutover, an isolated maintenance Worker returns HTTP 503 for every method and path, including reads and health checks, with Retry-After: 60 and Cache-Control: no-store. API, MCP, internal, and webhook paths return error.code MAINTENANCE and error.message "Arkrel is updating. Please try again in a few minutes." MCP receives this plain JSON error instead of JSON-RPC while the bridge is deployed. Other paths return HTML. HEAD returns headers without a body. Retry after the indicated delay.'
x-maintenance-mode:
  description: 'MAINTENANCE_MODE=1 freezes mutations across app, REST, MCP and engine routes. Mutations and OAuth or verification callbacks return 503 with Retry-After: 60. REST errors use code MAINTENANCE_MODE. MCP tool mutations use JSON-RPC code -32004. Reads, health and status remain available. Read-time refresh, audit, counters and automatic categorization are suspended. Cron writes are skipped; inbound email invocations fail before ingestion so delivery can be retried.'
x-stripe-billing-webhook:
  path: /app/api/billing/webhook
  authentication: Stripe-Signature
  refund_events:
  - charge.refunded
  - refund.updated
  - refund.failed
  dispute_events:
  - charge.dispute.created
  - charge.dispute.updated
  - charge.dispute.closed
  description: Refund IDs and provider statuses are persisted. Catch-Up access and unused page credits are revoked only after a succeeded refund. Pending or failed refunds retain access. The dashboard refund response has refunded=false while an automatic refund is pending or failed, with auto=true indicating that the automatic request was submitted. Disputes suspend the charged subscription, Catch-Up year, or unused page credits. A won dispute restores only the saved access and original credit expiration, unless the payment was refunded or another dispute still holds it. Lost disputes remain suspended. Subscription updates cannot bypass a hold. Independent AppSumo codes are unaffected. The owner receives an operational email alert.
x-app-catchup-payment-clock:
  path: /app/api/usage
  field: catchup_purchases
  items:
    type: object
    required:
    - tax_year
    - purchased_at
    - payment_settled_at
    - expires_at
    properties:
      tax_year:
        type: integer
      purchased_at:
        type: string
        format: date-time
        description: Purchase record time. Do not use as an unresolved payment clock fallback.
      expires_at:
        type: string
        format: date-time
        description: Access and unused pages end at this instant, 12 months after settlement. Older test rows use their purchase timestamp until settlement is reconciled.
      payment_settled_at:
        type: string
        format: date-time
        nullable: true
        description: Confirmed payment charge time, or null while confirmation is unresolved. The 30-day guarantee starts at this time.