Зобов’язання підприємства

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

Перелік зобов’язань

GET /api/v1/enterprises/{registry_id}/obligations/{domain}

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

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

Доступні значення domain можна отримати в запиті Домени даних.

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligations/agro-receipts?obligation_type_id=1" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "14020012" },
    "domain": { "slug": "agro-receipts", "label": "Розписки" },
    "items": [
      {
        "id": 599,
        "type_id": 1,
        "type_name": "Аграрна розписка",
        "registry_id": "300",
        "authority_name": "Мінагрополітики",
        "name": "Товарна аграрна розписка №300",
        "description_lines": ["Забезпечена майбутнім урожаєм"],
        "status": "чинна",
        "date": "2024-03-10",
        "deadline": "2025-03-10",
        "registered_at": "2024-03-10",
        "price": 1250000.00,
        "address": "Сумська область",
        "files_count": 2,
        "land_plots_count": 232,
        "links": {
          "details": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-details/599",
          "files": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-files/599",
          "land_plots": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-land-plots/599"
        },
        "coordinates": null
      }
    ]
  },
  "stats": { "..." }
}

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

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

Фільтри

obligation_type_id: ідентифікатор типу зобов'язання. Доступні значення можна отримати в запиті Типи зобов’язань.

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

`results.items[]`

id: ідентифікатор зобов'язання.
type_id: ідентифікатор типу зобов'язання.
type_name: назва типу зобов'язання.
registry_id: реєстраційний номер, якщо він є.
authority_name: орган або джерело запису.
name: назва запису.
description_lines[]: короткий опис окремими рядками.
status: статус зобов'язання.
date: основна дата запису.
deadline: крайній строк виконання або погашення.
registered_at: дата реєстрації.
price: сума або вартість, якщо вона є.
address: адреса об'єкта.
files_count: кількість пов'язаних файлів.
land_plots_count: кількість пов'язаних земельних ділянок.
links.details: посилання на деталі зобов'язання.
links.files: посилання на окремий перелік файлів.
links.land_plots: посилання на перелік земельних ділянок.
coordinates: координати адреси, якщо доступ до них дозволений для ключа.
coordinates.latitude: широта.
coordinates.longitude: довгота.

Деталі зобов’язання

GET /api/v1/enterprises/{registry_id}/obligation-details/{obligation_id}

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

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

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

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

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "14020012" },
    "object": {
      "id": 599,
      "type_id": 1,
      "type_name": "Аграрна розписка",
      "registry_id": "300",
      "authority_name": "Мінагрополітики",
      "name": "Товарна аграрна розписка №300",
      "description_lines": ["Забезпечена майбутнім урожаєм"],
      "status": "чинна",
      "date": "2024-03-10",
      "deadline": "2025-03-10",
      "registered_at": "2024-03-10T00:00:00+00:00",
      "price": 1250000.00,
      "address": "Сумська область",
      "files_count": 2,
      "land_plots_count": 232,
      "coordinates": null,
      "links": {
        "files": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-files/599",
        "land_plots": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-land-plots/599"
      }
    }
  },
  "stats": { "..." }
}

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

`results.object`

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

`results.object.links`

files: посилання на окремий перелік файлів зобов'язання, якщо файли є.
land_plots: посилання на перелік пов'язаних земельних ділянок, якщо вони є.

Файли зобов’язання

GET /api/v1/enterprises/{registry_id}/obligation-files/{obligation_id}

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

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

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

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "14020012" },
    "object": {
      "type": "obligation",
      "id": 599,
      "registry_id": "300",
      "type_id": 1,
      "type_name": "Аграрна розписка",
      "name": "Товарна аграрна розписка №300"      
    },
    "items": [
      {
        "id": 1,
        "type_id": 1,
        "type_name": "Акт",
        "name": "obligation.pdf",
        "format": "application/pdf",
        "size": 65021,
        "uploaded_at": "2024-03-10T12:00:00+00:00",
        "downloaded_at": "2024-03-11T09:00:00+00:00",
        "links": {
          "download": "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-files/599/download/1"
        }
      }
    ]
  },
  "stats": { "..." }
}

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

`results.object`

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

`results.items[]`

id: ідентифікатор файла зобов'язання.
type_id: ідентифікатор типу файла.
type_name: назва типу файла.
name: назва файла.
format: формат файла.
size: розмір файла в байтах.
uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.
downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.
links.download: посилання на завантаження файла.

Завантаження файла зобов'язання

GET /api/v1/enterprises/{registry_id}/obligation-files/{obligation_id}/download/{file_id}

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

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

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

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

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

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="agro-receipt-99-1.pdf"

Земельні ділянки зобов’язання

GET /api/v1/enterprises/{registry_id}/obligation-land-plots/{obligation_id}

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

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/14020012/obligation-land-plots/599?page=1" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "14020012" },
    "object": {
      "type": "obligation",
      "id": 599,
      "registry_id": "300",
      "type_id": 1,
      "type_name": "Аграрна розписка",
      "name": "Товарна аграрна розписка №300"
    },
    "items": [
      {
        "cadastral_number": "5920682000:01:001:0001",
        "katottg": null,
        "koatuu": {
          "code": "5920682000",
          "name": "СУМСЬКА ОБЛАСТЬ, БІЛОПІЛЬСЬКИЙ РАЙОН, ВИРІВСЬКА"
        },
        "area_ha": 3.14,
        "purpose": "Для ведення товарного сільськогосподарського виробництва",
        "region": "Сумська область"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 232,
      "last_page": 12
    }
  },
  "stats": { "..." }
}

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

`results.object`

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

`results.items[]`

cadastral_number: кадастровий номер ділянки.
katottg: інформація про КАТОТТГ, якщо вона є.
katottg.code: код КАТОТТГ.
katottg.name: назва КАТОТТГ.
koatuu: інформація про КОАТУУ, якщо вона є.
koatuu.code: код КОАТУУ.
koatuu.name: назва КОАТУУ.
area_ha: площа ділянки в гектарах.
purpose: цільове призначення.
region: регіон ділянки.

Перелік зобов’язань

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

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

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

Фільтри

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

results.items[]

Деталі зобов’язання

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

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

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

results.object

results.object.links

Файли зобов’язання

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

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

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

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[]`