Akeda Core ledger API

openapi: 3.2.0
info:
  title: Akeda ERP Client Core ledger 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: Core ledger
  description: Модуль core (справочники) — план счетов, схема проводок и оборотно-сальдовая ведомость
paths:
  /api/v1/core/gl-accounts:
    get:
      tags:
      - Core ledger
      operationId: coreListGLAccounts
      summary: Получить план счетов главной книги
      description: Возвращает план счетов главной книги.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: include_inactive
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: План счетов
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreGLAccountPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Core ledger
      operationId: coreCreateGLAccount
      summary: Создать клиентский счёт поверх системного плана
      description: Создаёт клиентский счёт в дополнение к системному плану счетов.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoreGLAccountCreate'
      responses:
        '201':
          description: Созданный счёт
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreGLAccount'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/core/gl-accounts/{id}:
    parameters:
    - $ref: '#/components/parameters/TenantHeader'
    - name: id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/UUID'
    patch:
      tags:
      - Core ledger
      operationId: coreUpdateGLAccount
      summary: Изменить название, родителя, активность или участие в ДДС
      description: Код, тип и участие в ОПиУ неизменяемы, потому что задают смысл истории.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoreGLAccountPatch'
      responses:
        '200':
          description: Обновлённый счёт
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreGLAccount'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Core ledger
      operationId: coreDeleteGLAccount
      summary: Удалить пустой клиентский счёт
      description: Системный, используемый или связанный правилом счёт не удаляется; его можно отключить.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      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/core/gl-mappings:
    get:
      tags:
      - Core ledger
      operationId: coreListGLMappings
      summary: Получить правила схемы проводок
      description: Возвращает правила схемы проводок главной книги.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: subject_type
        in: query
        schema:
          type: string
      - name: include_closed
        in: query
        schema:
          type: boolean
          default: false
      - name: limit
        in: query
        description: Размер страницы; не задан — все правила. Запрос сверх потолка 500 зажимается до него
        schema:
          type: integer
          minimum: 1
          maximum: 500
      - name: offset
        in: query
        description: Сколько правил пропустить; учитывается вместе с limit
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: Правила проводок
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreGLMappingPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Core ledger
      operationId: coreCreateGLMapping
      summary: Установить версионированное правило проводки
      description: Новое правило закрывает предыдущее с даты valid_from; пустой subject_id создаёт правило по умолчанию.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoreGLMappingCreate'
      responses:
        '201':
          description: Созданное правило
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreGLMapping'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/core/gl-mappings/{id}:
    delete:
      tags:
      - Core ledger
      operationId: coreDeleteGLMapping
      summary: Закрыть правило проводки на выбранную дату
      description: Закрывает правило проводки с выбранной даты.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.accounting:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      - name: 'on'
        in: query
        schema:
          type: string
          format: date
      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/core/ledger/trial-balance:
    get:
      tags:
      - Core ledger
      operationId: coreGetTrialBalance
      summary: Получить оборотно-сальдовую ведомость и проверку баланса
      description: Возвращает оборотно-сальдовую ведомость и результат проверки баланса.
      x-akeda-module: core
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: core.trial_balance:read
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - $ref: '#/components/parameters/BusinessQuery'
      - name: date_from
        in: query
        schema:
          type: string
          format: date
      - name: date_to
        in: query
        schema:
          type: string
          format: date
      - name: company
        in: query
        description: Юрлицо (UUID) или none — только проводки без юрлица
        schema:
          type: string
      - name: include_empty
        in: query
        schema:
          type: boolean
          default: false
      - name: group
        in: query
        description: contact — строка на пару «счёт и контрагент» (только счета, где есть проводки с контрагентом; без контрагента — строка без contact_id); без параметра — строка на счёт.
        schema:
          type: string
          enum:
          - contact
      responses:
        '200':
          description: ОСВ с итогами и balanced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreTrialBalance'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
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:
    CoreGLMapping:
      type: object
      additionalProperties: false
      required:
      - id
      - subject_type
      - account_id
      - account_code
      - account_name
      - valid_from
      - is_system
      - comment
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        subject_type:
          type: string
          enum:
          - item
          - money_account
          - contact
          - product
          - document_type
          - acquiring_clearing
          - warehouse
        subject_id:
          $ref: '#/components/schemas/UUID'
        account_id:
          $ref: '#/components/schemas/UUID'
        account_code:
          type: string
        account_name:
          type: string
        valid_from:
          type: string
          format: date
        valid_to:
          type: string
          format: date
        is_system:
          type: boolean
        comment:
          type: string
    CoreTrialBalance:
      type: object
      additionalProperties: false
      required:
      - date_from
      - date_to
      - currency
      - rows
      - totals
      properties:
        date_from:
          type: string
        date_to:
          type: string
        currency:
          type: string
          pattern: ^[A-Z]{3}$
        rows:
          type: array
          items:
            $ref: '#/components/schemas/CoreTrialBalanceRow'
        totals:
          $ref: '#/components/schemas/CoreTrialBalanceTotals'
        accounting_basis:
          $ref: '#/components/schemas/AccountingBasis'
        unassigned_company:
          description: При отборе по юрлицу — итоги проводок без юрлица за тот же период; только при доступе ко всей книге
          allOf:
          - $ref: '#/components/schemas/CoreTrialBalanceTotals'
    CoreGLAccount:
      type: object
      additionalProperties: false
      required:
      - id
      - code
      - name
      - type
      - is_active
      - is_system
      - affects_pnl
      - opening_input
      - affects_cashflow
      - created_at
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        code:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,19}$
        name:
          type: string
        type:
          $ref: '#/components/schemas/CoreGLAccountType'
        parent_id:
          $ref: '#/components/schemas/UUID'
        is_active:
          type: boolean
        is_system:
          type: boolean
        affects_pnl:
          type: boolean
        opening_input:
          type: string
          enum:
          - free
          - contact
          - employee
          - stock
          - money
        affects_cashflow:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CoreTrialBalanceTotals:
      type: object
      additionalProperties: false
      required:
      - opening_debit
      - opening_credit
      - turnover_debit
      - turnover_credit
      - closing_debit
      - closing_credit
      - balanced
      properties:
        opening_debit:
          type: string
        opening_credit:
          type: string
        turnover_debit:
          type: string
        turnover_credit:
          type: string
        closing_debit:
          type: string
        closing_credit:
          type: string
        balanced:
          type: boolean
    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.
    CoreGLAccountType:
      type: string
      enum:
      - asset
      - liability
      - equity
      - income
      - expense
    CoreGLAccountPatch:
      type: object
      additionalProperties: false
      minProperties: 1
      properties:
        name:
          type: string
          minLength: 1
        parent_id:
          $ref: '#/components/schemas/UUID'
        is_active:
          type: boolean
        affects_cashflow:
          type: boolean
    CoreTrialBalanceRow:
      type: object
      additionalProperties: false
      required:
      - account_id
      - code
      - name
      - type
      - opening_debit
      - opening_credit
      - turnover_debit
      - turnover_credit
      - closing_debit
      - closing_credit
      - entry_count
      properties:
        account_id:
          $ref: '#/components/schemas/UUID'
        code:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/CoreGLAccountType'
        opening_debit:
          type: string
        opening_credit:
          type: string
        turnover_debit:
          type: string
        turnover_credit:
          type: string
        closing_debit:
          type: string
        closing_credit:
          type: string
        entry_count:
          type: integer
          format: int64
          minimum: 0
        contact_id:
          $ref: '#/components/schemas/UUID'
        employee_id:
          $ref: '#/components/schemas/UUID'
    AccountingBasis:
      type: string
      enum:
      - cash
      - accrual
      - mixed
      description: 'Основание, на котором сведён отчёт: метод учёта бизнесов его разреза. cash — выручку признают деньги, accrual — выручку создаёт сделка, mixed — в разрез попали оба основания (разные бизнесы либо период, пересекающий дату перехода). Поля нет, когда подписывать нечем: бизнесов в разрезе не нашлось. Кассовые ОПиУ и баланс правдивы, но отвечают не на тот вопрос, что отчёты по начислению, и обязаны быть отличимы по подписи, а не по догадке читателя.'
    CoreGLMappingCreate:
      type: object
      additionalProperties: false
      required:
      - subject_type
      - account_id
      properties:
        subject_type:
          type: string
          enum:
          - item
          - money_account
          - contact
          - product
          - document_type
          - acquiring_clearing
          - warehouse
        subject_id:
          $ref: '#/components/schemas/UUID'
        account_id:
          $ref: '#/components/schemas/UUID'
        valid_from:
          type: string
          format: date
          description: Omitted means today
        comment:
          type: string
    UUID:
      type: string
      format: uuid
    CoreGLAccountPage:
      type: object
      additionalProperties: false
      required:
      - count
      - results
      properties:
        count:
          type: integer
          minimum: 0
        results:
          type: array
          items:
            $ref: '#/components/schemas/CoreGLAccount'
    CoreGLAccountCreate:
      type: object
      additionalProperties: false
      required:
      - code
      - name
      - type
      properties:
        code:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,19}$
        name:
          type: string
          minLength: 1
        type:
          $ref: '#/components/schemas/CoreGLAccountType'
        parent_id:
          $ref: '#/components/schemas/UUID'
        affects_pnl:
          type: boolean
          description: Ignored; server derives it from type
        affects_cashflow:
          type: boolean
          default: false
    CoreGLMappingPage:
      type: object
      additionalProperties: false
      required:
      - count
      - results
      properties:
        count:
          type: integer
          minimum: 0
        total:
          type: integer
          minimum: 0
          description: Сколько правил под отбором всего, до среза limit/offset
        results:
          type: array
          items:
            $ref: '#/components/schemas/CoreGLMapping'
  parameters:
    BusinessQuery:
      name: business
      in: query
      required: false
      description: UUID управленческого бизнеса; без параметра — консолидация «Весь бизнес»
      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