Перейти к основному содержимому

Docflows API

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

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

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


[GET]/api/v3/docflows/{docflowId}/History

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

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

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

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

КодТипОписание
200HistoryИстория прохождения по маршруту согласования
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/v2/docflows

Создать документооборот.

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

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(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)Идентификатор подразделения отправителя.

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

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

[GET]/api/v2/docflows/outgoing

Получение списка исходящих документооборотов.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
counterpartyIdНетQuerystring(uuid)Идентификатор контрагента (получателя).
SearchНетQuerystringПоисковое значение по наименованию.
DocumentTypesНетQueryDocumentTypeFilterOption[array]Список типов документов.
StatusesНетQueryDocflowStatus[array]Список статусов ДО.
FromНетQuerydate-time-offsetФильтрация по дате начала ДО "от".
ToНетQuerydate-time-offsetФильтрация по дате начала ДО "до".
OnlyNotViewedНетQuerybooleanПризнак того, что необходимо вернуть только не просмотренные документообороты.
DepartmentIdsНетQuerystring(uuid)[array]Список подразделений.
offsetНетQueryinteger(int32)Начальное значение списка.
countНетQueryinteger(int32)Количество выводимых значений (По умолчанию: 15).

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

КодТипОписание
200DocflowSummaryResultListСписок исходящих документооборотов.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"count": 1,
"data": [
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}
]
}

[GET]/api/v2/docflows/incoming

Получение списка входящих документооборотов.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
counterpartyIdНетQuerystring(uuid)Идентификатор контрагента (получателя).
SearchНетQuerystringПоисковое значение по наименованию.
DocumentTypesНетQueryDocumentTypeFilterOption[array]Список типов документов.
StatusesНетQueryDocflowStatus[array]Список статусов ДО.
FromНетQuerydate-time-offsetФильтрация по дате начала ДО "от".
ToНетQuerydate-time-offsetФильтрация по дате начала ДО "до".
OnlyNotViewedНетQuerybooleanПризнак того, что необходимо вернуть только не просмотренные документообороты.
offsetНетQueryinteger(int32)Начальное значение списка.
countНетQueryinteger(int32)Количество выводимых значений (По умолчанию: 15).

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

КодТипОписание
200DocflowSummaryResultListСписок входящих документооборотов.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"count": 1,
"data": [
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}
]
}

[GET]/api/v1/docflows/outgoing

Получение списка исходящих документооборотов.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
counterpartyIdНетQuerystring(uuid)Идентификатор контрагента (получателя).
SearchНетQuerystringПоисковое значение по наименованию.
DocumentTypesНетQueryDocumentTypeFilterOption[array]Список типов документов.
StatusНетQueryDocflowStatusСтатус ДО.
FromНетQuerydate-time-offsetФильтрация по дате начала ДО "от".
ToНетQuerydate-time-offsetФильтрация по дате начала ДО "до".
OnlyNotViewedНетQuerybooleanПризнак того что необходимо вернуть только не просмотренные документообороты.
offsetНетQueryinteger(int32)Начальное значение списка.
countНетQueryinteger(int32)Количество выводимых значений (По умолчанию: 15).

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

КодТипОписание
200DocflowSummaryResultListСписок исходящих документооборотов.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"count": 1,
"data": [
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}
]
}

[GET]/api/v1/docflows/incoming

Получение списка входящих документооборотов.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
counterpartyIdНетQuerystring(uuid)Идентификатор контрагента (получателя).
SearchНетQuerystringПоисковое значение по наименованию.
DocumentTypesНетQueryDocumentTypeFilterOption[array]Список типов документов.
StatusНетQueryDocflowStatusСтатус ДО.
FromНетQuerydate-time-offsetФильтрация по дате начала ДО "от".
ToНетQuerydate-time-offsetФильтрация по дате начала ДО "до".
OnlyNotViewedНетQuerybooleanПризнак того что необходимо вернуть только не просмотренные документообороты.
offsetНетQueryinteger(int32)Начальное значение списка.
countНетQueryinteger(int32)Количество выводимых значений (По умолчанию: 15).

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

