Поделиться через

Impower ERP (предварительная версия)

Разрешить взаимодействие с системой учета impower.de для руководителей свойств

Этот соединитель доступен в следующих продуктах и регионах:

Услуга 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)
Контакт
Имя Поддержка API
URL https://impower.de
Адрес электронной почты support+api@impower.de
Метаданные соединителя
Publisher Impower GmbH
Веб-сайт https://www.impower.de
Политика конфиденциальности https://www.impower.de/datenschutzerklaerung
Категории Управление бизнесом; Финансировать

Соединитель Impower позволяет получить доступ к набору masterdataset, таким как свойства, единицы, контракты и контакты. Кроме того, вы можете отправлять документы и счета. Можно считывать данные по расписанию или регистрировать веб-перехватчики с помощью встроенного триггера.

Предпосылки

Чтобы использовать Impower, вам потребуется:

  1. Платная подписка Impower
  2. Подписка PowerAutomate Premium

Получение учетных данных

Чтобы получить APIKey для вашего домена, чтобы подключить powerautomate к нему, напишите запрос.support@impower.de

Начало работы с соединителем

Сценарии, которые можно использовать для создания:

  1. Просмотрите папку Sharepoint или Onedrive для изменений, и если новые PDF-файлы отображаются для отправки их в impower
  2. Синхронизация списка контактов с адресной книгой команд

Известные проблемы и ограничения

Скачивание и отправка файлов

Файлы отправляются в виде многопартийных данных формы в двоичном формате. То же самое относится к скачиванию: файлы предоставляются так же, как и с предлагаемым именем файла в заголовке - так же, как в стандарте HTTP

Ratelimiting

Пожалуйста, не старайтесь делать более 5000 запросов в минуту. Мы налагаем частоту на API, чтобы гарантировать, что система может быстро обслуживать пользователей.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
API-Key securestring API-Key для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

(Устаревшая версия) Отправка счета

Отправьте PDF-файл в Impower с помощью устаревшего API. Используйте вместо этого операцию uploadInvoiceUsingPOST.
Обновление подключения

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

Все необходимые сведения содержатся в тексте запроса
Обновление существующего тега документа на основе заданного идентификатора

Обновленный тег документа будет возвращен как ответ
Обновление счета на основе предоставленных полей

Обновление счета
Обновление текста резервирования заданного элемента резервирования счета

Обновление текста резервирования
Отправка PDF-документа счета

По умолчанию документ будет проходить хотя анализ OCR
Получение всех единиц по заданным параметрам фильтра

Возвращает все единицы, уважающие заданные критерии фильтра.
Получение всех предопределенных значений кода ошибки

Возвращает список всех предопределенных кодов ошибок
Получение документов по заданным параметрам фильтра

Получение документов с помощью заданных параметров фильтра
Получение единицы по заданному идентификатору

Возвращает единицу с заданным идентификатором
Получение контакта по указанному идентификатору

Извлекает контакт по указанному идентификатору
Получение контактов по заданным параметрам фильтра

Получение контактов заданными параметрами фильтра
Получение контракта по указанному идентификатору

Извлекает контракт по указанному идентификатору
Получение контрактов заданными параметрами фильтра

Получение контрактов заданными параметрами фильтра
Получение сведений о конкретном коде ошибки

Извлекает описание определенного кода ошибки
Получение свойств заданными параметрами фильтра

Получение свойств заданными параметрами фильтра
Получение свойства по заданному идентификатору

Извлекает свойство по заданному идентификатору
Получение счета по указанному идентификатору

Извлекает счет по указанному идентификатору
Получение счетов по заданным параметрам фильтра

Извлекает счета по заданным параметрам фильтра
Получение тегов документов

Теги документов категории "Стандартный" и "Домен" будут возвращены в виде ответа
Скачивание нескольких документов с учетом условий фильтра

Документы приходят в zip-формате
Скачивание одного документа по заданному идентификатору

Формат документа определяется миметипом
Создание документа на основе заданного файла

Только что созданный документ будет возвращен в качестве ответа
Создание тега документа

Созданный тег документа будет возвращен в качестве ответа.
Удаление подключения

Удаление подключения
Удаление существующего документа на основе заданного идентификатора

Не удается удалить созданные системой документы
Удаление существующего тега документа на основе заданного идентификатора

Не удается удалить созданные системой теги
Устаревшие сведения о счете

Получение сведений о счете из Impower с помощью устаревшего API. Вместо этого используйте getInvoiceByIdUsingGET.
Чтение подключения

Чтение подключения

(Устаревшая версия) Отправка счета

Идентификатор операции:
UploadInvoice

Отправьте PDF-файл в Impower с помощью устаревшего API. Используйте вместо этого операцию uploadInvoiceUsingPOST.

Параметры

Имя Ключ Обязательно Тип Описание
Указание pdf-файла для отправки
 file True file

Указание pdf-файла для отправки

Возвращаемое значение

LegacyInvoiceDto
LegacyInvoiceDto

Обновление подключения

Идентификатор операции:
updateConnectionUsingPUT

Обновление подключения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подключения
 connectionIdX True integer

Идентификатор подключения
Имя соединения, как оно должно быть представлено в пользовательском интерфейсе. Если оно не указано, по умолчанию будет указано имя приложения.
name string

