Сервіси інтеграції. Інструкція для роботи із застосунком «Автоклієнт»

1. Загальний опис

Додавання нового «Автоклієнта»

Запуск декількох «Автоклієнтів»

Додаткові функції

Імпорт платежів

Структура файлу у форматі DBF

Опис формату експорту транзакцій CSV

Структура файлу з експортованими виписками (транзакціями) у форматі CSV (ХХХ_opers.csv, ХХХ_lastday.csv)

Структура файлу оборотно-сальдової відомості у форматі CSV (Рахунок {дата}_saldo.csv)

Опис формату експорту транзакцій DBF

Структура файлу з експортованими виписками (транзакціями) у форматі DBF (JBKL_REC.DBF)

Структура файлу виписки у форматі DBF (MJ {дата} .dbf)

Структура файлу оборотно-сальдової відомості у форматі DBF

Системні вимоги

2. Опис API

3. Застосунки для вашої облікової системи

1. Загальний опис

Модуль «Автоклієнт» комплексу «Приват24 для бізнесу» призначений для обслуговування корпоративних клієнтів і приватних підприємців.

«Автоклієнт» – програмне забезпечення, що дає змогу налаштувати автоматичне періодичне отримання виписок і залишків за рахунками, а також імпортувати платежі в Приват24.

Підключити «Автоклієнт» може уповноважена або довірена особа підприємства в межах своїх повноважень (доступ до рахунків та операцій синхронні у вебверсії і застосунку «Автоклієнт»).

Модуль має графічний вебінтерфейс, за допомогою якого можна додати новий «Автоклієнт» із необхідними налаштуваннями.

Для юридичних осіб «Автоклієнт» доступний у тарифах «Бізнес Комфорт» і «Бізнес ПРО». Для ФОП – у будь-якому тарифі.

Додавання нового «Автоклієнта»

1. Щоб додати або оновити «Автоклієнт», виберіть підприємство та знайдіть у пошуку модуль «Інтеграція (Автоклієнт)». У меню ліворуч натисніть
   

2. Відкриється стартова сторінка з описом усіх можливостей застосунків у сервісі «Інтеграція (Автоклієнт)».

Для роботи з групою ФОП після входу до сервісу «Інтеграція (Автоклієнт)» перемкніться на групу ФОП:
1. У верхньому лівому куті поруч із назвою компанії натисніть кнопку вибору підприємства.
2. Виберіть групу ФОП.
3. Підключіть застосунок (API, «Автоклієнт», «Модуль обміну»).
Підключений застосунок працюватиме в режимі групи ФОП.

3. Щоб додати новий «Автоклієнт», натисніть «Підключити Автоклієнт» та в розкривному списку виберіть «Автоклієнт».
   
4. У вікні генерації «Автоклієнта» заповніть такі поля:

• Назва застосунку. 
• Формат файлу для експорту виписки. 
• Кодування файлу (якщо можливо).
• Інтервал між запитами на отримання виписки й залишків.
• Шлях до балансів (шлях для збереження файлів із балансами).
• Шлях до виписки (шлях для збереження файлів із виписками).
• Шлях до платежів, готових до імпорту (збереження файлу з платежами, підготовленими до імпорту).
• Шлях до імпортованих платежів (збереження файлу з платежами, які було імпортовано).
• Шлях до неімпортованих платежів (збереження файлу з платежами, які не вдалося імпортувати).

За замовчуванням залишки й виписка зберігаються до папки balance і statements, дані для імпорту платежів – до папок prepared, saved, rejected, які містяться в папці застосунку «Автоклієнт». Ознайомтеся з умовами та правилами використання застосунку й поставте позначку.

Якщо вибрано формат DBF, виписку та баланси буде збережено в одному файлі за вибраними рахунками одного підприємства з кодуванням cp1251. Якщо вибрано формат CSV – виписку та відомість буде збережено в окремі файли за кожним вибраним рахунком одного підприємства або в одному файлі за всіма рахунками (для цього треба вибрати «Вивантажувати дані по всіх рахунках в один файл», як показано на скриншоті нижче). Також для зручності користування файлами CSV можна поставити позначку «Включати дату в найменування файлів», тоді в назві файлу буде зазначено дату, за яку збережено дані.

У вкладці «Рахунки» виберіть рахунки, для яких потрібно налаштувати автоматичне періодичне отримання виписок і залишків (за замовчуванням вибрано всі рахунки).

У вкладці «Додаткові налаштування» можна встановити обмеження за IP-адресою та параметри проксі (якщо підключення здійснюється через проксі-сервер). Для цього активуйте відповідне обмеження та встановіть необхідні значення.

Після вибору налаштувань натисніть «Підключити».

5. У журналі з’явиться створений «Автоклієнт», який потрібно завантажити та запустити. Натисніть значок «Встановити»  
   
6. У вікні, що відкриється, завантажте «Автоклієнт», натиснувши «Завантажити». Для оновлення «Автоклієнта» потрібно деінсталювати застосунок, який було встановлено раніше (за допомогою деінсталятора unins000.exe, що міститься в папці «Автоклієнт», або через системне керування програмами на вашому комп’ютері), а потім встановити новий.
7. Натисніть autoclientInstaller_1141979494.exe (1141979494 – ідентифікатор вашого підприємства, тому цифри можуть відрізнятися), прийміть умови угоди, виберіть шлях для встановлення «Автоклієнта» та запустіть застосунок. За замовчуванням буде створено папку з назвою ID підприємства, наприклад 123456.
   
   
   
   

