medianfi-com Accounting Classes API

openapi: 3.2.0
info:
  title: Median Accounting Classes API
  version: 0.1.0
  description: Production-grade Node.js + Express API starter template
  license:
    name: Proprietary
servers:
- url: /api/v1
security: []
tags:
- name: Accounting Classes
paths:
  /companies/{companyId}/classes:
    parameters:
    - $ref: '#/components/parameters/companyId'
    get:
      operationId: listAccountingClasses
      summary: List accounting classes
      description: Customer-facing class list. Returns only active classes approved for this company. Draft or inactive classes and proposal evidence are never returned to customer app users.
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Accounting classes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerAccountingClassesListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /accountant/companies/{customerId}/classes:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: listAccountantAccountingClasses
      summary: List customer accounting classes as accountant
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      - serviceApiKey: []
      parameters:
      - name: includeInactive
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      responses:
        '200':
          description: Accounting classes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassesListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: createAccountantAccountingClass
      summary: Create a customer accounting class
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountingClassInput'
      responses:
        '201':
          description: Accounting class created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Class name already exists for customer
        '422':
          description: Validation error
  /accountant/companies/{customerId}/classes/proposals:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      operationId: listAccountingClassProposals
      summary: List customer class assignment proposals
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      - serviceApiKey: []
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - proposed
          - approved
          - applied
          - rejected
          - correction_proposed
      - name: transactionId
        in: query
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 200
      responses:
        '200':
          description: Accounting class proposals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassProposalsListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /accountant/companies/{customerId}/classes/proposals/bulk:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      operationId: bulkReviewAccountingClassProposals
      summary: Bulk approve, change, or reject class proposals
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      - serviceApiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkAccountingClassProposalActionInput'
      responses:
        '200':
          description: Bulk class proposal action result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassProposalBulkActionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
  /accountant/companies/{customerId}/classes/proposals/{proposalId}/approve:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    - name: proposalId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      operationId: approveAccountingClassProposal
      summary: Approve a class assignment proposal
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      - serviceApiKey: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveAccountingClassProposalInput'
      responses:
        '200':
          description: Class proposal approved or converted to correction proposal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassProposalActionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
  /accountant/companies/{customerId}/classes/proposals/{proposalId}/reject:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    - name: proposalId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      operationId: rejectAccountingClassProposal
      summary: Reject a class assignment proposal
      description: Rejects an unapplied proposed, approved, or correction proposal. Applied proposals are immutable.
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      - serviceApiKey: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RejectAccountingClassProposalInput'
      responses:
        '200':
          description: Class proposal rejected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassProposalActionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ConflictJson'
        '422':
          $ref: '#/components/responses/ValidationError'
  /accountant/companies/{customerId}/classes/{classId}:
    parameters:
    - name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    - name: classId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    patch:
      operationId: updateAccountantAccountingClass
      summary: Update a customer accounting class
      tags:
      - Accounting Classes
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountingClassInput'
      responses:
        '200':
          description: Accounting class updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingClassResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Accounting class not found
        '409':
          description: Class name already exists for customer
        '422':
          description: Validation error
