Взаимозачет - API3 Объект — различия между версиями
Строка 1: | Строка 1: | ||
{{Документ!_-_API3_Объект}} | {{Документ!_-_API3_Объект}} | ||
* Контрагент - объект контрагент [[Контрагент_-_API3_Объект|Контрагент]] | * Контрагент - объект контрагент [[Контрагент_-_API3_Объект|Контрагент]] | ||
+ | * ТретьеЛицо - объект контрагент [[Контрагент_-_API3_Объект|Контрагент]] | ||
* <span style="color:#077F0B">СуммыДолга</span> - массив, данные о связанных документах | * <span style="color:#077F0B">СуммыДолга</span> - массив, данные о связанных документах | ||
** ДокументРасчетов* - объект Документ [[ВозвратОтПокупателя_-_API3_Объект|ВозвратОтПокупателя]] или [[ВходящийПлатеж_-_API3_Объект|ВходящийПлатеж]] или [[ИсходящийПлатеж_-_API3_Объект|ИсходящийПлатеж]] | ** ДокументРасчетов* - объект Документ [[ВозвратОтПокупателя_-_API3_Объект|ВозвратОтПокупателя]] или [[ВходящийПлатеж_-_API3_Объект|ВходящийПлатеж]] или [[ИсходящийПлатеж_-_API3_Объект|ИсходящийПлатеж]] | ||
Строка 20: | Строка 21: | ||
"Контрагент": { | "Контрагент": { | ||
"ИдСБИС": "12362" | "ИдСБИС": "12362" | ||
+ | }, | ||
+ | "ТретьеЛицо ": { | ||
+ | "ИдСБИС": "1331" | ||
}, | }, | ||
"Комментарий": "Обновление (+)", | "Комментарий": "Обновление (+)", |
Текущая версия на 14:19, 23 сентября 2024
Объект
Тип: Документ
Легенда:
- Реквизиты черного цвета поддерживаются синхронизацией в обоих направлениях
- Реквизиты зеленого цвета поддерживаются синхронизацией только в СБИС
- Реквизиты красного цвета поддерживаются синхронизацией только из СБИС
Структура:
- Автор — объект ЧастноеЛицо
- Вложение — массив с данными файлов, прилагаемых к документу
- Идентификатор — идентификатор файла в хранилище СБИС Диск
- Тип - строка, название типа формализованного вложения
- Подтип - строка, название подтипа формализованного вложения
- ВерсияФормата - строка, версия формата
- ПодверсияФормата - строка, подверсия формата
- Файл
- Имя
- Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
- ЗапуститьЭДО — флаг необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается новый документ, действие на этапе не требует выбора ответственного или подписания, булево
- ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
- ИдИС — идентификатор документа в ИС, строка
- ИдСБИС — идентификатор документа в СБИС, строка
- ИмяСБИС — имя api3 объекта
- Комментарий — строка
- Название — представление объекта
- НашаОрганизация* — объект НашаОрганизация
- Номер* — номер документа, строка
- Основание — список объектов документы основания (массив)
- ВидСвязи — вид связи с документом-основания
- Документ — объект документа-основания
- Сумма — сумма связи
- Ответственный — объект ЧастноеЛицо
- Параметры — массив именованных параметров ключ / значение
- Значение — значение параметра, строка
- Название — название параметра, строка
- Тип — тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект], строка
- Пометки — пометки по документу
- Проведён — Признак проведения документа, булево
- Удалён — Признак перемещения документа в удаленные, булево
- Важный — отметка Флажок на документе СБИС, булево
- Плюс — отметка Плюс на документе СБИС, булево
- Срочно — отметка Красный круг на документе СБИС, булево
- НеТребуется — отметка Зеленый круг на документе СБИС, булево
- Просмотрен — отметка Синий круг на документе СБИС, булево
- Значительный — отметка Желтый круг на документе СБИС, булево
- ЗакрытоОтИзменений — отметка серая галка на документе СБИС, булево
- Провести — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
- Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
- Регламент — название регламента, строка
- Состояние — код состояния документа
- СчетУчетаКонтрагент — объект ПоказательУчета
- СчетУчетаАванс — объект ПоказательУчета
- Контрагент - объект контрагент Контрагент
- ТретьеЛицо - объект контрагент Контрагент
- СуммыДолга - массив, данные о связанных документах
- ДокументРасчетов* - объект Документ ВозвратОтПокупателя или ВходящийПлатеж или ИсходящийПлатеж
- Сумма* - сумма зачета
Объем данных возвращаемых методом 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