medianfi-com GL Accounts API

openapi: 3.2.0
info:
  title: Median GL Accounts API
  version: 0.1.0
  description: Production-grade Node.js + Express API starter template
  license:
    name: Proprietary
servers:
- url: /api/v1
security: []
tags:
- name: GL Accounts
paths:
  /companies/{companyId}/gl-accounts:
    parameters:
    - $ref: '#/components/parameters/companyId'
    get:
      operationId: listGlAccounts
      summary: List GL accounts (chart of accounts)
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      parameters:
      - name: type
        in: query
        schema:
          type: string
          enum:
          - Asset
          - Liability
          - Equity
          - Revenue
          - Expense
      - name: isActive
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - name: limit
        in: query
        description: Maximum GL accounts to return. Defaults high enough to avoid truncating normal charts of accounts.
        schema:
          type: integer
          minimum: 1
          maximum: 5000
          default: 5000
      - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: Paginated list of GL accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountsListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: createGlAccount
      summary: Create a GL account
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGlAccountInput'
      description: Creates a GL account, audited with the acting user. An exact replay (#2883) — an active account with the same code whose name, type, detail type, subtype, parent and normal balance all match the request — returns that account with 200 and writes nothing. A same-code request that differs is a 409 GL_ACCOUNT_CODE_CONFLICT naming the fields; a code held by a retired account is a 409 GL_ACCOUNT_CODE_RETIRED.
      responses:
        '200':
          description: Exact replay; the existing GL account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '201':
          description: GL account created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Account code already exists with different fields (GL_ACCOUNT_CODE_CONFLICT) or belongs to a retired account (GL_ACCOUNT_CODE_RETIRED)
        '422':
          description: Validation error
  /companies/{companyId}/gl-accounts/{id}:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/resourceId'
    get:
      operationId: getGlAccount
      summary: Get a GL account by ID
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      responses:
        '200':
          description: GL account found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: GL account not found
    patch:
      operationId: updateGlAccount
      summary: Update a GL account
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGlAccountInput'
      responses:
        '200':
          description: GL account updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: GL account not found
        '422':
          description: Validation error
    delete:
      operationId: softDeleteGlAccount
      summary: Soft-delete a GL account (set inactive)
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      responses:
        '204':
          description: GL account deactivated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: GL account not found
  /companies/{companyId}/gl-accounts/{id}/monetary-classification:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/resourceId'
    - $ref: '#/components/parameters/qaAppSurface'
    patch:
      operationId: classifyGlAccountMonetaryQa
      summary: Record an audited monetary decision (QA test companies only)
      description: Requires an allowlisted test company, the QA application marker, and company role admin or owner. Unknown foreign-balance accounts block revaluation until this explicit decision exists.
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - isMonetary
              properties:
                isMonetary:
                  type: boolean
      responses:
        '200':
          description: Classification recorded with actor and timestamp
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside QA, or account not found
        '422':
          description: Only Asset and Liability accounts may be manually classified
  /companies/{companyId}/fx-account-roles:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/qaAppSurface'
    get:
      operationId: listFxAccountingRolesQa
      summary: List configured FX accounting authorities
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      responses:
        '200':
          description: The three supported roles and their real company accounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FxAccountingRolesResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside the QA test-company boundary
  /companies/{companyId}/fx-account-roles/{role}:
    parameters:
    - $ref: '#/components/parameters/companyId'
    - $ref: '#/components/parameters/fxAccountingRole'
    - $ref: '#/components/parameters/qaAppSurface'
    put:
      operationId: configureFxAccountingRoleQa
      summary: Map an FX authority to a real company GL account
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - glAccountId
              properties:
                glAccountId:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Audited company-scoped role mapping
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FxAccountingRoleResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside QA, or account not found
        '422':
          description: Account is incompatible with the selected accounting role
  /accountant/companies/{customerId}/gl-accounts/{id}/monetary-classification:
    parameters:
    - $ref: '#/components/parameters/customerId'
    - $ref: '#/components/parameters/resourceId'
    - $ref: '#/components/parameters/qaAppSurface'
    patch:
      operationId: classifyAccountantGlAccountMonetaryQa
      summary: Record an assigned QA company's audited monetary decision
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - isMonetary
              properties:
                isMonetary:
                  type: boolean
      responses:
        '200':
          description: Classification recorded with accountant actor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlAccountResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside QA, assignment missing, or account not found
        '422':
          description: Only Asset and Liability accounts may be manually classified
  /accountant/companies/{customerId}/fx-account-roles:
    parameters:
    - $ref: '#/components/parameters/customerId'
    - $ref: '#/components/parameters/qaAppSurface'
    get:
      operationId: listAccountantFxAccountingRolesQa
      summary: List an assigned QA company's FX accounting authorities
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Configured role mappings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FxAccountingRolesResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside the QA test-company boundary
  /accountant/companies/{customerId}/fx-account-roles/{role}:
    parameters:
    - $ref: '#/components/parameters/customerId'
    - $ref: '#/components/parameters/fxAccountingRole'
    - $ref: '#/components/parameters/qaAppSurface'
    put:
      operationId: configureAccountantFxAccountingRoleQa
      summary: Configure an assigned QA company's FX accounting authority
      tags:
      - GL Accounts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - glAccountId
              properties:
                glAccountId:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Audited role mapping
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FxAccountingRoleResponse'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Hidden outside QA, or account not found
        '422':
          description: Account is incompatible with the selected accounting role
components:
  schemas:
    FxAccountingRoleAuthority:
      type: object
      required:
      - role
      properties:
        role:
          type: string
          enum:
          - TRANSFER_CLEARING
          - REALIZED_FX_GAIN_LOSS
          - UNREALIZED_FX_GAIN_LOSS
        glAccountId:
          type: string
          format: uuid
        mapping:
          oneOf:
          - $ref: '#/components/schemas/GlAccountRoleMapping'
          - type: 'null'
        account:
          oneOf:
          - $ref: '#/components/schemas/GlAccount'
          - type: 'null'
    CreateGlAccountInput:
      type: object
      required:
      - code
      - name
      - type
      properties:
        code:
          type: string
          minLength: 1
          maxLength: 20
        name:
          type: string
          minLength: 1
          maxLength: 255
        type:
          type: string
          enum:
          - Asset
          - Liability
          - Equity
          - Revenue
          - Expense
        subtype:
          type: string
          maxLength: 100
        parentAccountId:
          type: string
          format: uuid
        normalBalance:
          type: string
          enum:
          - debit
          - credit
        detailTypeKey:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 100
        reportSectionKey:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 100
        description:
          type:
          - string
          - 'null'
          maxLength: 1000
    GlAccountRoleMapping:
      type: object
      required:
      - id
      - companyId
      - role
      - glAccountId
      - createdAt
      - updatedAt
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        role:
          type: string
          enum:
          - TRANSFER_CLEARING
          - REALIZED_FX_GAIN_LOSS
          - UNREALIZED_FX_GAIN_LOSS
        glAccountId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        updatedByUserId:
          type:
          - string
          - 'null'
          format: uuid
    PaginationMeta:
      type: object
      properties:
        nextCursor:
          type:
          - string
          - 'null'
        hasMore:
          type: boolean
    CoaAccountExplanation:
      type: object
      description: 'Read-only COA account context returned only when the customer company is allowlisted by CUSTOMER_APP_INTELLIGENCE_HOME_COMPANY_IDS.

        '
      properties:
        accountType:
          $ref: '#/components/schemas/CoaAccountExplanationPart'
        detailType:
          $ref: '#/components/schemas/CoaAccountExplanationPart'
        reportSection:
          $ref: '#/components/schemas/CoaAccountExplanationPart'
        classification:
          oneOf:
          - $ref: '#/components/schemas/CoaAccountExplanationPart'
          - type: 'null'
    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
    GlAccountsListResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/GlAccount'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    FxAccountingRolesResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/FxAccountingRoleAuthority'
    GlAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type: string
          format: uuid
        code:
          type: string
          example: '1000'
        name:
          type: string
          example: Cash
        type:
          type: string
          enum:
          - Asset
          - Liability
          - Equity
          - Revenue
          - Expense
        subtype:
          type:
          - string
          - 'null'
        parentAccountId:
          type:
          - string
          - 'null'
          format: uuid
        normalBalance:
          type: string
          enum:
          - debit
          - credit
        detailTypeKey:
          type: string
          description: Canonical COA detail type used for report grouping.
        detailTypeLabel:
          type: string
        detailTypeDescription:
          type: string
        reportSectionKey:
          type: string
        reportSectionLabel:
          type: string
        accountExplanation:
          $ref: '#/components/schemas/CoaAccountExplanation'
        cashFlowSection:
          type:
          - string
          - 'null'
          enum:
          - operating
          - investing
          - financing
          - cash
          - non_cash
          - null
        taxFormSectionKey:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        source:
          type: string
          enum:
          - system
          - template
          - integration
          - migration
          - manual
          - repair
        isSystem:
          type: boolean
        isLocked:
          type: boolean
          description: Locked accounts cannot be selected for new direct posting.
        isPostable:
          type: boolean
          description: False for parent, locked, inactive, or otherwise non-postable accounts.
        isParent:
          type: boolean
          description: True when at least one active child account references this account.
        isActive:
          type: boolean
        isMonetary:
          type:
          - boolean
          - 'null'
          description: Null is fail-closed and blocks foreign-balance revaluation.
        monetaryClassificationSource:
          type:
          - string
          - 'null'
          enum:
          - account_type_subtype
          - manual
          - null
        monetaryClassifiedAt:
          type:
          - string
          - 'null'
          format: date-time
        monetaryClassifiedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        deactivatedAt:
          type:
          - string
          - 'null'
          format: date-time
        deactivatedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        deactivationReason:
          type:
          - string
          - 'null'
        expectedNormalBalance:
          type: string
          enum:
          - debit
          - credit
        healthFindings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              severity:
                type: string
                enum:
                - critical
                - high
                - medium
                - low
              message:
                type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    UpdateGlAccountInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        subtype:
          type:
          - string
          - 'null'
          maxLength: 100
        parentAccountId:
          type:
          - string
          - 'null'
          format: uuid
        isActive:
          type: boolean
        detailTypeKey:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 100
        reportSectionKey:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 100
        description:
          type:
          - string
          - 'null'
          maxLength: 1000
        isLocked:
          type: boolean
        isPostable:
          type: boolean
    FxAccountingRoleResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/FxAccountingRoleAuthority'
    CoaAccountExplanationPart:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        description:
          type: string
    GlAccountResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/GlAccount'
  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'
  parameters:
    customerId:
      name: customerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    resourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    qaAppSurface:
      name: X-Median-App-Surface
      in: header
      required: true
      description: 'Customer-app QA bundle marker. This is necessary but not sufficient; the server also requires a JWT-authenticated member, an allowlisted company id, and persisted client_status=test.

        '
      schema:
        type: string
        const: qa
    fxAccountingRole:
      name: role
      in: path
      required: true
      schema:
        type: string
        enum:
        - TRANSFER_CLEARING
        - REALIZED_FX_GAIN_LOSS
        - UNREALIZED_FX_GAIN_LOSS
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    cursor:
      name: cursor
      in: query
      schema:
        type: string
  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