Получить список документов по заявкам на выплаты в ESOP

GET

https://secured-openapi.tbank.ru/api/v1/esop/document

Метод возвращает метаданные документов по заявкам на выплаты в виде списка. В качестве параметров можно передать идентификаторы сотрудника, заявки на выплату или документа в ESOP.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

ESOP → Работа с API системы ESOP

Header parameters

X-Request-Id

String<uuid>

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

Query parameters

cursor

String<string>

Requirements: non-empty

Указатель для пагинации.

documentId

String<uuid>

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

employeeId

String<uuid>

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

limit

Integer<int32>

Requirements: <= 2000

Количество документов на странице.

payoutOrderId

String<uuid>

Идентификатор заявки на выплату в системе ESOP.

Ответ

200

400

Некорректный запрос

401

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

403

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

422

Ошибка при обработке данных

429

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

500

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

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

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