Impower ERP (Preview)
Allow interaction with impower.de accounting system for property managers
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Api Support |
URL | https://impower.de |
support+api@impower.de |
Connector Metadata | |
---|---|
Publisher | Impower GmbH |
Website | https://www.impower.de |
Privacy policy | https://www.impower.de/datenschutzerklaerung |
Categories | Business Management;Finance |
The Impower connector allows you to access the masterdataset such as properties,units,contracts and contacts. Moreover you may upload documents and invoices. One may read the data on a scheduled basis, or by registering webhooks using the integrated trigger.
In order to use Impower you will need:
- Paid Impower subscription
- Powerautomate Premium subscription
To get the APIKey for your domain to connect powerautomate with, please write a request at support@impower.de.
Scenarios you might consider building:
- Watch a Sharepoint/Onedrive folder for changes and if new PDF files appear upload them to impower
- Synchronize the contact list with your teams addressbook
The files are uploaded as multipart form data in binary format. The same goes for download: files are provided as is with a suggested filename in the header - just as in http standard
Please aim not to do more than 5000 requests per minute. We impose a ratelimiting on the API to ensure that the system can serve users quickly
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API-Key | securestring | API-Key for this API | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
(Legacy) Upload invoice |
Upload a pdf file to Impower using legacy API. Use the uploadInvoiceUsingPOST operation instead. |
Create a new document based on given the file |
The newly created document will be returned as response |
Create a new document tag |
The newly created document tag will be returned as response |
Delete a connection |
Delete a connection |
Delete an existing document based on the given id |
System generated documents cannot be deleted |
Delete an existing document tag based on the given id |
System generated tags cannot be deleted |
Download a single document by given id |
Format of the document is defined by the mimetype |
Download multiple documents by given filter conditions |
Documents come in zip format |
Get a contact by the given id |
Retrieves a contact by the given id |
Get a contract by the given id |
Retrieves a contract by the given id |
Get a invoice by the given id |
Retrieves an invoice by the given id |
Get a property by the given id |
Retrieves a property by the given id |
Get a unit by the given id |
Return the unit having the given id |
Get all predefined error code values |
Returns a list of all predefined error codes |
Get all units by given filter parameters |
Returns all units respecting the given filter criteria |
Get contacts by the given filter parameters |
Retrieve contacts by the given filter parameters |
Get contracts by the given filter parameters |
Retrieve contracts by the given filter parameters |
Get details of a specific error code |
Retrieves the description of a specific error code |
Get document tags |
Standard and domain specific document tags will be returned as response |
Get documents by the given filter parameters |
Retrieve documents by the given filter parameters |
Get invoices by the given filter parameters |
Retrieves invoices by the given filter parameters |
Get properties by the given filter parameters |
Retrieve properties by the given filter parameters |
Legacy Invoice details |
Get invoice details from Impower via legacy API. Use getInvoiceByIdUsingGET instead. |
Read a connection |
Read a connection |
Update a connection |
Update a connection |
Update an existing document based on the given request body |
All the need information is in the request body |
Update an existing document tag based on the given id |
The updated document tag will be returned as response |
Update an invoice based on provided fields |
Update invoice |
Update booking text of the given invoice booking item |
Update booking text |
Upload invoice PDF document |
By default, the document will go though an OCR analysis |
Upload a pdf file to Impower using legacy API. Use the uploadInvoiceUsingPOST operation instead.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Specify the pdf file to upload
|
file | True | file |
Specify the pdf file to upload |
Returns
- LegacyInvoiceDto
- LegacyInvoiceDto
The newly created document will be returned as response
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
PDF file to upload
|
file | True | file |
PDF file to upload |
Returns
Document data structure.
- DocumentDto
- DocumentDto
The newly created document tag will be returned as response
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Description of the newly created document tag.
|
description | string |
Description of the newly created document tag. |
|
Name of the newly created document tag.
|
name | string |
Name of the newly created document tag. |
Returns
Model class of a document tag.
- DocumentTagDto
- DocumentTagDto
Delete a connection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of the connection
|
connectionIdX | True | integer |
Id of the connection |
System generated documents cannot be deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
documentId
|
documentId | True | integer |
documentId |
System generated tags cannot be deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of the document tag to be deleted
|
tagId | True | integer |
Unique identifier of the document tag to be deleted |
Format of the document is defined by the mimetype
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of a document
|
documentId | True | integer |
Unique identifier of a document |
Returns
- response
- file
Documents come in zip format
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Accountant name of the property.
|
accountant | string |
Accountant name of the property. |
|
Administrator name of the property.
|
administrator | string |
Administrator name of the property. |
|
ID of the contact entity the document belongs to.
|
contactId | integer |
ID of the contact entity the document belongs to. |
|
Documents linked to contracts with similar name.
|
contractName | string |
Documents linked to contracts with similar name. |
|
IDs of the documents to be returned.
|
documentIds | array |
IDs of the documents to be returned. |
|
Name of the documents to be returned.
|
documentName | string |
Name of the documents to be returned. |
|
Issued date of the document.
|
issuedDate | string |
Issued date of the document. |
|
Documents having issued date before.
|
maxIssuedDate | string |
Documents having issued date before. |
|
Documents having issued date after.
|
minIssuedDate | string |
Documents having issued date after. |
|
Human readable id of the property the document belongs to.
|
propertyHrId | string |
Human readable id of the property the document belongs to. |
|
ID of the property the document belongs to.
|
propertyId | integer |
ID of the property the document belongs to. |
|
Name of the property the document belongs to.
|
propertyName | string |
Name of the property the document belongs to. |
|
ID of the source entity the document belongs to.
|
sourceId | integer |
ID of the source entity the document belongs to. |
|
Source types of the document.
|
sourceType | array |
Source types of the document. |
|
IDs of tags the document is associated to.
|
tagIds | array |
IDs of tags the document is associated to. |
|
Similar name of tag the document is associate to.
|
tagName | string |
Similar name of tag the document is associate to. |
|
ID of the unit entity the document belongs to.
|
unitId | integer |
ID of the unit entity the document belongs to. |
Returns
- response
- file
Retrieves a contact by the given id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of a contact
|
contactId | True | integer |
Unique identifier of a contact |
Returns
A contact represents a natural person or legal entity, and the way to contact them. Shall an identity/company have multiple postal addresses through which it may be contacted. These are represented as 2 different contacts.
- ContactDto
- ContactDto
Retrieves a contract by the given id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of a contract
|
contractId | True | integer |
Unique identifier of a contract |
Returns
Contract data structure.
- ContractDto
- ContractDto
Retrieves an invoice by the given id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of an invoice
|
invoiceId | True | integer |
Unique identifier of an invoice |
Returns
Invoice data structure.
- InvoiceDto
- InvoiceDto
Retrieves a property by the given id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of a property
|
propertyId | True | integer |
Unique identifier of a property |
Returns
Property data structure.
- PropertyDto
- PropertyDto
Return the unit having the given id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id of a unit
|
unitId | True | integer |
Unique id of a unit |
Returns
Unit data structure.
- UnitDto
- UnitDto
Returns a list of all predefined error codes
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of string |
Returns all units respecting the given filter criteria
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
Unique identifier of the property a unit belongs to
|
propertyId | integer |
Unique identifier of the property a unit belongs to |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
Returns
- PageOfUnitDto
- PageOfUnitDto
Retrieve contacts by the given filter parameters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
List of contact ids to filter contacts by.
|
contactIds | array |
List of contact ids to filter contacts by. |
|
Email address of the contact.
|
string |
Email address of the contact. |
||
Any name of the contact. Might be first name, last name or company name.
|
name | string |
Any name of the contact. Might be first name, last name or company name. |
|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
Returns
- PageOfContactDto
- PageOfContactDto
Retrieve contracts by the given filter parameters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID of the contact instance the contract is associated with.
|
contactId | integer |
ID of the contact instance the contract is associated with. |
|
List of contract ids to filter contracts by.
|
contractIds | array |
List of contract ids to filter contracts by. |
|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
ID of the property instance the contract belongs to.
|
propertyId | integer |
ID of the property instance the contract belongs to. |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
|
Type of the contract. Options: OWNER | TENANT | PROPERTY_OWNER
|
type | array |
Type of the contract. Options: OWNER | TENANT | PROPERTY_OWNER |
|
ID of the unit instance the contract is associated with.
|
unitId | integer |
ID of the unit instance the contract is associated with. |
|
Return valid contracts at date. Null is interpreted as beginning/end of time.
|
validAtDate | string |
Return valid contracts at date. Null is interpreted as beginning/end of time. |
Returns
- PageOfContractDto
- PageOfContractDto
Retrieves the description of a specific error code
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
value
|
value | True | string |
value |
Returns
- ErrorCodeDetailsDto
- ErrorCodeDetailsDto
Standard and domain specific document tags will be returned as response
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Search string applied to name and description
|
description | string |
Search string applied to name and description |
Returns
- response
- array of DocumentTagDto
Retrieve documents by the given filter parameters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Accountant name of the property.
|
accountant | string |
Accountant name of the property. |
|
Administrator name of the property.
|
administrator | string |
Administrator name of the property. |
|
ID of the contact entity the document belongs to.
|
contactId | integer |
ID of the contact entity the document belongs to. |
|
Documents linked to contracts with similar name.
|
contractName | string |
Documents linked to contracts with similar name. |
|
IDs of the documents to be returned.
|
documentIds | array |
IDs of the documents to be returned. |
|
Name of the documents to be returned.
|
documentName | string |
Name of the documents to be returned. |
|
Issued date of the document.
|
issuedDate | string |
Issued date of the document. |
|
Documents having issued date before.
|
maxIssuedDate | string |
Documents having issued date before. |
|
Documents having issued date after.
|
minIssuedDate | string |
Documents having issued date after. |
|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
Human readable id of the property the document belongs to.
|
propertyHrId | string |
Human readable id of the property the document belongs to. |
|
ID of the property the document belongs to.
|
propertyId | integer |
ID of the property the document belongs to. |
|
Name of the property the document belongs to.
|
propertyName | string |
Name of the property the document belongs to. |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
|
ID of the source entity the document belongs to.
|
sourceId | integer |
ID of the source entity the document belongs to. |
|
Source types of the document.
|
sourceType | array |
Source types of the document. |
|
IDs of tags the document is associated to.
|
tagIds | array |
IDs of tags the document is associated to. |
|
Similar name of tag the document is associate to.
|
tagName | string |
Similar name of tag the document is associate to. |
|
ID of the unit entity the document belongs to.
|
unitId | integer |
ID of the unit entity the document belongs to. |
Returns
- PageOfDocumentDto
- PageOfDocumentDto
Retrieves invoices by the given filter parameters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of the counterpart contact
|
counterpartContactId | integer |
Unique identifier of the counterpart contact |
|
Date of the invoices to be retrieved
|
issuedDate | string |
Date of the invoices to be retrieved |
|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
Unique identifier of the property an invoice belongs to
|
propertyId | integer |
Unique identifier of the property an invoice belongs to |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
|
States of the invoices to be retrieved
|
states | array |
States of the invoices to be retrieved |
Returns
- PageOfInvoiceDto
- PageOfInvoiceDto
Retrieve properties by the given filter parameters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name of the property.
|
name | string |
Name of the property. |
|
Sorting direction. Possible values: ASC, DESC
|
order | string |
Sorting direction. Possible values: ASC, DESC |
|
Page number to be returned
|
page | integer |
Page number to be returned |
|
Human readable id of the property.
|
propertyHrId | string |
Human readable id of the property. |
|
Number of items to be returned in single page
|
size | integer |
Number of items to be returned in single page |
|
Sorting parameter
|
sort | string |
Sorting parameter |
Returns
- PageOfPropertyDto
- PageOfPropertyDto
Get invoice details from Impower via legacy API. Use getInvoiceByIdUsingGET instead.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Invoice ID
|
invoiceId | True | integer |
Specify the invoice ID for details |
Returns
- LegacyInvoiceDto
- LegacyInvoiceDto
Read a connection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The id of the connection
|
connectionIdX | True | integer |
The id of the connection |
Returns
Data that describes an existing connection
- ConnectionDto
- ConnectionDto
Update a connection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of the connection
|
connectionIdX | True | integer |
Id of the connection |
Name of the connection as it shall be presented in the UI.
If not specified, will be defaulted to the name of the application
|
name | string |
Name of the connection as it shall be presented in the UI. If not specified, will be defaulted to the name of the application |
|
The URL will be called with an authorization token you may validate and the following body: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
|
webhookUrl | string |
The URL will be called with an authorization token you may validate and the following body: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"} |
Returns
Data that describes an existing connection
- ConnectionDto
- ConnectionDto
All the need information is in the request body
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
New value the document amount to be updated to
|
amount | float |
New value the document amount to be updated to |
|
New building building the document to be assigned to.
|
buildingId | integer |
New building building the document to be assigned to. |
|
New contact the document to be assigned to
|
contactId | integer |
New contact the document to be assigned to |
|
New contract the document to be assigned to
|
contractId | integer |
New contract the document to be assigned to |
|
The unique identifier of the document to be updated
|
id | True | integer |
The unique identifier of the document to be updated |
New date the document issued date to be updated to
|
issuedDate | string |
New date the document issued date to be updated to |
|
New value the document name to be updated to
|
name | string |
New value the document name to be updated to |
|
New property the document to be assigned to
|
propertyId | integer |
New property the document to be assigned to |
|
New source process id the document to be assigned to
|
sourceId | integer |
New source process id the document to be assigned to |
|
Identifiers of tags to be assigned to the document
|
tagIds | array of integer |
Identifiers of tags to be assigned to the document |
|
New unit the document to be assigned to
|
unitId | integer |
New unit the document to be assigned to |
Returns
- response
- array of DocumentDto
The updated document tag will be returned as response
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique identifier of a document tag
|
tagId | True | integer |
Unique identifier of a document tag |
New description of the document tag.
|
description | string |
New description of the document tag. |
|
New name of the document tag.
|
name | string |
New name of the document tag. |
Returns
Model class of a document tag.
- DocumentTagDto
- DocumentTagDto
Update invoice
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id of an invoice
|
invoiceId | True | integer |
Unique id of an invoice |
New issued date of the invoice.
|
issuedDate | string |
New issued date of the invoice. |
|
New name of the invoice.
|
name | string |
New name of the invoice. |
Returns
Invoice data structure.
- InvoiceDto
- InvoiceDto
Update booking text
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id of invoice booking item
|
invoiceItemId | True | integer |
Unique id of invoice booking item |
Booking text of the invoice item.
|
bookingText | string |
Booking text of the invoice item. |
Returns
- InvoiceItemDto
- InvoiceItemDto
By default, the document will go though an OCR analysis
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
PDF file of an invoice
|
file | True | file |
PDF file of an invoice |
Returns
Invoice data structure.
- InvoiceDto
- InvoiceDto
Create an application connection |
Create an application connection |
Name | Path | Type | Description |
---|---|---|---|
The id of the connection the notification applies to
|
connectionId | integer |
connectionId |
entityType
|
entityType | string |
entityType |
entityId
|
entityId | integer |
entityId |
eventType
|
eventType | string |
eventType |
Data that describes an existing connection
Name | Path | Type | Description |
---|---|---|---|
Id of an application
|
appId | integer |
Id of an application |
Name of the application of the connection
|
appName | string |
Name of the application of the connection |
Creation time of the entity.
|
created | string |
Creation time of the entity. |
Id of the entity.
|
id | integer |
Id of the entity. |
Name of the connection
|
name | string |
Name of the connection |
Last update time of the entity.
|
updated | string |
Last update time of the entity. |
Webhook of the connection that will be called like
```
POST https://your.webhook.url/path/somewhere
Authorization: Bearer TOKEN
{
"connectionId": 0,
"entityType": "properties|contacts|invoices|etc.",
"entityId": 0,
"eventType": "CREATE|UPDATE|DELETE"
}```
|
webhookUrl | string |
Webhook of the connection that will be called like
|
Contact details
Name | Path | Type | Description |
---|---|---|---|
Business telephone number of the contact
|
businessPhoneNumber | array of string |
Business telephone number of the contact |
Date of birth of the contact.
|
dateOfBirth | string |
Date of birth of the contact. |
Email address of the contact
|
array of string |
Email address of the contact |
|
Fax number of the contact
|
fax | array of string |
Fax number of the contact |
Mobile telephone number of the contact
|
mobilePhoneNumber | array of string |
Mobile telephone number of the contact |
Private telephone number of the contact
|
privatePhoneNumber | array of string |
Private telephone number of the contact |
Trade register number.
|
tradeRegisterNumber | string |
Trade register number. |
VAT id of the contact.
|
vatId | string |
VAT id of the contact. |
Website of the contact
|
website | array of string |
Website of the contact |
A contact represents a natural person or legal entity, and the way to contact them. Shall an identity/company have multiple postal addresses through which it may be contacted. These are represented as 2 different contacts.
Name | Path | Type | Description |
---|---|---|---|
Name of the city.
|
city | string |
Name of the city. |
Name of the company, in case the contact is a company.
|
companyName | string |
Name of the company, in case the contact is a company. |
Country code according to ISO 3166-1 alpha-2 standard.
|
country | string |
Country code according to ISO 3166-1 alpha-2 standard. |
Creation time of the contact.
|
created | string |
Creation time of the contact. |
ContactDetailsDto
|
details | ContactDetailsDto |
Contact details |
First name of the contact, in case the contact is a person.
|
firstName | string |
First name of the contact, in case the contact is a person. |
ID of the contact instance.
|
id | integer |
ID of the contact instance. |
Last name of the contact, in case the contact is a person.
|
lastName | string |
Last name of the contact, in case the contact is a person. |
Street number.
|
number | string |
Street number. |
Postal or zip code. Ensure it is specified for every person requiring physical letter contact via e-post.
|
postalCode | string |
Postal or zip code. Ensure it is specified for every person requiring physical letter contact via e-post. |
Recipient name of the contact.
|
recipientName | string |
Recipient name of the contact. |
A standard formula of words used to address the contact.
|
salutation | string |
A standard formula of words used to address the contact. |
State name, also called province, subdivision, or region.
|
state | string |
State name, also called province, subdivision, or region. |
Name of the street.
|
street | string |
Name of the street. |
Job title of the contact.
|
title | string |
Job title of the contact. |
Last update time of the contact.
|
updated | string |
Last update time of the contact. |
Contact simplified data structure.
Name | Path | Type | Description |
---|---|---|---|
ID of the contact instance.
|
id | integer |
ID of the contact instance. |
The name of the contact. For more detailed information load the contact via id.
|
name | string |
The name of the contact. For more detailed information load the contact via id. |
Contract data structure.
Name | Path | Type | Description |
---|---|---|---|
List of the contacts associated to the contract.
|
contacts | array of ContactSimpleDto |
List of the contacts associated to the contract. |
Number of the contract.
|
contractNumber | string |
Number of the contract. |
Creation time of the contract.
|
created | string |
Creation time of the contract. |
Date the validity period of the contract ends to. Null is interpreted as end of time.
|
endDate | string |
Date the validity period of the contract ends to. Null is interpreted as end of time. |
ID of the contract instance.
|
id | integer |
ID of the contract instance. |
Describes whether this contract is a vacant type contract. As of now it can only be true in case the contract is of type is TENANT. Vacant contract means the unit is not rented out.
|
isVacant | boolean |
Describes whether this contract is a vacant type contract. As of now it can only be true in case the contract is of type is TENANT. Vacant contract means the unit is not rented out. |
Name of the contract consisting of the unit key and name of the mailing contact.
|
name | string |
Name of the contract consisting of the unit key and name of the mailing contact. |
ID of the property instance the contract belongs to.
|
propertyId | integer |
ID of the property instance the contract belongs to. |
Date the validity period of the contract starts from. Null is interpreted as beginning of time.
|
startDate | string |
Date the validity period of the contract starts from. Null is interpreted as beginning of time. |
Type of the contract.
1. OWNER - a contract of such type proves ownership of the unit.
2. TENANT - a contract of such type is renting the unit.
3. PROPERTY_OWNER - a contract of such type proves ownership of the property.
|
type | string |
Type of the contract.
|
ID of the unit instance the contract belongs to.
|
unitId | integer |
ID of the unit instance the contract belongs to. |
Last update time of the contract.
|
updated | string |
Last update time of the contract. |
Document data structure.
Name | Path | Type | Description |
---|---|---|---|
Total amount present on the document.
|
amount | float |
Total amount present on the document. |
ID of the building the document belongs to.
|
buildingId | integer |
ID of the building the document belongs to. |
ID of the contact the document belongs to.
|
contactId | integer |
ID of the contact the document belongs to. |
ID of the contract the document belongs to.
|
contractId | integer |
ID of the contract the document belongs to. |
Creation time of the document.
|
created | string |
Creation time of the document. |
ID of the document instance.
|
id | integer |
ID of the document instance. |
Issued date of the document.
|
issuedDate | string |
Issued date of the document. |
Name of the document instance.
|
name | string |
Name of the document instance. |
Human readable id of the property the document is assigned to.
|
propertyHrId | string |
Human readable id of the property the document is assigned to. |
ID of the property the document belongs to.
|
propertyId | integer |
ID of the property the document belongs to. |
Name of the property the document is assigned to.
|
propertyName | string |
Name of the property the document is assigned to. |
ID of the source entity the document belongs to.
|
sourceId | integer |
ID of the source entity the document belongs to. |
Source type of the document.
Together with the id identifies the business process of the same name the document originates from/is attached to.
It may be null.
|
sourceType | string |
Source type of the document. Together with the id identifies the business process of the same name the document originates from/is attached to. It may be null. |
State of the document.
|
state | string |
State of the document. |
tags
|
tags | array of DocumentTagSimpleDto | |
Human readable id of the unit the document is assigned to.
|
unitHrId | string |
Human readable id of the unit the document is assigned to. |
ID of the unit the document belongs to.
|
unitId | integer |
ID of the unit the document belongs to. |
Last update time of the document.
|
updated | string |
Last update time of the document. |
Model class of a document tag.
Name | Path | Type | Description |
---|---|---|---|
Description of the document tag.
|
description | string |
Description of the document tag. |
ID of the document tag.
|
id | integer |
ID of the document tag. |
Name of the document tag.
|
name | string |
Name of the document tag. |
Model class of a document tag.
Name | Path | Type | Description |
---|---|---|---|
Unique identifier of the document tag.
|
id | integer |
Unique identifier of the document tag. |
Name of the document tag.
|
name | string |
Name of the document tag. |
Name | Path | Type | Description |
---|---|---|---|
code
|
code | string | |
description
|
description | string |
Invoice data structure.
Name | Path | Type | Description |
---|---|---|---|
Amount to be payed according to the invoice.
|
amount | float |
Amount to be payed according to the invoice. |
ID of the counterpart contact of the invoice.
|
counterpartContactId | integer |
ID of the counterpart contact of the invoice. |
Name of the counterpart contact of the invoice.
|
counterpartContactName | string |
Name of the counterpart contact of the invoice. |
Creation time of the entity.
|
created | string |
Creation time of the entity. |
Id of the entity.
|
id | integer |
Id of the entity. |
Issued date of the invoice.
|
issuedDate | string |
Issued date of the invoice. |
items
|
items | array of InvoiceItemDto | |
Name of the invoice.
|
name | string |
Name of the invoice. |
BIC number of the counterpart's bank account.
|
orderCounterpartBic | string |
BIC number of the counterpart's bank account. |
IBAN of the counterpart's bank account.
|
orderCounterpartIban | string |
IBAN of the counterpart's bank account. |
The number of days before or after the booking date where the bank order shall appear for execution.
|
orderDayOffset | integer |
The number of days before or after the booking date where the bank order shall appear for execution. |
Unique identifier of the bank account of the property.
|
orderPropertyBankAccountId | integer |
Unique identifier of the bank account of the property. |
BIC number of the property bank account.
|
orderPropertyBic | string |
BIC number of the property bank account. |
IBAN of the property bank account.
|
orderPropertyIban | string |
IBAN of the property bank account. |
True in case there is a corresponding order of the invoice.
|
orderRequired | boolean |
True in case there is a corresponding order of the invoice. |
Statement of the generated order.
|
orderStatement | string |
Statement of the generated order. |
Human readable id of the property the invoice belongs to.
|
propertyHrId | string |
Human readable id of the property the invoice belongs to. |
ID of the property the invoice belongs to.
|
propertyId | integer |
ID of the property the invoice belongs to. |
Name of the property the invoice belongs to.
|
propertyName | string |
Name of the property the invoice belongs to. |
State of the invoice. Possible values:
1. DRAFT - invoice created, but incomplete.
2. READY - invoice ready to be booked.
3. BOOKED - invoice booked.
4. SCHEDULED - only applies to recurring invoices.
5. REVERSED - all bookings generated by the invoice have been reversed.
|
state | string |
State of the invoice. Possible values:
|
Last update time of the entity.
|
updated | string |
Last update time of the entity. |
Name | Path | Type | Description |
---|---|---|---|
Account code of the booking item.
|
accountCode | string |
Account code of the booking item. |
Account id of the booking item.
|
accountId | integer |
Account id of the booking item. |
Account name of the booking item.
|
accountName | string |
Account name of the booking item. |
Amount corresponding to the booking item.
|
amount | float |
Amount corresponding to the booking item. |
Booking text of the booking item.
|
bookingText | string |
Booking text of the booking item. |
Creation time of the invoice item.
|
created | string |
Creation time of the invoice item. |
Unique identifier of the booking item.
|
id | integer |
Unique identifier of the booking item. |
Amount relevant for income tax declaration according to the Income Tax Act: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
|
laborCostAmount | float |
Amount relevant for income tax declaration according to the Income Tax Act: Einkommenstueregesetz EStG 35a. |
Depending on the selected type: percentages of the amounts will be reported on the 35a annexes of multiple reports according to the Income Tax Act: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
Ex: Housemoney Settlement (Hausgeldabrechnung) or 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 |
Depending on the selected type: percentages of the amounts will be reported on the 35a annexes of multiple reports according to the Income Tax Act: Einkommenstueregesetz EStG 35a. Ex: Housemoney Settlement (Hausgeldabrechnung) or Opscost Report (Nebenkostenabrechnung).
|
Last update time of the invoice item.
|
updated | string |
Last update time of the invoice item. |
Corresponding vat amount of the booking item.
|
vatAmount | float |
Corresponding vat amount of the booking item. |
Corresponding vat percentage of the vat amount of the total amount.
|
vatPercentage | float |
Corresponding vat percentage of the vat amount of the total amount. |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of ContactDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of ContractDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of DocumentDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of InvoiceDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of PropertyDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
content
|
content | array of UnitDto | |
empty
|
empty | boolean | |
first
|
first | boolean | |
last
|
last | boolean | |
number
|
number | integer | |
numberOfElements
|
numberOfElements | integer | |
Pageable
|
pageable | Pageable | |
size
|
size | integer | |
Sort
|
sort | Sort | |
totalElements
|
totalElements | integer | |
totalPages
|
totalPages | integer |
Name | Path | Type | Description |
---|---|---|---|
offset
|
offset | integer | |
pageNumber
|
pageNumber | integer | |
pageSize
|
pageSize | integer | |
paged
|
paged | boolean | |
Sort
|
sort | Sort | |
unpaged
|
unpaged | boolean |
Property data structure.
Name | Path | Type | Description |
---|---|---|---|
Creation time of the property instance.
|
created | string |
Creation time of the property instance. |
ID of the property instance.
|
id | integer |
ID of the property instance. |
Name of the property instance.
|
name | string |
Name of the property instance. |
Human readable id of the property instance.
|
propertyHrId | string |
Human readable id of the property instance. |
Current state of the property.
1. DRAFT - property not activated yet, therefore no bookings/bank orders/reports can be generated.
2. READY - property has been activated and can be used for bookings/bank orders/reports generation.
3. DISABLED - property has been deactivated, and can no longer generate bookings/bank orders/reports.
|
state | string |
Current state of the property.
|
Administration type of the property. OWNER - Home Owner Association. RENTAL - Tenant Management.
|
type | string |
Administration type of the property. OWNER - Home Owner Association. RENTAL - Tenant Management. |
Update time of the property instance.
|
updated | string |
Update time of the property instance. |
Name | Path | Type | Description |
---|---|---|---|
empty
|
empty | boolean | |
sorted
|
sorted | boolean | |
unsorted
|
unsorted | boolean |
Unit data structure.
Name | Path | Type | Description |
---|---|---|---|
Creation time of the unit instance.
|
created | string |
Creation time of the unit instance. |
Floor the unit is located on.
|
floor | string |
Floor the unit is located on. |
ID of the unit instance.
|
id | integer |
ID of the unit instance. |
Position of the unit within the floor.
|
position | string |
Position of the unit within the floor. |
ID of the property instance the unit belongs to.
|
propertyId | integer |
ID of the property instance the unit belongs to. |
Purpose the unit is used for.APARTMENT - unit used for residential purposes. PARKING - unit used for parking purposes. COMMERCIAL - unit used for business/commercial purposes. OTHER - unit used for other purposes.
|
type | string |
Purpose the unit is used for.APARTMENT - unit used for residential purposes. PARKING - unit used for parking purposes. COMMERCIAL - unit used for business/commercial purposes. OTHER - unit used for other purposes. |
Human readable id of the unit instance.
|
unitHrId | string |
Human readable id of the unit instance. |
The rank defines the order how units are displayed on the UI / Reports. The user may update it in the UI.
|
unitRank | integer |
The rank defines the order how units are displayed on the UI / Reports. The user may update it in the UI. |
Update time of the unit instance.
|
updated | string |
Update time of the unit instance. |
Name | Path | Type | Description |
---|---|---|---|
BIC Counterpart
|
counterpartBic | string |
BIC Counterpart |
ContactID Counterpart
|
counterpartContactId | integer |
ContactID Counterpart |
IBAN Counterpart
|
counterpartIban | string |
IBAN Counterpart |
Counterpart
|
counterpartName | string |
Counterpart |
Date
|
created | string |
Date |
Invoice URL
|
documentUrl | string |
Invoice URL |
ID
|
id | integer |
ID |
Invoice Date
|
invoiceDate | string |
Invoice Date |
Invoice ID
|
invoiceHrId | string |
Invoice ID |
Invoice Number
|
invoiceNumber | string |
Invoice Number |
Payment target date
|
paymentTargetDate | string |
Payment target date |
Payment Type
|
paymentType | string |
Payment Type |
Property NR
|
propertyHrId | string |
Property NR |
Property ID
|
propertyId | integer |
Property ID |
Property Internal ID
|
propertyIdInternal | string |
Property Internal ID |
Property Name
|
propertyName | string |
Property Name |
Reference Nr
|
refNr | string |
Reference Nr |
Status of Invoice
|
state | string |
Status of Invoice |
Total Gross
|
totalGross | float |
Total Gross |
Total Net
|
totalNet | float |
Total Net |
VAT incl.
|
vatIncluded | boolean |
VAT incl. |
VAT percentage
|
vatPercentage | float |
VAT percentage |
This is the basic data type 'file'.