3.4.4.1. Приглашение обмениваться документами
|
|
Интеграционное решение должно обеспечивать возможность формирования списка приглашений в формате XML (см. п. 2.1.1.3. XML файлы списка контрагентов) и возможность перемещения готового списка приглашений в папку Import приложения Такском-Ассистент. Такском-Ассистент автоматически обработает полученные от интеграционного решения файлы и отправит приглашения контрагентам. После получения от приглашенного контрагента отказа или согласия Такском-Ассистент обновит данные списка статусов приглашений "Мои контрагенты" в XML файле ...\Inbox\ContactListStatuses.xml.
Необходимый xml-файл списка приглашений должен состоять из четырех частей:
•
|
заголовка;
|
•
|
произвольного количества тегов, задающих информацию о приглашаемых контрагентах;
|
•
|
тега идентификатора шаблона при необходимости (опционально);
|
•
|
тега окончания </Contacts>.
|
Заголовок всегда должен быть таким:
<?xml version="1.0" encoding="utf-8"?>
<Contacts xmlns="http://api-invoice.taxcom.ru/contacts">
|
Пригласить контрагента можно разными способами:
1.
|
Отправив приглашение на адрес его электронной почты.
|
2.
|
С указанием логина или идентификатора участника документооборота EDXClientId, если контрагент является абонентом системы Такском-Доклайнз.
|
3.
|
Используя сразу оба способа, приведенные выше.
|
Например, при использовании первого способа тег, задающий информацию о приглашаемом контрагенте может иметь следующий вид:
<Contact>
<Name>бухгалтер ООО Рассвет Ильин И.И.</Name>
<Inn>9999111222</Inn>
<Kpp>999911122</Kpp>
<Email>IljinII@yandex.com</Email>
<Comment>Прошу разрешить обмен электронными документами</Comment>
</Contact>
В приведенном примере указаны данные контрагента с наименованием бухгалтер ООО Рассвет Ильин И.И., ИНН 9999111222, КПП 999911122, адресом электронной почты IljinII@yandex.com.
ИНН и адрес электронной почты - обязательные параметры, КПП - необязательный.
Табличное описание
Тег (узел) Contacts содержит следующие данные:
Атрибут
|
Тип
|
Описание
|
Обязательное присутствие
| ||||||||||||
Asof
|
Дата и время - стандарт XML (YYYY-MM-DDТHH:mm:ss.ttt)
|
Отметка времени
|
Да
| ||||||||||||
Contact
|
Комплексный тип.
См. следующую табл.
|
Содержит узел Contact для каждой записи обновления списка контактов.
См. следующую табл.
|
Нет
| ||||||||||||
TemplateID
|
Идентификатор типа GUID
|
Идентификатор шаблона письма приглашения
Тег TemplateID опционален. Если его нет, то используется шаблон по умолчанию.
Указанный шаблон должен быть создан и записан в системе заранее.
Набор поддерживаемых маркеров шаблона, которые при формировании сообщения заменяются на реальные значения:
|
Нет
|
Тег (узел) Contact содержит следующие данные
Атрибут
|
Тип
|
Описание
|
Обязательное присутствие
|
Name
|
Текст, до 255 символов
|
Полное или краткое наименование организации или индивидуального предпринимателя.
|
Да
|
Inn
|
Число, до 12 символов
|
ИНН юридического лица (10 цифр) или индивидуального предпринимателя (12 цифр). Система проверят правильность ИНН.
|
Да
|
Kpp
|
Число, до 9 символов
|
КПП юридического лица получателя (если получатель - индивидуальный предприниматель, то значение не задаётся);
|
Нет
|
Email
|
Текст, до 32 символов
|
Адрес электронной почты контрагента в формате [имя_пользователя]@[сервер].[домен] (например, demo@mail.ru)
|
Да - при отсутстви в данном теге Contact значения атрибута EDXClientId.
Нет - если в данном теге Contact указано значение атрибута EDXClientId.
|
Login
|
Текст, до 255 символов
|
Псевдоним пользователя в системе Такском-Доклайнз.
|
Нет
|
EDXClientId
|
Текст, до 46 символов
|
Идентификатор участника документооборота.
|
Нет
|
ExternalContactId
|
Текст, до 255 символов
|
Идентификатор контрагента во внешней учетной системе.
|
Нет
|
Comment
|
Текст, до 255 символов
|
Текст приглашения или комментарий
|
Нет
|
Agreements
|
Комплексный тип.
См. табл. ниже.
|
Список договоров (контрактов) с контрагентом.
См. табл. ниже.
|
Нет
|
Тег (узел) Agreements может содержать несколько узлов Agreement, которые содержат следующие данные:
Атрибут
|
Тип
|
Описание
|
Обязательное присутствие
|
Number
|
Текст, до 255 символов
|
Номер договора/контракта
|
Нет
|
Date
|
Дата и время - стандарт XML (YYYY-MM-DDТHH:mm:ss.ttt)
|
Дата заключения договора/контракта
|
Нет
|
Пример содержания xml-файла заявки на отправку приглашения целиком:
<?xml version="1.0" encoding="utf-8" ?>
<Contacts xmlns="http://api-invoice.taxcom.ru/contacts">
<Contact>
<Name>бухгалтер ООО Рассвет Ильин И.И.</Name>
<Inn>9999111222</Inn>
<Kpp>999911122</Kpp>
<Email>IljinII@yandex.com</Email>
<Comment>Прошу разрешить обмен электронными документами</Comment>
</Contact>
<TemplateID>1B3F3F57-96BD-40AB-83FE-8C63540EE8BD</TemplateID>
</Contacts>
При формировании письма будет использован шаблон 1B3F3F57-96BD-40AB-83FE-8C63540EE8BD.
ПРИМЕЧАНИЕ
В случае, если шаблон не найден, формируется ответ 400 Bad Request с кодом 4201 "Не удалось найти шаблон письма, идентификатор которого указан в заявке. Идентификатор шаблона...".