Руководства пользователей Goodfin
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 3 Следующий »

POST /api/v1/deal/findProducts

Имя поляКратностьТипОписание
fetchFields[]0-NEnum(Service, Product)[]

Запрашиваемые дополнительные поля
Service - Информация о сервисе (банке)
Product - Информация о продукте сервиса


dealState1ObjectСостояние заявки
dealState.result.id1UUIDИдентификатор сделки (может быть одинаковым для разных заявок)

dealState.result.dealNumber???

1String
Номер сделки

dealState.result.name???

1String
Наименование сделки

dealState.result.currencyType

1FF_ID(CurrencyTypeCatalog)Тип валюты

dealState.result.income

1NUM(20, 2)
Планируемая сумма сделки

dealState.result.dealProbability???

0-1Integer
Вероятность сделки

dealState.result.resolutionDateTime???

0-1DateTime
Необходимая (ожидаемая) дата завершения сделки

dealState.result.client

1FF_ID(Company)Клиент

dealState.result.clientContact

1FF_ID(NotebookContact)Контактная информация о Клиенте

dealState.result.agent???



Агент - в теории указывать не нужно

dealState.result.pipeline???



в теории указывать не нужно

dealState.result.responsible???



в теории указывать не нужно

dealState.result.isFirstDealClient???



в теории указывать не нужно

dealState.result.priority???



в теории указывать не нужно

dealState.result.baseOnType???



в теории указывать не нужно

dealState.result.baseOnValue???



в теории указывать не нужно

dealState.result.clientContactPhone

1StringТелефон контактного лица клиента

dealState.result.clientContactEmail

1StringEmail контактного лица клиента

dealState.result.productDealState

1ObjectДанные заявки для конкретного типа продукта

dealState.result.productDealState.productType

1

FK(product_types.id)

см product_types

dealState.result.author???



в теории указывать не нужно

dealState.result.clientDocuments[]

0-NFF_ID(DocumentRoot)Документы клиента (общие для всех заявок)

dealState.result.dealDocuments[]

0-NFF_ID(DocumentRoot)Документы специфичные для заявок конкретного продукта

dealState.result.financeForms[]

0-2Object[]Фин отчетность по двум формам
dealState.result.financeForms[].formId1
Идентификатор согласно справочнику finance_forms

dealState.result.financeForms[].formType

1

FORM_1 - форма 1 (ОКУД 0710001)

FORM_2 - форма 2 (ОКУД 0710002)

FORM_2

dealState.result.financeForms[].indicators[]

0-NString

<FORM_TYPE>:<IND_CODE>
где
FORM_TYPE - Enum(FORM_1 FORM_2)
IND_CODE - код индикаторов.

см справочник finance_fields

"FORM_2:2110"

dealState.result.financeForms[].periods[]

0-NStringИмеет следующий формат
<P_END_DATE>:THOUSAND_RUB
где
P_END_DATE - Дата окончания отчетного периода в формате ISO(YYYY-MM-DD)		2020-12-31:THOUSAND_RUB

dealState.result.financeForms[].values[IND_IDX][PERIOD_IDX]



Матрица значений показателей IND_IDX за период PERIOD_IDX
dealState.result.financeForms[].values[IND_IDX][PERIOD_IDX][0]

Значение показателя. Значение null обрабатывается по разному, в зависимости от [2].
dealState.result.financeForms[].values[IND_IDX][PERIOD_IDX][1]

Зарезервировано
dealState.result.financeForms[].values[IND_IDX][PERIOD_IDX][2]
booleantrue - значение "не определенно"(прочерк). false - в элементе [0] должно быть значение отличное от null, иначе будет ошибка проверки, если данный период и показатель обязателен в настройках продукта
dealState.result.fetchFields.OkfsCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkfsCatalog<ID>.code1
Внешний код каталога  (ОКФС)
dealState.result.fetchFields.OksmCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OksmCatalog<ID>.code1
Внешний код каталога  (ОКСМ)
dealState.result.fetchFields.OkopfCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkopfCatalog<ID>.code1
Внешний код каталога  (ОКОПФ)
dealState.result.fetchFields.OkpdCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkpdCatalog<ID>.code1
Внешний код каталога (ОКПД)
dealState.result.fetchFields.OkvedCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkvedCatalog<ID>.code1
Внешний код каталога (ОКВЭД)
dealState.result.fetchFields.LegalTypeCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.LegalTypeCatalog<ID>.code1
Внешний код каталога (legal_types)
dealState.result.fetchFields.CurrencyTypeCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.CurrencyTypeCatalog<ID>.code1
Внешний код каталога (валюты)RUB
dealState.result.fetchFields.OkatoCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkatoCatalog<ID>.code1
Внешний код каталога (ОКАТО)
dealState.result.fetchFields.OktmoCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OktmoCatalog<ID>.code1
Внешний код каталога (ОКТМО)
dealState.result.fetchFields.TaxSystemCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.TaxSystemCatalog<ID>.code1
Внешний код каталога (Налогооблажение)
OSNO
USN
ESHN
PSN
ENVD

