Partager via

Impower ERP (préversion)

Autoriser l’interaction avec impower.de système de comptabilité pour les gestionnaires de propriétés

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge des API
URL https://impower.de
Messagerie électronique support+api@impower.de
Métadonnées du connecteur
Éditeur Impower GmbH
Site internet https://www.impower.de
Politique de confidentialité https://www.impower.de/datenschutzerklaerung
Catégories Gestion de l’entreprise ; Finance

Le connecteur Impower vous permet d’accéder au masterdataset, comme les propriétés, les unités, les contrats et les contacts. En outre, vous pouvez charger des documents et des factures. Vous pouvez lire les données sur une base planifiée ou en inscrivant des webhooks à l’aide du déclencheur intégré.

Prerequisites

Pour utiliser Impower, vous aurez besoin des éléments suivants :

  1. Abonnement Impower payant
  2. Abonnement Powerautomate Premium

Comment obtenir des informations d’identification

Pour obtenir l’APIKey pour votre domaine avec lequel connecter powerautomate, écrivez une demande à l’adresse support@impower.de.

Bien démarrer avec votre connecteur

Scénarios que vous pouvez envisager de créer :

  1. Regardez un dossier Sharepoint/Onedrive pour obtenir les modifications et si de nouveaux fichiers PDF apparaissent les charger sur impower
  2. Synchroniser la liste des contacts avec votre carnet d’adresses Teams

Problèmes connus et limitations

Téléchargement/chargement de fichiers

Les fichiers sont chargés en tant que données de formulaire multipart au format binaire. Il en va de même pour le téléchargement : les fichiers sont fournis comme avec un nom de fichier suggéré dans l’en-tête , comme dans http standard

Limitation des débits

S’il vous plaît ne pas faire plus de 5 000 demandes par minute. Nous imposons une limitation de débit sur l’API pour garantir que le système peut servir rapidement les utilisateurs

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
API-Key securestring API-Key pour cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

(Hérité) Charger la facture

Chargez un fichier pdf sur Impower à l’aide de l’API héritée. Utilisez plutôt l’opération uploadInvoiceUsingPOST.
Créer un document basé sur le fichier donné

Le document nouvellement créé est retourné en tant que réponse
Créer une balise de document

La balise de document nouvellement créée est retournée en tant que réponse
Détails de la facture héritée

Obtenez les détails de la facture à partir d’Impower via l’API héritée. Utilisez getInvoiceByIdUsingGET à la place.
Lire une connexion

Lire une connexion
Mettre à jour le texte de réservation de l’élément de réservation de facture donné

Mettre à jour le texte de réservation
Mettre à jour un document existant en fonction du corps de la demande donné

Toutes les informations nécessaires se trouve dans le corps de la requête
Mettre à jour une balise de document existante en fonction de l’ID donné

La balise de document mise à jour est retournée en tant que réponse
Mettre à jour une connexion

Mettre à jour une connexion
Mettre à jour une facture en fonction des champs fournis

Mettre à jour la facture
Obtenir des balises de document

Les balises de document standard et spécifiques au domaine sont retournées en tant que réponse
Obtenir des contacts par les paramètres de filtre donnés

Récupérer des contacts par les paramètres de filtre donnés
Obtenir des contrats par les paramètres de filtre donnés

Récupérer des contrats par les paramètres de filtre donnés
Obtenir des documents par les paramètres de filtre donnés

Récupérer des documents par les paramètres de filtre donnés
Obtenir des factures par les paramètres de filtre donnés

Récupère les factures par les paramètres de filtre donnés
Obtenir les détails d’un code d’erreur spécifique

Récupère la description d’un code d’erreur spécifique
Obtenir les propriétés par les paramètres de filtre donnés

Récupérer les propriétés par les paramètres de filtre donnés
Obtenir toutes les unités par paramètres de filtre donnés

Retourne toutes les unités respectant les critères de filtre donnés
Obtenir toutes les valeurs de code d’erreur prédéfinies

Retourne une liste de tous les codes d’erreur prédéfinis
Obtenir un contact par l’ID donné

Récupère un contact par l’ID donné
Obtenir un contrat par l’ID donné

Récupère un contrat par l’ID donné
Obtenir une facture par l’ID donné

Récupère une facture par l’ID donné
Obtenir une propriété par l’ID donné

Récupère une propriété par l’ID donné
Obtenir une unité par l’ID donné

Retourner l’unité ayant l’ID donné
Supprimer un document existant en fonction de l’ID donné

Les documents générés par le système ne peuvent pas être supprimés
Supprimer une balise de document existante en fonction de l’ID donné

Les balises générées par le système ne peuvent pas être supprimées
Supprimer une connexion

Supprimer une connexion
Télécharger le document PDF de facture

Par défaut, le document va passer par une analyse OCR
Télécharger plusieurs documents par des conditions de filtre données

Les documents sont au format zip
Télécharger un document unique par ID donné

Le format du document est défini par le mimetype

(Hérité) Charger la facture

ID d’opération :
UploadInvoice

Chargez un fichier pdf sur Impower à l’aide de l’API héritée. Utilisez plutôt l’opération uploadInvoiceUsingPOST.

Paramètres

Nom Clé Obligatoire Type Description
Spécifier le fichier pdf à charger
 file True file

Spécifier le fichier pdf à charger

Retours

LegacyInvoiceDto
LegacyInvoiceDto

