Condividi tramite


Impower ERP (anteprima)

Consentire l'interazione con impower.de sistema di contabilità per i gestori di proprietà

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Di alta qualità Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Supporto api
URL https://impower.de
Email support+api@impower.de
Metadati del connettore
Editore Impower GmbH
Sito web https://www.impower.de
Informativa sulla privacy https://www.impower.de/datenschutzerklaerung
Categorie Gestione aziendale; Finanza

Il connettore Impower consente di accedere al masterdataset, ad esempio proprietà, unità, contratti e contatti. Inoltre, è possibile caricare documenti e fatture. È possibile leggere i dati in base a una pianificazione o registrando webhook usando il trigger integrato.

Prerequisiti

Per usare Impower è necessario:

  1. Abbonamento a Impower a pagamento
  2. Sottoscrizione di Powerautomate Premium

Come ottenere le credenziali

Per ottenere l'APIKey per il dominio con cui connettersi powerautomate, scrivere una richiesta all'indirizzo support@impower.de.

Introduzione al connettore

Scenari che è possibile prendere in considerazione per la compilazione:

  1. Controllare una cartella di Sharepoint/Onedrive per verificare la presenza di modifiche e se vengono visualizzati nuovi file PDF, caricarli in potenza
  2. Sincronizzare l'elenco contatti con l'indirizzobook di Teams

Problemi noti e limitazioni

Download/caricamento di file

I file vengono caricati come dati di modulo multipart in formato binario. Lo stesso vale per il download: i file vengono forniti così come con un nome file suggerito nell'intestazione , come nello standard HTTP

Ratelimiting

Mirare a non eseguire più di 5000 richieste al minuto. Viene imposto un tassolimit sull'API per garantire che il sistema possa servire rapidamente gli utenti

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita Parametri per la creazione della connessione. Tutte le aree geografiche Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome TIPO Description Obbligatorio
API-Key securestring API-Key per questa API Vero

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 100 60 secondi

Azioni

(Legacy) Caricare la fattura

Caricare un file PDF in Impower usando l'API legacy. Usare invece l'operazione uploadInvoiceUsingPOST.

Aggiornare il testo della prenotazione della fattura specificata

Aggiornare il testo della prenotazione

Aggiornare un documento esistente in base al corpo della richiesta specificato

Tutte le informazioni necessarie si trovano nel corpo della richiesta

Aggiornare un tag documento esistente in base all'ID specificato

Il tag del documento aggiornato verrà restituito come risposta

Aggiornare una connessione

Aggiornare una connessione

Aggiornare una fattura in base ai campi forniti

Aggiornare la fattura

Caricare il documento PDF della fattura

Per impostazione predefinita, il documento verrà eseguito tramite un'analisi OCR

Creare un nuovo documento in base al file specificato

Il documento appena creato verrà restituito come risposta

Creare un nuovo tag documento

Il tag del documento appena creato verrà restituito come risposta

Dettagli fattura legacy

Ottenere i dettagli della fattura da Impower tramite l'API legacy. Usare invece getInvoiceByIdUsingGET.

Eliminare un documento esistente in base all'ID specificato

Impossibile eliminare i documenti generati dal sistema

Eliminare un tag documento esistente in base all'ID specificato

I tag generati dal sistema non possono essere eliminati

Eliminare una connessione

Eliminare una connessione

Leggere una connessione

Leggere una connessione

Ottenere contratti in base ai parametri di filtro specificati

Recuperare i contratti in base ai parametri di filtro specificati

Ottenere documenti in base ai parametri di filtro specificati

Recuperare i documenti in base ai parametri di filtro specificati

Ottenere i contatti in base ai parametri di filtro specificati

Recuperare i contatti in base ai parametri di filtro specificati

Ottenere i dettagli di un codice di errore specifico

Recupera la descrizione di un codice di errore specifico

Ottenere i tag del documento

I tag di documento standard e specifici del dominio verranno restituiti come risposta

Ottenere le fatture in base ai parametri di filtro specificati

Recupera le fatture in base ai parametri di filtro specificati

Ottenere le proprietà in base ai parametri di filtro specificati

Recuperare le proprietà in base ai parametri di filtro specificati

Ottenere tutte le unità in base ai parametri di filtro specificati

Restituisce tutte le unità che rispettano i criteri di filtro specificati

Ottenere tutti i valori predefiniti del codice di errore

Restituisce un elenco di tutti i codici di errore predefiniti

Ottenere un'unità in base all'ID specificato

Restituire l'unità con l'ID specificato

Ottenere un contatto in base all'ID specificato

Recupera un contatto in base all'ID specificato

Ottenere un contratto in base all'ID specificato

Recupera un contratto in base all'ID specificato

Ottenere una fattura in base all'ID specificato

Recupera una fattura in base all'ID specificato

Ottenere una proprietà in base all'ID specificato

Recupera una proprietà in base all'ID specificato

Scaricare più documenti in base alle condizioni di filtro specificate

I documenti sono disponibili in formato ZIP

Scaricare un singolo documento in base all'ID specificato

Il formato del documento è definito dal mimetype

(Legacy) Caricare la fattura

Caricare un file PDF in Impower usando l'API legacy. Usare invece l'operazione uploadInvoiceUsingPOST.

Parametri

