• Описание изменений в версиях
• Описание формата json
  • Общее описание пакета сообщений
  • postMessage
    • getTaskStatus по заданию загрузки
  • Сообщения пакета
    • Залог Pawn -
    • Клиент Client -
    • КлиентСДокументами ClientWtIdDocs - Клиент ломбарда
    • КлиентСДокументом ClientWtIdDoc -
    • ОбъектЗалога PawnObject -
    • ОбъектЗалогаЮвелирноеИзделие JewelleryPawnObject -
    • Тариф FinancialProduct - Тариф
  • Методы
    • auth auth - Авторизоваться
    • doRemotePayment doRemotePayment - Отразить проведенные платёж
    • getClientDetails getClientDetails - Получить данные клиента
    • getClientID getClientID - Получить идентификатор клиента
    • getClientLoans getClientLoans - Перечень залогов клиентов
    • getClientPayments getClientPayments - Список операций по клиенту (залогу)
    • getClientsList getClientsList - Получить список клиентов
    • getCustomCallingList getCustomCallingList - Произвольный запрос на обзвон
    • getLoanDetails getLoanDetails - Получить информацию по займу
    • getLoanDocument getLoanDocument - Получить pdf залога
    • getLocationDetails getLocationDetails - Информация по отделениям
    • getOperationsList getOperationsList - Получить список операций
    • getPaymentSchedule getPaymentSchedule - Получить график платежей
    • getStuffList getStuffList - Перечень вещей
    • requestPayment requestPayment - Запрос оплаты через Мандарин
  • Типы с перечисляемыми значениями
    • getCustomCallingListRequestType
    • stuffType
    • НаправлениеОтсчета
    • ПериодыНачислений
    • ПолКлиента
    • РазмерностиЛьготногоПериода
    • ТипОбъектаЗалога

Описание изменений в версиях

1.70 от 31.03.2025 15:29:51

Сообщение обмена: getClientDetails (getClientDetails)

• Введено дополнительне поле ClientInternalCode
• Введено дополнительно поле Segments

Сообщение обмена: getClientsList (getClientsList)

• Введено дополнительне поле ClientInternalCode

1.69 от 25.03.2025 23:19:05

Сообщение обмена: getClientsList (getClientsList)

• Введены дополнительные поля AdditionalInformation и Segments

1.58 от 26.10.2024 21:28:45

Сообщение обмена: getClientDetails (getClientDetails)

Добавлено поле AdditionalInformation для вывода дополнительных данных клиента, не относящихся к предопределённой контактной инофрмации, например, статус программы лояльности, если она заведена через КИ.

Сообщение обмена: getPaymentSchedule (getPaymentSchedule)

Новый метод для графика платежей по залогу

Сообщение обмена: getStuffList (getStuffList)

Расширен перечень описаний объекта залога Предоставлена информация о вставках. Вставки выводятся одной строкой и разделены точкой с запятой

1.20 от 02.05.2023 14:12:37

Сообщение обмена: getClientDetails (getClientDetails)

Добавлен новый метод

Сообщение обмена: getClientLoans (getClientLoans)

Добавлено поле sellingDate

Сообщение обмена: getClientPayments (getClientPayments)

Добавлен новый метод. Получает историю погашений по клиенту

Сообщение обмена: getLoanDetails (getLoanDetails)

Добавлены поля tariffID, tariffDescription

Сообщение обмена: getLoanDetails (getLoanDetails)

Добавлено новое поле DetailedInfo

Сообщение обмена: getLocationDetails (getLocationDetails)

Добавлено новый метод

Сообщение обмена: getStuffList (getStuffList)

Добавлено поле BillNumber

Сообщение обмена: getStuffList (getStuffList)

Предоставлены ссылки на загруженные фотографии и их миниатюры в SuffList

Описание формата json

Общее описание пакета сообщений

Сообщение всегда передается в составе пакета, т.е. библиотека интеграции на стороне потребителя данных всегда ожидает массив сообщений. В частном случае в массиве может быть одно сообщение. Для каждого сообщения должны быть объявлены поля:

• MsgType - Строка - имя типа сообщения;
• MsgID - Число - уникальный номер;
• MsgData - вложенный json - содержание сообщения, формат определяется типом, который задан в MsgType;

[
	{
		"MsgType": "Loan", // имя типа
		"MsgID": 1, // уникальный номер в пакете
		"MsgData":
		{
			// содержание сообщения, формат определяется типом сообщения
		}
	},
	{
		"MsgType": "Client", // имя типа
		"MsgID": 2, // уникальный номер в пакете
		"MsgData":
		{
			// содержание сообщения, формат определяется типом сообщения
		}
	}
]

postMessage

Пакет сообщений передается в теле запроса POST “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/postMessage”. Где “[ИмяБазы]” это наименование информационной базы, указанное при ее публикации. А “[ИдентификаторПоставщика]” это идентификатор поставщика, указанный в поле “Идентификатор” в соответствующем элементе справочника Поставщики данных, по настройкам которого будет загружаться пакет сообщений. Пример ответа от сервера:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор запущенного задания загрузки переданных данных
	"taskStarted", "true" // Признак, что задание успешно запущено
	"declineReason", "" // Представление ошибки, в случае если задание не запущено
}

getTaskStatus по заданию загрузки

Получить результат загрузки пакета сообщений можно через запрос GET “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/getTaskStatus?taskID=[ИдентификаторЗаданияПотребителя]” Где “[ИмяБазы]” это наименование информационной базы, указанное при ее публикации. А “[ИдентификаторПоставщика]” это идентификатор поставщика, использованный ранее при выгрузке данных. И “[ИдентификаторЗаданияПотребителя]” это идентификатор, полученный с ответом сервера при выполнении postMessage.

Пример ответа от сервера:

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 150000, // Общее количество сообщений в задании
	"dataProcessed": 150000, // Количество обработанных на момент запроса сообщений
	"dataDeclined": 2, // Количество сообщений с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания загрузки данных
	"msgIDs": // Массив сообщений, которые не были загружены или были загружены с ошибками
	[
		{
			"msgID": "34" // Идентификатор сообщения с ошибкой
		},
		{
			"msgID": "54792" // Идентификатор сообщения с ошибкой
		}
	]
}

Сообщения пакета

Залог Pawn -

Наименование этого сообщения в журнале регистрации: “Залог”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. Num (Номер) - Строка - ;

3. Date (Дата) - Дата - ;

4. AgreementDate (ДатаСоглашения) - Дата - ;

5. RegDate (ДатаРегистрации) - Дата - ;

6. Dept (Подразделение) - Строка - ;

7. Client (Клиент) - Строка - ;

8. Store (МестоХранения) - Строка - ;

9. FinancialProduct (Тариф) - Строка - ;

10. MainPeriodEndDate (ОкончаниеОП) - Дата - ;

11. GracePeriodEndDate (ОкончаниеЛП) - Дата - ;

12. TrueInterestCost (ПСК) - Число - ;

    Необязательный параметр.

13. LoanAmount (СуммаЗайма) - Число - ;

14. LoanTerm (СрокЗайма) - Число - ;

    Необязательный параметр.

15. PrincipalDebtBalance (ОстатокОсновногоДолга) - Число - ;

    Необязательный параметр.

16. InterestDebtBalance (ОстатокПроцентов) - Число - ;

    Необязательный параметр.

17. InterestLimitBalance (ОстатокЛимитаНачислений) - Число - ;

    Необязательный параметр.

18. PawnObjects (ОбъектыЗалога) - Массив -

    1. ID (Идентификатор) - Строка -
    2. PawnValue (ЗалоговаяСтоимость) - Число -
    3. LoanAmount (СуммаЗайма) - Число -

19. Comment (Комментарий) - Строка - ;

    Необязательный параметр.

20. InterestPlan (ПланНачислений) - Массив -

    1. Begin (Начало) - Дата -

    2. End (Окончание) - Дата -

    3. Accrual (ВидНачисления) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

    4. InterestRate (ПроцентнаяСтавка) - Число -

    5. RegInterestRate (ПроцентнаяСтавкаРегл) - Число -

       Необязательный параметр. Значение по умолчанию: 0;

    6. DifCloseDate (ДатаЗакрытияРазницы) - Дата -

       Необязательный параметр. Значение по умолчанию: 01.01.0001 0:00:00;

21. FixedInterestPlan (ПланФиксированныхНачислений) - Массив -

    1. Begin (Начало) - Дата -

    2. End (Окончание) - Дата -

    3. Accrual (ВидНачисления) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

    4. Amount (Сумма) - Число -

    5. RegAmount (СуммаРегл) - Число -

       Необязательный параметр. Значение по умолчанию: 0;

    6. DifCloseDate (ДатаЗакрытияРазницы) - Дата -

       Необязательный параметр. Значение по умолчанию: 01.01.0001 0:00:00;

Пример пакета с сообщением Pawn

[
	{
		"MsgType": "Pawn",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"Num": ,
			"Date": ,
			"AgreementDate": ,
			"RegDate": ,
			"Dept": ,
			"Client": ,
			"Store": ,
			"FinancialProduct": ,
			"MainPeriodEndDate": ,
			"GracePeriodEndDate": ,
			"TrueInterestCost": ,
			"LoanAmount": ,
			"LoanTerm": ,
			"PrincipalDebtBalance": ,
			"InterestDebtBalance": ,
			"InterestLimitBalance": ,
			"PawnObjects":
			[
				{
					"ID": ,
					"PawnValue": ,
					"LoanAmount": 
				}
			],
			"Comment": ,
			"InterestPlan":
			[
				{
					"Begin": ,
					"End": ,
					"Accrual": ,
					"InterestRate": ,
					"RegInterestRate": ,
					"DifCloseDate": 
				}
			],
			"FixedInterestPlan":
			[
				{
					"Begin": ,
					"End": ,
					"Accrual": ,
					"Amount": ,
					"RegAmount": ,
					"DifCloseDate": 
				}
			]
		}
	}
]

Клиент Client -

Наименование этого сообщения в журнале регистрации: “Клиент”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. LastName (Фамилия) - Строка - ;

3. FirstName (Имя) - Строка - ;

4. Patronymic (Отчество) - Строка - ;

   Необязательный параметр.

5. Sex (Пол) - Строка - ;

   Необязательный параметр.

   Допустимые значения (см. описание типа с перечисляемыми значениями ПолКлиента):

   • “Female” (Женский);
   • “Male” (Мужской);

6. BirthDate (ДатаРождения) - Дата - ;

7. BirthPlace (МестоРождения) - Строка - ;

   Необязательный параметр.

8. CitizenCountryCode (Гражданство) - Строка - ;

   Необязательный параметр.

9. RussianTaxpayerID (ИНН) - Строка - ;

   Необязательный параметр.

10. RussianInsuranceID (СНИЛС) - Строка - ;

    Необязательный параметр.

11. TelephoneNumber (Телефон) - Строка - ;

    Необязательный параметр.

12. RegirstrationAddress (АдресПрописки) - Строка - ;

    Необязательный параметр.

13. ResidentialAddress (АдресПроживания) - Строка - ;

    Необязательный параметр.

Пример пакета с сообщением Client

[
	{
		"MsgType": "Client",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"LastName": ,
			"FirstName": ,
			"Patronymic": ,
			"Sex": ,
			"BirthDate": ,
			"BirthPlace": ,
			"CitizenCountryCode": ,
			"RussianTaxpayerID": ,
			"RussianInsuranceID": ,
			"TelephoneNumber": ,
			"RegirstrationAddress": ,
			"ResidentialAddress": 
		}
	}
]

КлиентСДокументами ClientWtIdDocs - Клиент ломбарда

Наименование этого сообщения в журнале регистрации: “КлиентСДокументами”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. LastName (Фамилия) - Строка - ;

3. FirstName (Имя) - Строка - ;

4. Patronymic (Отчество) - Строка - ;

   Необязательный параметр.

5. Sex (Пол) - Строка - ;

   Необязательный параметр.

   Допустимые значения (см. описание типа с перечисляемыми значениями ПолКлиента):

   • “Female” (Женский);
   • “Male” (Мужской);

6. BirthDate (ДатаРождения) - Дата - ;

7. BirthPlace (МестоРождения) - Строка - ;

   Необязательный параметр.

8. CitizenCountryCode (Гражданство) - Строка - ;

   Необязательный параметр.

9. RussianTaxpayerID (ИНН) - Строка - ;

   Необязательный параметр.

10. RussianInsuranceID (СНИЛС) - Строка - ;

    Необязательный параметр.

11. TelephoneNumber (Телефон) - Строка - ;

    Необязательный параметр.

12. RegirstrationAddress (АдресПрописки) - Строка - ;

    Необязательный параметр.

13. ResidentialAddress (АдресПроживания) - Строка - ;

    Необязательный параметр.

