Авторизація
Невірна адреса, або пароль
Email:
Пароль:

Якщо Ви бажаєте отримувати новини на email і т.д. - Зареєструйтеся

Законодавство

Фізичним особам

Юридичним особам

Самозайнятим особам

Опитування

Сервіс API доступу до податкових показників платника податків

1.Загальна інформація

Сервіс API доступу до податкових показників надає можливість отримання суб’єктом підприємницької діяльності даних, які обробляються, формуються  або розраховуються Державною податковою службою України по даному платнику податків.

Технологічно сервіс реалізований з використанням взаємодії через програмний інтерфейс REST АРІ.

Коренева адреса сервісу: https://api.tax.gov.ua/gateway, всі адреси API наводяться щодо нього.

 

2. Взаємодія через програмний інтерфейс REST АРІ

 

2.1. Авторизація

Перед проведенням запитів до даних необхідно авторизуватися.

Комплекс підтримує bearer авторизацію c використанням кваліфікованого електронного підпису (далі КЕП) з використанням програмного токену.

Програмний токен виступає  засобом ідентифікації користувача та являє собою зашифровану послідовність символів, яка дозволяє точно ідентифікувати користувача і визначити рівень його привілеїв. Токен генерується системою авторизації і прив'язується до конкретного сеансу роботи.

Користувач повинен мати КЕП, виданий одним з українських кваліфікованих надавачів електронних довірчих послуг. Отримати перелік кваліфікованих надавачів електронних довірчих послуг можливо за посиланням https://iit.com.ua/download/productfiles/CAs.json.

 

2.2.Запит на отримання токену

Токен отримується шляхом надсилання НТТР запиту за адресою https://api.tax.gov.ua/gateway/get_token з використанням методу POST, який містить JSON об’єкт { "data": "<<em>data_value>"}.

Значення "<<em>data_value>" формується шляхом накладання кваліфікованого електронного підпису на код ЄДРПОУ платника податків та наступним кодуванням результату в форматі Base64.

 

Наприклад:  { "data": "VUE =="}

 

Відповідь, що отримується на запит про авторизацію, має наступний вигляд:

 

HTTP 200

Content-Type: application / json; charset = utf-8

{ "access_token": "< access_token_value>", "token_type": "Bearer", "expires_in": 10800}

 

де

-        "access_token" - робочий токен, наприклад:

    "access_token": "UWUoSqxKtCAe8MaPRuK5MaiIxj8g ==";

-        "token_type" - тип токену;

-        "expires_in" - час життя, сек.

Отриманий токен використовується як складова наступних запитів на отримання податкових показників платника податків.

 

3. Запити на отримання даних

 

3.1. Отримання показників розрахунків з бюджетом з інтегрованих карток платника податків

 

Отримання показників розрахунків з бюджетом з інтегрованих карток платника податків реалізується шляхом надсилання  НТТР запиту за адресою https://api.tax.gov.ua/gateway/json з використанням методу POST.

Запит повинен мати наступну структуру:

 

-        HTTP header

Authorization: Bearer <<em>access_token_value>

 

-        тіло запиту

       { "actionName": "get_kor",

         "data": {

                   "startPos": 0,

                   "MaxCount": 10,

                   "YEAROPERS": [2019,2018]

                     }

       }

 

де

"startPos" - номер позиції з 0, з якої віддається список, обов'язковий параметр;

"maxCount" - максимальна кількість елементів списку, maxCount<=100, обов'язковий параметр;

"YEAROPERS" - фільтр по роках, не обов'язковий параметр .

 

Відповідь, що отримується на запит на отримання показників розрахунків з бюджетом з інтегрованих карток платника податків, має наступний вигляд:

 

HTTP 200

Content-Type: application / json; charset = utf-8