Nome Chiave Necessario Tipo Descrizione
Specificare il file PDF da caricare
file True file

Specificare il file PDF da caricare

Restituisce

LegacyInvoiceDto
LegacyInvoiceDto

Aggiornare il testo della prenotazione della fattura specificata

Aggiornare il testo della prenotazione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID univoco dell'articolo di prenotazione della fattura
invoiceItemId True integer

ID univoco dell'articolo di prenotazione della fattura

Testo di prenotazione dell'articolo della fattura.
bookingText string

Testo di prenotazione dell'articolo della fattura.

Restituisce

InvoiceItemDto
InvoiceItemDto

Aggiornare un documento esistente in base al corpo della richiesta specificato

Tutte le informazioni necessarie si trovano nel corpo della richiesta

Parametri

Nome Chiave Necessario Tipo Descrizione
Nuovo valore dell'importo del documento da aggiornare a
amount float

Nuovo valore dell'importo del documento da aggiornare a

Nuovo edificio a cui assegnare il documento.
buildingId integer

Nuovo edificio a cui assegnare il documento.

Nuovo contatto a cui assegnare il documento
contactId integer

Nuovo contatto a cui assegnare il documento

Nuovo contratto a cui assegnare il documento
contractId integer

Nuovo contratto a cui assegnare il documento

Identificatore univoco del documento da aggiornare
id True integer

Identificatore univoco del documento da aggiornare

Nuova data di rilascio del documento in cui aggiornare
issuedDate string

Nuova data di rilascio del documento in cui aggiornare

Nuovo valore a cui aggiornare il nome del documento
name string

Nuovo valore a cui aggiornare il nome del documento

Nuova proprietà a cui assegnare il documento
propertyId integer

Nuova proprietà a cui assegnare il documento

Nuovo ID del processo di origine a cui assegnare il documento
sourceId integer

Nuovo ID del processo di origine a cui assegnare il documento

Identificatori dei tag da assegnare al documento
tagIds array of integer

Identificatori dei tag da assegnare al documento

Nuova unità a cui assegnare il documento
unitId integer

Nuova unità a cui assegnare il documento

Restituisce

Aggiornare un tag documento esistente in base all'ID specificato

Il tag del documento aggiornato verrà restituito come risposta

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di un tag di documento
tagId True integer

Identificatore univoco di un tag di documento

Nuova descrizione del tag del documento.
description string

Nuova descrizione del tag del documento.

Nuovo nome del tag del documento.
name string

Nuovo nome del tag del documento.

Restituisce

Classe modello di un tag di documento.

DocumentTagDto
DocumentTagDto

Aggiornare una connessione

Aggiornare una connessione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID della connessione
connectionIdX True integer

ID della connessione

Nome della connessione come deve essere presentato nell'interfaccia utente. Se non specificato, verrà impostato come predefinito il nome dell'applicazione
name string

Nome della connessione come deve essere presentato nell'interfaccia utente. Se non specificato, verrà impostato come predefinito il nome dell'applicazione

L'URL verrà chiamato con un token di autorizzazione che è possibile convalidare e il corpo seguente: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
webhookUrl string

L'URL verrà chiamato con un token di autorizzazione che è possibile convalidare e il corpo seguente: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}

Restituisce

Dati che descrivono una connessione esistente

ConnectionDto
ConnectionDto

Aggiornare una fattura in base ai campi forniti

Aggiornare la fattura

Parametri

Nome Chiave Necessario Tipo Descrizione
ID univoco di una fattura
invoiceId True integer

ID univoco di una fattura

Nuova data emessa della fattura.
issuedDate string

Nuova data emessa della fattura.

Nuovo nome della fattura.
name string

Nuovo nome della fattura.

Restituisce

Struttura dei dati della fattura.

InvoiceDto
InvoiceDto

Caricare il documento PDF della fattura

Per impostazione predefinita, il documento verrà eseguito tramite un'analisi OCR

Parametri

Nome Chiave Necessario Tipo Descrizione
File PDF di una fattura
file True file

File PDF di una fattura

Restituisce

Struttura dei dati della fattura.

InvoiceDto
InvoiceDto

Creare un nuovo documento in base al file specificato

Il documento appena creato verrà restituito come risposta

Parametri

Nome Chiave Necessario Tipo Descrizione
File PDF da caricare
file True file

File PDF da caricare

Restituisce

Struttura dei dati del documento.

DocumentDto
DocumentDto

Creare un nuovo tag documento

Il tag del documento appena creato verrà restituito come risposta

Parametri

Nome Chiave Necessario Tipo Descrizione
Descrizione del tag del documento appena creato.
description string

Descrizione del tag del documento appena creato.

Nome del tag del documento appena creato.
name string

Nome del tag del documento appena creato.

Restituisce

Classe modello di un tag di documento.

DocumentTagDto
DocumentTagDto

Dettagli fattura legacy

Ottenere i dettagli della fattura da Impower tramite l'API legacy. Usare invece getInvoiceByIdUsingGET.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID fattura
invoiceId True integer

Specificare l'ID fattura per i dettagli

Restituisce

LegacyInvoiceDto
LegacyInvoiceDto

Eliminare un documento esistente in base all'ID specificato

Impossibile eliminare i documenti generati dal sistema

Parametri

Nome Chiave Necessario Tipo Descrizione
documentId
documentId True integer

