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

После отправки черновика ответа на требование появляется документооборот urn:docflow:fns534-inventory или Опись — ответ на требование.

В методах для работы с документооборотом достаточно знать идентификатор docflowId, чтобы отследить документооборот. Опись в свою очередь характеризуют три параметра, поэтому для работы с ней были реализовали отдельные методы. Параметры, которые характеризуют опись:

  • Идентификатор документооборота описи — inventoryId.

  • Идентификатор входящего документооборота, в ответ на которое посылается опись — relatedDocflowId.

  • Идентификатор документа из входящего документооборота, на который была отправлена опись — relatedDocumentId.

Подробная спецификация методов показана в Swagger в разделе InventoriesDocflows.

Список доступных методов

Получение всех отправленных ответов на требование

Метод: GET GetAllInventoryDocflows

С помощью этого метода можно получить список всех отправленных описей. Так как опись формируется в ответ на входящий документооборот, нужно знать два идентификатора: самого документооборота и документа с типом fns534-demand-attachment в нем.

В ответе метод возвращает список документооборотов с метаинформацией. Чтобы получить ограниченную выборку, можно применить различные фильтры (в теле запроса).

Сценарии, в которых можно использовать списки документооборотов:

  • следить за статусом отправленных описей;

  • отображать пользователю списки его документооборотов, применяя различные фильтры.

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

Метод: GET GetOneInventoryDocflow

С помощью этого метода можно получить информацию о документообороте:

  • текущий статус;

  • метаинформацию;

  • список документов;

  • список подписей;

  • и многое другое, полный ответ можно посмотреть в Swagger.

Если текущий статус документооборота подразумевает необходимость отправки ответного документа в контролирующий орган, например, квитанцию о приеме, среди ссылок в ответе этого метода будет ссылка на методы для работы с ответными документами к описи.

Подтверждение дешифрования содержимого документа

Метод: POST ConfirmationDecryptDocument

Подтверждает дешифрование документа, метод возвращает ссылку на расшифрованный контент документа.

Получение контента конкретной подписи под документом

Метод: GET GetSignatureContent

Чтобы получить контент подписи, необходимо передать ее идентификатор. Его можно узнать в методе получения документооборота описи.

Печать документа

Метод: POST DocumentPrint

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

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

deferred — флаг асинхронного выполнения запроса. Принимает значение true. Запрос будет выполнен асинхронно: будет создана задача, статус выполнения которой можно посмотреть по task-id.

Предупреждение

Значение флага false для синхронного вызова метода устарело и больше не используется в методах API. При таком значении флага вернется ошибка 400 BadRequest.

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

  • 202 Accepted — поставлена задача на печать документа, результат можно получить в методе Get DraftDocumentTask.

  • 400 BadRequest — печать невозможна: тип контента или тип документа не поддерживается, либо передано значение флага асинхронного вызова метода deferred — false.

Получение зашифрованного контента документа (deprecated)

Метод: GET GetEncryptedDocumentContent

Внимание

Метод устарел. Вместо него используйте Сервис контентов. Идентификатор контента лежит в параметре content-id.

Зашифрованный контент возвращается в формате base64. Чтобы получить контент, его нужно конвертировать и дешифровать при помощи закрытого ключа, на который он был зашифрован. В результате вы получите архив, который нужно разархивировать.

Максимальный размер возвращаемого контента 32 МБ для тестовой и 64 МБ для рабочей площадки.

Получение расшифрованного контента документа (deprecated)

Метод: GET GetDecryptedDocumentContent

Внимание

Метод устарел. Вместо него используйте Сервис контентов. Идентификатор контента лежит в параметре content-id.

Метод возвращает расшифрованный контент документа. Наличие расшифрованного контента возможно не для всех документов.

Максимальный размер возвращаемого контента 32 МБ для тестовой и 64 МБ для рабочей площадки.

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

На входящие документы от налогового органа налогоплательщик должен отправлять определенные ответные документы. Представленные ниже методы позволяют формировать подобные технологические документы и работать с ними. Также необходимые ссылки для формирования ответных документов будут появляться в работе с методом получения документооборота.

Генерация ответного документа

Метод: POST CreateReplyDocument

Метод генерирует XML-файл документа установленного формата. В результате возвращает идентификатор черновика документа. Также в ответе будет доступна и печатная форма сгенерированного документа.

Просмотр ответного документа

Метод: GET GetReplyDocument

Метод возвращает всю информацию об ответном документе по его идентификатору. У каждого документа будет ссылка на контенты (зашифрованный или расшифрованный, либо оба) в текущем состоянии в соответствии с требованиями контролирующих органов.

Обновление контента ответного документа

Метод: PUT SaveReplyDocumentContent

Метод обновляет контент ответного документа.

Добавление подписи к ответному документу

Метод: PUT SaveReplyDocumentSignature

Метод сохраняет файл подписи к ответному документу.

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

Метод: POST SendReplyDocument

Метод отправляет в контролирующий орган ответный документ с электронной подписью абонента под ним.