Описание API интерфейса программного продукта «Микрофинансовая система»

Документация API интерфейса ПО 1С «Микрофинансовая система»

Данная документация создана с целью описания механизмов взаимодействия системы ПО "Микрофинансовые системы" и другого программного обеспечения. Данный API (программный интерфейс) реализован с помощью SOAP формата обмена сообщениями. Чтобы начать использовать эти возможности, нужно опубликовать базу данных. Возможно ведение лога обмена.

1. МЕТОДЫ ПОЛУЧЕНИЯ ИНФОРМАЦИИ.

1.1. Метод «CheckContract».

Описание: проверяет наличие договора в системе МФС.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
Contract	Строка [max 36]	нет	Входной	Идентификатор договора для обмена с сайтом
idTransaction	Строка	да	Входной - Выходной	Номер транзакции
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	Строка	да	Выходной	дополнительное описание

1.2. Метод «GetClientInfo»

Описание: выдача информации о контрагенте

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	строка с идентификатором, по которому искать контрагента
TypeOfIdentification	Строка	нет	Входной	строка поиска (см. описание под таблицей) * 1
DateOfQuery	Дата	нет	Входной	Дата запроса
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	Контрагент	да	Выходной	См. описание типа контрагент
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

Значения параметра «TypeOfIdentification»

Значение	Описание
0	поиск по полю ClientID из справочника Контрагенты
1	поиск по ИНН/КПП. В ClientID ИНН и КПП разделяются "/". Если "/" не указан, то все содержимое ClientID воспринимается как ИНН. Например, "77461324561/774600101".
2	поиск по виды, серии и номеру документа, удостоверяющего личность. В ClientID компоненты задаются через "/". Например, "21/4692/789536". Если серии в реквизитах документе нет, то "/" все равно надо передавать.
3	поиск по полю СтрокаПоиска регистра документов. Строка поиска обычно представляет собойобъединенные серию и номер документа
4	поиск по номеру мобильного телефона

1.3. Метод «GetClientInfo2»

Описание: выдача информации о оформленном договоре и заявки контрагента

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	строка с идентификатором, по которому искать контрагента
TypeOfIdentification	Строка	нет	Входной	строка поиска (см. описание под таблицей) * 1
DateOfQuery	Дата	нет	Входной	Дата запроса
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetClientInfo2Result	да	Выходной	См. описание типа
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.4. Метод «GetClientInfo3»

Описание: выдача информации о заявки контрагента, а так же информация по просрочкам.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	строка с идентификатором, по которому искать контрагента
TypeOfIdentification	Строка	нет	Входной	строка поиска (см. описание под таблицей) * 1
DateOfQuery	Дата	нет	Входной	Дата запроса
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetClientInfo3Result	да	Выходной	См. описание типа
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.5. Метод «GetContractInfo1»

Описание: выдача информации по займу с графиком платежей.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
Contract	Строка	нет	Входной	строка с идентификатором, по которому искать договор
DateOfQuery	Дата	нет	Входной	Дата запроса
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetContractInfo1Result	да	Выходной	См. описание типа
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.6. Метод «GetCurrentDebtInfo»

Описание: выдача информации по текущей задолженности клиента.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	строка с идентификатором, по которому искать договор
DateOfQuery	Дата	нет	Входной	Дата запроса
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	РасчетыПоЗаймамОстатки	да	Выходной	См. описание типа
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.7. Метод «GetLists»

Описание: Выдача списков значений справочников/перечислений по имени.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
Lists	Массив	нет	Входной	строка с идентификатором, по которому искать договор
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	Массив	да	Выходной
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.8. Метод «GetOutdatedContracts»

Описание: .

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ContractIDs	Массив	нет	Входной	массив идентификаторов договоров
DateFrom	Дата	да	Выходной	Дата начала выборки
DateTo	Массив	да	Выходной	Дата конца выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetOutdatedContractsResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.9. Метод «GetRequestInfo»