components:
  schemas:
    AccountingClass:
      type: object
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - draft
          - active
          - inactive
        source:
          type: string
          enum:
          - accountant
          - bookkeeping_engine
          - import
        isActive:
          type: boolean
        approvedAt:
          type:
          - string
          - 'null'
          format: date-time
        approvedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        metadata:
          type: object
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ApproveAccountingClassProposalInput:
      type: object
      properties:
        classId:
          type: string
          format: uuid
          description: Optional active class to use instead of the proposed class.
        apply:
          type: boolean
          description: Apply to the transaction when possible. Posted journal entries create correction proposals instead.
    CustomerAccountingClassesListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerAccountingClass'
    AccountingClassProposalActionResult:
      type: object
      properties:
        proposal:
          $ref: '#/components/schemas/AccountingClassProposal'
        outcome:
          type: string
          enum:
          - approved
          - applied
          - rejected
          - correction_proposed
        transactionId:
          type:
          - string
          - 'null'
          format: uuid
        classId:
          type:
          - string
          - 'null'
          format: uuid
    ApiErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ProblemDetail'
    UpdateAccountingClassInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        description:
          type:
          - string
          - 'null'
          maxLength: 500
        isActive:
          type: boolean
        status:
          type: string
          enum:
          - draft
          - active
          - inactive
    ProblemDetail:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
          description: 'For application errors, a stable UPPER_SNAKE machine code (for example `NOT_FOUND`, `FORECAST_NOT_FOUND`, `VALIDATION_ERROR`). Clients branch on this, never on `detail` wording. A few transport level responses use a short human title instead.

            '
        status:
          type: integer
        detail:
          type: string
          description: 'Human-readable explanation; correlate a failure with `traceId`. A NOT_FOUND-family 404 names the resource type (for example "Company not found"), not its id. Some legacy messages still include an id (tracked in #2666).

            '
        instance:
          type: string
        traceId:
          type: string
        retryAfter:
          type: integer
          minimum: 0
          description: Whole seconds until retry is allowed for a 429 response
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        extensions:
          type: object
          additionalProperties: true
    AccountingClassProposalBulkActionResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/AccountingClassProposalActionResult'
    AccountingClassesListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountingClass'
    AccountingClassProposal:
      type: object
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        engineRunId:
          type:
          - string
          - 'null'
          format: uuid
        transactionId:
          type:
          - string
          - 'null'
          format: uuid
        transactionSplitId:
          type:
          - string
          - 'null'
          format: uuid
        proposedClassId:
          type:
          - string
          - 'null'
          format: uuid
        proposedClassName:
          type:
          - string
          - 'null'
        proposedClass:
          oneOf:
          - $ref: '#/components/schemas/AccountingClass'
          - type: 'null'
        approvedClassId:
          type:
          - string
          - 'null'
          format: uuid
        status:
          type: string
          enum:
          - proposed
          - approved
          - applied
          - rejected
          - correction_proposed
        confidence:
          type:
          - number
          - 'null'
          minimum: 0
          maximum: 1
        applyEligibility:
          type: boolean
        source:
          type: string
          enum:
          - bookkeeping_engine
          - accountant
          - import
        reasoningSummary:
          type:
          - string
          - 'null'
        evidence:
          type: object
          additionalProperties: true
        metadata:
          type: object
          additionalProperties: true
        approvedAt:
          type:
          - string
          - 'null'
          format: date-time
        approvedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        appliedAt:
          type:
          - string
          - 'null'
          format: date-time
        rejectedAt:
          type:
          - string
          - 'null'
          format: date-time
        rejectedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    AccountingClassResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/AccountingClass'
    BulkAccountingClassProposalActionInput:
      oneOf:
      - type: object
        required:
        - action
        - proposalIds
        properties:
          action:
            type: string
            enum:
            - approve
          proposalIds:
            type: array
            minItems: 1
            maxItems: 200
            items:
              type: string
              format: uuid
          apply:
            type: boolean
        additionalProperties: false
      - type: object
        required:
        - action
        - proposalIds
        - classId
        properties:
          action:
            type: string
            enum:
            - change
          proposalIds:
            type: array
            minItems: 1
            maxItems: 200
            items:
              type: string
              format: uuid
          classId:
            type: string
            format: uuid
          apply:
            type: boolean
        additionalProperties: false
      - type: object
        required:
        - action
        - proposalIds
        properties:
          action:
            type: string
            enum:
            - reject
          proposalIds:
            type: array
            minItems: 1
            maxItems: 200
            items:
              type: string
              format: uuid
          reason:
            type: string
            maxLength: 500
        additionalProperties: false
      discriminator:
        propertyName: action
    AccountingClassProposalActionResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/AccountingClassProposalActionResult'
    AccountingClassProposalsListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountingClassProposal'
    CreateAccountingClassInput:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        description:
          type:
          - string
          - 'null'
          maxLength: 500
        isActive:
          type: boolean
        status:
          type: string
          enum:
          - draft
          - active
          - inactive
    CustomerAccountingClass:
      type: object
      description: 'Customer-facing accounting class. Only active classes approved for the company are returned; accountant-only metadata and proposal evidence are never included.

        '
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - active
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    RejectAccountingClassProposalInput:
      type: object
      properties:
        reason:
          type: string
          maxLength: 500
  responses:
    Forbidden:
      description: Insufficient permissions or not a company member
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    Unauthorized:
      description: Authentication required
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    ConflictJson:
      description: Request conflicts with the durable onboarding state
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
    ValidationError:
      description: Request failed validation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    NotFound:
      description: Resource not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    serviceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Persistent credential for the configured cloud-bookkeeping service principal. The key must carry accountant:* and is accepted only on accountant operations that explicitly list this scheme. Ordinary API keys, and service keys presented to bearer-only operations, are denied.

        '
    refreshSessionCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_refresh
      description: 'Exact production HttpOnly refresh-session cookie. Local non-secure development uses median_refresh.

        '
    passkeyEnrollmentGrantCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_passkey_enrollment
      description: 'Exact production HttpOnly passkey-enrollment grant cookie. Local non-secure development uses median_passkey_enrollment.

        '
    webAuthnCeremonyCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_webauthn
      description: 'Exact production HttpOnly WebAuthn ceremony cookie. Local non-secure development uses median_webauthn.

        '
