# Об'єкт XDocApprovalScenario (дані кроків за сценарієм)

**Опис параметрів об’єкта**

<div class="wy-table-responsive" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A2%D0%B8%D0%BF%C2%A01-%D0%A4%D0%BE%D1%80%D0%BC%D0%B0"><table class="colwidths-given docutils align-default" style="width: 100%;"><colgroup><col style="width: 16.6843%;"></col><col style="width: 6.79189%;"></col><col style="width: 22.1673%;"></col><col style="width: 54.4624%;"></col></colgroup><thead><tr class="row-odd"><th class="head">Параметр

</th><th class="head">Тип <sup>1</sup>

</th><th class="head">Формат

</th><th class="head">Опис

</th></tr></thead><tbody><tr class="row-odd"><td>id

</td><td> </td><td>long

</td><td>id сценарію

</td></tr><tr class="row-even"><td>actual

</td><td>O

</td><td>boolean

</td><td>актуальність

- true - актуальний
- false - архівний

actual=false - передається для видалення сценарію

</td></tr><tr class="row-odd"><td>userId

</td><td> </td><td>long

</td><td>id користувача

</td></tr><tr class="row-even"><td>docType

</td><td>O

</td><td>int

</td><td>тип документа для автопогодження:

- <dl class="simple"><dt>28 - COMDOC:</dt><dd>
    - Акт наданих послуг (COMDOC\_018)
    - Акт виконаних робіт (COMDOC\_013)
    - Акт взаємозаліку (COMDOC\_015)
    - Рахунок-фактура (COMDOC\_016)
    - Акт звірки зведений (COMDOC\_029)
    - Претензія (COMDOC\_030)
    - Акт наданих послуг (Логістика) (COMDOC\_037)
    
    </dd></dl>
- 118 - Акт приймання наданих послуг (DOCINVOICEACT)
- 115 - Повідомлення про штрафні санкції (ORDRPT)

</td></tr><tr class="row-odd"><td>auto

</td><td>O

</td><td>boolean

</td><td>автоматичний запуск погодження

</td></tr><tr class="row-even"><td>name

</td><td>M

</td><td>String

</td><td>назва сценарію

</td></tr><tr class="row-odd"><td>subDocTypes

</td><td>O

</td><td>List&lt;Integer&gt;

</td><td>масив чисел; підтип COMDOC документа для автопогодження:

- 18 - Акт наданих послуг (COMDOC\_018)
- 13 - Акт виконаних робіт (COMDOC\_013)
- 15 - Акт взаємозаліку (COMDOC\_015)
- 16 - Рахунок-фактура (COMDOC\_016)
- 29 - Акт звірки зведений (COMDOC\_029)
- 30 - Претензія (COMDOC\_030)
- 37 - Акт наданих послуг (Логістика) (COMDOC\_037)

</td></tr><tr class="row-even"><td>partners

</td><td>O

</td><td>List&lt;String&gt;

</td><td>масив значень; перелік GLN контрагентів, за якими буде запускатись автопогодження

</td></tr><tr class="row-odd"><td>documentSumMin

</td><td>O

</td><td>double

</td><td>ВІД якої суми документа (з ПДВ) буде запускатись автопогодження

</td></tr><tr class="row-even"><td>documentSumMax

</td><td>O

</td><td>double

</td><td>ДО якої суми документа (з ПДВ) буде запускатись автопогодження

</td></tr><tr class="row-odd"><td>**steps**

</td><td>M

</td><td>&lt;Integer, List&lt;[XDocApprovalStep](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocapprovalstep)&gt;&gt;

</td><td>об’єкт з пронумерованими масивами об’єктів; тіло сценарію (кроки погодження документів)

</td></tr></tbody></table>

</div><details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-"><summary>JSON приклад запиту</summary>

```json
{
        "name": "Бахмут - це Україна",
        "userId": 50206653,
        "actual": true,
        "auto": false,
        "partners":
        [],
        "documentSumMin": "500",
        "documentSumMax": "1000",
        "steps":
        {
                "1":
                [
                                {
                                        "userId": "50206653",
                                        "operationType": "1"
                                }
                ],
                "2":
                [
                                {
                                        "userId": "60215367",
                                        "operationType": "2"
                                }
                ]
        },
        "docType": 28,
        "subDocTypes":
        [
                13
        ]
}
```

