Akeda CRM pipelines API

openapi: 3.2.0
info:
  title: Akeda ERP Client CRM pipelines 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: CRM pipelines
  description: Модуль crm — воронки, стадии, нормативы SLA и порядок этапов
paths:
  /api/v1/crm/pipelines:
    get:
      tags:
      - CRM pipelines
      operationId: crmListPipelines
      summary: Получить воронки со стадиями
      description: Возвращает воронки CRM вместе с их стадиями.
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      responses:
        '200':
          description: Воронки кабинета в порядке сортировки
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CRMPipeline'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - CRM pipelines
      operationId: crmCreatePipeline
      summary: Создать воронку
      description: Создаёт воронку CRM.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMPipelineInput'
      responses:
        '201':
          description: Созданная воронка
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRMPipeline'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/crm/pipelines/reorder:
    patch:
      tags:
      - CRM pipelines
      operationId: crmReorderPipelines
      summary: Изменить порядок воронок
      description: Передаётся полный порядок без повторов; частичный список отклоняется.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMReorderInput'
      responses:
        '204':
          description: Порядок сохранён
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/crm/pipelines/{id}:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - $ref: '#/components/parameters/ResourceID'
    get:
      tags:
      - CRM pipelines
      operationId: crmGetPipeline
      summary: Получить воронку
      description: Возвращает указанную воронку CRM.
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:read
      responses:
        '200':
          description: Воронка со стадиями
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRMPipeline'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - CRM pipelines
      operationId: crmUpdatePipeline
      summary: Изменить воронку
      description: Изменяет указанную воронку CRM.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMPipelinePatch'
      responses:
        '200':
          description: Обновлённая воронка
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRMPipeline'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - CRM pipelines
      operationId: crmDeletePipeline
      summary: Удалить воронку
      description: 'Удаляет воронку вместе с её этапами; архива воронок нет, как в Битрикс24. Нельзя удалить основную воронку, «Общую» воронку (есть в кабинете всегда) и воронку, в которой есть сделки, в том числе архивные (409 crm.pipeline_default, crm.pipeline_system, crm.pipeline_has_deals): сначала сделки переносят в другую воронку или удаляют. Шаги истории внутри воронки удаляются, переезд сделки из неё в другую воронку остаётся входом в новую.'
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      responses:
        '204':
          description: Воронка удалена
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
  /api/v1/crm/pipelines/{id}/stages:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - $ref: '#/components/parameters/ResourceID'
    post:
      tags:
      - CRM pipelines
      operationId: crmCreateStage
      summary: Добавить стадию в воронку
      description: Добавляет стадию в указанную воронку CRM.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMStageInput'
      responses:
        '201':
          description: Созданная стадия
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRMStage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/crm/pipelines/{id}/stages/reorder:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - $ref: '#/components/parameters/ResourceID'
    patch:
      tags:
      - CRM pipelines
      operationId: crmReorderStages
      summary: Изменить порядок стадий воронки
      description: Изменяет порядок стадий указанной воронки CRM.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMReorderInput'
      responses:
        '204':
          description: Порядок стадий сохранён
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/crm/stages/{id}:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - $ref: '#/components/parameters/ResourceID'
    patch:
      tags:
      - CRM pipelines
      operationId: crmUpdateStage
      summary: Изменить стадию
      description: Изменяет указанную стадию воронки CRM.
      security:
      - erpUserToken: []
      - mcpOAuth:
        - akeda:delegate
      x-akeda-module: crm
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: crm:admin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CRMStagePatch'
      responses:
        '200':
          description: Обновлённая стадия
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CRMStage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: Текущая роль не имеет требуемого права
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Некорректный запрос или нарушение бизнес-правила
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Сессия, ключ или кабинет не подтверждены
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Конфликт версии, идемпотентности или бизнес-состояния
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Запись не найдена или не видима текущему пользователю
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    CRMPipelineInput:
      type: object
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          minLength: 1
        is_default:
          type: boolean
          default: false
        business_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Бизнес воронки. Пусто — единственный бизнес области доступа или весь кабинет (его заводит только доступ ко всем бизнесам). Бизнес вне области доступа — 403 crm.pipeline_business_forbidden
        auto_order_on_win:
          type: boolean
          default: false
          description: «Создавать заказ при выигрыше»
    CRMStage:
      type: object
      additionalProperties: false
      required:
      - id
      - pipeline_id
      - name
      - sort_order
      - category
      - color
      - probability
      - sla_hours
      - required_fields
      - is_active
      - created_at
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        pipeline_id:
          $ref: '#/components/schemas/UUID'
        name:
          type: string
        label_key:
          $ref: '#/components/schemas/CRMLabelKey'
        sort_order:
          type: integer
          minimum: 0
        category:
          $ref: '#/components/schemas/CRMStageCategory'
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        probability:
          type: integer
          minimum: 0
          maximum: 100
        sla_hours:
          type: integer
          minimum: 0
          description: Норматив пребывания на стадии в часах; 0 - без норматива
        required_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CRMRequiredField'
        is_active:
          type: boolean
        show_on_board:
          $ref: '#/components/schemas/CRMStageShowOnBoard'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CRMStageCategory:
      type: string
      enum:
      - open
      - won
      - lost
      description: Категория стадии; won и lost закрывают сделку
    CRMPipelinePatch:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
        is_default:
          type: boolean
        business_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Бизнес воронки; поле не передано — не менять, null — весь кабинет. Бизнес вне области доступа — 403 crm.pipeline_business_forbidden
        auto_order_on_win:
          type: boolean
          description: «Создавать заказ при выигрыше»; поле не передано — не менять
    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.
    CRMRequiredField:
      type: string
      pattern: ^(title|amount|currency|probability|expected_close_at|custom\.\S{1,200})$
      description: 'Поле, обязательное на этапе: встроенное поле сделки (title, amount, currency, probability, expected_close_at) или дополнительное поле сделки в виде custom.<ключ поля> из «Настройки → Поля». Дополнительное поле должно быть действующим полем сделки; сделку без значения не пустят на этап с кодом crm.stage_fields_required'
    CRMStagePatch:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
        category:
          $ref: '#/components/schemas/CRMStageCategory'
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
        probability:
          type: integer
          minimum: 0
          maximum: 100
        sla_hours:
          type: integer
          minimum: 0
        required_fields:
          type: array
          items:
            $ref: '#/components/schemas/CRMRequiredField'
        is_active:
          type: boolean
        show_on_board:
          $ref: '#/components/schemas/CRMStageShowOnBoard'
    UUID:
      type: string
      format: uuid
    CRMReorderInput:
      type: object
      additionalProperties: false
      required:
      - ids
      description: Полный порядок без повторов; частичный список отклоняется
      properties:
        ids:
          type: array
          items:
            $ref: '#/components/schemas/UUID'
    CRMStageShowOnBoard:
      type: boolean
      description: Показывать ли этап проигрыша (category lost) колонкой на доске сделок. Решает кабинет, по умолчанию нет; для открытых и выигрышных этапов признак ничего не меняет - они на доске всегда
    CRMStageInput:
      type: object
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          minLength: 1
        category:
          $ref: '#/components/schemas/CRMStageCategory'
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: Пустое значение подставляет цвет категории
        probability:
          type: integer
          minimum: 0
          maximum: 100
        sla_hours:
          type: integer
          minimum: 0
        required_fields:
          type: array
          items:
            $ref: '#/components/schemas/CRMRequiredField'
        show_on_board:
          $ref: '#/components/schemas/CRMStageShowOnBoard'
    CRMLabelKey:
      type: string
      description: 'Ключ подписи строки, которую завёл стартовый посев или готовый набор CRM (например crm.lead_stage.unsorted, crm.set.pipeline.patients, crm.source.manual): экран переводит подпись по ключу, а name остаётся прежним представлением. Пусто - кабинет назвал строку сам, показывается name как есть'
    CRMPipeline:
      type: object
      additionalProperties: false
      required:
      - id
      - name
      - sort_order
      - is_default
      - is_active
      - is_system
      - business_id
      - auto_order_on_win
      - created_at
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        name:
          type: string
        label_key:
          $ref: '#/components/schemas/CRMLabelKey'
        sort_order:
          type: integer
          minimum: 0
        is_default:
          type: boolean
        is_active:
          type: boolean
        is_system:
          type: boolean
          description: '«Общая» воронка, как в Битрикс24: есть в кабинете всегда, удалить её нельзя (409 crm.pipeline_system), даже если основной сделали другую. Название и стадии меняют как у любой воронки'
        business_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: 'Бизнес воронки: её сделки, лиды, ставшие такими сделками, и привязанные диалоги видят участники, чья область доступа касается бизнеса, и ответственные. null — воронка всего кабинета'
        auto_order_on_win:
          type: boolean
          description: '«Создавать заказ при выигрыше»: сделка воронки на выигранном этапе сама заводит черновик заказа в «Продажах». Работает только при подключённом «Документообороте»'
        stages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CRMStage'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  parameters:
    ResourceID:
      name: id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/UUID'
    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