Compartir a través de


Impower ERP (versión preliminar)

Permitir la interacción con impower.de sistema de contabilidad para administradores de propiedades

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con api
URL https://impower.de
Correo Electrónico support+api@impower.de
Metadatos del conector
Publicador Impower GmbH
Sitio web https://www.impower.de
Directiva de privacidad https://www.impower.de/datenschutzerklaerung
Categorías Gestión empresarial; Finanzas

El conector Impower permite acceder al conjunto de datos maestros, como propiedades, unidades, contratos y contactos. Además, puede cargar documentos y facturas. Uno puede leer los datos de forma programada o registrar webhooks mediante el desencadenador integrado.

Prerrequisitos

Para poder usar Impower necesitará:

  1. Suscripción de impower de pago
  2. Suscripción a Powerautomate Premium

Obtención de credenciales

Para obtener la APIKey del dominio con el que conectarse powerautomate, escriba una solicitud en support@impower.de.

Introducción al conector

Escenarios que podría considerar la posibilidad de crear:

  1. Vea una carpeta de Sharepoint/Onedrive para ver los cambios y si los archivos PDF nuevos aparecen cargarlos en un poder
  2. Sincronizar la lista de contactos con el libro de direcciones de teams

Problemas y limitaciones conocidos

Descarga o carga de archivos

Los archivos se cargan como datos de formulario de varias partes en formato binario. Lo mismo sucede para la descarga: los archivos se proporcionan tal cual con un nombre de archivo sugerido en el encabezado , igual que en el estándar http

Ratelimiting

Por favor, no haga más de 5000 solicitudes por minuto. Imponemos un límite de velocidad en la API para asegurarnos de que el sistema pueda atender rápidamente a los usuarios.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
API-Key securestring API-Key para esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

(Heredado) Cargar factura

Cargue un archivo PDF en Impower mediante la API heredada. Use la operación uploadInvoiceUsingPOST en su lugar.

Actualización de un documento existente basado en el cuerpo de solicitud especificado

Toda la información necesaria está en el cuerpo de la solicitud

Actualización de una etiqueta de documento existente basada en el identificador especificado

La etiqueta de documento actualizada se devolverá como respuesta.

Actualización de una factura basada en campos proporcionados

Actualización de la factura

Actualizar el texto de la reserva de la factura especificada

Actualizar texto de reserva

Actualizar una conexión

Actualizar una conexión

Cargar documento PDF de factura

De forma predeterminada, el documento irá a través de un análisis de OCR.

Creación de una nueva etiqueta de documento

La etiqueta de documento recién creada se devolverá como respuesta.

Crear un nuevo documento basado en un archivo determinado

El documento recién creado se devolverá como respuesta.

Descarga de un único documento por identificador dado

El formato del documento se define mediante el mimetype

Descarga de varios documentos mediante condiciones de filtro dadas

Los documentos vienen en formato zip

Detalles de la factura heredada

Obtenga los detalles de la factura de Impower a través de la API heredada. Use getInvoiceByIdUsingGET en su lugar.

Eliminación de una conexión

Eliminación de una conexión

Eliminar un documento existente basado en el identificador especificado

No se pueden eliminar documentos generados por el sistema

Eliminar una etiqueta de documento existente basada en el identificador especificado

No se pueden eliminar etiquetas generadas por el sistema

Leer una conexión

Leer una conexión

Obtención de documentos mediante los parámetros de filtro especificados

Recuperación de documentos mediante los parámetros de filtro especificados

Obtención de etiquetas de documento

Las etiquetas de documento estándar y específicas del dominio se devolverán como respuesta.

Obtención de facturas por los parámetros de filtro especificados

Recupera facturas por los parámetros de filtro especificados.

Obtención de todas las unidades por parámetros de filtro especificados

Devuelve todas las unidades que respetan los criterios de filtro especificados.

Obtención de todos los valores de código de error predefinidos

Devuelve una lista de todos los códigos de error predefinidos.

Obtención de una factura mediante el identificador especificado

Recupera una factura por el identificador especificado.

Obtención de una propiedad por el identificador especificado

Recupera una propiedad por el identificador especificado.

Obtener contactos por los parámetros de filtro especificados

Recuperar contactos por los parámetros de filtro especificados

Obtener contratos por los parámetros de filtro especificados

Recuperar contratos por los parámetros de filtro especificados

Obtener detalles de un código de error específico

Recupera la descripción de un código de error específico.

Obtener propiedades por los parámetros de filtro especificados

Recuperación de propiedades por los parámetros de filtro especificados

Obtener un contacto con el identificador especificado

Recupera un contacto por el identificador especificado.

Obtener un contrato por el identificador especificado

Recupera un contrato por el identificador especificado.

Obtener una unidad por el identificador especificado

Devolver la unidad que tiene el identificador especificado

(Heredado) Cargar factura

Cargue un archivo PDF en Impower mediante la API heredada. Use la operación uploadInvoiceUsingPOST en su lugar.

Parámetros

Nombre Clave Requerido Tipo Description
Especificar el archivo pdf que se va a cargar
file True file

Especificar el archivo pdf que se va a cargar

Devoluciones

LegacyInvoiceDto
LegacyInvoiceDto

Actualización de un documento existente basado en el cuerpo de solicitud especificado

