1. Saby
  2. База знаний
  3. API
  4. API СБИС CRM
  5. Узнать статус сделки

Узнать текущее состояние сделки по API

Узнать текущее состояние сделки по API

Команда «CRMLead.getLeadStatus» возвращает текущее состояние и последний комментарий по сделке.

Параметры запроса

Адрес запроса: https://online.sbis.ru/service/

Параметр
* — обязательный
ТипОписание
ИдентификаторДокумента*UUIDUUID документа. Уникальный идентификатор, который получен при создании сделки

Результат

Параметр

Тип

Описание

ИдентификаторДокументаUUIDUUID-идентификатор документа в системе клиента
@Документinteger идентификатор документа в Saby. Целое число
Активностьboolean флаг, который определяет статус сделки. Возможные значения: «False» — сделка новая, по ней нет событий, «True» — сделка в работе или завершена, есть события
Результатboolean результат сделки. Возможные значения: «True»/«False» — сделка завершена положительно/отрицательно, «None» — сделка не завершена
ПоследнийКомментарийstringкомментарий из последнего события по сделке либо комментарий из самой сделки
ДатаКомментарияdate
«ГГГГ.ММ.ДД ЧЧ:ММ:СС»
дата и время последнего события
АвторКомментарияUUIDUUID-идентификатор пользователя, который создал последнее событие
Ошибкаstringтекст ошибки, если запрос не был выполнен
Статусstringрезультат выполнения запроса. Возможные значения: «fail» — если в процессе поиска получили ошибку, «success» — если документ найден

Пример запроса

Пример ответа

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.