Опис API доступу до реєстрів відкритої частини ЕК¶
Електонний кабінет надає у відкритій частині в меню Реєстри можливість здійснювати пошук та отримувати дані наступних відкритих реєстрів:
- Дані про взяття на облік платників податків
- Реєстр страхувальників
- Реєстр платників єдиного податку
- Реєстр платників акцизного податку з реалізації пального та спирту етилового
- Реєстр осіб, які здійснюють операції з товарами
- Реєстр довідок про відсутність заборгованості
- Єдиний реєстр індивідуальних податкових консультацій
- Реєстр отримувачів бюджетної дотації
- Реєстр неприбуткових установ та організацій
- Інформація про РРО
- Інформація про книги ОРО
- Реєстр платників ПДВ
- Реєстр заяв про повернення суми бюджетного відшкодування
- Система обліку публічної інформації
- Реєстр ПН / РК, реєстрація яких зупинена
- Заяви про розстрочення, відстрочення грошового зобов'язання чи податкового боргу
- Реєстр фіскальних чеків
- Реєстр екземплярів РРО
- Реєстр ЦСО
Також доступ до зазначених реєстрів можна отримати за допомогою АРІ доступу до реєстрів відкритої частини ЕК. API надає можливість автоматизованого доступу до реєстрів в двох режимах:
1. Отримання повного реєстру у вигляді файлу формату CSV:¶
Реєстр платників єдиного податку https://cabinet.tax.gov.ua/ws/api/public/registers/export/reestr_edpod https://cabinet.tax.gov.ua/ws/api/public/registers/export/kilk_edpod
Реєстр платників акцизного податку з реалізації пального та спирту етилового https://cabinet.tax.gov.ua/ws/api/public/registers/export/reestr_searpse
Реєстр осіб, які здійснюють операції з товарами https://cabinet.tax.gov.ua/ws/api/public/registers/export/reestr_operac_z_tov
Реєстр неприбуткових установ та організацій https://cabinet.tax.gov.ua/ws/api/public/registers/export/reestr_nuo
Реєстр платників ПДВ https://cabinet.tax.gov.ua/ws/api/public/registers/export/pdv
Реєстр ЦСО https://cabinet.tax.gov.ua/ws/api/public/registers/export/rro_cso
Приклад використання API для отримання повного реєстру платників ПДВ: :
wget https://cabinet.tax.gov.ua/ws/api/public/registers/export/pdv
2. Взаємодія через програмний інтерфейс REST АРІ¶
Розташування у мережі Internet:
Вузол: https://cabinet.tax.gov.ua
Основной шлях: https://cabinet.tax.gov.ua/ws/api/public/registers/
Параметри запиту на доступ до реєстрів та відповідь клієнту передаються у вигляді стандартного формату JSON
Авторизаційний токен користувачі АРІ доступу до реєстрів відкритої частини Електронного кабінету (далі – АРІ реєстрів) створюють самостійно у вкладці «Токени відкритої частини» меню "Налаштування" приватної частини Електронного кабінету (https://cabinet.tax.gov.ua/user/settings).
Звертаємо увагу, що за умови використання отриманого токену більше ніж у 1000 запитах за один день, цей токен буде автоматично скасовано. Для поновлення можливості направляти запити через АРІ реєстрів необхідно згенерувати новий авторизаційний токен.
Розглянемо приклад запиту до API для пошуку платників у
Реєстр платників ПДВ¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/pdv_act/list
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| kodPdvList | false | Передається список номерів платників ПДВ (до 10) |
| tinList | false | Передається список кодів ЄДРПОУ (до 10) |
| name | false | Передається назва платника ПДВ |
| token | true | Передається авторизаційний токен |
Параметри запиту
Приклад запиту до API для пошуку платників в реєстрі платників ПДВ: :
curl -d '{"kodPdvList":null,"tinList":"34554355 34554357","name":null,"token":"03AOLTBLRIFo9xivFXYOrFqaLL6g0HKv"}'
-H "Content-Type: application/json" -X POST 'https://cabinet.tax.gov.ua/ws/api/public/registers/pdv_act/list'
| Назва | Опис |
|---|---|
| kodPdv | Номер платника ПДВ |
| tin | ЄДРПОУ |
| datReestr | Дата реєстрації платником ПДВ |
| datAnul | Дата скасування реєстрації платником ПДВ |
| kodPdvs | Номер платника ПДВ (символьний) |
| danulSg | Дата анулювання свідоцтва платника ПДВ |
| kodAnul | Причина скасування реєстрації платнком ПДВ |
| kodPid | Підстава скасування реєстрації платнком ПДВ |
Параметри відповіді
Приклад відповіді API на запит пошуку платників в реєстрі платників ПДВ: :
[{"kodPdv":123456789015,"tin":34554357,"name":"ТОВ \"Літак-2\"","datReestr":"2016-01-11 00:00:00","datAnul":"2016-10-14 00:00:00","kodPdvs":"123456789015","datTerm":null,"dreestrSg":null,"datSvd":"2016-01-11 00:00:00","danulSg":null,"dpdvSg":null,"kodAnul":"iншi випадки, передбаченi законодавством","kodPid":"АНУЛЬОВАНО ЗА САМОСТIЙНИМ РIШЕННЯМ КОНТРОЛЮЮЧОГО ОРГАНУ"},{"kodPdv":123456789057,"tin":34554357,"name":"ТОВ \"Літак-2\"","datReestr":"2017-01-01 00:00:00","datAnul":null,"kodPdvs":"123456789057","datTerm":null,"dreestrSg":null,"datSvd":"2017-01-01 00:00:00","danulSg":null,"dpdvSg":null,"kodAnul":null,"kodPid":"ЗАРЕЄСТРОВАНО"},{"kodPdv":123456789017,"tin":34554359,"name":"ТОВ \"Літак-3\"","datReestr":"2016-01-11 00:00:00","datAnul":null,"kodPdvs":"123456789017","datTerm":null,"dreestrSg":null,"datSvd":"2016-01-11 00:00:00","danulSg":null,"dpdvSg":null,"kodAnul":null,"kodPid":"ЗАРЕЄСТРОВАНО"}]
Дані про взяття на облік платників податків¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/registration
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
| Назва | Опис |
|---|---|
| FULL_NAME | Назва |
| TIN_S | ЄДРПОУ |
| ADRESS | Юридична адреса |
| D_REG_STI | Дата реєстрації в органах ДПС |
| N_REG_STI | Номер реєстрації в органах ДПС |
| C_STI_MAIN_NAME | Назва органу ДПС де зареєстрований платник |
| VED_LIC | Ознака зовнішньоекономічної діяльності |
| FACE_MODE | Тип платника |
| C_STAN | Стан платника |
Параметри відповіді
Приклад відповіді API: :
{"FULL_NAME":"ПрАТ \"Літак\"","TIN_S":"34554355","ADRESS":"УКРАЇНА, 88745, ЧЕРКАСЬКА ОБЛАСТЬ, ЖАШКІВСЬКИЙ РАЙОН Р-Н, М.ЖАШКІВ, ВУЛ. ЛЕНІНА, БУД. 22, КВ (ОФІС) 57","D_REG_STI":"01.01.2011","N_REG_STI":"555","C_STI_MAIN_NAME":"2311, ГОЛОВНЕ УПРАВЛІННЯ ДПС У ЧЕРКАСЬКІЙ ОБЛАСТІ, УМАНСЬКЕ УПРАВЛІННЯ, ЖАШКІВСЬКА ДПІ(ЖАШКІВСЬКИЙ Р-Н)","VED_LIC":null,"FACE_MODE":1,"C_STAN":3,"D_ZAKR_STI":null,"C_KIND":230,"C_CLOSE":3}
Реєстр страхувальників¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/ev
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tin | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Приклад відповіді API: :
{"TIN_S":"34554355","FULL_NAME":"ПрАТ \"Літак\"","DATE_ACC_ERS":"26.06.1995","ID_ERS":"10-30-03-0395","C_STI_MAIN_NAME":"2311, ГУ ДПС У ЧЕРКАСЬКІЙ ОБЛАСТІ (ЖАШКІВСЬКИЙ Р-Н)","KVED":"23.13","RCLASS":"46","DATE_DCC_ERS":null,"IS_PAYER":null}
Реєстр платників акцизного податку з реалізації пального та спирту етилового¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/excise
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tin | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| nReg | false | Номер запису в реєстрі |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Приклад відповіді API: :
{"TIN_S":"34554357","FULL_NAME":"ТОВ \"Літак-2\"","DAT_REEST":"01.07.2019","N_REG":-124,"LAST_DATE":"19.06.2019","DAT_ANUL":null,"C_ANUL_NAME":null,"FACE_MODE":1,"OZN_P":"X","OZN_S":null}
Реєстр осіб, які здійснюють операції з товарами¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/cli-zed
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| kodPdv | false | Обліковий номер особи |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр отримувачів бюджетної дотації¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/obd
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| kodPdv | false | Обліковий номер особи |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр неприбуткових установ та організацій¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/non-profit
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tin | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Інформація про РРО¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/rro
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| nFis | false | Передається фіскальний номер РРО |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Інформація про книги ОРО¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/koro
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | false | Передається код ЄДРПОУ |
| name | false | Передається назва платника ПДВ |
| nFis | false | Передається фіскальний номер РРО |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр ПН / РК, реєстрація яких зупинена¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/inv-stopped
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| ipn | true | Передається ІПН |
| num | false | Передається номнер ПН/РК |
| crtDate | false | Передається дата ПН/РК |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр екземплярів РРО¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/rro-instance
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| sn | true | Передається Серійний номер РРО |
| cekka | true | Передається код моделі РРО |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр ЦСО¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api/public/registers/rro-cso
Метод (Request Method): POST
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| tins | true | Передається список кодв ЄДРПОУ |
| cekka | false | Передається код моделі РРО |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Реєстр фіскальних чеків¶
Повний шлях (Request URL): https://cabinet.tax.gov.ua/ws/api_public/rro/chkAll
Метод (Request Method): GET
Параметри запиту (Request Payload):запиту
| Назва | Обов'язковий | Опис |
|---|---|---|
| id | true | Номер чека |
| date | false | Дата (формат YYYY-MM-DD HH:mm:ss) |
| fn | false | Фіскальний номер РРО |
| type | true | 1 - Оригінальний XML, 2 - XML підписаний КЕП, 3 - Документ в текстовому форматі для відображення (UTF-8) |
| token | true | Передається авторизаційний токен |
Параметри запиту
Параметри відповіді (Responce):
Приклад відповіді API: :
{"check":"ICA....","fn":"3000512560","name":null,"addressGo":null,"typeGo":null,"tins":null,"xml":true,"sign":false,"qr":null,"resultCode":null,"resultText":null}