Toda la información necesaria está en el cuerpo de la solicitud

Parámetros

Nombre Clave Requerido Tipo Description
Nuevo valor al que se va a actualizar la cantidad del documento
amount float

Nuevo valor al que se va a actualizar la cantidad del documento

Nuevo edificio al que se va a asignar el documento.
buildingId integer

Nuevo edificio al que se va a asignar el documento.

Nuevo contacto con el documento al que se va a asignar
contactId integer

Nuevo contacto con el documento al que se va a asignar

Nuevo contrato al que se va a asignar el documento
contractId integer

Nuevo contrato al que se va a asignar el documento

Identificador único del documento que se va a actualizar.
id True integer

Identificador único del documento que se va a actualizar.

Nueva fecha a la que se va a actualizar el documento
issuedDate string

Nueva fecha a la que se va a actualizar el documento

Nuevo valor al que se va a actualizar el nombre del documento
name string

Nuevo valor al que se va a actualizar el nombre del documento

Nueva propiedad a la que se va a asignar el documento
propertyId integer

Nueva propiedad a la que se va a asignar el documento

Nuevo identificador de proceso de origen al que se va a asignar el documento
sourceId integer

Nuevo identificador de proceso de origen al que se va a asignar el documento

Identificadores de etiquetas que se asignarán al documento
tagIds array of integer

Identificadores de etiquetas que se asignarán al documento

Nueva unidad a la que se va a asignar el documento
unitId integer

Nueva unidad a la que se va a asignar el documento

Devoluciones

Actualización de una etiqueta de documento existente basada en el identificador especificado

La etiqueta de documento actualizada se devolverá como respuesta.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de una etiqueta de documento
tagId True integer

Identificador único de una etiqueta de documento

Nueva descripción de la etiqueta de documento.
description string

Nueva descripción de la etiqueta de documento.

Nuevo nombre de la etiqueta de documento.
name string

Nuevo nombre de la etiqueta de documento.

Devoluciones

Clase de modelo de una etiqueta de documento.

DocumentTagDto
DocumentTagDto

Actualización de una factura basada en campos proporcionados

Actualización de la factura

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de una factura
invoiceId True integer

Identificador único de una factura

Nueva fecha emitida de la factura.
issuedDate string

Nueva fecha emitida de la factura.

Nuevo nombre de la factura.
name string

Nuevo nombre de la factura.

Devoluciones

Estructura de datos de factura.

InvoiceDto
InvoiceDto

Actualizar el texto de la reserva de la factura especificada

Actualizar texto de reserva

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del elemento de reserva de factura
invoiceItemId True integer

Identificador único del elemento de reserva de factura

Texto de reserva del artículo de factura.
bookingText string

Texto de reserva del artículo de factura.

Devoluciones

InvoiceItemDto
InvoiceItemDto

Actualizar una conexión

Actualizar una conexión

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de la conexión
connectionIdX True integer

Identificador de la conexión

Nombre de la conexión tal como se mostrará en la interfaz de usuario. Si no se especifica, el valor predeterminado será el nombre de la aplicación.
name string

Nombre de la conexión tal como se mostrará en la interfaz de usuario. Si no se especifica, el valor predeterminado será el nombre de la aplicación.

Se llamará a la dirección URL con un token de autorización que pueda validar y el siguiente cuerpo: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
webhookUrl string

Se llamará a la dirección URL con un token de autorización que pueda validar y el siguiente cuerpo: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

Devoluciones

Datos que describen una conexión existente

ConnectionDto
ConnectionDto

Cargar documento PDF de factura

De forma predeterminada, el documento irá a través de un análisis de OCR.

Parámetros

Nombre Clave Requerido Tipo Description
Archivo PDF de una factura
file True file

Archivo PDF de una factura

Devoluciones

Estructura de datos de factura.

InvoiceDto
InvoiceDto

Creación de una nueva etiqueta de documento

La etiqueta de documento recién creada se devolverá como respuesta.

Parámetros

Nombre Clave Requerido Tipo Description
Descripción de la etiqueta de documento recién creada.
description string

Descripción de la etiqueta de documento recién creada.

Nombre de la etiqueta de documento recién creada.
name string

Nombre de la etiqueta de documento recién creada.

Devoluciones

Clase de modelo de una etiqueta de documento.

DocumentTagDto
DocumentTagDto

Crear un nuevo documento basado en un archivo determinado

El documento recién creado se devolverá como respuesta.

Parámetros

Nombre Clave Requerido Tipo Description
Archivo PDF que se va a cargar
file True file

Archivo PDF que se va a cargar

Devoluciones

Estructura de datos del documento.

DocumentDto
DocumentDto

Descarga de un único documento por identificador dado

El formato del documento se define mediante el mimetype

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de un documento
documentId True integer

Identificador único de un documento

Devoluciones

response
file

Descarga de varios documentos mediante condiciones de filtro dadas

Los documentos vienen en formato zip

Parámetros

Nombre Clave Requerido Tipo Description
Nombre contable de la propiedad.
accountant string

Nombre contable de la propiedad.

Nombre de administrador de la propiedad.
administrator string

Nombre de administrador de la propiedad.

Identificador de la entidad de contacto a la que pertenece el documento.
contactId integer