x-median-quarantined-authorities:
  decision: ADR-0001-model-a
  runtimeStatus: unmounted
  description: 'Migrations 267-272 modeled legal entities as separate company tenants. These paths are not runtime API authority while their preserved accounting math is re-keyed to legal entities inside one company workspace.

    '
  paths:
  - /companies/{companyId}/consolidation-groups
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/report-rollups
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/report-rollups/{rollupId}
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/translation-adjustments
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/translation-adjustments/{adjustmentId}
x-median-demo-parity-customer-surface:
  runtimeStatus: mounted-lifecycle-only
  description: 'v2 customer-app capabilities available to JWT-authenticated members of any active or test company — the v2 app is the product, not a rollout cohort, so no allowlist applies to the markerless path. Production customer calls omit X-Median-App-Surface. Test-company calls may carry X-Median-App-Surface: qa to select the QA bundle; that marker branch alone still requires membership in CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS. An API key, unknown marker, malformed company id, inactive company, missing gate dependency, or failed company lookup receives the standard hidden-resource 404 contract. The held surfaces riding these prefixes (AR/AP, Forecast, Insights) carry their own additional allowlist gate — see x-median-forecast-hold and x-median-ar-ap-hold.

    '
  headerContract: '#/components/parameters/demoParityCustomerAppSurface'
  routePrefixes:
  - /companies/{companyId}/ar
  - /companies/{companyId}/ap
  - /companies/{companyId}/customers
  - /companies/{companyId}/vendors
  - /companies/{companyId}/contracts
  - /companies/{companyId}/receivables
  - /companies/{companyId}/entities
  - /companies/{companyId}/currencies
  - /companies/{companyId}/reporting-scopes
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/rollups
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/translation-adjustments
  - /companies/{companyId}/presentation-report-snapshots
  - /companies/{companyId}/reporting-trial-balances
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/trial-balances
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/intercompany
  - /companies/{companyId}/weekly-email
  - /companies/{companyId}/forecast
  - /companies/{companyId}/books
  - /companies/{companyId}/sub-ledgers
x-median-forecast-hold:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Forecast is held. Beyond the lifecycle-only customer surface above, every operation under the prefix below also requires the company to appear in the held-surface allowlist CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS — the one operator-set list that opens AR/AP, Forecast and Insights (the legacy CUSTOMER_APP_FORECAST_COMPANY_IDS variable is no longer consulted). It is empty by default, so the v2 rollout alone never exposes Forecast. A company off the list receives the same hidden-resource 404 contract as one for which the surface does not exist. The auth-context featureFlags key `forecast` mirrors this verdict for the customer app shell.

    '
  featureFlag: forecast
  routePrefixes:
  - /companies/{companyId}/forecast
