Для перегляду параметрів API перейдіть за посиланням:
http Table of Contents
Посилання на Swagger
https://api.spending.gov.ua/api/swagger-ui.html
У випадаючому списку оберіть версію 2.0:
При роботі з API. Version 2.0 до трансакцій використовується формат дати РРРР-ММ-ДД (як для запиту, так і для відповіді) ISO 8601
Список методів API:
Повертає дату останнього завантаження даних до БД API:
Request URL: http:html#/Transactions
Список доступних енд-поінтів
Метод | Енд-поінт | Опис |
---|---|---|
Get | https://api.spending.gov.ua/api/v2/api/transactions/ |
...
Method: GET
Content type: application/json
Перевірка доступності API:
...
ping | Перевірка доступності сервісу |
Get | https://api.spending.gov.ua/api/v2/api/transactions/ |
...
Method: GET
Content type: application/json
...
top100 | Отримати Топ-100 трансакцій |
...
...
за поточний місяць | |
Get | https://api.spending.gov.ua/api/v2/api/transactions/ |
...
Method: GET
Response Content type:
application/json (для відповіді в форматі json)
application/octet-stream (для відповіді в форматі csv)
Повертає дані по трансакціях:
Request params:
Приклад 1: Пошук трансакцій, оприлюднених за попередній день:
Приклад 2: Пошук за Кодом платника та Періодом (період не більше ніж 92 дня):
Приклад 3: Пошук за Кодом отримувача та Періодом (період не більше ніж 92 дня):
Приклад 4: Пошук за Джерелом ПАТ "Укрзалізниця" та Кодом платника (ПАТ "Укрзалізниця" та її філії) та Періодом (період не більше ніж 92 дня):
...
lastload | Отримати дату останнього завантаження |
Get | https://api.spending.gov.ua/api/v2/api/transactions/ |
...
Method: GET
Response Content type:
application/json (для відповіді в форматі json)
application/octet-stream (для відповіді в форматі csv)
API RESPONSE
{
id (integer) — унікальний ідентифікатор,
doc_vob (string) — код розрахункового документа,
doc_vob_name (string) — тип розрахункового документа,
doc_number (string) — номер розрахункового документа,
doc_date (string) — дата складання (формат: рррр-мм-дд),
doc_v_date (string) — дата валютування (формат: рррр-мм-дд),
trans_date (string) — дата оплати (формат: рррр-мм-дд),
amount (string) — сума,
amount_cop (integer) — сума в копійках,
currency (string) —валюта,
payer_edrpou (string) — код платника,
payer_name (string) — найменування платника,
payer_account (string) — рахунок платника,
payer_mfo (string) — код банку платника,
payer_bank (string) — найменування банку платника,
recipt_edrpou (string) — код отримувача,
recipt_name (string) — найменування отримувача,
recipt_account (string) — рахунок отримувача,
recipt_bank (string) — найменування банку отримувача,
recipt_mfo (string) — код банку отримувача,
payment_details (string) — призначення платежу,
doc_add_attr (string) — податковий реквізит,
region_id (integer) — регіон,
payment_type (string) — тип платіжної системи,
payment_data (string) — додаткові дані визначеного типу платіжної системи,
source_id (integer) — ідентифікатор джерела даних,
source_name (string) — джерело даних
}
ПРИКЛАД:
...
"payers_edrpous":"",
"recipt_edrpous":"40075815",
"regions": "",
"source": "",
"startdate" : "2017-09-12",
"enddate" :"".
...
{
"id": 83538542,
"doc_vob": "1",
"doc_vob_name": null,
"doc_number": "5629",
"doc_date": "2018-04-21",
"doc_v_date": "2018-04-23",
"trans_date": "2018-04-24",
"amount": 196915.18,
"amount_cop": 19691518,
"currency": "UAH",
"payer_edrpou": "34999049",
"payer_name": "Святошинський РВДВС м. Київ",
"payer_account": "37316001004450",
"payer_mfo": "820172",
"payer_bank": "Держказначейська служба України,м.Київ",
"recipt_edrpou": "40075815",
"recipt_name": "РФ \"Пiвденно-Захiдна залiзниця\"",
"recipt_account": "26005300148927",
"recipt_bank": "ФГОЛОВНЕ УПРАВЛІННЯ ПО АТОЩАД М.КИЇВ",
"recipt_mfo": "322669",
"payment_details": "Перерах.боргу ТОВ \"Гудтайм\"(xxxx),згiдно ВД № 910/xxxx/16 вiд 01.11.xxxx;розп.держ/вик. № xxxx вiд 20.04.xxxx. Без ПДВ.",
"doc_add_attr": null,
"region_id": 28,
"payment_type": "nsep",
"payment_data": null,
"source_id": 2,
"source_name": "ДКСУ"
}
200 OK — успішний запит. Якщо клієнтом були запитані будь-які дані, то вони знаходяться в заголовку і / або тексті повідомлення. З'явився в HTTP / 1.0.
201 Created — в результаті успішного виконання запиту був створений новий ресурс. Детальніше тут.
401 Unauthorized — для доступу до запитуваного ресурсу потрібно аутентифікація. Детальніше тут.
403 Forbidden — сервер зрозумів запит, але він відмовляється його виконувати через обмеження в доступі для клієнта до зазначеного ресурсу. Детальніше тут.
...
?{params} | Отримати Реєстр трансакцій |
Структура трансакції
# | Поле | Тип даних | Опис | Приклад | JSON відповідь |
---|---|---|---|---|---|
1 | id | Ціле число | унікальний ідентифікатор трансакції в Системі | 256103375 | { "id": 256103375, "doc_vob": "6", "doc_vob_name": null, "doc_number": "8139/903", "doc_date": "2023-05-10", "doc_v_date": "2023-05-10", "trans_date": "2023-05-10", "amount": 19415413165.34, "amount_cop": 1941541316534, "currency": "UAH", "payer_edrpou": "37567646", "payer_name": "Виділення асигнувань по ЗФ", "payer_account": "UA618201720000042314000000000", "payer_mfo": null, "payer_bank": null, "recipt_edrpou": "00013480", "recipt_name": "Мінфін", "recipt_account": "UA608201720343340023000000141", "recipt_mfo": null, "recipt_bank": null, "payment_details": "Спл.дох.по ОВДП.Розп.МФУ вчд 27.04.xxxx Nxxxx", "doc_add_attr": null, "region_id": 28, "payment_type": "nsep", "payment_data": null, "source_id": 2, "source_name": "ДКСУ", "kekv": 2410, "kpk": "3511350", "contractId": null, "contractNumber": null, "budgetCode": "9900000000" } |
2 | doc_vob | Текст | код розрахункового документа | "1" | |
3 | doc_vob_name | Текст | назва коду розрахункового документа | "платіжне доручення" | |
4 | doc_number | Текст | номер розрахункового документа, до 35 знаків | "8139/903" | |
5 | doc_date | Текст | дата складання розрахункового документа у форматі РРРР-ММ-ДД | "2023-05-10" | |
6 | doc_v_date | Текст | дата валютування документа у форматі РРРР-ММ-ДД | "2023-05-10" | |
7 | trans_date | Текст | дата оплати у форматі РРРР-ММ-ДД | "2023-05-10" | |
8 | amount | Число з плаваючою крапкою | сума оплати в гривнях з копійками, роздільник крапка | 19415413165.34 | |
9 | amount_cop | Ціле число | сума оплати в копійках | 1941541316534 | |
10 | currency | Текст | літеральний код валюти (довідник) | "UAH" | |
11 | payer_edrpou | Текст | код ЄДРПОУ платника, 8 знаків | "37567646" | |
12 | payer_name | Текст | найменування платника, до 140 знаків | "Виділення асигнувань по ЗФ" | |
13 | payer_account | Текст | рахунок платника (IBAN), до 29 знаків | "UA618201720000042314000000000" | |
14 | payer_mfo | Текст | код банку платника (опціонально), 6 знаків | "820172" | |
15 | payer_bank | Текст | найменування банку платника (опціонально), до 140 знаків | "Державна казначейська служба України" | |
16 | recipt_edrpou | Текст | код ЄДРПОУ отримувача, 8 або 10 знаків | для юридичної особи: "00013480" для фізичної особи: "хххххххххх" | |
17 | recipt_name | Текст | найменування отримувача, до 140 знаків | "Мінфін" | |
18 | recipt_account | Текст | рахунок отримувача (IBAN), до 29 знаків | "UA608201720343340023000000141" | |
19 | recipt_mfo | Текст | код банку отримувача (опціонально), 6 знаків | "820172" | |
20 | recipt_bank | Текст | найменування банку отримувача (опціонально), до 140 знаків | "Державна казначейська служба України" | |
21 | payment_details | Текст | призначення платежу, до 420 знаків | "Спл.дох.по ОВДП.Розп.МФУ вчд 27.04.xxxx Nxxxx" | |
22 | doc_add_attr | Текст | додатковий реквізит, до 80 знаків (опціонально) | null | |
23 | region_id | Ціле число | код регіону (довідник) | 28 | |
24 | payment_type | Текст | тип платіжної системи | "nsep" | |
25 | payment_data | Текст | додаткові дані для типу платіжної системи (опціонально) | null | |
26 | source_id | Ціле число | унікальний ідентифікатор джерела даних в Системі | 2 | |
27 | source_name | Текст | найменування джерела даних, до 140 знаків | "ДКСУ" | |
28 | kekv | Ціле число | код економічної класифікації видатків, 4 знаки (довідник) | 2410 | |
29 | kpk | Текст | код програмної класифікації видатків та кредитування, до 7 знаків (довідник ДБ, довідник МБ) | "3511350" | |
30 | contractId | Текст | унікальний ідентифікатор договору про закупівлю в системі Prozorro, 32 знаки | "64e949275b3749d5b6b82917b01249eb" | |
31 | contractNumber | Текст | унікальний ідентифікатор закупівлі в системі Prozorro, 22 знаки | "UA-2020-09-10-005249-b" | |
32 | budgetCode | Текст | код бюджету, 10 знаків (довідник) | "9900000000" |
Параметри запиту на отримання Топ-100 трансакцій за поточний місяць
https://api.spending.gov.ua/api/v2/api/transactions/top100
отримати файлом у форматі .CSV
curl -X GET "https://api.spending.gov.ua/api/v2/api/transactions/top100" -H "accept: application/octet-stream"
Параметр | Тип даних | Обов’язковість | Опис | Приклад |
---|---|---|---|---|
region | Ціле число | Ні | код регіону (довідник), масив елементів | https://api.spending.gov.ua/api/v2/api/transactions/top100?region=1®ion=5®ion=7 |
Параметри запиту на отримання Реєстру трансакцій за 1 день
https://api.spending.gov.ua/api/v2/api/transactions/?{params}
отримати файлом у форматі .CSV
curl -X GET "https://api.spending.gov.ua/api/v2/api/transactions/?startdate=2023-06-10&enddate=2023-06-10" -H "accept: application/octet-stream"
Параметр | Тип даних | Обов’язковість | Опис | Приклад |
---|---|---|---|---|
startdate | Текст | Так | дата оплати у форматі РРРР-ММ-ДД, має дорівнювати endate | https://api.spending.gov.ua/api/v2/api/transactions/?startdate=2023-06-10&enddate=2023-06-10 |
enddate | Текст | Так | дата оплати у форматі РРРР-ММ-ДД, має дорівнювати startdate |
Параметри запиту на отримання Реєстру трансакцій за період
https://api.spending.gov.ua/api/v2/api/transactions/?{params}
отримати файлом у форматі .CSV
curl -X GET "https://api.spending.gov.ua/api/v2/api/transactions/?{params}" -H "accept: application/octet-stream"
Параметр | Тип даних | Обов’язковість | Опис | Приклад |
---|---|---|---|---|
startdate | Текст | Так | дата оплати у форматі РРРР-ММ-ДД, період не більше 92 днів | https://api.spending.gov.ua/api/v2/api/transactions/? https://api.spending.gov.ua/api/v2/api/transactions/? https://api.spending.gov.ua/api/v2/api/transactions/? https://api.spending.gov.ua/api/v2/api/transactions/? |
enddate | Текст | Так | дата оплати у форматі РРРР-ММ-ДД, період не більше 92 днів | |
payers_edrpous | Текст | Так, якщо startdate != enddate та recipt_edrpous == NULL | код ЄДРПОУ платника, 8 знаків, масив значень | |
recipt_edrpous | Текст | Так, якщо startdate != enddate та payers_edrpous == NULL | код ЄДРПОУ отримувача, 8 знаків, масив значень | |
sumFrom | Число з плаваючою крапкою | Ні | сума оплати Від в гривнях з копійками, роздільник крапка | |
sumTo | Число з плаваючою крапкою | Ні | сума оплати До в гривнях з копійками, роздільник крапка | |
regions | Ціле число | Ні | код регіону (довідник), масив елементів |