КодТипОписание
200DocflowSummaryResultListСписок входящих документооборотов.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"count": 1,
"data": [
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}
]
}

[GET]/api/v1/docflows/{docflowId}

Получение детальной информации по указанному документообороту.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор конкретного документооборота.

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

КодТипОписание
200DocflowInfoДетальная информация по конкретному документообороту.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
404Без данныхРесурс не найден.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"globalId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"certificate": {
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
},
"warrant": {
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
},
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"globalId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"certificate": {
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
},
"warrant": {
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
},
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"isResponseSignatureRequired": true,
"direction": "Incoming",
"type": "Utd14N",
"status": "Created",
"name": "АКТ № 00000000007 от 30.06.2021",
"primaryDocumentId": "C2830703-A58D-4441-8C48-3CD096E4383E",
"primaryDocumentSignatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"completionDate": "2022-02-11T13:03:05.670Z",
"answer": {
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
},
"cancellation": {
"cancellationDirection": "Incoming",
"senderId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"signInformation": [
{
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
}
],
"cancellationRequestMessage": "Сообщение предложения об аннулировании",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
],
"cancellationAnswer": {
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
}
},
"allowedActions": [
"SignAutomaticTransactions"
],
"hasLimitedRejectionPeriod": true,
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"isViewed": true,
"hasMarkingCodeScanningStarted": true,
"markingProcessing": {
"markingProcessingId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"informationTransferStatus": "Transferring",
"informationProcessingStatus": "Failed",
"errors": [
{
"id": "CC980B27-7350-4380-956B-5B6F8D238C3E",
"description": "Документ с таким номером уже зарегистрирован в ГИС МТ.",
"recommendation": "Необходимо обратиться в техническую поддержку ГИС МТ “Честный знак” по номеру телефона 8 800 222 15 23 или написать письмо на почту support@crpt.ru"
}
],
"gisMtReceiptId": "818C5ED5-CEF8-4FC3-B805-F2E7AC08F263"
},
"hasInvalidWarrant": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"disallowedActions": [
{
"message": "Строка",
"action": "SignAutomaticTransactions"
}
],
"permittedUserActions": [
"SignAutomaticTransactions"
],
"isCancellationSupportedByCounterparty": true,
"hasMarkingGisMtErrors": true,
"hasMarkingScanningErrors": true,
"docflowWarrants": [
{
"type": "CancellationReject",
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}
],
"deal1CId": "Строка"
}

[PUT]/api/v1/docflows/{docflowId}/viewed

Отметить документооборот как просмотренный.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор конкретного документооборота.

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

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

[GET]/api/v1/docflows/{docflowId}/transactions

Получить список транзакций по указанному документообороту.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор конкретного документооборота.

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

КодТипОписание
200DocflowTransactionResultListСписок транзакций в рамках конкретного документооборота.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
404Без данныхРесурс не найден.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"count": 1,
"data": [
{
"id": "281DBF3F-3912-42DE-B747-071B3EC10A64",
"relatedTransactionId": "DE9B69CE-27CC-4850-951C-99C179DD4FAE",
"transactionDocumentId": "6F26058B-9383-45DE-9581-03E013786C49",
"status": "Closed",
"type": "CancellationReject",
"docflowCode": 28,
"transactionCode": 1,
"documentCode": 3,
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}
]
}

[GET]/api/v1/docflows/{docflowId}/documents/files

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

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор конкретного документооборота.

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

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

[GET]/api/v1/docflows/{docflowId}/visualization

Получить протокол документооборота.

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор конкретного документооборота.

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

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

[GET]/api/v1/docflows/documents/{documentId}/visualization

Скачивание визуализации документа.

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

НазваниеОбязат.МестоТипОписание
documentIdДаPathstring(uuid)Идентификатор документа.

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

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

