Опис 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 Передається рік, за який необхідно отримати дані

Авторизація – в header запиту 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"...}]}

Облікові дані платника

Розглянемо приклад запиту до API для отримання інформації щодо Облікові дані платника:

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/payer_card

Метод (Request Method): GET

Параметри запиту (Query String Parameters Payload): відсутні

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту до API для отримання облікових даних платника:

curl 'https://cabinet.tax.gov.ua/ws/public_api/payer_card' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь складається з блоків даних

  • 1 Ідентифікаційні дані
  • 2 Реєстраційні дані
  • 3 Відомості про керівників
  • 4 Присвоєння ознаки неприбутковості
  • 5 Дані про реєстрацію платником ПДВ
  • 6 Дані про реєстрацію платником єдиного податку
  • 7 Дані про реєстрацію платником ЄСВ
  • 8 Відомості з Реєстру осіб, які здійснюють операції з товаром
  • 9 Відомості про РРО
  • 10 Інформація про книги ОРО
  • 11 Відомості про ПРРО
  • 12 Відомості про об’єкти оподаткування
  • 13 Інформація про неосновні місця обліку
  • 14 Дані про банківські рахунки
  • 15 Дані про укладені договори згідно з журналом договорів
  • 16 Види діяльності

Наприклад Ідентифікаційні дані :

[
  {
  "idGroup": 1,
  "title": "Ідентифікаційні дані",
  "type": 1,
  "headers": {
    "TIN": "Податковий номер",
    "FULL_NAME": "Повне найменування",
    "NAME": "Скорочене найменування"
  },
  "values": {
    "TIN": "34554355",
    "FULL_NAME": "ПрАТ \"Літак\"",
    "NAME": "ПрАТ \"Літак\""
  },
  "listValues": null
    },
  ...
  ]
Параметри відповіді
Назва Опис
headers Опис полів
values Значення
listValues Значення в табличному вигляді

Запит окремого блоку облікових даних

Розглянемо приклад запиту до API для отримання інформації щодо Дані про банківські рахунки:

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/payer_card/14?page=0&size=20

Метод (Request Method): GET

Параметри запиту (Query String Parameters Payload):

Параметри запиту
Назва Обов’язковий Опис
14 true Група
page true Сторінка
size false Розмір

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту до API для отримання облікових даних платника:

curl 'https://cabinet.tax.gov.ua/ws/public_api/payer_card/14?page=0&size=20' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Приклад відповіді API :

