Drafts API

Группа методов для работы с черновиками.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

---

[POST]/api/v3/drafts

Импорт черновика в систему (не более 60 мб).

Основной сценарий Импортировать черновик документа для последующей отправки.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
AbonentId	Да	string(uuid)	Внутренний идентификатор абонента.
DocumentFile	Да	string(binary)	Файл черновика для импорта в систему.
IsReadOnly	Нет	boolean	Индикатор, показывающий, что черновик доступен только на чтение. По умолчанию значение равно false.
PackageId	Нет	string(uuid)	Идентификатор пакета.
RecipientIds	Нет	string(uuid)[array]	Внутренние идентификаторы контрагентов-получателей.
ResponseSignatureRequired	Нет	boolean	Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота.
DepartmentId	Нет	string(uuid)	Подразделение, в которое импортируется черновик. Если null - черновик будет импортирован в подразделение сотрудника.

Возможные ответы метода

Код	Тип	Описание
200	ImportDraftResult	Сведения о загруженном черновике.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "draftDocumentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "senderChanged": true,
  "recipientChanged": true,
  "signerChanged": true,
  "changes": "Строка",
  "type": "OperatorErrorMessage",
  "recipientIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "message": "Строка",
  "employeeDepartmentId": "7143b542-80ed-48ae-9f4a-812dccfe3e73"
}

---

[POST]/api/v3/drafts/withoutModify

Импорт черновика в систему с запретом его модификации (не более 60 мб).

Основной сценарий Импортировать черновик документа для последующей отправки.
Этот метод запрещает изменять черновик при импорте.
В случае, если черновик требует модификации, операция будет отменена.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
WarrantNumber	Нет	string(uuid)	Номер доверенности (МЧД).
DocumentSign	Нет	string(binary)	Файл подписи.
AbonentId	Да	string(uuid)	Внутренний идентификатор абонента.
DocumentFile	Да	string(binary)	Файл черновика для импорта в систему.
IsReadOnly	Нет	boolean	Индикатор, показывающий, что черновик доступен только на чтение. По умолчанию значение равно false.
PackageId	Нет	string(uuid)	Идентификатор пакета.
RecipientIds	Нет	string(uuid)[array]	Внутренние идентификаторы контрагентов-получателей.
ResponseSignatureRequired	Нет	boolean	Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота.
DepartmentId	Нет	string(uuid)	Подразделение, в которое импортируется черновик. Если null - черновик будет импортирован в подразделение сотрудника.

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор черновика.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

---

[POST]/api/v3/drafts/{draftId}/SendAlongApprovalRoute

Отправка черновика по маршруту согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)
draftId	Да	Path	string(uuid)

Тело запроса

Тип запроса: application/json

Название	Обязат.	Тип	Описание
approvalRouteId	Да	string(uuid)	Идентификатор маршрута согласования

Пример модели

{
  "approvalRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

Возможные ответы метода

Код	Тип	Описание
200	SendAlongApprovalRouteResult	Результат отправки черновика по маршруту.

Пример успешного ответа

{
  "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "runningRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "runningRouteStatus": "Signed"
}

---

[GET]/api/v3/drafts/ToProcess

Получение списка черновиков, ожидающих согласования или подписания

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)

Возможные ответы метода

Код	Тип	Описание
200	DraftDocumentResultList	Список черновиков, ожидающих обработки.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "C0775FB3-B718-4CD5-B95A-2856A179C779",
      "senderAbonentId": "3925EF38-5937-4253-9797-5B77FC13E075",
      "status": "ExpectedSending",
      "recipients": [
        {
          "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
          "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
          "name": "Рога и Копыта",
          "inn": "9678731893",
          "kpp": "999901006",
          "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
          "departmentId": "Строка"
        }
      ],
      "name": "Акт № 1 от 29.07.2020",
      "function": "DIS",
      "type": "OperatorErrorMessage",
      "uploadDate": "2022-02-11T13:03:05.670Z",
      "responseSignatureRequired": true,
      "hasMarkingCodes": true,
      "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "updatedDate": "2022-02-11T13:03:05.670Z",
      "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "draftDelegation": {
        "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "createdAt": "2022-02-11T13:03:05.670Z",
        "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "counterpartyGlobalId": "Строка",
        "recipientName": "Строка",
        "recipientInn": "Строка",
        "recipientKpp": "Строка"
      }
    }
  ]
}

---

[PUT]/api/v3/drafts/{draftId}/Approve

