Docflows API

Группа методов для работы со списком документооборотов, а также получения информации по ним.
Обращаем ваше внимание, что данная группа методов считается устаревшей. Мы рекомендуем перейти на новые асинхронные методы.
Документация доступна по ссылке: https://docs.google.com/document/d/1VVzNFnAsc5KcUMtJx2wPe1-fOO9QyRPYZ-vITdMEIUs/edit?tab=t.22dtpl64dkdc#heading=h.35qhuoe7gdim

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

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

---

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

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

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

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

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

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

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

{
  "totalCount": 1,
  "passedCount": 1,
  "approvalRouteId": "Строка",
  "approvalRouteName": "Строка",
  "historyRecords": [
    {
      "progress": "NotPassed",
      "status": "SentToCounterparty",
      "statusName": "Строка",
      "executorId": "Строка",
      "executorType": "Строка",
      "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	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Тело запроса

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

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

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

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

---

[GET]/api/v2/docflows/outgoing

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

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartyId	Нет	Query	string	Идентификатор контрагента (получателя).
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	Без данных	Внутренняя ошибка сервера.

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

{
  "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": "Template",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "hasMarkingCodes": true,
      "hasMarkingCodesDisparity": true,
      "hasMarkingCodeScanningStarted": true,
      "isViewed": true,
      "packageId": "Строка",
      "hasWarrant": true,
      "deal1CId": "Строка",
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      },
      "closedMessageId": "Строка",
      "isAllowed": true,
      "sendingError": "Строка"
    }
  ]
}

---

[GET]/api/v2/docflows/incoming

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

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartyId	Нет	Query	string	Идентификатор контрагента (получателя).
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	Без данных	Внутренняя ошибка сервера.

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

{
  "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": "Template",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "hasMarkingCodes": true,
      "hasMarkingCodesDisparity": true,
      "hasMarkingCodeScanningStarted": true,
      "isViewed": true,
      "packageId": "Строка",
      "hasWarrant": true,
      "deal1CId": "Строка",
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      },
      "closedMessageId": "Строка",
      "isAllowed": true,
      "sendingError": "Строка"
    }
  ]
}

---

[GET]/api/v1/docflows/outgoing

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

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartyId	Нет	Query	string	Идентификатор контрагента (получателя).
Search	Нет	Query	string	Поисковое значение по наименованию.
DocumentTypes	Нет	Query	DocumentTypeFilterOption[array]	Список типов документов.
Status	Нет	Query	string	Статус ДО.
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	Без данных	Внутренняя ошибка сервера.

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

{
  "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": "Template",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "hasMarkingCodes": true,
      "hasMarkingCodesDisparity": true,
      "hasMarkingCodeScanningStarted": true,
      "isViewed": true,
      "packageId": "Строка",
      "hasWarrant": true,
      "deal1CId": "Строка",
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      },
      "closedMessageId": "Строка",
      "isAllowed": true,
      "sendingError": "Строка"
    }
  ]
}

---

[GET]/api/v1/docflows/incoming

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

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
counterpartyId	Нет	Query	string	Идентификатор контрагента (получателя).
Search	Нет	Query	string	Поисковое значение по наименованию.
DocumentTypes	Нет	Query	DocumentTypeFilterOption[array]	Список типов документов.
Status	Нет	Query	string	Статус ДО.
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	Без данных	Внутренняя ошибка сервера.

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

{
  "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": "Template",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "hasMarkingCodes": true,
      "hasMarkingCodesDisparity": true,
      "hasMarkingCodeScanningStarted": true,
      "isViewed": true,
      "packageId": "Строка",
      "hasWarrant": true,
      "deal1CId": "Строка",
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      },
      "closedMessageId": "Строка",
      "isAllowed": true,
      "sendingError": "Строка"
    }
  ]
}

---

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

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

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

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

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

