InfoQuery
InfoQuery позволяет автоматизировать бизнес, используя данные Resware в решении с низким кодом. Вы можете просматривать, создавать, удалять и обновлять файлы, документы, партнеры и т. д.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка InfoQuery |
| URL | https://infoquery.pro/support/ |
| Адрес электронной почты | support@infoquery.pro |
| Метаданные соединителя | |
|---|---|
| Publisher | InfoQuery LLC |
| Website | https://infoquery.pro/ |
| Политика конфиденциальности | https://infoquery.pro/privacy/ |
| Категории | Содержимое и файлы; Данные |
Обозреватель заголовков InfoQuery позволяет автоматизировать изменения в системе Resware. Вы сможете добавлять, удалять или изменять файлы, действия, заметки, документы и т. д.
Предпосылки
- Ключ API является обязательным, должен зарегистрироваться по адресу https://connector.infoquery.pro/
- Также требуется учетная запись Resware. Для формирования подключения потребуется URL-адрес имени пользователя, пароля и портала.
Получение учетных данных
- Перейдите к https://connector.infoquery.pro/signup учетной записи и создайте ее. Здесь вы можете выбрать подписку, ключ API будет предоставлен после выбора.
- Посетите https://connector.infoquery.pro/products сведения о подписке и ценах.
- Сведения о учетной записи resware будут предоставлены администратором Resware.
Начало работы с соединителем
- Перейдите в Power Automate по адресу https://powerautomate.microsoft.com.
- Создайте новый поток или измените существующий поток.
- Добавьте новый шаг в поток, найдите обозреватель заголовков InfoQuery, чтобы просмотреть все доступные действия.
- После выбора действия необходимо создать новое подключение.
- Введите имя подключения, ключ API, имя пользователя Resware, пароль и URL-адрес портала. URL-адрес портала должен быть в формате https://portal.infoquery.com/API.
- Обратитесь support@infoquery.pro или посетите https://infoquery.pro/support/ , если требуется помощь.
Известные проблемы и ограничения
Каждый бизнес, использующее Resware, имеет возможность настроить его в соответствии с конкретными потребностями. В зависимости от настройки resware некоторые действия могут потребовать предоставления определенной информации для правильной работы соединителя. Потребуется знание системы Resware.
Распространенные ошибки и средства устранения неполадок
Действия могут дать ответ 200, но ожидаемые сведения не возвращаются. Это, скорее всего, связано с требуемыми сведениями о настройке resware, не предоставленными. Предоставленные вами сведения были успешно отправлены в Resware, предоставляя ответ 200, но действия, возможно, не произошли должным образом. Администратор resware или портал смогут предоставить вам сведения, необходимые для выполнения действий.
Часто задаваемые вопросы
Где найти URL-адрес портала Resware?
Администратор Resware предоставит URL-адрес портала.
Как получить ключ API?
Перейдите к https://connector.infoquery.pro/signup учетной записи и создайте ее. Отсюда вы можете выбрать подписку, ключ API будет предоставлен после выбора.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
| Имя пользователя ResWare | струна | Имя пользователя для ResWare | True |
| Пароль ResWare | securestring | Пароль для ResWare | True |
| URL-адрес портала ResWare | струна | URL-адрес портала для ResWare | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление действия в файл |
Добавляет действие в указанный файл. |
| Добавление заметки в файл |
Добавляет новую заметку в указанный файл. |
| Добавление или обновление настраиваемого поля в определенном документе |
Добавляет или обновляет настраиваемые поля в указанном документе в указанном файле. |
| Добавление или обновление настраиваемого поля в определенном файле |
Добавляет или обновляет настраиваемые поля в указанном файле. |
| Добавление нового сотрудника партнера в партнерская компания |
Добавляет нового сотрудника партнера в партнерную компанию. |
| Добавление партнера в конкретный файл |
Добавляет партнера в указанный файл. |
| Обновление действия для файла |
Обновляет действие для заданного файла. Может обновить идентификатор группы действий и идентификатор типа координатора, тип партнера, дату выполнения, заблокированную дату выполнения и заблокированную дату завершения. Этот вызов API нельзя использовать для пометки действия как запущенного или завершенного. |
| Обновление сведений о партнере для конкретного файла |
Обновляет сведения о партнере по указанному файлу. |
| Обновление сотрудника партнера |
Обновляет сведения о сотруднике партнера. |
| Отмена ранее размещенного заказа |
Отменяет ранее размещенный заказ. |
| Отправка документа веб-URL-адреса в конкретный файл |
Загружает документ веб-URL-адреса в указанном файле. |
| Оценка закрывающей платы |
Оценивает закрывающие сборы. |
| Получает файлы из заданных условий поиска |
Возвращает список файлов и их сведения на основе заданных критериев поиска. |
| Получение pdf-файла получения оценки оплаты за закрытие |
Возвращает квитанцию о закрытии платы в формате pdf. |
| Получение действий для конкретного файла |
Возвращает все действия в указанном файле. |
| Получение документа |
Возвращает сведения о документе с указанным идентификатором. |
| Получение документов для конкретного файла |
Получает все сведения о документах в указанном файле. |
| Получение заметки |
Возвращает заметку с указанным идентификатором. |
| Получение заметок для конкретного файла |
Возвращает список заметок в указанном файле. |
| Получение квитанции о закрытии сборов |
Возвращает квитанцию о закрытии платы. |
| Получение настраиваемых полей в определенном документе |
Получите настраиваемые поля в указанном документе. |
| Получение настраиваемых полей для определенного файла |
Возвращает настраиваемые поля для указанного файла. |
| Получение партнеров для конкретного файла |
Возвращает список партнеров и их сведения о указанном файле. |
| Получение сведений о партнере |
Получает сведения о партнере с указанным идентификатором. |
| Получение сведений о текущем пользователе |
Возвращает сведения о текущем подключенном пользователе. |
| Получение сторон для конкретного файла |
Возвращает список сторон и их сведения о указанном файле. |
| Получение типов транзакций и продуктов для оценки и размещения заказов |
Получение типов транзакций и типов продуктов для оценки сборов и размещения заказов. |
| Создание документа в определенном файле |
Создает новый документ в указанном файле. |
| Создание файла |
Создает новый файл. |
| Удаление партнера в определенном файле |
Удаляет партнера из указанного файла. |
| Удаление ранее размещенного заказа |
Отменяет ранее размещенный заказ. |
Добавление действия в файл
Добавляет действие в указанный файл.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
ActionTypeID
|
ActionTypeID | integer |
Идентификационный номер типа действия. |
|
|
ActionGroupID
|
ActionGroupID | integer |
Идентификационный номер группы действий. |
|
|
КоординаторTypeID
|
CoordinatorTypeID | integer |
Идентификационный номер типа координатора. |
|
|
Дата выполнения
|
DueDate | string |
Дата выполнения действия. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Дата выполнения
|
DueDate | string |
Дата выполнения действия. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
Идентификационный номер действия файла. |
Добавление заметки в файл
Добавляет новую заметку в указанный файл.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Тема
|
Subject | string |
Тема заметки. |
|
|
Тело
|
Body | string |
Текст заметки. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
Идентификационный номер заметки. |
Добавление или обновление настраиваемого поля в определенном документе
Добавляет или обновляет настраиваемые поля в указанном документе в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Идентификатор документа
|
DocumentID | True | string |
Идентификационный номер документа. |
|
Имя
|
Name | string |
Имя настраиваемого поля. |
|
|
Ценность
|
Value | string |
Значение настраиваемого поля. |
Возвращаемое значение
- response
- object
Добавление или обновление настраиваемого поля в определенном файле
Добавляет или обновляет настраиваемые поля в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Имя
|
Name | string |
Имя настраиваемого поля. |
|
|
Ценность
|
Value | string |
Значение настраиваемого поля. |
Возвращаемое значение
- response
- object
Добавление нового сотрудника партнера в партнерская компания
Добавляет нового сотрудника партнера в партнерную компанию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор партнерской компании
|
PartnerCompanyID | True | string |
Идентификационный номер партнерской компании. |
|
Пароль
|
Password | string |
Пароль для нового сотрудника. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
Дата истечения срока действия пароля. |
|
|
Включен
|
Enabled | boolean |
Будет ли включен новый сотрудник. |
|
|
SiteAccess
|
WebsiteAccess | boolean |
Имеет ли новый сотрудник доступ к веб-сайту. |
|
|
Имя
|
Name | string |
Полное имя нового сотрудника. |
|
|
Имя
|
FirstName | string |
Первое имя нового сотрудника. |
|
|
Фамилия
|
LastName | string |
Фамилия нового сотрудника. |
|
|
Электронный адрес
|
EmailAddress | string |
Адрес электронной почты нового сотрудника. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
Идентификационный номер партнерской компании. |
|
Включен
|
Employee.Enabled | boolean |
Независимо от того, включен ли новый сотрудник для использования. |
|
SiteAccess
|
Employee.WebsiteAccess | boolean |
Имеет ли сотрудник доступ к веб-сайту. |
|
Идентификатор пользователя
|
Employee.UserID | integer |
Идентификационный номер нового сотрудника. |
|
Имя
|
Employee.Name | string |
Полное имя сотрудника. |
|
Имя
|
Employee.FirstName | string |
Имя сотрудника. |
|
Фамилия
|
Employee.LastName | string |
Фамилия сотрудника. |
|
Электронный адрес
|
Employee.ContactInformation.EmailAddress | string |
Адрес электронной почты сотрудника. |
Добавление партнера в конкретный файл
Добавляет партнера в указанный файл.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
Возвращаемое значение
- response
- object
Обновление действия для файла
Обновляет действие для заданного файла. Может обновить идентификатор группы действий и идентификатор типа координатора, тип партнера, дату выполнения, заблокированную дату выполнения и заблокированную дату завершения. Этот вызов API нельзя использовать для пометки действия как запущенного или завершенного.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Идентификатор действия файла
|
FileActionID | True | string |
Идентификационный номер действия. |
|
КоординаторTypeID
|
CoordinatorTypeID | integer |
Идентификационный номер типа координатора. |
|
|
Дата выполнения
|
DueDate | string |
Дата выполнения действия. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Заблокирована ли дата завершения. |
|
|
КоординаторTypeID
|
CoordinatorTypeID | integer |
Идентификационный номер типа координатора. |
|
|
Дата выполнения
|
DueDate | string |
Дата выполнения действия. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Заблокирована ли дата завершения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
Идентификационный номер действия. |
Обновление сведений о партнере для конкретного файла
Обновляет сведения о партнере по указанному файлу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Partner ID
|
PartnerID | True | string |
Идентификационный номер партнера. |
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
|
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
|
Имя
|
Name | string |
Полное имя сотрудника. |
|
|
Имя
|
FirstName | string |
Имя сотрудника. |
|
|
Фамилия
|
LastName | string |
Фамилия сотрудника. |
|
|
Номер телефона
|
PhoneNumber | string |
Номер телефона сотрудника. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
Номер домашнего телефона сотрудника. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
Номер мобильного телефона сотрудника. |
|
|
Голосовая почта
|
Voicemail | string |
Голосовая почта сотрудника. |
|
|
ФаксNumber
|
FaxNumber | string |
Номер факса сотрудника. |
|
|
Электронный адрес
|
EmailAddress | string |
Адрес электронной почты сотрудника. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
Предпочтительный метод связи для сотрудников. |
|
|
Website
|
Website | string |
Веб-ссылка сотрудника. |
|
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
|
Имя
|
Name | string |
Полное имя дополнительного сотрудника. |
|
|
Имя
|
FirstName | string |
Имя дополнительного сотрудника. |
|
|
Фамилия
|
LastName | string |
Фамилия дополнительного сотрудника. |
|
|
Номер телефона
|
PhoneNumber | string |
Номер телефона дополнительного сотрудника. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
Номер домашнего телефона дополнительного сотрудника. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
Номер мобильного телефона дополнительного сотрудника. |
|
|
Голосовая почта
|
Voicemail | string |
Голосовая почта вторичного сотрудника. |
|
|
ФаксNumber
|
FaxNumber | string |
Номер факса дополнительного сотрудника. |
|
|
Электронный адрес
|
EmailAddress | string |
Адрес электронной почты дополнительного сотрудника. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
Вторичные сотрудники предпочли метод обмена данными. |
|
|
Website
|
Website | string |
Веб-ссылка вторичного сотрудника. |
|
|
ReferenceNumber
|
ReferenceNumber | string |
Номер ссылки. |
|
|
RemoteFileNumber
|
RemoteFileNumber | string |
Номер удаленного файла. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
PartnerTypeName
|
PartnerTypeName | string |
Имя типа партнера. |
|
|
OfficeID
|
OfficeID | integer |
Идентификационный номер офиса. |
|
|
Имя партнёра
|
PartnerName | string |
Имя партнера. |
|
|
Адрес1
|
Address1 | string |
Номер улицы и имя. |
|
|
Адрес2
|
Address2 | string |
Дополнительные сведения об адресе. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
|
|
Номер телефона
|
PhoneNumber | string |
Номер телефона партнера. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
Номер домашнего телефона партнера. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
Номер мобильного телефона партнера. |
|
|
Голосовая почта
|
Voicemail | string |
Номер голосовой почты партнера. |
|
|
ФаксNumber
|
FaxNumber | string |
Номер факса партнера. |
|
|
Электронный адрес
|
EmailAddress | string |
Адрес электронной почты партнера. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
Партнеры предпочли способ общения. |
|
|
Website
|
Website | string |
URL-адрес веб-сайта партнера. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
|
FileNumber
|
FileNumber | string |
Номер файла |
|
Идентификатор пользователя
|
PrimaryEmployee.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
PrimaryEmployee.Name | string |
Полное имя сотрудника. |
|
Имя
|
PrimaryEmployee.FirstName | string |
Имя сотрудника. |
|
Фамилия
|
PrimaryEmployee.LastName | string |
Фамилия сотрудника. |
|
Номер телефона
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
Номер телефона сотрудника. |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
Номер домашнего телефона сотрудника. |
|
CellPhoneNumber
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
Номер мобильного телефона сотрудника. |
|
Голосовая почта
|
PrimaryEmployee.ContactInformation.Voicemail | string |
Голосовая почта сотрудника. |
|
ФаксNumber
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
Номер факса сотрудника. |
|
Электронный адрес
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
Адрес электронной почты сотрудника. |
|
PreferredCommunicationMethod
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
Предпочтительный метод связи для сотрудников. |
|
Website
|
PrimaryEmployee.ContactInformation.Website | string |
Веб-ссылка сотрудника. |
|
ВторичныеEmployees
|
SecondaryEmployees | array of object |
Сведения о дополнительном сотруднике. |
|
Идентификатор пользователя
|
SecondaryEmployees.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
SecondaryEmployees.Name | string |
Полное имя дополнительного сотрудника. |
|
Имя
|
SecondaryEmployees.FirstName | string |
Имя дополнительного сотрудника. |
|
Фамилия
|
SecondaryEmployees.LastName | string |
Фамилия дополнительного сотрудника. |
|
Номер телефона
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
Номер телефона дополнительного сотрудника. |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
Номер домашнего телефона дополнительного сотрудника. |
|
CellPhoneNumber
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
Номер мобильного телефона дополнительного сотрудника. |
|
Голосовая почта
|
SecondaryEmployees.ContactInformation.Voicemail | string |
Голосовая почта вторичного сотрудника. |
|
ФаксNumber
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
Номер факса дополнительного сотрудника. |
|
Электронный адрес
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
Адрес электронной почты дополнительного сотрудника. |
|
PreferredCommunicationMethod
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
Вторичные сотрудники предпочли метод обмена данными. |
|
Website
|
SecondaryEmployees.ContactInformation.Website | string |
Веб-ссылка вторичного сотрудника. |
|
ReferenceNumber
|
ReferenceNumber | string |
Номер ссылки. |
|
RemoteFileNumber
|
RemoteFileNumber | string |
Номер удаленного файла. |
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
PartnerTypeID
|
PartnerType.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
PartnerTypeName
|
PartnerType.PartnerTypeName | string |
Имя типа партнера. |
|
OfficeID
|
OfficeID | integer |
Идентификационный номер офиса. |
|
Имя партнёра
|
PartnerName | string |
Имя партнера. |
|
Адрес1
|
MailingAddress.Address1 | string |
Номер улицы и имя. |
|
Адрес2
|
MailingAddress.Address2 | string |
Дополнительные сведения об адресе. |
|
Город
|
MailingAddress.City | string |
Имя города. |
|
Государство
|
MailingAddress.State | string |
Сокращение состояния двух букв. |
|
Zip-архив
|
MailingAddress.Zip | string |
ZIP-код. |
|
Номер телефона
|
ContactInformation.PhoneNumber | string |
Номер телефона партнера. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
Номер домашнего телефона партнера. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
Номер мобильного телефона партнера. |
|
Голосовая почта
|
ContactInformation.Voicemail | string |
Номер голосовой почты партнера. |
|
ФаксNumber
|
ContactInformation.FaxNumber | string |
Номер факса партнера. |
|
Электронный адрес
|
ContactInformation.EmailAddress | string |
Адрес электронной почты партнера. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
Партнеры предпочли способ общения. |
|
Website
|
ContactInformation.Website | string |
URL-адрес веб-сайта партнера. |
Обновление сотрудника партнера
Обновляет сведения о сотруднике партнера.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
UserID | True | string |
Идентификационный номер пользователя. |
|
Идентификатор партнерской компании
|
PartnerCompanyID | True | string |
Идентификационный номер партнерской компании. |
|
Пароль
|
Password | string |
Пароль сотрудников. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
Дата истечения срока действия пароля. |
|
|
RoleID
|
RoleID | integer |
Идентификационный номер роли. |
|
|
Имя
|
Name | string |
Имя роли. |
|
|
Включен
|
Enabled | boolean |
Независимо от того, включен ли сотрудник для использования. |
|
|
SiteAccess
|
WebsiteAccess | boolean |
Имеет ли сотрудник доступ к веб-сайту. |
|
|
Имя
|
Name | string |
Полное имя сотрудника. |
|
|
Имя
|
FirstName | string |
Имя сотрудника. |
|
|
Фамилия
|
LastName | string |
Фамилия сотрудника. |
|
|
Электронный адрес
|
EmailAddress | string |
Адрес электронной почты сотрудника. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
Идентификационный номер партнерской компании. |
|
Роли
|
Employee.Roles | array of object |
Роли сотрудника. |
|
RoleID
|
Employee.Roles.RoleID | integer |
Идентификационный номер роли. |
|
Имя
|
Employee.Roles.Name | string |
Имя роли. |
|
Включен
|
Employee.Enabled | boolean |
Независимо от того, включен ли сотрудник для использования. |
|
SiteAccess
|
Employee.WebsiteAccess | boolean |
Имеет ли сотрудник доступ к веб-сайту. |
|
Идентификатор пользователя
|
Employee.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Employee.Name | string |
Полное имя сотрудника. |
|
Имя
|
Employee.FirstName | string |
Имя сотрудника. |
|
Фамилия
|
Employee.LastName | string |
Фамилия сотрудника. |
|
Электронный адрес
|
Employee.ContactInformation.EmailAddress | string |
Адрес электронной почты сотрудника. |
Отмена ранее размещенного заказа
Отменяет ранее размещенный заказ.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
Возвращаемое значение
- response
- object
Отправка документа веб-URL-адреса в конкретный файл
Загружает документ веб-URL-адреса в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Имя документа
|
DocumentName | string |
Имя документа. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
Идентификационный номер типа документа. |
|
|
Description
|
Description | string |
Описание документа. |
|
|
InternalOnly
|
InternalOnly | boolean |
Независимо от того, является ли документ внутренним только. |
|
|
WebURL
|
WebURL | string |
URL-адрес документа. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
Идентификационный номер документа. |
Оценка закрывающей платы
Оценивает закрывающие сборы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
TransactionTypeID
|
TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
|
ProductTypeID
|
ProductTypeID | integer |
Идентификационный номер типа продукта. |
|
|
SettlementStatementVersion
|
SettlementStatementVersion | string |
Версия инструкции расчетов. |
|
|
SalesPrice
|
SalesPrice | integer |
Цена на продажу. |
|
|
LienPosition
|
LienPosition | integer |
Позиция лжей. |
|
|
КредитAmount
|
LoanAmount | integer |
Сумма кредита. |
|
|
LoanType
|
LoanType | string |
Тип кредита. |
|
|
IsPrimary
|
IsPrimary | boolean |
Независимо от того, является ли это основным свойством. |
|
|
StreetNumber
|
StreetNumber | string |
Номер дома. |
|
|
StreetName
|
StreetName | string |
Имя улицы. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Округ
|
County | string |
Имя округа. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Имя
|
Name | string |
Имя подтверждения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
Закрывающая плата оценивает идентификационный номер. |
|
HUDFees
|
ClosingFeeEstimate.HUDFees | array of object |
Сборы HUD. |
|
Сумма
|
ClosingFeeEstimate.HUDFees.Amount | integer |
Сумма платы HUD. |
|
Description
|
ClosingFeeEstimate.HUDFees.Description | string |
Описание платы. |
|
LineNumber
|
ClosingFeeEstimate.HUDFees.LineNumber | string |
Номер строки. |
|
BuyerAmount
|
ClosingFeeEstimate.HUDFees.BuyerAmount | integer |
Сумма покупателя. |
|
BuyerPOCAmount
|
ClosingFeeEstimate.HUDFees.BuyerPOCAmount | integer |
Сумма POC покупателя. |
|
SellerAmount
|
ClosingFeeEstimate.HUDFees.SellerAmount | integer |
Сумма продавца. |
|
SellerPOCAmount
|
ClosingFeeEstimate.HUDFees.SellerPOCAmount | integer |
Сумма POC продавца. |
|
OtherPOCAmount
|
ClosingFeeEstimate.HUDFees.OtherPOCAmount | integer |
Другая сумма POC. |
|
PartnerTypeID
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
PartnerTypeName
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
Имя типа партнера. |
|
GFE
|
ClosingFeeEstimate.GFE | array of object |
Оценка доброй воли. |
|
Description
|
ClosingFeeEstimate.GFE.Description | string |
Что такое оценка. |
|
Сумма
|
ClosingFeeEstimate.GFE.Amount | integer |
Сумма оценки. |
|
КредиторыPremium
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
Кредиторы премиум. |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
Полные кредиторы премии. |
|
Отметка времени
|
ClosingFeeEstimate.Timestamp | string |
Метка времени. |
Получает файлы из заданных условий поиска
Возвращает список файлов и их сведения на основе заданных критериев поиска.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
FileNumber
|
FileNumber | string |
Номер файла. |
|
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
|
|
OfficeID
|
OfficeID | integer |
Идентификационный номер офиса. |
|
|
ClientFileNumber
|
ClientsFileNumber | string |
Номер файла клиентов. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
|
ProductTypeID
|
ProductTypeID | integer |
Идентификационный номер типа продукта. |
|
|
StatusID
|
StatusID | integer |
Идентификационный номер состояния. |
|
|
Имя
|
Name | string |
Имя состояния. |
|
|
PolicyNumber
|
PolicyNumber | string |
Номер политики. |
|
|
SearchNumber
|
SearchNumber | string |
Номер поиска. |
|
|
Номер кредита
|
LoanNumber | string |
Номер кредита. |
|
|
IsPrimary
|
IsPrimary | boolean |
Указывает, является ли это основным адресом свойства. |
|
|
StreetNumber
|
StreetNumber | string |
Номер дома. |
|
|
StreetName
|
StreetName | string |
Имя улицы. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
|
|
Подразделение
|
Subdivision | string |
Подразделение, в которое находится свойство. |
|
|
Пакетный идентификатор
|
ParcelID | string |
Идентификационный номер посылки. |
|
|
EntityType
|
EntityType | string |
Тип сущности. |
|
|
First
|
First | string |
Имя партии. |
|
|
Фамилия
|
Last | string |
Фамилия партии. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Указывает, является ли это основным адресом свойства. |
|
|
MaritalStatus
|
MaritalStatus | string |
Семейное положение партии. |
|
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
ОткрытыйFromDate
|
OpenedFromDate | string |
Дата открытия файла. |
|
|
ОткрытиеToDate
|
OpenedToDate | string |
Дата закрытия файла. |
Возвращаемое значение
- response
- object
Получение pdf-файла получения оценки оплаты за закрытие
Возвращает квитанцию о закрытии платы в формате pdf.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор закрывающей платы
|
ClosingFeeID | True | string |
Закрывающий идентификационный номер платы. |
Возвращаемое значение
- response
- object
Получение действий для конкретного файла
Возвращает все действия в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Действия
|
Actions | array of object |
Список действий. |
|
FileActionID
|
Actions.FileActionID | integer |
Идентификационный номер действия файла. |
|
ActionTypeID
|
Actions.ActionType.ActionTypeID | integer |
Идентификационный номер типа действия. |
|
Имя
|
Actions.ActionType.Name | string |
Имя действия. |
|
Отображаемое имя
|
Actions.ActionType.DisplayName | string |
Отображаемое имя. |
|
ActionGroupID
|
Actions.Group.ActionGroupID | integer |
Идентификационный номер группы действий. |
|
Имя
|
Actions.Group.Name | string |
Имя действия. |
|
КоординаторTypeID
|
Actions.StartTask.CoordinatorTypeID | integer |
Идентификационный номер типа координатора. |
|
Дата выполнения
|
Actions.StartTask.DueDate | string |
Дата выполнения действия. |
|
DueDateLocked
|
Actions.StartTask.DueDateLocked | boolean |
Указывает, заблокирована ли дата выполнения. |
|
Готовоеdate
|
Actions.StartTask.DoneDate | string |
Дата выполнения действия. |
|
DoneDateLocked
|
Actions.StartTask.DoneDateLocked | boolean |
Заблокирована ли дата завершения. |
|
Идентификатор пользователя
|
Actions.StartTask.DoneBy.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Actions.StartTask.DoneBy.Name | string |
Имя пользователя. |
|
КоординаторTypeID
|
Actions.CompleteTask.CoordinatorTypeID | integer |
Идентификационный номер типа координатора. |
|
Дата выполнения
|
Actions.CompleteTask.DueDate | string |
Дата выполнения действия. |
|
DueDateLocked
|
Actions.CompleteTask.DueDateLocked | boolean |
Указывает, заблокирована ли дата выполнения. |
|
DoneDateLocked
|
Actions.CompleteTask.DoneDateLocked | boolean |
Заблокирована ли дата завершения. |
|
Идентификатор пользователя
|
Actions.CompleteTask.DoneBy.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Actions.CompleteTask.DoneBy.Name | string |
Имя пользователя. |
Получение документа
Возвращает сведения о документе с указанным идентификатором.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
DocumentID | True | string |
Идентификационный номер документа. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
DocumentID
|
DocumentID | integer |
Идентификационный номер документа. |
|
Имя документа
|
DocumentName | string |
Имя документа. |
|
DocumentTypeID
|
DocumentType.DocumentTypeID | integer |
Имя типа документа. |
|
Имя
|
DocumentType.Name | string |
Имя типа документа. |
|
Description
|
Description | string |
Описание документа. |
|
InternalOnly
|
InternalOnly | boolean |
Независимо от того, является ли документ внутренним только. |
|
Утверждено
|
Approved | boolean |
Утверждается ли документ. |
|
Идентификатор пользователя
|
CreateUser.UserID | integer |
Идентификационный номер пользователя. |
|
CreateDate
|
CreateDate | string |
Дата создания документа. |
Получение документов для конкретного файла
Получает все сведения о документах в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Documents
|
Documents | array of object |
Список документов в файле. |
|
DocumentID
|
Documents.DocumentID | integer |
Идентификационный номер документа. |
|
Имя документа
|
Documents.DocumentName | string |
Имя документа. |
|
DocumentTypeID
|
Documents.DocumentType.DocumentTypeID | integer |
Идентификационный номер типа документа. |
|
Имя
|
Documents.DocumentType.Name | string |
Имя типа документа. |
|
Description
|
Documents.Description | string |
Описание документа. |
|
InternalOnly
|
Documents.InternalOnly | boolean |
Независимо от того, является ли документ внутренним только. |
|
Утверждено
|
Documents.Approved | boolean |
Утверждается ли документ. |
|
AssociatedNotes
|
Documents.AssociatedNotes | array of object |
Заметки, связанные с документом. |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
Запишите идентификационный номер. |
|
Идентификатор пользователя
|
Documents.CreateUser.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Documents.CreateUser.Name | string |
Имя пользователя. |
|
CreateDate
|
Documents.CreateDate | string |
Дата создания документа. |
|
Идентификатор пользователя
|
Documents.ModifyUser.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Documents.ModifyUser.Name | string |
Имя пользователя. |
|
ИзменениеDate
|
Documents.ModifyDate | string |
Дата изменения документа. |
Получение заметки
Возвращает заметку с указанным идентификатором.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор заметки
|
NoteID | True | string |
Запишите идентификационный номер. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
NoteID
|
NoteID | integer |
Идентификационный номер заметки. |
|
Тема
|
Subject | string |
Тема заметки. |
|
Тело
|
Body | string |
Текст заметки. |
|
Идентификатор пользователя
|
CreatedBy.UserID | integer |
Идентификационный номер пользователя. |
|
CreatedDate
|
CreatedDate | string |
Дата создания заметки. |
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
Получение заметок для конкретного файла
Возвращает список заметок в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Примечания.
|
Notes | array of object |
Список заметок в файле. |
|
NoteID
|
Notes.NoteID | integer |
Идентификационный номер заметки. |
|
Тема
|
Notes.Subject | string |
Тема заметки. |
|
Тело
|
Notes.Body | string |
Текст заметки. |
|
Идентификатор пользователя
|
Notes.CreatedBy.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Notes.CreatedBy.Name | string |
Полное имя пользователя. |
|
Имя
|
Notes.CreatedBy.FirstName | string |
Имя пользователя. |
|
Фамилия
|
Notes.CreatedBy.LastName | string |
Фамилия пользователя. |
|
Номер телефона
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
Номер телефона пользователей. |
|
Электронный адрес
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
Адрес электронной почты пользователей. |
|
CreatedDate
|
Notes.CreatedDate | string |
Дата создания заметки. |
|
FileID
|
Notes.FileID | integer |
Идентификационный номер файла. |
|
Ускорить
|
Notes.Expedite | boolean |
Независимо от того, была ли ускоренная заметка. |
Получение квитанции о закрытии сборов
Возвращает квитанцию о закрытии платы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор закрывающей платы
|
ClosingFeeID | True | string |
Закрывающий идентификационный номер платы. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Оценка
|
EstimateDate | string |
Дата оценки. |
|
TransactionTypeID
|
Request.TransactionProductType.TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
ProductTypeID
|
Request.TransactionProductType.ProductTypeID | integer |
Идентификационный номер типа продукта. |
|
SettlementStatementVersion
|
Request.SettlementStatementVersion | string |
Версия инструкции расчетов. |
|
SalesPrice
|
Request.SalesPrice | integer |
Цена на продажу. |
|
Кредиты
|
Request.Loans | array of object |
Сведения о кредитах. |
|
LienPosition
|
Request.Loans.LienPosition | integer |
Позиция лжей. |
|
КредитAmount
|
Request.Loans.LoanAmount | integer |
Сумма кредита. |
|
LoanType
|
Request.Loans.LoanType | string |
Тип кредита. |
|
Свойства
|
Request.Properties | array of object |
Свойства в оценке. |
|
IsPrimary
|
Request.Properties.IsPrimary | boolean |
Независимо от того, является ли это основным свойством. |
|
StreetNumber
|
Request.Properties.StreetNumber | string |
Номер дома. |
|
StreetName
|
Request.Properties.StreetName | string |
Имя улицы. |
|
Город
|
Request.Properties.City | string |
Имя города. |
|
Государство
|
Request.Properties.State | string |
Сокращение состояния двух букв. |
|
Округ
|
Request.Properties.County | string |
Имя округа. |
|
Zip-архив
|
Request.Properties.Zip | string |
ZIP-код. |
|
FilePartners
|
Request.FilePartners | array of object |
Партнеры по файлу. |
|
PartnerTypeID
|
Request.FilePartners.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
Идентификатор партнёра
|
Request.FilePartners.PartnerID | integer |
Идентификационный номер партнера. |
|
PartnerTypeID
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
Одобрения
|
Request.Endorsements | array of object |
Подтверждения. |
|
Имя
|
Request.Endorsements.Name | string |
Имя подтверждения. |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
Закрывающая плата оценивает идентификационный номер. |
|
HUDFees
|
Response.HUDFees | array of object |
Сборы HUD. |
|
Сумма
|
Response.HUDFees.Amount | integer |
Сумма платы HUD. |
|
Description
|
Response.HUDFees.Description | string |
Описание платы. |
|
LineNumber
|
Response.HUDFees.LineNumber | string |
Номер строки. |
|
BuyerAmount
|
Response.HUDFees.BuyerAmount | integer |
Сумма покупателя. |
|
BuyerPOCAmount
|
Response.HUDFees.BuyerPOCAmount | integer |
Сумма POC покупателя. |
|
SellerAmount
|
Response.HUDFees.SellerAmount | integer |
Сумма продавца. |
|
SellerPOCAmount
|
Response.HUDFees.SellerPOCAmount | integer |
Сумма POC продавца. |
|
OtherPOCAmount
|
Response.HUDFees.OtherPOCAmount | integer |
Другая сумма POC. |
|
PartnerTypeID
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
PartnerTypeName
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
Имя типа партнера. |
|
GFE
|
Response.GFE | array of object |
Оценка доброй воли. |
|
Description
|
Response.GFE.Description | string |
Что такое оценка. |
|
Сумма
|
Response.GFE.Amount | integer |
Сумма оценки. |
|
КредиторыPremium
|
Response.Premiums.LendersPremium | integer |
Кредиторы премиум. |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
Полные кредиторы премии. |
|
Отметка времени
|
Response.Timestamp | string |
Метка времени. |
Получение настраиваемых полей в определенном документе
Получите настраиваемые поля в указанном документе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Идентификатор документа
|
DocumentID | True | string |
Идентификационный номер документа. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
настраиваемые поля. |
|
Имя
|
CustomFields.Name | string |
Имя настраиваемого поля. |
|
Ценность
|
CustomFields.Value | string |
Значение настраиваемого поля. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
Количество настраиваемых полей в файле. |
Получение настраиваемых полей для определенного файла
Возвращает настраиваемые поля для указанного файла.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
Список настраиваемых полей в файле. |
|
Имя
|
CustomFields.Name | string |
Имя настраиваемого поля. |
|
Ценность
|
CustomFields.Value | string |
Значение настраиваемого поля. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
количество настраиваемых полей в файле. |
Получение партнеров для конкретного файла
Возвращает список партнеров и их сведения о указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Partners
|
Partners | array of object |
Сведения о партнерах. |
|
Идентификатор пользователя
|
Partners.PrimaryEmployee.UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Partners.PrimaryEmployee.Name | string |
Полное имя сотрудника. |
|
Имя
|
Partners.PrimaryEmployee.FirstName | string |
Имя сотрудника. |
|
Фамилия
|
Partners.PrimaryEmployee.LastName | string |
Фамилия сотрудника. |
|
Номер телефона
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
Номер телефона сотрудника. |
|
Электронный адрес
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
Адрес электронной почты сотрудника. |
|
PartnerTypeID
|
Partners.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
Идентификатор партнёра
|
Partners.PartnerID | integer |
Идентификационный номер партнера. |
|
PartnerTypeID
|
Partners.PartnerType.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
PartnerTypeName
|
Partners.PartnerType.PartnerTypeName | string |
Имя типа партнера. |
|
Имя партнёра
|
Partners.PartnerName | string |
Имя партнера. |
Получение сведений о партнере
Получает сведения о партнере с указанным идентификатором.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор партнерской компании
|
PartnerCompanyID | True | string |
Идентификационный номер партнерской компании. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PartnerCompanyID
|
PartnerCompanyID | integer |
Идентификационный номер партнерской компании. |
|
PartnerTypes
|
PartnerTypes | array of object |
Сведения о типе партнера. |
|
PartnerTypeID
|
PartnerTypes.PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
PartnerTypeName
|
PartnerTypes.PartnerTypeName | string |
Имя типа партнера. |
|
OfficeID
|
OfficeID | integer |
Идентификационный номер офиса. |
|
Имя партнёра
|
PartnerName | string |
Имя партнера. |
|
CompanyAbbreviation
|
CompanyAbbreviation | string |
Сокращение компании. |
|
ProperCompanyName
|
ProperCompanyName | string |
Полное имя компании. |
|
Адрес1
|
MailingAddress.Address1 | string |
Номер улицы и имя. |
|
Адрес2
|
MailingAddress.Address2 | string |
Дополнительные сведения об адресе. |
|
Город
|
MailingAddress.City | string |
Имя города. |
|
Государство
|
MailingAddress.State | string |
Сокращение состояния двух букв. |
|
Zip-архив
|
MailingAddress.Zip | string |
ZIP-код. |
|
Номер телефона
|
ContactInformation.PhoneNumber | string |
Номер телефона партнера. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
Номер домашнего телефона партнера. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
Номер мобильного телефона партнера. |
|
Голосовая почта
|
ContactInformation.Voicemail | string |
Номер голосовой почты партнера. |
|
ФаксNumber
|
ContactInformation.FaxNumber | string |
Номер факса партнера. |
|
Электронный адрес
|
ContactInformation.EmailAddress | string |
Адрес электронной почты партнера. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
Партнеры предпочли способ общения. |
|
Website
|
ContactInformation.Website | string |
URL-адрес веб-сайта партнера. |
|
Идентификатор
|
CompanyInformation.ParentCompany.ID | integer |
Идентификационный номер. |
|
Имя
|
CompanyInformation.ParentCompany.Name | string |
Имя родительской компании. |
|
Идентификатор
|
CompanyInformation.PartnerEntity.ID | integer |
Идентификационный номер. |
|
имя
|
CompanyInformation.PartnerEntity.name | string |
Имя сущности партнера. |
|
IsBillable
|
CompanyInformation.IsBillable | boolean |
Независимо от того, является ли партнер выставлен счетом. |
|
IsInvoiceable
|
CompanyInformation.IsInvoiceable | boolean |
Независимо от того, является ли свойство выставленным счетом. |
|
TaxID
|
CompanyInformation.TaxID | string |
Идентификационный номер партнера. |
|
AccountingCode
|
CompanyInformation.AccountingCode | string |
Код учета. |
|
КомментарииSpecialInstructions
|
CompanyInformation.CommentsSpecialInstructions | string |
Комментарии партнера. |
|
DontAllowSelectionInSettlement
|
CompanyInformation.DontAllowSelectionInSettlement | boolean |
Следует ли разрешать выделение в расчете. |
|
Требуется 1099
|
CompanyInformation.Needs1099 | boolean |
Требуется ли значение 1099. |
|
MWBE
|
CompanyInformation.MWBE | boolean |
Независимо от того, является ли партнер MWBE? |
|
SendDocumentsAsWebLinks
|
SendDocumentsAsWebLinks | boolean |
Следует ли отправлять документы в виде веб-ссылок. |
|
WireConfirmationEmailTemplateID
|
WireConfirmationEmailTemplateID | integer |
Идентификационный номер шаблона подтверждения провода. |
|
UseOnDisbursementsements
|
CourierAddress.UseOnDisbursements | boolean |
Следует ли использовать это для выплат. |
|
Адрес1
|
CourierAddress.Address1 | string |
Номер улицы и имя. |
|
Адрес2
|
CourierAddress.Address2 | string |
Дополнительные сведения об адресе. |
|
Город
|
CourierAddress.City | string |
Имя города. |
|
Государство
|
CourierAddress.State | string |
Сокращение состояния двух букв. |
|
Zip-архив
|
CourierAddress.Zip | string |
ZIP-код. |
Получение сведений о текущем пользователе
Возвращает сведения о текущем подключенном пользователе.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Название
|
Title | string |
Заголовок пользователя. |
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
Дата истечения срока действия пароля. |
|
Идентификатор пользователя
|
UserID | integer |
Идентификационный номер пользователя. |
|
Имя
|
Name | string |
Имя пользователя. |
|
Имя
|
FirstName | string |
Имя пользователя. |
|
Фамилия
|
LastName | string |
Фамилия пользователя. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
Номер мобильного телефона пользователя. |
|
Электронный адрес
|
ContactInformation.EmailAddress | string |
Адрес электронной почты пользователя. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
Предпочтительный метод связи для пользователей. |
|
Номер телефона
|
ContactInformation.PhoneNumber | string |
Номер телефона пользователя. |
|
ФаксNumber
|
ContactInformation.FaxNumber | string |
Номер факса пользователя. |
|
Website
|
ContactInformation.Website | string |
Веб-сайт пользователя. |
Получение сторон для конкретного файла
Возвращает список сторон и их сведения о указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Покупателей
|
Buyers | array of object |
Сведения о покупателях. |
|
LegalEntityID
|
Buyers.LegalEntityID | integer |
Идентификационный номер юридического лица. |
|
EntityType
|
Buyers.EntityType | string |
Имя типа сущности. |
|
Приставка
|
Buyers.Primary.Prefix | string |
Префикс покупателя. |
|
First
|
Buyers.Primary.First | string |
Имя покупателя. |
|
Отчество
|
Buyers.Primary.Middle | string |
По промежуточному имени покупателя. |
|
Фамилия
|
Buyers.Primary.Last | string |
Фамилия покупателя. |
|
Суффикс
|
Buyers.Primary.Suffix | string |
Суффикс покупателя. |
|
Приставка
|
Buyers.Secondary.Prefix | string |
Префикс вторичного покупателя. |
|
First
|
Buyers.Secondary.First | string |
Имя вторичного покупателя. |
|
Отчество
|
Buyers.Secondary.Middle | string |
Среднее имя вторичного покупателя. |
|
Фамилия
|
Buyers.Secondary.Last | string |
Фамилия вторичного покупателя. |
|
UsePropertyAddress
|
Buyers.UsePropertyAddress | boolean |
Следует ли использовать адрес. |
|
Адрес1
|
Buyers.Address.Address1 | string |
Номер улицы и имя. |
|
Город
|
Buyers.Address.City | string |
Имя города. |
|
Государство
|
Buyers.Address.State | string |
Сокращение состояния двух букв. |
|
Zip-архив
|
Buyers.Address.Zip | string |
ZIP-код. |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
Семейное положение партии. |
|
Адрес электронной почты
|
Buyers.Email | string |
Адрес электронной почты стороны. |
|
HomePhone
|
Buyers.HomePhone | string |
Номер домашнего телефона партии. |
|
EmailSecondary
|
Buyers.EmailSecondary | string |
Адрес электронной почты вторичной стороны. |
|
Продавцов
|
Sellers | array of object |
Сведения о продавцах. |
|
LegalEntityID
|
Sellers.LegalEntityID | integer |
Идентификационный номер юридического лица. |
|
EntityType
|
Sellers.EntityType | string |
Тип сущности. |
|
BusinessName
|
Sellers.Primary.BusinessName | string |
Название компании. |
|
UsePropertyAddress
|
Sellers.UsePropertyAddress | boolean |
Следует ли использовать адрес. |
|
Адрес1
|
Sellers.Address.Address1 | string |
Номер улицы и имя. |
|
Город
|
Sellers.Address.City | string |
Имя города. |
|
Государство
|
Sellers.Address.State | string |
Сокращение состояния двух букв. |
|
Zip-архив
|
Sellers.Address.Zip | string |
ZIP-код. |
|
MaritalStatus
|
Sellers.MaritalStatus | string |
Семейное положение партии. |
|
Адрес электронной почты
|
Sellers.Email | string |
Адрес электронной почты стороны. |
|
Customers
|
Customers | array of string |
Сведения о клиентах. |
Получение типов транзакций и продуктов для оценки и размещения заказов
Получение типов транзакций и типов продуктов для оценки сборов и размещения заказов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Государство
|
State | string |
Состояние предполагаемого расположения свойства. |
|
|
Округ
|
County | string |
Округ предполагаемого расположения имущества. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
TransactionType
|
TransactionType | string |
Тип транзакции. |
|
TransactionTypeID
|
TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
ProductType
|
ProductType | string |
Тип продукта. |
|
ProductTypeID
|
ProductTypeID | integer |
Идентификационный номер типа продукта. |
|
AncillaryProducts
|
AncillaryProducts | array of object |
Вспомогательные продукты. |
|
Имя
|
AncillaryProducts.Name | string |
Имя вспомогательного продукта. |
|
Идентификатор
|
AncillaryProducts.ID | integer |
Идентификационный номер продукта. |
|
Options
|
AncillaryProducts.Options | array of object |
Параметры. |
|
Идентификатор
|
AncillaryProducts.Options.ID | integer |
Идентификационный номер параметра. |
|
Имя
|
AncillaryProducts.Options.Name | string |
Имя параметра. |
|
AddOnProducts
|
AddOnProducts | array of object |
Добавлено на продукты. |
|
TransactionType
|
AddOnProducts.TransactionType | string |
Тип транзакции. |
|
TransactionTypeID
|
AddOnProducts.TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
ProductType
|
AddOnProducts.ProductType | string |
Тип продукта. |
|
ProductTypeID
|
AddOnProducts.ProductTypeID | integer |
Идентификационный номер типа продукта. |
Создание документа в определенном файле
Создает новый документ в указанном файле.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
Имя документа
|
DocumentName | string |
Имя документа. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
Идентификационный номер типа документа. |
|
|
Description
|
Description | string |
Описание документа. |
|
|
InternalOnly
|
InternalOnly | string |
Независимо от того, является ли документ внутренним только. |
|
|
ДокументТело
|
DocumentBody | string |
Текст документа. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
Идентификационный номер документа. |
Создание файла
Создает новый файл.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
EntityType
|
EntityType | string |
Имя типа сущности. Индивидуальный, корпоративный и т. д. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Независимо от того, является ли покупатель основным транзакцией. |
|
|
First
|
First | string |
Первое имя покупателя. |
|
|
Фамилия
|
Last | string |
Фамилия покупателя. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Следует ли использовать почтовый адрес в качестве адреса свойства нового файла. |
|
|
Адрес1
|
Address1 | string |
Номер улицы и имя. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
|
|
MaritalStatus
|
MaritalStatus | string |
Семейное состояние покупателя. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты покупателя. |
||
|
EntityType
|
EntityType | string |
Имя типа сущности. Индивидуальный, корпоративный и т. д. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Независимо от того, является ли продавец основным трансактеем. |
|
|
First
|
First | string |
Имя продавца. |
|
|
Фамилия
|
Last | string |
Фамилия продавца. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Следует ли использовать почтовый адрес в качестве адреса свойства нового файла. |
|
|
Адрес1
|
Address1 | string |
Номер улицы и имя. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
|
|
MaritalStatus
|
MaritalStatus | string |
Семейное состояние продавца. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты продавца. |
||
|
EstimatedSettlementDate
|
EstimatedSettlementDate | string |
Оценочная дата урегулирования заказа. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
Идентификационный номер типа транзакции. |
|
|
ProductTypeID
|
ProductTypeID | integer |
Идентификационный номер типа продукта. |
|
|
SalesPrice
|
SalesPrice | integer |
Цена на продажу имущества. |
|
|
ClientFileNumber
|
ClientFileNumber | string |
Номер файла клиентов. |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
Номер файла piggyback. |
|
|
MainFileNumber
|
MainFileNumber | string |
Основной номер файла. |
|
|
SourceOfBusinessID
|
SourceOfBusinessID | integer |
Источник идентификатора бизнеса. |
|
|
Замечание
|
Note | string |
Примечание, добавляемое в новый файл. |
|
|
Имя
|
Name | string |
Имя настраиваемого поля. |
|
|
Ценность
|
Value | string |
Значение настраиваемого поля |
|
|
LienPosition
|
LienPosition | integer |
Позиция лжей. |
|
|
Номер кредита
|
LoanNumber | string |
Номер кредита. |
|
|
КредитAmount
|
LoanAmount | integer |
Сумма кредита. |
|
|
LoanType
|
LoanType | string |
Тип кредита. |
|
|
IsPrimary
|
IsPrimary | boolean |
Указывает, является ли это основным адресом свойства. |
|
|
StreetNumber
|
StreetNumber | string |
Номер дома. |
|
|
StreetName
|
StreetName | string |
Имя улицы. |
|
|
Город
|
City | string |
Имя города. |
|
|
Государство
|
State | string |
Сокращение состояния двух букв. |
|
|
Округ
|
County | string |
В округе находится свойство. |
|
|
Zip-архив
|
Zip | string |
ZIP-код. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
FileID
|
FileID | integer |
Идентификационный номер нового файла. |
|
FileNumber
|
FileNumber | string |
Номер файла нового файла. |
|
Warnings
|
Warnings | array of string |
Предупреждения о новом файле. |
Удаление партнера в определенном файле
Удаляет партнера из указанного файла.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
|
|
Идентификатор партнёра
|
PartnerID | integer |
Идентификационный номер партнера. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
Идентификационный номер типа партнера. |
Возвращаемое значение
- response
- object
Удаление ранее размещенного заказа
Отменяет ранее размещенный заказ.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор файла
|
FileID | True | string |
Идентификационный номер файла. |
|
FileID
|
FileID | integer |
Идентификационный номер файла. |
Возвращаемое значение
- response
- object
Определения
объект
Это тип object.