Согласование одного черновика на этапе маршрута согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)
draftId	Да	Path	string(uuid)

Тело запроса

Тип запроса: application/json

Название	Обязат.	Тип	Описание
comment	Нет	string	Комментарий

Пример модели

{
  "comment": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	ApproveDraftResultList	Список результатов согласования.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

[PUT]/api/v3/drafts/Approve

Согласование черновиков на этапе маршрута согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)

Тело запроса

Тип запроса: application/json

Название	Обязат.	Тип	Описание
draftsIds	Да	string(uuid)[array]	Список идентификаторов черновиков
comment	Нет	string	Комментарий

Пример модели

{
  "draftsIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "comment": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	ApproveDraftResultList	Список результатов согласования.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

[PUT]/api/v3/drafts/{draftId}/Reject

Отказ в согласовании/подписании черновика на этапе маршрута согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)
draftId	Да	Path	string(uuid)

Тело запроса

Тип запроса: application/json

Название	Обязат.	Тип	Описание
comment	Нет	string	Комментарий

Пример модели

{
  "comment": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	RejectDraftResultList	Список результатов отклонения.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

[PUT]/api/v3/drafts/Reject

Отказ в согласовании/подписании черновиков на этапе маршрута согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)

Тело запроса

Тип запроса: application/json

Название	Обязат.	Тип	Описание
draftsIds	Да	string(uuid)[array]	Список идентификаторов черновиков
comment	Нет	string	Комментарий

Пример модели

{
  "draftsIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "comment": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	RejectDraftResultList	Список результатов отклонения.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

[GET]/api/v3/drafts/{draftId}/History

Получение истории прохождения черновика по маршруту согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)
draftId	Да	Path	string(uuid)

Возможные ответы метода

Код	Тип	Описание
200	History	История прохождения по маршруту согласования
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "totalCount": 1,
  "passedCount": 1,
  "approvalRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "approvalRouteName": "Строка",
  "historyRecords": [
    {
      "progress": "NotPassed",
      "status": "SentToCounterparty",
      "statusName": "Строка",
      "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "executorType": "Department",
      "executorName": "Строка",
      "executorDepartmentName": "Строка",
      "passedDateTime": "2022-02-11T13:03:05.670Z",
      "comment": "Строка"
    }
  ],
  "recipients": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "globalId": "Строка",
      "name": "Строка",
      "inn": "Строка",
      "kpp": "Строка"
    }
  ]
}

---

[POST]/api/v3/drafts/{draftId}/delegate

Делегировать черновик.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Идентификатор абонента, который делегирует черновик.
draftId	Да	Path	string(uuid)	Идентификатор делегируемого черновика.

Тело запроса

Тип запроса: application/json

Запрос на делегирование черновика.

Название	Обязат.	Тип	Описание
isPaid	Нет	boolean	Признак платы за делегируемый черновик.
recipientId	Нет	string(uuid)	Идентификатор получателя делегируемого черновика.

Пример модели

{
  "isPaid": true,
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Success
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

---

[POST]/api/v2/drafts/withoutModify

Импорт черновика в систему с запретом его модификации (не более 60 мб).

Основной сценарий Импортировать черновик документа, для последующей отправки.
Этот метод запрещает изменять черновик при импорте.
В случае, если черновик требует модификации, операция будет отменена.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
isReadOnly	Нет	Query	boolean

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
documentFile	Да	string(binary)

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор черновика.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

---

[POST]/api/v2/drafts

Импорт черновика в систему (не более 60 мб).

Основной сценарий Импортировать черновик документа для последующей отправки.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
isReadOnly	Нет	Query	boolean

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
documentFile	Да	string(binary)

Возможные ответы метода

Код	Тип	Описание
200	ImportDraftResult	Сведения о загруженном черновике.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "draftDocumentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "senderChanged": true,
  "recipientChanged": true,
  "signerChanged": true,
  "changes": "Строка",
  "type": "OperatorErrorMessage",
  "recipientIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "message": "Строка",
  "employeeDepartmentId": "7143b542-80ed-48ae-9f4a-812dccfe3e73"
}

---

[POST]/api/v2/drafts/{draftId}/sign

Прикрепление подписи к черновику.

Основной сценарий Прикрепить подпись к черновику документа для последующей отправки.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
SignFile	Да	string(binary)	Файл подписи черновика.
WarrantNumber	Нет	string(uuid)	Номер доверенности.

Возможные ответы метода

