Получение списка валютных договоров

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

Endpoint	GET /demands/foreign-exchange-contracts
Content-Type	application/json
Response status	200 OK

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

Параметр	Тип	Описание
search	string	Единый поиск сразу по номеру договора, номеру УНВД или контрагенту
counterParty	string	Фильтр по контрагенту
contractNumber	string	Фильтр по номеру контракта
conContractNumber	string	Фильтр по номеру УНВД
statusCode	string	Код статуса договора (например, 1 — открыт)
contractCurrency	string	Валюта договора
isImport	boolean	Фильтр: импортные договоры
isExport	boolean	Фильтр: экспортные договоры
sort	string	Сортировка, например endDate,desc
page	int	Номер страницы (с нуля)
size	int	Размер страницы

примечание

Параметр search ищет одновременно по номеру договора, номеру УНВД и наименованию контрагента. Для точечной фильтрации используйте contractNumber, conContractNumber или counterParty.

Ответ

Ответ — стандартная постраничная обёртка (Page): метаданные пагинации и массив content[] с договорами.

Поле	Тип	Описание
content	array of objects	Список договоров (ForeignExchangeContract)
totalElements	long	Всего записей
totalPages	int	Всего страниц
number	int	Текущая страница (с нуля)
size	int	Размер страницы
numberOfElements	int	Записей на текущей странице
first / last	boolean	Признак первой / последней страницы
empty	boolean	Пустая ли страница
pageable / sort	object	Параметры пагинации и сортировки

Object: content -> object (ForeignExchangeContract)

Поле	Тип	Описание
id / externalId	long / string	Идентификаторы контракта в Системе и внешний
customerId	long	Идентификатор организации
contractNumber / contractDate	string / date	Номер и дата договора
conContractNumber / conContractNumberDate	string / date	Номер и дата УНВД
contractAmount / contractCurrency	decimal / string	Сумма и валюта договора
endDate	date	Дата окончания договора
isExpired	boolean	Срок договора истёк
counterparty	string	Наименование инопартнёра
counterparties	array of objects	Реквизиты инопартнёров: name, address, bankAccount, bankName, bankSwift, countryCode, countryName, benefCode, econSector, residency, okved
balance	decimal	Сумма совершённых платежей (в валюте договора)
contractUsdBalance	decimal	Сумма совершённых платежей в долларах США
conversionBalance	decimal	Осталось сконвертировать
conversionSum	decimal	Общая сумма конвертации в валюте договора
paymentSum	decimal	Оставшаяся доступная сумма
paymentCurrency	string	Валюта платежа
dio	decimal	Сумма всех исполненных обязательств
difference	decimal	Разница
status	object	Статус контракта: code, label, category, nameMap
contractType / contractTypeCode	object / string	Предмет договора + импорт/экспорт (суффикс _1 — экспорт, _2 — импорт)
contractSubject	object	Предмет договора (valueRu, valueKz, valueEng)
bankBranchCode / bankBranchName	string	Код и название филиала
knp / operationCode / tnvedCode	array / array / string	Коды КНП / КБО / ТНВЭД
repatriation	string	Срок репатриации
extraRequirements	array of objects	Дополнительные требования (name, code)
files	array of objects	Файлы (id, uuid, name, type, например FIRST_OR_LAST_PAGE)
actions	array of string	Доступные действия в интерфейсе
alias / defaultAlias / displayOrder / visible	string / string / double / boolean	Параметры отображения

Пример запроса

cURL

curl --location \
  'https://api-test.business-t.berekebank.kz/demands/foreign-exchange-contracts?sort=endDate,desc&statusCode=1&isImport=false&isExport=false&page=0&size=10' \
  --header 'Authorization: Bearer <token>'

Показать примеры фильтрации

Поиск (единый)

GET /demands/foreign-exchange-contracts?search=Протокол №3&statusCode=1&page=0&size=10

По контрагенту

GET /demands/foreign-exchange-contracts?counterParty=Демо Импорт&statusCode=1&page=0&size=10

По номеру контракта

GET /demands/foreign-exchange-contracts?contractNumber=ДЕМО-3/19-003&statusCode=1&page=0&size=10

По номеру УНВД

GET /demands/foreign-exchange-contracts?conContractNumber=2/000/0000/0000&statusCode=1&page=0&size=10

Пример ответа

Показать ответ

200 OK

{
  "totalElements": 1,
  "totalPages": 1,
  "last": true,
  "pageable": {
    "unpaged": false,
    "paged": true,
    "pageNumber": 0,
    "pageSize": 10,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    }
  },
  "numberOfElements": 1,
  "first": true,
  "size": 10,
  "content": [
    {
      "id": 142840,
      "externalId": "216471",
      "customerId": 1160,
      "contractNumber": "ДЕМО-3/19-003",
      "contractDate": "14.06.2019",
      "conContractNumber": "2/000/0000/0000",
      "conContractNumberDate": "14.02.2020",
      "contractAmount": 3000000000,
      "contractCurrency": "RUB",
      "endDate": "31.12.2025",
      "counterparty": "ООО «Демо Импорт»",
      "balance": 1839476323.73,
      "contractUsdBalance": 46422719.83,
      "conversionBalance": 1742903394.84,
      "status": {
        "id": 1157,
        "externalId": "1",
        "code": "1",
        "category": "ForeignExchangeContractStatus",
        "label": "Открыт",
        "nameKey": null,
        "nameMap": null,
        "deleted": null
      },
      "paymentCurrency": "RUB",
      "counterparties": [
        {
          "id": 2362249,
          "externalId": "189979",
          "name": "ООО «Демо Импорт»",
          "countryCode": "RUS",
          "address": "г. Москва",
          "isDefault": true,
          "benefCode": "29",
          "econSector": null,
          "bankAccount": null,
          "bankSwift": null,
          "countryName": null,
          "bankName": null,
          "okved": null,
          "residency": null
        }
      ],
      "alias": null,
      "defaultAlias": null,
      "displayOrder": 1,
      "visible": true,
      "contractType": {
        "id": 4742436,
        "externalId": null,
        "code": "vk_1_2",
        "category": "ForeignExchangeContractType",
        "label": null,
        "nameKey": null,
        "nameMap": null,
        "deleted": null
      },
      "dio": 1613814869.97,
      "difference": 225661453.76,
      "countryCode": "RUS",
      "bankBranchCode": "11",
      "bankBranchName": "Филиал АО «Bereke Bank» в г. Демонстрационск",
      "contractTypeValue": null,
      "repatriation": "000.01",
      "actions": [],
      "contractSubject": {
        "id": 5,
        "valueKz": "Тауарлар",
        "valueRu": "Товары, пересекающие границу РК",
        "valueEng": "Goods",
        "externalId": null,
        "code": null,
        "label": null
      },
      "conversionSum": 1257096605.16,
      "paymentSum": 1160523676.27,
      "tnvedCode": "[]",
      "isImport": true,
      "isExpired": true,
      "hasFirstOrLastPage": false,
      "knp": [
        "710",
        "780",
        "790"
      ],
      "operationCode": [
        "1111"
      ],
      "files": [],
      "contractTypeCode": "vk_1_2",
      "extraRequirements": [
        {
          "name": "1",
          "code": "Платежи географически связанные с РФ/РБ"
        }
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  },
  "empty": false
}