Menu Финансы Процессы Реестры Сервис Новости Подключиться Войти

API ПФП

API ПФП

Обмен данными осуществляется посредством POST-запросов вида https://budgetform.appspot.com/api/v1?doc=%DOC%&auth=%AUTH%&event=%EVENT%, где

  • %DOC% и %AUTH% – авторизационные параметры, зависящие от базы, к которой происходит обращение;
  • %EVENT% – вызываемый метод (см. ниже).

Обмен данными производится в JSON-формате.

Методы

Метод firstRun

Аргумент – объект Customer; результат – объект FirstRunResponse.

Customer

ПараметрТипОписание
keyStringУникальный ключ клиента в базе Process Insight; назначается бекэндом при создании нового клиента
lastNameStringФамилия
firstNameStringИмя
secondNameStringОтчество
birthDateDateДата рождения
genderStringПол (MALE, FEMALE)
spouseCustomerСупруг(а)
childrenListдети
monthlyIncomeNumberМесячный доход
monthlyPaymentsNumberМесячные платежи
currentAccumulationNumberНакопления
riskProfileStringРиск-профиль (CONSERVATIVE, BALANCED, AGGRESSIVE)

Person

ПараметрТипОписание
keyStringУникальный ключ клиента в базе Process Insight; назначается бекэндом при создании нового клиента
lastNameStringФамилия
firstNameStringИмя
secondNameStringОтчество
birthDateDateДата рождения

FirstRunResponse

ПараметрТипОписание
customerKeyStringПрисвоенный бекэндом уникальный ключ клиента
targetsListЦели

Target

ПараметрТипОписание
keyStringКлюч (уникальный идентификатор) цели
typeStringТип (PENSION, EDUCATION, OTHER, HEALTH, REAL_ESTATE)
nameStringНаименование
monthsIntegerКоличество месяцев
costNumberСтоимость
initialCapitalNumberНачальный капитал
initialReplenishmentNumber
portfolioPortfolio
potentialYieldNumber
costWithInflationNumber
taxDeductionIISNumberНалоговый вычет ИИС
taxDeductionNSGNumberНалоговый вычет НСЖ
costRaisingList
capitalRaisingList
loanRepaymentList
toolTool
toolsList

Portfolio

ПараметрТипОписание
keyStringКлюч (уникальный идентификатор)
targetYearsMinInteger
targetYearsMaxInteger
conservativeLinePortfolioLine
balancedLinePortfolioLine
aggressiveLinePortfolioLine

PortfolioLine

ПараметрТипОписание
potentialYieldNumber
toolsInitialCapitalMap<Long, Double>
toolsReplenishmentCapitalMap<Long, Double>

Tool

ПараметрТипОписание
keyStringКлюч
idInteger
nameStringНаименование
descriptionStringОписание
maxTaxDeductionNumber

Метод calcTarget

Аргумент – объект CalcTargetRequest; результат – объект Target.

CalcTargetRequest

ПараметрТипОписание
customerKeyStringключ клиента
targetTargetЦель для обсчёта
riskProfileStringРиск-профиль (CONSERVATIVE, BALANCED, AGGRESSIVE)

Метод updatePortfolio

Обновление портфеля.

Аргумент – объект CreatePortfolioRequest; результат – объект Portfolio.

CreatePortfolioRequest

ПараметрТипОписание
nameStringНаименование
classNameString
portfolioPortfolio

Метод updateClient

Обновление информации о клиенте.

Аргумент – объект Customer; результат – объект Customer.

Метод updateTool

Создание / обновление инструмента. Если запрос не содержит параметр key, то создаётся новый инструмент; если запрос содержит key, то обновляется инструмент.

Аргумент – объект ToolRequest; результат – объект ToolRequest.

ToolRequest

ПараметрТипОписание
keyStringКлюч инструмента
idInteger
nameStringНаименование

Метод getClient

Возвращает информацию по клиенту.

Аргумент – объект KeyRequest; результат – объект Customer.

KeyRequest

ПараметрТипОписание
keyStringключ

Метод getClients

Возвращает массив всех клиентов ArrayList.

Метод getPortfolio

Возвращает информацию о портфеле.

Аргумент – объект KeyRequest; результат – объект Portfolio.

Метод getPortfolios

Возвращает массив всех портфелей List.

Метод getTool

Возвращает информацию об инструменте.

Аргумент – KeyRequest; результат – объект Tool.

Метод getTools

Возвращает массив всех инструментов List.

Метод getTargets

Возвращает массив всех целей клиента.

Аргумент – KeyRequest; результат – List.

Метод deleteTarget

Удаление цели с пересчётом оставшихся целей клиента.

Аргумент – KeyRequest; результат – Сообщение “OK”.

Метод getAgents

Получение всех агентов

Результат – List.

Объект Agent

ПараметрТипОписание
keyStringКлюч агента (идентификатор Process Insight
idStringИдентификатор агента во внешней системе
fioStringФИО агента
phoneStringТелефон
emailStringemail

Метод getAgent

Возвращает информацию об агенте.

Аргумент – KeyRequest; результат – объект Agent.

Метод updateAgent

Создаёт нового агента (если key не указан) или изменяет информацию по существующему агенту (если указан key).

Аргумент – объект Agent; результат – объект Agent.

Продукт

Обзор Интеграция Частное облако Стоимость Process Insight API Условия использования

Методология

Руководство пользователя Пример: инжиниринг Модуль "Проектная организация" Безопасность Обновления

Компания

Контакты Услуги Работа у нас Вакансия Java-разработчика Политика конфиденциальности

Новости

Viber-боты на платформе Process Insight Process Insight для Google Assistant Автоматический импорт выписок Модуль проектной организации
© 2008–2019, ООО «Процессные технологии»