Код	Тип	Описание
200	AttachSignatureResult	Результат прикрепления подписи.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "signIsValid": true,
  "errorMessage": "Подпись не валидна.",
  "warrantValidationStatus": "NotRequired",
  "warrantErrorMessage": "Строка"
}

---

[POST]/api/v2/drafts/{draftId}/dispatch

Старт подписанного черновика.

Основной сценарий Осуществляет отправку подписанного черновика с целью начать документооборот.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика.

Возможные ответы метода

Код	Тип	Описание
200	StartedDocflow[array]	Список идентификаторов документооборотов и получателей.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[POST]/api/v2/drafts/{draftId}/UpdateSigner

Обновление Подписанта в черновике и его последующая загрузка.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
draftId	Да	Path	string(uuid)	Идентификатор черновика.
abonentId	Да	Query	string(uuid)	Внутренний идентификатор абонента.
warrantNumber	Нет	Query	string	Номер доверенности (МЧД).

Возможные ответы метода

Код	Тип	Описание
200	string(binary)	Файл черновика.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[POST]/api/v1/drafts

Импорт черновика в систему (не более 60 мб).

Основной сценарий Импортировать черновик документа для последующей отправки.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
isReadOnly	Нет	Query	boolean	Индикатор, показывающий, что черновик доступен только на чтение. По умолчанию значение равно false.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
documentFile	Да	string(binary)

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор черновика внутри системы.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

---

[GET]/api/v1/drafts

Получение списка черновиков.

Основной сценарий Получить информацию по черновикам, загруженных в систему.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).
Search	Нет	Query	string	Поисковый запрос.
From	Нет	Query	date-time-offset	Фильтрация по дате создания (от).
To	Нет	Query	date-time-offset	Фильтрация по дате создания (до).
DocumentTypes	Нет	Query	DocumentTypeFilterOption[array]	Фильтрация по типам документов.
RecipientOption	Нет	Query	RecipientFilterOption	Типы установленных получателей для фильтрации.

Возможные ответы метода

Код	Тип	Описание
200	DraftDocumentResultList	Список загруженных черновиков в систему.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "C0775FB3-B718-4CD5-B95A-2856A179C779",
      "senderAbonentId": "3925EF38-5937-4253-9797-5B77FC13E075",
      "status": "ExpectedSending",
      "recipients": [
        {
          "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
          "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
          "name": "Рога и Копыта",
          "inn": "9678731893",
          "kpp": "999901006",
          "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
          "departmentId": "Строка"
        }
      ],
      "name": "Акт № 1 от 29.07.2020",
      "function": "DIS",
      "type": "OperatorErrorMessage",
      "uploadDate": "2022-02-11T13:03:05.670Z",
      "responseSignatureRequired": true,
      "hasMarkingCodes": true,
      "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "updatedDate": "2022-02-11T13:03:05.670Z",
      "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "draftDelegation": {
        "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "createdAt": "2022-02-11T13:03:05.670Z",
        "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "counterpartyGlobalId": "Строка",
        "recipientName": "Строка",
        "recipientInn": "Строка",
        "recipientKpp": "Строка"
      }
    }
  ]
}

---

[GET]/api/v1/drafts/{draftId}

Получение информации о черновике.

Основной сценарий Получить информацию о ранее загруженном черновике в систему.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Возможные ответы метода

Код	Тип	Описание
200	DraftDocument	Информация о загруженном черновике.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "C0775FB3-B718-4CD5-B95A-2856A179C779",
  "senderAbonentId": "3925EF38-5937-4253-9797-5B77FC13E075",
  "status": "ExpectedSending",
  "recipients": [
    {
      "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
      "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "name": "Рога и Копыта",
      "inn": "9678731893",
      "kpp": "999901006",
      "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "departmentId": "Строка"
    }
  ],
  "name": "Акт № 1 от 29.07.2020",
  "function": "DIS",
  "type": "OperatorErrorMessage",
  "uploadDate": "2022-02-11T13:03:05.670Z",
  "responseSignatureRequired": true,
  "hasMarkingCodes": true,
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "updatedDate": "2022-02-11T13:03:05.670Z",
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "draftDelegation": {
    "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "createdAt": "2022-02-11T13:03:05.670Z",
    "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "counterpartyGlobalId": "Строка",
    "recipientName": "Строка",
    "recipientInn": "Строка",
    "recipientKpp": "Строка"
  }
}

---

[DELETE]/api/v1/drafts/{draftId}

