Робота з документом за допомогою M.E.Doc REST API

M.E.Doc REST API забезпечує виконання 3 основних кроків для роботи з документами: створити – підписати та відправити – отримати стан обробки

1. Створення та робота з документом

Податкові, акцизні накладні, первинні документи

Створюються методом /api/Document/MakeDoc шляхом передачі параметрів створення документа та тіла документа в форматі Json з елементами {TAB", "LINE", "NAME", "VALUE"}.

Приклади заповнення документів у JSON:

Для створення інших первинних документів необхідно переглянути структуру шаблона за допомогою /api/PrimaryTemplate та заповнити документ за аналогією до наведеного вище прикладу.

Додавання вкладень до первинного документа слід виконувати за допомогою метода /api/Document/AddAppendix

Звітність за період (декларації, ПДФО тощо)

Можна скористатися наступним сценарієм:

Створити пустий документ методом /api/Document/CreateDocumentByParam та отримати його cardcode;
Отримати створений пустий документ методом /api/Document/GetValues (якщо переглядати структуру документа не потрібно - цей крок можна пропустити);
Заповнити і зберегти таблиці документа методом /api/Document/SetValues.

Приклади заповнення документів у JSON:

Для створення іншої звітності необхідно переглянути структуру шаблона за допомогою /api/TemplateScheme та заповнити документ за аналогією до прикладу вище.

Переглянути типи документів, доступні для створення, можна за цим посиланням

2. Відправка й отримання документів та отримання квитанцій про стан обробки документів

Методи відправки застосовуються для відправки як підписаних, так і непідписаних документів. Слід зазначити, що для непідписаних документів потрібно передати сертифікати підписання підписантів; а також сертифікат шифрування.

При відсутності одного або декількох сертифікатів підписів або шифрування, документ підписується наявними сертифікатами та набуває відповідний стан підписання.

Використовуються методи:

/api/SignSendReceive/ToPartner – відправка документів контрагенту;
/api/SignSendReceive/ToGov – відправка документів та звітів у контролюючий орган;
/api/SignSendReceive/ReceiveCorrespondence – прийом пошти (всі доступні квитанції та документи).

3. Отримання інформації по документу та даних з реєстрів

Для отримання інформації про стан документа застосовуються методи:

/api/Info/GetDocKVT – отримання квитанцій документа;
/api/Info/GetDocStatus – отримання статусу документа;
/api/Info/GetDocSendStt - отримання стану руху документа;
/api/Info/GetDocInfo – отримання розширеної інформації про документ;
/api/Info/GetPrimaryReestr – повертає реєстри документів за заданими критеріями пошуку та інформацію по ним.

Переглянути специфікацію у Swagger можна перейшовши за посиланням з ConnectionSetup -> REST API або відкривши сторінку http://localhost:63777/Swagger/index.html, що генерується автоматично на основі налаштованого URL (якщо налаштували інший порт, тощо - врахуйте це).