Описание: Получения информации по заявки.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
RequestID	Строка	нет	Входной	Идентификатор заявки на займ
DateOfQuery	Дата	да	Выходной	Дата запроса
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestInfoResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.10. Метод «GetRequestsByState»

Описание: Возвращает заявки заданного статуса.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
StateID	Массив	нет	Входной	массив идентификаторов договоров
DateFrom	Дата	нет	Выходной	Дата начала выборки
DateTo	Массив	нет	Выходной	Дата конца выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestsByStateResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.11. Метод «GetRequestsByStateClient»

Описание: Возвращает заявки заданного статуса с отбором по клиенту.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	Идентификатор контрагента
TypeOfIdentification	Число	нет	Входной	Критерий поиска. Возможные значения см. ниже *
StateID	Строка	нет	Входной	Идентификатор статуса
DateFrom	Дата	да	Входной	Дата начала выборки
DateTo	Дата	да	Входной	Дата конца выборки
ResultMessage	Строка	да	Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestsByStateResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

* 0 - по ID, 1 - по ИНН/КПП, 2 - по документу (вид/серия/номер), 3 - по документу (вид/серияномер), 4 - по номеру мобильного телефона

1.12. Метод «GetRequestState»

Описание: Выдача информации о статусе заявки.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
RequestID	Строка	нет	Входной	массив идентификаторов договоров
DateOfQuery	Дата	нет	Выходной	Дата начала выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestStateResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.13. Метод «GetRequestState2»

Описание: Возвращает статус заявки из реквизита документа.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
RequestID	Строка	нет	Входной	массив идентификаторов договоров
DateOfQuery	Дата	нет	Выходной	Дата начала выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestStateResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.14. Метод «GetRequestStates»

Описание: Возвращает статусы заявок.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
RequestIDs	Массив	нет	Входной	Идентификаторы заявок на займ
DateOfQuery	Дата	нет	Выходной	Дата начала выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestStatesResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.15. Метод «GetRequestStates2»

Описание: Возвращает статусы заявок из реквизита документа.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
RequestIDs	Массив	нет	Входной	Идентификаторы заявок на займ
DateFrom	Дата	нет	Выходной	Дата начала выборки
DateTo	Дата	нет	Выходной	Дата конца выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	GetRequestStatesResult	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.16. Метод «GetTotalDebtInfo»

Описание: Выдача информации об общей задолженности по основному долгу.

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
ClientID	Строка	нет	Входной	Идентификатор контрагента
DateOfQuery	Дата	нет	Выходной	Дата начала выборки
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	ВыданныеЗаймыОстатки	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

1.17. Метод «LoadClients»

Описание: Выполняет загрузку клиентов в справочник "Контрагенты".

Параметры запроса:

Наименование	Тип	Пустое значение	Направление	Описание
ExchangeKey	Строка	нет	Входной	Ключ обмена с сайтом
Data	Clients	нет	Входной	См. описание типов
ResultMessage	Строка	да	Входной - Выходной	трехзначный код ответа на HTTP-запрос
ResultDetails	LoadClientsReply	да	Выходной	См. описание типов
idTransaction	Строка	да	Входной - Выходной	Номер транзакции

ТИП «Контрагент».

Описание: В системе МФС контрагент – это заёмщик.