Имя соединения, как оно должно быть представлено в пользовательском интерфейсе. Если оно не указано, по умолчанию будет указано имя приложения.
URL-адрес будет вызываться с маркером авторизации, который можно проверить, и следующий текст: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
 webhookUrl string

URL-адрес будет вызываться с маркером авторизации, который можно проверить, и следующий текст: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

Возвращаемое значение

Данные, описывающие существующее подключение

ConnectionDto
ConnectionDto

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

Идентификатор операции:
updateDocumentsUsingPUT

Все необходимые сведения содержатся в тексте запроса

Параметры

Имя Ключ Обязательно Тип Описание
Новое значение суммы документа для обновления до
 amount float

Новое значение суммы документа для обновления до
Новое здание здания, которому будет назначен документ.
 buildingId integer

Новое здание здания, которому будет назначен документ.
Новый контакт, которому нужно назначить документ
 contactId integer

Новый контакт, которому нужно назначить документ
Новый контракт, которому будет назначен документ
 contractId integer

Новый контракт, которому будет назначен документ
Уникальный идентификатор обновляемого документа
 id True integer

Уникальный идентификатор обновляемого документа
Новая дата обновления документа
 issuedDate string

Новая дата обновления документа
Новое значение имени документа для обновления до
 name string

Новое значение имени документа для обновления до
Новое свойство, которому необходимо назначить документ
 propertyId integer

Новое свойство, которому необходимо назначить документ
Новый идентификатор исходного процесса, которому необходимо назначить документ
 sourceId integer

Новый идентификатор исходного процесса, которому необходимо назначить документ
Идентификаторы тегов, назначенных документу
 tagIds array of integer

Идентификаторы тегов, назначенных документу
Новое подразделение, назначаемое документу
 unitId integer

Новое подразделение, назначаемое документу

Возвращаемое значение

response
array of DocumentDto

Обновление существующего тега документа на основе заданного идентификатора

Идентификатор операции:
updateDocumentTagUsingPUT

Обновленный тег документа будет возвращен как ответ

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор тега документа
 tagId True integer

Уникальный идентификатор тега документа
Новое описание тега документа.
 description string

Новое описание тега документа.
Новое имя тега документа.
 name string

Новое имя тега документа.

Возвращаемое значение

Класс модели тега документа.

DocumentTagDto
DocumentTagDto

Обновление счета на основе предоставленных полей

Идентификатор операции:
updateInvoiceUsingPUT

Обновление счета

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор счета
 invoiceId True integer

Уникальный идентификатор счета
Новая дата выдачи счета.
 issuedDate string

Новая дата выдачи счета.
Новое имя счета.
 name string

Новое имя счета.

Возвращаемое значение

Структура данных счета.

InvoiceDto
InvoiceDto

Обновление текста резервирования заданного элемента резервирования счета

Идентификатор операции:
updateInvoiceItemUsingPUT

Обновление текста резервирования

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор элемента резервирования счета
 invoiceItemId True integer

Уникальный идентификатор элемента резервирования счета
Текст резервирования элемента счета.
 bookingText string

Текст резервирования элемента счета.

Возвращаемое значение

InvoiceItemDto
InvoiceItemDto

Отправка PDF-документа счета

Идентификатор операции:
uploadInvoiceUsingPOST

По умолчанию документ будет проходить хотя анализ OCR

Параметры

Имя Ключ Обязательно Тип Описание
PDF-файл счета
 file True file

PDF-файл счета

Возвращаемое значение

Структура данных счета.

InvoiceDto
InvoiceDto

Получение всех единиц по заданным параметрам фильтра

Идентификатор операции:
getUnitsByFilterUsingGET

Возвращает все единицы, уважающие заданные критерии фильтра.

Параметры

Имя Ключ Обязательно Тип Описание
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Уникальный идентификатор свойства, к которому принадлежит единица
 propertyId integer

Уникальный идентификатор свойства, к которому принадлежит единица
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

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

Возвращаемое значение

PageOfUnitDto
PageOfUnitDto

Получение всех предопределенных значений кода ошибки

Идентификатор операции:
errorCodesUsingGET

Возвращает список всех предопределенных кодов ошибок

Возвращаемое значение

Имя Путь Тип Описание
array of string

Получение документов по заданным параметрам фильтра

Идентификатор операции:
getDocumentsByFilterUsingGET

Получение документов с помощью заданных параметров фильтра

Параметры

Имя Ключ Обязательно Тип Описание
Имя бухгалтера свойства.
 accountant string

Имя бухгалтера свойства.
Имя администратора свойства.
 administrator string

Имя администратора свойства.
Идентификатор сущности контакта, к которой принадлежит документ.
 contactId integer

Идентификатор сущности контакта, к которой принадлежит документ.
Документы, связанные с контрактами с аналогичным именем.
 contractName string

Документы, связанные с контрактами с аналогичным именем.
Идентификаторы возвращаемых документов.
 documentIds array

Идентификаторы возвращаемых документов.
Имя возвращаемых документов.
 documentName string

Имя возвращаемых документов.
Дата выдачи документа.
 issuedDate string

Дата выдачи документа.
Документы, выданные ранее.
 maxIssuedDate string

Документы, выданные ранее.
Документы, выдаваемые после.
 minIssuedDate string

Документы, выдаваемые после.
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Удобочитаемый идентификатор свойства, к которому принадлежит документ.
 propertyHrId string

