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

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

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

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

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Данные заявки для конкретного типа продукта. Список полей определен в Поля в заявках по продуктам: product_types_fields

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(CompanyAddress)
Юридический адрес (адрес регистрации).

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
0-1
Наименование банка
dealState.result.fetchFields.BankingDetail<ID>.corrAccount
0-1
Корреспонденский счет банка
dealState.result.fetchFields.BankingDetail<ID>.bik
0-1
БИК банка
dealState.result.fetchFields.BankingDetail<ID>.paymentAccount
0-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
dealState.result.fetchFields.CompanyAddress<ID>.id
1
Идентификатор адреса компании.
Формат:
<COMPANY_ID>:<ITEM_ID>
dealState.result.fetchFields.CompanyAddress<ID>.addressType

Enum (
LEGAL_ADDRESS
FACT_ADDRESS
CORR_ADDRESS
)



dealState.result.fetchFields.CompanyAddress<ID>.isPresent
1boolean
Сведения о присутствии юридического лица и его постоянно действующих органов управления по адресу его местонахождения

dealState.result.fetchFields.CompanyAddress<ID>.isPost
1boolean
Адрес почтовый (адрес для корреспонденции)

dealState.result.fetchFields.CompanyAddress<ID>.isOwned
1boolean
Помещение находится в собственности?

dealState.result.fetchFields.CompanyAddress<ID>.addressString
0-1StringАдрес строкой
dealState.result.fetchFields.CompanyAddress<ID>.kladr
0-1StringКЛАДР
dealState.result.fetchFields.CompanyAddress<ID>.fias
0-1StringФИАС
dealState.result.fetchFields.CompanyAddress<ID>.postCode
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.country
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.region
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.district
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.city
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.street
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.house
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.building
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.flat
0-1String

dealState.result.fetchFields.CompanyAddress<ID>.rentOrOwnerContract
0-1String

Далее поля вложенных сущностей компании определяются в том же стиле. Более подробный список атрибутов этих сущностей можно найти в Поля карточки компании: company_fields. Общий принцип формирования связей между сущьностями ("один ко многим", "один к одному") определен в Концепция организации передаваемых данных, используемая в API.
dealState.result.fetchFields.PersonRole<ID>.id1StringИдентификатор роли ФЛ, который является представителем компании.
dealState.result.fetchFields.PersonRole<ID>.roleType
1Enum(
DIRECTOR
BOOKER
FOUNDER
BENEFICIAR
TRUSTEE
)
DIRECTOR - Директор
BOOKER - Бухгалтер
FOUNDER - Соучеридитель
BENEFICIAR - Бенифициар
TRUSTEE - Доверенное лицо

dealState.result.fetchFields.PersonRole<ID>.stateInDraft???
0-1


dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.fullPostName
0-1
Должность

dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.postDate
0-1
Дата назначения на должность

dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.endDate
0-1
Дата окончания полномочий

dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.workYears
0-1
Работа в отрасли организации (лет)

dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.workPrev
0-1
Предыдущее место работы

dealState.result.fetchFields.PersonRole<ID>{BOOKER}.fullPostName0-1
Должность
dealState.result.fetchFields.PersonRole<ID>{BOOKER}.postDate0-1
Дата назначения на должность
dealState.result.fetchFields.PersonRole<ID>{BOOKER}.endDate0-1
Дата окончания полномочий
dealState.result.fetchFields.PersonRole<ID>{BOOKER}.workYears0-1
Работа в отрасли организации (лет)
dealState.result.fetchFields.PersonRole<ID>{BOOKER}.workPrev0-1
Предыдущее место работы
dealState.result.fetchFields.PersonRole<ID>{FOUNDER}.percent
0-1Decimal(5, 2) (0-100)
Доля в %

dealState.result.fetchFields.PersonRole<ID>{FOUNDER}.date
0-1Date
Дата начала владения

dealState.result.fetchFields.PersonRole<ID>{BENEFICIAR}.percent
0-1Decimal(5, 2) (0-100)Доля в %
dealState.result.fetchFields.PersonRole<ID>{BENEFICIAR}.date0-1Date
Дата начала владения

dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.startDate
0-1DateДата начала действия доверенности
dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.endDate
0-1DateДата начала окончания доверенности
dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.isEdsSigner
0-1BooleanИмеет право подписи по ЕЦП?
dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.docNumber
0-1StringНомер доверености
dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.controlId
FF_ID(PersonRole)
Ссылка на роль представителя, от кого получена довернность.
dealState.result.fetchFields.DocumentRoot<ID>.id
1
Идентификатор логического документа заявления. Формирует концепцию архива из нескольких директорий, каждая директория которого может иметь историю версий.
Формат:
<ITEM_ID>

