ERP do impower (versão prévia)
Permitir interação com impower.de sistema de contabilidade para gerentes de propriedades
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte à API |
| URL | https://impower.de |
| support+api@impower.de |
| Metadados do conector | |
|---|---|
| Publicador | Impower GmbH |
| Site | https://www.impower.de |
| Política de privacidade | https://www.impower.de/datenschutzerklaerung |
| Categorias | Gestão de empresas; Financiar |
O conector impower permite que você acesse o conjunto de mestres, como propriedades, unidades, contratos e contatos. Além disso, você pode carregar documentos e faturas. Pode-se ler os dados em uma base agendada ou registrando webhooks usando o gatilho integrado.
Pré-requisitos
Para usar o Impower, você precisará:
- Assinatura paga do Impower
- Assinatura do Powerautomate Premium
Como obter credenciais
Para obter a APIKey para seu domínio para se conectar ao powerautomate, escreva uma solicitação em support@impower.de.
Introdução ao conector
Cenários que você pode considerar como criar:
- Assista a uma pasta do Sharepoint/Onedrive para obter alterações e, se novos arquivos PDF aparecerem, carregue-os no impower
- Sincronizar a lista de contatos com a pasta de endereços do teams
Problemas e limitações conhecidos
Baixando/carregando arquivos
Os arquivos são carregados como dados de formulário de várias partes no formato binário. O mesmo vale para download: os arquivos são fornecidos como estão com um nome de arquivo sugerido no cabeçalho - assim como no padrão http
Ratelimiting
Procure não fazer mais de 5.000 solicitações por minuto. Impomos um ratelimiting na API para garantir que o sistema possa atender rapidamente aos usuários
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| API-Key | secureString | API-Key para esta API | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| (Herdado) Carregar fatura |
Carregue um arquivo pdf no Impower usando a API herdada. Em vez disso, use a operação uploadInvoiceUsingPOST. |
| Atualizar o texto de reserva do item de reserva de fatura especificado |
Atualizar texto de reserva |
| Atualizar um documento existente com base no corpo da solicitação fornecida |
Todas as informações necessárias estão no corpo da solicitação |
| Atualizar uma conexão |
Atualizar uma conexão |
| Atualizar uma fatura com base nos campos fornecidos |
Atualizar fatura |
| Atualizar uma marca de documento existente com base na ID fornecida |
A marca de documento atualizada será retornada como resposta |
| Baixar um único documento por ID fornecida |
O formato do documento é definido pelo mimetype |
| Baixar vários documentos por determinadas condições de filtro |
Os documentos vêm em formato zip |
| Carregar documento PDF da fatura |
Por padrão, o documento passará por uma análise do OCR |
| Criar um novo documento com base em determinado arquivo |
O documento recém-criado será retornado como resposta |
| Criar uma nova marca de documento |
A marca de documento recém-criada será retornada como resposta |
| Detalhes da fatura herdada |
Obtenha detalhes da fatura do Impower por meio da API herdada. Em vez disso, use getInvoiceByIdUsingGET. |
| Excluir um documento existente com base na ID fornecida |
Documentos gerados pelo sistema não podem ser excluídos |
| Excluir uma conexão |
Excluir uma conexão |
| Excluir uma marca de documento existente com base na ID fornecida |
As marcas geradas pelo sistema não podem ser excluídas |
| Ler uma conexão |
Ler uma conexão |
| Obter contatos pelos parâmetros de filtro especificados |
Recuperar contatos pelos parâmetros de filtro especificados |
| Obter contratos pelos parâmetros de filtro especificados |
Recuperar contratos pelos parâmetros de filtro especificados |
| Obter detalhes de um código de erro específico |
Recupera a descrição de um código de erro específico |
| Obter documentos pelos parâmetros de filtro especificados |
Recuperar documentos pelos parâmetros de filtro especificados |
| Obter faturas pelos parâmetros de filtro especificados |
Recupera faturas pelos parâmetros de filtro especificados |
| Obter marcas de documento |
As marcas de documento padrão e específicas do domínio serão retornadas como resposta |
| Obter propriedades pelos parâmetros de filtro especificados |
Recuperar propriedades pelos parâmetros de filtro especificados |
| Obter todas as unidades por determinados parâmetros de filtro |
Retorna todas as unidades que respeitam os critérios de filtro especificados |
| Obter todos os valores de código de erro predefinidos |
Retorna uma lista de todos os códigos de erro predefinidos |
| Obter um contato pela ID fornecida |
Recupera um contato pela ID fornecida |
| Obter um contrato pela ID fornecida |
Recupera um contrato pela ID fornecida |
| Obter uma fatura pela ID fornecida |
Recupera uma fatura pela ID fornecida |
| Obter uma propriedade pela ID fornecida |
Recupera uma propriedade pela ID fornecida |
| Obter uma unidade pela ID fornecida |
Retornar a unidade com a ID fornecida |
(Herdado) Carregar fatura
Carregue um arquivo pdf no Impower usando a API herdada. Em vez disso, use a operação uploadInvoiceUsingPOST.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Especificar o arquivo pdf a ser carregado
|
file | True | file |
Especificar o arquivo pdf a ser carregado |
Retornos
- LegacyInvoiceDto
- LegacyInvoiceDto
Atualizar o texto de reserva do item de reserva de fatura especificado
Atualizar texto de reserva
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do item de reserva de fatura
|
invoiceItemId | True | integer |
ID exclusiva do item de reserva de fatura |
|
Texto de reserva do item da fatura.
|
bookingText | string |
Texto de reserva do item da fatura. |
Retornos
- InvoiceItemDto
- InvoiceItemDto
Atualizar um documento existente com base no corpo da solicitação fornecida
Todas as informações necessárias estão no corpo da solicitação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Novo valor para o qual o valor do documento deve ser atualizado
|
amount | float |
Novo valor para o qual o valor do documento deve ser atualizado |
|
|
Nova compilação do documento a ser atribuído.
|
buildingId | integer |
Nova compilação do documento a ser atribuído. |
|
|
Novo contato com o documento a ser atribuído
|
contactId | integer |
Novo contato com o documento a ser atribuído |
|
|
Novo contrato ao qual o documento a ser atribuído
|
contractId | integer |
Novo contrato ao qual o documento a ser atribuído |
|
|
O identificador exclusivo do documento a ser atualizado
|
id | True | integer |
O identificador exclusivo do documento a ser atualizado |
|
Nova data em que o documento emitiu a data a ser atualizada para
|
issuedDate | string |
Nova data em que o documento emitiu a data a ser atualizada para |
|
|
Novo valor para o qual o nome do documento será atualizado
|
name | string |
Novo valor para o qual o nome do documento será atualizado |
|
|
Nova propriedade à qual o documento será atribuído
|
propertyId | integer |
Nova propriedade à qual o documento será atribuído |
|
|
Nova ID do processo de origem ao qual o documento será atribuído
|
sourceId | integer |
Nova ID do processo de origem ao qual o documento será atribuído |
|
|
Identificadores de marcas a serem atribuídas ao documento
|
tagIds | array of integer |
Identificadores de marcas a serem atribuídas ao documento |
|
|
Nova unidade à qual o documento será atribuído
|
unitId | integer |
Nova unidade à qual o documento será atribuído |
Retornos
- response
- array of DocumentDto
Atualizar uma conexão
Atualizar uma conexão
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da conexão
|
connectionIdX | True | integer |
ID da conexão |
|
Nome da conexão, pois ela deve ser apresentada na interface do usuário.
Se não for especificado, será padronizado para o nome do aplicativo
|
name | string |
Nome da conexão, pois ela deve ser apresentada na interface do usuário. Se não for especificado, será padronizado para o nome do aplicativo |
|
|
A URL será chamada com um token de autorização que você pode validar e o seguinte corpo: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"}
|
webhookUrl | string |
A URL será chamada com um token de autorização que você pode validar e o seguinte corpo: {"connectionId":123,"entityType":"properties","entityId":123,"eventType": "UPDATE"} |
Retornos
Dados que descrevem uma conexão existente
- ConnectionDto
- ConnectionDto
Atualizar uma fatura com base nos campos fornecidos
Atualizar fatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva de uma fatura
|
invoiceId | True | integer |
ID exclusiva de uma fatura |
|
Nova data emitida da fatura.
|
issuedDate | string |
Nova data emitida da fatura. |
|
|
Novo nome da fatura.
|
name | string |
Novo nome da fatura. |
Retornos
Estrutura de dados da fatura.
- InvoiceDto
- InvoiceDto
Atualizar uma marca de documento existente com base na ID fornecida
A marca de documento atualizada será retornada como resposta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma marca de documento
|
tagId | True | integer |
Identificador exclusivo de uma marca de documento |
|
Nova descrição da marca do documento.
|
description | string |
Nova descrição da marca do documento. |
|
|
Novo nome da marca do documento.
|
name | string |
Novo nome da marca do documento. |
Retornos
Classe de modelo de uma marca de documento.
- DocumentTagDto
- DocumentTagDto
Baixar um único documento por ID fornecida
O formato do documento é definido pelo mimetype
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de um documento
|
documentId | True | integer |
Identificador exclusivo de um documento |
Retornos
- response
- file
Baixar vários documentos por determinadas condições de filtro
Os documentos vêm em formato zip
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do contador da propriedade.
|
accountant | string |
Nome do contador da propriedade. |
|
|
Nome do administrador da propriedade.
|
administrator | string |
Nome do administrador da propriedade. |
|
|
ID da entidade de contato à qual o documento pertence.
|
contactId | integer |
ID da entidade de contato à qual o documento pertence. |
|
|
Documentos vinculados a contratos com nome semelhante.
|
contractName | string |
Documentos vinculados a contratos com nome semelhante. |
|
|
IDs dos documentos a serem retornados.
|
documentIds | array |
IDs dos documentos a serem retornados. |
|
|
Nome dos documentos a serem retornados.
|
documentName | string |
Nome dos documentos a serem retornados. |
|
|
Data emitida do documento.
|
issuedDate | string |
Data emitida do documento. |
|
|
Documentos que já emitiram data antes.
|
maxIssuedDate | string |
Documentos que já emitiram data antes. |
|
|
Documentos que têm data emitida após.
|
minIssuedDate | string |
Documentos que têm data emitida após. |
|
|
ID legível humana da propriedade à qual o documento pertence.
|
propertyHrId | string |
ID legível humana da propriedade à qual o documento pertence. |
|
|
ID da propriedade à qual o documento pertence.
|
propertyId | integer |
ID da propriedade à qual o documento pertence. |
|
|
Nome da propriedade à qual o documento pertence.
|
propertyName | string |
Nome da propriedade à qual o documento pertence. |
|
|
ID da entidade de origem à qual o documento pertence.
|
sourceId | integer |
ID da entidade de origem à qual o documento pertence. |
|
|
Tipos de origem do documento.
|
sourceType | array |
Tipos de origem do documento. |
|
|
IDs de marcas às qual o documento está associado.
|
tagIds | array |
IDs de marcas às qual o documento está associado. |
|
|
Nome semelhante da marca ao qual o documento está associado.
|
tagName | string |
Nome semelhante da marca ao qual o documento está associado. |
|
|
ID da entidade de unidade à qual o documento pertence.
|
unitId | integer |
ID da entidade de unidade à qual o documento pertence. |
Retornos
- response
- file
Carregar documento PDF da fatura
Por padrão, o documento passará por uma análise do OCR
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivo PDF de uma fatura
|
file | True | file |
Arquivo PDF de uma fatura |
Retornos
Estrutura de dados da fatura.
- InvoiceDto
- InvoiceDto
Criar um novo documento com base em determinado arquivo
O documento recém-criado será retornado como resposta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivo PDF a ser carregado
|
file | True | file |
Arquivo PDF a ser carregado |
Retornos
Estrutura de dados do documento.
- DocumentDto
- DocumentDto
Criar uma nova marca de documento
A marca de documento recém-criada será retornada como resposta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Descrição da marca de documento recém-criada.
|
description | string |
Descrição da marca de documento recém-criada. |
|
|
Nome da marca de documento recém-criada.
|
name | string |
Nome da marca de documento recém-criada. |
Retornos
Classe de modelo de uma marca de documento.
- DocumentTagDto
- DocumentTagDto
Detalhes da fatura herdada
Obtenha detalhes da fatura do Impower por meio da API herdada. Em vez disso, use getInvoiceByIdUsingGET.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoiceId | True | integer |
Especificar a ID da fatura para obter detalhes |
Retornos
- LegacyInvoiceDto
- LegacyInvoiceDto
Excluir um documento existente com base na ID fornecida
Documentos gerados pelo sistema não podem ser excluídos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
documentId
|
documentId | True | integer |
documentId |
Excluir uma conexão
Excluir uma conexão
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da conexão
|
connectionIdX | True | integer |
ID da conexão |
Excluir uma marca de documento existente com base na ID fornecida
As marcas geradas pelo sistema não podem ser excluídas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo da marca de documento a ser excluído
|
tagId | True | integer |
Identificador exclusivo da marca de documento a ser excluído |
Ler uma conexão
Ler uma conexão
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID da conexão
|
connectionIdX | True | integer |
A ID da conexão |
Retornos
Dados que descrevem uma conexão existente
- ConnectionDto
- ConnectionDto
Obter contatos pelos parâmetros de filtro especificados
Recuperar contatos pelos parâmetros de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lista de IDs de contato para filtrar contatos.
|
contactIds | array |
Lista de IDs de contato para filtrar contatos. |
|
|
Endereço de email do contato.
|
string |
Endereço de email do contato. |
||
|
Qualquer nome do contato. Pode ser nome, sobrenome ou nome da empresa.
|
name | string |
Qualquer nome do contato. Pode ser nome, sobrenome ou nome da empresa. |
|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Retornos
- PageOfContactDto
- PageOfContactDto
Obter contratos pelos parâmetros de filtro especificados
Recuperar contratos pelos parâmetros de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da instância de contato à qual o contrato está associado.
|
contactId | integer |
ID da instância de contato à qual o contrato está associado. |
|
|
Lista de IDs de contrato para filtrar contratos.
|
contractIds | array |
Lista de IDs de contrato para filtrar contratos. |
|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
ID da instância de propriedade à qual o contrato pertence.
|
propertyId | integer |
ID da instância de propriedade à qual o contrato pertence. |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
|
|
Tipo do contrato. Opções: PROPRIETÁRIO | LOCATÁRIO | PROPERTY_OWNER
|
type | array |
Tipo do contrato. Opções: PROPRIETÁRIO | LOCATÁRIO | PROPERTY_OWNER |
|
|
ID da instância de unidade à qual o contrato está associado.
|
unitId | integer |
ID da instância de unidade à qual o contrato está associado. |
|
|
Retornar contratos válidos na data. Nulo é interpretado como início/fim do tempo.
|
validAtDate | string |
Retornar contratos válidos na data. Nulo é interpretado como início/fim do tempo. |
Retornos
- PageOfContractDto
- PageOfContractDto
Obter detalhes de um código de erro específico
Recupera a descrição de um código de erro específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
value
|
value | True | string |
value |
Retornos
- ErrorCodeDetailsDto
- ErrorCodeDetailsDto
Obter documentos pelos parâmetros de filtro especificados
Recuperar documentos pelos parâmetros de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do contador da propriedade.
|
accountant | string |
Nome do contador da propriedade. |
|
|
Nome do administrador da propriedade.
|
administrator | string |
Nome do administrador da propriedade. |
|
|
ID da entidade de contato à qual o documento pertence.
|
contactId | integer |
ID da entidade de contato à qual o documento pertence. |
|
|
Documentos vinculados a contratos com nome semelhante.
|
contractName | string |
Documentos vinculados a contratos com nome semelhante. |
|
|
IDs dos documentos a serem retornados.
|
documentIds | array |
IDs dos documentos a serem retornados. |
|
|
Nome dos documentos a serem retornados.
|
documentName | string |
Nome dos documentos a serem retornados. |
|
|
Data emitida do documento.
|
issuedDate | string |
Data emitida do documento. |
|
|
Documentos que já emitiram data antes.
|
maxIssuedDate | string |
Documentos que já emitiram data antes. |
|
|
Documentos que têm data emitida após.
|
minIssuedDate | string |
Documentos que têm data emitida após. |
|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
ID legível humana da propriedade à qual o documento pertence.
|
propertyHrId | string |
ID legível humana da propriedade à qual o documento pertence. |
|
|
ID da propriedade à qual o documento pertence.
|
propertyId | integer |
ID da propriedade à qual o documento pertence. |
|
|
Nome da propriedade à qual o documento pertence.
|
propertyName | string |
Nome da propriedade à qual o documento pertence. |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
|
|
ID da entidade de origem à qual o documento pertence.
|
sourceId | integer |
ID da entidade de origem à qual o documento pertence. |
|
|
Tipos de origem do documento.
|
sourceType | array |
Tipos de origem do documento. |
|
|
IDs de marcas às qual o documento está associado.
|
tagIds | array |
IDs de marcas às qual o documento está associado. |
|
|
Nome semelhante da marca ao qual o documento está associado.
|
tagName | string |
Nome semelhante da marca ao qual o documento está associado. |
|
|
ID da entidade de unidade à qual o documento pertence.
|
unitId | integer |
ID da entidade de unidade à qual o documento pertence. |
Retornos
- PageOfDocumentDto
- PageOfDocumentDto
Obter faturas pelos parâmetros de filtro especificados
Recupera faturas pelos parâmetros de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo do contato de equivalente
|
counterpartContactId | integer |
Identificador exclusivo do contato de equivalente |
|
|
Data das faturas a serem recuperadas
|
issuedDate | string |
Data das faturas a serem recuperadas |
|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
Identificador exclusivo da propriedade à qual uma fatura pertence
|
propertyId | integer |
Identificador exclusivo da propriedade à qual uma fatura pertence |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
|
|
Estados das faturas a serem recuperadas
|
states | array |
Estados das faturas a serem recuperadas |
Retornos
- PageOfInvoiceDto
- PageOfInvoiceDto
Obter marcas de documento
As marcas de documento padrão e específicas do domínio serão retornadas como resposta
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cadeia de caracteres de pesquisa aplicada ao nome e à descrição
|
description | string |
Cadeia de caracteres de pesquisa aplicada ao nome e à descrição |
Retornos
- response
- array of DocumentTagDto
Obter propriedades pelos parâmetros de filtro especificados
Recuperar propriedades pelos parâmetros de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da propriedade.
|
name | string |
Nome da propriedade. |
|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
ID legível humana da propriedade.
|
propertyHrId | string |
ID legível humana da propriedade. |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Retornos
- PageOfPropertyDto
- PageOfPropertyDto
Obter todas as unidades por determinados parâmetros de filtro
Retorna todas as unidades que respeitam os critérios de filtro especificados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Direção de classificação. Valores possíveis: ASC, DESC
|
order | string |
Direção de classificação. Valores possíveis: ASC, DESC |
|
|
Número da página a ser retornado
|
page | integer |
Número da página a ser retornado |
|
|
Identificador exclusivo da propriedade à qual uma unidade pertence
|
propertyId | integer |
Identificador exclusivo da propriedade à qual uma unidade pertence |
|
|
Número de itens a serem retornados em uma única página
|
size | integer |
Número de itens a serem retornados em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Retornos
- PageOfUnitDto
- PageOfUnitDto
Obter todos os valores de código de erro predefinidos
Retorna uma lista de todos os códigos de erro predefinidos
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter um contato pela ID fornecida
Recupera um contato pela ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de um contato
|
contactId | True | integer |
Identificador exclusivo de um contato |
Retornos
Um contato representa uma pessoa física ou pessoa jurídica e a maneira de contatá-lo. Uma identidade/empresa deve ter vários endereços postais por meio dos quais pode ser contatado. Eles são representados como dois contatos diferentes.
- ContactDto
- ContactDto
Obter um contrato pela ID fornecida
Recupera um contrato pela ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de um contrato
|
contractId | True | integer |
Identificador exclusivo de um contrato |
Retornos
Estrutura de dados do contrato.
- ContractDto
- ContractDto
Obter uma fatura pela ID fornecida
Recupera uma fatura pela ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma fatura
|
invoiceId | True | integer |
Identificador exclusivo de uma fatura |
Retornos
Estrutura de dados da fatura.
- InvoiceDto
- InvoiceDto
Obter uma propriedade pela ID fornecida
Recupera uma propriedade pela ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma propriedade
|
propertyId | True | integer |
Identificador exclusivo de uma propriedade |
Retornos
Estrutura de dados da propriedade.
- PropertyDto
- PropertyDto
Obter uma unidade pela ID fornecida
Retornar a unidade com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva de uma unidade
|
unitId | True | integer |
ID exclusiva de uma unidade |
Retornos
Estrutura de dados de unidade.
- UnitDto
- UnitDto
Gatilhos
| Criar uma conexão de aplicativo |
Criar uma conexão de aplicativo |
Criar uma conexão de aplicativo
Definições
ConnectionNotificationDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
A ID da conexão à qual a notificação se aplica
|
connectionId | integer |
connectionId |
|
entityType
|
entityType | string |
entityType |
|
entityId
|
entityId | integer |
entityId |
|
eventType
|
eventType | string |
eventType |
ConnectionDto
Dados que descrevem uma conexão existente
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de um aplicativo
|
appId | integer |
ID de um aplicativo |
|
Nome do aplicativo da conexão
|
appName | string |
Nome do aplicativo da conexão |
|
Hora de criação da entidade.
|
created | string |
Hora de criação da entidade. |
|
ID da entidade.
|
id | integer |
ID da entidade. |
|
Nome da conexão
|
name | string |
Nome da conexão |
|
Hora da última atualização da entidade.
|
updated | string |
Hora da última atualização da entidade. |
|
Webhook da conexão que será chamada como ''' 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 da conexão que será chamada como
|
ContactDetailsDto
Detalhes do contato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de telefone comercial do contato
|
businessPhoneNumber | array of string |
Número de telefone comercial do contato |
|
Data de nascimento do contato.
|
dateOfBirth | string |
Data de nascimento do contato. |
|
Endereço de email do contato
|
array of string |
Endereço de email do contato |
|
|
Número de fax do contato
|
fax | array of string |
Número de fax do contato |
|
Número de telefone celular do contato
|
mobilePhoneNumber | array of string |
Número de telefone celular do contato |
|
Número de telefone privado do contato
|
privatePhoneNumber | array of string |
Número de telefone privado do contato |
|
Número do registro de comércio.
|
tradeRegisterNumber | string |
Número do registro de comércio. |
|
ID de IVA do contato.
|
vatId | string |
ID de IVA do contato. |
|
Site do contato
|
website | array of string |
Site do contato |
ContactDto
Um contato representa uma pessoa física ou pessoa jurídica e a maneira de contatá-lo. Uma identidade/empresa deve ter vários endereços postais por meio dos quais pode ser contatado. Eles são representados como dois contatos diferentes.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da cidade.
|
city | string |
Nome da cidade. |
|
Nome da empresa, caso o contato seja uma empresa.
|
companyName | string |
Nome da empresa, caso o contato seja uma empresa. |
|
Código do país de acordo com o padrão ISO 3166-1 alfa-2.
|
country | string |
Código do país de acordo com o padrão ISO 3166-1 alfa-2. |
|
Hora de criação do contato.
|
created | string |
Hora de criação do contato. |
|
ContactDetailsDto
|
details | ContactDetailsDto |
Detalhes do contato |
|
Nome do contato, caso o contato seja uma pessoa.
|
firstName | string |
Nome do contato, caso o contato seja uma pessoa. |
|
ID da instância de contato.
|
id | integer |
ID da instância de contato. |
|
Sobrenome do contato, caso o contato seja uma pessoa.
|
lastName | string |
Sobrenome do contato, caso o contato seja uma pessoa. |
|
Número da rua.
|
number | string |
Número da rua. |
|
Cep ou cep. Certifique-se de que ele seja especificado para cada pessoa que precise de contato de carta física por meio de um post eletrônico.
|
postalCode | string |
Cep ou cep. Certifique-se de que ele seja especificado para cada pessoa que precise de contato de carta física por meio de um post eletrônico. |
|
Nome do destinatário do contato.
|
recipientName | string |
Nome do destinatário do contato. |
|
Uma fórmula padrão de palavras usada para abordar o contato.
|
salutation | string |
Uma fórmula padrão de palavras usada para abordar o contato. |
|
Nome do estado, também chamado de província, subdivisão ou região.
|
state | string |
Nome do estado, também chamado de província, subdivisão ou região. |
|
Nome da rua.
|
street | string |
Nome da rua. |
|
Cargo do contato.
|
title | string |
Cargo do contato. |
|
Hora da última atualização do contato.
|
updated | string |
Hora da última atualização do contato. |
ContactSimpleDto
Entre em contato com a estrutura de dados simplificada.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da instância de contato.
|
id | integer |
ID da instância de contato. |
|
O nome do contato. Para obter informações mais detalhadas, carregue o contato por meio da ID.
|
name | string |
O nome do contato. Para obter informações mais detalhadas, carregue o contato por meio da ID. |
ContractDto
Estrutura de dados do contrato.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista dos contatos associados ao contrato.
|
contacts | array of ContactSimpleDto |
Lista dos contatos associados ao contrato. |
|
Número do contrato.
|
contractNumber | string |
Número do contrato. |
|
Hora de criação do contrato.
|
created | string |
Hora de criação do contrato. |
|
Data em que o período de validade do contrato termina. Nulo é interpretado como fim do tempo.
|
endDate | string |
Data em que o período de validade do contrato termina. Nulo é interpretado como fim do tempo. |
|
ID da instância do contrato.
|
id | integer |
ID da instância do contrato. |
|
Descreve se esse contrato é um contrato de tipo vago. A partir de agora, ele só pode ser verdadeiro caso o contrato seja do tipo TENANT. Contrato vago significa que a unidade não está alugada.
|
isVacant | boolean |
Descreve se esse contrato é um contrato de tipo vago. A partir de agora, ele só pode ser verdadeiro caso o contrato seja do tipo TENANT. Contrato vago significa que a unidade não está alugada. |
|
Nome do contrato que consiste na chave de unidade e nome do contato de endereçamento.
|
name | string |
Nome do contrato que consiste na chave de unidade e nome do contato de endereçamento. |
|
ID da instância de propriedade à qual o contrato pertence.
|
propertyId | integer |
ID da instância de propriedade à qual o contrato pertence. |
|
Data da qual o período de validade do contrato começa. Nulo é interpretado como início do tempo.
|
startDate | string |
Data da qual o período de validade do contrato começa. Nulo é interpretado como início do tempo. |
|
Tipo do contrato.
1. OWNER - um contrato desse tipo prova a propriedade da unidade.
2. LOCATÁRIO – um contrato desse tipo está alugando a unidade.
3. PROPERTY_OWNER - um contrato desse tipo prova a propriedade da propriedade.
|
type | string |
Tipo do contrato.
|
|
ID da instância de unidade à qual o contrato pertence.
|
unitId | integer |
ID da instância de unidade à qual o contrato pertence. |
|
Hora da última atualização do contrato.
|
updated | string |
Hora da última atualização do contrato. |
DocumentDto
Estrutura de dados do documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor total presente no documento.
|
amount | float |
Valor total presente no documento. |
|
ID do prédio ao qual o documento pertence.
|
buildingId | integer |
ID do prédio ao qual o documento pertence. |
|
A ID do contato ao qual o documento pertence.
|
contactId | integer |
A ID do contato ao qual o documento pertence. |
|
ID do contrato ao qual o documento pertence.
|
contractId | integer |
ID do contrato ao qual o documento pertence. |
|
Hora de criação do documento.
|
created | string |
Hora de criação do documento. |
|
ID da instância do documento.
|
id | integer |
ID da instância do documento. |
|
Data emitida do documento.
|
issuedDate | string |
Data emitida do documento. |
|
Nome da instância do documento.
|
name | string |
Nome da instância do documento. |
|
ID legível humana da propriedade à qual o documento é atribuído.
|
propertyHrId | string |
ID legível humana da propriedade à qual o documento é atribuído. |
|
ID da propriedade à qual o documento pertence.
|
propertyId | integer |
ID da propriedade à qual o documento pertence. |
|
Nome da propriedade à qual o documento é atribuído.
|
propertyName | string |
Nome da propriedade à qual o documento é atribuído. |
|
ID da entidade de origem à qual o documento pertence.
|
sourceId | integer |
ID da entidade de origem à qual o documento pertence. |
|
Tipo de origem do documento.
Junto com a ID, identifica o processo de negócios com o mesmo nome ao qual o documento é originado/anexado.
Pode ser nulo.
|
sourceType | string |
Tipo de origem do documento. Junto com a ID, identifica o processo de negócios com o mesmo nome ao qual o documento é originado/anexado. Pode ser nulo. |
|
Estado do documento.
|
state | string |
Estado do documento. |
|
tags
|
tags | array of DocumentTagSimpleDto | |
|
ID legível humana da unidade à qual o documento é atribuído.
|
unitHrId | string |
ID legível humana da unidade à qual o documento é atribuído. |
|
ID da unidade à qual o documento pertence.
|
unitId | integer |
ID da unidade à qual o documento pertence. |
|
Hora da última atualização do documento.
|
updated | string |
Hora da última atualização do documento. |
DocumentTagDto
Classe de modelo de uma marca de documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição da marca do documento.
|
description | string |
Descrição da marca do documento. |
|
ID da marca do documento.
|
id | integer |
ID da marca do documento. |
|
Nome da marca do documento.
|
name | string |
Nome da marca do documento. |
DocumentTagSimpleDto
Classe de modelo de uma marca de documento.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador exclusivo da marca de documento.
|
id | integer |
Identificador exclusivo da marca de documento. |
|
Nome da marca do documento.
|
name | string |
Nome da marca do documento. |
ErrorCodeDetailsDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
code | string | |
|
descrição
|
description | string |
InvoiceDto
Estrutura de dados da fatura.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor a ser pago de acordo com a fatura.
|
amount | float |
Valor a ser pago de acordo com a fatura. |
|
ID do contato de equivalente da fatura.
|
counterpartContactId | integer |
ID do contato de equivalente da fatura. |
|
Nome do contato de equivalente da fatura.
|
counterpartContactName | string |
Nome do contato de equivalente da fatura. |
|
Hora de criação da entidade.
|
created | string |
Hora de criação da entidade. |
|
ID da entidade.
|
id | integer |
ID da entidade. |
|
Data emitida da fatura.
|
issuedDate | string |
Data emitida da fatura. |
|
items
|
items | array of InvoiceItemDto | |
|
Nome da fatura.
|
name | string |
Nome da fatura. |
|
Número BIC da conta bancária do equivalente.
|
orderCounterpartBic | string |
Número BIC da conta bancária do equivalente. |
|
IBAN da conta bancária do equivalente.
|
orderCounterpartIban | string |
IBAN da conta bancária do equivalente. |
|
O número de dias antes ou depois da data de reserva em que o pedido bancário será exibido para execução.
|
orderDayOffset | integer |
O número de dias antes ou depois da data de reserva em que o pedido bancário será exibido para execução. |
|
Identificador exclusivo da conta bancária da propriedade.
|
orderPropertyBankAccountId | integer |
Identificador exclusivo da conta bancária da propriedade. |
|
Número BIC da conta bancária do imóvel.
|
orderPropertyBic | string |
Número BIC da conta bancária do imóvel. |
|
IBAN da conta bancária do imóvel.
|
orderPropertyIban | string |
IBAN da conta bancária do imóvel. |
|
True no caso de haver uma ordem correspondente da fatura.
|
orderRequired | boolean |
True no caso de haver uma ordem correspondente da fatura. |
|
Instrução da ordem gerada.
|
orderStatement | string |
Instrução da ordem gerada. |
|
ID legível humana da propriedade à qual a fatura pertence.
|
propertyHrId | string |
ID legível humana da propriedade à qual a fatura pertence. |
|
ID da propriedade à qual a fatura pertence.
|
propertyId | integer |
ID da propriedade à qual a fatura pertence. |
|
Nome da propriedade à qual a fatura pertence.
|
propertyName | string |
Nome da propriedade à qual a fatura pertence. |
|
Estado da fatura. Valores possíveis: 1. RASCUNHO – fatura criada, mas incompleta.
2. READY - fatura pronta para ser reservada.
3. RESERVADO - fatura reservada.
4. AGENDADO – aplica-se apenas a faturas recorrentes.
5. REVERSED - todas as reservas geradas pela fatura foram revertidas.
|
state | string |
Estado da fatura. Valores possíveis:
|
|
Hora da última atualização da entidade.
|
updated | string |
Hora da última atualização da entidade. |
InvoiceItemDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código da conta do item de reserva.
|
accountCode | string |
Código da conta do item de reserva. |
|
ID da conta do item de reserva.
|
accountId | integer |
ID da conta do item de reserva. |
|
Nome da conta do item de reserva.
|
accountName | string |
Nome da conta do item de reserva. |
|
Valor correspondente ao item de reserva.
|
amount | float |
Valor correspondente ao item de reserva. |
|
Texto de reserva do item de reserva.
|
bookingText | string |
Texto de reserva do item de reserva. |
|
Hora de criação do item da fatura.
|
created | string |
Hora de criação do item da fatura. |
|
Identificador exclusivo do item de reserva.
|
id | integer |
Identificador exclusivo do item de reserva. |
|
Valor relevante para declaração de imposto de renda de acordo com a Lei do Imposto de Renda: [Einkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
|
laborCostAmount | float |
Valor relevante para a declaração de imposto de renda de acordo com a Lei do Imposto de Renda: Einkommenstueregesetz EStG 35a. |
|
Dependendo do tipo selecionado: os percentuais dos valores serão relatados nos anexos 35a de vários relatórios de acordo com a Lei do Imposto de Renda: [EInkommenstueregesetz EStG 35a](https://www.gesetze-im-internet.de/estg/__35a.html).
Ex: Housemoney Settlement (Hausgeldabrechnung) ou Opscost Report (Nebenkostenabrechnung).
1. HOUSEHOLD_RELATED_SERVICES - haushaltsnahe Dienstleistungen 2. TECHNICIAN_SERVICE - haushaltsnahe Handwerkerleistungen 3. MARGINAL_EMPLOYMENT - haushaltsnahe geringfügige Beschäftigungsverhältnisse 4. INSURABLE_EMPLOYMENT - sozialversicherungspflichtigen haushaltsnahen Beschäftigungsverhältnissen
|
laborCostType | string |
Dependendo do tipo selecionado: os percentuais dos valores serão relatados nos anexos 35a de vários relatórios de acordo com a Lei do Imposto de Renda: EStG 35a Einkommenstueregesetz. Ex: Housemoney Settlement (Hausgeldabrechnung) ou Opscost Report (Nebenkostenabrechnung).
|
|
Hora da última atualização do item da fatura.
|
updated | string |
Hora da última atualização do item da fatura. |
|
Valor correspondente do iva do item de reserva.
|
vatAmount | float |
Valor correspondente do iva do item de reserva. |
|
Percentual de iva correspondente do valor total do iva.
|
vatPercentage | float |
Percentual de iva correspondente do valor total do iva. |
PageOfContactDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of ContactDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
PageOfContractDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of ContractDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
PageOfDocumentDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of DocumentDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
PageOfInvoiceDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of InvoiceDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
PageOfPropertyDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of PropertyDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
PageOfUnitDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of UnitDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
numberOfElements
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Classificar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
Paginável
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deslocamento
|
offset | integer | |
|
pageNumber
|
pageNumber | integer | |
|
pageSize
|
pageSize | integer | |
|
Paginada
|
paged | boolean | |
|
Classificar
|
sort | Sort | |
|
despagado
|
unpaged | boolean |
PropertyDto
Estrutura de dados da propriedade.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Hora de criação da instância de propriedade.
|
created | string |
Hora de criação da instância de propriedade. |
|
ID da instância de propriedade.
|
id | integer |
ID da instância de propriedade. |
|
Nome da instância de propriedade.
|
name | string |
Nome da instância de propriedade. |
|
ID legível humana da instância de propriedade.
|
propertyHrId | string |
ID legível humana da instância de propriedade. |
|
Estado atual da propriedade.
1. RASCUNHO – propriedade ainda não ativada, portanto, não é possível gerar reservas/pedidos bancários/relatórios.
2. READY - a propriedade foi ativada e pode ser usada para reservas/pedidos bancários/geração de relatórios.
3. DISABLED - a propriedade foi desativada e não pode mais gerar reservas/pedidos bancários/relatórios.
|
state | string |
Estado atual da propriedade.
|
|
Tipo de administração da propriedade. PROPRIETÁRIO - Associação do Proprietário da Casa. RENTAL – Gerenciamento de Locatários.
|
type | string |
Tipo de administração da propriedade. PROPRIETÁRIO - Associação do Proprietário da Casa. RENTAL – Gerenciamento de Locatários. |
|
Tempo de atualização da instância de propriedade.
|
updated | string |
Tempo de atualização da instância de propriedade. |
Classificar
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
vazio
|
empty | boolean | |
|
Classificados
|
sorted | boolean | |
|
Unsorted
|
unsorted | boolean |
UnitDto
Estrutura de dados de unidade.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Hora de criação da instância da unidade.
|
created | string |
Hora de criação da instância da unidade. |
|
Andar em que a unidade está localizada.
|
floor | string |
Andar em que a unidade está localizada. |
|
ID da instância da unidade.
|
id | integer |
ID da instância da unidade. |
|
Posição da unidade no chão.
|
position | string |
Posição da unidade no chão. |
|
ID da instância de propriedade à qual a unidade pertence.
|
propertyId | integer |
ID da instância de propriedade à qual a unidade pertence. |
|
Finalidade para a qual a unidade é usada. APARTMENT - unidade usada para fins residenciais. PARKING - unidade usada para fins de estacionamento. COMERCIAL – unidade usada para fins comerciais/comerciais. OTHER – unidade usada para outras finalidades.
|
type | string |
Finalidade para a qual a unidade é usada. APARTMENT - unidade usada para fins residenciais. PARKING - unidade usada para fins de estacionamento. COMERCIAL – unidade usada para fins comerciais/comerciais. OTHER – unidade usada para outras finalidades. |
|
ID legível humana da instância da unidade.
|
unitHrId | string |
ID legível humana da instância da unidade. |
|
A classificação define a ordem de como as unidades são exibidas na interface do usuário/relatórios. O usuário pode atualizá-lo na interface do usuário.
|
unitRank | integer |
A classificação define a ordem de como as unidades são exibidas na interface do usuário/relatórios. O usuário pode atualizá-lo na interface do usuário. |
|
Tempo de atualização da instância de unidade.
|
updated | string |
Tempo de atualização da instância de unidade. |
LegacyInvoiceDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Equivalente do BIC
|
counterpartBic | string |
Equivalente do BIC |
|
Equivalente do ContactID
|
counterpartContactId | integer |
Equivalente do ContactID |
|
Equivalente do IBAN
|
counterpartIban | string |
Equivalente do IBAN |
|
Contrapartida
|
counterpartName | string |
Contrapartida |
|
Date
|
created | string |
Date |
|
URL da fatura
|
documentUrl | string |
URL da fatura |
|
ID
|
id | integer |
ID |
|
Data da fatura
|
invoiceDate | string |
Data da fatura |
|
ID da fatura
|
invoiceHrId | string |
ID da fatura |
|
Número da fatura
|
invoiceNumber | string |
Número da fatura |
|
Data de destino do pagamento
|
paymentTargetDate | string |
Data de destino do pagamento |
|
Tipo de pagamento
|
paymentType | string |
Tipo de pagamento |
|
Propriedade NR
|
propertyHrId | string |
Propriedade NR |
|
ID da Propriedade
|
propertyId | integer |
ID da Propriedade |
|
ID interna da propriedade
|
propertyIdInternal | string |
ID interna da propriedade |
|
Nome da propriedade
|
propertyName | string |
Nome da propriedade |
|
Referência Nr
|
refNr | string |
Referência Nr |
|
Status da fatura
|
state | string |
Status da fatura |
|
Total bruto
|
totalGross | float |
Total bruto |
|
Total de Rede
|
totalNet | float |
Total de Rede |
|
IVA incl.
|
vatIncluded | boolean |
IVA incl. |
|
Percentual de IVA
|
vatPercentage | float |
Percentual de IVA |
arquivo
Esse é o tipo de dados básico 'file'.