documentId

Eliminare un tag documento esistente in base all'ID specificato

I tag generati dal sistema non possono essere eliminati

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco del tag del documento da eliminare
tagId True integer

Identificatore univoco del tag del documento da eliminare

Eliminare una connessione

Eliminare una connessione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID della connessione
connectionIdX True integer

ID della connessione

Leggere una connessione

Leggere una connessione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID della connessione
connectionIdX True integer

ID della connessione

Restituisce

Dati che descrivono una connessione esistente

ConnectionDto
ConnectionDto

Ottenere contratti in base ai parametri di filtro specificati

Recuperare i contratti in base ai parametri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
ID dell'istanza del contatto a cui è associato il contratto.
contactId integer

ID dell'istanza del contatto a cui è associato il contratto.

Elenco di ID contratto per cui filtrare i contratti.
contractIds array

Elenco di ID contratto per cui filtrare i contratti.

Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

ID dell'istanza della proprietà a cui appartiene il contratto.
propertyId integer

ID dell'istanza della proprietà a cui appartiene il contratto.

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

Tipo del contratto. Opzioni: OWNER | TENANT | PROPERTY_OWNER
type array

Tipo del contratto. Opzioni: OWNER | TENANT | PROPERTY_OWNER

ID dell'istanza dell'unità a cui è associato il contratto.
unitId integer

ID dell'istanza dell'unità a cui è associato il contratto.

Restituisce contratti validi alla data. Null viene interpretato come inizio/fine dell'ora.
validAtDate string

Restituisce contratti validi alla data. Null viene interpretato come inizio/fine dell'ora.

Restituisce

PageOfContractDto
PageOfContractDto

Ottenere documenti in base ai parametri di filtro specificati

Recuperare i documenti in base ai parametri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome contabile della proprietà.
accountant string

Nome contabile della proprietà.

Nome amministratore della proprietà.
administrator string

Nome amministratore della proprietà.

ID dell'entità contatto a cui appartiene il documento.
contactId integer

ID dell'entità contatto a cui appartiene il documento.

Documenti collegati a contratti con un nome simile.
contractName string

Documenti collegati a contratti con un nome simile.

ID dei documenti da restituire.
documentIds array

ID dei documenti da restituire.

Nome dei documenti da restituire.
documentName string

Nome dei documenti da restituire.

Data emessa del documento.
issuedDate string

Data emessa del documento.

Documenti con data di rilascio precedente.
maxIssuedDate string

Documenti con data di rilascio precedente.

Documenti con data di rilascio successiva.
minIssuedDate string

Documenti con data di rilascio successiva.

Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

ID leggibile della proprietà a cui appartiene il documento.
propertyHrId string

ID leggibile della proprietà a cui appartiene il documento.

ID della proprietà a cui appartiene il documento.
propertyId integer

ID della proprietà a cui appartiene il documento.

Nome della proprietà a cui appartiene il documento.
propertyName string

Nome della proprietà a cui appartiene il documento.

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

ID dell'entità di origine a cui appartiene il documento.
sourceId integer

ID dell'entità di origine a cui appartiene il documento.

Tipi di origine del documento.
sourceType array

Tipi di origine del documento.

Id dei tag a cui è associato il documento.
tagIds array

Id dei tag a cui è associato il documento.

Nome simile del tag a cui è associato il documento.
tagName string

Nome simile del tag a cui è associato il documento.

ID dell'entità unità a cui appartiene il documento.
unitId integer

ID dell'entità unità a cui appartiene il documento.

Restituisce

PageOfDocumentDto
PageOfDocumentDto

Ottenere i contatti in base ai parametri di filtro specificati

Recuperare i contatti in base ai parametri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
Elenco di ID contatto per cui filtrare i contatti.
contactIds array

Elenco di ID contatto per cui filtrare i contatti.

Indirizzo di posta elettronica del contatto.
email string

Indirizzo di posta elettronica del contatto.

Qualsiasi nome del contatto. Potrebbe essere il nome, il cognome o il nome della società.
name string

Qualsiasi nome del contatto. Potrebbe essere il nome, il cognome o il nome della società.

Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

Restituisce

PageOfContactDto
PageOfContactDto

Ottenere i dettagli di un codice di errore specifico

Recupera la descrizione di un codice di errore specifico

Parametri

Nome Chiave Necessario Tipo Descrizione
value
value True string

value

Restituisce

ErrorCodeDetailsDto
ErrorCodeDetailsDto

Ottenere i tag del documento

I tag di documento standard e specifici del dominio verranno restituiti come risposta

Parametri

Nome Chiave Necessario Tipo Descrizione
Stringa di ricerca applicata al nome e alla descrizione
description string

Stringa di ricerca applicata al nome e alla descrizione

Restituisce

Ottenere le fatture in base ai parametri di filtro specificati

Recupera le fatture in base ai parametri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco del contatto controparte
counterpartContactId integer

Identificatore univoco del contatto controparte

Data delle fatture da recuperare
issuedDate string

Data delle fatture da recuperare

Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

Identificatore univoco della proprietà a cui appartiene una fattura
propertyId integer

Identificatore univoco della proprietà a cui appartiene una fattura

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

Stati delle fatture da recuperare
states array

Stati delle fatture da recuperare

Restituisce

PageOfInvoiceDto
PageOfInvoiceDto

