Взыскание - API3 Объект

Материал из razgovorov.ru
Перейти к: навигация, поиск

Объект

Тип: Документ

Легенда:

  • Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
  • Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
  • Реквизиты красного цвета поддерживаются синхронизацией только из СБИС


Структура:

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

Объем данных возвращаемых методом API3.GetSbisObject может отличаться в бóльшую сторону


Пример:

{
  "Номер": "123",
  "Дата": "15.07.2019",
  "ИдИС": "ИдИС",
  "Комментарий": "опоздания",
  "Вид": {
    "ИдСБИС": "3"
  }
  "Получатели": [
    {
      "ЧастноеЛицо": {
        "ИдСБИС": "62"
      },
      "Сотрудник": {
        "ИдСБИС": "233"
      },
      "Сумма": "500.00",
      "Комментарий": "опоздание 01.04.2022"
    },
    {
      "ЧастноеЛицо": {
        "ИдСБИС": "63"
      },
      "Сотрудник": {
        "ИдСБИС": "235"
      },
      "Сумма": "1000.00",
      "Комментарий": "опоздание 10.04.2022 и 15.04.2022"
    }
  ]
}

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

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


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

  • ЧастноеЛицо
  • ВидВзыскания

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

  • SmotDocName.DeleteAllReceivers
  • SmotDocName.AddReceivers
  • ПоощренияИВзыскания.Прочитать
  • ПоощренияИВзыскания.Создать
  • ПоощренияИВзыскания.Записать