Наименование	Тип	Описание
ID	Строка	Идентификатор обмена контрагента
НаименованиеПолное	Строка	Полное наименование контрагента
ЮрФизЛицо	ЮрФизицо	ЮрЛицо, ФизЛицо
ИНН	Строка	ИНН контрагента
КПП	строка	КПП контрагента
КодПоОКПО	Строка	Код по ОКПО
Связи контрагента	Связи контрагента	См. описание типа
Пол	Атрибут	Мужской, Женский
МестоРождения	Строка	Место рождения
ДатаРождения	Дата	Дата рождения контрагента
БанковскиеСчета	БанковскиеСчета	см. описание типа
ОГРН	Строка	ОГРН контрагента
СвидетельствоОГосРегистрации	Строка	Свидетельство о гос регистрации
ДатаРегистрации	Дата	Дата гос регистрации
ИндивидуальныйПредприниматель	Булево	Признак ИП
Гражданство	Страна	Цифровой код страны
НаименованиеСтраныГражданства	Строка	название страны
ДатаСозданияКомпании	Дата
ОКВЭД	Строка	ОКВЭД
Фамилия	Строка	Фамилия контрагента
Имя	Строка	Имя контрагента
Отчество	Строка	Отчество контрагента
КонтактнаяИнформация	КонтактнаяИнформация	см. описание типа
Документы	Документы	См. описание типа
IDЭлекснет	Строка	Идентификатор используемый для обмена с различными платежными системами.
IDЛидер
IDЗолотаяКорона

ТИП «БанковскиеСчета».

Описание: Банковские счета контрагента.

Наименование	Тип	Описание
НомерСчета	Строка	20 цифр номера счета
Банк	BankId	9 цифр банковский идентификатор

ТИП «Связи контрагента».

Описание: Лица связанные с заемщиком.

Наименование	Тип	Описание
Фамилия	Строка	Фамилия
Имя	Строка	Имя
Отчество	Строка	Отчество
ДатаРождения	Дата	Дата рождения
Должность	Строка	Должность
Описание	Строка	Дополнительное описание
ConnectionType	Строка	Тип взаимосвязи
ConnectionTypeName	Строка	Наименование типа взаимосвязи

ТИП «КонтактнаяИнформация».

Описание: Контактная информация контрагента.

Наименование	Тип	Описание
Адрес	Адрес
Телефон	Телефон
ПрочаяКонтактнаяИнформация	Произвольная Контактная Информация

ТИП «Адрес».

Описание: Адрес контрагента.

Наименование	Тип	Описание
Вид	Строка	Возможные значения: ЮрАдрес ФактАдрес ВременнаяРегистрация РабАдрес СвЛ_ЮрАдрес СвЛ_ФактАдрес
Presentation	Строка	Представление
Страна	Строка	Числовой код страны
Индекс	Строка
Регион	Строка
Район	Строка
Город	Строка
НаселенныйПункт	Строка
Улица	Строка
Дом	Строка
Корпус	Строка
Строение	Строка
Квартира	Строка
Comment	Строка

ТИП «Телефон».

Описание: Телефоны контрагента.

Наименование	Тип	Описание
Вид	Строка	Возможные значения: Мобильный Рабочий Домашний СвЛ_Мобильный СвЛ_Рабочий СвЛ_Домашний
Presentation	Строка
КодСтраны	Строка
КодГорода	Строка
Номер	Строка
Добавочный	Строка
Comment	Строка

ТИП «ПроизвольнаяКонтактнаяИнформация».

Описание: Контактная информация в свободном виде.

Наименование	Тип	Описание
Тип	Тип контактной информации	Возможные значения: Адрес Телефон АдресЭлектроннойПочты ВебСтраница Факс Другое
Вид	Строка
Presentation	Строка	Представление

ТИП «Идентификатор Платежной Системы».

Описание: Идентификатор используемый для обмена с различными платежными системами.

Наименование

Тип

Описание

Тип

Тип контактной информации

Возможные значения:

Адрес

Телефон

АдресЭлектроннойПочты ВебСтраница

Факс

Другое

ТИП «GetClientInfo2Result».

Описание: Информации о заявке и договоре контрагента.

Наименование	Тип	Описание
RequestID	Строка	Идентификатор обмена заявки
RequestDate	Дата	Дата заявки
ContractID	Строка	Идентификатор обмена договора
ContractNumber	Строка	Номер договора
ContractDateOfSigning	Дата	Дата подписания договора
ContractDateOfClosing	Дата	Дата закрытия договора
ProductName	Строка	Наименование кредитного продукта
Sum	Число	Сумма займа
Paid	Число	Сумма платежей
ContractState	Строка	Статус договора
RequestSum	Число	Сумма заявленная в заявке
RequestPeriod	Число	Срок заявленный в заявке

