---
title: "Получить доску сделок воронки"
method: GET
path: "/api/v1/crm/deals/board"
tags: ["CRM deals"]
---

# Получить доску сделок воронки

`GET /api/v1/crm/deals/board`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/crm/deals/board`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

Итоги в валюте учёта отдаются только при полном покрытии курсами; missing_rates перечисляет непереведённые валюты.

## Query parameters

- `pipeline` string, uuid, required
- `q` string
- `owner` integer
- `customer` string, uuid
- `archived` boolean
- `sort` string
- `limit` integer

## Headers

- `X-Tenant` string, required

## Response `200`

Колонки доски с итогами

- CRMDealBoard
  - `pipeline_id` string, uuid, required
  - `accounting_currency` string
  - `totals_available` boolean, required: false означает, что итоги в валюте учёта неполные
  - `missing_rates` string[], nullable, required
  - `stages` CRMDealBoardStage[], nullable, required
    - `stage` CRMStage, required
      - `id` string, uuid, required
      - `pipeline_id` string, uuid, required
      - `name` string, required
      - `label_key` string: Ключ подписи строки, которую завёл стартовый посев или готовый набор CRM (например crm.lead_stage.unsorted, crm.set.pipeline.patients, crm.source.manual): экран переводит подпись по ключу, а name остаётся прежним представлением. Пусто - кабинет назвал строку сам, показывается name как есть
      - `sort_order` integer, required
      - `category` 'open' | 'won' | 'lost', required: Категория стадии; won и lost закрывают сделку
      - `color` string, required
      - `probability` integer, required
      - `sla_hours` integer, required: Норматив пребывания на стадии в часах; 0 - без норматива
      - `required_fields` CRMRequiredField[], nullable, required
      - `is_active` boolean, required
      - `show_on_board` boolean: Показывать ли этап проигрыша (category lost) колонкой на доске сделок. Решает кабинет, по умолчанию нет; для открытых и выигрышных этапов признак ничего не меняет - они на доске всегда
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `total_count` integer, required
    - `original_totals` object, nullable, required: Суммы по валютам сделок колонки, десятичными строками
    - `amount_in_accounting` string: Сумма в валюте учёта десятичной строкой; отсутствует при неполном покрытии курсами
    - `weighted_in_accounting` string
    - `cards` CRMDealCard[], nullable, required
      - `id` string, uuid, required
      - `pipeline_id` string, uuid, required
      - `stage_id` string, uuid, required
      - `title` string, required
      - `amount` string, required: Сумма десятичной строкой: «19990.50». Разрядность берёт валюта (MONEY-ROUNDING.md)
      - `currency` string, required: Код валюты из справочника ERP
      - `amount_manual` boolean: Сумма набрана руками, а не сложена из состава сделки; сохранение состава снимает признак
      - `prices_include_vat` boolean: Цены строк состава включают НДС
      - `source` string, required: Канал обращения; manual для ручного заведения
      - `probability` integer, required
      - `expected_close_at` string, date-time
      - `owner_id` integer
      - `crm_customer_id` string, uuid
      - `next_action` string, required
      - `next_action_at` string, date-time
      - `archived_at` string, date-time
      - `closed_at` string, date-time
      - `loss_reason_id` string, uuid
      - `description` string
      - `first_message` string
      - `utm_source` string
      - `utm_medium` string
      - `utm_campaign` string
      - `utm_term` string
      - `utm_content` string
      - `landing_page` string
      - `referrer` string
      - `custom` object, nullable: Дополнительные поля кабинета: состав задаёт «Настройки → Поля»
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `customer_name` string
      - `owner_name` string
      - `stage_since` string, date-time: Когда сделка встала на текущий этап; от этого момента считается норматив этапа
    - `has_more` boolean, required

## Other responses

- `400`: Некорректный запрос или нарушение бизнес-правила
- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/a99574d597cc?raw)