Отредактировать заявку на декларацию клиента

PUT

https://secured-openapi.tbank.ru/api/v2/ndfl-3/requests/{taxRequestId}/declaration

Метод редактирует или обновляет декларацию клиента по её идентификатору — RequestId. Элементы заявки, которые не изменяются, всё равно должны быть в запросе — частично обновить заявку нельзя.

Если заявка или вложения к заявке не будут найдены, вернётся ошибка.

Авторизация

Security

Bearer API Token

MTLS-сертификат

RPS

Ограничение — 10 запросов в секунду

Scopes

Декларации 3-НДФЛ → Декларации 3-НДФЛ - Работа с налоговой декларацией

Запрос

Header parameters

Required

If-Match

String

Requirements: <= 50 characters

Версия заявки в формате ETag, которая используется для оптимистичных блокировок. Другое название — casVersion.

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Path parameters

Required

taxRequestId

String<uuid>

Уникальный идентификатор заявки.

Request body schema application/json

Required

primaryForm

Object

Requirements: <= 1000 items

Перечень идентификаторов групп для первичной формы согласно структуре анкеты. Для каждого идентификатора выводится группа для формы (FormGroup).

property name*

Object

Required

String

Requirements: <= 100 characters

Идентификатор группы для формы.

Required

content

Object

Опции внутри группы.

Required

chosenOptions

Object

Required

ndfl3

Object

Перечень идентификаторов групп для первичной декларации согласно структуре анкеты. Для каждого идентификатора выводится группа (Group).

property name*

Object

Required

String

Requirements: <= 100 characters

ID группы опций из структуры анкеты

Required

chosenOptions

Object

property name*

Object

Required

String

Requirements: <= 100 characters

ID опции из структуры анкеты

Required

documents

Object

Перечень идентификаторов документов согласно структуре анкеты для выбранной опции. Для каждого идентификатора выводится список вложений (Attachment)

property name*

Array of objects ()

Requirements: <= 1000 items

Идентификатор вложения.

uuid

Required

incomeSources

Object

Перечень идентификаторов групп доходов согласно структуре анкеты. Для каждого идентификатора выводится группа (Group).

property name*

Object

Required

String

Requirements: <= 100 characters

ID группы опций из структуры анкеты

Required

chosenOptions

Object

property name*

Object

Required

String

Requirements: <= 100 characters

ID опции из структуры анкеты

Required

documents

Object

property name*

Array of objects ()

Requirements: <= 1000 items

Идентификатор вложения.

uuid

Required

taxReturnReasons

Object

Перечень выбранных клиентом идентификаторов групп вычетов согласно структуре анкеты. Для каждого идентификатора выводится группа (Group).

property name*

Object

Required

String

Requirements: <= 100 characters

ID группы опций из структуры анкеты

Required

chosenOptions

Object

property name*

Object

Required

String

Requirements: <= 100 characters

ID опции из структуры анкеты

Required

documents

Object

property name*

Array of objects ()

Requirements: <= 1000 items

Идентификатор вложения.

uuid

finalDocuments

Object

Финальные документы декларации.

Required

exportedFile

String

Requirements: <= 100 characters

Уникальный идентификатор вложения.

Ответ

200

400

Заявка не найдена

401

Ошибка аутентификации

403

Ошибка авторизации

422

Некоторые вложения не найдены

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции