Інспекційні перевірки

У цьому розділі описані запити для роботи з інспекційними перевірками підприємства, а також з їхніми частинами, порушеннями, санкціями й файлами актів та приписів.

Перелік перевірок

GET /api/v1/enterprises/{registry_id}/inspections

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

Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspections?super_type_id=1" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "items": [
      {
        "id": 7001,
        "parent_id": null,
        "super_type_id": 1,
        "super_type_name": "Екологічні",
        "authority_name": "ДЕІ",
        "name": "Перевірка виконання припису щодо усунення порушень.",
        "description_lines": ["Перевірка дотримання природоохоронного законодавства"],
        "address": "Україна, Київська область, місто Київ",
        "region": "Київська область",
        "is_planned": true,
        "status": "Проведено",
        "risk": "Високий",
        "sphere": "Охорона навколишнього природного середовища, раціональне використання, відтворення і охорона природних ресурсів",
        "source": "Інспекційний портал",
        "date_start": "2025-03-10",
        "date_finish": null,
        "date_order_by": "2025-03-01",
        "violations_count": 3,
        "sanctions_count": 1,
        "parts_count": 2,
        "acts_count": 1,
        "orders_count": 1,
        "files_count": 2,
        "links": {
          "details": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-details/7001",
          "violations": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-violations/7001",
          "sanctions": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-sanctions/7001",
          "parts": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-parts/7001",
          "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-files/7001"
        },
        "coordinates": null
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 4,
      "last_page": 1
    }
  },
  "stats": { "..." }
}

Параметри пагінації

page: номер сторінки.

Фільтри

year: рік перевірки.
super_type_id: тип перевірки. Доступні значення можна отримати в запиті Типи інспекційних перевірок.
has_violations: показувати тільки перевірки, де є порушення.
has_sanctions: показувати тільки перевірки, де є санкції.

Поля відповіді

`results.items[]`

id: ідентифікатор перевірки.
parent_id: ідентифікатор батьківської перевірки, якщо цей запис є частиною іншої перевірки. Для основної перевірки повертається null.
super_type_id: ідентифікатор типу інспекційної перевірки верхнього рівня.
super_type_name: назва типу інспекційної перевірки верхнього рівня.
authority_name: орган, який проводив перевірку.
name: назва перевірки.
description_lines[]: короткий опис перевірки у вигляді окремих рядків.
address: адреса об'єкта перевірки.
region: регіон перевірки.
is_planned: ознака планової перевірки.
status: поточний статус перевірки.
risk: рівень ризику, якщо він визначений.
sphere: сфера перевірки.
source: джерело даних.
date_start: дата початку перевірки.
date_finish: дата завершення перевірки.
date_order_by: службова дата, яку ESG SaveEcoBot використовує для хронологічного сортування перевірок. Вона допомагає впорядкувати записи, якщо в перевірці є кілька різних дат.
violations_count: кількість порушень.
sanctions_count: кількість санкцій.
parts_count: кількість частин перевірки.
acts_count: кількість актів перевірки.
orders_count: кількість приписів.
files_count: загальна кількість доступних файлів перевірки.
links.details: посилання на деталі перевірки.
links.violations: посилання на окремий перелік порушень.
links.sanctions: посилання на окремий перелік санкцій.
links.parts: посилання на перелік частин перевірки.
links.files: посилання на перелік файлів перевірки.
coordinates: координати адреси, якщо доступ до них дозволений для ключа.
coordinates.latitude: широта.
coordinates.longitude: довгота.

Деталі перевірки

GET /api/v1/enterprises/{registry_id}/inspection-details/{inspection_id}

Цей запит повертає повні дані конкретної перевірки. У відповіді ви отримаєте той самий набір полів, що й у переліку перевірок, а також блок links для переходу до частин перевірки, порушень, санкцій і файлів.