Créer un document basé sur le fichier donné

ID d’opération :
createDocumentByUploadUsingPOST

Le document nouvellement créé est retourné en tant que réponse

Paramètres

Nom Clé Obligatoire Type Description
Fichier PDF à charger
 file True file

Fichier PDF à charger

Retours

Structure des données de document.

DocumentDto
DocumentDto

Créer une balise de document

ID d’opération :
createDocumentTagUsingPOST

La balise de document nouvellement créée est retournée en tant que réponse

Paramètres

Nom Clé Obligatoire Type Description
Description de la balise de document nouvellement créée.
 description string

Description de la balise de document nouvellement créée.
Nom de la balise de document nouvellement créée.
 name string

Nom de la balise de document nouvellement créée.

Retours

Classe model d’une balise de document.

DocumentTagDto
DocumentTagDto

Détails de la facture héritée

ID d’opération :
GetInvoice

Obtenez les détails de la facture à partir d’Impower via l’API héritée. Utilisez getInvoiceByIdUsingGET à la place.

Paramètres

Nom Clé Obligatoire Type Description
ID facture
 invoiceId True integer

Spécifier l’ID de facture pour plus d’informations

Retours

LegacyInvoiceDto
LegacyInvoiceDto

Lire une connexion

ID d’opération :
getConnectionUsingGET

Lire une connexion

Paramètres

Nom Clé Obligatoire Type Description
ID de la connexion
 connectionIdX True integer

ID de la connexion

Retours

Données qui décrivent une connexion existante

ConnectionDto
ConnectionDto

Mettre à jour le texte de réservation de l’élément de réservation de facture donné

ID d’opération :
updateInvoiceItemUsingPUT

Mettre à jour le texte de réservation

Paramètres

Nom Clé Obligatoire Type Description
ID unique de l’élément de réservation de facture
 invoiceItemId True integer

ID unique de l’élément de réservation de facture
Texte de réservation de l’élément de facture.
 bookingText string

Texte de réservation de l’élément de facture.

Retours

InvoiceItemDto
InvoiceItemDto

Mettre à jour un document existant en fonction du corps de la demande donné

ID d’opération :
updateDocumentsUsingPUT

Toutes les informations nécessaires se trouve dans le corps de la requête

Paramètres

Nom Clé Obligatoire Type Description
Nouvelle valeur de la quantité de document à mettre à jour
 amount float

Nouvelle valeur de la quantité de document à mettre à jour
Nouveau bâtiment auquel le document doit être affecté.
 buildingId integer

Nouveau bâtiment auquel le document doit être affecté.
Nouveau contact auquel le document doit être affecté
 contactId integer

Nouveau contact auquel le document doit être affecté
Nouveau contrat auquel le document doit être affecté
 contractId integer

Nouveau contrat auquel le document doit être affecté
Identificateur unique du document à mettre à jour
 id True integer

Identificateur unique du document à mettre à jour
Nouvelle date à laquelle la date d’émission du document doit être mise à jour
 issuedDate string

Nouvelle date à laquelle la date d’émission du document doit être mise à jour
Nouvelle valeur du nom du document à mettre à jour
 name string

Nouvelle valeur du nom du document à mettre à jour
Nouvelle propriété à laquelle le document doit être affecté
 propertyId integer

Nouvelle propriété à laquelle le document doit être affecté
Nouvel ID de processus source auquel le document doit être affecté
 sourceId integer

Nouvel ID de processus source auquel le document doit être affecté
Identificateurs des balises à affecter au document
 tagIds array of integer

Identificateurs des balises à affecter au document
Nouvelle unité à laquelle le document doit être affecté
 unitId integer

Nouvelle unité à laquelle le document doit être affecté

Retours

response
array of DocumentDto

Mettre à jour une balise de document existante en fonction de l’ID donné

ID d’opération :
updateDocumentTagUsingPUT

La balise de document mise à jour est retournée en tant que réponse

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’une balise de document
 tagId True integer

Identificateur unique d’une balise de document
Nouvelle description de la balise de document.
 description string

Nouvelle description de la balise de document.
Nouveau nom de la balise de document.
 name string

Nouveau nom de la balise de document.

Retours

Classe model d’une balise de document.

DocumentTagDto
DocumentTagDto

Mettre à jour une connexion

ID d’opération :
updateConnectionUsingPUT

Mettre à jour une connexion

Paramètres

Nom Clé Obligatoire Type Description
ID de la connexion
 connectionIdX True integer

ID de la connexion
Nom de la connexion telle qu’elle doit être présentée dans l’interface utilisateur. S’il n’est pas spécifié, est défini par défaut sur le nom de l’application.
name string

Nom de la connexion telle qu’elle doit être présentée dans l’interface utilisateur. S’il n’est pas spécifié, est défini par défaut sur le nom de l’application.
L’URL est appelée avec un jeton d’autorisation que vous pouvez valider et le corps suivant : {"connectionId » :123,"entityType » :"properties »,"entityId » :123,"eventType » : « UPDATE"}
 webhookUrl string

L’URL est appelée avec un jeton d’autorisation que vous pouvez valider et le corps suivant : {"connectionId » :123,"entityType » :"properties »,"entityId » :123,"eventType » : « UPDATE"}

Retours

Données qui décrivent une connexion existante

ConnectionDto
ConnectionDto

Mettre à jour une facture en fonction des champs fournis