Identificador de la entidad de contacto a la que pertenece el documento.

Documentos vinculados a contratos con un nombre similar.
contractName string

Documentos vinculados a contratos con un nombre similar.

Identificadores de los documentos que se van a devolver.
documentIds array

Identificadores de los documentos que se van a devolver.

Nombre de los documentos que se van a devolver.
documentName string

Nombre de los documentos que se van a devolver.

Fecha de emisión del documento.
issuedDate string

Fecha de emisión del documento.

Documentos que han emitido la fecha anterior.
maxIssuedDate string

Documentos que han emitido la fecha anterior.

Documentos que se han emitido después de la fecha.
minIssuedDate string

Documentos que se han emitido después de la fecha.

Identificador legible de la propiedad a la que pertenece el documento.
propertyHrId string

Identificador legible de la propiedad a la que pertenece el documento.

Identificador de la propiedad a la que pertenece el documento.
propertyId integer

Identificador de la propiedad a la que pertenece el documento.

Nombre de la propiedad a la que pertenece el documento.
propertyName string

Nombre de la propiedad a la que pertenece el documento.

Identificador de la entidad de origen a la que pertenece el documento.
sourceId integer

Identificador de la entidad de origen a la que pertenece el documento.

Tipos de origen del documento.
sourceType array

Tipos de origen del documento.

Identificadores de etiquetas a los que está asociado el documento.
tagIds array

Identificadores de etiquetas a los que está asociado el documento.

Nombre similar de etiqueta al que está asociado el documento.
tagName string

Nombre similar de etiqueta al que está asociado el documento.

Identificador de la entidad de unidad a la que pertenece el documento.
unitId integer

Identificador de la entidad de unidad a la que pertenece el documento.

Devoluciones

response
file

Detalles de la factura heredada

Obtenga los detalles de la factura de Impower a través de la API heredada. Use getInvoiceByIdUsingGET en su lugar.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de factura
invoiceId True integer

Especificar el identificador de factura para obtener más información

Devoluciones

LegacyInvoiceDto
LegacyInvoiceDto

Eliminación de una conexión

Eliminación de una conexión

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de la conexión
connectionIdX True integer

Identificador de la conexión

Eliminar un documento existente basado en el identificador especificado

No se pueden eliminar documentos generados por el sistema

Parámetros

Nombre Clave Requerido Tipo Description
documentId
documentId True integer

documentId

Eliminar una etiqueta de documento existente basada en el identificador especificado

No se pueden eliminar etiquetas generadas por el sistema

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de la etiqueta de documento que se va a eliminar
tagId True integer

Identificador único de la etiqueta de documento que se va a eliminar

Leer una conexión

Leer una conexión

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de la conexión
connectionIdX True integer

Identificador de la conexión

Devoluciones

Datos que describen una conexión existente

ConnectionDto
ConnectionDto

Obtención de documentos mediante los parámetros de filtro especificados

Recuperación de documentos mediante los parámetros de filtro especificados

Parámetros

Nombre Clave Requerido Tipo Description
Nombre contable de la propiedad.
accountant string

Nombre contable de la propiedad.

Nombre de administrador de la propiedad.
administrator string

Nombre de administrador de la propiedad.

Identificador de la entidad de contacto a la que pertenece el documento.
contactId integer

Identificador de la entidad de contacto a la que pertenece el documento.

Documentos vinculados a contratos con un nombre similar.
contractName string

Documentos vinculados a contratos con un nombre similar.

Identificadores de los documentos que se van a devolver.
documentIds array

Identificadores de los documentos que se van a devolver.

Nombre de los documentos que se van a devolver.
documentName string

Nombre de los documentos que se van a devolver.

Fecha de emisión del documento.
issuedDate string

Fecha de emisión del documento.

Documentos que han emitido la fecha anterior.
maxIssuedDate string

Documentos que han emitido la fecha anterior.

Documentos que se han emitido después de la fecha.
minIssuedDate string

Documentos que se han emitido después de la fecha.

Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Identificador legible de la propiedad a la que pertenece el documento.
propertyHrId string

Identificador legible de la propiedad a la que pertenece el documento.

Identificador de la propiedad a la que pertenece el documento.
propertyId integer

Identificador de la propiedad a la que pertenece el documento.

Nombre de la propiedad a la que pertenece el documento.
propertyName string

Nombre de la propiedad a la que pertenece el documento.

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Identificador de la entidad de origen a la que pertenece el documento.
sourceId integer

Identificador de la entidad de origen a la que pertenece el documento.

Tipos de origen del documento.
sourceType array

Tipos de origen del documento.

Identificadores de etiquetas a los que está asociado el documento.
tagIds array

Identificadores de etiquetas a los que está asociado el documento.

Nombre similar de etiqueta al que está asociado el documento.
tagName string

Nombre similar de etiqueta al que está asociado el documento.

Identificador de la entidad de unidad a la que pertenece el documento.
unitId integer

Identificador de la entidad de unidad a la que pertenece el documento.

Devoluciones

PageOfDocumentDto
PageOfDocumentDto

Obtención de etiquetas de documento

Las etiquetas de documento estándar y específicas del dominio se devolverán como respuesta.

Parámetros