Код	Тип	Описание
200	DocflowInfo	Детальная информация по конкретному документообороту.
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": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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": "Строка",
  "primaryDocumentFunction": "DIS",
  "primaryDocumentType": "Template",
  "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": "Message",
        "status": "Closed",
        "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
        "transactionClosingDate": "2022-02-11T13:03:05.670Z",
        "transportAnswers": [
          {
            "type": "TechnologicalReceipt",
            "message": "Строка",
            "isNegative": true,
            "receivedAt": "2022-02-11T13:03:05.670Z"
          }
        ]
      }
    ],
    "answerTitleInfo": {
      "resultCode": 1,
      "acceptanceDate": "2022-02-11T13:03:05.670Z",
      "contentOperation": "Строка",
      "documentOnDisagreements": {
        "name": "Строка",
        "number": "Строка",
        "date": "2022-02-11T13:03:05.670Z"
      },
      "disagreementAdditionalInfoList": [
        {
          "id": "Строка",
          "value": "Строка"
        }
      ]
    }
  },
  "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": "Message",
        "status": "Closed",
        "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
        "transactionClosingDate": "2022-02-11T13:03:05.670Z",
        "transportAnswers": [
          {
            "type": "TechnologicalReceipt",
            "message": "Строка",
            "isNegative": true,
            "receivedAt": "2022-02-11T13:03:05.670Z"
          }
        ]
      }
    ],
    "cancellationAnswer": {
      "type": "FailedToSend",
      "clarificationRequestMessage": "Причина отказа",
      "transactions": [
        {
          "id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
          "type": "Message",
          "status": "Closed",
          "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
          "transactionClosingDate": "2022-02-11T13:03:05.670Z",
          "transportAnswers": [
            {
              "type": "TechnologicalReceipt",
              "message": "Строка",
              "isNegative": true,
              "receivedAt": "2022-02-11T13:03:05.670Z"
            }
          ]
        }
      ],
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      }
    }
  },
  "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": "Строка",
  "disallowedActions": [
    {
      "message": "Строка",
      "action": "SignAutomaticTransactions"
    }
  ],
  "permittedUserActions": [
    "SignAutomaticTransactions"
  ],
  "isCancellationSupportedByCounterparty": true,
  "hasMarkingGisMtErrors": true,
  "hasMarkingScanningErrors": true,
  "docflowWarrants": [
    {
      "type": "Message",
      "warrants": [
        {
          "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
          "status": "Строка",
          "verificationResult": "ValidationInProgress",
          "verificationResultDetails": "Строка",
          "signatureId": "Строка",
          "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": "Строка",
  "closedMessageId": "Строка",
  "departmentId": "Строка",
  "sendingError": {
    "type": "CancellationRejectionSendingError",
    "message": "Строка"
  },
  "updateDate": "2022-02-11T13:03:05.670Z"
}

---

[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	Без данных	Внутренняя ошибка сервера.

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

{
  "count": 1,
  "data": [
    {
      "id": "281DBF3F-3912-42DE-B747-071B3EC10A64",
      "relatedTransactionId": "DE9B69CE-27CC-4850-951C-99C179DD4FAE",
      "transactionDocumentId": "6F26058B-9383-45DE-9581-03E013786C49",
      "status": "Closed",
      "type": "Message",
      "docflowCode": 28,
      "transactionCode": 1,
      "documentCode": 3,
      "warrants": [
        {
          "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
          "status": "Строка",
          "verificationResult": "ValidationInProgress",
          "verificationResultDetails": "Строка",
          "signatureId": "Строка",
          "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
        }
      ],
      "transportAnswers": [
        {
          "type": "TechnologicalReceipt",
          "message": "Строка",
          "isNegative": true,
          "receivedAt": "2022-02-11T13:03:05.670Z"
        }
      ]
    }
  ]
}

---

[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	string	Максимальное количество записей в ответе. Интервал допустимых значений от 1 до 1000 включительно.
departmentId	Нет	Query	string	Идентификатор подразделения, по которому нужно получить ленту событий, если null - лента будет собрана для всех ДО .

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

Код	Тип	Описание
200	DocflowChangeInfoChangesListResult	Список идентификаторов документооборотов, по которым есть изменения.
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	Да	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.

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

{
  "resultCode": 1,
  "acceptanceDate": "2022-02-11T13:03:05.670Z",
  "contentOperation": "Строка",
  "documentOnDisagreements": {
    "name": "Строка",
    "number": "Строка",
    "date": "2022-02-11T13:03:05.670Z"
  },
  "disagreementAdditionalInfoList": [
    {
      "id": "Строка",
      "value": "Строка"
    }
  ]
}

---

ApprovalRouteCounterparty

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

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

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

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

---

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	Идентификатор подразделения контрагента.

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

{
  "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": "ValidationInProgress",
    "verificationResultDetails": "Строка",
    "signatureId": "Строка",
    "url": "Строка"
  },
  "departmentId": "56877C86-73A4-4D97-BBCF-C63A44153C8C"
}

---

DisagreementAdditionalInfo

ИнфПолФХЖ4.

Название	Обязат.	Тип	Описание
id	Да	string	Идентификатор
value	Да	string	Значение.

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

{
  "id": "Строка",
  "value": "Строка"
}

---

DisallowedAction

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

Название	Обязат.	Тип	Описание
message	Нет	string
action	Нет	DocflowAllowedActions

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

{
  "message": "Строка",
  "action": "SignAutomaticTransactions"
}

---

DispatchResult

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

Название	Обязат.	Тип	Описание
draftId	Нет	string	Идентификатор черновика.
docflowId	Нет	string	Идентификатор документооборота.
sendStatus	Нет	Одна из: SendStatus	Статус отправки.
counterpartyId	Нет	string	Идентификатор получателя.
docflowStatus	Нет	string	Статус документооборота.
description	Нет	string	Описание результата действия.
senderDepartmentId	Нет	string	Идентификатор подразделения отправителя.

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

{
  "draftId": "Строка",
  "docflowId": "Строка",
  "sendStatus": "Loaded",
  "counterpartyId": "Строка",
  "docflowStatus": "Строка",
  "description": "Строка",
  "senderDepartmentId": "Строка"
}

---

DocflowAllowedActions

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

---

DocflowAnswer

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

Название	Обязат.	Тип	Описание
type	Да	Одна из: DocflowAnswerType	Тип.
clarificationRequestMessage	Нет	string	Причина отказа.
transactions	Да	Transaction[array]	Список транзакций.
answerTitleInfo	Нет	Одна из: AnswerTitleInfo	Дополнительная информация в ответном титуле.

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

{
  "type": "FailedToSend",
  "clarificationRequestMessage": "Причина отказа",
  "transactions": [
    {
      "id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
      "type": "Message",
      "status": "Closed",
      "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
      "transactionClosingDate": "2022-02-11T13:03:05.670Z",
      "transportAnswers": [
        {
          "type": "TechnologicalReceipt",
          "message": "Строка",
          "isNegative": true,
          "receivedAt": "2022-02-11T13:03:05.670Z"
        }
      ]
    }
  ],
  "answerTitleInfo": {
    "resultCode": 1,
    "acceptanceDate": "2022-02-11T13:03:05.670Z",
    "contentOperation": "Строка",
    "documentOnDisagreements": {
      "name": "Строка",
      "number": "Строка",
      "date": "2022-02-11T13:03:05.670Z"
    },
    "disagreementAdditionalInfoList": [
      {
        "id": "Строка",
        "value": "Строка"
      }
    ]
  }
}

---

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": "Message",
      "status": "Closed",
      "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
      "transactionClosingDate": "2022-02-11T13:03:05.670Z",
      "transportAnswers": [
        {
          "type": "TechnologicalReceipt",
          "message": "Строка",
          "isNegative": true,
          "receivedAt": "2022-02-11T13:03:05.670Z"
        }
      ]
    }
  ],
  "cancellationAnswer": {
    "type": "FailedToSend",
    "clarificationRequestMessage": "Причина отказа",
    "transactions": [
      {
        "id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
        "type": "Message",
        "status": "Closed",
        "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
        "transactionClosingDate": "2022-02-11T13:03:05.670Z",
        "transportAnswers": [
          {
            "type": "TechnologicalReceipt",
            "message": "Строка",
            "isNegative": true,
            "receivedAt": "2022-02-11T13:03:05.670Z"
          }
        ]
      }
    ],
    "answerTitleInfo": {
      "resultCode": 1,
      "acceptanceDate": "2022-02-11T13:03:05.670Z",
      "contentOperation": "Строка",
      "documentOnDisagreements": {
        "name": "Строка",
        "number": "Строка",
        "date": "2022-02-11T13:03:05.670Z"
      },
      "disagreementAdditionalInfoList": [
        {
          "id": "Строка",
          "value": "Строка"
        }
      ]
    }
  }
}

---

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	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	Идентификатор пакета.
disallowedActions	Нет	DisallowedAction[array]	Список недоступных действий по документообороту.
permittedUserActions	Нет	DocflowAllowedActions[array]	Список разрешенных пользователю действий.
isCancellationSupportedByCounterparty	Нет	boolean	Признак поддерживаемости аннулирования контрагентом.
hasMarkingGisMtErrors	Нет	boolean	true, если документооборот имеет ошибки ГИСМТ
hasMarkingScanningErrors	Нет	boolean	true, если документооборот имеет ошибки сканирования
docflowWarrants	Нет	TransactionWarrantInfo[array]	Информация о доверенностях документооборота.
deal1CId	Нет	string	Идентификатор сделки, для абонентов 1С-Хаб.Предназначен для мигрирующих документов переданных в новый софт Доки
closedMessageId	Нет	string	Идентификатор закрытого сообщения.
departmentId	Нет	string	Идентификатор подразделения, в котором находится документооборот.
sendingError	Нет	Одна из: SendingError	Информация об ошибке отправки исходящей транзакции.
updateDate	Да	date-time-offset	Дата последнего обновления документооборота.

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

{
  "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": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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": "Строка",
  "primaryDocumentFunction": "DIS",
  "primaryDocumentType": "Template",
  "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": "Message",
        "status": "Closed",
        "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
        "transactionClosingDate": "2022-02-11T13:03:05.670Z",
        "transportAnswers": [
          {
            "type": "TechnologicalReceipt",
            "message": "Строка",
            "isNegative": true,
            "receivedAt": "2022-02-11T13:03:05.670Z"
          }
        ]
      }
    ],
    "answerTitleInfo": {
      "resultCode": 1,
      "acceptanceDate": "2022-02-11T13:03:05.670Z",
      "contentOperation": "Строка",
      "documentOnDisagreements": {
        "name": "Строка",
        "number": "Строка",
        "date": "2022-02-11T13:03:05.670Z"
      },
      "disagreementAdditionalInfoList": [
        {
          "id": "Строка",
          "value": "Строка"
        }
      ]
    }
  },
  "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": "Message",
        "status": "Closed",
        "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
        "transactionClosingDate": "2022-02-11T13:03:05.670Z",
        "transportAnswers": [
          {
            "type": "TechnologicalReceipt",
            "message": "Строка",
            "isNegative": true,
            "receivedAt": "2022-02-11T13:03:05.670Z"
          }
        ]
      }
    ],
    "cancellationAnswer": {
      "type": "FailedToSend",
      "clarificationRequestMessage": "Причина отказа",
      "transactions": [
        {
          "id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
          "type": "Message",
          "status": "Closed",
          "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
          "transactionClosingDate": "2022-02-11T13:03:05.670Z",
          "transportAnswers": [
            {
              "type": "TechnologicalReceipt",
              "message": "Строка",
              "isNegative": true,
              "receivedAt": "2022-02-11T13:03:05.670Z"
            }
          ]
        }
      ],
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      }
    }
  },
  "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": "Строка",
  "disallowedActions": [
    {
      "message": "Строка",
      "action": "SignAutomaticTransactions"
    }
  ],
  "permittedUserActions": [
    "SignAutomaticTransactions"
  ],
  "isCancellationSupportedByCounterparty": true,
  "hasMarkingGisMtErrors": true,
  "hasMarkingScanningErrors": true,
  "docflowWarrants": [
    {
      "type": "Message",
      "warrants": [
        {
          "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
          "status": "Строка",
          "verificationResult": "ValidationInProgress",
          "verificationResultDetails": "Строка",
          "signatureId": "Строка",
          "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": "Строка",
  "closedMessageId": "Строка",
  "departmentId": "Строка",
  "sendingError": {
    "type": "CancellationRejectionSendingError",
    "message": "Строка"
  },
  "updateDate": "2022-02-11T13:03:05.670Z"
}

---

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	Идентификатор пакета.
hasWarrant	Да	boolean	Флаг о том что ДО работает через МЧД.
deal1CId	Нет	string	Идентификатор сделки, для абонентов 1С-Хаб.Предназначен для мигрирующих документов переданных в новый софт Доки
answerTitleInfo	Нет	Одна из: AnswerTitleInfo	Дополнительная информация из ответного титула.
closedMessageId	Нет	string
isAllowed	Нет	boolean	Имеет ли сотрудник доступ к данному документообороту пакета.
sendingError	Нет	string	Ошибка отправки исходящей транзакции.

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

{
  "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": "Template",
  "creationDate": "2022-02-11T13:03:05.670Z",
  "hasMarkingCodes": true,
  "hasMarkingCodesDisparity": true,
  "hasMarkingCodeScanningStarted": true,
  "isViewed": true,
  "packageId": "Строка",
  "hasWarrant": true,
  "deal1CId": "Строка",
  "answerTitleInfo": {
    "resultCode": 1,
    "acceptanceDate": "2022-02-11T13:03:05.670Z",
    "contentOperation": "Строка",
    "documentOnDisagreements": {
      "name": "Строка",
      "number": "Строка",
      "date": "2022-02-11T13:03:05.670Z"
    },
    "disagreementAdditionalInfoList": [
      {
        "id": "Строка",
        "value": "Строка"
      }
    ]
  },
  "closedMessageId": "Строка",
  "isAllowed": true,
  "sendingError": "Строка"
}

---

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": "Template",
      "creationDate": "2022-02-11T13:03:05.670Z",
      "hasMarkingCodes": true,
      "hasMarkingCodesDisparity": true,
      "hasMarkingCodeScanningStarted": true,
      "isViewed": true,
      "packageId": "Строка",
      "hasWarrant": true,
      "deal1CId": "Строка",
      "answerTitleInfo": {
        "resultCode": 1,
        "acceptanceDate": "2022-02-11T13:03:05.670Z",
        "contentOperation": "Строка",
        "documentOnDisagreements": {
          "name": "Строка",
          "number": "Строка",
          "date": "2022-02-11T13:03:05.670Z"
        },
        "disagreementAdditionalInfoList": [
          {
            "id": "Строка",
            "value": "Строка"
          }
        ]
      },
      "closedMessageId": "Строка",
      "isAllowed": true,
      "sendingError": "Строка"
    }
  ]
}

