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

URI: /documents?edrpou={{edrpou}}&from=14.04.2022 14:55

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

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

Параметри URI

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

/documents?edrpou={{edrpou}}&from=14.04.2022 14:55, де:

• edrpou — код ЄДРПОУ компанії;
• from — дата, з якої необхідно відобразити документи (формат d.m.Y H:i ).

info

from — дата потрапляння документа в нашу базу з ПТАХ

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

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

/documents?edrpou=123123&from=14.04.2022 14:55

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

Ім'я	Тип	Опис
data	list[object]	Містить перелік доступних документів
data.uuid	string	Універсальний унікальний ідентифікатор документа
data.from	string	Код ЄДРПОУ відправника документа
data.to	string	Код ЄДРПОУ отримувача документа
data.date	string	Дата створення документа
data.has_pdf	boolean	Документ має pdf представлення
data.has_xml	boolean	Документ має xml тіло
data.signed	string	Ознака підписаного документа
data.status	string	Статус документа: NEW — документ знаходиться в розробці і буде використаний пізніше PENDING — документ очікує дію (погодження/відхилення) однією зі сторін REJECTED — документ відхилений APPROVED — документ погоджено (процес завершено)
total	integer	Загальна кількість доступних документів
error	string	Текст помилки

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

200 OK

Відповідь: /documents?edrpou=123123&from=14.04.2022 14:55

{
    "data": [
        {
            "uuid": "001897f7-6406-4694-93aa-98fd089dbb2b",
            "from": "35758853",
            "to": "31454383",
            "date": "28.03.2022 16:49:47",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "761ff34f-d961-48e4-99d0-37b536212e00",
            "from": "35758853",
            "to": "31454383",
            "date": "28.03.2022 16:51:20",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "f10d64b3-1b83-4678-b20e-3a87216ab0b6",
            "from": "43424671",
            "to": "31454383",
            "date": "28.03.2022 17:25:36",
            "has_pdf": false,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "496c2fd6-4cf0-48bd-a7de-05d4b6fca088",
            "from": "38800462",
            "to": "31454383",
            "date": "29.03.2022 10:52:43",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "ddf8edac-e443-4c0d-baa7-541238bab3c1",
            "from": "35758853",
            "to": "31454383",
            "date": "28.03.2022 11:38:17",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "6651600a-0067-48e4-88bd-1ff860cd049f",
            "from": "39576411",
            "to": "31454383",
            "date": "28.03.2022 08:00:45",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "2c24ead0-2d53-433e-acb1-e616fddab45b",
            "from": "39576411",
            "to": "31454383",
            "date": "28.03.2022 08:01:18",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "382f5532-d01c-4279-87f8-690fffdbf3e0",
            "from": "35758853",
            "to": "31454383",
            "date": "28.03.2022 11:35:39",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "1f355069-637a-411a-a242-e84e494387a0",
            "from": "35758853",
            "to": "31454383",
            "date": "25.03.2022 11:20:41",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        },
        {
            "uuid": "fc967474-bb0d-4934-8630-7009cfbe62d5",
            "from": "35912126",
            "to": "31454383",
            "date": "25.03.2022 11:29:23",
            "has_pdf": true,
            "has_xml": true,
            "signed": "?",
            "status": "?"
        }
    ],
    "total": 10
}

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

400 Bad Request

Відповідь: /documents?edrpou=123123&from=14.04.2022 14:55

{
    "error": "Текст помилки"
}