Nombre Clave Requerido Tipo Description
Cadena de búsqueda aplicada a nombre y descripción
description string

Cadena de búsqueda aplicada a nombre y descripción

Devoluciones

Obtención de facturas por los parámetros de filtro especificados

Recupera facturas por los parámetros de filtro especificados.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del contacto homólogo
counterpartContactId integer

Identificador único del contacto homólogo

Fecha de recuperación de las facturas
issuedDate string

Fecha de recuperación de las facturas

Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Identificador único de la propiedad a la que pertenece una factura
propertyId integer

Identificador único de la propiedad a la que pertenece una factura

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Estados de las facturas que se van a recuperar
states array

Estados de las facturas que se van a recuperar

Devoluciones

PageOfInvoiceDto
PageOfInvoiceDto

Obtención de todas las unidades por parámetros de filtro especificados

Devuelve todas las unidades que respetan los criterios de filtro especificados.

Parámetros

Nombre Clave Requerido Tipo Description
Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Identificador único de la propiedad a la que pertenece una unidad
propertyId integer

Identificador único de la propiedad a la que pertenece una unidad

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Devoluciones

PageOfUnitDto
PageOfUnitDto

Obtención de todos los valores de código de error predefinidos

Devuelve una lista de todos los códigos de error predefinidos.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of string

Obtención de una factura mediante el identificador especificado

Recupera una factura por el identificador especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de una factura
invoiceId True integer

Identificador único de una factura

Devoluciones

Estructura de datos de factura.

InvoiceDto
InvoiceDto

Obtención de una propiedad por el identificador especificado

Recupera una propiedad por el identificador especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de una propiedad
propertyId True integer

Identificador único de una propiedad

Devoluciones

Estructura de datos de propiedad.

PropertyDto
PropertyDto

Obtener contactos por los parámetros de filtro especificados

Recuperar contactos por los parámetros de filtro especificados

Parámetros

Nombre Clave Requerido Tipo Description
Lista de identificadores de contacto por los que filtrar los contactos.
contactIds array

Lista de identificadores de contacto por los que filtrar los contactos.

Dirección de correo electrónico del contacto.
email string

Dirección de correo electrónico del contacto.

Cualquier nombre del contacto. Puede ser el nombre, el apellido o el nombre de la compañía.
name string

Cualquier nombre del contacto. Puede ser el nombre, el apellido o el nombre de la compañía.

Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Devoluciones

PageOfContactDto
PageOfContactDto

Obtener contratos por los parámetros de filtro especificados

Recuperar contratos por los parámetros de filtro especificados

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de la instancia de contacto a la que está asociado el contrato.
contactId integer

Identificador de la instancia de contacto a la que está asociado el contrato.

Lista de identificadores de contrato por los que filtrar los contratos.
contractIds array

Lista de identificadores de contrato por los que filtrar los contratos.

Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Identificador de la instancia de propiedad a la que pertenece el contrato.
propertyId integer

Identificador de la instancia de propiedad a la que pertenece el contrato.

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Tipo del contrato. Opciones: OWNER | TENANT | PROPERTY_OWNER
type array

Tipo del contrato. Opciones: OWNER | TENANT | PROPERTY_OWNER

Identificador de la instancia de unidad a la que está asociado el contrato.
unitId integer

Identificador de la instancia de unidad a la que está asociado el contrato.

Devolver contratos válidos en la fecha. Null se interpreta como principio y fin de hora.
validAtDate string

Devolver contratos válidos en la fecha. Null se interpreta como principio y fin de hora.

Devoluciones

PageOfContractDto
PageOfContractDto

Obtener detalles de un código de error específico

Recupera la descripción de un código de error específico.

Parámetros

Nombre Clave Requerido Tipo Description
value
value True string

value

Devoluciones

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Obtener propiedades por los parámetros de filtro especificados

Recuperación de propiedades por los parámetros de filtro especificados

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de la propiedad.
name string

Nombre de la propiedad.

Dirección de ordenación. Valores posibles: ASC, DESC
order string

Dirección de ordenación. Valores posibles: ASC, DESC

Número de página que se va a devolver
page integer

Número de página que se va a devolver

Identificador legible de la propiedad.
propertyHrId string

Identificador legible de la propiedad.

Número de elementos que se van a devolver en una sola página
size integer

Número de elementos que se van a devolver en una sola página

Parámetro de ordenación
sort string

Parámetro de ordenación

Devoluciones

PageOfPropertyDto
PageOfPropertyDto

Obtener un contacto con el identificador especificado

Recupera un contacto por el identificador especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de un contacto
contactId True integer

Identificador único de un contacto

Devoluciones

Un contacto representa una persona física o una entidad jurídica, y la forma de ponerse en contacto con ellos. Deberá una identidad o empresa tener varias direcciones postales a través de las cuales se pueda contactar. Se representan como 2 contactos diferentes.

ContactDto
ContactDto

Obtener un contrato por el identificador especificado

Recupera un contrato por el identificador especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de un contrato
contractId True integer

Identificador único de un contrato

Devoluciones

Estructura de datos del contrato.

ContractDto
ContractDto

Obtener una unidad por el identificador especificado

Devolver la unidad que tiene el identificador especificado

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único de una unidad
unitId True integer

Identificador único de una unidad

