Docflows API
Группа методов для работы со списком документооборотов, а также получения информации по ним.
Описание методов
Данный блок содержит подробное описание по каждому методу API.
[GET]/api/v3/docflows/{docflowId}/History
Получение истории прохождения документа по маршруту согласования
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | |
docflowId | Да | Path | string(uuid) |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | History | История прохождения по маршруту согласования |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[POST]/api/v2/docflows
Создать документооборот.
Основной сценарий Осуществляет отправку сформированного контейнера (документ с файлом подписи) с целью начать документооборот.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
Тело запроса
Тип запроса: multipart/form-data
Название | Обязат. | Тип | Описание |
---|---|---|---|
DocumentFile | Да | string(binary) | Документ, который необходимо отправить. |
SignDocumentFile | Да | string(binary) | Файл подписи к документу. |
WarrantNumber | Нет | string(uuid) | Номер доверенности. |
RecipientIds | Нет | string(uuid)[array] | Список идентификаторов контрагентов-получателей, которым необходимо отправить документ. Заполняется в случае когда отправляется НЕформализованный документ. |
ResponseSignatureRequired | Нет | boolean | Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота. |
IsReadOnly | Нет | boolean | Индикатор, показывающий, что созданный черновик для отправки документа будет доступен только на чтение. По умолчанию значение равно false. |
SenderDepartmentId | Нет | string(uuid) | Идентификатор подразделения отправителя. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DispatchResult[array] | Список с информацией об отправленном документе. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v2/docflows/outgoing
Получение списка исходящих документооборотов.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
counterpartyId | Нет | Query | string(uuid) | Идентификатор контрагента (получателя). |
Search | Нет | Query | string | Поисковое значение по наименованию. |
DocumentTypes | Нет | Query | DocumentTypeFilterOption[array] | Список типов документов. |
Statuses | Нет | Query | DocflowStatus[array] | Список статусов ДО. |
From | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "от". |
To | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "до". |
OnlyNotViewed | Нет | Query | boolean | Признак того, что необходимо вернуть только не просмотренные документообороты. |
DepartmentIds | Нет | Query | string(uuid)[array] | Список подразделений. |
offset | Нет | Query | integer(int32) | Начальное значение списка. |
count | Нет | Query | integer(int32) | Количество выводимых значений (По умолчанию: 15). |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowSummaryResultList | Список исходящих документооборотов. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[GET]/api/v2/docflows/incoming
Получение списка входящих документооборотов.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
counterpartyId | Нет | Query | string(uuid) | Идентификатор контрагента (получателя). |
Search | Нет | Query | string | Поисковое значение по наименованию. |
DocumentTypes | Нет | Query | DocumentTypeFilterOption[array] | Список типов документов. |
Statuses | Нет | Query | DocflowStatus[array] | Список статусов ДО. |
From | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "от". |
To | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "до". |
OnlyNotViewed | Нет | Query | boolean | Признак того, что необходимо вернуть только не просмотренные документообороты. |
offset | Нет | Query | integer(int32) | Начальное значение списка. |
count | Нет | Query | integer(int32) | Количество выводимых значений (По умолчанию: 15). |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowSummaryResultList | Список входящих документооборотов. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[GET]/api/v1/docflows/outgoing
Получение списка исходящих документооборотов.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
counterpartyId | Нет | Query | string(uuid) | Идентификатор контрагента (получателя). |
Search | Нет | Query | string | Поисковое значение по наименованию. |
DocumentTypes | Нет | Query | DocumentTypeFilterOption[array] | Список типов документов. |
Status | Нет | Query | DocflowStatus | Статус ДО. |
From | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "от". |
To | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "до". |
OnlyNotViewed | Нет | Query | boolean | Признак того что необходимо вернуть только не просмотренные документообороты. |
offset | Нет | Query | integer(int32) | Начальное значение списка. |
count | Нет | Query | integer(int32) | Количество выводимых значений (По умолчанию: 15). |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowSummaryResultList | Список исходящих документооборотов. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[GET]/api/v1/docflows/incoming
Получение списка входящих документооборотов.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
counterpartyId | Нет | Query | string(uuid) | Идентификатор контрагента (получателя). |
Search | Нет | Query | string | Поисковое значение по наименованию. |
DocumentTypes | Нет | Query | DocumentTypeFilterOption[array] | Список типов документов. |
Status | Нет | Query | DocflowStatus | Статус ДО. |
From | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "от". |
To | Нет | Query | date-time-offset | Фильтрация по дате начала ДО "до". |
OnlyNotViewed | Нет | Query | boolean | Признак того что необходимо вернуть только не просмотренные документообороты. |
offset | Нет | Query | integer(int32) | Начальное значение списка. |
count | Нет | Query | integer(int32) | Количество выводимых значений (По умолчанию: 15). |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowSummaryResultList | Список входящих документооборотов. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[GET]/api/v1/docflows/{docflowId}
Получение детальной информации по указанному документообороту.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор конкретного документооборота. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowInfo | Детальная информация по конкретному документообороту. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[PUT]/api/v1/docflows/{docflowId}/viewed
Отметить документооборот как просмотренный.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор конкретного документооборота. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | Без данных | Документооборот помечен как просмотренный. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/docflows/{docflowId}/transactions
Получить список транзакций по указанному документообороту.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор конкретного документооборота. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowTransactionResultList | Список транзакций в рамках конкретного документооборота. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[GET]/api/v1/docflows/{docflowId}/documents/files
Получить архив с документами в рамках указанного документооборота.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор конкретного документооборота. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | string(binary) | Архив с документами в рамках конкретного документооборота. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/docflows/{docflowId}/visualization
Получить протокол документооборота.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор конкретного документооборота. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | string(binary) | Pdf файл с данными документооборота. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/docflows/documents/{documentId}/visualization
Скачивание визуализации документа.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
documentId | Да | Path | string(uuid) | Идентификатор документа. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | string(binary) | Файл с визуализацией документа (PDF). |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/docflows/documents/{documentId}
Скачивание документа.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
documentId | Да | Path | string(uuid) | Идентификатор документа. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | string(binary) | Файл документа. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/docflows/newEvents
Получить список измененных ДО.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
dateFrom | Нет | Query | date-time-offset | Дата, с которой необходимо сформировать список идентификаторов, где произошли изменения. |
limit | Нет | Query | integer(int32) | Максимальное количество записей в ответе. Интервал допустимых значений от 1 до 1000 включительно. |
departmentId | Нет | Query | string(uuid) | Идентификатор подразделения, по которому нужно получить ленту событий, если null - лента будет собрана для всех ДО . |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | DocflowChangeInfoChangesListResult | Список идентификаторов документооборотов, по которым есть изменения. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
[PUT]/api/v1/docflows/{docflowId}/changeDepartment/{departmentId}
Переместить документооборот в другое подразделение.
Параметры в строке запроса
Название | Обязат. | Место | Тип | Описание |
---|---|---|---|---|
abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
docflowId | Да | Path | string(uuid) | Идентификатор ДО. |
departmentId | Да | Path | string(uuid) | Идентификатор подразделения. |
Возможные ответы метода
Код | Тип | Описание |
---|---|---|
200 | Без данных | Документооборот перемещён. |
400 | Без данных | Переданы некорректные параметры запроса. |
401 | Без данных | Пользователь не авторизован. |
403 | Без данных | Отказано в доступе. |
404 | Без данных | Ресурс не найден. |
500 | Без данных | Внутренняя ошибка сервера. |
Описание дополнительных моделей
Данный блок содержит описание дополнительных моделей.
AnswerTitleInfo
Дополнительная информация из ответного титула.
Название | Обязат. | Тип | Описание |
---|---|---|---|
resultCode | Да | integer(int32) | Код, обозначающий итог приемки товара (работ, услуг, прав). |
acceptanceDate | Да | date-time-offset | Дата принятия товаров. |
contentOperation | Нет | string | Детальная информация. |
documentOnDisagreements | Нет | Одна из: DocumentOnDisagreements | Реквизиты документа, оформляющего расхождения. |
disagreementAdditionalInfoList | Нет | DisagreementAdditionalInfo[array] | Список ИнфПолФХЖ4. |
Пример модели
ApprovalRouteCounterparty
ОПИСАНИЕ НЕ УКАЗАНО!!!
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Нет | string(uuid) | Идентификатор контрагента |
globalId | Нет | string | Идентификатор участника ЭДО (ИдЭДО) |
name | Нет | string | Название |
inn | Нет | string | Инн |
kpp | Нет | string | Кпп |
Пример модели
ApprovalStepExecutorType
Тип исполнителя шага маршрута согласования
Значение | Описание |
---|---|
Department | Подразделение |
Employee | Сотрудник |
ApprovalStepProgress
Состояние записи шага в истории маршрута согласования
Значение | Описание |
---|---|
Active | Шаг активен |
NotPassed | Шаг не пройден |
Passed | Шаг пройден |
CancellationDirectionType
Направление документа "Предложение об аннулировании".
Значение | Описание |
---|---|
Incoming | Входящее. |
Outgoing | Исходящее. |
CounterpartyInfo
Информация о контрагенте.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор абонента. |
globalId | Да | string | Внешний идентификатор абонента с префиксом оператора. |
name | Да | string | Наименование. |
inn | Да | string | ИНН. |
kpp | Нет | string | КПП. |
certificate | Нет | Одна из: SignInformation | Информация о сертификате. |
warrant | Нет | Одна из: WarrantInfo | МЧД контрагента. |
departmentId | Нет | string(uuid) | Идентификатор подразделения контрагента. |
Пример модели
DisagreementAdditionalInfo
ИнфПолФХЖ4.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string | Идентификатор |
value | Да | string | Значение. |
Пример модели
DisallowedAction
ОПИСАНИЕ НЕ УКАЗАНО!!!
Название | Обязат. | Тип | Описание |
---|---|---|---|
message | Нет | string | |
action | Нет | DocflowAllowedActions |
Пример модели
DispatchResult
Информация об отправленном документе.
Название | Обязат. | Тип | Описание |
---|---|---|---|
draftId | Нет | string(uuid) | Идентификатор черновика. |
docflowId | Нет | string(uuid) | Идентификатор документооборота. |
sendStatus | Нет | Одна из: SendStatus | Статус отправки. |
counterpartyId | Нет | string(uuid) | Идентификатор получателя. |
docflowStatus | Нет | Одна из: DocflowStatus | Статус документооборота. |
description | Нет | string | Описание результата действия. |
senderDepartmentId | Нет | string(uuid) | Идентификатор подразделения отправителя. |
Пример модели
DocflowAllowedActions
Значение | Описание |
---|---|
AcceptCancellation | Принять аннулирование. |
ConfirmReceipt | Подтвердить получение (отправить ИоП). |
Можно ли распечатать документ. | |
Reject | Отклонить документ. |
RejectCancellation | Отклонить аннулирование. |
RequestCancellation | Отправить запрос на аннулирование (ПоА). |
Sign | Подписать документ. |
SignAutomaticTransactions | Сформировать и подписать автоматическую служебную транзакцию. |
VerifyMarkingCodes | Сверить коды маркировки. |
DocflowAnswer
Информация об ответе.
Название | Обязат. | Тип | Описание |
---|---|---|---|
type | Да | Одна из: DocflowAnswerType | Тип. |
clarificationRequestMessage | Нет | string | Причина отказа. |
transactions | Да | Transaction[array] | Список транзакций. |
answerTitleInfo | Нет | Одна из: AnswerTitleInfo | Дополнительная информация в ответном титуле. |
Пример модели
DocflowAnswerType
Тип ответа.
Значение | Описание |
---|---|
Acceptance | Принят. |
FailedToSend | Ошибка при отправке. |
Rejection | Отказан. |
DocflowCancellation
Информация о документе "Предложение об аннулировании"
Название | Обязат. | Тип | Описание |
---|---|---|---|
cancellationDirection | Да | Одна из: CancellationDirectionType | Направление ПОА. |
senderId | Да | string(uuid) | Идентификатор инициатора. |
signInformation | Нет | SignInformation[array] | Информация о подписанте. |
cancellationRequestMessage | Нет | string | Сообщение ПОА. |
transactions | Да | Transaction[array] | Список транзакций. |
cancellationAnswer | Нет | Одна из: DocflowAnswer | Ответ на аннулирование. |
Пример модели
DocflowChangeInfo
Сведения о дате изменения документооборота.
Название | Обязат. | Тип | Описание |
---|---|---|---|
docflowId | Да | string(uuid) | Идентификатор документооборота. |
updateDate | Да | date-time-offset | Дата последнего обновления. |
Пример модели
DocflowChangeInfoChangesListResult
Список идентификаторов документооборотов, по которым есть изменения.
Название | Обязат. | Тип | Описание |
---|---|---|---|
abonentId | Да | string(uuid) | Внутренний идентификатор абонента. |
limit | Да | integer(int32) | Количество запрошенных документооборотов, по которым произошли изменения. |
dateFrom | Нет | date-time-offset | Дата, начиная с которой был получен список идентификаторов ДО с изменениями. |
count | Да | integer(int32) | Количество элементов в результате. |
totalCount | Да | integer(int32) | Общее количество элементов. |
events | Нет | DocflowChangeInfo[array] | Список элементов в результате. |
Пример модели
DocflowCounterparty
Участник документооборота.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор контрагента внутри системы Астрал.ЭДО. |
name | Да | string | Наименование организации. |
inn | Да | string | ИНН контрагента. |
kpp | Нет | string | КПП контрагента. |
departmentId | Нет | string | Идентификатор подразделения контрагента. |
Пример модели
DocflowInfo
Информация по документообороту.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор документооборота. |
docflowPartId | Да | string(uuid) | Идентификатор части документооборота. Это не тоже самое, что общий идентификатор документооборота, данный идентификатор уникален для каждой стороны в рамках одного обмена документами. |
owner | Да | Одна из: CounterpartyInfo | Владелец (инициатор) документооборота. |
counterparty | Да | Одна из: CounterpartyInfo | Вторая сторона документооборота. |
isResponseSignatureRequired | Да | boolean | Признак необходимости ответной подписи. |
direction | Да | Одна из: DocflowSide | Направление документооборота. |
type | Да | Одна из: DocflowType | Тип документооборота. |
status | Да | Одна из: DocflowStatus | Статус документооборота. |
name | Да | string | Наименование документооборота. |
primaryDocumentId | Да | string(uuid) | ID первичного документа. |
primaryDocumentSignatureId | Нет | string(uuid) | ID подписи первичного документа отправителем. |
primaryDocumentFunction | Да | Одна из: DocumentFunction | Функция первичного документа. |
primaryDocumentType | Да | Одна из: DocumentType | Тип первичного документа. |
creationDate | Да | date-time-offset | Дата создания документооборота. |
completionDate | Нет | date-time-offset | Дата завершения документооборота. |
answer | Нет | Одна из: DocflowAnswer | Информация об ответных действиях по документообороту. |
cancellation | Нет | Одна из: DocflowCancellation | Информация о завершении документооборота. |
allowedActions | Да | DocflowAllowedActions[array] | Список доступных действий по документообороту. |
hasLimitedRejectionPeriod | Да | boolean | Флаг о том, что имеется ограничение по времени запроса ПОА. |
hasMarkingCodes | Да | boolean | Признак, что документооборот содержит коды маркировки. |
hasMarkingCodesDisparity | Да | boolean | Флаг наличия несоответствующих кодов маркировок что документооборот содержит коды маркировки содержат несоответствия. |
isViewed | Да | boolean | Признак, что документооборот просмотрен. |
hasMarkingCodeScanningStarted | Да | boolean | Признак, того что начато сканирование кодов маркировки. |
markingProcessing | Нет | Одна из: MarkingProcessing | Информация об обработке кодов маркировки, содержащихся в данном документообороте. |
hasInvalidWarrant | Да | boolean | Признак наличия недействительной доверенности. |
packageId | Нет | string(uuid) | Идентификатор пакета. |
disallowedActions | Нет | DisallowedAction[array] | Список недоступных действий по документообороту. |
permittedUserActions | Нет | DocflowAllowedActions[array] | Список разрешенных пользователю действий. |
isCancellationSupportedByCounterparty | Нет | boolean | Признак поддерживаемости аннулирования контрагентом. |
hasMarkingGisMtErrors | Нет | boolean | true, если документооборот имеет ошибки ГИСМТ |
hasMarkingScanningErrors | Нет | boolean | true, если документооборот имеет ошибки сканирования |
docflowWarrants | Нет | TransactionWarrantInfo[array] | Информация о доверенностях документооборота. |
deal1CId | Нет | string | Идентификатор сделки, для абонентов 1С-Хаб. Предназначен для мигрирующих документов переданных в новый софт Доки |
closedMessageId | Нет | string(uuid) | Идентификатор закрытого сообщения. |
departmentId | Нет | string(uuid) | Идентификатор подразделения, в котором находится документооборот. |
Пример модели
DocflowSide
Направление ДО.
Значение | Описание |
---|---|
Incoming | Входящий. |
Outgoing | Исходящий. |
DocflowStatus
Статус ДО.
Значение | Описание |
---|---|
AwaitingOperatorConfirmation | Ожидается подтверждение оператора. |
AwaitingRecipientResponse | Ожидается ответ получателя. |
CancellationResponseRequired | Требуется аннулирование. |
Cancelled | Аннулирован. |
Completed | Завершен. |
Created | Создано |
CreatingAnswerTitle | Подписывается |
CreatingCancellationAcceptance | Создается согласие с аннулированием |
CreatingCancellationProposal | Создается ПОА |
CreatingCancellationRejection | Создается отклонение аннулирования |
CreatingReceiptConfirmation | Подтверждается получение |
CreatingRejection | Отклоняется |
FailedToSend | Ошибка отправки документа. |
NeedToSignReceiptConfirmation | Требуется подписать ИОП. |
Rejected | Отклонен. |
ResponseSignatureRequired | Требуется подпись. |
Signed | Подписан. |
Unknown | Неопределенный статус документа |
WaitingCancellationResponse | Ожидается аннулирование. |
WaitingReceiptConfirmation | Ожидается извещение о получении. |
WaitingResponseSignature | Ожидается ответная подпись. |
DocflowSummary
Общая информация по документообороту.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | ID документооборота. |
docflowPartId | Да | string(uuid) | Идентификатор части документооборота. Это не тоже самое, что общий идентификатор документооборота, данный идентификатор уникален для каждой стороны в рамках одного обмена документами. |
owner | Да | Одна из: DocflowCounterparty | Владелец (инициатор) документооборота. |
counterparty | Да | Одна из: DocflowCounterparty | Подписант документооборота. |
type | Да | Одна из: DocflowType | Тип документооборота. |
status | Да | Одна из: DocflowStatus | Статус документооборота. |
name | Да | string | Наименование документооборота. |
primaryDocumentId | Да | string(uuid) | ID первичного документа. |
primaryDocumentFunction | Да | Одна из: DocumentFunction | Функция первичного документа. |
primaryDocumentType | Да | Одна из: DocumentType | Тип первичного документа. |
creationDate | Да | date-time-offset | Дата создания документооборота. |
hasMarkingCodes | Да | boolean | Признак, что документооборот содержит коды маркировки. |
hasMarkingCodesDisparity | Да | boolean | Признак, что документооборот содержит коды маркировки, содержащие несоответствия. |
hasMarkingCodeScanningStarted | Да | boolean | Признак, что если начато сканирование кодов маркировки. |
isViewed | Да | boolean | Просмотрен ли документ. |
packageId | Нет | string(uuid) | Идентификатор пакета. |
hasWarrant | Да | boolean | Флаг о том что ДО работает через МЧД. |
deal1CId | Нет | string | Идентификатор сделки, для абонентов 1С-Хаб. Предназначен для мигрирующих документов переданных в новый софт Доки |
answerTitleInfo | Нет | Одна из: AnswerTitleInfo | Дополнительная информация из ответного титула. |
closedMessageId | Нет | string(uuid) | |
isAllowed | Нет | boolean | Имеет ли сотрудник доступ к данному документообороту пакета. |
Пример модели
DocflowSummaryResultList
Список с результатом поиска.
Название | Обязат. | Тип | Описание |
---|---|---|---|
count | Да | integer(int32) | Количество элементов в результате. |
data | Да | DocflowSummary[array] | Список элементов в результате. |
Пример модели
DocflowTransaction
Транзакция.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор. |
relatedTransactionId | Нет | string(uuid) | Связанная транзакция. |
transactionDocumentId | Нет | string(uuid) | Идентификатор переданного документа. |
status | Да | Одна из: TransactionStatus | Статус транзакции. |
type | Да | Одна из: TransactionType | Тип транзакции. |
docflowCode | Да | integer(int32) | Код документооборота. |
transactionCode | Да | integer(int32) | Код транзакции. |
documentCode | Да | integer(int32) | Код документа. |
warrants | Нет | DocumentWarrantInfo[array] | Информация о доверенностях документооборота. |
Пример модели
DocflowTransactionResultList
Список с результатом поиска.
Название | Обязат. | Тип | Описание |
---|---|---|---|
count | Да | integer(int32) | Количество элементов в результате. |
data | Да | DocflowTransaction[array] | Список элементов в результате. |
Пример модели
DocflowType
Тип ДО
Значение | Описание |
---|---|
Act | АКТ. |
Informal | Неформализованный. |
Torg12 | Документ о передаче товаров (Торг-12). |
Utd | УПД/УКД. |
Utd14N | УПД/УКД по приказу 14н. |
DocflowWarrantStatus
Статус доверенности.
Название | Обязат. | Тип | Описание |
---|---|---|---|
code | Да | integer(int32) | Код статуса. |
name | Да | string | Название статуса. |
description | Да | string | Описание статуса. |
Пример модели
DocflowWarrantVerificationResult
Тип проверки валидации на опреаторе.
Значение | Описание |
---|---|
Invalid | Отрицательный результат проверки МЧД |
NotChecked | Проверка МЧД не выполнялась. |
Valid | Положительный результат проверки МЧД |
ValidationInProgress | Ожидает проверку. |
DocumentFunction
Перечисление функций УКД и УПД.
Значение | Описание |
---|---|
DIS | Документ об изменении стоимости отгруженных товаров (выполненных работ, оказанных услуг), переданных имущественных прав (ДИС). |
DOP | Документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг) (ДОП). |
KSCHF | Корректировочный счет-фактура (КСЧФ). |
KSCHFDIS | Корректировочный счет-фактура и документ об изменении стоимости отгруженных товаров (выполненных работ, оказанных услуг), переданных имущественных прав (КСЧФДИС). |
none | Документ не содержит функции. |
SCHF | Счет-фактура (СЧФ). |
SCHFDOP | Счет-фактура и документ об отгрузке товаров (выполнении работ), передаче имущественных прав (документ об оказании услуг) (СЧФДОП). |
DocumentOnDisagreements
Реквизиты документа, оформляющего расхождения.
Название | Обязат. | Тип | Описание |
---|---|---|---|
name | Да | string | Наименование документа. |
number | Нет | string | Номер документа. |
date | Да | date-time-offset | Дата документа. |
Пример модели
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 | УПД. |
DocumentWarrantInfo
Информация о доверенности документа.
Название | Обязат. | Тип | Описание |
---|---|---|---|
number | Да | string | Номер доверенности. |
status | Нет | string | Статус доверенности в реестре ФНС в момент проверки. |
verificationResult | Да | Одна из: DocflowWarrantVerificationResult | Результат проверки доверенности. |
verificationResultDetails | Нет | string | Описание результата проверки МЧД. |
signatureId | Нет | string(uuid) | Ссылка на подпись, к которой довереность относится. |
url | Нет | string | Ссылка на скачивание МЧД. |
startDate | Нет | date-time-offset | Дата начала действия доверенности. |
principals | Да | PrincipalInfo[array] | Информация о доверителях. |
representatives | Нет | RepresentativeInfo[array] | Информация о представителях. |
endDate | Нет | date-time-offset | Дата окончания действия доверенности. |
hasFile | Да | boolean | Признак того,что доверенность была передана файлом. |
Пример модели
FullName
ФИО Доверителя/Представителя.
Название | Обязат. | Тип | Описание |
---|---|---|---|
name | Нет | string | Имя. |
surname | Нет | string | Фамилия. |
patronymic | Нет | string | Отчество. |
Пример модели
History
История прохождения маршрута согласования
Название | Обязат. | Тип | Описание |
---|---|---|---|
totalCount | Нет | integer(int32) | Общее количество шагов |
passedCount | Нет | integer(int32) | Количество пройденных шагов |
approvalRouteId | Нет | string(uuid) | Идентификатор маршрута, по которому был отправлен документ |
approvalRouteName | Нет | string | Название маршрута, по которому был отправлен документ |
historyRecords | Нет | HistoryRecord[array] | Записи в истории |
recipients | Нет | ApprovalRouteCounterparty[array] | Получатели черновика |
Пример модели
HistoryRecord
Запись в истории прохождения маршрута согласования
Название | Обязат. | Тип | Описание |
---|---|---|---|
progress | Нет | Одна из: ApprovalStepProgress | Состояние записи в истории о шаге маршрута |
status | Нет | Одна из: DocumentStatus | Статус документа на маршруте |
statusName | Нет | string | |
executorId | Нет | string(uuid) | Идентификатор исполнителя |
executorType | Нет | Одна из: ApprovalStepExecutorType | Тип исполнителя |
executorName | Нет | string | Имя или название исполнителя |
executorDepartmentName | Нет | string | Название подразделения, к которому относится исполнитель в случае, если это сотрудник |
passedDateTime | Нет | date-time-offset | Время прохождения шага |
comment | Нет | string | Комментарий |
Пример модели
InformationProcessingStatus
Статус обработки.
Значение | Описание |
---|---|
Failed | Отменен. |
Processing | В работе. |
Success | Успешно. |
InformationTransferStatus
Статус передачи.
Значение | Описание |
---|---|
ContainsErrors | Содержит ошибки. |
Processed | Обработан. |
Transferring | Передается. |
MarkingProcessing
Информация о маркировке.
Название | Обязат. | Тип | Описание |
---|---|---|---|
markingProcessingId | Да | string(uuid) | Идентификатор маркировки. |
informationTransferStatus | Да | Одна из: InformationTransferStatus | Статус передачи. |
informationProcessingStatus | Да | Одна из: InformationProcessingStatus | Статус обработки. |
errors | Нет | ProcessingError[array] | Список ошибок. |
gisMtReceiptId | Да | string | Идентификатор квитанции ГИС МТ. |
Пример модели
PrincipalInfo
Информация о доверителе.
Название | Обязат. | Тип | Описание |
---|---|---|---|
inn | Нет | string | ИНН Доверителя. |
name | Нет | string | Наименование доверителя. Заполняется, если доверитель ЮЛ/ИП/ИО/Филиал. |
fullName | Нет | Одна из: FullName | ФИО доверителя. Заполняется, если доверитель ФЛ. |
Пример модели
ProcessingError
Информация об ошибке маркировки.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор ошибки. |
description | Да | string | Описание. |
recommendation | Да | string | Пояснение. |
Пример модели
RepresentativeInfo
Информация о доверенном лице.
Название | Обязат. | Тип | Описание |
---|---|---|---|
inn | Нет | string | ИНН Доверенного лица. |
name | Нет | string | Наименование доверенного лица. Заполняется, если доверенное лицо ЮЛ/ИП/ИО/Филиал. |
fullName | Нет | Одна из: FullName | ФИО доверенного лица. Заполняется, если доверенное лицо ФЛ. |
Пример модели
SendStatus
Статус отправки документа с подписью.
Значение | Описание |
---|---|
IsNotSent | Документ не отправлен. |
Loaded | Документ не отправлен, загружен в черновики. |
Sent | Документ отправлен успешно. |
Undefined | Неизвестный статус |
SignInformation
Информация о подписанте.
Название | Обязат. | Тип | Описание |
---|---|---|---|
signerId | Да | string(uuid) | Идентификатор подписанта. |
serialNumber | Да | string | Серийный номер. |
ownerName | Да | string | Имя владельца. |
ownerSurname | Да | string | Фамилия владельца. |
ownerPatronymic | Нет | string | Отчество владельца. |
certificateAuthority | Да | string | Наименование УЦ. |
Пример модели
Transaction
Информация о транзакции.
Название | Обязат. | Тип | Описание |
---|---|---|---|
id | Да | string(uuid) | Идентификатор транзакции. |
type | Да | Одна из: TransactionType | Тип. |
status | Да | Одна из: TransactionStatus | Статус. |
documentId | Нет | string(uuid) | Идентификатор документа. |
transactionClosingDate | Нет | date-time-offset | Дата закрытия транзакции. |
Пример модели
TransactionStatus
Статусы транзакции.
Значение | Описание |
---|---|
Closed | Завершена. |
Pending | Подготовка. |
Sending | Отправка. |
WaitingDocument | Ожидание отправки или получения документов. |
WaitingSignatures | Ожидание подписи. |
TransactionType
Типы транзакций.
Значение | Описание |
---|---|
AnswerTitle | Ответный титул. |
CancellationAnswer | Положительный ответ на аннулирование (принятие) |
CancellationProposal | Предложение об аннулировании. |
CancellationReject | Отклонение аннулирования |
ClarificationRequest | Уведомление об уточнении |
MarkingProcessingResult | Результат обработки маркировки. |
OperatorErrorMessage | Сообщение об ошибке оператора. |
PrimaryDocument | Первичный документ. |
ReceiptConfirmation | Извещение о получении. |
ReceiptDateConfirmation | Подтверждение даты получения. |
SendDateConfirmation | Подтверждение даты отправки. |
TransactionWarrantInfo
Информация об мчд у транзакции.
Название | Обязат. | Тип | Описание |
---|---|---|---|
type | Нет | Одна из: TransactionType | Тип транзакции. |
warrants | Нет | DocumentWarrantInfo[array] | Информация о доверенностях. |
Пример модели
WarrantInfo
Информация о доверенности.
Название | Обязат. | Тип | Описание |
---|---|---|---|
number | Нет | string | Номер доверенности. |
status | Нет | Одна из: DocflowWarrantStatus | Статус доверенности. |
verificationResult | Да | Одна из: DocflowWarrantVerificationResult | Результат проверки доверенности оператором. |
verificationResultDetails | Нет | string | Описание результата проверки МЧД |
signatureId | Нет | string(uuid) | Ссылка на подпись, к которой довереность относится. |
url | Нет | string | Ссылка на скачивание МЧД. |