Akeda Finance requisites API

openapi: 3.2.0
info:
  title: Akeda ERP Client Finance requisites API
  version: 0.21.0-core-public
  summary: Проверяемый публичный контракт Go API Akeda ERP
  license:
    name: Proprietary
    identifier: LicenseRef-Akeda-Proprietary
  description: 'Этот контракт описывает API Akeda ERP. Полный исходный файл используют

    проверки живых Go-маршрутов, внутренние клиенты и реестр MCP. Скачиваемый

    клиентский контракт в `/docs` содержит только отобранные внешние методы;

    административные методы кабинета показаны отдельно после входа, а

    платформенные операторские методы остаются во внутреннем источнике.

    Стадия `public` означает обещание совместимости; `preview` допускает

    изменение формы. Аудитория, стадия и `security` — разные признаки:

    наличие метода в полном файле само по себе не выдаёт вызывающему право.

    Сервер отдельно проверяет тип токена, кабинет, scope и права на запись.

    Актуальные числа покрытия берите из генерируемой карты маршрутов и

    каталога покрытия, а не из описательного текста.'
servers:
- url: https://erp.akeda.ru
  description: PROD
security:
- erpUserToken: []
- tenantApiKey: []
- mcpOAuth:
  - akeda:delegate
tags:
- name: Finance requisites
  description: Модуль finance (счета и выписки) — проверка владельца, БИК и номера счёта