[GET]/api/v1/docflows/documents/{documentId}

Скачивание документа.

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

НазваниеОбязат.МестоТипОписание
documentIdДаPathstring(uuid)Идентификатор документа.

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

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

[GET]/api/v1/docflows/newEvents

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

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

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

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

КодТипОписание
200DocflowChangeInfoChangesListResultСписок идентификаторов документооборотов, по которым есть изменения.
400Без данныхПереданы некорректные параметры запроса.
401Без данныхПользователь не авторизован.
403Без данныхОтказано в доступе.
500Без данныхВнутренняя ошибка сервера.
Пример успешного ответа
{
"abonentId": " 41ea218c-8539-49e4-83a9-9032ed6abc01 ",
"limit": 1,
"dateFrom": "2022-02-11T13:03:05.670Z",
"count": 1,
"totalCount": 1,
"events": [
{
"docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"updateDate": "2022-02-11T13:03:05.670Z"
}
]
}

[PUT]/api/v1/docflows/{docflowId}/changeDepartment/{departmentId}

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

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

НазваниеОбязат.МестоТипОписание
abonentIdДаHeaderstring(uuid)Внутренний идентификатор абонента.
docflowIdДаPathstring(uuid)Идентификатор ДО.
departmentIdДаPathstring(uuid)Идентификатор подразделения.

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

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

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

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


ApprovalStepExecutorType

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

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

ApprovalStepProgress

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

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

CancellationDirectionType

Направление документа "Предложение об аннулировании".

ЗначениеОписание
IncomingВходящее.
OutgoingИсходящее.

Counterparty

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

НазваниеОбязат.ТипОписание
idНетstring(uuid)Идентификатор контрагента
globalIdНетstringИдентификатор участника ЭДО (ИдЭДО)
nameНетstringНазвание
innНетstringИнн
kppНетstringКпп
Пример модели
{
"id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"globalId": "Строка",
"name": "Строка",
"inn": "Строка",
"kpp": "Строка"
}

CounterpartyInfo

Информация о контрагенте.

НазваниеОбязат.ТипОписание
idДаstring(uuid)Идентификатор абонента.
globalIdДаstringВнешний идентификатор абонента с префиксом оператора.
nameДаstringНаименование.
innДаstringИНН.
kppНетstringКПП.
certificateНетОдна из: SignInformationИнформация о сертификате.
warrantНетОдна из: WarrantInfoМЧД контрагента.
departmentIdНетstring(uuid)Идентификатор подразделения контрагента.
Пример модели
{
"id": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"globalId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"certificate": {
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
},
"warrant": {
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
},
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
}

DisallowedAction

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

НазваниеОбязат.ТипОписание
messageНетstring
actionНетDocflowAllowedActions
Пример модели
{
"message": "Строка",
"action": "SignAutomaticTransactions"
}

DispatchResult

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