{

"HandlerStatus": 0, "message": "Ok", "elapsedTimeMs": 61, "data":

{

"Count": 1, "list": [{

  "BUD_ACCOUNT": 31416698026011, "C_RAJ": 59, "C_REG": 26, "HEAD_TIN": 1010101017, "KOD_RECIPIENT": 37995466, "MFO": 899998, "NAME_PLATEJ": "Єдиний податок з юридичний осiб ", " NAME_RECIPIENT ":" УПРАВЛІННЯ ДЕРЖАВНОЇ КАЗНАЧЕЙСЬКОЇ СЛУЖБИ  УКРАЇНИ У Шевченківському РАЙОНІ м.Києва "," NARAH_0 ": 0," NEDOIM_0 ": 0," PENIA_0 ": 0

," PEREPL_0 ": 0.04," POVBD_0 ": 1085, "ROW_NUM": 1, "SHOT": 18050300, "SPLBD_0": 1085, "ST": 0, "STI_NAME": "ГУ ДФС У м.Києві (ШЕВЧЕНКІВСЬКИЙ Р-Н м.Києва)", "TSTMP ":" 2019-05-27T04: 01: 29Z "," VB ": 50," YEAROPER ": 2019}]

}

}

де

"Count"- загальна кількість рядків даних, що задовольняють запиту;

"list" - рядки даних з наступними елементами:

-        "BUD_ACCOUNT" – бюджетний рахунок по обліку платежів;

-        "C_RAJ" – код адміністративного району, за яким обліковується платіж;

-        "C_REG" – код області;

-        "HEAD_TIN" – код ЄДРПОУ / номер РНОКПП платника податків;

-        "KOD_RECIPIENT" - код ЄДРПОУ фінансової установи, отримувача платежів до бюджету;

-        "MFO" – код МФО фінансової установи, отримувача платежів до бюджету;

-        "NAME_PLATEJ" – назва податку;

-        " NAME_RECIPIENT" – назва фінансової установи, отримувача платежів до бюджету, грн;

-        " NARAH_0 " – нарахована сума податку за даними інтегрованої картки платника, грн;

-        " NEDOIM_0 " – сума податкового боргу за даними інтегрованої картки платника, грн;

-        " PENIA_0 " – нарахована сума пені за даними інтегрованої картки платника, грн;

-        " PEREPL_0 " – сума переплати за даними інтегрованої картки платника, грн;

-        " POVBD_0 " – повернута з бюджету сума податків за даними інтегрованої картки платника, грн;

-        "ROW_NUM" – номер рядка даних;

-        "SHOT" – код бюджетної класифікації платежу до бюджету;

-        "SPLBD_0" – сплачена до бюджету сума податків за даними інтегрованої картки платника, грн;

-        "ST" – стаття інтегрованої картки платника;

-        "STI_NAME" – назва органу ДПС за місцем обліку платника податків;

-        "TSTMP " – час розрахунку показників;

-        " VB " – код виду бюджету;

-        " YEAROPER " – операційний рік.

 

4. Помилки

 

4.1. Помилки отримання токену (URL https://api.tax.gov.ua/gateway/get_token)

 

Помилка видається в разі неправильного запиту на отримання токену.

 

Формат відповіді - Content-Type: application / json; charset = utf-8

HTTP status: 400 message: { "error": "invalid_request", "error_description": "Authentication request is invalid."}

 

4.2. Помилки робочого запиту (URL https://api.tax.gov.ua/ gateway/json)

 

4.2.1. Помилки авторизації

Формат відповіді - Content-Type: application / json; charset = utf-8

HTTP status: 401 message: { "handlerStatus": 401, "message": "Token was invalid or missing.", "ElapsedTimeMs": 0, "data": {}}

 

4.2.2. Помилки сервісу, викликані неправильними вхідними даними або внутрішніми помилками

 

HTTP status: 500 message: { "handlerStatus": 500, "message": "<<em>message_value> "," elapsedTimeMs ": 0," data ": {}}

 

де "<<em>message_value> "- зміст повідомлення про помилку

 

 

4.2.3. Інші помилки

 

HTTP status: 500 Internal server error - внутрішня помилка сервісу

HTTP status: 502 Bad Gateway - помилка проксі під’єднання до сервісу