paths:
  /api/v1/finance/lookup/company:
    get:
      tags:
      - Finance requisites
      operationId: financeLookupCompany
      summary: Сопоставить владельца счёта с юрлицом по ИНН
      description: Ничего не создаёт; возвращает найденное юрлицо либо заготовку для формы создания.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: finance.lookup:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: inn
        in: query
        required: true
        schema:
          type: string
          minLength: 10
          maxLength: 12
      responses:
        '200':
          description: Результат сопоставления
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceCompanyMatch'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /api/v1/finance/lookup/requisites:
    get:
      tags:
      - Finance requisites
      operationId: financeLookupRequisites
      summary: Проверить ИНН, БИК и номер счёта
      description: Внешний справочник обогащает организацию и банк, а контроль номера по БИК выполняется локально и доступен даже без внешнего ключа.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: finance.lookup:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: inn
        in: query
        schema:
          type: string
      - name: bic
        in: query
        schema:
          type: string
          minLength: 9
          maxLength: 9
      - name: number
        in: query
        schema:
          type: string
          minLength: 20
          maxLength: 20
      responses:
        '200':
          description: Обогащённые реквизиты и предупреждения
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceRequisitesLookup'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: Внешний справочник временно недоступен
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/core/lookup/parties:
    get:
      tags:
      - Finance requisites
      operationId: coreSuggestRequisitesParties
      summary: Найти организации по части ИНН, ОГРН или названия
      description: Возвращает варианты для выпадающего списка карточки юрлица; ничего не создаёт и допускает ручное заполнение, если внешний справочник не настроен.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 3
      responses:
        '200':
          description: Подходящие организации и признак настройки справочника
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceRequisitesSuggestions'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: Внешний справочник временно недоступен
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/core/lookup/bank:
    get:
      tags:
      - Finance requisites
      operationId: coreLookupBank
      summary: Найти банк по БИК
      description: Название банка и корреспондентский счёт по девяти цифрам БИК для карточек контрагента и юрлица. Справочник не настроен или банк не найден — bank=null без ошибки.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: bic
        in: query
        required: true
        schema:
          type: string
          pattern: ^\d{9}$
      responses:
        '200':
          description: Банк и признак настройки справочника
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceBankLookup'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: Внешний справочник временно недоступен
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/core/lookup/banks:
    get:
      tags:
      - Finance requisites
      operationId: coreSuggestBanks
      summary: Подсказать банки по части БИК или названия
      description: Выпадающий список поля БИК. Выбор банка ставит БИК, название и корреспондентский счёт; короче трёх знаков — пустой список без запроса к справочнику.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 3
      responses:
        '200':
          description: Подходящие банки и признак настройки справочника
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceBankSuggestions'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: Внешний справочник временно недоступен
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    BadRequest:
      description: Некорректный запрос или нарушение бизнес-правила
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Сессия, ключ или кабинет не подтверждены
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Текущая роль не имеет требуемого права
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: Внешний банк, справочник или контур подключений временно недоступен
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    FinanceRequisitesParty:
      type: object
      additionalProperties: false
      required:
      - name
      - full_name
      - entity_type
      - inn
      - kpp
      - ogrn
      - okpo
      - address
      - address_parts
      - entrepreneur
      - status
      properties:
        name:
          type: string
        full_name:
          type: string
        entity_type:
          type: string
          enum:
          - LEGAL
          - INDIVIDUAL
          - ''
        inn:
          type: string
        kpp:
          type: string
        ogrn:
          type: string
        ogrn_date:
          type: string
          format: date
          description: Дата присвоения ОГРН (у ИП — ОГРНИП) по реестру
        okpo:
          type: string
        address:
          type: string
        address_parts:
          $ref: '#/components/schemas/FinanceRequisitesAddress'
        entrepreneur:
          $ref: '#/components/schemas/FinanceRequisitesPerson'
        status:
          type: string
    FinanceRequisitesPerson:
      type: object
      additionalProperties: false
      required:
      - surname
      - name
      - patronymic
      properties:
        surname:
          type: string
        name:
          type: string
        patronymic:
          type: string
    FinanceRequisitesSuggestions:
      type: object
      required:
      - suggestions
      - directory_configured
      properties:
        suggestions:
          type: array
          items:
            $ref: '#/components/schemas/FinanceRequisitesParty'
        directory_configured:
          type: boolean
    FinanceRequisitesBank:
      type: object
      additionalProperties: false
      required:
      - name
      - bic
      - correspondent_account
      - city
      - inn
      - kpp
      properties:
        name:
          type: string
        bic:
          type: string
        correspondent_account:
          type: string
        city:
          type: string
        inn:
          type: string
          description: ИНН банка; пусто — справочник не назвал
        kpp:
          type: string
          description: КПП банка; пусто — справочник не назвал
    FinanceCompanyMatch:
      type: object
      additionalProperties: false
      required:
      - status
      - inn
      - company
      - owner_name
      - suggestion
      - message
      properties:
        status:
          type: string
          enum:
          - linked
          - not_found
          - no_inn
        inn:
          type: string
        company:
          oneOf:
          - $ref: '#/components/schemas/FinanceDirectoryCompany'
          - type: 'null'
        owner_name:
          type: string
        suggestion:
          oneOf:
          - $ref: '#/components/schemas/FinanceCompanySuggestion'
          - type: 'null'
        message:
          type: string
    FinanceBankSuggestions:
      type: object
      additionalProperties: false
      required:
      - directory_configured
      - banks
      properties:
        directory_configured:
          type: boolean
        banks:
          type: array
          items:
            $ref: '#/components/schemas/FinanceRequisitesBank'
    FinanceRequisitesLookup:
      type: object
      additionalProperties: false
      required:
      - organization
      - bank
      - number_valid
      - warnings
      - directory_configured
      properties:
        organization:
          oneOf:
          - $ref: '#/components/schemas/FinanceRequisitesParty'
          - type: 'null'
        bank:
          oneOf:
          - $ref: '#/components/schemas/FinanceRequisitesBank'
          - type: 'null'
        number_valid:
          type:
          - boolean
          - 'null'
        warnings:
          type:
          - array
          - 'null'
          items:
            type: string
        directory_configured:
          type: boolean
    FinanceDirectoryCompany:
      type: object
      additionalProperties: false
      required:
      - id
      - name
      - legal_name
      - inn
      - kpp
      - is_active
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        name:
          type: string
        legal_name:
          type: string
        inn:
          type: string
        kpp:
          type: string
        is_active:
          type: boolean
    FinanceCompanySuggestion:
      type: object
      additionalProperties: false
      required:
      - name
      - legal_name
      - inn
      - kpp
      - address
      properties:
        name:
          type: string
        legal_name:
          type: string
        inn:
          type: string
        kpp:
          type: string
        address:
          type: string
    Error:
      type: object
      additionalProperties: false
      required:
      - detail
      properties:
        detail:
          type: string
          description: One human sentence in the request language (Accept-Language, echoed as Content-Language)
        code:
          type: string
          description: Stable module error code when the endpoint defines one
        field:
          type: string
          description: Request body path of the field the refusal is about, e.g. content.commercial.amount or due_date; present when the endpoint names the field
        reason:
          type: string
          description: Machine code of the field refusal reason, e.g. required, format, total_mismatch; present together with field when the endpoint defines reasons
        request_id:
          type: string
          format: uuid
          description: Case id. Always present on 5xx and on any error produced by the server itself; the same value is returned in the X-Request-ID header and recorded in the access log and the incident. Quote it to support instead of the cause, which the response never carries.
    FinanceBankLookup:
      type: object
      additionalProperties: false
      required:
      - directory_configured
      - bank
      properties:
        directory_configured:
          type: boolean
        bank:
          oneOf:
          - $ref: '#/components/schemas/FinanceRequisitesBank'
          - type: 'null'
    FinanceRequisitesAddress:
      type: object
      additionalProperties: false
      required:
      - postal_code
      - region_code
      - region_name
      - district
      - city
      - settlement
      - street
      - building
      - block
      - flat
      properties:
        postal_code:
          type: string
        region_code:
          type: string
        region_name:
          type: string
        district:
          type: string
        city:
          type: string
        settlement:
          type: string
        street:
          type: string
        building:
          type: string
        block:
          type: string
        flat:
          type: string
    UUID:
      type: string
      format: uuid
  parameters:
    TenantHeader:
      name: X-Tenant
      in: header
      required: true
      description: Slug выбранного кабинета; кабинет не является юрлицом
      schema:
        type: string
        minLength: 1
  securitySchemes:
    erpUserToken:
      type: http
      scheme: bearer
      bearerFormat: go_session
      description: Пользовательский ERP token, полученный через ORY Kratos session bridge
    tenantApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Tenant-scoped сервисный API-ключ Akeda
    installationToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_installation_token
      description: 'Краткосрочный токен установки приложения (`ai_…`). Выдаёт его человек: публичной двери обмена учётных данных на токен нет и не будет, пока нет брокера долгой половины секрета, асимметричного подтверждения и ограничителя с аудитом неудачных попыток. Токен принимается и в заголовке X-Api-Key, и живёт минуты — вместо показа его ротируют'
    developerSessionToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_session
      description: 'Сессия аккаунта разработчика (`ad_…`). Своя схема, а не пользовательский токен ERP: у разработчика нет кабинета, роли и прав, а хеш этого токена лежит в отдельном хранилище — на кабинетных маршрутах он не находится ничем. Выдаёт его обмен одноразовой ссылки из письма; пароля в этом контуре нет вовсе'
    developerAppKey:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_app_key
      description: 'Учётные данные приложения (`adk_…`) — это машина конвейера издателя, а не человек. Ключ привязан к ОДНОМУ приложению внешним ключом, и достижимая им поверхность — маршруты `/api/v1/developer` этого приложения. Обменять его на токен установки нельзя: такой двери нет, и ни одного маршрута к данным кабинета за ним не существует. Выпуск, ротацию и отзыв учётных данных этот ключ не выполняет: ключ, умеющий выпустить следующий ключ, не отзывается никогда. Значение показывается один раз, при выдаче; в хранилище лежит хеш'
    mcpOAuth:
      type: oauth2
      description: OAuth 2.1 delegation для MCP; кабинетные права проверяются на каждом вызове
      flows:
        authorizationCode:
          authorizationUrl: https://erp.akeda.ru/oauth2/authorize
          tokenUrl: https://erp.akeda.ru/oauth2/token
          scopes:
            akeda:delegate: Делегировать текущие пользовательские права MCP-подключению