Удаление черновика.

Основной сценарий Удалить неактуальный или загруженный по ошибке черновик.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Черновик успешно удален.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[PUT]/api/v1/drafts/{draftId}/metadata

Обновление информации в черновике.

Основной сценарий Обновить информацию о получателях.
Дополнительный сценарий Обновить информацию о получателях с последующей отправкой документа.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Тело запроса

Тип запроса: application/json

Данные для обновления черновика.

Название	Обязат.	Тип	Описание
recipientIds	Да	string(uuid)[array]	Список идентификаторов контрагентов-получателей, которым необходимо отправить документ.
responseSignatureRequired	Нет	boolean	Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота.
shouldSend	Нет	boolean	Признак того, что после обновления данных в черновике, его сразу же следует отправить.

Пример модели

{
  "recipientIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "responseSignatureRequired": true,
  "shouldSend": true
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Данные черновика успешно обновлены (в случае отправки, также будет сообщение об успешном запуске ДО).
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[PUT]/api/v1/drafts/{draftId}/dispatch

Отправка черновика на подписание.

Основной сценарий Отправить ранее импортированный черновик с целью начать документооборот.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Документооборот запущен. Ожидается подписание.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[GET]/api/v1/drafts/{draftId}/file

Выгрузка файла черновика.

Основной сценарий Выгрузить файл черновика с целью убедиться, какой именно документ будет отправлен.
Дополнительный сценарий Выгрузить файл черновика с целью подписания.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Возможные ответы метода

Код	Тип	Описание
200	string(binary)	Файл черновика.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[GET]/api/v1/drafts/{draftId}/visualization

Выгрузка печатной формы черновика.

Основной сценарий Выгрузить печатную форму черновика черновика для удобного просмотра.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
draftId	Да	Path	string(uuid)	Идентификатор черновика внутри системы.

Возможные ответы метода

Код	Тип	Описание
200	string(binary)	Файл черновика.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

[GET]/api/v1/drafts/newEvents

Получить список измененных черновиков.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
dateFrom	Нет	Query	date-time-offset	Дата, с которой необходимо сформировать список идентификаторов, где произошли изменения.
limit	Нет	Query	integer(int32)	Максимальное количество записей в ответе. Интервал допустимых значений от 1 до 1000 включительно.
departmentId	Нет	Query	string(uuid)	Идентификатор подразделения, по которому нужно получить ленту событий, если null - лента будет собрана для всех черновиков .

Возможные ответы метода

Код	Тип	Описание
200	DraftChangeInfoChangesListResult	Список идентификаторов черновиков, по которым есть изменения.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "abonentId": " 41ea218c-8539-49e4-83a9-9032ed6abc01 ",
  "limit": 1,
  "dateFrom": "2022-02-11T13:03:05.670Z",
  "count": 1,
  "totalCount": 1,
  "events": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "updateDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

---

[PUT]/api/v1/drafts/{draftId}/changeDepartment/{departmentId}

Переместить черновик в другое подразделение.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)
draftId	Да	Path	string(uuid)	Идентификатор черновика.
departmentId	Да	Path	string(uuid)	Идентификатор подразделения.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Черновик перемещён.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

---

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

---

ApprovalStepExecutorType

Тип исполнителя шага маршрута согласования

Значение	Описание
Department	Подразделение
Employee	Сотрудник

---

ApprovalStepProgress

Состояние записи шага в истории маршрута согласования

Значение	Описание
Active	Шаг активен
NotPassed	Шаг не пройден
Passed	Шаг пройден

---

ApproveDraft

Результат согласования черновика

Название	Обязат.	Тип	Описание
draftId	Нет	string(uuid)	Идентификатор черновика
error	Нет	string	Сообщение об ошибке

Пример модели

{
  "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "error": "Строка"
}

---

ApproveDraftRequest

Запрос на согласование черновика на маршруте согласования

Название	Обязат.	Тип	Описание
comment	Нет	string	Комментарий

Пример модели

{
  "comment": "Строка"
}

---

ApproveDraftResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	ApproveDraft[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

ApproveDraftsRequest

Запрос на согласование черновиков на маршруте согласования

Название	Обязат.	Тип	Описание
draftsIds	Да	string(uuid)[array]	Список идентификаторов черновиков
comment	Нет	string	Комментарий

Пример модели

{
  "draftsIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "comment": "Строка"
}

---

AttachSignatureResult

Результат прикрепление подписи к черновику.

Название	Обязат.	Тип	Описание
signIsValid	Нет	boolean	Флаг о том что подпись валидна.
errorMessage	Нет	string	Причина не валидной подписи.
warrantValidationStatus	Нет	Одна из: SyncWarrantStatus	Является ли доверенность валидной.
warrantErrorMessage	Нет	string	Причина невалидноcти доверенности.

Пример модели

{
  "signIsValid": true,
  "errorMessage": "Подпись не валидна.",
  "warrantValidationStatus": "NotRequired",
  "warrantErrorMessage": "Строка"
}

---

Counterparty

ОПИСАНИЕ НЕ УКАЗАНО!!!

Название	Обязат.	Тип	Описание
id	Нет	string(uuid)	Идентификатор контрагента
globalId	Нет	string	Идентификатор участника ЭДО (ИдЭДО)
name	Нет	string	Название
inn	Нет	string	Инн
kpp	Нет	string	Кпп

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "globalId": "Строка",
  "name": "Строка",
  "inn": "Строка",
  "kpp": "Строка"
}

---

DelegateDraftRequest

Запрос на делегирование черновика.

Название	Обязат.	Тип	Описание
isPaid	Нет	boolean	Признак платы за делегируемый черновик.
recipientId	Нет	string(uuid)	Идентификатор получателя делегируемого черновика.

Пример модели

{
  "isPaid": true,
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

---

DocumentFunction

Перечисление функций УКД и УПД.

Значение	Описание
DIS	Документ об изменении стоимости отгруженных товаров (выполненных работ, оказанных услуг), переданных имущественных прав (ДИС).
DOP	Документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг) (ДОП).
KSCHF	Корректировочный счет-фактура (КСЧФ).
KSCHFDIS	Корректировочный счет-фактура и документ об изменении стоимости отгруженных товаров (выполненных работ, оказанных услуг), переданных имущественных прав (КСЧФДИС).
none	Документ не содержит функции.
SCHF	Счет-фактура (СЧФ).
SCHFDOP	Счет-фактура и документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг) (СЧФДОП).

---

DocumentStatus

Статус документа на маршруте

Значение	Описание
ApprovalRejected	Отказано в согласовании
Approved	Согласован
SentAlongApprovalRoute	Отправлен по маршруту
SentToCounterparty	Отправлен контрагенту
Signed	Подписан
SigningFailed	Не удалось подписать
SigningRejected	Отказано в подписании
WaitingForApproval	Ожидается согласование
WaitingForSending	Ожидается отправка
WaitingForSigning	Ожидается подписание

---

DocumentType

Тип документа.

Значение	Описание
Act	Акт сдачи-приемки.
ActBuyerTitle	Титул заказчика акта.
CancellationRequest	Запрос на аннулирование.
Informal	НЕформализованный.
Izvpol	Извещение о получении.
MarkingProcessingResult	Результат обработки маркировки.
Obsolete	Устаревший, и более НЕподдерживаемый тип.
OperatorErrorMessage	Сообщение об ошибке.
Pdotpr	Подтверждение даты отправки.
Pdpol	Подтверждение даты получения.
Torg12	Документ о передаче товаров (Торг-12).
Torg12BuyerTitle	Титул получателя товарной накладной.
Ucd	УКД.
UcdBuyerTitle	Титул покупателя УКД.
Utd	УПД.
UtdBuyerTitle	Титул покупателя.
Uvutoch	Уведомление об уточнении.

---

DocumentTypeFilterOption

Типы документов для фильтрации черновиков.

Значение	Описание
Act	Акт.
Informal	Неформальный ДО.
Torg12	Торг 12.
Ucd	УКД.
Utd	УПД.

---

DraftChangeInfo

Сведения о дате изменения черновика.

Название	Обязат.	Тип	Описание
draftId	Да	string(uuid)	Идентификатор черновика.
updateDate	Да	date-time-offset	Дата последнего обновления.

Пример модели

{
  "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "updateDate": "2022-02-11T13:03:05.670Z"
}

---

DraftChangeInfoChangesListResult

Список идентификаторов документооборотов, по которым есть изменения.

Название	Обязат.	Тип	Описание
abonentId	Да	string(uuid)	Внутренний идентификатор абонента.
limit	Да	integer(int32)	Количество запрошенных документооборотов, по которым произошли изменения.
dateFrom	Нет	date-time-offset	Дата, начиная с которой был получен список идентификаторов ДО с изменениями.
count	Да	integer(int32)	Количество элементов в результате.
totalCount	Да	integer(int32)	Общее количество элементов.
events	Нет	DraftChangeInfo[array]	Список элементов в результате.