ID d’opération :
updateInvoiceUsingPUT

Mettre à jour la facture

Paramètres

Nom Clé Obligatoire Type Description
ID unique d’une facture
 invoiceId True integer

ID unique d’une facture
Nouvelle date d’émission de la facture.
 issuedDate string

Nouvelle date d’émission de la facture.
Nouveau nom de la facture.
 name string

Nouveau nom de la facture.

Retours

Structure des données de facture.

InvoiceDto
InvoiceDto

Obtenir des balises de document

ID d’opération :
getDocumentTagsUsingGET

Les balises de document standard et spécifiques au domaine sont retournées en tant que réponse

Paramètres

Nom Clé Obligatoire Type Description
Chaîne de recherche appliquée au nom et à la description
 description string

Chaîne de recherche appliquée au nom et à la description

Retours

response
array of DocumentTagDto

Obtenir des contacts par les paramètres de filtre donnés

ID d’opération :
getContactsByFilterUsingGET

Récupérer des contacts par les paramètres de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
Liste des ID de contact pour filtrer les contacts par.
 contactIds array

Liste des ID de contact pour filtrer les contacts par.
Adresse e-mail du contact.
 email string

Adresse e-mail du contact.
Nom du contact. Il peut s’agir du prénom, du nom ou du nom de la société.
 name string

Nom du contact. Il peut s’agir du prénom, du nom ou du nom de la société.
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri

Retours

PageOfContactDto
PageOfContactDto

Obtenir des contrats par les paramètres de filtre donnés

ID d’opération :
getContractsByFilterUsingGET

Récupérer des contrats par les paramètres de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
ID de l’instance de contact à laquelle le contrat est associé.
 contactId integer

ID de l’instance de contact à laquelle le contrat est associé.
Liste des ID de contrat pour filtrer les contrats par.
 contractIds array

Liste des ID de contrat pour filtrer les contrats par.
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
ID de l’instance de propriété à laquelle appartient le contrat.
 propertyId integer

ID de l’instance de propriété à laquelle appartient le contrat.
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri
Type du contrat. Options : OWNER | TENANT | PROPERTY_OWNER
 type array

Type du contrat. Options : OWNER | TENANT | PROPERTY_OWNER
ID de l’instance d’unité à laquelle le contrat est associé.
 unitId integer

ID de l’instance d’unité à laquelle le contrat est associé.
Retournez des contrats valides à la date. La valeur Null est interprétée comme début/fin de l’heure.
 validAtDate string

Retournez des contrats valides à la date. La valeur Null est interprétée comme début/fin de l’heure.

Retours

PageOfContractDto
PageOfContractDto

Obtenir des documents par les paramètres de filtre donnés

ID d’opération :
getDocumentsByFilterUsingGET

Récupérer des documents par les paramètres de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
Nom comptable de la propriété.
 accountant string

Nom comptable de la propriété.
Nom administrateur de la propriété.
 administrator string

Nom administrateur de la propriété.
ID de l’entité de contact auquel appartient le document.
 contactId integer

ID de l’entité de contact auquel appartient le document.
Documents liés à des contrats portant un nom similaire.
 contractName string

Documents liés à des contrats portant un nom similaire.
ID des documents à renvoyer.
 documentIds array

ID des documents à renvoyer.
Nom des documents à renvoyer.
 documentName string

Nom des documents à renvoyer.
Date d’émission du document.
 issuedDate string

Date d’émission du document.
Documents ayant émis la date antérieure.
 maxIssuedDate string

Documents ayant émis la date antérieure.
Documents ayant émis la date après.
 minIssuedDate string

Documents ayant émis la date après.
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
ID lisible humain de la propriété à laquelle appartient le document.
 propertyHrId string

ID lisible humain de la propriété à laquelle appartient le document.
ID de la propriété à laquelle appartient le document.
 propertyId integer

ID de la propriété à laquelle appartient le document.
Nom de la propriété à laquelle appartient le document.
 propertyName string

Nom de la propriété à laquelle appartient le document.
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri
ID de l’entité source à laquelle appartient le document.
 sourceId integer

ID de l’entité source à laquelle appartient le document.
Types sources du document.
 sourceType array

Types sources du document.
ID des balises à laquelle le document est associé.
 tagIds array

ID des balises à laquelle le document est associé.
Nom similaire de la balise à laquelle le document est associé.
 tagName string

Nom similaire de la balise à laquelle le document est associé.
ID de l’entité d’unité à laquelle appartient le document.
 unitId integer

ID de l’entité d’unité à laquelle appartient le document.

Retours

PageOfDocumentDto
PageOfDocumentDto

Obtenir des factures par les paramètres de filtre donnés

ID d’opération :
getInvoicesByFilterUsingGET

Récupère les factures par les paramètres de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du contact équivalent
 counterpartContactId integer

Identificateur unique du contact équivalent
Date de récupération des factures
 issuedDate string

Date de récupération des factures
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
Identificateur unique de la propriété à laquelle appartient une facture
 propertyId integer

Identificateur unique de la propriété à laquelle appartient une facture
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri
États des factures à récupérer
 states array

États des factures à récupérer

Retours

PageOfInvoiceDto
PageOfInvoiceDto

Obtenir les détails d’un code d’erreur spécifique

ID d’opération :
errorCodeUsingGET

Récupère la description d’un code d’erreur spécifique

Paramètres

Nom Clé Obligatoire Type Description
value
 value True string

