Получить список справок
Запрос позволяет получить список справок, имеющийся на стороне банка и удовлетворяющий условиям фильтрации, и их состояние на момент запроса.
Чтобы использовать метод:
- В параметре
scopeссылки авторизации пользователя должен быть указан сервисTAX_DEDUCTION_INFOдля получения доступа к этому ресурсу. - Запросы должны отправляться с токеном доступа (
access_token) пользователя в параметреAuthorizationзаголовка. Подробнее об авторизации в соответствующем разделе документации.
Если ваша схема реализации предполагает фильтрацию по статусам, то значения deductionStatuses должны соответствовать статусной модели (ссылка).
В методе используется Cursor-based пагинация — способ постраничного получения данных, при котором для навигации используется уникальный идентификатор (курсор) последнего элемента предыдущей страницы. Для получения следующей пачки справок вместо передачи номера страницы или смещения необходимо указывать курсор (cursor), сервере вернет следующий набор данных, начиная с элемента, следующего за этим курсором.
Рекомендации по вызову метода
- При первом вызове метода допустимо получение справок за предыдущие 3 года, но не ранее 01.01.2025 года.
- При настройке регулярного получения справок рекомендуем использовать параметры
deductionLastChangeDate, чтобы получать только новые/обновленные в этом временном интервале справки. При этом необходимо пересчитывать from-to параметры относительно предыдущего запроса.
Для запроса установлена пропускная способность: 5tps
- Для получения первой части списка справок отправьте запрос без указания курсора и параметров фильтрации.
- Для получения второй части справок отправьте запрос с курсором, полученным в первом запросе:
cursor == "MjAyNi0wMi0xMVQwOTo1MjowMi4wMzc2NzZaOzFkZDZiMjViLWNhZGEtNGQ3Mi1iMTQ5LTk3NTRkYzEzNTU5ZTsxMTI7MTEw". - Для получения ответа с ошибкой отправьте запрос с параметром
size = 102. - Для получения ответа со статусом 204 отправьте запрос с параметром
size = 101.