Пример модели

{
  "abonentId": " 41ea218c-8539-49e4-83a9-9032ed6abc01 ",
  "limit": 1,
  "dateFrom": "2022-02-11T13:03:05.670Z",
  "count": 1,
  "totalCount": 1,
  "events": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "updateDate": "2022-02-11T13:03:05.670Z"
    }
  ]
}

---

DraftDelegation

Информация о делегировании.

Название	Обязат.	Тип	Описание
creatorAbonentId	Да	string(uuid)	Идентификатор создателя.
createdAt	Да	date-time-offset	Дата делегирования.
whoPaidAbonentId	Да	string(uuid)	Идентификатор абонента, который платит за документ после отправки.
creatorDepartmentId	Да	string(uuid)	Департамент создателя.
creatorEmployeeId	Да	string(uuid)	Идентификатор сотрудника организации создателя.
counterpartyGlobalId	Да	string	Идентификатор участника ЭДО (ИдЭДО) получателя делегированного черновика.
recipientName	Да	string	Наименование получателя делегированного черновика.
recipientInn	Да	string	ИНН получателя делегированного черновика.
recipientKpp	Нет	string	КПП получателя делегированного черновика.

Пример модели

{
  "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "createdAt": "2022-02-11T13:03:05.670Z",
  "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "counterpartyGlobalId": "Строка",
  "recipientName": "Строка",
  "recipientInn": "Строка",
  "recipientKpp": "Строка"
}

---

DraftDocument

Информация о черновом документе.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор черновика.
senderAbonentId	Да	string(uuid)	Идентификатор абонента (отправитель).
status	Да	Одна из: DraftStatus	Статус черновика.
recipients	Нет	RecipientInfo[array]	Получатели документа.
name	Да	string	Наименование документа.
function	Да	Одна из: DocumentFunction	Функция документа.
type	Да	Одна из: DocumentType	Тип документа.
uploadDate	Да	date-time-offset	Дата загрузки.
responseSignatureRequired	Да	boolean	Признак необходимости ответной подписи.
hasMarkingCodes	Да	boolean	Флаг наличия кодов маркировок в документе.
packageId	Нет	string(uuid)	Идентификатор пакета.
updatedDate	Да	date-time-offset	Дата обновления.
departmentId	Да	string(uuid)	Идентификатор подразделения, которому принадлежит черновик.
draftDelegation	Нет	Одна из: DraftDelegation	Информация о делегировании.

Пример модели

{
  "id": "C0775FB3-B718-4CD5-B95A-2856A179C779",
  "senderAbonentId": "3925EF38-5937-4253-9797-5B77FC13E075",
  "status": "ExpectedSending",
  "recipients": [
    {
      "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
      "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
      "name": "Рога и Копыта",
      "inn": "9678731893",
      "kpp": "999901006",
      "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "departmentId": "Строка"
    }
  ],
  "name": "Акт № 1 от 29.07.2020",
  "function": "DIS",
  "type": "OperatorErrorMessage",
  "uploadDate": "2022-02-11T13:03:05.670Z",
  "responseSignatureRequired": true,
  "hasMarkingCodes": true,
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "updatedDate": "2022-02-11T13:03:05.670Z",
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "draftDelegation": {
    "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "createdAt": "2022-02-11T13:03:05.670Z",
    "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "counterpartyGlobalId": "Строка",
    "recipientName": "Строка",
    "recipientInn": "Строка",
    "recipientKpp": "Строка"
  }
}

---

DraftDocumentResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	DraftDocument[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "C0775FB3-B718-4CD5-B95A-2856A179C779",
      "senderAbonentId": "3925EF38-5937-4253-9797-5B77FC13E075",
      "status": "ExpectedSending",
      "recipients": [
        {
          "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
          "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
          "name": "Рога и Копыта",
          "inn": "9678731893",
          "kpp": "999901006",
          "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
          "departmentId": "Строка"
        }
      ],
      "name": "Акт № 1 от 29.07.2020",
      "function": "DIS",
      "type": "OperatorErrorMessage",
      "uploadDate": "2022-02-11T13:03:05.670Z",
      "responseSignatureRequired": true,
      "hasMarkingCodes": true,
      "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "updatedDate": "2022-02-11T13:03:05.670Z",
      "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "draftDelegation": {
        "creatorAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "createdAt": "2022-02-11T13:03:05.670Z",
        "whoPaidAbonentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "creatorEmployeeId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "counterpartyGlobalId": "Строка",
        "recipientName": "Строка",
        "recipientInn": "Строка",
        "recipientKpp": "Строка"
      }
    }
  ]
}