Удобочитаемый идентификатор свойства, к которому принадлежит документ.
Идентификатор свойства, к которому принадлежит документ.
 propertyId integer

Идентификатор свойства, к которому принадлежит документ.
Имя свойства, к которому принадлежит документ.
 propertyName string

Имя свойства, к которому принадлежит документ.
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

Параметр сортировки
Идентификатор исходной сущности, к которой принадлежит документ.
 sourceId integer

Идентификатор исходной сущности, к которой принадлежит документ.
Исходные типы документа.
 sourceType array

Исходные типы документа.
Идентификаторы тегов, с которые связан документ.
 tagIds array

Идентификаторы тегов, с которые связан документ.
Аналогичное имя тега, с которым связан документ.
 tagName string

Аналогичное имя тега, с которым связан документ.
Идентификатор сущности единицы, к которой принадлежит документ.
 unitId integer

Идентификатор сущности единицы, к которой принадлежит документ.

Возвращаемое значение

PageOfDocumentDto
PageOfDocumentDto

Получение единицы по заданному идентификатору

Идентификатор операции:
getUnitByIdUsingGET

Возвращает единицу с заданным идентификатором

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор единицы
 unitId True integer

Уникальный идентификатор единицы

Возвращаемое значение

Структура данных единиц.

UnitDto
UnitDto

Получение контакта по указанному идентификатору

Идентификатор операции:
getContactByIdUsingGET

Извлекает контакт по указанному идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор контакта
 contactId True integer

Уникальный идентификатор контакта

Возвращаемое значение

Контакт представляет физическое лицо или юридическое лицо, а также способ связаться с ними. Должен ли удостоверение или компания иметь несколько почтовых адресов, с помощью которых он может быть контактирован. Они представлены как 2 разных контакта.

ContactDto
ContactDto

Получение контактов по заданным параметрам фильтра

Идентификатор операции:
getContactsByFilterUsingGET

Получение контактов заданными параметрами фильтра

Параметры

Имя Ключ Обязательно Тип Описание
Список идентификаторов контактов для фильтрации контактов по.
 contactIds array

Список идентификаторов контактов для фильтрации контактов по.
Адрес электронной почты контакта.
 email string

Адрес электронной почты контакта.
Любое имя контакта. Может быть первым именем, фамилией или именем компании.
 name string

Любое имя контакта. Может быть первым именем, фамилией или именем компании.
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

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

Возвращаемое значение

PageOfContactDto
PageOfContactDto

Получение контракта по указанному идентификатору

Идентификатор операции:
getContractByIdUsingGET

Извлекает контракт по указанному идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор контракта
 contractId True integer

Уникальный идентификатор контракта

Возвращаемое значение

Структура данных контракта.

ContractDto
ContractDto

Получение контрактов заданными параметрами фильтра

Идентификатор операции:
getContractsByFilterUsingGET

Получение контрактов заданными параметрами фильтра

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор экземпляра контакта, с которым связан контракт.
 contactId integer

Идентификатор экземпляра контакта, с которым связан контракт.
Список идентификаторов контракта для фильтрации контрактов по.
 contractIds array

Список идентификаторов контракта для фильтрации контрактов по.
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Идентификатор экземпляра свойства, к которому принадлежит контракт.
 propertyId integer

Идентификатор экземпляра свойства, к которому принадлежит контракт.
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

Параметр сортировки
Тип контракта. Параметры: OWNER | TENANT | PROPERTY_OWNER
 type array

Тип контракта. Параметры: OWNER | TENANT | PROPERTY_OWNER
Идентификатор экземпляра единицы, с которым связан контракт.
 unitId integer

Идентификатор экземпляра единицы, с которым связан контракт.
Возвращает допустимые контракты на дату. Значение NULL интерпретируется как начало и конец времени.
 validAtDate string

Возвращает допустимые контракты на дату. Значение NULL интерпретируется как начало и конец времени.

Возвращаемое значение

PageOfContractDto
PageOfContractDto

Получение сведений о конкретном коде ошибки

Идентификатор операции:
errorCodeUsingGET

Извлекает описание определенного кода ошибки

Параметры

Имя Ключ Обязательно Тип Описание
value
 value True string

value

Возвращаемое значение

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Получение свойств заданными параметрами фильтра

Идентификатор операции:
getPropertiesByFilterUsingGET

Получение свойств заданными параметрами фильтра

Параметры

Имя Ключ Обязательно Тип Описание
Имя свойства.
 name string

Имя свойства.
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Удобочитаемый человеком идентификатор свойства.
 propertyHrId string

Удобочитаемый человеком идентификатор свойства.
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

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

Возвращаемое значение

PageOfPropertyDto
PageOfPropertyDto

Получение свойства по заданному идентификатору

Идентификатор операции:
getPropertyByIdUsingGET

Извлекает свойство по заданному идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор свойства
 propertyId True integer

Уникальный идентификатор свойства

Возвращаемое значение

Структура данных свойств.

PropertyDto
PropertyDto

Получение счета по указанному идентификатору

Идентификатор операции:
getInvoiceByIdUsingGET

Извлекает счет по указанному идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор счета
 invoiceId True integer

Уникальный идентификатор счета

Возвращаемое значение

Структура данных счета.