Параметри registry_id і inspection_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. inspection_id — це ідентифікатор перевірки.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-details/7001" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "id": 7001,
      "parent_id": null,
      "super_type_id": 1,
      "super_type_name": "Екологічні",
      "authority_name": "ДЕІ",
      "name": "Перевірка виконання припису щодо усунення порушень.",
      "description_lines": ["Перевірка дотримання природоохоронного законодавства"],
      "address": "Україна, Київська область, місто Київ",
      "region": "Київська область",
      "is_planned": true,
      "status": "Проведено",
      "risk": "Високий",
      "sphere": "Охорона навколишнього природного середовища, раціональне використання, відтворення і охорона природних ресурсів",
      "source": "Інспекційний портал",
      "date_start": "2025-03-10",
      "date_finish": null,
      "date_order_by": "2025-03-01",
      "violations_count": 3,
      "sanctions_count": 1,
      "parts_count": 2,
      "acts_count": 1,
      "orders_count": 1,
      "files_count": 2,
      "coordinates": null,
      "links": {
        "parts": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-parts/7001",
        "violations": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-violations/7001",
        "sanctions": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-sanctions/7001",
        "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-files/7001"
      }
    }
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

Поля об'єкта ті самі, що й у results.items[] в переліку перевірок.

`results.object.links`

parts: посилання на окремий перелік частин перевірки, якщо вони є.
violations: посилання на окремий перелік порушень, якщо вони є.
sanctions: посилання на окремий перелік санкцій, якщо вони є.
files: посилання на окремий перелік файлів перевірки, якщо вони є.

Частини перевірки

GET /api/v1/enterprises/{registry_id}/inspection-parts/{inspection_id}

Цей запит повертає окремі частини перевірки, якщо вона складається з кількох блоків. Разом із переліком частин повертається блок object з короткою інформацією про саму перевірку.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-parts/7001" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "inspection",
      "id": 7001,
      "super_type_id": 1,
      "super_type_name": "Екологічні",
      "name": "Перевірка виконання припису щодо усунення порушень."
    },
    "items": [
      {
        "id": 7001,
        "authority_name": "ДЕІ",
        "name": "Частина перевірки",
        "description_lines": ["Окремий блок перевірки"],
        "address": "Україна, Київська область, місто Київ"
      }
    ]
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

type: тип об'єкта. Для цього запиту використовується значення inspection.
id: ідентифікатор перевірки.
super_type_id: ідентифікатор типу інспекційної перевірки верхнього рівня.
super_type_name: назва типу інспекційної перевірки верхнього рівня.
name: назва перевірки.

`results.items[]`

Елементи мають той самий набір полів, що й у головному списку перевірок.

Порушення за перевіркою

GET /api/v1/enterprises/{registry_id}/inspection-violations/{inspection_id}

Цей запит повертає порушення, пов'язані з перевіркою. Разом із переліком порушень повертається блок object з короткою інформацією про саму перевірку.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-violations/7001" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "inspection",
      "id": 7001,
      "super_type_id": 1,
      "super_type_name": "Екологічні",
      "name": "Перевірка виконання припису щодо усунення порушень."
    },
    "items": [
      {
        "number": 848074,
        "description": "Акт перевірки 005/03 від 16.01.2019"
      },
      {
        "number": 673098,
        "description": "Не ведеться первинний поточний облік згідно форми 1-ВТ."
      },
      {
        "number": 673095,
        "description": "Не забезпечення достовірного обліку забраної води"
      }
    ]
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

type: тип об'єкта. Для цього запиту використовується значення inspection.
id: ідентифікатор перевірки.
super_type_id: ідентифікатор типу інспекційної перевірки верхнього рівня.
super_type_name: назва типу інспекційної перевірки верхнього рівня.
name: назва перевірки.

`results.items[]`

number: номер або порядковий індекс порушення.
description: текстовий опис порушення.

Санкції за перевіркою

GET /api/v1/enterprises/{registry_id}/inspection-sanctions/{inspection_id}