---

DraftStatus

Статус черновика.

Значение	Описание
ApprovalRejected	Отказано в согласовании. Используется в случае отправки по маршруту согласования.
ContainsErrors	Содержит ошибки.
ExpectedSending	Ожидается отправка.
ReadyToSend	Готов к отправке.
Removed	Удален.
SigningRejected	Отказано в подписании. Используется в случае отправки по маршруту согласования.
SomeContactsRemoved	Связь с некоторыми получателями разорвана/отклонена.
WaitingForApproval	Ожидается согласование. Используется в случае отправки по маршруту согласования.
WaitingForSigning	Ожидается подписание. Используется в случае отправки по маршруту согласования.
WaitingSignature	Ожидает подписи.
WithoutRecipient	Отсутствует получатель.

---

History

История прохождения маршрута согласования

Название	Обязат.	Тип	Описание
totalCount	Нет	integer(int32)	Общее количество шагов
passedCount	Нет	integer(int32)	Количество пройденных шагов
approvalRouteId	Нет	string(uuid)	Идентификатор маршрута, по которому был отправлен документ
approvalRouteName	Нет	string	Название маршрута, по которому был отправлен документ
historyRecords	Нет	HistoryRecord[array]	Записи в истории
recipients	Нет	Counterparty[array]	Получатели черновика

Пример модели

{
  "totalCount": 1,
  "passedCount": 1,
  "approvalRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "approvalRouteName": "Строка",
  "historyRecords": [
    {
      "progress": "NotPassed",
      "status": "SentToCounterparty",
      "statusName": "Строка",
      "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "executorType": "Department",
      "executorName": "Строка",
      "executorDepartmentName": "Строка",
      "passedDateTime": "2022-02-11T13:03:05.670Z",
      "comment": "Строка"
    }
  ],
  "recipients": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "globalId": "Строка",
      "name": "Строка",
      "inn": "Строка",
      "kpp": "Строка"
    }
  ]
}

---

HistoryRecord

Запись в истории прохождения маршрута согласования

Название	Обязат.	Тип	Описание
progress	Нет	Одна из: ApprovalStepProgress	Состояние записи в истории о шаге маршрута
status	Нет	Одна из: DocumentStatus	Статус документа на маршруте
statusName	Нет	string
executorId	Нет	string(uuid)	Идентификатор исполнителя
executorType	Нет	Одна из: ApprovalStepExecutorType	Тип исполнителя
executorName	Нет	string	Имя или название исполнителя
executorDepartmentName	Нет	string	Название подразделения, к которому относится исполнитель в случае, если это сотрудник
passedDateTime	Нет	date-time-offset	Время прохождения шага
comment	Нет	string	Комментарий

Пример модели

{
  "progress": "NotPassed",
  "status": "SentToCounterparty",
  "statusName": "Строка",
  "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "executorType": "Department",
  "executorName": "Строка",
  "executorDepartmentName": "Строка",
  "passedDateTime": "2022-02-11T13:03:05.670Z",
  "comment": "Строка"
}

---

ImportDraftResult

Результат импорта черновика.

Название	Обязат.	Тип	Описание
draftDocumentId	Да	string(uuid)	Идентификатор импортированного черновика.
senderChanged	Да	boolean	Признак изменения сведений об отправителе в документе.
recipientChanged	Да	boolean	Признак изменения сведений о получателе в документе.
signerChanged	Да	boolean	Признак изменения сведений о подписанте в документе.
changes	Нет	string	Сообщение об изменениях в загруженном черновике.
type	Нет	Одна из: DocumentType	Тип документа.
recipientIds	Нет	string(uuid)[array]	Список получателей.
message	Нет	string	Ошибка при попытке импорта.
employeeDepartmentId	Да	string(uuid)	Идентификатор подразделения пользователя выполнившего импорт черновика.

Пример модели

{
  "draftDocumentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "senderChanged": true,
  "recipientChanged": true,
  "signerChanged": true,
  "changes": "Строка",
  "type": "OperatorErrorMessage",
  "recipientIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "message": "Строка",
  "employeeDepartmentId": "7143b542-80ed-48ae-9f4a-812dccfe3e73"
}

