Page tree
Skip to end of metadata
Go to start of metadata

Для перегляду параметрів API перейдіть за посиланням:

http://api.spending.gov.ua/api/swagger-ui.html

У випадаючому списку оберіть версію 2.0:

При роботі з API. Version 2.0 до трансакцій використовується формат дати РРРР-ММ-ДД (як для запиту, так і для відповіді) ISO 8601


Список методів API:


Повертає дату останнього завантаження даних до БД API:

Request URL: http://api.spending.gov.ua/api/v2/api/transactions/lastload

Method: GET

Content type: application/json


Перевірка доступності API:

Request URL: http://api.spending.gov.ua/api/v2/api/transactions/ping

Method: GET

Content type: application/json


Повертає ТОП-100 трансакцій по управлінню ДКСУ:

Request URL: http://api.spending.gov.ua/api/v2/api/transactions/top100

Method: GET

Response Content type:

application/json (для відповіді в форматі json)

application/octet-stream (для відповіді в форматі csv)


Повертає дані по трансакціях:

Request params:

Приклад 1: Пошук трансакцій, оприлюднених за попередній день:



Приклад 2: Пошук за Кодом платника та Періодом (період не більше ніж 92 дня):


Приклад 3: Пошук за Кодом отримувача та Періодом (період не більше ніж 92 дня):


Приклад 4: Пошук за Джерелом ПАТ "Укрзалізниця" та Кодом платника (ПАТ "Укрзалізниця" та її філії) та Періодом (період не більше ніж 92 дня):

Request URL: http://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) — джерело даних

}


ПРИКЛАД:

API REQUEST (Request params)API RESPONSE

"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 — сервер зрозумів запит, але він відмовляється його виконувати через обмеження в доступі для клієнта до зазначеного ресурсу. Детальніше тут.

404 Not Found —найпоширеніша помилка при користуванні Інтернетом, основна причина - помилка в написанні адреси Web-сторінки. Детальніше тут.

  

  • No labels