InvoiceDto
InvoiceDto

Получение счетов по заданным параметрам фильтра

Идентификатор операции:
getInvoicesByFilterUsingGET

Извлекает счета по заданным параметрам фильтра

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор контакта-аналога
 counterpartContactId integer

Уникальный идентификатор контакта-аналога
Дата получения счетов
 issuedDate string

Дата получения счетов
Направление сортировки. Возможные значения: ASC, DESC
 order string

Направление сортировки. Возможные значения: ASC, DESC
Возвращаемый номер страницы
 page integer

Возвращаемый номер страницы
Уникальный идентификатор свойства, к которому принадлежит счет
 propertyId integer

Уникальный идентификатор свойства, к которому принадлежит счет
Количество возвращаемых элементов на одной странице
 size integer

Количество возвращаемых элементов на одной странице
Параметр сортировки
 sort string

Параметр сортировки
Состояния полученных счетов
 states array

Состояния полученных счетов

Возвращаемое значение

PageOfInvoiceDto
PageOfInvoiceDto

Получение тегов документов

Идентификатор операции:
getDocumentTagsUsingGET

Теги документов категории "Стандартный" и "Домен" будут возвращены в виде ответа

Параметры

Имя Ключ Обязательно Тип Описание
Строка поиска, примененная к имени и описанию
 description string

Строка поиска, примененная к имени и описанию

Возвращаемое значение

response
array of DocumentTagDto

Скачивание нескольких документов с учетом условий фильтра

Идентификатор операции:
downloadDocumentsByFilterUsingGET

Документы приходят в zip-формате

Параметры

Имя Ключ Обязательно Тип Описание
Имя бухгалтера свойства.
 accountant string

Имя бухгалтера свойства.
Имя администратора свойства.
 administrator string

Имя администратора свойства.
Идентификатор сущности контакта, к которой принадлежит документ.
 contactId integer

Идентификатор сущности контакта, к которой принадлежит документ.
Документы, связанные с контрактами с аналогичным именем.
 contractName string

Документы, связанные с контрактами с аналогичным именем.
Идентификаторы возвращаемых документов.
 documentIds array

Идентификаторы возвращаемых документов.
Имя возвращаемых документов.
 documentName string

Имя возвращаемых документов.
Дата выдачи документа.
 issuedDate string

Дата выдачи документа.
Документы, выданные ранее.
 maxIssuedDate string

Документы, выданные ранее.
Документы, выдаваемые после.
 minIssuedDate string

Документы, выдаваемые после.
Удобочитаемый идентификатор свойства, к которому принадлежит документ.
 propertyHrId string

Удобочитаемый идентификатор свойства, к которому принадлежит документ.
Идентификатор свойства, к которому принадлежит документ.
 propertyId integer

Идентификатор свойства, к которому принадлежит документ.
Имя свойства, к которому принадлежит документ.
 propertyName string

Имя свойства, к которому принадлежит документ.
Идентификатор исходной сущности, к которой принадлежит документ.
 sourceId integer

Идентификатор исходной сущности, к которой принадлежит документ.
Исходные типы документа.
 sourceType array

Исходные типы документа.
Идентификаторы тегов, с которые связан документ.
 tagIds array

Идентификаторы тегов, с которые связан документ.
Аналогичное имя тега, с которым связан документ.
 tagName string

Аналогичное имя тега, с которым связан документ.
Идентификатор сущности единицы, к которой принадлежит документ.
 unitId integer

Идентификатор сущности единицы, к которой принадлежит документ.

Возвращаемое значение

response
file

Скачивание одного документа по заданному идентификатору

Идентификатор операции:
downloadUsingGET

Формат документа определяется миметипом

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор документа
 documentId True integer

Уникальный идентификатор документа

Возвращаемое значение

response
file

Создание документа на основе заданного файла

Идентификатор операции:
createDocumentByUploadUsingPOST

Только что созданный документ будет возвращен в качестве ответа

Параметры

Имя Ключ Обязательно Тип Описание
PDF-файл для отправки
 file True file

PDF-файл для отправки

Возвращаемое значение

Структура данных документа.

DocumentDto
DocumentDto

Создание тега документа

Идентификатор операции:
createDocumentTagUsingPOST

Созданный тег документа будет возвращен в качестве ответа.

Параметры

Имя Ключ Обязательно Тип Описание
Описание только что созданного тега документа.
 description string

Описание только что созданного тега документа.
Имя только что созданного тега документа.
 name string

Имя только что созданного тега документа.

Возвращаемое значение

Класс модели тега документа.

DocumentTagDto
DocumentTagDto

Удаление подключения

Идентификатор операции:
deleteConnectionUsingDELETE

Удаление подключения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подключения
 connectionIdX True integer

Идентификатор подключения

Удаление существующего документа на основе заданного идентификатора

Идентификатор операции:
deleteDocumentUsingDELETE

Не удается удалить созданные системой документы

Параметры

Имя Ключ Обязательно Тип Описание
documentId
 documentId True integer

documentId

Удаление существующего тега документа на основе заданного идентификатора

Идентификатор операции:
deleteDocumentTagUsingDELETE

Не удается удалить созданные системой теги

Параметры

Имя Ключ Обязательно Тип Описание
Уникальный идентификатор тега документа, который необходимо удалить
 tagId True integer