dealState.result.fetchFields.OkoguCatalog<ID>.id1
Внутренний идентификатор каталога (используется в рамках заявки)
dealState.result.fetchFields.OkoguCatalog<ID>.code1
Внешний код каталога (ОКОГУ)
dealState.result.fetchFields.Company<ID>.id
1String

dealState.result.fetchFields.Company<ID>.legalType
0-1String

dealState.result.fetchFields.Company<ID>.fullName
0-1StringПолное имя
dealState.result.fetchFields.Company<ID>.shortName
0-1StringКороткое имя
dealState.result.fetchFields.Company<ID>.okopf
0-1FF_ID(OkopfCatalog)ОКПФ
dealState.result.fetchFields.Company<ID>.inn
0-1StringИНН
dealState.result.fetchFields.Company<ID>.kpp
0-1StringКПП
dealState.result.fetchFields.Company<ID>.innDate
0-1
Дата выдачи ИНН
dealState.result.fetchFields.Company<ID>.innPlace
0-1String
Наименование органа, выдавшего ИНН

dealState.result.fetchFields.Company<ID>.ogrn
0-1StringОГРН
dealState.result.fetchFields.Company<ID>.regNumber
0-1String
Серия и номер свидетельства о регистрации

dealState.result.fetchFields.Company<ID>.regDate
0-1
Дата государственной регистрации

dealState.result.fetchFields.Company<ID>.regDocDate
0-1
Дата выписки свидетельства о государственной регистрации

dealState.result.fetchFields.Company<ID>.regOrg
0-1String
Наименование регистрирующего органа

dealState.result.fetchFields.Company<ID>.regPlace
0-1String
Место государственной регистрации

dealState.result.fetchFields.Company<ID>.okpo
0-1StringОКПО
dealState.result.fetchFields.Company<ID>.okato
0-1FF_ID(OkatoCatalog)ОКАТО
dealState.result.fetchFields.Company<ID>.oktmo
0-1FF_ID(OktmoCatalog)ОКТМО
dealState.result.fetchFields.Company<ID>.okogu
0-1FF_ID(OkoguCatalog)ОКОГУ
dealState.result.fetchFields.Company<ID>.okfs
0-1FF_ID(OkfsCatalog)ОКФС
dealState.result.fetchFields.Company<ID>.companySystemType
0-1StringВсегда "Client"Client
dealState.result.fetchFields.Company<ID>.baseOkved
0-1FF_ID(OkvedCatalog)
Базовый ОКВЭД

dealState.result.fetchFields.Company<ID>.okveds[]
0-NFF_ID(OkvedCatalog)[]Список дополнительных ОКВЭД
dealState.result.fetchFields.Company<ID>.regCapital
0-1
Величина зарегистрированного уставного (складочного) капитала или уставного фонда, имущества (руб.)

dealState.result.fetchFields.Company<ID>.paidCapital
0-1
Величина оплаченного уставного (складочного) капитала или уставного фонда, имущества (руб.)

dealState.result.fetchFields.Company<ID>.taxSystem
0-1FF_ID(TaxSystemCatalog)Налогообложение
dealState.result.fetchFields.Company<ID>.pfr
0-1String
Номер в пенсионном фонде Российской Федерации

dealState.result.fetchFields.Company<ID>.fss
0-1String
Номер в фонде социального страхования Российской Федерации

dealState.result.fetchFields.Company<ID>.staff
0-1Integer
Штатная численность сотрудников

dealState.result.fetchFields.Company<ID>.orgType
0-1

Enum (
COM
UNCOM
FIN
)

COM - Комерческая орг.
UNCOM - Не комерческая орг.
FIN - Финансовая орг.
COM
dealState.result.fetchFields.Company<ID>.topType
0-1FF_ID(TopTypeCatalog)

dealState.result.fetchFields.Company<ID>.legalAddress
0-1FF_ID(TopTypeCatalog)
Юридический адрес (адрес регистрации)

dealState.result.fetchFields.Company<ID>.factAddress
0-1FF_ID(CompanyAddress)
Фактический адрес

dealState.result.fetchFields.Company<ID>.corrAddress
0-1FF_ID(CompanyAddress)
Адрес для корреспонденции

dealState.result.fetchFields.BankingDetail<ID>.id1
Идентификатор банковских рексизитов компании.
Формат:
<COMPANY_ID>:<ITEM_ID>
dealState.result.fetchFields.BankingDetail<ID>.bankName
1
Наименование банка
dealState.result.fetchFields.BankingDetail<ID>.corrAccount
1
Корреспонденский счет банка
dealState.result.fetchFields.BankingDetail<ID>.bik
1
БИК банка
dealState.result.fetchFields.BankingDetail<ID>.paymentAccount
1
Расчетный счет в банке
dealState.result.fetchFields.CompanySourceInfo<ID>.id
1
Идентификатор компании54b19d56-6e68-3479-b329-bf4b10a511fa
dealState.result.fetchFields.CompanySourceInfo<ID>.headCompany1
Головной ли филиал компании(если филиалов нет - значение должно быть true)
dealState.result.fetchFields.CompanySourceInfo<ID>.hasBranches1booleanИмеет ли компания филиалы?
dealState.result.fetchFields.CompanySourceInfo<ID>.source1