Ottenere le proprietà in base ai parametri di filtro specificati

Recuperare le proprietà in base ai parametri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome della proprietà.
name string

Nome della proprietà.

Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

ID leggibile della proprietà.
propertyHrId string

ID leggibile della proprietà.

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

Restituisce

PageOfPropertyDto
PageOfPropertyDto

Ottenere tutte le unità in base ai parametri di filtro specificati

Restituisce tutte le unità che rispettano i criteri di filtro specificati

Parametri

Nome Chiave Necessario Tipo Descrizione
Direzione di ordinamento. Valori possibili: ASC, DESC
order string

Direzione di ordinamento. Valori possibili: ASC, DESC

Numero di pagina da restituire
page integer

Numero di pagina da restituire

Identificatore univoco della proprietà a cui appartiene un'unità
propertyId integer

Identificatore univoco della proprietà a cui appartiene un'unità

Numero di elementi da restituire in una singola pagina
size integer

Numero di elementi da restituire in una singola pagina

Parametro di ordinamento
sort string

Parametro di ordinamento

Restituisce

PageOfUnitDto
PageOfUnitDto

Ottenere tutti i valori predefiniti del codice di errore

Restituisce un elenco di tutti i codici di errore predefiniti

Restituisce

Nome Percorso Tipo Descrizione
array of string

Ottenere un'unità in base all'ID specificato

Restituire l'unità con l'ID specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
ID univoco di un'unità
unitId True integer

ID univoco di un'unità

Restituisce

Struttura dei dati unità.

UnitDto
UnitDto

Ottenere un contatto in base all'ID specificato

Recupera un contatto in base all'ID specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di un contatto
contactId True integer

Identificatore univoco di un contatto

Restituisce

Un contatto rappresenta una persona fisica o una persona giuridica e il modo per contattarli. Un'identità o una società ha più indirizzi postali tramite cui può essere contattato. Questi sono rappresentati come 2 contatti diversi.

ContactDto
ContactDto

Ottenere un contratto in base all'ID specificato

Recupera un contratto in base all'ID specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di un contratto
contractId True integer

Identificatore univoco di un contratto

Restituisce

Struttura dei dati del contratto.

ContractDto
ContractDto

Ottenere una fattura in base all'ID specificato

Recupera una fattura in base all'ID specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di una fattura
invoiceId True integer

Identificatore univoco di una fattura

Restituisce

Struttura dei dati della fattura.

InvoiceDto
InvoiceDto

Ottenere una proprietà in base all'ID specificato

Recupera una proprietà in base all'ID specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di una proprietà
propertyId True integer

Identificatore univoco di una proprietà

Restituisce

Struttura dei dati delle proprietà.

PropertyDto
PropertyDto

Scaricare più documenti in base alle condizioni di filtro specificate

I documenti sono disponibili in formato ZIP

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome contabile della proprietà.
accountant string

Nome contabile della proprietà.

Nome amministratore della proprietà.
administrator string

Nome amministratore della proprietà.

ID dell'entità contatto a cui appartiene il documento.
contactId integer

ID dell'entità contatto a cui appartiene il documento.

Documenti collegati a contratti con un nome simile.
contractName string

Documenti collegati a contratti con un nome simile.

ID dei documenti da restituire.
documentIds array

ID dei documenti da restituire.

Nome dei documenti da restituire.
documentName string

Nome dei documenti da restituire.

Data emessa del documento.
issuedDate string

Data emessa del documento.

Documenti con data di rilascio precedente.
maxIssuedDate string

Documenti con data di rilascio precedente.

Documenti con data di rilascio successiva.
minIssuedDate string

Documenti con data di rilascio successiva.

ID leggibile della proprietà a cui appartiene il documento.
propertyHrId string

ID leggibile della proprietà a cui appartiene il documento.

ID della proprietà a cui appartiene il documento.
propertyId integer

ID della proprietà a cui appartiene il documento.

Nome della proprietà a cui appartiene il documento.
propertyName string

Nome della proprietà a cui appartiene il documento.

ID dell'entità di origine a cui appartiene il documento.
sourceId integer

ID dell'entità di origine a cui appartiene il documento.

Tipi di origine del documento.
sourceType array

Tipi di origine del documento.

Id dei tag a cui è associato il documento.
tagIds array

Id dei tag a cui è associato il documento.

Nome simile del tag a cui è associato il documento.
tagName string

Nome simile del tag a cui è associato il documento.

ID dell'entità unità a cui appartiene il documento.
unitId integer

ID dell'entità unità a cui appartiene il documento.

Restituisce

response
file

Scaricare un singolo documento in base all'ID specificato

Il formato del documento è definito dal mimetype

Parametri

Nome Chiave Necessario Tipo Descrizione
Identificatore univoco di un documento
documentId True integer

Identificatore univoco di un documento

Restituisce

response
file

Trigger

Creare una connessione all'applicazione

Creare una connessione all'applicazione

Creare una connessione all'applicazione

Creare una connessione all'applicazione

Restituisce

Definizioni

ConnectionNotificationDto

Nome Percorso Tipo Descrizione
ID della connessione a cui si applica la notifica
connectionId integer

connectionId

tipo di entità
entityType string

tipo di entità

entityId
entityId integer

entityId

eventType
eventType string

