...
| Имя поля | Кратность | Тип | Описание | |
|---|---|---|---|---|
| fetchFields[] | 0-N | Enum(Service, Product)[] | Запрашиваемые дополнительные поля Service - Информация о сервисе (банке) Product - Информация о продукте сервиса | |
| dealState | 1 | Object | Состояние заявки | |
| dealState.result.id | 1 | UUID | Идентификатор сделки (может быть одинаковым для разных заявок) | |
| dealState.result.dealNumber | 1 | String | Номер сделки | |
| dealState.result.name | 1 | String | Наименование сделки | |
| dealState.result.currencyType | 1 | FF_ID(CurrencyTypeCatalog) | Тип валюты | |
| dealState.result.income | 1 | NUM(20, 2) | Планируемая сумма сделки | |
| dealState.result.dealProbability | 0-1 | Integer | Вероятность сделки | |
| dealState.result.resolutionDateTime | 0-1 | DateTime | Необходимая (ожидаемая) дата завершения сделки | |
| dealState.result.client | 1 | FF_ID(Company) | Клиент | |
| dealState.result.clientContact | 1 | FF_ID(NotebookContact) | Контактная информация о Клиенте | |
| dealState.result.agent | 0-1 | Абстрактная ссылка | Агент | Company:UUID или IndividualContactParticipant:UUID |
| dealState.result.pipeline | 0-1 | |||
| dealState.result.responsible | 0-1 | абстрактная ссылка | CompanyContactParticipant:UUID | |
| dealState.result.isFirstDealClient | 0-1 | Boolean | ||
| dealState.result.priority | 0-1 | Enum ( HIGH MEDIUM LOW ) | ||
| dealState.result.baseOnType | 0-1 | Enum ( CLIENT_APPEAL EVENT_RESULT LEAD NEED_FOR_PRODUCT MASTER_DEALS OTHER ) | Основание сделки. Указывается причина, по которой создается сделка. Для клиентов - это чаще всего "Потребность в выбранном типе продукта", для агентов - это один из результатов взаимодействия с клиентом. CLIENT_APPEAL // Обращение клиентаEVENT_RESULT // Результат мероприятияLEAD // Лид NEED_FOR_PRODUCT // Потребность в продукте MASTER_DEALS // Мастер сделки OTHER // Иное | |
| dealState.result.baseOnValue | 0-1 | String | Детальное описание основания | |
| dealState.result.clientContactPhone | 1 | String | Телефон контактного лица клиента | |
| dealState.result.clientContactEmail | 1 | String | Email контактного лица клиента | |
| dealState.result.productDealState | 1 | Object | Данные заявки для конкретного типа продукта. Список полей определен в Поля в заявках по продуктам: product_types_fields | |
| dealState.result.productDealState.productType | 1 | FK(product_types.id) | см product_types | |
| dealState.result.author | 0-1 | Абстрактная ссылка | CompanyContactParticipant:UUID | |
| dealState.result.clientDocuments[] | 0-N | FF_ID(DocumentRoot) | Документы клиента (общие для всех заявок) | |
| dealState.result.dealDocuments[] | 0-N | FF_ID(DocumentRoot) | Документы специфичные для заявок конкретного продукта | |
| dealState.result.financeForms[] | 0-2 | Object[] | Фин отчетность по двум формам | |
| dealState.result.financeForms[].formId | 1 | Идентификатор согласно справочнику finance_forms | ||
| dealState.result.financeForms[].formType | 1 | FORM_1 - форма 1 (ОКУД 0710001)FORM_2 - форма 2 (ОКУД 0710002) | FORM_2 | |
| dealState.result.financeForms[].indicators[] | 0-N | String | <FORM_TYPE>:<IND_CODE> где FORM_TYPE - Enum(FORM_1 FORM_2) IND_CODE - код индикаторов.см справочник finance_fields | "FORM_2:2110" |
| dealState.result.financeForms[].periods[] | 0-N | String | Имеет следующий формат<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] | boolean | true - значение "не определенно"(прочерк). false - в элементе [0] должно быть значение отличное от null, иначе будет ошибка проверки, если данный период и показатель обязателен в настройках продукта | ||
| dealState.result.fetchFields.OkfsCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkfsCatalog<ID>.code | 1 | Внешний код каталога (ОКФС) | ||
| dealState.result.fetchFields.OksmCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OksmCatalog<ID>.code | 1 | Внешний код каталога (ОКСМ) | ||
| dealState.result.fetchFields.OkopfCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkopfCatalog<ID>.code | 1 | Внешний код каталога (ОКОПФ) | ||
| dealState.result.fetchFields.OkpdCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkpdCatalog<ID>.code | 1 | Внешний код каталога (ОКПД) | ||
| dealState.result.fetchFields.OkvedCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkvedCatalog<ID>.code | 1 | Внешний код каталога (ОКВЭД) | ||
| dealState.result.fetchFields.LegalTypeCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.LegalTypeCatalog<ID>.code | 1 | Внешний код каталога (legal_types) | ||
| dealState.result.fetchFields.CurrencyTypeCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.CurrencyTypeCatalog<ID>.code | 1 | Внешний код каталога (валюты) | RUB | |
| dealState.result.fetchFields.OkatoCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkatoCatalog<ID>.code | 1 | Внешний код каталога (ОКАТО) | ||
| dealState.result.fetchFields.OktmoCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OktmoCatalog<ID>.code | 1 | Внешний код каталога (ОКТМО) | ||
| dealState.result.fetchFields.TaxSystemCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.TaxSystemCatalog<ID>.code | 1 | Внешний код каталога (Налогооблажение)OSNO USN ESHN PSN ENVD | ||
| dealState.result.fetchFields.OkoguCatalog<ID>.id | 1 | Внутренний идентификатор каталога (используется в рамках заявки) | ||
| dealState.result.fetchFields.OkoguCatalog<ID>.code | 1 | Внешний код каталога (ОКОГУ) | ||
| dealState.result.fetchFields.Company<ID>.id | 1 | String | ||
| dealState.result.fetchFields.Company<ID>.legalType | 0-1 | Enum( ORGANIZATION IP ) | ||
| dealState.result.fetchFields.Company<ID>.fullName | 0-1 | String | Полное имя | |
| dealState.result.fetchFields.Company<ID>.shortName | 0-1 | String | Короткое имя | |
| dealState.result.fetchFields.Company<ID>.okopf | 0-1 | FF_ID(OkopfCatalog) | ОКПФ | |
| dealState.result.fetchFields.Company<ID>.inn | 0-1 | String | ИНН | |
| dealState.result.fetchFields.Company<ID>.kpp | 0-1 | String | КПП | |
| dealState.result.fetchFields.Company<ID>.innDate | 0-1 | Date | Дата выдачи ИНН | 2000-12-31 |
| dealState.result.fetchFields.Company<ID>.innPlace | 0-1 | String | Наименование органа, выдавшего ИНН | |
| dealState.result.fetchFields.Company<ID>.ogrn | 0-1 | String | ОГРН | |
| dealState.result.fetchFields.Company<ID>.regNumber | 0-1 | String | Серия и номер свидетельства о регистрации | |
| dealState.result.fetchFields.Company<ID>.regDate | 0-1 | Дата государственной регистрации | 2000-12-31 | |
| dealState.result.fetchFields.Company<ID>.regDocDate | 0-1 | Дата выписки свидетельства о государственной регистрации | 2000-12-31 | |
| dealState.result.fetchFields.Company<ID>.regOrg | 0-1 | String | Наименование регистрирующего органа | |
| dealState.result.fetchFields.Company<ID>.regPlace | 0-1 | String | Место государственной регистрации | |
| dealState.result.fetchFields.Company<ID>.okpo | 0-1 | String | ОКПО | |
| dealState.result.fetchFields.Company<ID>.okato | 0-1 | FF_ID(OkatoCatalog) | ОКАТО | |
| dealState.result.fetchFields.Company<ID>.oktmo | 0-1 | FF_ID(OktmoCatalog) | ОКТМО | |
| dealState.result.fetchFields.Company<ID>.okogu | 0-1 | FF_ID(OkoguCatalog) | ОКОГУ | |
| dealState.result.fetchFields.Company<ID>.okfs | 0-1 | FF_ID(OkfsCatalog) | ОКФС | |
| dealState.result.fetchFields.Company<ID>.companySystemType | 0-1 | String | Всегда "Client" | Client |
| dealState.result.fetchFields.Company<ID>.baseOkved | 0-1 | FF_ID(OkvedCatalog) | Базовый ОКВЭД | |
| dealState.result.fetchFields.Company<ID>.okveds[] | 0-N | FF_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-1 | FF_ID(TaxSystemCatalog) | Налогообложение | |
| dealState.result.fetchFields.Company<ID>.pfr | 0-1 | String | Номер в пенсионном фонде Российской Федерации | |
| dealState.result.fetchFields.Company<ID>.fss | 0-1 | String | Номер в фонде социального страхования Российской Федерации | |
| dealState.result.fetchFields.Company<ID>.staff | 0-1 | Integer | Штатная численность сотрудников | |
| dealState.result.fetchFields.Company<ID>.orgType | 0-1 | Enum ( COM UNCOM FIN ) | COM - Комерческая орг. UNCOM - Не комерческая орг. FIN - Финансовая орг. | COM |
| dealState.result.fetchFields.Company<ID>.topType | 0-1 | FF_ID(TopTypeCatalog) | Тип высшего органа управления | |
| dealState.result.fetchFields.Company<ID>.legalAddress | 0-1 | FF_ID(CompanyAddress) | Юридический адрес (адрес регистрации). | |
| dealState.result.fetchFields.Company<ID>.factAddress | 0-1 | FF_ID(CompanyAddress) | Фактический адрес. | |
| dealState.result.fetchFields.Company<ID>.corrAddress | 0-1 | FF_ID(CompanyAddress) | Адрес для корреспонденции. | |
| dealState.result.fetchFields.BankingDetail<ID>.id | 1 | Идентификатор банковских реквизитов компании.Формат:<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>.headCompany | 1 | Головной ли филиал компании(если филиалов нет - значение должно быть true) | ||
| dealState.result.fetchFields.CompanySourceInfo<ID>.hasBranches | 1 | boolean | Имеет ли компания филиалы? | |
| dealState.result.fetchFields.CompanySourceInfo<ID>.source | 1 | 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 ) | |||
Атрибутивный состав объекта CompanyAddress эквивалентен определенному в Поля карточки компании: company_fields (corrAddress.*, factAddress.*, legalAddress.*) | ||||
Person<ID>.id | 1 | Идентификатор ФЛ, который является представителем компании. Формат: <COMPANY_ID>:<ITEM_ID> | ||
Атрибутивный состав объекта Person эквивалентен определенному в Поля карточки компании: company_fields (person.*) | ||||
| PersonAddress<ID>.id | 1 | Идентификатор ФЛ, который является представителем компании. Формат: <COMPANY_ID>:<PERSON_ID>:<ITEM_ID> | ||
| Далее поля вложенных сущностей компании определяются в том же стиле. Более подробный список атрибутов этих сущностей можно найти в Поля карточки компании: company_fields. Общий принцип формирования связей между сущьностями ("один ко многим", "один к одному") определен в Концепция организации передаваемых данных, используемая в API. | ||||
| dealState.result.fetchFields.PersonRole<ID>.id | 1 | String | Идентификатор роли ФЛ, который является представителем компании. Формат: <COMPANY_ID>:<PERSON_ID>:<ITEM_ID> | |
| dealState.result.fetchFields.PersonRole<ID>.roleType | 1 | Enum(DIRECTOR BOOKER FOUNDER BENEFICIAR TRUSTEE) | DIRECTOR - Директор BOOKER - Бухгалтер FOUNDER - Соучеридитель BENEFICIAR - Бенифициар TRUSTEE - Доверенное лицо | |
| dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.fullPostName | 0-1 | Должность | ||
| dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.postDate | 0-1 | Date | Дата назначения на должность | |
| dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.endDate | 0-1 | Date | Дата окончания полномочий | |
| dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.workYears | 0-1 | Integer | Работа в отрасли организации (лет) | |
| dealState.result.fetchFields.PersonRole<ID>{DIRECTOR}.workPrev | 0-1 | String | Предыдущее место работы | |
| dealState.result.fetchFields.PersonRole<ID>{BOOKER}.fullPostName | 0-1 | Должность | ||
| dealState.result.fetchFields.PersonRole<ID>{BOOKER}.postDate | 0-1 | Date | Дата назначения на должность | |
| dealState.result.fetchFields.PersonRole<ID>{BOOKER}.endDate | 0-1 | Date | Дата окончания полномочий | |
| dealState.result.fetchFields.PersonRole<ID>{BOOKER}.workYears | 0-1 | Integer | Работа в отрасли организации (лет) | |
| dealState.result.fetchFields.PersonRole<ID>{BOOKER}.workPrev | 0-1 | String | Предыдущее место работы | |
| dealState.result.fetchFields.PersonRole<ID>{FOUNDER}.percent | 0-1 | Decimal(5, 2) (0-100) | Доля в % | |
| dealState.result.fetchFields.PersonRole<ID>{FOUNDER}.date | 0-1 | Date | Дата начала владения | |
| dealState.result.fetchFields.PersonRole<ID>{BENEFICIAR}.percent | 0-1 | Decimal(5, 2) (0-100) | Доля в % | |
| dealState.result.fetchFields.PersonRole<ID>{BENEFICIAR}.date | 0-1 | Date | Дата начала владения | |
| dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.startDate | 0-1 | Date | Дата начала действия доверенности | |
| dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.endDate | 0-1 | Date | Дата начала окончания доверенности | |
| dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.isEdsSigner | 0-1 | Boolean | Имеет право подписи по ЕЦП? | |
| dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.docNumber | 0-1 | String | Номер доверености | |
| dealState.result.fetchFields.PersonRole<ID>{TRUSTEE}.controlId | FF_ID(PersonRole) | Ссылка на роль представителя, от кого получена довернность. | ||
| dealState.result.fetchFields.DocumentRoot<ID>.id | 1 | Идентификатор логического документа заявления. Формирует концепцию архива из нескольких директорий, каждая директория которого может иметь историю версий. | ||
| 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 | String | ||
| dealState.result.fetchFields.ApplicationDocumentBranch<ID>.lastVersionDocument | 1 | FF_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 | DateTime | ||
| dealState.result.fetchFields.ApplicationDocument<ID>.createDateTime | 0-1 | DateTime | ||
| dealState.result.fetchFields.ApplicationDocument<ID>.description | 0-1 | String | ||
| 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 | UUID | Идентификатор контактной информации | |
| dealState.result.fetchFields.NotebookContact<ID>.company | 1 | FF_ID(Company) | Ссылка на компанию, к которой принадлежит контакт | |
| dealState.result.fetchFields.NotebookContact<ID>.lastName | 1 | String | Фамилия | |
| dealState.result.fetchFields.NotebookContact<ID>.firstName | 1 | String | Имя | |
| dealState.result.fetchFields.NotebookContact<ID>.middleName | 1 | String | Отчество | |
| dealState.result.fetchFields.NotebookContact<ID>.fullName | 1 | String | ФИО одной строкой | |
| dealState.result.fetchFields.NotebookContact<ID>.job | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.department | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.startDate | 0-1 | Date | ||
| dealState.result.fetchFields.NotebookContact<ID>.endDate | 0-1 | Date | ||
| dealState.result.fetchFields.NotebookContact<ID>.notebookContactType | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.decisionRole | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.isActive | 0-1 | Boolean | ||
| dealState.result.fetchFields.NotebookContact<ID>.comment | 0-1 | String | ||
| dealState.result.fetchFields.NotebookContact<ID>.priorityNumber | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.isEdsSigner | 0-1 | Boolean | ||
| dealState.result.fetchFields.NotebookContact<ID>.isMainEdsSigner | 0-1 | Boolean | ||
| dealState.result.fetchFields.NotebookContact<ID>.author | 0-1 | |||
| dealState.result.fetchFields.NotebookContact<ID>.createDateTime | 0-1 | DateTime | ||
...