---

DocflowTransaction

Транзакция.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор.
relatedTransactionId	Нет	string	Связанная транзакция.
transactionDocumentId	Нет	string	Идентификатор переданного документа.
status	Да	Одна из: TransactionStatus	Статус транзакции.
type	Да	Одна из: TransactionType	Тип транзакции.
docflowCode	Да	integer(int32)	Код документооборота.
transactionCode	Да	integer(int32)	Код транзакции.
documentCode	Да	integer(int32)	Код документа.
warrants	Нет	DocumentWarrantInfo[array]	Информация о доверенностях документооборота.
transportAnswers	Нет	TransportAnswer[array]	Ответные сообщения на исходящие транзакции.

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

{
  "id": "281DBF3F-3912-42DE-B747-071B3EC10A64",
  "relatedTransactionId": "DE9B69CE-27CC-4850-951C-99C179DD4FAE",
  "transactionDocumentId": "6F26058B-9383-45DE-9581-03E013786C49",
  "status": "Closed",
  "type": "Message",
  "docflowCode": 28,
  "transactionCode": 1,
  "documentCode": 3,
  "warrants": [
    {
      "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
      "status": "Строка",
      "verificationResult": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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
    }
  ],
  "transportAnswers": [
    {
      "type": "TechnologicalReceipt",
      "message": "Строка",
      "isNegative": true,
      "receivedAt": "2022-02-11T13:03:05.670Z"
    }
  ]
}