eventType

ConnectionDto

Dati che descrivono una connessione esistente

Nome Percorso Tipo Descrizione
ID di un'applicazione
appId integer

ID di un'applicazione

Nome dell'applicazione della connessione
appName string

Nome dell'applicazione della connessione

Ora di creazione dell'entità.
created string

Ora di creazione dell'entità.

ID dell'entità.
id integer

ID dell'entità.

Nome della connessione
name string

Nome della connessione

Ora dell'ultimo aggiornamento dell'entità.
updated string

Ora dell'ultimo aggiornamento dell'entità.

Webhook della connessione che verrà chiamata come ''' AUTORIZZAZIONE POST https://your.webhook.url/path/somewhere : Bearer TOKEN { "connectionId": 0, "entityType": "properties|contacts|invoices|etc.", "entityId": 0, "eventType": "CREATE|UPDATE |DELETE" }'''
webhookUrl string

Webhook della connessione che verrà chiamata come

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

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

ContactDetailsDto

Dettagli del contatto

Nome Percorso Tipo Descrizione
Numero di telefono aziendale del contatto
businessPhoneNumber array of string

Numero di telefono aziendale del contatto

Data di nascita del contatto.
dateOfBirth string

Data di nascita del contatto.

Indirizzo di posta elettronica del contatto
email array of string

Indirizzo di posta elettronica del contatto

Numero fax del contatto
fax array of string

Numero fax del contatto

Numero di telefono cellulare del contatto
mobilePhoneNumber array of string

Numero di telefono cellulare del contatto

Numero di telefono privato del contatto
privatePhoneNumber array of string

Numero di telefono privato del contatto

Numero registro commerciale.
tradeRegisterNumber string

Numero registro commerciale.

PARTITA IVA del contatto.
vatId string

PARTITA IVA del contatto.

Sito Web del contatto
website array of string

Sito Web del contatto

ContactDto

Un contatto rappresenta una persona fisica o una persona giuridica e il modo per contattarli. Un'identità o una società ha più indirizzi postali tramite cui può essere contattato. Questi sono rappresentati come 2 contatti diversi.

Nome Percorso Tipo Descrizione
Nome della città.
city string

Nome della città.

Nome della società, nel caso in cui il contatto sia una società.
companyName string

Nome della società, nel caso in cui il contatto sia una società.

Codice paese in base allo standard ISO 3166-1 alfa-2.
country string

Codice paese in base allo standard ISO 3166-1 alfa-2.

Ora di creazione del contatto.
created string

Ora di creazione del contatto.

ContactDetailsDto
details ContactDetailsDto

Dettagli del contatto

Nome del contatto, nel caso in cui il contatto sia una persona.
firstName string

Nome del contatto, nel caso in cui il contatto sia una persona.

ID dell'istanza del contatto.
id integer

ID dell'istanza del contatto.

Cognome del contatto, nel caso in cui il contatto sia una persona.
lastName string

Cognome del contatto, nel caso in cui il contatto sia una persona.

Numero civico.
number string

Numero civico.

Codice postale o postale. Assicurarsi che sia specificato per ogni persona che richiede un contatto di lettera fisica tramite e-post.
postalCode string

Codice postale o postale. Assicurarsi che sia specificato per ogni persona che richiede un contatto di lettera fisica tramite e-post.

Nome destinatario del contatto.
recipientName string

Nome destinatario del contatto.

Formula standard di parole utilizzate per affrontare il contatto.
salutation string

Formula standard di parole utilizzate per affrontare il contatto.

Nome dello stato, detto anche provincia, suddivisione o area geografica.
state string

Nome dello stato, detto anche provincia, suddivisione o area geografica.

Nome della strada.
street string

Nome della strada.

Posizione del contatto.
title string

Posizione del contatto.

Ora dell'ultimo aggiornamento del contatto.
updated string

Ora dell'ultimo aggiornamento del contatto.

ContactSimpleDto

Contattare la struttura dei dati semplificata.

Nome Percorso Tipo Descrizione
ID dell'istanza del contatto.
id integer

ID dell'istanza del contatto.

Nome del contatto. Per informazioni più dettagliate, caricare il contatto tramite ID.
name string

Nome del contatto. Per informazioni più dettagliate, caricare il contatto tramite ID.

ContractDto

Struttura dei dati del contratto.

Nome Percorso Tipo Descrizione
Elenco dei contatti associati al contratto.
contacts array of ContactSimpleDto

Elenco dei contatti associati al contratto.

Numero del contratto.
contractNumber string

Numero del contratto.

Ora di creazione del contratto.
created string

Ora di creazione del contratto.

Data di fine del periodo di validità del contratto. Null viene interpretato come fine dell'ora.
endDate string

Data di fine del periodo di validità del contratto. Null viene interpretato come fine dell'ora.

ID dell'istanza del contratto.
id integer

ID dell'istanza del contratto.

Descrive se il contratto è un contratto di tipo vacante. A partire da ora può essere true solo nel caso in cui il contratto sia di tipo TENANT. Il contratto vacante indica che l'unità non è in affitto.
isVacant boolean

Descrive se il contratto è un contratto di tipo vacante. A partire da ora può essere true solo nel caso in cui il contratto sia di tipo TENANT. Il contratto vacante indica che l'unità non è in affitto.