14. IdDocs (ДокументыУдостоверяющиеЛичность) - Массив -

    1. DocType (ВидДокумента) - Строка -

    2. DocSeries (СерияДокумента) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

    3. DocNumber (НомерДокумента) - Строка -

    4. DocIssueDate (ДатаВыдачиДокумента) - Дата -

    5. DocIssueDepartment (КемВыданДокумент) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

    6. DocIssueDepartmentCode (КодПодразделенияДокумента) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

Пример пакета с сообщением ClientWtIdDocs

[
	{
		"MsgType": "ClientWtIdDocs",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"LastName": ,
			"FirstName": ,
			"Patronymic": ,
			"Sex": ,
			"BirthDate": ,
			"BirthPlace": ,
			"CitizenCountryCode": ,
			"RussianTaxpayerID": ,
			"RussianInsuranceID": ,
			"TelephoneNumber": ,
			"RegirstrationAddress": ,
			"ResidentialAddress": ,
			"IdDocs":
			[
				{
					"DocType": ,
					"DocSeries": ,
					"DocNumber": ,
					"DocIssueDate": ,
					"DocIssueDepartment": ,
					"DocIssueDepartmentCode": 
				}
			]
		}
	}
]

КлиентСДокументом ClientWtIdDoc -

Наименование этого сообщения в журнале регистрации: “КлиентСДокументом”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. LastName (Фамилия) - Строка - ;

3. FirstName (Имя) - Строка - ;

4. Patronymic (Отчество) - Строка - ;

   Необязательный параметр.

5. Sex (Пол) - Строка - ;

   Необязательный параметр.

   Допустимые значения (см. описание типа с перечисляемыми значениями ПолКлиента):

   • “Female” (Женский);
   • “Male” (Мужской);

6. BirthDate (ДатаРождения) - Дата - ;

7. BirthPlace (МестоРождения) - Строка - ;

   Необязательный параметр.

8. CitizenCountryCode (Гражданство) - Строка - ;

   Необязательный параметр.

9. RussianTaxpayerID (ИНН) - Строка - ;

   Необязательный параметр.

10. RussianInsuranceID (СНИЛС) - Строка - ;

    Необязательный параметр.

11. TelephoneNumber (Телефон) - Строка - ;

    Необязательный параметр.

12. RegirstrationAddress (АдресПрописки) - Строка - ;

    Необязательный параметр.

13. ResidentialAddress (АдресПроживания) - Строка - ;

    Необязательный параметр.

14. IdDocType (ВидДокумента) - Строка - ;

15. IdDocSeries (СерияДокумента) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

16. IdDocNumber (НомерДокумента) - Строка - ;

17. IdDocIssueDate (ДатаВыдачиДокумента) - Дата - ;

    Необязательный параметр. Значение по умолчанию: Дата(“00010101000000”)

18. IdDocIssueDepartment (КемВыданДокумент) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

19. IdDocIssueDepartmentCode (КодПодразделенияДокумента) - Строка - ;

    Необязательный параметр. Значение по умолчанию: ""

Пример пакета с сообщением ClientWtIdDoc

[
	{
		"MsgType": "ClientWtIdDoc",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"LastName": ,
			"FirstName": ,
			"Patronymic": ,
			"Sex": ,
			"BirthDate": ,
			"BirthPlace": ,
			"CitizenCountryCode": ,
			"RussianTaxpayerID": ,
			"RussianInsuranceID": ,
			"TelephoneNumber": ,
			"RegirstrationAddress": ,
			"ResidentialAddress": ,
			"IdDocType": ,
			"IdDocNumber": 
		}
	}
]

ОбъектЗалога PawnObject -

Наименование этого сообщения в журнале регистрации: “ОбъектЗалога”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. Name (Наименование) - Строка - ;

3. Type (Тип) - Строка - ;

   Допустимые значения (см. описание типа с перечисляемыми значениями ТипОбъектаЗалога):

   • “OtherPawnObject” (Прочее);
   • “TransportFacilityPawnObject” (ТранспортныеСредства);
   • “JewelleryPawnObject” (ЮвелирныеИзделия);

4. Category (Категория) - Строка - ;

5. Pawn (Залог) - Строка - ;

6. Description (Описание) - Строка - ;

   Необязательный параметр.

Пример пакета с сообщением PawnObject

[
	{
		"MsgType": "PawnObject",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"Name": ,
			"Type": ,
			"Category": ,
			"Pawn": ,
			"Description": 
		}
	}
]

ОбъектЗалогаЮвелирноеИзделие JewelleryPawnObject -

Наименование этого сообщения в журнале регистрации: “ОбъектЗалогаЮвелирноеИзделие”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - ;

2. Name (Наименование) - Строка - ;

3. Type (Тип) - Строка - ;

   Допустимые значения (см. описание типа с перечисляемыми значениями ТипОбъектаЗалога):

   • “OtherPawnObject” (Прочее);
   • “TransportFacilityPawnObject” (ТранспортныеСредства);
   • “JewelleryPawnObject” (ЮвелирныеИзделия);

4. Category (Категория) - Строка - ;

5. Pawn (Залог) - Строка - ;

6. Description (Описание) - Строка - ;

   Необязательный параметр.

7. Metall (Металл) - Строка - ;

8. Hallmark (Проба) - Строка - ;

9. FullWeight (Вес) - Число - ;

10. MetallWeight (ВесМеталла) - Число - ;

11. Size (Размер) - Число - ;

    Необязательный параметр.

Пример пакета с сообщением JewelleryPawnObject

[
	{
		"MsgType": "JewelleryPawnObject",
		"MsgID": 1,
		"MsgData":
		{
			"ID": ,
			"Name": ,
			"Type": ,
			"Category": ,
			"Pawn": ,
			"Description": ,
			"Metall": ,
			"Hallmark": ,
			"FullWeight": ,
			"MetallWeight": ,
			"Size": 
		}
	}
]

Тариф FinancialProduct - Тариф

Сообщение предназначается для передачи информации о тарифе

Наименование этого сообщения в журнале регистрации: “Тариф”.

Для сообщения определены следующие поля (в скобках представление для журнала регистрации):

1. ID (Идентификатор) - Строка - Уникальный идентификтор тарифа;

2. Name (Наименование) - Строка - Наименование тарифа;

3. Enable (Действует) - Булево - Признак доступности тарифа для новых выдач. Истина – если тариф должен быть доступен для новых договоров, Ложь – если тариф не должен быть скрыт при выдаче.;

4. Priority (Приоритет) - Число - Приоритет выбора тарифа при выдаче. Чем больше, тем выше в списке выбора будет отображаться тариф для нового договора. Тариф с максимальным значением будет выбран как значение по умолчанию.;

   Необязательный параметр. Значение по умолчанию: 0