Цей запит повертає санкції, пов'язані з перевіркою. Разом із переліком санкцій повертається блок object з короткою інформацією про саму перевірку.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-sanctions/7001" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "inspection",
      "id": 7001,
      "super_type_id": 1,
      "super_type_name": "Екологічні",
      "name": "Перевірка виконання припису щодо усунення порушень."
    },
    "items": [
      {
        "type_name": "Штраф, який визначається уповноваженим органом (посадовою особою) у межах, встановлених законом",
        "document_type_name": "Про охорону атмосферного повітря",
        "document_part": "78",
        "document": "Постанова №012237 від 16 січня 2019",
        "fine_amount": "136.00 грн."
      },
      {
        "type_name": "Штраф, який встановлено законом у фіксованому розмірі",
        "document_type_name": "Про охорону атмосферного повітря",
        "document_part": "78",
        "document": "Постанова №012237 від 16 січня 2019",
        "fine_amount": "136.00 грн."
      }
    ]
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

type: тип об'єкта. Для цього запиту використовується значення inspection.
id: ідентифікатор перевірки.
super_type_id: ідентифікатор типу інспекційної перевірки верхнього рівня.
super_type_name: назва типу інспекційної перевірки верхнього рівня.
name: назва перевірки.

`results.items[]`

type_name: тип санкції.
document_type_name: тип документа, яким оформлено санкцію.
document_part: частина документа.
document: назва або номер документа.
fine_amount: сума штрафу, якщо вона є.

Файли перевірки

GET /api/v1/enterprises/{registry_id}/inspection-files/{inspection_id}

Цей запит повертає файли перевірки, наприклад акти та приписи. Разом із переліком файлів повертається блок object з короткою інформацією про саму перевірку.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-files/7001" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "inspection",
      "id": 7001,
      "name": "Планова перевірка"
    },
    "items": [
      {
        "type_code": "act",
        "type_name": "Акт",
        "name": "act.pdf",
        "format": "application/pdf",
        "size": 65021,
        "uploaded_at": "2025-03-10",
        "downloaded_at": "2025-03-11T09:00:00+02:00",
        "links": {
          "download": "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-files/7001/download/act"
        }
      }
    ]
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

type: тип об'єкта. Для цього запиту використовується значення inspection.
id: ідентифікатор перевірки.
name: назва перевірки.

`results.items[]`

type_name: назва файла, наприклад Акт або Припис.
type_code: технічний код файла, наприклад act або order.
name: назва файла.
format: MIME-тип файла.
size: розмір файла в байтах.
uploaded_at: дата документа, якщо вона відома.
downloaded_at: дата й час, коли файл був завантажений у систему ESG SaveEcoBot.
links.download: посилання на завантаження файла.

Завантаження файла перевірки

GET /api/v1/enterprises/{registry_id}/inspection-files/{inspection_id}/download/{file_type}

Цей запит повертає бінарний файл перевірки для завантаження.

Параметри registry_id, inspection_id і file_type в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. inspection_id — це ідентифікатор перевірки. file_type — це тип файла перевірки, наприклад act або order.

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

$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/inspection-files/7001/download/act" \
  -H "Authorization: Bearer $ESG_API_TOKEN"

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

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="act.pdf"

Перелік перевірок

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

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

Параметри пагінації

Фільтри

Поля відповіді

results.items[]

Деталі перевірки

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

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

Поля відповіді

results.object

results.object.links

Частини перевірки

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

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

Поля відповіді

results.object

results.items[]

Порушення за перевіркою

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

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

Поля відповіді

results.object

results.items[]

Санкції за перевіркою

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

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

Поля відповіді

results.object

results.items[]

Файли перевірки

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

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

Поля відповіді

results.object

results.items[]

Завантаження файла перевірки

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

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

Візьміть участь в тестуванні ESG профілю підприємства у системі SaveEcoBot

`results.items[]`

`results.object`

`results.object.links`

`results.object`

`results.items[]`

`results.object`

`results.items[]`

`results.object`

`results.items[]`

`results.object`

`results.items[]`