---

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": "Message",
      "docflowCode": 28,
      "transactionCode": 1,
      "documentCode": 3,
      "warrants": [
        {
          "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
          "status": "Строка",
          "verificationResult": "ValidationInProgress",
          "verificationResultDetails": "Строка",
          "signatureId": "Строка",
          "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
        }
      ],
      "transportAnswers": [
        {
          "type": "TechnologicalReceipt",
          "message": "Строка",
          "isNegative": true,
          "receivedAt": "2022-02-11T13:03:05.670Z"
        }
      ]
    }
  ]
}

---

DocflowType

Тип ДО

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

---

DocflowWarrantStatus

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

Название	Обязат.	Тип	Описание
code	Да	integer(int32)	Код статуса.
name	Да	string	Название статуса.
description	Да	string	Описание статуса.

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

{
  "code": 2,
  "name": "Действующая.",
  "description": "Доверенность действует."
}

---

DocflowWarrantVerificationResult

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

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

---

DocumentFunction

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

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

---

DocumentOnDisagreements

Реквизиты документа, оформляющего расхождения.

Название	Обязат.	Тип	Описание
name	Да	string	Наименование документа.
number	Нет	string	Номер документа.
date	Да	date-time-offset	Дата документа.

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

{
  "name": "Строка",
  "number": "Строка",
  "date": "2022-02-11T13:03:05.670Z"
}

