ДокументЭквайринга - API3 Объект — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
 
Строка 60: Строка 60:
 
* <span style="color:#E70000">Состояние</span> — код состояния документа
 
* <span style="color:#E70000">Состояние</span> — код состояния документа
 
* Контрагент — Лицо1, объект [[Контрагент_-_API3_Объект|Контрагент]]
 
* Контрагент — Лицо1, объект [[Контрагент_-_API3_Объект|Контрагент]]
 +
* Сумма — сумма, строка
 
* ДоговорЭквайринга — договор эквайринга, объект [[ДоговорЭквайринга_-_API3_Объект|ДоговорЭквайринга]]
 
* ДоговорЭквайринга — договор эквайринга, объект [[ДоговорЭквайринга_-_API3_Объект|ДоговорЭквайринга]]
 
* Карта — номер карты оплаты, строка
 
* Карта — номер карты оплаты, строка

Текущая версия на 14:54, 27 января 2025

Объект

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

Легенда:

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


Структура:

развернуть
  • Вложение — массив с данными файлов, прилагаемых к документу
  • Дата* — дата документа, строка в формате "ДД.ММ.ГГГГ"
  • ВнешнийИдентификатор — внешний идентификатор документа в СБИС. Если передан является ключом поиска документа без учета типа (в СБИС это уникальное поле в разрезе всех типов документов). При создании будет записан и в последующем документ может быть найден по нему, даже при условии изменившихся других ключей
  • ИдИС — идентификатор документа в ИС, строка
  • ИдСБИС — идентификатор документа в СБИС, строка
  • ИмяСБИС — имя api3 объекта
  • Комментарий — назначение платежа
  • Название — представление объекта
  • НашаОрганизация* — объект НашаОрганизация
  • Номер* — номер документа, строка
развернуть
  • Основание — список объектов документы основания (массив)
развернуть
  • Параметры — массив именованных параметров ключ / значение
развернуть
  • Пометки — пометки по документу
  • Проведён — флаг необходимости провести документ. Документы проводятся в СБИС по умолчанию, булево
  • Удалён — признак удаленности документа в ИС. По умолчанию считаем что документ не помечен на удаление, булево
  • Регламент — название регламента, строка
  • Состояние — код состояния документа
  • Контрагент — Лицо1, объект Контрагент
  • Сумма — сумма, строка
  • ДоговорЭквайринга — договор эквайринга, объект ДоговорЭквайринга
  • Карта — номер карты оплаты, строка
  • Комиссия — сумма комиссии, число строкой
{
    'ИдСБИС': "1443",
    'ИмяСБИС': "ДокументЭквайринга"
    'Дата': "01.12.2023",
    'Номер': "123",
    'Название': "Документ эквайринга № 123 от 01.12.2023",
    'НашаОрганизация': {
        'ИдСБИС': '2',
        'ИмяСБИС': 'НашаОрганизация',
    },
    'Удалён': false,
    'Проведён': true,
    'Ответственный': {
        'ИдСБИС': '1',
        'ИмяСБИС': 'ЧастноеЛицо',
    },
    'Сумма': "10000",
    'ДоговорЭквайринга': {
        'ИдСБИС': '3',
        'ИмяСБИС': 'ДоговорЭквайринга',
    },
    'Регламент': 'Выручка розницы',
    'Основание': []
}

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

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