Уникальный идентификатор тега документа, который необходимо удалить

Устаревшие сведения о счете

Идентификатор операции:
GetInvoice

Получение сведений о счете из Impower с помощью устаревшего API. Вместо этого используйте getInvoiceByIdUsingGET.

Параметры

Имя Ключ Обязательно Тип Описание
Номер счета
 invoiceId True integer

Укажите идентификатор счета для получения сведений

Возвращаемое значение

LegacyInvoiceDto
LegacyInvoiceDto

Чтение подключения

Идентификатор операции:
getConnectionUsingGET

Чтение подключения

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подключения
 connectionIdX True integer

Идентификатор подключения

Возвращаемое значение

Данные, описывающие существующее подключение

ConnectionDto
ConnectionDto

Триггеры

Создание подключения к приложению

Создание подключения к приложению

Создание подключения к приложению

Идентификатор операции:
createConnectionUsingPOST

Создание подключения к приложению

Возвращаемое значение

Тело
ConnectionNotificationDto

Определения

ConnectionNotificationDto

Имя Путь Тип Описание
Идентификатор подключения, к который применяется уведомление
 connectionId integer

connectionId
entityType
 entityType string

entityType
entityId
 entityId integer

entityId
eventType
 eventType string

eventType

ConnectionDto

Данные, описывающие существующее подключение

Имя Путь Тип Описание
Идентификатор приложения
 appId integer

Идентификатор приложения
Имя приложения подключения
 appName string

Имя приложения подключения
Время создания сущности.
 created string

Время создания сущности.
Идентификатор сущности.
 id integer

Идентификатор сущности.
Имя подключения
 name string

Имя подключения
Время последнего обновления сущности.
 updated string

Время последнего обновления сущности.
Веб-перехватчик подключения, который будет называться как "'" POST https://your.webhook.url/path/somewhere Authorization: Bearer TOKEN { connectionId: 0, EntityType: "properties|contacts|invoices|etc.", "entityId": 0, eventType: "CREATE|UPDATE|DELETE" }''
 webhookUrl string

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

POST https://your.webhook.url/path/somewhere
Authorization: Bearer TOKEN