Devoluciones

Estructura de datos de unidad.

UnitDto
UnitDto

Desencadenadores

Creación de una conexión de aplicación

Creación de una conexión de aplicación

Creación de una conexión de aplicación

Creación de una conexión de aplicación

Devoluciones

Definiciones

ConnectionNotificationDto

Nombre Ruta de acceso Tipo Description
El identificador de la conexión a la que se aplica la notificación
connectionId integer

connectionId

entityType
entityType string

entityType

entityId
entityId integer

entityId

eventType
eventType string

eventType

ConnectionDto

Datos que describen una conexión existente

Nombre Ruta de acceso Tipo Description
Identificador de una aplicación
appId integer

Identificador de una aplicación

Nombre de la aplicación de la conexión
appName string

Nombre de la aplicación de la conexión

Hora de creación de la entidad.
created string

Hora de creación de la entidad.

Identificador de la entidad.
id integer

Identificador de la entidad.

Nombre de la conexión
name string

Nombre de la conexión

Hora de la última actualización de la entidad.
updated string

Hora de la última actualización de la entidad.

Webhook de la conexión a la que se llamará como "" AUTORIZACIÓN POST https://your.webhook.url/path/somewhere : TOKEN de portador { "connectionId": 0, "entityType": "properties|contacts|invoices|etc.", "entityId": 0, "eventType": "CREATE|UPDATE|DELETE" }''
webhookUrl string

Webhook de la conexión a la que se llamará como

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

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

ContactDetailsDto

Detalles de contacto

Nombre Ruta de acceso Tipo Description
Número de teléfono comercial del contacto
businessPhoneNumber array of string

Número de teléfono comercial del contacto

Fecha de nacimiento del contacto.
dateOfBirth string

Fecha de nacimiento del contacto.

Dirección de correo electrónico del contacto
email array of string

Dirección de correo electrónico del contacto

Número de fax del contacto
fax array of string

Número de fax del contacto

Número de teléfono móvil del contacto
mobilePhoneNumber array of string

Número de teléfono móvil del contacto

Número de teléfono privado del contacto
privatePhoneNumber array of string

Número de teléfono privado del contacto

Número de registro comercial.
tradeRegisterNumber string

Número de registro comercial.

Id. de IVA del contacto.
vatId string

Id. de IVA del contacto.

Sitio web del contacto
website array of string

Sitio web del contacto

ContactDto

Un contacto representa una persona física o una entidad jurídica, y la forma de ponerse en contacto con ellos. Deberá una identidad o empresa tener varias direcciones postales a través de las cuales se pueda contactar. Se representan como 2 contactos diferentes.

Nombre Ruta de acceso Tipo Description
Nombre de la ciudad.
city string

Nombre de la ciudad.

Nombre de la empresa, en caso de que el contacto sea una empresa.
companyName string

Nombre de la empresa, en caso de que el contacto sea una empresa.

Código de país según la norma ISO 3166-1 alpha-2.
country string

Código de país según la norma ISO 3166-1 alpha-2.

Hora de creación del contacto.
created string

Hora de creación del contacto.

ContactDetailsDto
details ContactDetailsDto

Detalles de contacto

Nombre del contacto, en caso de que el contacto sea una persona.
firstName string

Nombre del contacto, en caso de que el contacto sea una persona.

Identificador de la instancia de contacto.
id integer

Identificador de la instancia de contacto.

Apellidos del contacto, en caso de que el contacto sea una persona.
lastName string

Apellidos del contacto, en caso de que el contacto sea una persona.

Número de calle.
number string

Número de calle.

Código postal o postal. Asegúrese de que se especifica para cada persona que requiera contacto de carta física a través de e-post.
postalCode string

Código postal o postal. Asegúrese de que se especifica para cada persona que requiera contacto de carta física a través de e-post.

Nombre del destinatario del contacto.
recipientName string

Nombre del destinatario del contacto.

Fórmula estándar de palabras usadas para abordar el contacto.
salutation string

Fórmula estándar de palabras usadas para abordar el contacto.

Nombre de estado, también denominado provincia, subdivisión o región.
state string

Nombre de estado, también denominado provincia, subdivisión o región.

Nombre de la calle.
street string

Nombre de la calle.

Título del trabajo del contacto.
title string

Título del trabajo del contacto.

Hora de la última actualización del contacto.
updated string

Hora de la última actualización del contacto.

ContactSimpleDto

Póngase en contacto con la estructura de datos simplificada.

Nombre Ruta de acceso Tipo Description
Identificador de la instancia de contacto.
id integer

Identificador de la instancia de contacto.

Nombre del contacto. Para obtener información más detallada, cargue el contacto a través de id.
name string

Nombre del contacto. Para obtener información más detallada, cargue el contacto a través de id.

ContractDto

Estructura de datos del contrato.

Nombre Ruta de acceso Tipo Description
Lista de los contactos asociados al contrato.
contacts array of ContactSimpleDto

Lista de los contactos asociados al contrato.

Número del contrato.
contractNumber string

Número del contrato.

Tiempo de creación del contrato.
created string

Tiempo de creación del contrato.

Fecha en que finaliza el período de validez del contrato. Null se interpreta como fin de hora.
endDate string

