АктПриемки - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
Строка 1: Строка 1:
{{Документ!_-_API3_Объект}}
+
 
* ЧастноеЛицо* - объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
+
===Объект===
* Договор - объект [[ПриемНаРаботу_-_API3_Объект|ПриемНаРаботу]] - прием на работу ГПХ
+
Тип: Документ
 +
 
 +
{{Легенда_-_API3_Объект}}
 +
 
 +
 
 +
'''Структура:'''
 +
<div class="mw-collapsible mw-collapsed">
 +
* Вложение — массив, массив с данными файлов, прилагаемых к документу
 +
<div class="mw-collapsible-content">
 +
:* Идентификатор — строка, идентификатор файла в хранилище СБИС Диск
 +
:* Тип - строка, название типа [https://sbis.ru/help/integration/catalog/guide#3 формализованного вложения]
 +
:* ПодТип - строка, название подтипа формализованного вложения
 +
:* ВерсияФормата - строка, версия формата
 +
:* ПодверсияФормата - строка, подверсия формата
 +
:* Файл
 +
:** Имя
 +
</div></div>
 +
* ВнешнийИдентификатор — строка, внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
 +
* Дата* — строка в формате "ДД.ММ.ГГГГ", дата документа
 +
* Договор - объект [[ПриемНаРаботуГПХ_-_API3_Объект|ПриемНаРаботуГПХ]] - прием на работу ГПХ
 +
* <span style="color:#077F0B">ЗапуститьЭДО</span> — булево, признак необходимости запустить документ в ДО. Документооборот по умолчанию не запускается. Запускается при условии, что передан флаг, создается '''новый''' документ, действие на этапе не требует выбора ответственного или подписания. Актуально только для документов с фазами ЭДО
 +
* <span style="color:#077F0B">ЗавершитьДО</span> — флаг завершения документооборота
 +
* Комментарий — строка, комментарий к документу
 +
* Название — строка, представление документа
 +
* НашаОрганизация* — объект [[НашаОрганизация_-_API3_Объект|НашаОрганизация]], организация документа
 +
* Номер* — строка, номер документа
 
* НомерЭтапа - строка (если в контракте было выбрано поэтапное вознаграждение)
 
* НомерЭтапа - строка (если в контракте было выбрано поэтапное вознаграждение)
 +
<div class="mw-collapsible mw-collapsed">
 +
* Основание — массив, массив документов основания
 +
<div class="mw-collapsible-content">
 +
:* ВидСвязи — число строкой, код вида связи с документом-основания [https://wi.sbis.ru/doc/edo/edo-platform/work-with-docs/doc-card/linked-docs/]
 +
:* Документ — объект документа-основания (любой объект с типом Документ)
 +
:* Сумма — число строкой, сумма связи в валюте учета
 +
:* СуммаВалютная — число строкой, сумма связи в валюте документа
 +
</div></div>
 +
* Ответственный — объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]], ответственный за документ
 +
<div class="mw-collapsible mw-collapsed">
 +
* Параметры — массив, массив именованных параметров ключ / значение
 +
<div class="mw-collapsible-content">
 +
:* Значение — строка или объект, значение параметра
 +
:* Название — строка, название параметра
 +
:* Тип — строка, тип параметра [Текст, Многострочный текст, Число, Флаг, Логическое, Дата, Период, Время, Список, Группа флагов, Объект]
 +
</div></div>
 +
<div class="mw-collapsible mw-collapsed">
 +
* <span style="color:#E70000">Пометки</span> — словарь, пометки по документу
 +
<div class="mw-collapsible-content">
 +
:* <span style="color:#E70000">Проведён</span> — Признак проведения документа, булево
 +
:* <span style="color:#E70000">Важный</span> — отметка Флажок на документе СБИС, булево
 +
:* <span style="color:#E70000">Плюс</span> — отметка Плюс на документе СБИС, булево
 +
:* <span style="color:#E70000">Срочно</span> — отметка Красный круг на документе СБИС, булево
 +
:* <span style="color:#E70000">НеТребуется</span> — отметка Зеленый круг на документе СБИС, булево
 +
:* <span style="color:#E70000">Просмотрен</span> — отметка Синий круг на документе СБИС, булево
 +
:* <span style="color:#E70000">Значительный</span> — отметка Желтый круг на документе СБИС, булево
 +
:* <span style="color:#E70000">ЗакрытоОтИзменений</span> — отметка серая галка на документе СБИС, булево
 +
</div></div>
 +
* <span style="color:#077F0B">Проведён</span> — булево, признак необходимости провести документ. Актуально только для документов с движениями
 
* Работы - массив
 
* Работы - массив
** Название - название работы
+
:* Название - строка, название работы
** Сумма - сумма работы
+
:* Сумма - число строкой, сумма работы
 +
* Регламент — строка, название регламента
 +
* <span style="color:#E70000">Состояние</span> — число строкой, код состояния документа
 +
* Сумма — число строкой, сумма документа
 +
* Удалён — булево, признак удаленности документа. По умолчанию считаем что документ не помечен на удаление
 +
* ЧастноеЛицо* — объект [[ЧастноеЛицо_-_API3_Объект|ЧастноеЛицо]]
  
  

Версия 21:16, 7 мая 2025

Объект

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

Легенда:

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


Структура:

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


Пример:

{
        "Дата": '28.01.2023',
        "Номер": '123123123',
        'Сумма': '500.0',
        'НашаОрганизация': {'ИдСБИС': '184'},
        'Договор': {'ИдСБИС': '1348'},
        'ЧастноеЛицо': {'ИдСБИС': '394'},
        "Работы": [
            {'Название': 'test3', 'Сумма': '500.00'},
            {'Название': 'test4', 'Сумма': '600.00'}
        ]
    }

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

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

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

  • НашаОрганизация
  • ЧастноеЛицо
  • ПриемНаРаботу

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

  • GphAct.Создать
  • GphAct.Прочитать
  • GphAct.Записать
  • Документ.ОтменитьПроведение
  • Документ.Провести