5. LoanTerm (СрокЗайма) - Число - Количество дней основного периода займа, для которого может применятся этот тариф.;

6. IncludeIssueDay (СрокЗаймаВключаетДеньВыдачи) - Булево - Признак, что срок займа включает или исключает день выдачи. Истина – значит включается день выдачи, при сроке займа 2 дня, плановая дата выкупа будет на следующий день после выдачи. Ложь – значит день выдачи исключен из срока, если займ выдается на 2 дня, плановая дата выкупа будет после завтра от дня выдачи.;

7. ProlongationEnable (ДоступноПродление) - Булево - Признак, что договоры, выданные по данному тарифу, можно продлять.;

8. DistantProlongationEnable (ДоступноДистанционноеПогашение) - Булево - Признак, что договоры, выданные по данному тарифу, можно дистанционно погашать.;

9. ProlongationAfterPartialRdmp (ПродлениеПриЧастичномВыкупе) - Булево - Признак, что договоры с более чем одним объектом залога, выданные по данному тарифу, при выкупе части заложенного имущества будут автоматически продлеваться согласно правилам продления.;

10. ProlongationTerm (СрокПродления) - Число - Количество дней основного периода, на которые продлевается договор при продлении.;

11. GracePeriodUnit (РазмерностьЛьготногоПериода) - Строка - Размерность периода заданного числом в GracePeriod (ЛьготныйПериод);

    Допустимые значения (см. описание типа с перечисляемыми значениями РазмерностиЛьготногоПериода):

    • “Day” (День);
    • “Month” (Месяц);

12. GracePeriod (ЛьготныйПериод) - Число - Количество дней льготного периода;

13. UseFixedTrueInterestCost (ИспользоватьФиксированнуюПСК) - Булево - Признак, что по новым договорам, выданным по данному тарифу, не будет рассчитываться ПСК. Если признак установлен, в поле FixedTrueInterestCost (ФиксированнаяПСК) должно быть указано значение, которое будет копироваться в новый договор.;

    Необязательный параметр. Значение по умолчанию: Ложь

14. FixedTrueInterestCost (ФиксированнаяПСК) - Число - Значение фиксированной ПСК, если по новым договорам, выданным по данному тарифу, не будет рассчитываться ПСК.;

    Необязательный параметр.

15. PR (ПериодическиеНачисления) - Массив - Перечень правил начисления процентов по данному тарифу

    1. Concept (Представление) - Строка - Произвольное описание правила начисления процентов

       Необязательный параметр. Значение по умолчанию: ;

    2. ForPawn (ДляЗалога) - Булево - Правило применяется для операции первичной выдачи

    3. ForProlongation (ДляПродления) - Булево - Правило применяется для операций обычного продления и продления при частичном выкупе части имущества из договора залога

    4. Period (Период) - Строка - Идентификатор варианта периода жизненного цикла договора займа

    5. Direction (Направление) - Строка -

    6. Begin (Начало) - Число -

    7. HasEnd (ЕстьОкончание) - Булево -

    8. End (Окончание) - Число -

       Необязательный параметр. Значение по умолчанию: 0;

    9. Accrual (ВидНачисления) - Строка -

       Необязательный параметр. Значение по умолчанию: ;

    10. InterestRate (Ставка) - Число -

        Необязательный параметр. Значение по умолчанию: 0;

    11. RegInterestRate (СтавкаРегл) - Число -

        Необязательный параметр. Значение по умолчанию: 0;

    12. DifClosePeriod (ПериодЗакрытияРазницы) - Строка -

        Необязательный параметр. Значение по умолчанию: ;

    13. DifCloseDirection (НаправлениеЗакрытияРазницы) - Строка -

        Необязательный параметр. Значение по умолчанию: ;

    14. DifCloseDay (ДеньЗакрытияРазницы) - Число -

        Необязательный параметр. Значение по умолчанию: 0;

Пример пакета с сообщением FinancialProduct

[
	{
		"MsgType": "FinancialProduct",
		"MsgID": 1,
		"MsgData":
		{
			"ID": "f23fd3bd-3bc0-4f85-8ef4-69ced6779ff4",
			"Name": "Основой тариф ломбарда",
			"Enable": true,
			"LoanTerm": 30,
			"IncludeIssueDay": false,
			"ProlongationEnable": true,
			"DistantProlongationEnable": true,
			"ProlongationAfterPartialRdmp": true,
			"ProlongationTerm": 30,
			"GracePeriodUnit": "Day",
			"GracePeriod": 30,
			"FixedTrueInterestCost": 0.0,
			"PR":
			[
				{
					"Concept": "Проценты на весь основной период займа",
					"ForPawn": true,
					"ForProlongation": true,
					"Period": "MainPeriod",
					"Direction": ,
					"Begin": ,
					"HasEnd": ,
					"End": ,
					"Accrual": ,
					"InterestRate": ,
					"RegInterestRate": ,
					"DifClosePeriod": ,
					"DifCloseDirection": ,
					"DifCloseDay": 
				}
			]
		}
	}
]

Методы

Метод может быть вызван синхронно и асинхронно: соответственно через PUT методы syncCall и asyncCall. В случае асинхронного вызова результат выполнения метода может быть получен через GET метод getTaskStatus

auth auth - Авторизоваться

Запрос авторизации пользователя по СМС

В журнале регистрации метод имеет наименование: “auth”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/auth”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/auth”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. phoneNumber (phoneNumber) - Строка - Номер телефона для авторизации;

Пример параметров метода auth

{
	"phoneNumber": 
}

В случае вызова для асинхронного запуска asyncCall/auth возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/auth:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/auth возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. success (success) - Булево - Успешно или нет ;

    Необязательный параметр.

Пример результата метода auth

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"success": ,
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

doRemotePayment doRemotePayment - Отразить проведенные платёж

Запрос отражения удалённого платежа

В журнале регистрации метод имеет наименование: “doRemotePayment”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/doRemotePayment”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/doRemotePayment”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. LoanID (LoanID) - Строка - Идентификатор залога;
2. PaymentSum (PaymentSum) - Число - Сумма погашения;

Пример параметров метода doRemotePayment

{
	"LoanID": ""8d3efade-1dca-45e5-a060-3ceb7d66eaf4"",
	"PaymentSum": 222.32
}

В случае вызова для асинхронного запуска asyncCall/doRemotePayment возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/doRemotePayment:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/doRemotePayment возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. Result (Result) - Булево - Результат выполнения запроса;

    Необязательный параметр.

Пример результата метода doRemotePayment

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"Result": ,
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getClientDetails getClientDetails - Получить данные клиента