value

Retours

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Obtenir les propriétés par les paramètres de filtre donnés

ID d’opération :
getPropertiesByFilterUsingGET

Récupérer les propriétés par les paramètres de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
Nom de la propriété.
 name string

Nom de la propriété.
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
ID lisible humain de la propriété.
 propertyHrId string

ID lisible humain de la propriété.
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri

Retours

PageOfPropertyDto
PageOfPropertyDto

Obtenir toutes les unités par paramètres de filtre donnés

ID d’opération :
getUnitsByFilterUsingGET

Retourne toutes les unités respectant les critères de filtre donnés

Paramètres

Nom Clé Obligatoire Type Description
Direction de tri. Valeurs possibles : ASC, DESC
 order string

Direction de tri. Valeurs possibles : ASC, DESC
Numéro de page à renvoyer
 page integer

Numéro de page à renvoyer
Identificateur unique de la propriété à laquelle appartient une unité
 propertyId integer

Identificateur unique de la propriété à laquelle appartient une unité
Nombre d’éléments à retourner dans une seule page
 size integer

Nombre d’éléments à retourner dans une seule page
Paramètre de tri
 sort string

Paramètre de tri

Retours

PageOfUnitDto
PageOfUnitDto

Obtenir toutes les valeurs de code d’erreur prédéfinies

ID d’opération :
errorCodesUsingGET

Retourne une liste de tous les codes d’erreur prédéfinis

Retours

Nom Chemin d’accès Type Description
array of string

Obtenir un contact par l’ID donné

ID d’opération :
getContactByIdUsingGET

Récupère un contact par l’ID donné

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’un contact
 contactId True integer

Identificateur unique d’un contact

Retours

Un contact représente une personne physique ou une entité juridique et la façon de les contacter. Une identité/une société a plusieurs adresses postales par le biais de laquelle elle peut être contactée. Elles sont représentées sous la forme de 2 contacts différents.

ContactDto
ContactDto

Obtenir un contrat par l’ID donné

ID d’opération :
getContractByIdUsingGET

Récupère un contrat par l’ID donné

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’un contrat
 contractId True integer

Identificateur unique d’un contrat

Retours

Structure des données de contrat.

ContractDto
ContractDto

Obtenir une facture par l’ID donné

ID d’opération :
getInvoiceByIdUsingGET

Récupère une facture par l’ID donné

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’une facture
 invoiceId True integer

Identificateur unique d’une facture

Retours

Structure des données de facture.

InvoiceDto
InvoiceDto

Obtenir une propriété par l’ID donné

ID d’opération :
getPropertyByIdUsingGET

Récupère une propriété par l’ID donné

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’une propriété
 propertyId True integer

Identificateur unique d’une propriété

Retours

Structure des données de propriété.

PropertyDto
PropertyDto

Obtenir une unité par l’ID donné

ID d’opération :
getUnitByIdUsingGET

Retourner l’unité ayant l’ID donné

Paramètres

Nom Clé Obligatoire Type Description
ID unique d’une unité
 unitId True integer

ID unique d’une unité

Retours

Structure des données d’unité.

UnitDto
UnitDto

Supprimer un document existant en fonction de l’ID donné

ID d’opération :
deleteDocumentUsingDELETE

Les documents générés par le système ne peuvent pas être supprimés

Paramètres

Nom Clé Obligatoire Type Description
documentId
 documentId True integer

documentId

Supprimer une balise de document existante en fonction de l’ID donné

ID d’opération :
deleteDocumentTagUsingDELETE

Les balises générées par le système ne peuvent pas être supprimées

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique de la balise de document à supprimer
 tagId True integer

Identificateur unique de la balise de document à supprimer

Supprimer une connexion

ID d’opération :
deleteConnectionUsingDELETE

Supprimer une connexion

Paramètres

Nom Clé Obligatoire Type Description
ID de la connexion
 connectionIdX True integer

ID de la connexion

Télécharger le document PDF de facture

ID d’opération :
uploadInvoiceUsingPOST

Par défaut, le document va passer par une analyse OCR

Paramètres

Nom Clé Obligatoire Type Description
Fichier PDF d’une facture
 file True file

Fichier PDF d’une facture

Retours

Structure des données de facture.

InvoiceDto
InvoiceDto

Télécharger plusieurs documents par des conditions de filtre données

ID d’opération :
downloadDocumentsByFilterUsingGET

Les documents sont au format zip

Paramètres

Nom Clé Obligatoire Type Description
Nom comptable de la propriété.
 accountant string

Nom comptable de la propriété.
Nom administrateur de la propriété.
 administrator string

Nom administrateur de la propriété.
ID de l’entité de contact auquel appartient le document.
 contactId integer

ID de l’entité de contact auquel appartient le document.
Documents liés à des contrats portant un nom similaire.
 contractName string

Documents liés à des contrats portant un nom similaire.
ID des documents à renvoyer.
 documentIds array

ID des documents à renvoyer.
Nom des documents à renvoyer.
 documentName string

Nom des documents à renvoyer.
Date d’émission du document.
 issuedDate string

Date d’émission du document.
Documents ayant émis la date antérieure.
 maxIssuedDate string

Documents ayant émis la date antérieure.
Documents ayant émis la date après.
 minIssuedDate string

Documents ayant émis la date après.
ID lisible humain de la propriété à laquelle appartient le document.
 propertyHrId string