НазваниеОбязат.ТипОписание
draftIdНетstring(uuid)Идентификатор черновика.
docflowIdНетstring(uuid)Идентификатор документооборота.
sendStatusНетОдна из: SendStatusСтатус отправки.
counterpartyIdНетstring(uuid)Идентификатор получателя.
docflowStatusНетОдна из: DocflowStatusСтатус документооборота.
descriptionНетstringОписание результата действия.
senderDepartmentIdНетstring(uuid)Идентификатор подразделения отправителя.
Пример модели
{
"draftId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"sendStatus": "Loaded",
"counterpartyId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"docflowStatus": "Created",
"description": "Строка",
"senderDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

DocflowAllowedActions

ЗначениеОписание
AcceptCancellationПринять аннулирование.
ConfirmReceiptПодтвердить получение (отправить ИоП).
PrintМожно ли распечатать документ.
RejectОтклонить документ.
RejectCancellationОтклонить аннулирование.
RequestCancellationОтправить запрос на аннулирование (ПоА).
SignПодписать документ.
SignAutomaticTransactionsСформировать и подписать автоматическую служебную транзакцию.
VerifyMarkingCodesСверить коды маркировки.

DocflowAnswer

Информация об ответе.

НазваниеОбязат.ТипОписание
typeДаОдна из: DocflowAnswerTypeТип.
clarificationRequestMessageНетstringПричина отказа.
transactionsДаTransaction[array]Список транзакций.
Пример модели
{
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
}

DocflowAnswerType

Тип ответа.

ЗначениеОписание
AcceptanceПринят.
FailedToSendОшибка при отправке.
RejectionОтказан.

DocflowCancellation

Информация о документе "Предложение об аннулировании"

НазваниеОбязат.ТипОписание
cancellationDirectionДаОдна из: CancellationDirectionTypeНаправление ПОА.
senderIdДаstring(uuid)Идентификатор инициатора.
signInformationНетSignInformation[array]Информация о подписанте.
cancellationRequestMessageНетstringСообщение ПОА.
transactionsДаTransaction[array]Список транзакций.
cancellationAnswerНетОдна из: DocflowAnswerОтвет на аннулирование.
Пример модели
{
"cancellationDirection": "Incoming",
"senderId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"signInformation": [
{
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
}
],
"cancellationRequestMessage": "Сообщение предложения об аннулировании",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
],
"cancellationAnswer": {
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
}
}

DocflowChangeInfo

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

НазваниеОбязат.ТипОписание
docflowIdДаstring(uuid)Идентификатор документооборота.
updateDateДаdate-time-offsetДата последнего обновления.
Пример модели
{
"docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"updateDate": "2022-02-11T13:03:05.670Z"
}

DocflowChangeInfoChangesListResult

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

НазваниеОбязат.ТипОписание
abonentIdДаstring(uuid)Внутренний идентификатор абонента.
limitДаinteger(int32)Количество запрошенных документооборотов, по которым произошли изменения.
dateFromНетdate-time-offsetДата, начиная с которой был получен список идентификаторов ДО с изменениями.
countДаinteger(int32)Количество элементов в результате.
totalCountДаinteger(int32)Общее количество элементов.
eventsНетDocflowChangeInfo[array]Список элементов в результате.
Пример модели
{
"abonentId": " 41ea218c-8539-49e4-83a9-9032ed6abc01 ",
"limit": 1,
"dateFrom": "2022-02-11T13:03:05.670Z",
"count": 1,
"totalCount": 1,
"events": [
{
"docflowId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"updateDate": "2022-02-11T13:03:05.670Z"
}
]
}

DocflowCounterparty

Участник документооборота.

