Published using Google Docs
Інструкція “Автоклієнт”
Updated automatically every 5 minutes

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

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. Для додавання нового автоклієнта або оновлення потрібно вибрати підприємство, потім перейти в меню «Каталог послуг». 

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

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

      2.1. Для роботи в групі ФОП після підключення модуля необхідно переключитись на групу ФОП:
1. зліва зверху біля назви компанії натиснути на стрілку


2. з випадаючого списку вибрати групу ФОП


3. підключити необхідний додаток (Автоклієнт, модуль обміну, API)
Підключений додаток буде працювати в режимі групи ФОП

  1. Для додавання нового автоклієнта натисніть кнопку «Підключити додаток» та у випадаючому списку виберіть «Автоклієнт».

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

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

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

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

Після вибору налаштувань натисніть кнопку «Зберегти».

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

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

Потрібно встановити «Автоклієнт», виконавши кроки 1–7 для кожного підприємства. 

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

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

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

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

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

Вимоги: 

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

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

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

Назва поля DBF

Назва поля CSV

Тип поля

Довжина

Опис поля

Приклад

N_D

N_D

CHARACTER

10

Номер документа

77

SUMMA

SUMMA

NUMERIC

15.2

Сума платежу

2015.99

COUNT_A

COUNT_A

CHARACTER

29

Номер рахунку/картки

платника

UA593052990000026001555777001

NAME_B

NAME_B

CHARACTER

40

Найменування отримувача

ТОВ Львів

MFO_B

MFO_B

CHARACTER

9

МФО банку отримувача

305299

COUNT_B

COUNT_B

CHARACTER

29

Номер рахунку/картки отримувача

UA453052990000026009444333002

N_P

N_P

CHARACTER

160

Призначення платежу

Оплата згідно з угодою 22 від 01.01.2015, ПДВ...

OKPO_B

OKPO_B

CHARACTER

10

Код ЄДРПОУ / ІПН отримувача

13422702

SER_PAS_B

SER_PAS_B

CHARACTER

2

Серія паспорта (для ID-паспорта залишається порожньою)

АК

NOM_PAS_B

NOM_PAS_B

CHARACTER

9

Номер паспорта

126126 (126126126 для ID-паспорта)

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

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

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

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

UA453052990000026001222148856UAH0202201603022016_opers.csv;

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

UA453052990000026001222148856UAH0202201603022016_lastday.csv;

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

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

UA453052990000026001222148856UAH0202201603022016_saldo.csv.

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

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

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


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

Назва поля

Опис поля

Приклад

ЄДРПОУ

код ЄДРПОУ клієнта

12345678

МФО

код МФО банку, у якому відкрито рахунок клієнта

305299

Рахунок

номер рахунку клієнта

UA593052990000026001555777001

Валюта

міжнародний тризначний символьний код валюти рахунку клієнта

UAH

Дата операції

дата й час операції

22.06.2023 13:18:00

Код операції

Не потрібно заповнювати

1

МФО банка

код МФО банку, у якому відкрито рахунок кореспондента

305299

Назва банка

найменування банку, у якому відкрито рахунок кореспондента

АТ КБ "ПРИВАТБАНК"

Рахунок кореспондента

номер рахунку кореспондента

UA593052990000026001555777001

ЄДРПОУ кореспондента

код ЄДРПОУ кореспондента

1234567890

Кореспондент

найменування кореспондента

ТОВ «Кореспондент»

Номер документа

Номер документа

AUTO-91594

Дата документа

Дата документа

22.06.2023

Дебет

сума за дебетом у валюті рахунку (не заповнюється для кредитних операцій)

0.01

Кредит

сума за кредитом у валюті рахунку (не заповнюється для дебетових операцій)

0.01

Призначення платежу

текст призначення платежу

Тестове призначення платежу

Гривневе покриття

сума операції в гривневому еквіваленті

0.01

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

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

Назва поля

Опис поля

Приклад

Дата оборота

Сформований залишок на вказану дату

07.06.2023 00:00:00

Рахунок

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

UA083052990000035700050051672

Валюта

Валюта

UAH

Вхідний залишок

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

0.01