ID lisible humain de la propriété à laquelle appartient le document.
ID de la propriété à laquelle appartient le document.
 propertyId integer

ID de la propriété à laquelle appartient le document.
Nom de la propriété à laquelle appartient le document.
 propertyName string

Nom de la propriété à laquelle appartient le document.
ID de l’entité source à laquelle appartient le document.
 sourceId integer

ID de l’entité source à laquelle appartient le document.
Types sources du document.
 sourceType array

Types sources du document.
ID des balises à laquelle le document est associé.
 tagIds array

ID des balises à laquelle le document est associé.
Nom similaire de la balise à laquelle le document est associé.
 tagName string

Nom similaire de la balise à laquelle le document est associé.
ID de l’entité d’unité à laquelle appartient le document.
 unitId integer

ID de l’entité d’unité à laquelle appartient le document.

Retours

response
file

Télécharger un document unique par ID donné

ID d’opération :
downloadUsingGET

Le format du document est défini par le mimetype

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique d’un document
 documentId True integer

Identificateur unique d’un document

Retours

response
file

Déclencheurs

Créer une connexion d’application

Créer une connexion d’application

Créer une connexion d’application

ID d’opération :
createConnectionUsingPOST

Créer une connexion d’application

Retours

Corps
ConnectionNotificationDto

Définitions

ConnectionNotificationDto

Nom Chemin d’accès Type Description
L’ID de la connexion à la notification s’applique à
 connectionId integer

connectionId
entityType
 entityType string

entityType
entityId
 entityId integer

entityId
eventType
 eventType string

eventType

ConnectionDto

Données qui décrivent une connexion existante

Nom Chemin d’accès Type Description
ID d’une application
 appId integer

ID d’une application
Nom de l’application de la connexion
 appName string

Nom de l’application de la connexion
Heure de création de l’entité.
 created string

Heure de création de l’entité.
ID de l’entité.
 id integer

ID de l’entité.
Nom de la connexion
 name string

Nom de la connexion
Heure de la dernière mise à jour de l’entité.
 updated string

Heure de la dernière mise à jour de l’entité.
Webhook de la connexion qui sera appelée comme « » AUTORISATION POST https://your.webhook.url/path/somewhere : JETON du porteur { « connectionId » : 0, « entityType » : « properties|contacts|invoices|etc. », « entityId » : 0, « eventType » : « CREATE|UPDATE|DELETE" }'''
 webhookUrl string

Webhook de la connexion qui sera appelée comme

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

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

ContactDetailsDto

Coordonnées

Nom Chemin d’accès Type Description
Numéro de téléphone professionnel du contact
 businessPhoneNumber array of string

Numéro de téléphone professionnel du contact
Date de naissance du contact.
 dateOfBirth string

Date de naissance du contact.
Adresse e-mail du contact
 email array of string

Adresse e-mail du contact
Numéro de télécopie du contact
 fax array of string

Numéro de télécopie du contact
Numéro de téléphone mobile du contact
 mobilePhoneNumber array of string

Numéro de téléphone mobile du contact
Numéro de téléphone privé du contact
 privatePhoneNumber array of string

Numéro de téléphone privé du contact
Numéro du registre commercial.
 tradeRegisterNumber string

Numéro du registre commercial.
ID de TVA du contact.
 vatId string

ID de TVA du contact.
Site web du contact
 website array of string

Site web du contact

ContactDto

Un contact représente une personne physique ou une entité juridique et la façon de les contacter. Une identité/une société a plusieurs adresses postales par le biais de laquelle elle peut être contactée. Elles sont représentées sous la forme de 2 contacts différents.

Nom Chemin d’accès Type Description
Nom de la ville.
 city string

Nom de la ville.
Nom de l’entreprise, dans le cas où le contact est une société.
 companyName string

Nom de l’entreprise, dans le cas où le contact est une société.
Code de pays selon la norme ISO 3166-1 alpha-2.
 country string

Code de pays selon la norme ISO 3166-1 alpha-2.
Heure de création du contact.
 created string

Heure de création du contact.
ContactDetailsDto
 details ContactDetailsDto

Coordonnées
Prénom du contact, au cas où le contact était une personne.
 firstName string

Prénom du contact, au cas où le contact était une personne.
ID de l’instance de contact.
 id integer

ID de l’instance de contact.
Nom du contact, au cas où le contact était une personne.
 lastName string

Nom du contact, au cas où le contact était une personne.
Numéro de rue.
 number string

Numéro de rue.
Code postal ou postal. Assurez-vous qu’elle est spécifiée pour chaque personne nécessitant un contact physique par courrier électronique.
 postalCode string

Code postal ou postal. Assurez-vous qu’elle est spécifiée pour chaque personne nécessitant un contact physique par courrier électronique.
Nom du destinataire du contact.
 recipientName string

Nom du destinataire du contact.
Formule standard de mots utilisés pour traiter le contact.
 salutation string

Formule standard de mots utilisés pour traiter le contact.
Nom de l’état, également appelé province, sous-division ou région.
 state string

Nom de l’état, également appelé province, sous-division ou région.
Nom de la rue.
 street string

Nom de la rue.
Titre du travail du contact.
 title string

Titre du travail du contact.
Heure de la dernière mise à jour du contact.
 updated string

Heure de la dernière mise à jour du contact.

ContactSimpleDto

Contactez la structure de données simplifiée.