kontur
CompanyAddress<ID>.id
1
Идентификатор адреса компании.
Формат:
<COMPANY_ID>:<ITEM_ID>
addressType

Enum (
LEGAL_ADDRESS
FACT_ADDRESS
CORR_ADDRESS
)



isPresent

boolean
Сведения о присутствии юридического лица и его постоянно действующих органов управления по адресу его местонахождения

isPost

boolean
Адрес почтовый (адрес для корреспонденции)

isOwned

boolean
Помещение находится в собственности?

addressString

StringАдрес строкой
kladr

StringКЛАДР
fias

StringФИАС
postCode

String

country

String

region

String

district

String

city

String

street

String

house

String

building

String

flat

String

rentOrOwnerContract

String






Рабочий пример состояния сделки: deal_app.json

Пример сообщения: findProducts.json  (ДОБАВИТЬ ИЗ ПЕРВОИСТОЧНИКА)

Информация о подходящих продуктах и требования по дальнейшему заполнению

Ответ, получаемый при выполнении findProducts, содержит список доступных продуктов


{
    "result": [
      {
        "product": "7ab44246-4607-41f4-8272-8b2ed290e210:beff7718-c72b-43be-b7c6-aa58b1df3cca",
        "serviceCompanyErrors": [],
        "serviceProductErrors": [
          {
            "validator": {
              "field": "BG:productDealState.tender.enforceAmount",
              "type": "PRODUCT_FIELD_REQUIRED"
            },
            "count": 1
          }
        ],
        "serviceMissingClientDocTypes": [
            {
              "docType": "EXTRACT_FROM_LEGAL_PERSON_REGISTRY",
              "paramGroups": []
            }
          ],
        "serviceMissingDealDocTypes": [],
        "serviceMissingIndicators": [],
        "documentTooltips": [
            {
              "tooltip": null,
              "docTypes": [
                "HEAD_PASSPORT_COPY",
                "EXTRACT_FROM_LEGAL_PERSON_REGISTRY",
                "CHARTER",
                "HEAD_APPOINTMENT_PROTOCOL",
                "FINANCE_REPORT_LAST_QUARTER",
                "ANALYTICAL_BALANCE_LAST_REPORTING_YEAR"
              ]
            }
          ],
        "financeIndicatorTooltips": [],
        "tariffCompanyErrors": [],
        "tariffProductErrors": []
      }
    ],
    "fetchFields": {
      "Product": {
        "7ab44246-4607-41f4-8272-8b2ed290e210:beff7718-c72b-43be-b7c6-aa58b1df3cca": {
          "id": "7ab44246-4607-41f4-8272-8b2ed290e210:beff7718-c72b-43be-b7c6-aa58b1df3cca",
          "name": "Банковская гарантия на исполнение для ЮЛ банка ДЖОЛВЖД (ред.10.12.20)",
          "shortName": "БГ на исполнение, ЮЛ (ред.10.12.20, ДЖОЛВЖД)",
          "productType": "BG",
          "description": null,
          "state": "1",
          "author": "ServiceContactParticipant:806b9fea-0d07-4f18-bd9d-0ca3c1e9a346",
          "createDateTime": "2020-12-10T05:59:47.746426",
          "modifier": "ServiceContactParticipant:806b9fea-0d07-4f18-bd9d-0ca3c1e9a346",
          "modifiedDateTime": "2020-12-28T06:27:48.044206"
        }
      }
    }
}

Описание полей ответа

КлючОписаниеПрим.
productСодержит ссылку на fetchField Product
serviceCompanyErrors

Содержит информацию о необходимых для заполнения полях продукта.
Перечень возможных значений см. в справочнике company_fields


serviceProductErrorsСодержит информацию о необходимых для заполнения полях продукта.
Перечень возможных значений см. в справочнике product_types_fields
serviceMissingClientDocTypesСодержит список недостающих документов клиента.
Перечень возможных значений см. в справочнике docs_types
serviceMissingDealDocTypesСодержит список недостающих обязательных документов о сделке.
serviceMissingIndicatorsСодержит список достающих обязательных фин.показателей.
Перечень возможных значений см. в справочнике finance_fields
documentTooltips

Содержит список документов необходимых при заполнении
"либо документы, либо фин.показатели"


financeIndicatorTooltipsСодержит список фин.показателей необходимых при заполнении
"либо документы, либо фин.показатели"
tariffCompanyErrors

tariffProductErrors


  • Нет меток