Fecha en que finaliza el período de validez del contrato. Null se interpreta como fin de hora.

Identificador de la instancia del contrato.
id integer

Identificador de la instancia del contrato.

Describe si este contrato es un contrato de tipo vacante. A partir de ahora solo puede ser true en caso de que el contrato sea de tipo TENANT. Contrato vacante significa que la unidad no se alquila.
isVacant boolean

Describe si este contrato es un contrato de tipo vacante. A partir de ahora solo puede ser true en caso de que el contrato sea de tipo TENANT. Contrato vacante significa que la unidad no se alquila.

Nombre del contrato que consta de la clave de unidad y nombre del contacto postal.
name string

Nombre del contrato que consta de la clave de unidad y nombre del contacto postal.

Identificador de la instancia de propiedad a la que pertenece el contrato.
propertyId integer

Identificador de la instancia de propiedad a la que pertenece el contrato.

Fecha desde la que comienza el período de validez del contrato. Null se interpreta como principio de hora.
startDate string

Fecha desde la que comienza el período de validez del contrato. Null se interpreta como principio de hora.

Tipo del contrato. 1. PROPIETARIO : un contrato de este tipo demuestra la propiedad de la unidad. 2. INQUILINO - un contrato de este tipo está alquilando la unidad. 3. PROPERTY_OWNER - un contrato de este tipo demuestra la propiedad de la propiedad.
type string

Tipo del contrato.

  1. OWNER: un contrato de este tipo demuestra la propiedad de la unidad.
  2. INQUILINO: un contrato de este tipo está alquilando la unidad.
  3. PROPERTY_OWNER: un contrato de este tipo demuestra la propiedad de la propiedad.
Identificador de la instancia de unidad a la que pertenece el contrato.
unitId integer

Identificador de la instancia de unidad a la que pertenece el contrato.

Hora de última actualización del contrato.
updated string

Hora de última actualización del contrato.

DocumentDto

Estructura de datos del documento.

Nombre Ruta de acceso Tipo Description
Importe total presente en el documento.
amount float

Importe total presente en el documento.

Identificador del edificio al que pertenece el documento.
buildingId integer

Identificador del edificio al que pertenece el documento.

Identificador del contacto al que pertenece el documento.
contactId integer

Identificador del contacto al que pertenece el documento.

Identificador del contrato al que pertenece el documento.
contractId integer

Identificador del contrato al que pertenece el documento.

Hora de creación del documento.
created string

Hora de creación del documento.

Id. de la instancia del documento.
id integer

Id. de la instancia del documento.

Fecha de emisión del documento.
issuedDate string

Fecha de emisión del documento.

Nombre de la instancia del documento.
name string

Nombre de la instancia del documento.

Identificador legible de la propiedad a la que se asigna el documento.
propertyHrId string

Identificador legible de la propiedad a la que se asigna el documento.

Identificador de la propiedad a la que pertenece el documento.
propertyId integer

Identificador de la propiedad a la que pertenece el documento.

Nombre de la propiedad a la que se asigna el documento.
propertyName string

Nombre de la propiedad a la que se asigna el documento.

Identificador de la entidad de origen a la que pertenece el documento.
sourceId integer

Identificador de la entidad de origen a la que pertenece el documento.

Tipo de origen del documento. Junto con el identificador, se identifica el proceso de negocio del mismo nombre al que se origina el documento o se adjunta. Puede ser null.
sourceType string

Tipo de origen del documento. Junto con el identificador, se identifica el proceso de negocio del mismo nombre al que se origina el documento o se adjunta. Puede ser null.

Estado del documento.
state string

Estado del documento.

tags
tags array of DocumentTagSimpleDto
Identificador legible de la unidad a la que se asigna el documento.
unitHrId string

Identificador legible de la unidad a la que se asigna el documento.

Identificador de la unidad a la que pertenece el documento.
unitId integer

Identificador de la unidad a la que pertenece el documento.

Hora de la última actualización del documento.
updated string

Hora de la última actualización del documento.

DocumentTagDto

Clase de modelo de una etiqueta de documento.

Nombre Ruta de acceso Tipo Description
Descripción de la etiqueta de documento.
description string

Descripción de la etiqueta de documento.

Identificador de la etiqueta de documento.
id integer

Identificador de la etiqueta de documento.

Nombre de la etiqueta del documento.
name string

Nombre de la etiqueta del documento.

DocumentTagSimpleDto

Clase de modelo de una etiqueta de documento.

Nombre Ruta de acceso Tipo Description
Identificador único de la etiqueta de documento.
id integer

Identificador único de la etiqueta de documento.

Nombre de la etiqueta del documento.
name string

Nombre de la etiqueta del documento.

ErrorCodeDetailsDto

Nombre Ruta de acceso Tipo Description
código
code string
descripción
description string

InvoiceDto

Estructura de datos de factura.

Nombre Ruta de acceso Tipo Description
Importe que se va a pagar según la factura.
amount float

Importe que se va a pagar según la factura.

Identificador del contacto homólogo de la factura.
counterpartContactId integer

Identificador del contacto homólogo de la factura.

Nombre del contacto homólogo de la factura.
counterpartContactName string

Nombre del contacto homólogo de la factura.

Hora de creación de la entidad.
created string

Hora de creación de la entidad.