Nome del contratto costituito dalla chiave di unità e dal nome del contatto postale.
name string

Nome del contratto costituito dalla chiave di unità e dal nome del contatto postale.

ID dell'istanza della proprietà a cui appartiene il contratto.
propertyId integer

ID dell'istanza della proprietà a cui appartiene il contratto.

Data di inizio del periodo di validità del contratto. Null viene interpretato come inizio dell'ora.
startDate string

Data di inizio del periodo di validità del contratto. Null viene interpretato come inizio dell'ora.

Tipo del contratto. 1. PROPRIETARIO : un contratto di questo tipo dimostra la proprietà dell'unità. 2. TENANT : un contratto di questo tipo è l'affitto dell'unità. 3. PROPERTY_OWNER - un contratto di questo tipo dimostra la proprietà della proprietà.
type string

Tipo del contratto.

  1. OWNER: un contratto di questo tipo dimostra la proprietà dell'unità.
  2. TENANT: un contratto di questo tipo è l'affitto dell'unità.
  3. PROPERTY_OWNER : un contratto di questo tipo dimostra la proprietà della proprietà.
ID dell'istanza dell'unità a cui appartiene il contratto.
unitId integer

ID dell'istanza dell'unità a cui appartiene il contratto.

Ora dell'ultimo aggiornamento del contratto.
updated string

Ora dell'ultimo aggiornamento del contratto.

DocumentDto

Struttura dei dati del documento.

Nome Percorso Tipo Descrizione
Importo totale presente nel documento.
amount float

Importo totale presente nel documento.

ID dell'edificio a cui appartiene il documento.
buildingId integer

ID dell'edificio a cui appartiene il documento.

ID del contatto a cui appartiene il documento.
contactId integer

ID del contatto a cui appartiene il documento.

ID del contratto a cui appartiene il documento.
contractId integer

ID del contratto a cui appartiene il documento.

Ora di creazione del documento.
created string

Ora di creazione del documento.

ID dell'istanza del documento.
id integer

ID dell'istanza del documento.

Data emessa del documento.
issuedDate string

Data emessa del documento.

Nome dell'istanza del documento.
name string

Nome dell'istanza del documento.

ID leggibile della proprietà a cui viene assegnato il documento.
propertyHrId string

ID leggibile della proprietà a cui viene assegnato il documento.

ID della proprietà a cui appartiene il documento.
propertyId integer

ID della proprietà a cui appartiene il documento.

Nome della proprietà a cui è assegnato il documento.
propertyName string

Nome della proprietà a cui è assegnato il documento.

ID dell'entità di origine a cui appartiene il documento.
sourceId integer

ID dell'entità di origine a cui appartiene il documento.

Tipo di origine del documento. Insieme all'ID identifica il processo aziendale con lo stesso nome a cui proviene/è associato il documento. Può essere null.
sourceType string

Tipo di origine del documento. Insieme all'ID identifica il processo aziendale con lo stesso nome a cui proviene/è associato il documento. Può essere null.

Stato del documento.
state string

Stato del documento.

tags
tags array of DocumentTagSimpleDto
ID leggibile dell'unità a cui è assegnato il documento.
unitHrId string

ID leggibile dell'unità a cui è assegnato il documento.

ID dell'unità a cui appartiene il documento.
unitId integer

ID dell'unità a cui appartiene il documento.

Ora dell'ultimo aggiornamento del documento.
updated string

Ora dell'ultimo aggiornamento del documento.

DocumentTagDto

Classe modello di un tag di documento.

Nome Percorso Tipo Descrizione
Descrizione del tag del documento.
description string

Descrizione del tag del documento.

ID del tag del documento.
id integer

ID del tag del documento.

Nome del tag del documento.
name string

Nome del tag del documento.

DocumentTagSimpleDto

Classe modello di un tag di documento.

Nome Percorso Tipo Descrizione
Identificatore univoco del tag del documento.
id integer

Identificatore univoco del tag del documento.

Nome del tag del documento.
name string

Nome del tag del documento.

ErrorCodeDetailsDto

Nome Percorso Tipo Descrizione
codice
code string
descrizione
description string

InvoiceDto

Struttura dei dati della fattura.

Nome Percorso Tipo Descrizione
Importo da pagare in base alla fattura.
amount float

Importo da pagare in base alla fattura.

ID del contatto controparte della fattura.
counterpartContactId integer

ID del contatto controparte della fattura.

Nome del contatto controparte della fattura.
counterpartContactName string

Nome del contatto controparte della fattura.

Ora di creazione dell'entità.
created string

Ora di creazione dell'entità.

ID dell'entità.
id integer

ID dell'entità.

Data emessa della fattura.
issuedDate string

Data emessa della fattura.

items
items array of InvoiceItemDto
Nome della fattura.
name string

Nome della fattura.

Numero BIC del conto bancario della controparte.
orderCounterpartBic string

Numero BIC del conto bancario della controparte.

IBAN del conto bancario della controparte.
orderCounterpartIban string

IBAN del conto bancario della controparte.

Numero di giorni prima o dopo la data di prenotazione in cui verrà visualizzato l'ordine bancario per l'esecuzione.
orderDayOffset integer

Numero di giorni prima o dopo la data di prenotazione in cui verrà visualizzato l'ordine bancario per l'esecuzione.

