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

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

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

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

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

Структура файлу у форматі dbf має відповідати вимогам:

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

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

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

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

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

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

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

2. Опис API

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

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

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

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

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

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

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

1. Для додавання нового автоклієнта або оновлення потрібно вибрати підприємство, потім перейти в меню «Каталог послуг». 

2. У меню «Каталог послуг» виберіть розділ «Інтеграція (Автоклієнт)» і натисніть кнопку «Підключити», потім – «Відкрити».

Після того, як Автоклієнт буде підключений, додаток стає доступним на стартовій сторінці в розділі «Облік та звіти» - «Інтеграція (Автоклієнт)»

      2.1. Для роботи в групі ФОП після підключення модуля необхідно переключитись на групу ФОП:
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 для кожного підприємства. 

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

Для активації/деактивації автоклієнта треба натиснути на значок «Активувати/Деактивувати», на який показує стрілка на скриншоті нижче.

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

 Для видалення автоклієнта натисніть на значок «Видалити Автоклієнт», на який показує стрілка на скриншоті нижче. 

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

Вимоги: 

• Якщо потрібно використати символ, наприклад ";' тощо, вводьте найменування й призначення в лапках “”, наприклад “ТОВ ТЕСТ;'/. ТЕСТ”.
• Назва імпортованого файлу має бути 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.

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

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

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

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

• ЄДРПОУ – код ЄДРПОУ клієнта;
• МФО – код МФО банку, у якому відкрито рахунок клієнта;
• рахунок – номер рахунку клієнта;
• валюта – міжнародний тризначний символьний код валюти рахунку клієнта;
• дата операції – дата й час операції;
• код операції (не потрібно заповнювати);
• МФО банку – код МФО банку, у якому відкрито рахунок кореспондента;
• назва банку – найменування банку, у якому відкрито рахунок кореспондента;
• рахунок кореспондента – номер рахунку кореспондента;
• ЄДРПОУ кореспондента – код ЄДРПОУ кореспондента;
• кореспондент – найменування кореспондента (ТОВ «Кореспондент»);
• номер документа;
• дата документа;
• дебет – сума за дебетом у валюті рахунку (не потрібно заповнювати для кредитних операцій);
• кредит – сума за кредитом у валюті рахунку (не потрібно заповнювати для дебетових операцій);
• призначення платежу – текст призначення платежу операції;
• гривневе покриття – сума операції в гривневому еквіваленті.

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

Приклад файлу експорту оборотів: 

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

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

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

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

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

BRNM – чотиризначний код банку.

J_CS – рахунок відправника.

J_CR – рахунок одержувача.

J_S – сума платежу.

J_SV – сума в еквіваленті.

J_CURR – курс перерахунку.

J_CCY – валюта.

J_N – призначення платежу.

J_FIL – код МФО банку.

J_DDOC – дата документа.

J_DAV – дата здійснення платежу.

J_SNAME – найменування відправника.

J_SFIL – найменування банку відправника.

J_RFIL – найменування банку одержувача.

J_WHATF1 – призначення платежу.

J_REF – референс платежу.

J_TIME – час здійснення платежу.

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

(MO {дата} .dbf)

BRNM – чотиризначний код банку.

SC – номер рахунку, за яким сформовано оборотно-сальдову відомість.

NAME – найменування платника.

ON – вхідний залишок.

OK – вихідний залишок.

OBD – обороти ДТ – сумарний оборот за дебетом за день у валюті рахунку.

OBK – обороти КТ – сумарний оборот за кредитом за день у валюті рахунку.

ONV – вхідний залишок в еквіваленті.

OKV – вихідний залишок в еквіваленті.

OBDV – обороти ДТ в еквіваленті.

OBKV – обороти КТ в еквіваленті.

DPRD – дата формування файлу з відомістю.

DPD – дата виписки за попередній день.

CCY – валюта.

FIL – філія.

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

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

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

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

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

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