НазваниеОбязат.ТипОписание
idДаstring(uuid)Идентификатор контрагента внутри системы Астрал.ЭДО.
nameДаstringНаименование организации.
innДаstringИНН контрагента.
kppНетstringКПП контрагента.
departmentIdНетstringИдентификатор подразделения контрагента.
Пример модели
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
}

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Нетbooleantrue, если документооборот имеет ошибки ГИСМТ
hasMarkingScanningErrorsНетbooleantrue, если документооборот имеет ошибки сканирования
docflowWarrantsНетTransactionWarrantInfo[array]Информация о доверенностях документооборота.
deal1CIdНетstringИдентификатор сделки, для абонентов 1С-Хаб.
Предназначен для мигрирующих документов переданных в новый софт Доки
Пример модели
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"globalId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"certificate": {
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
},
"warrant": {
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
},
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"globalId": "2AEF9596552-364A-402E-AFFE-7C01F9C1B449",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"certificate": {
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
},
"warrant": {
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
},
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"isResponseSignatureRequired": true,
"direction": "Incoming",
"type": "Utd14N",
"status": "Created",
"name": "АКТ № 00000000007 от 30.06.2021",
"primaryDocumentId": "C2830703-A58D-4441-8C48-3CD096E4383E",
"primaryDocumentSignatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"completionDate": "2022-02-11T13:03:05.670Z",
"answer": {
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
},
"cancellation": {
"cancellationDirection": "Incoming",
"senderId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"signInformation": [
{
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
}
],
"cancellationRequestMessage": "Сообщение предложения об аннулировании",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
],
"cancellationAnswer": {
"type": "FailedToSend",
"clarificationRequestMessage": "Причина отказа",
"transactions": [
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}
]
}
},
"allowedActions": [
"SignAutomaticTransactions"
],
"hasLimitedRejectionPeriod": true,
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"isViewed": true,
"hasMarkingCodeScanningStarted": true,
"markingProcessing": {
"markingProcessingId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"informationTransferStatus": "Transferring",
"informationProcessingStatus": "Failed",
"errors": [
{
"id": "CC980B27-7350-4380-956B-5B6F8D238C3E",
"description": "Документ с таким номером уже зарегистрирован в ГИС МТ.",
"recommendation": "Необходимо обратиться в техническую поддержку ГИС МТ “Честный знак” по номеру телефона 8 800 222 15 23 или написать письмо на почту support@crpt.ru"
}
],
"gisMtReceiptId": "818C5ED5-CEF8-4FC3-B805-F2E7AC08F263"
},
"hasInvalidWarrant": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"disallowedActions": [
{
"message": "Строка",
"action": "SignAutomaticTransactions"
}
],
"permittedUserActions": [
"SignAutomaticTransactions"
],
"isCancellationSupportedByCounterparty": true,
"hasMarkingGisMtErrors": true,
"hasMarkingScanningErrors": true,
"docflowWarrants": [
{
"type": "CancellationReject",
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}
],
"deal1CId": "Строка"
}

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С-Хаб.
Предназначен для мигрирующих документов переданных в новый софт Доки
Пример модели
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}

DocflowSummaryResultList

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

НазваниеОбязат.ТипОписание
countДаinteger(int32)Количество элементов в результате.
dataДаDocflowSummary[array]Список элементов в результате.
Пример модели
{
"count": 1,
"data": [
{
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"docflowPartId": "738D2745-B5EF-4E37-8C60-08E17C623499",
"owner": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"counterparty": {
"id": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
"name": "Рога и Копыта",
"inn": "9678731893",
"kpp": "999901006",
"departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
},
"type": "Utd14N",
"status": "Created",
"name": "Акт № 1 от 29.07.2020",
"primaryDocumentId": "D45E6D2B-7929-4499-A8CE-06D9CA9EEACF",
"primaryDocumentFunction": "DIS",
"primaryDocumentType": "OperatorErrorMessage",
"creationDate": "2022-02-11T13:03:05.670Z",
"hasMarkingCodes": true,
"hasMarkingCodesDisparity": true,
"hasMarkingCodeScanningStarted": true,
"isViewed": true,
"packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"hasWarrant": true,
"deal1CId": "Строка"
}
]
}

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]Информация о доверенностях документооборота.
Пример модели
{
"id": "281DBF3F-3912-42DE-B747-071B3EC10A64",
"relatedTransactionId": "DE9B69CE-27CC-4850-951C-99C179DD4FAE",
"transactionDocumentId": "6F26058B-9383-45DE-9581-03E013786C49",
"status": "Closed",
"type": "CancellationReject",
"docflowCode": 28,
"transactionCode": 1,
"documentCode": 3,
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}

DocflowTransactionResultList

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

НазваниеОбязат.ТипОписание
countДаinteger(int32)Количество элементов в результате.
dataДаDocflowTransaction[array]Список элементов в результате.
Пример модели
{
"count": 1,
"data": [
{
"id": "281DBF3F-3912-42DE-B747-071B3EC10A64",
"relatedTransactionId": "DE9B69CE-27CC-4850-951C-99C179DD4FAE",
"transactionDocumentId": "6F26058B-9383-45DE-9581-03E013786C49",
"status": "Closed",
"type": "CancellationReject",
"docflowCode": 28,
"transactionCode": 1,
"documentCode": 3,
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}
]
}