Додатково: для перевірки достовірності отриманого виконуваного файлу можна перевірити контрольну суму, яка відображається після завантаження застосунку.

Інструкція з перевірки контрольної суми – за кнопкою «Як перевірити».

Запуск декількох «Автоклієнтів»

Щоб запустити декілька «Автоклієнтів», виконайте кроки 1–7 для кожного підприємства. 

Додаткові функції

Щоб активувати або деактивувати «Автоклієнт», натисніть значок «Активувати/Деактивувати».

Щоб змінити налаштування, натисніть значок «Редагувати додаток», внесіть зміни у форму, що з’явиться, і збережіть їх. «Автоклієнт» автоматично отримає нові налаштування й буде їх використовувати. 

Щоб видалити «Автоклієнт», натисніть значок «Видалити додаток». 

Імпорт платежів

Вимоги: 

• Якщо потрібно використати символ, наприклад «;» тощо, вводьте найменування та призначення в лапках “”, наприклад “ТОВ ТЕСТ;'/. ТЕСТ”.
• Роздільник для CSV-файлу – «;» (крапка з комою).
• Назва імпортованого файлу має бути import (формат CSV або DBF – відповідно до вибраного формату вивантаження файлів на кроці 4).
• Файл для імпорту повинен бути в кодуванні, вибраному в налаштуваннях «Автоклієнта» на кроці 4.
• Назви папок, куди вивантажуються чи імпортуються файли, мають бути латиницею.
• Якщо в одержувача немає коду ЄДРПОУ / ІПН, обов’язково введіть у полі OKPO_B 0000000000 і коректно заповніть поля «Серія паспорта отримувача (SER_PAS_В)» та «Номер паспорта отримувача (NOM_PAS_В.)».
• Якщо одержувач має електронний паспорт громадянина України, коректно заповніть «Номер паспорта отримувача (NOM_PAS_В.)», а поле «Серія паспорта отримувача (SER_PAS_В)» залиште порожнім.

Кроки для імпорту платежів:

1. Перенесіть файл із платежами до папки prepared.
2. Якщо «Автоклієнт» вимкнуто, треба його запустити, якщо увімкнуто, то імпорт почнеться за наступного запиту даних.
3. Файл зі збереженими платежами буде в папці saved, файл із платежами, у реквізитах яких є помилки, разом із лог-файлом опису, що містить поле помилки, – у папці rejected.

Структура файлу у форматі DBF має відповідати вимогам (сірим кольором позначено обов’язкові поля):

Структура файлу має відповідати опису, а необов’язкові поля можна залишити порожніми. 

Опис формату експорту транзакцій CSV

Найменування файлів автоматично формуються в такому форматі:

• виписка за поточний день:

{14_останніх_цифр_номера_рахунку_або_IBAN_рахунок}{валюта}{дата} _opers.csv, наприклад UA453052990000026001222148856UAH0202201603022016_opers.csv;

• виписка за попередній день:

{14_останніх_цифр_номера_рахунку}{валюта}{дата} _lastday.csv, наприклад UA453052990000026001222148856UAH0202201603022016_lastday.csv;

• оборотно-сальдова відомість:

{14_останніх_цифр_номера_рахунку}{валюта}{дата}_saldo.csv, наприклад UA453052990000026001222148856UAH0202201603022016_saldo.csv.

Роздільник копійок у файлі – «.» (крапка).

Якщо в інтерфейсі не поставлено позначку «Включати дату в найменування файлів», назва файлів буде без дати. Виписка формуватиметься в одному файлі за рахунком.

Структура файлу з експортованими виписками (транзакціями) у форматі CSV (ХХХ_opers.csv, ХХХ_lastday.csv)

Опис полів, які експортуються:

Структура файлу оборотно-сальдової відомості у форматі CSV

(Рахунок {дата}_saldo.csv)

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

Приклад файлу з експортованими виписками (транзакціями) у форматі CSV (ХХХ_opers.csv): 

Опис формату експорту транзакцій DBF 

Найменування файлів автоматично формуються в такому форматі:

• виписка за поточний день: JBKL_REC.DBF;
• оборотно-сальдова відомість: MO {дата} .dbf, наприклад MO171025.dbf;
• виписка за попередній день: MJ {дата} .dbf, наприклад MJ171025.dbf.

Структура файлу з експортованими виписками (транзакціями) у форматі DBF (JBKL_REC.DBF)

Структура файлу виписки у форматі DBF (MJ {дата} .dbf)

Структура файлу оборотно-сальдової відомості у форматі DBF

(MO {дата} .dbf)

Системні вимоги

Windows Server 2008 64х, Windows Server 2012 64х, Windows 7 64х, Windows 8 64х, Windows 10 64х.

На папку зі встановленим «Автоклієнтом» мають бути права на читання й запис.

Не передавайте ID та токен третім особам. Якщо ви плануєте зберігати чи використовувати ID та токен не на своєму сервері або в застосунку, ознайомтеся з політикою конфіденційності та інформацією про безпеку, щоб знати, як будуть використовувати й захищати ваші дані.

3. Застосунки для вашої облікової системи

• «Автоклієнт» – для будь-якої облікової системи.
• «Модуль обміну з Приват24» – для бухгалтерських облікових систем, розроблених в Україні. Завантажити можна через «Приват24 для бізнесу» в меню «Каталог послуг – Модуль обміну з Приват24».