iMIS
iMIS, специально созданная система управления взаимодействием для ассоциаций и некоммерческих организаций.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Компьютерная система инноваций, Inc. |
| URL | https://csiinc.com/support |
| Адрес электронной почты | support@csiinc.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Компьютерная система инноваций, Inc. |
| Website | https://www.csiinc.com/ |
| Политика конфиденциальности | https://www.csiinc.com/privacy |
| Категории | Данные; Продажи и CRM |
iMIS — это единственная в мире система управления взаимодействием (EMS), предназначенная для удовлетворения уникальных потребностей вашей организации и поддержки непрерывного улучшения производительности. Расширьте данные iMIS — контакты, действия, панели, IQAs и многое другое — в экосистему Power Automate и Logic Apps с триггерами и действиями, доступными в этом соединителе.
Предпосылки
Для использования этого соединителя потребуется активный экземпляр iMIS и подписка. Дополнительную информацию см. по адресу: https://csi.ms/paprerequisites.
Получение учетных данных
Для использования этого соединителя потребуется ключ API. (Примечание. Это не так же, как учетные данные API iMIS.) Инструкции по получению ключа API см. в следующих разделах: https://csi.ms/paapikey
Начало работы с соединителем
Вы можете следовать нашему простому руководству по началу работы с iMIS и Power Automate здесь: https://csi.ms/pagettingstarted
После успешного создания подключения ознакомьтесь с библиотекой идей службы автоматизации для идей по автоматизации, которые можно создать с помощью iMIS и Power Automate: http://csi.ms/paideas
Известные проблемы и ограничения
Полный список известных ограничений и текущих проблем см. в статье: https://csi.ms/palimitations
Распространенные ошибки и средства устранения неполадок
401 — не авторизовано
При возврате этого кода состояния проверьте текст отклика и найдите X-CSI-Error-Msg пользовательский заголовок. Это поможет диагностировать проблему.
Полный список распространенных действий по устранению неполадок см. в статье: https://csi.ms/palimitations
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API CSI | securestring | Введите ключ API CSI, найденный на облачной панели CSI. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Выполнение IQA |
Выполняет IQA iMIS по указанному пути. |
| Обновить организацию |
Обновляет запись контакта (организации) в iMIS. |
| Обновление действия |
Обновление записи действий в iMIS |
| Обновление записи панели с несколькими экземплярами |
Обновляет запись панели нескольких экземпляров в iMIS. |
| Обновление записи панели с одним экземпляром |
Обновите запись одной панели экземпляров в iMIS. |
| Обновление контакта |
Обновляет запись контакта (человека) в iMIS. Идентификатор iMIS необходим в тексте запроса и будет использоваться для поиска контакта для обновления. Будут обновлены только поля со значениями. Если поле остается пустым, оно не будет обновлено. |
| Обновление почтового адреса контакта |
Обновляет почтовый адрес контакта в iMIS. |
| Поиск действий |
Поиск действий по типу, идентификатору iMIS и т. д. |
| Поиск записей панели |
Находит записи панели iMIS по различным критериям. Большинство полей поиска поддерживают фильтры поиска, такие как "startsWith:x" или "contains:x". Ознакомьтесь с документацией по полному списку. |
| Поиск контактов |
Находит записи контактов iMIS по различным критериям. Большинство полей поиска поддерживают фильтры поиска, такие как "startsWith:x" или "contains:x". Ознакомьтесь с документацией по полному списку. |
| Получение адреса контакта |
Извлекает адрес контакта. |
| Получение всех адресов для контакта |
Извлекает список адресов для контакта. |
| Получение действия по последовательности |
Получение одной записи действия по значению последовательности (SEQN) |
| Получение записи панели с несколькими экземплярами |
Возвращает запись панели нескольких экземпляров в iMIS. |
| Получение записи панели с одним экземпляром |
Получает запись одной панели экземпляров в iMIS. |
| Получение контакта |
Извлекает одну запись контакта по идентификатору iMIS. |
| Получение рисунка контакта |
Извлекает изображение профиля контакта по идентификатору iMIS. |
| Создание действия |
Создание записи действия в iMIS |
| Создание записи панели с несколькими экземплярами |
Создает запись панели нескольких экземпляров в iMIS. |
| Создание контакта |
Создает запись контакта (человека) в iMIS. |
| Создание организации |
Создает запись контакта (организации) в iMIS. |
| Удаление записи панели с несколькими экземплярами |
Удаляет запись панели нескольких экземпляров в iMIS. |
| Удаление записи панели с одним экземпляром |
Удаляет запись одной панели экземпляров в iMIS. |
Выполнение IQA
Выполняет IQA iMIS по указанному пути.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Путь IQA
|
iqaPath | string |
Путь к выполняемой IQA. |
|
|
body
|
body | dynamic |
Фильтры Iqa. |
Возвращаемое значение
Обновить организацию
Обновляет запись контакта (организации) в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
id | True | string |
Идентификатор iMIS (также называется: контактный идентификатор, идентификатор стороны) |
|
Название организации
|
organizationName | string |
Имя этой организации |
|
|
URL-адрес веб-сайта
|
websiteUrl | string |
URL-адрес веб-сайта для домашней страницы этой организации |
|
|
Адрес электронной почты
|
string |
Основной адрес электронной почты организации |
||
|
Рабочий телефон
|
workPhone | string |
Рабочий номер телефона организации |
|
|
Факс
|
fax | string |
Номер факса организации |
|
|
Тип члена
|
memberType | string |
Код типа члена организации (например, NM или WEB) |
|
|
Категория выставления счетов
|
billingCategory | string |
Имя категории выставления счетов организации |
|
|
Основной ключ
|
majorKey | string |
Основное ключевое поле организации |
|
|
Состояние
|
status | string |
Код состояния организации (например, "A", "D", "X") |
Возвращаемое значение
- Тело
- ContactDTO
Обновление действия
Обновление записи действий в iMIS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды действий
|
actionCodes | string | ||
|
Тип действия
|
activityType | string | ||
|
Сумма
|
amount | double | ||
|
Последовательность вложений
|
attachSeqn | integer | ||
|
Общее количество вложений
|
attachTotal | double | ||
|
Номер пакета
|
batchNum | string | ||
|
Код кампании
|
campaignCode | string | ||
|
Категория
|
category | string | ||
|
Код co
|
coId | string | ||
|
Description
|
description | string | ||
|
Дата вступления в силу
|
effectiveDate | date | ||
|
Льготный период
|
gracePeriod | integer | ||
|
Намерение изменить
|
intentToEdit | string | ||
|
Мемориал/Дань Код
|
memTribCode | string | ||
|
Тип члена
|
memberType | string | ||
|
Дата следующей установки
|
nextInstallDate | date | ||
|
Замечание
|
note | string | ||
|
Примечание 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Код организации
|
orgCode | string | ||
|
Исходное транс-число
|
originatingTransNum | integer | ||
|
Другой код
|
otherCode | string | ||
|
Другой идентификатор
|
otherId | string | ||
|
Метод оплаты
|
payMethod | string | ||
|
Код продукта
|
productCode | string | ||
|
Количество
|
quantity | double | ||
|
Повторяющийся запрос
|
recurringRequest | boolean | ||
|
Последовательность
|
seqn | True | integer | |
|
Идентификатор адвоката
|
solicitorId | string | ||
|
Исходный код
|
sourceCode | string | ||
|
Исходная система
|
sourceSystem | string | ||
|
Код состояния
|
statusCode | string | ||
|
Налогооблагаемая стоимость
|
taxableValue | double | ||
|
Дата регулирования
|
thruDate | date | ||
|
Тиклер Дата
|
ticklerDate | date | ||
|
Дата транзакции
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Поле пользователя 1 (строка) |
|
|
UF2
|
uF2 | string |
Поле пользователя 2 (строка) |
|
|
UF3
|
uF3 | string |
Поле пользователя 3 (строка) |
|
|
UF4
|
uF4 | double |
Поле пользователя 4 (десятичное) |
|
|
UF5
|
uF5 | double |
Поле пользователя 5 (десятичное) |
|
|
UF6
|
uF6 | date |
Поле пользователя 6 (дата) |
|
|
UF7
|
uF7 | date |
Поле пользователя 7 (дата) |
|
|
Единицы
|
units | double |
Возвращаемое значение
- Тело
- ActivityDTO
Обновление записи панели с несколькими экземплярами
Обновляет запись панели нескольких экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameMultiUpdate | string |
Имя панели для обновления. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelUpdateSchema. |
Возвращаемое значение
Обновление записи панели с одним экземпляром
Обновите запись одной панели экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameSingleUpdate | string |
Имя панели для обновления. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelSchema. |
Возвращаемое значение
Обновление контакта
Обновляет запись контакта (человека) в iMIS. Идентификатор iMIS необходим в тексте запроса и будет использоваться для поиска контакта для обновления. Будут обновлены только поля со значениями. Если поле остается пустым, оно не будет обновлено.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
id | True | string |
Идентификатор iMIS (также называется: контактный идентификатор, идентификатор стороны) |
|
Префикс имени
|
namePrefix | string |
Префикс имени контакта (например, "Mrs.") |
|
|
Имя (Первое имя)
|
firstName | string |
Имя контакта |
|
|
Неофициальное имя
|
informalName | string |
Неофициальное имя контакта (или псевдоним) |
|
|
Второе имя
|
middleName | string |
По промежуточному имени контакта |
|
|
Фамилия
|
lastName | string |
Фамилия контакта |
|
|
Суффикс имени
|
nameSuffix | string |
Суффикс имени контакта (например, "младший"). |
|
|
Функциональное название
|
functionalTitle | string |
Значение функционального кода заголовка контакта |
|
|
Идентификатор родительской организации
|
parentOrganizationId | string |
Укажите идентификатор iMIS родительской организации, чтобы связать этого пользователя с |
|
|
Адрес электронной почты
|
string |
Основной адрес электронной почты контакта |
||
|
Рабочий телефон
|
workPhone | string |
Рабочий номер телефона контакта |
|
|
Домашний телефон
|
homePhone | string |
Номер домашнего телефона контакта |
|
|
Мобильный телефон
|
mobilePhone | string |
Номер мобильного телефона контакта |
|
|
Факс
|
fax | string |
Номер факса контакта |
|
|
Gender
|
gender | string |
Гендерный код контакта (например, "M", "F" или другие определенные коды) |
|
|
Тип члена
|
memberType | string |
Код типа члена контакта (например, NM или WEB) |
|
|
Категория выставления счетов
|
billingCategory | string |
Имя категории выставления счетов контакта |
|
|
Основной ключ
|
majorKey | string |
Основное ключевое поле контакта |
|
|
Состояние
|
status | string |
Код состояния контакта (например, "A", "D", "X") |
Возвращаемое значение
- Тело
- ContactDTO
Обновление почтового адреса контакта
Обновляет почтовый адрес контакта в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
id | True | string |
Идентификатор iMIS адреса для обновления |
|
Адрес 1
|
address1 | string |
Адресная строка 1 |
|
|
Адрес 2
|
address2 | string |
Строка адреса 2 |
|
|
Имя города
|
city | string |
Имя города на адресе |
|
|
Код штата или провинции
|
stateProvinceCode | string |
Сокращенный код для штата или провинции |
|
|
Почтовый индекс
|
postalCode | string |
Почтовый или ПОЧТОВЫй индекс |
|
|
Код страны
|
countryCode | string |
Сокращенный код страны |
|
|
Номер телефона
|
phone | string |
Форматированный номер телефона для этого адреса |
|
|
Электронная почта
|
string |
Электронная почта для этого адреса |
||
|
Адрес 3
|
address3 | string |
Адресная строка 3 |
|
|
номер факса;
|
fax | string |
Форматированный номер факса для этого адреса |
Возвращаемое значение
- Тело
- AddressDTO
Поиск действий
Поиск действий по типу, идентификатору iMIS и т. д.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип действия
|
activityType | string |
Код типа действия |
|
|
Идентификатор iMIS
|
imisId | string |
Идентификатор iMIS |
|
|
Код продукта
|
productCode | string |
Код продукта |
|
|
Категория
|
category | string |
Категория |
|
|
Дата транзакции включено или раньше
|
transactionDateBefore | date |
Дата транзакции в или до |
|
|
Дата транзакции после
|
transactionDateAfter | date |
Дата транзакции после |
|
|
Дата действия включено или раньше
|
effectiveDateBefore | date |
Дата вступления в силу или раньше |
|
|
Дата действия после
|
effectiveDateAfter | date |
Дата действия после |
|
|
Регулирование даты включено или раньше
|
thruDateBefore | date |
Регулирование даты до или до |
|
|
Регулирование даты после
|
thruDateAfter | date |
Дата регулирования после |
|
|
Сортировка по
|
sortBy | string |
Имя свойства для сортировки по |
|
|
Сортировка по убыванию
|
sortDesc | boolean |
Если порядок сортировки должен быть по убыванию (по умолчанию по умолчанию возрастает) |
Возвращаемое значение
- Тело
- ActivityListDTO
Поиск записей панели
Находит записи панели iMIS по различным критериям. Большинство полей поиска поддерживают фильтры поиска, такие как "startsWith:x" или "contains:x". Ознакомьтесь с документацией по полному списку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameFindPost | string |
Имя панели для запроса. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelSchema. |
Возвращаемое значение
Поиск контактов
Находит записи контактов iMIS по различным критериям. Большинство полей поиска поддерживают фильтры поиска, такие как "startsWith:x" или "contains:x". Ознакомьтесь с документацией по полному списку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя (Первое имя)
|
firstName | string |
Имя контакта (поддерживает фильтры) |
|
|
Фамилия
|
lastName | string |
Фамилия контакта (поддерживает фильтры) |
|
|
Полное имя
|
fullName | string |
Полное имя контакта (поддерживает фильтры) |
|
|
Основной адрес эл. почты
|
string |
Основной адрес электронной почты контакта (поддерживает фильтры) |
||
|
Код типа члена
|
memberType | string |
Код типа члена контакта (поддерживает фильтры) |
|
|
Название компании
|
organization | string |
Имя организации контакта (поддерживает фильтры) |
|
|
Фильтрация типов записей
|
recordType | string |
Фильтрация типов записей (людей, организаций) |
|
|
Фильтрация удаленного состояния
|
deleteType | string |
Фильтрация удаленного состояния (помеченная для удаления) |
Возвращаемое значение
- Тело
- ContactListDTO
Получение адреса контакта
Извлекает адрес контакта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
contactId | True | string |
Идентификатор iMIS для получения адреса |
|
Назначение адреса
|
addressPurpose | True | string |
Должно быть хорошо определенным именем назначения адресов в iMIS |
Возвращаемое значение
- Тело
- AddressDTO
Получение всех адресов для контакта
Извлекает список адресов для контакта.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
contactId | True | string |
Идентификатор iMIS для получения адресов |
Возвращаемое значение
- Тело
- AddressListDTO
Получение действия по последовательности
Получение одной записи действия по значению последовательности (SEQN)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Порядковый номер
|
sequenceNumber | True | integer |
Порядковый номер |
Возвращаемое значение
- Тело
- ActivityDTO
Получение записи панели с несколькими экземплярами
Возвращает запись панели нескольких экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameMultiGet | string |
Имя панели, из которого требуется получить. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelGetSchema. |
Возвращаемое значение
Получение записи панели с одним экземпляром
Получает запись одной панели экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameSingleGet | string |
Имя панели, из которого требуется получить. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelGetSchema. |
Возвращаемое значение
Получение контакта
Извлекает одну запись контакта по идентификатору iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
contactId | True | string |
Идентификатор iMIS |
Возвращаемое значение
- Тело
- ContactDTO
Получение рисунка контакта
Извлекает изображение профиля контакта по идентификатору iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор iMIS
|
contactId | True | string |
Идентификатор iMIS |
Возвращаемое значение
Представляет рисунок профиля контакта
- Тело
- ContactPictureDTO
Создание действия
Создание записи действия в iMIS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Коды действий
|
actionCodes | string | ||
|
Тип действия
|
activityType | True | string | |
|
Сумма
|
amount | double | ||
|
Последовательность вложений
|
attachSeqn | integer | ||
|
Общее количество вложений
|
attachTotal | double | ||
|
Номер пакета
|
batchNum | string | ||
|
Код кампании
|
campaignCode | string | ||
|
Категория
|
category | string | ||
|
Код co
|
coId | string | ||
|
Description
|
description | string | ||
|
Дата вступления в силу
|
effectiveDate | date | ||
|
Льготный период
|
gracePeriod | integer | ||
|
Идентификатор iMIS
|
id | True | string | |
|
Намерение изменить
|
intentToEdit | string | ||
|
Мемориал/Дань Код
|
memTribCode | string | ||
|
Тип члена
|
memberType | string | ||
|
Дата следующей установки
|
nextInstallDate | date | ||
|
Замечание
|
note | string | ||
|
Примечание 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Код организации
|
orgCode | string | ||
|
Исходное транс-число
|
originatingTransNum | integer | ||
|
Другой код
|
otherCode | string | ||
|
Другой идентификатор
|
otherId | string | ||
|
Метод оплаты
|
payMethod | string | ||
|
Код продукта
|
productCode | string | ||
|
Количество
|
quantity | double | ||
|
Повторяющийся запрос
|
recurringRequest | boolean | ||
|
Идентификатор адвоката
|
solicitorId | string | ||
|
Исходный код
|
sourceCode | string | ||
|
Исходная система
|
sourceSystem | string | ||
|
Код состояния
|
statusCode | string | ||
|
Налогооблагаемая стоимость
|
taxableValue | double | ||
|
Дата регулирования
|
thruDate | date | ||
|
Тиклер Дата
|
ticklerDate | date | ||
|
Дата транзакции
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Поле пользователя 1 (строка) |
|
|
UF2
|
uF2 | string |
Поле пользователя 2 (строка) |
|
|
UF3
|
uF3 | string |
Поле пользователя 3 (строка) |
|
|
UF4
|
uF4 | double |
Поле пользователя 4 (десятичное) |
|
|
UF5
|
uF5 | double |
Поле пользователя 5 (десятичное) |
|
|
UF6
|
uF6 | date |
Поле пользователя 6 (дата) |
|
|
UF7
|
uF7 | date |
Поле пользователя 7 (дата) |
|
|
Единицы
|
units | double |
Возвращаемое значение
- Тело
- ActivityDTO
Создание записи панели с несколькими экземплярами
Создает запись панели нескольких экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameMultiCreate | string |
Имя создаваемой панели. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelCreateSchema. |
Возвращаемое значение
Создание контакта
Создает запись контакта (человека) в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Префикс имени
|
namePrefix | string |
Префикс имени контакта (например, "Mrs.") |
|
|
Имя (Первое имя)
|
firstName | string |
Имя контакта |
|
|
Неофициальное имя
|
informalName | string |
Неофициальное имя контакта (или псевдоним) |
|
|
Второе имя
|
middleName | string |
По промежуточному имени контакта |
|
|
Фамилия
|
lastName | string |
Фамилия контакта |
|
|
Суффикс имени
|
nameSuffix | string |
Суффикс имени контакта (например, "младший"). |
|
|
Функциональное название
|
functionalTitle | string |
Значение функционального кода заголовка контакта |
|
|
Идентификатор родительской организации
|
parentOrganizationId | string |
Укажите идентификатор iMIS родительской организации, чтобы связать этого пользователя с |
|
|
Название организации
|
organizationName | string |
Имя организации, к которой принадлежит этот контакт (не используется, если задан идентификатор родительской организации) |
|
|
Адрес электронной почты
|
string |
Основной адрес электронной почты контакта |
||
|
Рабочий телефон
|
workPhone | string |
Рабочий номер телефона контакта |
|
|
Домашний телефон
|
homePhone | string |
Номер домашнего телефона контакта |
|
|
Мобильный телефон
|
mobilePhone | string |
Номер мобильного телефона контакта |
|
|
Факс
|
fax | string |
Номер факса контакта |
|
|
Gender
|
gender | string |
Гендерный код контакта (например, "M", "F" или другие определенные коды) |
|
|
Тип члена
|
memberType | string |
Код типа члена контакта (например, NM или WEB) |
|
|
Категория выставления счетов
|
billingCategory | string |
Имя категории выставления счетов контакта |
|
|
Основной ключ
|
majorKey | string |
Основное ключевое поле контакта |
|
|
Состояние
|
status | string |
Код состояния контакта (например, "A", "D", "X") |
|
|
Дата рождения
|
birthDate | date |
Дата рождения контакта |
|
|
Дата присоединения
|
joinDate | date |
Дата присоединения контакта |
Возвращаемое значение
- Тело
- ContactDTO
Создание организации
Создает запись контакта (организации) в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Название организации
|
organizationName | string |
Имя этой организации |
|
|
URL-адрес веб-сайта
|
websiteUrl | string |
URL-адрес веб-сайта для домашней страницы этой организации |
|
|
Адрес электронной почты
|
string |
Основной адрес электронной почты организации |
||
|
Рабочий телефон
|
workPhone | string |
Рабочий номер телефона организации |
|
|
Факс
|
fax | string |
Номер факса организации |
|
|
Тип члена
|
memberType | string |
Код типа члена организации (например, NM или WEB) |
|
|
Категория выставления счетов
|
billingCategory | string |
Имя категории выставления счетов организации |
|
|
Основной ключ
|
majorKey | string |
Основное ключевое поле организации |
|
|
Состояние
|
status | string |
Код состояния организации (например, "A", "D", "X") |
|
|
Дата присоединения
|
joinDate | date |
Дата присоединения организации |
Возвращаемое значение
- Тело
- ContactDTO
Удаление записи панели с несколькими экземплярами
Удаляет запись панели нескольких экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameMultiDelete | string |
Имя панели для удаления. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelDeleteSchema. |
Удаление записи панели с одним экземпляром
Удаляет запись одной панели экземпляров в iMIS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя панели
|
panelNameSingleDelete | string |
Имя панели для удаления. |
|
|
body
|
body | dynamic |
Схема, созданная GetPanelDeleteSchema. |
Триггеры
| При добавлении действия |
При добавлении действия |
| При добавлении заказа |
При добавлении заказа |
При добавлении действия
При добавлении заказа
Определения
ActivityDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Коды действий
|
actionCodes | string | |
|
Тип действия
|
activityType | string | |
|
Сумма
|
amount | double | |
|
Последовательность вложений
|
attachSeqn | integer | |
|
Общее количество вложений
|
attachTotal | double | |
|
Номер пакета
|
batchNum | string | |
|
Код кампании
|
campaignCode | string | |
|
Категория
|
category | string | |
|
Код co
|
coId | string | |
|
Description
|
description | string | |
|
Дата вступления в силу
|
effectiveDate | date | |
|
Льготный период
|
gracePeriod | integer | |
|
Идентификатор iMIS
|
id | string | |
|
Намерение изменить
|
intentToEdit | string | |
|
Мемориал/Дань Код
|
memTribCode | string | |
|
Тип члена
|
memberType | string | |
|
Дата следующей установки
|
nextInstallDate | date | |
|
Замечание
|
note | string | |
|
Примечание 2
|
note2 | string | |
|
Object
|
object | string | |
|
Код организации
|
orgCode | string | |
|
Исходное транс-число
|
originatingTransNum | integer | |
|
Другой код
|
otherCode | string | |
|
Другой идентификатор
|
otherId | string | |
|
Метод оплаты
|
payMethod | string | |
|
Код продукта
|
productCode | string | |
|
Количество
|
quantity | double | |
|
Повторяющийся запрос
|
recurringRequest | boolean | |
|
Идентификатор адвоката
|
solicitorId | string | |
|
Исходный код
|
sourceCode | string | |
|
Исходная система
|
sourceSystem | string | |
|
Код состояния
|
statusCode | string | |
|
Налогооблагаемая стоимость
|
taxableValue | double | |
|
Дата регулирования
|
thruDate | date | |
|
Тиклер Дата
|
ticklerDate | date | |
|
Дата транзакции
|
transactionDate | date | |
|
UF1
|
uF1 | string |
Поле пользователя 1 (строка) |
|
UF2
|
uF2 | string |
Поле пользователя 2 (строка) |
|
UF3
|
uF3 | string |
Поле пользователя 3 (строка) |
|
UF4
|
uF4 | double |
Поле пользователя 4 (десятичное) |
|
UF5
|
uF5 | double |
Поле пользователя 5 (десятичное) |
|
UF6
|
uF6 | date |
Поле пользователя 6 (дата) |
|
UF7
|
uF7 | date |
Поле пользователя 7 (дата) |
|
Единицы
|
units | double | |
|
Последовательность
|
seqn | integer |
Значение последовательности действия (первичный ключ) |
ActivityListDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список действий
|
value | array of ActivityDTO |
Список записей действий |
AddressDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор адреса
|
addressId | string |
Уникальный идентификатор для этой записи адреса. |
|
Линии адресов
|
addressLines | string |
Линии улицы, разделенные новой линией. |
|
Имя города
|
city | string |
Имя города на адресе. |
|
Код штата или провинции
|
stateProvinceCode | string |
Сокращенный код для штата или провинции. |
|
Почтовый индекс
|
postalCode | string |
Почтовый или ПОЧТОВЫй индекс. |
|
Код страны
|
countryCode | string |
Сокращенный код страны. |
|
Номер телефона
|
phone | string |
Отформатированный номер телефона для этого адреса. |
|
Электронная почта
|
string |
Электронная почта для этого адреса. |
|
|
Полный адрес
|
fullAddress | string |
Полный вычисляемый адрес с новыми линиями. |
|
Имя и полный адрес
|
nameAndFullAddress | string |
Полный вычисляемый адрес с именем контакта в первой строке. |
|
Назначение адреса
|
addressPurpose | string |
Имя назначения адреса (категории). |
|
Список предпочтений связи
|
communicationPreferences | array of string |
Список типов предпочтений связи. |
AddressListDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список адресов
|
addresses | array of AddressDTO |
Список адресов для указанного контакта |
ContactDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип контакта
|
contactType | string |
Тип контакта (организация или лицо) |
|
Идентификатор iMIS
|
id | string |
Идентификатор iMIS (также называется: контактный идентификатор, идентификатор стороны) |
|
Имя
|
name | string |
Полное имя вычисленного пользователя или имя организации контакта |
|
Префикс имени
|
namePrefix | string |
Префикс имени контакта (например, "Mrs.") |
|
Имя (Первое имя)
|
firstName | string |
Имя контакта |
|
Неофициальное имя
|
informalName | string |
Неофициальное имя контакта (или псевдоним) |
|
Второе имя
|
middleName | string |
По промежуточному имени контакта |
|
Фамилия
|
lastName | string |
Фамилия контакта |
|
Суффикс имени
|
nameSuffix | string |
Суффикс имени контакта (например, "младший"). |
|
Функциональное название
|
functionalTitle | string |
Функциональное название контакта, включая любые обозначения |
|
Является членом
|
isMember | boolean |
Флаг, указывающий, является ли этот контакт членом организации. |
|
Активен
|
isActive | boolean |
Флаг, указывающий, помечен ли этот контакт как активный (т. е. не помечен для удаления, умершего и т. д.) |
|
Название организации
|
organizationName | string |
Имя организации, к которой принадлежит этот контакт |
|
Идентификатор организации
|
organizationId | string |
Для типов пользователей указывает идентификатор родительской организации, связанный |
|
Адрес электронной почты
|
string |
Основной адрес электронной почты контакта |
|
|
Рабочий телефон
|
workPhone | string |
Рабочий номер телефона контакта |
|
Домашний телефон
|
homePhone | string |
Номер домашнего телефона контакта |
|
Мобильный телефон
|
mobilePhone | string |
Номер мобильного телефона контакта |
|
Факс
|
fax | string |
Номер факса контакта |
|
Gender
|
gender | string |
Гендерный код контакта (например, "M", "F" или другие определенные коды) |
|
Тип члена
|
memberType | string |
Код типа члена контакта (например, NM или WEB) |
|
Категория выставления счетов
|
billingCategory | string |
Имя категории выставления счетов контакта |
|
Основной ключ
|
majorKey | string |
Основное ключевое поле контакта |
|
Состояние
|
status | string |
Код состояния контакта (например, "A", "D", "X") |
|
Ключ контакта
|
contactKey | string |
Ключ контакта, иногда называемый "Net ID" (Guid) |
|
Дата рождения
|
birthDate | date |
Дата рождения контакта |
|
Дата присоединения
|
joinDate | date |
Дата присоединения контакта |
|
Платный регулирование
|
paidThruDate | date |
Дата оплаты членства контакта (если член) |
|
Продленный регулирование
|
renewedThruDate | date |
Продленная дата контакта |
ContactListDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список контактов
|
value | array of ContactDTO |
Список записей контактов |
ContactPictureDTO
Представляет рисунок профиля контакта
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор iMIS
|
id | string |
Идентификатор iMIS, связанный с этим рисунком |
|
Данные рисунка
|
pictureData | byte |
Данные рисунка |
OrderDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отправка в адресную строку 1
|
address1 | string | |
|
Отправка в адресную строку 2
|
address2 | string | |
|
Отправка в адресную строку 3
|
address3 | string | |
|
Отправка в адресный код формата
|
addressFormat | integer | |
|
Сумма баланса
|
balance | double | |
|
Номер пакета
|
batchNumber | string | |
|
Выставление счета к идентификатору iMIS
|
billToId | string | |
|
Отправка в адрес города
|
city | string | |
|
Идентификатор iMIS компании
|
companyId | string | |
|
Тип участника компании
|
companyMemberType | string | |
|
Название компании
|
company | string | |
|
Код сортировки компании
|
companySort | string | |
|
Отправка в адрес страны
|
country | string | |
|
Справочник по клиенту
|
customerReference | string | |
|
Отправка по адресу электронной почты
|
string | ||
|
Сумма грузовых грузов 1
|
freight1 | double | |
|
Объем грузов 2
|
freight2 | double | |
|
Отправка на полный адрес
|
fullAddress | string | |
|
Отправка в полное имя
|
fullName | string | |
|
Обработка 1 суммы
|
handling1 | double | |
|
Обработка 2 суммы
|
handling2 | double | |
|
Удержание кода
|
holdCode | string | |
|
Удержание комментария
|
holdComment | string | |
|
Проводится?
|
holdFlag | boolean | |
|
Справочный номер счета
|
invoiceReferenceNumber | integer | |
|
Отправка в тип члена
|
memberType | string | |
|
Заметки о заказе
|
notes | string | |
|
Дата заказа
|
orderDate | date | |
|
Номер заказа
|
orderNumber | double | |
|
Код типа заказа
|
orderTypeCode | string | |
|
Код сущности
|
entityCode | string | |
|
Тип оплаты
|
payType | string | |
|
Отправка по телефону
|
phone | string | |
|
Исходный код
|
sourceCode | string | |
|
Отправка в идентификатор iMIS
|
shipToId | string | |
|
Этап заказа
|
stage | string | |
|
Отправка в штат или провинцию
|
stateProvince | string | |
|
Состояние заказа
|
status | string | |
|
Сумма налога 1
|
tax1 | double | |
|
Сумма налога 2
|
tax2 | double | |
|
Сумма налога 3
|
tax3 | double | |
|
Налог 1 Ставка
|
taxRate1 | double | |
|
Ставка налога 2
|
taxRate2 | double | |
|
Ставка налога 3
|
taxRate3 | double | |
|
Название заказа
|
title | string | |
|
Общий сбор заказов
|
totalCharges | double | |
|
Сумма платежей заказа
|
totalPayments | double | |
|
Общее количество отсортированных
|
totalQuantityBackordered | integer | |
|
Общее количество упорядоченных
|
totalQuantityOrdered | integer | |
|
Отправка в почтовый индекс
|
zip | string | |
|
Исходная система
|
sourceSystem | string | |
|
Код скидки
|
discountCode | string | |
|
Налоговый код НДС
|
vatTaxCodeFh | string | |
|
Нерасчитаемый итог
|
undiscountedTotal | double | |
|
Код терминов
|
termsCode | string | |
|
Налоговая ставка
|
taxRateFh | double | |
|
Автор налога 1
|
taxAuthor1 | string | |
|
Автор налога 2
|
taxAuthor2 | string | |
|
Автор налога 3
|
taxAuthor3 | string | |
|
Освобождение от налога
|
taxExempt | string | |
|
Влияет на инвентаризацию?
|
affectInventory | boolean | |
|
Сумма налога на груз
|
freightTax | double | |
|
Обработка налоговой суммы
|
handlingTax | double | |
|
Дата счета
|
invoiceDate | date | |
|
Номер счета
|
invoiceNumber | integer | |
|
Общая сумма строки
|
lineTotal | double | |
|
Метод доставки
|
shipMethod | string | |
|
Дата отправки документов
|
shipPapersDateTime | date | |
|
Дата доставки
|
shippedDateTime | date | |
|
Общий вес
|
totalWeight | double | |
|
Введено
|
enteredBy | string | |
|
Введенная дата и время
|
enteredDateTime | date |
OrderListDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список заказов
|
value | array of OrderDTO |
Список записей заказа |