</details><details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96"><summary>JSON приклад відповіді за одним сценарієм</summary>

```json
{
        "id": 5,
        "actual": true,
        "userId": 50206655,
        "docType": 28,
        "auto": true,
        "name": "СценкаНова",
        "subDocTypes":
        [
                13
        ],
        "partners":
        [],
        "documentSumMin": 0.0,
        "documentSumMax": 0.0,
        "steps":
        {
                "1":
                [
                                {
                                        "docId": 0,
                                        "scenarioId": 0,
                                        "stepId": 0,
                                        "userId": 50206655,
                                        "stepStatus": 0,
                                        "operationType": 1,
                                        "dateChanged": 0
                                }
                ],
                "2":
                [
                                {
                                        "docId": 0,
                                        "scenarioId": 0,
                                        "stepId": 0,
                                        "userId": 50206655,
                                        "stepStatus": 0,
                                        "operationType": 2,
                                        "dateChanged": 0
                                }
                ]
        }
}
```

</details><details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%D0%B2%D1%96%D0%B4%D0%BF%D0%BE%D0%B2%D1%96-1"><summary>JSON приклад відповіді за всіма сценаріями</summary>

```json
[
        {
                "id": 1,
                "actual": true,
                "userId": 50206655,
                "docType": 0,
                "auto": false,
                "name": "very short",
                "documentSumMin": 0.0,
                "documentSumMax": 0.0,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 2,
                                                "dateChanged": 0
                                        }
                                ]
                }
        },
        {
                "id": 2,
                "actual": true,
                "userId": 50206655,
                "docType": 0,
                "auto": false,
                "name": "Акт наданих послуг",
                "documentSumMin": 0.0,
                "documentSumMax": 0.0,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 2,
                                                "dateChanged": 0
                                        }
                                ]
                }
        },
        {
                "id": 3,
                "actual": true,
                "userId": 50206655,
                "docType": 0,
                "auto": false,
                "name": "test skip first step",
                "documentSumMin": 0.0,
                "documentSumMax": 0.0,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206661,
                                                "stepStatus": 0,
                                                "operationType": 1,
                                                "dateChanged": 0
                                        }
                                ],
                                "2":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 1,
                                                "dateChanged": 0
                                        }
                                ]
                }
        },
        {
                "id": 4,
                "actual": true,
                "userId": 50206655,
                "docType": 0,
                "auto": false,
                "name": "На Дарʼю",
                "documentSumMin": 0.0,
                "documentSumMax": 0.0,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 1,
                                                "dateChanged": 0
                                        }
                                ],
                                "2":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206661,
                                                "stepStatus": 0,
                                                "operationType": 2,
                                                "dateChanged": 0
                                        }
                                ]
                }
        },
        {
                "id": 5,
                "actual": true,
                "userId": 50206655,
                "docType": 28,
                "auto": true,
                "name": "СценкаНова",
                "subDocTypes":
                [
                                13
                ],
                "partners":
                [],
                "documentSumMin": 0.0,
                "documentSumMax": 0.0,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 1,
                                                "dateChanged": 0
                                        }
                                ],
                                "2":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 2,
                                                "dateChanged": 0
                                        }
                                ]
                }
        },
        {
                "id": 6,
                "actual": false,
                "userId": 50206655,
                "docType": 28,
                "auto": false,
                "name": "На підтримку ЗСУ",
                "subDocTypes":
                [
                                13
                ],
                "partners":
                [
                                "1234567890AaB",
                                "4823058722214"
                ],
                "documentSumMin": 5.0E+10,
                "documentSumMax": 5000000000000001,
                "steps":
                {
                                "1":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 1,
                                                "dateChanged": 0
                                        }
                                ],
                                "2":
                                [
                                        {
                                                "docId": 0,
                                                "scenarioId": 0,
                                                "stepId": 0,
                                                "userId": 50206655,
                                                "stepStatus": 0,
                                                "operationType": 2,
                                                "dateChanged": 0
                                        }
                                ]
                }
        }
]
```

</details>