---

DocumentStatus

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

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

---

DocumentType

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

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

---

DocumentTypeFilterOption

Фильтр для типов документов.

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

---

DocumentWarrantInfo

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

Название	Обязат.	Тип	Описание
number	Да	string	Номер доверенности.
status	Нет	string	Статус доверенности в реестре ФНС в момент проверки.
verificationResult	Да	Одна из: DocflowWarrantVerificationResult	Результат проверки доверенности.
verificationResultDetails	Нет	string	Описание результата проверки МЧД.
signatureId	Нет	string	Ссылка на подпись, к которой довереность относится.
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": "ValidationInProgress",
  "verificationResultDetails": "Строка",
  "signatureId": "Строка",
  "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	Идентификатор маршрута, по которому был отправлен документ
approvalRouteName	Нет	string	Название маршрута, по которому был отправлен документ
historyRecords	Нет	HistoryRecord[array]	Записи в истории
recipients	Нет	ApprovalRouteCounterparty[array]	Получатели черновика

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

{
  "totalCount": 1,
  "passedCount": 1,
  "approvalRouteId": "Строка",
  "approvalRouteName": "Строка",
  "historyRecords": [
    {
      "progress": "NotPassed",
      "status": "SentToCounterparty",
      "statusName": "Строка",
      "executorId": "Строка",
      "executorType": "Строка",
      "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	Идентификатор исполнителя
executorType	Нет	string	Тип исполнителя
executorName	Нет	string	Имя или название исполнителя
executorDepartmentName	Нет	string	Название подразделения, к которому относится исполнитель в случае, если это сотрудник
passedDateTime	Нет	date-time-offset	Время прохождения шага
comment	Нет	string	Комментарий

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

{
  "progress": "NotPassed",
  "status": "SentToCounterparty",
  "statusName": "Строка",
  "executorId": "Строка",
  "executorType": "Строка",
  "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	Неизвестный статус

---

SendingError

Ошибка отправки исходящей транзакции

Название	Обязат.	Тип	Описание
type	Нет	Одна из: SendingErrorType	Тип ошибки исходящей транзакции.
message	Нет	string	Сообщение об ошибке отправки исходящей транзакции.

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

{
  "type": "CancellationRejectionSendingError",
  "message": "Строка"
}

---

SendingErrorType

Тип ошибки отправки исходящей транзакции.

Значение	Описание
AnswerTitleSendingError	Ошибка отправки ответного титула.
CancellationAcceptanceSendingError	Ошибка отправки принятия аннулирования.
CancellationProposalSendingError	Ошибка отправки предложения об аннулировании.
CancellationRejectionSendingError	Ошибка отправки отклонения аннулирования.
ReceiptConfirmationSendingError	Ошибка отправки ИоП.
RejectionSendingError	Ошибка отправки отклонения первичного документа.
SendingPrimaryError	Ошибка отправки первичного документа.

---

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	Идентификатор документа.
transactionClosingDate	Нет	date-time-offset	Дата закрытия транзакции.
transportAnswers	Нет	TransportAnswer[array]	Ответы транспортного уровня на исходящую транзакцию.Для входящих транзакций будет пустой список.

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

{
  "id": "3A58DBB4-DBEE-4CF9-A1A3-ACF1A0CDF0BC",
  "type": "Message",
  "status": "Closed",
  "documentId": "76B56875-6B2E-4B77-8659-58EB3EDE550F",
  "transactionClosingDate": "2022-02-11T13:03:05.670Z",
  "transportAnswers": [
    {
      "type": "TechnologicalReceipt",
      "message": "Строка",
      "isNegative": true,
      "receivedAt": "2022-02-11T13:03:05.670Z"
    }
  ]
}

---

TransactionStatus

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

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

---

TransactionType

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

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

---

TransactionWarrantInfo

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

Название	Обязат.	Тип	Описание
type	Нет	Одна из: TransactionType	Тип транзакции.
warrants	Нет	DocumentWarrantInfo[array]	Информация о доверенностях.

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

{
  "type": "Message",
  "warrants": [
    {
      "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
      "status": "Строка",
      "verificationResult": "ValidationInProgress",
      "verificationResultDetails": "Строка",
      "signatureId": "Строка",
      "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
    }
  ]
}

---

TransportAnswer

Информация об ответах на исходящую транзакцию.

Название	Обязат.	Тип	Описание
type	Да	Одна из: TransportAnswerType	Тип транспортного ответа.
message	Нет	string	Текст ответного сообщения.
isNegative	Да	boolean	Признак отрицательного ответа.
receivedAt	Нет	date-time-offset	Дата получения ответа на транзакцию.

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

{
  "type": "TechnologicalReceipt",
  "message": "Строка",
  "isNegative": true,
  "receivedAt": "2022-02-11T13:03:05.670Z"
}

---

TransportAnswerType

Тип сообщения на отправленную транзакцию.

Значение	Описание
Ack	Ответ о взятии в обработку отправляемую транзакцию.
TechnologicalReceipt	Транспортная квитанция возникшая после обработки транзакции оператором (получателя).

---

WarrantInfo

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

Название	Обязат.	Тип	Описание
number	Нет	string	Номер доверенности.
status	Нет	Одна из: DocflowWarrantStatus	Статус доверенности.
verificationResult	Да	Одна из: DocflowWarrantVerificationResult	Результат проверки доверенности оператором.
verificationResultDetails	Нет	string	Описание результата проверки МЧД
signatureId	Нет	string	Ссылка на подпись, к которой довереность относится.
url	Нет	string	Ссылка на скачивание МЧД.

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

{
  "number": "cbe7d117-193b-4c25-af55-12ea6dae90c1",
  "status": {
    "code": 2,
    "name": "Действующая.",
    "description": "Доверенность действует."
  },
  "verificationResult": "ValidationInProgress",
  "verificationResultDetails": "Строка",
  "signatureId": "Строка",
  "url": "Строка"
}