Взаимозачет - API3 Объект

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

Объект

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

Легенда:

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


Структура:

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

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


Пример:

{
  "ИдСБИС": "25316",
  "ИдИС": "ИдИС",
  "Номер": "3test",
  "Дата": "12.11.2020",
  "НашаОрганизация": {
    "ИдСБИС": "167"
  },
  "Контрагент": {
    "ИдСБИС": "12362"
  },
  "ТретьеЛицо ": {
    "ИдСБИС": "1331"
  },
  "Комментарий": "Обновление (+)",
  "Регламент": "Взаимозачет"
  "СуммыДолга": [{
      "ДокументРасчетов": {
        "ИдСБИС": "1234"
      },
      "Сумма": "1000.99"
    }
  ]
}

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

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


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

  • НашаОрганизация
  • Контрагент

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

  • MutualOffsetReal.RemoveAllLinks
  • PaymentLinking.LinkDocuments
  • MutualOffsetReal.LinkedDocsList
  • ОплаченныйСчет.Прочитать
  • MutualOffset.UpdateInnerLink