Impower ERP (Pré-visualização)
Permitir a interação com impower.de sistema de contabilidade para gestores de propriedades
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 | |
|---|---|
| Editora | Impower GmbH |
| Sítio Web | https://www.impower.de |
| Política de privacidade | https://www.impower.de/datenschutzerklaerung |
| Categorias | Gestão Empresarial; Finanças |
O conector Impower permite que você acesse o masterdataset, como propriedades, unidades, contratos e contatos. Além disso, pode carregar documentos e faturas. Pode-se ler os dados de forma programada ou registrando webhooks usando o gatilho integrado.
Pré-requisitos
Para utilizar Impower irá necessitar de:
- Subscrição Impower paga
- Assinatura Powerautomate Premium
Como obter credenciais
Para obter o APIKey para o seu domínio para conectar o powerautomat, escreva uma solicitação em support@impower.de.
Introdução ao conector
Cenários que você pode considerar criar:
- Veja as alterações numa pasta do Sharepoint/Onedrive e, se aparecerem novos ficheiros PDF, carregue-os para impower
- Sincronize a lista de contatos com o catálogo de endereços de suas equipes
Problemas conhecidos e limitações
Download/upload de arquivos
Os arquivos são carregados como dados de formulário de várias partes em formato binário. O mesmo vale para download: os arquivos são fornecidos como é com um nome de arquivo sugerido no cabeçalho - assim como no padrão http
Limitação de taxas
Por favor, procure não fazer mais de 5000 pedidos por minuto. Nós impomos um limite de taxa na API para garantir que o sistema possa atender os usuários rapidamente
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| (Legado) Carregar fatura |
Carregue um arquivo pdf para o Impower usando a API herdada. Em vez disso, use a operação uploadInvoiceUsingPOST. |
| Atualizar o texto da reserva do item de reserva da fatura fornecida |
Atualizar texto da reserva |
| Atualizar um documento existente com base no corpo da solicitação fornecido |
Todas as informações necessárias estão no corpo do pedido |
| Atualizar uma conexão |
Atualizar uma conexão |
| Atualizar uma etiqueta de documento existente com base no id fornecido |
A tag de documento atualizada será retornada como resposta |
| Atualizar uma fatura com base nos campos fornecidos |
Atualizar fatura |
| Carregar documento PDF da fatura |
Por padrão, o documento passará por uma análise OCR |
| Criar um novo documento com base em determinado arquivo |
O documento recém-criado será retornado como resposta |
| Criar uma nova etiqueta de documento |
A tag de documento recém-criada será retornada como resposta |
| Descarregar um único documento por id |
O formato do documento é definido pelo mimetype |
| Detalhes da fatura antiga |
Obtenha detalhes da fatura da Impower através da API herdada. Em vez disso, use getInvoiceByIdUsingGET. |
| Download de vários documentos por determinadas condições de filtro |
Os documentos vêm em formato zip |
| Excluir um documento existente com base na id fornecida |
Os documentos gerados pelo sistema não podem ser excluídos |
| Excluir uma conexão |
Excluir uma conexão |
| Excluir uma tag de documento existente com base na id fornecida |
As tags geradas pelo sistema não podem ser excluídas |
| Ler uma ligação |
Ler uma ligação |
| Obter contatos pelos parâmetros de filtro fornecidos |
Recuperar contatos pelos parâmetros de filtro fornecidos |
| Obter contratos pelos parâmetros de filtro fornecidos |
Recuperar contratos pelos parâmetros de filtro fornecidos |
| 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 fornecidos |
Recuperar documentos pelos parâmetros de filtro fornecidos |
| Obter etiquetas de documentos |
As tags de documento padrão e específicas do domínio serão retornadas como resposta |
| Obter faturas pelos parâmetros de filtro fornecidos |
Recupera faturas pelos parâmetros de filtro fornecidos |
| Obter propriedades pelos parâmetros de filtro fornecidos |
Recuperar propriedades pelos parâmetros de filtro fornecidos |
| Obter todas as unidades por determinados parâmetros de filtro |
Devolve todas as unidades respeitando os critérios de filtro fornecidos |
| Obter todos os valores de código de erro predefinidos |
Devolve uma lista de todos os códigos de erro predefinidos |
| Obter um contato pelo id fornecido |
Recupera um contato pelo id fornecido |
| Obter um contrato pelo id fornecido |
Recupera um contrato pelo id fornecido |
| Obter uma fatura pelo ID fornecido |
Recupera uma fatura pelo id fornecido |
| Obter uma propriedade pelo id fornecido |
Recupera uma propriedade pelo id fornecido |
| Obter uma unidade pelo id fornecido |
Devolva a unidade com o id fornecido |
(Legado) Carregar fatura
Carregue um arquivo pdf para o Impower usando a API herdada. Em vez disso, use a operação uploadInvoiceUsingPOST.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifique o ficheiro pdf a carregar
|
file | True | file |
Especifique o ficheiro pdf a carregar |
Devoluções
- LegacyInvoiceDto
- LegacyInvoiceDto
Atualizar o texto da reserva do item de reserva da fatura fornecida
Atualizar texto da reserva
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID único do item de reserva da fatura
|
invoiceItemId | True | integer |
ID único do item de reserva da fatura |
|
Texto de reserva do item da fatura.
|
bookingText | string |
Texto de reserva do item da fatura. |
Devoluções
- InvoiceItemDto
- InvoiceItemDto
Atualizar um documento existente com base no corpo da solicitação fornecido
Todas as informações necessárias estão no corpo do pedido
Parâmetros
| Name | Chave | Necessá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 |
|
|
Novo edifício edifício o documento a ser atribuído.
|
buildingId | integer |
Novo edifício edifício o 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 o documento a ser atribuído
|
contractId | integer |
Novo contrato o documento a ser atribuído |
|
|
O identificador único do documento a atualizar
|
id | True | integer |
O identificador único do documento a atualizar |
|
Nova data de emissão do documento data a ser atualizada para
|
issuedDate | string |
Nova data de emissão do documento data a ser atualizada para |
|
|
Novo valor para o qual o nome do documento a ser atualizado
|
name | string |
Novo valor para o qual o nome do documento a ser atualizado |
|
|
Nova propriedade do documento a ser atribuído
|
propertyId | integer |
Nova propriedade do documento a ser atribuído |
|
|
Novo ID do processo de origem do documento a ser atribuído
|
sourceId | integer |
Novo ID do processo de origem do documento a ser atribuído |
|
|
Identificadores das etiquetas a atribuir ao documento
|
tagIds | array of integer |
Identificadores das etiquetas a atribuir ao documento |
|
|
Nova unidade do documento a atribuir
|
unitId | integer |
Nova unidade do documento a atribuir |
Devoluções
- response
- array of DocumentDto
Atualizar uma conexão
Atualizar uma conexão
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conexão
|
connectionIdX | True | integer |
ID da conexão |
|
Nome da conexão como 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 como 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"} |
Devoluções
Dados que descrevem uma conexão existente
- ConexãoDto
- ConnectionDto
Atualizar uma etiqueta de documento existente com base no id fornecido
A tag de documento atualizada será retornada como resposta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma etiqueta de documento
|
tagId | True | integer |
Identificador exclusivo de uma etiqueta de documento |
|
Nova descrição da etiqueta do documento.
|
description | string |
Nova descrição da etiqueta do documento. |
|
|
Novo nome da tag do documento.
|
name | string |
Novo nome da tag do documento. |
Devoluções
Classe de modelo de uma marca de documento.
- DocumentTagDto
- DocumentTagDto
Atualizar uma fatura com base nos campos fornecidos
Atualizar fatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo de uma fatura
|
invoiceId | True | integer |
ID exclusivo de uma fatura |
|
Nova data de emissão da fatura.
|
issuedDate | string |
Nova data de emissão da fatura. |
|
|
Novo nome da fatura.
|
name | string |
Novo nome da fatura. |
Devoluções
Estrutura de dados da fatura.
- InvoiceDto
- InvoiceDto
Carregar documento PDF da fatura
Por padrão, o documento passará por uma análise OCR
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ficheiro PDF de uma fatura
|
file | True | file |
Ficheiro PDF de uma fatura |
Devoluções
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ficheiro PDF para carregar
|
file | True | file |
Ficheiro PDF para carregar |
Devoluções
Estrutura de dados do documento.
- DocumentDto
- DocumentDto
Criar uma nova etiqueta de documento
A tag de documento recém-criada será retornada como resposta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Descrição da tag de documento recém-criada.
|
description | string |
Descrição da tag de documento recém-criada. |
|
|
Nome da tag de documento recém-criada.
|
name | string |
Nome da tag de documento recém-criada. |
Devoluções
Classe de modelo de uma marca de documento.
- DocumentTagDto
- DocumentTagDto
Descarregar um único documento por id
O formato do documento é definido pelo mimetype
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador único de um documento
|
documentId | True | integer |
Identificador único de um documento |
Devoluções
- response
- file
Detalhes da fatura antiga
Obtenha detalhes da fatura da Impower através da API herdada. Em vez disso, use getInvoiceByIdUsingGET.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoiceId | True | integer |
Especifique o ID da fatura para obter detalhes |
Devoluções
- LegacyInvoiceDto
- LegacyInvoiceDto
Download de vários documentos por determinadas condições de filtro
Os documentos vêm em formato zip
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do contabilista do imóvel.
|
accountant | string |
Nome do contabilista do imóvel. |
|
|
Nome do administrador da propriedade.
|
administrator | string |
Nome do administrador da propriedade. |
|
|
ID da entidade de contacto a que pertence o documento.
|
contactId | integer |
ID da entidade de contacto a que pertence o documento. |
|
|
Documentos ligados a contratos com nome semelhante.
|
contractName | string |
Documentos ligados a contratos com nome semelhante. |
|
|
IDs dos documentos a devolver.
|
documentIds | array |
IDs dos documentos a devolver. |
|
|
Nome dos documentos a devolver.
|
documentName | string |
Nome dos documentos a devolver. |
|
|
Data de emissão do documento.
|
issuedDate | string |
Data de emissão do documento. |
|
|
Documentos emitidos com data anterior.
|
maxIssuedDate | string |
Documentos emitidos com data anterior. |
|
|
Documentos emitidos com data posterior.
|
minIssuedDate | string |
Documentos emitidos com data posterior. |
|
|
ID legível por humanos da propriedade a que o documento pertence.
|
propertyHrId | string |
ID legível por humanos da propriedade a que o documento pertence. |
|
|
ID da propriedade a que o documento pertence.
|
propertyId | integer |
ID da propriedade a que 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 das tags às quais o documento está associado.
|
tagIds | array |
IDs das tags às quais o documento está associado. |
|
|
Nome semelhante da tag à qual o documento está associado.
|
tagName | string |
Nome semelhante da tag à qual o documento está associado. |
|
|
ID da entidade unitária a que pertence o documento.
|
unitId | integer |
ID da entidade unitária a que pertence o documento. |
Devoluções
- response
- file
Excluir um documento existente com base na id fornecida
Os documentos gerados pelo sistema não podem ser excluídos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
documentId
|
documentId | True | integer |
documentId |
Excluir uma conexão
Excluir uma conexão
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conexão
|
connectionIdX | True | integer |
ID da conexão |
Excluir uma tag de documento existente com base na id fornecida
As tags geradas pelo sistema não podem ser excluídas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo da etiqueta do documento a eliminar
|
tagId | True | integer |
Identificador exclusivo da etiqueta do documento a eliminar |
Ler uma ligação
Ler uma ligação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O id da conexão
|
connectionIdX | True | integer |
O id da conexão |
Devoluções
Dados que descrevem uma conexão existente
- ConexãoDto
- ConnectionDto
Obter contatos pelos parâmetros de filtro fornecidos
Recuperar contatos pelos parâmetros de filtro fornecidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lista de ids de contato para filtrar contatos.
|
contactIds | array |
Lista de ids de contato para filtrar contatos. |
|
|
Endereço de e-mail do contato.
|
string |
Endereço de e-mail 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 devolver
|
page | integer |
Número da página a devolver |
|
|
Número de itens a serem devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Devoluções
- PageOfContactDto
- PageOfContactDto
Obter contratos pelos parâmetros de filtro fornecidos
Recuperar contratos pelos parâmetros de filtro fornecidos
Parâmetros
| Name | Chave | Necessá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 devolver
|
page | integer |
Número da página a devolver |
|
|
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 devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
|
|
Tipo de contrato. Opções: PROPRIETÁRIO | INQUILINO | PROPERTY_OWNER
|
type | array |
Tipo de contrato. Opções: PROPRIETÁRIO | INQUILINO | PROPERTY_OWNER |
|
|
ID da instância da unidade à qual o contrato está associado.
|
unitId | integer |
ID da instância da unidade à qual o contrato está associado. |
|
|
Devolver contratos válidos na data. Nulo é interpretado como início/fim do tempo.
|
validAtDate | string |
Devolver contratos válidos na data. Nulo é interpretado como início/fim do tempo. |
Devoluções
- 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
valor
|
value | True | string |
valor |
Devoluções
- ErrorCodeDetailsDto
- ErrorCodeDetailsDto
Obter documentos pelos parâmetros de filtro fornecidos
Recuperar documentos pelos parâmetros de filtro fornecidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do contabilista do imóvel.
|
accountant | string |
Nome do contabilista do imóvel. |
|
|
Nome do administrador da propriedade.
|
administrator | string |
Nome do administrador da propriedade. |
|
|
ID da entidade de contacto a que pertence o documento.
|
contactId | integer |
ID da entidade de contacto a que pertence o documento. |
|
|
Documentos ligados a contratos com nome semelhante.
|
contractName | string |
Documentos ligados a contratos com nome semelhante. |
|
|
IDs dos documentos a devolver.
|
documentIds | array |
IDs dos documentos a devolver. |
|
|
Nome dos documentos a devolver.
|
documentName | string |
Nome dos documentos a devolver. |
|
|
Data de emissão do documento.
|
issuedDate | string |
Data de emissão do documento. |
|
|
Documentos emitidos com data anterior.
|
maxIssuedDate | string |
Documentos emitidos com data anterior. |
|
|
Documentos emitidos com data posterior.
|
minIssuedDate | string |
Documentos emitidos com data posterior. |
|
|
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 devolver
|
page | integer |
Número da página a devolver |
|
|
ID legível por humanos da propriedade a que o documento pertence.
|
propertyHrId | string |
ID legível por humanos da propriedade a que o documento pertence. |
|
|
ID da propriedade a que o documento pertence.
|
propertyId | integer |
ID da propriedade a que 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 devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos 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 das tags às quais o documento está associado.
|
tagIds | array |
IDs das tags às quais o documento está associado. |
|
|
Nome semelhante da tag à qual o documento está associado.
|
tagName | string |
Nome semelhante da tag à qual o documento está associado. |
|
|
ID da entidade unitária a que pertence o documento.
|
unitId | integer |
ID da entidade unitária a que pertence o documento. |
Devoluções
- PageOfDocumentDto
- PageOfDocumentDto
Obter etiquetas de documentos
As tags de documento padrão e específicas do domínio serão retornadas como resposta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Cadeia de pesquisa aplicada ao nome e à descrição
|
description | string |
Cadeia de pesquisa aplicada ao nome e à descrição |
Devoluções
- response
- array of DocumentTagDto
Obter faturas pelos parâmetros de filtro fornecidos
Recupera faturas pelos parâmetros de filtro fornecidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador único do contacto homólogo
|
counterpartContactId | integer |
Identificador único do contacto homólogo |
|
|
Data das faturas a recuperar
|
issuedDate | string |
Data das faturas a recuperar |
|
|
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 devolver
|
page | integer |
Número da página a devolver |
|
|
Identificador exclusivo da propriedade à qual uma fatura pertence
|
propertyId | integer |
Identificador exclusivo da propriedade à qual uma fatura pertence |
|
|
Número de itens a serem devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
|
|
Estados das faturas a recuperar
|
states | array |
Estados das faturas a recuperar |
Devoluções
- PageOfInvoiceDto
- PageOfInvoiceDto
Obter propriedades pelos parâmetros de filtro fornecidos
Recuperar propriedades pelos parâmetros de filtro fornecidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do imóvel.
|
name | string |
Nome do imóvel. |
|
|
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 devolver
|
page | integer |
Número da página a devolver |
|
|
ID legível por humanos da propriedade.
|
propertyHrId | string |
ID legível por humanos da propriedade. |
|
|
Número de itens a serem devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Devoluções
- PageOfPropertyDto
- PageOfPropertyDto
Obter todas as unidades por determinados parâmetros de filtro
Devolve todas as unidades respeitando os critérios de filtro fornecidos
Parâmetros
| Name | Chave | Necessá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 devolver
|
page | integer |
Número da página a devolver |
|
|
Identificador exclusivo da propriedade a que uma unidade pertence
|
propertyId | integer |
Identificador exclusivo da propriedade a que uma unidade pertence |
|
|
Número de itens a serem devolvidos em uma única página
|
size | integer |
Número de itens a serem devolvidos em uma única página |
|
|
Parâmetro de classificação
|
sort | string |
Parâmetro de classificação |
Devoluções
- PageOfUnitDto
- PageOfUnitDto
Obter todos os valores de código de erro predefinidos
Devolve uma lista de todos os códigos de erro predefinidos
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of string |
Obter um contato pelo id fornecido
Recupera um contato pelo id fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de um contacto
|
contactId | True | integer |
Identificador exclusivo de um contacto |
Devoluções
Um contacto representa uma pessoa singular ou coletiva e a forma de os contactar. Deve uma identidade/empresa ter vários endereços postais através dos quais possa ser contactada. Estes são representados como 2 contatos diferentes.
- ContatoDto
- ContactDto
Obter um contrato pelo id fornecido
Recupera um contrato pelo id fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador único de um contrato
|
contractId | True | integer |
Identificador único de um contrato |
Devoluções
Estrutura de dados do contrato.
- ContractDto
- ContractDto
Obter uma fatura pelo ID fornecido
Recupera uma fatura pelo id fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma fatura
|
invoiceId | True | integer |
Identificador exclusivo de uma fatura |
Devoluções
Estrutura de dados da fatura.
- InvoiceDto
- InvoiceDto
Obter uma propriedade pelo id fornecido
Recupera uma propriedade pelo id fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificador exclusivo de uma propriedade
|
propertyId | True | integer |
Identificador exclusivo de uma propriedade |
Devoluções
Estrutura de dados de propriedade.
- PropriedadeDto
- PropertyDto
Obter uma unidade pelo id fornecido
Devolva a unidade com o id fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID único de uma unidade
|
unitId | True | integer |
ID único de uma unidade |
Devoluções
Estrutura de dados da unidade.
- UnitDto
- UnitDto
Acionadores
| Criar uma conexão de aplicativo |
Criar uma conexão de aplicativo |
Criar uma conexão de aplicativo
Definições
ConnectionNotificationDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
O id da conexão à qual a notificação se aplica
|
connectionId | integer |
connectionId |
|
tipo de entidade
|
entityType | string |
tipo de entidade |
|
entityId
|
entityId | integer |
entityId |
|
eventType
|
eventType | string |
eventType |
ConexãoDto
Dados que descrevem uma conexão existente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id de um pedido
|
appId | integer |
Id de um pedido |
|
Nome do aplicativo da conexão
|
appName | string |
Nome do aplicativo da conexão |
|
Tempo de criação da entidade.
|
created | string |
Tempo 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 ''' Autorização POST https://your.webhook.url/path/somewhere : Bearer TOKEN
{ "connectionId": 0, "entityType": "properties|contacts|invoices|etc.", "entityId": 0, "eventType": "CREATE|ATUALIZAÇÃO|ELIMINAR" }'''
|
webhookUrl | string |
Webhook da conexão que será chamada como
|
ContactoDetalhesDto
Detalhes do contacto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de telefone comercial do contacto
|
businessPhoneNumber | array of string |
Número de telefone comercial do contacto |
|
Data de nascimento do contacto.
|
dateOfBirth | string |
Data de nascimento do contacto. |
|
Endereço de e-mail do contato
|
array of string |
Endereço de e-mail do contato |
|
|
Número de fax do contacto
|
fax | array of string |
Número de fax do contacto |
|
Número de telemóvel do contacto
|
mobilePhoneNumber | array of string |
Número de telemóvel do contacto |
|
Número de telefone privado do contacto
|
privatePhoneNumber | array of string |
Número de telefone privado do contacto |
|
Número de registo comercial.
|
tradeRegisterNumber | string |
Número de registo comercial. |
|
ID de IVA do contacto.
|
vatId | string |
ID de IVA do contacto. |
|
Website do contacto
|
website | array of string |
Website do contacto |
ContatoDto
Um contacto representa uma pessoa singular ou coletiva e a forma de os contactar. Deve uma identidade/empresa ter vários endereços postais através dos quais possa ser contactada. Estes são representados como 2 contatos diferentes.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da cidade.
|
city | string |
Nome da cidade. |
|
Nome da empresa, caso o contacto seja uma empresa.
|
companyName | string |
Nome da empresa, caso o contacto seja uma empresa. |
|
Código do país de acordo com a norma ISO 3166-1 alpha-2.
|
country | string |
Código do país de acordo com a norma ISO 3166-1 alpha-2. |
|
Tempo de criação do contacto.
|
created | string |
Tempo de criação do contacto. |
|
ContactoDetalhesDto
|
details | ContactDetailsDto |
Detalhes do contacto |
|
Nome próprio do contacto, no caso de o contacto ser uma pessoa.
|
firstName | string |
Nome próprio do contacto, no caso de o contacto ser uma pessoa. |
|
ID da instância de contato.
|
id | integer |
ID da instância de contato. |
|
Apelido do contacto, caso o contacto seja uma pessoa.
|
lastName | string |
Apelido do contacto, caso o contacto seja uma pessoa. |
|
Número da rua.
|
number | string |
Número da rua. |
|
Código postal ou código postal. Certifique-se de que é especificado para cada pessoa que necessite de contato físico por carta via e-post.
|
postalCode | string |
Código postal ou código postal. Certifique-se de que é especificado para cada pessoa que necessite de contato físico por carta via e-post. |
|
Nome do destinatário do contato.
|
recipientName | string |
Nome do destinatário do contato. |
|
Uma fórmula padrão de palavras usadas para abordar o contato.
|
salutation | string |
Uma fórmula padrão de palavras usadas 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 contacto.
|
updated | string |
Hora da última atualização do contacto. |
ContatoSimpleDto
Entre em contato com a estrutura de dados simplificada.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da instância de contato.
|
id | integer |
ID da instância de contato. |
|
O nome do contato. Para informações mais detalhadas, carregue o contato via id.
|
name | string |
O nome do contato. Para informações mais detalhadas, carregue o contato via id. |
ContractDto
Estrutura de dados do contrato.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista dos contactos associados ao contrato.
|
contacts | array of ContactSimpleDto |
Lista dos contactos associados ao contrato. |
|
Número do contrato.
|
contractNumber | string |
Número do contrato. |
|
Tempo de criação do contrato.
|
created | string |
Tempo de criação do contrato. |
|
Data de termo do período de validade do contrato. Nulo é interpretado como fim dos tempos.
|
endDate | string |
Data de termo do período de validade do contrato. Nulo é interpretado como fim dos tempos. |
|
ID da instância do contrato.
|
id | integer |
ID da instância do contrato. |
|
Descreve se este contrato é um contrato de tipo vago. A partir de agora só pode ser verdade no caso de o contrato ser do tipo é LOCATÁRIO. Contrato vago significa que a unidade não está alugada.
|
isVacant | boolean |
Descreve se este contrato é um contrato de tipo vago. A partir de agora só pode ser verdade no caso de o contrato ser do tipo é LOCATÁRIO. Contrato vago significa que a unidade não está alugada. |
|
Nome do contrato que consiste na chave da unidade e nome do contacto postal.
|
name | string |
Nome do contrato que consiste na chave da unidade e nome do contacto postal. |
|
ID da instância de propriedade à qual o contrato pertence.
|
propertyId | integer |
ID da instância de propriedade à qual o contrato pertence. |
|
Data de início do período de validade do contrato. Nulo é interpretado como início do tempo.
|
startDate | string |
Data de início do período de validade do contrato. Nulo é interpretado como início do tempo. |
|
Tipo de contrato.
1. PROPRIETÁRIO - um contrato deste tipo comprova a propriedade da unidade.
2. INQUILINO - um contrato deste tipo é o arrendamento da unidade.
3. PROPERTY_OWNER - um contrato deste tipo comprova a propriedade do imóvel.
|
type | string |
Tipo de contrato.
|
|
ID da instância da unidade à qual o contrato pertence.
|
unitId | integer |
ID da instância da 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.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor total presente no documento.
|
amount | float |
Valor total presente no documento. |
|
ID do edifício ao qual o documento pertence.
|
buildingId | integer |
ID do edifício ao qual o documento pertence. |
|
ID do contacto a que pertence o documento.
|
contactId | integer |
ID do contacto a que pertence o documento. |
|
ID do contrato a que pertence o documento.
|
contractId | integer |
ID do contrato a que pertence o documento. |
|
Tempo de criação do documento.
|
created | string |
Tempo de criação do documento. |
|
ID da instância do documento.
|
id | integer |
ID da instância do documento. |
|
Data de emissão do documento.
|
issuedDate | string |
Data de emissão do documento. |
|
Nome da instância do documento.
|
name | string |
Nome da instância do documento. |
|
ID legível por humanos da propriedade à qual o documento está atribuído.
|
propertyHrId | string |
ID legível por humanos da propriedade à qual o documento está atribuído. |
|
ID da propriedade a que o documento pertence.
|
propertyId | integer |
ID da propriedade a que o documento pertence. |
|
Nome da propriedade à qual o documento está atribuído.
|
propertyName | string |
Nome da propriedade à qual o documento está 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.
Juntamente com o id identifica o processo comercial com o mesmo nome do qual o documento se origina/está anexado.
Pode ser nulo.
|
sourceType | string |
Tipo de origem do documento. Juntamente com o id identifica o processo comercial com o mesmo nome do qual o documento se origina/está anexado. Pode ser nulo. |
|
Estado do documento.
|
state | string |
Estado do documento. |
|
tags
|
tags | array of DocumentTagSimpleDto | |
|
ID legível por humanos da unidade à qual o documento está atribuído.
|
unitHrId | string |
ID legível por humanos da unidade à qual o documento está atribuído. |
|
ID da unidade a que pertence o documento.
|
unitId | integer |
ID da unidade a que pertence o documento. |
|
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.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição da etiqueta do documento.
|
description | string |
Descrição da etiqueta do documento. |
|
ID da etiqueta do documento.
|
id | integer |
ID da etiqueta do documento. |
|
Nome da etiqueta do documento.
|
name | string |
Nome da etiqueta do documento. |
DocumentTagSimpleDto
Classe de modelo de uma marca de documento.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador exclusivo da etiqueta do documento.
|
id | integer |
Identificador exclusivo da etiqueta do documento. |
|
Nome da etiqueta do documento.
|
name | string |
Nome da etiqueta do documento. |
ErrorCodeDetailsDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string | |
|
descrição
|
description | string |
InvoiceDto
Estrutura de dados da fatura.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor a pagar de acordo com a fatura.
|
amount | float |
Valor a pagar de acordo com a fatura. |
|
ID do contacto de contrapartida da fatura.
|
counterpartContactId | integer |
ID do contacto de contrapartida da fatura. |
|
Nome do contacto homólogo da fatura.
|
counterpartContactName | string |
Nome do contacto homólogo da fatura. |
|
Tempo de criação da entidade.
|
created | string |
Tempo de criação da entidade. |
|
Id da entidade.
|
id | integer |
Id da entidade. |
|
Data de emissão da fatura.
|
issuedDate | string |
Data de emissão da fatura. |
|
items
|
items | array of InvoiceItemDto | |
|
Nome da fatura.
|
name | string |
Nome da fatura. |
|
Número BIC da conta bancária da contraparte.
|
orderCounterpartBic | string |
Número BIC da conta bancária da contraparte. |
|
IBAN da conta bancária da contraparte.
|
orderCounterpartIban | string |
IBAN da conta bancária da contraparte. |
|
O número de dias antes ou depois da data de reserva em que a ordem bancária deve aparecer para execução.
|
orderDayOffset | integer |
O número de dias antes ou depois da data de reserva em que a ordem bancária deve aparecer para execução. |
|
Identificador único da conta bancária do imóvel.
|
orderPropertyBankAccountId | integer |
Identificador único da conta bancária do imóvel. |
|
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. |
|
Declaração da ordem gerada.
|
orderStatement | string |
Declaração da ordem gerada. |
|
ID legível por humanos da propriedade a que a fatura pertence.
|
propertyHrId | string |
ID legível por humanos da propriedade a que 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. PRONTO - fatura pronta para ser reservada.
3. RESERVADO - fatura reservada.
4. AGENDADO - aplica-se apenas a faturas recorrentes.
5. REVERTIDO - 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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de conta do item da reserva.
|
accountCode | string |
Código de conta do item da reserva. |
|
ID da conta do item da reserva.
|
accountId | integer |
ID da conta do item da reserva. |
|
Nome da conta do item de reserva.
|
accountName | string |
Nome da conta do item de reserva. |
|
Valor correspondente ao item da reserva.
|
amount | float |
Valor correspondente ao item da reserva. |
|
Texto da reserva do item de reserva.
|
bookingText | string |
Texto da reserva do item de reserva. |
|
Tempo de criação do item da fatura.
|
created | string |
Tempo de criação do item da fatura. |
|
Identificador único do item de reserva.
|
id | integer |
Identificador único do item de reserva. |
|
Montante relevante para a declaração do imposto sobre o rendimento de acordo com a Lei do Imposto sobre o Rendimento: [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: as percentagens dos montantes serão comunicadas nos anexos 35a de relatórios múltiplos de acordo com a Lei do Imposto sobre o Rendimento: [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: as percentagens dos montantes serão declaradas nos anexos 35a de vários relatórios de acordo com a Lei do Imposto sobre o Rendimento: Einkommenstueregesetz EStG 35a. 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 do IVA correspondente ao item da reserva.
|
vatAmount | float |
Valor do IVA correspondente ao item da reserva. |
|
Percentagem de IVA correspondente ao montante do IVA do montante total.
|
vatPercentage | float |
Percentagem de IVA correspondente ao montante do IVA do montante total. |
PageOfContactDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of ContactDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
PageOfContractDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of ContractDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
PageOfDocumentDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of DocumentDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
PageOfInvoiceDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of InvoiceDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
PageOfPropertyDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of PropertyDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
PageOfUnitDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conteúdo
|
content | array of UnitDto | |
|
vazio
|
empty | boolean | |
|
primeiro
|
first | boolean | |
|
último
|
last | boolean | |
|
número
|
number | integer | |
|
númerodeelementos
|
numberOfElements | integer | |
|
Paginável
|
pageable | Pageable | |
|
size
|
size | integer | |
|
Ordenar
|
sort | Sort | |
|
totalElements
|
totalElements | integer | |
|
totalPáginas
|
totalPages | integer |
Paginável
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
offset
|
offset | integer | |
|
Número da página
|
pageNumber | integer | |
|
pageSize
|
pageSize | integer | |
|
paginado
|
paged | boolean | |
|
Ordenar
|
sort | Sort | |
|
não paginado
|
unpaged | boolean |
PropriedadeDto
Estrutura de dados de propriedade.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tempo de criação da instância do imóvel.
|
created | string |
Tempo de criação da instância do imóvel. |
|
ID da instância da propriedade.
|
id | integer |
ID da instância da propriedade. |
|
Nome da instância da propriedade.
|
name | string |
Nome da instância da propriedade. |
|
ID legível por humanos da instância de propriedade.
|
propertyHrId | string |
ID legível por humanos da instância de propriedade. |
|
Estado atual da propriedade.
1. RASCUNHO - imóvel ainda não ativado, portanto não podem ser geradas reservas/ordens bancárias/relatórios.
2. PRONTO - a propriedade foi ativada e pode ser usada para reservas / ordens bancárias / geração de relatórios.
3. DESATIVADO - a propriedade foi desativada e não pode mais gerar reservas/ordens bancárias/relatórios.
|
state | string |
Estado atual da propriedade.
|
|
Tipo de administração do imóvel. PROPRIETÁRIO - Associação de Proprietários. ARRENDAMENTO - Gestão de Inquilinos.
|
type | string |
Tipo de administração do imóvel. PROPRIETÁRIO - Associação de Proprietários. ARRENDAMENTO - Gestão de Inquilinos. |
|
Hora de atualização da instância da propriedade.
|
updated | string |
Hora de atualização da instância da propriedade. |
Ordenar
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
vazio
|
empty | boolean | |
|
ordenado
|
sorted | boolean | |
|
não classificado
|
unsorted | boolean |
UnitDto
Estrutura de dados da unidade.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tempo de criação da instância da unidade.
|
created | string |
Tempo 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 dentro do piso.
|
position | string |
Posição da unidade dentro do piso. |
|
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. APARTAMENTO - unidade utilizada para fins residenciais. ESTACIONAMENTO - unidade utilizada para fins de estacionamento. COMERCIAL - unidade utilizada para fins comerciais. OUTROS - unidade utilizada para outros fins.
|
type | string |
Finalidade para a qual a unidade é usada. APARTAMENTO - unidade utilizada para fins residenciais. ESTACIONAMENTO - unidade utilizada para fins de estacionamento. COMERCIAL - unidade utilizada para fins comerciais. OUTROS - unidade utilizada para outros fins. |
|
ID legível por humanos da instância da unidade.
|
unitHrId | string |
ID legível por humanos 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 da unidade.
|
updated | string |
Tempo de atualização da instância da unidade. |
LegacyInvoiceDto
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contrapartida BIC
|
counterpartBic | string |
Contrapartida BIC |
|
Contraparte ContactID
|
counterpartContactId | integer |
Contraparte ContactID |
|
Contrapartida IBAN
|
counterpartIban | string |
Contrapartida 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-limite de pagamento
|
paymentTargetDate | string |
Data-limite de pagamento |
|
Tipo de Pagamento
|
paymentType | string |
Tipo de Pagamento |
|
Propriedade NR
|
propertyHrId | string |
Propriedade NR |
|
ID da Propriedade
|
propertyId | integer |
ID da Propriedade |
|
ID Interno da Propriedade
|
propertyIdInternal | string |
ID Interno da Propriedade |
|
Nome da propriedade
|
propertyName | string |
Nome da propriedade |
|
N.º de referência
|
refNr | string |
N.º de referência |
|
Status da fatura
|
state | string |
Status da fatura |
|
Total Bruto
|
totalGross | float |
Total Bruto |
|
Total líquido
|
totalNet | float |
Total líquido |
|
IVA incl.
|
vatIncluded | boolean |
IVA incl. |
|
Percentagem de IVA
|
vatPercentage | float |
Percentagem de IVA |
ficheiro
Este é o tipo de dados básicos 'arquivo'.