{
  "connectionId": 0,
  "entityType": "properties|contacts|invoices|etc.",
  "entityId": 0,
  "eventType": "CREATE|UPDATE|DELETE"
}```

ContactDetailsDto

Сведения о контакте

Имя Путь Тип Описание
Бизнес-телефонный номер контакта
 businessPhoneNumber array of string

Бизнес-телефонный номер контакта
Дата рождения контакта.
 dateOfBirth string

Дата рождения контакта.
Адрес электронной почты контакта
 email array of string

Адрес электронной почты контакта
Номер факса контакта
 fax array of string

Номер факса контакта
Номер мобильного телефона контакта
 mobilePhoneNumber array of string

Номер мобильного телефона контакта
Частный телефонный номер контакта
 privatePhoneNumber array of string

Частный телефонный номер контакта
Номер торгового регистра.
 tradeRegisterNumber string

Номер торгового регистра.
Идентификатор НДС контакта.
 vatId string

Идентификатор НДС контакта.
Веб-сайт контакта
 website array of string

Веб-сайт контакта

ContactDto

Контакт представляет физическое лицо или юридическое лицо, а также способ связаться с ними. Должен ли удостоверение или компания иметь несколько почтовых адресов, с помощью которых он может быть контактирован. Они представлены как 2 разных контакта.

Имя Путь Тип Описание
Имя города.
 city string

Имя города.
Имя компании, если контакт является компанией.
 companyName string

Имя компании, если контакт является компанией.
Код страны в соответствии со стандартом ISO 3166-1 alpha-2.
 country string

Код страны в соответствии со стандартом ISO 3166-1 alpha-2.
Время создания контакта.
 created string

Время создания контакта.
ContactDetailsDto
 details ContactDetailsDto

Сведения о контакте
Имя контакта, если контакт является человеком.
 firstName string

Имя контакта, если контакт является человеком.
Идентификатор экземпляра контакта.
 id integer

Идентификатор экземпляра контакта.
Фамилия контакта, если контакт является человеком.
 lastName string

Фамилия контакта, если контакт является человеком.
Номер улицы.
 number string

Номер улицы.
Почтовый или почтовый индекс. Убедитесь, что он указан для каждого пользователя, требующего физического контакта с письмом через электронную почту.
 postalCode string

Почтовый или почтовый индекс. Убедитесь, что он указан для каждого пользователя, требующего физического контакта с письмом через электронную почту.
Имя получателя контакта.
 recipientName string

Имя получателя контакта.
Стандартная формула слов, используемых для обращения к контакту.
 salutation string

Стандартная формула слов, используемых для обращения к контакту.
Название штата, также называемое провинцией, подразделением или регионом.
 state string

Название штата, также называемое провинцией, подразделением или регионом.
Имя улицы.
 street string

Имя улицы.
Название задания контакта.
 title string

Название задания контакта.
Время последнего обновления контакта.
 updated string

Время последнего обновления контакта.

ContactSimpleDto

Упрощенная структура данных для контакта.

Имя Путь Тип Описание
Идентификатор экземпляра контакта.
 id integer

Идентификатор экземпляра контакта.
Имя контакта. Для получения более подробных сведений о загрузке контакта с помощью идентификатора.
 name string

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

ContractDto

Структура данных контракта.

Имя Путь Тип Описание
Список контактов, связанных с контрактом.
 contacts array of ContactSimpleDto

Список контактов, связанных с контрактом.
Номер контракта.
 contractNumber string

Номер контракта.
Время создания контракта.
 created string

Время создания контракта.
Дата окончания срока действия контракта. Значение NULL интерпретируется как окончание времени.
 endDate string

Дата окончания срока действия контракта. Значение NULL интерпретируется как окончание времени.
Идентификатор экземпляра контракта.
 id integer

Идентификатор экземпляра контракта.
Описывает, является ли этот контракт вакантным контрактом типа. По состоянию на данный момент это может быть верно только в том случае, если контракт имеет тип TENANT. Вакантный контракт означает, что единица не арендуется.
isVacant boolean

Описывает, является ли этот контракт вакантным контрактом типа. По состоянию на данный момент это может быть верно только в том случае, если контракт имеет тип TENANT. Вакантный контракт означает, что единица не арендуется.
Имя контракта, состоящего из ключа единицы и имени почтового контакта.
 name string

Имя контракта, состоящего из ключа единицы и имени почтового контакта.
Идентификатор экземпляра свойства, к которому принадлежит контракт.
 propertyId integer

Идентификатор экземпляра свойства, к которому принадлежит контракт.
Дата начала срока действия контракта. Значение NULL интерпретируется как начало времени.
 startDate string

Дата начала срока действия контракта. Значение NULL интерпретируется как начало времени.
Тип контракта. 1. ВЛАДЕЛЕЦ - контракт такого типа подтверждает владение единицей. 2. КЛИЕНТ - контракт такого типа аренды единицы. 3. PROPERTY_OWNER - контракт такого типа подтверждает владение имуществом.
 type string

Тип контракта.

  1. ВЛАДЕЛЕЦ - контракт такого типа подтверждает владение единицей.
  2. TENANT - контракт такого типа аренды единицы.
  3. PROPERTY_OWNER - контракт такого типа подтверждает владение имуществом.
Идентификатор экземпляра единицы, к которому принадлежит контракт.
 unitId integer

Идентификатор экземпляра единицы, к которому принадлежит контракт.
Время последнего обновления контракта.
 updated string

Время последнего обновления контракта.

DocumentDto

Структура данных документа.

Имя Путь Тип Описание
Общая сумма, представленная в документе.
 amount float

Общая сумма, представленная в документе.
Идентификатор здания документа принадлежит.
 buildingId integer

Идентификатор здания документа принадлежит.
Идентификатор контакта, к которому принадлежит документ.
 contactId integer

Идентификатор контакта, к которому принадлежит документ.
Идентификатор контракта, к которому принадлежит документ.
 contractId integer

Идентификатор контракта, к которому принадлежит документ.
Время создания документа.
 created string

Время создания документа.
Идентификатор экземпляра документа.
 id integer

Идентификатор экземпляра документа.
Дата выдачи документа.
 issuedDate string

Дата выдачи документа.
Имя экземпляра документа.
 name string

Имя экземпляра документа.
Удобочитаемый идентификатор свойства, которому назначается документ.
 propertyHrId string

Удобочитаемый идентификатор свойства, которому назначается документ.
Идентификатор свойства, к которому принадлежит документ.
 propertyId integer

Идентификатор свойства, к которому принадлежит документ.
Имя свойства, которому назначается документ.
 propertyName string

Имя свойства, которому назначается документ.
Идентификатор исходной сущности, к которой принадлежит документ.
 sourceId integer

Идентификатор исходной сущности, к которой принадлежит документ.
Тип источника документа. Вместе с идентификатором идентифицирует бизнес-процесс того же имени, к которому относится документ. Оно может иметь значение NULL.
 sourceType string

Тип источника документа. Вместе с идентификатором идентифицирует бизнес-процесс того же имени, к которому относится документ. Оно может иметь значение NULL.
Состояние документа.
 state string

Состояние документа.
tags
 tags array of DocumentTagSimpleDto
Удобочитаемый идентификатор единицы, которому назначается документ.
 unitHrId string

Удобочитаемый идентификатор единицы, которому назначается документ.
Идентификатор единицы, к которой принадлежит документ.
 unitId integer

Идентификатор единицы, к которой принадлежит документ.
Время последнего обновления документа.
 updated string

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

DocumentTagDto

Класс модели тега документа.

Имя Путь Тип Описание
Описание тега документа.
 description string

Описание тега документа.
Идентификатор тега документа.
 id integer

Идентификатор тега документа.
Имя тега документа.
 name string

Имя тега документа.

DocumentTagSimpleDto

Класс модели тега документа.

Имя Путь Тип Описание
Уникальный идентификатор тега документа.
 id integer

Уникальный идентификатор тега документа.
Имя тега документа.
 name string

Имя тега документа.

ErrorCodeDetailsDto

Имя Путь Тип Описание
код
 code string
описание
 description string

InvoiceDto

Структура данных счета.

Имя Путь Тип Описание
Сумма, которую необходимо оплатить в соответствии с счетом.
 amount float

Сумма, которую необходимо оплатить в соответствии с счетом.
Идентификатор контакта партнера по счету.
 counterpartContactId integer

Идентификатор контакта партнера по счету.
Имя контакта партнера по счету.
 counterpartContactName string

Имя контакта партнера по счету.
Время создания сущности.
 created string

Время создания сущности.
Идентификатор сущности.
 id integer

Идентификатор сущности.
Дата выдачи счета.
 issuedDate string

Дата выдачи счета.
items
 items array of InvoiceItemDto
Имя счета.
 name string

Имя счета.
BIC-номер банковского счета коллеги.
 orderCounterpartBic string

BIC-номер банковского счета коллеги.
IBAN банковского счета коллеги.
 orderCounterpartIban string

IBAN банковского счета коллеги.
Количество дней до или после даты бронирования, в которой банковский заказ должен отображаться для выполнения.
 orderDayOffset integer

Количество дней до или после даты бронирования, в которой банковский заказ должен отображаться для выполнения.
Уникальный идентификатор банковского счета свойства.
 orderPropertyBankAccountId integer

Уникальный идентификатор банковского счета свойства.
BIC-номер банковского счета собственности.
 orderPropertyBic string

BIC-номер банковского счета собственности.
IBAN банковского счета собственности.
 orderPropertyIban string

IBAN банковского счета собственности.
True в случае, если имеется соответствующий заказ счета.
 orderRequired boolean

True в случае, если имеется соответствующий заказ счета.
Оператор созданного заказа.
 orderStatement string

Оператор созданного заказа.
Удобочитаемый идентификатор свойства, к которому принадлежит счет.
 propertyHrId string

Удобочитаемый идентификатор свойства, к которому принадлежит счет.
Идентификатор свойства, к которому принадлежит счет.
 propertyId integer

Идентификатор свойства, к которому принадлежит счет.
Имя свойства, к которому принадлежит счет.
 propertyName string

Имя свойства, к которому принадлежит счет.
Состояние счета. Возможные значения: 1. ЧЕРНОВИК — созданный счет, но неполный. 2. READY — счет готов к резервированию. 3. BOOKED — выставлен счет. 4. SCHEDULED — применяется только к повторяющимся счетам. 5. ОБРАТНЫЙ — все резервирования, созданные счетом, были отменены.
 state string

Состояние счета. Возможные значения:

  1. DRAFT — созданный счет, но неполный.
  2. READY — счет готов к резервированию.
  3. BOOKED — счет забронировать.
  4. SCHEDULED — применяется только к повторяющимся счетам.
  5. REVERSED - все резервирования, созданные счетом, были отменены.
Время последнего обновления сущности.
 updated string

Время последнего обновления сущности.

InvoiceItemDto

Имя Путь Тип Описание
Код учетной записи элемента резервирования.
 accountCode string

Код учетной записи элемента резервирования.
Идентификатор учетной записи элемента резервирования.
 accountId integer

Идентификатор учетной записи элемента резервирования.
Имя учетной записи элемента резервирования.
 accountName string

Имя учетной записи элемента резервирования.
Сумма, соответствующая элементу резервирования.
 amount float

Сумма, соответствующая элементу резервирования.
Текст резервирования элемента резервирования.
 bookingText string

Текст резервирования элемента резервирования.
Время создания элемента счета.
 created string

Время создания элемента счета.
Уникальный идентификатор элемента резервирования.
 id integer

Уникальный идентификатор элемента резервирования.
Сумма, соответствующая декларации подоходного налога в соответствии с Законом о подоходном налоге: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
 laborCostAmount float

Сумма, соответствующая декларации подоходного налога в соответствии с Законом о подоходном налоге: Einkommenstueregesetz EStG 35a.
В зависимости от выбранного типа: проценты сумм будут сообщаться в приложениях 35a нескольких отчетов в соответствии с Законом о налоге на доходы: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Ex: Housemoney Settlement (Hausgeldabrechnung) или Opscost Report (Nebenkostenabrechnung). 1. HOUSEHOLD_RELATED_SERVICES - haushaltsnahe Dienstleistungen 2. TECHNICIAN_SERVICE - haushaltsnahe Handwerkerleistungen 3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse 4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen haushaltsnahen Beschäftigungsverhältnissen
 laborCostType string

В зависимости от выбранного типа: проценты сумм будут сообщаться в 35a приложениях нескольких отчетов в соответствии с Законом о налоге на доходы: Einkommenstueregtz EStG 35a.

Ex: Housemoney Settlement (Hausgeldabrechnung) или Opscost Report (Nebenkostenabrechnung).

  1. HOUSEHOLD_RELATED_SERVICES - haushaltsnahe Dienstleistungen
  2. TECHNICIAN_SERVICE - haushaltsnahe Handwerkerleistungen
  3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse
  4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen haushaltsnahen Beschäftigungsverhältnissen
Время последнего обновления элемента счета.
 updated string

Время последнего обновления элемента счета.
Соответствующая сумма ндс для элемента резервирования.
 vatAmount float

Соответствующая сумма ндс для элемента резервирования.
Соответствующий процент ндс суммы общей суммы.
 vatPercentage float

Соответствующий процент ндс суммы общей суммы.

PageOfContactDto

Имя Путь Тип Описание
содержимое
 content array of ContactDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfContractDto

Имя Путь Тип Описание
содержимое
 content array of ContractDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfDocumentDto

Имя Путь Тип Описание
содержимое
 content array of DocumentDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfInvoiceDto

Имя Путь Тип Описание
содержимое
 content array of InvoiceDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfPropertyDto

Имя Путь Тип Описание
содержимое
 content array of PropertyDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfUnitDto

Имя Путь Тип Описание
содержимое
 content array of UnitDto
empty
 empty boolean
первый
 first boolean
последний
 last boolean
число/номер
 number integer
numberOfElements
 numberOfElements integer
Страница с возможностью страницы
 pageable Pageable
size
 size integer
Сортировать
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

Страница с возможностью страницы

Имя Путь Тип Описание
offset
 offset integer
pageNumber
 pageNumber integer
pageSize
 pageSize integer
Вызвала
 paged boolean
Сортировать
 sort Sort
с ненумерованными страницами
 unpaged boolean

PropertyDto

Структура данных свойств.

Имя Путь Тип Описание
Время создания экземпляра свойства.
 created string

Время создания экземпляра свойства.
Идентификатор экземпляра свойства.
 id integer

Идентификатор экземпляра свойства.
Имя экземпляра свойства.
 name string

Имя экземпляра свойства.
Удобочитаемый идентификатор экземпляра свойства.
 propertyHrId string

Удобочитаемый идентификатор экземпляра свойства.
Текущее состояние свойства. 1. ЧЕРНОВИК - свойство еще не активировано, поэтому не могут быть созданы резервирования, банковские заказы и отчеты. 2. READY - свойство активировано и может использоваться для резервирования, банковских заказов и отчетов. 3. DISABLED - свойство было деактивировано и больше не может создавать резервирования, банковские заказы и отчеты.
state string

Текущее состояние свойства.

  1. DRAFT - свойство еще не активировано, поэтому не могут быть созданы резервирования, банковские заказы и отчеты.
  2. READY - свойство активировано и может использоваться для резервирования, банковских заказов и отчетов.
  3. DISABLED — свойство было деактивировано и больше не может создавать резервирования, банковские заказы и отчеты.
Тип администрирования свойства. ВЛАДЕЛЕЦ - Ассоциация владельцев дома. RENTAL — управление клиентами.
 type string

Тип администрирования свойства. ВЛАДЕЛЕЦ - Ассоциация владельцев дома. RENTAL — управление клиентами.
Время обновления экземпляра свойства.
 updated string

Время обновления экземпляра свойства.

Сортировать

Имя Путь Тип Описание
empty
 empty boolean
сортированный
 sorted boolean
несортированный
 unsorted boolean

UnitDto

Структура данных единиц.

Имя Путь Тип Описание
Время создания экземпляра единицы.
 created string

Время создания экземпляра единицы.
Этаж, на который находится единица.
 floor string

Этаж, на который находится единица.
Идентификатор экземпляра единицы.
 id integer

Идентификатор экземпляра единицы.
Положение единицы в полу.
 position string

Положение единицы в полу.
Идентификатор экземпляра свойства, к которому принадлежит единица.
 propertyId integer

Идентификатор экземпляра свойства, к которому принадлежит единица.
Назначение единицы используется для. КВАРТИРА — единица, используемая для жилых целей. ПАРКОВКА — единица, используемая для парковочных целей. COMMERCIAL — единица, используемая для бизнес-и коммерческих целей. OTHER — единица, используемая для других целей.
 type string

Назначение единицы используется для. КВАРТИРА — единица, используемая для жилых целей. ПАРКОВКА — единица, используемая для парковочных целей. COMMERCIAL — единица, используемая для бизнес-и коммерческих целей. OTHER — единица, используемая для других целей.
Удобочитаемый идентификатор экземпляра единицы.
 unitHrId string

Удобочитаемый идентификатор экземпляра единицы.
Ранг определяет порядок отображения единиц в пользовательском интерфейсе или отчетах. Пользователь может обновить его в пользовательском интерфейсе.
 unitRank integer

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

Время обновления экземпляра единицы.

LegacyInvoiceDto

Имя Путь Тип Описание
BIC-аналог
 counterpartBic string

BIC-аналог
Коллега ContactID
 counterpartContactId integer

Коллега ContactID
Аналог IBAN
 counterpartIban string

Аналог IBAN
Двойник
 counterpartName string

Двойник
Date
 created string

Date
URL-адрес счета
 documentUrl string

URL-адрес счета
Идентификатор
 id integer

Идентификатор
Дата счета
 invoiceDate string

Дата счета
Номер счета
 invoiceHrId string

Номер счета
Номер счета
 invoiceNumber string

Номер счета
Дата целевого объекта оплаты
 paymentTargetDate string

Дата целевого объекта оплаты
Тип оплаты
 paymentType string

Тип оплаты
Свойство NR
 propertyHrId string

Свойство NR
Идентификатор свойства
 propertyId integer

Идентификатор свойства
Внутренний идентификатор свойства
 propertyIdInternal string

Внутренний идентификатор свойства
Название свойства
 propertyName string

Название свойства
Справочник по Nr
 refNr string

Справочник по Nr
Состояние счета
 state string

Состояние счета
Общий валовой
 totalGross float

Общий валовой
Итого net
 totalNet float

Итого net
Включаемая ндс.
 vatIncluded boolean

Включаемая ндс.
Процент НДС
 vatPercentage float

Процент НДС

file

Это базовый тип данных file.