Информация по клиенту из базы

В журнале регистрации метод имеет наименование: “getClientDetails”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getClientDetails”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getClientDetails”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. clientID (clientID) - Строка - Идентификатор клиента;

Пример параметров метода getClientDetails

{
	"clientID": "8d3efade-1dca-45e5-a060-3ceb7d66eaf4"
}

В случае вызова для асинхронного запуска asyncCall/getClientDetails возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getClientDetails:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getClientDetails возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. clientInternalCode (КодКлиента) - Строка - Код клиента в Ломбардис;

    Необязательный параметр.

13. surname (Фамилия) - Строка - Последний вариант фамилии;

    Необязательный параметр.

14. name (Имя) - Строка - Последний вариант имени;

    Необязательный параметр.

15. patronymic (Отчество) - Строка - Последний вариант отчества;

    Необязательный параметр.

16. email (email) - Строка - Формат почты не гарантирован;

    Необязательный параметр.

17. phone (Телефон) - Строка - Формат телефона не гарантирован;

    Необязательный параметр.

18. taxNumber (ИНН) - Строка - Формат ИНН не гарантирован;

    Необязательный параметр.

19. additionalInformation (ДополнительнаяИнформация) - Массив -

    1. Field (Свойство) - Строка -
    2. Value (Значение) - Строка -

20. segments (Сегменты) - Массив -

    1. SegmentID (SegmentID) - Строка - Код сегмента
    2. SegmentDescription (SegmentDescription) - Строка - Представление сегмента