{
  "idGroup": 14,
  "page": 0,
  "values": [
    {
      "MFO": 300001,
      "MFO_NAME": "ОПЕРАЦІЙНЕ УПРАВЛІННЯ НБУ, М.КИЇВ",
      "CLIENT_COUNT": "UA03300001000000000000000001",
      "CODE_CURRENCY_NAME": "980 УКРАЇНСЬКА ГРИВНЯ",
      "DATE_CREATE_COUNT": "26.07.2019",
      "DATE_REGIST": "04.08.2019"
    },
    ....

Перегляд звітності

(детальніше в розділі Перегляд звітності)

Розглянемо приклад запиту до API для отримання інформації щодо Перегляд звітності:

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/reg_doc/list?periodYear=2020&periodMonth=8

Метод (Request Method): GET

Параметри запиту (Query String Parameters Payload):

Параметри запиту
Назва Обов’язковий Опис
periodYear true Передається рік, за який необхідно отримати дані
periodMonth true Передається місяць, за який необхідно отримати дані

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/reg_doc/list?periodYear=2020&periodMonth=8' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Приклад відповіді API на запит :

{
"content": [
  {
    "codRegdoc": 999950000008140,
    "codRegdocRef": null,
    "csti": 2705,
    "tin": 34554355,
    "doc": "J0200120",
    "cdocSub": "001",
    "cdocVer": 20,
    "cdocCnt": 1,
    "cdocType": 0,
    "periodMonth": 8,
    "periodType": 1,
    "periodYear": 2020,
    "dterm": "2020-07-20 00:00:00",
    "dget": "2020-09-21 22:03:07",
    "nreg": 37374323,
    "flags": 8388609,
    "flagName": "Прийнято в режимі On-line,\n            дозволено тільки перегляд",
    "docName": "Податкова декларацiя з податку на додану вартiсть",
    "cntAppendix": 0,
    "period": "Серпень 2020",
    "cdoc": "J02",
    "cDoc": "J02"
  },
  ........
  ],
    "number": 0,
    "size": 20,
    "totalElements": 7,
    "pageable": {
      "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
      },
      "offset": 0,
      "pageNumber": 0,
      "pageSize": 20,
      "unpaged": false,
      "paged": true
    },
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "totalPages": 1,
    "first": true,
    "last": true,
    "empty": false,
    "numberOfElements": 7
  }
Параметри відповіді
Назва Опис
codRegdoc ID документа
csti ID ДПС
dget Дата
nreg Номер
flagName Статус
docName Назва
cntAppendix Наявність додатків

Запит документа з додатками

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/reg_doc/docs/2020/999950000008140

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
2020 true Передається рік, за який необхідно отримати дані
999950000008140 true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/reg_doc/docs/2020/150670000009251' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Приклад відповіді API на запит :

[
  {
    "codRegdoc": 150670000009251,
    "codRegdocRef": null,
    "csti": 1506,
    "tin": 34554355,
    "doc": "J1317102",
    "cdocSub": "171",
    "cdocVer": 2,
    "cdocCnt": 12,
    "cdocType": 0,
    "periodMonth": 8,
    "periodType": 1,
    "periodYear": 2020,
    "dterm": "2020-08-31 00:00:00",
    "dget": "2020-07-30 14:43:15",
    "nreg": 275,
    "flags": 8388609,
    "flagName": "Прийнято в режимі On-line,\n            дозволено тільки перегляд",
    "docName": "Заява на включення до реєстру центрiв сервiсного обслуговування реєстраторiв розрахункових операцiй за ф. № 1-РЦСО",
    "cntAppendix": 1,
    "period": "Серпень 2020",
    "cdoc": "J13",
    "cDoc": "J13"
  },
  {
    "codRegdoc": 150690000009251,
    "codRegdocRef": 150670000009251,
    "csti": 1506,
    "tin": 34554355,
    "doc": "J1499201",
    "cdocSub": "992",
    "cdocVer": 1,
    "cdocCnt": 1,
    "cdocType": 1,
    "periodMonth": 7,
    "periodType": 1,
    "periodYear": 2020,
    "dterm": null,
    "dget": "2020-07-30 15:20:34",
    "nreg": 275,
    "flags": 32769,
    "flagName": "дозволено тільки перегляд",
    "docName": "Квитанцiя № 2",
    "cntAppendix": 0,
    "period": "Липень 2020",
    "cdoc": "J14",
    "cDoc": "J14"
  }
]
Параметри відповіді
Назва Опис
codRegdoc ID документа
codRegdocRef ID батьківського документу
csti ID ДПС
dget Дата
nreg Номер
flagName Статус
docName Назва
cntAppendix Наявність додатків

Запит PDF документа

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/reg_doc/doc/2020/999950000008140/pdf

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
2020 true Передається рік, за який необхідно отримати дані
999950000008140 true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/reg_doc/doc/2020/999950000008140/pdf' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь документ в PDF форматі.

Запит XML документа

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/reg_doc/doc/{year}/{id}/xml

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
{year} true Передається рік, за який необхідно отримати дані
{id} true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/ws/public_api/reg_doc/doc/2019/231140000018730/xml' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь документ в XML форматі.

Вхідні/вихідні документи та листування з ДПС

(детальніше в розділі Вхідні/вихідні документи)

Розглянемо приклад запиту до API для отримання інформації щодо Вхідні документи:

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/post/incoming?page=0

Метод (Request Method): GET

Параметри запиту (Query String Parameters Payload):

Параметри запиту
Назва Обов’язковий Опис
page false Сторінка

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/post/incoming?page=0' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Приклад відповіді API на запит :

   {
"content": [
  {
    "id": 231140000018730,
    "idPar": null,
    "idContent": null,
    "cdoc": "J1499202",
    "text": null,
    "tin": 34554355,
    "csti": 2311,
    "dateIn": "2021-05-05 16:11:32",
    "dateRead": null,
    "isRead": 0,
    "isDel": 0,
    "operDate": "2021-05-05 16:11:32",
    "periodYear": 2019,
    "idAppl": 8000,
    "codRegdocRef": 231120000018730,
    "status": -1,
    "params": null,
    "name": "Квитанцiя № 2[J1499202]"
  },
  ........
    ],
    "pageable": {
      "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
      },
      "offset": 0,
      "pageSize": 10,
      "pageNumber": 0,
      "paged": true,
      "unpaged": false
    },
    "totalElements": 1175,
    "last": false,
    "totalPages": 118,
    "size": 10,
    "number": 0,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "numberOfElements": 10,
    "first": true,
    "empty": false
  }