Nom Chemin d’accès Type Description
ID de l’instance de contact.
 id integer

ID de l’instance de contact.
Nom du contact. Pour plus d’informations, chargez le contact via l’ID.
 name string

Nom du contact. Pour plus d’informations, chargez le contact via l’ID.

ContractDto

Structure des données de contrat.

Nom Chemin d’accès Type Description
Liste des contacts associés au contrat.
 contacts array of ContactSimpleDto

Liste des contacts associés au contrat.
Nombre du contrat.
 contractNumber string

Nombre du contrat.
Durée de création du contrat.
 created string

Durée de création du contrat.
Date à laquelle la période de validité du contrat se termine. La valeur Null est interprétée comme la fin de l’heure.
 endDate string

Date à laquelle la période de validité du contrat se termine. La valeur Null est interprétée comme la fin de l’heure.
ID de l’instance de contrat.
 id integer

ID de l’instance de contrat.
Décrit si ce contrat est un contrat de type vacant. À l’heure actuelle, elle ne peut être vraie que si le contrat est de type TENANT. Contrat vacant signifie que l’unité n’est pas louée.
isVacant boolean

Décrit si ce contrat est un contrat de type vacant. À l’heure actuelle, elle ne peut être vraie que si le contrat est de type TENANT. Contrat vacant signifie que l’unité n’est pas louée.
Nom du contrat composé de la clé d’unité et du nom du contact de publipostage.
 name string

Nom du contrat composé de la clé d’unité et du nom du contact de publipostage.
ID de l’instance de propriété à laquelle appartient le contrat.
 propertyId integer

ID de l’instance de propriété à laquelle appartient le contrat.
Date de début de la période de validité du contrat. La valeur Null est interprétée comme un début de temps.
 startDate string

Date de début de la période de validité du contrat. La valeur Null est interprétée comme un début de temps.
Type du contrat. 1. PROPRIÉTAIRE - un contrat de ce type prouve la propriété de l’unité. 2. LOCATAIRE - un contrat de ce type loue l’unité. 3. PROPERTY_OWNER - un contrat de ce type prouve la propriété.
 type string

Type du contrat.

  1. OWNER - un contrat de ce type prouve la propriété de l’unité.
  2. LOCATAIRE - un contrat de ce type loue l’unité.
  3. PROPERTY_OWNER - un contrat de ce type prouve la propriété.
ID de l’instance d’unité auquel appartient le contrat.
 unitId integer

ID de l’instance d’unité auquel appartient le contrat.
Heure de la dernière mise à jour du contrat.
 updated string

Heure de la dernière mise à jour du contrat.

DocumentDto

Structure des données de document.

Nom Chemin d’accès Type Description
Montant total présent sur le document.
 amount float

Montant total présent sur le document.
ID du bâtiment auquel appartient le document.
 buildingId integer

ID du bâtiment auquel appartient le document.
ID du contact auquel appartient le document.
 contactId integer

ID du contact auquel appartient le document.
ID du contrat auquel appartient le document.
 contractId integer

ID du contrat auquel appartient le document.
Heure de création du document.
 created string

Heure de création du document.
ID de l’instance de document.
 id integer

ID de l’instance de document.
Date d’émission du document.
 issuedDate string

Date d’émission du document.
Nom de l’instance de document.
 name string

Nom de l’instance de document.
ID lisible humain de la propriété à laquelle le document est affecté.
 propertyHrId string

ID lisible humain de la propriété à laquelle le document est affecté.
ID de la propriété à laquelle appartient le document.
 propertyId integer

ID de la propriété à laquelle appartient le document.
Nom de la propriété à laquelle le document est affecté.
 propertyName string

Nom de la propriété à laquelle le document est affecté.
ID de l’entité source à laquelle appartient le document.
 sourceId integer

ID de l’entité source à laquelle appartient le document.
Type source du document. En même temps que l’ID identifie le processus métier du même nom, le document provient/est attaché. Il peut s’agir de null.
 sourceType string

Type source du document. En même temps que l’ID identifie le processus métier du même nom, le document provient/est attaché. Il peut s’agir de null.
État du document.
 state string

État du document.
tags
 tags array of DocumentTagSimpleDto
ID lisible humain de l’unité à laquelle le document est affecté.
 unitHrId string

ID lisible humain de l’unité à laquelle le document est affecté.
ID de l’unité à laquelle appartient le document.
 unitId integer

ID de l’unité à laquelle appartient le document.
Heure de la dernière mise à jour du document.
 updated string

Heure de la dernière mise à jour du document.

DocumentTagDto

Classe model d’une balise de document.

Nom Chemin d’accès Type Description
Description de la balise de document.
 description string

Description de la balise de document.
ID de la balise de document.
 id integer

ID de la balise de document.
Nom de la balise de document.
 name string

Nom de la balise de document.

DocumentTagSimpleDto

Classe model d’une balise de document.

Nom Chemin d’accès Type Description
Identificateur unique de la balise de document.
 id integer

Identificateur unique de la balise de document.
Nom de la balise de document.
 name string

Nom de la balise de document.

ErrorCodeDetailsDto

Nom Chemin d’accès Type Description
code
 code string
descriptif
 description string

InvoiceDto

Structure des données de facture.

Nom Chemin d’accès Type Description
Montant à payer en fonction de la facture.
 amount float

Montant à payer en fonction de la facture.
ID du contact équivalent de la facture.
 counterpartContactId integer

