Brainysoft Docs

Русский

English

Русский

English

Appearance

Основные методы API для работы с депозитными контрактами ​

Данный документ описывает основные методы API для работы с депозитными контрактами в системе Brainysoft. В документе приведены назначение методов, технические параметры, примеры запросов и ответов, а также описание полей.

Общие принципы ​

  • Все примеры приведены в формате JSON.
  • Для вызова методов используется авторизация bsauth <access_token>.
  • Для всех описанных методов используется Content-Type: application/json.
  • Порядок методов в документе соответствует исходному перечню.
  • В колонке Обяз. сохранены обозначения из исходного описания: R, М, О.

1. Инициализация нового депозитного контракта ​

  • Метод: GET /bs-core/main/deposit-contracts/init
  • Назначение: получение шаблона параметров для создания и дальнейшей работы с депозитным контрактом в системе
ПараметрЗначение
МетодGET
Path/bs-core/main/deposit-contracts/init
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается.

Успешный ответ 200:

json
{
  "id": null,
  "name": "Д-1146",
  "creationDate": "2026-04-29",
  "depositProductId": null,
  "depositFieldReq": {
    "id": null,
    "depositTypeId": null,
    "interestChargeMethodId": null,
    "periodChargeScopeId": null,
    "allowHolidaysPayment": false,
    "depositRateTypeId": null,
    "depositTaxCalcTypeId": null,
    "clearIntRate": 0.0,
    "lowLimit": 0.0,
    "maxLimit": 0.0,
    "minDepositIncrease": 0.0,
    "intRate": 0.0,
    "insuranceFee": 0.0,
    "fixedInsuranceFee": 0.0,
    "estimateFee": 0.0,
    "fixedEstimateFee": 0.0,
    "depositScheduleCalcMethodId": null,
    "interestPaymentPeriodicityId": null,
    "paymentByMonthLastDay": false,
    "monthsQty": 0,
    "reCalcIntRate": 0.0,
    "postContractIntRate": 0.0,
    "maxPartialWithdrawalQty": 0,
    "paymentAmount": 0.0,
    "penaltyRate": 0.0,
    "penaltyDaysCount": 0,
    "recalculationRates": [],
    "partialWithdrawalRules": []
  },
  "branchId": null,
  "subdivisionId": null,
  "clientId": null,
  "currencyId": 101011,
  "depositAmount": 0.0,
  "firstDepositPaymentDate": "2026-04-29",
  "returnPlanDate": null,
  "creditOfficerId": null,
  "insurancePolicy": "",
  "insurance": false,
  "insurancePremiumRate": 0.0,
  "insurancePremiumAmount": 0.0,
  "creditContractId": null,
  "paymentViaBank": null
}
ПолеОбяз.ТипОписание
idRintИдентикационный номер депозитного контракта
nameRstringКод контракта
creationDateRdateДата создания депозитного контракта в формате YYYY-MM-DD
depositProductIdRintИдентификационный номер депозитного продукта
depositFieldReqRobjectУсловия депозита
depositFieldReq.maxPartialWithdrawalQtyМintМаксимальное кол-во возможных частичных снятий. Если нужно запретить частичное снятие, достаточно оставить значение 0
depositFieldReq.partialWithdrawalRulesМcollectionПравила частичного снятия
depositFieldReq.partialWithdrawalRules._.idRintИдентификатор правила частичного снятия
depositFieldReq.partialWithdrawalRules._.withdrawalPartFromRfloatДоля частичного снятия с (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.withdrawalPartToRfloatДоля частичного снятия по (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.monthsFromRintНачало периода в месяцах
depositFieldReq.partialWithdrawalRules._.monthsToRintКонец периода в месяцах
depositFieldReq.partialWithdrawalRules._.decreaseIntRateValueRfloatУменьшение депозитной процентной ставки. Если значение равно нулю, уменьшать ставку не нужно
depositFieldReq.idМintId
depositFieldReq.depositTypeIdМintId вида депозита
depositFieldReq.interestChargeMethodIdМintId метода начисления процентов
depositFieldReq.periodChargeScopeIdМintId границы периода начисления процентов
depositFieldReq.allowHolidaysPaymentМboolНе переносить с праздников и выходных
depositFieldReq.depositRateTypeIdМintId вида процентной ставки депозита
depositFieldReq.depositTaxCalcTypeIdМintId способа расчета НДФЛ
depositFieldReq.clearIntRateМfloatСтавка выплаты процентов на руки
depositFieldReq.lowLimitМfloatМинимальный размер депозита
depositFieldReq.maxLimitМfloatМаксимальный размер депозита
depositFieldReq.minDepositIncreaseМfloatМинимальная сумма доп. взноса
depositFieldReq.intRateМfloatПроцентная ставка
depositFieldReq.insuranceFeeМfloatСтраховочный взнос (ставка)
depositFieldReq.fixedInsuranceFeeМfloatФиксированный страховочный взнос (сумма)
depositFieldReq.estimateFeeМfloatСметный взнос (ставка)
depositFieldReq.fixedEstimateFeeМfloatФиксированный сметный взнос (сумма)
depositFieldReq.depositScheduleCalcMethodIdМintId дня снятия процентов
depositFieldReq.interestPaymentPeriodicityIdМintId периодичности выплаты процентов
depositFieldReq.paymentByMonthLastDayМboolВыплаты по последним числам месяца
depositFieldReq.monthsQtyМintСрок депозита: количество месяцев
depositFieldReq.reCalcIntRateМfloatПроцентная ставка перерасчет
depositFieldReq.postContractIntRateМfloatПроцентная ставка постконтрактная
depositFieldReq.paymentAmountМfloatСумма взноса
depositFieldReq.penaltyRateМfloatСтавка штрафа
depositFieldReq.penaltyDaysCountМintКоличество дней начисления штрафа
depositFieldReq.recalculationRatesМcollectionСтавки перерасчета
depositFieldReq.recalculationRates._.idRintId
depositFieldReq.recalculationRates._.periodBeginRintНачало периода
depositFieldReq.recalculationRates._.periodEndRintКонец периода
depositFieldReq.recalculationRates._.rateRfloatСтавка перерасчета
branchIdRintId филиала
subdivisionIdRintId подразделения
clientIdRintИдентификационный номер клиента
currencyIdRintId валюты
depositAmountRfloatСумма депозита
firstDepositPaymentDateRdateДата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD
returnPlanDateRdateПлановая дата возврата депозита в формате YYYY-MM-DD
creditOfficerIdRintИдентификационный номер менеджера по работе с клиентом
insurancePolicyRstringСтраховой полис
insuranceRboolСтрахование
insurancePremiumRateRfloatСтавка страховой премии
insurancePremiumAmountRfloatСумма страховой премии
creditContractIdRintСсылка на кредитный контракт
paymentViaBankRboolВзаиморасчеты через банк

2. Создание депозитного контракта ​

  • Метод: POST /bs-core/main/deposit-contracts
  • Назначение: создаёт новый депозитный контракт для существующего клиента. Используется при открытии нового вклада или подключении дополнительного счета
ПараметрЗначение
МетодPOST
Path/bs-core/main/deposit-contracts
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: передавать заполненные поля, кроме идентификаторов - поле ID.

json
{
  "id": null,
  "name": "Д-1150",
  "creationDate": "2026-04-29",
  "depositProductId": 8,
  "depositFieldReq": {
    "id": null,
    "depositTypeId": 101852,
    "interestChargeMethodId": 101863,
    "periodChargeScopeId": null,
    "allowHolidaysPayment": false,
    "depositRateTypeId": 101871,
    "depositTaxCalcTypeId": 102101,
    "clearIntRate": 0.0,
    "lowLimit": 200000.0,
    "maxLimit": 0.0,
    "minDepositIncrease": 0.0,
    "intRate": 1.0,
    "insuranceFee": 0.0,
    "fixedInsuranceFee": 0.0,
    "estimateFee": 0.0,
    "fixedEstimateFee": 0.0,
    "depositScheduleCalcMethodId": 101882,
    "interestPaymentPeriodicityId": 101511,
    "paymentByMonthLastDay": false,
    "monthsQty": 3,
    "reCalcIntRate": 0.0,
    "postContractIntRate": 0.0,
    "maxPartialWithdrawalQty": 0,
    "paymentAmount": 0.0,
    "penaltyRate": 0.0,
    "penaltyDaysCount": 0,
    "recalculationRates": [],
    "partialWithdrawalRules": []
  },
  "branchId": 101304,
  "subdivisionId": 101796,
  "clientId": 39208,
  "currencyId": 101011,
  "depositAmount": 200000.0,
  "firstDepositPaymentDate": "2026-05-29",
  "returnPlanDate": "2026-06-29",
  "insurancePolicy": "",
  "insurance": false,
  "insurancePremiumRate": 0.0,
  "insurancePremiumAmount": 0.0,
  "creditContractId": null,
  "paymentViaBank": null
}
ПолеОбяз.ТипОписание
idRintИдентикационный номер депозитного контракта
nameRstringКод контракта
creationDateRdateДата создания депозитного контракта в формате YYYY-MM-DD
depositProductIdRintИдентификационный номер депозитного продукта
depositFieldReqRobjectУсловия депозита
depositFieldReq.maxPartialWithdrawalQtyМintМаксимальное кол-во возможных частичных снятий. Если нужно запретить частичное снятие, достаточно оставить значение 0
depositFieldReq.partialWithdrawalRulesМcollectionПравила частичного снятия
depositFieldReq.partialWithdrawalRules._.idRintИдентификатор правила частичного снятия
depositFieldReq.partialWithdrawalRules._.withdrawalPartFromRfloatДоля частичного снятия с (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.withdrawalPartToRfloatДоля частичного снятия по (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.monthsFromRintНачало периода в месяцах
depositFieldReq.partialWithdrawalRules._.monthsToRintКонец периода в месяцах
depositFieldReq.partialWithdrawalRules._.decreaseIntRateValueRfloatУменьшение депозитной процентной ставки. Если значение равно нулю, уменьшать ставку не нужно
depositFieldReq.idМintId
depositFieldReq.depositTypeIdМintId вида депозита
depositFieldReq.interestChargeMethodIdМintId метода начисления процентов
depositFieldReq.periodChargeScopeIdМintId границы периода начисления процентов
depositFieldReq.allowHolidaysPaymentМboolНе переносить с праздников и выходных
depositFieldReq.depositRateTypeIdМintId вида процентной ставки депозита
depositFieldReq.depositTaxCalcTypeIdМintId способа расчета НДФЛ
depositFieldReq.clearIntRateМfloatСтавка выплаты процентов на руки
depositFieldReq.lowLimitМfloatМинимальный размер депозита
depositFieldReq.maxLimitМfloatМаксимальный размер депозита
depositFieldReq.minDepositIncreaseМfloatМинимальная сумма доп. взноса
depositFieldReq.intRateМfloatПроцентная ставка
depositFieldReq.insuranceFeeМfloatСтраховочный взнос (ставка)
depositFieldReq.fixedInsuranceFeeМfloatФиксированный страховочный взнос (сумма)
depositFieldReq.estimateFeeМfloatСметный взнос (ставка)
depositFieldReq.fixedEstimateFeeМfloatФиксированный сметный взнос (сумма)
depositFieldReq.depositScheduleCalcMethodIdМintId дня снятия процентов
depositFieldReq.interestPaymentPeriodicityIdМintId периодичности выплаты процентов
depositFieldReq.paymentByMonthLastDayМboolВыплаты по последним числам месяца
depositFieldReq.monthsQtyМintСрок депозита: количество месяцев
depositFieldReq.reCalcIntRateМfloatПроцентная ставка перерасчет
depositFieldReq.postContractIntRateМfloatПроцентная ставка постконтрактная
depositFieldReq.paymentAmountМfloatСумма взноса
depositFieldReq.penaltyRateМfloatСтавка штрафа
depositFieldReq.penaltyDaysCountМintКоличество дней начисления штрафа
depositFieldReq.recalculationRatesМcollectionСтавки перерасчета
depositFieldReq.recalculationRates._.idRintId
depositFieldReq.recalculationRates._.periodBeginRintНачало периода
depositFieldReq.recalculationRates._.periodEndRintКонец периода
depositFieldReq.recalculationRates._.rateRfloatСтавка перерасчета
branchIdRintId филиала
subdivisionIdRintId подразделения
clientIdRintИдентификационный номер клиента
currencyIdRintId валюты
depositAmountRfloatСумма депозита
firstDepositPaymentDateRdateДата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD
returnPlanDateRdateПлановая дата возврата депозита в формате YYYY-MM-DD
creditOfficerIdRintИдентификационный номер менеджера по работе с клиентом
insurancePolicyRstringСтраховой полис
insuranceRboolСтрахование
insurancePremiumRateRfloatСтавка страховой премии
insurancePremiumAmountRfloatСумма страховой премии
creditContractIdRintСсылка на кредитный контракт
paymentViaBankRboolВзаиморасчеты через банк

Успешный ответ 200:

json
{
  "id": 47630,
  "name": "Д-1150",
  "creationDate": "2026-04-29",
  "depositProductId": 8,
  "depositFieldReq": {
    "id": 941,
    "depositTypeId": 101852,
    "interestChargeMethodId": 101863,
    "periodChargeScopeId": null,
    "allowHolidaysPayment": false,
    "depositRateTypeId": 101871,
    "depositTaxCalcTypeId": 102101,
    "clearIntRate": 0.0,
    "lowLimit": 200000.0,
    "maxLimit": 0.0,
    "minDepositIncrease": 0.0,
    "intRate": 1.0,
    "insuranceFee": 0.0,
    "fixedInsuranceFee": 0.0,
    "estimateFee": 0.0,
    "fixedEstimateFee": 0.0,
    "depositScheduleCalcMethodId": 101882,
    "interestPaymentPeriodicityId": 101511,
    "paymentByMonthLastDay": false,
    "monthsQty": 3,
    "reCalcIntRate": 0.0,
    "postContractIntRate": 0.0,
    "maxPartialWithdrawalQty": 0,
    "paymentAmount": 0.0,
    "penaltyRate": 0.0,
    "penaltyDaysCount": 0,
    "recalculationRates": [],
    "partialWithdrawalRules": []
  },
  "branchId": 101304,
  "subdivisionId": 101796,
  "clientId": 39208,
  "currencyId": 101011,
  "depositAmount": 200000.0,
  "firstDepositPaymentDate": "2026-05-29",
  "returnPlanDate": "2026-06-29",
  "creditOfficerId": null,
  "insurancePolicy": "",
  "insurance": false,
  "insurancePremiumRate": 0.0,
  "insurancePremiumAmount": 0.0,
  "creditContractId": null,
  "paymentViaBank": null,
  "contractTypeId": 101912,
  "takeDepositDate": null,
  "closeDate": null,
  "createUserId": 1334,
  "createSubdivisionId": 101791,
  "contractLine": {
    "id": 47627,
    "lineLimit": null
  }
}
ПолеТипОписание
idintИдентикационный номер депозитного контракта
namestringКод контракта
creationDatedateДата создания депозитного контракта
depositProductIdintИдентификационный номер депозитного продукта
depositFieldReqobjectУсловия депозита
branchIdintId филиала
subdivisionIdintId подразделения
clientIdintИдентификационный номер клиента
currencyIdintId валюты
depositAmountfloatСумма депозита
firstDepositPaymentDatedateДата первой выплаты процентов по депозитному контракту
returnPlanDatedateПлановая дата возврата депозита
creditOfficerIdintИдентификационный номер менеджера по работе с клиентом
insurancePolicystringСтраховой полис
insuranceboolСтрахование
insurancePremiumRatefloatСтавка страховой премии
insurancePremiumAmountfloatСумма страховой премии
creditContractIdintСсылка на кредитный контракт
paymentViaBankboolВзаиморасчеты через банк
contractTypeIdintId типа контракта
takeDepositDatetimestampДата открытия депозита в формате unix timestamp в миллисекундах
closeDatetimestampДата закрытия в формате unix timestamp в миллисекундах
createUserIdintId пользователя, создавшего контракт
createSubdivisionIdintId подразделения пользователя, создавшего контракт
contractLineobjectЛиния нарушения последовательности
contractLine.idintId
contractLine.lineLimitintГраница последовательности

3. Получение/редактирование депозитного контракта по его идентификатору ​

  • Метод: GET/PUT /bs-core/main/deposit-contracts/{id}
  • Назначение: получение всех заполненных параметров депозитного контракта по указанному идентификатору / редактирование, изменение параметров и их сохранение методом PUT
ПараметрЗначение
МетодGET/PUT
Path/bs-core/main/deposit-contracts/{id}
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается для GET; для PUT передается ответ GET.

Успешный ответ 200:

json
{
  "id": 47630,
  "name": "Д-1150",
  "creationDate": "2026-04-29",
  "depositProductId": 8,
  "depositFieldReq": {
    "id": 941,
    "depositTypeId": 101852,
    "interestChargeMethodId": 101863,
    "periodChargeScopeId": null,
    "allowHolidaysPayment": false,
    "depositRateTypeId": 101871,
    "depositTaxCalcTypeId": 102101,
    "clearIntRate": 0.0,
    "lowLimit": 200000.0,
    "maxLimit": 0.0,
    "minDepositIncrease": 0.0,
    "intRate": 1.0,
    "insuranceFee": 0.0,
    "fixedInsuranceFee": 0.0,
    "estimateFee": 0.0,
    "fixedEstimateFee": 0.0,
    "depositScheduleCalcMethodId": 101882,
    "interestPaymentPeriodicityId": 101511,
    "paymentByMonthLastDay": false,
    "monthsQty": 3,
    "reCalcIntRate": 0.0,
    "postContractIntRate": 0.0,
    "maxPartialWithdrawalQty": 0,
    "paymentAmount": 0.0,
    "penaltyRate": 0.0,
    "penaltyDaysCount": 0,
    "recalculationRates": [],
    "partialWithdrawalRules": []
  },
  "branchId": 101304,
  "subdivisionId": 101796,
  "clientId": 39208,
  "currencyId": 101011,
  "depositAmount": 200000.0,
  "firstDepositPaymentDate": "2026-05-29",
  "returnPlanDate": "2026-06-29",
  "creditOfficerId": null,
  "insurancePolicy": "",
  "insurance": false,
  "insurancePremiumRate": 0.0,
  "insurancePremiumAmount": 0.0,
  "creditContractId": null,
  "paymentViaBank": null,
  "contractTypeId": 101912,
  "takeDepositDate": null,
  "closeDate": null,
  "createUserId": 1334,
  "createSubdivisionId": 101791,
  "contractLine": {
    "id": 47627,
    "lineLimit": null
  }
}
ПолеОбяз.ТипОписание
idRintИдентикационный номер депозитного контракта
nameRstringКод контракта
creationDateRdateДата создания депозитного контракта в формате YYYY-MM-DD
depositProductIdRintИдентификационный номер депозитного продукта
depositFieldReqRobjectУсловия депозита
depositFieldReq.idRintId
depositFieldReq.depositTypeIdRintId вида депозита
depositFieldReq.interestChargeMethodIdRintId метода начисления процентов
depositFieldReq.periodChargeScopeIdRintId границы периода начисления процентов
depositFieldReq.allowHolidaysPaymentRboolНе переносить с праздников и выходных
depositFieldReq.depositRateTypeIdRintId вида процентной ставки депозита
depositFieldReq.depositTaxCalcTypeIdRintId способа расчета НДФЛ
depositFieldReq.clearIntRateRfloatСтавка выплаты процентов на руки
depositFieldReq.lowLimitRfloatМинимальный размер депозита
depositFieldReq.maxLimitRfloatМаксимальный размер депозита
depositFieldReq.minDepositIncreaseRfloatМинимальная сумма доп. взноса
depositFieldReq.intRateRfloatПроцентная ставка
depositFieldReq.insuranceFeeRfloatСтраховочный взнос (ставка)
depositFieldReq.fixedInsuranceFeeRfloatФиксированный страховочный взнос (сумма)
depositFieldReq.estimateFeeRfloatСметный взнос (ставка)
depositFieldReq.fixedEstimateFeeRfloatФиксированный сметный взнос (сумма)
depositFieldReq.depositScheduleCalcMethodIdRintId дня снятия процентов
depositFieldReq.interestPaymentPeriodicityIdRintId периодичности выплаты процентов
depositFieldReq.paymentByMonthLastDayRboolВыплаты по последним числам месяца
depositFieldReq.monthsQtyRintСрок депозита: количество месяцев
depositFieldReq.reCalcIntRateRfloatПроцентная ставка перерасчет
depositFieldReq.postContractIntRateRfloatПроцентная ставка постконтрактная
depositFieldReq.maxPartialWithdrawalQtyОintМаксимальное кол-во возможных частичных снятий. Если нужно запретить частичное снятие, достаточно оставить значение 0
depositFieldReq.paymentAmountRfloatСумма взноса
depositFieldReq.penaltyRateОfloatСтавка штрафа
depositFieldReq.penaltyDaysCountОintКоличество дней начисления штрафа
depositFieldReq.recalculationRatesОcollectionСтавки перерасчета
depositFieldReq.recalculationRates._.idОintId
depositFieldReq.recalculationRates._.periodBeginОintНачало периода
depositFieldReq.recalculationRates._.periodEndОintКонец периода
depositFieldReq.recalculationRates._.rateОfloatСтавка перерасчета
depositFieldReq.partialWithdrawalRulesОcollectionПравила частичного снятия
depositFieldReq.partialWithdrawalRules._.idОintИдентификатор правила частичного снятия
depositFieldReq.partialWithdrawalRules._.withdrawalPartFromОfloatДоля частичного снятия с (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.withdrawalPartToОfloatДоля частичного снятия по (в процентах от начальной суммы депозита)
depositFieldReq.partialWithdrawalRules._.monthsFromОintНачало периода в месяцах
depositFieldReq.partialWithdrawalRules._.monthsToОintКонец периода в месяцах
depositFieldReq.partialWithdrawalRules._.decreaseIntRateValueОfloatУменьшение депозитной процентной ставки. Если значение равно нулю, уменьшать ставку не нужно
branchIdОintId филиала
subdivisionIdОintId подразделения
clientIdОintИдентификационный номер клиента
currencyIdОintId валюты
depositAmountОfloatСумма депозита
firstDepositPaymentDateОdateДата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD
returnPlanDateОdateПлановая дата возврата депозита в формате YYYY-MM-DD
creditOfficerIdОintИдентификационный номер менеджера по работе с клиентом
insurancePolicyОstringСтраховой полис
insuranceОboolСтрахование
insurancePremiumRateОfloatСтавка страховой премии
insurancePremiumAmountОfloatСумма страховой премии
creditContractIdОintСсылка на кредитный контракт
paymentViaBankОboolВзаиморасчеты через банк
contractTypeIdОintId типа контракта
takeDepositDateОtimestampДата открытия депозита в формате unix timestamp в миллисекундах
closeDateОtimestampДата закрытия в формате unix timestamp в миллисекундах
createUserIdОintId пользователя, создавшего контракт
createSubdivisionIdОintId подразделения пользователя, создавшего контракт
contractLineОobjectЛиния нарушения последовательности
contractLine.idОintId
contractLine.lineLimitОintГраница последовательности

4. Получение общего количества депозитных контрактов ​

  • Метод: GET /bs-core/main/deposit-contracts/qty
  • Назначение: получение общего количества депозитных контрактов, созданных в системе
ПараметрЗначение
МетодGET
Path/bs-core/main/deposit-contracts/qty
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается.

Успешный ответ 200:

json
{
  "status": "ok",
  "timestamp": 1473068978054,
  "data": 2
}

Примечание: параметр data генерирует и возвращает количество депозитных контрактов, созданных в системе.

5. Удаление депозитных контрактов ​

  • Метод: DELETE /bs-core/main/deposit-contracts/{id}
  • Назначение: удаление депозитного контракта
ПараметрЗначение
МетодDELETE
Path/bs-core/main/deposit-contracts/{id}
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается.

Успешный ответ 200:

json
{
  "status": "ok",
  "timestamp": 1473068884050,
  "data": ""
}

6. Поиск депозитных контрактов по списку идентификаторов ​

  • Метод: GET /bs-core/main/deposit-contracts/find/{ids}
  • Назначение: осуществление поиска депозитных контрактов по списку идентификаторов
ПараметрЗначение
МетодGET
Path/bs-core/main/deposit-contracts/find/{ids}
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается.

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

text
/bs-core/main/deposit-contracts/find/47630,47559

или

text
/bs-core/main/deposit-contracts/find/47630,47559?preserveOrder=true

Успешный ответ 200: в ответ возвращаются все депозитные контракты в соответствии с перечисленными идентификаторами.

Примечание: поиск выполняется по списку идентификаторов, разделенных запятыми. При передаче параметра preserveOrder=true метод возвратит депозитные контракты в том порядке, в котором идентификаторы были переданы в запросе. Если параметр не передается, контракты возвращаются по возрастающим идентификаторам.

7. Поиск депозитных контрактов ​

  • Метод: POST /bs-core/main/deposit-contracts/partial-load
  • Назначение: метод предназначен для поиска по депозитным контрактам с возможностью задавать набор полей в ответе и порядок сортировки элементов
ПараметрЗначение
МетодPOST
Path/bs-core/main/deposit-contracts/partial-load
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса:

json
{
  "fields": [
    "id",
    "client.id",
    "client.creationDate",
    "client.additionalInfo.riskStatusType.id",
    "name",
    "creationDate",
    "closeDate",
    "closedStatus.id",
    "branch.id",
    "subdivision.id",
    "loanAmount",
    "creditProductName",
    "creditProduct.id",
    "loanApplication.id",
    "loanApplication.gettingMoneyMethod.id",
    "loanApplication.name",
    "creditField.id",
    "client.naturalperson",
    "client.sex.id",
    "client.lastName",
    "client.firstName",
    "client.patronymic",
    "client.title",
    "issueDate",
    "forIssue",
    "creditContract.id"
  ],
  "orderBy": "id",
  "orderDirection": "DESC",
  "orderByFields": [{ "field": "creationDate" }, { "field": "id", "direction": "desc" }],
  "searchFields": [
    {
      "field": "creationDate",
      "value": ">=2018-05-20 00:00:00"
    }
  ],
  "countFrom": 0,
  "countTo": 10
}
ПараметрОбяз.ТипОписание
fieldsRcollectionКоллекция полей, которые должны вернуться в результатах поиска
fields.{fieldName}Мstring[255]В качестве элементов списка могут быть указаны любые поля из депозитного контракта, которые не являются внешними ключами
orderByRstring[255]Название поля, по которому надо делать сортировку. С релиза 2.0.0-65 для сортировки следует использовать коллекцию orderByFields
orderDirectionRenumНаправление сортировки результатов поиска: DESC - по убыванию, ASC - по возрастанию. С релиза 2.0.0-65 направление сортировки следует передавать в orderByFields
orderByFieldsRcollectionМассив полей, по которым происходит сортировка
searchFieldsRstringУсловия поиска (фильтрации) депозитных контрактов. Наличие параметра обязательно, однако это может быть пустая коллекция
searchFields._.fieldМstring[255]Название поля, по которому нужно сделать фильтрацию
searchFields._.valueМstring[255]Значение для фильтрации
searchFields._.ornumberМstring[255]Значение для группировки параметров поиска в условии OR
countFromRintСмещение от начала поиска
countToRintЛимит, сколько записей будет возвращено

Особенности параметров поиска ​

fields.{fieldName}

  • В качестве элементов списка могут быть указаны любые поля из сущности Депозитный контракт, которые не являются внешними ключами.
  • Например: name, creationDate и так далее.
  • Признаком внешнего ключа является указание в описании параметра на метод, который позволяет по ID получить объект. Пример: clientId.
  • Для полей, которые являются внешними ключами, возможно получение любых полей объекта, ID которого указано в поле. Например: client.id, client.lastName.
  • Также возможны варианты, при которых можно запросить поля из более глубоких сущностей при наличии внешних ключей, например client.passport.seria.

orderByFields

json
[{ "field": "creationDate" }, { "field": "manualStatusId", "direction": "desc" }]
  • В этом примере сортировка происходит по полям creationDate и manualStatusId.
  • Если поле direction не указано, то сортировка по полю выполняется по возрастанию.
  • Если в запросе на ядро переданы оба способа сортировки, то старый способ задания сортировки игнорируется.

searchFields._.field

  • В качестве элементов списка могут быть указаны любые поля из сущности Депозитный контракт, которые не являются внешними ключами.
  • Для внешних ключей доступны вложенные поля связанных объектов.
  • Например: client.id, client.lastName, client.passport.seria.

searchFields._.value

  • Для указания значений можно использовать следующие операторы: %, like, !=, null, not null, >, <, >=, <=.
  • Для передачи даты используется формат YYYY-MM-DD.
  • Для передачи даты и времени используется формат YYYY-MM-DD hh:mm:ss.

Пример строгого соответствия:

json
{
  "field": "client.id",
  "value": "123"
}

Примеры нестрогого соответствия:

json
{
  "field": "creationDate",
  "value": ">=2017-09-01 00:00:00"
}
json
{
  "field": "creationDate",
  "value": "<=2017-09-01 00:00:00"
}

Также в поле field можно передать тип контракта:

  • Кредитный - 101911
  • Депозитный - 101912
  • Паевой - 101913

Пример:

json
{
  "field": "contractType.id",
  "value": 101911
}

Поле businessStatus из списка динамических параметров в списке полей для вывода и в списке полей для поиска может принимать значение null.

  • В поиске можно использовать поиск по null, но нельзя использовать like, >, <.
  • Допустимо только строгое соответствие или null.

Пример:

json
{
  "field": "businessStatus",
  "value": "AUTO_CHECK"
}

searchFields._.ornumber

  • Поле не обязательное и используется в случаях, когда нужно искать как условия по И, так и условия по ИЛИ.
  • Значение может быть числом или символом, но должно быть уникальным в рамках одной группы условий ИЛИ.
  • Зарезервированным значением является -1.

Пример 1:

json
[
  {
    "field": "contract.id",
    "value": "10134756"
  },
  {
    "field": "loanAmount",
    "value": "10000",
    "ornumber": "1"
  },
  {
    "field": "name",
    "value": "5%",
    "ornumber": "1"
  }
]

В этом примере будут искаться все записи, у которых в поле contract.id указано 10134756, и при этом одновременно выполняется одно из условий: поле loanAmount равно 10000 или поле name начинается с 5%.

SQL-аналог:

sql
contract.id = 10134756 AND (loanAmount = 10000 OR name like "5%")

Пример 2:

json
[
  {
    "field": "name",
    "value": "1%",
    "ornumber": "1"
  },
  {
    "field": "name",
    "value": "5%",
    "ornumber": "1"
  },
  {
    "field": "loanAmount",
    "value": "10000",
    "ornumber": "2"
  },
  {
    "field": "loanAmount",
    "value": "20000",
    "ornumber": "2"
  }
]

SQL-аналог:

sql
(name like "1%" OR name like "5%") AND (loanAmount = 10000 OR loanAmount = 20000)

Успешный ответ 200:

json
[
  {
    "id": 101342034,
    "fields": {
      "id": 101342034,
      "client.id": 101322875,
      "client.creationDate": "2018-06-04",
      "client.additionalInfo.riskStatusType.id": null,
      "name": "Д-1350",
      "creationDate": "2018-06-04",
      "closeDate": null,
      "closedStatus.id": null,
      "branch.id": 101305,
      "subdivision.id": 101796,
      "loanAmount": 141000,
      "creditProductName": "",
      "creditProduct.id": null,
      "loanApplication.id": null,
      "loanApplication.gettingMoneyMethod.id": null,
      "loanApplication.name": null,
      "creditField.id": null,
      "client.naturalperson": true,
      "client.sex.id": 101252,
      "client.lastName": "Иван",
      "client.firstName": "Сергей",
      "client.patronymic": "Ира",
      "client.title": "",
      "issueDate": null,
      "forIssue": true,
      "creditContract.id": null
    }
  },
  {
    "id": 101342032,
    "fields": {
      "id": 101342032,
      "client.id": 101322875,
      "client.creationDate": "2018-06-04",
      "client.additionalInfo.riskStatusType.id": null,
      "name": "Д-1349",
      "creationDate": "2018-06-04",
      "closeDate": null,
      "closedStatus.id": null,
      "branch.id": 101305,
      "subdivision.id": 101796,
      "loanAmount": 141000,
      "creditProductName": "",
      "creditProduct.id": null,
      "loanApplication.id": null,
      "loanApplication.gettingMoneyMethod.id": null,
      "loanApplication.name": null,
      "creditField.id": null,
      "client.naturalperson": true,
      "client.sex.id": 101252,
      "client.lastName": "Иван",
      "client.firstName": "Сергей",
      "client.patronymic": "Ира",
      "client.title": "",
      "issueDate": 1528059600000,
      "forIssue": true,
      "creditContract.id": null
    }
  },
  {
    "id": 101342029,
    "fields": {
      "id": 101342029,
      "client.id": 101322875,
      "client.creationDate": "2018-06-04",
      "client.additionalInfo.riskStatusType.id": null,
      "name": "Д-1348",
      "creationDate": "2018-06-04",
      "closeDate": null,
      "closedStatus.id": null,
      "branch.id": 101305,
      "subdivision.id": 101796,
      "loanAmount": 14100,
      "creditProductName": "",
      "creditProduct.id": null,
      "loanApplication.id": null,
      "loanApplication.gettingMoneyMethod.id": null,
      "loanApplication.name": null,
      "creditField.id": null,
      "client.naturalperson": true,
      "client.sex.id": 101252,
      "client.lastName": "Иван",
      "client.firstName": "Сергей",
      "client.patronymic": "Ира",
      "client.title": "",
      "issueDate": null,
      "forIssue": true,
      "creditContract.id": null
    }
  },
  {
    "id": 101342027,
    "fields": {
      "id": 101342027,
      "client.id": 101322875,
      "client.creationDate": "2018-06-04",
      "client.additionalInfo.riskStatusType.id": null,
      "name": "Д-1347",
      "creationDate": "2018-06-04",
      "closeDate": null,
      "closedStatus.id": null,
      "branch.id": 101305,
      "subdivision.id": 101796,
      "loanAmount": 141000,
      "creditProductName": "",
      "creditProduct.id": null,
      "loanApplication.id": null,
      "loanApplication.gettingMoneyMethod.id": null,
      "loanApplication.name": null,
      "creditField.id": null,
      "client.naturalperson": true,
      "client.sex.id": 101252,
      "client.lastName": "Иван",
      "client.firstName": "Сергей",
      "client.patronymic": "Ира",
      "client.title": "",
      "issueDate": null,
      "forIssue": true,
      "creditContract.id": null
    }
  }
]
ПолеОбяз.ТипОписание
idRintИдентификатор депозитного контракта, который соответствует заданным параметрам фильтрации
fieldsRcollectionКоллекция полей, которые вернулись в ответ на запрос
fields.{field}RmixedНабор полей в ответе зависит от того, какие поля были переданы в коллекцию searchFields. Типы данных и значения следует смотреть в описании соответствующих сущностей

8. Создание комментария по депозитному контракту ​

  • Метод: POST /bs-core/main/deposit-contracts/{contractId}/comments
  • Назначение: метод предназначен для создания комментариев для депозитных контрактов
ПараметрЗначение
МетодPOST
Path/bs-core/main/deposit-contracts/{contractId}/comments
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса:

json
{
  "body": "Комментарий по этому депозитному контракту"
}

Успешный ответ 200:

json
{
  "status": "ok",
  "timestamp": 1535718458354,
  "data": 10224288
}

Примечание: data - идентификатор созданного комментария депозитного контракта.

9. Получение комментариев по депозитному контракту ​

  • Метод: GET /bs-core/main/deposit-contracts/{contractId}/comments
  • Назначение: получение комментариев по депозитному контракту
ПараметрЗначение
МетодGET
Path/bs-core/main/deposit-contracts/{contractId}/comments
Content-Typeapplication/json
Авторизацияbsauth <access_token>

Тело запроса: не передается.

Успешный ответ 200:

json
{
  "status": "ok",
  "timestamp": 1535719004871,
  "data": [
    {
      "body": "Комментарий по этому депозитному контракту",
      "id": 10224288,
      "userId": 1082,
      "creationDate": 1535718458353
    }
  ]
}
ПолеОбяз.ТипОписание
bodyОstring[65535]Комментарий
idОint[20]Идентификатор
userIdОint[11]Id пользователя
creationDateОtimestampДата и время комментария в формате unix timestamp в миллисекундах

ОСНОВНЫЕ МЕТОДЫ API ДЛЯ РАБОТЫ С ДЕПОЗИТНЫМИ КОНТРАКТАМИ - DEPOSIT-CONTRACTS. 1) Метод: GET /bs-core/main/deposit-contracts/init - Инициализация нового паевого контракта для последующего заполнения полей и сохранения. Назначение: получение «шаблона» параметров для создания и дальнейшей работы с депозитным контрактом в системе.

Технические параметры:

Параметр Значение Метод GET Путь /bs-core/main/deposit-contracts/init Content-Type application/json Авторизация bsauth <access_token>

Тело запроса: Не передается. Успешный ответ 200 JSON {         "id": null,         "name": "Д-1146",         "creationDate": "2026-04-29",         "depositProductId": null,         "depositFieldReq": {             "id": null,             "depositTypeId": null,             "interestChargeMethodId": null,             "periodChargeScopeId": null,             "allowHolidaysPayment": false,             "depositRateTypeId": null,             "depositTaxCalcTypeId": null,             "clearIntRate": 0.0,             "lowLimit": 0.0,             "maxLimit": 0.0,             "minDepositIncrease": 0.0,             "intRate": 0.0,             "insuranceFee": 0.0,             "fixedInsuranceFee": 0.0,             "estimateFee": 0.0,             "fixedEstimateFee": 0.0,             "depositScheduleCalcMethodId": null,             "interestPaymentPeriodicityId": null,             "paymentByMonthLastDay": false,             "monthsQty": 0,             "reCalcIntRate": 0.0,             "postContractIntRate": 0.0,             "maxPartialWithdrawalQty": 0,             "paymentAmount": 0.0,             "penaltyRate": 0.0,             "penaltyDaysCount": 0,             "recalculationRates": [],             "partialWithdrawalRules": []         },         "branchId": null,         "subdivisionId": null,         "clientId": null,         "currencyId": 101011,         "depositAmount": 0.0,         "firstDepositPaymentDate": "2026-04-29",         "returnPlanDate": null,         "creditOfficerId": null,         "insurancePolicy": "",         "insurance": false,         "insurancePremiumRate": 0.0,         "insurancePremiumAmount": 0.0,         "creditContractId": null,         "paymentViaBank": null     }

Параметр Обязателен Тип данных Описание id R [int] Идентикационный номер депозитного контракта name R [string] Код контракта creationDate R [date] Дата создания депозитного контракта  в формате YYYY-MM-DD depositProductId R [int] Идентификационный номер депозитного продукта depositFieldReq R [object] Условия депозита depositFieldReq.maxPartialWithdrawalQty М [int] Максимальное кол-во возможных частичных снятий. В случае если нужно запретить частичное снятие, то достаточно оставить в этом поле значение ноль ("maxPartialWithdrawalQty": 0). depositFieldReq.partialWithdrawalRules М [collection] Правила частичного снятия. depositFieldReq.partialWithdrawalRules..id R [int] Идентификатор правила частичного снятия depositFieldReq.partialWithdrawalRules..withdrawalPartFrom R [float] Доля частичного снятия с (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..withdrawalPartTo R [float] Доля частичного снятия по (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..monthsFrom R [int] Начало периода в месяцах depositFieldReq.partialWithdrawalRules..monthsTo R [int] Конец периода в месяцах depositFieldReq.partialWithdrawalRules..decreaseIntRateValue R [float] Уменьшение депозитной процентной ставки (значение на которое начальная ставка должна уменьшиться). Если значение равно ноль, то уменьшать ставку не нужно. depositFieldReq.Id М [int] Id depositFieldReq.depositTypeId М [int] Id Вида депозита depositFieldReq.interestChargeMethodId М [int] Id Метода начисления процентов depositFieldReq.periodChargeScopeId М [int] Id Границы периода начисления процентов depositFieldReq.allowHolidaysPayment М [bool] Не переносить с праздников и выходных depositFieldReq.depositRateTypeId М [int] Id Вида процентной ставки депозита depositFieldReq.depositTaxCalcTypeId М [int] Id Способа расчета НДФЛ depositFieldReq.clearIntRate М [float] Ставка выплаты процентов на руки depositFieldReq.lowLimit М [float] Минимальный размер депозита depositFieldReq.maxLimit М [float] Максимальный размер депозита depositFieldReq.minDepositIncrease М [float] Минимальная сумма доп.взноса depositFieldReq.intRate М [float] Процентная ставка depositFieldReq.insuranceFee М [float] Страховочный взнос (ставка) depositFieldReq.fixedInsuranceFee М [float] Фиксированный страховочный взнос (сумма) depositFieldReq.estimateFee М [float] Сметный взнос (ставка) depositFieldReq.fixedEstimateFee М [float] Фиксированный сметный взнос (сумма) depositFieldReq.depositScheduleCalcMethodId М [int] Id Дня снятия процентов depositFieldReq.interestPaymentPeriodicityId М [int] Id Периодичности выплаты процентов depositFieldReq.paymentByMonthLastDay М [bool] Выплаты по последним числам месяца depositFieldReq.monthsQty М [int] Cрок депозита: количество месяцев depositFieldReq.reCalcIntRate М [float] Процентная ставка перерасчет depositFieldReq.postContractIntRate М [float] Процентная ставка постКонтрактная depositFieldReq.paymentAmount М [float] Сумма взноса depositFieldReq.penaltyRate М [float] Ставка штрафа depositFieldReq.penaltyDaysCount М [int] Количество дней начисления штрафа depositFieldReq.recalculationRates М [collection] Ставки перерасчета depositFieldReq.recalculationRates..id R [int] Id depositFieldReq.recalculationRates..periodBegin R [int] Начало периода depositFieldReq.recalculationRates..periodEnd  R [int] Конец периода depositFieldReq.recalculationRates..rate R [float] ставка перерасчета branchId R [int] Id Филиала subdivisionId R [int] Id Подразделения clientId R [int] Идентификационный номер клиента currencyId R [int] Id Валюты depositAmount R [float] Сумма депозита firstDepositPaymentDate R [date] Дата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD returnPlanDate R [date] Плановая дата возврата депозита в формате YYYY-MM-DD creditOfficerld R [int] Идентификационный номер менеджера по работе с клиентом insurancePolicy R [string] Страховой полис insurance R [bool] Страхование insurancePremiumRate R [float] Ставка страховой премии insurancePremiumAmount R [float] Сумма страховой премии creditContractId R [int] Ссылка на кредитный контракт paymentViaBank R [bool] Взаиморасчеты через банк

2) Метод: POST /bs-core/main/deposit-contracts — Создание депозитного контракта

Назначение: Создаёт новый депозитный контракт для существующего клиента. Используется при открытии нового вклада или подключении дополнительного счета.

Технические параметры:

Параметр Значение Метод POST Путь /bs-core/main/deposit-contracts Content-Type application/json Авторизация bsauth <access_token>

Тело запроса: передавать заполненные поля, кроме идентификаторов – поле ID. JSON {         "id": null,         "name": "Д-1150",         "creationDate": "2026-04-29",         "depositProductId": 8,         "depositFieldReq": {             "id": null,             "depositTypeId": 101852,             "interestChargeMethodId": 101863,             "periodChargeScopeId": null,             "allowHolidaysPayment": false,             "depositRateTypeId": 101871,             "depositTaxCalcTypeId": 102101,             "clearIntRate": 0.0,             "lowLimit":  200000.0,             "maxLimit": 0.0,             "minDepositIncrease": 0.0,             "intRate": 1.0,             "insuranceFee": 0.0,             "fixedInsuranceFee": 0.0,             "estimateFee": 0.0,             "fixedEstimateFee": 0.0,             "depositScheduleCalcMethodId": 101882,             "interestPaymentPeriodicityId": 101511,             "paymentByMonthLastDay": false,             "monthsQty": 3,             "reCalcIntRate": 0.0,             "postContractIntRate": 0.0,             "maxPartialWithdrawalQty": 0,             "paymentAmount": 0.0,             "penaltyRate": 0.0,             "penaltyDaysCount": 0,             "recalculationRates": [],             "partialWithdrawalRules": []         },         "branchId": 101304,         "subdivisionId": 101796,         "clientId": 39208,         "currencyId": 101011,         "depositAmount": 200000.0,         "firstDepositPaymentDate": "2026-05-29",         "returnPlanDate": "2026-06-29",         "insurancePolicy": "",         "insurance": false,         "insurancePremiumRate": 0.0,         "insurancePremiumAmount": 0.0,         "creditContractId": null,         "paymentViaBank": null     }

Параметр Обязателен Тип данных Описание id R [int] Идентикационный номер депозитного контракта name R [string] Код контракта creationDate R [date] Дата создания депозитного контракта  в формате YYYY-MM-DD depositProductId R [int] Идентификационный номер депозитного продукта depositFieldReq R [object] Условия депозита depositFieldReq.maxPartialWithdrawalQty М [int] Максимальное кол-во возможных частичных снятий. В случае если нужно запретить частичное снятие, то достаточно оставить в этом поле значение ноль ("maxPartialWithdrawalQty": 0). depositFieldReq.partialWithdrawalRules М [collection] Правила частичного снятия. depositFieldReq.partialWithdrawalRules..id R [int] Идентификатор правила частичного снятия depositFieldReq.partialWithdrawalRules..withdrawalPartFrom R [float] Доля частичного снятия с (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..withdrawalPartTo R [float] Доля частичного снятия по (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..monthsFrom R [int] Начало периода в месяцах depositFieldReq.partialWithdrawalRules..monthsTo R [int] Конец периода в месяцах depositFieldReq.partialWithdrawalRules..decreaseIntRateValue R [float] Уменьшение депозитной процентной ставки (значение на которое начальная ставка должна уменьшиться). Если значение равно ноль, то уменьшать ставку не нужно. depositFieldReq.Id М [int] Id depositFieldReq.depositTypeId М [int] Id Вида депозита depositFieldReq.interestChargeMethodId М [int] Id Метода начисления процентов depositFieldReq.periodChargeScopeId М [int] Id Границы периода начисления процентов depositFieldReq.allowHolidaysPayment М [bool] Не переносить с праздников и выходных depositFieldReq.depositRateTypeId М [int] Id Вида процентной ставки депозита depositFieldReq.depositTaxCalcTypeId М [int] Id Способа расчета НДФЛ depositFieldReq.clearIntRate М [float] Ставка выплаты процентов на руки depositFieldReq.lowLimit М [float] Минимальный размер депозита depositFieldReq.maxLimit М [float] Максимальный размер депозита depositFieldReq.minDepositIncrease М [float] Минимальная сумма доп.взноса depositFieldReq.intRate М [float] Процентная ставка depositFieldReq.insuranceFee М [float] Страховочный взнос (ставка) depositFieldReq.fixedInsuranceFee М [float] Фиксированный страховочный взнос (сумма) depositFieldReq.estimateFee М [float] Сметный взнос (ставка) depositFieldReq.fixedEstimateFee М [float] Фиксированный сметный взнос (сумма) depositFieldReq.depositScheduleCalcMethodId М [int] Id Дня снятия процентов depositFieldReq.interestPaymentPeriodicityId М [int] Id Периодичности выплаты процентов depositFieldReq.paymentByMonthLastDay М [bool] Выплаты по последним числам месяца depositFieldReq.monthsQty М [int] Cрок депозита: количество месяцев depositFieldReq.reCalcIntRate М [float] Процентная ставка перерасчет depositFieldReq.postContractIntRate М [float] Процентная ставка постКонтрактная depositFieldReq.paymentAmount М [float] Сумма взноса depositFieldReq.penaltyRate М [float] Ставка штрафа depositFieldReq.penaltyDaysCount М [int] Количество дней начисления штрафа depositFieldReq.recalculationRates М [collection] Ставки перерасчета depositFieldReq.recalculationRates..id R [int] Id depositFieldReq.recalculationRates..periodBegin R [int] Начало периода depositFieldReq.recalculationRates..periodEnd  R [int] Конец периода depositFieldReq.recalculationRates..rate R [float] ставка перерасчета branchId R [int] Id Филиала subdivisionId R [int] Id Подразделения clientId R [int] Идентификационный номер клиента currencyId R [int] Id Валюты depositAmount R [float] Сумма депозита firstDepositPaymentDate R [date] Дата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD returnPlanDate R [date] Плановая дата возврата депозита в формате YYYY-MM-DD creditOfficerld R [int] Идентификационный номер менеджера по работе с клиентом insurancePolicy R [string] Страховой полис insurance R [bool] Страхование insurancePremiumRate R [float] Ставка страховой премии insurancePremiumAmount R [float] Сумма страховой премии creditContractId R [int] Ссылка на кредитный контракт paymentViaBank R [bool] Взаиморасчеты через банк

Успешный ответ 200 JSON {         "id": 47630,         "name": "Д-1150",         "creationDate": "2026-04-29",         "depositProductId": 8,         "depositFieldReq": {             "id": 941,             "depositTypeId": 101852,             "interestChargeMethodId": 101863,             "periodChargeScopeId": null,             "allowHolidaysPayment": false,             "depositRateTypeId": 101871,             "depositTaxCalcTypeId": 102101,             "clearIntRate": 0.0,             "lowLimit": 200000.0,             "maxLimit": 0.0,             "minDepositIncrease": 0.0,             "intRate": 1.0,             "insuranceFee": 0.0,             "fixedInsuranceFee": 0.0,             "estimateFee": 0.0,             "fixedEstimateFee": 0.0,             "depositScheduleCalcMethodId": 101882,             "interestPaymentPeriodicityId": 101511,             "paymentByMonthLastDay": false,             "monthsQty": 3,             "reCalcIntRate": 0.0,             "postContractIntRate": 0.0,             "maxPartialWithdrawalQty": 0,             "paymentAmount": 0.0,             "penaltyRate": 0.0,             "penaltyDaysCount": 0,             "recalculationRates": [],             "partialWithdrawalRules": []         },         "branchId": 101304,         "subdivisionId": 101796,         "clientId": 39208,         "currencyId": 101011,         "depositAmount": 200000.0,         "firstDepositPaymentDate": "2026-05-29",         "returnPlanDate": "2026-06-29",         "creditOfficerId": null,         "insurancePolicy": "",         "insurance": false,         "insurancePremiumRate": 0.0,         "insurancePremiumAmount": 0.0,         "creditContractId": null,         "paymentViaBank": null,         "contractTypeId": 101912,         "takeDepositDate": null,         "closeDate": null,         "createUserId": 1334,         "createSubdivisionId": 101791,         "contractLine": {             "id": 47627,             "lineLimit": null         }     }

Параметр Обязателен Тип данных Описание id R [int] Идентикационный номер депозитного контракта name R [string] Код контракта creationDate R [date] Дата создания депозитного контракта  в формате YYYY-MM-DD depositProductId R [int] Идентификационный номер депозитного продукта depositFieldReq R [object] Условия депозита depositFieldReq.maxPartialWithdrawalQty О [int] Максимальное кол-во возможных частичных снятий. В случае если нужно запретить частичное снятие, то достаточно оставить в этом поле значение ноль ("maxPartialWithdrawalQty": 0). depositFieldReq.partialWithdrawalRules О [collection] Правила частичного снятия depositFieldReq.partialWithdrawalRules..id О [int] Идентификатор правила частичного снятия depositFieldReq.partialWithdrawalRules..withdrawalPartFrom О [float] Доля частичного снятия с (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..withdrawalPartTo О [float] Доля частичного снятия по (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..monthsFrom О [int] Начало периода в месяцах depositFieldReq.partialWithdrawalRules..monthsTo О [int] Конец периода в месяцах depositFieldReq.partialWithdrawalRules..decreaseIntRateValue О [float] Уменьшение депозитной процентной ставки (значение на которое начальная ставка должна уменьшиться). Если значение равно ноль, то уменьшать ставку не нужно. depositFieldReq.Id R [int] Id depositFieldReq.depositTypeId R [int] Id Вида депозита depositFieldReq.interestChargeMethodId R [int] Id Метода начисления процентов depositFieldReq.periodChargeScopeId R [int] Id Границы периода начисления процентов depositFieldReq.allowHolidaysPayment R [bool] Не переносить с праздников и выходных depositFieldReq.depositRateTypeId R [int] Id Вида процентной ставки депозита depositFieldReq.depositTaxCalcTypeId R [int] Id Способа расчета НДФЛ depositFieldReq.clearIntRate R [float] Ставка выплаты процентов на руки depositFieldReq.lowLimit R [float] Минимальный размер депозита depositFieldReq.maxLimit R [float] Максимальный размер депозита depositFieldReq.minDepositIncrease R [float] Минимальная сумма доп.взноса depositFieldReq.intRate R [float] Процентная ставка depositFieldReq.insuranceFee R [float] Страховочный взнос (ставка) depositFieldReq.fixedInsuranceFee R [float] Фиксированный страховочный взнос (сумма) depositFieldReq.estimateFee R [float] Сметный взнос (ставка) depositFieldReq.fixedEstimateFee R [float] Фиксированный сметный взнос (сумма) depositFieldReq.depositScheduleCalcMethodId R [int] Id Дня снятия процентов depositFieldReq.interestPaymentPeriodicityId R [int] Id Периодичности выплаты процентов depositFieldReq.paymentByMonthLastDay R [bool] Выплаты по последним числам месяца depositFieldReq.monthsQty R [int] Cрок депозита: количество месяцев depositFieldReq.reCalcIntRate R [float] Процентная ставка перерасчет depositFieldReq.postContractIntRate R [float] Процентная ставка постКонтрактная depositFieldReq.paymentAmount R [float] Сумма взноса depositFieldReq.penaltyRate R [float] Ставка штрафа depositFieldReq.penaltyDaysCount R [int] Количество дней начисления штрафа depositFieldReq.recalculationRates R [collection] Ставки перерасчета depositFieldReq.recalculationRates..id R [int] Id depositFieldReq.recalculationRates..periodBegin R [int] Начало периода depositFieldReq.recalculationRates..periodEnd  R [int] Конец периода depositFieldReq.recalculationRates..rate R [float] ставка перерасчета branchId R [int] Id Филиала subdivisionId R [int] Id Подразделения clientId R [int] Идентификационный номер клиента currencyId R [int] Id Валюты depositAmount R [float] Сумма депозита firstDepositPaymentDate R [date] Дата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD returnPlanDate R [date] Плановая дата возврата депозита в формате YYYY-MM-DD creditOfficerld R [int] Идентификационный номер менеджера по работе с клиентом insurancePolicy R [string] Страховой полис insurance R [bool] Страхование insurancePremiumRate R [float] Ставка страховой премии insurancePremiumAmount R [float] Сумма страховой премии creditContractId R [int] Ссылка на кредитный контракт paymentViaBank R [bool] Взаиморасчеты через банк contractTypeId R [int] Id Типа контракта takeDepositDate R [timestamp] Дата открытия депозита в формате unix timestamp в миллисекундах closeDate R [timestamp] Дата закрытия в формате unix timestamp в миллисекундах createUserId R [int] Id Пользователя, создавшего контракт createSubdivisionId R [int] Id Подразделения пользователя, создавшего контракт contractLine R [object] Линия нарушения последовательности contractLine.id R [int] Id contractLine.lineLimit R [int] Граница последовательности

3) Метод: GET/PUT  /bs-core/main/deposit-contracts/{id} — Получение/редактирование депозитного контракта по его идентификатору

Назначение: Получение всех заполненных параметров депозитного контракта, по указанному идентификатору/Редактирование, изменение параметров и их сохранение методом PUT

Технические параметры:

Параметр Значение Метод GET/PUT Путь /bs-core/main/deposit-contracts/{id} Content-Type application/json Авторизация bsauth <accesstoken> Тело запроса: не передается для GET/для PUT передается ответ GET. Успешный ответ 200. JSON { "id": 47630, "name": "Д-1150", "creationDate": "2026-04-29", "depositProductId": 8, "depositFieldReq": { "id": 941, "depositTypeId": 101852, "interestChargeMethodId": 101863, "periodChargeScopeId": null, "allowHolidaysPayment": false, "depositRateTypeId": 101871, "depositTaxCalcTypeId": 102101, "clearIntRate": 0.0, "lowLimit": 200000.0, "maxLimit": 0.0, "minDepositIncrease": 0.0, "intRate": 1.0, "insuranceFee": 0.0, "fixedInsuranceFee": 0.0, "estimateFee": 0.0, "fixedEstimateFee": 0.0, "depositScheduleCalcMethodId": 101882, "interestPaymentPeriodicityId": 101511, "paymentByMonthLastDay": false, "monthsQty": 3, "reCalcIntRate": 0.0, "postContractIntRate": 0.0, "maxPartialWithdrawalQty": 0, "paymentAmount": 0.0, "penaltyRate": 0.0, "penaltyDaysCount": 0, "recalculationRates": [], "partialWithdrawalRules": [] }, "branchId": 101304, "subdivisionId": 101796, "clientId": 39208, "currencyId": 101011, "depositAmount": 200000.0, "firstDepositPaymentDate": "2026-05-29", "returnPlanDate": "2026-06-29", "creditOfficerId": null, "insurancePolicy": "", "insurance": false, "insurancePremiumRate": 0.0, "insurancePremiumAmount": 0.0, "creditContractId": null, "paymentViaBank": null, "contractTypeId": 101912, "takeDepositDate": null, "closeDate": null, "createUserId": 1334, "createSubdivisionId": 101791, "contractLine": { "id": 47627, "lineLimit": null } } Параметр Обязателен Тип данных Описание id R [int] Идентикационный номер депозитного контракта name R [string] Код контракта creationDate R [date] Дата создания депозитного контракта  в формате YYYY-MM-DD depositProductId R [int] Идентификационный номер депозитного продукта depositFieldReq R [object] Условия депозита depositFieldReq.Id R [int] Id depositFieldReq.depositTypeId R [int] Id Вида депозита depositFieldReq.interestChargeMethodId R [int] Id Метода начисления процентов depositFieldReq.periodChargeScopeId R [int] Id Границы периода начисления процентов depositFieldReq.allowHolidaysPayment R [bool] Не переносить с праздников и выходных depositFieldReq.depositRateTypeId R [int] Id Вида процентной ставки депозита depositFieldReq.depositTaxCalcTypeId R [int] Id Способа расчета НДФЛ depositFieldReq.clearIntRate R [float] Ставка выплаты процентов на руки depositFieldReq.lowLimit R [float] Минимальный размер депозита depositFieldReq.maxLimit R [float] Максимальный размер депозита depositFieldReq.minDepositIncrease R [float] Минимальная сумма доп.взноса depositFieldReq.intRate R [float] Процентная ставка depositFieldReq.insuranceFee R [float] Страховочный взнос (ставка) depositFieldReq.fixedInsuranceFee R [float] Фиксированный страховочный взнос (сумма) depositFieldReq.estimateFee R [float] Сметный взнос (ставка) depositFieldReq.fixedEstimateFee R [float] Фиксированный сметный взнос (сумма) depositFieldReq.depositScheduleCalcMethodId R [int] Id Дня снятия процентов depositFieldReq.interestPaymentPeriodicityId R [int] Id Периодичности выплаты процентов depositFieldReq.paymentByMonthLastDay R [bool] Выплаты по последним числам месяца depositFieldReq.monthsQty R [int] Cрок депозита: количество месяцев depositFieldReq.reCalcIntRate R [float] Процентная ставка перерасчет depositFieldReq.postContractIntRate R [float] Процентная ставка постКонтрактная depositFieldReq.maxPartialWithdrawalQty О [int] Максимальное кол-во возможных частичных снятий. В случае если нужно запретить частичное снятие, то достаточно оставить в этом поле значение ноль ("maxPartialWithdrawalQty": 0). depositFieldReq.paymentAmount R [float] Сумма взноса depositFieldReq.penaltyRate О [float] Ставка штрафа depositFieldReq.penaltyDaysCount О [int] Количество дней начисления штрафа depositFieldReq.recalculationRates О [collection] Ставки перерасчета depositFieldReq.recalculationRates..id О [int] Id depositFieldReq.recalculationRates..periodBegin О [int] Начало периода depositFieldReq.recalculationRates..periodEnd О [int] Конец периода depositFieldReq.recalculationRates..rate О [float] ставка перерасчета depositFieldReq.partialWithdrawalRules О [collection] Правила частичного снятия. depositFieldReq.partialWithdrawalRules..id О [int] Идентификатор правила частичного снятия depositFieldReq.partialWithdrawalRules..withdrawalPartFrom О [float] Доля частичного снятия с (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..withdrawalPartTo О [float] Доля частичного снятия по (в процентах от начальной суммы депозита) depositFieldReq.partialWithdrawalRules..monthsFrom О [int] Начало периода в месяцах depositFieldReq.partialWithdrawalRules..monthsTo О [int] Конец периода в месяцах depositFieldReq.partialWithdrawalRules._.decreaseIntRateValue О [float] Уменьшение депозитной процентной ставки (значение на которое начальная ставка должна уменьшиться). Если значение равно ноль, то уменьшать ставку не нужно. branchId О [int] Id Филиала subdivisionId О [int] Id Подразделения clientId О [int] Идентификационный номер клиента currencyId О [int] Id Валюты depositAmount О [float] Сумма депозита firstDepositPaymentDate О [date] Дата первой выплаты процентов по депозитному контракту в формате YYYY-MM-DD returnPlanDate О [date] Плановая дата возврата депозита в формате YYYY-MM-DD creditOfficerld О [int] Идентификационный номер менеджера по работе с клиентом insurancePolicy О [string] Страховой полис insurance О [bool] Страхование insurancePremiumRate О [float] Ставка страховой премии insurancePremiumAmount О [float] Сумма страховой премии creditContractId О [int] Ссылка на кредитный контракт paymentViaBank О [bool] Взаиморасчеты через банк contractTypeId О [int] Id Типа контракта takeDepositDate О [timestamp] Дата открытия депозита в формате unix timestamp в миллисекундах closeDate О [timestamp] Дата закрытия в формате unix timestamp в миллисекундах createUserId О [int] Id Пользователя, создавшего контракт createSubdivisionId О [int] Id Подразделения пользователя, создавшего контракт contractLine О [object] Линия нарушения последовательности contractLine.id О [int] Id contractLine.lineLimit О [int] Граница последовательности

4) Метод: GET  /bs-core/main/deposit-contracts/qty — Получение общего количества депозитных  контрактов

Назначение: Получение общего количества депозитных контрактов, созданных в системе.

Технические параметры:

Параметр Значение Метод GET Путь /bs-core/main/deposit-contracts/qty Content-Type application/json Авторизация bsauth <access_token> Тело запроса: не передается. Успешный ответ 200. JSON { "status": "ok", "timestamp": 1473068978054, "data": 2 }

Примечание: Параметр "data": генерирует и возвращает количество паевых контрактов, созданных в системе.

5) Метод: DELETE /bs-core/main/deposit-contracts/{id} — Удаление депозитных контрактов

Назначение: Удаление депозитного контракта.

Технические параметры:

Параметр Значение Метод DELETE
Путь /bs-core/main/deposit-contracts/{id} Content-Type application/json Авторизация bsauth <access_token> Тело запроса: не передается. Успешный ответ 200. JSON

{ "status": "ok", "timestamp": 1473068884050, "data": "" } 6) Метод: GET /bs-core/main/deposit-contracts/find/{ids} - Поиск депозитных контрактов по списку идентификаторов

Назначение: Осуществление поиска депозитных контрактов по списку идентификаторов.

Технические параметры:

Параметр Значение Метод GET
Путь bs-core/main/deposit-contracts/find/{ids} Content-Type application/json Авторизация bsauth <access_token> Тело запроса: не передается.

Пример запроса: /bs-core/main/deposit-contracts/find/47630, 47559 или /bs-core/main/deposit-contracts/find/47630, 47559?preserveOrder=true

Успешный ответ 200 – В ответ возвращаются все депозитные контракты, в соответствии с перечисленными идентификаторами.

Примечание: Поиск депозитных контрактов по списку идентификаторов, разделённых запятыми. При передаче методу параметра preserveOrder со значением true, метод возвратит групповые соглашения в JSON-файле именно в том порядке, который был передан методу. Если этот параметр не передается, то депозитные контракты возвращаются по возрастающим идентификаторам.

7) Метод: POST /bs-core/main/deposit-contracts/partial-load - Поиск депозитных контрактов.

Назначение: Метод предназначен для поиска по депозитным контрактам с возможностью задавать набор полей в ответе и порядок сортировки элементов.

Технические параметры:

Параметр Значение Метод POST Путь /bs-core/main/deposit-contracts/partial-load Content-Type application/json Авторизация bsauth <access_token> Тело запроса: "fields": [ "id", "client.id", "client.creationDate", "client.additionalInfo.riskStatusType.id", "name", "creationDate", "closeDate", "closedStatus.id", "branch.id", "subdivision.id", "loanAmount", "creditProductName", "creditProduct.id", "loanApplication.id", "loanApplication.gettingMoneyMethod.id", "loanApplication.name", "creditField.id", "client.naturalperson", "client.sex.id", "client.lastName", "client.firstName", "client.patronymic", "client.title", "issueDate", "forIssue", "creditContract.id" ], "orderBy": "id", "orderDirection": "DESC", "orderByFields": [ { "field": "creationDate" }, { "field": "id", "direction": "desc" } ], "searchFields": [ { "field": "creationDate", "value": ">=2018-05-20 00:00:00" } ], "countFrom": 0, "countTo": 10 }

Параметр Обязателен Тип данных Описание fields R [collection] Коллекция полей, которые должны вернуться в результатах поиска. fields.{fieldName} М [string][255] В качестве элементов списка могут быть указаны любые поля из  Депозитного контракта, которые не являются внешними ключами. Например: "name", "CreationDate" и так далее.  Признаком внешнего ключа является указание в описании параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: clientId. Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте депозитный контракт есть поле clientId, которое является внешним ключом. Это значит, что мы можем запросить любое поле объекта клиент: client.id, client.lastName и так далее. Также возможны варианты, при которых мы можем запросить поля из более глубоких сущностей, при наличии внешних ключей в объекте.  Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлен депозитный контракт. orderBy R [string][255 ] Название поля, по которому надо делать сортировку. С релиза 2.0.0-65 для сортировки следует использовать коллецию orderByFields. ​ orderDirection R [enum ] Направление сортировки результатов поиска DESC - по убыванию ASC - по позрастанию С релиза 2.0.0-65 для направления сортировки следует передавать направление в коллекции orderByFields. orderByFields R [collection] Массив полей, по которым происходит сортировка. "orderByFields": [      { "field": "creationDate" },      { "field": "manualStatusId", "direction": "desc" }     ] В этом примере сортировка происходит по полям creationDate и manualStatusId. Также результат сортируется по убыванию. Для направления сортировки используется параметр manualStatusId. Если поле direction не указан, то сортировка по полю выполняется по возрастанию. Если в запросе на ядро переданы оба способа сортировки, то старый способ задания сортировки игнорируется. Эти изменения действуют с релиза 2.0.0-65. Смотрите также описание параметров orderBy и orderDirection. searchFields R [string] Условия поиска (фильтрации) депозитных контрактов, наличие параметра searchFields является обязательным, однако это может быть пустая коллекция (условия поиска могут быть не заданы). Строго рекомендуется задавать параметры фильтрации.  searchFields..field М [string][255 ] Название поля, по которому нужно сделать фильтрацию. Правила формирования этого поля следующие:  В качестве элементов списка могут быть указаны любые поля из сущности Депозитный контракт, которые не являются внешними ключами. Например: "name", "CreationDate" и так далее.  Признаком внешнего ключа является указание в описание параметра на метод, который позволяет по ID (по значению параметра - получить объект). Пример: clientId. Для полей, которые являются внешними ключами - возможно получение любых полей объекта, ID котрого указано в поле. Например: в объекте "Паевой контракт"  есть поле clientId, котрое является внешним ключом. Это значит, что мы можем запросить любое поле объекта клиент: client.id, client.lastName и так далее. Также возможны варианты, при которых мы можем запросить поля из более глубоких сущностей, при наличии внешних ключей в объекте.  Например: client.passport.seria - позволяет получить серию паспорта клиента, от которого оформлен депозитный контракт. searchFields..value М [string][255] Значение для фильтрации. В значении параметра может указывается как точное значение, так и нет. Для значений не полного соответствия используются различные параметры. Для указания значений этого параметра можно использовать следующие операторы: %, like, !=, null, not null, >, <, >=, <=. Для передачи даты используется следующий формат YYYY-MM-DD (действует с 2.0.0-65 релиза) например 2018-05-25, а для передачи даты и времени YYYY-MM-DD hh:mm:ss (например 2018-05-25 12:22:35). Пример условия строгого соответствия:        {            "field": "client.id",            "value": "123"        }, Так и условия нестрогого соответствия, например:        {            "field": "creationDate",            "value": ">=2017-09-01 00:00:00"        },       {            "field": "creationDate",            "value": "<=2017-09-01 00:00:00"        } Так же в поле "field" можно передать тип контракта ( по умолчанию поиск по всем типам контракта) :  Кредитный - 101911;  Депозитный - 101912; Паевой - 101913. Например: { "field": "contractType.id", "value": 101911 }
Поле businessStatus из списка динамических параметров в списке поля для вывода и в списке полей для поиска может принимать значение null. При этом в поиске можно использовать поиск по null, но нельзя использовать like, >, <. То есть или строгое соответствие или null. Например:         {             "field": "businessStatus",             "value": "AUTOCHECK"         } searchFields..ornumber М [string][255] Значение для группировки параметров поиска (фильтрации) в условии OR. Поле не обязательное и используется в случаях когда нужно искать как условия по И, так и условия по ИЛИ. Например, нужно найти все записи у которых в поле1 указано значение XXXX, при этом в поле2 указано YYYY или ZZZZ. В этом случае можно использовать поле ornumber. Значение может быть числом или символом, но уникальным в рамках одной группы условий ИЛИ. Зарезервированным значением является  -1 Пример 1:        {            "field": "contract.id",            "value": "10134756"        },       {            "field": "loanAmount",            "value": "10000",            "ornumber": "1",        },      {            "field": "name",            "value": "5%",            "ornumber": "1",        },  В этом примере будут искаться все записи, у которых в поле contract.id указано 10134756 и при этом одновременно выполняется одно из условий поле loanAmount равно 10000 или поле name начинается с 5%. То есть, в выражении языка SQL : contract.id = 10134756 AND (loanAmount = 10000 OR name like "5%") Пример 2:        {            "field": "name",            "value": "1%",            "ornumber": "1",        },      {            "field": "name",            "value": "5%",            "ornumber": "1",        },     {            "field": "loanAmount",            "value": "10000",            "ornumber": "2",        },      {            "field": "loanAmount",            "value": "20000",            "ornumber": "2",        },  В  выражении языка SQL : (name like "1%" OR name like "5%" ) AND (loanAmount = 10000 OR loanAmount = 20000) countFrom R [int] Смещение от начала поиска, т.е. если хотим получить с 10-ой записи, то передаем 10. countTo R [int ] Лимит (сколько записей будет возвращено)

Успешный ответ

[ { "id": 101342034, "fields": { "id": 101342034, "client.id": 101322875, "client.creationDate": "2018-06-04", "client.additionalInfo.riskStatusType.id": null, "name": "Д-1350", "creationDate": "2018-06-04", "closeDate": null, "closedStatus.id": null, "branch.id": 101305, "subdivision.id": 101796, "loanAmount": 141000, "creditProductName": "", "creditProduct.id": null, "loanApplication.id": null, "loanApplication.gettingMoneyMethod.id": null, "loanApplication.name": null, "creditField.id": null, "client.naturalperson": true, "client.sex.id": 101252, "client.lastName": "Иван", "client.firstName": "Сергей", "client.patronymic": "Ира", "client.title": "", "issueDate": null, "forIssue": true, "creditContract.id": null } }, { "id": 101342032, "fields": { "id": 101342032, "client.id": 101322875, "client.creationDate": "2018-06-04", "client.additionalInfo.riskStatusType.id": null, "name": "Д-1349", "creationDate": "2018-06-04", "closeDate": null, "closedStatus.id": null, "branch.id": 101305, "subdivision.id": 101796, "loanAmount": 141000, "creditProductName": "", "creditProduct.id": null, "loanApplication.id": null, "loanApplication.gettingMoneyMethod.id": null, "loanApplication.name": null, "creditField.id": null, "client.naturalperson": true, "client.sex.id": 101252, "client.lastName": "Иван", "client.firstName": "Сергей", "client.patronymic": "Ира", "client.title": "", "issueDate": 1528059600000, "forIssue": true, "creditContract.id": null } }, { "id": 101342029, "fields": { "id": 101342029, "client.id": 101322875, "client.creationDate": "2018-06-04", "client.additionalInfo.riskStatusType.id": null, "name": "Д-1348", "creationDate": "2018-06-04", "closeDate": null, "closedStatus.id": null, "branch.id": 101305, "subdivision.id": 101796, "loanAmount": 14100, "creditProductName": "", "creditProduct.id": null, "loanApplication.id": null, "loanApplication.gettingMoneyMethod.id": null, "loanApplication.name": null, "creditField.id": null, "client.naturalperson": true, "client.sex.id": 101252, "client.lastName": "Иван", "client.firstName": "Сергей", "client.patronymic": "Ира", "client.title": "", "issueDate": null, "forIssue": true, "creditContract.id": null } }, { "id": 101342027, "fields": { "id": 101342027, "client.id": 101322875, "client.creationDate": "2018-06-04", "client.additionalInfo.riskStatusType.id": null, "name": "Д-1347", "creationDate": "2018-06-04", "closeDate": null, "closedStatus.id": null, "branch.id": 101305, "subdivision.id": 101796, "loanAmount": 141000, "creditProductName": "", "creditProduct.id": null, "loanApplication.id": null, "loanApplication.gettingMoneyMethod.id": null, "loanApplication.name": null, "creditField.id": null, "client.naturalperson": true, "client.sex.id": 101252, "client.lastName": "Иван", "client.firstName": "Сергей", "client.patronymic": "Ира", "client.title": "", "issueDate": null, "forIssue": true, "creditContract.id": null } } ]

Параметр Обязателен Тип данных Описание id R [int] Идентификатор депозитного контракта, который соотвествует заданным параметрам фильтрации fields R [collection] Коллекция полей, которые вернулись в ответ на запрос fields.{field} R [mixed] Набор полей в ответе зависит от того, какие поля были переданы в коллекцию searchFields. Типы данных и значения следует смотреть в описании соответствующих сущностей.

8) Метод: POST /bs-core/main/deposit-contracts/{contractId}/comments – Создать комментарии по депозитному контракту

Назначение: Метод предназначен для создания комментариев для депозитных контрактов.

Технические параметры:

Параметр Значение Метод POST Путь /bs-core/main/deposit-contracts/{contractId}/comments Content-Type application/json Авторизация bsauth <access_token> Тело запроса: { "body":"Комментарий по этому депозитному контракту" } Успешный ответ: { "status": "ok", "timestamp": 1535718458354, "data": 10224288 // Идентификатор созданного комментария депозитного контракта }

9) Метод: GET /bs-core/main/deposit-contracts/{contractId}/comments – Получить комментарии по депозитному контракту

Технические параметры:

Параметр Значение Метод GET Путь /bs-core/main/deposit-contracts/{contractId}/comments Content-Type application/json Авторизация bsauth <access_token> Тело запроса: Не передается

Ответ: { { "status": "ok", "timestamp": 1535719004871, "data": [ { "body": "Комментарий по этому депозитному контракту", "id": 10224288, "userId": 1082, "creationDate": 1535718458353 } ] }

Параметр Обязателен Тип данных Описание body О [string][65535] Комментарий id О [int][20] Идентификатор userId О [int][11] Id пользователя creationDate О [timestamp] Дата и время комментария в формате unix timestamp в миллисекундах