Інтеграція з обліковими системами
Інтеграція Шрифт з обліковими системами дає змогу спростити створення нових і оновлення наявних документів між СЕД і системою бухобліку.
Завдяки інтеграції функціональність облікових систем розширюється можливостями Шрифт по зберіганню, пошуку електронних документів, зокрема повнотекстовому, виконанню процесів узгодження і підписання документів, зокрема із зовнішніми контрагентами, у зручній формі через веб інтерфейс або мобільний застосунок.
СЕД Шрифт має більш загальну управлінську функціональність, націлену на спільну роботу співробітників над проєктами, документами і задачами порівняно зі спеціалізованими обліковими системами, даючи змогу створювати документи на підставі первинних документів або звітів з облікових систем.
Бізнес-процеси, у межах яких можна застосувати модуль інтеграції Шрифт через відповідні API:
Підписання договорів
Виставлення рахунків та актів виконаних робіт
Підписання видаткових накладних
Звірка актів взаєморозрахунків
Внутрішнє узгодження документів руху грошей
Узгодження прайсів
Збереження документів-звітів за залишками ТМЦ
Збереження документів-звіти з виробництва продукції
Збереження документів-звітів з підсумками за період
Збереження документів з управлінської звітності.
Увімкнення інтеграції на стороні Акаунта компанії
Для початку роботи із зовнішніми API системи Шрифт необхідно активувати на сторінці Акаунта компанії цю опцію.
(скріншот)
Опція роботи за зовнішніми API доступна на всіх тарифах, включно з безкоштовним тарифом Free.
API ключ співробітника
Кожен співробітник компанії може створити свій API ключ доступу для створення документів у Шрифт із зовнішніх додатків. Ключ створюється в профілі співробітника.
Модуль інтеграції в обліковій системі
Для створення документів, завдань у Шрифт необхідно в обліковій системі налаштувати модуль інтеграції із застосуванням зовнішніх API системи Шрифт.
Як контент електронного документа з облікової системи можна взяти друковану форму документа або звіту, сформовану в pdf, xlsx або docx форматі, тому що такий файл буде максимально відповідати користувацькому уявленню про документ.
Для мінімальної інтеграції із зовнішнім застосунком необхідно реалізувати такі функції:
дію за документом «Відправити документ у Шрифт»
показати Статус документа в Шрифт
дію за документом «Оновити стан документа і відомості про підписання»
дію за документом «Перейти за посиланням на документ».
Робота із зовнішніми API - посилання на статтю.
Відстеження змін документів у Шрифт
Для схем інтеграції, за яких необхідно відстежувати зміни статусу, складу підписів та інші зміни документів у Шрифт, передбачено кілька механізмів:
Встановлення зв'язку за первинними ключами зовнішніх документів із документами Шрифт;
Поділ документів Шрифт на зовнішні групи;
Отримання списку змінених документів з моменту останньої відпрацьованої події;
Отримання списку змінених документів за період часу.
Комбінація цих механізмів дає змогу реалізувати різні сценарії відпрацювання в зовнішній системі змін документів у Шрифт. Дає змогу реалізувати інтеграційні семи, коли робота користувачів із документом у Шрифт є одним з етапів роботи з документами в зовнішній системі.
Встановлення первинних ключів зовнішньої системи
Для створення зв'язку документа зовнішньої системи з документом Шрифт у структурі документа передбачено зберігання полів DocumentExternalKeyType і DocumentExternalKey. Їх можна передавати при створенні нового документа або виконувати оновлення наявних документів у Шрифт.
Наприклад, у полі DocumentExternalKeyType можна вказати групу зовнішніх документів (ідентифікатор БД, підрозділу або юрособи), а в поле DocumentExternalKey передавати первинний ключ документа.
Для оновлення зовнішніх документа виконайте http запит:
curl --location --request PUT '{{baseUrl}}/Documents/{{DocumentID}}' ^
--header 'Content-Type: application/json' ^
--header 'Accept: text/plain' ^
--header 'X-API-KEY: {{EmployeeAPIKey}}'^
--data '{
"DocumentExternalKeyType": {{DocumentExternalKeyType}},
"DocumentExternalKey": {{DocumentExternalKey}}
}'
DocumentExternalKeyType – зовнішня група документів
DocumentExternalKey – первинний ключ документа в зовнішній системі
Отримання документів зі змінами за останньою подією зміни
Для відстеження зміни статусів документів, складу підписів та інших відомостей за документом можна періодично виконувати запит Documents/Changes, який повертає список DocumentIds змінених документів. Запит дає змогу фільтрувати документи зі змінами в Шрифт за зовнішньою групою документів DocumentExternalKeyType з моменту конкретної події і до поточного моменту.
curl --location '{{baseUrl}}//Documents/Changes? ObjectTypes=100&DocumentExternalKeyType={{DocumentExternalKeyType}}&OldMaxChangeId={{NewMaxChangeId}}' ^
--header 'Accept: text/plain' ^
--header 'X-API-KEY: {{EmployeeAPIKey}}'
ObjectTypes - тип об'єкта Шрифт, 100 - тип зміни документа
DocumentExternalKeyType - зовнішня група документів
OldMaxChangeId - ID останньої зміни за документами
Запит повертає DocumentIds і NewMaxChangeId. Для отримання та оновлення потрібних відомостей за документами виконайте відповідні запити за документом, застосовуючи отримані DocumentIds.
Рекомендуємо виконувати запит раз на кілька хвилин зі збереженням останнього ідентифікатора зміни NewMaxChangeId і передачею його в наступні запити як параметра OldMaxChangeId. Це дасть змогу отримувати тільки документи зі змінами, які з'явилися в Шрифті починаючи з події OldMaxChangeId і до поточного моменту.
Якщо змін за документами відповідно до переданих параметрів не було, то DocumentIds буде порожнім, а NewMaxChangeId повернеться без змін або може просунутися, якщо були події по інших об'єктах або документах, що не входять у передану групу.
Відстеження змін за документами в такий спосіб має обмеження. Запит Documents/Changes повертає відомості щодо документів, які змінювалися за останні 7 днів.
Отримання документів зі змінами за період часу
Для отримання списку документів, що змінилися за вказаний період, виконайте запит:
curl --location '{{baseUrl}}//Documents/ByEvents?DocumentExternalKeyType={{DocumentExternalKeyType}}&DateFrom={{DateFrom}}&DateTo={{DateTo}}' ^
--header 'Accept: text/plain' ^
--header 'X-API-KEY: {{EmployeeAPIKey}}'
DocumentExternalKeyType - зовнішня група документів
DateFrom, DateTo - період часу з по за який потрібно відібрати зміни.
Робота з документом у Шрифт
Після створення документа в Шрифт, у СЕД можуть бути виконані будь-які бізнес-процеси, передбачені в рамках документообігу для такого виду документів.
Зміни, зроблені за документом, можуть впливати на його статус, на склад файлів документа, на склад його підписантів тощо. Ці зміни будуть автоматично синхронізуватися з бухгалтерською системою.