ТИП «GetClientInfo3Result».

Описание: Информации о заявке и договоре контрагента.

Наименование	Тип	Описание
RequestID	Строка	Идентификатор обмена заявки
RequestDate	Дата	Дата заявки
ContractID	Строка	Идентификатор обмена договора
ContractNumber	Строка	Номер договора
ContractDateOfSigning	Дата	Дата подписания договора
ContractDateOfClosing	Дата	Дата закрытия договора
ProductName	Строка	Наименование кредитного продукта
Sum	Число	Сумма займа
Paid	Число	Сумма платежей
LastPaymentDate	Дата	Дата окончания займа
SumToPay	Число	Сумма займа
RequestDecisionDate	Дата	Дата принятия решение по заявке
LoanDate	Дата	Дата выдачи займа
ContractState	Строка	Статус займа
RequestPeriod	Число	Срок займа

ТИП «GetContractInfo1Result».

Описание: Информации о займе.

Наименование	Тип	Описание
RequestDate	Дата	Дата заявки
LoanDate	Дата	Дата выдачи
Sum	Число	Сумма кредита
SumToPay	Число	Текущая задолженность
NextPaymentDate	Дата	Дата платежа
Paid	Число	Оплачено
Repaid	Число	Распределено
DateClosed	Дата	Дата закрытия кредита

ТИП «РасчетыПоЗаймамОстатки».

Описание: Информации о займе.

Наименование	Тип	Описание
ИдентификаторОрганизации	Строка	Идентификатор организации
НаименованиеОрганизации	Строка	Наименование организации
ИдентификаторПодразделения	Строка	Идентификатор подразделения
НаименованиеПодразделения	Строка	Наименование подразделения
Договор	Договор	См. описание типа
ДатаПлатежа	Дата	Дата платежа
СуммаОсновногоДолга	Число	Сумма основного долга
СуммаПроцентов	Число	Сумма процентов
СуммаКомиссии	Число	Сумма комиссии
СуммаПени	Число	Сумма пени
СуммаШтрафа	Число	Сумма штрафа

ТИП «Договор».

Описание: Информации о договоре.

Наименование	Тип	Описание
ИдентификаторОрганизации	Строка	Идентификатор организации
НаименованиеОрганизации	Строка	Наименование организации
ИдентификаторПодразделения	Строка	Идентификатор подразделения
НаименованиеПодразделения	Договор	Наименование подразделения
НомерДоговора	Строка	Номер договора
ДатаДоговора	Дата	Дата договора
ИдентификаторЗаявкиНаЗайм	Строка	Идентификатор обмена заявки на займ
НаименованиеКредитногоПродукта	Строка	Наименование кредитного продукта
ИдентификаторКредитногоПродукта	Строка	Идентификатор обмена кредитного продукта
ДатаВыдачи	Дата	Дата выдачи займа
ДатаВозврата	Дата	Дата возврата займа
СуммаЗайма	Число	Сумма займа
IDЭлекснет	Строка	Идентификатор обмена с платежной системой
IDЛидер	Строка	Идентификатор обмена с платежной системой

ТИП «GetOutdatedContractsResultItem».

Описание:

