Отримати список документів

URI: /external/documents?api_token={{api_token}}&edrpou={{edrpou}}&contractor={{contractor}}&status={{status}}&from={{from}}&page={{page}}

Використовується для отримання списку документів.

Запит виконується методом GET у json форматі з даними.

Параметри URI

Метод дозволяє передати наступні параметри:

/external/documents?api_token={{api_token}}&edrpou={{edrpou}}&contractor={{contractor}}&status={{status}}&from={{from}}&page={{page}}, де:

• api_token — токен авторизації компанії;
• edrpou — код ЄДРПОУ відділення компанії;
• contractor — код ЄДРПОУ контрагента (опціонально);
• status — поточний статус документа:
  • STATUS_PENDING - очікує підпису однією зі сторін;
  • STATUS_COMPLETED - повністю підписаний;
  • STATUS_REJECTED - відхилений контрагентом.
• from — дата, з якої необхідно відображати документи;
• page — сторінка з документами.

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

⚠️ Запит повинен містити заголовок Accept: application/json

json title="Запит: /external/documents?api_token=12ejh124gvhjv12h41jh241d1df&edrpou=12312312&contractor=&status=STATUS_REJECTED&from=21.02.2022&page=1

Параметри відповіді

Ім'я	Тип	Опис
data	list[object]	Містить список документів
data.uuid	string	Універсальний унікальний ідентифікатор документа
data.external_id	string	Зовнішній ідентифікатор документа
data.date	string	Дата створення документа
data.name	string	Назва документа
data.status	string	Поточний статус документа
data.description	string	Опис статусу документа
total	string	Загальна кількість доступних документів

Приклад успішної відповіді

200 OK

Відповідь: /external/documents?api_token=12ejh124gvhjv12h41jh241d1df&edrpou=12312312&contractor=&status=STATUS_REJECTED&from=21.02.2022&page=1

{
    "data": [
        {
            "uuid": "23e54562-be1f-4ac1-980d-e329c14a973e",
            "external_id": "СК000000859-28.02.2022",
            "date": "28.02.2022",
            "name": "Акт №859 28.02.2022 р.",
            "status": "STATUS_PENDING",
            "description": "Ожидает подписи другого участника"
        },
        {
            "uuid": "d579541f-99e4-4478-bbc8-56026a301b4b",
            "external_id": "СК000000852-28.02.2022",
            "date": "28.02.2022",
            "name": "Акт №852 28.02.2022 р.",
            "status": "STATUS_PENDING",
            "description": "Ожидает подписи другого участника"
        },
        {
            "uuid": "244ff578-74a3-4f84-9b19-371c30e2232f",
            "external_id": "СК000000851-28.02.2022",
            "date": "28.02.2022",
            "name": "Акт №851 28.02.2022 р.",
            "status": "STATUS_PENDING",
            "description": "Ожидает подписи другого участника"
        },
        {
            "uuid": "9ac524da-1f39-4bfb-a27d-0f3dad58a1ee",
            "external_id": "СК000000849-28.02.2022",
            "date": "28.02.2022",
            "name": "Акт №849 28.02.2022 р.",
            "status": "STATUS_PENDING",
            "description": "Ожидает подписи другого участника"
        },
        {
            "uuid": "430789fa-4777-430d-8d79-8246bcec74fa",
            "external_id": "СК000000848-28.02.2022",
            "date": "28.02.2022",
            "name": "Акт №848 28.02.2022 р.",
            "status": "STATUS_PENDING",
            "description": "Ожидает подписи другого участника"
        }
    ],
    "total": 1247
}