DocflowType

Тип ДО

ЗначениеОписание
ActАКТ.
InformalНеформализованный.
Torg12Документ о передаче товаров (Торг-12).
UtdУПД/УКД.
Utd14NУПД/УКД по приказу 14н.

DocflowWarrantStatus

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

НазваниеОбязат.ТипОписание
codeДаinteger(int32)Код статуса.
nameДаstringНазвание статуса.
descriptionДаstringОписание статуса.
Пример модели
{
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
}

DocflowWarrantVerificationResult

Тип проверки валидации на опреаторе.

ЗначениеОписание
InvalidОтрицательный результат проверки МЧД
NotCheckedПроверка МЧД не выполнялась.
ValidПоложительный результат проверки МЧД

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УПД.

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Признак того,что доверенность была передана файлом.
Пример модели
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}

FullName

ФИО Доверителя/Представителя.

НазваниеОбязат.ТипОписание
nameНетstringИмя.
surnameНетstringФамилия.
patronymicНетstringОтчество.
Пример модели
{
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}

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": "Строка"
}

InformationProcessingStatus

Статус обработки.

ЗначениеОписание
FailedОтменен.
ProcessingВ работе.
SuccessУспешно.

InformationTransferStatus

Статус передачи.

ЗначениеОписание
ContainsErrorsСодержит ошибки.
ProcessedОбработан.
TransferringПередается.

MarkingProcessing

Информация о маркировке.

НазваниеОбязат.ТипОписание
markingProcessingIdДаstring(uuid)Идентификатор маркировки.
informationTransferStatusДаОдна из: InformationTransferStatusСтатус передачи.
informationProcessingStatusДаОдна из: InformationProcessingStatusСтатус обработки.
errorsНетProcessingError[array]Список ошибок.
gisMtReceiptIdДаstringИдентификатор квитанции ГИС МТ.
Пример модели
{
"markingProcessingId": "1E536C56-34BA-47E1-97B0-8905EE6FA9E3",
"informationTransferStatus": "Transferring",
"informationProcessingStatus": "Failed",
"errors": [
{
"id": "CC980B27-7350-4380-956B-5B6F8D238C3E",
"description": "Документ с таким номером уже зарегистрирован в ГИС МТ.",
"recommendation": "Необходимо обратиться в техническую поддержку ГИС МТ “Честный знак” по номеру телефона 8 800 222 15 23 или написать письмо на почту support@crpt.ru"
}
],
"gisMtReceiptId": "818C5ED5-CEF8-4FC3-B805-F2E7AC08F263"
}

PrincipalInfo

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

НазваниеОбязат.ТипОписание
innНетstringИНН Доверителя.
nameНетstringНаименование доверителя. Заполняется, если доверитель ЮЛ/ИП/ИО/Филиал.
fullNameНетОдна из: FullNameФИО доверителя. Заполняется, если доверитель ФЛ.
Пример модели
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}

ProcessingError

Информация об ошибке маркировки.

НазваниеОбязат.ТипОписание
idДаstring(uuid)Идентификатор ошибки.
descriptionДаstringОписание.
recommendationДаstringПояснение.
Пример модели
{
"id": "CC980B27-7350-4380-956B-5B6F8D238C3E",
"description": "Документ с таким номером уже зарегистрирован в ГИС МТ.",
"recommendation": "Необходимо обратиться в техническую поддержку ГИС МТ “Честный знак” по номеру телефона 8 800 222 15 23 или написать письмо на почту support@crpt.ru"
}

RepresentativeInfo

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

НазваниеОбязат.ТипОписание
innНетstringИНН Доверенного лица.
nameНетstringНаименование доверенного лица. Заполняется, если доверенное лицо ЮЛ/ИП/ИО/Филиал.
fullNameНетОдна из: FullNameФИО доверенного лица. Заполняется, если доверенное лицо ФЛ.
Пример модели
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}