Identificador de la entidad.
id integer

Identificador de la entidad.

Fecha de emisión de la factura.
issuedDate string

Fecha de emisión de la factura.

items
items array of InvoiceItemDto
Nombre de la factura.
name string

Nombre de la factura.

Número BIC de la cuenta bancaria del homólogo.
orderCounterpartBic string

Número BIC de la cuenta bancaria del homólogo.

IBAN de la cuenta bancaria del homólogo.
orderCounterpartIban string

IBAN de la cuenta bancaria del homólogo.

Número de días antes o después de la fecha de reserva en la que deberá aparecer el pedido bancario para su ejecución.
orderDayOffset integer

Número de días antes o después de la fecha de reserva en la que deberá aparecer el pedido bancario para su ejecución.

Identificador único de la cuenta bancaria de la propiedad.
orderPropertyBankAccountId integer

Identificador único de la cuenta bancaria de la propiedad.

Número BIC de la cuenta bancaria del establecimiento.
orderPropertyBic string

Número BIC de la cuenta bancaria del establecimiento.

IBAN de la cuenta bancaria del establecimiento.
orderPropertyIban string

IBAN de la cuenta bancaria del establecimiento.

True en caso de que haya un orden correspondiente de la factura.
orderRequired boolean

True en caso de que haya un orden correspondiente de la factura.

Instrucción del orden generado.
orderStatement string

Instrucción del orden generado.

Identificador legible de la propiedad a la que pertenece la factura.
propertyHrId string

Identificador legible de la propiedad a la que pertenece la factura.

Identificador de la propiedad a la que pertenece la factura.
propertyId integer

Identificador de la propiedad a la que pertenece la factura.

Nombre de la propiedad a la que pertenece la factura.
propertyName string

Nombre de la propiedad a la que pertenece la factura.

Estado de la factura. Valores posibles: 1. BORRADOR: factura creada, pero incompleta. 2. LISTO - factura lista para reservar. 3. RESERVADO - factura reservada. 4. SCHEDULED : solo se aplica a las facturas periódicas. 5. INVERTIDO - se han invertido todas las reservas generadas por la factura.
state string

Estado de la factura. Valores posibles:

  1. BORRADOR: factura creada, pero incompleta.
  2. READY: factura lista para reservar.
  3. RESERVADO : factura reservada.
  4. SCHEDULED: solo se aplica a las facturas periódicas.
  5. INVERTIDO: se han invertido todas las reservas generadas por la factura.
Hora de la última actualización de la entidad.
updated string

Hora de la última actualización de la entidad.

InvoiceItemDto

Nombre Ruta de acceso Tipo Description
Código de cuenta del elemento de reserva.
accountCode string

Código de cuenta del elemento de reserva.

Id. de cuenta del elemento de reserva.
accountId integer

Id. de cuenta del elemento de reserva.

Nombre de cuenta del elemento de reserva.
accountName string

Nombre de cuenta del elemento de reserva.

Importe correspondiente al artículo de reserva.
amount float

Importe correspondiente al artículo de reserva.

Texto de reserva del elemento de reserva.
bookingText string

Texto de reserva del elemento de reserva.

Hora de creación del elemento de factura.
created string

Hora de creación del elemento de factura.

Identificador único del elemento de reserva.
id integer

Identificador único del elemento de reserva.

Importe relevante para la declaración fiscal de ingresos de acuerdo con la Ley de Impuestos sobre la Renta: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
laborCostAmount float

Importe relevante para la declaración fiscal de ingresos de acuerdo con la Ley de Impuestos sobre la Renta: Einkommenstueregesetz EStG 35a.

Dependiendo del tipo seleccionado: porcentajes de los importes se notificarán en los anexos 35a de varios informes según la Ley de Impuestos sobre la Renta: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Por ejemplo: Housemoney Settlement (Hausgeldabrechnung) o 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

Dependiendo del tipo seleccionado: porcentajes de los importes se notificarán en los anexos 35a de varios informes según la Ley de Impuestos sobre la Renta: Einkommenstueregesetz EStG 35a.

Por ejemplo: Housemoney Settlement (Hausgeldabrechnung) o 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
Hora de última actualización del elemento de factura.
updated string

Hora de última actualización del elemento de factura.

Importe del iva correspondiente del artículo de reserva.
vatAmount float

Importe del iva correspondiente del artículo de reserva.

Porcentaje de iva correspondiente del importe total del iva.
vatPercentage float

Porcentaje de iva correspondiente del importe total del iva.

PageOfContactDto

Nombre Ruta de acceso Tipo Description
contenido
content array of ContactDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfContractDto

Nombre Ruta de acceso Tipo Description
contenido
content array of ContractDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfDocumentDto

Nombre Ruta de acceso Tipo Description
contenido
content array of DocumentDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfInvoiceDto

Nombre Ruta de acceso Tipo Description
contenido
content array of InvoiceDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfPropertyDto

Nombre Ruta de acceso Tipo Description
contenido
content array of PropertyDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfUnitDto

Nombre Ruta de acceso Tipo Description
contenido
content array of UnitDto
vacío
empty boolean
Primero
first boolean
último
last boolean
number
number integer
numberOfElements
numberOfElements integer
Paginable
pageable Pageable
size
size integer
Ordenar
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