x-akeda-contract-coverage:
- dashboard-metrics
- tasks-lifecycle
- tasks-collaboration
- tasks-workflow
- tasks-organization
- tasks-automation
- tasks-planning
- tasks-project-hub
- tasks-files
- calendar-events
- calendar-availability
- calendar-booking
- calendar-notifications
- calendar-connectors
- chat-conversations
- chat-messages
- chat-receipts
- chat-mentions
- chat-realtime
- core-directories
- core-folders
- core-contacts
- core-products
- core-documents
- core-orders
- core-registers
- core-accounting
- core-ledger
- core-items
- core-employees
- core-employee-operations
- core-currency-rates
- core-preferences
- core-ui-state
- core-external-refs
- core-product-imports
- core-product-exports
- core-gl-opening-imports
- core-reference
- core-change-feed
- finance-accounts
- finance-statements
- finance-transactions
- finance-connectors
- finance-connector-sync
- finance-requisites
- finance-counterparty-terms
- finance-operations
- finance-settlements
- finance-trade
- finance-exchange
- finance-imports
- finance-payment-calendar
- finance-pnl-layouts
- finance-registers
- finance-reports
- crm-pipelines
- crm-deals
- crm-leads
- crm-customers
- crm-links
- crm-inbox
- crm-automation
- crm-analytics
- knowledge-spaces
- knowledge-pages
- knowledge-access
- knowledge-files
- knowledge-search
- files-drives
- files-content
- files-access
- files-uploads
- files-shares
- stock-documents
- stock-inventory
- stock-warehouses
- stock-handling-units
- stock-batches
- stock-product-units
- stock-references
- stock-imports
- stock-exports
- stock-reports
- stock-valuation
- stock-reorder-rules
- stock-settings
- stock-purchasing
- marking-settings
- marking-connections
- marking-products
- marking-codes
- marking-labels
- marking-stock-codes
- marking-orders
- marking-gismt-documents
- marking-boxes
- marketplace-stores
- marketplace-ozon
- marketplace-wildberries
- marketplace-yandex
- marketplace-product-groups
- marketplace-accounting
- marketplace-catalog
- settings-companies
- settings-roles
- settings-members
- settings-fields
- settings-api-keys
- finance-payroll
- finance-report-details
- knowledge-tags
- knowledge-revisions
- knowledge-approval
- chat-attachments
- chat-reactions
- chat-folders
- platform-apps
- platform-app-installations
- platform-app-tokens
- platform-app-deliveries
- platform-app-publishers
- platform-app-publication
- platform-app-rollouts
- platform-app-runtime
- platform-app-access
- platform-app-blocks
- platform-demo-data
- billing-usage
- platform-analytics
- finance-staffing
- platform-tenants
- platform-users
- platform-access
- platform-mcp-publication
- platform-incidents
- platform-health
- settings-apps
- docflow-connections
- docflow-mirror
- docflow-signing
- docflow-actions
- docflow-outgoing
- docflow-intake
- docflow-flow
- docflow-approvals
- docflow-flow-accounting
- mail-accounts
- mail-folders
- mail-messages
- mail-rules
- mail-outbound
- mail-attachments
- billing-plans
- billing-subscriptions
- billing-invoices
- billing-analytics
- settings-subscription
- billing-payments
- billing-public
x-akeda-docs-path: /docs
x-akeda-default-release-stage: internal
x-akeda-default-audience: operator