Packages API

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

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

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

[POST]/api/v3/packages/{packageId}/dispatch

Отправка пакета документов.

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

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

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

Тело запроса

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

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

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

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

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

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

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

{
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "documents": [
    {
      "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"
    }
  ]
}

[POST]/api/v1/packages/{packageId}

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

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

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

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

Тело запроса

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

Название	Обязат.	Тип	Описание
documents	Да	DocumentWithSign[array]

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

{
  "documents": [
    {
      "document": "ФАЙЛ!!!",
      "documentSign": "ФАЙЛ!!!",
      "warrantNumber": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "isResponseSignature": true
    }
  ]
}

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

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

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

{
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "documents": [
    {
      "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"
    }
  ]
}

[PATCH]/api/v1/packages/{packageId}/drafts/{draftId}/remove

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

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

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

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

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

[GET]/api/v1/packages/{packageId}/drafts

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

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

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

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

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

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

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

[GET]/api/v1/packages/{packageId}/docflows

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

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

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

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

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

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

{
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "count": 1,
  "docflows": [
    {
      "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": "Строка"
    }
  ]
}

[POST]/api/v1/packages/{packageId}/drafts/{draftId}

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

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

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

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

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

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

[PUT]/api/v1/packages/{packageId}/docflows/changeDepartment/{departmentId}

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

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

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

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

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

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

{
  "count": 1,
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "docflowIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

[PATCH]/api/v1/packages/{packageId}/recipientDepartment/{departmentId}

Обновить подразделение получателя пакета.

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

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

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

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

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

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

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"
}

DocflowChangeDepartmentList

Информация по ДО у которых поменяли подразделение.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество ДО.
departmentId	Да	string(uuid)	Идентификатор подразделения.
docflowIds	Да	string(uuid)[array]	Идентификаторы документооборота.

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

{
  "count": 1,
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "docflowIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

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"
}

DocflowPackageInfo

Модель пакета docflows.

Название	Обязат.	Тип	Описание
packageId	Да	string(uuid)	Идентификатор пакета.
count	Да	integer(int32)	Количество ДО в пакете.
docflows	Да	DocflowSummary[array]	Список ДО.

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

{
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "count": 1,
  "docflows": [
    {
      "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": "Строка"
    }
  ]
}

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

DocflowType

Тип ДО

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

DocumentFunction

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

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

DocumentType

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

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

DocumentWithSign

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

Название	Обязат.	Тип	Описание
document	Да	string(binary)	Документ.
documentSign	Нет	string(binary)	Файл открепленной подписи к документу
warrantNumber	Нет	string(uuid)	Номер доверенности.
isResponseSignature	Да	boolean	Признак необходимости ответной подписи. Данный флаг имеет значение только для НЕформализованного документооборота.

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

{
  "document": "ФАЙЛ!!!",
  "documentSign": "ФАЙЛ!!!",
  "warrantNumber": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "isResponseSignature": true
}

DraftDelegation

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

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

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

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

DraftDocument

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

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

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

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

DraftPackageInfo

Модель пакета черновиков.

Название	Обязат.	Тип	Описание
packageId	Да	string(uuid)	Идентификатор пакета.
count	Да	integer(int32)	Количество черновиков в пакете.
drafts	Да	DraftDocument[array]	Список черновиков.

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

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

DraftStatus

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

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

ProcessPackageResult

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

Название	Обязат.	Тип	Описание
packageId	Да	string(uuid)	Идентификатор пакета.
recipientId	Нет	string(uuid)	Идентификатор получателя.
documents	Да	DispatchResult[array]	Список документов.

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

{
  "packageId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "recipientId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "documents": [
    {
      "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"
    }
  ]
}

RecipientInfo

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

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

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

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

SendStatus

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

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

Packages API

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

[POST]/api/v3/packages/{packageId}/dispatch​

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

Тело запроса​

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

[POST]/api/v1/packages/{packageId}​

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

Тело запроса​

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

[PATCH]/api/v1/packages/{packageId}/drafts/{draftId}/remove​

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

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

[GET]/api/v1/packages/{packageId}/drafts​

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

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

[GET]/api/v1/packages/{packageId}/docflows​

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

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

[POST]/api/v1/packages/{packageId}/drafts/{draftId}​

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

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

[PUT]/api/v1/packages/{packageId}/docflows/changeDepartment/{departmentId}​

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

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

[PATCH]/api/v1/packages/{packageId}/recipientDepartment/{departmentId}​

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

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

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

DispatchResult​

DocflowChangeDepartmentList​

DocflowCounterparty​

DocflowPackageInfo​

DocflowStatus​

DocflowSummary​

DocflowType​

DocumentFunction​

DocumentType​

DocumentWithSign​

DraftDelegation​

DraftDocument​

DraftPackageInfo​

DraftStatus​

ProcessPackageResult​

RecipientInfo​

SendStatus​

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

[POST]/api/v3/packages/{packageId}/dispatch

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

Тело запроса

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

[POST]/api/v1/packages/{packageId}

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

Тело запроса

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

[PATCH]/api/v1/packages/{packageId}/drafts/{draftId}/remove

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

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

[GET]/api/v1/packages/{packageId}/drafts

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

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

[GET]/api/v1/packages/{packageId}/docflows

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

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

[POST]/api/v1/packages/{packageId}/drafts/{draftId}

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

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

[PUT]/api/v1/packages/{packageId}/docflows/changeDepartment/{departmentId}

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

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

[PATCH]/api/v1/packages/{packageId}/recipientDepartment/{departmentId}

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

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

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

DispatchResult

DocflowChangeDepartmentList

DocflowCounterparty

DocflowPackageInfo

DocflowStatus

DocflowSummary

DocflowType

DocumentFunction

DocumentType

DocumentWithSign

DraftDelegation

DraftDocument

DraftPackageInfo

DraftStatus

ProcessPackageResult

RecipientInfo

SendStatus