Paginable

Nombre Ruta de acceso Tipo Description
offset
offset integer
pageNumber
pageNumber integer
pageSize
pageSize integer
Paginado
paged boolean
Ordenar
sort Sort
despáginado
unpaged boolean

PropertyDto

Estructura de datos de propiedad.

Nombre Ruta de acceso Tipo Description
Hora de creación de la instancia de propiedad.
created string

Hora de creación de la instancia de propiedad.

Identificador de la instancia de propiedad.
id integer

Identificador de la instancia de propiedad.

Nombre de la instancia de propiedad.
name string

Nombre de la instancia de propiedad.

Identificador legible de la instancia de propiedad.
propertyHrId string

Identificador legible de la instancia de propiedad.

Estado actual de la propiedad. 1. DRAFT - propiedad no activada aún, por lo tanto no se puede generar reservas/pedidos bancarios/informes. 2. READY - el establecimiento se ha activado y se puede utilizar para la generación de reservas, pedidos bancarios o informes. 3. DISABLED - propiedad ha sido desactivada, y ya no puede generar reservas/pedidos bancarios/informes.
state string

Estado actual de la propiedad.

  1. DRAFT - propiedad no activada aún, por lo tanto no se puede generar reservas/pedidos bancarios/informes.
  2. READY : el establecimiento se ha activado y se puede utilizar para la generación de reservas, pedidos bancarios e informes.
  3. DISABLED : la propiedad se ha desactivado y ya no puede generar reservas, pedidos bancarios o informes.
Tipo de administración de la propiedad. PROPIETARIO - Asociación de propietarios del hogar. RENTAL - Administración de inquilinos.
type string

Tipo de administración de la propiedad. PROPIETARIO - Asociación de propietarios del hogar. RENTAL - Administración de inquilinos.

Hora de actualización de la instancia de propiedad.
updated string

Hora de actualización de la instancia de propiedad.

Ordenar

Nombre Ruta de acceso Tipo Description
vacío
empty boolean
Ordenados
sorted boolean
sin ordenar
unsorted boolean

UnitDto

Estructura de datos de unidad.

Nombre Ruta de acceso Tipo Description
Hora de creación de la instancia de unidad.
created string

Hora de creación de la instancia de unidad.

Piso en el que se encuentra el apartamento.
floor string

Piso en el que se encuentra el apartamento.

Identificador de la instancia de unidad.
id integer

Identificador de la instancia de unidad.

Posición de la unidad dentro del piso.
position string

Posición de la unidad dentro del piso.

Identificador de la instancia de propiedad a la que pertenece la unidad.
propertyId integer

Identificador de la instancia de propiedad a la que pertenece la unidad.

Propósito para el que se usa la unidad. APARTAMENTO - unidad utilizada para fines residenciales. ESTACIONAMIENTO - unidad utilizada para fines de estacionamiento. COMMERCIAL: unidad utilizada para fines comerciales o comerciales. OTHER: unidad utilizada para otros fines.
type string

Propósito para el que se usa la unidad. APARTAMENTO - unidad utilizada para fines residenciales. ESTACIONAMIENTO - unidad utilizada para fines de estacionamiento. COMMERCIAL: unidad utilizada para fines comerciales o comerciales. OTHER: unidad utilizada para otros fines.

Identificador legible del usuario de la instancia de unidad.
unitHrId string

Identificador legible del usuario de la instancia de unidad.

La clasificación define el orden en que se muestran las unidades en la interfaz de usuario o los informes. El usuario puede actualizarlo en la interfaz de usuario.
unitRank integer

La clasificación define el orden en que se muestran las unidades en la interfaz de usuario o los informes. El usuario puede actualizarlo en la interfaz de usuario.

Hora de actualización de la instancia de unidad.
updated string

Hora de actualización de la instancia de unidad.

LegacyInvoiceDto

Nombre Ruta de acceso Tipo Description
Homólogo de BIC
counterpartBic string

Homólogo de BIC

Homólogo de ContactID
counterpartContactId integer

Homólogo de ContactID

Homólogo iban
counterpartIban string

Homólogo iban

Homólogo
counterpartName string

Homólogo

Fecha
created string

Fecha

Dirección URL de factura
documentUrl string

Dirección URL de factura

identificación
id integer

identificación

Fecha de factura
invoiceDate string

Fecha de factura

Id. de factura
invoiceHrId string

Id. de factura

Número de factura
invoiceNumber string

Número de factura

Fecha de destino de pago
paymentTargetDate string

Fecha de destino de pago

Tipo de pago
paymentType string

Tipo de pago

NR de propiedad
propertyHrId string

NR de propiedad

Id. de propiedad
propertyId integer

Id. de propiedad

Id. interno de la propiedad
propertyIdInternal string

Id. interno de la propiedad

Nombre de propiedad
propertyName string

Nombre de propiedad

Nr de referencia
refNr string

Nr de referencia

Estado de la factura
state string

Estado de la factura

Total bruto
totalGross float

Total bruto

Total neto
totalNet float

Total neto

IVA incluido.
vatIncluded boolean

IVA incluido.

Porcentaje de IVA
vatPercentage float

Porcentaje de IVA

archivo

Este es el tipo de datos básico "file".