Akeda Finance trade API

openapi: 3.2.0
info:
  title: Akeda ERP Client Finance trade 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 trade
  description: Модуль finance (счета и выписки) — журнал продаж и закупок, свободные авансы
paths:
  /api/v1/finance/trade-journal:
    get:
      tags:
      - Finance trade
      operationId: financeGetTradeJournal
      summary: Получить журнал продаж или закупок
      description: 'С этапа 2 эпика ERP-1427 строки журнала — продажи или закупки ядра (customer_order у продаж, supplier_order у закупок) с колонками «заказано · исполнено · оплачено · аванс · долг»; по умолчанию — подтверждённые продажи или закупки и дальше, черновики и отменённые — отбором status. У бизнеса, прошедшего отсечку расчётов по продажам или закупкам (этап 3), аванс и долг — остатки регистра расчётов по продаже или закупке (money_from_register у строки); до отсечки они вычисляются из «исполнено» и «оплачено» (computed_columns есть, пока в ответе есть такие строки). Документы без продажи или закупки отдаёт group=without_order («Поступления без продажи или закупки»). Это ломающее изменение preview-контракта: прежняя строка-документ осталась только в группе without_order.'
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: finance.reports.trade:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - $ref: '#/components/parameters/BusinessQuery'
      - name: direction
        in: query
        required: true
        schema:
          type: string
          enum:
          - sales
          - purchases
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          default: 500
          maximum: 500
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      - name: q
        in: query
        schema:
          type: string
      - name: company_id
        in: query
        schema:
          type: string
          format: uuid
      - name: date_from
        in: query
        schema:
          type: string
          format: date
      - name: date_to
        in: query
        schema:
          type: string
          format: date
      - name: status
        in: query
        schema:
          type: string
          enum:
          - draft
          - posted
          - cancelled
      - name: view
        in: query
        schema:
          type: string
          enum:
          - all
          - control
          - due
          default: all
      - name: settlement_state
        in: query
        schema:
          type: string
          enum:
          - all
          - unaccrued
          - open
          - overdue
          - advance
      - name: currency
        in: query
        schema:
          type: string
          minLength: 3
          maxLength: 3
      - name: record_id
        in: query
        description: Точная строка; у продажи или закупки раскрывается всегда
        schema:
          type: string
          format: uuid
      - name: group
        in: query
        description: orders — строки-продажи или закупки; without_order — документы без продажи или закупки; executions — все документы исполнения («Реализации» / «Поступления») со ссылкой на продажу или закупку order_id, order_number
        schema:
          type: string
          enum:
          - orders
          - without_order
          - executions
          default: orders
      - name: expand
        in: query
        description: Раскрыть строки страницы — исполнения и оплаты продажи или закупки
        schema:
          type: boolean
          default: false
      - name: responsible_id
        in: query
        description: Продажи или закупки, где сотрудник ответственный
        schema:
          type: string
          format: uuid
      - name: mine
        in: query
        description: Продажи или закупки, где ответственный — сам вызывающий
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Продажи или закупки с колонками журнала или документы без продажи или закупки
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceTradeJournalPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /api/v1/finance/trade-journal/advance:
    get:
      tags:
      - Finance trade
      operationId: financeGetTradeAdvance
      summary: Получить свободные авансы контрагента
      description: Возвращает свободные, то есть неразнесённые, авансы контрагента.
      x-akeda-module: finance
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: finance.reports.trade:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - $ref: '#/components/parameters/BusinessQuery'
      - name: company_id
        in: query
        description: Omit for the selected business without a legal entity
        schema:
          $ref: '#/components/schemas/UUID'
      - name: contact_id
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      - name: currency
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          maxLength: 3
      - name: direction
        in: query
        required: true
        schema:
          type: string
          enum:
          - sales
          - purchases
      responses:
        '200':
          description: Общая сумма и адресуемые авансы
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinanceTradeAdvance'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
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:
    FinanceTradeAdvance:
      type: object
      additionalProperties: false
      required:
      - amount
      - advances
      properties:
        amount:
          type: string
          description: Общая свободная decimal string
        advances:
          type: array
          items:
            $ref: '#/components/schemas/FinanceOpenAdvance'
    FinanceTradeJournalDocument:
      type: object
      additionalProperties: false
      required:
      - id
      - type_key
      - type_name
      - number
      - date
      - status
      - amount
      - currency
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        type_key:
          type: string
        type_name:
          type: string
        display_kind:
          type: string
          enum:
          - supplier_act
          - goods_receipt
          - purchase
          - act
          - goods_sale
          - sale
          description: 'Имя документа людям по составу (ERP-1810), только у finance_purchase и finance_sale: supplier_act — акт поставщика (одни услуги), goods_receipt — поступление товаров (один товар), purchase — поступление (смесь или состав неизвестен); act, goods_sale, sale — то же у реализации. Приходит только у вида с именем посева: вид, названный кабинетом по-своему, показывается своим type_name'
        number:
          type: string
        date:
          type: string
          format: date
        status:
          type: string
        amount:
          type: string
          description: Доля документа в колонке, decimal string
        currency:
          type: string
          minLength: 3
          maxLength: 3
    FinanceOpenAdvance:
      type: object
      additionalProperties: false
      required:
      - id
      - number
      - date
      - amount
      - currency
      - outstanding
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        number:
          type: string
        date:
          type: string
          format: date
        amount:
          type: string
          description: Decimal string
        currency:
          type: string
          minLength: 3
          maxLength: 3
        outstanding:
          type: string
          description: Незачтённая decimal string
    FinanceTradeJournalRow:
      type: object
      additionalProperties: false
      required:
      - id
      - number
      - date
      - status
      - contact_id
      - contact_name
      - company_id
      - company_name
      - project_id
      - project_name
      - item_name
      - amount
      - currency
      - due_date
      - outstanding
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        number:
          type: string
        date:
          type: string
          format: date
        status:
          type: string
        contact_id:
          type:
          - string
          - 'null'
          format: uuid
        contact_name:
          type: string
        company_id:
          type:
          - string
          - 'null'
          format: uuid
        company_name:
          type: string
        project_id:
          type:
          - string
          - 'null'
          format: uuid
        project_name:
          type: string
        item_name:
          type: string
        amount:
          type: string
          description: Decimal string
        currency:
          type: string
          minLength: 3
          maxLength: 3
        due_date:
          type: string
          format: date
        outstanding:
          type: string
          description: Decimal string из регистра расчётов
        operation_id:
          type: string
          format: uuid
        parent_operation_id:
          type: string
          format: uuid
        parent_document_id:
          type: string
          format: uuid
        recognition_mode:
          type: string
        type_key:
          type: string
        type_name:
          type: string
        display_kind:
          type: string
          enum:
          - supplier_act
          - goods_receipt
          - purchase
          - act
          - goods_sale
          - sale
          description: 'Имя документа людям по составу (ERP-1810), только у finance_purchase и finance_sale: supplier_act — акт поставщика (одни услуги), goods_receipt — поступление товаров (один товар), purchase — поступление (смесь или состав неизвестен); act, goods_sale, sale — то же у реализации. Приходит только у вида с именем посева: вид, названный кабинетом по-своему, показывается своим type_name'
        overdue_amount:
          type: string
        accrued:
          type: string
        paid:
          type: string
        cash_paid:
          type: string
        advance:
          type: string
        change_kind:
          type: string
        source_system:
          type: string
        source_ref:
          type: string
        external_id:
          type: string
        version:
          type: integer
          minimum: 0
        cash_documents:
          type: integer
          minimum: 0
        accrual_stages:
          type: integer
          minimum: 0
        payment_stages:
          type: integer
          minimum: 0
        accrued_stages:
          type: integer
          minimum: 0
        paid_stages:
          type: integer
          minimum: 0
        group:
          type: string
          enum:
          - orders
          - without_order
          - executions
        state:
          type: string
          description: Состояние продажи или закупки по канону
          enum:
          - draft
          - confirmed
          - executing
          - executed
          - closed
          - cancelled
        title:
          type: string
        contract_id:
          type:
          - string
          - 'null'
          format: uuid
        cabinet_status_name:
          type: string
        ordered:
          type: string
          description: Итог продажи или закупки, decimal string
        executed:
          type: string
          description: Долг, рождённый исполнениями продажи или закупки, decimal string
        debt:
          type: string
          description: 'Долг, decimal string: остаток регистра расчётов (money_from_register), иначе вычисленный max(0, исполнено − оплачено)'
        execution_count:
          type: integer
          minimum: 0
        money_from_register:
          type: boolean
          description: 'Аванс, долг и оплачено — остатками регистра расчётов по продаже или закупке: бизнес прошёл отсечку расчётов по продажам или закупкам (этап 3 ERP-1427)'
        execution_cutover:
          type: boolean
          description: 'Бизнес продажи или закупки прошёл отсечку исполнения (этап 4 ERP-1427): при включённом документообороте акт по продаже или закупке выпускают «Документы» продажи или закупки — бумага и исполнение одной командой; прямой акт финансов отвечает 409 finance.trade.act_needs_paper'
        order_id:
          type: string
          format: uuid
          description: Продажа или закупка документа исполнения по цепочке оснований (группы without_order и executions)
        order_number:
          type: string
          description: Номер продажи или закупки документа исполнения
        executions:
          type: array
          items:
            $ref: '#/components/schemas/FinanceTradeJournalDocument'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/FinanceTradeJournalDocument'
    FinanceTradeJournalPage:
      type: object
      additionalProperties: false
      required:
      - count
      - results
      properties:
        count:
          type: integer
          minimum: 0
        results:
          type: array
          items:
            $ref: '#/components/schemas/FinanceTradeJournalRow'
        limit:
          type: integer
          minimum: 1
        offset:
          type: integer
          minimum: 0
        has_more:
          type: boolean
        limit_reached:
          type: boolean
        group:
          type: string
          enum:
          - orders
          - without_order
          - executions
        computed_columns:
          type: array
          description: Колонки, вычисленные до отсечки расчётов по продажам или закупкам (этап 3); нет, когда все строки ответа — из регистра
          items:
            type: string
            enum:
            - advance
            - debt
    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.
    UUID:
      type: string
      format: uuid
  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