Перейти до головного контенту

Погодити документ​

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

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

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

Параметри URI​

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

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

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

Параметри запиту​

Ім'яТипОбов'язковийОпис
fileslist[object]ТакПараметри файлу
files.file_namestringТакПовна назва документа
files.bodystringТакТіло xml документа в кодуванні Base64
forcebooleanНіПрапор, який дозволяє погоджувати документи зі статусом APPROVED

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

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

Запит: /documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9/approve?edrpou=123123
{
    "files": [
        {
            "file_name": "BC2E8434-A183-4510-924F-6625A02B6ABC.XML",
            "body": "signed base64 encoded file content"
        }
    ],
    "force": true
}

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

Ім'яТипОпис
dataobjectДетальна інформація про документ
data.uuidstringУніверсальний унікальний ідентифікатор документа
data.namestringНазва документа
data.fromstringВідправник документа
data.tostringОтримувач документа
data.statusstringСтатус документа:
NEW — документ знаходиться в розробці і буде використаний пізніше
PENDING — документ очікує дію (погодження/відхилення) однією зі сторін
REJECTED — документ відхилений
APPROVED — документ погоджено (процес завершено)
data.parsedobjectМістить інформацію з шаблона
data.parsed.Deptstring
data.parsed.Namestring
data.parsed.DocIdstring
data.parsed.GrpIdstring
data.parsed.OutIdstring
data.parsed.Routelist[object]
data.parsed.Route.Innstring
data.parsed.Route.Namestring
data.parsed.Route.Edrpoustring
data.parsed.Edrpoustring
data.parsed.Tablesarray
data.parsed.Tables.NUMstringНомер документа
data.parsed.Tables.DOCSUMstringСума по документу
data.parsed.Tables.DOCDATEstringДата документа
data.parsed.Tables.FIRM_NMstringНазва компанії
data.parsed.Tables.FIRM_RSstringРозрахунковий рахунок компанії
data.parsed.Tables.VERSIONstringВерсія документа
data.parsed.Tables.VO_NAMEstring
data.parsed.Tables.FIRM_ADRstringАдреса компанії
data.parsed.Tables.FIRM_INNstringІНН компанії
data.parsed.Tables.FIRM_RUKstringПовне ім'я керівника компанії
data.parsed.Tables.FIRM_NAMEstringПовна назва компанії
data.parsed.Tables.MISZE_SKLstring
data.parsed.Tables.TAXSYSTEMstringСистема оподаткування компанії
data.parsed.Tables.FIRM_CBANKstring
data.parsed.Tables.FIRM_EDRPOUstringЄДРПОУ/ДРФО компанії
data.parsed.Tables.FIRM_NMBANKstring
data.parsed.Tables.FIRM_RUKPOSstringПосада керівника компанії
data.parsed.Tables.FIRM_SRPNDSstring
data.parsed.Tables.FIRM_ADR_FIZstringФізична адреса компанії
data.parsed.Tables.FIRM_EMAILORGstringЕлектронна пошта компанії
data.parsed.Tables.SIDE_EDRPOU_KstringЄДРПОУ/ДРФО філії
data.parsed.Tables.SIDE_SHORTNAME_KstringКоротке найменування філії
data.parsed.DocNamestringНайменування документа
data.parsed.CharCodestring
data.parsed.Notationstring
data.parsed.SDocTypeintegerТип шаблону S-Doc
data.parsed.AutoEditionstring
data.parsed.TmplVersionstringВерсія шаблону
data.parsed.ForbidEditionstringОзнака заборони редагування документа
data.parsed.TmplOwnerCodestringКод власника шаблону
data.datestring
data.received_atstring
data.created_atstring
data.updated_atstring
errorstringТекст помилки

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

200 OK

Відповідь: /documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9/approve?edrpou=123123
{
    "data": {
        "uuid": "c4d8710c-26c4-4969-8ff5-1111111111",
        "name": "Акт звіряння",
        "from": "11111111",
        "to": "22222222",
        "status": "REJECTED",
        "parsed": {
            "Dept": null,
            "Name": null,
            "DocId": "117E5FE2-0956-42A6-9475-2ABE0674F773",
            "GrpId": null,
            "OutId": null,
            "Route": [
                {
                    "Name": "ТОВ",
                    "Edrpou": "1111111"
                },
                {
                    "Inn": "22222222",
                    "Name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
                    "Edrpou": "2222222"
                }
            ],
            "Edrpou": "35758853",
            "Tables": [
                [
                    {
                        "NUM": "1",
                        "DOCSUM": "1",
                        "DOCDATE": "25.03.2022 00:00:00",
                        "FIRM_NM": "ТОВ",
                        "FIRM_RS": "121212122112",
                        "VERSION": "1",
                        "VO_NAME": "Name",
                        "FIRM_ADR": "01001, КИЇВ",
                        "FIRM_INN": "357588526594",
                        "FIRM_RUK": "Ruk",
                        "FIRM_NAME": "Товариство з обмеженою відповідальністю",
                        "MISZE_SKL": "м. Київ",
                        "TAXSYSTEM": "Загальна",
                        "FIRM_CBANK": "351005",
                        "FIRM_EDRPOU": "1212121212",
                        "FIRM_NMBANK": "АТ \"УкрСиббанк\"",
                        "FIRM_RUKPOS": "Директор",
                        "FIRM_SRPNDS": "121111111",
                        "FIRM_ADR_FIZ": "01001, КИЇВ",
                        "FIRM_EMAILORG": "[email protected]",
                        "SIDE_EDRPOU_K": "123123124124",
                        "SIDE_SHORTNAME_K": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ"
                    }
                ]
            ],
            "DocName": "Універсальний документ",
            "CharCode": "MULTIDOC",
            "Notation": null,
            "SDocType": 10111,
            "AutoEdition": false,
            "TmplVersion": "602c228e-5c4c-4371-ba32-ebf7021b0e6b",
            "ForbidEdition": false,
            "TmplOwnerCode": "311131113"
        },
        "date": "01.01.2023 13:31:40",
        "received_at": "27.06.2023 14:00:26",
        "created_at": "27.06.2023 14:00:25",
        "updated_at": "28.06.2023 14:09:18"
    }
}

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

400 Bad Request

Відповідь: /documents/f0e40266-5c9d-4faa-a7e9-19cf021a03d9/approve?edrpou=123123
{
    "error": "Текст помилки"
}