API Reference

Получить документы по овердрафту (v2)

Метод позволяет получить документы по овердрафтам пользователя

Response

Параметр

Обязательность

Описание

documentId

Да

Идентификатор документа

documentNumber

Да

Номер документа

documentTypeId

Да

Идентификатор типа документа

documentOperationType

Да

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

documentMethod

Да

Метод документа

documentStatus

Да

Статус документа

documentDate

Да

Дата документа

createdAt

Да

Дата создания

amount

Да

Сумма

symbolId

Да

Символ валюты

amountType

Да

Тип суммы

isAccrual

Да

Признак начисления

userId

Да

ID пользователя

isCoin

Да

Признак криптовалюты

true - криптовалюта

false - фиатная валюта

accountNumber

Да

Номер счета

ledgerAccountId

Да

Идентификатор счета

maxAmount

Да

Текущий доступный лимит овердрафта

overdraftCreatedAt

Да

Дата создания овердрафта

meta

Да

Поля курсорной пагинации

itemsPerPage

Да

Количество объектов на странице

totalItems

Да

Общее количество объектов на странице

currentPage

Да

Текущая страница

totalPages

Да

Общее количество страниц

sortBy

Да

Сортировка (Ask, Desc)

search

Да

Строка, содержащая поисковый запрос

searchBy

Да

Массив полей сущности, по которым должен производиться поиск при использовании search

filter

Да

Фильтры запроса

paginationMode

Да

Вариант пагинации (default, disabled, count)

{
  "data": [
    {
      "documentId": "123x-123x-123x",
      "documentNumber": "33-4",
      "documentTypeId": "00000000-0000-0000-0000",
      "documentOperationType": "repayment",
      "documentMethod": "overdraft",
      "documentStatus": "completed",
      "documentDate": "2025-06-23T00:00:00Z",
      "createdAt": "2025-06-23T12:42:01Z",
      "amount": "100",
      "symbolId": "RUB",
      "amountType": "overdraft",
      "isAccrual": false,
      "userId": "00000000-0000-0000-0000",
      "isCoin": false,
      "accountNumber": "",
      "ledgerAccountId": "",
      "maxAmount": "0",
      "overdraftCreatedAt": "2025-06-23T12:42:01Z"
    }
  ],
  "meta": {
    "itemsPerPage": 1,
    "totalItems": 11687,
    "currentPage": 1,
    "totalPages": 11687,
    "sortBy": null,
    "search": "",
    "searchBy": [],
    "filter": null,
    "paginationMode": "default"
  }
}
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!