x-median-ar-ap-hold:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Receivables/Payables are held behind TWO required authorities. Beyond the lifecycle-only customer surface above, every operation under the prefixes below requires the company to appear in the held-surface allowlist CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS (requireDemoParityAllowlistedCompany) AND to satisfy the company_subledger_flags conversion chain (requireArApItemsEnabled — the same authority the public /pay page, aging and the accountant portal consult); failing either answers the opaque 404. The auth-context featureFlags key `arApItems` mirrors exactly that conjunction, resolved server-side, so the customer shell hides the Receivables/Payables nav and pages instead of offering menu entries these routes 404. Default is FALSE for every company while the list is empty or the conversion has not run.

    '
  featureFlag: arApItems
  routePrefixes:
  - /companies/{companyId}/ar
  - /companies/{companyId}/ap
  - /companies/{companyId}/customers
  - /companies/{companyId}/vendors
  - /companies/{companyId}/contracts
  - /companies/{companyId}/receivables
x-median-demo-parity-qa-only:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Strict test-company-only routes. Every interactive call requires X-Median-App-Surface: qa in addition to JWT authentication, the server allowlist, and persisted client_status=test. A copied header, API key, active company, missing gate dependency, or failed company lookup receives the standard hidden-resource 404 contract.

    '
  headerContract: '#/components/parameters/qaAppSurface'
  routePrefixes:
  - /companies/{companyId}/gl-accounts/{id}/monetary-classification
  - /companies/{companyId}/fx-account-roles
  - /companies/{companyId}/gl-periods/{periodId}/fx-revaluation
  - /accountant/companies/{customerId}/gl-accounts/{id}/monetary-classification
  - /accountant/companies/{customerId}/fx-account-roles
  - /accountant/companies/{customerId}/gl-periods/{periodId}/fx-revaluation
  - /accountant/companies/{customerId}/ar/{id}
  - /accountant/companies/{customerId}/ap/{id}
x-median-onboarding-v3-surface:
  runtimeStatus: promoted
  promotionFlag: ONBOARDING_V3_QA_ONLY=false
  description: 'Promoted. The deployment this contract describes runs ONBOARDING_V3_QA_ONLY=false, so none of the onboarding-v3 auth, pricing, or setup paths below requires X-Median-App-Surface: qa. An unmarked request is served and reaches ordinary authentication, so an unauthenticated call now answers 401 rather than the hidden-resource 404. Mounting is still conditional: with ONBOARDING_V3_ENABLED false every path below returns the hidden-resource 404 before body parsing or authentication. The header stays defined and is still honoured, because a deployment left at ONBOARDING_V3_QA_ONLY=true keeps requiring it on every path below and 404s unmarked traffic; setting that flag back to true is the rollback. On either setting the header is a pre-company bundle marker, never tenant authorization.

    '
  headerContract: '#/components/parameters/onboardingV3QaSurface'
  routePaths:
  - /auth/otp/start
  - /auth/otp/verify
  - /auth/passkeys/register/options
  - /auth/passkeys/register/verify
  - /auth/passkeys/assert/options
  - /auth/passkeys/assert/verify
  - /onboarding/v3/quote
  - /onboarding/v3/offer/resolve
  - /onboarding/v3/flow
  - /onboarding/v3/setup-intent
  - /onboarding/v3/subscribe
  - /onboarding/v3/test-account-activation
  - /onboarding/v3/checkout-session
  - /onboarding/v3/checkout-session/complete
  - /onboarding/v3/setup-state
  - /onboarding/v3/delegate-invites
  - /onboarding/v3/delegate-invites/{inviteId}
  - /onboarding/v3/delegate/resolve
  - /onboarding/v3/delegate
  - /onboarding/v3/task-context
  - /onboarding/v3/delegate/task-context
  - /onboarding/v3/banks/plaid/link-token
  - /onboarding/v3/banks/plaid/exchange
  - /onboarding/v3/banks/commit
  - /onboarding/v3/documents/google-workspace/auth-url
  - /onboarding/v3/documents/google-workspace/callback
  - /onboarding/v3/books/quickbooks/auth-url
  - /onboarding/v3/books/quickbooks/callback
  - /onboarding/v3/books/xero/auth-url
  - /onboarding/v3/books/xero/callback
  - /onboarding/v3/welcome-call
  - /onboarding/v3/welcome-call/embed
  - /onboarding/v3/books-progress
  - /onboarding/v3/books/open
  - /companies/{companyId}/onboarding/v3/questions
  - /companies/{companyId}/onboarding/v3/questions/{questionId}/answer
  - /companies/{companyId}/onboarding/v3/review-items