Опис API доступу до інформації приватної частини ЕК¶
Електонний кабінет надає у приватній частині можливість в режимі онлайн здійснювати переглят, пошук та вивантаження дані наступної інформації:
- інформація про стан розрахунків з бюджетом (детальніше в розділі Стан розрахунків з бюджетом)
Розташування у мережі Internet:
Вузол: https://cabinet.tax.gov.ua
Основной шлях: https://cabinet.tax.gov.ua/ws/public_api/
Параметри запиту на доступ до реєстрів та відповідь клієнту передаються у вигляді стандартного формату JSON
Розглянемо приклад запиту до API для отримання інформації щодо стану розрахунків з бюджетом:
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/ta/splatp?year=2020
Метод (Request Method): GET
Параметри запиту (Query String Parameters Payload):запиту
Назва | Обов’язковий | Опис |
---|---|---|
year | true | Передається рік, за який необхідно отримати дані |
Авторизація – в heder запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64
Приклад запиту до API для отримання узагальненої інформації щодо стану розрахунків платників з бюджетом в розрізі платежів:
curl 'https://cabinet.tax.gov.ua/ws/public_api/ta/splatp?year=2020' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: MIIStwYJKoZIhvcNAQ...
-H 'Accept: application/json'
Параметри відповіді (Responce):
Назва | Опис |
---|---|
idpmnt | ІД особового рахунку платника |
yearoper | Рік |
cSti | Код органу ДПС |
nameSti | Назва органу ДПС |
facemode | Тип платника |
tinS | ЄДРПОУ/РНОКПП |
payerName | Назва платника |
plat1 | Коб бюджетної класификації |
budgetTin | ЄДРПОУ органу ДКСУ |
budgetPayerName | Назва органу ДКСУ |
budgetMfo | МФО банку отримувача |
budgetBankName | Назва банку отримувача |
budgetAccount | Бюджетний рахунок |
budgetAccountIban | Бюджетний рахунок (IBAN) |
namePlt | Назва платежу |
narah0 | Нараховано |
splbd0 | Сплачено |
povbd0 | Повернуто |
penia0 | Пеня |
nedoim0 | Недоїмка |
perepl0 | Переплата |
sldpn0 | Сальдо пені |
debtAll | Сальдо всього |
Приклад відповіді API на запит стану розрахунків з бюджетом:
[{"idpmnt":"01200BEEDAA5032AE0530A214206197B",
"yearoper":2019,
"cSti":2659,
"nameSti":"ГУ ДПС У М.КИЄВІ (ШЕВЧЕНКІВСЬКИЙ Р-Н М.КИЄВА)",
"facemode":1,
"tinS":"34554355",
"payerName":"ПРАТ \"ЛІТАК\"",
"plat1":"30 11011000 00",
"budgetTin":37995466,
"budgetPayerName":"УДКСУ У ШЕВЧЕНКІВСЬКОМУ РАЙОНІ М.КИЄВА",
"budgetMfo":899998,
"budgetBankName":"Казначейство України(ел. адм. подат.)",
"budgetAccount":31115063026011,
"budgetAccountIban":"UA058999980000031115063026011",
"namePlt":"ВIЙСЬКОВИЙ ЗБIР",
"narah0":0,
"splbd0":131.21,
"povbd0":0,
"penia0":0,
"nedoim0":0,
"perepl0":0,
"sldpn0":0,
"debtAll":0},
{"idpmnt":"482BFC59A9E20374E053C0A8016DC6DD",...}]
Розглянемо приклад запиту до API для отримання інформації щодо детальної інформації по особовому рахунку платнка:
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/ta/splatp/2020/541/E2F2B841AF30059EE0430A2142061006/pa?page=0
Метод (Request Method): GET
Параметри запиту (Query String Parameters Payload):
Назва | Обов’язковий | Опис |
---|---|---|
page | true | Передається номер сторінки (нумерація з 0) |
2020 | true | Рік |
541 | true | Код органу ДПС |
E2F2B841AF30.. | true | ІД особового рахунку платника |
Приклад запиту до API для отримання узагальненої інформації щодо стану розрахунків платників з бюджетом в розрізі платежів:
curl 'https://cabinet.tax.gov.ua/ws/public_api/ta/splatp/2020/541/E2F2B841AF30059EE0430A2142061006/pa' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: MIIStwYJK...
-H 'Accept: application/json'
Параметри відповіді (Responce):
Назва | Опис |
---|---|
rn | Номер рядка |
dateoper | Дата операції |
vidpa | Код операції |
namevid | Назва операції |
isnull0 | Сума операції |
narah0 | Нараховано |
splpov0 | Сплачено/повернуто |
sld0 | Сальдо |
penia0 | Пеня |
trmbeg0 | Початок нарахування пені |
trmend0 | Завершення нарахування пені |
splpovpn0 | Сальдо пені |
sldpn0 | Залишок несплаченої пені |
povbd0 | Повернуто з бюджету |
nedoim0 | Недоїмка |
zaborg0 | Заборгованість всього |
perepl0 | Переплата |
templ | Коментар до операції |
Приклад відповіді API на запит стану розрахунків з бюджетом:
{"content":[{"rn":299912000000,
"dateoper":null,
"vidpa":"Всього",
"namevid":null,
"isnull0":null,
"narah0":null,
"splpov0":131233.21,
"sld0":null,
"penia0":null,
"trmbeg0":" ",
"trmend0":" ",
"splpovpn0":null,
"sldpn0":0,
"povbd0":null,
"nedoim0":0,
"zaborg0":null,
"perepl0":null,
"templ":null},
{"rn":201912000025,
"dateoper":"05.12.2019",
"vidpa":"101",
"namevid":"Сплата суми податкiв i зборiв / єдиного внеску",
"isnull0":106.36,
"narah0":null,
"splpov0":106.36,
"sld0":null,
"penia0":null,
"trmbeg0":" ",
"trmend0":" ",
"splpovpn0":null,
"sldpn0":0,
"povbd0":null,
"nedoim0":0,
"zaborg0":null,
"perepl0":null,
"templ":"Зараховано 05.12.2019 Сплата суми податкiв i зборiв / єдиного внеску Платiжне доручення N 100 вiд 02.12.2019"},
{"rn"...}]}