Лид - API3 Объект

Материал из razgovorov.ru
Версия от 12:15, 20 апреля 2020; Вишневский Никита (обсуждение | вклад) (Вишневский Никита переименовал страницу !Вишневский Лид - API3 Объект в Лид - API3 Объект поверх перенаправления)
Перейти к: навигация, поиск

Объект

  • ИдИС — идентификатор документа в ИС
  • ИдСБИС — идентификатор документа в СБИС
  • Номер* — номер документа, строка
  • Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
  • Название — Название документа
  • Сумма — число
  • НашаОрганизация* — объект НашаОрганизация
  • Основание — список объектов документы основания, массив
    • Документ — объект с типом Документ
    • ВидСвязи — вид связи документа основания
  • Регламент — регламент документа или тема отношений
  • ТекущийЭтап — текущий этап документа, строка
  • Ответственный — лицо, ответственное за документ. Объект Частное лицо
  • РабочаяГруппа — подразделение ответственное за документ. Объект Структура предприятия
  • Комментарий — комментарий к документу, строка
  • Параметры — массив именованных параметров ключ / значение
    • Название
    • Значение
  • Проводки — список проводок документа
    • Сумма
    • СуммаВВалюте
    • Валюта — Объект Валюта
    • Дата
    • Дебет
      • Счет
      • Аналитика1
        • ИмяСБИС
        • ИдСБИС
      • Аналитика2
      • Аналитика3
      • Аналитика4
    • Кредит
      • Счет
      • Аналитика1
      • Аналитика2
      • Аналитика3
      • Аналитика4
  • Вложение — массив с данными файлов, прилагаемых к документу.
  • Название - Название файла вложения с расширением
  • ДвоичныеДанные - строка в кодировке Bаse64. Используется для отправки содержимого бинарных данных на сервер. Не рекомендуется для файлов более 30 Мб.
  • Ссылка - ссылка на файл в хранилище СБИС Диск
  • Ид - идентификатор файла в хранилище СБИС Диск
  • Пометки — пометки по документу, используется исключительно при экспорте документов из СБИС
  • Важный — отметка Флажок на документе СБИС (булево)
  • Плюс — отметка Плюс на документе СБИС (булево)
  • Срочно — отметка Красный круг на документе СБИС (булево)
  • НеТребуется — отметка Зеленый круг на документе СБИС (булево)
  • Просмотрен — отметка Синий круг на документе СБИС (булево)
  • Значительный — отметка Желтый круг на документе СБИС (булево)
  • ЗакрытоОтИзменений — отметка серая галка на документе СБИС (булево)
  • Проведён — Признак проведения документа (булево)
  • Удалён — Признак перемещения документа в удаленные (булево)

Опции загрузки документа в СБИС.

  • Провести — Документы проводятся в СБИС по умолчанию. При выполнении следующего условия документ проведен не будет:

Значение узла не равно "Истина", "True" или "Да" (регистронезависимо).

  • ЗапуститьЭДО — Признак необходимости запуска документооборота по документу с выбором первого действия из списка возможных, после загрузки в СБИ. Документооборот запускается при выполнении следующих условий:

1) Значение узла "Истина", "True" или "Да" (регистронезависимо).

2) В результате выполнения UpdateSbisObject создается новый документ.

3) Действие на этапе не требует выбора ответственного или подписания.

  • ПрерватьЭДО — Признак необходимости прерывания документооборота по документу перед обновлением в СБИС. Документооборот будет прерван и будет создана новая редакция документа при выполнении следующих условий:

1) Значение узла "Истина", "True" или "Да" (регистронезависимо).

2) Обновляемый документ имеется в СБИС и по нему запущен документооборот.

  • События. Массив объектов вида:
    • Название - название перехода (строка)
    • Дата - дата перехода (строка в формате "ДД.ММ.ГГГГ")
    • Время - время перехода (строка в формате "ЧЧ:ММ")
    • Этап - название этапа (строка)
    • Исполнитель - объект ЧастноеЛицо
    • Комментарий - комментарий к переходу (строка)

Пример:

{
  "ИдИС": "7cf838b6-f9e6-11e7-ad08-3497f6377b7e",
  "Номер": "00000000001",
  "Дата": "15.01.2018",
  "НашаОрганизация": {
    "ИдИС": "56c61dec-e570-11e3-893a-005056c00008",
    "ИмяСБИС": "НашаОрганизация"
  },
  "Контрагент": {
    "ИдИС": "b9321b89-2648-11e6-ab23-080027358f3f",
    "ИмяСБИС": "Контрагент"
  },
  "Подразделение": {
    "ИдИС": "30b64f32-9102-4ba3-896d-cf60f1535c4f",
    "ИмяСБИС": "СтруктураПредприятия"
  },
  "Ответственный": {
    "ИдИС": "30b64f32-9102-4ba3-896d-cf60f1535c4f",
    "ИмяСБИС": "ЧастноеЛицо"
  },
  "Регламент": "Заключение договора"
  "События": [
    {
      "Название": "Первичный контакт",
      "Дата": "11.01.2020",
      "Время": "15:15",
      "Этап": "Звонок",
      "Исполнитель": {
        "ИдИС": "30b64f32-9102-4ba3-896d-cf60f1535c4f",
        "ИмяСБИС": "ЧастноеЛицо"
      },
      "Комментарий": "Не дозвонился"
    }
  ]
}

Естественные ключи

  • Ключ1 - номер документа + дата документа + организация + контрагент(вес = 3)
    • Ключ1_1 - номер документа
    • Ключ1_2 - дата документа
    • Ключ1_3 - идентификатор организации в ИС
    • Ключ1_4 - идентификатор контрагента в ИС
  • Ключ2 - не используется
  • Ключ3 - не используется

Зависит от объектов

  • НашаОрганизация
  • СтруктураПредприятия
  • Контрагент
  • ЧастноеЛицо

Используемые методы БЛ

  • Документ.ОтменитьПроведение
  • Документ.Провести