SendStatus

Статус отправки документа с подписью.

ЗначениеОписание
IsNotSentДокумент не отправлен.
LoadedДокумент не отправлен, загружен в черновики.
SentДокумент отправлен успешно.
UndefinedНеизвестный статус

SignInformation

Информация о подписанте.

НазваниеОбязат.ТипОписание
signerIdДаstring(uuid)Идентификатор подписанта.
serialNumberДаstringСерийный номер.
ownerNameДаstringИмя владельца.
ownerSurnameДаstringФамилия владельца.
ownerPatronymicНетstringОтчество владельца.
certificateAuthorityДаstringНаименование УЦ.
Пример модели
{
"signerId": "F9596552-364A-402E-AFFE-7C01F9C1B449",
"serialNumber": "01D616E407A9C7500000001703410002",
"ownerName": "Константин",
"ownerSurname": "Константинопольский",
"ownerPatronymic": "Константинович",
"certificateAuthority": "Тестовое УЦ"
}

Transaction

Информация о транзакции.

НазваниеОбязат.ТипОписание
idДаstring(uuid)Идентификатор транзакции.
typeДаОдна из: TransactionTypeТип.
statusДаОдна из: TransactionStatusСтатус.
documentIdНетstring(uuid)Идентификатор документа.
transactionClosingDateНетdate-time-offsetДата закрытия транзакции.
Пример модели
{
"id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
"type": "CancellationReject",
"status": "Closed",
"documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
"transactionClosingDate": "2022-02-11T13:03:05.670Z"
}

TransactionStatus

Статусы транзакции.

ЗначениеОписание
ClosedЗавершена.
PendingПодготовка.
SendingОтправка.
WaitingDocumentОжидание отправки или получения документов.
WaitingSignaturesОжидание подписи.

TransactionType

Типы транзакций.

ЗначениеОписание
AnswerTitleОтветный титул.
CancellationAnswerПоложительный ответ на аннулирование (принятие)
CancellationProposalПредложение об аннулировании.
CancellationRejectОтклонение аннулирования
ClarificationRequestУведомление об уточнении
MarkingProcessingResultРезультат обработки маркировки.
OperatorErrorMessageСообщение об ошибке оператора.
PrimaryDocumentПервичный документ.
ReceiptConfirmationИзвещение о получении.
ReceiptDateConfirmationПодтверждение даты получения.
SendDateConfirmationПодтверждение даты отправки.

TransactionWarrantInfo

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

НазваниеОбязат.ТипОписание
typeНетОдна из: TransactionTypeТип транзакции.
warrantsНетDocumentWarrantInfo[array]Информация о доверенностях.
Пример модели
{
"type": "CancellationReject",
"warrants": [
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": "Строка",
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка",
"startDate": "2022-02-11T13:03:05.670Z",
"principals": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"representatives": [
{
"inn": "Строка",
"name": "Строка",
"fullName": {
"name": "Строка",
"surname": "Строка",
"patronymic": "Строка"
}
}
],
"endDate": "2022-02-11T13:03:05.670Z",
"hasFile": true
}
]
}

WarrantInfo

Информация о доверенности.

НазваниеОбязат.ТипОписание
numberНетstringНомер доверенности.
statusНетОдна из: DocflowWarrantStatusСтатус доверенности.
verificationResultДаОдна из: DocflowWarrantVerificationResultРезультат проверки доверенности оператором.
verificationResultDetailsНетstringОписание результата проверки МЧД
signatureIdНетstring(uuid)Ссылка на подпись, к которой довереность относится.
urlНетstringСсылка на скачивание МЧД.
Пример модели
{
"number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
"status": {
"code": 2,
"name": "Действующая.",
"description": "Доверенность действует."
},
"verificationResult": "Invalid",
"verificationResultDetails": "Строка",
"signatureId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
"url": "Строка"
}