Параметри відповіді
Назва Опис
id ID документа
periodYear Рік
text Текст
status Статус
name Назва

Запит PDF документа

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/incoming/{year}/{id}/pdf

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
{year} true Передається рік, за який необхідно отримати дані
{id} true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/ws/public_api/post/incoming/2019/231140000018730/pdf' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь документ в PDF форматі.

Запит XML документа

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/incoming/{year}/{id}/xml

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
{year} true Передається рік, за який необхідно отримати дані
{id} true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/ws/public_api/post/incoming/2019/231140000018730/xml' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь документ в XML форматі.

Розглянемо приклад запиту до API для отримання інформації щодо Вихідні документи та листування з ДПС:

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/post/sent?page=0

Метод (Request Method): GET

Параметри запиту (Query String Parameters Payload):

Параметри запиту
Назва Обов’язковий Опис
page false Сторінка

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/post/sent?page=0' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Приклад відповіді API на запит :

   {
"content": [
      {
    "id": 150670000011728,
    "idPar": null,
    "idContent": null,
    "cdoc": "J1203301",
    "name": "15060034554355J1203301100000000110320211506.XML",
    "text": null,
    "tin": 34554355,
    "dateOut": "2021-03-10 14:11:48",
    "isDel": 0,
    "operDate": "2021-03-10 14:11:48",
    "periodYear": 2021,
    "flag": 4,
    "csti": 1506,
    "docName": "Розрахунок коригування акцизної накладної форми 'П'"
  },
  ........
    ],
    "pageable": {
      "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
      },
      "offset": 0,
      "pageSize": 10,
      "pageNumber": 0,
      "paged": true,
      "unpaged": false
    },
    "totalElements": 1175,
    "last": false,
    "totalPages": 118,
    "size": 10,
    "number": 0,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "numberOfElements": 10,
    "first": true,
    "empty": false
  }
Параметри відповіді
Назва Опис
id ID документа
periodYear Рік
text Файл
status Статус
dateOut Дата
docName Назва

Запит PDF документа

Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/public_api/post/sent/{year}/{id}/pdf

Метод (Request Method): GET

Параметри запиту:

Параметри запиту
Назва Обов’язковий Опис
{year} true Передається рік, за який необхідно отримати дані
{id} true ID документа

Авторизація – в header запиту Authorization ЄДРПОУ/РНОКПП підписаний внутрішнім підписом з додаванням сертифікату в BASE64

Приклад запиту :

curl 'https://cabinet.tax.gov.ua/ws/public_api/ws/public_api/post/sent/2021/150670000011728/pdf' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: MIIStwYJKoZIhvcNAQ...
    -H 'Accept: application/json'

Відповідь документ в PDF форматі.