Наименование	Тип	Описание
ContractID	Строка	Идентификатор обмена договора
Date	Дата	Дата договора
Number	Строка	Номер договора
FIO	Строка	ФИО контрагента
Employer	Строка	Место работы
Position	Строка	Должность
DaysOutdated	Число	Дней просрочки
DaysOutdatedTotal	Число	Всего дней просрочки
OutdatedFrom	Дата	Дата начала просрочки
OutdatedFromTotal	Дата	Дата первой просрочки
SumMain	Число	Сумма остатка основного долга
SumInterest	Число	Сумма остатка процентов
SumCommission	Число	Сумма остатка комиссии
SumPenalty	Число	Сумма остатка пени
SumFine	Число	Сумма остатка штрафа
SumTotal	Число	Сумма остатка всего
ContactInfo	ContactInfo	См. описание типов
RelatedPerson	RelatedPerson	См. описание типов
Payment	PaymentInfo	См. описание типов

ТИП «ContactInfo».

Описание: Контрактная информация

Наименование	Тип	Описание
Type	Строка	Представление вида контактной информации
TypeID	Строка	Вид контактной информации
Presentation	Строка	Представление контактной информации
Data	Строка	Значения полей контактной информации

ТИП «RelatedPerson».

Описание: Связанные лица

Наименование	Тип	Описание
Type	Строка	Представление вида связанного лица
FIO	Строка	Представление связанного лица
ContactInfo	Строка	См. описание типов

ТИП «PaymentInfo».

Описание: Оплаты

Наименование	Тип	Описание
Date	Дата	Дата платежа
PaymentMethod	Строка	Способ платежа
Sum	Число	Сумма платежа

ТИП «GetRequestInfoResult».

Описание: Данные утверждённой заявки

Наименование	Тип	Описание
Number	Строка	Номер заявки
Date	Дата	Дата заявки
Posted	Булево	Проведен в системе
State	Строка	Код статуса для обмена с сайтом
Product	Строка	Идентификатор обмена кредитного продукта
PaymentMethod	Строка	Идентификатор обмена способа выдачи
Sum	Число	Сумма заявки
LoanPeriod	Число	Срок в заявке
Rate	Число	Процентная ставка
Commission	Число	Комиссия

ТИП «GetRequestsByStateResult».

Описание:

Наименование	Тип	Описание
RequestID	Строка	Идентификатор обмена заявки
Date	Дата	Дата заявки
FIO	Строка	ФИО контрагента
ContactInfo	ContactInfo	См. описание типа
Sum	Число	Утвержденная сумма
LoanPeriod	Число	Утвержденный срок
PeriodType	PeriodType	Расчетный период
Description	Строка	Комментарий

ТИП «GetRequestStateResult».

Описание:

Наименование	Тип	Описание
Code	Строка	Код статуса для обмена с сайтом
Name	Строка	Наименование статуса
Description	Строка	Причина отказа

ТИП «GetRequestStatesResult».

Описание:

Наименование	Тип	Описание
ID	Строка	Идентификатор обмена заявки
Date	Дата	Период статуса заявки
Code	Строка	Код статуса для обмена с сайтом
Name	Строка	Наименование статуса заявки
Description	Строка	Причина отказа

ТИП «ВыданныеЗаймыОстатки».

Описание:

Наименование	Тип	Описание
ИдентификаторОрганизации	Строка	Идентификатор организации
НаименованиеОрганизации	Строка	Наименование организации
ИдентификаторПодразделения	Строка	Идентификатор подразделения
НаименованиеПодразделения	Строка	Наименование подразделения
Договор	Договор	См. описание типа
СуммаОсновногоДолга	Число	Сумма долга

ТИП «Clients».

Описание:

Наименование	Тип	Описание
Заявитель	Заявитель	См. описание типа
БанковскийСчет	БанковскийСчет	См. описание типа
BankCard	BankCard	См. описание типа
ДокументЗаявителя	ДокументЗаявителя	См. описание типа
Адрес	Адрес	См. описание типа
СрокДействияВременнойРегистрации	СрокДействия Временной Регистрации	См. описание типа
Телефон	Телефон	См. описание типа
ЭлектроннаяПочта	ЭлектроннаяПочта	См. описание типа
WebSite	WebSite	См. описание типа

Помогло? Да Нет 0% пользователей считают эту статью полезной.

Благодарим вас за отзыв.