Identificatore univoco del conto bancario della proprietà.
orderPropertyBankAccountId integer

Identificatore univoco del conto bancario della proprietà.

Numero BIC del conto bancario di proprietà.
orderPropertyBic string

Numero BIC del conto bancario di proprietà.

IBAN del conto bancario di proprietà.
orderPropertyIban string

IBAN del conto bancario di proprietà.

True nel caso in cui sia presente un ordine corrispondente della fattura.
orderRequired boolean

True nel caso in cui sia presente un ordine corrispondente della fattura.

Istruzione dell'ordine generato.
orderStatement string

Istruzione dell'ordine generato.

ID leggibile della proprietà a cui appartiene la fattura.
propertyHrId string

ID leggibile della proprietà a cui appartiene la fattura.

ID della proprietà a cui appartiene la fattura.
propertyId integer

ID della proprietà a cui appartiene la fattura.

Nome della proprietà a cui appartiene la fattura.
propertyName string

Nome della proprietà a cui appartiene la fattura.

Stato della fattura. Valori possibili: 1. BOZZA - Fattura creata, ma incompleta. 2. PRONTO - Fattura pronta per essere prenotato. 3. PRENOTATO - fattura prenotato. 4. SCHEDULED : si applica solo alle fatture ricorrenti. 5. REVERSED : tutte le prenotazioni generate dalla fattura sono state annullate.
state string

Stato della fattura. Valori possibili:

  1. BOZZA: fattura creata, ma incompleta.
  2. READY: fattura pronta per essere prenotato.
  3. PRENOTATO - fattura prenotato.
  4. SCHEDULED: si applica solo alle fatture ricorrenti.
  5. REVERSED: tutte le prenotazioni generate dalla fattura sono state annullate.
Ora dell'ultimo aggiornamento dell'entità.
updated string

Ora dell'ultimo aggiornamento dell'entità.

InvoiceItemDto

Nome Percorso Tipo Descrizione
Codice dell'account dell'articolo di prenotazione.
accountCode string

Codice dell'account dell'articolo di prenotazione.

ID account dell'elemento di prenotazione.
accountId integer

ID account dell'elemento di prenotazione.

Nome dell'account dell'elemento di prenotazione.
accountName string

Nome dell'account dell'elemento di prenotazione.

Importo corrispondente all'articolo di prenotazione.
amount float

Importo corrispondente all'articolo di prenotazione.

Testo di prenotazione dell'articolo di prenotazione.
bookingText string

Testo di prenotazione dell'articolo di prenotazione.

Ora di creazione dell'articolo della fattura.
created string

Ora di creazione dell'articolo della fattura.

Identificatore univoco dell'elemento di prenotazione.
id integer

Identificatore univoco dell'elemento di prenotazione.

Importo rilevante per la dichiarazione d'imposta sul reddito in base alla legge sul reddito: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
laborCostAmount float

Importo rilevante per la dichiarazione d'imposta sul reddito in base alla legge sul reddito: Einkommenstueregesetz EStG 35a.

A seconda del tipo selezionato: le percentuali degli importi verranno segnalate sulle 35a dipendenze di più segnalazioni secondo il Income Tax Act: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html). Ad esempio: Insediamento housemoney (Hausgeldabrechnung) o rapporto Opscost (Nebenkostenabrechnung). 1. HOUSEHOLD_RELATED_SERVICES -ungenhaltsnahe Dienstleistungen 2. TECHNICIAN_SERVICE -haltsnahe Handwerkerleistungen 3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse 4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen frameworkhaltsnahen Beschäftigungsverhältnissen
laborCostType string

A seconda del tipo selezionato: le percentuali degli importi verranno segnalate sulle 35a segnalazioni di più segnalazioni secondo il Income Tax Act: Einkommenstueregesetz EStG 35a.

Ad esempio: Insediamento housemoney (Hausgeldabrechnung) o rapporto Opscost (Nebenkostenabrechnung).

  1. HOUSEHOLD_RELATED_SERVICES -haltsnahe Dienstleistungen
  2. TECHNICIAN_SERVICE -haltsnahe Handwerkerleistungen
  3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse
  4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen frameworkhaltsnahen Beschäftigungsverhältnissen
Ora dell'ultimo aggiornamento dell'articolo della fattura.
updated string

Ora dell'ultimo aggiornamento dell'articolo della fattura.

Importo iva corrispondente dell'articolo di prenotazione.
vatAmount float

Importo iva corrispondente dell'articolo di prenotazione.

Percentuale iva corrispondente dell'importo totale dell'importo iva.
vatPercentage float

Percentuale iva corrispondente dell'importo totale dell'importo iva.

PageOfContactDto

Nome Percorso Tipo Descrizione
contenuto
content array of ContactDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfContractDto

Nome Percorso Tipo Descrizione
contenuto
content array of ContractDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfDocumentDto

Nome Percorso Tipo Descrizione
contenuto
content array of DocumentDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfInvoiceDto

Nome Percorso Tipo Descrizione
contenuto
content array of InvoiceDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfPropertyDto

Nome Percorso Tipo Descrizione
contenuto
content array of PropertyDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

PageOfUnitDto

Nome Percorso Tipo Descrizione
contenuto
content array of UnitDto
empty
empty boolean
primo
first boolean
ultimo
last boolean
numero
number integer
numberOfElements
numberOfElements integer
Paginabile
pageable Pageable
size
size integer
Ordinamento
sort Sort
totalElements
totalElements integer
totalPages
totalPages integer

