openapi: 3.0.3
info:
title: 'API Apresenta.me'
description: 'Esta documentação serve para fornecer todas as informações de que você precisa para trabalhar com a API da Apresenta.me.'
version: 1.0.0
servers:
- url: 'https://api.apresenta.me'
tags:
- name: 'Classificação dos Imóveis › Tipos de Imóveis'
x-displayName: 'Tipos de Imóveis'
- name: 'Classificação dos Imóveis › Categorias'
x-displayName: Categorias
- name: Condomínios
x-displayName: Condomínios
- name: Construtoras
x-displayName: Construtoras
- name: Endpoints
x-displayName: Endpoints
- name: 'Equipes de Usuários'
x-displayName: 'Equipes de Usuários'
- name: Eventos
x-displayName: Eventos
- name: 'Financeiro › Faturas'
x-displayName: Faturas
- name: 'Financeiro › Contas a Pagar e Receber'
x-displayName: 'Contas a Pagar e Receber'
- name: 'Financeiro › Repasses'
x-displayName: Repasses
- name: 'Financeiro › Itens para Lançamentos'
x-displayName: 'Itens para Lançamentos'
- name: 'Financeiro › Contratos » Veículos'
x-displayName: 'Contratos » Veículos'
- name: 'Financeiro › Contratos » Ocupantes'
x-displayName: 'Contratos » Ocupantes'
- name: 'Financeiro › Contratos » Itens'
x-displayName: 'Contratos » Itens'
- name: 'Financeiro › Contratos'
x-displayName: Contratos
- name: 'Grupos de Usuários'
x-displayName: 'Grupos de Usuários'
- name: 'Históricos › Tipos'
x-displayName: Tipos
- name: Históricos
x-displayName: Históricos
- name: 'Imóveis › Finalidades'
x-displayName: Finalidades
- name: 'Imóveis › Data indisponível'
x-displayName: 'Data indisponível'
- name: 'Imóveis › Abas'
x-displayName: Abas
- name: 'Imóveis › Pacote de Temporadas'
x-displayName: 'Pacote de Temporadas'
- name: 'Imóveis › Estágios'
x-displayName: Estágios
- name: 'Imóveis › Movimentação de Chaves'
x-displayName: 'Movimentação de Chaves'
- name: 'Imóveis › Claviculário'
x-displayName: Claviculário
- name: 'Imóveis › Chaves'
x-displayName: Chaves
- name: 'Imóveis › Detalhes'
x-displayName: Detalhes
- name: 'Imóveis › Grupo de Detalhes'
x-displayName: 'Grupo de Detalhes'
- name: Imóveis
x-displayName: Imóveis
- name: 'Imóveis › Mídia'
x-displayName: Mídia
- name: 'Imóveis - Atualizar imóveis com IA'
x-displayName: 'Imóveis - Atualizar imóveis com IA'
description: "\nLê arquivos (tabela de construtora, folder, planilha), acha o imóvel de cada linha e propõe as alterações campo a campo.\nNada é gravado antes da revisão; aplicar e desfazer rodam em segundo plano.\n\n🔒 Alteração em Massa de imóveis. A leitura por IA também exige Executar Tarefas de IA. "
- name: 'Imóveis - Quadro de Unidades'
x-displayName: 'Imóveis - Quadro de Unidades'
description: "\nTabela de vendas do lançamento. Cada unidade é uma linha da tabela da construtora\ne só vira imóvel de verdade quando entra em proposta."
- name: Leads
x-displayName: Leads
- name: 'Localizações › Países'
x-displayName: Países
- name: 'Localizações › Estados'
x-displayName: Estados
- name: 'Localizações › Cidades'
x-displayName: Cidades
- name: 'Localizações › Bairros'
x-displayName: Bairros
- name: Negócio
x-displayName: Negócio
- name: 'Negócios › Etapas do Funil'
x-displayName: 'Etapas do Funil'
- name: 'Negócios › Funis'
x-displayName: Funis
- name: Negócios
x-displayName: Negócios
- name: Pessoas
x-displayName: Pessoas
- name: 'Pessoas › Profissões'
x-displayName: Profissões
- name: 'Pessoas › Contatos'
x-displayName: Contatos
- name: 'Pessoas › Contas Bancárias'
x-displayName: 'Contas Bancárias'
- name: Propostas
x-displayName: Propostas
- name: 'Regras para Rodízio de Leads'
x-displayName: 'Regras para Rodízio de Leads'
- name: 'Remessas de Cobrança'
x-displayName: 'Remessas de Cobrança'
description: "\nRemessas de cobrança / boletos (CNAB 240/400).\n\nFluxo de geração de remessa para envio ao banco:\n\n1. `POST /financial/ticketBatch` — cria a remessa vazia (informe `description`, `account_id`, etc.).\n2. `POST /financial/ticketBatch/{id}/addInvoices` — anexa as faturas que terão boleto gerado (envie `invoices: [ids]`).\n Use `removeInvoices` / `revertInvoices` para ajustes antes de fechar o arquivo.\n3. `GET /financial/ticketBatch/{id}/downloadBatchFile` — baixa o arquivo `.REM` (CNAB) para envio ao banco.\n4. `GET /financial/ticketBatch/{id}/invoices` — consulta as faturas vinculadas à remessa."
- name: 'Remessas de Pagamento'
x-displayName: 'Remessas de Pagamento'
description: "\nRemessas de pagamento (CNAB 240/400).\n\nFluxo de geração de remessa para envio ao banco:\n\n1. `POST /financial/paymentBatch` — cria a remessa vazia (informe `description`, `account_id`, etc.).\n2. `POST /financial/paymentBatch/{id}/addTransactions` — anexa os lançamentos a pagar (envie `transactions: [ids]`).\n Repita conforme necessário ou utilize `removeTransactions` / `revertTransactions` para ajustes.\n3. `GET /financial/paymentBatch/{id}/downloadBatchFile` — baixa o arquivo `.REM` para envio ao banco.\n4. `GET /financial/paymentBatch/{id}/transactions` — consulta os lançamentos vinculados à remessa."
- name: Tickets
x-displayName: Tickets
- name: Usuários
x-displayName: Usuários
- name: 'Vistorias › Contestações'
x-displayName: Contestações
- name: 'Vistorias › Ambientes'
x-displayName: Ambientes
- name: 'Vistorias › Itens'
x-displayName: Itens
- name: Vistorias
x-displayName: Vistorias
- name: '[Imóveis] Imóveis'
x-displayName: '[Imóveis] Imóveis'
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'Para gerar seu Token de API entre em contato com o suporte da Apresenta.me '
security:
-
default: []
x-tagGroups:
-
name: 'Classificação dos Imóveis'
tags:
- 'Classificação dos Imóveis › Tipos de Imóveis'
- 'Classificação dos Imóveis › Categorias'
-
name: Condomínios
tags:
- Condomínios
-
name: Construtoras
tags:
- Construtoras
-
name: Endpoints
tags:
- Endpoints
-
name: 'Equipes de Usuários'
tags:
- 'Equipes de Usuários'
-
name: Eventos
tags:
- Eventos
-
name: Financeiro
tags:
- 'Financeiro › Faturas'
- 'Financeiro › Contas a Pagar e Receber'
- 'Financeiro › Repasses'
- 'Financeiro › Itens para Lançamentos'
- 'Financeiro › Contratos » Veículos'
- 'Financeiro › Contratos » Ocupantes'
- 'Financeiro › Contratos » Itens'
- 'Financeiro › Contratos'
-
name: 'Grupos de Usuários'
tags:
- 'Grupos de Usuários'
-
name: Históricos
tags:
- 'Históricos › Tipos'
- Históricos
-
name: Imóveis
tags:
- 'Imóveis › Finalidades'
- 'Imóveis › Data indisponível'
- 'Imóveis › Abas'
- 'Imóveis › Pacote de Temporadas'
- 'Imóveis › Estágios'
- 'Imóveis › Movimentação de Chaves'
- 'Imóveis › Claviculário'
- 'Imóveis › Chaves'
- 'Imóveis › Detalhes'
- 'Imóveis › Grupo de Detalhes'
- Imóveis
- 'Imóveis › Mídia'
-
name: 'Imóveis - Atualizar imóveis com IA'
tags:
- 'Imóveis - Atualizar imóveis com IA'
-
name: 'Imóveis - Quadro de Unidades'
tags:
- 'Imóveis - Quadro de Unidades'
-
name: Leads
tags:
- Leads
-
name: Localizações
tags:
- 'Localizações › Países'
- 'Localizações › Estados'
- 'Localizações › Cidades'
- 'Localizações › Bairros'
-
name: Negócio
tags:
- Negócio
-
name: Negócios
tags:
- 'Negócios › Etapas do Funil'
- 'Negócios › Funis'
- Negócios
-
name: Pessoas
tags:
- Pessoas
- 'Pessoas › Profissões'
- 'Pessoas › Contatos'
- 'Pessoas › Contas Bancárias'
-
name: Propostas
tags:
- Propostas
-
name: 'Regras para Rodízio de Leads'
tags:
- 'Regras para Rodízio de Leads'
-
name: 'Remessas de Cobrança'
tags:
- 'Remessas de Cobrança'
-
name: 'Remessas de Pagamento'
tags:
- 'Remessas de Pagamento'
-
name: Tickets
tags:
- Tickets
-
name: Usuários
tags:
- Usuários
-
name: Vistorias
tags:
- 'Vistorias › Contestações'
- 'Vistorias › Ambientes'
- 'Vistorias › Itens'
- Vistorias
-
name: '[Imóveis] Imóveis'
tags:
- '[Imóveis] Imóveis'
paths:
/buildings/types:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'filter[id]'
description: 'ID do tipo de imóvel.'
example: 123456
required: false
schema:
type: integer
description: 'ID do tipo de imóvel.'
example: 123456
-
in: query
name: 'filter[description]'
description: 'Descrição do tipo de imóvel.'
example: '%Apartamento%'
required: false
schema:
type: string
description: 'Descrição do tipo de imóvel.'
example: '%Apartamento%'
-
in: query
name: 'filter[category_id]'
description: 'ID da categoria do tipo de imóvel.'
example: 1
required: false
schema:
type: integer
description: 'ID da categoria do tipo de imóvel.'
example: 1
-
in: query
name: 'include[category]'
description: 'Retorna os dados da categoria do tipo de imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados da categoria do tipo de imóvel.'
example: 'id,description'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos imóveis relacionados ao tipo de imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos imóveis relacionados ao tipo de imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Tipos de Imóveis '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Tipos de Imóveis'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: required
description: 'string Descrição do tipo de imóvel.'
example: fazenda
category_id:
type: integer
description: 'ID da Categoria.'
example: 1
required:
- category_id
'/buildings/types/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'include[category]'
description: 'Retorna os dados da categoria do tipo de imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados da categoria do tipo de imóvel.'
example: 'id,description'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos imóveis relacionados ao tipo de imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos imóveis relacionados ao tipo de imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Tipos de Imóveis '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Tipos de Imóveis'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição do Tipo de Imóvel.'
example: Apartamento
category_id:
type: integer
description: 'ID da Categoria.'
example: 1
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Tipos de Imóveis '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Tipos de Imóveis'
parameters:
-
in: path
name: id
description: 'ID do Tipo de Imóvel.'
example: 11
required: true
schema:
type: integer
/buildings/categories:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóvel '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'filter[id]'
description: 'ID da categoria.'
example: 1
required: false
schema:
type: integer
description: 'ID da categoria.'
example: 1
-
in: query
name: 'filter[description]'
description: 'Descrição da categoria.'
example: Rural
required: false
schema:
type: string
description: 'Descrição da categoria.'
example: Rural
-
in: query
name: 'filter[color]'
description: 'Cor da categoria.'
example: 0000FF
required: false
schema:
type: string
description: 'Cor da categoria.'
example: 0000FF
-
in: query
name: 'include[types]'
description: 'Retorna todos os tipos de imóveis relacionados à categoria.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna todos os tipos de imóveis relacionados à categoria.'
example: 'id,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Categoria de imóvel '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Categorias'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição da categoria.'
example: Rural
color:
type: string
description: 'Cor da categoria.'
example: 0000FF
required:
- description
- color
'/buildings/categories/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóvel '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'include[types]'
description: 'Retorna todos os tipos de imóveis relacionados à categoria.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna todos os tipos de imóveis relacionados à categoria.'
example: 'id,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Categoria de imóvel '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Categorias'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição da categoria.'
example: Rural
color:
type: string
description: 'Cor da categoria.'
example: 0000FF
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Categoria de imóvel '
parameters: []
responses: {}
tags:
- 'Classificação dos Imóveis › Categorias'
parameters:
-
in: path
name: id
description: 'ID da categoria.'
example: 4
required: true
schema:
type: integer
'/condominiums/groups/{id}':
delete:
summary: 'Excluir tipo de unidade do empreendimento'
operationId: excluirTipoDeUnidadeDoEmpreendimento
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Imóveis '
parameters: []
responses: {}
tags:
- Condomínios
parameters:
-
in: path
name: id
description: 'ID do Tipo de Unidade'
example: 20
required: true
schema:
type: integer
/condominiums:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Condomínio '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,id2,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,id2,title'
-
in: query
name: 'filter[id]'
description: 'ID do condomínio.'
example: 14
required: false
schema:
type: integer
description: 'ID do condomínio.'
example: 14
-
in: query
name: 'filter[id2]'
description: 'ID visível do condomínio.'
example: 7
required: false
schema:
type: integer
description: 'ID visível do condomínio.'
example: 7
-
in: query
name: 'filter[mode]'
description: 'Modo (condomínio ou lançamento).'
example: release
required: false
schema:
type: string
description: 'Modo (condomínio ou lançamento).'
example: release
-
in: query
name: 'filter[status]'
description: Status.
example: active
required: false
schema:
type: string
description: Status.
example: active
-
in: query
name: 'filter[lock]'
description: Status.
example: active
required: false
schema:
type: string
description: Status.
example: active
-
in: query
name: 'filter[type_id]'
description: 'ID da Subcategoria/Tipo do condomínio.'
example: 18
required: false
schema:
type: integer
description: 'ID da Subcategoria/Tipo do condomínio.'
example: 18
-
in: query
name: 'filter[stage_id]'
description: 'ID do estágio.'
example: 9
required: false
schema:
type: integer
description: 'ID do estágio.'
example: 9
-
in: query
name: 'filter[country_id]'
description: 'ID do País.'
example: 10
required: false
schema:
type: integer
description: 'ID do País.'
example: 10
-
in: query
name: 'filter[state_id]'
description: 'ID do estado.'
example: 4
required: false
schema:
type: integer
description: 'ID do estado.'
example: 4
-
in: query
name: 'filter[city_id]'
description: 'ID da cidade.'
example: 13
required: false
schema:
type: integer
description: 'ID da cidade.'
example: 13
-
in: query
name: 'filter[district_id]'
description: 'ID do bairro'
example: 19
required: false
schema:
type: integer
description: 'ID do bairro'
example: 19
-
in: query
name: 'filter[tag]'
description: Tags.
example:
- 13
- 11
- 12
required: false
schema:
type: array
description: Tags.
example:
- 13
- 11
- 12
items:
type: integer
-
in: query
name: 'filter[responsible]'
description: 'Corretores responsáveis.'
example:
- 123
- 132
required: false
schema:
type: array
description: 'Corretores responsáveis.'
example:
- 123
- 132
items:
type: integer
-
in: query
name: 'filter[constructor_id]'
description: 'ID da construtora.'
example: 14
required: false
schema:
type: integer
description: 'ID da construtora.'
example: 14
-
in: query
name: 'filter[access]'
description: 'Tipo de Acesso.'
example: all
required: false
schema:
type: string
description: 'Tipo de Acesso.'
example: all
-
in: query
name: 'filter[pickup]'
description: 'Corretores captadores.'
example:
- 1123
- 1322
required: false
schema:
type: array
description: 'Corretores captadores.'
example:
- 1123
- 1322
items:
type: integer
-
in: query
name: 'filter[slug]'
description: 'Link permanente para site.'
example: exemplo-perma-link
required: false
schema:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
-
in: query
name: 'filter[updated_by]'
description: 'ID do usuário que atualizou.'
example: 9
required: false
schema:
type: integer
description: 'ID do usuário que atualizou.'
example: 9
-
in: query
name: 'filter[created_by]'
description: 'ID do usuário que cadastrou.'
example: 3
required: false
schema:
type: integer
description: 'ID do usuário que cadastrou.'
example: 3
-
in: query
name: 'filter[principal_media]'
description: 'Mídia principal.'
example: laborum
required: false
schema:
type: string
description: 'Mídia principal.'
example: laborum
-
in: query
name: 'filter[built_year]'
description: 'Ano de construção.'
example: 5
required: false
schema:
type: integer
description: 'Ano de construção.'
example: 5
-
in: query
name: 'filter[total_floors]'
description: 'Quantidade de andares.'
example: 9
required: false
schema:
type: integer
description: 'Quantidade de andares.'
example: 9
-
in: query
name: 'filter[total_by_floor]'
description: 'Quantidade de unidades por andar.'
example: 17
required: false
schema:
type: integer
description: 'Quantidade de unidades por andar.'
example: 17
-
in: query
name: 'filter[blocks]'
description: 'Quantidade de Blocos do condomínio.'
example: 13
required: false
schema:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 13
-
in: query
name: 'filter[title]'
description: 'Titulo do condomínio.'
example: 'Título Exemplar'
required: false
schema:
type: string
description: 'Titulo do condomínio.'
example: 'Título Exemplar'
-
in: query
name: 'filter[content]'
description: 'HTML do conteúdo da descrição.'
example: 'Condomínio de frente para o mar...
'
required: false
schema:
type: string
description: 'HTML do conteúdo da descrição.'
example: 'Condomínio de frente para o mar...
'
-
in: query
name: 'filter[lock_description]'
description: 'Motivo do bloqueio.'
example: 'Bloqueado para atualização'
required: false
schema:
type: string
description: 'Motivo do bloqueio.'
example: 'Bloqueado para atualização'
-
in: query
name: 'filter[street]'
description: 'Rua do condomínio.'
example: 'Rua Guanabara'
required: false
schema:
type: string
description: 'Rua do condomínio.'
example: 'Rua Guanabara'
-
in: query
name: 'filter[number]'
description: 'número do condomínio'
example: 12
required: false
schema:
type: integer
description: 'número do condomínio'
example: 12
-
in: query
name: 'filter[complement]'
description: 'Complemento do condomínio.'
example: Apartamento
required: false
schema:
type: string
description: 'Complemento do condomínio.'
example: Apartamento
-
in: query
name: 'filter[zip_code]'
description: 'CEP do condomínio.'
example: 3
required: false
schema:
type: integer
description: 'CEP do condomínio.'
example: 3
-
in: query
name: 'filter[notes]'
description: Observações.
example: non
required: false
schema:
type: string
description: Observações.
example: non
-
in: query
name: 'filter[html_title]'
description: 'Título da página (HTML title).'
example: 'SEO Título'
required: false
schema:
type: string
description: 'Título da página (HTML title).'
example: 'SEO Título'
-
in: query
name: 'filter[html_keyword]'
description: 'Palavras Chave (HTML Keyword).'
example: 'condomínio,grupo,venda'
required: false
schema:
type: string
description: 'Palavras Chave (HTML Keyword).'
example: 'condomínio,grupo,venda'
-
in: query
name: 'filter[html_description]'
description: 'descrição SEO.'
example: SEO
required: false
schema:
type: string
description: 'descrição SEO.'
example: SEO
-
in: query
name: 'include[buildings]'
description: 'Imóveis do condomínio.'
example: 'id,title,slug'
required: false
schema:
type: string
description: 'Imóveis do condomínio.'
example: 'id,title,slug'
-
in: query
name: 'include[purposes]'
description: 'Finalidades do condomínio.'
example: 'type,amount'
required: false
schema:
type: string
description: 'Finalidades do condomínio.'
example: 'type,amount'
-
in: query
name: 'include[groups]'
description: 'Grupos do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Grupos do condomínio.'
example: 'id,title'
-
in: query
name: 'include[units]'
description: 'Unidades do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Unidades do condomínio.'
example: 'id,title'
-
in: query
name: 'include[related]'
description: 'Pessoas relacionadas ao condomínio.'
example: 'id,title,slug'
required: false
schema:
type: string
description: 'Pessoas relacionadas ao condomínio.'
example: 'id,title,slug'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Condomínios '
parameters: []
responses: {}
tags:
- Condomínios
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: 'ID do condomínio.'
example: 4
id2:
type: integer
description: 'ID visível do condomínio.'
example: 16
mode:
type: string
description: 'Modo (condomínio ou lançamento).'
example: release
status:
type: string
description: Status.
example: active
lock:
type: string
description: Status.
example: active
type_id:
type: integer
description: 'ID da Subcategoria/Tipo do condomínio.'
example: 1
stage_id:
type: integer
description: 'ID do estágio.'
example: 6
country_id:
type: integer
description: 'ID do País.'
example: 9
state_id:
type: integer
description: 'ID do estado.'
example: 8
city_id:
type: integer
description: 'ID da cidade.'
example: 6
district_id:
type: integer
description: 'ID do bairro'
example: 4
tag:
type: array
description: Tags.
example:
- 10
items:
type: integer
responsible:
type: array
description: 'Corretores responsáveis.'
example:
- 14
items:
type: integer
constructor_id:
type: integer
description: 'ID da construtora.'
example: 18
access:
type: string
description: 'Tipo de Acesso.'
example: all
pickup:
type: array
description: 'Corretores captadores.'
example:
- 18
items:
type: integer
slug:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
updated_by:
type: integer
description: 'ID do usuário que atualizou.'
example: 5
created_by:
type: integer
description: 'ID do usuário que cadastrou.'
example: 11
principal_media:
type: string
description: 'Mídia principal.'
example: voluptas
built_year:
type: integer
description: 'Ano de construção.'
example: 3
total_floors:
type: integer
description: 'Quantidade de andares.'
example: 19
total_by_floor:
type: integer
description: 'Quantidade de unidades por andar.'
example: 7
blocks:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 14
title:
type: string
description: 'Titulo do condomínio.'
example: 'Título Exemplar'
content:
type: string
description: 'HTML do conteúdo da descrição.'
example: 'Condomínio de frente para o mar...
'
lock_description:
type: string
description: 'Motivo do bloqueio.'
example: 'Bloqueado para atualização'
street:
type: string
description: 'Rua do condomínio.'
example: 'Rua Guanabara'
number:
type: integer
description: 'número do condomínio'
example: 7
complement:
type: string
description: 'Complemento do condomínio.'
example: Apartamento
zip_code:
type: integer
description: 'CEP do condomínio.'
example: 11
notes:
type: string
description: Observações.
example: sint
html_title:
type: string
description: 'Título da página (HTML title).'
example: 'SEO Título'
html_keyword:
type: string
description: 'Palavras Chave (HTML Keyword). Example:'
example: voluptatibus
html_description:
type: string
description: 'descrição SEO.'
example: 'SEO,chave'
groups:
type: json
description: 'Grupos do condomínio.'
example: '[{"title": "Grupo A", "status": "active", "area_total": "150,00", "bathroom": "1", "bedroom": "2", "room": "1", "suite": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]'
required:
- mode
- status
- type_id
- title
'/condominiums/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Condomínio '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,id2,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,id2,title'
-
in: query
name: 'include[buildings]'
description: 'Imóveis do condomínio.'
example: 'id,title,slug'
required: false
schema:
type: string
description: 'Imóveis do condomínio.'
example: 'id,title,slug'
-
in: query
name: 'include[purposes]'
description: 'Finalidades do condomínio.'
example: 'type,amount'
required: false
schema:
type: string
description: 'Finalidades do condomínio.'
example: 'type,amount'
-
in: query
name: 'include[groups]'
description: 'Grupos do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Grupos do condomínio.'
example: 'id,title'
-
in: query
name: 'include[units]'
description: 'Unidades do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Unidades do condomínio.'
example: 'id,title'
-
in: query
name: 'include[related]'
description: 'Pessoas relacionadas ao condomínio.'
example: 'id,title,slug'
required: false
schema:
type: string
description: 'Pessoas relacionadas ao condomínio.'
example: 'id,title,slug'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Condomínios '
parameters: []
responses: {}
tags:
- Condomínios
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mode:
type: string
description: 'Tipo do Empreendimento.'
example: condominium
status:
type: string
description: Status.
example: active
type_id:
type: integer
description: 'ID da Subcategoria/Tipo do condomínio.'
example: 9
stage_id:
type: integer
description: 'ID do estágio.'
example: 15
country_id:
type: integer
description: 'ID do País.'
example: 11
state_id:
type: integer
description: 'ID do estado.'
example: 5
city_id:
type: integer
description: 'ID da cidade.'
example: 13
district_id:
type: integer
description: 'ID do bairro'
example: 2
responsible:
type: array
description: 'IDs dos responsáveis'
example:
- 4
items:
type: integer
constructor_id:
type: integer
description: 'ID da construtora.'
example: 6
access:
type: string
description: 'Tipo de Acesso.'
example: all
pickup:
type: array
description: 'IDs dos captadores do condomínio.'
example:
- 7
items:
type: integer
slug:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
updated_by:
type: integer
description: 'ID do usuário que atualizou.'
example: 10
created_by:
type: integer
description: 'ID do usuário que cadastrou.'
example: 4
principal_media:
type: string
description: 'Mídia principal.'
example: recusandae
built_year:
type: integer
description: 'Ano de construção.'
example: 2021
blocks:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 4
title:
type: string
description: 'Titulo do condomínio.'
example: 'Título Exemplar'
street:
type: string
description: 'Rua do condomínio.'
example: 'Rua Guanabara'
number:
type: integer
description: 'número do condomínio'
example: 14
complement:
type: string
description: 'Complemento do condomínio.'
example: Apartamento
zip_code:
type: integer
description: 'CEP do condomínio.'
example: 9
notes:
type: string
description: Observações.
example: eum
details:
type: array
description: 'Detalhes do condomínio.'
example:
- 1083
- 1093
items:
type: integer
groups:
type: json
description: 'Grupos do condomínio.'
example: '[{"title": "Grupo A", "status": "active", "area_total": "150,00", "bathroom": "1", "bedroom": "2", "room": "1", "suite": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]'
required:
- title
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Condomínios '
parameters: []
responses: {}
tags:
- Condomínios
parameters:
-
in: path
name: id
description: 'ID do condomínio'
example: 18
required: true
schema:
type: integer
/buildings/constructors:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Construtoras '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'filter[id]'
description: 'ID da construtora.'
example: 123456
required: false
schema:
type: integer
description: 'ID da construtora.'
example: 123456
-
in: query
name: 'filter[name]'
description: 'Nome da construtora.'
example: 'Construtora Teste'
required: false
schema:
type: string
description: 'Nome da construtora.'
example: 'Construtora Teste'
-
in: query
name: 'filter[state_id]'
description: 'Estado de atuação.'
example: 24
required: false
schema:
type: integer
description: 'Estado de atuação.'
example: 24
-
in: query
name: 'filter[notes]'
description: Observações.
example: Observação
required: false
schema:
type: string
description: Observações.
example: Observação
-
in: query
name: 'include[state]'
description: 'Retorna os dados do Estado da construtora.'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do Estado da construtora.'
example: 'id,name,abbreviation'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos imóveis da construtora.'
example: 'id,reference,title'
required: false
schema:
type: string
description: 'Retorna os dados dos imóveis da construtora.'
example: 'id,reference,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Construtora '
parameters: []
responses: {}
tags:
- Construtoras
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da construtora.'
example: 'Construtora Exemplo'
state_id:
type: integer
description: 'estado de atuação.'
example: 24
notes:
type: string
description: Observações.
example: Observação
required:
- name
'/buildings/constructors/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Construtora '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna os dados do Estado da construtora.'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do Estado da construtora.'
example: 'id,name,abbreviation'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos imóveis da construtora.'
example: 'id,reference,title'
required: false
schema:
type: string
description: 'Retorna os dados dos imóveis da construtora.'
example: 'id,reference,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Construtora '
parameters: []
responses: {}
tags:
- Construtoras
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da construtora.'
example: 'Construtora Exemplo 2'
state_id:
type: integer
description: 'estado de atuação.'
example: 24
notes:
type: string
description: Observações.
example: Observação
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Construtora '
parameters: []
responses: {}
tags:
- Construtoras
parameters:
-
in: path
name: id
description: 'ID da construtora.'
example: 20
required: true
schema:
type: integer
/deals/conversion/funnel:
get:
summary: ''
operationId: getDealsConversionFunnel
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de criação de Equipe de Usuários '
parameters: []
responses: {}
tags:
- 'Equipes de Usuários'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da equipe.'
example: Vendas
manager_id:
type: integer
description: 'ID do gerente da equipe, deve ser um ID de um usuário.'
example: 1010
business_id:
type: integer
description: 'ID da empresa financeira que o grupo pertence.'
example: 1058
notes:
type: string
description: 'Observação para a equipe.'
example: nemo
required:
- name
- manager_id
- business_id
'/users/teams/{id}':
get:
summary: Obter
operationId: obter
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'include[manager]'
description: 'Retorna os dados do gerente da equipe.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do gerente da equipe.'
example: 'id,name'
-
in: query
name: 'include[users]'
description: 'Retorna os usuários integrantes da equipe.'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Retorna os usuários integrantes da equipe.'
example: 'id,name,email'
-
in: query
name: 'include[business]'
description: 'Retorna os dados da empresa relacionada à equipe.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da empresa relacionada à equipe.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de alteração de Equipe de Usuários '
parameters: []
responses: {}
tags:
- 'Equipes de Usuários'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da equipe.'
example: Vendas
manager_id:
type: integer
description: 'ID do gerente da equipe, deve ser um ID de um usuário.'
example: 1010
business_id:
type: integer
description: 'ID da empresa financeira que o grupo pertence.'
example: 1058
notes:
type: string
description: 'Observação para a equipe.'
example: voluptatum
delete:
summary: Excluir
operationId: excluir
description: ''
parameters: []
responses: {}
tags:
- 'Equipes de Usuários'
parameters:
-
in: path
name: id
description: 'ID da equipe'
example: 1096
required: true
schema:
type: integer
/events:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
-
in: query
name: 'filter[id]'
description: 'ID do Evento'
example: 2
required: false
schema:
type: integer
description: 'ID do Evento'
example: 2
-
in: query
name: 'filter[father_id]'
description: 'ID do Evento Pai'
example: 10
required: false
schema:
type: integer
description: 'ID do Evento Pai'
example: 10
-
in: query
name: 'filter[recurrence_id]'
description: 'ID da Recorrência'
example: 5
required: false
schema:
type: integer
description: 'ID da Recorrência'
example: 5
-
in: query
name: 'filter[calendar_id]'
description: 'ID do Calendário'
example: 3
required: false
schema:
type: integer
description: 'ID do Calendário'
example: 3
-
in: query
name: 'filter[title]'
description: 'Título do Evento'
example: 'Reunião mensal'
required: false
schema:
type: string
description: 'Título do Evento'
example: 'Reunião mensal'
-
in: query
name: 'filter[type]'
description: "Tipo do Evento.\nValores permitidos:\n- `task`: Tarefa\n- `reminder`: Lembrete\n- `meet`: Reunião\n- `visit`: Visita\n- `whatsapp`: WhatsApp\n- `email`: E-mail\n- `call`: Ligação\n- `inspect`: Vistoria\n- `maintenance`: Manutenção\n- `billing`: Cobrança"
example: task
required: false
schema:
type: string
description: "Tipo do Evento.\nValores permitidos:\n- `task`: Tarefa\n- `reminder`: Lembrete\n- `meet`: Reunião\n- `visit`: Visita\n- `whatsapp`: WhatsApp\n- `email`: E-mail\n- `call`: Ligação\n- `inspect`: Vistoria\n- `maintenance`: Manutenção\n- `billing`: Cobrança"
example: task
-
in: query
name: 'filter[status]'
description: "Status do Evento\nValores permitidos:\n- `cancelled`: Cancelado\n- `concluded`: Concluído\n- `scheduled`: Agendado\n- `recurrent`: Recorrente\n- `late`: Atrasado\n- `five_days_late`: +5 dias de atraso\n- `thirty_days_late`: +1 mês atrasado"
example: scheduled
required: false
schema:
type: string
description: "Status do Evento\nValores permitidos:\n- `cancelled`: Cancelado\n- `concluded`: Concluído\n- `scheduled`: Agendado\n- `recurrent`: Recorrente\n- `late`: Atrasado\n- `five_days_late`: +5 dias de atraso\n- `thirty_days_late`: +1 mês atrasado"
example: scheduled
-
in: query
name: 'filter[guest][]'
description: 'IDs dos Convidados'
example: 1
required: false
schema:
type: array
description: 'IDs dos Convidados'
example: 1
items:
type: integer
-
in: query
name: 'filter[guest_group][]'
description: 'IDs dos Grupos de Convidados'
example: 2
required: false
schema:
type: array
description: 'IDs dos Grupos de Convidados'
example: 2
items:
type: integer
-
in: query
name: 'filter[guest_access]'
description: "Tipo de acesso dos convidados\nValores permitidos:\n- `full`: Acesso total\n- `invite`: Editar convidados\n- `view`: Visualizar"
example: full
required: false
schema:
type: string
description: "Tipo de acesso dos convidados\nValores permitidos:\n- `full`: Acesso total\n- `invite`: Editar convidados\n- `view`: Visualizar"
example: full
-
in: query
name: 'filter[tag][]'
description: 'IDs das Tags'
example: 1
required: false
schema:
type: array
description: 'IDs das Tags'
example: 1
items:
type: integer
-
in: query
name: 'filter[initial_date]'
description: 'date Data inicial do Evento'
example: '2025-06-10'
required: false
schema:
type: string
description: 'date Data inicial do Evento'
example: '2025-06-10'
-
in: query
name: 'filter[final_date]'
description: 'date Data final do Evento'
example: '2025-06-11'
required: false
schema:
type: string
description: 'date Data final do Evento'
example: '2025-06-11'
-
in: query
name: 'filter[time_zone]'
description: "Fuso horário\nValores permitidos:\n- `America/Sao_Paulo`: Horário de Brasília -3:00\n- `America/Noronha`: Noronha -2:00\n- `America/Manaus`: Manaus -4:00\n- `America/Rio_Branco`: Rio Branco -5:00\n- `Atlantic/Azores`: Açores -1:00\n- `America/Costa_Rica`: Costa Rica -6:00\n- `America/Tijuana`: Tijuana -7:00\n- `America/Sitka`: Sitka -8:00\n- `Pacific/Gambier`: Gambier -9:00\n- `Pacific/Honolulu`: Honolulu -10:00\n- `Pacific/Midway`: Midway -11:00"
example: America/Sao_Paulo
required: false
schema:
type: string
description: "Fuso horário\nValores permitidos:\n- `America/Sao_Paulo`: Horário de Brasília -3:00\n- `America/Noronha`: Noronha -2:00\n- `America/Manaus`: Manaus -4:00\n- `America/Rio_Branco`: Rio Branco -5:00\n- `Atlantic/Azores`: Açores -1:00\n- `America/Costa_Rica`: Costa Rica -6:00\n- `America/Tijuana`: Tijuana -7:00\n- `America/Sitka`: Sitka -8:00\n- `Pacific/Gambier`: Gambier -9:00\n- `Pacific/Honolulu`: Honolulu -10:00\n- `Pacific/Midway`: Midway -11:00"
example: America/Sao_Paulo
-
in: query
name: 'filter[created_by]'
description: 'ID do Criador'
example: 7
required: false
schema:
type: integer
description: 'ID do Criador'
example: 7
-
in: query
name: 'filter[building_id]'
description: 'ID do Imóvel'
example: 12
required: false
schema:
type: integer
description: 'ID do Imóvel'
example: 12
-
in: query
name: 'filter[deal_id]'
description: 'ID do Negócio'
example: 8
required: false
schema:
type: integer
description: 'ID do Negócio'
example: 8
-
in: query
name: 'filter[contract_id]'
description: 'ID do contrato'
example: 123456
required: false
schema:
type: integer
description: 'ID do contrato'
example: 123456
-
in: query
name: 'filter[person_id]'
description: 'ID da Pessoa'
example: 5
required: false
schema:
type: integer
description: 'ID da Pessoa'
example: 5
-
in: query
name: 'filter[invite_person]'
description: 'Se convidou pessoa'
example: true
required: false
schema:
type: boolean
description: 'Se convidou pessoa'
example: true
-
in: query
name: 'filter[endless]'
description: 'Evento sem fim'
example: true
required: false
schema:
type: boolean
description: 'Evento sem fim'
example: true
-
in: query
name: 'filter[all_day]'
description: 'Evento o dia todo'
example: true
required: false
schema:
type: boolean
description: 'Evento o dia todo'
example: true
-
in: query
name: 'filter[description]'
description: 'Descrição do Evento'
example: 'Discussão de metas'
required: false
schema:
type: string
description: 'Descrição do Evento'
example: 'Discussão de metas'
-
in: query
name: 'filter[address]'
description: 'Endereço do Evento'
example: 'Av. Paulista, 1000'
required: false
schema:
type: string
description: 'Endereço do Evento'
example: 'Av. Paulista, 1000'
-
in: query
name: 'filter[reminder][]'
description: "Lembretes do Evento\nValores permitidos:\n- `START`: Ao Iniciar ao Evento\n- `5_MIN`: 5 minutos antes de começar\n- `15_MIN`: 5 minutos antes de começar\n- `30_MIN`: 0 minutos antes de começar\n- `1_HOUR`: 1 hora antes de começar\n- `2_HOUR`: 2 horas antes de começar\n- `6_HOUR`: 6 horas antes de começar\n- `1_DAY`: 1 dia antes de começar\n- `2_DAY`: 2 dias antes de começar\n- `5_DAY`: 5 dias antes de começar\n- `1_WEEK`: 1 semana antes de começar\n- `2_WEEK`: 2 semanas antes de começar\n- `1_MONTH`: 1 mês antes de começar"
example: START
required: false
schema:
type: array
description: "Lembretes do Evento\nValores permitidos:\n- `START`: Ao Iniciar ao Evento\n- `5_MIN`: 5 minutos antes de começar\n- `15_MIN`: 5 minutos antes de começar\n- `30_MIN`: 0 minutos antes de começar\n- `1_HOUR`: 1 hora antes de começar\n- `2_HOUR`: 2 horas antes de começar\n- `6_HOUR`: 6 horas antes de começar\n- `1_DAY`: 1 dia antes de começar\n- `2_DAY`: 2 dias antes de começar\n- `5_DAY`: 5 dias antes de começar\n- `1_WEEK`: 1 semana antes de começar\n- `2_WEEK`: 2 semanas antes de começar\n- `1_MONTH`: 1 mês antes de começar"
example: START
items:
type: string
-
in: query
name: 'filter[private]'
description: 'Evento privado'
example: true
required: false
schema:
type: boolean
description: 'Evento privado'
example: true
-
in: query
name: 'filter[recurrency]'
description: "Recorrência do Evento\nValores permitidos:\n- `daily`: Diária\n- `weekly`: Semanal\n- `monthly`: Mensal\n- `yearly`: Anual"
example: weekly
required: false
schema:
type: string
description: "Recorrência do Evento\nValores permitidos:\n- `daily`: Diária\n- `weekly`: Semanal\n- `monthly`: Mensal\n- `yearly`: Anual"
example: weekly
-
in: query
name: 'filter[accessible]'
description: 'Filtra eventos acessíveis pelo usuário informado'
example: 7
required: false
schema:
type: integer
description: 'Filtra eventos acessíveis pelo usuário informado'
example: 7
-
in: query
name: 'filter[descendant][]'
description: 'Filtra eventos descendentes do ID informado'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos descendentes do ID informado'
example: 1
items:
type: integer
-
in: query
name: 'filter[guestsIn][]'
description: 'Filtra eventos onde o usuário é convidado'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos onde o usuário é convidado'
example: 1
items:
type: integer
-
in: query
name: 'filter[responsibleIn][]'
description: 'Filtra eventos onde o usuário é responsável'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos onde o usuário é responsável'
example: 1
items:
type: integer
-
in: query
name: 'filter[userIn][]'
description: 'Filtra eventos pelo(s) usuário(s) convidado(s)'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) usuário(s) convidado(s)'
example: 1
items:
type: integer
-
in: query
name: 'filter[responsibleGroupIn][]'
description: 'Filtra eventos pelo(s) grupo(s) responsável(is)'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) grupo(s) responsável(is)'
example: 1
items:
type: integer
-
in: query
name: 'filter[creatorIn][]'
description: 'Filtra eventos pelo(s) criador(es)'
example: 7
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) criador(es)'
example: 7
items:
type: integer
-
in: query
name: 'filter[calendarIn][]'
description: 'Filtra eventos pelo(s) calendário(s)'
example: 3
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) calendário(s)'
example: 3
items:
type: integer
-
in: query
name: 'filter[calendarOrInvitedIn][]'
description: 'Filtra pelo(s) calendário(s) e inclui os eventos em que o usuário é convidado em agenda sem acesso'
example: 3
required: false
schema:
type: array
description: 'Filtra pelo(s) calendário(s) e inclui os eventos em que o usuário é convidado em agenda sem acesso'
example: 3
items:
type: integer
-
in: query
name: 'filter[createdBetween][]'
description: 'Filtra eventos pela data de criação (intervalo)'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos pela data de criação (intervalo)'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[typeIn][]'
description: 'Filtra eventos pelos tipos'
example: null
required: false
schema:
type: array
description: 'Filtra eventos pelos tipos'
example: null
items:
type: string
-
in: query
name: 'filter[dateMinMax][]'
description: 'Filtra eventos pela data inicial (intervalo)'
example: '2024-01-01'
required: false
schema:
type: array
description: 'Filtra eventos pela data inicial (intervalo)'
example: '2024-01-01'
items:
type: string
-
in: query
name: 'filter[isLate]'
description: 'Filtra eventos atrasados'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos atrasados'
example: true
-
in: query
name: 'filter[isNotRecurrence]'
description: 'Filtra eventos que não são recorrências'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos que não são recorrências'
example: true
-
in: query
name: 'filter[isCancelled]'
description: 'Filtra eventos cancelados'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos cancelados'
example: true
-
in: query
name: 'filter[notCancelled]'
description: 'Filtra eventos não cancelados'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos não cancelados'
example: true
-
in: query
name: 'filter[scheduledBetween][]'
description: 'Filtra eventos agendados entre datas'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos agendados entre datas'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[active]'
description: 'Filtra eventos ativos'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos ativos'
example: true
-
in: query
name: 'filter[statusIn][]'
description: 'Filtra eventos pelos status'
example: scheduled
required: false
schema:
type: array
description: 'Filtra eventos pelos status'
example: scheduled
items:
type: string
-
in: query
name: 'filter[statusNotIn][]'
description: 'Filtra eventos excluindo status'
example: cancelled
required: false
schema:
type: array
description: 'Filtra eventos excluindo status'
example: cancelled
items:
type: string
-
in: query
name: 'filter[recurrencyIn][]'
description: 'Filtra eventos pela recorrência'
example: weekly
required: false
schema:
type: array
description: 'Filtra eventos pela recorrência'
example: weekly
items:
type: string
-
in: query
name: 'filter[hasReminder]'
description: 'Filtra eventos com lembrete'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos com lembrete'
example: true
-
in: query
name: 'filter[hasAnyReminder]'
description: 'Filtra eventos com qualquer lembrete'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos com qualquer lembrete'
example: true
-
in: query
name: 'filter[buildingIn][]'
description: 'Filtra eventos pelo(s) imóvel(is)'
example: 1
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) imóvel(is)'
example: 1
items:
type: integer
-
in: query
name: 'filter[dealIn][]'
description: 'Filtra eventos pelo(s) negócio(s)'
example: 8
required: false
schema:
type: array
description: 'Filtra eventos pelo(s) negócio(s)'
example: 8
items:
type: integer
-
in: query
name: 'filter[personIn][]'
description: 'Filtra eventos pela(s) pessoa(s)'
example: 5
required: false
schema:
type: array
description: 'Filtra eventos pela(s) pessoa(s)'
example: 5
items:
type: integer
-
in: query
name: 'filter[googleId]'
description: 'Filtra eventos pelo Google ID'
example: abc123
required: false
schema:
type: string
description: 'Filtra eventos pelo Google ID'
example: abc123
-
in: query
name: 'filter[occurrenceBetween][]'
description: 'Filtra eventos por ocorrência entre datas'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos por ocorrência entre datas'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[yearBetween][]'
description: 'Filtra eventos recorrentes anuais entre datas'
example: '2025-01-01'
required: false
schema:
type: array
description: 'Filtra eventos recorrentes anuais entre datas'
example: '2025-01-01'
items:
type: string
-
in: query
name: 'filter[monthBetween][]'
description: 'Filtra eventos recorrentes mensais entre datas'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos recorrentes mensais entre datas'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[weekBetween][]'
description: 'Filtra eventos recorrentes semanais entre datas'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos recorrentes semanais entre datas'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[dayBetween][]'
description: 'Filtra eventos recorrentes diários entre datas'
example: '2025-06-01'
required: false
schema:
type: array
description: 'Filtra eventos recorrentes diários entre datas'
example: '2025-06-01'
items:
type: string
-
in: query
name: 'filter[nonRecurring]'
description: 'Filtra eventos não recorrentes'
example: true
required: false
schema:
type: boolean
description: 'Filtra eventos não recorrentes'
example: true
-
in: query
name: 'include[guests]'
description: 'Incluir dados dos Convidados'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Incluir dados dos Convidados'
example: 'id,name,email'
-
in: query
name: 'include[guestGroups]'
description: 'Incluir dados dos Grupos de Convidados'
example: 'id,name,users'
required: false
schema:
type: string
description: 'Incluir dados dos Grupos de Convidados'
example: 'id,name,users'
-
in: query
name: 'include[tags]'
description: 'Incluir dados das Tags'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados das Tags'
example: 'id,name'
-
in: query
name: 'include[creator]'
description: 'Incluir dados do Criador'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Incluir dados do Criador'
example: 'id,name,email'
-
in: query
name: 'include[calendar]'
description: 'Incluir dados do Calendário'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Calendário'
example: 'id,title'
-
in: query
name: 'include[person]'
description: 'Incluir dados da Pessoa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Pessoa'
example: 'id,name'
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel'
example: 'id,title'
-
in: query
name: 'include[deal]'
description: 'Incluir dados do Negócio'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Negócio'
example: 'id,title'
-
in: query
name: 'include[parent]'
description: 'Incluir dados do Evento Pai'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Evento Pai'
example: 'id,title'
-
in: query
name: 'include[childs]'
description: 'Incluir dados dos Eventos Filhos'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados dos Eventos Filhos'
example: 'id,title'
-
in: query
name: 'include[arisingFrom]'
description: 'Incluir dados do Evento de Origem'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Evento de Origem'
example: 'id,title'
-
in: query
name: 'include[recurrences]'
description: 'Incluir dados das Recorrências'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados das Recorrências'
example: 'id,title'
-
in: query
name: 'include[cancelled]'
description: 'Incluir dados das Recorrências Canceladas'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados das Recorrências Canceladas'
example: 'id,title'
-
in: query
name: 'include[files]'
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
required: false
schema:
type: string
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
-
in: query
name: 'include[lastFeedback]'
description: 'Incluir último feedback'
example: 'id,date,history_type_id'
required: false
schema:
type: string
description: 'Incluir último feedback'
example: 'id,date,history_type_id'
-
in: query
name: 'include[contract]'
description: 'Incluir dados do Contrato'
example: 'id,type'
required: false
schema:
type: string
description: 'Incluir dados do Contrato'
example: 'id,type'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento '
parameters: []
responses: {}
tags:
- Eventos
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
'filter[calendar_id]':
type: integer
description: 'ID do Calendário'
example: 3
'filter[title]':
type: string
description: 'Título do Evento'
example: 'Reunião mensal'
'filter[guest][]':
type: array
description: 'IDs dos Convidados'
example: 1
items:
type: integer
'filter[guest_group][]':
type: array
description: 'IDs dos Grupos de Convidados'
example: 2
items:
type: integer
'filter[guest_access]':
type: string
description: "Tipo de acesso dos convidados\nValores permitidos:\n- `full`: Acesso total\n- `invite`: Editar convidados\n- `view`: Visualizar"
example: full
'filter[type]':
type: string
description: "Tipo do Evento.\nValores permitidos:\n- `task`: Tarefa\n- `reminder`: Lembrete\n- `meet`: Reunião\n- `visit`: Visita\n- `whatsapp`: WhatsApp\n- `email`: E-mail\n- `call`: Ligação"
example: task
'filter[status]':
type: string
description: "Status do Evento\nValores permitidos:\n- `cancelled`: Cancelado\n- `concluded`: Concluído\n- `scheduled`: Agendado\n- `recurrent`: Recorrente\n- `late`: Atrasado\n- `five_days_late`: +5 dias de atraso\n- `thirty_days_late`: +1 mês atrasado"
example: scheduled
'filter[initial_date]':
type: date
description: 'Data inicial do Evento'
example: '2025-06-10'
'filter[father_id]':
type: integer
description: 'ID do Evento Pai'
example: 10
'filter[recurrence_id]':
type: integer
description: 'ID da Recorrência'
example: 5
'filter[tag][]':
type: array
description: 'IDs das Tags'
example: 1
items:
type: integer
'filter[final_date]':
type: date
description: 'Data final do Evento'
example: '2025-06-11'
'filter[time_zone]':
type: string
description: "Fuso horário\nValores permitidos:\n- `America/Sao_Paulo`: Horário de Brasília -3:00\n- `America/Noronha`: Noronha -2:00\n- `America/Manaus`: Manaus -4:00\n- `America/Rio_Branco`: Rio Branco -5:00\n- `Atlantic/Azores`: Açores -1:00\n- `America/Costa_Rica`: Costa Rica -6:00\n- `America/Tijuana`: Tijuana -7:00\n- `America/Sitka`: Sitka -8:00\n- `Pacific/Gambier`: Gambier -9:00\n- `Pacific/Honolulu`: Honolulu -10:00\n- `Pacific/Midway`: Midway -11:00"
example: America/Sao_Paulo
'filter[created_by]':
type: integer
description: 'ID do Criador'
example: 7
'filter[building_id]':
type: integer
description: 'ID do Imóvel'
example: 12
'filter[deal_id]':
type: integer
description: 'ID do Negócio'
example: 8
'filter[contract_id]':
type: integer
description: 'ID do contrato'
example: 123456
'filter[person_id]':
type: integer
description: 'ID da Pessoa'
example: 5
'filter[invite_person]':
type: boolean
description: 'Se convidou pessoa'
example: true
'filter[endless]':
type: boolean
description: 'Evento sem fim'
example: false
'filter[all_day]':
type: boolean
description: 'Evento o dia todo'
example: true
'filter[description]':
type: string
description: 'Descrição do Evento'
example: 'Discussão de metas'
'filter[address]':
type: string
description: 'Endereço do Evento'
example: 'Av. Paulista, 1000'
'filter[reminder][]':
type: array
description: "Lembretes do Evento\nValores permitidos:\n= `START`: Ao Iniciar ao Evento\n= `5_MIN`: 5 minutos antes de começar\n= `15_MIN`: 5 minutos antes de começar\n= `30_MIN`: 0 minutos antes de começar\n= `1_HOUR`: 1 hora antes de começar\n= `2_HOUR`: 2 horas antes de começar\n= `6_HOUR`: 6 horas antes de começar\n= `1_DAY`: 1 dia antes de começar\n= `2_DAY`: 2 dias antes de começar\n= `5_DAY`: 5 dias antes de começar\n= `1_WEEK`: 1 semana antes de começar\n= `2_WEEK`: 2 semanas antes de começar\n= `1_MONTH`: 1 mês antes de começar"
example: START
items:
type: string
'filter[private]':
type: boolean
description: 'Evento privado'
example: false
'filter[recurrency]':
type: string
description: "Recorrência do Evento\nValores permitidos:\n- `daily`: Diária\n- `weekly`: Semanal\n- `monthly`: Mensal\n- `yearly`: Anual"
example: weekly
required:
- 'filter[calendar_id]'
- 'filter[title]'
- 'filter[guest][]'
- 'filter[guest_group][]'
- 'filter[guest_access]'
- 'filter[type]'
- 'filter[status]'
- 'filter[initial_date]'
'/events/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento '
parameters:
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
-
in: query
name: 'include[guests]'
description: 'Incluir dados dos Convidados'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Incluir dados dos Convidados'
example: 'id,name,email'
-
in: query
name: 'include[guestGroups]'
description: 'Incluir dados dos Grupos de Convidados'
example: 'id,name,users'
required: false
schema:
type: string
description: 'Incluir dados dos Grupos de Convidados'
example: 'id,name,users'
-
in: query
name: 'include[tags]'
description: 'Incluir dados das Tags'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados das Tags'
example: 'id,name'
-
in: query
name: 'include[creator]'
description: 'Incluir dados do Criador'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Incluir dados do Criador'
example: 'id,name,email'
-
in: query
name: 'include[calendar]'
description: 'Incluir dados do Calendário'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Calendário'
example: 'id,title'
-
in: query
name: 'include[person]'
description: 'Incluir dados da Pessoa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Pessoa'
example: 'id,name'
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel'
example: 'id,title'
-
in: query
name: 'include[deal]'
description: 'Incluir dados do Negócio'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Negócio'
example: 'id,title'
-
in: query
name: 'include[parent]'
description: 'Incluir dados do Evento Pai'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Evento Pai'
example: 'id,title'
-
in: query
name: 'include[childs]'
description: 'Incluir dados dos Eventos Filhos'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados dos Eventos Filhos'
example: 'id,title'
-
in: query
name: 'include[arisingFrom]'
description: 'Incluir dados do Evento de Origem'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Evento de Origem'
example: 'id,title'
-
in: query
name: 'include[recurrences]'
description: 'Incluir dados das Recorrências'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados das Recorrências'
example: 'id,title'
-
in: query
name: 'include[cancelled]'
description: 'Incluir dados das Recorrências Canceladas'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados das Recorrências Canceladas'
example: 'id,title'
-
in: query
name: 'include[files]'
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
required: false
schema:
type: string
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
-
in: query
name: 'include[lastFeedback]'
description: 'Incluir último feedback'
example: 'id,date,history_type_id'
required: false
schema:
type: string
description: 'Incluir último feedback'
example: 'id,date,history_type_id'
-
in: query
name: 'include[contract]'
description: 'Incluir dados do Contrato'
example: 'id,type'
required: false
schema:
type: string
description: 'Incluir dados do Contrato'
example: 'id,type'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento '
parameters: []
responses: {}
tags:
- Eventos
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
'filter[title]':
type: string
description: 'Título do Evento'
example: 'Reunião mensal'
'filter[guest][]':
type: array
description: 'IDs dos Convidados'
example: 1
items:
type: integer
'filter[guest_group][]':
type: array
description: 'IDs dos Grupos de Convidados'
example: 2
items:
type: integer
'filter[guest_access]':
type: string
description: "Tipo de acesso dos convidados\nValores permitidos:\n- `full`: Acesso total\n- `invite`: Editar convidados\n- `view`: Visualizar"
example: full
'filter[type]':
type: string
description: "Tipo do Evento.\nValores permitidos:\n- `task`: Tarefa\n- `reminder`: Lembrete\n- `meet`: Reunião\n- `visit`: Visita\n- `whatsapp`: WhatsApp\n- `email`: E-mail\n- `call`: Ligação"
example: task
'filter[status]':
type: string
description: "Status do Evento\nValores permitidos:\n- `cancelled`: Cancelado\n- `concluded`: Concluído\n- `scheduled`: Agendado\n- `recurrent`: Recorrente\n- `late`: Atrasado\n- `five_days_late`: +5 dias de atraso\n- `thirty_days_late`: +1 mês atrasado"
example: scheduled
'filter[initial_date]':
type: date
description: 'Data inicial do Evento'
example: '2025-06-10'
'filter[father_id]':
type: integer
description: 'ID do Evento Pai'
example: 10
'filter[recurrence_id]':
type: integer
description: 'ID da Recorrência'
example: 5
'filter[tag][]':
type: array
description: 'IDs das Tags'
example: 1
items:
type: integer
'filter[final_date]':
type: date
description: 'Data final do Evento'
example: '2025-06-11'
'filter[time_zone]':
type: string
description: "Fuso horário\nValores permitidos:\n- `America/Sao_Paulo`: Horário de Brasília -3:00\n- `America/Noronha`: Noronha -2:00\n- `America/Manaus`: Manaus -4:00\n- `America/Rio_Branco`: Rio Branco -5:00\n- `Atlantic/Azores`: Açores -1:00\n- `America/Costa_Rica`: Costa Rica -6:00\n- `America/Tijuana`: Tijuana -7:00\n- `America/Sitka`: Sitka -8:00\n- `Pacific/Gambier`: Gambier -9:00\n- `Pacific/Honolulu`: Honolulu -10:00\n- `Pacific/Midway`: Midway -11:00"
example: America/Sao_Paulo
'filter[building_id]':
type: integer
description: 'ID do Imóvel'
example: 12
'filter[deal_id]':
type: integer
description: 'ID do Negócio'
example: 8
'filter[contract_id]':
type: integer
description: 'ID do contrato'
example: 123456
'filter[person_id]':
type: integer
description: 'ID da Pessoa'
example: 5
'filter[invite_person]':
type: boolean
description: 'Se convidou pessoa'
example: true
'filter[endless]':
type: boolean
description: 'Evento sem fim'
example: false
'filter[all_day]':
type: boolean
description: 'Evento o dia todo'
example: true
'filter[description]':
type: string
description: 'Descrição do Evento'
example: 'Discussão de metas'
'filter[address]':
type: string
description: 'Endereço do Evento'
example: 'Av. Paulista, 1000'
'filter[reminder][]':
type: array
description: "Lembretes do Evento\nValores permitidos:\n= `START`: Ao Iniciar ao Evento\n= `5_MIN`: 5 minutos antes de começar\n= `15_MIN`: 5 minutos antes de começar\n= `30_MIN`: 0 minutos antes de começar\n= `1_HOUR`: 1 hora antes de começar\n= `2_HOUR`: 2 horas antes de começar\n= `6_HOUR`: 6 horas antes de começar\n= `1_DAY`: 1 dia antes de começar\n= `2_DAY`: 2 dias antes de começar\n= `5_DAY`: 5 dias antes de começar\n= `1_WEEK`: 1 semana antes de começar\n= `2_WEEK`: 2 semanas antes de começar\n= `1_MONTH`: 1 mês antes de começar"
example: START
items:
type: string
'filter[private]':
type: boolean
description: 'Evento privado'
example: false
'filter[recurrency]':
type: string
description: "Recorrência do Evento\nValores permitidos:\n- `daily`: Diária\n- `weekly`: Semanal\n- `monthly`: Mensal\n- `yearly`: Anual"
example: weekly
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento '
parameters: []
responses: {}
tags:
- Eventos
parameters:
-
in: path
name: id
description: 'Id do ticket'
example: 10
required: true
schema:
type: integer
'/invoices/{invoice_id}/pixCode':
post:
summary: 'Gravar código PIX da fatura'
operationId: gravarCdigoPIXDaFatura
description: "Grava na fatura o código PIX (payload EMV \"copia e cola\") gerado pelo banco para o boleto, permitindo que a tela\npública de pagamento, o PDF, o e-mail e o WhatsApp ofereçam o pagamento por PIX em boleto de qualquer banco, e\nnão apenas no ApBank.\n\nO código é validado antes de ser gravado: estrutura EMV do arranjo PIX, chave estática ou URL de cobrança\ndinâmica, campos obrigatórios do BR Code (moeda, país, recebedor e cidade) e dígito verificador CRC16. O payload\nnão pode passar de 512 caracteres, e o dígito verificador é gravado em maiúsculo, como manda a especificação do\nBR Code. Payload recusado não grava nada.\n\nA fatura precisa ter um método de cobrança vinculado: em cobrança manual não há boleto em canal nenhum, e o\ncódigo nunca chegaria ao pagador. Fatura paga, cancelada, renegociada, reembolsada ou incobrável também não\nrecebe código.\n\nA origem fica registrada no histórico da fatura, e alterar o valor ou o vencimento da fatura descarta o código.\n\n🔒 Requer a permissão FINANCEIRO_LANCAMENTO_EDITAR "
parameters: []
responses: {}
tags:
- 'Financeiro › Faturas'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pixCode:
type: string
description: 'Payload EMV do PIX (copia e cola) da fatura.'
example: '00020101021226590014br.gov.bcb.pix2537qrcodepix.banco.com.br/qr/v2/9f1a2b3c52040000530398654071234.565802BR5913IMOBILIARIA X6009SAO PAULO62070503***63040606'
required:
- pixCode
parameters:
-
in: path
name: invoice_id
description: 'ID da fatura.'
example: 123456
required: true
schema:
type: integer
'/invoices/{invoice_id}/receiptLink':
get:
summary: 'Gerar link do Recibo de Recebimento'
operationId: gerarLinkDoReciboDeRecebimento
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,contract_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,contract_id'
-
in: query
name: 'filter[mode]'
description: "Filtra por modo do item.\nValores permitidos:\n- `item`: Padrão\n- `commission`: Comissão\n- `service`: Serviço"
example: item
required: false
schema:
type: string
description: "Filtra por modo do item.\nValores permitidos:\n- `item`: Padrão\n- `commission`: Comissão\n- `service`: Serviço"
example: item
-
in: query
name: 'filter[item_id]'
description: 'Filtra por ID do tipo de item'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID do tipo de item'
example: 1
-
in: query
name: 'filter[parent_id]'
description: 'Filtra por ID do item pai'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID do item pai'
example: 1
-
in: query
name: 'filter[contract_id]'
description: 'Filtra por ID do contrato'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID do contrato'
example: 1
-
in: query
name: 'filter[transfer_owner_id]'
description: 'Filtra por ID do proprietário da transferência'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID do proprietário da transferência'
example: 1
-
in: query
name: 'filter[broker_id]'
description: 'Filtra por ID do corretor'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID do corretor'
example: 1
-
in: query
name: 'filter[start_at]'
description: 'date Filtra por mês inicial'
example: '2024-01-01'
required: false
schema:
type: string
description: 'date Filtra por mês inicial'
example: '2024-01-01'
-
in: query
name: 'filter[end_at]'
description: 'date Filtra por mês final'
example: '2024-12-31'
required: false
schema:
type: string
description: 'date Filtra por mês final'
example: '2024-12-31'
-
in: query
name: 'filter[description]'
description: 'Filtra por descritivo do Item'
example: Aluguel
required: false
schema:
type: string
description: 'Filtra por descritivo do Item'
example: Aluguel
-
in: query
name: 'filter[amount]'
description: 'Filtra por valor'
example: 1000.0
required: false
schema:
type: number
description: 'Filtra por valor'
example: 1000.0
-
in: query
name: 'filter[calculate_mode]'
description: "Filtra por tipo de valor.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Valor fixo"
example: fixed
required: false
schema:
type: string
description: "Filtra por tipo de valor.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Valor fixo"
example: fixed
-
in: query
name: 'filter[percentage]'
description: 'Filtra por porcentagem'
example: 10.0
required: false
schema:
type: number
description: 'Filtra por porcentagem'
example: 10.0
-
in: query
name: 'filter[percentage_mode]'
description: "Filtra por base de cálculo de porcentagem.\nValores permitidos:\n- `rental_value`: Valor da Locação\n- `recurring_commission`: Comissão Recorrente\n- `first_commission`: Primeira Comissão"
example: rental_value
required: false
schema:
type: string
description: "Filtra por base de cálculo de porcentagem.\nValores permitidos:\n- `rental_value`: Valor da Locação\n- `recurring_commission`: Comissão Recorrente\n- `first_commission`: Primeira Comissão"
example: rental_value
-
in: query
name: 'filter[commissioned_type]'
description: "Filtra por tipo de comissionado.\nValores permitidos:\n- `seller`: Corretor Vendedor\n- `broker`: Corretor Agenciador\n- `pickup`: Captador/Angariador\n- `indicator`: Indicador\n- `partner`: Parceria\n- `manager`: Gerente\n- `director`: Diretor\n- `supervisor`: Supervisor\n- `marketing`: Marketing\n- `coordinator`: Coordenador\n- `others`: Outros"
example: seller
required: false
schema:
type: string
description: "Filtra por tipo de comissionado.\nValores permitidos:\n- `seller`: Corretor Vendedor\n- `broker`: Corretor Agenciador\n- `pickup`: Captador/Angariador\n- `indicator`: Indicador\n- `partner`: Parceria\n- `manager`: Gerente\n- `director`: Diretor\n- `supervisor`: Supervisor\n- `marketing`: Marketing\n- `coordinator`: Coordenador\n- `others`: Outros"
example: seller
-
in: query
name: 'filter[item_default]'
description: 'Filtra por item padrão'
example: true
required: false
schema:
type: boolean
description: 'Filtra por item padrão'
example: true
-
in: query
name: 'filter[modeIn][]'
description: 'Filtra por modos do item'
example: null
required: false
schema:
type: array
description: 'Filtra por modos do item'
example: null
items:
type: string
-
in: query
name: 'filter[contractIn][]'
description: 'Filtra por contratos'
example: 1
required: false
schema:
type: array
description: 'Filtra por contratos'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerIn][]'
description: 'Filtra por proprietários'
example: 1
required: false
schema:
type: array
description: 'Filtra por proprietários'
example: 1
items:
type: integer
-
in: query
name: 'filter[amountMin]'
description: 'Filtra por valor mínimo'
example: 1000.0
required: false
schema:
type: number
description: 'Filtra por valor mínimo'
example: 1000.0
-
in: query
name: 'filter[withReadjust]'
description: 'Filtra por valor mínimo'
example: true
required: false
schema:
type: boolean
description: 'Filtra por valor mínimo'
example: true
-
in: query
name: 'include[item]'
description: 'Incluir dados do Item'
example: 'id,description,type'
required: false
schema:
type: string
description: 'Incluir dados do Item'
example: 'id,description,type'
-
in: query
name: 'include[contract]'
description: 'Incluir dados do Contrato'
example: 'id,reference,type'
required: false
schema:
type: string
description: 'Incluir dados do Contrato'
example: 'id,reference,type'
-
in: query
name: 'include[parent]'
description: 'Incluir dados do Item Pai'
example: 'id,description'
required: false
schema:
type: string
description: 'Incluir dados do Item Pai'
example: 'id,description'
-
in: query
name: 'include[transfer_owner]'
description: 'Incluir dados do Proprietário'
example: 'id,name,tax_id'
required: false
schema:
type: string
description: 'Incluir dados do Proprietário'
example: 'id,name,tax_id'
-
in: query
name: 'include[broker]'
description: 'Incluir dados do Corretor'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Incluir dados do Corretor'
example: 'id,name,email'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Contratos '
parameters: []
responses: {}
tags:
- 'Financeiro › Contratos'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
preview:
type: boolean
description: 'Caso informado, o sistema irá mostrar uma prévia das faturas que será gerada'
example: true
parameters:
-
in: path
name: contract
description: 'ID do contrato'
example: 10
required: true
schema:
type: integer
/financial/contracts:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,reference,deal_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,reference,deal_id'
-
in: query
name: 'filter[id]'
description: 'ID do contrato'
example: 123123
required: false
schema:
type: integer
description: 'ID do contrato'
example: 123123
-
in: query
name: 'filter[id2]'
description: 'ID do contrato'
example: 123123
required: false
schema:
type: integer
description: 'ID do contrato'
example: 123123
-
in: query
name: 'filter[building_id]'
description: 'ID do Imóvel'
example: 123456
required: false
schema:
type: integer
description: 'ID do Imóvel'
example: 123456
-
in: query
name: 'filter[tenant_id]'
description: 'ID do Inquilino'
example: 123456
required: false
schema:
type: integer
description: 'ID do Inquilino'
example: 123456
-
in: query
name: 'filter[billing_id]'
description: 'ID do método de pagamento'
example: 123456
required: false
schema:
type: integer
description: 'ID do método de pagamento'
example: 123456
-
in: query
name: 'filter[reference]'
description: 'Código de referência'
example: CONTR-001
required: false
schema:
type: string
description: 'Código de referência'
example: CONTR-001
-
in: query
name: 'filter[type]'
description: "Tipo do contrato.\nValores permitidos:\n- `rent`: Anual\n- `season`: Temporada\n- `sale`: Venda\n- `subscription`: Assinatura"
example: rent
required: false
schema:
type: string
description: "Tipo do contrato.\nValores permitidos:\n- `rent`: Anual\n- `season`: Temporada\n- `sale`: Venda\n- `subscription`: Assinatura"
example: rent
-
in: query
name: 'filter[sale_type]'
description: "Tipo de venda.\nValores permitidos:\n- `deed_registration`: Escritura/Registro\n- `financing`: Financiamento\n- `private_document`: Documento Particular\n- `assignment_of_rights`: Cessão de direito"
example: deed_registration
required: false
schema:
type: string
description: "Tipo de venda.\nValores permitidos:\n- `deed_registration`: Escritura/Registro\n- `financing`: Financiamento\n- `private_document`: Documento Particular\n- `assignment_of_rights`: Cessão de direito"
example: deed_registration
-
in: query
name: 'filter[active]'
description: "Status de atividade.\nValores permitidos:\n- `active`: Ativo\n- `pre_reserved`: Pré-Reservado\n- `reserved`: Reservado\n- `suspended`: Suspenso\n- `canceled`: Cancelado\n- `finished`: Concluído"
example: active
required: false
schema:
type: string
description: "Status de atividade.\nValores permitidos:\n- `active`: Ativo\n- `pre_reserved`: Pré-Reservado\n- `reserved`: Reservado\n- `suspended`: Suspenso\n- `canceled`: Cancelado\n- `finished`: Concluído"
example: active
-
in: query
name: 'filter[active_date]'
description: 'Data de alteração da atividade'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data de alteração da atividade'
example: '2024-01-01'
-
in: query
name: 'filter[status]'
description: "Status do contrato.\nValores permitidos:\n- `progress`: Em Andamento\n- `closing`: Encerrando\n- `readjust`: Aguardando Reajuste\n- `renew`: Aguardando Renovação\n- `no_invoices`: Contrato sem Faturas\n- `suspended`: Suspenso\n- `pending`: Pendente\n- `finished`: Finalizado\n- `canceled`: Cancelado\n- `terminating`: Aguardando Rescisão\n- `on_notice`: Em Aviso Prévio\n- `terminated`: Rescindido"
example: no_invoices
required: false
schema:
type: string
description: "Status do contrato.\nValores permitidos:\n- `progress`: Em Andamento\n- `closing`: Encerrando\n- `readjust`: Aguardando Reajuste\n- `renew`: Aguardando Renovação\n- `no_invoices`: Contrato sem Faturas\n- `suspended`: Suspenso\n- `pending`: Pendente\n- `finished`: Finalizado\n- `canceled`: Cancelado\n- `terminating`: Aguardando Rescisão\n- `on_notice`: Em Aviso Prévio\n- `terminated`: Rescindido"
example: no_invoices
-
in: query
name: 'filter[status_date]'
description: 'Data de alteração do status'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data de alteração do status'
example: '2024-01-01'
-
in: query
name: 'filter[payment_status]'
description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 dias\n- `due_10_days`: Vence em 10 dias\n- `nothing`: Nada a pagar\n- `ok`: Pagamento em Dia\n- `5_days`: Menos de 5 dias Vencido\n- `30_days`: Menos de um mês Vencido\n- `month`: Mais de um mês Vencido\n- `3_months`: Mais de três meses Vencido"
example: ok
required: false
schema:
type: string
description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 dias\n- `due_10_days`: Vence em 10 dias\n- `nothing`: Nada a pagar\n- `ok`: Pagamento em Dia\n- `5_days`: Menos de 5 dias Vencido\n- `30_days`: Menos de um mês Vencido\n- `month`: Mais de um mês Vencido\n- `3_months`: Mais de três meses Vencido"
example: ok
-
in: query
name: 'filter[payment_status_date]'
description: 'Data de alteração do status de pagamento'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data de alteração do status de pagamento'
example: '2024-01-01'
-
in: query
name: 'filter[user_id]'
description: 'ID do usuário responsável'
example: 123456
required: false
schema:
type: integer
description: 'ID do usuário responsável'
example: 123456
-
in: query
name: 'filter[agent_id]'
description: 'ID do corretor'
example: 123456
required: false
schema:
type: integer
description: 'ID do corretor'
example: 123456
-
in: query
name: 'filter[procurator_id]'
description: 'ID do procurador'
example: 123456
required: false
schema:
type: integer
description: 'ID do procurador'
example: 123456
-
in: query
name: 'filter[team_id]'
description: 'ID da equipe'
example: 123456
required: false
schema:
type: integer
description: 'ID da equipe'
example: 123456
-
in: query
name: 'filter[access]'
description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
example: all
required: false
schema:
type: string
description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
example: all
-
in: query
name: 'filter[tag]'
description: Tags
example: importante
required: false
schema:
type: string
description: Tags
example: importante
-
in: query
name: 'filter[guaranteed_transfer]'
description: 'Repasse garantido'
example: true
required: false
schema:
type: boolean
description: 'Repasse garantido'
example: true
-
in: query
name: 'filter[guaranteed_transfer_months]'
description: 'Meses garantidos no repasse'
example: 12
required: false
schema:
type: integer
description: 'Meses garantidos no repasse'
example: 12
-
in: query
name: 'filter[guaranteed_transfer_release_after_days]'
description: 'Dias para liberação do repasse'
example: 30
required: false
schema:
type: integer
description: 'Dias para liberação do repasse'
example: 30
-
in: query
name: 'filter[start_at]'
description: 'Data de início'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data de início'
example: '2024-01-01'
-
in: query
name: 'filter[end_at]'
description: 'Data de término'
example: '2024-12-31'
required: false
schema:
type: string
description: 'Data de término'
example: '2024-12-31'
-
in: query
name: 'filter[signed_at]'
description: 'Data de assinatura'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data de assinatura'
example: '2024-01-01'
-
in: query
name: 'filter[recurrency]'
description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
example: monthly
required: false
schema:
type: string
description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
example: monthly
-
in: query
name: 'filter[recurrency_amount]'
description: 'Quantidade de recorrências'
example: 12
required: false
schema:
type: integer
description: 'Quantidade de recorrências'
example: 12
-
in: query
name: 'filter[modality]'
description: "Modalidade.\nValores permitidos:\n- `start`: Início do Contrato\n- `due_date`: Dia de Vencimento\n- `monthly`: Início do Mês"
example: start
required: false
schema:
type: string
description: "Modalidade.\nValores permitidos:\n- `start`: Início do Contrato\n- `due_date`: Dia de Vencimento\n- `monthly`: Início do Mês"
example: start
-
in: query
name: 'filter[amount]'
description: 'Valor do contrato'
example: 1500.0
required: false
schema:
type: number
description: 'Valor do contrato'
example: 1500.0
-
in: query
name: 'filter[current_amount]'
description: 'Valor atual do contrato'
example: 1500.0
required: false
schema:
type: number
description: 'Valor atual do contrato'
example: 1500.0
-
in: query
name: 'filter[service_rate_amount]'
description: 'Valor da taxa de serviço'
example: 150.0
required: false
schema:
type: number
description: 'Valor da taxa de serviço'
example: 150.0
-
in: query
name: 'filter[total]'
description: 'Valor total'
example: 1650.0
required: false
schema:
type: number
description: 'Valor total'
example: 1650.0
-
in: query
name: 'filter[signal_amount]'
description: 'Valor de sinal'
example: 1500.0
required: false
schema:
type: number
description: 'Valor de sinal'
example: 1500.0
-
in: query
name: 'filter[refund_amount]'
description: 'Valor de reembolso'
example: 0.0
required: false
schema:
type: number
description: 'Valor de reembolso'
example: 0.0
-
in: query
name: 'filter[fiscal_note_withholding]'
description: 'Retenção de nota fiscal'
example: 0.0
required: false
schema:
type: number
description: 'Retenção de nota fiscal'
example: 0.0
-
in: query
name: 'filter[due_day]'
description: 'Dia do vencimento'
example: 5
required: false
schema:
type: integer
description: 'Dia do vencimento'
example: 5
-
in: query
name: 'filter[due_date]'
description: 'Data do vencimento'
example: '2024-01-05'
required: false
schema:
type: string
description: 'Data do vencimento'
example: '2024-01-05'
-
in: query
name: 'filter[billing_timing]'
description: 'Momento do faturamento'
example: pre
required: false
schema:
type: string
description: 'Momento do faturamento'
example: pre
-
in: query
name: 'filter[first_commission]'
description: 'Primeira comissão'
example: 0.0
required: false
schema:
type: number
description: 'Primeira comissão'
example: 0.0
-
in: query
name: 'filter[first_commission_installment]'
description: 'Parcelas da primeira comissão'
example: 1
required: false
schema:
type: integer
description: 'Parcelas da primeira comissão'
example: 1
-
in: query
name: 'filter[recurring_commission]'
description: 'Comissão recorrente'
example: 0.0
required: false
schema:
type: number
description: 'Comissão recorrente'
example: 0.0
-
in: query
name: 'filter[add_commission_on_first]'
description: 'Adicionar comissão na primeira parcela'
example: false
required: false
schema:
type: boolean
description: 'Adicionar comissão na primeira parcela'
example: false
-
in: query
name: 'filter[proportional]'
description: Proporcional
example: false
required: false
schema:
type: boolean
description: Proporcional
example: false
-
in: query
name: 'filter[unify_first_invoice]'
description: 'Unificar primeira fatura'
example: false
required: false
schema:
type: boolean
description: 'Unificar primeira fatura'
example: false
-
in: query
name: 'filter[readjust_active]'
description: 'Reajuste ativo'
example: true
required: false
schema:
type: boolean
description: 'Reajuste ativo'
example: true
-
in: query
name: 'filter[readjust_indicator]'
description: "Indicador de reajuste.\nValores permitidos:\n- `IGP-M`: IGP-M\n- `INCC-M`: INCC-M\n- `INPC`: INPC\n- `IVAR`: IVAR\n- `IPC-BR`: IPC-BR\n- `IPCA`: IPCA\n- `highest_index`: Maior disponível\n- `lowest_index`: Menor disponível\n- `IPC-FIPE`: IPC-FIPE"
example: IGP-M
required: false
schema:
type: string
description: "Indicador de reajuste.\nValores permitidos:\n- `IGP-M`: IGP-M\n- `INCC-M`: INCC-M\n- `INPC`: INPC\n- `IVAR`: IVAR\n- `IPC-BR`: IPC-BR\n- `IPCA`: IPCA\n- `highest_index`: Maior disponível\n- `lowest_index`: Menor disponível\n- `IPC-FIPE`: IPC-FIPE"
example: IGP-M
-
in: query
name: 'filter[readjust_with]'
description: 'Período de reajuste'
example: 12
required: false
schema:
type: integer
description: 'Período de reajuste'
example: 12
-
in: query
name: 'filter[readjust_at]'
description: 'Data do reajuste'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data do reajuste'
example: '2024-01-01'
-
in: query
name: 'filter[readjusted_at]'
description: 'Data do último reajuste'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Data do último reajuste'
example: '2024-01-01'
-
in: query
name: 'filter[guarantee]'
description: Garantia
example: caução
required: false
schema:
type: string
description: Garantia
example: caução
-
in: query
name: 'filter[notes]'
description: Observações
example: 'Contrato de aluguel residencial'
required: false
schema:
type: string
description: Observações
example: 'Contrato de aluguel residencial'
-
in: query
name: 'filter[clauses]'
description: Cláusulas
example: 'Cláusulas do contrato'
required: false
schema:
type: string
description: Cláusulas
example: 'Cláusulas do contrato'
-
in: query
name: 'filter[invoice_installment]'
description: 'Parcelas da fatura'
example: 1
required: false
schema:
type: integer
description: 'Parcelas da fatura'
example: 1
-
in: query
name: 'filter[witness_1]'
description: 'ID da primeira testemunha'
example: 123456
required: false
schema:
type: integer
description: 'ID da primeira testemunha'
example: 123456
-
in: query
name: 'filter[witness_2]'
description: 'ID da segunda testemunha'
example: 123456
required: false
schema:
type: integer
description: 'ID da segunda testemunha'
example: 123456
-
in: query
name: 'filter[guarantor_1]'
description: 'ID do primeiro fiador'
example: 123456
required: false
schema:
type: integer
description: 'ID do primeiro fiador'
example: 123456
-
in: query
name: 'filter[guarantor_2]'
description: 'ID do segundo fiador'
example: 123456
required: false
schema:
type: integer
description: 'ID do segundo fiador'
example: 123456
-
in: query
name: 'filter[ticket_late_fee]'
description: 'Multa por atraso'
example: true
required: false
schema:
type: boolean
description: 'Multa por atraso'
example: true
-
in: query
name: 'filter[ticket_late_fee_item_id]'
description: 'ID do item de multa'
example: 123456
required: false
schema:
type: integer
description: 'ID do item de multa'
example: 123456
-
in: query
name: 'filter[ticket_late_fee_percentage]'
description: 'Porcentagem da multa'
example: 2.0
required: false
schema:
type: number
description: 'Porcentagem da multa'
example: 2.0
-
in: query
name: 'filter[ticket_late_fee_interest]'
description: 'Juros da multa'
example: 1.0
required: false
schema:
type: number
description: 'Juros da multa'
example: 1.0
-
in: query
name: 'filter[ticket_discount]'
description: Desconto
example: true
required: false
schema:
type: boolean
description: Desconto
example: true
-
in: query
name: 'filter[ticket_discount_action]'
description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
example: percentage
required: false
schema:
type: string
description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
example: percentage
-
in: query
name: 'filter[ticket_discount_mode]'
description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
example: fixed
required: false
schema:
type: string
description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
example: fixed
-
in: query
name: 'filter[ticket_discount_percentage]'
description: 'Porcentagem do desconto'
example: 5.0
required: false
schema:
type: number
description: 'Porcentagem do desconto'
example: 5.0
-
in: query
name: 'filter[ticket_discount_fixed]'
description: 'Valor fixo do desconto'
example: 50.0
required: false
schema:
type: number
description: 'Valor fixo do desconto'
example: 50.0
-
in: query
name: 'filter[ticket_discount_days]'
description: 'Dias para desconto'
example: 5
required: false
schema:
type: integer
description: 'Dias para desconto'
example: 5
-
in: query
name: 'filter[termination_fee]'
description: 'Valor da multa de rescisão'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa de rescisão'
example: 1500.0
-
in: query
name: 'filter[termination_fee_months]'
description: 'Meses de multa'
example: 3
required: false
schema:
type: integer
description: 'Meses de multa'
example: 3
-
in: query
name: 'filter[termination_fee_exemption]'
description: 'Isenção de multa'
example: false
required: false
schema:
type: boolean
description: 'Isenção de multa'
example: false
-
in: query
name: 'filter[termination_fee_amount]'
description: 'Valor da multa'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa'
example: 1500.0
-
in: query
name: 'filter[termination_fee_comission]'
description: 'Valor da multa'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa'
example: 1500.0
-
in: query
name: 'filter[termination_fee_requester]'
description: 'Valor da multa'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa'
example: 1500.0
-
in: query
name: 'filter[termination_fee_motive]'
description: 'Valor da multa'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa'
example: 1500.0
-
in: query
name: 'filter[termination_fee_calculate_mode]'
description: 'Valor da multa'
example: 1500.0
required: false
schema:
type: number
description: 'Valor da multa'
example: 1500.0
-
in: query
name: 'filter[termination_at]'
description: 'Data de Rescisão'
example: '1500.00'
required: false
schema:
type: string
description: 'Data de Rescisão'
example: '1500.00'
-
in: query
name: 'filter[deal_id]'
description: 'ID do negócio'
example: 123456
required: false
schema:
type: integer
description: 'ID do negócio'
example: 123456
-
in: query
name: 'filter[business_id]'
description: 'ID da empresa'
example: 123456
required: false
schema:
type: integer
description: 'ID da empresa'
example: 123456
-
in: query
name: 'filter[account_id]'
description: 'ID da conta financeira'
example: 123456
required: false
schema:
type: integer
description: 'ID da conta financeira'
example: 123456
-
in: query
name: 'filter[billing_method]'
description: "Tipo de pagamento ao proprietário.\nValores permitidos:\n- `ticket`: Boleto\n- `cash`: Dinheiro\n- `deposit`: Depósito\n- `pix`: PIX\n- `ted`: DOC/TED\n- `credit`: Cartão de Crédito\n- `debit`: Cartão de Débito\n- `check`: Cheque\n- `debit_account`: Débito em Conta"
example: pix
required: false
schema:
type: string
description: "Tipo de pagamento ao proprietário.\nValores permitidos:\n- `ticket`: Boleto\n- `cash`: Dinheiro\n- `deposit`: Depósito\n- `pix`: PIX\n- `ted`: DOC/TED\n- `credit`: Cartão de Crédito\n- `debit`: Cartão de Débito\n- `check`: Cheque\n- `debit_account`: Débito em Conta"
example: pix
-
in: query
name: 'filter[metadata]'
description: 'json Metadados'
example: '{"key": "value"}'
required: false
schema:
type: string
description: 'json Metadados'
example: '{"key": "value"}'
-
in: query
name: 'filter[documentables.template_id]'
description: 'Filtra contratos por template de documento (nova estrutura documentables)'
example: 123456
required: false
schema:
type: integer
description: 'Filtra contratos por template de documento (nova estrutura documentables)'
example: 123456
-
in: query
name: 'filter[documentables.privacy]'
description: 'Filtra contratos por privacidade do documentable'
example: private
required: false
schema:
type: string
description: 'Filtra contratos por privacidade do documentable'
example: private
-
in: query
name: 'filter[receipt_document_id]'
description: 'Modelo de documento do recibo'
example: 123123
required: false
schema:
type: integer
description: 'Modelo de documento do recibo'
example: 123123
-
in: query
name: 'filter[transfer_mode]'
description: "Modo de transferência.\nValores permitidos:\n- `manually`: Manual\n- `after_receive`: Após Recebimento\n- `fixed_day_or_next`: Em dia Fixo ou Seguinte\n- `fixed_day`: Em dia Fixo"
example: manually
required: false
schema:
type: string
description: "Modo de transferência.\nValores permitidos:\n- `manually`: Manual\n- `after_receive`: Após Recebimento\n- `fixed_day_or_next`: Em dia Fixo ou Seguinte\n- `fixed_day`: Em dia Fixo"
example: manually
-
in: query
name: 'filter[transfer_auto]'
description: 'Transferência automática'
example: false
required: false
schema:
type: boolean
description: 'Transferência automática'
example: false
-
in: query
name: 'filter[transfer_after_days]'
description: 'Dias para transferência'
example: 5
required: false
schema:
type: integer
description: 'Dias para transferência'
example: 5
-
in: query
name: 'filter[renewed_id]'
description: 'Código do ID do contrato que foi renovado'
example: 987987
required: false
schema:
type: integer
description: 'Código do ID do contrato que foi renovado'
example: 987987
-
in: query
name: 'filter[fiscal_note_trigger]'
description: 'Modo de emissão da nota fiscal (NONE, BUSINESS, MANUAL, ON_PAYMENT_CONFIRMATION, ON_PAYMENT_NO_CONVERT)'
example: BUSINESS
required: false
schema:
type: string
description: 'Modo de emissão da nota fiscal (NONE, BUSINESS, MANUAL, ON_PAYMENT_CONFIRMATION, ON_PAYMENT_NO_CONVERT)'
example: BUSINESS
-
in: query
name: 'filter[statusIn][]'
description: 'Filtra contratos por status'
example: null
required: false
schema:
type: array
description: 'Filtra contratos por status'
example: null
items:
type: string
-
in: query
name: 'filter[statusNotIn][]'
description: 'Filtra contratos excluindo status'
example: null
required: false
schema:
type: array
description: 'Filtra contratos excluindo status'
example: null
items:
type: string
-
in: query
name: 'filter[paymentStatusIn][]'
description: 'Filtra contratos por status de pagamento'
example: null
required: false
schema:
type: array
description: 'Filtra contratos por status de pagamento'
example: null
items:
type: string
-
in: query
name: 'filter[activeIn][]'
description: 'Filtra contratos por status de atividade'
example: null
required: false
schema:
type: array
description: 'Filtra contratos por status de atividade'
example: null
items:
type: string
-
in: query
name: 'filter[typeIn][]'
description: 'Filtra contratos por tipo'
example: null
required: false
schema:
type: array
description: 'Filtra contratos por tipo'
example: null
items:
type: string
-
in: query
name: 'filter[accountIn][]'
description: 'Filtra contratos por conta financeira'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por conta financeira'
example: 1
items:
type: integer
-
in: query
name: 'filter[businessIn][]'
description: 'Filtra contratos por empresa'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por empresa'
example: 1
items:
type: integer
-
in: query
name: 'filter[tenantIn][]'
description: 'Filtra contratos por inquilino'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por inquilino'
example: 1
items:
type: integer
-
in: query
name: 'filter[buildingIn][]'
description: 'Filtra contratos por imóvel'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por imóvel'
example: 1
items:
type: integer
-
in: query
name: 'filter[buildingId2In][]'
description: 'Filtra contratos por código do imóvel'
example: null
required: false
schema:
type: array
description: 'Filtra contratos por código do imóvel'
example: null
items:
type: integer
-
in: query
name: 'filter[condominiumIn][]'
description: 'Filtra contratos por condomínio'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por condomínio'
example: 1
items:
type: integer
-
in: query
name: 'filter[dealIn][]'
description: 'Filtra contratos por negócio'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por negócio'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerIn][]'
description: 'Filtra contratos por proprietário'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por proprietário'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerAllIn][]'
description: 'Filtra contratos por todos os proprietários'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por todos os proprietários'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerOrTenantIn][]'
description: 'Filtra contratos por proprietário ou inquilino'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por proprietário ou inquilino'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerOrTenantOrBuyerIn][]'
description: 'Filtra contratos por proprietário, inquilino ou comprador'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por proprietário, inquilino ou comprador'
example: 1
items:
type: integer
-
in: query
name: 'filter[billingIn][]'
description: 'Filtra contratos por método de pagamento'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por método de pagamento'
example: 1
items:
type: integer
-
in: query
name: 'filter[ownerNotIn][]'
description: 'Filtra contratos excluindo proprietários'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos excluindo proprietários'
example: 1
items:
type: integer
-
in: query
name: 'filter[occupantIn][]'
description: 'Filtra contratos por ocupante'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por ocupante'
example: 1
items:
type: integer
-
in: query
name: 'filter[buyerIn][]'
description: 'Filtra contratos por comprador'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por comprador'
example: 1
items:
type: integer
-
in: query
name: 'filter[renewedFrom][]'
description: 'Filtra contratos renovados a partir de'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos renovados a partir de'
example: 1
items:
type: integer
-
in: query
name: 'filter[atMonth]'
description: 'Filtra contratos por mês de atividade'
example: 1
required: false
schema:
type: integer
description: 'Filtra contratos por mês de atividade'
example: 1
-
in: query
name: 'filter[atYear]'
description: 'Filtra contratos por ano de atividade'
example: 2024
required: false
schema:
type: integer
description: 'Filtra contratos por ano de atividade'
example: 2024
-
in: query
name: 'filter[soldMonth]'
description: 'Filtra contratos por mês de venda'
example: 1
required: false
schema:
type: integer
description: 'Filtra contratos por mês de venda'
example: 1
-
in: query
name: 'filter[soldYear]'
description: 'Filtra contratos por ano de venda'
example: 2024
required: false
schema:
type: integer
description: 'Filtra contratos por ano de venda'
example: 2024
-
in: query
name: 'filter[readjustMonth]'
description: 'Filtra contratos por mês/ano de reajuste'
example: 2024-01
required: false
schema:
type: string
description: 'Filtra contratos por mês/ano de reajuste'
example: 2024-01
-
in: query
name: 'filter[endMonth]'
description: 'Filtra contratos por mês/ano de término'
example: 2024-01
required: false
schema:
type: string
description: 'Filtra contratos por mês/ano de término'
example: 2024-01
-
in: query
name: 'filter[renewedBetween][]'
description: 'Filtra contratos renovados entre datas'
example: null
required: false
schema:
type: array
description: 'Filtra contratos renovados entre datas'
example: null
items:
type: string
-
in: query
name: 'filter[responsibleIn][]'
description: 'Filtra contratos por responsáveis'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por responsáveis'
example: 1
items:
type: integer
-
in: query
name: 'filter[team]'
description: 'Filtra contratos por equipe'
example: 1
required: false
schema:
type: integer
description: 'Filtra contratos por equipe'
example: 1
-
in: query
name: 'filter[extended]'
description: 'Filtra contratos prorrogados'
example: true
required: false
schema:
type: boolean
description: 'Filtra contratos prorrogados'
example: true
-
in: query
name: 'filter[contractItems][]'
description: 'Filtra contratos por itens'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por itens'
example: 1
items:
type: integer
-
in: query
name: 'filter[guaranteeTypeIn][]'
description: 'Filtra contratos pela modalidade da garantia locatícia; use "undefined" para os que ainda não têm garantia informada'
example: null
required: false
schema:
type: array
description: 'Filtra contratos pela modalidade da garantia locatícia; use "undefined" para os que ainda não têm garantia informada'
example: null
items:
type: string
-
in: query
name: 'filter[hasGuarantor]'
description: 'Filtra contratos com fiador'
example: true
required: false
schema:
type: boolean
description: 'Filtra contratos com fiador'
example: true
-
in: query
name: 'filter[hasFireInsurance]'
description: 'Filtra contratos com seguro de incêndio'
example: true
required: false
schema:
type: boolean
description: 'Filtra contratos com seguro de incêndio'
example: true
-
in: query
name: 'filter[overduePaymentDays]'
description: 'Filtra contratos com pagamentos atrasados em dias'
example: 30
required: false
schema:
type: integer
description: 'Filtra contratos com pagamentos atrasados em dias'
example: 30
-
in: query
name: 'filter[dueDateInvoices]'
description: 'Filtra contratos com faturas vencidas em data'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Filtra contratos com faturas vencidas em data'
example: '2024-01-01'
-
in: query
name: 'filter[paidPeriod][]'
description: 'Filtra contratos com pagamentos entre datas'
example: null
required: false
schema:
type: array
description: 'Filtra contratos com pagamentos entre datas'
example: null
items:
type: string
-
in: query
name: 'filter[cityIn][]'
description: 'Filtra contratos por cidade'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por cidade'
example: 1
items:
type: integer
-
in: query
name: 'filter[stateIn][]'
description: 'Filtra contratos por estado'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por estado'
example: 1
items:
type: integer
-
in: query
name: 'filter[districtIn][]'
description: 'Filtra contratos por bairro'
example: 1
required: false
schema:
type: array
description: 'Filtra contratos por bairro'
example: 1
items:
type: integer
-
in: query
name: 'include[occupants]'
description: 'Incluir dados dos Ocupantes'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Incluir dados dos Ocupantes'
example: 'id,name,type'
-
in: query
name: 'include[buyers]'
description: 'Incluir dados dos Compradores'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Incluir dados dos Compradores'
example: 'id,name,type'
-
in: query
name: 'include[vehicles]'
description: 'Incluir dados dos Veículos'
example: 'id,brand,model'
required: false
schema:
type: string
description: 'Incluir dados dos Veículos'
example: 'id,brand,model'
-
in: query
name: 'include[tickets]'
description: 'Incluir dados dos Atendimentos'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados dos Atendimentos'
example: 'id,title'
-
in: query
name: 'include[inspects]'
description: 'Incluir dados dos Atendimentos'
example: 'id,type,status'
required: false
schema:
type: string
description: 'Incluir dados dos Atendimentos'
example: 'id,type,status'
-
in: query
name: 'include[events]'
description: 'Incluir dados dos Eventos'
example: 'id,title,address'
required: false
schema:
type: string
description: 'Incluir dados dos Eventos'
example: 'id,title,address'
-
in: query
name: 'include[business]'
description: 'Incluir dados da Empresa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Empresa'
example: 'id,name'
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel'
example: 'id,title'
-
in: query
name: 'include[billing]'
description: 'Incluir dados da Empresa de Cobrança'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Empresa de Cobrança'
example: 'id,name'
-
in: query
name: 'include[account]'
description: 'Incluir dados da Conta Financeira'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Conta Financeira'
example: 'id,name'
-
in: query
name: 'include[user]'
description: 'Incluir dados do Responsável pelo Contrato'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados do Responsável pelo Contrato'
example: 'id,name'
-
in: query
name: 'include[renewed]'
description: 'Incluir dados do Contrato Pai que gerou este'
example: 'id,deal_id'
required: false
schema:
type: string
description: 'Incluir dados do Contrato Pai que gerou este'
example: 'id,deal_id'
-
in: query
name: 'include[renewedTo]'
description: 'Incluir dados do Contrato Filho que este gerou'
example: 'id,deal_id'
required: false
schema:
type: string
description: 'Incluir dados do Contrato Filho que este gerou'
example: 'id,deal_id'
-
in: query
name: 'include[team]'
description: 'Incluir dados da Equipe de Venda/Locação'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Equipe de Venda/Locação'
example: 'id,name'
-
in: query
name: 'include[tenant]'
description: 'Incluir dados do Inquilino'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados do Inquilino'
example: 'id,name'
-
in: query
name: 'include[owners]'
description: 'Incluir dados dos Proprietários'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados dos Proprietários'
example: 'id,name'
-
in: query
name: 'include[invoices]'
description: 'Incluir dados das Faturas'
example: 'id,amount'
required: false
schema:
type: string
description: 'Incluir dados das Faturas'
example: 'id,amount'
-
in: query
name: 'include[items]'
description: 'Incluir dados dos Itens'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Incluir dados dos Itens'
example: 'id,description,amount'
-
in: query
name: 'include[commissions]'
description: 'Incluir dados das Comissões'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Incluir dados das Comissões'
example: 'id,description,amount'
-
in: query
name: 'include[insurances]'
description: 'Incluir dados dos Seguros'
example: 'id,type,amount'
required: false
schema:
type: string
description: 'Incluir dados dos Seguros'
example: 'id,type,amount'
-
in: query
name: 'include[files]'
description: 'Incluir dados dos Arquivos'
example: 'id,name,url'
required: false
schema:
type: string
description: 'Incluir dados dos Arquivos'
example: 'id,name,url'
-
in: query
name: 'include[documentables]'
description: 'Incluir dados dos Documentos (estrutura documentables)'
example: 'id,template_id,privacy'
required: false
schema:
type: string
description: 'Incluir dados dos Documentos (estrutura documentables)'
example: 'id,template_id,privacy'
-
in: query
name: 'include[deal]'
description: 'Incluir dados do Negócio'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Negócio'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Contratos '
parameters: []
responses: {}
tags:
- 'Financeiro › Contratos'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: "Tipo do contrato.\nValores permitidos:\n- `rent`: Anual\n- `season`: Temporada\n- `sale`: Venda\n- `subscription`: Assinatura"
example: rent
building_id:
type: integer
description: 'ID do Imóvel'
example: 123456
tenant_id:
type: integer
description: 'ID do Inquilino'
example: 123456
billing_id:
type: integer
description: 'ID do método de pagamento'
example: 123456
start_at:
type: string
description: 'Data de início'
example: '2024-01-01'
recurrency:
type: string
description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
example: monthly
amount:
type: number
description: 'Valor do contrato'
example: 1500.0
business_id:
type: integer
description: 'ID da empresa'
example: 123456
account_id:
type: integer
description: 'ID da conta financeira'
example: 123456
billing_method:
type: string
description: "Tipo de pagamento ao proprietário.\nValores permitidos:\n- `ticket`: Boleto\n- `cash`: Dinheiro\n- `deposit`: Depósito\n- `pix`: PIX\n- `ted`: DOC/TED\n- `credit`: Cartão de Crédito\n- `debit`: Cartão de Débito\n- `check`: Cheque\n- `debit_account`: Débito em Conta"
example: pix
due_date:
type: string
description: 'Data do vencimento'
example: '2024-01-05'
sale_type:
type: string
description: "Tipo de venda.\nValores permitidos:\n- `deed_registration`: Escritura/Registro\n- `financing`: Financiamento\n- `private_document`: Documento Particular\n- `assignment_of_rights`: Cessão de direito"
example: deed_registration
reference:
type: string
description: 'Código de referência'
example: CONTR-001
active:
type: string
description: "Status de atividade.\nValores permitidos:\n- `active`: Ativo\n- `pre_reserved`: Pré-Reservado\n- `reserved`: Reservado\n- `suspended`: Suspenso\n- `canceled`: Cancelado\n- `finished`: Concluído"
example: active
active_date:
type: string
description: 'Data de alteração da atividade'
example: '2024-01-01'
status:
type: string
description: "Status do contrato.\nValores permitidos:\n- `progress`: Em Andamento\n- `closing`: Encerrando\n- `readjust`: Aguardando Reajuste\n- `renew`: Aguardando Renovação\n- `no_invoices`: Contrato sem Faturas\n- `suspended`: Suspenso\n- `pending`: Pendente\n- `finished`: Finalizado\n- `canceled`: Cancelado\n- `terminating`: Aguardando Rescisão\n- `on_notice`: Em Aviso Prévio\n- `terminated`: Rescindido"
example: no_invoices
status_date:
type: string
description: 'Data de alteração do status'
example: '2024-01-01'
payment_status:
type: string
description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 dias\n- `due_10_days`: Vence em 10 dias\n- `nothing`: Nada a pagar\n- `ok`: Pagamento em Dia\n- `5_days`: Menos de 5 dias Vencido\n- `30_days`: Menos de um mês Vencido\n- `month`: Mais de um mês Vencido\n- `3_months`: Mais de três meses Vencido"
example: ok
payment_status_date:
type: string
description: 'Data de alteração do status de pagamento'
example: '2024-01-01'
user_id:
type: integer
description: 'ID do usuário responsável'
example: 123456
agent_id:
type: integer
description: 'ID do corretor'
example: 123456
procurator_id:
type: integer
description: 'ID do procurador'
example: 123456
team_id:
type: integer
description: 'ID da equipe'
example: 123456
access:
type: string
description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
example: all
tag:
type: string
description: Tags
example: importante
guaranteed_transfer:
type: boolean
description: 'Repasse garantido'
example: true
guaranteed_transfer_months:
type: integer
description: 'Meses garantidos no repasse'
example: 12
guaranteed_transfer_release_after_days:
type: integer
description: 'Dias para liberação do repasse'
example: 30
end_at:
type: string
description: 'Data de término'
example: '2024-12-31'
boolean:
type: Fim
description: indeterminado
example: 'false'
signed_at:
type: string
description: 'Data de assinatura'
example: '2024-01-01'
recurrency_amount:
type: integer
description: 'Quantidade de recorrências'
example: 12
modality:
type: string
description: "Modalidade.\nValores permitidos:\n- `start`: Início do Contrato\n- `due_date`: Dia de Vencimento\n- `monthly`: Início do Mês"
example: start
current_amount:
type: number
description: 'Valor atual do contrato'
example: 1500.0
service_rate_amount:
type: number
description: 'Valor da taxa de serviço'
example: 150.0
total:
type: number
description: 'Valor total'
example: 1650.0
signal_amount:
type: number
description: 'Valor de sinal'
example: 1500.0
refund_amount:
type: number
description: 'Valor de reembolso'
example: 0.0
fiscal_note_withholding:
type: number
description: 'Retenção de nota fiscal'
example: 0.0
due_day:
type: integer
description: 'Dia do vencimento'
example: 5
billing_timing:
type: string
description: 'Momento do faturamento'
example: pre
first_commission:
type: number
description: 'Primeira comissão'
example: 0.0
first_commission_installment:
type: integer
description: 'Parcelas da primeira comissão'
example: 1
recurring_commission:
type: number
description: 'Comissão recorrente'
example: 0.0
add_commission_on_first:
type: boolean
description: 'Adicionar comissão na primeira parcela'
example: false
proportional:
type: boolean
description: Proporcional
example: false
unify_first_invoice:
type: boolean
description: 'Unificar primeira fatura'
example: false
readjust_active:
type: boolean
description: 'Reajuste ativo'
example: true
readjust_indicator:
type: string
description: "Indicador de reajuste.\nValores permitidos:\n- `IGP-M`: IGP-M\n- `INCC-M`: INCC-M\n- `INPC`: INPC\n- `IVAR`: IVAR\n- `IPC-BR`: IPC-BR\n- `IPCA`: IPCA\n- `highest_index`: Maior disponível\n- `lowest_index`: Menor disponível\n- `IPC-FIPE`: IPC-FIPE"
example: IGP-M
readjust_with:
type: integer
description: 'Período de reajuste'
example: 12
readjust_at:
type: string
description: 'Data do reajuste'
example: '2024-01-01'
readjusted_at:
type: string
description: 'Data do último reajuste'
example: '2024-01-01'
guarantee:
type: string
description: Garantia
example: caução
notes:
type: string
description: Observações
example: 'Contrato de aluguel residencial'
clauses:
type: string
description: Cláusulas
example: 'Cláusulas do contrato'
invoice_installment:
type: integer
description: 'Parcelas da fatura'
example: 1
witness_1:
type: integer
description: 'ID da primeira testemunha'
example: 123456
witness_2:
type: integer
description: 'ID da segunda testemunha'
example: 123456
guarantor_1:
type: integer
description: 'ID do primeiro fiador'
example: 123456
guarantor_2:
type: integer
description: 'ID do segundo fiador'
example: 123456
billing_auto:
type: string
description: 'Geração automática das faturas de locação: business, active ou inactive'
example: business
ticket_late_fee:
type: boolean
description: 'Multa por atraso'
example: true
ticket_late_fee_item_id:
type: integer
description: 'ID do item de multa'
example: 123456
ticket_late_fee_percentage:
type: number
description: 'Porcentagem da multa'
example: 2.0
ticket_late_fee_interest:
type: number
description: 'Juros da multa'
example: 1.0
ticket_discount:
type: boolean
description: Desconto
example: true
ticket_discount_action:
type: string
description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
example: percentage
ticket_discount_mode:
type: string
description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
example: fixed
ticket_discount_percentage:
type: number
description: 'Porcentagem do desconto'
example: 5.0
ticket_discount_fixed:
type: number
description: 'Valor fixo do desconto'
example: 50.0
ticket_discount_days:
type: integer
description: 'Dias para desconto'
example: 5
termination_fee:
type: number
description: 'Valor da multa de rescisão'
example: 1500.0
termination_fee_months:
type: integer
description: 'Meses de multa'
example: 3
termination_fee_exemption:
type: boolean
description: 'Isenção de multa'
example: false
termination_fee_amount:
type: number
description: 'Valor da multa'
example: 1500.0
deal_id:
type: integer
description: 'ID do negócio'
example: 123456
documentables:
type: array
description: 'Lista de documentos na nova estrutura polimórfica'
example:
-
template_id: 1
content: '...
'
privacy: private
items:
type: string
transfer_mode:
type: string
description: "Modo de transferência.\nValores permitidos:\n- `manually`: Manual\n- `after_receive`: Após Recebimento\n- `fixed_day_or_next`: Em dia Fixo ou Seguinte\n- `fixed_day`: Em dia Fixo"
example: manually
transfer_after_days:
type: integer
description: 'Dias para transferência'
example: 5
transfer_auto:
type: boolean
description: 'Transferência automática'
example: false
fiscal_note_trigger:
type: string
description: 'Modo de emissão da nota fiscal (NONE, BUSINESS, MANUAL, ON_PAYMENT_CONFIRMATION, ON_PAYMENT_NO_CONVERT)'
example: BUSINESS
dimob:
type: boolean
description: DIMOB
example: false
metadata:
type: json
description: Metadados
example: '{"key": "value"}'
required:
- type
- building_id
- tenant_id
- billing_id
- start_at
- recurrency
- amount
- business_id
- account_id
- billing_method
'/financial/contracts/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,reference,deal_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,reference,deal_id'
-
in: query
name: 'include[occupants]'
description: 'Incluir dados dos Ocupantes'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Incluir dados dos Ocupantes'
example: 'id,name,type'
-
in: query
name: 'include[buyers]'
description: 'Incluir dados dos Compradores'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Incluir dados dos Compradores'
example: 'id,name,type'
-
in: query
name: 'include[vehicles]'
description: 'Incluir dados dos Veículos'
example: 'id,brand,model'
required: false
schema:
type: string
description: 'Incluir dados dos Veículos'
example: 'id,brand,model'
-
in: query
name: 'include[tickets]'
description: 'Incluir dados dos Atendimentos'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados dos Atendimentos'
example: 'id,title'
-
in: query
name: 'include[inspects]'
description: 'Incluir dados dos Atendimentos'
example: 'id,type,status'
required: false
schema:
type: string
description: 'Incluir dados dos Atendimentos'
example: 'id,type,status'
-
in: query
name: 'include[business]'
description: 'Incluir dados da Empresa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Empresa'
example: 'id,name'
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel'
example: 'id,title'
-
in: query
name: 'include[billing]'
description: 'Incluir dados da Empresa de Cobrança'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Empresa de Cobrança'
example: 'id,name'
-
in: query
name: 'include[account]'
description: 'Incluir dados da Conta Financeira'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Conta Financeira'
example: 'id,name'
-
in: query
name: 'include[user]'
description: 'Incluir dados do Responsável pelo Contrato'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados do Responsável pelo Contrato'
example: 'id,name'
-
in: query
name: 'include[renewed]'
description: 'Incluir dados do Contrato Pai que gerou este'
example: 'id,deal_id'
required: false
schema:
type: string
description: 'Incluir dados do Contrato Pai que gerou este'
example: 'id,deal_id'
-
in: query
name: 'include[renewedTo]'
description: 'Incluir dados do Contrato Filho que este gerou'
example: 'id,deal_id'
required: false
schema:
type: string
description: 'Incluir dados do Contrato Filho que este gerou'
example: 'id,deal_id'
-
in: query
name: 'include[team]'
description: 'Incluir dados da Equipe de Venda/Locação'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Equipe de Venda/Locação'
example: 'id,name'
-
in: query
name: 'include[tenant]'
description: 'Incluir dados do Inquilino'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados do Inquilino'
example: 'id,name'
-
in: query
name: 'include[owners]'
description: 'Incluir dados dos Proprietários'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados dos Proprietários'
example: 'id,name'
-
in: query
name: 'include[invoices]'
description: 'Incluir dados das Faturas'
example: 'id,amount'
required: false
schema:
type: string
description: 'Incluir dados das Faturas'
example: 'id,amount'
-
in: query
name: 'include[items]'
description: 'Incluir dados dos Itens'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Incluir dados dos Itens'
example: 'id,description,amount'
-
in: query
name: 'include[commissions]'
description: 'Incluir dados das Comissões'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Incluir dados das Comissões'
example: 'id,description,amount'
-
in: query
name: 'include[insurances]'
description: 'Incluir dados dos Seguros'
example: 'id,type,amount'
required: false
schema:
type: string
description: 'Incluir dados dos Seguros'
example: 'id,type,amount'
-
in: query
name: 'include[files]'
description: 'Incluir dados dos Arquivos'
example: 'id,name,url'
required: false
schema:
type: string
description: 'Incluir dados dos Arquivos'
example: 'id,name,url'
-
in: query
name: 'include[documentables]'
description: 'Incluir dados dos Documentos (estrutura documentables)'
example: 'id,template_id,privacy'
required: false
schema:
type: string
description: 'Incluir dados dos Documentos (estrutura documentables)'
example: 'id,template_id,privacy'
-
in: query
name: 'include[deal]'
description: 'Incluir dados do Negócio'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Negócio'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Contratos '
parameters: []
responses: {}
tags:
- 'Financeiro › Contratos'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: "Tipo do contrato.\nValores permitidos:\n- `rent`: Anual\n- `season`: Temporada\n- `sale`: Venda\n- `subscription`: Assinatura"
example: rent
sale_type:
type: string
description: "Tipo de venda.\nValores permitidos:\n- `deed_registration`: Escritura/Registro\n- `financing`: Financiamento\n- `private_document`: Documento Particular\n- `assignment_of_rights`: Cessão de direito"
example: deed_registration
building_id:
type: integer
description: 'ID do Imóvel'
example: 123456
tenant_id:
type: integer
description: 'ID do Inquilino'
example: 123456
billing_id:
type: integer
description: 'ID do método de pagamento'
example: 123456
reference:
type: string
description: 'Código de referência'
example: CONTR-001
active:
type: string
description: "Status de atividade.\nValores permitidos:\n- `active`: Ativo\n- `pre_reserved`: Pré-Reservado\n- `reserved`: Reservado\n- `suspended`: Suspenso\n- `canceled`: Cancelado\n- `finished`: Concluído"
example: active
active_date:
type: string
description: 'Data de alteração da atividade'
example: '2024-01-01'
status:
type: string
description: "Status do contrato.\nValores permitidos:\n- `progress`: Em Andamento\n- `closing`: Encerrando\n- `readjust`: Aguardando Reajuste\n- `renew`: Aguardando Renovação\n- `no_invoices`: Contrato sem Faturas\n- `suspended`: Suspenso\n- `pending`: Pendente\n- `finished`: Finalizado\n- `canceled`: Cancelado\n- `terminating`: Aguardando Rescisão\n- `on_notice`: Em Aviso Prévio\n- `terminated`: Rescindido"
example: active
status_date:
type: string
description: 'Data de alteração do status'
example: '2024-01-01'
payment_status:
type: string
description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 dias\n- `due_10_days`: Vence em 10 dias\n- `nothing`: Nada a pagar\n- `ok`: Pagamento em Dia\n- `5_days`: Menos de 5 dias Vencido\n- `30_days`: Menos de um mês Vencido\n- `month`: Mais de um mês Vencido\n- `3_months`: Mais de três meses Vencido"
example: ok
payment_status_date:
type: string
description: 'Data de alteração do status de pagamento'
example: '2024-01-01'
user_id:
type: integer
description: 'ID do usuário responsável'
example: 123456
agent_id:
type: integer
description: 'ID do corretor'
example: 123456
procurator_id:
type: integer
description: 'ID do procurador'
example: 123456
team_id:
type: integer
description: 'ID da equipe'
example: 123456
access:
type: string
description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
example: all
tag:
type: string
description: Tags
example: importante
guaranteed_transfer:
type: boolean
description: 'Repasse garantido'
example: true
guaranteed_transfer_months:
type: integer
description: 'Meses garantidos no repasse'
example: 12
guaranteed_transfer_release_after_days:
type: integer
description: 'Dias para liberação do repasse'
example: 30
start_at:
type: string
description: 'Data de início'
example: '2024-01-01'
end_at:
type: string
description: 'Data de término'
example: '2024-12-31'
signed_at:
type: string
description: 'Data de assinatura'
example: '2024-01-01'
recurrency:
type: string
description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
example: monthly
recurrency_amount:
type: integer
description: 'Quantidade de recorrências'
example: 12
modality:
type: string
description: "Modalidade.\nValores permitidos:\n- `start`: Início do Contrato\n- `due_date`: Dia de Vencimento\n- `monthly`: Início do Mês"
example: start
amount:
type: number
description: 'Valor do contrato'
example: 1500.0
current_amount:
type: number
description: 'Valor atual do contrato'
example: 1500.0
service_rate_amount:
type: number
description: 'Valor da taxa de serviço'
example: 150.0
total:
type: number
description: 'Valor total'
example: 1650.0
signal_amount:
type: number
description: 'Valor de sinal'
example: 1500.0
refund_amount:
type: number
description: 'Valor de reembolso'
example: 0.0
fiscal_note_withholding:
type: number
description: 'Retenção de nota fiscal'
example: 0.0
due_day:
type: integer
description: 'Dia do vencimento'
example: 5
due_date:
type: string
description: 'Data do vencimento'
example: '2024-01-05'
billing_timing:
type: string
description: 'Momento do faturamento'
example: pre
first_commission:
type: number
description: 'Primeira comissão'
example: 0.0
first_commission_installment:
type: integer
description: 'Parcelas da primeira comissão'
example: 1
recurring_commission:
type: number
description: 'Comissão recorrente'
example: 0.0
add_commission_on_first:
type: boolean
description: 'Adicionar comissão na primeira parcela'
example: false
proportional:
type: boolean
description: Proporcional
example: false
unify_first_invoice:
type: boolean
description: 'Unificar primeira fatura'
example: false
readjust_active:
type: boolean
description: 'Reajuste ativo'
example: true
readjust_indicator:
type: string
description: "Indicador de reajuste.\nValores permitidos:\n- `IGP-M`: IGP-M\n- `INCC-M`: INCC-M\n- `INPC`: INPC\n- `IVAR`: IVAR\n- `IPC-BR`: IPC-BR\n- `IPCA`: IPCA\n- `highest_index`: Maior disponível\n- `lowest_index`: Menor disponível\n- `IPC-FIPE`: IPC-FIPE"
example: IGP-M
readjust_with:
type: integer
description: 'Período de reajuste'
example: 12
readjust_at:
type: string
description: 'Data do reajuste'
example: '2024-01-01'
readjusted_at:
type: string
description: 'Data do último reajuste'
example: '2024-01-01'
guarantee:
type: string
description: Garantia
example: caução
notes:
type: string
description: Observações
example: 'Contrato de aluguel residencial'
clauses:
type: string
description: Cláusulas
example: 'Cláusulas do contrato'
invoice_installment:
type: integer
description: 'Parcelas da fatura'
example: 1
witness_1:
type: integer
description: 'ID da primeira testemunha'
example: 123456
witness_2:
type: integer
description: 'ID da segunda testemunha'
example: 123456
guarantor_1:
type: integer
description: 'ID do primeiro fiador'
example: 123456
guarantor_2:
type: integer
description: 'ID do segundo fiador'
example: 123456
ticket_late_fee:
type: boolean
description: 'Multa por atraso'
example: true
ticket_late_fee_item_id:
type: integer
description: 'ID do item de multa'
example: 123456
ticket_late_fee_percentage:
type: number
description: 'Porcentagem da multa'
example: 2.0
ticket_late_fee_interest:
type: number
description: 'Juros da multa'
example: 1.0
ticket_discount:
type: boolean
description: Desconto
example: true
ticket_discount_action:
type: string
description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
example: percentage
ticket_discount_mode:
type: string
description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
example: fixed
ticket_discount_percentage:
type: number
description: 'Porcentagem do desconto'
example: 5.0
ticket_discount_fixed:
type: number
description: 'Valor fixo do desconto'
example: 50.0
ticket_discount_days:
type: integer
description: 'Dias para desconto'
example: 5
termination_fee:
type: number
description: 'Valor da multa de rescisão'
example: 1500.0
termination_fee_months:
type: integer
description: 'Meses de multa'
example: 3
termination_fee_exemption:
type: boolean
description: 'Isenção de multa'
example: false
termination_fee_amount:
type: number
description: 'Valor da multa'
example: 1500.0
deal_id:
type: integer
description: 'ID do negócio'
example: 123456
business_id:
type: integer
description: 'ID da empresa'
example: 123456
account_id:
type: integer
description: 'ID da conta financeira'
example: 123456
documentables:
type: array
description: 'Lista de documentos na nova estrutura polimórfica'
example:
-
template_id: 1
content: '...
'
privacy: private
items:
type: string
transfer_mode:
type: string
description: "Modo de transferência.\nValores permitidos:\n- `manually`: Manual\n- `after_receive`: Após Recebimento\n- `fixed_day_or_next`: Em dia Fixo ou Seguinte\n- `fixed_day`: Em dia Fixo"
example: manually
transfer_after_days:
type: integer
description: 'Dias para transferência'
example: 5
transfer_auto:
type: boolean
description: 'Transferência automática'
example: false
fiscal_note_trigger:
type: string
description: 'Modo de emissão da nota fiscal (NONE, BUSINESS, MANUAL, ON_PAYMENT_CONFIRMATION, ON_PAYMENT_NO_CONVERT)'
example: BUSINESS
dimob:
type: boolean
description: DIMOB
example: false
metadata:
type: json
description: Metadados
example: '{"key": "value"}'
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Contratos '
parameters: []
responses: {}
tags:
- 'Financeiro › Contratos'
parameters:
-
in: path
name: id
description: 'ID do contrato'
example: 10
required: true
schema:
type: integer
/users/groups:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'filter[id]'
description: 'Código do Grupo.'
example: 1
required: false
schema:
type: integer
description: 'Código do Grupo.'
example: 1
-
in: query
name: 'filter[name]'
description: 'Nome do Grupo.'
example: Corretores
required: false
schema:
type: string
description: 'Nome do Grupo.'
example: Corretores
-
in: query
name: 'filter[type]'
description: 'Tipo de Grupo.'
example: normal
required: false
schema:
type: string
description: 'Tipo de Grupo.'
example: normal
-
in: query
name: 'filter[notes]'
description: Observação.
example: 'Grupo de usuários corretores'
required: false
schema:
type: string
description: Observação.
example: 'Grupo de usuários corretores'
-
in: query
name: 'include[users]'
description: 'Retorna os usuários do grupo.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os usuários do grupo.'
example: 'id,name'
-
in: query
name: 'include[permissions]'
description: 'Retorna as permissões do grupo.'
example: permission
required: false
schema:
type: string
description: 'Retorna as permissões do grupo.'
example: permission
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis que o grupo é responsável.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os imóveis que o grupo é responsável.'
example: 'id,title'
-
in: query
name: 'include[persons]'
description: 'Retorna as pessoas que o grupo é responsável.'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Retorna as pessoas que o grupo é responsável.'
example: 'id,name,type'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de criação de Grupo de Usuários '
parameters: []
responses: {}
tags:
- 'Grupos de Usuários'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Tipo do grupo.'
example: normal
name:
type: string
description: 'Nome do grupo.'
example: 'Corretores - Locação'
notes:
type: string
description: 'Observação para o grupo.'
example: 'Este é um grupo para corretores de locação'
required:
- type
- name
'/users/groups/{id}':
get:
summary: Obter
operationId: obter
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'include[users]'
description: 'Retorna os usuários do grupo.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os usuários do grupo.'
example: 'id,name'
-
in: query
name: 'include[permissions]'
description: 'Retorna as permissões do grupo.'
example: permission
required: false
schema:
type: string
description: 'Retorna as permissões do grupo.'
example: permission
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis que o grupo é responsável.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os imóveis que o grupo é responsável.'
example: 'id,title'
-
in: query
name: 'include[persons]'
description: 'Retorna as pessoas que o grupo é responsável.'
example: 'id,name,type'
required: false
schema:
type: string
description: 'Retorna as pessoas que o grupo é responsável.'
example: 'id,name,type'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de alteração de Grupo de Usuários '
parameters: []
responses: {}
tags:
- 'Grupos de Usuários'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Tipo do grupo.'
example: normal
name:
type: string
description: 'Nome do grupo.'
example: 'Corretores - Locação'
notes:
type: string
description: 'Observação para o grupo.'
example: 'Este é um grupo para corretores de locação'
delete:
summary: Excluir
operationId: excluir
description: ''
parameters: []
responses: {}
tags:
- 'Grupos de Usuários'
parameters:
-
in: path
name: id
description: 'Id do Grupo'
example: 1096
required: true
schema:
type: integer
'/users/groups/{group_id}/duplicate':
post:
summary: Duplicar
operationId: duplicar
description: ''
parameters: []
responses: {}
tags:
- 'Grupos de Usuários'
parameters:
-
in: path
name: group_id
description: 'The ID of the group.'
example: 20
required: true
schema:
type: integer
-
in: path
name: id
description: 'ID do Grupo de Usuário'
example: 16
required: true
schema:
type: integer
/history/types:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'filter[id]'
description: 'ID do tipo.'
example: 1
required: false
schema:
type: integer
description: 'ID do tipo.'
example: 1
-
in: query
name: 'filter[description]'
description: 'ID do tipo.'
example: 1
required: false
schema:
type: integer
description: 'ID do tipo.'
example: 1
-
in: query
name: 'filter[modules]'
description: 'Módulos do tipo.'
example: null
required: false
schema:
type: array
description: 'Módulos do tipo.'
example: null
items:
type: string
-
in: query
name: 'filter[icon]'
description: Ícone.
example: ca-icon-example
required: false
schema:
type: string
description: Ícone.
example: ca-icon-example
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: amount
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: amount
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'type,amount'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'type,amount'
-
in: query
name: 'filter[type]'
description: 'Tipo de finalidade.'
example: sale
required: false
schema:
type: string
description: 'Tipo de finalidade.'
example: sale
-
in: query
name: 'filter[currency]'
description: 'Código da moeda.'
example: BRL
required: false
schema:
type: string
description: 'Código da moeda.'
example: BRL
-
in: query
name: 'filter[amount]'
description: Valor.
example: 1300.0
required: false
schema:
type: number
description: Valor.
example: 1300.0
-
in: query
name: 'filter[amount_original]'
description: 'Valor original quando em promoção.'
example: 1500.0
required: false
schema:
type: number
description: 'Valor original quando em promoção.'
example: 1500.0
-
in: query
name: 'filter[condition]'
description: 'Condição de pagamento.'
example: monthly
required: false
schema:
type: string
description: 'Condição de pagamento.'
example: monthly
-
in: query
name: 'filter[accepts]'
description: 'Opções de pagamento.'
example: FGTS
required: false
schema:
type: string
description: 'Opções de pagamento.'
example: FGTS
-
in: query
name: 'filter[acceptance_notes]'
description: 'Observações para Opções de pagamento.'
example: 'Apenas para Aposentados'
required: false
schema:
type: string
description: 'Observações para Opções de pagamento.'
example: 'Apenas para Aposentados'
-
in: query
name: 'filter[iptu_amount]'
description: 'Valor do IPTU.'
example: 1750.0
required: false
schema:
type: number
description: 'Valor do IPTU.'
example: 1750.0
-
in: query
name: 'filter[iptu_installment]'
description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
example: 8
required: false
schema:
type: integer
description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
example: 8
-
in: query
name: 'filter[condominium]'
description: 'Valor do Condomínio.'
example: 250.0
required: false
schema:
type: number
description: 'Valor do Condomínio.'
example: 250.0
-
in: query
name: 'filter[tax]'
description: 'Valor das taxas.'
example: 100.0
required: false
schema:
type: number
description: 'Valor das taxas.'
example: 100.0
-
in: query
name: 'filter[show_tax]'
description: 'Divulga Taxas.'
example: true
required: false
schema:
type: boolean
description: 'Divulga Taxas.'
example: true
-
in: query
name: 'filter[show]'
description: 'Divulga Finalidade.'
example: false
required: false
schema:
type: boolean
description: 'Divulga Finalidade.'
example: false
-
in: query
name: 'filter[show_pack]'
description: 'Divulga Pacotes de Temporada.'
example: true
required: false
schema:
type: boolean
description: 'Divulga Pacotes de Temporada.'
example: true
-
in: query
name: 'filter[season_low_active]'
description: 'Baixa Temporada Ativa.'
example: false
required: false
schema:
type: boolean
description: 'Baixa Temporada Ativa.'
example: false
-
in: query
name: 'filter[season_low_condition]'
description: 'Condição de pagamento da Baixa Temporada.'
example: daily
required: false
schema:
type: string
description: 'Condição de pagamento da Baixa Temporada.'
example: daily
-
in: query
name: 'filter[season_low_tax]'
description: 'Valor das Taxas da Baixa Temporada.'
example: 100.0
required: false
schema:
type: number
description: 'Valor das Taxas da Baixa Temporada.'
example: 100.0
-
in: query
name: 'filter[season_high_active]'
description: 'Alta Temporada Ativa.'
example: false
required: false
schema:
type: boolean
description: 'Alta Temporada Ativa.'
example: false
-
in: query
name: 'filter[season_high_condition]'
description: 'Condição de pagamento da Alta Temporada.'
example: daily
required: false
schema:
type: string
description: 'Condição de pagamento da Alta Temporada.'
example: daily
-
in: query
name: 'filter[season_high_tax]'
description: 'Valor das Taxas da Alta Temporada.'
example: 150.0
required: false
schema:
type: number
description: 'Valor das Taxas da Alta Temporada.'
example: 150.0
-
in: query
name: 'filter[comission]'
description: 'Porcentagem de Comissão.'
example: 20.0
required: false
schema:
type: number
description: 'Porcentagem de Comissão.'
example: 20.0
-
in: query
name: 'filter[first_commission]'
description: 'Porcentagem da primeira Comissão.'
example: 40.0
required: false
schema:
type: number
description: 'Porcentagem da primeira Comissão.'
example: 40.0
-
in: query
name: 'filter[iptu_free]'
description: 'IPTU isento.'
example: true
required: false
schema:
type: boolean
description: 'IPTU isento.'
example: true
-
in: query
name: 'filter[condominium_free]'
description: 'Condomínio isento.'
example: false
required: false
schema:
type: boolean
description: 'Condomínio isento.'
example: false
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel .'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel .'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Finalidades'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Tipo de finalidade.'
example: sale
currency:
type: string
description: 'Código da moeda.'
example: BRL
amount:
type: number
description: Valor.
example: 1300.0
amount_original:
type: number
description: 'Valor original; preenchido liga a promoção e o amount passa a ser o valor promocional.'
example: 1500.0
discount_type:
type: string
description: "Legado: use amount_original. Quando vier com discount e sem amount_original, é convertido (amount_original = amount informado; amount = valor com desconto, 'value' em R$ ou 'percentage' em %)."
example: percentage
discount:
type: number
description: 'Legado: valor do desconto de discount_type; convertido como descrito acima.'
example: 10.0
amount_max:
type: number
description: 'Valor da alta temporada (somente temporada).'
example: 1500.0
condition:
type: string
description: 'Condição de pagamento.'
example: monthly
accepts:
type: string
description: 'Opções de pagamento.'
example: FGTS
acceptance_notes:
type: string
description: 'Observações para Opções de pagamento.'
example: 'Apenas para Aposentados'
iptu_amount:
type: number
description: 'Valor do IPTU.'
example: 1750.0
iptu_installment:
type: integer
description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
example: 6
condominium:
type: number
description: 'Valor do Condomínio.'
example: 250.0
tax:
type: number
description: 'Valor das taxas.'
example: 100.0
show_tax:
type: boolean
description: 'Divulga Taxas.'
example: false
show:
type: boolean
description: 'Divulga Finalidade.'
example: true
show_pack:
type: boolean
description: 'Divulga Pacotes de Temporada.'
example: false
season_low_active:
type: boolean
description: 'Baixa Temporada Ativa.'
example: false
season_low_condition:
type: string
description: 'Condição de pagamento da Baixa Temporada.'
example: daily
season_low_tax:
type: number
description: 'Valor das Taxas da Baixa Temporada.'
example: 100.0
season_high_active:
type: boolean
description: 'Alta Temporada Ativa.'
example: true
season_high_condition:
type: string
description: 'Condição de pagamento da Alta Temporada.'
example: daily
season_high_tax:
type: number
description: 'Valor das Taxas da Alta Temporada.'
example: 150.0
comission:
type: number
description: 'Porcentagem de Comissão.'
example: 20.0
first_commission:
type: number
description: 'Porcentagem da primeira Comissão.'
example: 40.0
iptu_free:
type: boolean
description: 'IPTU isento.'
example: true
condominium_free:
type: boolean
description: 'Condomínio isento.'
example: false
sendCreateNotifications:
type: boolean
description: 'Envia notificações de criação.'
example: true
parameters:
-
in: path
name: building_id
description: 'ID do imóvel'
example: 14
required: true
schema:
type: integer
'/buildings/{building_id}/purposes/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: amount
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: amount
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'type,amount'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'type,amount'
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel .'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel .'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Finalidades'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Tipo de finalidade.'
example: sale
currency:
type: string
description: 'Código da moeda.'
example: BRL
amount:
type: number
description: Valor.
example: 1300.0
amount_original:
type: number
description: 'Valor original; preenchido liga a promoção e o amount passa a ser o valor promocional.'
example: 1500.0
discount_type:
type: string
description: "Legado: use amount_original. Quando vier com discount e sem amount_original, é convertido (amount_original = amount informado; amount = valor com desconto, 'value' em R$ ou 'percentage' em %)."
example: percentage
discount:
type: number
description: 'Legado: valor do desconto de discount_type; convertido como descrito acima.'
example: 10.0
amount_max:
type: number
description: 'Valor da alta temporada (somente temporada).'
example: 1500.0
condition:
type: string
description: 'Condição de pagamento.'
example: monthly
accepts:
type: string
description: 'Opções de pagamento.'
example: FGTS
acceptance_notes:
type: string
description: 'Observações para Opções de pagamento.'
example: 'Apenas para Aposentados'
iptu_amount:
type: number
description: 'Valor do IPTU.'
example: 1750.0
iptu_installment:
type: integer
description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
example: 11
condominium:
type: number
description: 'Valor do Condomínio.'
example: 250.0
tax:
type: number
description: 'Valor das taxas.'
example: 100.0
show_tax:
type: boolean
description: 'Divulga Taxas.'
example: true
show:
type: boolean
description: 'Divulga Finalidade.'
example: false
show_pack:
type: boolean
description: 'Divulga Pacotes de Temporada.'
example: false
season_low_active:
type: boolean
description: 'Baixa Temporada Ativa.'
example: true
season_low_condition:
type: string
description: 'Condição de pagamento da Baixa Temporada.'
example: daily
season_low_tax:
type: number
description: 'Valor das Taxas da Baixa Temporada.'
example: 100.0
season_high_active:
type: boolean
description: 'Alta Temporada Ativa.'
example: true
season_high_condition:
type: string
description: 'Condição de pagamento da Alta Temporada.'
example: daily
season_high_tax:
type: number
description: 'Valor das Taxas da Alta Temporada.'
example: 150.0
comission:
type: number
description: 'Porcentagem de Comissão.'
example: 20.0
first_commission:
type: number
description: 'Porcentagem da primeira Comissão.'
example: 40.0
iptu_free:
type: boolean
description: 'IPTU isento.'
example: true
condominium_free:
type: boolean
description: 'Condomínio isento.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Finalidades'
parameters:
-
in: path
name: building_id
description: 'ID do imóvel'
example: 4
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the purpose.'
example: mollitia
required: true
schema:
type: string
-
in: path
name: type
description: 'string Tipo de Finalidade'
example: sale
required: true
schema:
type: string
'/buildings/{building_id}/unavailabity':
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,finandial_contract_id,date'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,finandial_contract_id,date'
-
in: query
name: 'filter[id]'
description: 'ID da data indisponível.'
example: 1
required: false
schema:
type: integer
description: 'ID da data indisponível.'
example: 1
-
in: query
name: 'filter[date]'
description: Data.
example: 21/04/2021
required: false
schema:
type: string
description: Data.
example: 21/04/2021
-
in: query
name: 'filter[contract_id]'
description: 'ID do contrato atrelado.'
example: 321321
required: false
schema:
type: integer
description: 'ID do contrato atrelado.'
example: 321321
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel atrelado.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel atrelado.'
example: 'id,title'
-
in: query
name: 'include[contract]'
description: 'Retorna os dados do contrato atrelado.'
example: 'id,type,status'
required: false
schema:
type: string
description: 'Retorna os dados do contrato atrelado.'
example: 'id,type,status'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,position,title,building_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,position,title,building_id'
-
in: query
name: 'filter[id]'
description: 'ID da aba.'
example: 1
required: false
schema:
type: integer
description: 'ID da aba.'
example: 1
-
in: query
name: 'filter[title]'
description: 'Título da Aba.'
example: Características
required: false
schema:
type: string
description: 'Título da Aba.'
example: Características
-
in: query
name: 'filter[position]'
description: 'Ordem (crescente).'
example: 1
required: false
schema:
type: integer
description: 'Ordem (crescente).'
example: 1
-
in: query
name: 'filter[content]'
description: 'HTML do conteúdo.'
example: '3 Quartos
'
required: false
schema:
type: string
description: 'HTML do conteúdo.'
example: '3 Quartos
'
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Abas'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título da Aba.'
example: Características
position:
type: integer
description: 'Ordem (crescente).'
example: 1
content:
type: string
description: 'HTML do conteúdo.'
example: '3 Quartos
'
parameters:
-
in: path
name: building_id
description: 'ID do imóvel.'
example: 8
required: true
schema:
type: integer
'/buildings/{building_id}/tabs/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,position,title,building_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,position,title,building_id'
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Abas'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título da Aba.'
example: Características
position:
type: integer
description: 'Ordem (crescente).'
example: 1
content:
type: string
description: 'HTML do conteúdo.'
example: '3 Quartos
'
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Abas'
parameters:
-
in: path
name: building_id
description: 'ID do imóvel.'
example: 1
required: true
schema:
type: integer
-
in: path
name: id
description: 'ID da Aba.'
example: 4
required: true
schema:
type: integer
'/buildings/{building_id}/seasonPacks':
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,amount'
-
in: query
name: 'filter[id]'
description: 'ID do pacote.'
example: 123
required: false
schema:
type: integer
description: 'ID do pacote.'
example: 123
-
in: query
name: 'filter[currency]'
description: 'Código da moeda.'
example: BRL
required: false
schema:
type: string
description: 'Código da moeda.'
example: BRL
-
in: query
name: 'filter[description]'
description: Descrição.
example: 'Pacote de Carnaval'
required: false
schema:
type: string
description: Descrição.
example: 'Pacote de Carnaval'
-
in: query
name: 'filter[amount]'
description: Valor.
example: 5000.0
required: false
schema:
type: number
description: Valor.
example: 5000.0
-
in: query
name: 'filter[starts_at]'
description: 'Data de início.'
example: 07/02/2021
required: false
schema:
type: string
description: 'Data de início.'
example: 07/02/2021
-
in: query
name: 'filter[ends_at]'
description: 'Data de fim.'
example: 21/02/2021
required: false
schema:
type: string
description: 'Data de fim.'
example: 21/02/2021
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Pacote de Temporadas'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
currency:
type: string
description: 'Código da moeda.'
example: BRL
description:
type: string
description: Descrição.
example: 'Pacote de Carnaval'
amount:
type: number
description: Valor.
example: 5000.0
starts_at:
type: string
description: 'Data de início.'
example: 07/02/2021
ends_at:
type: string
description: 'Data de fim.'
example: 21/02/2021
parameters:
-
in: path
name: building_id
description: 'ID do imóvel'
example: 12
required: true
schema:
type: integer
'/buildings/{building_id}/seasonPacks/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description,amount'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description,amount'
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Pacote de Temporadas'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
currency:
type: string
description: 'Código da moeda.'
example: BRL
description:
type: string
description: Descrição.
example: 'Pacote de Carnaval'
amount:
type: number
description: Valor.
example: 5000.0
starts_at:
type: string
description: 'Data de início.'
example: 07/02/2021
ends_at:
type: string
description: 'Data de fim.'
example: 21/02/2021
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Pacote de Temporadas'
parameters:
-
in: path
name: building_id
description: 'ID do imóvel.'
example: 8
required: true
schema:
type: integer
-
in: path
name: id
description: 'ID do Pacote de Temporada.'
example: 9
required: true
schema:
type: integer
/buildings/stages:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: position
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: position
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,percentage'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,percentage'
-
in: query
name: 'filter[id]'
description: 'ID do estágio. Example:'
example: 14
required: false
schema:
type: integer
description: 'ID do estágio. Example:'
example: 14
-
in: query
name: 'filter[description]'
description: 'Descrição. Example:'
example: et
required: false
schema:
type: string
description: 'Descrição. Example:'
example: et
-
in: query
name: 'filter[percentage_active]'
description: 'Utilizar porcentagem para obra.'
example: false
required: false
schema:
type: boolean
description: 'Utilizar porcentagem para obra.'
example: false
-
in: query
name: 'filter[percentage]'
description: 'Porcentagem da Obra.'
example: 80
required: false
schema:
type: integer
description: 'Porcentagem da Obra.'
example: 80
-
in: query
name: 'filter[position]'
description: 'Ordem dos estágios com porcentagem.'
example: 2
required: false
schema:
type: integer
description: 'Ordem dos estágios com porcentagem.'
example: 2
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis no estágio.'
example: 'id,title,type_id'
required: false
schema:
type: string
description: 'Retorna os imóveis no estágio.'
example: 'id,title,type_id'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Estágio de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Estágios'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição. Example:'
example: 'Aut consequatur officia et temporibus.'
percentage_active:
type: boolean
description: 'Utilizar porcentagem para obra.'
example: false
percentage:
type: integer
description: 'Porcentagem da Obra.'
example: 80
position:
type: integer
description: 'Ordem dos estágios com porcentagem.'
example: 2
required:
- description
'/buildings/stages/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: position
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: position
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,percentage'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description,percentage'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis no estágio.'
example: 'id,title,type_id'
required: false
schema:
type: string
description: 'Retorna os imóveis no estágio.'
example: 'id,title,type_id'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Estágio de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Estágios'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição. Example:'
example: 'Eos dolore nulla voluptas quia quas voluptatem nulla natus.'
percentage_active:
type: boolean
description: 'Utilizar porcentagem para obra.'
example: false
percentage:
type: integer
description: 'Porcentagem da Obra.'
example: 80
position:
type: integer
description: 'Ordem dos estágios com porcentagem.'
example: 2
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Estágio de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Estágios'
parameters:
-
in: path
name: id
description: 'ID do estágio.'
example: 9
required: true
schema:
type: integer
/buildings/keys/keyMovements:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,person_id,tax_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,person_id,tax_id'
-
in: query
name: 'filter[id]'
description: 'ID da movimentação de chave.'
example: 1
required: false
schema:
type: integer
description: 'ID da movimentação de chave.'
example: 1
-
in: query
name: 'filter[key_id]'
description: 'ID da chave.'
example: 12
required: false
schema:
type: integer
description: 'ID da chave.'
example: 12
-
in: query
name: 'filter[person_id]'
description: 'ID do solicitante.'
example: 12
required: false
schema:
type: integer
description: 'ID do solicitante.'
example: 12
-
in: query
name: 'filter[user_id]'
description: 'ID do corretor responsável.'
example: 123
required: false
schema:
type: integer
description: 'ID do corretor responsável.'
example: 123
-
in: query
name: 'filter[returned]'
description: 'Se a chave foi devolvida.'
example: true
required: false
schema:
type: boolean
description: 'Se a chave foi devolvida.'
example: true
-
in: query
name: 'filter[taked_at]'
description: 'Quando a pessoa retirou.'
example: 20/04/2021
required: false
schema:
type: string
description: 'Quando a pessoa retirou.'
example: 20/04/2021
-
in: query
name: 'filter[returned_at]'
description: 'Quando a pessoa devolveu.'
example: 30/04/2021
required: false
schema:
type: string
description: 'Quando a pessoa devolveu.'
example: 30/04/2021
-
in: query
name: 'filter[return_prevision]'
description: 'Previsão de devolução.'
example: 30/04/2021
required: false
schema:
type: string
description: 'Previsão de devolução.'
example: 30/04/2021
-
in: query
name: 'filter[person_name]'
description: 'Nome do solicitante.'
example: Rogério
required: false
schema:
type: string
description: 'Nome do solicitante.'
example: Rogério
-
in: query
name: 'filter[person_phone]'
description: 'telefone do solicitante.'
example: '(47) 92860-8431'
required: false
schema:
type: string
description: 'telefone do solicitante.'
example: '(47) 92860-8431'
-
in: query
name: 'filter[person_tax_id]'
description: 'CPF do solicitante.'
example: 365.277.520-16
required: false
schema:
type: string
description: 'CPF do solicitante.'
example: 365.277.520-16
-
in: query
name: 'filter[person_zip_code]'
description: 'CEP do solicitante.'
example: 69316-038
required: false
schema:
type: string
description: 'CEP do solicitante.'
example: 69316-038
-
in: query
name: 'filter[country_id]'
description: 'ID de País do solicitante.'
example: 1
required: false
schema:
type: integer
description: 'ID de País do solicitante.'
example: 1
-
in: query
name: 'filter[state_id]'
description: 'ID de Estado do solicitante.'
example: 22
required: false
schema:
type: integer
description: 'ID de Estado do solicitante.'
example: 22
-
in: query
name: 'filter[city_id]'
description: 'ID de Cidade do solicitante.'
example: 7375
required: false
schema:
type: integer
description: 'ID de Cidade do solicitante.'
example: 7375
-
in: query
name: 'filter[district_id]'
description: 'ID de Bairro do solicitante.'
example: 35040
required: false
schema:
type: integer
description: 'ID de Bairro do solicitante.'
example: 35040
-
in: query
name: 'filter[street]'
description: 'Rua do solicitante.'
example: 'Rua Z-Y'
required: false
schema:
type: string
description: 'Rua do solicitante.'
example: 'Rua Z-Y'
-
in: query
name: 'filter[number]'
description: 'Complemento do solicitante.'
example: Apartamento
required: false
schema:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
-
in: query
name: 'filter[complement]'
description: 'Complemento do solicitante.'
example: Apartamento
required: false
schema:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
-
in: query
name: 'filter[notes]'
description: Observações.
example: 'Cliente é de outra cidade'
required: false
schema:
type: string
description: Observações.
example: 'Cliente é de outra cidade'
-
in: query
name: 'include[user]'
description: 'Retorna dados do corretor responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna dados do corretor responsável.'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna dados do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna dados do solicitante.'
example: 'id,name'
-
in: query
name: 'include[key]'
description: 'Retorna dados da chave.'
example: 'id,description,reference'
required: false
schema:
type: string
description: 'Retorna dados da chave.'
example: 'id,description,reference'
-
in: query
name: 'include[country]'
description: 'Retorna o país do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o país do solicitante.'
example: 'id,name'
-
in: query
name: 'include[city]'
description: 'Retorna a cidade do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a cidade do solicitante.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna o estado do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o estado do solicitante.'
example: 'id,name'
-
in: query
name: 'include[district]'
description: 'Retorna o bairro do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o bairro do solicitante.'
example: 'id,name'
-
in: query
name: 'include[image]'
description: 'Retorna a imagem do solicitante.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a imagem do solicitante.'
example: file_name
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves '
parameters: []
responses: {}
tags:
- 'Imóveis › Movimentação de Chaves'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
key_id:
type: integer
description: 'ID da chave.'
example: 12
person_id:
type: integer
description: 'ID do solicitante.'
example: 12
user_id:
type: integer
description: 'ID do corretor responsável.'
example: 123
returned:
type: boolean
description: 'Se a chave foi devolvida.'
example: true
taked_at:
type: string
description: 'Quando a pessoa retirou.'
example: 20/04/2021
returned_at:
type: string
description: 'Quando a pessoa devolveu.'
example: 30/04/2021
return_prevision:
type: string
description: 'Previsão de devolução.'
example: 30/04/2021
person_name:
type: string
description: 'Nome do solicitante.'
example: Rogério
person_phone:
type: string
description: 'telefone do solicitante.'
example: '(47) 92860-8431'
person_tax_id:
type: string
description: 'CPF do solicitante.'
example: 365.277.520-16
person_zip_code:
type: string
description: 'CEP do solicitante.'
example: 69316-038
country_id:
type: integer
description: 'ID de País do solicitante.'
example: 1
state_id:
type: integer
description: 'ID de Estado do solicitante.'
example: 22
city_id:
type: integer
description: 'ID de Cidade do solicitante.'
example: 7375
district_id:
type: integer
description: 'ID de Bairro do solicitante.'
example: 35040
street:
type: string
description: 'Rua do solicitante.'
example: 'Rua Z-Y'
number:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
complement:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
notes:
type: string
description: Observações.
example: 'Cliente é de outra cidade'
required:
- key_id
- user_id
- taked_at
- person_name
- person_phone
- person_tax_id
'/buildings/keys/keyMovements/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,person_id,tax_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,person_id,tax_id'
-
in: query
name: 'include[user]'
description: 'Retorna dados do corretor responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna dados do corretor responsável.'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna dados do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna dados do solicitante.'
example: 'id,name'
-
in: query
name: 'include[key]'
description: 'Retorna dados da chave.'
example: 'id,description,reference'
required: false
schema:
type: string
description: 'Retorna dados da chave.'
example: 'id,description,reference'
-
in: query
name: 'include[country]'
description: 'Retorna o país do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o país do solicitante.'
example: 'id,name'
-
in: query
name: 'include[city]'
description: 'Retorna a cidade do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a cidade do solicitante.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna o estado do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o estado do solicitante.'
example: 'id,name'
-
in: query
name: 'include[district]'
description: 'Retorna o bairro do solicitante.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o bairro do solicitante.'
example: 'id,name'
-
in: query
name: 'include[image]'
description: 'Retorna a imagem do solicitante.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a imagem do solicitante.'
example: file_name
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves '
parameters: []
responses: {}
tags:
- 'Imóveis › Movimentação de Chaves'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
key_id:
type: integer
description: 'ID da chave.'
example: 12
person_id:
type: integer
description: 'ID do solicitante.'
example: 12
user_id:
type: integer
description: 'ID do corretor responsável.'
example: 123
returned:
type: boolean
description: 'Se a chave foi devolvida.'
example: true
taked_at:
type: string
description: 'Quando a pessoa retirou.'
example: 20/04/2021
returned_at:
type: string
description: 'Quando a pessoa devolveu.'
example: 30/04/2021
return_prevision:
type: string
description: 'Previsão de devolução.'
example: 30/04/2021
person_name:
type: string
description: 'Nome do solicitante.'
example: Rogério
person_phone:
type: string
description: 'telefone do solicitante.'
example: '(47) 92860-8431'
person_tax_id:
type: string
description: 'CPF do solicitante.'
example: 365.277.520-16
person_zip_code:
type: string
description: 'CEP do solicitante.'
example: 69316-038
country_id:
type: integer
description: 'ID de País do solicitante.'
example: 1
state_id:
type: integer
description: 'ID de Estado do solicitante.'
example: 22
city_id:
type: integer
description: 'ID de Cidade do solicitante.'
example: 7375
district_id:
type: integer
description: 'ID de Bairro do solicitante.'
example: 35040
street:
type: string
description: 'Rua do solicitante.'
example: 'Rua Z-Y'
number:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
complement:
type: string
description: 'Complemento do solicitante.'
example: Apartamento
notes:
type: string
description: Observações.
example: 'Cliente é de outra cidade'
delete:
summary: Excluir
operationId: excluir
description: "\n🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves "
parameters: []
responses: {}
tags:
- 'Imóveis › Movimentação de Chaves'
parameters:
-
in: path
name: id
description: 'ID da Movimentação de Chaves .'
example: 2
required: true
schema:
type: integer
'/buildings/returnKey/{movement_id}':
get:
summary: Devolver
operationId: devolver
description: '🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves '
parameters:
-
in: query
name: date
description: 'Data da devolução.'
example: '10/05/2021 11:21:35'
required: false
schema:
type: string
description: 'Data da devolução.'
example: '10/05/2021 11:21:35'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de gerenciamento do Claviculário "
parameters: []
responses: {}
tags:
- 'Imóveis › Claviculário'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
key_id:
type: integer
description: 'ID da chave.'
example: 15
board_id:
type: integer
description: 'ID do claviculário, vazio para retirar a chave do quadro.'
example: 1
row:
type: integer
description: 'Linha do gancho, começando em 1 (letra A).'
example: 3
column:
type: integer
description: 'Coluna do gancho, começando em 1.'
example: 7
required:
- key_id
/buildings/keys/boards:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária a permissão de acesso ao Claviculário '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: position
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: position
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,total_rows'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,total_rows'
-
in: query
name: 'filter[id]'
description: 'ID do claviculário.'
example: 1
required: false
schema:
type: integer
description: 'ID do claviculário.'
example: 1
-
in: query
name: 'filter[title]'
description: 'Nome do claviculário.'
example: Locação
required: false
schema:
type: string
description: 'Nome do claviculário.'
example: Locação
-
in: query
name: 'filter[active]'
description: 'Somente claviculários ativos.'
example: true
required: false
schema:
type: boolean
description: 'Somente claviculários ativos.'
example: true
-
in: query
name: 'include[keys]'
description: 'Retorna as chaves posicionadas no claviculário.'
example: 'id,reference,board_row,board_column'
required: false
schema:
type: string
description: 'Retorna as chaves posicionadas no claviculário.'
example: 'id,reference,board_row,board_column'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de gerenciamento do Claviculário '
parameters: []
responses: {}
tags:
- 'Imóveis › Claviculário'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Nome do claviculário.'
example: Locação
total_rows:
type: integer
description: 'Quantidade de linhas, rotuladas de A a Z.'
example: 5
total_columns:
type: integer
description: 'Quantidade de colunas, numeradas a partir de 1.'
example: 20
position:
type: integer
description: 'Ordem de exibição.'
example: 0
active:
type: boolean
description: 'Claviculário ativo.'
example: true
required:
- title
- total_rows
- total_columns
'/buildings/keys/boards/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária a permissão de acesso ao Claviculário '
parameters:
-
in: query
name: 'include[keys]'
description: 'Retorna as chaves posicionadas no claviculário.'
example: 'id,reference,board_row,board_column'
required: false
schema:
type: string
description: 'Retorna as chaves posicionadas no claviculário.'
example: 'id,reference,board_row,board_column'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de gerenciamento do Claviculário '
parameters: []
responses: {}
tags:
- 'Imóveis › Claviculário'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Nome do claviculário.'
example: Locação
total_rows:
type: integer
description: 'Quantidade de linhas, rotuladas de A a Z.'
example: 5
total_columns:
type: integer
description: 'Quantidade de colunas, numeradas a partir de 1.'
example: 20
position:
type: integer
description: 'Ordem de exibição.'
example: 0
active:
type: boolean
description: 'Claviculário ativo.'
example: true
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de gerenciamento do Claviculário '
parameters: []
responses: {}
tags:
- 'Imóveis › Claviculário'
parameters:
-
in: path
name: id
description: 'ID do claviculário.'
example: 18
required: true
schema:
type: integer
/buildings/keys:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: principal
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: principal
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,is_with,principal'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,is_with,principal'
-
in: query
name: 'filter[id]'
description: 'ID da chave.'
example: 123
required: false
schema:
type: integer
description: 'ID da chave.'
example: 123
-
in: query
name: 'filter[building_id]'
description: 'ID do imóvel.'
example: 11111
required: false
schema:
type: integer
description: 'ID do imóvel.'
example: 11111
-
in: query
name: 'filter[reference]'
description: 'Referência da chave.'
example: CHA01
required: false
schema:
type: string
description: 'Referência da chave.'
example: CHA01
-
in: query
name: 'filter[description]'
description: 'Descrição da chave.'
example: 'Chave da Suíte'
required: false
schema:
type: string
description: 'Descrição da chave.'
example: 'Chave da Suíte'
-
in: query
name: 'filter[is_with]'
description: 'Com quem a chave está.'
example: proprietary
required: false
schema:
type: string
description: 'Com quem a chave está.'
example: proprietary
-
in: query
name: 'filter[principal]'
description: 'Chave principal.'
example: false
required: false
schema:
type: boolean
description: 'Chave principal.'
example: false
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
-
in: query
name: 'include[movements]'
description: 'Retorna as movimentações da chave.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna as movimentações da chave.'
example: 'id,title'
-
in: query
name: 'include[activeMovements]'
description: 'Retorna as movimentações ativas da chave.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna as movimentações ativas da chave.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Chaves '
parameters: []
responses: {}
tags:
- 'Imóveis › Chaves'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 11111
reference:
type: string
description: 'Referência da chave.'
example: CHA01
description:
type: string
description: 'Descrição da chave.'
example: 'Chave da Suíte'
is_with:
type: string
description: 'Com quem a chave está.'
example: proprietary
principal:
type: boolean
description: 'Chave principal.'
example: false
parameters:
-
in: path
name: building
description: 'Optional parameter. ID do imóvel.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 15
'/buildings/keys/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: principal
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: principal
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,is_with,principal'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,is_with,principal'
-
in: query
name: 'include[building]'
description: 'Retorna os dados do imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do imóvel.'
example: 'id,title'
-
in: query
name: 'include[movements]'
description: 'Retorna as movimentações da chave.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna as movimentações da chave.'
example: 'id,title'
-
in: query
name: 'include[activeMovements]'
description: 'Retorna as movimentações ativas da chave.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna as movimentações ativas da chave.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Chaves '
parameters: []
responses: {}
tags:
- 'Imóveis › Chaves'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 11111
reference:
type: string
description: 'Referência da chave.'
example: CHA01
description:
type: string
description: 'Descrição da chave.'
example: 'Chave da Suíte'
is_with:
type: string
description: 'Com quem a chave está.'
example: proprietary
principal:
type: boolean
description: 'Chave principal.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Chaves '
parameters: []
responses: {}
tags:
- 'Imóveis › Chaves'
parameters:
-
in: path
name: id
description: 'ID da Chave.'
example: 7
required: true
schema:
type: integer
/buildings/details:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description'
-
in: query
name: 'filter[id]'
description: 'ID do detalhe.'
example: 1
required: false
schema:
type: integer
description: 'ID do detalhe.'
example: 1
-
in: query
name: 'filter[group_id]'
description: 'ID do detalhe.'
example: 3
required: false
schema:
type: integer
description: 'ID do detalhe.'
example: 3
-
in: query
name: 'filter[description]'
description: 'ID do detalhe.'
example: 0
required: false
schema:
type: integer
description: 'ID do detalhe.'
example: 0
-
in: query
name: 'filter[default]'
description: 'Detalhe padrão.'
example: false
required: false
schema:
type: boolean
description: 'Detalhe padrão.'
example: false
-
in: query
name: 'include[group]'
description: 'Retorna os dados do grupo de detalhe.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do grupo de detalhe.'
example: 'id,description'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
example: minima
required: false
schema:
type: string
description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
example: minima
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Detalhes'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: 'ID do detalhe.'
example: 1
group_id:
type: integer
description: 'ID do detalhe.'
example: 3
description:
type: integer
description: 'ID do detalhe.'
example: 0
default:
type: boolean
description: 'Detalhe padrão.'
example: false
'/buildings/details/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description'
-
in: query
name: 'include[group]'
description: 'Retorna os dados do grupo de detalhe.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do grupo de detalhe.'
example: 'id,description'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
example: corporis
required: false
schema:
type: string
description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
example: corporis
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Detalhes'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: 'ID do detalhe.'
example: 1
group_id:
type: integer
description: 'ID do detalhe.'
example: 3
description:
type: integer
description: 'ID do detalhe.'
example: 0
default:
type: boolean
description: 'Detalhe padrão.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Detalhes'
parameters:
-
in: path
name: id
description: 'ID do Detalhe.'
example: 2
required: true
schema:
type: integer
/buildings/detailGroups:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'filter[id]'
description: 'ID do grupo de detalhe.'
example: 11
required: false
schema:
type: integer
description: 'ID do grupo de detalhe.'
example: 11
-
in: query
name: 'filter[description]'
description: Descrição.
example: Decorações
required: false
schema:
type: string
description: Descrição.
example: Decorações
-
in: query
name: 'include[details]'
description: 'Traz os detalhes do grupo.'
example: 'id,description'
required: false
schema:
type: string
description: 'Traz os detalhes do grupo.'
example: 'id,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Grupo de Detalhes'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: Descrição.
example: Decorações
required:
- description
'/buildings/detailGroups/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,description'
-
in: query
name: 'include[details]'
description: 'Traz os detalhes do grupo.'
example: 'id,description'
required: false
schema:
type: string
description: 'Traz os detalhes do grupo.'
example: 'id,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Grupo de Detalhes'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: Descrição.
example: Decorações
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Grupo de Detalhes'
parameters:
-
in: path
name: id
description: 'ID do Grupo de Detalhe'
example: 20
required: true
schema:
type: integer
'/buildings/approve/{building_id}':
put:
summary: Aprovar
operationId: aprovar
description: ''
parameters: []
responses: {}
tags:
- Imóveis
parameters:
-
in: path
name: building_id
description: 'ID do imóvel'
example: 16
required: true
schema:
type: integer
'/buildings/{building_id}/duplicate':
post:
summary: Duplicar
operationId: duplicar
description: '🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis '
parameters: []
responses: {}
tags:
- Imóveis
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
medias:
type: boolean
description: 'Define se duplica as mídias do imóvel'
example: false
keys:
type: boolean
description: 'Define se duplica as chaves do imóvel'
example: false
season_packs:
type: boolean
description: 'Define se duplica os pacotes de temporada'
example: true
unavailable_dates:
type: boolean
description: 'Define se duplica os dias indisponíveis'
example: true
parameters:
-
in: path
name: building_id
description: 'ID do Imóvel'
example: 7
required: true
schema:
type: integer
/buildings/media/analyze:
post:
summary: 'Analisar imagens enviadas'
operationId: analisarImagensEnviadas
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
batch_id:
type: string
description: 'Identificador do lote.'
example: 8f1c1e2a
files:
type: array
description: 'Arquivos temporários enviados.'
example:
- []
items:
type: object
required:
- batch_id
- files
/buildings/media/move:
post:
summary: 'Mover imagem de galeria'
operationId: moverImagemDeGaleria
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_id:
type: integer
description: 'ID da imagem.'
example: 10
collection:
type: string
description: 'Galeria de destino.'
example: images
required:
- building_id
- media_id
- collection
/buildings/media/enhance:
post:
summary: 'Melhorar imagens'
operationId: melhorarImagens
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_ids:
type: array
description: 'IDs das imagens.'
example:
- 10
- 11
items:
type: integer
instructions:
type: string
description: 'Instruções adicionais.'
example: 'iluminação mais quente'
required:
- building_id
- media_ids
/buildings/media/undo-enhance:
post:
summary: 'Desfazer a melhoria'
operationId: desfazerAMelhoria
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_id:
type: integer
description: 'ID da imagem melhorada.'
example: 12
required:
- building_id
- media_id
/buildings/media/decorate:
post:
summary: 'Gerar variações decoradas'
operationId: gerarVariaesDecoradas
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_ids:
type: array
description: 'IDs das fotos escolhidas.'
example:
- 10
- 11
items:
type: integer
mode:
type: string
description: 'O que fazer com as fotos.'
example: furnish
style:
type: string
description: 'Estilo de decoração.'
example: minimalist
add:
type: array
description: 'Elementos a adicionar na cena.'
example:
- plants
items:
type: string
remove:
type: array
description: 'Elementos a remover da cena.'
example:
- people
items:
type: string
instructions:
type: string
description: 'Detalhes adicionais aplicados a todas as fotos.'
example: 'tons quentes'
notes:
type: object
description: 'Ajuste escrito numa foto só, no formato {media_id: texto}.'
example:
10: 'trocar as árvores por palmeiras'
properties: {}
variations:
type: integer
description: 'Variações por foto (1 a 4).'
example: 2
required:
- building_id
- media_ids
- mode
/buildings/media/variations:
post:
summary: 'Listar variações pendentes'
operationId: listarVariaesPendentes
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
required:
- building_id
/buildings/media/publish-variation:
post:
summary: 'Publicar uma variação'
operationId: publicarUmaVariao
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_id:
type: integer
description: 'ID da variação.'
example: 30
required:
- building_id
- media_id
/buildings/media/discard-variation:
post:
summary: 'Descartar uma variação'
operationId: descartarUmaVariao
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_id:
type: integer
description: 'ID da variação.'
example: 30
required:
- building_id
- media_id
/buildings/media/approve-previews:
post:
summary: 'Aprovar prévias de melhoria'
operationId: aprovarPrviasDeMelhoria
description: '🔒 Necessárias as permissões de edição de Imóveis e de Tarefas de IA '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
media_ids:
type: array
description: 'IDs das prévias.'
example:
- 30
- 31
items:
type: integer
required:
- building_id
- media_ids
/buildings/media/suggest-details:
post:
summary: 'Sugerir características a partir das fotos'
operationId: sugerirCaractersticasAPartirDasFotos
description: '🔒 Necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- 'Imóveis › Mídia'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do imóvel.'
example: 1
required:
- building_id
/buildings:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,slug,type_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,slug,type_id'
-
in: query
name: 'filter[id]'
description: 'ID do imóvel.'
example: 1
required: false
schema:
type: integer
description: 'ID do imóvel.'
example: 1
-
in: query
name: 'filter[id2]'
description: 'ID visível do imóvel.'
example: 11
required: false
schema:
type: integer
description: 'ID visível do imóvel.'
example: 11
-
in: query
name: 'filter[condominium_id]'
description: 'ID do condomínio.'
example: 13
required: false
schema:
type: integer
description: 'ID do condomínio.'
example: 13
-
in: query
name: 'filter[reference]'
description: Referência.
example: CA001
required: false
schema:
type: string
description: Referência.
example: CA001
-
in: query
name: 'filter[status]'
description: Status.
example: active
required: false
schema:
type: string
description: Status.
example: active
-
in: query
name: 'filter[lock]'
description: 'Bloqueio do imóvel.'
example: free
required: false
schema:
type: string
description: 'Bloqueio do imóvel.'
example: free
-
in: query
name: 'filter[type_id]'
description: 'ID do Tipo do imóvel.'
example: 1
required: false
schema:
type: integer
description: 'ID do Tipo do imóvel.'
example: 1
-
in: query
name: 'filter[stage_id]'
description: 'ID do estágio.'
example: 2
required: false
schema:
type: integer
description: 'ID do estágio.'
example: 2
-
in: query
name: 'filter[country_id]'
description: 'ID do País.'
example: 1
required: false
schema:
type: integer
description: 'ID do País.'
example: 1
-
in: query
name: 'filter[state_id]'
description: 'ID do estado.'
example: 24
required: false
schema:
type: integer
description: 'ID do estado.'
example: 24
-
in: query
name: 'filter[city_id]'
description: 'ID da cidade.'
example: 8650
required: false
schema:
type: integer
description: 'ID da cidade.'
example: 8650
-
in: query
name: 'filter[district_id]'
description: 'ID do bairro.'
example: 1
required: false
schema:
type: integer
description: 'ID do bairro.'
example: 1
-
in: query
name: 'filter[tags]'
description: 'Tags do imóvel.'
example:
- 1
- 2
required: false
schema:
type: array
description: 'Tags do imóvel.'
example:
- 1
- 2
items:
type: integer
-
in: query
name: 'filter[responsible]'
description: 'IDs dos responsáveis.'
example:
- 1
required: false
schema:
type: array
description: 'IDs dos responsáveis.'
example:
- 1
items:
type: integer
-
in: query
name: 'filter[constructor_id]'
description: 'ID da construtora.'
example: 1
required: false
schema:
type: integer
description: 'ID da construtora.'
example: 1
-
in: query
name: 'filter[access]'
description: 'Tipo de Acesso.'
example: all
required: false
schema:
type: string
description: 'Tipo de Acesso.'
example: all
-
in: query
name: 'filter[pickup]'
description: 'ID do usuário que captou o imóvel.'
example: 123
required: false
schema:
type: integer
description: 'ID do usuário que captou o imóvel.'
example: 123
-
in: query
name: 'filter[slug]'
description: 'Link permanente para site.'
example: exemplo-perma-link
required: false
schema:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
-
in: query
name: 'filter[expiration]'
description: 'Expiração do imóvel ativa.'
example: false
required: false
schema:
type: boolean
description: 'Expiração do imóvel ativa.'
example: false
-
in: query
name: 'filter[expiration_date]'
description: 'Data da expiração do imóvel.'
example: '2024-03-20'
required: false
schema:
type: string
description: 'Data da expiração do imóvel.'
example: '2024-03-20'
-
in: query
name: 'filter[active]'
description: 'Imóvel Ativo.'
example: true
required: false
schema:
type: boolean
description: 'Imóvel Ativo.'
example: true
-
in: query
name: 'filter[import_id]'
description: 'Referência do sistema externo.'
example: CA001
required: false
schema:
type: string
description: 'Referência do sistema externo.'
example: CA001
-
in: query
name: 'filter[principal_media]'
description: 'Mídia principal.'
example: 'https://...'
required: false
schema:
type: string
description: 'Mídia principal.'
example: 'https://...'
-
in: query
name: 'filter[purpose_featured]'
description: 'Finalidade em destaque.'
example: rent
required: false
schema:
type: string
description: 'Finalidade em destaque.'
example: rent
-
in: query
name: 'filter[position]'
description: 'Ordem do imóvel.'
example: 1
required: false
schema:
type: integer
description: 'Ordem do imóvel.'
example: 1
-
in: query
name: 'filter[occupancy]'
description: 'Ocupação do imóvel.'
example: vacant
required: false
schema:
type: string
description: 'Ocupação do imóvel.'
example: vacant
-
in: query
name: 'filter[garage]'
description: 'Quantidade mínima de garagens.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade mínima de garagens.'
example: 1
-
in: query
name: 'filter[garage_number]'
description: 'Número da Vaga.'
example: 123
required: false
schema:
type: integer
description: 'Número da Vaga.'
example: 123
-
in: query
name: 'filter[suite]'
description: 'Quantidade mínima de Suítes.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade mínima de Suítes.'
example: 1
-
in: query
name: 'filter[room]'
description: 'Quantidade mínima de Salas.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade mínima de Salas.'
example: 1
-
in: query
name: 'filter[bathroom]'
description: 'Quantidade mínima de Banheiros.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade mínima de Banheiros.'
example: 1
-
in: query
name: 'filter[bedroom]'
description: 'Quantidade mínima de Quartos.'
example: 3
required: false
schema:
type: integer
description: 'Quantidade mínima de Quartos.'
example: 3
-
in: query
name: 'filter[conservation]'
description: 'Conservação do imóvel.'
example: 'Bem conservado'
required: false
schema:
type: string
description: 'Conservação do imóvel.'
example: 'Bem conservado'
-
in: query
name: 'filter[built_year]'
description: 'Ano de construção.'
example: 2000
required: false
schema:
type: integer
description: 'Ano de construção.'
example: 2000
-
in: query
name: 'filter[floor]'
description: 'Andar do imóvel.'
example: 2
required: false
schema:
type: integer
description: 'Andar do imóvel.'
example: 2
-
in: query
name: 'filter[total_floors]'
description: 'Quantidade de Andares.'
example: 4
required: false
schema:
type: integer
description: 'Quantidade de Andares.'
example: 4
-
in: query
name: 'filter[total_by_floors]'
description: 'Apartamentos por Andar.'
example: 2
required: false
schema:
type: integer
description: 'Apartamentos por Andar.'
example: 2
-
in: query
name: 'filter[blocks]'
description: 'Quantidade de Blocos do condomínio.'
example: 2
required: false
schema:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 2
-
in: query
name: 'filter[accommodates]'
description: 'Quantidade de Pessoas que acomoda.'
example: 5
required: false
schema:
type: integer
description: 'Quantidade de Pessoas que acomoda.'
example: 5
-
in: query
name: 'filter[furnishing]'
description: 'Status da mobília.'
example: furnished
required: false
schema:
type: string
description: 'Status da mobília.'
example: furnished
-
in: query
name: 'filter[title]'
description: 'Titulo do imóvel.'
example: 'Título Exemplar'
required: false
schema:
type: string
description: 'Titulo do imóvel.'
example: 'Título Exemplar'
-
in: query
name: 'filter[plate]'
description: 'Status da placa.'
example: without
required: false
schema:
type: string
description: 'Status da placa.'
example: without
-
in: query
name: 'filter[content]'
description: 'HTML de Descrição do imóvel.'
example: 'Imóvel de Exemplo!
'
required: false
schema:
type: string
description: 'HTML de Descrição do imóvel.'
example: 'Imóvel de Exemplo!
'
-
in: query
name: 'filter[lock_description]'
description: 'Observações do bloqueio.'
example: 'Fim da Locação'
required: false
schema:
type: string
description: 'Observações do bloqueio.'
example: 'Fim da Locação'
-
in: query
name: 'filter[area_total]'
description: 'numeric Área total mínima.'
example: '123'
required: false
schema:
type: string
description: 'numeric Área total mínima.'
example: '123'
-
in: query
name: 'filter[area_private]'
description: 'numeric Área privada mínima.'
example: '123'
required: false
schema:
type: string
description: 'numeric Área privada mínima.'
example: '123'
-
in: query
name: 'filter[area_useful]'
description: 'numeric Área útil mínima.'
example: '123'
required: false
schema:
type: string
description: 'numeric Área útil mínima.'
example: '123'
-
in: query
name: 'filter[area_ground]'
description: 'numeric Área do terreno.'
example: '12'
required: false
schema:
type: string
description: 'numeric Área do terreno.'
example: '12'
-
in: query
name: 'filter[area_front]'
description: 'numeric Frente do imóvel.'
example: '21'
required: false
schema:
type: string
description: 'numeric Frente do imóvel.'
example: '21'
-
in: query
name: 'filter[area_length]'
description: 'numeric Comprimento do imóvel.'
example: '132'
required: false
schema:
type: string
description: 'numeric Comprimento do imóvel.'
example: '132'
-
in: query
name: 'filter[area_back]'
description: 'numeric Fundos do imóvel.'
example: '123'
required: false
schema:
type: string
description: 'numeric Fundos do imóvel.'
example: '123'
-
in: query
name: 'filter[street]'
description: 'Rua do imóvel.'
example: 'Rua Guanabara'
required: false
schema:
type: string
description: 'Rua do imóvel.'
example: 'Rua Guanabara'
-
in: query
name: 'filter[number]'
description: 'número do imóvel.'
example: 1
required: false
schema:
type: integer
description: 'número do imóvel.'
example: 1
-
in: query
name: 'filter[complement]'
description: 'Complemento do imóvel.'
example: Apartamento
required: false
schema:
type: string
description: 'Complemento do imóvel.'
example: Apartamento
-
in: query
name: 'filter[reference_point]'
description: 'Ponto de referência.'
example: 'Bar do Seu Zé'
required: false
schema:
type: string
description: 'Ponto de referência.'
example: 'Bar do Seu Zé'
-
in: query
name: 'filter[building_name]'
description: 'Nome do empreendimento.'
example: 'Guanabara Prime'
required: false
schema:
type: string
description: 'Nome do empreendimento.'
example: 'Guanabara Prime'
-
in: query
name: 'filter[zip_code]'
description: 'CEP do imóvel.'
example: 89160000
required: false
schema:
type: integer
description: 'CEP do imóvel.'
example: 89160000
-
in: query
name: 'filter[amount_updated_at]'
description: 'Date Data de Atualização dos valores.'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Date Data de Atualização dos valores.'
example: '2024-01-01'
-
in: query
name: 'filter[delivery_date]'
description: 'Date Data de entrega.'
example: '2024-05-01'
required: false
schema:
type: string
description: 'Date Data de entrega.'
example: '2024-05-01'
-
in: query
name: 'filter[show_address]'
description: 'Divulga Endereço.'
example: true
required: false
schema:
type: boolean
description: 'Divulga Endereço.'
example: true
-
in: query
name: 'filter[show_number]'
description: 'Divulga Número.'
example: true
required: false
schema:
type: boolean
description: 'Divulga Número.'
example: true
-
in: query
name: 'filter[show_complement]'
description: 'Divulga Complemento.'
example: true
required: false
schema:
type: boolean
description: 'Divulga Complemento.'
example: true
-
in: query
name: 'filter[map]'
description: 'Divulga Mapa.'
example: false
required: false
schema:
type: boolean
description: 'Divulga Mapa.'
example: false
-
in: query
name: 'filter[map_street]'
description: 'Divulga Mapa da Rua.'
example: false
required: false
schema:
type: boolean
description: 'Divulga Mapa da Rua.'
example: false
-
in: query
name: 'filter[map_info]'
description: 'Infos do mapa.'
example: []
required: false
schema:
type: array
description: 'Infos do mapa.'
example: []
items:
type: string
-
in: query
name: 'filter[map_around]'
description: 'Ofuscar ponto exato no mapa.'
example: false
required: false
schema:
type: boolean
description: 'Ofuscar ponto exato no mapa.'
example: false
-
in: query
name: 'filter[iptu_reference]'
description: 'Inscrição de IPTU.'
example: '12321321'
required: false
schema:
type: string
description: 'Inscrição de IPTU.'
example: '12321321'
-
in: query
name: 'filter[energy_reference]'
description: 'Matrícula de inscrição de Energia.'
example: '12321313'
required: false
schema:
type: string
description: 'Matrícula de inscrição de Energia.'
example: '12321313'
-
in: query
name: 'filter[water_reference]'
description: 'Matrícula de inscrição de Água.'
example: '213213'
required: false
schema:
type: string
description: 'Matrícula de inscrição de Água.'
example: '213213'
-
in: query
name: 'filter[gas_reference]'
description: 'Matrícula de inscrição de gás.'
example: 23213213-12
required: false
schema:
type: string
description: 'Matrícula de inscrição de gás.'
example: 23213213-12
-
in: query
name: 'filter[incorporation_reference]'
description: 'Inscrição de Incorporação.'
example: '213213123.223'
required: false
schema:
type: string
description: 'Inscrição de Incorporação.'
example: '213213123.223'
-
in: query
name: 'filter[notes]'
description: Observações.
example: 'Observações do imóvel'
required: false
schema:
type: string
description: Observações.
example: 'Observações do imóvel'
-
in: query
name: 'filter[virtual_tour]'
description: 'Link do Tour Virtual.'
example: 'https://...'
required: false
schema:
type: string
description: 'Link do Tour Virtual.'
example: 'https://...'
-
in: query
name: 'filter[html_title]'
description: 'Título da página (HTML title).'
example: 'SEO Título'
required: false
schema:
type: string
description: 'Título da página (HTML title).'
example: 'SEO Título'
-
in: query
name: 'filter[html_keyword]'
description: 'Palavras Chave (HTML Keyword). Example:'
example: molestiae
required: false
schema:
type: string
description: 'Palavras Chave (HTML Keyword). Example:'
example: molestiae
-
in: query
name: 'filter[html_description]'
description: 'descrição SEO.'
example: 'SEO,chave'
required: false
schema:
type: string
description: 'descrição SEO.'
example: 'SEO,chave'
-
in: query
name: 'filter[system_featured]'
description: 'Destaque no Site.'
example: true
required: false
schema:
type: boolean
description: 'Destaque no Site.'
example: true
-
in: query
name: 'filter[thirdparty_featured]'
description: 'Destaque nos Portais.'
example: disabled
required: false
schema:
type: string
description: 'Destaque nos Portais.'
example: disabled
-
in: query
name: 'filter[uses_calendar]'
description: 'Uso do calendário.'
example: disabled
required: false
schema:
type: string
description: 'Uso do calendário.'
example: disabled
-
in: query
name: 'filter[watermark]'
description: "Usa Marca d'água."
example: true
required: false
schema:
type: boolean
description: "Usa Marca d'água."
example: true
-
in: query
name: 'filter[exclusivity]'
description: Exclusividade.
example: false
required: false
schema:
type: boolean
description: Exclusividade.
example: false
-
in: query
name: 'filter[head_code]'
description: 'Códigos para Plugins Específicos dentro da tag Head.'
example: 'function example(foo,bar){...}'
required: false
schema:
type: string
description: 'Códigos para Plugins Específicos dentro da tag Head.'
example: 'function example(foo,bar){...}'
-
in: query
name: 'filter[status_bar]'
description: 'Barra de Status ativa.'
example: false
required: false
schema:
type: boolean
description: 'Barra de Status ativa.'
example: false
-
in: query
name: 'filter[status_bar_content]'
description: 'Conteúdo da Barra de Status.'
example: 'Sem conteúdo'
required: false
schema:
type: string
description: 'Conteúdo da Barra de Status.'
example: 'Sem conteúdo'
-
in: query
name: 'filter[status_bar_color]'
description: 'Cor da Barra de Status.'
example: ff00fa
required: false
schema:
type: string
description: 'Cor da Barra de Status.'
example: ff00fa
-
in: query
name: 'filter[owner_report]'
description: 'Notificação para o Proprietário.'
example: true
required: false
schema:
type: boolean
description: 'Notificação para o Proprietário.'
example: true
-
in: query
name: 'include[purposes]'
description: 'Retorna os dados das finalidades do imóvel.'
example: 'type,amount'
required: false
schema:
type: string
description: 'Retorna os dados das finalidades do imóvel.'
example: 'type,amount'
-
in: query
name: 'include[contracts]'
description: 'Retorna os dados de contratos do imóvel.'
example: 'type,status'
required: false
schema:
type: string
description: 'Retorna os dados de contratos do imóvel.'
example: 'type,status'
-
in: query
name: 'include[rentActive]'
description: 'Retorna contrato de locação ativo/reservado.'
example: 'type,example'
required: false
schema:
type: string
description: 'Retorna contrato de locação ativo/reservado.'
example: 'type,example'
-
in: query
name: 'include[details]'
description: 'Retorna os dados dos detalhes do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados dos detalhes do imóvel.'
example: 'id,description'
-
in: query
name: 'include[tabs]'
description: 'Retorna os dados das abas do imóvel.'
example: 'id,tlte'
required: false
schema:
type: string
description: 'Retorna os dados das abas do imóvel.'
example: 'id,tlte'
-
in: query
name: 'include[keys]'
description: 'Retorna os dados das chaves do imóvel.'
example: 'id,reference'
required: false
schema:
type: string
description: 'Retorna os dados das chaves do imóvel.'
example: 'id,reference'
-
in: query
name: 'include[seasonPacks]'
description: 'Retorna os pacotes de temporadas do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os pacotes de temporadas do imóvel.'
example: 'id,description'
-
in: query
name: 'include[unavailableDates]'
description: 'Retorna as datas indisponíveis do imóvel.'
example: 'id,date'
required: false
schema:
type: string
description: 'Retorna as datas indisponíveis do imóvel.'
example: 'id,date'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets abertos para o imóvel.'
example: 'id,title,notes'
required: false
schema:
type: string
description: 'Retorna os tickets abertos para o imóvel.'
example: 'id,title,notes'
-
in: query
name: 'include[inspects]'
description: 'Retorna as vistorias do imóvel.'
example: 'id,type,status'
required: false
schema:
type: string
description: 'Retorna as vistorias do imóvel.'
example: 'id,type,status'
-
in: query
name: 'include[constructor]'
description: 'Retorna a construtora.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a construtora.'
example: 'id,name'
-
in: query
name: 'include[type]'
description: 'Retorna os dados do tipo do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do tipo do imóvel.'
example: 'id,description'
-
in: query
name: 'include[category]'
description: 'Retorna os dados da categoria do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados da categoria do imóvel.'
example: 'id,description'
-
in: query
name: 'include[stage]'
description: 'Retorna os dados do estágio do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do estágio do imóvel.'
example: 'id,description'
-
in: query
name: 'include[catcher]'
description: 'Retorna os dados dos corretores captadores do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores captadores do imóvel.'
example: 'id,name'
-
in: query
name: 'include[responsibles]'
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
-
in: query
name: 'include[responsibleGroups]'
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
-
in: query
name: 'include[owners]'
description: 'Retorna os dados dos proprietários dos imóveis.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos proprietários dos imóveis.'
example: 'id,name'
-
in: query
name: 'include[ownersPivot]'
description: 'Retorna os dados de distribuição de renda dos proprietários.'
example: 'person_id,percentage,principal'
required: false
schema:
type: string
description: 'Retorna os dados de distribuição de renda dos proprietários.'
example: 'person_id,percentage,principal'
-
in: query
name: 'include[country]'
description: 'Retorna o País do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o País do imóvel.'
example: 'id,name'
-
in: query
name: 'include[city]'
description: 'Retorna a Cidade do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a Cidade do imóvel.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna o Estado do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Estado do imóvel.'
example: 'id,name'
-
in: query
name: 'include[district]'
description: 'Retorna o Bairro do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Bairro do imóvel.'
example: 'id,name'
-
in: query
name: 'include[principal]'
description: 'Retorna a imagem principal do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a imagem principal do imóvel.'
example: file_name
-
in: query
name: 'include[enterprise]'
description: 'Retorna as imagens do Empreendimento.'
example: file_name
required: false
schema:
type: string
description: 'Retorna as imagens do Empreendimento.'
example: file_name
-
in: query
name: 'include[images]'
description: 'Retorna a galeria de imagens do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a galeria de imagens do imóvel.'
example: file_name
-
in: query
name: 'include[plants]'
description: 'Retorna galeria de imagens de plantas do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna galeria de imagens de plantas do imóvel.'
example: file_name
-
in: query
name: 'include[documents]'
description: 'Retorna os documentos públicos do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna os documentos públicos do imóvel.'
example: file_name
-
in: query
name: 'include[files]'
description: 'Retorna os documentos do imóvel restritos à imobiliária.'
example: file_name
required: false
schema:
type: string
description: 'Retorna os documentos do imóvel restritos à imobiliária.'
example: file_name
-
in: query
name: 'include[condominium]'
description: 'Retorna os dados do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do condomínio.'
example: 'id,title'
-
in: query
name: 'include[tags]'
description: 'Retorna as Tags do imóvel. Example:'
example: libero
required: false
schema:
type: string
description: 'Retorna as Tags do imóvel. Example:'
example: libero
-
in: query
name: 'include[deals]'
description: 'Retorna os negócios com o imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os negócios com o imóvel.'
example: 'id,title'
-
in: query
name: 'include[events]'
description: 'Retorna os eventos para o imóvel.'
example: 'id,type'
required: false
schema:
type: string
description: 'Retorna os eventos para o imóvel.'
example: 'id,type'
-
in: query
name: 'include[leads]'
description: 'Retorna os leads desse imóvel.'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Retorna os leads desse imóvel.'
example: 'id,name,phone,email'
-
in: query
name: 'include[proposals]'
description: 'Retorna as propostas feitas para o imóvel. Example:'
example: accusantium
required: false
schema:
type: string
description: 'Retorna as propostas feitas para o imóvel. Example:'
example: accusantium
-
in: query
name: 'include[proposalsActive]'
description: 'Retorna os dados das propostas pendentes ou aceitas do imóvel.'
example: 'id,notes,status'
required: false
schema:
type: string
description: 'Retorna os dados das propostas pendentes ou aceitas do imóvel.'
example: 'id,notes,status'
-
in: query
name: 'include[proposalAccepted]'
description: 'Retorna os dados das propostas aceitas do imóvel.'
example: 'id,notes,deal_id'
required: false
schema:
type: string
description: 'Retorna os dados das propostas aceitas do imóvel.'
example: 'id,notes,deal_id'
-
in: query
name: 'include[exchangeStage]'
description: 'Retorna os estágios de imóvel (radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os estágios de imóvel (radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeType]'
description: 'Retorna os tipos de imóvel (radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os tipos de imóvel (radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeDetails]'
description: 'Retorna os detalhes(radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os detalhes(radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeCity]'
description: 'Retorna as cidades (radar de permuta).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as cidades (radar de permuta).'
example: 'id,name'
-
in: query
name: 'include[exchangeDistrict]'
description: 'Retorna os bairros (radar de permuta).'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os bairros (radar de permuta).'
example: 'id,name,abbreviation'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis '
parameters: []
responses: {}
tags:
- Imóveis
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id2:
type: integer
description: 'ID visível do imóvel.'
example: 11
condominium_id:
type: integer
description: 'ID do condomínio.'
example: 13
reference:
type: string
description: Referência.
example: CA001
status:
type: string
description: Status.
example: active
lock:
type: string
description: 'Bloqueio do imóvel.'
example: free
type_id:
type: integer
description: 'ID do Tipo do imóvel.'
example: 1
stage_id:
type: integer
description: 'ID do estágio.'
example: 2
country_id:
type: integer
description: 'ID do País.'
example: 1
state_id:
type: integer
description: 'ID do estado.'
example: 24
city_id:
type: integer
description: 'ID da cidade.'
example: 8650
district_id:
type: integer
description: 'ID do bairro.'
example: 1
tags:
type: array
description: 'Tags do imóvel.'
example:
- 1
- 2
items:
type: integer
responsible:
type: array
description: 'IDs dos responsáveis.'
example:
- 1
items:
type: integer
constructor_id:
type: integer
description: 'ID da construtora.'
example: 1
access:
type: string
description: 'Tipo de Acesso.'
example: all
pickup:
type: integer
description: 'ID do usuário que captou o imóvel.'
example: 123
slug:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
expiration:
type: boolean
description: 'Expiração do imóvel ativa.'
example: false
expiration_date:
type: string
description: 'Data da expiração do imóvel.'
example: '2024-03-20'
active:
type: boolean
description: 'Imóvel Ativo.'
example: true
import_id:
type: string
description: 'Referência do sistema externo.'
example: CA001
principal_media:
type: string
description: 'Mídia principal.'
example: 'https://...'
purpose_featured:
type: string
description: 'Finalidade em destaque.'
example: rent
position:
type: integer
description: 'Ordem do imóvel.'
example: 1
occupancy:
type: string
description: 'Ocupação do imóvel.'
example: vacant
garage:
type: integer
description: 'Quantidade mínima de garagens.'
example: 1
garage_number:
type: integer
description: 'Número da Vaga.'
example: 123
suite:
type: integer
description: 'Quantidade mínima de Suítes.'
example: 1
room:
type: integer
description: 'Quantidade mínima de Salas.'
example: 1
bathroom:
type: integer
description: 'Quantidade mínima de Banheiros.'
example: 1
bedroom:
type: integer
description: 'Quantidade mínima de Quartos.'
example: 3
conservation:
type: string
description: 'Conservação do imóvel.'
example: 'Bem conservado'
built_year:
type: integer
description: 'Ano de construção.'
example: 2000
floor:
type: integer
description: 'Andar do imóvel.'
example: 2
total_floors:
type: integer
description: 'Quantidade de Andares.'
example: 4
total_by_floors:
type: integer
description: 'Apartamentos por Andar.'
example: 2
blocks:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 2
accommodates:
type: integer
description: 'Quantidade de Pessoas que acomoda.'
example: 5
furnishing:
type: string
description: 'Status da mobília.'
example: furnished
title:
type: string
description: 'Titulo do imóvel.'
example: 'Título Exemplar'
plate:
type: string
description: 'Status da placa.'
example: without
content:
type: string
description: 'HTML de Descrição do imóvel.'
example: 'Imóvel de Exemplo!
'
lock_description:
type: string
description: 'Observações do bloqueio.'
example: 'Fim da Locação'
area_total:
type: numeric
description: 'Área total mínima.'
example: '123'
area_private:
type: numeric
description: 'Área privada mínima.'
example: '123'
area_useful:
type: numeric
description: 'Área útil mínima.'
example: '123'
area_ground:
type: numeric
description: 'Área do terreno.'
example: '12'
area_front:
type: numeric
description: 'Frente do imóvel.'
example: '21'
area_length:
type: numeric
description: 'Comprimento do imóvel.'
example: '132'
area_back:
type: numeric
description: 'Fundos do imóvel.'
example: '123'
street:
type: string
description: 'Rua do imóvel.'
example: 'Rua Guanabara'
number:
type: integer
description: 'número do imóvel.'
example: 1
complement:
type: string
description: 'Complemento do imóvel.'
example: Apartamento
reference_point:
type: string
description: 'Ponto de referência.'
example: 'Bar do Seu Zé'
building_name:
type: string
description: 'Nome do empreendimento.'
example: 'Guanabara Prime'
zip_code:
type: integer
description: 'CEP do imóvel.'
example: 89160000
amount_updated_at:
type: Date
description: 'Data de Atualização dos valores.'
example: '2024-01-01'
delivery_date:
type: Date
description: 'Data de entrega.'
example: '2024-05-01'
show_address:
type: boolean
description: 'Divulga Endereço.'
example: true
show_number:
type: boolean
description: 'Divulga Número.'
example: true
show_complement:
type: boolean
description: 'Divulga Complemento.'
example: true
map:
type: boolean
description: 'Divulga Mapa.'
example: false
map_street:
type: boolean
description: 'Divulga Mapa da Rua.'
example: false
map_info:
type: array
description: 'Infos do mapa.'
example: []
items:
type: string
map_around:
type: boolean
description: 'Ofuscar ponto exato no mapa.'
example: false
iptu_reference:
type: string
description: 'Inscrição de IPTU.'
example: '12321321'
energy_reference:
type: string
description: 'Matrícula de inscrição de Energia.'
example: '12321313'
water_reference:
type: string
description: 'Matrícula de inscrição de Água.'
example: '213213'
gas_reference:
type: string
description: 'Matrícula de inscrição de gás.'
example: 23213213-12
incorporation_reference:
type: string
description: 'Inscrição de Incorporação.'
example: '213213123.223'
notes:
type: string
description: Observações.
example: 'Observações do imóvel'
virtual_tour:
type: string
description: 'Link do Tour Virtual.'
example: 'https://...'
html_title:
type: string
description: 'Título da página (HTML title).'
example: 'SEO Título'
html_keyword:
type: string
description: 'Palavras Chave (HTML Keyword). Example:'
example: eveniet
html_description:
type: string
description: 'descrição SEO.'
example: 'SEO,chave'
system_featured:
type: boolean
description: 'Destaque no Site.'
example: true
thirdparty_featured:
type: string
description: 'Destaque nos Portais.'
example: disabled
uses_calendar:
type: string
description: 'Uso do calendário.'
example: disabled
watermark:
type: boolean
description: "Usa Marca d'água."
example: true
exclusivity:
type: boolean
description: Exclusividade.
example: false
head_code:
type: string
description: 'Códigos para Plugins Específicos dentro da tag Head.'
example: 'function example(foo,bar){...}'
status_bar:
type: boolean
description: 'Barra de Status ativa.'
example: false
status_bar_content:
type: string
description: 'Conteúdo da Barra de Status.'
example: 'Sem conteúdo'
status_bar_color:
type: string
description: 'Cor da Barra de Status.'
example: ff00fa
owner_report:
type: boolean
description: 'Notificação para o Proprietário.'
example: true
required:
- type_id
- title
'/buildings/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,slug,type_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title,slug,type_id'
-
in: query
name: 'include[purposes]'
description: 'Retorna os dados das finalidades do imóvel.'
example: 'type,amount'
required: false
schema:
type: string
description: 'Retorna os dados das finalidades do imóvel.'
example: 'type,amount'
-
in: query
name: 'include[contracts]'
description: 'Retorna os dados de contratos do imóvel.'
example: 'type,status'
required: false
schema:
type: string
description: 'Retorna os dados de contratos do imóvel.'
example: 'type,status'
-
in: query
name: 'include[rentActive]'
description: 'Retorna contrato de locação ativo/reservado.'
example: 'type,example'
required: false
schema:
type: string
description: 'Retorna contrato de locação ativo/reservado.'
example: 'type,example'
-
in: query
name: 'include[details]'
description: 'Retorna os dados dos detalhes do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados dos detalhes do imóvel.'
example: 'id,description'
-
in: query
name: 'include[tabs]'
description: 'Retorna os dados das abas do imóvel.'
example: 'id,tlte'
required: false
schema:
type: string
description: 'Retorna os dados das abas do imóvel.'
example: 'id,tlte'
-
in: query
name: 'include[keys]'
description: 'Retorna os dados das chaves do imóvel.'
example: 'id,reference'
required: false
schema:
type: string
description: 'Retorna os dados das chaves do imóvel.'
example: 'id,reference'
-
in: query
name: 'include[seasonPacks]'
description: 'Retorna os pacotes de temporadas do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os pacotes de temporadas do imóvel.'
example: 'id,description'
-
in: query
name: 'include[unavailableDates]'
description: 'Retorna as datas indisponíveis do imóvel.'
example: 'id,date'
required: false
schema:
type: string
description: 'Retorna as datas indisponíveis do imóvel.'
example: 'id,date'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets abertos para o imóvel.'
example: 'id,title,notes'
required: false
schema:
type: string
description: 'Retorna os tickets abertos para o imóvel.'
example: 'id,title,notes'
-
in: query
name: 'include[inspects]'
description: 'Retorna as vistorias do imóvel.'
example: 'id,type,status'
required: false
schema:
type: string
description: 'Retorna as vistorias do imóvel.'
example: 'id,type,status'
-
in: query
name: 'include[constructor]'
description: 'Retorna a construtora.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a construtora.'
example: 'id,name'
-
in: query
name: 'include[type]'
description: 'Retorna os dados do tipo do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do tipo do imóvel.'
example: 'id,description'
-
in: query
name: 'include[category]'
description: 'Retorna os dados da categoria do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados da categoria do imóvel.'
example: 'id,description'
-
in: query
name: 'include[stage]'
description: 'Retorna os dados do estágio do imóvel.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os dados do estágio do imóvel.'
example: 'id,description'
-
in: query
name: 'include[catcher]'
description: 'Retorna os dados dos corretores captadores do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores captadores do imóvel.'
example: 'id,name'
-
in: query
name: 'include[responsibles]'
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
-
in: query
name: 'include[responsibleGroups]'
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos corretores responsáveis do imóvel.'
example: 'id,name'
-
in: query
name: 'include[owners]'
description: 'Retorna os dados dos proprietários dos imóveis.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos proprietários dos imóveis.'
example: 'id,name'
-
in: query
name: 'include[ownersPivot]'
description: 'Retorna os dados de distribuição de renda dos proprietários.'
example: 'person_id,percentage,principal'
required: false
schema:
type: string
description: 'Retorna os dados de distribuição de renda dos proprietários.'
example: 'person_id,percentage,principal'
-
in: query
name: 'include[country]'
description: 'Retorna o País do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o País do imóvel.'
example: 'id,name'
-
in: query
name: 'include[city]'
description: 'Retorna a Cidade do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a Cidade do imóvel.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna o Estado do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Estado do imóvel.'
example: 'id,name'
-
in: query
name: 'include[district]'
description: 'Retorna o Bairro do imóvel.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Bairro do imóvel.'
example: 'id,name'
-
in: query
name: 'include[principal]'
description: 'Retorna a imagem principal do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a imagem principal do imóvel.'
example: file_name
-
in: query
name: 'include[enterprise]'
description: 'Retorna as imagens do Empreendimento.'
example: file_name
required: false
schema:
type: string
description: 'Retorna as imagens do Empreendimento.'
example: file_name
-
in: query
name: 'include[images]'
description: 'Retorna a galeria de imagens do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna a galeria de imagens do imóvel.'
example: file_name
-
in: query
name: 'include[plants]'
description: 'Retorna galeria de imagens de plantas do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna galeria de imagens de plantas do imóvel.'
example: file_name
-
in: query
name: 'include[documents]'
description: 'Retorna os documentos públicos do imóvel.'
example: file_name
required: false
schema:
type: string
description: 'Retorna os documentos públicos do imóvel.'
example: file_name
-
in: query
name: 'include[files]'
description: 'Retorna os documentos do imóvel restritos à imobiliária.'
example: file_name
required: false
schema:
type: string
description: 'Retorna os documentos do imóvel restritos à imobiliária.'
example: file_name
-
in: query
name: 'include[condominium]'
description: 'Retorna os dados do condomínio.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados do condomínio.'
example: 'id,title'
-
in: query
name: 'include[tags]'
description: 'Retorna as Tags do imóvel. Example:'
example: dolor
required: false
schema:
type: string
description: 'Retorna as Tags do imóvel. Example:'
example: dolor
-
in: query
name: 'include[deals]'
description: 'Retorna os negócios com o imóvel.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os negócios com o imóvel.'
example: 'id,title'
-
in: query
name: 'include[events]'
description: 'Retorna os eventos para o imóvel.'
example: 'id,type'
required: false
schema:
type: string
description: 'Retorna os eventos para o imóvel.'
example: 'id,type'
-
in: query
name: 'include[leads]'
description: 'Retorna os leads desse imóvel.'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Retorna os leads desse imóvel.'
example: 'id,name,phone,email'
-
in: query
name: 'include[proposals]'
description: 'Retorna as propostas feitas para o imóvel. Example:'
example: molestiae
required: false
schema:
type: string
description: 'Retorna as propostas feitas para o imóvel. Example:'
example: molestiae
-
in: query
name: 'include[proposalsActive]'
description: 'Retorna os dados das propostas pendentes ou aceitas do imóvel.'
example: 'id,notes,status'
required: false
schema:
type: string
description: 'Retorna os dados das propostas pendentes ou aceitas do imóvel.'
example: 'id,notes,status'
-
in: query
name: 'include[proposalAccepted]'
description: 'Retorna os dados das propostas aceitas do imóvel.'
example: 'id,notes,deal_id'
required: false
schema:
type: string
description: 'Retorna os dados das propostas aceitas do imóvel.'
example: 'id,notes,deal_id'
-
in: query
name: 'include[exchangeStage]'
description: 'Retorna os estágios de imóvel (radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os estágios de imóvel (radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeType]'
description: 'Retorna os tipos de imóvel (radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os tipos de imóvel (radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeDetails]'
description: 'Retorna os detalhes(radar de permuta).'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna os detalhes(radar de permuta).'
example: 'id,description'
-
in: query
name: 'include[exchangeCity]'
description: 'Retorna as cidades (radar de permuta).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as cidades (radar de permuta).'
example: 'id,name'
-
in: query
name: 'include[exchangeDistrict]'
description: 'Retorna os bairros (radar de permuta).'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os bairros (radar de permuta).'
example: 'id,name,abbreviation'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis '
parameters: []
responses: {}
tags:
- Imóveis
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
id2:
type: integer
description: 'ID visível do imóvel.'
example: 11
condominium_id:
type: integer
description: 'ID do condomínio.'
example: 13
reference:
type: string
description: Referência.
example: CA001
status:
type: string
description: Status.
example: active
lock:
type: string
description: 'Bloqueio do imóvel.'
example: free
type_id:
type: integer
description: 'ID do Tipo do imóvel.'
example: 1
stage_id:
type: integer
description: 'ID do estágio.'
example: 2
country_id:
type: integer
description: 'ID do País.'
example: 1
state_id:
type: integer
description: 'ID do estado.'
example: 24
city_id:
type: integer
description: 'ID da cidade.'
example: 8650
district_id:
type: integer
description: 'ID do bairro.'
example: 1
tags:
type: array
description: 'Tags do imóvel.'
example:
- 1
- 2
items:
type: integer
responsible:
type: array
description: 'IDs dos responsáveis.'
example:
- 1
items:
type: integer
constructor_id:
type: integer
description: 'ID da construtora.'
example: 1
access:
type: string
description: 'Tipo de Acesso.'
example: all
pickup:
type: integer
description: 'ID do usuário que captou o imóvel.'
example: 123
slug:
type: string
description: 'Link permanente para site.'
example: exemplo-perma-link
expiration:
type: boolean
description: 'Expiração do imóvel ativa.'
example: false
expiration_date:
type: string
description: 'Data da expiração do imóvel.'
example: '2024-03-20'
active:
type: boolean
description: 'Imóvel Ativo.'
example: true
import_id:
type: string
description: 'Referência do sistema externo.'
example: CA001
purpose_featured:
type: string
description: 'Finalidade em destaque.'
example: rent
position:
type: integer
description: 'Ordem do imóvel.'
example: 1
occupancy:
type: string
description: 'Ocupação do imóvel.'
example: vacant
garage:
type: integer
description: 'Quantidade mínima de garagens.'
example: 1
garage_number:
type: integer
description: 'Número da Vaga.'
example: 123
suite:
type: integer
description: 'Quantidade mínima de Suítes.'
example: 1
room:
type: integer
description: 'Quantidade mínima de Salas.'
example: 1
bathroom:
type: integer
description: 'Quantidade mínima de Banheiros.'
example: 1
bedroom:
type: integer
description: 'Quantidade mínima de Quartos.'
example: 3
conservation:
type: string
description: 'Conservação do imóvel.'
example: 'Bem conservado'
built_year:
type: integer
description: 'Ano de construção.'
example: 2000
floor:
type: integer
description: 'Andar do imóvel.'
example: 2
total_floors:
type: integer
description: 'Quantidade de Andares.'
example: 4
total_by_floors:
type: integer
description: 'Apartamentos por Andar.'
example: 2
blocks:
type: integer
description: 'Quantidade de Blocos do condomínio.'
example: 2
accommodates:
type: integer
description: 'Quantidade de Pessoas que acomoda.'
example: 5
furnishing:
type: string
description: 'Status da mobília.'
example: furnished
title:
type: string
description: 'Titulo do imóvel.'
example: 'Título Exemplar'
plate:
type: string
description: 'Status da placa.'
example: without
content:
type: string
description: 'HTML de Descrição do imóvel.'
example: 'Imóvel de Exemplo!
'
lock_description:
type: string
description: 'Observações do bloqueio.'
example: 'Fim da Locação'
area_total:
type: numeric
description: 'Área total mínima.'
example: '123'
area_private:
type: numeric
description: 'Área privada mínima.'
example: '123'
area_useful:
type: numeric
description: 'Área útil mínima.'
example: '123'
area_ground:
type: numeric
description: 'Área do terreno.'
example: '12'
area_front:
type: numeric
description: 'Frente do imóvel.'
example: '21'
area_length:
type: numeric
description: 'Comprimento do imóvel.'
example: '132'
area_back:
type: numeric
description: 'Fundos do imóvel.'
example: '123'
street:
type: string
description: 'Rua do imóvel.'
example: 'Rua Guanabara'
number:
type: integer
description: 'número do imóvel.'
example: 1
complement:
type: string
description: 'Complemento do imóvel.'
example: Apartamento
reference_point:
type: string
description: 'Ponto de referência.'
example: 'Bar do Seu Zé'
building_name:
type: string
description: 'Nome do empreendimento.'
example: 'Guanabara Prime'
zip_code:
type: integer
description: 'CEP do imóvel.'
example: 89160000
amount_updated_at:
type: Date
description: 'Data de Atualização dos valores.'
example: '2024-01-01'
delivery_date:
type: Date
description: 'Data de entrega.'
example: '2024-05-01'
show_address:
type: boolean
description: 'Divulga Endereço.'
example: true
show_number:
type: boolean
description: 'Divulga Número.'
example: true
show_complement:
type: boolean
description: 'Divulga Complemento.'
example: true
map:
type: boolean
description: 'Divulga Mapa.'
example: false
map_street:
type: boolean
description: 'Divulga Mapa da Rua.'
example: false
map_info:
type: array
description: 'Infos do mapa.'
example: []
items:
type: string
map_around:
type: boolean
description: 'Ofuscar ponto exato no mapa.'
example: false
iptu_reference:
type: string
description: 'Inscrição de IPTU.'
example: '12321321'
energy_reference:
type: string
description: 'Matrícula de inscrição de Energia.'
example: '12321313'
water_reference:
type: string
description: 'Matrícula de inscrição de Água.'
example: '213213'
gas_reference:
type: string
description: 'Matrícula de inscrição de gás.'
example: 23213213-12
incorporation_reference:
type: string
description: 'Inscrição de Incorporação.'
example: '213213123.223'
notes:
type: string
description: Observações.
example: 'Observações do imóvel'
virtual_tour:
type: string
description: 'Link do Tour Virtual.'
example: 'https://...'
html_title:
type: string
description: 'Título da página (HTML title).'
example: 'SEO Título'
html_keyword:
type: string
description: 'Palavras Chave (HTML Keyword). Example:'
example: sit
html_description:
type: string
description: 'descrição SEO.'
example: 'SEO,chave'
system_featured:
type: boolean
description: 'Destaque no Site.'
example: true
thirdparty_featured:
type: string
description: 'Destaque nos Portais.'
example: disabled
uses_calendar:
type: string
description: 'Uso do calendário.'
example: disabled
watermark:
type: boolean
description: "Usa Marca d'água."
example: true
exclusivity:
type: boolean
description: Exclusividade.
example: false
head_code:
type: string
description: 'Códigos para Plugins Específicos dentro da tag Head.'
example: 'function example(foo,bar){...}'
status_bar:
type: boolean
description: 'Barra de Status ativa.'
example: false
status_bar_content:
type: string
description: 'Conteúdo da Barra de Status.'
example: 'Sem conteúdo'
status_bar_color:
type: string
description: 'Cor da Barra de Status.'
example: ff00fa
owner_report:
type: boolean
description: 'Notificação para o Proprietário.'
example: true
ignoreGenerateTitle:
type: boolean
description: 'Não recria o título automático do imóvel neste salvamento, mesmo com a personalização de título ligada.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Imóveis '
parameters: []
responses: {}
tags:
- Imóveis
parameters:
-
in: path
name: id
description: 'ID do Imóvel'
example: 5
required: true
schema:
type: integer
/buildings/bulkUpdates:
get:
summary: 'Últimos lotes do usuário (todos, com acesso total)'
operationId: ltimosLotesDoUsuriotodosComAcessoTotal
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Nunca altera unidade reservada ou vendida. '
parameters: []
responses: {}
tags:
- 'Imóveis - Quadro de Unidades'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do lançamento.'
example: 18432
type:
type: string
description: 'percent ou fixed.'
example: percent
value:
type: number
description: 'Percentual ou valor.'
example: 8.0
preview:
type: boolean
description: 'Só devolve a prévia, sem gravar.'
example: true
required:
- building_id
- value
/buildings/units/massAction:
post:
summary: 'Ações em lote sobre as unidades marcadas'
operationId: aesEmLoteSobreAsUnidadesMarcadas
description: '🔒 Situação de unidade negociada só muda pelo negócio; exclusão de unidade negociada é recusada. '
parameters: []
responses: {}
tags:
- 'Imóveis - Quadro de Unidades'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do lançamento.'
example: 18432
units:
type: array
description: 'IDs marcados no quadro.'
example:
- 1
- 2
- 3
items:
type: integer
action:
type: string
description: 'status, group ou delete.'
example: status
status:
type: string
description: 'Situação nova quando action = status.'
example: blocked
group_id:
type: integer
description: 'Grupo quando action = group.'
example: 991
required:
- building_id
- units
- action
/buildings/units/read:
post:
summary: 'Lê a tabela da construtora com IA'
operationId: lATabelaDaConstrutoraComIA
description: "Aceita PDF, planilha, CSV ou foto. Devolve a prévia das unidades para conferência.\n🔒 Não grava nada: a gravação é feita pelo endpoint de importação. "
parameters: []
responses: {}
tags:
- 'Imóveis - Quadro de Unidades'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do lançamento.'
example: 18432
file:
type: string
description: 'Arquivo enviado previamente.'
example: tabela.pdf
required:
- building_id
- file
/buildings/units/import:
post:
summary: 'Aplica a prévia conferida'
operationId: aplicaAPrviaConferida
description: ''
parameters: []
responses: {}
tags:
- 'Imóveis - Quadro de Unidades'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
building_id:
type: integer
description: 'ID do lançamento.'
example: 18432
units:
type: array
description: 'Unidades conferidas pelo usuário.'
example:
- []
items:
type: object
required:
- building_id
- units
'/buildings/units/{unit_id}/status':
post:
summary: 'Altera a situação de uma unidade'
operationId: alteraASituaoDeUmaUnidade
description: ''
parameters: []
responses: {}
tags:
- 'Imóveis - Quadro de Unidades'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 'available, reserved, sold, blocked ou unavailable.'
example: blocked
required:
- status
parameters:
-
in: path
name: unit_id
description: 'The ID of the unit.'
example: 19
required: true
schema:
type: integer
/buildings/units:
get:
summary: ''
operationId: getBuildingsUnits
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota são necessárias as permissões de Cadastro de Pessoas e de Negócios '
parameters: []
responses: {}
tags:
- Leads
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
funnel_step_id:
type: integer
description: 'ID da Etapa de Funil'
example: 19
user:
type: integer
description: 'Código do usuário responsável pelo Negócio'
example: 13
notes:
type: string
description: 'Histórico adicionado no negócio'
example: asperiores
required:
- funnel_step_id
- user
parameters:
-
in: path
name: id
description: 'ID do lead'
example: 16
required: true
schema:
type: integer
/persons/leads:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Lead '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
-
in: query
name: 'filter[id]'
description: 'Filtra por código'
example: 2
required: false
schema:
type: integer
description: 'Filtra por código'
example: 2
-
in: query
name: 'filter[name]'
description: 'Filtra por nome'
example: '%exemplo%'
required: false
schema:
type: string
description: 'Filtra por nome'
example: '%exemplo%'
-
in: query
name: 'filter[date]'
description: 'Filtra por data do contato'
example: '2024-01-01'
required: false
schema:
type: string
description: 'Filtra por data do contato'
example: '2024-01-01'
-
in: query
name: 'filter[email]'
description: 'Filtra por e-mail'
example: example@mail.com
required: false
schema:
type: string
description: 'Filtra por e-mail'
example: example@mail.com
-
in: query
name: 'filter[status]'
description: "Filtra por status, permitindo: `read`, 'not-read', 'filed' e 'distribuition'"
example: read
required: false
schema:
type: string
description: "Filtra por status, permitindo: `read`, 'not-read', 'filed' e 'distribuition'"
example: read
-
in: query
name: 'filter[phone]'
description: 'Filtra por telefone'
example: '999999999'
required: false
schema:
type: string
description: 'Filtra por telefone'
example: '999999999'
-
in: query
name: 'filter[purpose]'
description: 'Filtra por Finalidade, podendo ser: change, rent, sale, season'
example: rent
required: false
schema:
type: string
description: 'Filtra por Finalidade, podendo ser: change, rent, sale, season'
example: rent
-
in: query
name: 'filter[building_id]'
description: 'Filtra por ID do Imóvel'
example: 123456
required: false
schema:
type: integer
description: 'Filtra por ID do Imóvel'
example: 123456
-
in: query
name: 'filter[origin_id]'
description: 'Filtra por ID de origem'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID de origem'
example: 1
-
in: query
name: 'filter[origin_details]'
description: 'Filtra por detalhe de origem'
example: '%Site%'
required: false
schema:
type: string
description: 'Filtra por detalhe de origem'
example: '%Site%'
-
in: query
name: 'filter[message]'
description: 'Filtra por mensagem'
example: 'Tenho interesse%'
required: false
schema:
type: string
description: 'Filtra por mensagem'
example: 'Tenho interesse%'
-
in: query
name: 'filter[notes]'
description: 'Filtra por observações'
example: 'Deseja casa no bairro%'
required: false
schema:
type: string
description: 'Filtra por observações'
example: 'Deseja casa no bairro%'
-
in: query
name: 'filter[ads_campaign]'
description: 'Filtra por ID de campanha ADS'
example: Cj0KCQiA4L2FFhCvARIsAO0SBdZrTYfubPvY61Sggf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
required: false
schema:
type: string
description: 'Filtra por ID de campanha ADS'
example: Cj0KCQiA4L2FFhCvARIsAO0SBdZrTYfubPvY61Sggf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
-
in: query
name: 'filter[deal_id]'
description: 'Filtra por código do negócio vinculado ao lead.'
example: 123
required: false
schema:
type: integer
description: 'Filtra por código do negócio vinculado ao lead.'
example: 123
-
in: query
name: 'filter[ad_name]'
description: 'Filtra por Nome do anúncio.'
example: 'Nome Teste'
required: false
schema:
type: string
description: 'Filtra por Nome do anúncio.'
example: 'Nome Teste'
-
in: query
name: 'filter[adset_name]'
description: 'Filtra por Nome do conjunto de anúncio.'
example: 'Conjunto Teste'
required: false
schema:
type: string
description: 'Filtra por Nome do conjunto de anúncio.'
example: 'Conjunto Teste'
-
in: query
name: 'include[origin]'
description: 'Incluir dados da Origem do Lead'
example: id
required: false
schema:
type: string
description: 'Incluir dados da Origem do Lead'
example: id
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel vinculado'
example: 'reference,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel vinculado'
example: 'reference,title'
-
in: query
name: 'include[deal]'
description: 'Incluir dados da Origem do Lead'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados da Origem do Lead'
example: 'id,title'
-
in: query
name: 'include[formBuilder]'
description: 'Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Leads '
parameters: []
responses: {}
tags:
- Leads
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome do Lead.'
example: 'Nome do Lead'
email:
type: string
description: 'E-mail do Lead.'
example: teste@gmail.com
phone:
type: integer
description: 'Telefone do Lead.'
example: 47988888888
purpose:
type: string
description: 'Finalidade do Lead, podendo ser: change, rent, sale, season.'
example: sale
building_id:
type: integer
description: 'Imóvel que originou o Lead.'
example: 321123
deal_id:
type: integer
description: 'Negociação relacionada ao Lead.'
example: 321123
origin_id:
type: integer
description: 'ID da Origem.'
example: 1
origin:
type: string
description: 'Origem do lead, caso não saiba o ID.'
example: Site
message:
type: string
description: Mensagem.
example: 'Olá de chamo exemplo que gostaria de um....'
notes:
type: string
description: Observações
example: 'Cliente quer imóvel no bairro...'
ads_campaign:
type: string
description: 'ID de campanha ADS'
example: Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
ad_name:
type: string
description: 'Nome do anúncio.'
example: 'Nome Teste'
adset_name:
type: string
description: 'Nome do conjunto de anúncio.'
example: 'Conjunto Teste'
notifyUsers:
type: boolean
description: 'Define se deve notificar usuários'
example: false
fields:
type: json
description: 'Campos Extras'
example: "{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}"
required:
- name
'/persons/leads/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Lead '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
-
in: query
name: 'include[origin]'
description: 'Incluir dados da Origem do Lead'
example: id
required: false
schema:
type: string
description: 'Incluir dados da Origem do Lead'
example: id
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel vinculado'
example: 'reference,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel vinculado'
example: 'reference,title'
-
in: query
name: 'include[deal]'
description: 'Incluir dados da Origem do Lead'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados da Origem do Lead'
example: 'id,title'
-
in: query
name: 'include[formBuilder]'
description: 'Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Leads '
parameters: []
responses: {}
tags:
- Leads
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome do Lead.'
example: 'Nome do Lead'
email:
type: string
description: 'E-mail do Lead.'
example: teste@gmail.com
phone:
type: integer
description: 'Telefone do Lead.'
example: 47988888888
purpose:
type: string
description: 'Finalidade do Lead, podendo ser: change, rent, sale, season.'
example: sale
building_id:
type: integer
description: 'Imóvel que originou o Lead.'
example: 321123
deal_id:
type: integer
description: 'Negociação relacionada ao Lead.'
example: 321123
origin_id:
type: integer
description: 'ID da Origem.'
example: 1
origin:
type: string
description: 'Origem do lead, caso não saiba o ID.'
example: Site
message:
type: string
description: Mensagem.
example: 'Olá de chamo exemplo que gostaria de um....'
notes:
type: string
description: Observações
example: 'Cliente quer imóvel no bairro...'
ads_campaign:
type: string
description: 'ID de campanha ADS'
example: Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
ad_name:
type: string
description: 'Nome do anúncio.'
example: 'Nome Teste'
adset_name:
type: string
description: 'Nome do conjunto de anúncio.'
example: 'Conjunto Teste'
notifyUsers:
type: boolean
description: 'Define se deve notificar usuários'
example: false
fields:
type: json
description: 'Campos Extras'
example: "{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}"
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Leads '
parameters: []
responses: {}
tags:
- Leads
parameters:
-
in: path
name: id
description: 'ID do lead'
example: 19
required: true
schema:
type: integer
/dependency/locale/country:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,abbreviation'
-
in: query
name: 'filter[id]'
description: 'ID do País.'
example: 1
required: false
schema:
type: integer
description: 'ID do País.'
example: 1
-
in: query
name: 'filter[name]'
description: 'Nome do País.'
example: Brasil
required: false
schema:
type: string
description: 'Nome do País.'
example: Brasil
-
in: query
name: 'filter[abbreviation]'
description: 'Código ISO do País.'
example: BR
required: false
schema:
type: string
description: 'Código ISO do País.'
example: BR
-
in: query
name: 'include[states]'
description: 'Retorna os estados do país.'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os estados do país.'
example: 'id,name,abbreviation'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis do país.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os imóveis do país.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Consome crédito de IA da empresa "
operationId: geraUmResumoNOVODaNegociaoPorIAEOGravaNoNegcioENoHistricoComUseChatAAnliseDaConversaDoApreChatEntraNoDossiSeElaAindaEstiverSendoFeitaARespostaStatusprocessingEOResumoChegaPeloWebSocketeventoDealsummarygeneratedasideConsomeCrditoDeIADaEmpresaaside
description: ''
parameters: []
responses: {}
tags:
- Negócio
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
use_chat:
type: boolean
description: 'Incluir a análise da conversa do Apre.Chat (padrão: true)'
example: false
parameters:
-
in: path
name: id
description: 'ID do Negócio'
example: 11
required: true
schema:
type: integer
'/deals/{id}/summaryApplyFields':
post:
summary: 'Grava no negócio e no cliente os campos sugeridos pelo resumo que o usuário marcou.'
operationId: gravaNoNegcioENoClienteOsCamposSugeridosPeloResumoQueOUsurioMarcou
description: ''
parameters: []
responses: {}
tags:
- Negócio
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
fields:
type: object
description: 'Chave do campo (como veio em field_suggestions) → valor a gravar'
example: []
properties: {}
required:
- fields
parameters:
-
in: path
name: id
description: 'ID do Negócio'
example: 13
required: true
schema:
type: integer
'/deals/{id}/chatSummary':
get:
summary: "A análise das conversas com o cliente gravada no resumo, como estava quando ele foi gerado.\nSó leitura: não consulta o Apre.Chat."
operationId: aAnliseDasConversasComOClienteGravadaNoResumoComoEstavaQuandoEleFoiGeradoSLeituraNoConsultaOApreChat
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Etapas '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
-
in: query
name: 'filter[id]'
description: 'ID Código da Etapa.'
example: 1
required: false
schema:
type: integer
description: 'ID Código da Etapa.'
example: 1
-
in: query
name: 'filter[title]'
description: 'Título da Etapa.'
example: Interesse
required: false
schema:
type: string
description: 'Título da Etapa.'
example: Interesse
-
in: query
name: 'filter[funnel_id]'
description: 'Funil da Etapa.'
example: 12
required: false
schema:
type: integer
description: 'Funil da Etapa.'
example: 12
-
in: query
name: 'filter[position]'
description: 'Posição da Etapa.'
example: 2
required: false
schema:
type: integer
description: 'Posição da Etapa.'
example: 2
-
in: query
name: 'filter[notes]'
description: 'Descrição da Etapa.'
example: 'Etapa para interessados'
required: false
schema:
type: string
description: 'Descrição da Etapa.'
example: 'Etapa para interessados'
-
in: query
name: 'filter[deadline]'
description: 'Prazo para Repasse (dias).'
example: 10
required: false
schema:
type: integer
description: 'Prazo para Repasse (dias).'
example: 10
-
in: query
name: 'filter[color]'
description: 'Cor da Etapa.'
example: FF00FA
required: false
schema:
type: string
description: 'Cor da Etapa.'
example: FF00FA
-
in: query
name: 'filter[active]'
description: 'Etapa Ativa.'
example: true
required: false
schema:
type: boolean
description: 'Etapa Ativa.'
example: true
-
in: query
name: 'include[funnel]'
description: 'Retorna o funil.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna o funil.'
example: 'id,title'
-
in: query
name: 'include[deals]'
description: 'Retorna os negócios que estão na etapa.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os negócios que estão na etapa.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Etapas '
parameters: []
responses: {}
tags:
- 'Negócios › Etapas do Funil'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título da Etapa.'
example: Interesse
funnel_id:
type: integer
description: 'Funil da Etapa.'
example: 12
position:
type: integer
description: 'Posição da Etapa.'
example: 2
notes:
type: string
description: 'Descrição da Etapa.'
example: 'Etapa para interessados'
deadline:
type: integer
description: 'Prazo para Repasse (dias).'
example: 10
color:
type: string
description: 'Cor da Etapa.'
example: FF00FA
active:
type: boolean
description: 'Etapa Ativa.'
example: true
'/deals/funnels/steps/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Etapa '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
-
in: query
name: 'include[funnel]'
description: 'Retorna o funil.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna o funil.'
example: 'id,title'
-
in: query
name: 'include[deals]'
description: 'Retorna os negócios que estão na etapa.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os negócios que estão na etapa.'
example: 'id,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Etapas '
parameters: []
responses: {}
tags:
- 'Negócios › Etapas do Funil'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título da Etapa.'
example: Interesse
funnel_id:
type: integer
description: 'Funil da Etapa.'
example: 12
position:
type: integer
description: 'Posição da Etapa.'
example: 2
notes:
type: string
description: 'Descrição da Etapa.'
example: 'Etapa para interessados'
deadline:
type: integer
description: 'Prazo para Repasse (dias).'
example: 10
color:
type: string
description: 'Cor da Etapa.'
example: FF00FA
active:
type: boolean
description: 'Etapa Ativa.'
example: true
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Etapas '
parameters: []
responses: {}
tags:
- 'Negócios › Etapas do Funil'
parameters:
-
in: path
name: id
description: 'ID da Etapa'
example: 14
required: true
schema:
type: integer
/deals/funnels:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de cadastro de Funis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
-
in: query
name: 'filter[id]'
description: 'ID do Funil.'
example: 1
required: false
schema:
type: integer
description: 'ID do Funil.'
example: 1
-
in: query
name: 'filter[title]'
description: 'Título do Funil.'
example: 'Funil de Vendas'
required: false
schema:
type: string
description: 'Título do Funil.'
example: 'Funil de Vendas'
-
in: query
name: 'filter[notes]'
description: 'Descrição do Funil'
example: soluta
required: false
schema:
type: string
description: 'Descrição do Funil'
example: soluta
-
in: query
name: 'filter[active]'
description: 'Funil Ativo.'
example: true
required: false
schema:
type: boolean
description: 'Funil Ativo.'
example: true
-
in: query
name: 'filter[skip]'
description: 'Transferir para o próximo corretor.'
example: true
required: false
schema:
type: boolean
description: 'Transferir para o próximo corretor.'
example: true
-
in: query
name: 'filter[responsible]'
description: 'Responsávei(s) pelo Funil.'
example:
- 3324
- 5223
required: false
schema:
type: array
description: 'Responsávei(s) pelo Funil.'
example:
- 3324
- 5223
items:
type: string
-
in: query
name: 'filter[skip_step_change]'
description: 'Não altera etapa após limite de dias.'
example: false
required: false
schema:
type: boolean
description: 'Não altera etapa após limite de dias.'
example: false
-
in: query
name: 'filter[step_id_peal]'
description: 'Transferir para a etapa do Funil.'
example: 1
required: false
schema:
type: integer
description: 'Transferir para a etapa do Funil.'
example: 1
-
in: query
name: 'filter[block_step_jump]'
description: 'Bloquear pulo de etapa.'
example: false
required: false
schema:
type: boolean
description: 'Bloquear pulo de etapa.'
example: false
-
in: query
name: 'include[steps]'
description: 'Etapas do funil.'
example: 'id,title'
required: false
schema:
type: string
description: 'Etapas do funil.'
example: 'id,title'
-
in: query
name: 'include[responsibles]'
description: 'Responsáveis do Funil.'
example: 'id,name'
required: false
schema:
type: string
description: 'Responsáveis do Funil.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Funis '
parameters: []
responses: {}
tags:
- 'Negócios › Funis'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título do Funil.'
example: 'Funil de Vendas'
notes:
type: string
description: 'Descrição do Funil'
example: natus
active:
type: boolean
description: 'Funil Ativo.'
example: true
skip:
type: boolean
description: 'Transferir para o próximo corretor.'
example: true
responsible:
type: array
description: 'Responsávei(s) pelo Funil.'
example:
- 3324
- 5223
items:
type: string
skip_step_change:
type: boolean
description: 'Não altera etapa após limite de dias.'
example: false
step_id_peal:
type: integer
description: 'Transferir para a etapa do Funil.'
example: 1
block_step_jump:
type: boolean
description: 'Bloquear pulo de etapa.'
example: false
required:
- title
- responsible
'/deals/funnels/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Funis '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,title'
-
in: query
name: 'include[steps]'
description: 'Etapas do funil.'
example: 'id,title'
required: false
schema:
type: string
description: 'Etapas do funil.'
example: 'id,title'
-
in: query
name: 'include[responsibles]'
description: 'Responsáveis do Funil.'
example: 'id,name'
required: false
schema:
type: string
description: 'Responsáveis do Funil.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Funis '
parameters: []
responses: {}
tags:
- 'Negócios › Funis'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Título do Funil.'
example: 'Funil de Vendas'
notes:
type: string
description: 'Descrição do Funil'
example: minima
active:
type: boolean
description: 'Funil Ativo.'
example: true
skip:
type: boolean
description: 'Transferir para o próximo corretor.'
example: true
responsible:
type: array
description: 'Responsávei(s) pelo Funil.'
example:
- 3324
- 5223
items:
type: string
skip_step_change:
type: boolean
description: 'Não altera etapa após limite de dias.'
example: false
step_id_peal:
type: integer
description: 'Transferir para a etapa do Funil.'
example: 1
block_step_jump:
type: boolean
description: 'Bloquear pulo de etapa.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Funis '
parameters: []
responses: {}
tags:
- 'Negócios › Funis'
parameters:
-
in: path
name: id
description: 'ID do Funil'
example: 18
required: true
schema:
type: integer
'/deals/funnels/{funnel_id}/duplicate':
get:
summary: Duplicar
operationId: duplicar
description: '🔒 Para acessar essa rota é necessária a permissão para criar Funis '
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Negócios '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
-
in: query
name: 'filter[title]'
description: Título.
example: 'Título do Negócio.'
required: false
schema:
type: string
description: Título.
example: 'Título do Negócio.'
-
in: query
name: 'filter[step_id]'
description: 'Etapa do Negócio.'
example: 1
required: false
schema:
type: integer
description: 'Etapa do Negócio.'
example: 1
-
in: query
name: 'filter[step_date]'
description: 'date Data da Etapa do Negócio.'
example: '2022-08-31 00:00:00'
required: false
schema:
type: string
description: 'date Data da Etapa do Negócio.'
example: '2022-08-31 00:00:00'
-
in: query
name: 'filter[status]'
description: 'Status do Negócio.'
example: won
required: false
schema:
type: string
description: 'Status do Negócio.'
example: won
-
in: query
name: 'filter[status_date]'
description: 'date Date do Status do Negócio.'
example: '2022-12-06 10:17:16'
required: false
schema:
type: string
description: 'date Date do Status do Negócio.'
example: '2022-12-06 10:17:16'
-
in: query
name: 'filter[type]'
description: 'Tipo do Negócio (Radar).'
example: sale
required: false
schema:
type: string
description: 'Tipo do Negócio (Radar).'
example: sale
-
in: query
name: 'filter[responsible]'
description: 'Responsável(s) pelo Negócio.'
example:
- 123
- 456
- 789
required: false
schema:
type: array
description: 'Responsável(s) pelo Negócio.'
example:
- 123
- 456
- 789
items:
type: integer
-
in: query
name: 'filter[customer_id]'
description: 'Cliente do Negócio.'
example: 1234
required: false
schema:
type: integer
description: 'Cliente do Negócio.'
example: 1234
-
in: query
name: 'filter[origin_id]'
description: 'Origem do Negócio.'
example: 9
required: false
schema:
type: integer
description: 'Origem do Negócio.'
example: 9
-
in: query
name: 'filter[price]'
description: 'Valor do Negócio.'
example: '1500.00'
required: false
schema:
type: string
description: 'Valor do Negócio.'
example: '1500.00'
-
in: query
name: 'filter[date]'
description: 'date Data do Negócio.'
example: '2020-04-30'
required: false
schema:
type: string
description: 'date Data do Negócio.'
example: '2020-04-30'
-
in: query
name: 'filter[forecast]'
description: 'date Data da previsão de finalização do Negócio.'
example: '2020-05-30'
required: false
schema:
type: string
description: 'date Data da previsão de finalização do Negócio.'
example: '2020-05-30'
-
in: query
name: 'filter[potential]'
description: 'Potencial do Negócio. Options: cold, hot, scalding, warm.'
example: hot
required: false
schema:
type: string
description: 'Potencial do Negócio. Options: cold, hot, scalding, warm.'
example: hot
-
in: query
name: 'filter[radar]'
description: 'Radar Ativo para o Negócio.'
example: true
required: false
schema:
type: boolean
description: 'Radar Ativo para o Negócio.'
example: true
-
in: query
name: 'filter[private]'
description: 'Visibilidade do Negócio.'
example: false
required: false
schema:
type: boolean
description: 'Visibilidade do Negócio.'
example: false
-
in: query
name: 'filter[position]'
description: 'Posição do negócio (Kanban).'
example: 3
required: false
schema:
type: integer
description: 'Posição do negócio (Kanban).'
example: 3
-
in: query
name: 'filter[tag]'
description: 'Tags para o Negócio.'
example:
- 1326
- 1306
- 1305
required: false
schema:
type: array
description: 'Tags para o Negócio.'
example:
- 1326
- 1306
- 1305
items:
type: integer
-
in: query
name: 'filter[building]'
description: 'Imóveis para o Negócio.'
example:
- 13914
- 15155
- 15467
required: false
schema:
type: array
description: 'Imóveis para o Negócio.'
example:
- 13914
- 15155
- 15467
items:
type: integer
-
in: query
name: 'filter[extend]'
description: 'date Prorrogação do Negócio.'
example: '2022-02-21'
required: false
schema:
type: string
description: 'date Prorrogação do Negócio.'
example: '2022-02-21'
-
in: query
name: 'filter[reason_id]'
description: 'Motivo do Negócio quando o status é alterado.'
example: 1
required: false
schema:
type: integer
description: 'Motivo do Negócio quando o status é alterado.'
example: 1
-
in: query
name: 'filter[reason_notes]'
description: 'Observações do motivo quando o status do Negócio é alterado.'
example: 'Cliente ganho'
required: false
schema:
type: string
description: 'Observações do motivo quando o status do Negócio é alterado.'
example: 'Cliente ganho'
-
in: query
name: 'filter[building_type]'
description: 'Tipos de Imóveis para o Radar de Negócio.'
example:
- 5
- 1
- 3
required: false
schema:
type: array
description: 'Tipos de Imóveis para o Radar de Negócio.'
example:
- 5
- 1
- 3
items:
type: integer
-
in: query
name: 'filter[building_stage]'
description: 'Estágio dos Imóveis para o Radar de Negócio.'
example:
- 3
required: false
schema:
type: array
description: 'Estágio dos Imóveis para o Radar de Negócio.'
example:
- 3
items:
type: integer
-
in: query
name: 'filter[building_furnishing]'
description: 'Mobília dos Imóveis para o Radar de Negócio.'
example: null
required: false
schema:
type: array
description: 'Mobília dos Imóveis para o Radar de Negócio.'
example: null
items:
type: string
-
in: query
name: 'filter[building_price_min]'
description: 'Valor mínimo dos Imóveis do Negócio (Radar).'
example: '1500.00'
required: false
schema:
type: string
description: 'Valor mínimo dos Imóveis do Negócio (Radar).'
example: '1500.00'
-
in: query
name: 'filter[building_price_max]'
description: 'Valor máximo dos Imóveis do Negócio (Radar).'
example: '2500.00'
required: false
schema:
type: string
description: 'Valor máximo dos Imóveis do Negócio (Radar).'
example: '2500.00'
-
in: query
name: 'filter[building_bedroom]'
description: 'Quantidade de quartos para o Radar de Negócio.'
example: 2
required: false
schema:
type: integer
description: 'Quantidade de quartos para o Radar de Negócio.'
example: 2
-
in: query
name: 'filter[building_living_room]'
description: 'Quantidade de salas para o Radar de Negócio.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade de salas para o Radar de Negócio.'
example: 1
-
in: query
name: 'filter[building_parking]'
description: 'Quantidade de vagas de estacionamento para o Radar de Negócio.'
example: 1
required: false
schema:
type: integer
description: 'Quantidade de vagas de estacionamento para o Radar de Negócio.'
example: 1
-
in: query
name: 'filter[building_bathroom]'
description: 'Quantidade de banheiros para o Radar de Negócio.'
example: 3
required: false
schema:
type: integer
description: 'Quantidade de banheiros para o Radar de Negócio.'
example: 3
-
in: query
name: 'filter[building_area]'
description: 'Área em metros quadrados para o Radar de Negócio.'
example: 120
required: false
schema:
type: integer
description: 'Área em metros quadrados para o Radar de Negócio.'
example: 120
-
in: query
name: 'filter[building_district]'
description: 'Bairro para o Radar de Negócio.'
example: '1'
required: false
schema:
type: string
description: 'Bairro para o Radar de Negócio.'
example: '1'
-
in: query
name: 'filter[building_city]'
description: 'Cidade para o Radar de Negócio.'
example: '3'
required: false
schema:
type: string
description: 'Cidade para o Radar de Negócio.'
example: '3'
-
in: query
name: 'filter[building_detail]'
description: 'Detalhes do Imóvel para o Radar de Negócio.'
example:
- 9889
- 29988
required: false
schema:
type: array
description: 'Detalhes do Imóvel para o Radar de Negócio.'
example:
- 9889
- 29988
items:
type: integer
-
in: query
name: 'filter[building_check_in]'
description: 'date Check-in do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
required: false
schema:
type: string
description: 'date Check-in do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
-
in: query
name: 'filter[building_check_out]'
description: 'date Check-out do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
required: false
schema:
type: string
description: 'date Check-out do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
-
in: query
name: 'filter[building_accommodation]'
description: 'Quantidade de acomodações do Imóvel para o Radar de Negócio.'
example: 4
required: false
schema:
type: integer
description: 'Quantidade de acomodações do Imóvel para o Radar de Negócio.'
example: 4
-
in: query
name: 'include[tags]'
description: 'Retorna as tags do negócio'
example: inventore
required: false
schema:
type: string
description: 'Retorna as tags do negócio'
example: inventore
-
in: query
name: 'include[notifications]'
description: 'Retorna as notificações do negócio'
example: possimus
required: false
schema:
type: string
description: 'Retorna as notificações do negócio'
example: possimus
-
in: query
name: 'include[contracts]'
description: 'Retorna os contratos vinculados ao negócio'
example: minus
required: false
schema:
type: string
description: 'Retorna os contratos vinculados ao negócio'
example: minus
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis vinculados ao negócio'
example: eos
required: false
schema:
type: string
description: 'Retorna os imóveis vinculados ao negócio'
example: eos
-
in: query
name: 'include[responsibles]'
description: 'Retorna os responsáveis do negócio'
example: quis
required: false
schema:
type: string
description: 'Retorna os responsáveis do negócio'
example: quis
-
in: query
name: 'include[creator]'
description: 'Retorna o criador do negócio'
example: repellendus
required: false
schema:
type: string
description: 'Retorna o criador do negócio'
example: repellendus
-
in: query
name: 'include[customer]'
description: 'Retorna o cliente do negócio'
example: ut
required: false
schema:
type: string
description: 'Retorna o cliente do negócio'
example: ut
-
in: query
name: 'include[proposals]'
description: 'Retorna as propostas do negócio'
example: officia
required: false
schema:
type: string
description: 'Retorna as propostas do negócio'
example: officia
-
in: query
name: 'include[activeProposals]'
description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
example: dolores
required: false
schema:
type: string
description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
example: dolores
-
in: query
name: 'include[leads]'
description: 'Retorna os leads do negócio'
example: ipsa
required: false
schema:
type: string
description: 'Retorna os leads do negócio'
example: ipsa
-
in: query
name: 'include[reason]'
description: 'Retorna o motivo do status do negócio.'
example: 'id,notes'
required: false
schema:
type: string
description: 'Retorna o motivo do status do negócio.'
example: 'id,notes'
-
in: query
name: 'include[step]'
description: 'Retorna a etapa do negócio.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna a etapa do negócio.'
example: 'id,description'
-
in: query
name: 'include[files]'
description: 'Retorna os arquivos do negócio.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna os arquivos do negócio.'
example: 'id,file_name'
-
in: query
name: 'include[origin]'
description: 'Retorna a origem do negócio.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a origem do negócio.'
example: 'id,name'
-
in: query
name: 'include[lastHistory]'
description: 'Retorna o último histórico da negociação.'
example: 'id,created_at'
required: false
schema:
type: string
description: 'Retorna o último histórico da negociação.'
example: 'id,created_at'
-
in: query
name: 'include[districts]'
description: 'Retorna os bairros dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os bairros dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[cities]'
description: 'Retorna as cidades dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as cidades dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[details]'
description: 'Retorna os detalhes dos imóveis (Radar).'
example: id
required: false
schema:
type: string
description: 'Retorna os detalhes dos imóveis (Radar).'
example: id
-
in: query
name: 'include[buildingTypes]'
description: 'Retorna os tipos dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os tipos dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[buildingStages]'
description: 'Retorna os estágios dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os estágios dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[eventsNotConcludedNonRecurring]'
description: 'Retorna eventos não recorrentes que não estão concluídos.'
example: 'id,type,title'
required: false
schema:
type: string
description: 'Retorna eventos não recorrentes que não estão concluídos.'
example: 'id,type,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Negócio '
parameters: []
responses: {}
tags:
- Negócios
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: Título.
example: 'Título do Negócio.'
step_id:
type: integer
description: 'Etapa do Negócio.'
example: 1
step_date:
type: date
description: 'Data da Etapa do Negócio.'
example: '2022-08-31 00:00:00'
status:
type: string
description: 'Status do Negócio.'
example: won
status_date:
type: date
description: 'Date do Status do Negócio.'
example: '2022-12-06 10:17:16'
type:
type: string
description: 'Tipo do Negócio (Radar).'
example: sale
responsible:
type: array
description: 'Responsável(s) pelo Negócio.'
example:
- 123
- 456
- 789
items:
type: integer
customer_id:
type: integer
description: 'Cliente do Negócio.'
example: 1234
origin_id:
type: integer
description: 'Origem do Negócio.'
example: 9
created_by:
type: integer
description: 'Criado por.'
example: 12
price:
type: string
description: 'Valor do Negócio.'
example: '1500.00'
date:
type: date
description: 'Data do Negócio.'
example: '2020-04-30'
forecast:
type: date
description: 'Data da previsão de finalização do Negócio.'
example: '2020-05-30'
potential:
type: string
description: 'Potencial do Negócio. Options: cold, hot, scalding, warm.'
example: hot
radar:
type: boolean
description: 'Radar Ativo para o Negócio.'
example: true
private:
type: boolean
description: 'Visibilidade do Negócio.'
example: true
position:
type: integer
description: 'Posição do negócio (Kanban).'
example: 3
tag:
type: array
description: 'Tags para o Negócio.'
example:
- 1326
- 1306
- 1305
items:
type: integer
building:
type: array
description: 'Imóveis para o Negócio.'
example:
- 13914
- 15155
- 15467
items:
type: integer
extend:
type: date
description: 'Prorrogação do Negócio.'
example: '2022-02-21'
reason_id:
type: integer
description: 'Motivo do Negócio quando o status é alterado.'
example: 1
reason_notes:
type: string
description: 'Observações do motivo quando o status do Negócio é alterado.'
example: 'Cliente ganho'
building_type:
type: array
description: 'Tipos de Imóveis para o Radar de Negócio.'
example:
- 5
- 1
- 3
items:
type: integer
building_stage:
type: array
description: 'Estágio dos Imóveis para o Radar de Negócio.'
example:
- 3
items:
type: integer
building_furnishing:
type: array
description: 'Mobília dos Imóveis para o Radar de Negócio.'
example: null
items:
type: string
building_price_min:
type: string
description: 'Valor mínimo dos Imóveis do Negócio (Radar).'
example: '1500.00'
building_price_max:
type: string
description: 'Valor máximo dos Imóveis do Negócio (Radar).'
example: '2500.00'
building_bedroom:
type: integer
description: 'Quantidade de quartos para o Radar de Negócio.'
example: 2
building_living_room:
type: integer
description: 'Quantidade de salas para o Radar de Negócio.'
example: 1
building_parking:
type: integer
description: 'Quantidade de vagas de estacionamento para o Radar de Negócio.'
example: 1
building_bathroom:
type: integer
description: 'Quantidade de banheiros para o Radar de Negócio.'
example: 3
building_area:
type: integer
description: 'Área em metros quadrados para o Radar de Negócio.'
example: 120
building_district:
type: string
description: 'Bairro para o Radar de Negócio.'
example: '1'
building_city:
type: string
description: 'Cidade para o Radar de Negócio.'
example: '3'
building_detail:
type: array
description: 'Detalhes do Imóvel para o Radar de Negócio.'
example:
- 9889
- 29988
items:
type: integer
building_check_in:
type: date
description: 'Check-in do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
building_check_out:
type: date
description: 'Check-out do Imóvel para o Radar de Negócio.'
example: '2022-02-21'
building_accommodation:
type: integer
description: 'Quantidade de acomodações do Imóvel para o Radar de Negócio.'
example: 4
required:
- title
- step_id
- responsible
- customer_id
- created_by
'/deals/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Negócios '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,phone,email'
-
in: query
name: 'include[tags]'
description: 'Retorna as tags do negócio'
example: et
required: false
schema:
type: string
description: 'Retorna as tags do negócio'
example: et
-
in: query
name: 'include[notifications]'
description: 'Retorna as notificações do negócio'
example: accusantium
required: false
schema:
type: string
description: 'Retorna as notificações do negócio'
example: accusantium
-
in: query
name: 'include[contracts]'
description: 'Retorna os contratos vinculados ao negócio'
example: ullam
required: false
schema:
type: string
description: 'Retorna os contratos vinculados ao negócio'
example: ullam
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis vinculados ao negócio'
example: quaerat
required: false
schema:
type: string
description: 'Retorna os imóveis vinculados ao negócio'
example: quaerat
-
in: query
name: 'include[responsibles]'
description: 'Retorna os responsáveis do negócio'
example: quos
required: false
schema:
type: string
description: 'Retorna os responsáveis do negócio'
example: quos
-
in: query
name: 'include[creator]'
description: 'Retorna o criador do negócio'
example: magni
required: false
schema:
type: string
description: 'Retorna o criador do negócio'
example: magni
-
in: query
name: 'include[customer]'
description: 'Retorna o cliente do negócio'
example: rerum
required: false
schema:
type: string
description: 'Retorna o cliente do negócio'
example: rerum
-
in: query
name: 'include[proposals]'
description: 'Retorna as propostas do negócio'
example: eos
required: false
schema:
type: string
description: 'Retorna as propostas do negócio'
example: eos
-
in: query
name: 'include[activeProposals]'
description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
example: omnis
required: false
schema:
type: string
description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
example: omnis
-
in: query
name: 'include[leads]'
description: 'Retorna os leads do negócio'
example: et
required: false
schema:
type: string
description: 'Retorna os leads do negócio'
example: et
-
in: query
name: 'include[reason]'
description: 'Retorna o motivo do status do negócio.'
example: 'id,notes'
required: false
schema:
type: string
description: 'Retorna o motivo do status do negócio.'
example: 'id,notes'
-
in: query
name: 'include[step]'
description: 'Retorna a etapa do negócio.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna a etapa do negócio.'
example: 'id,description'
-
in: query
name: 'include[files]'
description: 'Retorna os arquivos do negócio.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna os arquivos do negócio.'
example: 'id,file_name'
-
in: query
name: 'include[origin]'
description: 'Retorna a origem do negócio.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a origem do negócio.'
example: 'id,name'
-
in: query
name: 'include[lastHistory]'
description: 'Retorna o último histórico da negociação.'
example: 'id,created_at'
required: false
schema:
type: string
description: 'Retorna o último histórico da negociação.'
example: 'id,created_at'
-
in: query
name: 'include[districts]'
description: 'Retorna os bairros dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os bairros dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[cities]'
description: 'Retorna as cidades dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as cidades dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[details]'
description: 'Retorna os detalhes dos imóveis (Radar).'
example: id
required: false
schema:
type: string
description: 'Retorna os detalhes dos imóveis (Radar).'
example: id
-
in: query
name: 'include[buildingTypes]'
description: 'Retorna os tipos dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os tipos dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[buildingStages]'
description: 'Retorna os estágios dos imóveis (Radar).'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os estágios dos imóveis (Radar).'
example: 'id,name'
-
in: query
name: 'include[eventsNotConcludedNonRecurring]'
description: 'Retorna eventos não recorrentes que não estão concluídos.'
example: 'id,type,title'
required: false
schema:
type: string
description: 'Retorna eventos não recorrentes que não estão concluídos.'
example: 'id,type,title'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de exclusão de Negócios '
parameters: []
responses: {}
tags:
- Negócios
parameters:
-
in: path
name: id
description: 'ID do Negócio'
example: 13
required: true
schema:
type: integer
'/deals/{deal_id}/duplicate':
put:
summary: Duplicar
operationId: duplicar
description: ''
parameters: []
responses: {}
tags:
- Negócios
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
medias:
type: boolean
description: 'Define se duplica os imóveis vinculados ao Negócio'
example: true
season_packs:
type: boolean
description: 'Define se duplica os documentos do Negócio'
example: false
parameters:
-
in: path
name: deal_id
description: 'ID do Negócio'
example: 6
required: true
schema:
type: integer
'/persons/approve/{person_id}':
put:
summary: Aprovar
operationId: aprovar
description: '🔒 Para acessar essa rota são necessárias as permissões de Aprovar Pessoas '
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
check:
type: boolean
description: 'Aprovar cadastro da pessoa.'
example: true
merge:
type: boolean
description: 'Indica se deve unificar os dados da pessoa.'
example: true
parameters:
-
in: path
name: person_id
description: 'ID da pessoa'
example: 20
required: true
schema:
type: integer
/persons/cnpjLookup:
post:
summary: 'Consultar CNPJ'
operationId: consultarCNPJ
description: 'Consulta a base de Dados Abertos CNPJ da Receita Federal e retorna os dados da empresa para preenchimento automático do cadastro.'
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cnpj:
type: string
description: 'CNPJ com 14 dígitos.'
example: '00000000000191'
required:
- cnpj
/persons/cnpjSearch:
post:
summary: 'Buscar empresa por nome'
operationId: buscarEmpresaPorNome
description: 'Busca reversa na base de Dados Abertos CNPJ por razão social ou nome fantasia, retornando empresas ativas para autocomplete.'
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
term:
type: string
description: 'Termo de busca (mínimo 3 caracteres).'
example: 'DESC IMOVEIS'
required:
- term
/persons/cpfLookup:
post:
summary: 'Consultar CPF'
operationId: consultarCPF
description: "Consulta os dados cadastrais do CPF na BigDataCorp e retorna o resultado normalizado para preenchimento automático do cadastro de pessoas. Consome créditos do módulo Consulta de CPF.\n\n🔒 Requer a permissão CONTATO_CONTATO_CONSULTAR_CPF. "
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cpf:
type: string
description: 'CPF com 11 dígitos.'
example: '52998224725'
force:
type: boolean
description: 'Ignora a ficha já gravada e consulta a BigDataCorp de novo.'
example: false
required:
- cpf
/persons/readDocument:
post:
summary: 'Ler documento e sugerir o cadastro'
operationId: lerDocumentoESugerirOCadastro
description: "Lê RG, CNH, ficha cadastral, contrato social ou cartão CNPJ anexado e devolve o que o documento\npermite preencher, agrupado por cadastro, contato, conta bancária e cônjuge. NÃO grava nada: o\nretorno é rascunho para a tela de conferência, e quem grava é o cadastro normal depois de o\nusuário conferir."
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
files:
type: array
description: 'Arquivos já enviados, no formato do componente de anexo.'
example:
- []
items:
type: object
current:
type: object
description: "O que já está preenchido no formulário, para marcar o que muda.\n\n🔒 Requer permissão CONTATO_CONTATO_CADASTRAR "
example: []
properties: {}
required:
- files
/persons/contacts:
post:
summary: Contatos
operationId: contatos
description: 'Telefones, celulares e e-mails da pessoa (usado pelo popup de contato dos grids)'
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: 'ID da pessoa.'
example: 12
required:
- id
/persons/occupations:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'filter[id]'
description: 'ID da profissão.'
example: '123'
required: false
schema:
type: string
description: 'ID da profissão.'
example: '123'
-
in: query
name: 'filter[name]'
description: 'Nome da profissão.'
example: '%Açougueiro%'
required: false
schema:
type: string
description: 'Nome da profissão.'
example: '%Açougueiro%'
-
in: query
name: 'filter[reference]'
description: 'Referência da profissão.'
example: '%Frigorífico%'
required: false
schema:
type: string
description: 'Referência da profissão.'
example: '%Frigorífico%'
-
in: query
name: 'include[persons]'
description: 'Retorna as pessoas vinculadas à profissão.'
example: 'id,name,gender'
required: false
schema:
type: string
description: 'Retorna as pessoas vinculadas à profissão.'
example: 'id,name,gender'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contato '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'filter[id]'
description: 'ID do contato.'
example: 1
required: false
schema:
type: integer
description: 'ID do contato.'
example: 1
-
in: query
name: 'filter[person_id]'
description: Pessoa.
example: 123
required: false
schema:
type: integer
description: Pessoa.
example: 123
-
in: query
name: 'filter[country_id]'
description: País.
example: 1
required: false
schema:
type: integer
description: País.
example: 1
-
in: query
name: 'filter[state_id]'
description: Estado.
example: 24
required: false
schema:
type: integer
description: Estado.
example: 24
-
in: query
name: 'filter[city_id]'
description: Cidade.
example: 3
required: false
schema:
type: integer
description: Cidade.
example: 3
-
in: query
name: 'filter[district_id]'
description: Bairro.
example: 12
required: false
schema:
type: integer
description: Bairro.
example: 12
-
in: query
name: 'filter[zip_code]'
description: CEP.
example: 89160000
required: false
schema:
type: integer
description: CEP.
example: 89160000
-
in: query
name: 'filter[street]'
description: Rua.
example: '%Rua México%'
required: false
schema:
type: string
description: Rua.
example: '%Rua México%'
-
in: query
name: 'filter[number]'
description: Número.
example: '1090'
required: false
schema:
type: string
description: Número.
example: '1090'
-
in: query
name: 'filter[complement]'
description: 'Complemento de endereço.'
example: Casa
required: false
schema:
type: string
description: 'Complemento de endereço.'
example: Casa
-
in: query
name: 'filter[description]'
description: Descrição.
example: Marcelo
required: false
schema:
type: string
description: Descrição.
example: Marcelo
-
in: query
name: 'filter[cellphone]'
description: Celular.
example: '47988888888'
required: false
schema:
type: string
description: Celular.
example: '47988888888'
-
in: query
name: 'filter[phone]'
description: Telefone.
example: '4735310000'
required: false
schema:
type: string
description: Telefone.
example: '4735310000'
-
in: query
name: 'filter[email]'
description: E-mail.
example: mail@example.com
required: false
schema:
type: string
description: E-mail.
example: mail@example.com
-
in: query
name: 'filter[principal]'
description: 'Contato Principal.'
example: true
required: false
schema:
type: boolean
description: 'Contato Principal.'
example: true
-
in: query
name: 'filter[financial]'
description: 'Contato Financeiro.'
example: false
required: false
schema:
type: boolean
description: 'Contato Financeiro.'
example: false
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa.'
example: 'id,name'
-
in: query
name: 'include[country]'
description: 'Retorna os dados do país.'
example: 'id,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do país.'
example: 'id,abbreviation'
-
in: query
name: 'include[city]'
description: 'Retorna os dados da cidade.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da cidade.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna os dados do estado.'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do estado.'
example: 'id,name,abbreviation'
-
in: query
name: 'include[district]'
description: 'Retorna os dados do bairro.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do bairro.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Contato '
parameters: []
responses: {}
tags:
- 'Pessoas › Contatos'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
person_id:
type: integer
description: 'ID da Pessoa.'
example: 123
country_id:
type: integer
description: 'ID do País.'
example: 1
state_id:
type: integer
description: 'ID do Estado.'
example: 24
city_id:
type: integer
description: 'ID do Cidade.'
example: 3
district_id:
type: integer
description: 'ID do Bairro.'
example: 12
zip_code:
type: integer
description: CEP.
example: 89160000
street:
type: string
description: Rua.
example: '%Rua México%'
number:
type: string
description: Número.
example: '1090'
complement:
type: string
description: 'Complemento de endereço.'
example: Casa
description:
type: string
description: Descrição.
example: Marcelo
cellphone:
type: string
description: Celular.
example: '47988888888'
phone:
type: string
description: Telefone.
example: '4735310000'
email:
type: string
description: E-mail.
example: mail@example.com
principal:
type: boolean
description: 'Contato Principal.'
example: true
financial:
type: boolean
description: 'Contato Financeiro.'
example: false
required:
- person_id
parameters:
-
in: path
name: person_id
description: 'Optional parameter. ID da Pessoa'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 6
'/persons/{person_id}/contacts/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contato '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa.'
example: 'id,name'
-
in: query
name: 'include[country]'
description: 'Retorna os dados do país.'
example: 'id,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do país.'
example: 'id,abbreviation'
-
in: query
name: 'include[city]'
description: 'Retorna os dados da cidade.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da cidade.'
example: 'id,name'
-
in: query
name: 'include[state]'
description: 'Retorna os dados do estado.'
example: 'id,name,abbreviation'
required: false
schema:
type: string
description: 'Retorna os dados do estado.'
example: 'id,name,abbreviation'
-
in: query
name: 'include[district]'
description: 'Retorna os dados do bairro.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do bairro.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Contato '
parameters: []
responses: {}
tags:
- 'Pessoas › Contatos'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
country_id:
type: integer
description: 'ID do País.'
example: 1
state_id:
type: integer
description: 'ID do Estado.'
example: 24
city_id:
type: integer
description: 'ID do Cidade.'
example: 3
district_id:
type: integer
description: 'ID do Bairro.'
example: 12
zip_code:
type: integer
description: CEP.
example: 89160000
street:
type: string
description: Rua.
example: '%Rua México%'
number:
type: string
description: Número.
example: '1090'
complement:
type: string
description: 'Complemento de endereço.'
example: Casa
description:
type: string
description: Descrição.
example: Marcelo
cellphone:
type: string
description: Celular.
example: '47988888888'
phone:
type: string
description: Telefone.
example: '4735310000'
email:
type: string
description: E-mail.
example: mail@example.com
principal:
type: boolean
description: 'Contato Principal.'
example: true
financial:
type: boolean
description: 'Contato Financeiro.'
example: false
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Contato '
parameters: []
responses: {}
tags:
- 'Pessoas › Contatos'
parameters:
-
in: path
name: person_id
description: 'ID da Pessoa'
example: 3
required: true
schema:
type: integer
-
in: path
name: id
description: 'ID do contato'
example: 13
required: true
schema:
type: integer
'/persons/{person_id}/bankAccounts':
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoa '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'filter[id]'
description: 'ID da conta.'
example: 123
required: false
schema:
type: integer
description: 'ID da conta.'
example: 123
-
in: query
name: 'filter[person_id]'
description: 'ID da Pessoa.'
example: 321
required: false
schema:
type: integer
description: 'ID da Pessoa.'
example: 321
-
in: query
name: 'filter[description]'
description: Descrição.
example: Itaú
required: false
schema:
type: string
description: Descrição.
example: Itaú
-
in: query
name: 'filter[holder]'
description: 'Nome do titular.'
example: 'Ciclano Fulano'
required: false
schema:
type: string
description: 'Nome do titular.'
example: 'Ciclano Fulano'
-
in: query
name: 'filter[person_type]'
description: 'Tipo de Pessoa (física ou jurídica)'
example: J
required: false
schema:
type: string
description: 'Tipo de Pessoa (física ou jurídica)'
example: J
-
in: query
name: 'filter[tax_id]'
description: 'CPF/CNPJ: 99999999999'
example: 14
required: false
schema:
type: integer
description: 'CPF/CNPJ: 99999999999'
example: 14
-
in: query
name: 'filter[birth_date]'
description: 'date Data de Nascimento.'
example: '1999-06-09'
required: false
schema:
type: string
description: 'date Data de Nascimento.'
example: '1999-06-09'
-
in: query
name: 'filter[type]'
description: 'Tipo da Conta.'
example: CC
required: false
schema:
type: string
description: 'Tipo da Conta.'
example: CC
-
in: query
name: 'filter[pix_type]'
description: 'Tipo da chave PIX.'
example: email
required: false
schema:
type: string
description: 'Tipo da chave PIX.'
example: email
-
in: query
name: 'filter[pix_key]'
description: 'Chave PIX.'
example: mail@example.com
required: false
schema:
type: string
description: 'Chave PIX.'
example: mail@example.com
-
in: query
name: 'filter[bank]'
description: 'Código do Banco.'
example: 260
required: false
schema:
type: integer
description: 'Código do Banco.'
example: 260
-
in: query
name: 'filter[agency]'
description: Agência.
example: '0223'
required: false
schema:
type: string
description: Agência.
example: '0223'
-
in: query
name: 'filter[account]'
description: Conta.
example: 2140104-7
required: false
schema:
type: string
description: Conta.
example: 2140104-7
-
in: query
name: 'filter[principal]'
description: 'Conta principal.'
example: true
required: false
schema:
type: boolean
description: 'Conta principal.'
example: true
-
in: query
name: 'filter[active]'
description: 'Status da conta.'
example: true
required: false
schema:
type: boolean
description: 'Status da conta.'
example: true
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de Cadastro de Pessoa '
parameters: []
responses: {}
tags:
- 'Pessoas › Contas Bancárias'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
person_id:
type: integer
description: 'ID da Pessoa.'
example: 321
description:
type: string
description: Descrição.
example: Itaú
holder:
type: string
description: 'Nome do titular.'
example: 'Ciclano Fulano'
person_type:
type: string
description: 'Tipo de Pessoa (física ou jurídica)'
example: J
tax_id:
type: integer
description: 'CPF/CNPJ: 99999999999'
example: 18
birth_date:
type: date
description: 'Data de Nascimento.'
example: '1999-06-09'
type:
type: string
description: 'Tipo da Conta.'
example: CC
pix_type:
type: string
description: 'Tipo da chave PIX.'
example: email
pix_key:
type: string
description: 'Chave PIX.'
example: mail@example.com
bank:
type: integer
description: 'Código do Banco.'
example: 260
agency:
type: string
description: Agência.
example: '0223'
account:
type: string
description: Conta.
example: 2140104-7
principal:
type: boolean
description: 'Conta principal.'
example: true
active:
type: boolean
description: 'Status da conta.'
example: true
parameters:
-
in: path
name: person_id
description: 'Optional parameter. ID da Pessoa'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 6
'/persons/{person_id}/bankAccounts/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoa '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa.'
example: 'id,name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de Edição de Pessoa '
parameters: []
responses: {}
tags:
- 'Pessoas › Contas Bancárias'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
person_id:
type: integer
description: 'ID da Pessoa.'
example: 321
description:
type: string
description: Descrição.
example: Itaú
holder:
type: string
description: 'Nome do titular.'
example: 'Ciclano Fulano'
person_type:
type: string
description: 'Tipo de Pessoa (física ou jurídica)'
example: J
tax_id:
type: integer
description: 'CPF/CNPJ: 99999999999'
example: 17
birth_date:
type: date
description: 'Data de Nascimento.'
example: '1999-06-09'
type:
type: string
description: 'Tipo da Conta.'
example: CC
pix_type:
type: string
description: 'Tipo da chave PIX.'
example: email
pix_key:
type: string
description: 'Chave PIX.'
example: mail@example.com
bank:
type: integer
description: 'Código do Banco.'
example: 260
agency:
type: string
description: Agência.
example: '0223'
account:
type: string
description: Conta.
example: 2140104-7
principal:
type: boolean
description: 'Conta principal.'
example: true
active:
type: boolean
description: 'Status da conta.'
example: true
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de Exclusão de Pessoa '
parameters: []
responses: {}
tags:
- 'Pessoas › Contas Bancárias'
parameters:
-
in: path
name: person_id
description: 'int ID da Pessoa'
example: omnis
required: true
schema:
type: string
-
in: path
name: id
description: 'ID da Conta Bancária'
example: 19
required: true
schema:
type: integer
/persons:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoas '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,tax_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,tax_id'
-
in: query
name: 'filter[id]'
description: 'ID da pessoa.'
example: 2
required: false
schema:
type: integer
description: 'ID da pessoa.'
example: 2
-
in: query
name: 'filter[id2]'
description: 'ID por empresa da pessoa.'
example: 2
required: false
schema:
type: integer
description: 'ID por empresa da pessoa.'
example: 2
-
in: query
name: 'filter[name]'
description: 'Nome da pessoa.'
example: carlos%
required: false
schema:
type: string
description: 'Nome da pessoa.'
example: carlos%
-
in: query
name: 'filter[responsible]'
description: 'Filtra por usuários responsáveis.'
example: '3,5'
required: false
schema:
type: string
description: 'Filtra por usuários responsáveis.'
example: '3,5'
-
in: query
name: 'filter[type]'
description: 'Vínculo com a imobiliária.'
example: owner
required: false
schema:
type: string
description: 'Vínculo com a imobiliária.'
example: owner
-
in: query
name: 'filter[access]'
description: 'Tipo de acesso à pessoa.'
example: all
required: false
schema:
type: string
description: 'Tipo de acesso à pessoa.'
example: all
-
in: query
name: 'filter[active]'
description: 'Pessoas ativas.'
example: true
required: false
schema:
type: boolean
description: 'Pessoas ativas.'
example: true
-
in: query
name: 'filter[origin_id]'
description: 'ID de origem.'
example: 29
required: false
schema:
type: integer
description: 'ID de origem.'
example: 29
-
in: query
name: 'filter[reference]'
description: Referência.
example: R55
required: false
schema:
type: string
description: Referência.
example: R55
-
in: query
name: 'filter[gender]'
description: Sexo.
example: M
required: false
schema:
type: string
description: Sexo.
example: M
-
in: query
name: 'filter[approved]'
description: 'Pessoas aprovadas.'
example: true
required: false
schema:
type: boolean
description: 'Pessoas aprovadas.'
example: true
-
in: query
name: 'filter[juridical]'
description: 'Tipo de pessoa (física, jurídica).'
example: F
required: false
schema:
type: string
description: 'Tipo de pessoa (física, jurídica).'
example: F
-
in: query
name: 'filter[tax_id]'
description: CPF/CNPJ.
example: '57157949008'
required: false
schema:
type: string
description: CPF/CNPJ.
example: '57157949008'
-
in: query
name: 'filter[tag]'
description: Tags.
example: 1182
required: false
schema:
type: integer
description: Tags.
example: 1182
-
in: query
name: 'filter[rg]'
description: RG.
example: 45.461.713-6
required: false
schema:
type: string
description: RG.
example: 45.461.713-6
-
in: query
name: 'filter[rg_emmiter]'
description: 'Emissor do RG.'
example: ssp
required: false
schema:
type: string
description: 'Emissor do RG.'
example: ssp
-
in: query
name: 'filter[rg_dispatcher]'
description: 'Data de Emissão do RG.'
example: '2011-09-08'
required: false
schema:
type: string
description: 'Data de Emissão do RG.'
example: '2011-09-08'
-
in: query
name: 'filter[cnh]'
description: 'N° da CNH.'
example: '43375783744'
required: false
schema:
type: string
description: 'N° da CNH.'
example: '43375783744'
-
in: query
name: 'filter[nationality]'
description: Nacionalidade.
example: Brasileira
required: false
schema:
type: string
description: Nacionalidade.
example: Brasileira
-
in: query
name: 'filter[naturality]'
description: Naturalidade.
example: 'Rio do Sul'
required: false
schema:
type: string
description: Naturalidade.
example: 'Rio do Sul'
-
in: query
name: 'filter[birthplace]'
description: 'Local de nascimento.'
example: 'Rio do Sul'
required: false
schema:
type: string
description: 'Local de nascimento.'
example: 'Rio do Sul'
-
in: query
name: 'filter[birth_date]'
description: 'Data de nascimento.'
example: '2011-09-08'
required: false
schema:
type: string
description: 'Data de nascimento.'
example: '2011-09-08'
-
in: query
name: 'filter[marital]'
description: 'Estado civil.'
example: married
required: false
schema:
type: string
description: 'Estado civil.'
example: married
-
in: query
name: 'filter[spouse_id]'
description: 'ID do cônjuge.'
example: 5
required: false
schema:
type: integer
description: 'ID do cônjuge.'
example: 5
-
in: query
name: 'filter[legal_representative_id]'
description: 'ID do Representante legal.'
example: 80
required: false
schema:
type: integer
description: 'ID do Representante legal.'
example: 80
-
in: query
name: 'filter[contacted_at]'
description: 'Data de contato.'
example: '2021-03-22 11:31:00'
required: false
schema:
type: string
description: 'Data de contato.'
example: '2021-03-22 11:31:00'
-
in: query
name: 'filter[last_contact_at]'
description: 'Última data de contato via Lead.'
example: '2021-03-22 11:31:00'
required: false
schema:
type: string
description: 'Última data de contato via Lead.'
example: '2021-03-22 11:31:00'
-
in: query
name: 'filter[father_name]'
description: 'Nome do pai.'
example: Rogério
required: false
schema:
type: string
description: 'Nome do pai.'
example: Rogério
-
in: query
name: 'filter[mother_name]'
description: 'Nome da mãe.'
example: Maria
required: false
schema:
type: string
description: 'Nome da mãe.'
example: Maria
-
in: query
name: 'filter[occupation_id]'
description: 'ID da profissão.'
example: 10
required: false
schema:
type: integer
description: 'ID da profissão.'
example: 10
-
in: query
name: 'filter[occupation]'
description: 'Descrição da profissão.'
example: 'Corretor imobiliário'
required: false
schema:
type: string
description: 'Descrição da profissão.'
example: 'Corretor imobiliário'
-
in: query
name: 'filter[employment_link]'
description: 'Vínculo empregatício.'
example: EMP
required: false
schema:
type: string
description: 'Vínculo empregatício.'
example: EMP
-
in: query
name: 'filter[employment_business]'
description: 'Nome da empresa de trabalho.'
example: Apresenta.me
required: false
schema:
type: string
description: 'Nome da empresa de trabalho.'
example: Apresenta.me
-
in: query
name: 'filter[employment_time]'
description: 'Tempo de empresa.'
example: 6
required: false
schema:
type: integer
description: 'Tempo de empresa.'
example: 6
-
in: query
name: 'filter[employment_phone]'
description: 'Telefone da empresa.'
example: '+55 47 98420-8674'
required: false
schema:
type: string
description: 'Telefone da empresa.'
example: '+55 47 98420-8674'
-
in: query
name: 'filter[employment_address]'
description: 'Endereço da empresa.'
example: 'Rua José Debieux'
required: false
schema:
type: string
description: 'Endereço da empresa.'
example: 'Rua José Debieux'
-
in: query
name: 'filter[income]'
description: Renda.
example: '1500.00'
required: false
schema:
type: string
description: Renda.
example: '1500.00'
-
in: query
name: 'filter[income_other]'
description: 'Outras rendas.'
example: '600.00'
required: false
schema:
type: string
description: 'Outras rendas.'
example: '600.00'
-
in: query
name: 'filter[notes]'
description: Observações
example: 'Entrou em contato pelo Facebook'
required: false
schema:
type: string
description: Observações
example: 'Entrou em contato pelo Facebook'
-
in: query
name: 'filter[company_name]'
description: 'Razão social.'
example: 'Empresa Exemplo'
required: false
schema:
type: string
description: 'Razão social.'
example: 'Empresa Exemplo'
-
in: query
name: 'filter[state_inscription_type]'
description: 'Indicador IE.'
example: immune
required: false
schema:
type: string
description: 'Indicador IE.'
example: immune
-
in: query
name: 'filter[state_inscription]'
description: 'Inscrição estadual (IE).'
example: '361944136227'
required: false
schema:
type: string
description: 'Inscrição estadual (IE).'
example: '361944136227'
-
in: query
name: 'filter[municipal_inscription]'
description: 'Inscrição municipal (IM).'
example: '361944136227'
required: false
schema:
type: string
description: 'Inscrição municipal (IM).'
example: '361944136227'
-
in: query
name: 'filter[login_date]'
description: 'Último login.'
example: '2021-03-17 15:50:22'
required: false
schema:
type: string
description: 'Último login.'
example: '2021-03-17 15:50:22'
-
in: query
name: 'filter[login_active]'
description: 'Login habilitado.'
example: true
required: false
schema:
type: boolean
description: 'Login habilitado.'
example: true
-
in: query
name: 'filter[login]'
description: Login.
example: carlos_oliveira
required: false
schema:
type: string
description: Login.
example: carlos_oliveira
-
in: query
name: 'filter[financial_alert]'
description: 'Alerta financeiro habilitado.'
example: true
required: false
schema:
type: boolean
description: 'Alerta financeiro habilitado.'
example: true
-
in: query
name: 'filter[create_building_alert]'
description: 'Alerta cadastro de imóveis habilitado.'
example: true
required: false
schema:
type: boolean
description: 'Alerta cadastro de imóveis habilitado.'
example: true
-
in: query
name: 'include[contacts]'
description: 'Retorna os contatos da pessoa.'
example: 'phone,email'
required: false
schema:
type: string
description: 'Retorna os contatos da pessoa.'
example: 'phone,email'
-
in: query
name: 'include[contact]'
description: 'Retorna o contato principal da pessoa.'
example: 'phone,email'
required: false
schema:
type: string
description: 'Retorna o contato principal da pessoa.'
example: 'phone,email'
-
in: query
name: 'include[spouse]'
description: 'Retorna os dados do cônjuge.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do cônjuge.'
example: 'id,name'
-
in: query
name: 'include[bankAccounts]'
description: 'Retorna as contas da pessoa.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna as contas da pessoa.'
example: 'id,description'
-
in: query
name: 'include[bankAccount]'
description: 'Retorna a conta principal ativa.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna a conta principal ativa.'
example: 'id,description'
-
in: query
name: 'include[occupation]'
description: 'Retorna a profissão da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a profissão da pessoa.'
example: 'id,name'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
-
in: query
name: 'include[contractTenant]'
description: 'Retorna os contratos em que a pessoa é inquilina.'
example: 'id,building_id,type'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é inquilina.'
example: 'id,building_id,type'
-
in: query
name: 'include[contractTenantRent]'
description: 'Retorna os contratos em que a pessoa é inquilina de aluguel.'
example: 'id,building_id'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é inquilina de aluguel.'
example: 'id,building_id'
-
in: query
name: 'include[contractOwner]'
description: 'Retorna os contratos em que a pessoa é proprietária.'
example: 'id,building_id'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é proprietária.'
example: 'id,building_id'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets da pessoa.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os tickets da pessoa.'
example: 'id,title'
-
in: query
name: 'include[deals]'
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
-
in: query
name: 'include[origin]'
description: 'Retorna os dados da origem da pessoa'
example: molestiae
required: false
schema:
type: string
description: 'Retorna os dados da origem da pessoa'
example: molestiae
-
in: query
name: 'include[tags]'
description: 'Retorna as Tags da pessoa'
example: fugiat
required: false
schema:
type: string
description: 'Retorna as Tags da pessoa'
example: fugiat
-
in: query
name: 'include[responsibles]'
description: 'Retorna as pessoas que esta pessoa é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as pessoas que esta pessoa é responsável.'
example: 'id,name'
-
in: query
name: 'include[responsibleGroups]'
description: 'Retorna os grupos de usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os grupos de usuário.'
example: 'id,name'
-
in: query
name: 'include[legalRepresentative]'
description: 'Retorna o Representante legal.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Representante legal.'
example: 'id,name'
-
in: query
name: 'include[image]'
description: 'Retorna as imagens.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna as imagens.'
example: 'id,file_name'
-
in: query
name: 'include[files]'
description: 'Retorna os arquivos.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna os arquivos.'
example: 'id,file_name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Pessoas '
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da pessoa.'
example: 'Carlos Ciclano'
responsible:
type: array
description: 'Usuários responsáveis.'
example:
- 3
- 5
items:
type: string
type:
type: array
description: 'Vínculo com a imobiliária.'
example: null
items:
type: string
access:
type: string
description: 'Tipo de acesso à pessoa.'
example: all
active:
type: boolean
description: Status.
example: true
origin_id:
type: integer
description: 'ID da origem.'
example: 29
origin:
type: string
description: 'Origem da pessoa, caso não saiba o ID.'
example: 'Facebook ADS'
reference:
type: string
description: Referência.
example: R55
gender:
type: string
description: Gênero.
example: M
approved:
type: boolean
description: Aprovada.
example: true
juridical:
type: string
description: 'Tipo de cadastro de pessoa (física, jurídica).'
example: F
tax_id:
type: integer
description: CPF/CNPJ.
example: 57157949008
tag:
type: array
description: Tags.
example:
- 1182
items:
type: string
rg:
type: string
description: RG.
example: 45.461.713-6
rg_emmiter:
type: string
description: 'Emissor do RG.'
example: ssp
rg_dispatcher:
type: date
description: 'Data de emissão do RG'
example: '2011-09-08'
cnh:
type: integer
description: CNH.
example: 43375783744
nationality:
type: string
description: Nacionalidade.
example: Brasileira
naturality:
type: string
description: Naturalidade.
example: Riosulense
birthplace:
type: string
description: 'Local de nascimento.'
example: Riosulense
birth_date:
type: date
description: 'Data de nascimento.'
example: '2011-09-08'
marital:
type: string
description: 'Estado civil.'
example: married
spouse_id:
type: integer
description: 'ID do Cônjuge.'
example: 5
legal_representative_id:
type: integer
description: 'Representante legal.'
example: 80
contacted_at:
type: date
description: 'Data de contato.'
example: '2021-03-22 11:31:00'
last_contact_at:
type: date
description: 'Data do último contato.'
example: '2021-03-22 11:31:00'
father_name:
type: string
description: 'Nome do pai.'
example: Rogério
mother_name:
type: string
description: 'Nome da mãe.'
example: Maria
occupation_id:
type: integer
description: 'ID de profissão .'
example: 10
occupation:
type: string
description: Profissão.
example: 'Corretor imobiliário'
employment_link:
type: string
description: 'Vínculo empregatício.'
example: EMP
employment_business:
type: string
description: 'Nome da empresa de trabalho.'
example: Apresenta.me
employment_time:
type: integer
description: 'Tempo de empresa.'
example: 6
employment_phone:
type: string
description: 'Telefone da empresa.'
example: '+55 47 98420-8674'
employment_address:
type: string
description: 'Endereço da empresa.'
example: 'Rua José Debieux'
income:
type: numeric
description: Renda.
example: '1500.00'
income_other:
type: Outras
description: rendas.
example: '600.00'
notes:
type: string
description: Observações.
example: 'Entrou em contato pelo Facebook'
company_name:
type: string
description: 'Razão social.'
example: Apresenta.me
state_inscription_type:
type: string
description: 'Indicador IE.'
example: immune
state_inscription:
type: integer
description: 'Inscrição estadual (IE).'
example: 361944136227
municipal_inscription:
type: integer
description: 'Inscrição Municipal (IM).'
example: 361944136227
login_date:
type: date
description: 'Data do último login.'
example: '2021-03-17 15:50:22'
login_active:
type: boolean
description: 'Login habilitado.'
example: true
login:
type: string
description: Login.
example: carlos_oliveira
password:
type: string
description: Senha.
example: senha@senha3412
financial_alert:
type: boolean
description: 'Alerta financeiro habilitado.'
example: true
create_building_alert:
type: boolean
description: 'Alerta cadastro de imóvel habilitado.'
example: true
required:
- name
'/persons/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoas '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,tax_id'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id,name,tax_id'
-
in: query
name: 'include[contacts]'
description: 'Retorna os contatos da pessoa.'
example: 'phone,email'
required: false
schema:
type: string
description: 'Retorna os contatos da pessoa.'
example: 'phone,email'
-
in: query
name: 'include[contact]'
description: 'Retorna o contato principal da pessoa.'
example: 'phone,email'
required: false
schema:
type: string
description: 'Retorna o contato principal da pessoa.'
example: 'phone,email'
-
in: query
name: 'include[apbank]'
description: 'Retorna conta ApBank da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna conta ApBank da pessoa.'
example: 'id,name'
-
in: query
name: 'include[spouse]'
description: 'Retorna os dados do cônjuge.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do cônjuge.'
example: 'id,name'
-
in: query
name: 'include[bankAccounts]'
description: 'Retorna as contas da pessoa.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna as contas da pessoa.'
example: 'id,description'
-
in: query
name: 'include[bankAccount]'
description: 'Retorna a conta principal ativa.'
example: 'id,description'
required: false
schema:
type: string
description: 'Retorna a conta principal ativa.'
example: 'id,description'
-
in: query
name: 'include[occupation]'
description: 'Retorna a profissão da pessoa.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna a profissão da pessoa.'
example: 'id,name'
-
in: query
name: 'include[buildings]'
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
-
in: query
name: 'include[contractTenant]'
description: 'Retorna os contratos em que a pessoa é inquilina.'
example: 'id,building_id,type'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é inquilina.'
example: 'id,building_id,type'
-
in: query
name: 'include[contractTenantRent]'
description: 'Retorna os contratos em que a pessoa é inquilina de aluguel.'
example: 'id,building_id'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é inquilina de aluguel.'
example: 'id,building_id'
-
in: query
name: 'include[contractOwner]'
description: 'Retorna os contratos em que a pessoa é proprietária.'
example: 'id,building_id'
required: false
schema:
type: string
description: 'Retorna os contratos em que a pessoa é proprietária.'
example: 'id,building_id'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets da pessoa.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os tickets da pessoa.'
example: 'id,title'
-
in: query
name: 'include[deals]'
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os dados dos negócios em que a pessoa é cliente.'
example: 'id,title'
-
in: query
name: 'include[origin]'
description: 'Retorna os dados da origem da pessoa'
example: et
required: false
schema:
type: string
description: 'Retorna os dados da origem da pessoa'
example: et
-
in: query
name: 'include[tags]'
description: 'Retorna as Tags da pessoa'
example: incidunt
required: false
schema:
type: string
description: 'Retorna as Tags da pessoa'
example: incidunt
-
in: query
name: 'include[responsibles]'
description: 'Retorna as pessoas que esta pessoa é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as pessoas que esta pessoa é responsável.'
example: 'id,name'
-
in: query
name: 'include[responsibleGroups]'
description: 'Retorna os grupos de usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os grupos de usuário.'
example: 'id,name'
-
in: query
name: 'include[legalRepresentative]'
description: 'Retorna o Representante legal.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna o Representante legal.'
example: 'id,name'
-
in: query
name: 'include[image]'
description: 'Retorna as imagens.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna as imagens.'
example: 'id,file_name'
-
in: query
name: 'include[files]'
description: 'Retorna os arquivos.'
example: 'id,file_name'
required: false
schema:
type: string
description: 'Retorna os arquivos.'
example: 'id,file_name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de edição de Pessoas '
parameters: []
responses: {}
tags:
- Pessoas
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome da pessoa.'
example: 'Carlos Ciclano'
responsible:
type: array
description: 'Usuários responsáveis.'
example:
- 3
- 5
items:
type: string
type:
type: array
description: 'Vínculo com a imobiliária.'
example: null
items:
type: string
access:
type: string
description: 'Tipo de acesso à pessoa.'
example: all
active:
type: boolean
description: Status.
example: true
origin_id:
type: integer
description: 'ID da origem.'
example: 29
origin:
type: string
description: 'Origem da pessoa, caso não saiba o ID.'
example: 'Facebook ADS'
reference:
type: string
description: Referência.
example: R55
gender:
type: string
description: Gênero.
example: M
approved:
type: boolean
description: Aprovada.
example: true
juridical:
type: string
description: 'Tipo de cadastro de pessoa (física, jurídica).'
example: F
tax_id:
type: integer
description: CPF/CNPJ.
example: 57157949008
tag:
type: array
description: Tags.
example:
- 1182
items:
type: string
rg:
type: string
description: RG.
example: 45.461.713-6
rg_emmiter:
type: string
description: 'Emissor do RG.'
example: ssp
rg_dispatcher:
type: date
description: 'Data de emissão do RG'
example: '2011-09-08'
cnh:
type: integer
description: CNH.
example: 43375783744
nationality:
type: string
description: Nacionalidade.
example: Brasileira
naturality:
type: string
description: Naturalidade.
example: Riosulense
birthplace:
type: string
description: 'Local de nascimento.'
example: Riosulense
birth_date:
type: date
description: 'Data de nascimento.'
example: '2011-09-08'
marital:
type: string
description: 'Estado civil.'
example: married
spouse_id:
type: integer
description: 'ID do Cônjuge.'
example: 5
legal_representative_id:
type: integer
description: 'Representante legal.'
example: 80
contacted_at:
type: date
description: 'Data de contato.'
example: '2021-03-22 11:31:00'
last_contact_at:
type: date
description: 'Data do último contato.'
example: '2021-03-22 11:31:00'
father_name:
type: string
description: 'Nome do pai.'
example: Rogério
mother_name:
type: string
description: 'Nome da mãe.'
example: Maria
occupation_id:
type: integer
description: 'ID de profissão .'
example: 10
occupation:
type: string
description: Profissão.
example: 'Corretor imobiliário'
employment_link:
type: string
description: 'Vínculo empregatício.'
example: EMP
employment_business:
type: string
description: 'Nome da empresa de trabalho.'
example: Apresenta.me
employment_time:
type: integer
description: 'Tempo de empresa.'
example: 6
employment_phone:
type: string
description: 'Telefone da empresa.'
example: '+55 47 98420-8674'
employment_address:
type: string
description: 'Endereço da empresa.'
example: 'Rua José Debieux'
income:
type: numeric
description: Renda.
example: '1500.00'
income_other:
type: Outras
description: rendas.
example: '600.00'
notes:
type: string
description: Observações.
example: 'Entrou em contato pelo Facebook'
company_name:
type: string
description: 'Razão social.'
example: Apresenta.me
state_inscription_type:
type: string
description: 'Indicador IE.'
example: immune
state_inscription:
type: integer
description: 'Inscrição estadual (IE).'
example: 361944136227
municipal_inscription:
type: integer
description: 'Inscrição Municipal (IM).'
example: 361944136227
login_date:
type: date
description: 'Data do último login.'
example: '2021-03-17 15:50:22'
login_active:
type: boolean
description: 'Login habilitado.'
example: true
login:
type: string
description: Login.
example: carlos_oliveira
password:
type: string
description: Senha.
example: senha@senha3412
financial_alert:
type: boolean
description: 'Alerta financeiro habilitado.'
example: true
create_building_alert:
type: boolean
description: 'Alerta cadastro de imóvel habilitado.'
example: true
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária a permissão de exclusão de Pessoas '
parameters: []
responses: {}
tags:
- Pessoas
parameters:
-
in: path
name: id
description: 'ID da pessoa'
example: 16
required: true
schema:
type: integer
'/deals/statistics/{widget}':
get:
summary: ''
operationId: getDealsStatisticsWidget
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket '
parameters: []
responses: {}
tags:
- Tickets
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
business_id:
type: integer
description: 'ID da empresa'
example: 6
person_id:
type: integer
description: 'ID da Pessoa'
example: 5
title:
type: string
description: 'Título do Ticket'
example: 'Problema com a internet'
type:
type: string
description: 'Tipo do Ticket.'
example: natus
origin:
type: string
description: "Origem do Ticket.\nValores permitidos:\n- `call`: Ligação\n- `presential`: Presencial\n- `site`: Site\n- `client`: Área do Cliente\n- `whatsapp`: WhatsApp"
example: call
contract_id:
type: integer
description: 'ID do Contrato'
example: 23
building_id:
type: integer
description: 'ID do Imóvel'
example: 12
responsible:
type: array
description: 'ID do Responsável'
example:
- 1
- 2
items:
type: integer
notes:
type: string
description: "Observações do Ticket Example: Internet está lenta\nValores permitidos:\n- `keychain`: Chaveiro\n- `eletric`: Elétrica\n- `building`: Entrega\n- `inspect`: Retorno\n- `financial`: Financeiro\n- `hydraulic`: Hidráulico\n- `woodwork`: Marcenaria\n- `paint`: Pintura\n- `roof`: Telhado\n- `other`: Outros"
example: eletric
priority:
type: string
description: "Prioridade do Ticket.\nValores permitidos:\n- `low`: Baixa\n- `normal`: Média\n- `high`: Alta\n- `highest`: Altíssima"
example: normal
status:
type: string
description: "Status do Ticket.\nValores permitidos:\n- `pending`: Pendente\n- `review`: Em Analise\n- `progress`: Em Andamento\n- `await`: Aguardando Retorno\n- `concluded`: Concluido\n- `reopened`: Reaberto\n- `canceled`: Cancelado"
example: pending
date:
type: dateTime
description: 'Data do Ticket'
example: '2025-04-28 14:12:00'
expected_date:
type: dateTime
description: 'Data de Previsão do Ticket'
example: '2025-06-25 09:30:00'
required:
- business_id
- person_id
- title
- type
- origin
'/tickets/{id}':
get:
summary: Obter
operationId: obter
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket '
parameters:
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
example: 'id, description'
-
in: query
name: 'include[business]'
description: 'Incluir dados da Empresa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Empresa'
example: 'id,name'
-
in: query
name: 'include[contract]'
description: 'Incluir dados do Contrato'
example: 0
required: false
schema:
type: integer
description: 'Incluir dados do Contrato'
example: 0
-
in: query
name: 'include[building]'
description: 'Incluir dados do Imóvel'
example: 'id,title'
required: false
schema:
type: string
description: 'Incluir dados do Imóvel'
example: 'id,title'
-
in: query
name: 'include[person]'
description: 'Incluir dados da Pessoa'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados da Pessoa'
example: 'id,name'
-
in: query
name: 'include[responsibles]'
description: 'Incluir dados dos Responsáveis'
example: 'id,name'
required: false
schema:
type: string
description: 'Incluir dados dos Responsáveis'
example: 'id,name'
-
in: query
name: 'include[files]'
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
required: false
schema:
type: string
description: 'Incluir arquivos anexados'
example: 'id,file_name,url'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket '
parameters: []
responses: {}
tags:
- Tickets
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
business_id:
type: integer
description: 'ID da empresa'
example: 6
person_id:
type: integer
description: 'ID da Pessoa'
example: 5
title:
type: string
description: 'Título do Ticket'
example: 'Problema com a internet'
type:
type: string
description: 'Tipo do Ticket.'
example: eaque
origin:
type: string
description: "Origem do Ticket.\nValores permitidos:\n- `call`: Ligação\n- `presential`: Presencial\n- `site`: Site\n- `client`: Área do Cliente\n- `whatsapp`: WhatsApp"
example: call
contract_id:
type: integer
description: 'ID do Contrato'
example: 23
building_id:
type: integer
description: 'ID do Imóvel'
example: 12
responsible:
type: array
description: 'ID do Responsável'
example:
- 1
- 2
items:
type: integer
notes:
type: string
description: "Observações do Ticket Example: Internet está lenta\nValores permitidos:\n- `keychain`: Chaveiro\n- `eletric`: Elétrica\n- `building`: Entrega\n- `inspect`: Retorno\n- `financial`: Financeiro\n- `hydraulic`: Hidráulico\n- `woodwork`: Marcenaria\n- `paint`: Pintura\n- `roof`: Telhado\n- `other`: Outros"
example: eletric
priority:
type: string
description: "Prioridade do Ticket.\nValores permitidos:\n- `low`: Baixa\n- `normal`: Média\n- `high`: Alta\n- `highest`: Altíssima"
example: normal
status:
type: string
description: "Status do Ticket.\nValores permitidos:\n- `pending`: Pendente\n- `review`: Em Analise\n- `progress`: Em Andamento\n- `await`: Aguardando Retorno\n- `concluded`: Concluido\n- `reopened`: Reaberto\n- `canceled`: Cancelado"
example: pending
date:
type: dateTime
description: 'Data do Ticket'
example: '2025-04-28 14:12:00'
expected_date:
type: dateTime
description: 'Data de Previsão do Ticket'
example: '2025-06-25 09:30:00'
delete:
summary: Excluir
operationId: excluir
description: '🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket '
parameters: []
responses: {}
tags:
- Tickets
parameters:
-
in: path
name: id
description: 'Id do ticket'
example: 3
required: true
schema:
type: integer
/users:
get:
summary: Pesquisar
operationId: pesquisar
description: '🔒 Para acessar essa rota é necessário ter permissões adequadas. '
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,login,name,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,login,name,email'
-
in: query
name: 'filter[id]'
description: 'ID do usuário.'
example: 123456
required: false
schema:
type: integer
description: 'ID do usuário.'
example: 123456
-
in: query
name: 'filter[group_id]'
description: 'ID do grupo ao qual o usuário pertence.'
example: 3
required: false
schema:
type: integer
description: 'ID do grupo ao qual o usuário pertence.'
example: 3
-
in: query
name: 'filter[team_id]'
description: 'ID da equipe a qual o usuário está associado.'
example: 5
required: false
schema:
type: integer
description: 'ID da equipe a qual o usuário está associado.'
example: 5
-
in: query
name: 'filter[login]'
description: 'Login do usuário.'
example: usuario123
required: false
schema:
type: string
description: 'Login do usuário.'
example: usuario123
-
in: query
name: 'filter[person_id]'
description: 'ID da pessoa associada ao usuário.'
example: 56789
required: false
schema:
type: integer
description: 'ID da pessoa associada ao usuário.'
example: 56789
-
in: query
name: 'filter[name]'
description: 'Nome do usuário.'
example: 'João Silva'
required: false
schema:
type: string
description: 'Nome do usuário.'
example: 'João Silva'
-
in: query
name: 'filter[name_public]'
description: 'Nome para o site.'
example: 'João Silva'
required: false
schema:
type: string
description: 'Nome para o site.'
example: 'João Silva'
-
in: query
name: 'filter[creci]'
description: 'CRECI do usuário (para corretor de imóveis).'
example: 12345-J
required: false
schema:
type: string
description: 'CRECI do usuário (para corretor de imóveis).'
example: 12345-J
-
in: query
name: 'filter[description]'
description: 'Descrição do usuário.'
example: 'Exemplo descrição...'
required: false
schema:
type: string
description: 'Descrição do usuário.'
example: 'Exemplo descrição...'
-
in: query
name: 'filter[email]'
description: 'E-mail do usuário.'
example: email@example.com
required: false
schema:
type: string
description: 'E-mail do usuário.'
example: email@example.com
-
in: query
name: 'filter[phone]'
description: 'Telefone do usuário.'
example: '(11) 98765-4321'
required: false
schema:
type: string
description: 'Telefone do usuário.'
example: '(11) 98765-4321'
-
in: query
name: 'filter[active]'
description: 'Status do usuário.'
example: true
required: false
schema:
type: boolean
description: 'Status do usuário.'
example: true
-
in: query
name: 'filter[public]'
description: 'Mostra no site.'
example: false
required: false
schema:
type: boolean
description: 'Mostra no site.'
example: false
-
in: query
name: 'include[calendars]'
description: 'Retorna os dados dos calendários criados pelo usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos calendários criados pelo usuário.'
example: 'id,name'
-
in: query
name: 'include[principalCalendar]'
description: 'Retorna os dados do calendário do usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do calendário do usuário.'
example: 'id,name'
-
in: query
name: 'include[systemCalendar]'
description: 'Retorna os dados do calendário pelo usuário via sistema.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do calendário pelo usuário via sistema.'
example: 'id,name'
-
in: query
name: 'include[notifications]'
description: 'Retorna os dados das notificações.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados das notificações.'
example: 'id,name'
-
in: query
name: 'include[group]'
description: 'Retorna os dados do grupo ao qual o usuário pertence.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do grupo ao qual o usuário pertence.'
example: 'id,name'
-
in: query
name: 'include[team]'
description: 'Retorna os dados da equipe a qual o usuário pertence.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da equipe a qual o usuário pertence.'
example: 'id,name'
-
in: query
name: 'include[permissionsTable]'
description: 'Retorna as permissões que o usuário possui.'
example: permission
required: false
schema:
type: string
description: 'Retorna as permissões que o usuário possui.'
example: permission
-
in: query
name: 'include[messages]'
description: 'Retorna as mensagens do usuário.'
example: 'type,message'
required: false
schema:
type: string
description: 'Retorna as mensagens do usuário.'
example: 'type,message'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis em que o usuário é responsável.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os imóveis em que o usuário é responsável.'
example: 'id,title'
-
in: query
name: 'include[persons]'
description: 'Retorna as pessoas que o usuário é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as pessoas que o usuário é responsável.'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa vinculada ao usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa vinculada ao usuário.'
example: 'id,name'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets em que o usuário é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os tickets em que o usuário é responsável.'
example: 'id,name'
-
in: query
name: 'include[contracts]'
description: 'Retorna os contrato.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os contrato.'
example: 'id,name'
-
in: query
name: 'include[deals]'
description: 'Retorna as negociações que o usuário é responsável.'
example: 'id,title,status'
required: false
schema:
type: string
description: 'Retorna as negociações que o usuário é responsável.'
example: 'id,title,status'
-
in: query
name: 'include[events]'
description: 'Retorna os eventos que o usuário está como convidado.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os eventos que o usuário está como convidado.'
example: 'id,title'
-
in: query
name: 'include[historys]'
description: 'Retorna os históricos gerados pelo usuário.'
example: description
required: false
schema:
type: string
description: 'Retorna os históricos gerados pelo usuário.'
example: description
-
in: query
name: 'include[transactions]'
description: 'Retorna as transações do usuário (corretor).'
example: 'mode,type,description'
required: false
schema:
type: string
description: 'Retorna as transações do usuário (corretor).'
example: 'mode,type,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Usuários '
parameters: []
responses: {}
tags:
- Usuários
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
group_id:
type: integer
description: 'ID do grupo de usuários que o corretor pertence.'
example: 14
team_id:
type: integer
description: 'ID da equipe que o corretor pertence.'
example: 16
login:
type: string
description: 'Login de acesso ao sistema.'
example: impedit
person_id:
type: integer
description: 'ID da pessoa cadastrada no sistema que corresponde ao corretor.'
example: 1
password:
type: string
description: 'Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.'
example: Usuario@8532
name:
type: string
description: 'Nome do usuário.'
example: modi
name_public:
type: string
description: 'Nome para ser exibido no site.'
example: voluptas
description:
type: string
description: 'Descrição para a página do corretor.'
example: 'Ipsum aut saepe rerum quia sunt quasi dolor.'
creci:
type: integer
description: 'Número do CRECI.'
example: 5555
email:
type: string
description: 'E-mail de contato.'
example: contato@contato.com
phone:
type: integer
description: 'Telefone de contato.'
example: 47988888888
image_path:
type: string
description: 'Caminho da foto de perfil.'
example: url.com
active:
type: boolean
description: 'Status do usuário.'
example: true
public:
type: boolean
description: 'Mostrar o usuário no site.'
example: false
notes:
type: string
description: 'Observações do usuário.'
example: vel
not_notify:
type: boolean
description: 'Não notificar. Example true'
example: false
position:
type: integer
description: 'Ordem de exibição dos corretores no site.'
example: 20
facebook_id:
type: string
description: 'Link do perfil do Facebook.'
example: excepturi
instagram_id:
type: string
description: 'Link do perfil do Instagram.'
example: mollitia
google_id:
type: integer
description: 'ID do google do usuário que cadastrou.'
example: 15
first_period_in:
type: Hour
description: 'Horário de entrada do primeiro período.'
example: '08:00.'
first_period_out:
type: Hour
description: 'Horário de saída do primeiro período.'
example: '08:00.'
second_period_in:
type: Hour
description: 'Horário de entrada do segundo período.'
example: '08:00.'
second_period_out:
type: Hour
description: 'Horário de saída do segundo período.'
example: '08:00.'
calender_id:
type: integer
description: 'ID do calendário do usuário.'
example: 123
force_password_change:
type: boolean
description: 'Forçar troca de senha.'
example: false
required:
- group_id
- login
- password
- name
- email
'/users/{id}':
get:
summary: Obter
operationId: obter
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,login,name,email'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,login,name,email'
-
in: query
name: 'include[calendars]'
description: 'Retorna os dados dos calendários criados pelo usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados dos calendários criados pelo usuário.'
example: 'id,name'
-
in: query
name: 'include[principalCalendar]'
description: 'Retorna os dados do calendário do usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do calendário do usuário.'
example: 'id,name'
-
in: query
name: 'include[systemCalendar]'
description: 'Retorna os dados do calendário pelo usuário via sistema.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do calendário pelo usuário via sistema.'
example: 'id,name'
-
in: query
name: 'include[notifications]'
description: 'Retorna os dados das notificações.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados das notificações.'
example: 'id,name'
-
in: query
name: 'include[group]'
description: 'Retorna os dados do grupo ao qual o usuário pertence.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados do grupo ao qual o usuário pertence.'
example: 'id,name'
-
in: query
name: 'include[team]'
description: 'Retorna os dados da equipe a qual o usuário pertence.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da equipe a qual o usuário pertence.'
example: 'id,name'
-
in: query
name: 'include[permissionsTable]'
description: 'Retorna as permissões que o usuário possui.'
example: permission
required: false
schema:
type: string
description: 'Retorna as permissões que o usuário possui.'
example: permission
-
in: query
name: 'include[messages]'
description: 'Retorna as mensagens do usuário.'
example: 'type,message'
required: false
schema:
type: string
description: 'Retorna as mensagens do usuário.'
example: 'type,message'
-
in: query
name: 'include[buildings]'
description: 'Retorna os imóveis em que o usuário é responsável.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os imóveis em que o usuário é responsável.'
example: 'id,title'
-
in: query
name: 'include[persons]'
description: 'Retorna as pessoas que o usuário é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna as pessoas que o usuário é responsável.'
example: 'id,name'
-
in: query
name: 'include[person]'
description: 'Retorna os dados da pessoa vinculada ao usuário.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os dados da pessoa vinculada ao usuário.'
example: 'id,name'
-
in: query
name: 'include[tickets]'
description: 'Retorna os tickets em que o usuário é responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os tickets em que o usuário é responsável.'
example: 'id,name'
-
in: query
name: 'include[contracts]'
description: 'Retorna os contrato.'
example: 'id,name'
required: false
schema:
type: string
description: 'Retorna os contrato.'
example: 'id,name'
-
in: query
name: 'include[deals]'
description: 'Retorna as negociações que o usuário é responsável.'
example: 'id,title,status'
required: false
schema:
type: string
description: 'Retorna as negociações que o usuário é responsável.'
example: 'id,title,status'
-
in: query
name: 'include[events]'
description: 'Retorna os eventos que o usuário está como convidado.'
example: 'id,title'
required: false
schema:
type: string
description: 'Retorna os eventos que o usuário está como convidado.'
example: 'id,title'
-
in: query
name: 'include[historys]'
description: 'Retorna os históricos gerados pelo usuário.'
example: description
required: false
schema:
type: string
description: 'Retorna os históricos gerados pelo usuário.'
example: description
-
in: query
name: 'include[transactions]'
description: 'Retorna as transações do usuário (corretor).'
example: 'mode,type,description'
required: false
schema:
type: string
description: 'Retorna as transações do usuário (corretor).'
example: 'mode,type,description'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de Alteração de Usuários '
parameters: []
responses: {}
tags:
- Usuários
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
group_id:
type: integer
description: 'ID do grupo de usuários que o corretor pertence.'
example: 12
team_id:
type: integer
description: 'ID da equipe que o corretor pertence.'
example: 10
login:
type: string
description: 'Login de acesso ao sistema.'
example: temporibus
person_id:
type: integer
description: 'ID da pessoa cadastrada no sistema que corresponde ao corretor.'
example: 1
password:
type: string
description: 'Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.'
example: Usuario@8532
name:
type: string
description: 'Nome do usuário.'
example: cupiditate
name_public:
type: string
description: 'Nome para ser exibido no site.'
example: velit
description:
type: string
description: 'Descrição para a página do corretor.'
example: 'Et aliquam dignissimos voluptas aliquam qui provident blanditiis.'
creci:
type: integer
description: 'Número do CRECI.'
example: 5555
email:
type: string
description: 'E-mail de contato.'
example: contato@contato.com
phone:
type: integer
description: 'Telefone de contato.'
example: 47988888888
image_path:
type: string
description: 'Caminho da foto de perfil.'
example: url.com
active:
type: boolean
description: 'Status do usuário.'
example: true
public:
type: boolean
description: 'Mostrar o usuário no site.'
example: false
notes:
type: string
description: 'Observações do usuário.'
example: magni
not_notify:
type: boolean
description: 'Não notificar. Example true'
example: true
position:
type: integer
description: 'Ordem de exibição dos corretores no site.'
example: 19
facebook_id:
type: string
description: 'Link do perfil do Facebook.'
example: exercitationem
instagram_id:
type: string
description: 'Link do perfil do Instagram.'
example: veniam
google_id:
type: integer
description: 'ID do google do usuário que cadastrou.'
example: 7
first_period_in:
type: Hour
description: 'Horário de entrada do primeiro período.'
example: '08:00.'
first_period_out:
type: Hour
description: 'Horário de saída do primeiro período.'
example: '08:00.'
second_period_in:
type: Hour
description: 'Horário de entrada do segundo período.'
example: '08:00.'
second_period_out:
type: Hour
description: 'Horário de saída do segundo período.'
example: '08:00.'
calender_id:
type: integer
description: 'ID do calendário do usuário.'
example: 123
force_password_change:
type: boolean
description: 'Forçar troca de senha.'
example: false
parameters:
-
in: path
name: id
description: 'ID do Usuário'
example: 6
required: true
schema:
type: integer
'/inspect/contestations/items/{item}/answer':
post:
summary: 'Responder Item'
operationId: responderItem
description: 'Responde um item de uma contestação (visão administrativa).'
parameters: []
responses: {}
tags:
- 'Vistorias › Contestações'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
answer:
type: string
description: 'Resposta da imobiliária.'
example: 'Item será reparado.'
required:
- answer
parameters:
-
in: path
name: item
description: 'Id do item de contestação.'
example: 1
required: true
schema:
type: integer
/inspect/contestations:
post:
summary: 'Criar (Área do Cliente)'
operationId: criarreaDoCliente
description: 'Cria uma contestação de vistoria a partir da Área do Cliente. O cliente é identificado pelo token.'
parameters: []
responses: {}
tags:
- 'Vistorias › Contestações'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
inspect_id:
type: integer
description: 'Id da vistoria.'
example: 1
term_accepted:
type: boolean
description: 'Confirma o aceite do termo de contestação.'
example: true
items:
type: array
description: 'Itens contestados (environment_id, item_id, message, suggested_condition, contestation_images).'
example:
- et
items:
type: string
required:
- inspect_id
- term_accepted
- items
'/inspect/environments/{environment_id}/duplicate':
post:
summary: Duplicar
operationId: duplicar
description: ''
parameters: []
responses: {}
tags:
- 'Vistorias › Ambientes'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: ''
example: Banheiro
inspect_id:
type: integer
description: ''
example: 1
icon:
type: string
description: ''
example: 'ics ic-address-book'
condition:
type: string
description: ''
example: good
notes:
type: array
description: ''
example: null
items:
type: string
withMedia:
type: boolean
description: 'Duplica o ambiente e seus itens com as imagens quando ativo'
example: false
parameters:
-
in: path
name: environment_id
description: 'The ID of the environment.'
example: 2
required: true
schema:
type: integer
-
in: path
name: environment
description: 'Id do Ambiente'
example: 2
required: true
schema:
type: integer
/inspect/environments:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description,type,condition'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,description,type,condition'
-
in: query
name: 'filter[id]'
description: 'Filtra por código do item.'
example: 12
required: false
schema:
type: integer
description: 'Filtra por código do item.'
example: 12
-
in: query
name: 'filter[description]'
description: 'Filtra por descrição do item. Suporta busca parcial.'
example: '%Lampada%'
required: false
schema:
type: string
description: 'Filtra por descrição do item. Suporta busca parcial.'
example: '%Lampada%'
-
in: query
name: 'filter[inspect_id]'
description: 'Filtra por ID da vistoria vinculada.'
example: 123
required: false
schema:
type: integer
description: 'Filtra por ID da vistoria vinculada.'
example: 123
-
in: query
name: 'filter[environment_id]'
description: 'Filtra por ID do ambiente vinculado.'
example: 456
required: false
schema:
type: integer
description: 'Filtra por ID do ambiente vinculado.'
example: 456
-
in: query
name: 'filter[type]'
description: 'Filtra por tipo de item. Padrão: environment. Valores: item, key, meter, environment.'
example: environment
required: false
schema:
type: string
description: 'Filtra por tipo de item. Padrão: environment. Valores: item, key, meter, environment.'
example: environment
-
in: query
name: 'filter[condition]'
description: 'Filtra por condição do item. Valores: new, good, regular, used, bad, terrible.'
example: good
required: false
schema:
type: string
description: 'Filtra por condição do item. Valores: new, good, regular, used, bad, terrible.'
example: good
-
in: query
name: 'filter[notes]'
description: 'Filtra por observações do item. Suporta busca parcial.'
example: quebrado
required: false
schema:
type: string
description: 'Filtra por observações do item. Suporta busca parcial.'
example: quebrado
-
in: query
name: 'include[inspect]'
description: 'Inclui dados da vistoria vinculada.'
example: 'id,reference,date'
required: false
schema:
type: string
description: 'Inclui dados da vistoria vinculada.'
example: 'id,reference,date'
-
in: query
name: 'include[environment]'
description: 'Inclui dados do ambiente vinculado.'
example: 'id,name'
required: false
schema:
type: string
description: 'Inclui dados do ambiente vinculado.'
example: 'id,name'
-
in: query
name: 'include[images]'
description: 'Inclui arquivos de imagem relacionados ao item.'
example: 'id,name,file_name'
required: false
schema:
type: string
description: 'Inclui arquivos de imagem relacionados ao item.'
example: 'id,name,file_name'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Requer a permissão INSPECT_INSPECT_UPDATE "
parameters: []
responses: {}
tags:
- Vistorias
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
duration:
type: number
description: 'Duração total conhecida dos vídeos, em segundos.'
example: 480.0
unknown_videos:
type: integer
description: 'Vídeos cuja duração o navegador não conseguiu ler.'
example: 0
documents:
type: integer
description: 'Quantidade de documentos anexados.'
example: 2
environments:
type: integer
description: 'Quantidade de ambientes (curadoria de fotos); vazio usa a vistoria do campo id.'
example: 8
'/inspects/{id}/aiFill':
post:
summary: 'Preencher com IA'
operationId: preencherComIA
description: "Envia vídeos narrados e/ou documentos para que a IA identifique ambientes, itens,\nchaves e medidores e os adicione à vistoria. O processamento é assíncrono: a resposta\nretorna imediatamente e o andamento é acompanhado por `ai_status`.\n\n🔒 Para acessar essa rota é necessária a permissão de edição de Vistorias "
parameters: []
responses: {}
tags:
- Vistorias
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
aiMedia:
type: array
description: 'Vídeos enviados para análise, no formato do upload da plataforma.'
example:
-
response:
file: abc123.mp4
name: vistoria.mp4
items:
type: string
files:
type: array
description: 'Documentos anexados que entram no contexto da análise.'
example:
- nihil
items:
type: string
environment_id:
type: integer
description: 'Preenche apenas o ambiente informado (vídeo específico do cômodo); exige vídeo e ignora documentos.'
example: 12
parameters:
-
in: path
name: id
description: 'The ID of the inspect.'
example: minus
required: true
schema:
type: string
-
in: path
name: inspect
description: 'ID da Vistoria.'
example: 1
required: true
schema:
type: integer
'/inspects/{id}/aiCancel':
post:
summary: 'Cancelar o preenchimento por IA'
operationId: cancelarOPreenchimentoPorIA
description: "Interrompe o preenchimento por IA em andamento e libera a vistoria para edição.\n\n🔒 Requer a permissão INSPECT_INSPECT_UPDATE "
parameters: []
responses: {}
tags:
- Vistorias
parameters:
-
in: path
name: id
description: 'The ID of the inspect.'
example: occaecati
required: true
schema:
type: string
/inspects:
get:
summary: Pesquisar
operationId: pesquisar
description: ''
parameters:
-
in: query
name: sort
description: 'Campo para ordenar os registros.'
example: id
required: false
schema:
type: string
description: 'Campo para ordenar os registros.'
example: id
-
in: query
name: fields
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,type,status,date'
required: false
schema:
type: string
description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta.'
example: 'id,type,status,date'
-
in: query
name: 'filter[id]'
description: 'Filtra por código da vistoria.'
example: 12
required: false
schema:
type: integer
description: 'Filtra por código da vistoria.'
example: 12
-
in: query
name: 'filter[reference]'
description: 'Filtra por referência única da vistoria.'
example: VIS-2024-01
required: false
schema:
type: string
description: 'Filtra por referência única da vistoria.'
example: VIS-2024-01
-
in: query
name: 'filter[type]'
description: 'Filtra por tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.'
example: entrance
required: false
schema:
type: string
description: 'Filtra por tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.'
example: entrance
-
in: query
name: 'filter[status]'
description: 'Filtra por status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.'
example: pending
required: false
schema:
type: string
description: 'Filtra por status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.'
example: pending
-
in: query
name: 'filter[contract_id]'
description: 'Filtra por ID do contrato vinculado.'
example: 123
required: false
schema:
type: integer
description: 'Filtra por ID do contrato vinculado.'
example: 123
-
in: query
name: 'filter[building_id]'
description: 'Filtra por ID do imóvel vinculado.'
example: 456
required: false
schema:
type: integer
description: 'Filtra por ID do imóvel vinculado.'
example: 456
-
in: query
name: 'filter[user_id]'
description: 'Filtra por responsável pela vistoria.'
example: 3
required: false
schema:
type: integer
description: 'Filtra por responsável pela vistoria.'
example: 3
-
in: query
name: 'filter[business_id]'
description: 'Filtra por ID da empresa vinculada.'
example: 1
required: false
schema:
type: integer
description: 'Filtra por ID da empresa vinculada.'
example: 1
-
in: query
name: 'filter[date]'
description: 'Filtra por data da vistoria (YYYY-MM-DD).'
example: '2025-05-01'
required: false
schema:
type: string
description: 'Filtra por data da vistoria (YYYY-MM-DD).'
example: '2025-05-01'
-
in: query
name: 'filter[area]'
description: 'Filtra por metragem da vistoria.'
example: 120.5
required: false
schema:
type: number
description: 'Filtra por metragem da vistoria.'
example: 120.5
-
in: query
name: 'filter[furniture]'
description: 'Filtra por mobília. Valores possíveis: furnished, semi_furnished, unfurnished.'
example: furnished
required: false
schema:
type: string
description: 'Filtra por mobília. Valores possíveis: furnished, semi_furnished, unfurnished.'
example: furnished
-
in: query
name: 'filter[tag]'
description: 'Filtra por ID da tag vinculada.'
example: 7
required: false
schema:
type: integer
description: 'Filtra por ID da tag vinculada.'
example: 7
-
in: query
name: 'filter[notes]'
description: 'Filtra por observações gerais (busca no array JSON). Suporta busca parcial.'
example: pintura
required: false
schema:
type: string
description: 'Filtra por observações gerais (busca no array JSON). Suporta busca parcial.'
example: pintura
-
in: query
name: 'filter[father_id]'
description: 'Filtra por ID da vistoria principal (quando esta for uma reedição).'
example: 10
required: false
schema:
type: integer
description: 'Filtra por ID da vistoria principal (quando esta for uma reedição).'
example: 10
-
in: query
name: 'filter[withImageCount]'
description: 'Inclui a contagem de imagens da vistoria via scope.'
example: true
required: false
schema:
type: boolean
description: 'Inclui a contagem de imagens da vistoria via scope.'
example: true
-
in: query
name: 'include[building]'
description: 'Inclui dados do imóvel vinculado.'
example: 'id,reference,title'
required: false
schema:
type: string
description: 'Inclui dados do imóvel vinculado.'
example: 'id,reference,title'
-
in: query
name: 'include[contract]'
description: 'Inclui dados do contrato vinculado.'
example: 0
required: false
schema:
type: integer
description: 'Inclui dados do contrato vinculado.'
example: 0
-
in: query
name: 'include[user]'
description: 'Inclui dados do usuário responsável.'
example: 'id,name,email'
required: false
schema:
type: string
description: 'Inclui dados do usuário responsável.'
example: 'id,name,email'
-
in: query
name: 'include[tags]'
description: 'Inclui as tags vinculadas.'
example: 'id,description'
required: false
schema:
type: string
description: 'Inclui as tags vinculadas.'
example: 'id,description'
-
in: query
name: 'include[business]'
description: 'Inclui dados da empresa responsável.'
example: 'id,name'
required: false
schema:
type: string
description: 'Inclui dados da empresa responsável.'
example: 'id,name'
-
in: query
name: 'include[environments]'
description: 'Inclui ambientes da vistoria.'
example: 'id,name'
required: false
schema:
type: string
description: 'Inclui ambientes da vistoria.'
example: 'id,name'
-
in: query
name: 'include[keys]'
description: 'Inclui os itens do tipo chave.'
example: 'id,name'
required: false
schema:
type: string
description: 'Inclui os itens do tipo chave.'
example: 'id,name'
-
in: query
name: 'include[meters]'
description: 'Inclui os itens do tipo medidor.'
example: 'id,name'
required: false
schema:
type: string
description: 'Inclui os itens do tipo medidor.'
example: 'id,name'
-
in: query
name: 'include[files]'
description: 'Inclui arquivos relacionados à vistoria.'
example: 'id,name,file_name'
required: false
schema:
type: string
description: 'Inclui arquivos relacionados à vistoria.'
example: 'id,name,file_name'
-
in: query
name: 'include[father]'
description: 'Inclui os dados da vistoria pai (original).'
example: 'id,type,date'
required: false
schema:
type: string
description: 'Inclui os dados da vistoria pai (original).'
example: 'id,type,date'
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Apresenta.me - Autenticação \n\n
\n\n \n Apresenta.me - Autenticação \n\n
\n\n \n 🔒 Para acessar essa rota é necessária a permissão de cadastro de Vistorias '
parameters: []
responses: {}
tags:
- Vistorias
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
environments:
type: boolean
description: 'Define se duplica os ambientes e seus itens da vistoria'
example: false
keys:
type: boolean
description: 'Define se duplica as chaves da vistoria'
example: true
meters:
type: boolean
description: 'Define se duplica os medidores da vistoria'
example: true
persons:
type: boolean
description: 'Define se duplica as pessoas da vistoria'
example: false
medias:
type: boolean
description: 'Define se duplica as fotos da vistoria'
example: true
parameters:
-
in: path
name: inspect_id
description: 'The ID of the inspect.'
example: 15
required: true
schema:
type: integer
-
in: path
name: inspect
description: 'ID da Vistoria'
example: 17
required: true
schema:
type: integer
/buildings/ai-batch:
post:
summary: 'Enfileira tarefas de IA em lote para os imóveis selecionados.'
operationId: enfileiraTarefasDeIAEmLoteParaOsImveisSelecionados
description: ''
parameters: []
responses: {}
tags:
- '[Imóveis] Imóveis'