Гривневе покриття

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

0.01

Обороти ДТ

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

0.01

Гривневе покриття

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

0.01

Обороти КТ

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

0.01

Гривневе покриття

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

0.01

Вихідний залишок

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

0.01

Гривневе покриття

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

0.01

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

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

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

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

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

Найменування поля

Тип поля

Довжина

Розшифрування найменування поля

Приклад значення

TIP  

Character      

4

Crrp, Crrm

N_D  

Character      

10

Номер документа

G0418S2IPX

DATE

Character      

8

Клієнтська дата

20160418

SUMMA

Numeric

15.2

Сума документа

600.00

NAME_A    

Character      

40

Найменування рахунку платника

ПАРТНЕР КОНСАЛТИНГ, ТОВ

COUNT_A

Character      

29

Рахунок платника

UA453052990000026008052725794

MFO_A

Character      

9

Код банку А

305299

BANK_A

Character        

45

Найменування банку A

АТ КБ "ПРИВАТБАНК"

NAME_B  

Character      

40

Найменування рахунку отримувача

КИЇВСТАР, ПРАТ

COUNT_B      

Character      

29

Рахунок отримувача

UA453052990000026008164716001

MFO_B

Character      

9

МФО банку отримувача

321842

BANK_B  

Character    

45

Найменування банку B

КИЇВСЬКЕ ГРУ АТ КБ "ПРИВАТБАНК", М. КИЇВ

N_P

Character  

160

Призначення платежу

Плата за послуги зв’язку, особовий рахунок 5204067, у т. ч. ПДВ 20% – 1666,67 грн.

VAL

Character        

4

Валюта документа

UAH

OKPO_A    

Character      

10

Код ЄДРПОУ платника

14360570

OKPO_B

Character  

10

Код ЄДРПОУ отримувача

21673832

TIME

Character      

17

Дата й час операції

20160418T01:31:00

COUNT

Character  

16

Не використовується

REF

Character  

15

Референс документа

HSKLG0418L04WA

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

Найменування поля

Тип поля

Довжина

Розшифрування найменування поля

Приклад значення

BRNM

Character      

4

0

J_S

Numeric

17.2

Сума документа

0,01

J_CS

Character      

29

Рахунок відправника

UA453052990000026008052725794

J_CR      

Character      

29

Рахунок отримувача

UA453052990000026008164716001

J_SV

Numeric

17.2

Сума документа в гривневому еквіваленті

0,01

J_CURR

Numeric

13.7

курс перерахунку

0,0000000

J_CCY

Character      

3

валюта

UAH

J_N

Character      

10

Номер платежу

CD1090312

J_FIL

Character      

6

МФО банку

305299

J_DDOC

Date

дата документа

26.06.2023

J_DAV

Date

Дата здійснення платежу

26.06.2023

J_SNAME

Character      

40

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

ТОВ “Тест”

J_SFIL

Character      

40

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

АТ КБ "ПРИВАТБАНК"

J_RFIL

Character      

40

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

АТ КБ "ПРИВАТБАНК"

J_WHATF1

Character      

74

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

Призначення платежу

J_REF

Character      

14

референс платежу

REGPN0626BAW6G

J_REFN

Character      

1

референс платежу

1

J_TIME

Character      

14

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

0802

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

(MO {дата} .dbf)

Найменування поля

Тип поля

Довжина

Розшифрування найменування поля

Приклад значення

BRNM

Character      

4

0

SC

Character      

29

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

UA453052990000026008052725794

NAME 

Character      

35

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

ТОВ “Тест”

ON

Numeric

17.2

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

0,01

OK

Numeric

17.2

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

0,01

OBD

Numeric

17.2

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

0,01

OBK

Numeric

17.2

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

0,01

ONV

Numeric

17.2

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

0,01

OKV

Numeric

17.2

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

0,01

OBDV

Numeric

17.2

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

0,01

OBKV

Numeric

17.2

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

0,01

DPRD

Date

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

27.06.2023

DPD

Date

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

26.06.2023

CCY

Character      

3

валюта

UAH

FIL

Character      

4

філія

DNH0

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

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

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

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

Для розробників

2. Опис API

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