---

RecipientFilterOption

Типы установленнных получателей для фильтрации.

Значение	Описание
All	Все.
Assigned	Присутствуют получатели.
NoRecipient	Отсутствуют получатели.

---

RecipientInfo

Информация о контрагенте-получателе.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Внутренний идентификатор контрагента.
globalId	Да	string	Идентификатор участника ЭДО (ИдЭДО).
name	Да	string	Наименование получателя.
inn	Да	string	ИНН получателя.
kpp	Нет	string	КПП получателя.
docflowId	Нет	string(uuid)	Идентификатор документооборота.
departmentId	Нет	string	Идентификатор подразделения контрагента.

Пример модели

{
  "id": "C3842CCD-FB76-4348-8C38-C90579858A40",
  "globalId": "2AE28F6ABFC-546A-4EFA-AD43-6F8DB8738875",
  "name": "Рога и Копыта",
  "inn": "9678731893",
  "kpp": "999901006",
  "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "departmentId": "Строка"
}

---

RejectDraft

Результат отклонения черновика

Название	Обязат.	Тип	Описание
draftId	Нет	string(uuid)	Идентификатор черновика
error	Нет	string	Сообщение об ошибке

Пример модели

{
  "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "error": "Строка"
}

---

RejectDraftRequest

Запрос на отклонение черновика на маршруте согласования

Название	Обязат.	Тип	Описание
comment	Нет	string	Комментарий

Пример модели

{
  "comment": "Строка"
}

---

RejectDraftResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	RejectDraft[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "error": "Строка"
    }
  ]
}

---

RejectDraftsRequest

Запрос на отклонение черновиков на маршруте согласования

Название	Обязат.	Тип	Описание
draftsIds	Да	string(uuid)[array]	Список идентификаторов черновиков
comment	Нет	string	Комментарий

Пример модели

{
  "draftsIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "comment": "Строка"
}

---

RunningRouteStatus

Статус запущенного маршрута согласования

Значение	Описание
ApprovalRejected	Отклонено на этапе согласования
Initial	Начальное состояние
Signed	Подписано
Signing	Происходит подписание
SigningRejected	Отклонено на этапе подписания
WaitingForApproval	Ожидает согласования (одного или нескольких)
WaitingForSigning	Ожидает подписания

---

SendAlongApprovalRouteResult

Результат отправки черновика по маршруту согласования

Название	Обязат.	Тип	Описание
draftId	Нет	string(uuid)	Идентификатор черновика
runningRouteId	Нет	string(uuid)	Идентификатор запущенного маршрута
runningRouteStatus	Нет	Одна из: RunningRouteStatus	Статус запущенного маршрута

Пример модели

{
  "draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "runningRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "runningRouteStatus": "Signed"
}

---

SendDraftAlongApprovalRouteRequest

Информация для отправки черновика по маршруту согласования

Название	Обязат.	Тип	Описание
approvalRouteId	Да	string(uuid)	Идентификатор маршрута согласования

Пример модели

{
  "approvalRouteId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

---

StartedDocflow

Документооборот связанный с получателем при отправке подписанного черновика.

Название	Обязат.	Тип	Описание
recipientId	Да	string(uuid)	Идентификатор получателя.
docflowId	Нет	string(uuid)	Идентификатор документооборота.
isStarted	Да	boolean	Удалось ли отправить черновик.
senderDepartmentId	Нет	string(uuid)	Идентификатор подразделения из которого был отпарвлен документ.

Пример модели

{
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "isStarted": true,
  "senderDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

---

SyncWarrantStatus

Статус доверенности по результатам синхронизации.

Значение	Описание
IsValid	Доверенность может быть использована для криптоопераций.
NotRequired	Доверенность не требуется.
NotUsed	Доверенность не входит в состав используемых.
NotValid	Доверенность не может быть использована для криптоопераций.
SyncRequestError	Не удалось получить информацию по доверенности в реестре ФНС.

---

UpdateDraftRequest

Запрос на обновление данных в черновике

Название	Обязат.	Тип	Описание
recipientIds	Да	string(uuid)[array]	Список идентификаторов контрагентов-получателей, которым необходимо отправить документ.
responseSignatureRequired	Нет	boolean	Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота.
shouldSend	Нет	boolean	Признак того, что после обновления данных в черновике, его сразу же следует отправить.

Пример модели

{
  "recipientIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "responseSignatureRequired": true,
  "shouldSend": true
}