Отримати детальну інформацію про один документ

URI: /documents/:uuid?edrpou={{edrpou}}

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

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

Параметри URI

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

/documents/:uuid?edrpou={{edrpou}}, де:

• uuid — універсальний унікальний ідентифікатор документа;
• edrpou — код ЄДРПОУ компанії.

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

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

/documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9?edrpou=123123

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

Ім'я	Тип	Опис
data	object	Детальна інформація про документ
data.uuid	string	Універсальний унікальний ідентифікатор документа
data.date	string	Дата створення документа
data.received_at	string	Дата отримання документа
data.status	string	Статус документа: NEW — документ знаходиться в розробці і буде використаний пізніше PENDING — документ очікує дію (погодження/відхилення) однією зі сторін REJECTED — документ відхилений APPROVED — документ погоджено (процес завершено)
data.parsed	object	Містить інформацію з шаблона
data.parsed.Dept	string
data.parsed.Name	string
data.parsed.DocId	string
data.parsed.GrpId	string
data.parsed.OutId	string
data.parsed.Route	list[object]
data.parsed.Route.Name	string
data.parsed.Route.Edrpou	string
data.parsed.Route.Inn	string
data.parsed.Edrpou	string
data.parsed.Tables	array
data.parsed.Tables.NUM	string	Номер документа
data.parsed.Tables.DOCSUM	string	Сума по документу
data.parsed.Tables.DOCDATE	string	Дата документа
data.parsed.Tables.FIRM_NM	string	Назва компанії
data.parsed.Tables.FIRM_RS	string	Розрахунковий рахунок компанії
data.parsed.Tables.VERSION	string	Версія документа
data.parsed.Tables.VO_NAME	string
data.parsed.Tables.FIRM_ADR	string	Адреса компанії
data.parsed.Tables.FIRM_INN	string	ІНН компанії
data.parsed.Tables.FIRM_RUK	string	Повне ім'я керівника компанії
data.parsed.Tables.FIRM_NAME	string	Повна назва компанії
data.parsed.Tables.MISZE_SKL	string
data.parsed.Tables.TAXSYSTEM	string	Система оподаткування компанії
data.parsed.Tables.FIRM_CBANK	string
data.parsed.Tables.FIRM_EDRPOU	string	ЄДРПОУ/ДРФО компанії
data.parsed.Tables.FIRM_NMBANK	string
data.parsed.Tables.FIRM_RUKPOS	string	Посада керівника компанії
data.parsed.Tables.FIRM_SRPNDS	string
data.parsed.Tables.FIRM_ADR_FIZ	string	Фізична адреса компанії
data.parsed.Tables.FIRM_EMAILORG	string	Електронна пошта компанії
data.parsed.Tables.SIDE_EDRPOU_K	string	ЄДРПОУ/ДРФО філії
data.parsed.Tables.SIDE_SHORTNAME_K	string	Коротке найменування філії
data.parsed.DocName	string	Найменування документа
data.parsed.CharCode	string
data.parsed.Notation	string
data.parsed.SDocType	integer	Тип шаблону S-Doc
data.parsed.AutoEdition	boolean
data.parsed.TmplVersion	string	Версія шаблону
data.parsed.ForbidEdition	boolean	Ознака заборони редагування документа
data.parsed.TmplOwnerCode	string	Код власника шаблону
error	string	Текст помилки

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

200 OK

Відповідь: /documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9?edrpou=123123

{
    "data": {
        "uuid": "f0e40266-5c9a-4faa-a7e9-19cf022a03d9",
        "date": "25.03.2022 11:20:41",
        "received_at": "25.03.2022 11:20:41",
        "status": "PENDING",
        "parsed": {
            "Dept": null,
            "Name": null,
            "DocId": "117E5FE2-0956-42A6-9475-2ABE0674F773",
            "GrpId": null,
            "OutId": null,
            "Route": [
                {
                    "Name": "Украгробізнес, ТОВ",
                    "Edrpou": "35758853"
                },
                {
                    "Inn": "314543826559",
                    "Name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"КЕРНЕЛ - ТРЕЙД\"",
                    "Edrpou": "31454383"
                }
            ],
            "Edrpou": "35758853",
            "Tables": [
                [
                    {
                        "NUM": "1",
                        "DOCSUM": "1",
                        "DOCDATE": "25.03.2022 00:00:00",
                        "FIRM_NM": "Украгробізнес, ТОВ",
                        "FIRM_RS": "26003341242200",
                        "VERSION": "1",
                        "VO_NAME": "ГОЛУБАХА МИХАЙЛО ЛЕОНІДОВИЧ",
                        "FIRM_ADR": "01001, КИЇВ, провулок Тараса Шевченка, 3",
                        "FIRM_INN": "357588526594",
                        "FIRM_RUK": "ГОЛУБАХА МИХАЙЛО ЛЕОНІДОВИЧ",
                        "FIRM_NAME": "Товариство з обмеженою відповідальністю \"Украгробізнес\"",
                        "MISZE_SKL": "м. Київ",
                        "TAXSYSTEM": "Загальна",
                        "FIRM_CBANK": "351005",
                        "FIRM_EDRPOU": "35758853",
                        "FIRM_NMBANK": "АТ \"УкрСиббанк\"",
                        "FIRM_RUKPOS": "Директор",
                        "FIRM_SRPNDS": "100346858",
                        "FIRM_ADR_FIZ": "01001, КИЇВ, провулок Тараса Шевченка, 3",
                        "FIRM_EMAILORG": "[email protected]",
                        "SIDE_EDRPOU_K": "31454383",
                        "SIDE_SHORTNAME_K": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"КЕРНЕЛ - ТРЕЙД\""
                    }
                ]
            ],
            "DocName": "Універсальний документ",
            "CharCode": "MULTIDOC",
            "Notation": null,
            "SDocType": 10111,
            "AutoEdition": false,
            "TmplVersion": "602c228e-5c4c-4371-ba32-ebf7021b0e6b",
            "ForbidEdition": false,
            "TmplOwnerCode": "311131113"
        }
    }
}

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

400 Bad Request

Відповідь: /documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9?edrpou=123123

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