ID du contact équivalent de la facture.
Nom du contact équivalent de la facture.
 counterpartContactName string

Nom du contact équivalent de la facture.
Heure de création de l’entité.
 created string

Heure de création de l’entité.
ID de l’entité.
 id integer

ID de l’entité.
Date d’émission de la facture.
 issuedDate string

Date d’émission de la facture.
items
 items array of InvoiceItemDto
Nom de la facture.
 name string

Nom de la facture.
Numéro BIC du compte bancaire de l’équivalent.
 orderCounterpartBic string

Numéro BIC du compte bancaire de l’équivalent.
IBAN du compte bancaire de l’équivalent.
 orderCounterpartIban string

IBAN du compte bancaire de l’équivalent.
Nombre de jours avant ou après la date de réservation où l’ordre bancaire doit apparaître pour exécution.
 orderDayOffset integer

Nombre de jours avant ou après la date de réservation où l’ordre bancaire doit apparaître pour exécution.
Identificateur unique du compte bancaire de la propriété.
 orderPropertyBankAccountId integer

Identificateur unique du compte bancaire de la propriété.
Numéro BIC du compte bancaire immobilier.
 orderPropertyBic string

Numéro BIC du compte bancaire immobilier.
IBAN du compte bancaire immobilier.
 orderPropertyIban string

IBAN du compte bancaire immobilier.
True dans le cas où il existe une commande correspondante de la facture.
 orderRequired boolean

True dans le cas où il existe une commande correspondante de la facture.
Instruction de l’ordre généré.
 orderStatement string

Instruction de l’ordre généré.
ID lisible par l’utilisateur de la propriété à laquelle appartient la facture.
 propertyHrId string

ID lisible par l’utilisateur de la propriété à laquelle appartient la facture.
ID de la propriété à laquelle appartient la facture.
 propertyId integer

ID de la propriété à laquelle appartient la facture.
Nom de la propriété à laquelle appartient la facture.
 propertyName string

Nom de la propriété à laquelle appartient la facture.
État de la facture. Valeurs possibles : 1. DRAFT - facture créée, mais incomplète. 2. READY - Facture prête à être réservée. 3. RÉSERVÉ - facture réservée. 4. SCHEDULED : s’applique uniquement aux factures périodiques. 5. INVERSED : toutes les réservations générées par la facture ont été inversées.
 state string

État de la facture. Valeurs possibles :

  1. DRAFT : facture créée, mais incomplète.
  2. READY - Facture prête à être réservée.
  3. RÉSERVÉ - facture réservée.
  4. SCHEDULED : s’applique uniquement aux factures périodiques.
  5. REVERSED : toutes les réservations générées par la facture ont été inversées.
Heure de la dernière mise à jour de l’entité.
 updated string

Heure de la dernière mise à jour de l’entité.

InvoiceItemDto

Nom Chemin d’accès Type Description
Code de compte de l’élément de réservation.
 accountCode string

Code de compte de l’élément de réservation.
ID de compte de l’élément de réservation.
 accountId integer

ID de compte de l’élément de réservation.
Nom du compte de l’élément de réservation.
 accountName string

Nom du compte de l’élément de réservation.
Montant correspondant à l’élément de réservation.
 amount float

Montant correspondant à l’élément de réservation.
Texte de réservation de l’élément de réservation.
 bookingText string

Texte de réservation de l’élément de réservation.
Heure de création de l’élément de facture.
 created string

Heure de création de l’élément de facture.
Identificateur unique de l’élément de réservation.
 id integer