dealState.result.fetchFields.DocumentRoot<ID>.docType


Прикрепляемые документы: docs_types
dealState.result.fetchFields.ApplicationDocumentBranch<ID>.id
1
Идентификатор директории в архиве. Является контейнером версий директории.
Формат:
<DOCUMENT_ROOT_ID>:<ITEM_ID>

dealState.result.fetchFields.ApplicationDocumentBranch<ID>.description???
0-1


dealState.result.fetchFields.ApplicationDocumentBranch<ID>.lastVersionDocument
1FF_ID(ApplicationDocument)Ссылка на последнюю версию директории (ApplicationDocument)
dealState.result.fetchFields.ApplicationDocument<ID>.id
1
Идентификатор версии директории.
Формат:
<DOCUMENT_ROOT_ID>:<DOCUMENT_BRANCH_ID>:<ITEM_ID>

dealState.result.fetchFields.ApplicationDocument<ID>.docType
1
Прикрепляемые документы: docs_types
FINANCE_REPORT_LAST_QUARTER
dealState.result.fetchFields.ApplicationDocument<ID>.docState
1
ACTUAL - актуальный
ARCHIVE - архивный
ACTUAL
dealState.result.fetchFields.ApplicationDocument<ID>.resolutionDateTime???
0-1


dealState.result.fetchFields.ApplicationDocument<ID>.createDateTime???
0-1


dealState.result.fetchFields.ApplicationDocument<ID>.description???
0-1


dealState.result.fetchFields.DocumentRoot<ID>.author???0-1


dealState.result.fetchFields.ApplicationDocumentFile<ID>.id
1

Идентификатор метаинформации файла в конкретной версии директории.

Формат:

<DOCUMENT_ROOT_ID>:<DOCUMENT_BRANCH_ID>:<DOCUMENT_VERSION_ID>:<ITEM_ID>


dealState.result.fetchFields.ApplicationDocumentFile<ID>.fileName
1
Имя файла
dealState.result.fetchFields.ApplicationDocumentFile<ID>.fileType
1
Тип файла
dealState.result.fetchFields.ApplicationDocumentFile<ID>.url
1
Ссылка на скачивание содержимого файла
dealState.result.fetchFields.ApplicationDocumentFileHash<ID>.id
1

Идентификатор метаинформации о хеше файла. 

Формат:

<DOCUMENT_ROOT_ID>:<DOCUMENT_BRANCH_ID>:<DOCUMENT_VERSION_ID>:<FILE_ID>

Сама структура не обязательна к передаче, но некоторые банки при обработке могут не выполнять загрузку файла, если этот файл уже есть в их хранилище.


dealState.result.fetchFields.ApplicationDocumentFileHash<ID>.hashAlgorithm
1

Алгоритм хеширования.

MD5
SHA-1
GOST3411
GOST3411-2012-256
GOST3411-2012-512


dealState.result.fetchFields.ApplicationDocumentFileHash<ID>.hash
1
String
Хеш, в кодировке HEX
dealState.result.fetchFields.NotebookContact<ID>.id
1
Идентификатор контактной информации
dealState.result.fetchFields.NotebookContact<ID>.company
1FF_ID(Company)Ссылка на компанию, к которой принадлежит контакт
dealState.result.fetchFields.NotebookContact<ID>.lastName
1StringФамилия
dealState.result.fetchFields.NotebookContact<ID>.firstName
1StringИмя
dealState.result.fetchFields.NotebookContact<ID>.middleName
1StringОтчество
dealState.result.fetchFields.NotebookContact<ID>.fullName
1StringФИО одной строкой
dealState.result.fetchFields.NotebookContact<ID>.job???




dealState.result.fetchFields.NotebookContact<ID>.department???




dealState.result.fetchFields.NotebookContact<ID>.startDate???




dealState.result.fetchFields.NotebookContact<ID>.endDate???




dealState.result.fetchFields.NotebookContact<ID>.notebookContactType???




dealState.result.fetchFields.NotebookContact<ID>.decisionRole???




dealState.result.fetchFields.NotebookContact<ID>.isActive???




dealState.result.fetchFields.NotebookContact<ID>.comment???




dealState.result.fetchFields.NotebookContact<ID>.priorityNumber???




dealState.result.fetchFields.NotebookContact<ID>.isEdsSigner???




dealState.result.fetchFields.NotebookContact<ID>.isMainEdsSigner???




dealState.result.fetchFields.NotebookContact<ID>.author???




dealState.result.fetchFields.NotebookContact<ID>.createDateTime???




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

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

Подробнее о структуре нормализованных данных см Концепция организации передаваемых данных, используемая в API

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

Ответ, получаемый при выполнении 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


  • Нет меток