Пример результата метода getClientDetails

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"clientInternalCode": "001230122",,
	"surname": "Иванов",,
	"name": "Алекснадр",,
	"patronymic": "Владимирович",,
	"email": "a@wow1c.com",,
	"phone": "+79112223344",,
	"taxNumber": "344346577788",,
	"additionalInformation":
	[
		{
			"Field": ,
			"Value": 
		}
	],
	"segments":
	[
		{
			"SegmentID": "ПЛ_Золото",
			"SegmentDescription": "Клиенты уровня Золото"
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getClientID getClientID - Получить идентификатор клиента

В журнале регистрации метод имеет наименование: “getClientID”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getClientID”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getClientID”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. queryString (queryString) - Строка - Строка запрос: “Номер залога + дата рождения” , “Номер паспорта + дата рождения”;

Пример параметров метода getClientID

{
	"queryString": "АБ332211 20220101"
}

В случае вызова для асинхронного запуска asyncCall/getClientID возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getClientID:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getClientID возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. ClientID (ClientID) - Строка - Идентфикатор клиента;

    Необязательный параметр.

Пример результата метода getClientID

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"ClientID": "8d3efade-1dca-45e5-a060-3ceb7d66eaf4",
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getClientLoans getClientLoans - Перечень залогов клиентов

В журнале регистрации метод имеет наименование: “getClientLoans”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getClientLoans”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getClientLoans”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. ClientID (clientID) - Строка - Идентификатор клиента;

2. closed (closed) - Булево - Возвращать ли закрытые займы;

   Необязательный параметр. Значение по умолчанию: Ложь

Пример параметров метода getClientLoans

{
	"ClientID": "8d3efade-1dca-45e5-a060-3ceb7d66eaf4"
}

В случае вызова для асинхронного запуска asyncCall/getClientLoans возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getClientLoans:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getClientLoans возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. Loans (Loans) - Массив -
    1. LoanID (LoanID) - Строка - Идентификатор залога
    2. pawnBillNumber (pawnBillNumber) - Строка - Номер залогового билета
    3. LoanDescription (LoanDescription) - Строка - Описание залога
    4. ShortLoanDescription (ShortLoanDescription) - Строка - Наименование категории
    5. LoanDate (LoanDate) - Дата - Дата залога
    6. PaymentDate (PaymentDate) - Дата - Дата платежа
    7. Closed (Closed) - Булево - Признак закрытости займа
    8. fullDebt (fullDebt) - Число - Полная задолженность
    9. prolongationSum (prolongationSum) - Число - Сумма для продления
    10. sellingDate (sellingDate) - Дата - Дата начала продажи
    11. PaymentAvailable (PaymentAvailable) - Булево - Доступно продление билета

Пример результата метода getClientLoans

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getClientPayments getClientPayments - Список операций по клиенту (залогу)

В журнале регистрации метод имеет наименование: “getClientPayments”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getClientPayments”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getClientPayments”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. ClientID (ClientID) - Строка - Идентификатор клиента;

2. lastDays (lastDays) - Число - За сколько последних дней необходимо найти платежи;

   Необязательный параметр. Значение по умолчанию: 90

Пример параметров метода getClientPayments

{
	"ClientID": "8d3efade-1dca-45e5-a060-3ceb7d66eaf4"
}

В случае вызова для асинхронного запуска asyncCall/getClientPayments возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getClientPayments:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getClientPayments возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. History (ИсторияОпераций) - Массив -
    1. LoanID (LoanID) - Строка - Идентификатор залога
    2. firstPawnBillNumber (firstPawnBillNumber) - Строка - Первичный номер залогового билета
    3. issuedPawnBillNumber (issuedPawnBillNumber) - Строка - Выданный номер билета
    4. Date (Date) - Дата - Дата и время проведённой операции в локали часового пояса базы
    5. Operation (Operation) - Строка - Продление, Выкуп, Частичный выкуп, Продажа с витрины (список расширяем)
    6. accrualType (accrualType) - Строка - Вид начисления, погашаемый платежом
    7. writingOffType (writingOffType) - Строка - Способ проведения погашения
    8. Amount (Amount) - Число - Сумма, погашаемая в рамках данного начисления

Пример результата метода getClientPayments

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"History":
	[
		{
			"LoanID": "adkfj12341234",
			"firstPawnBillNumber": "AB223311",
			"issuedPawnBillNumber": "AB261222",
			"Date": "2022-04-05T12:30:00",
			"Operation": "Продление",
			"accrualType": "Основной долг",
			"writingOffType": "Наличные ККТ",
			"Amount": 3300.00
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getClientsList getClientsList - Получить список клиентов

В журнале регистрации метод имеет наименование: “getClientsList”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getClientsList”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getClientsList”

Для метода не предусмотрены параметры.

В случае вызова для асинхронного запуска asyncCall/getClientsList возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getClientsList:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getClientsList возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. ClientsList (СписокКлиентов) - Массив -
    1. ClientID (ClientID) - Строка - Идентификартор клиента
    2. ClientInternalCode (ClientInternalCode) - Строка - Код клиента в Ломбардис
    3. PhoneNumber (PhoneNumber) - Строка - Номер телефона клиента
    4. FullDebt (FullDebt) - Число - Полная текущая задолженность по ОД и процентам
    5. FullInterestsDebt (FullInterestsDebt) - Число - Полная текущая задолженность по процентам
    6. OverdueDebt (OverdueDebt) - Число - Полная просроченная задолженность
    7. OverdueInterestsDebt (OverdueInterestsDebt) - Число - Просроченная задолженность по процентам
    8. NearestPaymentDate (NearestPaymentDate) - Дата - Ближайшая дата платежа
    9. AdditionalInformation (AdditionalInformation) - Строка - Дополнительная информация по клинту из не предопределённой контактной информации.
    10. Segments (Segments) - Строка - Сегменты клиента

Пример результата метода getClientsList

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"ClientsList":
	[
		{
			"ClientID": "3cf0f559-a752-4068-840f-15498209a5b3",
			"ClientInternalCode": "001271726",
			"PhoneNumber": "+79259084181",
			"FullDebt": 1000,
			"FullInterestsDebt": 100,
			"OverdueDebt": 1100,
			"OverdueInterestsDebt": 100,
			"NearestPaymentDate": "2024-04-16T00:00:00",
			"AdditionalInformation": [ {"Field": "КастомноеПоле1", "Value": "Значение поля 1"}, {"Field": "КастомноеПоле2", "Value": "Значение поля 2"}  ],
			"Segments": [ {"SegmentID": "Элита", "SegmentDescription": "Сегмент элиты"}, {"SegmentID": "СПатриарших", "SegmentDescription": "Патрики наше всё"} ]
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getCustomCallingList getCustomCallingList - Произвольный запрос на обзвон

В журнале регистрации метод имеет наименование: “getCustomCallingList”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getCustomCallingList”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getCustomCallingList”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. listType (ТипСписка) - Строка - Тип запрашивашемого списка;

   Допустимые значения (см. описание типа с перечисляемыми значениями getCustomCallingListRequestType):

   • “onGracePeriod” (onGracePeriod);
   • “onSell” (onSell);
   • “paymentDate” (paymentDate);
   • “sellingDate” (sellingDate);

2. date (Дата) - Дата - Дата, на которую предлагаемый список нужен. Может быть пустым и тогда запрос будет выполнен на сейчас;

   Необязательный параметр.

Пример параметров метода getCustomCallingList

{
	"listType": "onGracePeriod",
	"date": "20250102"
}

В случае вызова для асинхронного запуска asyncCall/getCustomCallingList возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getCustomCallingList:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getCustomCallingList возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. result (Результат) - Массив -
    1. clientID (ИдентификаторКлиента) - Строка - Идентификатор клиента
    2. loanID (ИдентификаторЗалога) - Строка - Идентификатор залога
    3. billNumber (НомерБилета) - Строка - Номер билета
    4. tarrifID (ИдентификаторТарифа) - Строка - Код тарифа ломбардиса
    5. paymentDate (ДатаПлатежа) - Дата - Плановая дата платежа
    6. sellingDate (ДатаНачалаРеализации) - Дата - Плановая дата начала реализации

Пример результата метода getCustomCallingList

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"result":
	[
		{
			"clientID": ,
			"loanID": ,
			"billNumber": ,
			"tarrifID": ,
			"paymentDate": ,
			"sellingDate": 
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getLoanDetails getLoanDetails - Получить информацию по займу

В журнале регистрации метод имеет наименование: “getLoanDetails”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getLoanDetails”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getLoanDetails”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. LoanID (LoanID) - Строка - Идентификатор займа;

Пример параметров метода getLoanDetails

{
	"LoanID": "8d3efade-1dca-45e5-a060-3ceb7d66eaf4"
}

В случае вызова для асинхронного запуска asyncCall/getLoanDetails возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getLoanDetails:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getLoanDetails возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. LoanNumber (НомерЗалога) - Строка - Идентификатор залога;

    Необязательный параметр.

13. LoanDate (ДатаЗалога) - Дата - Дата залога;

    Необязательный параметр.

14. PaymentDate (ДатаВозврата) - Дата - Дата планового платежа;

    Необязательный параметр.

15. SellingDate (ДатаРеализации) - Дата - Дата начала реализации;

    Необязательный параметр.

16. LoanSum (СуммаЗайма) - Число - Сумма займа;

    Необязательный параметр.

17. DebtSum (ВсегоНачислено) - Число - Всего начислено по займу;

    Необязательный параметр.

18. InterestsSum (СуммаПроцентов) - Число - Сумма процентов по займу;

    Необязательный параметр.

19. Stuff (Вещи) - Массив -

    1. Presentation (Presentation) - Строка - Представление, наименование вещи
    2. Description (Description) - Строка - Описание вещи
    3. FullDescription (FullDescription) - Строка - Полное описание
    4. Status (Status) - Строка - Текущий статус
    5. Location (Location) - Строка - Место положение вещи
    6. LocationID (LocationID) - Строка -
    7. StuffID (StuffID) - Строка - Идентификатор вещи
    8. Price (Price) - Число - Цена (залога, реализации, зависит от статуса)
    9. DetailedInfo (DetailedInfo) - Строка - Детальные данные по залоговой вещи. Возвращается только для метода “loan”. Для sales – пустое.
    10. BillNumber (BillNumber) - Строка -
    11. ThumbnailURLs (ThumbnailURLs) - Строка - Массив URL миниатюр , разделённых точкой с запятой
    12. ImageURLs (ImageURLs) - Строка - Массив URL фотографий , разделённых точкой с запятой
    13. StuffCode (StuffCode) - Строка -
    14. Gems (Gems) - Строка - Описание вставок, все перечислены через точку с запятой

20. tariffID (Тариф) - Строка - Код тарифа;

    Необязательный параметр.

21. tariffDescription (ТарифОписание) - Строка - Описание тарифа;

    Необязательный параметр.

22. paymentAvailable (ДоступнаОплата) - Булево - ;

    Необязательный параметр.

Пример результата метода getLoanDetails

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"LoanNumber": "asdf123312ladslqwe1234",,
	"LoanDate": "2022-04-05T00:00:00",,
	"PaymentDate": "2022-05-05T00:00:00",,
	"SellingDate": "2022-06-05T00:00:00",,
	"LoanSum": 3313,,
	"DebtSum": 4442,,
	"InterestsSum": 1022,,
	"Stuff":
	[
		{
			"Presentation": "кольцо",
			"Description": "кольцо из золота",
			"FullDescription": "очень красивое прекрасное произведение искусства",
			"Status": "",
			"Location": "отделение севере",
			"LocationID": "000003",
			"StuffID": "asiodjf123--3141234sdaf",
			"Price": 3446,
			"DetailedInfo": ,
			"BillNumber": ,
			"ThumbnailURLs": /1231233/333/1.jpg;/1231233/333/2.jpg;/1231233/333/3.jpg;,
			"ImageURLs": /1231233/333/1.jpg;/1231233/333/2.jpg;/1231233/333/3.jpg;,
			"StuffCode": ,
			"Gems": 33 Амазонит, Микроклин 3кар И-89 /; 1 Бриллиант 3кар И-89 6/3
		}
	],
	"tariffID": "00000004",,
	"tariffDescription": "5% на 30 дней",,
	"paymentAvailable": ,
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getLoanDocument getLoanDocument - Получить pdf залога

В журнале регистрации метод имеет наименование: “getLoanDocument”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getLoanDocument”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getLoanDocument”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. LoanID (LoanID) - Строка - Идентификатор залога;

Пример параметров метода getLoanDocument

{
	"LoanID": 
}

В случае вызова для асинхронного запуска asyncCall/getLoanDocument возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getLoanDocument:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getLoanDocument возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. result (result) - Строка - PDF в Base64;

    Необязательный параметр.

Пример результата метода getLoanDocument

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"result": ,
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getLocationDetails getLocationDetails - Информация по отделениям

В журнале регистрации метод имеет наименование: “getLocationDetails”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getLocationDetails”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getLocationDetails”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. locationCode (КодОтделения) - Строка - Код места хренения;

Пример параметров метода getLocationDetails

{
	"locationCode": "00000003"
}

В случае вызова для асинхронного запуска asyncCall/getLocationDetails возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getLocationDetails:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getLocationDetails возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. locationDescription (Описание) - Строка - Описание названия отделения;

    Необязательный параметр.

13. locationAddress (Адрес) - Строка - Адрес отделения;

    Необязательный параметр.

14. locationPhone (Телефон) - Строка - Телефон отделения;

    Необязательный параметр.

Пример результата метода getLocationDetails

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"locationDescription": "Отделение на парковой",,
	"locationAddress": "Москва, ул. Ленина д1",,
	"locationPhone": "+1233331222",
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getOperationsList getOperationsList - Получить список операций

В журнале регистрации метод имеет наименование: “getOperationsList”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getOperationsList”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getOperationsList”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. date (Дата) - Дата - ;

2. locationID (КодОтделения) - Строка - ;

   Необязательный параметр. Значение по умолчанию: """"

Пример параметров метода getOperationsList

{
	"date": 
}

В случае вызова для асинхронного запуска asyncCall/getOperationsList возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getOperationsList:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getOperationsList возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. operationsList (СписокОпераций) - Массив - Список операций
    1. date (ДатаОперации) - Дата - Дата и время операции
    2. clientID (ИдентификаторКлиента) - Строка - Идентификатор клиента
    3. loanID (ИдентификаторЗалога) - Строка - Идентификатор залога
    4. operation (Операция) - Строка - pawn - залог prolongation - продление partialBuyback - частичный выкуп buyback - выкуп
    5. locationID (КодОтделения) - Строка - Код отделения Ломбардис
    6. operatorID (Товаровед) - Строка - Имя товароведа
    7. remote (Удаленно) - Булево - Операция выполнена удалённо

Пример результата метода getOperationsList

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"operationsList":
	[
		{
			"date": ,
			"clientID": f76a9f4c-a079-4f98-9fc8-084ae7bd9f91,
			"loanID": 7f93c2cb-460a-40f1-bde9-01a570220815,
			"operation": "pawn",
			"locationID": "00000009",
			"operatorID": "Георгина Мазурова",
			"remote": false
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getPaymentSchedule getPaymentSchedule - Получить график платежей

В журнале регистрации метод имеет наименование: “getPaymentSchedule”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getPaymentSchedule”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getPaymentSchedule”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. LoanID (LoanID) - Строка - Идентификатор залога;

   Необязательный параметр.

Пример параметров метода getPaymentSchedule

{
	"LoanID": 
}

В случае вызова для асинхронного запуска asyncCall/getPaymentSchedule возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getPaymentSchedule:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getPaymentSchedule возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. paymentSchedule (ГрафикПлатежей) - Массив - Результат графика платежа

    1. typeOfAccrual (ВидНачисления) - Строка -
    2. amount (Сумма) - Число -
    3. date (Дата) - Дата -

13. scheduleEndDate (ГраницаГрафика) - Дата - Дата до которой рассчитан график;

    Необязательный параметр.

Пример результата метода getPaymentSchedule

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"paymentSchedule":
	[
		{
			"typeOfAccrual": ,
			"amount": ,
			"date": 
		}
	],
	"scheduleEndDate": ,
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

getStuffList getStuffList - Перечень вещей

В журнале регистрации метод имеет наименование: “getStuffList”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/getStuffList”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/getStuffList”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. stuffType (stuffType) - Строка - Тип запрашиваемых объетов;

   Допустимые значения (см. описание типа с перечисляемыми значениями stuffType):

   • “loan” (loan);
   • “pawner” (pawner);
   • “sales” (sales);

2. reqID (reqID) - Строка - Для pawner и loan - соответствующие идентификаторы;

   Необязательный параметр.

3. page (page) - Число - Номер страницы выборки данных, нумерация начинается с 1;

   Необязательный параметр.

4. pageSize (pageSize) - Число - Количество элементов на странице;

   Необязательный параметр.

Пример параметров метода getStuffList

{
	"stuffType": "sales",
	"reqID": ,
	"page": 1,
	"pageSize": 20
}

В случае вызова для асинхронного запуска asyncCall/getStuffList возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/getStuffList:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/getStuffList возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке
3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных
4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками
5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений
6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении
7. startTime (ВремяЗапуска) - Дата - Начало выполнения
8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения
9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении
10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных
11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания
12. SuffList (SuffList) - Массив -
    1. Presentation (Presentation) - Строка - Представление, наименование вещи
    2. Description (Description) - Строка - Описание вещи
    3. FullDescription (FullDescription) - Строка - Полное описание
    4. Status (Status) - Строка - Текущий статус
    5. Location (Location) - Строка - Место положение вещи
    6. LocationID (LocationID) - Строка -
    7. StuffID (StuffID) - Строка - Идентификатор вещи
    8. Price (Price) - Число - Цена (залога, реализации, зависит от статуса)
    9. DetailedInfo (DetailedInfo) - Строка - Детальные данные по залоговой вещи. Возвращается только для метода “loan”. Для sales – пустое.
    10. BillNumber (BillNumber) - Строка -
    11. ThumbnailURLs (ThumbnailURLs) - Строка - Массив URL миниатюр , разделённых точкой с запятой
    12. ImageURLs (ImageURLs) - Строка - Массив URL фотографий , разделённых точкой с запятой
    13. StuffCode (StuffCode) - Строка -
    14. Gems (Gems) - Строка - Описание вставок, все перечислены через точку с запятой

Пример результата метода getStuffList

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"SuffList":
	[
		{
			"Presentation": "кольцо",
			"Description": "кольцо из золота",
			"FullDescription": "очень красивое прекрасное произведение искусства",
			"Status": "",
			"Location": "отделение севере",
			"LocationID": "000003",
			"StuffID": "asiodjf123--3141234sdaf",
			"Price": 3446,
			"DetailedInfo": ,
			"BillNumber": ,
			"ThumbnailURLs": /1231233/333/1.jpg;/1231233/333/2.jpg;/1231233/333/3.jpg;,
			"ImageURLs": /1231233/333/1.jpg;/1231233/333/2.jpg;/1231233/333/3.jpg;,
			"StuffCode": ,
			"Gems": 33 Амазонит, Микроклин 3кар И-89 /; 1 Бриллиант 3кар И-89 6/3
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

requestPayment requestPayment - Запрос оплаты через Мандарин

requestPayment

В журнале регистрации метод имеет наименование: “requestPayment”.

Синхронный вызов метода осуществляется через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/syncCall/requestPayment”

Асинхронный вызов через PUT “[ИмяБазы]/hs/apiv1/[ИдентификаторПоставщика]/asyncCall/requestPayment”

Для метода определены следующие параметры, передаваемые через тело запроса в виде json (в скобках представление для журнала регистрации):

1. clientID (clientID) - Строка - requestPayment;
2. Loans (Loans) - Массив - requestPayment
   1. LoanID (LoanID) - Строка -

Пример параметров метода requestPayment

{
	"clientID": requestPayment,
	"Loans":
	[
		{
			"LoanID": 
		}
	]
}

В случае вызова для асинхронного запуска asyncCall/requestPayment возвращает результат со следующими полями (в скобках представление для журнала регистрации):

1. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при запуске
2. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок запуска
3. TaskID (ИдентификаторЗадания) - Строка - Идентификатор задания в случае успешного запуска

Пример результата asyncCall/requestPayment:

{
	"providerID": "ibd1", // Идентификатор поставщика данных
	"taskID", "744df418-5c52-471b-9f75-8095a3abad91", // Уникальный идентификатор задания выполняющегося метода
	"taskStarted", "true" // Признак, что метод успешно стартовал
	"declineReason", "" // Представление ошибки, в случае если метод не запущен
}

Получать результат асинхронного выполнения метода следует через getTaskStatus по TaskID, полученному при запуске. Метод getTaskStatus и синхронный вызов syncCall/requestPayment возвращают результат со следующими полями (в скобках представление для журнала регистрации):

1. taskStatus (СтатусЗадания) - Строка - 1 - Запланировано; 2 - Выполняется; 3 - Выполнено

2. dataToProcess (ДанныхКОбработке) - Число - Количество объектов данных к обработке

3. dataProcessed (ДанныхОбработано) - Число - Количество обработанных на момент запроса объектов данных

4. dataDeclined (ДанныхОтклонено) - Число - Количество объектов данных с ошибками

5. progress (Прогресс) - Число - Доля выполенных загрузок сообщений

6. isError (ВыполненоСОшибкой) - Булево - Признак наличия ошибок при выполнении

7. startTime (ВремяЗапуска) - Дата - Начало выполнения

8. finishTime (ВремяЗавершения) - Дата - Окончание выполнения

9. errorMessage (СообщениеОбОшибке) - Строка - Текстовое представление ошибок при выполнении

10. providerID (ПоставщикДанных) - Строка - Идентификатор поставщика данных

11. taskID (ИдентификаторЗадания) - Строка - Уникальный идентификатор задания

12. paymentLink (paymentLink) - Строка - ;

    Необязательный параметр.

13. paymentSum (paymentSum) - Число - ;

    Необязательный параметр.

14. paymentDetails (paymentDetails) - Массив -

    1. PawnbillNumber (PawnbillNumber) - Строка - Идентификтор залога
    2. PaymentSum (PaymentSum) - Число - Сумма платежа

Пример результата метода requestPayment

{
	"taskStatus": 1, // 1 - Запланировано; 2 - Выполняется; 3 - Выполнено
	"dataToProcess": 0, // Количество объектов данных к обработке
	"dataProcessed": 0, // Количество обработанных на момент запроса объектов данных
	"dataDeclined": 2, // Количество объектов данных с ошибками
	"progress": 1, // Доля выполенных загрузок сообщений
	"isError": "true", // Наличие ошибок во время выполнения
	"startTime": "20200211150000", // Начало выполнения
	"finishTime": "20200211150500", // Окончание выполнения
	"errorMessage": "", // Представление сообщения об ошибке
	"providerID": "ibd1", // Идентификатор поставщика данных
	"paymentLink": "https://mandario/somelink",,
	"paymentSum": 23312,,
	"paymentDetails":
	[
		{
			"PawnbillNumber": "Аб3333",
			"PaymentSum": 333
		}
	]
	"taskID": "744df418-5c52-471b-9f75-8095a3abad91" // Уникальный идентификатор задания
}

Типы с перечисляемыми значениями

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

getCustomCallingListRequestType

Допустимые значения:

• onGracePeriod - Займы на льготном сроке;
• onSell - На периоде реализации;
• paymentDate - Запрос по дате планового платежа;
• sellingDate - Запрос по дате начала реализации;

stuffType

Допустимые значения:

• loan - ;
• pawner - ;
• sales - ;

НаправлениеОтсчета

Допустимые значения:

• AtEnd - С конца;
• AtBegin - С начала;

ПериодыНачислений

Допустимые значения:

• GracePeriod - Льготный период;
• MainPeriod - Основной период;
• RetailPeriod - Период реализации;
• Current - Текущий;

ПолКлиента

Допустимые значения:

• Female - ;
• Male - ;

РазмерностиЛьготногоПериода

Допустимые значения:

• Day - День;
• Month - Месяц;

ТипОбъектаЗалога

Допустимые значения:

• OtherPawnObject - ;
• TransportFacilityPawnObject - ;
• JewelleryPawnObject - ;