Identificateur unique de l’élément de réservation.
Montant pertinent pour la déclaration d’impôt sur le revenu conformément à la Loi sur l’impôt sur le revenu : [Einkommenstuerekommenstuere ombudsman EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
 laborCostAmount float

Montant pertinent pour la déclaration d’impôt sur le revenu conformément à la Loi sur l’impôt sur le revenu : Einkommenstuereambre EStG 35a.
Selon le type sélectionné : les pourcentages des montants seront signalés aux annexes de 35a de plusieurs rapports conformément à la Loi sur l’impôt sur le revenu : [Einkommenstuerekommenstuere ombudsman EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Ex : Housemoney Settlement (Hausgeldabrechnung) ou 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

Selon le type sélectionné : les pourcentages des montants seront signalés sur les annexes de 35a de plusieurs rapports conformément à la Loi sur l’impôt sur le revenu : Einkommenstuere ombudsman EStG 35a.

Ex : Housemoney Settlement (Hausgeldabrechnung) ou 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
Heure de la dernière mise à jour de l’élément de facture.
 updated string

Heure de la dernière mise à jour de l’élément de facture.
Montant de tva correspondant de l’élément de réservation.
 vatAmount float

Montant de tva correspondant de l’élément de réservation.
Pourcentage de tva correspondant du montant total de la tva.
 vatPercentage float

Pourcentage de tva correspondant du montant total de la tva.

PageOfContactDto

Nom Chemin d’accès Type Description
contenu
 content array of ContactDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfContractDto

Nom Chemin d’accès Type Description
contenu
 content array of ContractDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfDocumentDto

Nom Chemin d’accès Type Description
contenu
 content array of DocumentDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfInvoiceDto

Nom Chemin d’accès Type Description
contenu
 content array of InvoiceDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfPropertyDto

Nom Chemin d’accès Type Description
contenu
 content array of PropertyDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

PageOfUnitDto

Nom Chemin d’accès Type Description
contenu
 content array of UnitDto
vide
 empty boolean
premier
 first boolean
last
 last boolean
nombre
 number integer
numberOfElements
 numberOfElements integer
Paginable
 pageable Pageable
size
 size integer
Trier
 sort Sort
totalElements
 totalElements integer
totalPages
 totalPages integer

Paginable

Nom Chemin d’accès Type Description
offset
 offset integer
pageNumber
 pageNumber integer
pageSize
 pageSize integer
Bipé
 paged boolean
Trier
 sort Sort
désépage
 unpaged boolean

PropertyDto

Structure des données de propriété.

Nom Chemin d’accès Type Description
Heure de création de l’instance de propriété.
 created string

Heure de création de l’instance de propriété.
ID de l’instance de propriété.
 id integer

ID de l’instance de propriété.
Nom de l’instance de propriété.
 name string

Nom de l’instance de propriété.
ID lisible humain de l’instance de propriété.
 propertyHrId string

ID lisible humain de l’instance de propriété.
État actuel de la propriété. 1. DRAFT : propriété non activée, par conséquent, aucune réservation/commandes bancaires/rapports ne peut être générée. 2. READY - La propriété a été activée et peut être utilisée pour les réservations/commandes bancaires/génération de rapports. 3. DÉSACTIVÉ : la propriété a été désactivée et ne peut plus générer de réservations/commandes/rapports bancaires.
state string

État actuel de la propriété.

  1. DRAFT : propriété non encore activée, par conséquent, aucune réservation/commandes bancaires/rapports ne peut être générée.
  2. READY : la propriété a été activée et peut être utilisée pour les réservations/commandes bancaires/génération de rapports.
  3. DISABLED : la propriété a été désactivée et ne peut plus générer de réservations/commandes/rapports bancaires.
Type d’administration de la propriété. OWNER - Home Owner Association. LOCATION - Gestion des locataires.
 type string

Type d’administration de la propriété. OWNER - Home Owner Association. LOCATION - Gestion des locataires.
Heure de mise à jour de l’instance de propriété.
 updated string

Heure de mise à jour de l’instance de propriété.

Trier

Nom Chemin d’accès Type Description
vide
 empty boolean
trié
 sorted boolean
Unsorted
 unsorted boolean

UnitDto

Structure des données d’unité.

Nom Chemin d’accès Type Description
Heure de création de l’instance d’unité.
 created string

Heure de création de l’instance d’unité.
Étage de l’unité est situé sur.
 floor string

Étage de l’unité est situé sur.
ID de l’instance d’unité.
 id integer

ID de l’instance d’unité.
Position de l’unité au sein du sol.
 position string

Position de l’unité au sein du sol.
ID de l’instance de propriété à laquelle appartient l’unité.
 propertyId integer

ID de l’instance de propriété à laquelle appartient l’unité.
Objectif pour lequel l’unité est utilisée. APPARTEMENT - unité utilisée à des fins résidentielles. PARKING - unité utilisée à des fins de stationnement. COMMERCIAL - unité utilisée à des fins commerciales/commerciales. OTHER : unité utilisée à d’autres fins.
 type string

Objectif pour lequel l’unité est utilisée. APPARTEMENT - unité utilisée à des fins résidentielles. PARKING - unité utilisée à des fins de stationnement. COMMERCIAL - unité utilisée à des fins commerciales/commerciales. OTHER : unité utilisée à d’autres fins.
ID lisible humain de l’instance d’unité.
 unitHrId string

ID lisible humain de l’instance d’unité.
Le classement définit l’ordre dans lequel les unités sont affichées sur l’interface utilisateur/rapports. L’utilisateur peut le mettre à jour dans l’interface utilisateur.
 unitRank integer

Le classement définit l’ordre dans lequel les unités sont affichées sur l’interface utilisateur/rapports. L’utilisateur peut le mettre à jour dans l’interface utilisateur.
Heure de mise à jour de l’instance d’unité.
 updated string

Heure de mise à jour de l’instance d’unité.

LegacyInvoiceDto

Nom Chemin d’accès Type Description
Équivalent BIC
 counterpartBic string

Équivalent BIC
Équivalent contactID
 counterpartContactId integer

Équivalent contactID
Équivalent IBAN
 counterpartIban string

Équivalent IBAN
Pendant
 counterpartName string

Pendant
Date
 created string

Date
URL de facture
 documentUrl string

URL de facture
ID
 id integer

ID
Date de facturation
 invoiceDate string

Date de facturation
ID facture
 invoiceHrId string

ID facture
Numéro de facture
 invoiceNumber string

Numéro de facture
Date cible de paiement
 paymentTargetDate string

Date cible de paiement
Type de paiement
 paymentType string

Type de paiement
Property NR
 propertyHrId string

Property NR
ID de propriété
 propertyId integer

ID de propriété
ID interne de propriété
 propertyIdInternal string

ID interne de propriété
Nom de la propriété
 propertyName string

Nom de la propriété
Référence nr
 refNr string

Référence nr
État de la facture
 state string

État de la facture
Total brut
 totalGross float

Total brut
Total Net
 totalNet float

Total Net
TVA incluse.
 vatIncluded boolean

TVA incluse.
Pourcentage de TVA
 vatPercentage float

Pourcentage de TVA

file

Il s’agit du type de données de base « fichier ».