Paginabile

Nome Percorso Tipo Descrizione
offset
offset integer
pageNumber
pageNumber integer
pageSize
pageSize integer
Paging
paged boolean
Ordinamento
sort Sort
unpaged
unpaged boolean

PropertyDto

Struttura dei dati delle proprietà.

Nome Percorso Tipo Descrizione
Ora di creazione dell'istanza della proprietà.
created string

Ora di creazione dell'istanza della proprietà.

ID dell'istanza della proprietà.
id integer

ID dell'istanza della proprietà.

Nome dell'istanza della proprietà.
name string

Nome dell'istanza della proprietà.

ID leggibile dell'istanza della proprietà.
propertyHrId string

ID leggibile dell'istanza della proprietà.

Stato corrente della proprietà. 1. BOZZA - proprietà non ancora attivata, pertanto non è possibile generare prenotazioni/ordini bancari/report. 2. READY : la proprietà è stata attivata e può essere utilizzata per la generazione di prenotazioni/ordini bancari/report. 3. DISABLED - la proprietà è stata disattivata e non può più generare prenotazioni/ordini bancari/rapporti.
state string

Stato corrente della proprietà.

  1. BOZZA - proprietà non ancora attivata, pertanto non è possibile generare prenotazioni/ordini bancari/report.
  2. READY: la proprietà è stata attivata e può essere utilizzata per la generazione di prenotazioni/ordini bancari/report.
  3. DISABLED : la proprietà è stata disattivata e non può più generare prenotazioni/ordini bancari/report.
Tipo di amministrazione della proprietà. OWNER - Home Owner Association. NOLEGGIO - Gestione tenant.
type string

Tipo di amministrazione della proprietà. OWNER - Home Owner Association. NOLEGGIO - Gestione tenant.

Ora di aggiornamento dell'istanza della proprietà.
updated string

Ora di aggiornamento dell'istanza della proprietà.

Ordinamento

Nome Percorso Tipo Descrizione
empty
empty boolean
assortito
sorted boolean
non ordinamento
unsorted boolean

UnitDto

Struttura dei dati unità.

Nome Percorso Tipo Descrizione
Ora di creazione dell'istanza dell'unità.
created string

Ora di creazione dell'istanza dell'unità.

Piano su cui si trova l'unità.
floor string

Piano su cui si trova l'unità.

ID dell'istanza dell'unità.
id integer

ID dell'istanza dell'unità.

Posizione dell'unità all'interno del pavimento.
position string

Posizione dell'unità all'interno del pavimento.

ID dell'istanza della proprietà a cui appartiene l'unità.
propertyId integer

ID dell'istanza della proprietà a cui appartiene l'unità.

Scopo per cui viene usata l'unità. APARTMENT - unità utilizzata per scopi residenziali. PARCHEGGIO - unità utilizzata per il parcheggio. COMMERCIAL : unità utilizzata per scopi commerciali/commerciali. OTHER : unità usata per altri scopi.
type string

Scopo per cui viene usata l'unità. APARTMENT - unità utilizzata per scopi residenziali. PARCHEGGIO - unità utilizzata per il parcheggio. COMMERCIAL : unità utilizzata per scopi commerciali/commerciali. OTHER : unità usata per altri scopi.

ID leggibile dell'unità.
unitHrId string

ID leggibile dell'unità.

La classificazione definisce l'ordine di visualizzazione delle unità nell'interfaccia utente/report. L'utente può aggiornarlo nell'interfaccia utente.
unitRank integer

La classificazione definisce l'ordine di visualizzazione delle unità nell'interfaccia utente/report. L'utente può aggiornarlo nell'interfaccia utente.

Ora di aggiornamento dell'istanza dell'unità.
updated string

Ora di aggiornamento dell'istanza dell'unità.

LegacyInvoiceDto

Nome Percorso Tipo Descrizione
Controparte BIC
counterpartBic string

Controparte BIC

ContactID Controparte
counterpartContactId integer

ContactID Controparte

Controparte IBAN
counterpartIban string

Controparte IBAN

Controparte
counterpartName string

Controparte

Date
created string

Date

URL fattura
documentUrl string

URL fattura

Documento d'identità
id integer

Documento d'identità

Data fattura
invoiceDate string

Data fattura

ID fattura
invoiceHrId string

ID fattura

Numero di fattura
invoiceNumber string

Numero di fattura

Data di destinazione del pagamento
paymentTargetDate string

Data di destinazione del pagamento

Tipo di pagamento
paymentType string

Tipo di pagamento

Proprietà NR
propertyHrId string

Proprietà NR

ID proprietà
propertyId integer

ID proprietà

ID interno proprietà
propertyIdInternal string

ID interno proprietà

Nome della proprietà
propertyName string

Nome della proprietà

Numero di riferimento
refNr string

Numero di riferimento

Stato della fattura
state string

Stato della fattura

Totale lordo
totalGross float

Totale lordo

Totale netto
totalNet float

Totale netto

IVA inclusa.
vatIncluded boolean

IVA inclusa.

Percentuale iva
vatPercentage float

Percentuale iva

documento

Si tratta del tipo di dati di base 'file'.