openapi: 3.0.3
info:
  title: 'API Apresenta.me'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://api.apresenta.me'
paths:
  /buildings/types:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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%'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Tipos de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos 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
                  nullable: false
                category_id:
                  type: integer
                  description: 'ID da Categoria.'
                  example: 1
                  nullable: false
              required:
                - category_id
  '/buildings/types/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Tipos de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos 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
                  nullable: false
                category_id:
                  type: integer
                  description: 'ID da Categoria.'
                  example: 1
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Tipos de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    parameters:
      -
        in: path
        name: id
        description: 'ID do Tipo de Imóvel.'
        example: 2
        required: true
        schema:
          type: integer
  /buildings/categories:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóvel</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da categoria.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da categoria.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Descrição da categoria.'
          example: Rural
          required: false
          schema:
            type: string
            description: 'Descrição da categoria.'
            example: Rural
            nullable: false
        -
          in: query
          name: 'filter[color]'
          description: 'Cor da categoria.'
          example: 0000FF
          required: false
          schema:
            type: string
            description: 'Cor da categoria.'
            example: 0000FF
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Categoria de imóvel</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição da categoria.'
                  example: Rural
                  nullable: false
                color:
                  type: string
                  description: 'Cor da categoria.'
                  example: 0000FF
                  nullable: false
              required:
                - description
                - color
  '/buildings/categories/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóvel</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Categoria de imóvel</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição da categoria.'
                  example: Rural
                  nullable: false
                color:
                  type: string
                  description: 'Cor da categoria.'
                  example: 0000FF
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Categoria de imóvel</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Classificação dos Imóveis'
    parameters:
      -
        in: path
        name: id
        description: 'ID da categoria.'
        example: 4
        required: true
        schema:
          type: integer
  '/condominiums/groups/{id}':
    delete:
      summary: 'Excluir grupo do condomínio'
      operationId: excluirGrupoDoCondomnio
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
    parameters:
      -
        in: path
        name: id
        description: 'ID do Grupo do Condomínio'
        example: 2
        required: true
        schema:
          type: integer
  /condominiums:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Condomínio</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do condomínio.'
          example: 4
          required: false
          schema:
            type: integer
            description: 'ID do condomínio.'
            example: 4
            nullable: false
        -
          in: query
          name: 'filter[id2]'
          description: 'ID visível do condomínio.'
          example: 11
          required: false
          schema:
            type: integer
            description: 'ID visível do condomínio.'
            example: 11
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[status]'
          description: Status.
          example: active
          required: false
          schema:
            type: string
            description: Status.
            example: active
            nullable: false
        -
          in: query
          name: 'filter[lock]'
          description: Status.
          example: active
          required: false
          schema:
            type: string
            description: Status.
            example: active
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[stage_id]'
          description: 'ID do estágio.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'ID do estágio.'
            example: 12
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[state_id]'
          description: 'ID do estado.'
          example: 8
          required: false
          schema:
            type: integer
            description: 'ID do estado.'
            example: 8
            nullable: false
        -
          in: query
          name: 'filter[city_id]'
          description: 'ID da cidade.'
          example: 19
          required: false
          schema:
            type: integer
            description: 'ID da cidade.'
            example: 19
            nullable: false
        -
          in: query
          name: 'filter[district_id]'
          description: 'ID do bairro'
          example: 14
          required: false
          schema:
            type: integer
            description: 'ID do bairro'
            example: 14
            nullable: false
        -
          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: 11
          required: false
          schema:
            type: integer
            description: 'ID da construtora.'
            example: 11
            nullable: false
        -
          in: query
          name: 'filter[access]'
          description: 'Tipo de Acesso.'
          example: all
          required: false
          schema:
            type: string
            description: 'Tipo de Acesso.'
            example: all
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[updated_by]'
          description: 'ID do usuário que atualizou.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'ID do usuário que atualizou.'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[created_by]'
          description: 'ID do usuário que cadastrou.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'ID do usuário que cadastrou.'
            example: 20
            nullable: false
        -
          in: query
          name: 'filter[principal_media]'
          description: 'Mídia principal.'
          example: animi
          required: false
          schema:
            type: string
            description: 'Mídia principal.'
            example: animi
            nullable: false
        -
          in: query
          name: 'filter[built_year]'
          description: 'Ano de construção.'
          example: 13
          required: false
          schema:
            type: integer
            description: 'Ano de construção.'
            example: 13
            nullable: false
        -
          in: query
          name: 'filter[total_floors]'
          description: 'Quantidade de andares.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Quantidade de andares.'
            example: 5
            nullable: false
        -
          in: query
          name: 'filter[total_by_floor]'
          description: 'Quantidade de unidades por andar.'
          example: 8
          required: false
          schema:
            type: integer
            description: 'Quantidade de unidades por andar.'
            example: 8
            nullable: false
        -
          in: query
          name: 'filter[blocks]'
          description: 'Quantidade de Blocos do condomínio.'
          example: 18
          required: false
          schema:
            type: integer
            description: 'Quantidade de Blocos do condomínio.'
            example: 18
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[content]'
          description: 'HTML do conteúdo da descrição.'
          example: '<p>Condomínio de frente para o mar...</p>'
          required: false
          schema:
            type: string
            description: 'HTML do conteúdo da descrição.'
            example: '<p>Condomínio de frente para o mar...</p>'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[number]'
          description: 'número do condomínio'
          example: 11
          required: false
          schema:
            type: integer
            description: 'número do condomínio'
            example: 11
            nullable: false
        -
          in: query
          name: 'filter[complement]'
          description: 'Complemento do condomínio.'
          example: Apartamento
          required: false
          schema:
            type: string
            description: 'Complemento do condomínio.'
            example: Apartamento
            nullable: false
        -
          in: query
          name: 'filter[zip_code]'
          description: 'CEP do condomínio.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'CEP do condomínio.'
            example: 20
            nullable: false
        -
          in: query
          name: 'filter[notes]'
          description: Observações.
          example: eum
          required: false
          schema:
            type: string
            description: Observações.
            example: eum
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[html_description]'
          description: 'descrição SEO.'
          example: SEO
          required: false
          schema:
            type: string
            description: 'descrição SEO.'
            example: SEO
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Condomínios</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: 'ID do condomínio.'
                  example: 18
                  nullable: false
                id2:
                  type: integer
                  description: 'ID visível do condomínio.'
                  example: 14
                  nullable: false
                mode:
                  type: string
                  description: 'Modo (condomínio ou lançamento).'
                  example: release
                  nullable: false
                status:
                  type: string
                  description: Status.
                  example: active
                  nullable: false
                lock:
                  type: string
                  description: Status.
                  example: active
                  nullable: false
                type_id:
                  type: integer
                  description: 'ID da Subcategoria/Tipo do condomínio.'
                  example: 20
                  nullable: false
                stage_id:
                  type: integer
                  description: 'ID do estágio.'
                  example: 10
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 4
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do estado.'
                  example: 13
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID da cidade.'
                  example: 18
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do bairro'
                  example: 5
                  nullable: false
                tag:
                  type: array
                  description: Tags.
                  example:
                    - 10
                  items:
                    type: integer
                responsible:
                  type: array
                  description: 'Corretores responsáveis.'
                  example:
                    - 18
                  items:
                    type: integer
                constructor_id:
                  type: integer
                  description: 'ID da construtora.'
                  example: 16
                  nullable: false
                access:
                  type: string
                  description: 'Tipo de Acesso.'
                  example: all
                  nullable: false
                pickup:
                  type: array
                  description: 'Corretores captadores.'
                  example:
                    - 13
                  items:
                    type: integer
                slug:
                  type: string
                  description: 'Link permanente para site.'
                  example: exemplo-perma-link
                  nullable: false
                updated_by:
                  type: integer
                  description: 'ID do usuário que atualizou.'
                  example: 17
                  nullable: false
                created_by:
                  type: integer
                  description: 'ID do usuário que cadastrou.'
                  example: 12
                  nullable: false
                principal_media:
                  type: string
                  description: 'Mídia principal.'
                  example: eligendi
                  nullable: false
                built_year:
                  type: integer
                  description: 'Ano de construção.'
                  example: 8
                  nullable: false
                total_floors:
                  type: integer
                  description: 'Quantidade de andares.'
                  example: 18
                  nullable: false
                total_by_floor:
                  type: integer
                  description: 'Quantidade de unidades por andar.'
                  example: 1
                  nullable: false
                blocks:
                  type: integer
                  description: 'Quantidade de Blocos do condomínio.'
                  example: 9
                  nullable: false
                title:
                  type: string
                  description: 'Titulo do condomínio.'
                  example: 'Título Exemplar'
                  nullable: false
                content:
                  type: string
                  description: 'HTML do conteúdo da descrição.'
                  example: '<p>Condomínio de frente para o mar...</p>'
                  nullable: false
                lock_description:
                  type: string
                  description: 'Motivo do bloqueio.'
                  example: 'Bloqueado para atualização'
                  nullable: false
                street:
                  type: string
                  description: 'Rua do condomínio.'
                  example: 'Rua Guanabara'
                  nullable: false
                number:
                  type: integer
                  description: 'número do condomínio'
                  example: 1
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do condomínio.'
                  example: Apartamento
                  nullable: false
                zip_code:
                  type: integer
                  description: 'CEP do condomínio.'
                  example: 16
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: provident
                  nullable: false
                html_title:
                  type: string
                  description: 'Título da página (HTML title).'
                  example: 'SEO Título'
                  nullable: false
                html_keyword:
                  type: string
                  description: 'Palavras Chave (HTML Keyword). Example:'
                  example: blanditiis
                  nullable: false
                html_description:
                  type: string
                  description: 'descrição SEO.'
                  example: 'SEO,chave'
                  nullable: false
                groups:
                  type: json
                  description: 'Grupos do condomínio.'
                  example: '[{"title": "Grupo A", "status": "active", "area_total_min": "150,00", "bathroom_min": "1", "bedroom_min": "2", "room_min": "1", "suite_min": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]'
                  nullable: false
              required:
                - mode
                - status
                - type_id
                - title
  '/condominiums/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Condomínio</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Condomínios</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  description: 'Tipo do Empreendimento.'
                  example: condominium
                  nullable: false
                status:
                  type: string
                  description: Status.
                  example: active
                  nullable: false
                type_id:
                  type: integer
                  description: 'ID da Subcategoria/Tipo do condomínio.'
                  example: 8
                  nullable: false
                stage_id:
                  type: integer
                  description: 'ID do estágio.'
                  example: 7
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 5
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do estado.'
                  example: 11
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID da cidade.'
                  example: 18
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do bairro'
                  example: 18
                  nullable: false
                responsible:
                  type: array
                  description: 'IDs dos responsáveis'
                  example:
                    - 4
                  items:
                    type: integer
                constructor_id:
                  type: integer
                  description: 'ID da construtora.'
                  example: 18
                  nullable: false
                access:
                  type: string
                  description: 'Tipo de Acesso.'
                  example: all
                  nullable: false
                pickup:
                  type: array
                  description: 'IDs dos captadores do condomínio.'
                  example:
                    - 2
                  items:
                    type: integer
                slug:
                  type: string
                  description: 'Link permanente para site.'
                  example: exemplo-perma-link
                  nullable: false
                updated_by:
                  type: integer
                  description: 'ID do usuário que atualizou.'
                  example: 17
                  nullable: false
                created_by:
                  type: integer
                  description: 'ID do usuário que cadastrou.'
                  example: 15
                  nullable: false
                principal_media:
                  type: string
                  description: 'Mídia principal.'
                  example: voluptatibus
                  nullable: false
                built_year:
                  type: integer
                  description: 'Ano de construção.'
                  example: 2021
                  nullable: false
                blocks:
                  type: integer
                  description: 'Quantidade de Blocos do condomínio.'
                  example: 15
                  nullable: false
                title:
                  type: string
                  description: 'Titulo do condomínio.'
                  example: 'Título Exemplar'
                  nullable: false
                street:
                  type: string
                  description: 'Rua do condomínio.'
                  example: 'Rua Guanabara'
                  nullable: false
                number:
                  type: integer
                  description: 'número do condomínio'
                  example: 6
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do condomínio.'
                  example: Apartamento
                  nullable: false
                zip_code:
                  type: integer
                  description: 'CEP do condomínio.'
                  example: 2
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: rerum
                  nullable: false
                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_min": "150,00", "bathroom_min": "1", "bedroom_min": "2", "room_min": "1", "suite_min": "1", "purposes": [{"type": "sale", "amount": "150000", "condominium": "5000", "iptu_amount": "1500"}]}]'
                  nullable: false
              required:
                - title
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Condomínios</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Condomínios
    parameters:
      -
        in: path
        name: id
        description: 'ID do condomínio'
        example: 15
        required: true
        schema:
          type: integer
  /buildings/constructors:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Construtoras</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da construtora.'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID da construtora.'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome da construtora.'
          example: 'Construtora Teste'
          required: false
          schema:
            type: string
            description: 'Nome da construtora.'
            example: 'Construtora Teste'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[notes]'
          description: Observações.
          example: Observação
          required: false
          schema:
            type: string
            description: Observações.
            example: Observação
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Construtoras
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Construtora</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Construtoras
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da construtora.'
                  example: 'Construtora Exemplo'
                  nullable: false
                state_id:
                  type: integer
                  description: 'estado de atuação.'
                  example: 24
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: Observação
                  nullable: false
              required:
                - name
  '/buildings/constructors/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Construtora</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Construtoras
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Construtora</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Construtoras
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da construtora.'
                  example: 'Construtora Exemplo 2'
                  nullable: false
                state_id:
                  type: integer
                  description: 'estado de atuação.'
                  example: 24
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: Observação
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Construtora</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Construtoras
    parameters:
      -
        in: path
        name: id
        description: 'ID da construtora.'
        example: 11
        required: true
        schema:
          type: integer
  /users/teams:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Códigio da equipe de usuário.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Códigio da equipe de usuário.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome da equipa de usuário.'
          example: 'Equipe X'
          required: false
          schema:
            type: string
            description: 'Nome da equipa de usuário.'
            example: 'Equipe X'
            nullable: false
        -
          in: query
          name: 'filter[business_id]'
          description: 'Código da empresa.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Código da empresa.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[manager_id]'
          description: 'Código do gerente da equipe.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Código do gerente da equipe.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[notes]'
          description: 'Observações da equipe.'
          example: 'Equipe para ...'
          required: false
          schema:
            type: string
            description: 'Observações da equipe.'
            example: 'Equipe para ...'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Equipes de Usuários'
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de criação de Equipe de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Equipes de Usuários'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da equipe.'
                  example: Vendas
                  nullable: false
                manager_id:
                  type: integer
                  description: 'ID do gerente da equipe, deve ser um ID de um usuário.'
                  example: 1010
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa financeira que o grupo pertence.'
                  example: 1058
                  nullable: false
                notes:
                  type: string
                  description: 'Observação para a equipe.'
                  example: et
                  nullable: false
              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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Equipes de Usuários'
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de alteração de Equipe de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Equipes de Usuários'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da equipe.'
                  example: Vendas
                  nullable: false
                manager_id:
                  type: integer
                  description: 'ID do gerente da equipe, deve ser um ID de um usuário.'
                  example: 1010
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa financeira que o grupo pertence.'
                  example: 1058
                  nullable: false
                notes:
                  type: string
                  description: 'Observação para a equipe.'
                  example: totam
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do Evento'
          example: 2
          required: false
          schema:
            type: integer
            description: 'ID do Evento'
            example: 2
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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`: Email\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`: Email\n- `call`: Ligação\n- `inspect`: Vistoria\n- `maintenance`: Manutenção\n- `billing`: Cobrança"
            example: task
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[created_by]'
          description: 'ID do Criador'
          example: 7
          required: false
          schema:
            type: integer
            description: 'ID do Criador'
            example: 7
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[contract_id]'
          description: 'ID do contrato'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do contrato'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'ID da Pessoa'
          example: 5
          required: false
          schema:
            type: integer
            description: 'ID da Pessoa'
            example: 5
            nullable: false
        -
          in: query
          name: 'filter[invite_person]'
          description: 'Se convidou pessoa'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Se convidou pessoa'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[endless]'
          description: 'Evento sem fim'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Evento sem fim'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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[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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[isCancelled]'
          description: 'Filtra eventos cancelados'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra eventos cancelados'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Eventos
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Eventos
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                'filter[calendar_id]':
                  type: integer
                  description: 'ID do Calendário'
                  example: 3
                  nullable: false
                'filter[title]':
                  type: string
                  description: 'Título do Evento'
                  example: 'Reunião mensal'
                  nullable: false
                '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
                  nullable: false
                '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`: Email\n- `call`: Ligação"
                  example: task
                  nullable: false
                '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
                  nullable: false
                'filter[initial_date]':
                  type: date
                  description: 'Data inicial do Evento'
                  example: '2025-06-10'
                  nullable: false
                'filter[father_id]':
                  type: integer
                  description: 'ID do Evento Pai'
                  example: 10
                  nullable: false
                'filter[recurrence_id]':
                  type: integer
                  description: 'ID da Recorrência'
                  example: 5
                  nullable: false
                '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'
                  nullable: false
                '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
                  nullable: false
                'filter[created_by]':
                  type: integer
                  description: 'ID do Criador'
                  example: 7
                  nullable: false
                'filter[building_id]':
                  type: integer
                  description: 'ID do Imóvel'
                  example: 12
                  nullable: false
                'filter[deal_id]':
                  type: integer
                  description: 'ID do Negócio'
                  example: 8
                  nullable: false
                'filter[contract_id]':
                  type: integer
                  description: 'ID do contrato'
                  example: 123456
                  nullable: false
                'filter[person_id]':
                  type: integer
                  description: 'ID da Pessoa'
                  example: 5
                  nullable: false
                'filter[invite_person]':
                  type: boolean
                  description: 'Se convidou pessoa'
                  example: true
                  nullable: false
                'filter[endless]':
                  type: boolean
                  description: 'Evento sem fim'
                  example: false
                  nullable: false
                'filter[all_day]':
                  type: boolean
                  description: 'Evento o dia todo'
                  example: true
                  nullable: false
                'filter[description]':
                  type: string
                  description: 'Descrição do Evento'
                  example: 'Discussão de metas'
                  nullable: false
                'filter[address]':
                  type: string
                  description: 'Endereço do Evento'
                  example: 'Av. Paulista, 1000'
                  nullable: false
                '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
                  nullable: 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
                  nullable: false
              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: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento</aside>'
      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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Eventos
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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'
                  nullable: false
                '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
                  nullable: false
                '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`: Email\n- `call`: Ligação"
                  example: task
                  nullable: false
                '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
                  nullable: false
                'filter[initial_date]':
                  type: date
                  description: 'Data inicial do Evento'
                  example: '2025-06-10'
                  nullable: false
                'filter[father_id]':
                  type: integer
                  description: 'ID do Evento Pai'
                  example: 10
                  nullable: false
                'filter[recurrence_id]':
                  type: integer
                  description: 'ID da Recorrência'
                  example: 5
                  nullable: false
                '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'
                  nullable: false
                '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
                  nullable: false
                'filter[building_id]':
                  type: integer
                  description: 'ID do Imóvel'
                  example: 12
                  nullable: false
                'filter[deal_id]':
                  type: integer
                  description: 'ID do Negócio'
                  example: 8
                  nullable: false
                'filter[contract_id]':
                  type: integer
                  description: 'ID do contrato'
                  example: 123456
                  nullable: false
                'filter[person_id]':
                  type: integer
                  description: 'ID da Pessoa'
                  example: 5
                  nullable: false
                'filter[invite_person]':
                  type: boolean
                  description: 'Se convidou pessoa'
                  example: true
                  nullable: false
                'filter[endless]':
                  type: boolean
                  description: 'Evento sem fim'
                  example: false
                  nullable: false
                'filter[all_day]':
                  type: boolean
                  description: 'Evento o dia todo'
                  example: true
                  nullable: false
                'filter[description]':
                  type: string
                  description: 'Descrição do Evento'
                  example: 'Discussão de metas'
                  nullable: false
                'filter[address]':
                  type: string
                  description: 'Endereço do Evento'
                  example: 'Av. Paulista, 1000'
                  nullable: false
                '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
                  nullable: 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
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Evento</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Eventos
    parameters:
      -
        in: path
        name: id
        description: 'Id do ticket'
        example: 10
        required: true
        schema:
          type: integer
  '/invoices/{invoice_id}/receiptLink':
    get:
      summary: 'Gerar link do Recibo de Recebimento'
      operationId: gerarLinkDoReciboDeRecebimento
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: invoice_id
        description: 'ID da Fatura'
        example: 4
        required: true
        schema:
          type: integer
  /invoices:
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,type,total'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,type,total'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da fatura.'
          example: '1'
          required: false
          schema:
            type: string
            description: 'ID da fatura.'
            example: '1'
            nullable: false
        -
          in: query
          name: 'filter[id2]'
          description: 'ID da fatura por empresa.'
          example: '1'
          required: false
          schema:
            type: string
            description: 'ID da fatura por empresa.'
            example: '1'
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: "Tipo da fatura.\nValores permitidos:\n- `single`: Avulsa\n- `contract`: Contrato"
          example: single
          required: false
          schema:
            type: string
            description: "Tipo da fatura.\nValores permitidos:\n- `single`: Avulsa\n- `contract`: Contrato"
            example: single
            nullable: false
        -
          in: query
          name: 'filter[payer_id]'
          description: 'ID do pagador.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do pagador.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[contract_id]'
          description: 'ID do contrato.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'ID do contrato.'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[business_id]'
          description: 'ID da empresa.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'ID da empresa.'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[account_id]'
          description: 'ID da conta bancária.'
          example: 4
          required: false
          schema:
            type: integer
            description: 'ID da conta bancária.'
            example: 4
            nullable: false
        -
          in: query
          name: 'filter[billing_id]'
          description: 'ID do método de cobrança automático.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'ID do método de cobrança automático.'
            example: 5
            nullable: false
        -
          in: query
          name: 'filter[billing_method]'
          description: "Método de cobrança.\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: "Método de cobrança.\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
            nullable: false
        -
          in: query
          name: 'filter[paid]'
          description: 'Filtra faturas pagas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas pagas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[paid_at]'
          description: 'date Data do pagamento.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Data do pagamento.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[credit_at]'
          description: 'date Data do crédito.'
          example: '2024-01-02'
          required: false
          schema:
            type: string
            description: 'date Data do crédito.'
            example: '2024-01-02'
            nullable: false
        -
          in: query
          name: 'filter[payment_error]'
          description: 'Erro no pagamento.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Erro no pagamento.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Descrição da fatura.'
          example: 'Fatura X'
          required: false
          schema:
            type: string
            description: 'Descrição da fatura.'
            example: 'Fatura X'
            nullable: false
        -
          in: query
          name: 'filter[total]'
          description: 'Valor total da fatura.'
          example: '1200'
          required: false
          schema:
            type: string
            description: 'Valor total da fatura.'
            example: '1200'
            nullable: false
        -
          in: query
          name: 'filter[date]'
          description: 'date Competência.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Competência.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[due_date]'
          description: 'date Data de vencimento.'
          example: '2024-01-10'
          required: false
          schema:
            type: string
            description: 'date Data de vencimento.'
            example: '2024-01-10'
            nullable: false
        -
          in: query
          name: 'filter[guaranteed_transfer]'
          description: 'Repasse garantido.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Repasse garantido.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[period_initial]'
          description: 'date Data de início da fatura, aluguel.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Data de início da fatura, aluguel.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[period_final]'
          description: 'date Data final da fatura, aluguel.'
          example: '2024-01-31'
          required: false
          schema:
            type: string
            description: 'date Data final da fatura, aluguel.'
            example: '2024-01-31'
            nullable: false
        -
          in: query
          name: 'filter[tag]'
          description: 'Tags da fatura.'
          example:
            - 123
            - 456
            - 789
          required: false
          schema:
            type: array
            description: 'Tags da fatura.'
            example:
              - 123
              - 456
              - 789
            items:
              type: string
        -
          in: query
          name: 'filter[ticket_registered]'
          description: 'Boleto registrado.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Boleto registrado.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[ticket_date]'
          description: 'date Data do boleto.'
          example: '2024-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'date Data do boleto.'
            example: '2024-01-01 00:00:00'
            nullable: false
        -
          in: query
          name: 'filter[ticket_key]'
          description: 'ID da cobrança dentro do banco integrador (Asaas).'
          example: abc123
          required: false
          schema:
            type: string
            description: 'ID da cobrança dentro do banco integrador (Asaas).'
            example: abc123
            nullable: false
        -
          in: query
          name: 'filter[ticket_id]'
          description: 'ID do boleto.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do boleto.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[ticket_fee]'
          description: 'Taxa do boleto.'
          example: '12.0'
          required: false
          schema:
            type: string
            description: 'Taxa do boleto.'
            example: '12.0'
            nullable: false
        -
          in: query
          name: 'filter[ticket_link]'
          description: 'Link do boleto.'
          example: 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1'
          required: false
          schema:
            type: string
            description: 'Link do boleto.'
            example: 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1'
            nullable: false
        -
          in: query
          name: 'filter[ticket_barcode]'
          description: 'Código de barras do boleto .'
          example: '12395828200001760000010003821587100516853008'
          required: false
          schema:
            type: string
            description: 'Código de barras do boleto .'
            example: '12395828200001760000010003821587100516853008'
            nullable: false
        -
          in: query
          name: 'filter[ticket_info]'
          description: 'Informações do boleto.'
          example: 'Este boleto...'
          required: false
          schema:
            type: string
            description: 'Informações do boleto.'
            example: 'Este boleto...'
            nullable: false
        -
          in: query
          name: 'filter[ticket_digitable]'
          description: 'Linha digitável do boleto.'
          example: '12390.01007 03821.587106 05168.530086 5 82820000176000'
          required: false
          schema:
            type: string
            description: 'Linha digitável do boleto.'
            example: '12390.01007 03821.587106 05168.530086 5 82820000176000'
            nullable: false
        -
          in: query
          name: 'filter[ticket_without_pix]'
          description: 'Boleto sem pix.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Boleto sem pix.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[ticket_late_fee]'
          description: 'Adicionar Multa e Juros para contratos de Locação.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Adicionar Multa e Juros para contratos de Locação.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[ticket_late_fee_item_id]'
          description: 'ID do item que será aplicado a multa.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do item que será aplicado a multa.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[ticket_late_fee_percentage]'
          description: 'Multa (%).'
          example: 12
          required: false
          schema:
            type: integer
            description: 'Multa (%).'
            example: 12
            nullable: false
        -
          in: query
          name: 'filter[ticket_late_fee_interest]'
          description: 'Juros (%).'
          example: 13
          required: false
          schema:
            type: integer
            description: 'Juros (%).'
            example: 13
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount]'
          description: 'Adicionar Desconto de Pontualidade.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Adicionar Desconto de Pontualidade.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_mode]'
          description: "Modo de desconto.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
          example: percentage
          required: false
          schema:
            type: string
            description: "Modo de desconto.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
            example: percentage
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_fixed]'
          description: 'Desconto (R$).'
          example: '123.20'
          required: false
          schema:
            type: string
            description: 'Desconto (R$).'
            example: '123.20'
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_percentage]'
          description: Desconto(%).
          example: '10'
          required: false
          schema:
            type: string
            description: Desconto(%).
            example: '10'
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_action]'
          description: "Ação do desconto de pontualidade.\nValores permitidos:\n- `business`: Reter desconto para imobiliária\n- `owner`: Repassar desconto ao proprietário"
          example: business
          required: false
          schema:
            type: string
            description: "Ação do desconto de pontualidade.\nValores permitidos:\n- `business`: Reter desconto para imobiliária\n- `owner`: Repassar desconto ao proprietário"
            example: business
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_days]'
          description: 'Quantidade de dias antes do vencimento.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'Quantidade de dias antes do vencimento.'
            example: 12
            nullable: false
        -
          in: query
          name: 'filter[transfer_auto_disabled]'
          description: 'Desativar repasse automático.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Desativar repasse automático.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[protest]'
          description: 'json Protesto.'
          example: '{"status":"PENDING"}'
          required: false
          schema:
            type: string
            description: 'json Protesto.'
            example: '{"status":"PENDING"}'
            nullable: false
        -
          in: query
          name: 'filter[ticketIdIn][]'
          description: 'Filtra faturas por IDs de ticket (chave do integrador).'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de ticket (chave do integrador).'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[idOldIn][]'
          description: 'Filtra faturas por IDs antigos (id2).'
          example: 100
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs antigos (id2).'
            example: 100
            items:
              type: integer
        -
          in: query
          name: 'filter[referenceId]'
          description: 'Filtra faturas por ID de referência.'
          example: REF-001
          required: false
          schema:
            type: string
            description: 'Filtra faturas por ID de referência.'
            example: REF-001
            nullable: false
        -
          in: query
          name: 'filter[emptyProtest]'
          description: 'Filtra faturas sem protesto.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas sem protesto.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[protestIdIn][]'
          description: 'Filtra faturas por IDs de protesto.'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de protesto.'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[unpaid]'
          description: 'Filtra faturas não pagas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas não pagas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[overdue]'
          description: 'Filtra faturas vencidas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas vencidas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[early]'
          description: 'Filtra faturas a vencer.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas a vencer.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[contractIn][]'
          description: 'Filtra faturas por IDs de contrato.'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de contrato.'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[contractIdIn][]'
          description: 'Filtra faturas por IDs de contrato (id2).'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de contrato (id2).'
            example: null
            items:
              type: integer
        -
          in: query
          name: 'filter[buildingIn][]'
          description: 'Filtra faturas por IDs de imóvel.'
          example: 10
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de imóvel.'
            example: 10
            items:
              type: integer
        -
          in: query
          name: 'filter[buildingId2In][]'
          description: 'Filtra faturas por IDs de imóvel (id2).'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de imóvel (id2).'
            example: null
            items:
              type: integer
        -
          in: query
          name: 'filter[dateMin]'
          description: 'Filtra faturas por data mínima.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filtra faturas por data mínima.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[dateMax]'
          description: 'Filtra faturas por data máxima.'
          example: '2024-01-31'
          required: false
          schema:
            type: string
            description: 'Filtra faturas por data máxima.'
            example: '2024-01-31'
            nullable: false
        -
          in: query
          name: 'filter[dueDateMin]'
          description: 'Filtra faturas por data de vencimento mínima.'
          example: '2024-01-10'
          required: false
          schema:
            type: string
            description: 'Filtra faturas por data de vencimento mínima.'
            example: '2024-01-10'
            nullable: false
        -
          in: query
          name: 'filter[businessIn][]'
          description: 'Filtra faturas por IDs de empresa.'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de empresa.'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[accountIn][]'
          description: 'Filtra faturas por IDs de conta financeira.'
          example: 3
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de conta financeira.'
            example: 3
            items:
              type: integer
        -
          in: query
          name: 'filter[payerIn][]'
          description: 'Filtra faturas por IDs de pagador.'
          example: 5
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de pagador.'
            example: 5
            items:
              type: integer
        -
          in: query
          name: 'filter[ownerIn][]'
          description: 'Filtra faturas por IDs de proprietário.'
          example: 7
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de proprietário.'
            example: 7
            items:
              type: integer
        -
          in: query
          name: 'filter[tenantIn][]'
          description: 'Filtra faturas por IDs de inquilino.'
          example: 9
          required: false
          schema:
            type: array
            description: 'Filtra faturas por IDs de inquilino.'
            example: 9
            items:
              type: integer
        -
          in: query
          name: 'filter[registered]'
          description: 'Filtra faturas registradas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas registradas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[registeredOrPix]'
          description: 'Filtra faturas registradas ou com Pix.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra faturas registradas ou com Pix.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[billingMethodIn][]'
          description: 'Filtra faturas por métodos de cobrança.'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra faturas por métodos de cobrança.'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[tagIn][]'
          description: 'Filtra faturas por tags.'
          example: 100
          required: false
          schema:
            type: array
            description: 'Filtra faturas por tags.'
            example: 100
            items:
              type: integer
        -
          in: query
          name: 'filter[autoTransferStatus][]'
          description: 'Filtra faturas por status de transferência automática.'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra faturas por status de transferência automática.'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[periodContains]'
          description: 'Filtra faturas cujo período contém a data especificada.'
          example: '2024-01-15'
          required: false
          schema:
            type: string
            description: 'Filtra faturas cujo período contém a data especificada.'
            example: '2024-01-15'
            nullable: false
        -
          in: query
          name: 'filter[payerTaxIdIn][]'
          description: 'Filtra faturas por CPF/CNPJ do pagador.'
          example: 000.000.000-00
          required: false
          schema:
            type: array
            description: 'Filtra faturas por CPF/CNPJ do pagador.'
            example: 000.000.000-00
            items:
              type: string
        -
          in: query
          name: 'include[items]'
          description: ''
          example: dolor
          required: false
          schema:
            type: string
            description: ''
            example: dolor
            nullable: false
        -
          in: query
          name: 'include[itemsPayer]'
          description: ''
          example: voluptatem
          required: false
          schema:
            type: string
            description: ''
            example: voluptatem
            nullable: false
        -
          in: query
          name: 'include[itemsAllGroupTransfer]'
          description: ''
          example: mollitia
          required: false
          schema:
            type: string
            description: ''
            example: mollitia
            nullable: false
        -
          in: query
          name: 'include[itemsAll]'
          description: ''
          example: ipsum
          required: false
          schema:
            type: string
            description: ''
            example: ipsum
            nullable: false
        -
          in: query
          name: 'include[autoTransactions]'
          description: ''
          example: dolore
          required: false
          schema:
            type: string
            description: ''
            example: dolore
            nullable: false
        -
          in: query
          name: 'include[building]'
          description: ''
          example: ut
          required: false
          schema:
            type: string
            description: ''
            example: ut
            nullable: false
        -
          in: query
          name: 'include[billing]'
          description: ''
          example: neque
          required: false
          schema:
            type: string
            description: ''
            example: neque
            nullable: false
        -
          in: query
          name: 'include[payer]'
          description: 'Retorna os dados do pagador.'
          example: 'id,name,type'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do pagador.'
            example: 'id,name,type'
            nullable: false
        -
          in: query
          name: 'include[account]'
          description: ''
          example: dolores
          required: false
          schema:
            type: string
            description: ''
            example: dolores
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Retorna os dados do contrato.'
          example: '*'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do contrato.'
            example: '*'
            nullable: false
        -
          in: query
          name: 'include[business]'
          description: 'Retorna os dados da empresa.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da empresa.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[lateFeeItem]'
          description: ''
          example: et
          required: false
          schema:
            type: string
            description: ''
            example: et
            nullable: false
        -
          in: query
          name: 'include[files]'
          description: 'Retorna os anexos da fatura.'
          example: 'id,name,file_name'
          required: false
          schema:
            type: string
            description: 'Retorna os anexos da fatura.'
            example: 'id,name,file_name'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as tags.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[messages]'
          description: 'Retorna as mensagens referente à fatura.'
          example: 'id,type,Message'
          required: false
          schema:
            type: string
            description: 'Retorna as mensagens referente à fatura.'
            example: 'id,type,Message'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: "Tipo da fatura.\nValores permitidos:\n- `single`: Avulsa\n- `contract`: Contrato"
                  example: single
                  nullable: false
                payer_id:
                  type: integer
                  description: 'ID do pagador.'
                  example: 1
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa.'
                  example: 3
                  nullable: false
                account_id:
                  type: integer
                  description: 'ID da conta bancária.'
                  example: 4
                  nullable: false
                description:
                  type: string
                  description: 'Descrição da fatura.'
                  example: 'Fatura X'
                  nullable: false
                total:
                  type: number
                  description: 'Valor total da fatura.'
                  example: 1200.0
                  nullable: false
                date:
                  type: string
                  description: Competência.
                  example: '2024-01-01'
                  nullable: false
                due_date:
                  type: string
                  description: 'Data de vencimento.'
                  example: '2024-01-10'
                  nullable: false
                items:
                  type: array
                  description: 'Itens para fatura.'
                  example:
                    -
                      item_id: 34
                      amount: 1200
                  items:
                    type: json
                contract_id:
                  type: integer
                  description: 'ID do contrato.'
                  example: 2
                  nullable: false
                billing_id:
                  type: integer
                  description: 'ID do método de cobrança automático.'
                  example: 5
                  nullable: false
                billing_method:
                  type: string
                  description: "Método de cobrança\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
                  nullable: false
                paid:
                  type: boolean
                  description: 'Paga. Pode ser `true` (Pago) ou `false` (Agendado/Não Pago).'
                  example: false
                  nullable: false
                paid_at:
                  type: string
                  description: 'Data do pagamento.'
                  example: '2024-01-01'
                  nullable: false
                credit_at:
                  type: string
                  description: 'Data do crédito.'
                  example: '2024-01-02'
                  nullable: false
                payment_error:
                  type: boolean
                  description: 'Erro no pagamento.'
                  example: true
                  nullable: false
                guaranteed_transfer:
                  type: boolean
                  description: 'Repasse garantido.'
                  example: true
                  nullable: false
                period_initial:
                  type: string
                  description: 'Data de início da fatura, aluguel.'
                  example: '2024-01-01'
                  nullable: false
                period_final:
                  type: string
                  description: 'Data final da fatura, aluguel.'
                  example: '2024-01-31'
                  nullable: false
                tag:
                  type: array
                  description: 'Tags da fatura.'
                  example:
                    - 123
                    - 456
                    - 789
                  items:
                    type: string
                ticket_registered:
                  type: boolean
                  description: 'Boleto registrado.'
                  example: false
                  nullable: false
                ticket_date:
                  type: string
                  description: 'Data do boleto.'
                  example: '2024-01-01 00:00:00'
                  nullable: false
                ticket_key:
                  type: string
                  description: 'ID da cobrança dentro do banco integrador (Asaas).'
                  example: abc123
                  nullable: false
                ticket_id:
                  type: integer
                  description: 'ID do boleto.'
                  example: 1
                  nullable: false
                ticket_fee:
                  type: string
                  description: 'Taxa do boleto.'
                  example: '12.0'
                  nullable: false
                ticket_link:
                  type: string
                  description: 'Link do boleto.'
                  example: 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1'
                  nullable: false
                ticket_barcode:
                  type: string
                  description: 'Código de barras do boleto .'
                  example: '12395828200001760000010003821587100516853008'
                  nullable: false
                ticket_info:
                  type: string
                  description: 'Informações do boleto.'
                  example: 'Este boleto...'
                  nullable: false
                ticket_digitable:
                  type: string
                  description: 'Linha digitável do boleto.'
                  example: '12390.01007 03821.587106 05168.530086 5 82820000176000'
                  nullable: false
                ticket_without_pix:
                  type: boolean
                  description: 'Boleto sem pix.'
                  example: false
                  nullable: false
                ticket_late_fee:
                  type: boolean
                  description: 'Adicionar Multa e Juros para contratos de Locação.'
                  example: true
                  nullable: false
                ticket_late_fee_item_id:
                  type: integer
                  description: 'ID do item que será aplicado a multa.'
                  example: 1
                  nullable: false
                ticket_late_fee_percentage:
                  type: integer
                  description: 'Multa (%).'
                  example: 12
                  nullable: false
                ticket_late_fee_interest:
                  type: integer
                  description: 'Juros (%).'
                  example: 13
                  nullable: false
                ticket_discount:
                  type: boolean
                  description: 'Adicionar Desconto de Pontualidade.'
                  example: true
                  nullable: false
                ticket_discount_mode:
                  type: string
                  description: "Modo de desconto.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
                  example: percentage
                  nullable: false
                ticket_discount_fixed:
                  type: string
                  description: 'Desconto (R$).'
                  example: '123.20'
                  nullable: false
                ticket_discount_percentage:
                  type: string
                  description: Desconto(%).
                  example: '10'
                  nullable: false
                ticket_discount_action:
                  type: string
                  description: "Ação do desconto de pontualidade.\nValores permitidos:\n- `business`: Reter desconto para imobiliária\n- `owner`: Repassar desconto ao proprietário"
                  example: business
                  nullable: false
                ticket_discount_days:
                  type: integer
                  description: 'Quantidade de dias antes do vencimento.'
                  example: 12
                  nullable: false
                transfer_auto_disabled:
                  type: boolean
                  description: 'Desativar repasse automático.'
                  example: false
                  nullable: false
                protest:
                  type: json
                  description: Protesto.
                  example: '{"status":"PENDING"}'
                  nullable: false
              required:
                - type
                - payer_id
                - business_id
                - account_id
                - description
                - total
                - date
                - due_date
                - items
                - billing_method
  '/invoices/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,type,total'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,type,total'
            nullable: false
        -
          in: query
          name: 'include[items]'
          description: ''
          example: quisquam
          required: false
          schema:
            type: string
            description: ''
            example: quisquam
            nullable: false
        -
          in: query
          name: 'include[itemsPayer]'
          description: ''
          example: quasi
          required: false
          schema:
            type: string
            description: ''
            example: quasi
            nullable: false
        -
          in: query
          name: 'include[itemsAllGroupTransfer]'
          description: ''
          example: voluptatem
          required: false
          schema:
            type: string
            description: ''
            example: voluptatem
            nullable: false
        -
          in: query
          name: 'include[itemsAll]'
          description: ''
          example: dolore
          required: false
          schema:
            type: string
            description: ''
            example: dolore
            nullable: false
        -
          in: query
          name: 'include[autoTransactions]'
          description: ''
          example: et
          required: false
          schema:
            type: string
            description: ''
            example: et
            nullable: false
        -
          in: query
          name: 'include[building]'
          description: ''
          example: itaque
          required: false
          schema:
            type: string
            description: ''
            example: itaque
            nullable: false
        -
          in: query
          name: 'include[billing]'
          description: ''
          example: quo
          required: false
          schema:
            type: string
            description: ''
            example: quo
            nullable: false
        -
          in: query
          name: 'include[payer]'
          description: 'Retorna os dados do pagador.'
          example: 'id,name,type'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do pagador.'
            example: 'id,name,type'
            nullable: false
        -
          in: query
          name: 'include[account]'
          description: ''
          example: molestiae
          required: false
          schema:
            type: string
            description: ''
            example: molestiae
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Retorna os dados do contrato.'
          example: '*'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do contrato.'
            example: '*'
            nullable: false
        -
          in: query
          name: 'include[business]'
          description: 'Retorna os dados da empresa.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da empresa.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[lateFeeItem]'
          description: ''
          example: dolorem
          required: false
          schema:
            type: string
            description: ''
            example: dolorem
            nullable: false
        -
          in: query
          name: 'include[files]'
          description: 'Retorna os anexos da fatura.'
          example: 'id,name,file_name'
          required: false
          schema:
            type: string
            description: 'Retorna os anexos da fatura.'
            example: 'id,name,file_name'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as tags.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[messages]'
          description: 'Retorna as mensagens referente à fatura.'
          example: 'id,type,message'
          required: false
          schema:
            type: string
            description: 'Retorna as mensagens referente à fatura.'
            example: 'id,type,message'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: "Tipo da fatura.\nValores permitidos:\n- `single`: Avulsa\n- `contract`: Contrato"
                  example: single
                  nullable: false
                payer_id:
                  type: integer
                  description: 'ID do pagador.'
                  example: 1
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do contrato.'
                  example: 2
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa.'
                  example: 3
                  nullable: false
                account_id:
                  type: integer
                  description: 'ID da conta bancária.'
                  example: 4
                  nullable: false
                billing_id:
                  type: integer
                  description: 'ID do método de cobrança automático.'
                  example: 5
                  nullable: false
                billing_method:
                  type: string
                  description: "Método de cobrança\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
                  nullable: false
                paid:
                  type: boolean
                  description: 'Paga. Pode ser `true` (Pago) ou `false` (Agendado/Não Pago).'
                  example: false
                  nullable: false
                paid_at:
                  type: string
                  description: 'Data do pagamento.'
                  example: '2024-01-01'
                  nullable: false
                credit_at:
                  type: string
                  description: 'Data do crédito.'
                  example: '2024-01-02'
                  nullable: false
                payment_error:
                  type: boolean
                  description: 'Erro no pagamento.'
                  example: true
                  nullable: false
                description:
                  type: string
                  description: 'Descrição da fatura.'
                  example: 'Fatura X'
                  nullable: false
                total:
                  type: number
                  description: 'Valor total da fatura.'
                  example: 1200.0
                  nullable: false
                date:
                  type: string
                  description: Competência.
                  example: '2024-01-01'
                  nullable: false
                due_date:
                  type: string
                  description: 'Data de vencimento.'
                  example: '2024-01-10'
                  nullable: false
                items:
                  type: array
                  description: "Itens para fatura.\n- Adicionar: `{\"item_id\": 34, \"amount\": 100, \"description\": \"Item 1\"}`\n- Editar: `{\"id\": 1, \"item_id\": 34, \"amount\": 150, \"description\": \"Item 1 Editado\"}`\n- Excluir: `{\"id\": 1, \"item_id\": 34, \"delete\": true}`"
                  example: null
                  items:
                    type: json
                guaranteed_transfer:
                  type: boolean
                  description: 'Repasse garantido.'
                  example: true
                  nullable: false
                period_initial:
                  type: string
                  description: 'Data de início da fatura, aluguel.'
                  example: '2024-01-01'
                  nullable: false
                period_final:
                  type: string
                  description: 'Data final da fatura, aluguel.'
                  example: '2024-01-31'
                  nullable: false
                tag:
                  type: array
                  description: 'Tags da fatura.'
                  example:
                    - 123
                    - 456
                    - 789
                  items:
                    type: string
                ticket_registered:
                  type: boolean
                  description: 'Boleto registrado.'
                  example: false
                  nullable: false
                ticket_date:
                  type: string
                  description: 'Data do boleto.'
                  example: '2024-01-01 00:00:00'
                  nullable: false
                ticket_key:
                  type: string
                  description: 'ID da cobrança dentro do banco integrador (Asaas).'
                  example: abc123
                  nullable: false
                ticket_id:
                  type: integer
                  description: 'ID do boleto.'
                  example: 1
                  nullable: false
                ticket_fee:
                  type: string
                  description: 'Taxa do boleto.'
                  example: '12.0'
                  nullable: false
                ticket_link:
                  type: string
                  description: 'Link do boleto.'
                  example: 'https://api.pjbank.com.br/boletos/823a8ee8043b3a96e2df963bead9gg63e5ea16c1'
                  nullable: false
                ticket_barcode:
                  type: string
                  description: 'Código de barras do boleto .'
                  example: '12395828200001760000010003821587100516853008'
                  nullable: false
                ticket_info:
                  type: string
                  description: 'Informações do boleto.'
                  example: 'Este boleto...'
                  nullable: false
                ticket_digitable:
                  type: string
                  description: 'Linha digitável do boleto.'
                  example: '12390.01007 03821.587106 05168.530086 5 82820000176000'
                  nullable: false
                ticket_without_pix:
                  type: boolean
                  description: 'Boleto sem pix.'
                  example: false
                  nullable: false
                ticket_late_fee:
                  type: boolean
                  description: 'Adicionar Multa e Juros para contratos de Locação.'
                  example: true
                  nullable: false
                ticket_late_fee_item_id:
                  type: integer
                  description: 'ID do item que será aplicado a multa.'
                  example: 1
                  nullable: false
                ticket_late_fee_percentage:
                  type: integer
                  description: 'Multa (%).'
                  example: 12
                  nullable: false
                ticket_late_fee_interest:
                  type: integer
                  description: 'Juros (%).'
                  example: 13
                  nullable: false
                ticket_discount:
                  type: boolean
                  description: 'Adicionar Desconto de Pontualidade.'
                  example: true
                  nullable: false
                ticket_discount_mode:
                  type: string
                  description: "Modo de desconto.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
                  example: percentage
                  nullable: false
                ticket_discount_fixed:
                  type: string
                  description: 'Desconto (R$).'
                  example: '123.20'
                  nullable: false
                ticket_discount_percentage:
                  type: string
                  description: Desconto(%).
                  example: '10'
                  nullable: false
                ticket_discount_action:
                  type: string
                  description: "Ação do desconto de pontualidade.\nValores permitidos:\n- `business`: Reter desconto para imobiliária\n- `owner`: Repassar desconto ao proprietário"
                  example: business
                  nullable: false
                ticket_discount_days:
                  type: integer
                  description: 'Quantidade de dias antes do vencimento.'
                  example: 12
                  nullable: false
                transfer_auto_disabled:
                  type: boolean
                  description: 'Desativar repasse automático.'
                  example: false
                  nullable: false
                protest:
                  type: json
                  description: Protesto.
                  example: '{"status":"PENDING"}'
                  nullable: false
              required:
                - billing_method
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                removeLiquidated:
                  type: boolean
                  description: 'Caso informado, será removido a fatura mesmo que esteja liquidada'
                  example: false
                  nullable: false
                removeWithFiscalNote:
                  type: boolean
                  description: 'Caso informado, será removido a fatura mesmo que alguma nota fiscal fora laçada vinculada a um item desta fatura'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: id
        description: 'ID da Fatura'
        example: 7
        required: true
        schema:
          type: integer
  /transactions:
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,type,total'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,type,total'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do lançamento.'
          example: '1'
          required: false
          schema:
            type: string
            description: 'ID do lançamento.'
            example: '1'
            nullable: false
        -
          in: query
          name: 'filter[company_id]'
          description: 'ID da empresa.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da empresa.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[split]'
          description: 'Filtra lançamentos por ID de agrupamento'
          example: '50'
          required: false
          schema:
            type: string
            description: 'Filtra lançamentos por ID de agrupamento'
            example: '50'
            nullable: false
        -
          in: query
          name: 'filter[invoice_id]'
          description: 'ID da fatura.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da fatura.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[transfer_id]'
          description: 'ID da transferência.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da transferência.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[morph_key]'
          description: 'Chave do módulo.'
          example: invoice
          required: false
          schema:
            type: string
            description: 'Chave do módulo.'
            example: invoice
            nullable: false
        -
          in: query
          name: 'filter[mode]'
          description: "Modo do lançamento.\nValores permitidos:\n- `transaction`: Lançamentos\n- `invoice`: Faturas\n- `transfer`: Repasses\n- `commission`: Comissões\n- `transfer_commission`: Repasses de Comissões\n- `guaranteed_rent`: Aluguel Garantido\n- `chargeback`: Estornos"
          example: transaction
          required: false
          schema:
            type: string
            description: "Modo do lançamento.\nValores permitidos:\n- `transaction`: Lançamentos\n- `invoice`: Faturas\n- `transfer`: Repasses\n- `commission`: Comissões\n- `transfer_commission`: Repasses de Comissões\n- `guaranteed_rent`: Aluguel Garantido\n- `chargeback`: Estornos"
            example: transaction
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: "Tipo do lançamento.\nValores permitidos:\n- `debit`: Despesa\n- `credit`: Crédito\n- `transfer`: Transferência"
          example: debit
          required: false
          schema:
            type: string
            description: "Tipo do lançamento.\nValores permitidos:\n- `debit`: Despesa\n- `credit`: Crédito\n- `transfer`: Transferência"
            example: debit
            nullable: false
        -
          in: query
          name: 'filter[account_id]'
          description: 'ID da conta bancária.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da conta bancária.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[business_id]'
          description: 'ID da empresa.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da empresa.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[plan_id]'
          description: 'ID do plano de contas.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do plano de contas.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[user_id]'
          description: 'ID do usuário.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do usuário.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[item_id]'
          description: 'ID do item.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do item.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[guaranteed_transfer_id]'
          description: 'ID da transferência garantida.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da transferência garantida.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'ID da pessoa.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da pessoa.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[building_id]'
          description: 'ID do imóvel.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do imóvel.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[contract_id]'
          description: 'ID do contrato.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do contrato.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[broker_id]'
          description: 'ID do corretor.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do corretor.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[owner_id]'
          description: 'ID do proprietário.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do proprietário.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[tenant_id]'
          description: 'ID do inquilino.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do inquilino.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[extract]'
          description: "Extrato.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
          example: owner
          required: false
          schema:
            type: string
            description: "Extrato.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
            example: owner
            nullable: false
        -
          in: query
          name: 'filter[date]'
          description: 'date Data do lançamento.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Data do lançamento.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[position]'
          description: Posição.
          example: 1
          required: false
          schema:
            type: integer
            description: Posição.
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[amount]'
          description: 'decimal Valor.'
          example: '100.00'
          required: false
          schema:
            type: string
            description: 'decimal Valor.'
            example: '100.00'
            nullable: false
        -
          in: query
          name: 'filter[amount_primary]'
          description: 'decimal Valor original.'
          example: '100.00'
          required: false
          schema:
            type: string
            description: 'decimal Valor original.'
            example: '100.00'
            nullable: false
        -
          in: query
          name: 'filter[percentage]'
          description: 'decimal Porcentagem.'
          example: '10.00'
          required: false
          schema:
            type: string
            description: 'decimal Porcentagem.'
            example: '10.00'
            nullable: false
        -
          in: query
          name: 'filter[competence]'
          description: 'date Competência.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Competência.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: 'Conta de Luz'
          required: false
          schema:
            type: string
            description: Descrição.
            example: 'Conta de Luz'
            nullable: false
        -
          in: query
          name: 'filter[paid]'
          description: 'Filtra lançamentos pagos'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos pagos'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[due_date]'
          description: 'date Data de vencimento.'
          example: '2024-01-10'
          required: false
          schema:
            type: string
            description: 'date Data de vencimento.'
            example: '2024-01-10'
            nullable: false
        -
          in: query
          name: 'filter[billing_method]'
          description: "Método de cobrança.\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: "Método de cobrança.\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
            nullable: false
        -
          in: query
          name: 'filter[onlyVisible]'
          description: 'Filtra apenas lançamentos visíveis'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra apenas lançamentos visíveis'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[transfer]'
          description: 'Filtra lançamentos do modo transferência'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do modo transferência'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[brokerTransfer]'
          description: 'Filtra lançamentos do modo transferência de comissão'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do modo transferência de comissão'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[autoTransfer]'
          description: 'Filtra lançamentos de transferência automática'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos de transferência automática'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[manualTransfer]'
          description: 'Filtra lançamentos de transferência manual'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos de transferência manual'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[bill]'
          description: 'Filtra lançamentos relacionados a contas a pagar'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos relacionados a contas a pagar'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[guaranteedTransferIn][]'
          description: 'Filtra lançamentos por IDs de transferência garantida'
          example: 5
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de transferência garantida'
            example: 5
            items:
              type: integer
        -
          in: query
          name: 'filter[haveTransfer][]'
          description: 'Filtra lançamentos que possuem as transferências com os IDs especificados'
          example: 10
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos que possuem as transferências com os IDs especificados'
            example: 10
            items:
              type: integer
        -
          in: query
          name: 'filter[personIn][]'
          description: 'Filtra lançamentos por IDs de pessoa'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de pessoa'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[tenantIn][]'
          description: 'Filtra lançamentos por IDs de inquilino'
          example: 3
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de inquilino'
            example: 3
            items:
              type: integer
        -
          in: query
          name: 'filter[ownerIn][]'
          description: 'Filtra lançamentos por IDs de proprietário'
          example: 5
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de proprietário'
            example: 5
            items:
              type: integer
        -
          in: query
          name: 'filter[ownerPlan]'
          description: 'Filtra lançamentos com plano de contas de proprietário'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos com plano de contas de proprietário'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[brokerPlan]'
          description: 'Filtra lançamentos com plano de contas de corretor'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos com plano de contas de corretor'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[tenantPlan]'
          description: 'Filtra lançamentos com plano de contas de inquilino'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos com plano de contas de inquilino'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[brokerIn][]'
          description: 'Filtra lançamentos por IDs de corretor'
          example: 7
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de corretor'
            example: 7
            items:
              type: integer
        -
          in: query
          name: 'filter[buildingIn][]'
          description: 'Filtra lançamentos por IDs de imóvel'
          example: 9
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de imóvel'
            example: 9
            items:
              type: integer
        -
          in: query
          name: 'filter[accountIn][]'
          description: 'Filtra lançamentos por IDs de conta financeira'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de conta financeira'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[businessIn][]'
          description: 'Filtra lançamentos por IDs de empresa'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de empresa'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[businessAllowedIn][]'
          description: 'Filtra lançamentos por IDs de empresas permitidas'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de empresas permitidas'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[itemIn][]'
          description: 'Filtra lançamentos por IDs de item'
          example: 100
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de item'
            example: 100
            items:
              type: integer
        -
          in: query
          name: 'filter[status]'
          description: 'Filtra lançamentos por status (paid ou unpaid)'
          example: paid
          required: false
          schema:
            type: string
            description: 'Filtra lançamentos por status (paid ou unpaid)'
            example: paid
            nullable: false
        -
          in: query
          name: 'filter[invoiceStatus]'
          description: 'Filtra lançamentos por status da fatura (paid, unpaid, overdue, in_protest, refunded, partially_paid, canceled ou uncollectible)'
          example: unpaid
          required: false
          schema:
            type: string
            description: 'Filtra lançamentos por status da fatura (paid, unpaid, overdue, in_protest, refunded, partially_paid, canceled ou uncollectible)'
            example: unpaid
            nullable: false
        -
          in: query
          name: 'filter[unpaid]'
          description: 'Filtra lançamentos não pagos'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos não pagos'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[paidOrGuaranteed]'
          description: 'Filtra lançamentos pagos ou com repasse garantido'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos pagos ou com repasse garantido'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[typeIn][]'
          description: 'Filtra lançamentos por tipos (credit, debit, transfer)'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por tipos (credit, debit, transfer)'
            example: null
            items:
              type: integer
        -
          in: query
          name: 'filter[typeInvoiceIn][]'
          description: 'Filtra lançamentos por tipo de fatura (geralmente credit)'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por tipo de fatura (geralmente credit)'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[modeIn][]'
          description: 'Filtra lançamentos por modos'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por modos'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[itemType][]'
          description: 'Filtra lançamentos por tipo de item'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por tipo de item'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[contractTypeIn][]'
          description: 'Filtra lançamentos por tipo de contrato'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por tipo de contrato'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[planIn][]'
          description: 'Filtra lançamentos por IDs de plano de contas'
          example: 10
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de plano de contas'
            example: 10
            items:
              type: integer
        -
          in: query
          name: 'filter[planAllIn][]'
          description: 'Filtra lançamentos por IDs de plano de contas (incluindo pais)'
          example: 10
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de plano de contas (incluindo pais)'
            example: 10
            items:
              type: integer
        -
          in: query
          name: 'filter[contractIn][]'
          description: 'Filtra lançamentos por IDs de contrato'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de contrato'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[contractIdIn][]'
          description: 'Filtra lançamentos por IDs de contrato (id2)'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de contrato (id2)'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[contractActiveIn][]'
          description: 'Filtra lançamentos por status de atividade do contrato'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por status de atividade do contrato'
            example: null
            items:
              type: integer
        -
          in: query
          name: 'filter[invoiceIn][]'
          description: 'Filtra lançamentos por IDs de fatura'
          example: 200
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de fatura'
            example: 200
            items:
              type: integer
        -
          in: query
          name: 'filter[isNotInvoice]'
          description: 'Filtra lançamentos que não são faturas'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos que não são faturas'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[invoiceIdIn][]'
          description: 'Filtra lançamentos por IDs de fatura (id2)'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de fatura (id2)'
            example: null
            items:
              type: integer
        -
          in: query
          name: 'filter[positionMin]'
          description: 'Filtra lançamentos por posição mínima (timestamp + position)'
          example: 1678886400
          required: false
          schema:
            type: integer
            description: 'Filtra lançamentos por posição mínima (timestamp + position)'
            example: 1678886400
            nullable: false
        -
          in: query
          name: 'filter[positionMax]'
          description: 'Filtra lançamentos por posição máxima (timestamp + position)'
          example: 1678972800
          required: false
          schema:
            type: integer
            description: 'Filtra lançamentos por posição máxima (timestamp + position)'
            example: 1678972800
            nullable: false
        -
          in: query
          name: 'filter[onlyAllowed]'
          description: 'Filtra lançamentos permitidos ao usuário logado'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos permitidos ao usuário logado'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[billingMethodIn][]'
          description: 'Filtra lançamentos por métodos de cobrança. Valores comuns incluem `pix`, `bank_transfer`, etc.'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por métodos de cobrança. Valores comuns incluem `pix`, `bank_transfer`, etc.'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[ticketRegister]'
          description: 'Filtra lançamentos por registro de ticket (registered ou unregistered)'
          example: registered
          required: false
          schema:
            type: string
            description: 'Filtra lançamentos por registro de ticket (registered ou unregistered)'
            example: registered
            nullable: false
        -
          in: query
          name: 'filter[onlyInvoice]'
          description: 'Filtra apenas lançamentos que são faturas'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra apenas lançamentos que são faturas'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[itemListOwnerReport]'
          description: 'Filtra lançamentos para relatório do proprietário'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos para relatório do proprietário'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[extractIn][]'
          description: 'Filtra lançamentos por extrato'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por extrato'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[overdue]'
          description: 'Filtra lançamentos vencidos'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos vencidos'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[early]'
          description: 'Filtra lançamentos a vencer'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos a vencer'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[forBusiness]'
          description: 'Filtra lançamentos do extrato da empresa'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do extrato da empresa'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[forOwner]'
          description: 'Filtra lançamentos do extrato do proprietário'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do extrato do proprietário'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[forBroker]'
          description: 'Filtra lançamentos do extrato do corretor'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do extrato do corretor'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[forTenant]'
          description: 'Filtra lançamentos do extrato do inquilino'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do extrato do inquilino'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[forPayer]'
          description: 'Filtra lançamentos do extrato do pagador'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos do extrato do pagador'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[tagIn][]'
          description: 'Filtra lançamentos por tags'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por tags'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[invoiceTypeIn]'
          description: "Filtra lançamentos por tipo de fatura 'single'"
          example: true
          required: false
          schema:
            type: boolean
            description: "Filtra lançamentos por tipo de fatura 'single'"
            example: true
            nullable: false
        -
          in: query
          name: 'filter[paidGuaranteedOrTransfer]'
          description: 'Filtra lançamentos pagos, garantidos ou de transferência'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos pagos, garantidos ou de transferência'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[billIdIn][]'
          description: 'Filtra lançamentos por IDs de contas a pagar'
          example: 300
          required: false
          schema:
            type: array
            description: 'Filtra lançamentos por IDs de contas a pagar'
            example: 300
            items:
              type: integer
        -
          in: query
          name: 'filter[billPayment]'
          description: 'Filtra lançamentos relacionados a pagamentos de contas'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos relacionados a pagamentos de contas'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[brokerCommission]'
          description: 'Filtra lançamentos de comissão do corretor logado'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra lançamentos de comissão do corretor logado'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[invoicePaidIn]'
          description: 'Filtra lançamentos por status de pagamento da fatura (paid ou unpaid)'
          example: paid
          required: false
          schema:
            type: string
            description: 'Filtra lançamentos por status de pagamento da fatura (paid ou unpaid)'
            example: paid
            nullable: false
        -
          in: query
          name: 'include[item]'
          description: 'Retorna os dados do item da transação.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do item da transação.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[commissionItem]'
          description: 'Retorna os dados do item de comissão.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do item de comissão.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Retorna os dados do contrato.'
          example: 'id,number'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do contrato.'
            example: 'id,number'
            nullable: false
        -
          in: query
          name: 'include[owner]'
          description: 'Retorna os dados do proprietário.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do proprietário.'
            example: 'id,name'
            nullable: 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'
            nullable: false
        -
          in: query
          name: 'include[tenant]'
          description: 'Retorna os dados do inquilino.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do inquilino.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[building]'
          description: 'Retorna os dados do imóvel.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do imóvel.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[account]'
          description: 'Retorna os dados da conta financeira.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da conta financeira.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[plan]'
          description: 'Retorna os dados do plano de contas.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do plano de contas.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[invoice]'
          description: 'Retorna os dados da fatura.'
          example: 'id,number'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da fatura.'
            example: 'id,number'
            nullable: false
        -
          in: query
          name: 'include[files]'
          description: 'Retorna os anexos da transação.'
          example: 'id,name,file_name'
          required: false
          schema:
            type: string
            description: 'Retorna os anexos da transação.'
            example: 'id,name,file_name'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as tags.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[transferredBy]'
          description: 'Retorna as transações que geraram esta transferência.'
          example: 'id,amount'
          required: false
          schema:
            type: string
            description: 'Retorna as transações que geraram esta transferência.'
            example: 'id,amount'
            nullable: false
        -
          in: query
          name: 'include[transferredItems]'
          description: 'Retorna os itens transferidos.'
          example: 'id,amount'
          required: false
          schema:
            type: string
            description: 'Retorna os itens transferidos.'
            example: 'id,amount'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do lançamento'
                  example: 'Pagamento de aluguel'
                  nullable: false
                amount:
                  type: number
                  description: 'Valor do lançamento'
                  example: 1500.0
                  nullable: false
                amount_primary:
                  type: number
                  description: 'Valor original do lançamento'
                  example: 1500.0
                  nullable: false
                date:
                  type: date
                  description: 'Data do lançamento'
                  example: '2024-03-20'
                  nullable: false
                type:
                  type: string
                  description: "Tipo do lançamento.\nValores permitidos:\n- `debit`: Despesa\n- `credit`: Crédito\n- `transfer`: Transferência"
                  example: credit
                  nullable: false
                mode:
                  type: string
                  description: "Modo do lançamento.\nValores permitidos:\n- `transaction`: Lançamentos\n- `invoice`: Faturas\n- `transfer`: Repasses\n- `commission`: Comissões\n- `transfer_commission`: Repasses de Comissões\n- `guaranteed_rent`: Aluguel Garantido\n- `chargeback`: Estornos"
                  example: transaction
                  nullable: false
                plan_id:
                  type: integer
                  description: 'Plano de contas'
                  example: 11
                  nullable: false
                business_id:
                  type: integer
                  description: Empresa
                  example: 6
                  nullable: false
                account_id:
                  type: integer
                  description: 'Conta financeira'
                  example: 1
                  nullable: false
                person_id:
                  type: integer
                  description: 'Pessoa relacionada'
                  example: 1
                  nullable: false
                building_id:
                  type: integer
                  description: 'Imóvel relacionado'
                  example: 1
                  nullable: false
                contract_id:
                  type: integer
                  description: 'Contrato relacionado'
                  example: 1
                  nullable: false
                owner_id:
                  type: integer
                  description: 'Proprietário relacionado'
                  example: 1
                  nullable: false
                tenant_id:
                  type: integer
                  description: 'Inquilino relacionado'
                  example: 1
                  nullable: false
                broker_id:
                  type: integer
                  description: 'Corretor relacionado'
                  example: 1
                  nullable: false
                item_id:
                  type: integer
                  description: 'Item da transação'
                  example: 1
                  nullable: false
                invoice_id:
                  type: integer
                  description: 'Fatura relacionada'
                  example: 1
                  nullable: false
                tag:
                  type: array
                  description: 'Tags relacionadas'
                  example:
                    - 1
                    - 2
                  items:
                    type: string
                notes:
                  type: string
                  description: Observações
                  example: 'Observação importante'
                  nullable: false
                paid:
                  type: boolean
                  description: 'Pago. Pode ser `true` (Pago) ou `false` (Agendado/Não Pago).'
                  example: true
                  nullable: false
                due_date:
                  type: date
                  description: 'Data de vencimento'
                  example: '2024-03-20'
                  nullable: false
                billing_method:
                  type: string
                  description: "Método de cobrança\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
                  nullable: false
                interest:
                  type: number
                  description: Juros
                  example: 10.0
                  nullable: false
                discount:
                  type: number
                  description: Desconto
                  example: 10.0
                  nullable: false
                check_agency:
                  type: string
                  description: 'Agência do cheque'
                  example: '1234'
                  nullable: false
                check_account:
                  type: string
                  description: 'Conta do cheque'
                  example: 12345-6
                  nullable: false
                check_id:
                  type: string
                  description: 'Número do cheque'
                  example: '123456'
                  nullable: false
                recurrency_periodicity:
                  type: string
                  description: "Periodicidade da recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `weekly`: Semanalmente\n- `monthly`: Mensalmente\n- `bimonthly`: Bimestralmente\n- `quarterly`: Trimestralmente\n- `semiannually`: Semestralmente\n- `annually`: Anualmente"
                  example: monthly
                  nullable: false
                recurrency_total:
                  type: integer
                  description: 'Total de recorrências'
                  example: 12
                  nullable: false
                recurrency_installment:
                  type: integer
                  description: 'Parcela atual'
                  example: 1
                  nullable: false
                commission:
                  type: boolean
                  description: Comissão
                  example: true
                  nullable: false
                commission_mode:
                  type: string
                  description: "Modo da comissão.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
                  example: fixed
                  nullable: false
                commission_fixed:
                  type: number
                  description: 'Valor fixo da comissão'
                  example: 100.0
                  nullable: false
                commission_percentage:
                  type: number
                  description: 'Percentual da comissão'
                  example: 10.0
                  nullable: false
                commission_item_id:
                  type: integer
                  description: 'Item da comissão'
                  example: 1
                  nullable: false
                commission_id:
                  type: integer
                  description: 'Comissão relacionada'
                  example: 1
                  nullable: false
                metadata:
                  type: json
                  description: Metadados
                  example: '{"key": "value"}'
                  nullable: false
              required:
                - description
                - amount
                - amount_primary
                - date
                - type
                - mode
                - plan_id
                - business_id
                - account_id
                - billing_method
  '/transactions/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,type,total'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,type,total'
            nullable: false
        -
          in: query
          name: 'include[item]'
          description: 'Retorna os dados do item da transação.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do item da transação.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[commissionItem]'
          description: 'Retorna os dados do item de comissão.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do item de comissão.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Retorna os dados do contrato.'
          example: 'id,number'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do contrato.'
            example: 'id,number'
            nullable: false
        -
          in: query
          name: 'include[owner]'
          description: 'Retorna os dados do proprietário.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do proprietário.'
            example: 'id,name'
            nullable: 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'
            nullable: false
        -
          in: query
          name: 'include[tenant]'
          description: 'Retorna os dados do inquilino.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do inquilino.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[building]'
          description: 'Retorna os dados do imóvel.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do imóvel.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[account]'
          description: 'Retorna os dados da conta financeira.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da conta financeira.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[plan]'
          description: 'Retorna os dados do plano de contas.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do plano de contas.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[invoice]'
          description: 'Retorna os dados da fatura.'
          example: 'id,number'
          required: false
          schema:
            type: string
            description: 'Retorna os dados da fatura.'
            example: 'id,number'
            nullable: false
        -
          in: query
          name: 'include[files]'
          description: 'Retorna os anexos da transação.'
          example: 'id,name,file_name'
          required: false
          schema:
            type: string
            description: 'Retorna os anexos da transação.'
            example: 'id,name,file_name'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as tags.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[transferredBy]'
          description: 'Retorna as transações que geraram esta transferência.'
          example: 'id,amount'
          required: false
          schema:
            type: string
            description: 'Retorna as transações que geraram esta transferência.'
            example: 'id,amount'
            nullable: false
        -
          in: query
          name: 'include[transferredItems]'
          description: 'Retorna os itens transferidos.'
          example: 'id,amount'
          required: false
          schema:
            type: string
            description: 'Retorna os itens transferidos.'
            example: 'id,amount'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do lançamento'
                  example: 'Pagamento de aluguel'
                  nullable: false
                amount:
                  type: number
                  description: 'Valor do lançamento'
                  example: 1500.0
                  nullable: false
                amount_primary:
                  type: number
                  description: 'Valor original do lançamento'
                  example: 1500.0
                  nullable: false
                date:
                  type: date
                  description: 'Data do lançamento'
                  example: '2024-03-20'
                  nullable: false
                type:
                  type: string
                  description: "Tipo do lançamento.\nValores permitidos:\n- `debit`: Despesa\n- `credit`: Crédito\n- `transfer`: Transferência"
                  example: credit
                  nullable: false
                mode:
                  type: string
                  description: "Modo do lançamento.\nValores permitidos:\n- `transaction`: Lançamentos\n- `invoice`: Faturas\n- `transfer`: Repasses\n- `commission`: Comissões\n- `transfer_commission`: Repasses de Comissões\n- `guaranteed_rent`: Aluguel Garantido\n- `chargeback`: Estornos"
                  example: transaction
                  nullable: false
                plan_id:
                  type: integer
                  description: 'Plano de contas'
                  example: 11
                  nullable: false
                business_id:
                  type: integer
                  description: Empresa
                  example: 6
                  nullable: false
                account_id:
                  type: integer
                  description: 'Conta financeira'
                  example: 1
                  nullable: false
                person_id:
                  type: integer
                  description: 'Pessoa relacionada'
                  example: 1
                  nullable: false
                building_id:
                  type: integer
                  description: 'Imóvel relacionado'
                  example: 1
                  nullable: false
                contract_id:
                  type: integer
                  description: 'Contrato relacionado'
                  example: 1
                  nullable: false
                owner_id:
                  type: integer
                  description: 'Proprietário relacionado'
                  example: 1
                  nullable: false
                tenant_id:
                  type: integer
                  description: 'Inquilino relacionado'
                  example: 1
                  nullable: false
                broker_id:
                  type: integer
                  description: 'Corretor relacionado'
                  example: 1
                  nullable: false
                item_id:
                  type: integer
                  description: 'Item da transação'
                  example: 1
                  nullable: false
                invoice_id:
                  type: integer
                  description: 'Fatura relacionada'
                  example: 1
                  nullable: false
                tag:
                  type: array
                  description: 'Tags relacionadas'
                  example:
                    - 1
                    - 2
                  items:
                    type: string
                notes:
                  type: string
                  description: Observações
                  example: 'Observação importante'
                  nullable: false
                paid:
                  type: boolean
                  description: 'Pago. Pode ser `true` (Pago) ou `false` (Agendado/Não Pago).'
                  example: true
                  nullable: false
                due_date:
                  type: date
                  description: 'Data de vencimento'
                  example: '2024-03-20'
                  nullable: false
                billing_method:
                  type: string
                  description: "Método de cobrança\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
                  nullable: false
                interest:
                  type: number
                  description: Juros
                  example: 10.0
                  nullable: false
                discount:
                  type: number
                  description: Desconto
                  example: 10.0
                  nullable: false
                check_agency:
                  type: string
                  description: 'Agência do cheque'
                  example: '1234'
                  nullable: false
                check_account:
                  type: string
                  description: 'Conta do cheque'
                  example: 12345-6
                  nullable: false
                check_id:
                  type: string
                  description: 'Número do cheque'
                  example: '123456'
                  nullable: false
                recurrency_periodicity:
                  type: string
                  description: "Periodicidade da recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `weekly`: Semanalmente\n- `monthly`: Mensalmente\n- `bimonthly`: Bimestralmente\n- `quarterly`: Trimestralmente\n- `semiannually`: Semestralmente\n- `annually`: Anualmente"
                  example: monthly
                  nullable: false
                recurrency_total:
                  type: integer
                  description: 'Total de recorrências'
                  example: 12
                  nullable: false
                recurrency_installment:
                  type: integer
                  description: 'Parcela atual'
                  example: 1
                  nullable: false
                commission:
                  type: boolean
                  description: Comissão
                  example: true
                  nullable: false
                commission_mode:
                  type: string
                  description: "Modo da comissão.\nValores permitidos:\n- `fixed`: Valor Fixo\n- `percentage`: Porcentagem"
                  example: fixed
                  nullable: false
                commission_fixed:
                  type: number
                  description: 'Valor fixo da comissão'
                  example: 100.0
                  nullable: false
                commission_percentage:
                  type: number
                  description: 'Percentual da comissão'
                  example: 10.0
                  nullable: false
                commission_item_id:
                  type: integer
                  description: 'Item da comissão'
                  example: 1
                  nullable: false
                commission_id:
                  type: integer
                  description: 'Comissão relacionada'
                  example: 1
                  nullable: false
                metadata:
                  type: json
                  description: Metadados
                  example: '{"key": "value"}'
                  nullable: false
              required:
                - billing_method
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: id
        description: 'ID do lançamento'
        example: 7
        required: true
        schema:
          type: integer
  '/transactions/{transaction_id}/receiptLink':
    get:
      summary: 'Gerar link para Recibo de Repasse'
      operationId: gerarLinkParaReciboDeRepasse
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: transaction_id
        description: 'ID do Lançamento'
        example: 10
        required: true
        schema:
          type: integer
  /financial/transactionItems:
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,description,debit,credit,active'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,description,debit,credit,active'
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Filtra por descrição do Item'
          example: Aluguel
          required: false
          schema:
            type: string
            description: 'Filtra por descrição do Item'
            example: Aluguel
            nullable: false
        -
          in: query
          name: 'filter[debit]'
          description: "Filtra por tipo de débito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
          example: owner
          required: false
          schema:
            type: string
            description: "Filtra por tipo de débito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
            example: owner
            nullable: false
        -
          in: query
          name: 'filter[credit]'
          description: "Filtra por tipo de crédito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
          example: customer
          required: false
          schema:
            type: string
            description: "Filtra por tipo de crédito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
            example: customer
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: "Filtra por tipo do Item.\nValores permitidos:\n- `default`: Padrão\n- `commission`: Comissão\n- `single_commission`: Comissão Avulsa\n- `rent`: Aluguel\n- `tariff`: Tarifa\n- `fee`: Multa/Juros\n- `discount`: Desconto\n- `duty`: Imposto Retido\n- `iptu`: IPTU"
          example: default
          required: false
          schema:
            type: string
            description: "Filtra por tipo do Item.\nValores permitidos:\n- `default`: Padrão\n- `commission`: Comissão\n- `single_commission`: Comissão Avulsa\n- `rent`: Aluguel\n- `tariff`: Tarifa\n- `fee`: Multa/Juros\n- `discount`: Desconto\n- `duty`: Imposto Retido\n- `iptu`: IPTU"
            example: default
            nullable: false
        -
          in: query
          name: 'filter[purpose]'
          description: "Filtra por finalidade do Item.\nValores permitidos:\n- `rent`: Locação\n- `sale`: Venda\n- `subscription`: Assinatura"
          example: rent
          required: false
          schema:
            type: string
            description: "Filtra por finalidade do Item.\nValores permitidos:\n- `rent`: Locação\n- `sale`: Venda\n- `subscription`: Assinatura"
            example: rent
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Filtra por status do Item'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por status do Item'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[guaranteed_transfer]'
          description: 'Filtra por transferência garantida'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por transferência garantida'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[owner_report]'
          description: 'Filtra por relatório do proprietário'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por relatório do proprietário'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[readjust]'
          description: 'Filtra por reajuste'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por reajuste'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[fiscal_note]'
          description: 'Filtra por nota fiscal'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por nota fiscal'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[dimob]'
          description: 'Filtra por DIMOB'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por DIMOB'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[blocked]'
          description: 'Filtra por bloqueado'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por bloqueado'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[typeIn][]'
          description: 'Filtra por tipos de item'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por tipos de item'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[debitIn][]'
          description: 'Filtra por tipos de débito'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por tipos de débito'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[creditIn][]'
          description: 'Filtra por tipos de crédito'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por tipos de crédito'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[withReadjust]'
          description: 'Filtra por reajuste'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por reajuste'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[generatesFiscalNote]'
          description: 'Filtra por geração de nota fiscal'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por geração de nota fiscal'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[onlyRent]'
          description: 'Filtra por itens de locação'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por itens de locação'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[onlySale]'
          description: 'Filtra por itens de venda'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por itens de venda'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[purposeIn][]'
          description: 'Filtra por finalidades'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por finalidades'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[involvedIn][]'
          description: 'Filtra por envolvidos'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por envolvidos'
            example: null
            items:
              type: string
        -
          in: query
          name: 'include[debitPlan]'
          description: 'Incluir dados do Plano de Contas de Débito'
          example: 'id,name,code'
          required: false
          schema:
            type: string
            description: 'Incluir dados do Plano de Contas de Débito'
            example: 'id,name,code'
            nullable: false
        -
          in: query
          name: 'include[creditPlan]'
          description: 'Incluir dados do Plano de Contas de Crédito'
          example: 'id,name,code'
          required: false
          schema:
            type: string
            description: 'Incluir dados do Plano de Contas de Crédito'
            example: 'id,name,code'
            nullable: false
        -
          in: query
          name: 'include[transactions]'
          description: 'Incluir dados das Transações'
          example: 'id,value,date'
          required: false
          schema:
            type: string
            description: 'Incluir dados das Transações'
            example: 'id,value,date'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do Item'
                  example: Aluguel
                  nullable: false
                debit:
                  type: string
                  description: "Tipo de débito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
                  example: owner
                  nullable: false
                credit:
                  type: string
                  description: "Tipo de crédito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
                  example: customer
                  nullable: false
                type:
                  type: string
                  description: "Tipo do Item.\nValores permitidos:\n- `default`: Padrão\n- `commission`: Comissão\n- `single_commission`: Comissão Avulsa\n- `rent`: Aluguel\n- `tariff`: Tarifa\n- `fee`: Multa/Juros\n- `discount`: Desconto\n- `duty`: Imposto Retido\n- `iptu`: IPTU"
                  example: default
                  nullable: false
                purpose:
                  type: string
                  description: "Finalidade do Item. (Pode ser um array de strings se múltiplas finalidades forem permitidas pela lógica de negócios, ajuste o tipo se necessário)\nValores permitidos:\n- `rent`: Locação\n- `sale`: Venda\n- `subscription`: Assinatura"
                  example: rent
                  nullable: false
                active:
                  type: boolean
                  description: 'Status do Item'
                  example: true
                  nullable: false
                guaranteed_transfer:
                  type: boolean
                  description: 'Transferência garantida'
                  example: true
                  nullable: false
                owner_report:
                  type: boolean
                  description: 'Relatório do proprietário'
                  example: true
                  nullable: false
                readjust:
                  type: boolean
                  description: Reajuste
                  example: true
                  nullable: false
                fiscal_note:
                  type: boolean
                  description: 'Nota fiscal'
                  example: true
                  nullable: false
                dimob:
                  type: boolean
                  description: DIMOB
                  example: true
                  nullable: false
                blocked:
                  type: boolean
                  description: Bloqueado
                  example: true
                  nullable: false
              required:
                - description
                - debit
                - credit
  '/financial/transactionItems/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,description,debit,credit,active'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,description,debit,credit,active'
            nullable: false
        -
          in: query
          name: 'include[debitPlan]'
          description: 'Incluir dados do Plano de Contas de Débito'
          example: 'id,name,code'
          required: false
          schema:
            type: string
            description: 'Incluir dados do Plano de Contas de Débito'
            example: 'id,name,code'
            nullable: false
        -
          in: query
          name: 'include[creditPlan]'
          description: 'Incluir dados do Plano de Contas de Crédito'
          example: 'id,name,code'
          required: false
          schema:
            type: string
            description: 'Incluir dados do Plano de Contas de Crédito'
            example: 'id,name,code'
            nullable: false
        -
          in: query
          name: 'include[transactions]'
          description: 'Incluir dados das Transações'
          example: 'id,value,date'
          required: false
          schema:
            type: string
            description: 'Incluir dados das Transações'
            example: 'id,value,date'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do Item'
                  example: Aluguel
                  nullable: false
                debit:
                  type: string
                  description: "Tipo de débito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
                  example: owner
                  nullable: false
                credit:
                  type: string
                  description: "Tipo de crédito.\nValores permitidos:\n- `business`: Imobiliária/Empresa\n- `owner`: Proprietário\n- `customer`: Cliente\n- `broker`: Corretor/Vendedor"
                  example: customer
                  nullable: false
                type:
                  type: string
                  description: "Tipo do Item.\nValores permitidos:\n- `default`: Padrão\n- `commission`: Comissão\n- `single_commission`: Comissão Avulsa\n- `rent`: Aluguel\n- `tariff`: Tarifa\n- `fee`: Multa/Juros\n- `discount`: Desconto\n- `duty`: Imposto Retido\n- `iptu`: IPTU"
                  example: default
                  nullable: false
                purpose:
                  type: string
                  description: "Finalidade do Item. (Pode ser um array de strings se múltiplas finalidades forem permitidas pela lógica de negócios, ajuste o tipo se necessário)\nValores permitidos:\n- `rent`: Locação\n- `sale`: Venda\n- `subscription`: Assinatura"
                  example: rent
                  nullable: false
                active:
                  type: boolean
                  description: 'Status do Item'
                  example: true
                  nullable: false
                guaranteed_transfer:
                  type: boolean
                  description: 'Transferência garantida'
                  example: true
                  nullable: false
                owner_report:
                  type: boolean
                  description: 'Relatório do proprietário'
                  example: true
                  nullable: false
                readjust:
                  type: boolean
                  description: Reajuste
                  example: true
                  nullable: false
                fiscal_note:
                  type: boolean
                  description: 'Nota fiscal'
                  example: true
                  nullable: false
                dimob:
                  type: boolean
                  description: DIMOB
                  example: true
                  nullable: false
                blocked:
                  type: boolean
                  description: Bloqueado
                  example: true
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: id
        description: 'Id do Item'
        example: 13
        required: true
        schema:
          type: integer
  '/financial/contracts/{contract_id}/vehicles':
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,brand,model,plate'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,brand,model,plate'
            nullable: false
        -
          in: query
          name: 'filter[brand]'
          description: 'Filtra por marca do veículo'
          example: Fiat
          required: false
          schema:
            type: string
            description: 'Filtra por marca do veículo'
            example: Fiat
            nullable: false
        -
          in: query
          name: 'filter[model]'
          description: 'Filtra por modelo do veículo'
          example: Uno
          required: false
          schema:
            type: string
            description: 'Filtra por modelo do veículo'
            example: Uno
            nullable: false
        -
          in: query
          name: 'filter[color]'
          description: 'Filtra por cor do veículo'
          example: Prata
          required: false
          schema:
            type: string
            description: 'Filtra por cor do veículo'
            example: Prata
            nullable: false
        -
          in: query
          name: 'filter[plate]'
          description: 'Filtra por placa do veículo'
          example: ABC1234
          required: false
          schema:
            type: string
            description: 'Filtra por placa do veículo'
            example: ABC1234
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                brand:
                  type: string
                  description: 'Marca do veículo'
                  example: Fiat
                  nullable: false
                model:
                  type: string
                  description: 'Modelo do veículo'
                  example: Uno
                  nullable: false
                color:
                  type: string
                  description: 'Cor do veículo'
                  example: Prata
                  nullable: false
                plate:
                  type: string
                  description: 'Placa do veículo'
                  example: ABC1234
                  nullable: false
              required:
                - brand
                - model
    parameters:
      -
        in: path
        name: contract_id
        description: 'Optional parameter. Id do Contrato'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 1
  '/financial/contracts/{contract_id}/vehicles/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,brand,model,plate'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,brand,model,plate'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                brand:
                  type: string
                  description: 'Marca do veículo'
                  example: Fiat
                  nullable: false
                model:
                  type: string
                  description: 'Modelo do veículo'
                  example: Uno
                  nullable: false
                color:
                  type: string
                  description: 'Cor do veículo'
                  example: Prata
                  nullable: false
                plate:
                  type: string
                  description: 'Placa do veículo'
                  example: ABC1234
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: contract_id
        description: 'Optional parameter. Id do Contrato'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 9
      -
        in: path
        name: id
        description: 'Id do Veículo'
        example: 20
        required: true
        schema:
          type: integer
  '/financial/contracts/{contract_id}/occupants':
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,type,principal'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,type,principal'
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Filtra por nome do Ocupante'
          example: Jorge
          required: false
          schema:
            type: string
            description: 'Filtra por nome do Ocupante'
            example: Jorge
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: "Filtra por tipo do Ocupante.\nValores permitidos:\n- `resident`: Morador\n- `tenant`: Inquilino\n- `guarantor`: Fiador\n- `witness`: Testemunha\n- `payer`: Responsável pelo Pagamento\n- `buyer`: Comprador\n- `procurator`: Procurador"
          example: resident
          required: false
          schema:
            type: string
            description: "Filtra por tipo do Ocupante.\nValores permitidos:\n- `resident`: Morador\n- `tenant`: Inquilino\n- `guarantor`: Fiador\n- `witness`: Testemunha\n- `payer`: Responsável pelo Pagamento\n- `buyer`: Comprador\n- `procurator`: Procurador"
            example: resident
            nullable: false
        -
          in: query
          name: 'filter[principal]'
          description: 'Filtra por ocupante principal'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra por ocupante principal'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[start_at]'
          description: 'date Filtra por data de entrada'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Filtra por data de entrada'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[end_at]'
          description: 'date Filtra por data de saída'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'date Filtra por data de saída'
            example: '2024-12-31'
            nullable: false
        -
          in: query
          name: 'filter[typeIn][]'
          description: 'Filtra por tipos de ocupante'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra por tipos de ocupante'
            example: null
            items:
              type: string
        -
          in: query
          name: 'include[person]'
          description: 'Incluir dados da Pessoa'
          example: 'id,name,tax_id'
          required: false
          schema:
            type: string
            description: 'Incluir dados da Pessoa'
            example: 'id,name,tax_id'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: "Tipo do ocupante.\nValores permitidos:\n- `resident`: Morador\n- `tenant`: Inquilino\n- `guarantor`: Fiador\n- `witness`: Testemunha\n- `payer`: Responsável pelo Pagamento\n- `buyer`: Comprador\n- `procurator`: Procurador"
                  example: resident
                  nullable: false
                name:
                  type: string
                  description: 'Nome do ocupante'
                  example: Jorge
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da pessoa'
                  example: 123456
                  nullable: false
                tax_id:
                  type: string
                  description: CPF/CNPJ
                  example: 123.456.789-00
                  nullable: false
                principal:
                  type: boolean
                  description: 'Ocupante principal'
                  example: false
                  nullable: false
                percentage:
                  type: number
                  description: Porcentagem
                  example: 100.0
                  nullable: false
                start_at:
                  type: date
                  description: 'Data de entrada'
                  example: '2024-01-01'
                  nullable: false
                end_at:
                  type: date
                  description: 'Data de saída'
                  example: '2024-12-31'
                  nullable: false
                description:
                  type: string
                  description: Descrição
                  example: 'Morador principal'
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Observações importantes'
                  nullable: false
              required:
                - type
                - name
    parameters:
      -
        in: path
        name: contract_id
        description: 'Optional parameter. Id do Contrato'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 5
  '/financial/contracts/{contract_id}/occupants/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,type,principal'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,type,principal'
            nullable: false
        -
          in: query
          name: 'include[person]'
          description: 'Incluir dados da Pessoa'
          example: 'id,name,tax_id'
          required: false
          schema:
            type: string
            description: 'Incluir dados da Pessoa'
            example: 'id,name,tax_id'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: "Tipo do ocupante.\nValores permitidos:\n- `resident`: Morador\n- `tenant`: Inquilino\n- `guarantor`: Fiador\n- `witness`: Testemunha\n- `payer`: Responsável pelo Pagamento\n- `buyer`: Comprador\n- `procurator`: Procurador"
                  example: resident
                  nullable: false
                name:
                  type: string
                  description: 'Nome do ocupante'
                  example: Jorge
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da pessoa'
                  example: 123456
                  nullable: false
                tax_id:
                  type: string
                  description: CPF/CNPJ
                  example: 123.456.789-00
                  nullable: false
                principal:
                  type: boolean
                  description: 'Ocupante principal'
                  example: false
                  nullable: false
                percentage:
                  type: number
                  description: Porcentagem
                  example: 100.0
                  nullable: false
                start_at:
                  type: date
                  description: 'Data de entrada'
                  example: '2024-01-01'
                  nullable: false
                end_at:
                  type: date
                  description: 'Data de saída'
                  example: '2024-12-31'
                  nullable: false
                description:
                  type: string
                  description: Descrição
                  example: 'Morador principal'
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Observações importantes'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: contract_id
        description: 'Optional parameter. Id do Contrato'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 6
      -
        in: path
        name: id
        description: 'Id do Ocupante'
        example: 7
        required: true
        schema:
          type: integer
  '/financial/contracts/{contract_id}/items':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[amount]'
          description: 'Filtra por valor'
          example: 1000.0
          required: false
          schema:
            type: number
            description: 'Filtra por valor'
            example: 1000.0
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[percentage]'
          description: 'Filtra por porcentagem'
          example: 10.0
          required: false
          schema:
            type: number
            description: 'Filtra por porcentagem'
            example: 10.0
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  description: "Modo do item.\nValores permitidos:\n- `item`: Padrão\n- `commission`: Comissão\n- `service`: Serviço"
                  example: item
                  nullable: false
                item_id:
                  type: integer
                  description: 'ID do tipo de item'
                  example: 1
                  nullable: false
                description:
                  type: string
                  description: 'Descrição do Item'
                  example: Aluguel
                  nullable: false
                calculate_mode:
                  type: string
                  description: "Tipo de valor.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Valor fixo"
                  example: fixed
                  nullable: false
                parent_id:
                  type: integer
                  description: 'ID do item pai'
                  example: 1
                  nullable: false
                percentage:
                  type: number
                  description: Porcentagem
                  example: 10.0
                  nullable: false
                amount:
                  type: number
                  description: 'Valor fixo'
                  example: 1000.0
                  nullable: false
                percentage_mode:
                  type: string
                  description: "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
                  nullable: false
                transfer_owner_id:
                  type: integer
                  description: 'ID do proprietário da transferência'
                  example: 1
                  nullable: false
                broker_id:
                  type: integer
                  description: 'ID do corretor'
                  example: 1
                  nullable: false
                start_at:
                  type: date
                  description: 'Data inicial'
                  example: '2024-01-01'
                  nullable: false
                end_at:
                  type: date
                  description: 'Data final'
                  example: '2024-12-31'
                  nullable: false
                commissioned_type:
                  type: string
                  description: "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
                  nullable: false
                config:
                  type: json
                  description: Configurações.
                  example: '{"installment": 1, "billing_mode": "monthly"}'
                  nullable: false
              required:
                - mode
                - item_id
                - description
                - calculate_mode
    parameters:
      -
        in: path
        name: contract_id
        description: 'ID do Contrato'
        example: 10
        required: true
        schema:
          type: integer
  '/financial/contracts/{contract_id}/items/{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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  description: "Modo do item.\nValores permitidos:\n- `item`: Padrão\n- `commission`: Comissão\n- `service`: Serviço"
                  example: item
                  nullable: false
                item_id:
                  type: integer
                  description: 'ID do tipo de item'
                  example: 1
                  nullable: false
                parent_id:
                  type: integer
                  description: 'ID do item pai'
                  example: 1
                  nullable: false
                description:
                  type: string
                  description: 'Descrição do Item'
                  example: Aluguel
                  nullable: false
                calculate_mode:
                  type: string
                  description: "Tipo de valor.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Valor fixo"
                  example: fixed
                  nullable: false
                percentage:
                  type: number
                  description: Porcentagem
                  example: 10.0
                  nullable: false
                amount:
                  type: number
                  description: 'Valor fixo'
                  example: 1000.0
                  nullable: false
                percentage_mode:
                  type: string
                  description: "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
                  nullable: false
                transfer_owner_id:
                  type: integer
                  description: 'ID do proprietário da transferência'
                  example: 1
                  nullable: false
                broker_id:
                  type: integer
                  description: 'ID do corretor'
                  example: 1
                  nullable: false
                start_at:
                  type: date
                  description: 'Data inicial'
                  example: '2024-01-01'
                  nullable: false
                end_at:
                  type: date
                  description: 'Data final'
                  example: '2024-12-31'
                  nullable: false
                commissioned_type:
                  type: string
                  description: "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
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: contract_id
        description: 'Optional parameter. Id do Contrato'
        required: true
        schema:
          type: integer
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 5
      -
        in: path
        name: id
        description: 'Id do Item'
        example: 15
        required: true
        schema:
          type: integer
  '/financial/contracts/{contract}/invoicesCreate':
    post:
      summary: 'Gerar Parcelas'
      operationId: gerarParcelas
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Contratos</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      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
                  nullable: false
    parameters:
      -
        in: path
        name: contract
        description: 'ID do contrato'
        example: 18
        required: true
        schema:
          type: integer
  /financial/contracts:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do contrato'
          example: 123123
          required: false
          schema:
            type: integer
            description: 'ID do contrato'
            example: 123123
            nullable: false
        -
          in: query
          name: 'filter[id2]'
          description: 'ID do contrato'
          example: 123123
          required: false
          schema:
            type: integer
            description: 'ID do contrato'
            example: 123123
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[tenant_id]'
          description: 'ID do Inquilino'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do Inquilino'
            example: 123456
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[payment_status]'
          description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 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- `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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[agent_id]'
          description: 'ID do corretor'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do corretor'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[procurator_id]'
          description: 'ID do procurador'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do procurador'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[team_id]'
          description: 'ID da equipe'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID da equipe'
            example: 123456
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[tag]'
          description: Tags
          example: importante
          required: false
          schema:
            type: string
            description: Tags
            example: importante
            nullable: false
        -
          in: query
          name: 'filter[guaranteed_transfer]'
          description: 'Repasse garantido'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Repasse garantido'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[amount]'
          description: 'Valor do contrato'
          example: 1500.0
          required: false
          schema:
            type: number
            description: 'Valor do contrato'
            example: 1500.0
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[total]'
          description: 'Valor total'
          example: 1650.0
          required: false
          schema:
            type: number
            description: 'Valor total'
            example: 1650.0
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[due_day]'
          description: 'Dia do vencimento'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Dia do vencimento'
            example: 5
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[billing_timing]'
          description: 'Momento do faturamento'
          example: pre
          required: false
          schema:
            type: string
            description: 'Momento do faturamento'
            example: pre
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[proportional]'
          description: Proporcional
          example: false
          required: false
          schema:
            type: boolean
            description: Proporcional
            example: false
            nullable: 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
            nullable: false
        -
          in: query
          name: 'filter[readjust_active]'
          description: 'Reajuste ativo'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Reajuste ativo'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[guarantee]'
          description: Garantia
          example: caução
          required: false
          schema:
            type: string
            description: Garantia
            example: caução
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[invoice_installment]'
          description: 'Parcelas da fatura'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Parcelas da fatura'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[ticket_late_fee]'
          description: 'Multa por atraso'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Multa por atraso'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount]'
          description: Desconto
          example: true
          required: false
          schema:
            type: boolean
            description: Desconto
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[ticket_discount_days]'
          description: 'Dias para desconto'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Dias para desconto'
            example: 5
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[termination_fee_months]'
          description: 'Meses de multa'
          example: 3
          required: false
          schema:
            type: integer
            description: 'Meses de multa'
            example: 3
            nullable: false
        -
          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
            nullable: 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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[business_id]'
          description: 'ID da empresa'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID da empresa'
            example: 123456
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[metadata]'
          description: 'json Metadados'
          example: '{"key": "value"}'
          required: false
          schema:
            type: string
            description: 'json Metadados'
            example: '{"key": "value"}'
            nullable: false
        -
          in: query
          name: 'filter[document_id_1]'
          description: 'ID do primeiro documento'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do primeiro documento'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[document_id_2]'
          description: 'ID do segundo documento'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do segundo documento'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[document_id_3]'
          description: 'ID do terceiro documento'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do terceiro documento'
            example: 123456
            nullable: false
        -
          in: query
          name: 'filter[document_privacy_1]'
          description: "Privacidade do primeiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
          example: private
          required: false
          schema:
            type: string
            description: "Privacidade do primeiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
            example: private
            nullable: false
        -
          in: query
          name: 'filter[document_privacy_2]'
          description: "Privacidade do segundo documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
          example: private
          required: false
          schema:
            type: string
            description: "Privacidade do segundo documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
            example: private
            nullable: false
        -
          in: query
          name: 'filter[document_privacy_3]'
          description: "Privacidade do terceiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
          example: private
          required: false
          schema:
            type: string
            description: "Privacidade do terceiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
            example: private
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: 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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[fiscal_note]'
          description: 'Nota fiscal'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Nota fiscal'
            example: false
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[extended]'
          description: 'Filtra contratos prorrogados'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra contratos prorrogados'
            example: true
            nullable: false
        -
          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[hasGuarantor]'
          description: 'Filtra contratos com fiador'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra contratos com fiador'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[documents]'
          description: 'Incluir dados dos Documentos'
          example: 'id,name,url'
          required: false
          schema:
            type: string
            description: 'Incluir dados dos Documentos'
            example: 'id,name,url'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Contratos</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      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
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do Imóvel'
                  example: 123456
                  nullable: false
                tenant_id:
                  type: integer
                  description: 'ID do Inquilino'
                  example: 123456
                  nullable: false
                billing_id:
                  type: integer
                  description: 'ID do método de pagamento'
                  example: 123456
                  nullable: false
                start_at:
                  type: string
                  description: 'Data de início'
                  example: '2024-01-01'
                  nullable: false
                recurrency:
                  type: string
                  description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
                  example: monthly
                  nullable: false
                amount:
                  type: number
                  description: 'Valor do contrato'
                  example: 1500.0
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa'
                  example: 123456
                  nullable: false
                account_id:
                  type: integer
                  description: 'ID da conta financeira'
                  example: 123456
                  nullable: false
                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
                  nullable: false
                due_date:
                  type: string
                  description: 'Data do vencimento'
                  example: '2024-01-05'
                  nullable: false
                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
                  nullable: false
                reference:
                  type: string
                  description: 'Código de referência'
                  example: CONTR-001
                  nullable: false
                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
                  nullable: false
                active_date:
                  type: string
                  description: 'Data de alteração da atividade'
                  example: '2024-01-01'
                  nullable: false
                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
                  nullable: false
                status_date:
                  type: string
                  description: 'Data de alteração do status'
                  example: '2024-01-01'
                  nullable: false
                payment_status:
                  type: string
                  description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 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
                  nullable: false
                payment_status_date:
                  type: string
                  description: 'Data de alteração do status de pagamento'
                  example: '2024-01-01'
                  nullable: false
                user_id:
                  type: integer
                  description: 'ID do usuário responsável'
                  example: 123456
                  nullable: false
                agent_id:
                  type: integer
                  description: 'ID do corretor'
                  example: 123456
                  nullable: false
                procurator_id:
                  type: integer
                  description: 'ID do procurador'
                  example: 123456
                  nullable: false
                team_id:
                  type: integer
                  description: 'ID da equipe'
                  example: 123456
                  nullable: false
                access:
                  type: string
                  description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
                  example: all
                  nullable: false
                tag:
                  type: string
                  description: Tags
                  example: importante
                  nullable: false
                guaranteed_transfer:
                  type: boolean
                  description: 'Repasse garantido'
                  example: true
                  nullable: false
                guaranteed_transfer_months:
                  type: integer
                  description: 'Meses garantidos no repasse'
                  example: 12
                  nullable: false
                guaranteed_transfer_release_after_days:
                  type: integer
                  description: 'Dias para liberação do repasse'
                  example: 30
                  nullable: false
                end_at:
                  type: string
                  description: 'Data de término'
                  example: '2024-12-31'
                  nullable: false
                boolean:
                  type: Fim
                  description: indeterminado
                  example: 'false'
                  nullable: false
                signed_at:
                  type: string
                  description: 'Data de assinatura'
                  example: '2024-01-01'
                  nullable: false
                recurrency_amount:
                  type: integer
                  description: 'Quantidade de recorrências'
                  example: 12
                  nullable: false
                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
                  nullable: false
                current_amount:
                  type: number
                  description: 'Valor atual do contrato'
                  example: 1500.0
                  nullable: false
                service_rate_amount:
                  type: number
                  description: 'Valor da taxa de serviço'
                  example: 150.0
                  nullable: false
                total:
                  type: number
                  description: 'Valor total'
                  example: 1650.0
                  nullable: false
                signal_amount:
                  type: number
                  description: 'Valor de sinal'
                  example: 1500.0
                  nullable: false
                refund_amount:
                  type: number
                  description: 'Valor de reembolso'
                  example: 0.0
                  nullable: false
                fiscal_note_withholding:
                  type: number
                  description: 'Retenção de nota fiscal'
                  example: 0.0
                  nullable: false
                due_day:
                  type: integer
                  description: 'Dia do vencimento'
                  example: 5
                  nullable: false
                billing_timing:
                  type: string
                  description: 'Momento do faturamento'
                  example: pre
                  nullable: false
                first_commission:
                  type: number
                  description: 'Primeira comissão'
                  example: 0.0
                  nullable: false
                first_commission_installment:
                  type: integer
                  description: 'Parcelas da primeira comissão'
                  example: 1
                  nullable: false
                recurring_commission:
                  type: number
                  description: 'Comissão recorrente'
                  example: 0.0
                  nullable: false
                add_commission_on_first:
                  type: boolean
                  description: 'Adicionar comissão na primeira parcela'
                  example: false
                  nullable: false
                proportional:
                  type: boolean
                  description: Proporcional
                  example: false
                  nullable: false
                unify_first_invoice:
                  type: boolean
                  description: 'Unificar primeira fatura'
                  example: false
                  nullable: false
                readjust_active:
                  type: boolean
                  description: 'Reajuste ativo'
                  example: true
                  nullable: false
                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
                  nullable: false
                readjust_with:
                  type: integer
                  description: 'Período de reajuste'
                  example: 12
                  nullable: false
                readjust_at:
                  type: string
                  description: 'Data do reajuste'
                  example: '2024-01-01'
                  nullable: false
                readjusted_at:
                  type: string
                  description: 'Data do último reajuste'
                  example: '2024-01-01'
                  nullable: false
                guarantee:
                  type: string
                  description: Garantia
                  example: caução
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Contrato de aluguel residencial'
                  nullable: false
                clauses:
                  type: string
                  description: Cláusulas
                  example: 'Cláusulas do contrato'
                  nullable: false
                invoice_installment:
                  type: integer
                  description: 'Parcelas da fatura'
                  example: 1
                  nullable: false
                witness_1:
                  type: integer
                  description: 'ID da primeira testemunha'
                  example: 123456
                  nullable: false
                witness_2:
                  type: integer
                  description: 'ID da segunda testemunha'
                  example: 123456
                  nullable: false
                guarantor_1:
                  type: integer
                  description: 'ID do primeiro fiador'
                  example: 123456
                  nullable: false
                guarantor_2:
                  type: integer
                  description: 'ID do segundo fiador'
                  example: 123456
                  nullable: false
                ticket_late_fee:
                  type: boolean
                  description: 'Multa por atraso'
                  example: true
                  nullable: false
                ticket_late_fee_item_id:
                  type: integer
                  description: 'ID do item de multa'
                  example: 123456
                  nullable: false
                ticket_late_fee_percentage:
                  type: number
                  description: 'Porcentagem da multa'
                  example: 2.0
                  nullable: false
                ticket_late_fee_interest:
                  type: number
                  description: 'Juros da multa'
                  example: 1.0
                  nullable: false
                ticket_discount:
                  type: boolean
                  description: Desconto
                  example: true
                  nullable: false
                ticket_discount_action:
                  type: string
                  description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
                  example: percentage
                  nullable: false
                ticket_discount_mode:
                  type: string
                  description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
                  example: fixed
                  nullable: false
                ticket_discount_percentage:
                  type: number
                  description: 'Porcentagem do desconto'
                  example: 5.0
                  nullable: false
                ticket_discount_fixed:
                  type: number
                  description: 'Valor fixo do desconto'
                  example: 50.0
                  nullable: false
                ticket_discount_days:
                  type: integer
                  description: 'Dias para desconto'
                  example: 5
                  nullable: false
                termination_fee:
                  type: number
                  description: 'Valor da multa de rescisão'
                  example: 1500.0
                  nullable: false
                termination_fee_months:
                  type: integer
                  description: 'Meses de multa'
                  example: 3
                  nullable: false
                termination_fee_exemption:
                  type: boolean
                  description: 'Isenção de multa'
                  example: false
                  nullable: false
                termination_fee_amount:
                  type: number
                  description: 'Valor da multa'
                  example: 1500.0
                  nullable: false
                deal_id:
                  type: integer
                  description: 'ID do negócio'
                  example: 123456
                  nullable: false
                document_id_1:
                  type: integer
                  description: 'ID do primeiro documento'
                  example: 123456
                  nullable: false
                document_id_2:
                  type: integer
                  description: 'ID do segundo documento'
                  example: 123456
                  nullable: false
                document_id_3:
                  type: integer
                  description: 'ID do terceiro documento'
                  example: 123456
                  nullable: false
                document_privacy_1:
                  type: string
                  description: "Privacidade do primeiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                document_privacy_2:
                  type: string
                  description: "Privacidade do segundo documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                document_privacy_3:
                  type: string
                  description: "Privacidade do terceiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                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
                  nullable: false
                transfer_after_days:
                  type: integer
                  description: 'Dias para transferência'
                  example: 5
                  nullable: false
                transfer_auto:
                  type: boolean
                  description: 'Transferência automática'
                  example: false
                  nullable: false
                fiscal_note:
                  type: boolean
                  description: 'Nota fiscal'
                  example: false
                  nullable: false
                dimob:
                  type: boolean
                  description: DIMOB
                  example: false
                  nullable: false
                metadata:
                  type: json
                  description: Metadados
                  example: '{"key": "value"}'
                  nullable: false
              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: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contrato</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[documents]'
          description: 'Incluir dados dos Documentos'
          example: 'id,name,url'
          required: false
          schema:
            type: string
            description: 'Incluir dados dos Documentos'
            example: 'id,name,url'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Contratos</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
      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
                  nullable: false
                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
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do Imóvel'
                  example: 123456
                  nullable: false
                tenant_id:
                  type: integer
                  description: 'ID do Inquilino'
                  example: 123456
                  nullable: false
                billing_id:
                  type: integer
                  description: 'ID do método de pagamento'
                  example: 123456
                  nullable: false
                reference:
                  type: string
                  description: 'Código de referência'
                  example: CONTR-001
                  nullable: false
                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
                  nullable: false
                active_date:
                  type: string
                  description: 'Data de alteração da atividade'
                  example: '2024-01-01'
                  nullable: false
                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
                  nullable: false
                status_date:
                  type: string
                  description: 'Data de alteração do status'
                  example: '2024-01-01'
                  nullable: false
                payment_status:
                  type: string
                  description: "Status de pagamento.\nValores permitidos:\n- `due_5_days`: Vence em 5 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
                  nullable: false
                payment_status_date:
                  type: string
                  description: 'Data de alteração do status de pagamento'
                  example: '2024-01-01'
                  nullable: false
                user_id:
                  type: integer
                  description: 'ID do usuário responsável'
                  example: 123456
                  nullable: false
                agent_id:
                  type: integer
                  description: 'ID do corretor'
                  example: 123456
                  nullable: false
                procurator_id:
                  type: integer
                  description: 'ID do procurador'
                  example: 123456
                  nullable: false
                team_id:
                  type: integer
                  description: 'ID da equipe'
                  example: 123456
                  nullable: false
                access:
                  type: string
                  description: "Nível de acesso.\nValores permitidos:\n- `all`: Todos os Usuários\n- `responsible`: Usuários Responsáveis"
                  example: all
                  nullable: false
                tag:
                  type: string
                  description: Tags
                  example: importante
                  nullable: false
                guaranteed_transfer:
                  type: boolean
                  description: 'Repasse garantido'
                  example: true
                  nullable: false
                guaranteed_transfer_months:
                  type: integer
                  description: 'Meses garantidos no repasse'
                  example: 12
                  nullable: false
                guaranteed_transfer_release_after_days:
                  type: integer
                  description: 'Dias para liberação do repasse'
                  example: 30
                  nullable: false
                start_at:
                  type: string
                  description: 'Data de início'
                  example: '2024-01-01'
                  nullable: false
                end_at:
                  type: string
                  description: 'Data de término'
                  example: '2024-12-31'
                  nullable: false
                signed_at:
                  type: string
                  description: 'Data de assinatura'
                  example: '2024-01-01'
                  nullable: false
                recurrency:
                  type: string
                  description: "Recorrência.\nValores permitidos:\n- `daily`: Diariamente\n- `monthly`: Mensalmente"
                  example: monthly
                  nullable: false
                recurrency_amount:
                  type: integer
                  description: 'Quantidade de recorrências'
                  example: 12
                  nullable: false
                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
                  nullable: false
                amount:
                  type: number
                  description: 'Valor do contrato'
                  example: 1500.0
                  nullable: false
                current_amount:
                  type: number
                  description: 'Valor atual do contrato'
                  example: 1500.0
                  nullable: false
                service_rate_amount:
                  type: number
                  description: 'Valor da taxa de serviço'
                  example: 150.0
                  nullable: false
                total:
                  type: number
                  description: 'Valor total'
                  example: 1650.0
                  nullable: false
                signal_amount:
                  type: number
                  description: 'Valor de sinal'
                  example: 1500.0
                  nullable: false
                refund_amount:
                  type: number
                  description: 'Valor de reembolso'
                  example: 0.0
                  nullable: false
                fiscal_note_withholding:
                  type: number
                  description: 'Retenção de nota fiscal'
                  example: 0.0
                  nullable: false
                due_day:
                  type: integer
                  description: 'Dia do vencimento'
                  example: 5
                  nullable: false
                due_date:
                  type: string
                  description: 'Data do vencimento'
                  example: '2024-01-05'
                  nullable: false
                billing_timing:
                  type: string
                  description: 'Momento do faturamento'
                  example: pre
                  nullable: false
                first_commission:
                  type: number
                  description: 'Primeira comissão'
                  example: 0.0
                  nullable: false
                first_commission_installment:
                  type: integer
                  description: 'Parcelas da primeira comissão'
                  example: 1
                  nullable: false
                recurring_commission:
                  type: number
                  description: 'Comissão recorrente'
                  example: 0.0
                  nullable: false
                add_commission_on_first:
                  type: boolean
                  description: 'Adicionar comissão na primeira parcela'
                  example: false
                  nullable: false
                proportional:
                  type: boolean
                  description: Proporcional
                  example: false
                  nullable: false
                unify_first_invoice:
                  type: boolean
                  description: 'Unificar primeira fatura'
                  example: false
                  nullable: false
                readjust_active:
                  type: boolean
                  description: 'Reajuste ativo'
                  example: true
                  nullable: false
                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
                  nullable: false
                readjust_with:
                  type: integer
                  description: 'Período de reajuste'
                  example: 12
                  nullable: false
                readjust_at:
                  type: string
                  description: 'Data do reajuste'
                  example: '2024-01-01'
                  nullable: false
                readjusted_at:
                  type: string
                  description: 'Data do último reajuste'
                  example: '2024-01-01'
                  nullable: false
                guarantee:
                  type: string
                  description: Garantia
                  example: caução
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Contrato de aluguel residencial'
                  nullable: false
                clauses:
                  type: string
                  description: Cláusulas
                  example: 'Cláusulas do contrato'
                  nullable: false
                invoice_installment:
                  type: integer
                  description: 'Parcelas da fatura'
                  example: 1
                  nullable: false
                witness_1:
                  type: integer
                  description: 'ID da primeira testemunha'
                  example: 123456
                  nullable: false
                witness_2:
                  type: integer
                  description: 'ID da segunda testemunha'
                  example: 123456
                  nullable: false
                guarantor_1:
                  type: integer
                  description: 'ID do primeiro fiador'
                  example: 123456
                  nullable: false
                guarantor_2:
                  type: integer
                  description: 'ID do segundo fiador'
                  example: 123456
                  nullable: false
                ticket_late_fee:
                  type: boolean
                  description: 'Multa por atraso'
                  example: true
                  nullable: false
                ticket_late_fee_item_id:
                  type: integer
                  description: 'ID do item de multa'
                  example: 123456
                  nullable: false
                ticket_late_fee_percentage:
                  type: number
                  description: 'Porcentagem da multa'
                  example: 2.0
                  nullable: false
                ticket_late_fee_interest:
                  type: number
                  description: 'Juros da multa'
                  example: 1.0
                  nullable: false
                ticket_discount:
                  type: boolean
                  description: Desconto
                  example: true
                  nullable: false
                ticket_discount_action:
                  type: string
                  description: "Ação do desconto.\nValores permitidos:\n- `percentage`: Porcentagem\n- `fixed`: Fixo"
                  example: percentage
                  nullable: false
                ticket_discount_mode:
                  type: string
                  description: "Modo do desconto.\nValores permitidos:\n- `fixed`: Fixo\n- `percentage`: Percentual"
                  example: fixed
                  nullable: false
                ticket_discount_percentage:
                  type: number
                  description: 'Porcentagem do desconto'
                  example: 5.0
                  nullable: false
                ticket_discount_fixed:
                  type: number
                  description: 'Valor fixo do desconto'
                  example: 50.0
                  nullable: false
                ticket_discount_days:
                  type: integer
                  description: 'Dias para desconto'
                  example: 5
                  nullable: false
                termination_fee:
                  type: number
                  description: 'Valor da multa de rescisão'
                  example: 1500.0
                  nullable: false
                termination_fee_months:
                  type: integer
                  description: 'Meses de multa'
                  example: 3
                  nullable: false
                termination_fee_exemption:
                  type: boolean
                  description: 'Isenção de multa'
                  example: false
                  nullable: false
                termination_fee_amount:
                  type: number
                  description: 'Valor da multa'
                  example: 1500.0
                  nullable: false
                deal_id:
                  type: integer
                  description: 'ID do negócio'
                  example: 123456
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa'
                  example: 123456
                  nullable: false
                account_id:
                  type: integer
                  description: 'ID da conta financeira'
                  example: 123456
                  nullable: false
                document_id_1:
                  type: integer
                  description: 'ID do primeiro documento'
                  example: 123456
                  nullable: false
                document_id_2:
                  type: integer
                  description: 'ID do segundo documento'
                  example: 123456
                  nullable: false
                document_id_3:
                  type: integer
                  description: 'ID do terceiro documento'
                  example: 123456
                  nullable: false
                document_privacy_1:
                  type: string
                  description: "Privacidade do primeiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                document_privacy_2:
                  type: string
                  description: "Privacidade do segundo documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                document_privacy_3:
                  type: string
                  description: "Privacidade do terceiro documento.\nValores permitidos:\n- `private`: Privado\n- `all`: Inquilino e Proprietários\n- `tenant`: Inquilino\n- `owner`: Proprietário"
                  example: private
                  nullable: false
                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
                  nullable: false
                transfer_after_days:
                  type: integer
                  description: 'Dias para transferência'
                  example: 5
                  nullable: false
                transfer_auto:
                  type: boolean
                  description: 'Transferência automática'
                  example: false
                  nullable: false
                fiscal_note:
                  type: boolean
                  description: 'Nota fiscal'
                  example: false
                  nullable: false
                dimob:
                  type: boolean
                  description: DIMOB
                  example: false
                  nullable: false
                metadata:
                  type: json
                  description: Metadados
                  example: '{"key": "value"}'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Contratos</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Financeiro
    parameters:
      -
        in: path
        name: id
        description: 'ID do contrato'
        example: 5
        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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Código do Grupo.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Código do Grupo.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome do Grupo.'
          example: Corretores
          required: false
          schema:
            type: string
            description: 'Nome do Grupo.'
            example: Corretores
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: 'Tipo de Grupo.'
          example: normal
          required: false
          schema:
            type: string
            description: 'Tipo de Grupo.'
            example: normal
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Grupos de Usuários'
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de criação de Grupo de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Grupos de Usuários'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: 'Tipo do grupo.'
                  example: normal
                  nullable: false
                name:
                  type: string
                  description: 'Nome do grupo.'
                  example: 'Corretores - Locação'
                  nullable: false
                notes:
                  type: string
                  description: 'Observação para o grupo.'
                  example: 'Este é um grupo para corretores de locação'
                  nullable: false
              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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Grupos de Usuários'
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de alteração de Grupo de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Grupos de Usuários'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: 'Tipo do grupo.'
                  example: normal
                  nullable: false
                name:
                  type: string
                  description: 'Nome do grupo.'
                  example: 'Corretores - Locação'
                  nullable: false
                notes:
                  type: string
                  description: 'Observação para o grupo.'
                  example: 'Este é um grupo para corretores de locação'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Grupos de Usuários'
    parameters:
      -
        in: path
        name: group_id
        description: 'The ID of the group.'
        example: 18
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'ID do Grupo de Usuário'
        example: 11
        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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do tipo.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do tipo.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'ID do tipo.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do tipo.'
            example: 1
            nullable: false
        -
          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
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: integer
                  description: 'ID do tipo.'
                  example: 1
                  nullable: false
                modules:
                  type: array
                  description: 'Módulos do tipo.'
                  example: null
                  items:
                    type: string
                icon:
                  type: string
                  description: 'Ícone. required.'
                  example: ca-icon-example
                  nullable: false
              required:
                - description
                - modules
  '/history/types/{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
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: integer
                  description: 'ID do tipo.'
                  example: 1
                  nullable: false
                modules:
                  type: array
                  description: 'Módulos do tipo.'
                  example: null
                  items:
                    type: string
                icon:
                  type: string
                  description: Ícone.
                  example: ca-icon-example
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    parameters:
      -
        in: path
        name: id
        description: 'Id do Tipo de Histórico'
        example: 1
        required: true
        schema:
          type: integer
  '/history/{history_id}/toggle':
    put:
      summary: Fixar
      operationId: fixar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    parameters:
      -
        in: path
        name: history_id
        description: 'The ID of the history.'
        example: 1
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'ID do Histórico'
        example: 19
        required: true
        schema:
          type: integer
  /history:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Código do histórico.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Código do histórico.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[history_type_id]'
          description: 'ID do Tipo do Histórico.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do Tipo do Histórico.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[module_type]'
          description: 'Módulo que gerou o histórico.'
          example: deal
          required: false
          schema:
            type: string
            description: 'Módulo que gerou o histórico.'
            example: deal
            nullable: false
        -
          in: query
          name: 'filter[module_id]'
          description: 'ID do registro do módulo.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID do registro do módulo.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[date]'
          description: 'date Data do Evento.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Data do Evento.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[user_id]'
          description: 'Responsável pelo histórico.'
          example: 321
          required: false
          schema:
            type: integer
            description: 'Responsável pelo histórico.'
            example: 321
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'Código do cliente da Imobiliária vinculado ao módulo.'
          example: 1111
          required: false
          schema:
            type: integer
            description: 'Código do cliente da Imobiliária vinculado ao módulo.'
            example: 1111
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: 'Tentei contato com o cliente, mas não houve retorno'
          required: false
          schema:
            type: string
            description: Descrição.
            example: 'Tentei contato com o cliente, mas não houve retorno'
            nullable: false
        -
          in: query
          name: 'filter[child_type]'
          description: 'Módulo Filho.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Módulo Filho.'
            example: 0
            nullable: false
        -
          in: query
          name: 'filter[child_id]'
          description: 'ID do registro do módulo filho.'
          example: 1233
          required: false
          schema:
            type: integer
            description: 'ID do registro do módulo filho.'
            example: 1233
            nullable: false
        -
          in: query
          name: 'filter[parent_id]'
          description: 'Código do histórico pai, utilizado para resposta de comentários por exemplo.'
          example: 321
          required: false
          schema:
            type: integer
            description: 'Código do histórico pai, utilizado para resposta de comentários por exemplo.'
            example: 321
            nullable: false
        -
          in: query
          name: 'filter[private]'
          description: 'Histórico privado.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Histórico privado.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[visualized_by]'
          description: 'json[] Usuários que visualizaram o histórico.'
          example: '[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]'
          required: false
          schema:
            type: string
            description: 'json[] Usuários que visualizaram o histórico.'
            example: '[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]'
            nullable: false
        -
          in: query
          name: 'filter[mentions]'
          description: 'Código dos usuários mencionados.'
          example:
            - 123
            - 3131
          required: false
          schema:
            type: array
            description: 'Código dos usuários mencionados.'
            example:
              - 123
              - 3131
            items:
              type: integer
        -
          in: query
          name: 'filter[fixed]'
          description: 'Histórico fixado.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Histórico fixado.'
            example: false
            nullable: false
        -
          in: query
          name: 'include[module]'
          description: 'Retorna os dados do registro que gerou o histórico.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do registro que gerou o histórico.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[child]'
          description: 'Retorna os dados do registro filho que gerou o histórico.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do registro filho que gerou o histórico.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[replies]'
          description: 'Retorna as respostas vinculadas ao histórico pai.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as respostas vinculadas ao histórico pai.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[parent]'
          description: 'Retorna os dados do histórico pai.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do histórico pai.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[user]'
          description: 'Retorna o usuário que gerou o histórico.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna o usuário que gerou o histórico.'
            example: 'id,name,email'
            nullable: false
        -
          in: query
          name: 'include[person]'
          description: 'Retorna a pessoa/cliente que está vinculada ao histórico.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a pessoa/cliente que está vinculada ao histórico.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[type]'
          description: 'Retorna o tipo de histórico.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna o tipo de histórico.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[mentionedUsers]'
          description: 'Retorna os usuários mencionados.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna os usuários mencionados.'
            example: 'id,name,email'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: 'Código do histórico.'
                  example: 1
                  nullable: false
                history_type_id:
                  type: integer
                  description: 'ID do Tipo do Histórico.'
                  example: 1
                  nullable: false
                module_type:
                  type: string
                  description: 'Módulo que gerou o histórico.'
                  example: deal
                  nullable: false
                module_id:
                  type: integer
                  description: 'ID do registro do módulo.'
                  example: 123
                  nullable: false
                date:
                  type: date
                  description: 'Data do Evento.'
                  example: '2024-01-01'
                  nullable: false
                user_id:
                  type: integer
                  description: 'Responsável pelo histórico.'
                  example: 321
                  nullable: false
                person_id:
                  type: integer
                  description: 'Código do cliente da Imobiliária vinculado ao módulo.'
                  example: 1111
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: 'Tentei contato com o cliente, mas não houve retorno'
                  nullable: false
                child_type:
                  type: integer
                  description: 'Módulo Filho.'
                  example: 0
                  nullable: false
                child_id:
                  type: integer
                  description: 'ID do registro do módulo filho.'
                  example: 1233
                  nullable: false
                parent_id:
                  type: integer
                  description: 'Código do histórico pai, utilizado para resposta de comentários por exemplo.'
                  example: 321
                  nullable: false
                private:
                  type: boolean
                  description: 'Histórico privado.'
                  example: false
                  nullable: false
                visualized_by:
                  type: array
                  description: 'Usuários que visualizaram o histórico.'
                  example:
                    -
                      user: 1233
                      dateTime: '2024-10-14T13:38:52.089117Z'
                  items:
                    type: json
                mentions:
                  type: array
                  description: 'Código dos usuários mencionados.'
                  example:
                    - 123
                    - 3131
                  items:
                    type: integer
                fixed:
                  type: boolean
                  description: 'Histórico fixado.'
                  example: false
                  nullable: false
              required:
                - history_type_id
                - module_type
                - module_id
                - date
                - description
  '/history/{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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[module]'
          description: 'Retorna os dados do registro que gerou o histórico.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do registro que gerou o histórico.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[child]'
          description: 'Retorna os dados do registro filho que gerou o histórico.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do registro filho que gerou o histórico.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[replies]'
          description: 'Retorna as respostas vinculadas ao histórico pai.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as respostas vinculadas ao histórico pai.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[parent]'
          description: 'Retorna os dados do histórico pai.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do histórico pai.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[user]'
          description: 'Retorna o usuário que gerou o histórico.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna o usuário que gerou o histórico.'
            example: 'id,name,email'
            nullable: false
        -
          in: query
          name: 'include[person]'
          description: 'Retorna a pessoa/cliente que está vinculada ao histórico.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a pessoa/cliente que está vinculada ao histórico.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[type]'
          description: 'Retorna o tipo de histórico.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna o tipo de histórico.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[mentionedUsers]'
          description: 'Retorna os usuários mencionados.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna os usuários mencionados.'
            example: 'id,name,email'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: 'Código do histórico.'
                  example: 1
                  nullable: false
                history_type_id:
                  type: integer
                  description: 'ID do Tipo do Histórico.'
                  example: 1
                  nullable: false
                module_type:
                  type: string
                  description: 'Módulo que gerou o histórico.'
                  example: deal
                  nullable: false
                module_id:
                  type: integer
                  description: 'ID do registro do módulo.'
                  example: 123
                  nullable: false
                date:
                  type: date
                  description: 'Data do Evento.'
                  example: '2024-01-01'
                  nullable: false
                user_id:
                  type: integer
                  description: 'Responsável pelo histórico.'
                  example: 321
                  nullable: false
                person_id:
                  type: integer
                  description: 'Código do cliente da Imobiliária vinculado ao módulo.'
                  example: 1111
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: 'Tentei contato com o cliente, mas não houve retorno'
                  nullable: false
                child_type:
                  type: integer
                  description: 'Módulo Filho.'
                  example: 0
                  nullable: false
                child_id:
                  type: integer
                  description: 'ID do registro do módulo filho.'
                  example: 1233
                  nullable: false
                parent_id:
                  type: integer
                  description: 'Código do histórico pai, utilizado para resposta de comentários por exemplo.'
                  example: 321
                  nullable: false
                private:
                  type: boolean
                  description: 'Histórico privado.'
                  example: false
                  nullable: false
                visualized_by:
                  type: array
                  description: 'Usuários que visualizaram o histórico.'
                  example:
                    -
                      user: 1233
                      dateTime: '2024-10-14T13:38:52.089117Z'
                  items:
                    type: json
                mentions:
                  type: array
                  description: 'Código dos usuários mencionados.'
                  example:
                    - 123
                    - 3131
                  items:
                    type: integer
                fixed:
                  type: boolean
                  description: 'Histórico fixado.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Históricos
    parameters:
      -
        in: path
        name: id
        description: 'Id do Histórico'
        example: 7
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/purposes':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: 'Tipo de finalidade.'
          example: sale
          required: false
          schema:
            type: string
            description: 'Tipo de finalidade.'
            example: sale
            nullable: false
        -
          in: query
          name: 'filter[currency]'
          description: 'Código da moeda.'
          example: BRL
          required: false
          schema:
            type: string
            description: 'Código da moeda.'
            example: BRL
            nullable: false
        -
          in: query
          name: 'filter[amount]'
          description: Valor.
          example: 1300.0
          required: false
          schema:
            type: number
            description: Valor.
            example: 1300.0
            nullable: false
        -
          in: query
          name: 'filter[amount_max]'
          description: 'Valor Máximo.'
          example: 1500.0
          required: false
          schema:
            type: number
            description: 'Valor Máximo.'
            example: 1500.0
            nullable: false
        -
          in: query
          name: 'filter[discount_type]'
          description: 'Valor Máximo.'
          example: 1500.0
          required: false
          schema:
            type: number
            description: 'Valor Máximo.'
            example: 1500.0
            nullable: false
        -
          in: query
          name: 'filter[discount]'
          description: 'Valor Máximo.'
          example: 1500.0
          required: false
          schema:
            type: number
            description: 'Valor Máximo.'
            example: 1500.0
            nullable: false
        -
          in: query
          name: 'filter[condition]'
          description: 'Condição de pagamento.'
          example: monthly
          required: false
          schema:
            type: string
            description: 'Condição de pagamento.'
            example: monthly
            nullable: false
        -
          in: query
          name: 'filter[accepts]'
          description: 'Opções de pagamento.'
          example: FGTS
          required: false
          schema:
            type: string
            description: 'Opções de pagamento.'
            example: FGTS
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[iptu_installment]'
          description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
          example: 11
          required: false
          schema:
            type: integer
            description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
            example: 11
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[tax]'
          description: 'Valor das taxas.'
          example: 100.0
          required: false
          schema:
            type: number
            description: 'Valor das taxas.'
            example: 100.0
            nullable: false
        -
          in: query
          name: 'filter[show_tax]'
          description: 'Divulga Taxas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Divulga Taxas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[show]'
          description: 'Divulga Finalidade.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Divulga Finalidade.'
            example: false
            nullable: 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
            nullable: false
        -
          in: query
          name: 'filter[season_low_active]'
          description: 'Baixa Temporada Ativa.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Baixa Temporada Ativa.'
            example: true
            nullable: 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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[season_high_active]'
          description: 'Alta Temporada Ativa.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Alta Temporada Ativa.'
            example: false
            nullable: 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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[iptu_free]'
          description: 'IPTU isento.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'IPTU isento.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[condominium_free]'
          description: 'Condomínio isento.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Condomínio isento.'
            example: false
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: 'Tipo de finalidade.'
                  example: sale
                  nullable: false
                currency:
                  type: string
                  description: 'Código da moeda.'
                  example: BRL
                  nullable: false
                amount:
                  type: number
                  description: Valor.
                  example: 1300.0
                  nullable: false
                amount_max:
                  type: number
                  description: 'Valor Máximo.'
                  example: 1500.0
                  nullable: false
                discount_type:
                  type: string
                  description: "Tipo de Desconto.\nValores permitidos:\n- `value`: Valor\n- `percentage`: Porcentagem\n- `disabled`: Sem Desconto"
                  example: value
                  nullable: false
                discount:
                  type: number
                  description: 'Valor do Desconto.'
                  example: 1500.0
                  nullable: false
                condition:
                  type: string
                  description: 'Condição de pagamento.'
                  example: monthly
                  nullable: false
                accepts:
                  type: string
                  description: 'Opções de pagamento.'
                  example: FGTS
                  nullable: false
                acceptance_notes:
                  type: string
                  description: 'Observações para Opções de pagamento.'
                  example: 'Apenas para Aposentados'
                  nullable: false
                iptu_amount:
                  type: number
                  description: 'Valor do IPTU.'
                  example: 1750.0
                  nullable: false
                iptu_installment:
                  type: integer
                  description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
                  example: 17
                  nullable: false
                condominium:
                  type: number
                  description: 'Valor do Condomínio.'
                  example: 250.0
                  nullable: false
                tax:
                  type: number
                  description: 'Valor das taxas.'
                  example: 100.0
                  nullable: false
                show_tax:
                  type: boolean
                  description: 'Divulga Taxas.'
                  example: true
                  nullable: false
                show:
                  type: boolean
                  description: 'Divulga Finalidade.'
                  example: false
                  nullable: false
                show_pack:
                  type: boolean
                  description: 'Divulga Pacotes de Temporada.'
                  example: false
                  nullable: false
                season_low_active:
                  type: boolean
                  description: 'Baixa Temporada Ativa.'
                  example: true
                  nullable: false
                season_low_condition:
                  type: string
                  description: 'Condição de pagamento da Baixa Temporada.'
                  example: daily
                  nullable: false
                season_low_tax:
                  type: number
                  description: 'Valor das Taxas da Baixa Temporada.'
                  example: 100.0
                  nullable: false
                season_high_active:
                  type: boolean
                  description: 'Alta Temporada Ativa.'
                  example: false
                  nullable: false
                season_high_condition:
                  type: string
                  description: 'Condição de pagamento da Alta Temporada.'
                  example: daily
                  nullable: false
                season_high_tax:
                  type: number
                  description: 'Valor das Taxas da Alta Temporada.'
                  example: 150.0
                  nullable: false
                comission:
                  type: number
                  description: 'Porcentagem de Comissão.'
                  example: 20.0
                  nullable: false
                first_commission:
                  type: number
                  description: 'Porcentagem da primeira Comissão.'
                  example: 40.0
                  nullable: false
                iptu_free:
                  type: boolean
                  description: 'IPTU isento.'
                  example: true
                  nullable: false
                condominium_free:
                  type: boolean
                  description: 'Condomínio isento.'
                  example: false
                  nullable: false
    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: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: 'Tipo de finalidade.'
                  example: sale
                  nullable: false
                currency:
                  type: string
                  description: 'Código da moeda.'
                  example: BRL
                  nullable: false
                amount:
                  type: number
                  description: Valor.
                  example: 1300.0
                  nullable: false
                amount_max:
                  type: number
                  description: 'Valor Máximo.'
                  example: 1500.0
                  nullable: false
                discount_type:
                  type: number
                  description: 'Valor Máximo.'
                  example: 1500.0
                  nullable: false
                discount:
                  type: number
                  description: 'Valor Máximo.'
                  example: 1500.0
                  nullable: false
                condition:
                  type: string
                  description: 'Condição de pagamento.'
                  example: monthly
                  nullable: false
                accepts:
                  type: string
                  description: 'Opções de pagamento.'
                  example: FGTS
                  nullable: false
                acceptance_notes:
                  type: string
                  description: 'Observações para Opções de pagamento.'
                  example: 'Apenas para Aposentados'
                  nullable: false
                iptu_amount:
                  type: number
                  description: 'Valor do IPTU.'
                  example: 1750.0
                  nullable: false
                iptu_installment:
                  type: integer
                  description: 'Quantidade em que pode-se parcelar o valor do IPTU.'
                  example: 12
                  nullable: false
                condominium:
                  type: number
                  description: 'Valor do Condomínio.'
                  example: 250.0
                  nullable: false
                tax:
                  type: number
                  description: 'Valor das taxas.'
                  example: 100.0
                  nullable: false
                show_tax:
                  type: boolean
                  description: 'Divulga Taxas.'
                  example: false
                  nullable: false
                show:
                  type: boolean
                  description: 'Divulga Finalidade.'
                  example: false
                  nullable: false
                show_pack:
                  type: boolean
                  description: 'Divulga Pacotes de Temporada.'
                  example: true
                  nullable: false
                season_low_active:
                  type: boolean
                  description: 'Baixa Temporada Ativa.'
                  example: false
                  nullable: false
                season_low_condition:
                  type: string
                  description: 'Condição de pagamento da Baixa Temporada.'
                  example: daily
                  nullable: false
                season_low_tax:
                  type: number
                  description: 'Valor das Taxas da Baixa Temporada.'
                  example: 100.0
                  nullable: false
                season_high_active:
                  type: boolean
                  description: 'Alta Temporada Ativa.'
                  example: false
                  nullable: false
                season_high_condition:
                  type: string
                  description: 'Condição de pagamento da Alta Temporada.'
                  example: daily
                  nullable: false
                season_high_tax:
                  type: number
                  description: 'Valor das Taxas da Alta Temporada.'
                  example: 150.0
                  nullable: false
                comission:
                  type: number
                  description: 'Porcentagem de Comissão.'
                  example: 20.0
                  nullable: false
                first_commission:
                  type: number
                  description: 'Porcentagem da primeira Comissão.'
                  example: 40.0
                  nullable: false
                iptu_free:
                  type: boolean
                  description: 'IPTU isento.'
                  example: true
                  nullable: false
                condominium_free:
                  type: boolean
                  description: 'Condomínio isento.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel'
        example: 7
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'The ID of the purpose.'
        example: facilis
        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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[date]'
          description: Data.
          example: 21/04/2021
          required: false
          schema:
            type: string
            description: Data.
            example: 21/04/2021
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: string
                  description: Data.
                  example: '2024-01-24'
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do contrato atrelado.'
                  example: 321321
                  nullable: false
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel'
        example: 16
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/unavailabity/{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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: string
                  description: Data.
                  example: '2024-01-24'
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do contrato atrelado.'
                  example: 321321
                  nullable: false
              required:
                - date
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel.'
        example: 4
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'ID da Data indisponível.'
        example: 12
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/tabs':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da aba.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID da aba.'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[position]'
          description: 'Ordem (crescente).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Ordem (crescente).'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[content]'
          description: 'HTML do conteúdo.'
          example: '<p>3 Quartos</p>'
          required: false
          schema:
            type: string
            description: 'HTML do conteúdo.'
            example: '<p>3 Quartos</p>'
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título da Aba.'
                  example: Características
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem (crescente).'
                  example: 1
                  nullable: false
                content:
                  type: string
                  description: 'HTML do conteúdo.'
                  example: '<p>3 Quartos</p>'
                  nullable: false
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel.'
        example: 16
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/tabs/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título da Aba.'
                  example: Características
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem (crescente).'
                  example: 1
                  nullable: false
                content:
                  type: string
                  description: 'HTML do conteúdo.'
                  example: '<p>3 Quartos</p>'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel.'
        example: 13
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'ID da Aba.'
        example: 16
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/seasonPacks':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do pacote.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID do pacote.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[currency]'
          description: 'Código da moeda.'
          example: BRL
          required: false
          schema:
            type: string
            description: 'Código da moeda.'
            example: BRL
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: 'Pacote de Carnaval'
          required: false
          schema:
            type: string
            description: Descrição.
            example: 'Pacote de Carnaval'
            nullable: false
        -
          in: query
          name: 'filter[amount]'
          description: Valor.
          example: 5000.0
          required: false
          schema:
            type: number
            description: Valor.
            example: 5000.0
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                currency:
                  type: string
                  description: 'Código da moeda.'
                  example: BRL
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: 'Pacote de Carnaval'
                  nullable: false
                amount:
                  type: number
                  description: Valor.
                  example: 5000.0
                  nullable: false
                starts_at:
                  type: string
                  description: 'Data de início.'
                  example: 07/02/2021
                  nullable: false
                ends_at:
                  type: string
                  description: 'Data de fim.'
                  example: 21/02/2021
                  nullable: false
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel'
        example: 5
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/seasonPacks/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                currency:
                  type: string
                  description: 'Código da moeda.'
                  example: BRL
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: 'Pacote de Carnaval'
                  nullable: false
                amount:
                  type: number
                  description: Valor.
                  example: 5000.0
                  nullable: false
                starts_at:
                  type: string
                  description: 'Data de início.'
                  example: 07/02/2021
                  nullable: false
                ends_at:
                  type: string
                  description: 'Data de fim.'
                  example: 21/02/2021
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    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: 6
        required: true
        schema:
          type: integer
  /buildings/stages:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do estágio. Example:'
          example: 19
          required: false
          schema:
            type: integer
            description: 'ID do estágio. Example:'
            example: 19
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'Descrição. Example:'
          example: vitae
          required: false
          schema:
            type: string
            description: 'Descrição. Example:'
            example: vitae
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[percentage]'
          description: 'Porcentagem da Obra.'
          example: 80
          required: false
          schema:
            type: integer
            description: 'Porcentagem da Obra.'
            example: 80
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Estágio de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição. Example:'
                  example: 'Et ad vel non repellendus reiciendis tenetur id.'
                  nullable: false
                percentage_active:
                  type: boolean
                  description: 'Utilizar porcentagem para obra.'
                  example: false
                  nullable: false
                percentage:
                  type: integer
                  description: 'Porcentagem da Obra.'
                  example: 80
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem dos estágios com porcentagem.'
                  example: 2
                  nullable: false
              required:
                - description
  '/buildings/stages/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Estágio de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição. Example:'
                  example: 'Tempore neque ipsa velit aut quam est.'
                  nullable: false
                percentage_active:
                  type: boolean
                  description: 'Utilizar porcentagem para obra.'
                  example: false
                  nullable: false
                percentage:
                  type: integer
                  description: 'Porcentagem da Obra.'
                  example: 80
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem dos estágios com porcentagem.'
                  example: 2
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Estágio de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: id
        description: 'ID do estágio.'
        example: 5
        required: true
        schema:
          type: integer
  /buildings/keys/keyMovements:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[key_id]'
          description: 'ID da chave.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'ID da chave.'
            example: 12
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'ID do solicitante.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'ID do solicitante.'
            example: 12
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[number]'
          description: 'Complemento do solicitante.'
          example: Apartamento
          required: false
          schema:
            type: string
            description: 'Complemento do solicitante.'
            example: Apartamento
            nullable: false
        -
          in: query
          name: 'filter[complement]'
          description: 'Complemento do solicitante.'
          example: Apartamento
          required: false
          schema:
            type: string
            description: 'Complemento do solicitante.'
            example: Apartamento
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                key_id:
                  type: integer
                  description: 'ID da chave.'
                  example: 12
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID do solicitante.'
                  example: 12
                  nullable: false
                user_id:
                  type: integer
                  description: 'ID do corretor responsável.'
                  example: 123
                  nullable: false
                returned:
                  type: boolean
                  description: 'Se a chave foi devolvida.'
                  example: true
                  nullable: false
                taked_at:
                  type: string
                  description: 'Quando a pessoa retirou.'
                  example: 20/04/2021
                  nullable: false
                returned_at:
                  type: string
                  description: 'Quando a pessoa devolveu.'
                  example: 30/04/2021
                  nullable: false
                return_prevision:
                  type: string
                  description: 'Previsão de devolução.'
                  example: 30/04/2021
                  nullable: false
                person_name:
                  type: string
                  description: 'Nome do solicitante.'
                  example: Rogério
                  nullable: false
                person_phone:
                  type: string
                  description: 'telefone do solicitante.'
                  example: '(47) 92860-8431'
                  nullable: false
                person_tax_id:
                  type: string
                  description: 'CPF do solicitante.'
                  example: 365.277.520-16
                  nullable: false
                person_zip_code:
                  type: string
                  description: 'CEP do solicitante.'
                  example: 69316-038
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID de País do solicitante.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID de Estado do solicitante.'
                  example: 22
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID de Cidade do solicitante.'
                  example: 7375
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID de Bairro do solicitante.'
                  example: 35040
                  nullable: false
                street:
                  type: string
                  description: 'Rua do solicitante.'
                  example: 'Rua Z-Y'
                  nullable: false
                number:
                  type: string
                  description: 'Complemento do solicitante.'
                  example: Apartamento
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do solicitante.'
                  example: Apartamento
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Cliente é de outra cidade'
                  nullable: false
              required:
                - key_id
                - user_id
                - taked_at
                - person_name
                - person_phone
                - person_tax_id
  '/buildings/keys/keyMovements/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                key_id:
                  type: integer
                  description: 'ID da chave.'
                  example: 12
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID do solicitante.'
                  example: 12
                  nullable: false
                user_id:
                  type: integer
                  description: 'ID do corretor responsável.'
                  example: 123
                  nullable: false
                returned:
                  type: boolean
                  description: 'Se a chave foi devolvida.'
                  example: true
                  nullable: false
                taked_at:
                  type: string
                  description: 'Quando a pessoa retirou.'
                  example: 20/04/2021
                  nullable: false
                returned_at:
                  type: string
                  description: 'Quando a pessoa devolveu.'
                  example: 30/04/2021
                  nullable: false
                return_prevision:
                  type: string
                  description: 'Previsão de devolução.'
                  example: 30/04/2021
                  nullable: false
                person_name:
                  type: string
                  description: 'Nome do solicitante.'
                  example: Rogério
                  nullable: false
                person_phone:
                  type: string
                  description: 'telefone do solicitante.'
                  example: '(47) 92860-8431'
                  nullable: false
                person_tax_id:
                  type: string
                  description: 'CPF do solicitante.'
                  example: 365.277.520-16
                  nullable: false
                person_zip_code:
                  type: string
                  description: 'CEP do solicitante.'
                  example: 69316-038
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID de País do solicitante.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID de Estado do solicitante.'
                  example: 22
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID de Cidade do solicitante.'
                  example: 7375
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID de Bairro do solicitante.'
                  example: 35040
                  nullable: false
                street:
                  type: string
                  description: 'Rua do solicitante.'
                  example: 'Rua Z-Y'
                  nullable: false
                number:
                  type: string
                  description: 'Complemento do solicitante.'
                  example: Apartamento
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do solicitante.'
                  example: Apartamento
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Cliente é de outra cidade'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: "<aside>\n🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves<br/><br/>\nA chave precisa ter retornado para excluir a movimentação!\n</aside>"
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    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: '<aside>🔒 Para acessar essa rota é necessária a permissão de Movimentação de chaves</aside>'
      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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: movement_id
        description: 'ID da Movimentação de Chave.'
        example: 3
        required: true
        schema:
          type: integer
  /buildings/keys:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da chave.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID da chave.'
            example: 123
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[reference]'
          description: 'Referência da chave.'
          example: CHA01
          required: false
          schema:
            type: string
            description: 'Referência da chave.'
            example: CHA01
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[principal]'
          description: 'Chave principal.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Chave principal.'
            example: false
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Chaves</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                building_id:
                  type: integer
                  description: 'ID do imóvel.'
                  example: 11111
                  nullable: false
                reference:
                  type: string
                  description: 'Referência da chave.'
                  example: CHA01
                  nullable: false
                description:
                  type: string
                  description: 'Descrição da chave.'
                  example: 'Chave da Suíte'
                  nullable: false
                is_with:
                  type: string
                  description: 'Com quem a chave está.'
                  example: proprietary
                  nullable: false
                principal:
                  type: boolean
                  description: 'Chave principal.'
                  example: false
                  nullable: 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: 2
  '/buildings/keys/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Chaves</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                building_id:
                  type: integer
                  description: 'ID do imóvel.'
                  example: 11111
                  nullable: false
                reference:
                  type: string
                  description: 'Referência da chave.'
                  example: CHA01
                  nullable: false
                description:
                  type: string
                  description: 'Descrição da chave.'
                  example: 'Chave da Suíte'
                  nullable: false
                is_with:
                  type: string
                  description: 'Com quem a chave está.'
                  example: proprietary
                  nullable: false
                principal:
                  type: boolean
                  description: 'Chave principal.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Chaves</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: id
        description: 'ID da Chave.'
        example: 4
        required: true
        schema:
          type: integer
  /buildings/details:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do detalhe.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do detalhe.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[group_id]'
          description: 'ID do detalhe.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'ID do detalhe.'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: 'ID do detalhe.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'ID do detalhe.'
            example: 0
            nullable: false
        -
          in: query
          name: 'filter[default]'
          description: 'Detalhe padrão.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Detalhe padrão.'
            example: false
            nullable: 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'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
          example: illum
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
            example: illum
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 1
                  nullable: false
                group_id:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 3
                  nullable: false
                description:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 0
                  nullable: false
                default:
                  type: boolean
                  description: 'Detalhe padrão.'
                  example: false
                  nullable: false
  '/buildings/details/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
          example: et
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis com o detalhe. Exmaple: id,title'
            example: et
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 1
                  nullable: false
                group_id:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 3
                  nullable: false
                description:
                  type: integer
                  description: 'ID do detalhe.'
                  example: 0
                  nullable: false
                default:
                  type: boolean
                  description: 'Detalhe padrão.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: id
        description: 'ID do Detalhe.'
        example: 2
        required: true
        schema:
          type: integer
  /buildings/detailGroups:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do grupo de detalhe.'
          example: 9
          required: false
          schema:
            type: integer
            description: 'ID do grupo de detalhe.'
            example: 9
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: Decorações
          required: false
          schema:
            type: string
            description: Descrição.
            example: Decorações
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: Descrição.
                  example: Decorações
                  nullable: false
              required:
                - description
  '/buildings/detailGroups/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: Descrição.
                  example: Decorações
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: id
        description: 'ID do Grupo de Detalhe'
        example: 9
        required: true
        schema:
          type: integer
  '/buildings/approve/{building_id}':
    put:
      summary: Aprovar
      operationId: aprovar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do imóvel'
        example: 14
        required: true
        schema:
          type: integer
  '/buildings/{building_id}/duplicate':
    post:
      summary: Duplicar
      operationId: duplicar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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: true
                  nullable: false
                keys:
                  type: boolean
                  description: 'Define se duplica as chaves do imóvel'
                  example: true
                  nullable: false
                season_packs:
                  type: boolean
                  description: 'Define se duplica os pacotes de temporada'
                  example: true
                  nullable: false
                unavailable_dates:
                  type: boolean
                  description: 'Define se duplica os dias indisponíveis'
                  example: false
                  nullable: false
    parameters:
      -
        in: path
        name: building_id
        description: 'ID do Imóvel'
        example: 6
        required: true
        schema:
          type: integer
  /buildings:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do imóvel.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do imóvel.'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[reference]'
          description: Referência.
          example: CA001
          required: false
          schema:
            type: string
            description: Referência.
            example: CA001
            nullable: false
        -
          in: query
          name: 'filter[status]'
          description: Status.
          example: active
          required: false
          schema:
            type: string
            description: Status.
            example: active
            nullable: false
        -
          in: query
          name: 'filter[lock]'
          description: 'Bloqueio do imóvel.'
          example: free
          required: false
          schema:
            type: string
            description: 'Bloqueio do imóvel.'
            example: free
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[state_id]'
          description: 'ID do estado.'
          example: 24
          required: false
          schema:
            type: integer
            description: 'ID do estado.'
            example: 24
            nullable: false
        -
          in: query
          name: 'filter[city_id]'
          description: 'ID da cidade.'
          example: 8650
          required: false
          schema:
            type: integer
            description: 'ID da cidade.'
            example: 8650
            nullable: false
        -
          in: query
          name: 'filter[district_id]'
          description: 'ID do bairro.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do bairro.'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[access]'
          description: 'Tipo de Acesso.'
          example: all
          required: false
          schema:
            type: string
            description: 'Tipo de Acesso.'
            example: all
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: 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'
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Imóvel Ativo.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Imóvel Ativo.'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[principal_media]'
          description: 'Mídia principal.'
          example: 'https://...'
          required: false
          schema:
            type: string
            description: 'Mídia principal.'
            example: 'https://...'
            nullable: false
        -
          in: query
          name: 'filter[purpose_featured]'
          description: 'Finalidade em destaque.'
          example: rent
          required: false
          schema:
            type: string
            description: 'Finalidade em destaque.'
            example: rent
            nullable: false
        -
          in: query
          name: 'filter[position]'
          description: 'Ordem do imóvel.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Ordem do imóvel.'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[garage_min]'
          description: 'Quantidade mínima de garagens.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade mínima de garagens.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[garage_max]'
          description: 'Quantidade máxima de garagens.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade máxima de garagens.'
            example: 1
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[suite_min]'
          description: 'Quantidade mínima de Suítes.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade mínima de Suítes.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[suite_max]'
          description: 'Quantidade máxima de Suítes.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade máxima de Suítes.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[room_min]'
          description: 'Quantidade mínima de Salas.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade mínima de Salas.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[room_max]'
          description: 'Quantidade máxima de Salas.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Quantidade máxima de Salas.'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[bathroom_min]'
          description: 'Quantidade mínima de Banheiros.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Quantidade mínima de Banheiros.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[bathroom_max]'
          description: 'Quantidade máxima de Banheiros.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'Quantidade máxima de Banheiros.'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[bedroom_min]'
          description: 'Quantidade mínima de Quartos.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'Quantidade mínima de Quartos.'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[bedroom_max]'
          description: 'Quantidade máxima de Quartos.'
          example: 3
          required: false
          schema:
            type: integer
            description: 'Quantidade máxima de Quartos.'
            example: 3
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[floor]'
          description: 'Andar do imóvel.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Andar do imóvel.'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[total_floors]'
          description: 'Quantidade de Andares.'
          example: 4
          required: false
          schema:
            type: integer
            description: 'Quantidade de Andares.'
            example: 4
            nullable: false
        -
          in: query
          name: 'filter[total_by_floors]'
          description: 'Apartamentos por Andar.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Apartamentos por Andar.'
            example: 2
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[furnishing]'
          description: 'Status da mobília.'
          example: furnished
          required: false
          schema:
            type: string
            description: 'Status da mobília.'
            example: furnished
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[plate]'
          description: 'Status da placa.'
          example: without
          required: false
          schema:
            type: string
            description: 'Status da placa.'
            example: without
            nullable: false
        -
          in: query
          name: 'filter[content]'
          description: 'HTML de Descrição do imóvel.'
          example: '<p>Imóvel de Exemplo!</p>'
          required: false
          schema:
            type: string
            description: 'HTML de Descrição do imóvel.'
            example: '<p>Imóvel de Exemplo!</p>'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[area_total_min]'
          description: 'numeric Área total mínima.'
          example: '123'
          required: false
          schema:
            type: string
            description: 'numeric Área total mínima.'
            example: '123'
            nullable: false
        -
          in: query
          name: 'filter[area_total_max]'
          description: 'numeric Área total máxima.'
          example: '321'
          required: false
          schema:
            type: string
            description: 'numeric Área total máxima.'
            example: '321'
            nullable: false
        -
          in: query
          name: 'filter[area_private_min]'
          description: 'numeric Área privada mínima.'
          example: '123'
          required: false
          schema:
            type: string
            description: 'numeric Área privada mínima.'
            example: '123'
            nullable: false
        -
          in: query
          name: 'filter[area_private_max]'
          description: 'numeric Área privada máxima.'
          example: '321'
          required: false
          schema:
            type: string
            description: 'numeric Área privada máxima.'
            example: '321'
            nullable: false
        -
          in: query
          name: 'filter[area_useful_min]'
          description: 'numeric Área útil mínima.'
          example: '123'
          required: false
          schema:
            type: string
            description: 'numeric Área útil mínima.'
            example: '123'
            nullable: false
        -
          in: query
          name: 'filter[area_useful_max]'
          description: 'numeric Área útil máxima.'
          example: '321'
          required: false
          schema:
            type: string
            description: 'numeric Área útil máxima.'
            example: '321'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[complement]'
          description: 'Complemento do imóvel.'
          example: Apartamento
          required: false
          schema:
            type: string
            description: 'Complemento do imóvel.'
            example: Apartamento
            nullable: false
        -
          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é'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[show_address]'
          description: 'Divulga Endereço.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Divulga Endereço.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[show_number]'
          description: 'Divulga Número.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Divulga Número.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[show_complement]'
          description: 'Divulga Complemento.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Divulga Complemento.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[map]'
          description: 'Divulga Mapa.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Divulga Mapa.'
            example: false
            nullable: 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
            nullable: 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
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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://...'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[html_keyword]'
          description: 'Palavras Chave (HTML Keyword). Example:'
          example: dolores
          required: false
          schema:
            type: string
            description: 'Palavras Chave (HTML Keyword). Example:'
            example: dolores
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[system_featured]'
          description: 'Destaque no Site.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Destaque no Site.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[thirdparty_featured]'
          description: 'Destaque nos Portais.'
          example: disabled
          required: false
          schema:
            type: string
            description: 'Destaque nos Portais.'
            example: disabled
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[watermark]'
          description: "Usa Marca d'água."
          example: true
          required: false
          schema:
            type: boolean
            description: "Usa Marca d'água."
            example: true
            nullable: false
        -
          in: query
          name: 'filter[exclusivity]'
          description: Exclusividade.
          example: false
          required: false
          schema:
            type: boolean
            description: Exclusividade.
            example: false
            nullable: 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){...}'
            nullable: false
        -
          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
            nullable: 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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[constructor]'
          description: 'Retorna a construtora.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a construtora.'
            example: 'id,name'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as Tags do imóvel. Example:'
          example: earum
          required: false
          schema:
            type: string
            description: 'Retorna as Tags do imóvel. Example:'
            example: earum
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[proposals]'
          description: 'Retorna as propostas feitas para o imóvel. Example:'
          example: rerum
          required: false
          schema:
            type: string
            description: 'Retorna as propostas feitas para o imóvel. Example:'
            example: rerum
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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
                  nullable: false
                condominium_id:
                  type: integer
                  description: 'ID do condomínio.'
                  example: 13
                  nullable: false
                reference:
                  type: string
                  description: Referência.
                  example: CA001
                  nullable: false
                status:
                  type: string
                  description: Status.
                  example: active
                  nullable: false
                lock:
                  type: string
                  description: 'Bloqueio do imóvel.'
                  example: free
                  nullable: false
                type_id:
                  type: integer
                  description: 'ID do Tipo do imóvel.'
                  example: 1
                  nullable: false
                stage_id:
                  type: integer
                  description: 'ID do estágio.'
                  example: 2
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do estado.'
                  example: 24
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID da cidade.'
                  example: 8650
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do bairro.'
                  example: 1
                  nullable: false
                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
                  nullable: false
                access:
                  type: string
                  description: 'Tipo de Acesso.'
                  example: all
                  nullable: false
                pickup:
                  type: integer
                  description: 'ID do usuário que captou o imóvel.'
                  example: 123
                  nullable: false
                slug:
                  type: string
                  description: 'Link permanente para site.'
                  example: exemplo-perma-link
                  nullable: false
                expiration:
                  type: boolean
                  description: 'Expiração do imóvel ativa.'
                  example: false
                  nullable: false
                expiration_date:
                  type: string
                  description: 'Data da expiração do imóvel.'
                  example: '2024-03-20'
                  nullable: false
                active:
                  type: boolean
                  description: 'Imóvel Ativo.'
                  example: true
                  nullable: false
                import_id:
                  type: string
                  description: 'Referência do sistema externo.'
                  example: CA001
                  nullable: false
                principal_media:
                  type: string
                  description: 'Mídia principal.'
                  example: 'https://...'
                  nullable: false
                purpose_featured:
                  type: string
                  description: 'Finalidade em destaque.'
                  example: rent
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem do imóvel.'
                  example: 1
                  nullable: false
                occupancy:
                  type: string
                  description: 'Ocupação do imóvel.'
                  example: vacant
                  nullable: false
                garage_min:
                  type: integer
                  description: 'Quantidade mínima de garagens.'
                  example: 1
                  nullable: false
                garage_max:
                  type: integer
                  description: 'Quantidade máxima de garagens.'
                  example: 1
                  nullable: false
                garage_number:
                  type: integer
                  description: 'Número da Vaga.'
                  example: 123
                  nullable: false
                suite_min:
                  type: integer
                  description: 'Quantidade mínima de Suítes.'
                  example: 1
                  nullable: false
                suite_max:
                  type: integer
                  description: 'Quantidade máxima de Suítes.'
                  example: 1
                  nullable: false
                room_min:
                  type: integer
                  description: 'Quantidade mínima de Salas.'
                  example: 1
                  nullable: false
                room_max:
                  type: integer
                  description: 'Quantidade máxima de Salas.'
                  example: 2
                  nullable: false
                bathroom_min:
                  type: integer
                  description: 'Quantidade mínima de Banheiros.'
                  example: 1
                  nullable: false
                bathroom_max:
                  type: integer
                  description: 'Quantidade máxima de Banheiros.'
                  example: 3
                  nullable: false
                bedroom_min:
                  type: integer
                  description: 'Quantidade mínima de Quartos.'
                  example: 3
                  nullable: false
                bedroom_max:
                  type: integer
                  description: 'Quantidade máxima de Quartos.'
                  example: 3
                  nullable: false
                conservation:
                  type: string
                  description: 'Conservação do imóvel.'
                  example: 'Bem conservado'
                  nullable: false
                built_year:
                  type: integer
                  description: 'Ano de construção.'
                  example: 2000
                  nullable: false
                floor:
                  type: integer
                  description: 'Andar do imóvel.'
                  example: 2
                  nullable: false
                total_floors:
                  type: integer
                  description: 'Quantidade de Andares.'
                  example: 4
                  nullable: false
                total_by_floors:
                  type: integer
                  description: 'Apartamentos por Andar.'
                  example: 2
                  nullable: false
                blocks:
                  type: integer
                  description: 'Quantidade de Blocos do condomínio.'
                  example: 2
                  nullable: false
                accommodates:
                  type: integer
                  description: 'Quantidade de Pessoas que acomoda.'
                  example: 5
                  nullable: false
                furnishing:
                  type: string
                  description: 'Status da mobília.'
                  example: furnished
                  nullable: false
                title:
                  type: string
                  description: 'Titulo do imóvel.'
                  example: 'Título Exemplar'
                  nullable: false
                plate:
                  type: string
                  description: 'Status da placa.'
                  example: without
                  nullable: false
                content:
                  type: string
                  description: 'HTML de Descrição do imóvel.'
                  example: '<p>Imóvel de Exemplo!</p>'
                  nullable: false
                lock_description:
                  type: string
                  description: 'Observações do bloqueio.'
                  example: 'Fim da Locação'
                  nullable: false
                area_total_min:
                  type: numeric
                  description: 'Área total mínima.'
                  example: '123'
                  nullable: false
                area_total_max:
                  type: numeric
                  description: 'Área total máxima.'
                  example: '321'
                  nullable: false
                area_private_min:
                  type: numeric
                  description: 'Área privada mínima.'
                  example: '123'
                  nullable: false
                area_private_max:
                  type: numeric
                  description: 'Área privada máxima.'
                  example: '321'
                  nullable: false
                area_useful_min:
                  type: numeric
                  description: 'Área útil mínima.'
                  example: '123'
                  nullable: false
                area_useful_max:
                  type: numeric
                  description: 'Área útil máxima.'
                  example: '321'
                  nullable: false
                area_ground:
                  type: numeric
                  description: 'Área do terreno.'
                  example: '12'
                  nullable: false
                area_front:
                  type: numeric
                  description: 'Frente do imóvel.'
                  example: '21'
                  nullable: false
                area_length:
                  type: numeric
                  description: 'Comprimento do imóvel.'
                  example: '132'
                  nullable: false
                area_back:
                  type: numeric
                  description: 'Fundos do imóvel.'
                  example: '123'
                  nullable: false
                street:
                  type: string
                  description: 'Rua do imóvel.'
                  example: 'Rua Guanabara'
                  nullable: false
                number:
                  type: integer
                  description: 'número do imóvel.'
                  example: 1
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do imóvel.'
                  example: Apartamento
                  nullable: false
                reference_point:
                  type: string
                  description: 'Ponto de referência.'
                  example: 'Bar do Seu Zé'
                  nullable: false
                building_name:
                  type: string
                  description: 'Nome do empreendimento.'
                  example: 'Guanabara Prime'
                  nullable: false
                zip_code:
                  type: integer
                  description: 'CEP do imóvel.'
                  example: 89160000
                  nullable: false
                amount_updated_at:
                  type: Date
                  description: 'Data de Atualização dos valores.'
                  example: '2024-01-01'
                  nullable: false
                delivery_date:
                  type: Date
                  description: 'Data de entrega.'
                  example: '2024-05-01'
                  nullable: false
                show_address:
                  type: boolean
                  description: 'Divulga Endereço.'
                  example: true
                  nullable: false
                show_number:
                  type: boolean
                  description: 'Divulga Número.'
                  example: true
                  nullable: false
                show_complement:
                  type: boolean
                  description: 'Divulga Complemento.'
                  example: true
                  nullable: false
                map:
                  type: boolean
                  description: 'Divulga Mapa.'
                  example: false
                  nullable: false
                map_street:
                  type: boolean
                  description: 'Divulga Mapa da Rua.'
                  example: false
                  nullable: 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
                  nullable: false
                iptu_reference:
                  type: string
                  description: 'Inscrição de IPTU.'
                  example: '12321321'
                  nullable: false
                energy_reference:
                  type: string
                  description: 'Matrícula de inscrição de Energia.'
                  example: '12321313'
                  nullable: false
                water_reference:
                  type: string
                  description: 'Matrícula de inscrição de Água.'
                  example: '213213'
                  nullable: false
                gas_reference:
                  type: string
                  description: 'Matrícula de inscrição de gás.'
                  example: 23213213-12
                  nullable: false
                incorporation_reference:
                  type: string
                  description: 'Inscrição de Incorporação.'
                  example: '213213123.223'
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Observações do imóvel'
                  nullable: false
                virtual_tour:
                  type: string
                  description: 'Link do Tour Virtual.'
                  example: 'https://...'
                  nullable: false
                html_title:
                  type: string
                  description: 'Título da página (HTML title).'
                  example: 'SEO Título'
                  nullable: false
                html_keyword:
                  type: string
                  description: 'Palavras Chave (HTML Keyword). Example:'
                  example: exercitationem
                  nullable: false
                html_description:
                  type: string
                  description: 'descrição SEO.'
                  example: 'SEO,chave'
                  nullable: false
                system_featured:
                  type: boolean
                  description: 'Destaque no Site.'
                  example: true
                  nullable: false
                thirdparty_featured:
                  type: string
                  description: 'Destaque nos Portais.'
                  example: disabled
                  nullable: false
                uses_calendar:
                  type: string
                  description: 'Uso do calendário.'
                  example: disabled
                  nullable: false
                watermark:
                  type: boolean
                  description: "Usa Marca d'água."
                  example: true
                  nullable: false
                exclusivity:
                  type: boolean
                  description: Exclusividade.
                  example: false
                  nullable: false
                head_code:
                  type: string
                  description: 'Códigos para Plugins Específicos dentro da tag Head.'
                  example: 'function example(foo,bar){...}'
                  nullable: false
                status_bar:
                  type: boolean
                  description: 'Barra de Status ativa.'
                  example: false
                  nullable: false
                status_bar_content:
                  type: string
                  description: 'Conteúdo da Barra de Status.'
                  example: 'Sem conteúdo'
                  nullable: false
                status_bar_color:
                  type: string
                  description: 'Cor da Barra de Status.'
                  example: ff00fa
                  nullable: false
                owner_report:
                  type: boolean
                  description: 'Notificação para o Proprietário.'
                  example: true
                  nullable: false
              required:
                - type_id
                - title
  '/buildings/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[constructor]'
          description: 'Retorna a construtora.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a construtora.'
            example: 'id,name'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as Tags do imóvel. Example:'
          example: qui
          required: false
          schema:
            type: string
            description: 'Retorna as Tags do imóvel. Example:'
            example: qui
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[proposals]'
          description: 'Retorna as propostas feitas para o imóvel. Example:'
          example: maxime
          required: false
          schema:
            type: string
            description: 'Retorna as propostas feitas para o imóvel. Example:'
            example: maxime
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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
                  nullable: false
                condominium_id:
                  type: integer
                  description: 'ID do condomínio.'
                  example: 13
                  nullable: false
                reference:
                  type: string
                  description: Referência.
                  example: CA001
                  nullable: false
                status:
                  type: string
                  description: Status.
                  example: active
                  nullable: false
                lock:
                  type: string
                  description: 'Bloqueio do imóvel.'
                  example: free
                  nullable: false
                type_id:
                  type: integer
                  description: 'ID do Tipo do imóvel.'
                  example: 1
                  nullable: false
                stage_id:
                  type: integer
                  description: 'ID do estágio.'
                  example: 2
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do estado.'
                  example: 24
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID da cidade.'
                  example: 8650
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do bairro.'
                  example: 1
                  nullable: false
                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
                  nullable: false
                access:
                  type: string
                  description: 'Tipo de Acesso.'
                  example: all
                  nullable: false
                pickup:
                  type: integer
                  description: 'ID do usuário que captou o imóvel.'
                  example: 123
                  nullable: false
                slug:
                  type: string
                  description: 'Link permanente para site.'
                  example: exemplo-perma-link
                  nullable: false
                expiration:
                  type: boolean
                  description: 'Expiração do imóvel ativa.'
                  example: false
                  nullable: false
                expiration_date:
                  type: string
                  description: 'Data da expiração do imóvel.'
                  example: '2024-03-20'
                  nullable: false
                active:
                  type: boolean
                  description: 'Imóvel Ativo.'
                  example: true
                  nullable: false
                import_id:
                  type: string
                  description: 'Referência do sistema externo.'
                  example: CA001
                  nullable: false
                principal_media:
                  type: string
                  description: 'Mídia principal.'
                  example: 'https://...'
                  nullable: false
                purpose_featured:
                  type: string
                  description: 'Finalidade em destaque.'
                  example: rent
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem do imóvel.'
                  example: 1
                  nullable: false
                occupancy:
                  type: string
                  description: 'Ocupação do imóvel.'
                  example: vacant
                  nullable: false
                garage_min:
                  type: integer
                  description: 'Quantidade mínima de garagens.'
                  example: 1
                  nullable: false
                garage_max:
                  type: integer
                  description: 'Quantidade máxima de garagens.'
                  example: 1
                  nullable: false
                garage_number:
                  type: integer
                  description: 'Número da Vaga.'
                  example: 123
                  nullable: false
                suite_min:
                  type: integer
                  description: 'Quantidade mínima de Suítes.'
                  example: 1
                  nullable: false
                suite_max:
                  type: integer
                  description: 'Quantidade máxima de Suítes.'
                  example: 1
                  nullable: false
                room_min:
                  type: integer
                  description: 'Quantidade mínima de Salas.'
                  example: 1
                  nullable: false
                room_max:
                  type: integer
                  description: 'Quantidade máxima de Salas.'
                  example: 2
                  nullable: false
                bathroom_min:
                  type: integer
                  description: 'Quantidade mínima de Banheiros.'
                  example: 1
                  nullable: false
                bathroom_max:
                  type: integer
                  description: 'Quantidade máxima de Banheiros.'
                  example: 3
                  nullable: false
                bedroom_min:
                  type: integer
                  description: 'Quantidade mínima de Quartos.'
                  example: 3
                  nullable: false
                bedroom_max:
                  type: integer
                  description: 'Quantidade máxima de Quartos.'
                  example: 3
                  nullable: false
                conservation:
                  type: string
                  description: 'Conservação do imóvel.'
                  example: 'Bem conservado'
                  nullable: false
                built_year:
                  type: integer
                  description: 'Ano de construção.'
                  example: 2000
                  nullable: false
                floor:
                  type: integer
                  description: 'Andar do imóvel.'
                  example: 2
                  nullable: false
                total_floors:
                  type: integer
                  description: 'Quantidade de Andares.'
                  example: 4
                  nullable: false
                total_by_floors:
                  type: integer
                  description: 'Apartamentos por Andar.'
                  example: 2
                  nullable: false
                blocks:
                  type: integer
                  description: 'Quantidade de Blocos do condomínio.'
                  example: 2
                  nullable: false
                accommodates:
                  type: integer
                  description: 'Quantidade de Pessoas que acomoda.'
                  example: 5
                  nullable: false
                furnishing:
                  type: string
                  description: 'Status da mobília.'
                  example: furnished
                  nullable: false
                title:
                  type: string
                  description: 'Titulo do imóvel.'
                  example: 'Título Exemplar'
                  nullable: false
                plate:
                  type: string
                  description: 'Status da placa.'
                  example: without
                  nullable: false
                content:
                  type: string
                  description: 'HTML de Descrição do imóvel.'
                  example: '<p>Imóvel de Exemplo!</p>'
                  nullable: false
                lock_description:
                  type: string
                  description: 'Observações do bloqueio.'
                  example: 'Fim da Locação'
                  nullable: false
                area_total_min:
                  type: numeric
                  description: 'Área total mínima.'
                  example: '123'
                  nullable: false
                area_total_max:
                  type: numeric
                  description: 'Área total máxima.'
                  example: '321'
                  nullable: false
                area_private_min:
                  type: numeric
                  description: 'Área privada mínima.'
                  example: '123'
                  nullable: false
                area_private_max:
                  type: numeric
                  description: 'Área privada máxima.'
                  example: '321'
                  nullable: false
                area_useful_min:
                  type: numeric
                  description: 'Área útil mínima.'
                  example: '123'
                  nullable: false
                area_useful_max:
                  type: numeric
                  description: 'Área útil máxima.'
                  example: '321'
                  nullable: false
                area_ground:
                  type: numeric
                  description: 'Área do terreno.'
                  example: '12'
                  nullable: false
                area_front:
                  type: numeric
                  description: 'Frente do imóvel.'
                  example: '21'
                  nullable: false
                area_length:
                  type: numeric
                  description: 'Comprimento do imóvel.'
                  example: '132'
                  nullable: false
                area_back:
                  type: numeric
                  description: 'Fundos do imóvel.'
                  example: '123'
                  nullable: false
                street:
                  type: string
                  description: 'Rua do imóvel.'
                  example: 'Rua Guanabara'
                  nullable: false
                number:
                  type: integer
                  description: 'número do imóvel.'
                  example: 1
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento do imóvel.'
                  example: Apartamento
                  nullable: false
                reference_point:
                  type: string
                  description: 'Ponto de referência.'
                  example: 'Bar do Seu Zé'
                  nullable: false
                building_name:
                  type: string
                  description: 'Nome do empreendimento.'
                  example: 'Guanabara Prime'
                  nullable: false
                zip_code:
                  type: integer
                  description: 'CEP do imóvel.'
                  example: 89160000
                  nullable: false
                amount_updated_at:
                  type: Date
                  description: 'Data de Atualização dos valores.'
                  example: '2024-01-01'
                  nullable: false
                delivery_date:
                  type: Date
                  description: 'Data de entrega.'
                  example: '2024-05-01'
                  nullable: false
                show_address:
                  type: boolean
                  description: 'Divulga Endereço.'
                  example: true
                  nullable: false
                show_number:
                  type: boolean
                  description: 'Divulga Número.'
                  example: true
                  nullable: false
                show_complement:
                  type: boolean
                  description: 'Divulga Complemento.'
                  example: true
                  nullable: false
                map:
                  type: boolean
                  description: 'Divulga Mapa.'
                  example: false
                  nullable: false
                map_street:
                  type: boolean
                  description: 'Divulga Mapa da Rua.'
                  example: false
                  nullable: 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
                  nullable: false
                iptu_reference:
                  type: string
                  description: 'Inscrição de IPTU.'
                  example: '12321321'
                  nullable: false
                energy_reference:
                  type: string
                  description: 'Matrícula de inscrição de Energia.'
                  example: '12321313'
                  nullable: false
                water_reference:
                  type: string
                  description: 'Matrícula de inscrição de Água.'
                  example: '213213'
                  nullable: false
                gas_reference:
                  type: string
                  description: 'Matrícula de inscrição de gás.'
                  example: 23213213-12
                  nullable: false
                incorporation_reference:
                  type: string
                  description: 'Inscrição de Incorporação.'
                  example: '213213123.223'
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Observações do imóvel'
                  nullable: false
                virtual_tour:
                  type: string
                  description: 'Link do Tour Virtual.'
                  example: 'https://...'
                  nullable: false
                html_title:
                  type: string
                  description: 'Título da página (HTML title).'
                  example: 'SEO Título'
                  nullable: false
                html_keyword:
                  type: string
                  description: 'Palavras Chave (HTML Keyword). Example:'
                  example: nulla
                  nullable: false
                html_description:
                  type: string
                  description: 'descrição SEO.'
                  example: 'SEO,chave'
                  nullable: false
                system_featured:
                  type: boolean
                  description: 'Destaque no Site.'
                  example: true
                  nullable: false
                thirdparty_featured:
                  type: string
                  description: 'Destaque nos Portais.'
                  example: disabled
                  nullable: false
                uses_calendar:
                  type: string
                  description: 'Uso do calendário.'
                  example: disabled
                  nullable: false
                watermark:
                  type: boolean
                  description: "Usa Marca d'água."
                  example: true
                  nullable: false
                exclusivity:
                  type: boolean
                  description: Exclusividade.
                  example: false
                  nullable: false
                head_code:
                  type: string
                  description: 'Códigos para Plugins Específicos dentro da tag Head.'
                  example: 'function example(foo,bar){...}'
                  nullable: false
                status_bar:
                  type: boolean
                  description: 'Barra de Status ativa.'
                  example: false
                  nullable: false
                status_bar_content:
                  type: string
                  description: 'Conteúdo da Barra de Status.'
                  example: 'Sem conteúdo'
                  nullable: false
                status_bar_color:
                  type: string
                  description: 'Cor da Barra de Status.'
                  example: ff00fa
                  nullable: false
                owner_report:
                  type: boolean
                  description: 'Notificação para o Proprietário.'
                  example: true
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Imóveis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Imóveis
    parameters:
      -
        in: path
        name: id
        description: 'ID do Imóvel'
        example: 4
        required: true
        schema:
          type: integer
  '/persons/leads/convert/{id}':
    post:
      summary: 'Converter Lead para Negócio'
      operationId: converterLeadParaNegcio
      description: '<aside>🔒 Para acessar essa rota são necessárias as permissões de Cadastro de Pessoas e de Negócios</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                funnel_step_id:
                  type: integer
                  description: 'ID da Etapa de Funil'
                  example: 16
                  nullable: false
                user:
                  type: integer
                  description: 'Código do usuário responsável pelo Negócio'
                  example: 16
                  nullable: false
                notes:
                  type: string
                  description: 'Histórico adicionado no negócio'
                  example: vitae
                  nullable: false
              required:
                - funnel_step_id
                - user
    parameters:
      -
        in: path
        name: id
        description: 'ID do lead'
        example: 1
        required: true
        schema:
          type: integer
  /persons/leads:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Lead</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Filtra por código'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Filtra por código'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Filtra por nome'
          example: '%exemplo%'
          required: false
          schema:
            type: string
            description: 'Filtra por nome'
            example: '%exemplo%'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[phone]'
          description: 'Filtra por telefone'
          example: '999999999'
          required: false
          schema:
            type: string
            description: 'Filtra por telefone'
            example: '999999999'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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%'
            nullable: false
        -
          in: query
          name: 'filter[message]'
          description: 'Filtra por mensagem'
          example: 'Tenho interesse%'
          required: false
          schema:
            type: string
            description: 'Filtra por mensagem'
            example: 'Tenho interesse%'
            nullable: false
        -
          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%'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Leads</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Lead.'
                  example: 'Nome do Lead'
                  nullable: false
                email:
                  type: string
                  description: 'E-mail do Lead.'
                  example: teste@gmail.com
                  nullable: false
                phone:
                  type: integer
                  description: 'Telefone do Lead.'
                  example: 47988888888
                  nullable: false
                purpose:
                  type: string
                  description: 'Finalidade do Lead, podendo ser: change, rent, sale, season.'
                  example: sale
                  nullable: false
                building_id:
                  type: integer
                  description: 'Imóvel que originou o Lead.'
                  example: 321123
                  nullable: false
                deal_id:
                  type: integer
                  description: 'Negociação relacionada ao Lead.'
                  example: 321123
                  nullable: false
                origin_id:
                  type: integer
                  description: 'ID da Origem.'
                  example: 1
                  nullable: false
                origin:
                  type: string
                  description: 'Origem do lead, caso não saiba o ID.'
                  example: Site
                  nullable: false
                message:
                  type: string
                  description: Mensagem.
                  example: 'Olá de chamo exemplo que gostaria de um....'
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Cliente quer imóvel no bairro...'
                  nullable: false
                ads_campaign:
                  type: string
                  description: 'ID de campanha ADS'
                  example: Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
                  nullable: false
                ad_name:
                  type: string
                  description: 'Nome do anúncio.'
                  example: 'Nome Teste'
                  nullable: false
                adset_name:
                  type: string
                  description: 'Nome do conjunto de anúncio.'
                  example: 'Conjunto Teste'
                  nullable: false
                notifyUsers:
                  type: boolean
                  description: 'Define se deve notificar usuários'
                  example: false
                  nullable: false
                fields:
                  type: json
                  description: 'Campos Extras'
                  example: "{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}"
                  nullable: false
              required:
                - name
  '/persons/leads/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Lead</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Leads</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Lead.'
                  example: 'Nome do Lead'
                  nullable: false
                email:
                  type: string
                  description: 'E-mail do Lead.'
                  example: teste@gmail.com
                  nullable: false
                phone:
                  type: integer
                  description: 'Telefone do Lead.'
                  example: 47988888888
                  nullable: false
                purpose:
                  type: string
                  description: 'Finalidade do Lead, podendo ser: change, rent, sale, season.'
                  example: sale
                  nullable: false
                building_id:
                  type: integer
                  description: 'Imóvel que originou o Lead.'
                  example: 321123
                  nullable: false
                deal_id:
                  type: integer
                  description: 'Negociação relacionada ao Lead.'
                  example: 321123
                  nullable: false
                origin_id:
                  type: integer
                  description: 'ID da Origem.'
                  example: 1
                  nullable: false
                origin:
                  type: string
                  description: 'Origem do lead, caso não saiba o ID.'
                  example: Site
                  nullable: false
                message:
                  type: string
                  description: Mensagem.
                  example: 'Olá de chamo exemplo que gostaria de um....'
                  nullable: false
                notes:
                  type: string
                  description: Observações
                  example: 'Cliente quer imóvel no bairro...'
                  nullable: false
                ads_campaign:
                  type: string
                  description: 'ID de campanha ADS'
                  example: Cj0KCQiA4L2BBhCvARIsAO0SBdZrTYfubPvY61Syyf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
                  nullable: false
                ad_name:
                  type: string
                  description: 'Nome do anúncio.'
                  example: 'Nome Teste'
                  nullable: false
                adset_name:
                  type: string
                  description: 'Nome do conjunto de anúncio.'
                  example: 'Conjunto Teste'
                  nullable: false
                notifyUsers:
                  type: boolean
                  description: 'Define se deve notificar usuários'
                  example: false
                  nullable: false
                fields:
                  type: json
                  description: 'Campos Extras'
                  example: "{'variavelCampo':{'value': 'valor do campo', 'description': 'nomeCampo', 'value_description': 'descricao do valor'}}"
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Leads</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Leads
    parameters:
      -
        in: path
        name: id
        description: 'ID do lead'
        example: 4
        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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do País.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do País.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome do País.'
          example: Brasil
          required: false
          schema:
            type: string
            description: 'Nome do País.'
            example: Brasil
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do País.'
                  example: Brasil
                  nullable: false
                abbreviation:
                  type: required
                  description: 'string Código ISO do País.'
                  example: BR
                  nullable: false
              required:
                - name
  '/dependency/locale/country/{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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do País.'
                  example: Brasil
                  nullable: false
                abbreviation:
                  type: string
                  description: 'Código ISO do País.'
                  example: BR
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    parameters:
      -
        in: path
        name: id
        description: 'ID do País'
        example: 1
        required: true
        schema:
          type: integer
  /dependency/locale/state:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Código do estado.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Código do estado.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome do estado.'
          example: 'Santa Catarina'
          required: false
          schema:
            type: string
            description: 'Nome do estado.'
            example: 'Santa Catarina'
            nullable: false
        -
          in: query
          name: 'filter[abbreviation]'
          description: 'Sigla do Estado.'
          example: SC
          required: false
          schema:
            type: string
            description: 'Sigla do Estado.'
            example: SC
            nullable: false
        -
          in: query
          name: 'filter[country_id]'
          description: 'ID do país.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID do país.'
            example: 123
            nullable: false
        -
          in: query
          name: 'include[cities]'
          description: 'Retorna as cidades do estado.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna as cidades do estado.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[country]'
          description: 'Retorna os dados do país.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do país.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis do estado.'
          example: 'id,title,slug'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis do estado.'
            example: 'id,title,slug'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Estado.'
                  example: 'Santa Catarina'
                  nullable: false
                abbreviation:
                  type: string
                  description: 'Sigla do Estado'
                  example: SC
                  nullable: false
                country_id:
                  type: integer
                  description: 'País do Estado'
                  example: 123
                  nullable: false
              required:
                - name
                - abbreviation
                - country_id
  '/dependency/locale/state/{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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[cities]'
          description: 'Retorna as cidades do estado.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna as cidades do estado.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[country]'
          description: 'Retorna os dados do país.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os dados do país.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis do estado.'
          example: 'id,title,slug'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis do estado.'
            example: 'id,title,slug'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Estado.'
                  example: 'Santa Catarina'
                  nullable: false
                abbreviation:
                  type: string
                  description: 'Sigla do Estado'
                  example: SC
                  nullable: false
                country_id:
                  type: integer
                  description: 'País do Estado'
                  example: 123
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    parameters:
      -
        in: path
        name: id
        description: 'Id do Estado'
        example: 12
        required: true
        schema:
          type: integer
  /dependency/locale/city:
    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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,state_id'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,state_id'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da cidade.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID da cidade.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome da cidade.'
          example: 'Rio do Sul'
          required: false
          schema:
            type: string
            description: 'Nome da cidade.'
            example: 'Rio do Sul'
            nullable: false
        -
          in: query
          name: 'filter[zip_code]'
          description: 'CEP da cidade.'
          example: '89160000'
          required: false
          schema:
            type: string
            description: 'CEP da cidade.'
            example: '89160000'
            nullable: false
        -
          in: query
          name: 'filter[ibge]'
          description: 'IBGE da cidade.'
          example: '1200013'
          required: false
          schema:
            type: string
            description: 'IBGE da cidade.'
            example: '1200013'
            nullable: false
        -
          in: query
          name: 'filter[state_id]'
          description: 'Código do Estado.'
          example: 321
          required: false
          schema:
            type: integer
            description: 'Código do Estado.'
            example: 321
            nullable: false
        -
          in: query
          name: 'include[districs]'
          description: 'Retorna os bairros da cidade.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os bairros da cidade.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[state]'
          description: 'Retorna o estado da cidade.'
          example: abbreviation
          required: false
          schema:
            type: string
            description: 'Retorna o estado da cidade.'
            example: abbreviation
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis da cidade.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis da cidade.'
            example: 'id,title'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da Cidade.'
                  example: 'Santa Catarina'
                  nullable: false
                state_id:
                  type: integer
                  description: 'Estado da Cidade.'
                  example: 1
                  nullable: false
                zip_code:
                  type: string
                  description: 'CEP da Cidade.'
                  example: '89160000'
                  nullable: false
                ibge:
                  type: string
                  description: 'IBGE da Cidade.'
                  example: '1200013'
                  nullable: false
              required:
                - name
                - state_id
  '/dependency/locale/city/{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
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,state_id'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,state_id'
            nullable: false
        -
          in: query
          name: 'include[districs]'
          description: 'Retorna os bairros da cidade.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os bairros da cidade.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[state]'
          description: 'Retorna o estado da cidade.'
          example: abbreviation
          required: false
          schema:
            type: string
            description: 'Retorna o estado da cidade.'
            example: abbreviation
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis da cidade.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis da cidade.'
            example: 'id,title'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da Cidade.'
                  example: 'Santa Catarina'
                  nullable: false
                state_id:
                  type: integer
                  description: 'Estado da Cidade.'
                  example: 1
                  nullable: false
                zip_code:
                  type: string
                  description: 'CEP da Cidade.'
                  example: '89160000'
                  nullable: false
                ibge:
                  type: string
                  description: 'IBGE da Cidade.'
                  example: '1200013'
                  nullable: false
              required:
                - name
                - state_id
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    parameters:
      -
        in: path
        name: id
        description: 'Id da Cidade'
        example: 11
        required: true
        schema:
          type: integer
  /dependency/locale/district:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'Código do bairro.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'Código do bairro.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome do bairro.'
          example: Centro
          required: false
          schema:
            type: string
            description: 'Nome do bairro.'
            example: Centro
            nullable: false
        -
          in: query
          name: 'filter[city_id]'
          description: 'Cidade do bairro.'
          example: 1321
          required: false
          schema:
            type: integer
            description: 'Cidade do bairro.'
            example: 1321
            nullable: false
        -
          in: query
          name: 'include[city]'
          description: 'Retorna a cidade do bairro.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a cidade do bairro.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[state]'
          description: 'Retorna o estado do bairro.'
          example: 'id,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna o estado do bairro.'
            example: 'id,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis do bairro.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis do bairro.'
            example: 'id,title'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Bairro'
                  example: Centro
                  nullable: false
                city_id:
                  type: integer
                  description: 'Códido da cidade.'
                  example: 1233
                  nullable: false
              required:
                - name
                - city_id
  '/dependency/locale/district/{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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[city]'
          description: 'Retorna a cidade do bairro.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna a cidade do bairro.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[state]'
          description: 'Retorna o estado do bairro.'
          example: 'id,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna o estado do bairro.'
            example: 'id,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis do bairro.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis do bairro.'
            example: 'id,title'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome do Bairro'
                  example: Centro
                  nullable: false
                city_id:
                  type: integer
                  description: Códido
                  example: 14
                  nullable: false
              required:
                - name
                - city_id
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Localizações
    parameters:
      -
        in: path
        name: id
        description: 'Id do Bairro'
        example: 1
        required: true
        schema:
          type: integer
  /deals/funnels/steps:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Etapas</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[title]'
          description: 'Título da Etapa.'
          example: Interesse
          required: false
          schema:
            type: string
            description: 'Título da Etapa.'
            example: Interesse
            nullable: false
        -
          in: query
          name: 'filter[funnel_id]'
          description: 'Funil da Etapa.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'Funil da Etapa.'
            example: 12
            nullable: false
        -
          in: query
          name: 'filter[position]'
          description: 'Posição da Etapa.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Posição da Etapa.'
            example: 2
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[deadline]'
          description: 'Prazo para Repasse (dias).'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Prazo para Repasse (dias).'
            example: 10
            nullable: false
        -
          in: query
          name: 'filter[color]'
          description: 'Cor da Etapa.'
          example: FF00FA
          required: false
          schema:
            type: string
            description: 'Cor da Etapa.'
            example: FF00FA
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Etapa Ativa.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Etapa Ativa.'
            example: true
            nullable: false
        -
          in: query
          name: 'include[funnel]'
          description: 'Retorna o funil.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna o funil.'
            example: 'id,title'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Etapas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título da Etapa.'
                  example: Interesse
                  nullable: false
                funnel_id:
                  type: integer
                  description: 'Funil da Etapa.'
                  example: 12
                  nullable: false
                position:
                  type: integer
                  description: 'Posição da Etapa.'
                  example: 2
                  nullable: false
                notes:
                  type: string
                  description: 'Descrição da Etapa.'
                  example: 'Etapa para interessados'
                  nullable: false
                deadline:
                  type: integer
                  description: 'Prazo para Repasse (dias).'
                  example: 10
                  nullable: false
                color:
                  type: string
                  description: 'Cor da Etapa.'
                  example: FF00FA
                  nullable: false
                active:
                  type: boolean
                  description: 'Etapa Ativa.'
                  example: true
                  nullable: false
  '/deals/funnels/steps/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Etapa</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[funnel]'
          description: 'Retorna o funil.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna o funil.'
            example: 'id,title'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Etapas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título da Etapa.'
                  example: Interesse
                  nullable: false
                funnel_id:
                  type: integer
                  description: 'Funil da Etapa.'
                  example: 12
                  nullable: false
                position:
                  type: integer
                  description: 'Posição da Etapa.'
                  example: 2
                  nullable: false
                notes:
                  type: string
                  description: 'Descrição da Etapa.'
                  example: 'Etapa para interessados'
                  nullable: false
                deadline:
                  type: integer
                  description: 'Prazo para Repasse (dias).'
                  example: 10
                  nullable: false
                color:
                  type: string
                  description: 'Cor da Etapa.'
                  example: FF00FA
                  nullable: false
                active:
                  type: boolean
                  description: 'Etapa Ativa.'
                  example: true
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Etapas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    parameters:
      -
        in: path
        name: id
        description: 'ID da Etapa'
        example: 8
        required: true
        schema:
          type: integer
  /deals/funnels:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de cadastro de Funis</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do Funil.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do Funil.'
            example: 1
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[notes]'
          description: 'Descrição do Funil'
          example: modi
          required: false
          schema:
            type: string
            description: 'Descrição do Funil'
            example: modi
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Funil Ativo.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Funil Ativo.'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: 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
            nullable: false
        -
          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
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Funis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título do Funil.'
                  example: 'Funil de Vendas'
                  nullable: false
                notes:
                  type: string
                  description: 'Descrição do Funil'
                  example: sed
                  nullable: false
                active:
                  type: boolean
                  description: 'Funil Ativo.'
                  example: true
                  nullable: false
                skip:
                  type: boolean
                  description: 'Transferir para o próximo corretor.'
                  example: true
                  nullable: false
                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
                  nullable: false
                step_id_peal:
                  type: integer
                  description: 'Transferir para a etapa do Funil.'
                  example: 1
                  nullable: false
                block_step_jump:
                  type: boolean
                  description: 'Bloquear pulo de etapa.'
                  example: false
                  nullable: false
              required:
                - title
                - responsible
  '/deals/funnels/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Funis</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Funis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Título do Funil.'
                  example: 'Funil de Vendas'
                  nullable: false
                notes:
                  type: string
                  description: 'Descrição do Funil'
                  example: corporis
                  nullable: false
                active:
                  type: boolean
                  description: 'Funil Ativo.'
                  example: true
                  nullable: false
                skip:
                  type: boolean
                  description: 'Transferir para o próximo corretor.'
                  example: true
                  nullable: false
                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
                  nullable: false
                step_id_peal:
                  type: integer
                  description: 'Transferir para a etapa do Funil.'
                  example: 1
                  nullable: false
                block_step_jump:
                  type: boolean
                  description: 'Bloquear pulo de etapa.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Funis</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    parameters:
      -
        in: path
        name: id
        description: 'ID do Funil'
        example: 7
        required: true
        schema:
          type: integer
  '/deals/confirm/{id}':
    post:
      summary: Confirmar/Rejeitar
      operationId: confirmarRejeitar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: boolean
                  description: 'Confirma ou Rejeita'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: id
        description: 'ID do Negócio'
        example: 12
        required: true
        schema:
          type: integer
  '/deals/acceptLeadCenter/{id}':
    post:
      summary: 'Aceitar/Negar Lead do Bolsão de Leads'
      operationId: aceitarNegarLeadDoBolsoDeLeads
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: boolean
                  description: 'Confirma ou Rejeita'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: id
        description: 'ID do Negócio'
        example: 12
        required: true
        schema:
          type: integer
  /deals:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Negócios</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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.'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[status]'
          description: 'Status do Negócio.'
          example: won
          required: false
          schema:
            type: string
            description: 'Status do Negócio.'
            example: won
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[private]'
          description: 'Visibilidade do Negócio.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Visibilidade do Negócio.'
            example: false
            nullable: 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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags do negócio'
          example: ut
          required: false
          schema:
            type: string
            description: 'Retorna as tags do negócio'
            example: ut
            nullable: false
        -
          in: query
          name: 'include[notifications]'
          description: 'Retorna as notificações do negócio'
          example: voluptates
          required: false
          schema:
            type: string
            description: 'Retorna as notificações do negócio'
            example: voluptates
            nullable: false
        -
          in: query
          name: 'include[contracts]'
          description: 'Retorna os contratos vinculados ao negócio'
          example: repudiandae
          required: false
          schema:
            type: string
            description: 'Retorna os contratos vinculados ao negócio'
            example: repudiandae
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis vinculados ao negócio'
          example: minus
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis vinculados ao negócio'
            example: minus
            nullable: false
        -
          in: query
          name: 'include[responsibles]'
          description: 'Retorna os responsáveis do negócio'
          example: quo
          required: false
          schema:
            type: string
            description: 'Retorna os responsáveis do negócio'
            example: quo
            nullable: false
        -
          in: query
          name: 'include[creator]'
          description: 'Retorna o criador do negócio'
          example: sint
          required: false
          schema:
            type: string
            description: 'Retorna o criador do negócio'
            example: sint
            nullable: false
        -
          in: query
          name: 'include[customer]'
          description: 'Retorna o cliente do negócio'
          example: quia
          required: false
          schema:
            type: string
            description: 'Retorna o cliente do negócio'
            example: quia
            nullable: false
        -
          in: query
          name: 'include[proposals]'
          description: 'Retorna as propostas do negócio'
          example: perspiciatis
          required: false
          schema:
            type: string
            description: 'Retorna as propostas do negócio'
            example: perspiciatis
            nullable: false
        -
          in: query
          name: 'include[activeProposals]'
          description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
          example: asperiores
          required: false
          schema:
            type: string
            description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
            example: asperiores
            nullable: false
        -
          in: query
          name: 'include[leads]'
          description: 'Retorna os leads do negócio'
          example: aut
          required: false
          schema:
            type: string
            description: 'Retorna os leads do negócio'
            example: aut
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Negócio</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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.'
                  nullable: false
                step_id:
                  type: integer
                  description: 'Etapa do Negócio.'
                  example: 1
                  nullable: false
                step_date:
                  type: date
                  description: 'Data da Etapa do Negócio.'
                  example: '2022-08-31 00:00:00'
                  nullable: false
                status:
                  type: string
                  description: 'Status do Negócio.'
                  example: won
                  nullable: false
                status_date:
                  type: date
                  description: 'Date do Status do Negócio.'
                  example: '2022-12-06 10:17:16'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo do Negócio (Radar).'
                  example: sale
                  nullable: false
                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
                  nullable: false
                origin_id:
                  type: integer
                  description: 'Origem do Negócio.'
                  example: 9
                  nullable: false
                created_by:
                  type: integer
                  description: 'Criado por.'
                  example: 12
                  nullable: false
                price:
                  type: string
                  description: 'Valor do Negócio.'
                  example: '1500.00'
                  nullable: false
                date:
                  type: date
                  description: 'Data do Negócio.'
                  example: '2020-04-30'
                  nullable: false
                forecast:
                  type: date
                  description: 'Data da previsão de finalização do Negócio.'
                  example: '2020-05-30'
                  nullable: false
                potential:
                  type: string
                  description: 'Potencial do Negócio. Options: cold, hot, scalding, warm.'
                  example: hot
                  nullable: false
                radar:
                  type: boolean
                  description: 'Radar Ativo para o Negócio.'
                  example: false
                  nullable: false
                private:
                  type: boolean
                  description: 'Visibilidade do Negócio.'
                  example: true
                  nullable: false
                position:
                  type: integer
                  description: 'Posição do negócio (Kanban).'
                  example: 3
                  nullable: false
                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'
                  nullable: false
                reason_id:
                  type: integer
                  description: 'Motivo do Negócio quando o status é alterado.'
                  example: 1
                  nullable: false
                reason_notes:
                  type: string
                  description: 'Observações do motivo quando o status do Negócio é alterado.'
                  example: 'Cliente ganho'
                  nullable: false
                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'
                  nullable: false
                building_price_max:
                  type: string
                  description: 'Valor máximo dos Imóveis do Negócio (Radar).'
                  example: '2500.00'
                  nullable: false
                building_bedroom:
                  type: integer
                  description: 'Quantidade de quartos para o Radar de Negócio.'
                  example: 2
                  nullable: false
                building_living_room:
                  type: integer
                  description: 'Quantidade de salas para o Radar de Negócio.'
                  example: 1
                  nullable: false
                building_parking:
                  type: integer
                  description: 'Quantidade de vagas de estacionamento para o Radar de Negócio.'
                  example: 1
                  nullable: false
                building_bathroom:
                  type: integer
                  description: 'Quantidade de banheiros para o Radar de Negócio.'
                  example: 3
                  nullable: false
                building_area:
                  type: integer
                  description: 'Área em metros quadrados para o Radar de Negócio.'
                  example: 120
                  nullable: false
                building_district:
                  type: string
                  description: 'Bairro para o Radar de Negócio.'
                  example: '1'
                  nullable: false
                building_city:
                  type: string
                  description: 'Cidade para o Radar de Negócio.'
                  example: '3'
                  nullable: false
                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'
                  nullable: false
                building_check_out:
                  type: date
                  description: 'Check-out do Imóvel para o Radar de Negócio.'
                  example: '2022-02-21'
                  nullable: false
                building_accommodation:
                  type: integer
                  description: 'Quantidade de acomodações do Imóvel para o Radar de Negócio.'
                  example: 4
                  nullable: false
              required:
                - title
                - step_id
                - responsible
                - customer_id
                - created_by
  '/deals/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Negócios</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as tags do negócio'
          example: repellat
          required: false
          schema:
            type: string
            description: 'Retorna as tags do negócio'
            example: repellat
            nullable: false
        -
          in: query
          name: 'include[notifications]'
          description: 'Retorna as notificações do negócio'
          example: id
          required: false
          schema:
            type: string
            description: 'Retorna as notificações do negócio'
            example: id
            nullable: false
        -
          in: query
          name: 'include[contracts]'
          description: 'Retorna os contratos vinculados ao negócio'
          example: assumenda
          required: false
          schema:
            type: string
            description: 'Retorna os contratos vinculados ao negócio'
            example: assumenda
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os imóveis vinculados ao negócio'
          example: vel
          required: false
          schema:
            type: string
            description: 'Retorna os imóveis vinculados ao negócio'
            example: vel
            nullable: false
        -
          in: query
          name: 'include[responsibles]'
          description: 'Retorna os responsáveis do negócio'
          example: optio
          required: false
          schema:
            type: string
            description: 'Retorna os responsáveis do negócio'
            example: optio
            nullable: false
        -
          in: query
          name: 'include[creator]'
          description: 'Retorna o criador do negócio'
          example: est
          required: false
          schema:
            type: string
            description: 'Retorna o criador do negócio'
            example: est
            nullable: false
        -
          in: query
          name: 'include[customer]'
          description: 'Retorna o cliente do negócio'
          example: similique
          required: false
          schema:
            type: string
            description: 'Retorna o cliente do negócio'
            example: similique
            nullable: false
        -
          in: query
          name: 'include[proposals]'
          description: 'Retorna as propostas do negócio'
          example: voluptate
          required: false
          schema:
            type: string
            description: 'Retorna as propostas do negócio'
            example: voluptate
            nullable: false
        -
          in: query
          name: 'include[activeProposals]'
          description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
          example: excepturi
          required: false
          schema:
            type: string
            description: 'Retorna as propostas (pendentes ou aceitas) do negócio.'
            example: excepturi
            nullable: false
        -
          in: query
          name: 'include[leads]'
          description: 'Retorna os leads do negócio'
          example: eum
          required: false
          schema:
            type: string
            description: 'Retorna os leads do negócio'
            example: eum
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: Título.
                  example: 'Título do Negócio.'
                  nullable: false
                step_id:
                  type: integer
                  description: 'Etapa do Negócio.'
                  example: 1
                  nullable: false
                step_date:
                  type: date
                  description: 'Data da Etapa do Negócio.'
                  example: '2022-08-31 00:00:00'
                  nullable: false
                status:
                  type: string
                  description: 'Status do Negócio.'
                  example: won
                  nullable: false
                status_date:
                  type: date
                  description: 'Date do Status do Negócio.'
                  example: '2022-12-06 10:17:16'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo do Negócio (Radar).'
                  example: sale
                  nullable: false
                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
                  nullable: false
                origin_id:
                  type: integer
                  description: 'Origem do Negócio.'
                  example: 9
                  nullable: false
                created_by:
                  type: integer
                  description: 'Criado por.'
                  example: 19
                  nullable: false
                price:
                  type: string
                  description: 'Valor do Negócio.'
                  example: '1500.00'
                  nullable: false
                date:
                  type: date
                  description: 'Data do Negócio.'
                  example: '2020-04-30'
                  nullable: false
                forecast:
                  type: date
                  description: 'Data da previsão de finalização do Negócio.'
                  example: '2020-05-30'
                  nullable: false
                potential:
                  type: string
                  description: 'Potencial do Negócio. Options: cold, hot, scalding, warm.'
                  example: hot
                  nullable: false
                radar:
                  type: boolean
                  description: 'Radar Ativo para o Negócio.'
                  example: false
                  nullable: false
                private:
                  type: boolean
                  description: 'Visibilidade do Negócio.'
                  example: false
                  nullable: false
                position:
                  type: integer
                  description: 'Posição do negócio (Kanban).'
                  example: 3
                  nullable: false
                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'
                  nullable: false
                reason_id:
                  type: integer
                  description: 'Motivo do Negócio quando o status é alterado.'
                  example: 1
                  nullable: false
                reason_notes:
                  type: string
                  description: 'Observações do motivo quando o status do Negócio é alterado.'
                  example: 'Cliente ganho'
                  nullable: false
                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'
                  nullable: false
                building_price_max:
                  type: string
                  description: 'Valor máximo dos Imóveis do Negócio (Radar).'
                  example: '2500.00'
                  nullable: false
                building_bedroom:
                  type: integer
                  description: 'Quantidade de quartos para o Radar de Negócio.'
                  example: 2
                  nullable: false
                building_living_room:
                  type: integer
                  description: 'Quantidade de salas para o Radar de Negócio.'
                  example: 1
                  nullable: false
                building_parking:
                  type: integer
                  description: 'Quantidade de vagas de estacionamento para o Radar de Negócio.'
                  example: 1
                  nullable: false
                building_bathroom:
                  type: integer
                  description: 'Quantidade de banheiros para o Radar de Negócio.'
                  example: 3
                  nullable: false
                building_area:
                  type: integer
                  description: 'Área em metros quadrados para o Radar de Negócio.'
                  example: 120
                  nullable: false
                building_district:
                  type: string
                  description: 'Bairro para o Radar de Negócio.'
                  example: '1'
                  nullable: false
                building_city:
                  type: string
                  description: 'Cidade para o Radar de Negócio.'
                  example: '3'
                  nullable: false
                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'
                  nullable: false
                building_check_out:
                  type: date
                  description: 'Check-out do Imóvel para o Radar de Negócio.'
                  example: '2022-02-21'
                  nullable: false
                building_accommodation:
                  type: integer
                  description: 'Quantidade de acomodações do Imóvel para o Radar de Negócio.'
                  example: 4
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Negócios</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Negócios
    parameters:
      -
        in: path
        name: id
        description: 'ID do Negócio'
        example: 7
        required: true
        schema:
          type: integer
  '/deals/{deal_id}/duplicate':
    put:
      summary: Duplicar
      operationId: duplicar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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: false
                  nullable: false
                season_packs:
                  type: boolean
                  description: 'Define se duplica os documentos do Negócio'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: deal_id
        description: 'ID do Negócio'
        example: 8
        required: true
        schema:
          type: integer
  '/persons/approve/{person_id}':
    put:
      summary: Aprovar
      operationId: aprovar
      description: '<aside>🔒 Para acessar essa rota são necessárias as permissões de Aprovar Pessoas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                check:
                  type: boolean
                  description: 'Aprovar cadastro da pessoa.'
                  example: true
                  nullable: false
                merge:
                  type: boolean
                  description: 'Indica se deve unificar os dados da pessoa.'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: person_id
        description: 'ID da pessoa'
        example: 16
        required: true
        schema:
          type: integer
  /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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da profissão.'
          example: '123'
          required: false
          schema:
            type: string
            description: 'ID da profissão.'
            example: '123'
            nullable: false
        -
          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%'
            nullable: false
        -
          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%'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
  '/persons/occupations/{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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    parameters:
      -
        in: path
        name: id
        description: 'ID da Profissão'
        example: 5
        required: true
        schema:
          type: integer
  '/persons/{person_id}/contacts':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contato</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do contato.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do contato.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: Pessoa.
          example: 123
          required: false
          schema:
            type: integer
            description: Pessoa.
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[country_id]'
          description: País.
          example: 1
          required: false
          schema:
            type: integer
            description: País.
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[state_id]'
          description: Estado.
          example: 24
          required: false
          schema:
            type: integer
            description: Estado.
            example: 24
            nullable: false
        -
          in: query
          name: 'filter[city_id]'
          description: Cidade.
          example: 3
          required: false
          schema:
            type: integer
            description: Cidade.
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[district_id]'
          description: Bairro.
          example: 12
          required: false
          schema:
            type: integer
            description: Bairro.
            example: 12
            nullable: false
        -
          in: query
          name: 'filter[zip_code]'
          description: CEP.
          example: 89160000
          required: false
          schema:
            type: integer
            description: CEP.
            example: 89160000
            nullable: false
        -
          in: query
          name: 'filter[street]'
          description: Rua.
          example: '%Rua México%'
          required: false
          schema:
            type: string
            description: Rua.
            example: '%Rua México%'
            nullable: false
        -
          in: query
          name: 'filter[number]'
          description: Número.
          example: '1090'
          required: false
          schema:
            type: string
            description: Número.
            example: '1090'
            nullable: false
        -
          in: query
          name: 'filter[complement]'
          description: 'Complemento de endereço.'
          example: Casa
          required: false
          schema:
            type: string
            description: 'Complemento de endereço.'
            example: Casa
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: Marcelo
          required: false
          schema:
            type: string
            description: Descrição.
            example: Marcelo
            nullable: false
        -
          in: query
          name: 'filter[cellphone]'
          description: Celular.
          example: '47988888888'
          required: false
          schema:
            type: string
            description: Celular.
            example: '47988888888'
            nullable: false
        -
          in: query
          name: 'filter[phone]'
          description: Telefone.
          example: '4735310000'
          required: false
          schema:
            type: string
            description: Telefone.
            example: '4735310000'
            nullable: false
        -
          in: query
          name: 'filter[email]'
          description: E-mail.
          example: mail@example.com
          required: false
          schema:
            type: string
            description: E-mail.
            example: mail@example.com
            nullable: false
        -
          in: query
          name: 'filter[principal]'
          description: 'Contato Principal.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Contato Principal.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[financial]'
          description: 'Contato Financeiro.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Contato Financeiro.'
            example: false
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Contato</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                person_id:
                  type: integer
                  description: 'ID da Pessoa.'
                  example: 123
                  nullable: false
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do Estado.'
                  example: 24
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID do Cidade.'
                  example: 3
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do Bairro.'
                  example: 12
                  nullable: false
                zip_code:
                  type: integer
                  description: CEP.
                  example: 89160000
                  nullable: false
                street:
                  type: string
                  description: Rua.
                  example: '%Rua México%'
                  nullable: false
                number:
                  type: string
                  description: Número.
                  example: '1090'
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento de endereço.'
                  example: Casa
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: Marcelo
                  nullable: false
                cellphone:
                  type: string
                  description: Celular.
                  example: '47988888888'
                  nullable: false
                phone:
                  type: string
                  description: Telefone.
                  example: '4735310000'
                  nullable: false
                email:
                  type: string
                  description: E-mail.
                  example: mail@example.com
                  nullable: false
                principal:
                  type: boolean
                  description: 'Contato Principal.'
                  example: true
                  nullable: false
                financial:
                  type: boolean
                  description: 'Contato Financeiro.'
                  example: false
                  nullable: 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: 20
  '/persons/{person_id}/contacts/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Contato</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Contato</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                country_id:
                  type: integer
                  description: 'ID do País.'
                  example: 1
                  nullable: false
                state_id:
                  type: integer
                  description: 'ID do Estado.'
                  example: 24
                  nullable: false
                city_id:
                  type: integer
                  description: 'ID do Cidade.'
                  example: 3
                  nullable: false
                district_id:
                  type: integer
                  description: 'ID do Bairro.'
                  example: 12
                  nullable: false
                zip_code:
                  type: integer
                  description: CEP.
                  example: 89160000
                  nullable: false
                street:
                  type: string
                  description: Rua.
                  example: '%Rua México%'
                  nullable: false
                number:
                  type: string
                  description: Número.
                  example: '1090'
                  nullable: false
                complement:
                  type: string
                  description: 'Complemento de endereço.'
                  example: Casa
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: Marcelo
                  nullable: false
                cellphone:
                  type: string
                  description: Celular.
                  example: '47988888888'
                  nullable: false
                phone:
                  type: string
                  description: Telefone.
                  example: '4735310000'
                  nullable: false
                email:
                  type: string
                  description: E-mail.
                  example: mail@example.com
                  nullable: false
                principal:
                  type: boolean
                  description: 'Contato Principal.'
                  example: true
                  nullable: false
                financial:
                  type: boolean
                  description: 'Contato Financeiro.'
                  example: false
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Contato</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    parameters:
      -
        in: path
        name: person_id
        description: 'ID da Pessoa'
        example: 15
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'ID do contato'
        example: 7
        required: true
        schema:
          type: integer
  '/persons/{person_id}/bankAccounts':
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoa</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da conta.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'ID da conta.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'ID da Pessoa.'
          example: 321
          required: false
          schema:
            type: integer
            description: 'ID da Pessoa.'
            example: 321
            nullable: false
        -
          in: query
          name: 'filter[description]'
          description: Descrição.
          example: Itaú
          required: false
          schema:
            type: string
            description: Descrição.
            example: Itaú
            nullable: false
        -
          in: query
          name: 'filter[holder]'
          description: 'Nome do titular.'
          example: 'Ciclano Fulano'
          required: false
          schema:
            type: string
            description: 'Nome do titular.'
            example: 'Ciclano Fulano'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[tax_id]'
          description: 'CPF/CNPJ: 99999999999'
          example: 7
          required: false
          schema:
            type: integer
            description: 'CPF/CNPJ: 99999999999'
            example: 7
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: 'Tipo da Conta.'
          example: CC
          required: false
          schema:
            type: string
            description: 'Tipo da Conta.'
            example: CC
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[bank]'
          description: 'Código do Banco.'
          example: 260
          required: false
          schema:
            type: integer
            description: 'Código do Banco.'
            example: 260
            nullable: false
        -
          in: query
          name: 'filter[agency]'
          description: Agência.
          example: '0223'
          required: false
          schema:
            type: string
            description: Agência.
            example: '0223'
            nullable: false
        -
          in: query
          name: 'filter[account]'
          description: Conta.
          example: 2140104-7
          required: false
          schema:
            type: string
            description: Conta.
            example: 2140104-7
            nullable: false
        -
          in: query
          name: 'filter[principal]'
          description: 'Conta principal.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Conta principal.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Status da conta.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Status da conta.'
            example: true
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Cadastro de Pessoa</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                person_id:
                  type: integer
                  description: 'ID da Pessoa.'
                  example: 321
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: Itaú
                  nullable: false
                holder:
                  type: string
                  description: 'Nome do titular.'
                  example: 'Ciclano Fulano'
                  nullable: false
                person_type:
                  type: string
                  description: 'Tipo de Pessoa (física ou jurídica)'
                  example: J
                  nullable: false
                tax_id:
                  type: integer
                  description: 'CPF/CNPJ: 99999999999'
                  example: 9
                  nullable: false
                birth_date:
                  type: date
                  description: 'Data de Nascimento.'
                  example: '1999-06-09'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo da Conta.'
                  example: CC
                  nullable: false
                pix_type:
                  type: string
                  description: 'Tipo da chave PIX.'
                  example: email
                  nullable: false
                pix_key:
                  type: string
                  description: 'Chave PIX.'
                  example: mail@example.com
                  nullable: false
                bank:
                  type: integer
                  description: 'Código do Banco.'
                  example: 260
                  nullable: false
                agency:
                  type: string
                  description: Agência.
                  example: '0223'
                  nullable: false
                account:
                  type: string
                  description: Conta.
                  example: 2140104-7
                  nullable: false
                principal:
                  type: boolean
                  description: 'Conta principal.'
                  example: true
                  nullable: false
                active:
                  type: boolean
                  description: 'Status da conta.'
                  example: true
                  nullable: false
    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: 20
  '/persons/{person_id}/bankAccounts/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoa</aside>'
      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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Edição de Pessoa</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                person_id:
                  type: integer
                  description: 'ID da Pessoa.'
                  example: 321
                  nullable: false
                description:
                  type: string
                  description: Descrição.
                  example: Itaú
                  nullable: false
                holder:
                  type: string
                  description: 'Nome do titular.'
                  example: 'Ciclano Fulano'
                  nullable: false
                person_type:
                  type: string
                  description: 'Tipo de Pessoa (física ou jurídica)'
                  example: J
                  nullable: false
                tax_id:
                  type: integer
                  description: 'CPF/CNPJ: 99999999999'
                  example: 5
                  nullable: false
                birth_date:
                  type: date
                  description: 'Data de Nascimento.'
                  example: '1999-06-09'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo da Conta.'
                  example: CC
                  nullable: false
                pix_type:
                  type: string
                  description: 'Tipo da chave PIX.'
                  example: email
                  nullable: false
                pix_key:
                  type: string
                  description: 'Chave PIX.'
                  example: mail@example.com
                  nullable: false
                bank:
                  type: integer
                  description: 'Código do Banco.'
                  example: 260
                  nullable: false
                agency:
                  type: string
                  description: Agência.
                  example: '0223'
                  nullable: false
                account:
                  type: string
                  description: Conta.
                  example: 2140104-7
                  nullable: false
                principal:
                  type: boolean
                  description: 'Conta principal.'
                  example: true
                  nullable: false
                active:
                  type: boolean
                  description: 'Status da conta.'
                  example: true
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Exclusão de Pessoa</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    parameters:
      -
        in: path
        name: person_id
        description: 'int ID da Pessoa'
        example: ab
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'ID da Conta Bancária'
        example: 7
        required: true
        schema:
          type: integer
  /persons:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoas</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da pessoa.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'ID da pessoa.'
            example: 2
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome da pessoa.'
          example: carlos%
          required: false
          schema:
            type: string
            description: 'Nome da pessoa.'
            example: carlos%
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[access]'
          description: 'Tipo de acesso à pessoa.'
          example: all
          required: false
          schema:
            type: string
            description: 'Tipo de acesso à pessoa.'
            example: all
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Pessoas ativas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Pessoas ativas.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[origin_id]'
          description: 'ID de origem.'
          example: 29
          required: false
          schema:
            type: integer
            description: 'ID de origem.'
            example: 29
            nullable: false
        -
          in: query
          name: 'filter[reference]'
          description: Referência.
          example: R55
          required: false
          schema:
            type: string
            description: Referência.
            example: R55
            nullable: false
        -
          in: query
          name: 'filter[gender]'
          description: Sexo.
          example: M
          required: false
          schema:
            type: string
            description: Sexo.
            example: M
            nullable: false
        -
          in: query
          name: 'filter[approved]'
          description: 'Pessoas aprovadas.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Pessoas aprovadas.'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[tax_id]'
          description: CPF/CNPJ.
          example: '57157949008'
          required: false
          schema:
            type: string
            description: CPF/CNPJ.
            example: '57157949008'
            nullable: false
        -
          in: query
          name: 'filter[tag]'
          description: Tags.
          example: 1182
          required: false
          schema:
            type: integer
            description: Tags.
            example: 1182
            nullable: false
        -
          in: query
          name: 'filter[rg]'
          description: RG.
          example: 45.461.713-6
          required: false
          schema:
            type: string
            description: RG.
            example: 45.461.713-6
            nullable: false
        -
          in: query
          name: 'filter[rg_emmiter]'
          description: 'Emissor do RG.'
          example: ssp
          required: false
          schema:
            type: string
            description: 'Emissor do RG.'
            example: ssp
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[cnh]'
          description: 'N° da CNH.'
          example: '43375783744'
          required: false
          schema:
            type: string
            description: 'N° da CNH.'
            example: '43375783744'
            nullable: false
        -
          in: query
          name: 'filter[nationality]'
          description: Nacionalidade.
          example: Brasileira
          required: false
          schema:
            type: string
            description: Nacionalidade.
            example: Brasileira
            nullable: false
        -
          in: query
          name: 'filter[naturality]'
          description: Naturalidade.
          example: 'Rio do Sul'
          required: false
          schema:
            type: string
            description: Naturalidade.
            example: 'Rio do Sul'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[marital]'
          description: 'Estado civil.'
          example: married
          required: false
          schema:
            type: string
            description: 'Estado civil.'
            example: married
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[employment_time]'
          description: 'Tempo de empresa.'
          example: 6
          required: false
          schema:
            type: integer
            description: 'Tempo de empresa.'
            example: 6
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[income]'
          description: Renda.
          example: '1500.00'
          required: false
          schema:
            type: string
            description: Renda.
            example: '1500.00'
            nullable: false
        -
          in: query
          name: 'filter[income_other]'
          description: 'Outras rendas.'
          example: '600.00'
          required: false
          schema:
            type: string
            description: 'Outras rendas.'
            example: '600.00'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[state_inscription_type]'
          description: 'Indicador IE.'
          example: immune
          required: false
          schema:
            type: string
            description: 'Indicador IE.'
            example: immune
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[login_active]'
          description: 'Login habilitado.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Login habilitado.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[login]'
          description: Login.
          example: carlos_oliveira
          required: false
          schema:
            type: string
            description: Login.
            example: carlos_oliveira
            nullable: false
        -
          in: query
          name: 'filter[financial_alert]'
          description: 'Alerta financeiro habilitado.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Alerta financeiro habilitado.'
            example: true
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[origin]'
          description: 'Retorna os dados da origem da pessoa'
          example: aliquid
          required: false
          schema:
            type: string
            description: 'Retorna os dados da origem da pessoa'
            example: aliquid
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as Tags da pessoa'
          example: quia
          required: false
          schema:
            type: string
            description: 'Retorna as Tags da pessoa'
            example: quia
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Pessoas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da pessoa.'
                  example: 'Carlos Ciclano'
                  nullable: false
                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
                  nullable: false
                active:
                  type: boolean
                  description: Status.
                  example: true
                  nullable: false
                origin_id:
                  type: integer
                  description: 'ID da origem.'
                  example: 29
                  nullable: false
                origin:
                  type: string
                  description: 'Origem da pessoa, caso não saiba o ID.'
                  example: 'Facebook ADS'
                  nullable: false
                reference:
                  type: string
                  description: Referência.
                  example: R55
                  nullable: false
                gender:
                  type: string
                  description: Gênero.
                  example: M
                  nullable: false
                approved:
                  type: boolean
                  description: Aprovada.
                  example: true
                  nullable: false
                juridical:
                  type: string
                  description: 'Tipo de cadastro de pessoa (física, jurídica).'
                  example: F
                  nullable: false
                tax_id:
                  type: integer
                  description: CPF/CNPJ.
                  example: 57157949008
                  nullable: false
                tag:
                  type: array
                  description: Tags.
                  example:
                    - 1182
                  items:
                    type: string
                rg:
                  type: string
                  description: RG.
                  example: 45.461.713-6
                  nullable: false
                rg_emmiter:
                  type: string
                  description: 'Emissor do RG.'
                  example: ssp
                  nullable: false
                rg_dispatcher:
                  type: date
                  description: 'Data de emissão do RG'
                  example: '2011-09-08'
                  nullable: false
                cnh:
                  type: integer
                  description: CNH.
                  example: 43375783744
                  nullable: false
                nationality:
                  type: string
                  description: Nacionalidade.
                  example: Brasileira
                  nullable: false
                naturality:
                  type: string
                  description: Naturalidade.
                  example: Riosulense
                  nullable: false
                birthplace:
                  type: string
                  description: 'Local de nascimento.'
                  example: Riosulense
                  nullable: false
                birth_date:
                  type: date
                  description: 'Data de nascimento.'
                  example: '2011-09-08'
                  nullable: false
                marital:
                  type: string
                  description: 'Estado civil.'
                  example: married
                  nullable: false
                spouse_id:
                  type: integer
                  description: 'ID do Cônjuge.'
                  example: 5
                  nullable: false
                legal_representative_id:
                  type: integer
                  description: 'Representante legal.'
                  example: 80
                  nullable: false
                contacted_at:
                  type: date
                  description: 'Data de contato.'
                  example: '2021-03-22 11:31:00'
                  nullable: false
                last_contact_at:
                  type: date
                  description: 'Data do último contato.'
                  example: '2021-03-22 11:31:00'
                  nullable: false
                father_name:
                  type: string
                  description: 'Nome do pai.'
                  example: Rogério
                  nullable: false
                mother_name:
                  type: string
                  description: 'Nome da mãe.'
                  example: Maria
                  nullable: false
                occupation_id:
                  type: integer
                  description: 'ID de profissão .'
                  example: 10
                  nullable: false
                occupation:
                  type: string
                  description: Profissão.
                  example: 'Corretor imobiliário'
                  nullable: false
                employment_link:
                  type: string
                  description: 'Vínculo empregatício.'
                  example: EMP
                  nullable: false
                employment_business:
                  type: string
                  description: 'Nome da empresa de trabalho.'
                  example: Apresenta.me
                  nullable: false
                employment_time:
                  type: integer
                  description: 'Tempo de empresa.'
                  example: 6
                  nullable: false
                employment_phone:
                  type: string
                  description: 'Telefone da empresa.'
                  example: '+55 47 98420-8674'
                  nullable: false
                employment_address:
                  type: string
                  description: 'Endereço da empresa.'
                  example: 'Rua José Debieux'
                  nullable: false
                income:
                  type: numeric
                  description: Renda.
                  example: '1500.00'
                  nullable: false
                income_other:
                  type: Outras
                  description: rendas.
                  example: '600.00'
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Entrou em contato pelo Facebook'
                  nullable: false
                company_name:
                  type: string
                  description: 'Razão social.'
                  example: Apresenta.me
                  nullable: false
                state_inscription_type:
                  type: string
                  description: 'Indicador IE.'
                  example: immune
                  nullable: false
                state_inscription:
                  type: integer
                  description: 'Inscrição estadual (IE).'
                  example: 361944136227
                  nullable: false
                municipal_inscription:
                  type: integer
                  description: 'Inscrição Municipal (IM).'
                  example: 361944136227
                  nullable: false
                login_date:
                  type: date
                  description: 'Data do último login.'
                  example: '2021-03-17 15:50:22'
                  nullable: false
                login_active:
                  type: boolean
                  description: 'Login habilitado.'
                  example: true
                  nullable: false
                login:
                  type: string
                  description: Login.
                  example: carlos_oliveira
                  nullable: false
                password:
                  type: string
                  description: Senha.
                  example: senha@senha3412
                  nullable: false
                financial_alert:
                  type: boolean
                  description: 'Alerta financeiro habilitado.'
                  example: true
                  nullable: false
                create_building_alert:
                  type: boolean
                  description: 'Alerta cadastro de imóvel habilitado.'
                  example: true
                  nullable: false
              required:
                - name
  '/persons/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Pessoas</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[origin]'
          description: 'Retorna os dados da origem da pessoa'
          example: laborum
          required: false
          schema:
            type: string
            description: 'Retorna os dados da origem da pessoa'
            example: laborum
            nullable: false
        -
          in: query
          name: 'include[tags]'
          description: 'Retorna as Tags da pessoa'
          example: amet
          required: false
          schema:
            type: string
            description: 'Retorna as Tags da pessoa'
            example: amet
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de edição de Pessoas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Nome da pessoa.'
                  example: 'Carlos Ciclano'
                  nullable: false
                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
                  nullable: false
                active:
                  type: boolean
                  description: Status.
                  example: true
                  nullable: false
                origin_id:
                  type: integer
                  description: 'ID da origem.'
                  example: 29
                  nullable: false
                origin:
                  type: string
                  description: 'Origem da pessoa, caso não saiba o ID.'
                  example: 'Facebook ADS'
                  nullable: false
                reference:
                  type: string
                  description: Referência.
                  example: R55
                  nullable: false
                gender:
                  type: string
                  description: Gênero.
                  example: M
                  nullable: false
                approved:
                  type: boolean
                  description: Aprovada.
                  example: true
                  nullable: false
                juridical:
                  type: string
                  description: 'Tipo de cadastro de pessoa (física, jurídica).'
                  example: F
                  nullable: false
                tax_id:
                  type: integer
                  description: CPF/CNPJ.
                  example: 57157949008
                  nullable: false
                tag:
                  type: array
                  description: Tags.
                  example:
                    - 1182
                  items:
                    type: string
                rg:
                  type: string
                  description: RG.
                  example: 45.461.713-6
                  nullable: false
                rg_emmiter:
                  type: string
                  description: 'Emissor do RG.'
                  example: ssp
                  nullable: false
                rg_dispatcher:
                  type: date
                  description: 'Data de emissão do RG'
                  example: '2011-09-08'
                  nullable: false
                cnh:
                  type: integer
                  description: CNH.
                  example: 43375783744
                  nullable: false
                nationality:
                  type: string
                  description: Nacionalidade.
                  example: Brasileira
                  nullable: false
                naturality:
                  type: string
                  description: Naturalidade.
                  example: Riosulense
                  nullable: false
                birthplace:
                  type: string
                  description: 'Local de nascimento.'
                  example: Riosulense
                  nullable: false
                birth_date:
                  type: date
                  description: 'Data de nascimento.'
                  example: '2011-09-08'
                  nullable: false
                marital:
                  type: string
                  description: 'Estado civil.'
                  example: married
                  nullable: false
                spouse_id:
                  type: integer
                  description: 'ID do Cônjuge.'
                  example: 5
                  nullable: false
                legal_representative_id:
                  type: integer
                  description: 'Representante legal.'
                  example: 80
                  nullable: false
                contacted_at:
                  type: date
                  description: 'Data de contato.'
                  example: '2021-03-22 11:31:00'
                  nullable: false
                last_contact_at:
                  type: date
                  description: 'Data do último contato.'
                  example: '2021-03-22 11:31:00'
                  nullable: false
                father_name:
                  type: string
                  description: 'Nome do pai.'
                  example: Rogério
                  nullable: false
                mother_name:
                  type: string
                  description: 'Nome da mãe.'
                  example: Maria
                  nullable: false
                occupation_id:
                  type: integer
                  description: 'ID de profissão .'
                  example: 10
                  nullable: false
                occupation:
                  type: string
                  description: Profissão.
                  example: 'Corretor imobiliário'
                  nullable: false
                employment_link:
                  type: string
                  description: 'Vínculo empregatício.'
                  example: EMP
                  nullable: false
                employment_business:
                  type: string
                  description: 'Nome da empresa de trabalho.'
                  example: Apresenta.me
                  nullable: false
                employment_time:
                  type: integer
                  description: 'Tempo de empresa.'
                  example: 6
                  nullable: false
                employment_phone:
                  type: string
                  description: 'Telefone da empresa.'
                  example: '+55 47 98420-8674'
                  nullable: false
                employment_address:
                  type: string
                  description: 'Endereço da empresa.'
                  example: 'Rua José Debieux'
                  nullable: false
                income:
                  type: numeric
                  description: Renda.
                  example: '1500.00'
                  nullable: false
                income_other:
                  type: Outras
                  description: rendas.
                  example: '600.00'
                  nullable: false
                notes:
                  type: string
                  description: Observações.
                  example: 'Entrou em contato pelo Facebook'
                  nullable: false
                company_name:
                  type: string
                  description: 'Razão social.'
                  example: Apresenta.me
                  nullable: false
                state_inscription_type:
                  type: string
                  description: 'Indicador IE.'
                  example: immune
                  nullable: false
                state_inscription:
                  type: integer
                  description: 'Inscrição estadual (IE).'
                  example: 361944136227
                  nullable: false
                municipal_inscription:
                  type: integer
                  description: 'Inscrição Municipal (IM).'
                  example: 361944136227
                  nullable: false
                login_date:
                  type: date
                  description: 'Data do último login.'
                  example: '2021-03-17 15:50:22'
                  nullable: false
                login_active:
                  type: boolean
                  description: 'Login habilitado.'
                  example: true
                  nullable: false
                login:
                  type: string
                  description: Login.
                  example: carlos_oliveira
                  nullable: false
                password:
                  type: string
                  description: Senha.
                  example: senha@senha3412
                  nullable: false
                financial_alert:
                  type: boolean
                  description: 'Alerta financeiro habilitado.'
                  example: true
                  nullable: false
                create_building_alert:
                  type: boolean
                  description: 'Alerta cadastro de imóvel habilitado.'
                  example: true
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de exclusão de Pessoas</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Pessoas
    parameters:
      -
        in: path
        name: id
        description: 'ID da pessoa'
        example: 20
        required: true
        schema:
          type: integer
  '/deals/statistics/{widget}':
    get:
      summary: ''
      operationId: getDealsStatisticsWidget
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Propostas
    parameters:
      -
        in: path
        name: widget
        description: ''
        example: laudantium
        required: true
        schema:
          type: string
  /deals/rotations:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: ''
      parameters:
        -
          in: query
          name: sort
          description: 'Campo para ordenar os registros'
          example: order
          required: false
          schema:
            type: string
            description: 'Campo para ordenar os registros'
            example: order
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,interest,type'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,interest,type'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID da regra de rodízio.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'ID da regra de rodízio.'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[funnel_step_id]'
          description: 'ID do Funil e etapa para encaminhar o lead.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'ID do Funil e etapa para encaminhar o lead.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[name]'
          description: 'Nome da regra.'
          example: carlos%
          required: false
          schema:
            type: string
            description: 'Nome da regra.'
            example: carlos%
            nullable: false
        -
          in: query
          name: 'filter[interest]'
          description: 'Interesses do lead.'
          example: null
          required: false
          schema:
            type: array
            description: 'Interesses do lead.'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[origin]'
          description: 'ID da Origem do Lead: 1'
          example: 3
          required: false
          schema:
            type: integer
            description: 'ID da Origem do Lead: 1'
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[user]'
          description: 'ID dos Corretores'
          example:
            - 123
            - 456
          required: false
          schema:
            type: array
            description: 'ID dos Corretores'
            example:
              - 123
              - 456
            items:
              type: integer
        -
          in: query
          name: 'filter[type]'
          description: 'Tipo de rodízio (roleta).'
          example: users
          required: false
          schema:
            type: string
            description: 'Tipo de rodízio (roleta).'
            example: users
            nullable: false
        -
          in: query
          name: 'filter[building]'
          description: 'Imóveis específicos.'
          example:
            - 123
            - 345
          required: false
          schema:
            type: array
            description: 'Imóveis específicos.'
            example:
              - 123
              - 345
            items:
              type: integer
        -
          in: query
          name: 'filter[building_type]'
          description: 'Tipo de Imóvel.'
          example:
            - 1
            - 2
          required: false
          schema:
            type: array
            description: 'Tipo de Imóvel.'
            example:
              - 1
              - 2
            items:
              type: integer
        -
          in: query
          name: 'filter[detail]'
          description: 'Detalhes do imóvel.'
          example:
            - 123
            - 321
          required: false
          schema:
            type: array
            description: 'Detalhes do imóvel.'
            example:
              - 123
              - 321
            items:
              type: integer
        -
          in: query
          name: 'filter[price_min]'
          description: 'Preço mínimo do imóvel.'
          example: '1200.00'
          required: false
          schema:
            type: string
            description: 'Preço mínimo do imóvel.'
            example: '1200.00'
            nullable: false
        -
          in: query
          name: 'filter[price_max]'
          description: 'Preço máximo do imóvel.'
          example: '1500.00'
          required: false
          schema:
            type: string
            description: 'Preço máximo do imóvel.'
            example: '1500.00'
            nullable: false
        -
          in: query
          name: 'filter[state]'
          description: Estado.
          example: 1
          required: false
          schema:
            type: integer
            description: Estado.
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[city]'
          description: Cidade.
          example: 2
          required: false
          schema:
            type: integer
            description: Cidade.
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[district]'
          description: Bairro.
          example: 3
          required: false
          schema:
            type: integer
            description: Bairro.
            example: 3
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: Status.
          example: true
          required: false
          schema:
            type: boolean
            description: Status.
            example: true
            nullable: false
        -
          in: query
          name: 'filter[position]'
          description: 'Ordem da regra.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Ordem da regra.'
            example: 1
            nullable: false
        -
          in: query
          name: 'filter[limit_security_user]'
          description: 'Limite de Segurança.'
          example: 2
          required: false
          schema:
            type: integer
            description: 'Limite de Segurança.'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[with_security_user]'
          description: 'Com Corretor de Segurança.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Com Corretor de Segurança.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[security_user]'
          description: 'Corretor de Segurança.'
          example:
            - 12
          required: false
          schema:
            type: array
            description: 'Corretor de Segurança.'
            example:
              - 12
            items:
              type: integer
        -
          in: query
          name: 'filter[send_lead_center]'
          description: 'Enviar para o Bolsão de Leads.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Enviar para o Bolsão de Leads.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[responsible_respect]'
          description: 'Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[responsible_respect_only_rule]'
          description: 'Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[hour_respect]'
          description: 'Distribuir apenas no horário determinado.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Distribuir apenas no horário determinado.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[online_only]'
          description: 'Distribuir apenas para corretores online.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Distribuir apenas para corretores online.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[with_contact_only]'
          description: 'Somente Lead com contato.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Somente Lead com contato.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[skip]'
          description: 'Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[skip_time]'
          description: 'Tempo para pular para o próximo corretor do rodízio.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Tempo para pular para o próximo corretor do rodízio.'
            example: 15
            nullable: false
        -
          in: query
          name: 'filter[skip_hour_initial]'
          description: 'time Horário inicial para rodízio de leads.'
          example: '08:00'
          required: false
          schema:
            type: string
            description: 'time Horário inicial para rodízio de leads.'
            example: '08:00'
            nullable: false
        -
          in: query
          name: 'filter[skip_hour_final]'
          description: 'time Horário final para rodízio de leads.'
          example: '18:00'
          required: false
          schema:
            type: string
            description: 'time Horário final para rodízio de leads.'
            example: '18:00'
            nullable: false
        -
          in: query
          name: 'filter[catcher_preference]'
          description: 'Dar preferência ao corretor captador.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Dar preferência ao corretor captador.'
            example: false
            nullable: false
        -
          in: query
          name: 'filter[pickup_user]'
          description: 'Corretor captador.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'Corretor captador.'
            example: 123
            nullable: false
        -
          in: query
          name: 'filter[pickup_user_expiration]'
          description: 'Enviar exclusivamente para o corretor captador (0-6).'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Enviar exclusivamente para o corretor captador (0-6).'
            example: 0
            nullable: false
        -
          in: query
          name: 'filter[days_for_rule]'
          description: 'Dias de vigência da regra.'
          example: null
          required: false
          schema:
            type: array
            description: 'Dias de vigência da regra.'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[from]'
          description: 'date Lead criado em.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'date Lead criado em.'
            example: '2024-01-01'
            nullable: false
        -
          in: query
          name: 'filter[constructor_id]'
          description: ''
          example:
            - 1
            - 2
            - 3
          required: false
          schema:
            type: array
            description: ''
            example:
              - 1
              - 2
              - 3
            items:
              type: integer
        -
          in: query
          name: 'include[funnelStep]'
          description: 'Retorna dados da etapa do funil da regra.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna dados da etapa do funil da regra.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[origins]'
          description: 'Retorna as origens.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as origens.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os Imóveis específicos da regra.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os Imóveis específicos da regra.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[buildingTypes]'
          description: 'Retorna os tipos de imóveis da regra.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os tipos de imóveis da regra.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[constructor_idToJson]'
          description: 'Retorna as construtoras.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna as construtoras.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[details]'
          description: 'Retorna os detalhes.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os detalhes.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[users]'
          description: 'Retorna os usuários.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna os usuários.'
            example: 'id,name,email'
            nullable: false
        -
          in: query
          name: 'include[states]'
          description: 'Retorna os estados da regra.'
          example: 'id,name,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna os estados da regra.'
            example: 'id,name,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[cities]'
          description: 'Retorna as cidades da regra.'
          example: 'id,name,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna as cidades da regra.'
            example: 'id,name,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[districts]'
          description: 'Retorna os bairros da regra.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os bairros da regra.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[pickupUsers]'
          description: 'Retorna os corretores captadores.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os corretores captadores.'
            example: 'id,name'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
    post:
      summary: Criar
      operationId: criar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                funnel_step_id:
                  type: required
                  description: 'int ID do Funil e etapa para encaminhar o lead.'
                  example: '1'
                  nullable: false
                name:
                  type: string
                  description: 'Nome da regra.'
                  example: carlos%
                  nullable: false
                interest:
                  type: array
                  description: 'Interesses do lead.'
                  example: null
                  items:
                    type: string
                origin:
                  type: integer
                  description: 'ID da Origem do Lead: 1'
                  example: 2
                  nullable: false
                user:
                  type: array
                  description: 'ID dos Corretores'
                  example:
                    - 123
                    - 456
                  items:
                    type: integer
                type:
                  type: string
                  description: 'Tipo de rodízio (roleta).'
                  example: users
                  nullable: false
                building:
                  type: array
                  description: 'Imóveis específicos.'
                  example:
                    - 123
                    - 345
                  items:
                    type: integer
                building_type:
                  type: array
                  description: 'Tipo de Imóvel.'
                  example:
                    - 1
                    - 2
                  items:
                    type: integer
                detail:
                  type: array
                  description: 'Detalhes do imóvel.'
                  example:
                    - 123
                    - 321
                  items:
                    type: integer
                price_min:
                  type: string
                  description: 'Preço mínimo do imóvel.'
                  example: '1200.00'
                  nullable: false
                price_max:
                  type: Preço
                  description: 'máximo do imóvel.'
                  example: '1500.00'
                  nullable: false
                state:
                  type: integer
                  description: Estado.
                  example: 1
                  nullable: false
                city:
                  type: integer
                  description: Cidade.
                  example: 2
                  nullable: false
                limit_security_user:
                  type: integer
                  description: 'Limite de Segurança.'
                  example: 2
                  nullable: false
                with_security_user:
                  type: boolean
                  description: 'Com Corretor de Segurança.'
                  example: true
                  nullable: false
                security_user:
                  type: array
                  description: 'Corretor de Segurança.'
                  example:
                    - 12
                  items:
                    type: integer
                send_lead_center:
                  type: boolean
                  description: 'Enviar para o Bolsão de Leads.'
                  example: true
                  nullable: false
                district:
                  type: integer
                  description: Bairro.
                  example: 3
                  nullable: false
                active:
                  type: boolean
                  description: Status.
                  example: true
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem da regra.'
                  example: 1
                  nullable: false
                responsible_respect:
                  type: boolean
                  description: 'Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.'
                  example: true
                  nullable: false
                responsible_respect_only_rule:
                  type: boolean
                  description: 'Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.'
                  example: false
                  nullable: false
                hour_respect:
                  type: boolean
                  description: 'Distribuir apenas no horário determinado.'
                  example: true
                  nullable: false
                online_only:
                  type: boolean
                  description: 'Distribuir apenas para corretores online.'
                  example: true
                  nullable: false
                with_contact_only:
                  type: boolean
                  description: 'Somente Lead com contato.'
                  example: true
                  nullable: false
                skip:
                  type: boolean
                  description: 'Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.'
                  example: true
                  nullable: false
                skip_time:
                  type: integer
                  description: 'Tempo para pular para o próximo corretor do rodízio.'
                  example: 15
                  nullable: false
                skip_hour_initial:
                  type: time
                  description: 'Horário inicial para rodízio de leads.'
                  example: '08:00'
                  nullable: false
                skip_hour_final:
                  type: time
                  description: 'Horário final para rodízio de leads.'
                  example: '18:00'
                  nullable: false
                catcher_preference:
                  type: boolean
                  description: 'Dar preferência ao corretor captador.'
                  example: false
                  nullable: false
                pickup_user:
                  type: integer
                  description: 'Corretor captador.'
                  example: 123
                  nullable: false
                pickup_user_expiration:
                  type: integer
                  description: 'Enviar exclusivamente para o corretor captador (0-6).'
                  example: 0
                  nullable: false
                days_for_rule:
                  type: array
                  description: 'Dias de vigência da regra.'
                  example: null
                  items:
                    type: string
                from:
                  type: date
                  description: 'Lead criado em.'
                  example: '2024-01-01'
                  nullable: false
                constructor_id:
                  type: array
                  description: ''
                  example:
                    - 1
                    - 2
                    - 3
                  items:
                    type: integer
              required:
                - name
  '/deals/rotations/{id}':
    get:
      summary: Obter
      operationId: obter
      description: ''
      parameters:
        -
          in: query
          name: sort
          description: 'Campo para ordenar os registros'
          example: order
          required: false
          schema:
            type: string
            description: 'Campo para ordenar os registros'
            example: order
            nullable: false
        -
          in: query
          name: fields
          description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
          example: 'id,name,interest,type'
          required: false
          schema:
            type: string
            description: 'Lista de campos separados por vírgula sem espaço para incluir na resposta'
            example: 'id,name,interest,type'
            nullable: false
        -
          in: query
          name: 'include[funnelStep]'
          description: 'Retorna dados da etapa do funil da regra.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna dados da etapa do funil da regra.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[origins]'
          description: 'Retorna as origens.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna as origens.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[buildings]'
          description: 'Retorna os Imóveis específicos da regra.'
          example: 'id,title'
          required: false
          schema:
            type: string
            description: 'Retorna os Imóveis específicos da regra.'
            example: 'id,title'
            nullable: false
        -
          in: query
          name: 'include[buildingTypes]'
          description: 'Retorna os tipos de imóveis da regra.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os tipos de imóveis da regra.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[constructor_idToJson]'
          description: 'Retorna as construtoras.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna as construtoras.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[details]'
          description: 'Retorna os detalhes.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Retorna os detalhes.'
            example: 'id,description'
            nullable: false
        -
          in: query
          name: 'include[users]'
          description: 'Retorna os usuários.'
          example: 'id,name,email'
          required: false
          schema:
            type: string
            description: 'Retorna os usuários.'
            example: 'id,name,email'
            nullable: false
        -
          in: query
          name: 'include[states]'
          description: 'Retorna os estados da regra.'
          example: 'id,name,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna os estados da regra.'
            example: 'id,name,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[cities]'
          description: 'Retorna as cidades da regra.'
          example: 'id,name,abbreviation'
          required: false
          schema:
            type: string
            description: 'Retorna as cidades da regra.'
            example: 'id,name,abbreviation'
            nullable: false
        -
          in: query
          name: 'include[districts]'
          description: 'Retorna os bairros da regra.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os bairros da regra.'
            example: 'id,name'
            nullable: false
        -
          in: query
          name: 'include[pickupUsers]'
          description: 'Retorna os corretores captadores.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os corretores captadores.'
            example: 'id,name'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
    put:
      summary: Alterar
      operationId: alterar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                funnel_step_id:
                  type: integer
                  description: 'ID do Funil e etapa para encaminhar o lead.'
                  example: 1
                  nullable: false
                name:
                  type: string
                  description: 'Nome da regra.'
                  example: carlos%
                  nullable: false
                interest:
                  type: array
                  description: 'Interesses do lead.'
                  example: null
                  items:
                    type: string
                origin:
                  type: integer
                  description: 'ID da Origem do Lead: 1'
                  example: 10
                  nullable: false
                user:
                  type: array
                  description: 'ID dos Corretores'
                  example:
                    - 123
                    - 456
                  items:
                    type: integer
                type:
                  type: string
                  description: 'Tipo de rodízio (roleta).'
                  example: users
                  nullable: false
                building:
                  type: array
                  description: 'Imóveis específicos.'
                  example:
                    - 123
                    - 345
                  items:
                    type: integer
                building_type:
                  type: array
                  description: 'Tipo de Imóvel.'
                  example:
                    - 1
                    - 2
                  items:
                    type: integer
                detail:
                  type: array
                  description: 'Detalhes do imóvel.'
                  example:
                    - 123
                    - 321
                  items:
                    type: integer
                price_min:
                  type: string
                  description: 'Preço mínimo do imóvel.'
                  example: '1200.00'
                  nullable: false
                price_max:
                  type: Preço
                  description: 'máximo do imóvel.'
                  example: '1500.00'
                  nullable: false
                state:
                  type: integer
                  description: Estado.
                  example: 1
                  nullable: false
                city:
                  type: integer
                  description: Cidade.
                  example: 2
                  nullable: false
                district:
                  type: integer
                  description: Bairro.
                  example: 3
                  nullable: false
                active:
                  type: boolean
                  description: Status.
                  example: true
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem da regra.'
                  example: 1
                  nullable: false
                limit_security_user:
                  type: integer
                  description: 'Limite de Segurança.'
                  example: 2
                  nullable: false
                with_security_user:
                  type: boolean
                  description: 'Com Corretor de Segurança.'
                  example: true
                  nullable: false
                security_user:
                  type: array
                  description: 'Corretor de Segurança.'
                  example:
                    - 12
                  items:
                    type: integer
                send_lead_center:
                  type: boolean
                  description: 'Enviar para o Bolsão de Leads.'
                  example: true
                  nullable: false
                responsible_respect:
                  type: boolean
                  description: 'Se o lead já tiver atendimento ou já possuir um responsável, repassá-lo para o mesmo corretor.'
                  example: true
                  nullable: false
                responsible_respect_only_rule:
                  type: boolean
                  description: 'Respeitar o atendimento ao mesmo corretor apenas se este estiver na regra.'
                  example: false
                  nullable: false
                hour_respect:
                  type: boolean
                  description: 'Distribuir apenas no horário determinado.'
                  example: true
                  nullable: false
                online_only:
                  type: boolean
                  description: 'Distribuir apenas para corretores online.'
                  example: true
                  nullable: false
                with_contact_only:
                  type: boolean
                  description: 'Somente Lead com contato.'
                  example: true
                  nullable: false
                skip:
                  type: boolean
                  description: 'Pular para próximo corretor do rodízio caso o lead não seja aceito dentro do prazo.'
                  example: true
                  nullable: false
                skip_time:
                  type: integer
                  description: 'Tempo para pular para o próximo corretor do rodízio.'
                  example: 15
                  nullable: false
                skip_hour_initial:
                  type: time
                  description: 'Horário inicial para rodízio de leads.'
                  example: '08:00'
                  nullable: false
                skip_hour_final:
                  type: time
                  description: 'Horário final para rodízio de leads.'
                  example: '18:00'
                  nullable: false
                catcher_preference:
                  type: boolean
                  description: 'Dar preferência ao corretor captador.'
                  example: false
                  nullable: false
                pickup_user:
                  type: integer
                  description: 'Corretor captador.'
                  example: 123
                  nullable: false
                pickup_user_expiration:
                  type: integer
                  description: 'Enviar exclusivamente para o corretor captador (0-6).'
                  example: 0
                  nullable: false
                days_for_rule:
                  type: array
                  description: 'Dias de vigência da regra.'
                  example: null
                  items:
                    type: string
                from:
                  type: date
                  description: 'Lead criado em.'
                  example: '2024-01-01'
                  nullable: false
                constructor_id:
                  type: array
                  description: ''
                  example:
                    - 1
                    - 2
                    - 3
                  items:
                    type: integer
    delete:
      summary: Excluir
      operationId: excluir
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
    parameters:
      -
        in: path
        name: id
        description: 'ID da Regra'
        example: 12
        required: true
        schema:
          type: integer
  '/deals/rotations/{rotation_id}/duplicate':
    get:
      summary: Duplicar
      operationId: duplicar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - 'Regras para Rodízio de Leads'
    parameters:
      -
        in: path
        name: rotation_id
        description: 'ID da Regra'
        example: 6
        required: true
        schema:
          type: integer
  /tickets:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do Ticket'
          example: 2
          required: false
          schema:
            type: integer
            description: 'ID do Ticket'
            example: 2
            nullable: false
        -
          in: query
          name: 'filter[business_id]'
          description: 'ID da empresa'
          example: 6
          required: false
          schema:
            type: integer
            description: 'ID da empresa'
            example: 6
            nullable: false
        -
          in: query
          name: 'filter[contract_id]'
          description: 'ID do Contrato'
          example: 23
          required: false
          schema:
            type: integer
            description: 'ID do Contrato'
            example: 23
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[person_id]'
          description: 'ID da Pessoa'
          example: 5
          required: false
          schema:
            type: integer
            description: 'ID da Pessoa'
            example: 5
            nullable: false
        -
          in: query
          name: 'filter[responsible][]'
          description: 'ID do Responsável'
          example: 1
          required: false
          schema:
            type: array
            description: 'ID do Responsável'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[title]'
          description: 'Título do Ticket'
          example: 'Problema com a internet'
          required: false
          schema:
            type: string
            description: 'Título do Ticket'
            example: 'Problema com a internet'
            nullable: false
        -
          in: query
          name: 'filter[notes]'
          description: 'Observações do Ticket'
          example: 'Internet está lenta'
          required: false
          schema:
            type: string
            description: 'Observações do Ticket'
            example: 'Internet está lenta'
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: "Tipo do Ticket.\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
          required: false
          schema:
            type: string
            description: "Tipo do Ticket.\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
            nullable: false
        -
          in: query
          name: 'filter[priority]'
          description: "Prioridade do Ticket.\nValores permitidos:\n- `low`: Baixa\n- `normal`: Média\n- `high`: Alta\n- `highest`: Altíssima"
          example: normal
          required: false
          schema:
            type: string
            description: "Prioridade do Ticket.\nValores permitidos:\n- `low`: Baixa\n- `normal`: Média\n- `high`: Alta\n- `highest`: Altíssima"
            example: normal
            nullable: false
        -
          in: query
          name: 'filter[origin]'
          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
          required: false
          schema:
            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
            nullable: false
        -
          in: query
          name: 'filter[status]'
          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
          required: false
          schema:
            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
            nullable: false
        -
          in: query
          name: 'filter[date]'
          description: 'dateTime Data do Ticket'
          example: '2025-04-28 14:12:00'
          required: false
          schema:
            type: string
            description: 'dateTime Data do Ticket'
            example: '2025-04-28 14:12:00'
            nullable: false
        -
          in: query
          name: 'filter[expected_date]'
          description: 'dateTime Data de Previsão do Ticket'
          example: '2025-06-25 09:30:00'
          required: false
          schema:
            type: string
            description: 'dateTime Data de Previsão do Ticket'
            example: '2025-06-25 09:30:00'
            nullable: false
        -
          in: query
          name: 'filter[buildingIn][]'
          description: 'Filtra os Tickets por Imóveis'
          example: 1
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Imóveis'
            example: 1
            items:
              type: integer
        -
          in: query
          name: 'filter[personIn][]'
          description: 'Filtra os Tickets por Pessoas'
          example: 2
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Pessoas'
            example: 2
            items:
              type: integer
        -
          in: query
          name: 'filter[responsibleIn][]'
          description: 'Filtra os Tickets por Responsáveis'
          example: 3
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Responsáveis'
            example: 3
            items:
              type: integer
        -
          in: query
          name: 'filter[typesIn][]'
          description: 'Filtra os Tickets por Tipos'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Tipos'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[statusIn][]'
          description: 'Filtra os Tickets por Status'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Status'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[priorityIn][]'
          description: 'Filtra os Tickets por Prioridades'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Prioridades'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[originIn][]'
          description: 'Filtra os Tickets por Origens'
          example: null
          required: false
          schema:
            type: array
            description: 'Filtra os Tickets por Origens'
            example: null
            items:
              type: string
        -
          in: query
          name: 'filter[late]'
          description: 'Filtra apenas Tickets atrasados'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filtra apenas Tickets atrasados'
            example: true
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Incluir dados do Contrato'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Incluir dados do Contrato'
            example: 0
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Tickets
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Tickets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                business_id:
                  type: integer
                  description: 'ID da empresa'
                  example: 6
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da Pessoa'
                  example: 5
                  nullable: false
                title:
                  type: string
                  description: 'Título do Ticket'
                  example: 'Problema com a internet'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo do Ticket.'
                  example: facilis
                  nullable: false
                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
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do Contrato'
                  example: 23
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do Imóvel'
                  example: 12
                  nullable: false
                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
                  nullable: false
                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
                  nullable: false
                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
                  nullable: false
                date:
                  type: dateTime
                  description: 'Data do Ticket'
                  example: '2025-04-28 14:12:00'
                  nullable: false
                expected_date:
                  type: dateTime
                  description: 'Data de Previsão do Ticket'
                  example: '2025-06-25 09:30:00'
                  nullable: false
              required:
                - business_id
                - person_id
                - title
                - type
                - origin
  '/tickets/{id}':
    get:
      summary: Obter
      operationId: obter
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket</aside>'
      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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[contract]'
          description: 'Incluir dados do Contrato'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Incluir dados do Contrato'
            example: 0
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Tickets
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Tickets
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                business_id:
                  type: integer
                  description: 'ID da empresa'
                  example: 6
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da Pessoa'
                  example: 5
                  nullable: false
                title:
                  type: string
                  description: 'Título do Ticket'
                  example: 'Problema com a internet'
                  nullable: false
                type:
                  type: string
                  description: 'Tipo do Ticket.'
                  example: iste
                  nullable: false
                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
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do Contrato'
                  example: 23
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do Imóvel'
                  example: 12
                  nullable: false
                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
                  nullable: false
                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
                  nullable: false
                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
                  nullable: false
                date:
                  type: dateTime
                  description: 'Data do Ticket'
                  example: '2025-04-28 14:12:00'
                  nullable: false
                expected_date:
                  type: dateTime
                  description: 'Data de Previsão do Ticket'
                  example: '2025-06-25 09:30:00'
                  nullable: false
    delete:
      summary: Excluir
      operationId: excluir
      description: '<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Ticket</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Tickets
    parameters:
      -
        in: path
        name: id
        description: 'Id do ticket'
        example: 5
        required: true
        schema:
          type: integer
  /users:
    get:
      summary: Pesquisar
      operationId: pesquisar
      description: '<aside>🔒 Para acessar essa rota é necessário ter permissões adequadas.</aside>'
      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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[id]'
          description: 'ID do usuário.'
          example: 123456
          required: false
          schema:
            type: integer
            description: 'ID do usuário.'
            example: 123456
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[login]'
          description: 'Login do usuário.'
          example: usuario123
          required: false
          schema:
            type: string
            description: 'Login do usuário.'
            example: usuario123
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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...'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'filter[active]'
          description: 'Status do usuário.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Status do usuário.'
            example: true
            nullable: false
        -
          in: query
          name: 'filter[public]'
          description: 'Mostra no site.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Mostra no site.'
            example: false
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[contracts]'
          description: 'Retorna os contrato.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os contrato.'
            example: 'id,name'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Usuários
    post:
      summary: Criar
      operationId: criar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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: 17
                  nullable: false
                team_id:
                  type: integer
                  description: 'ID da equipe que o corretor pertence.'
                  example: 4
                  nullable: false
                login:
                  type: string
                  description: 'Login de acesso ao sistema.'
                  example: harum
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da pessoa cadastrada no sistema que corresponde ao corretor.'
                  example: 1
                  nullable: false
                password:
                  type: string
                  description: 'Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.'
                  example: Usuario@8532
                  nullable: false
                name:
                  type: string
                  description: 'Nome do usuário.'
                  example: vel
                  nullable: false
                name_public:
                  type: string
                  description: 'Nome para ser exibido no site.'
                  example: numquam
                  nullable: false
                description:
                  type: string
                  description: 'Descrição para a página do corretor.'
                  example: 'Nihil cumque ut mollitia sed aliquid.'
                  nullable: false
                creci:
                  type: integer
                  description: 'Número do CRECI.'
                  example: 5555
                  nullable: false
                email:
                  type: string
                  description: 'E-mail de contato.'
                  example: contato@contato.com
                  nullable: false
                phone:
                  type: integer
                  description: 'Telefone de contato.'
                  example: 47988888888
                  nullable: false
                image_path:
                  type: string
                  description: 'Caminho da foto de perfil.'
                  example: url.com
                  nullable: false
                active:
                  type: boolean
                  description: 'Status do usuário.'
                  example: true
                  nullable: false
                public:
                  type: boolean
                  description: 'Mostrar o usuário no site.'
                  example: false
                  nullable: false
                notes:
                  type: string
                  description: 'Observações do usuário.'
                  example: nihil
                  nullable: false
                not_notify:
                  type: boolean
                  description: 'Não notificar. Example true'
                  example: true
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem de exibição dos corretores no site.'
                  example: 13
                  nullable: false
                facebook_id:
                  type: string
                  description: 'Link do perfil do Facebook.'
                  example: quos
                  nullable: false
                instagram_id:
                  type: string
                  description: 'Link do perfil do Instagram.'
                  example: exercitationem
                  nullable: false
                google_id:
                  type: integer
                  description: 'ID do google do usuário que cadastrou.'
                  example: 6
                  nullable: false
                first_period_in:
                  type: Hour
                  description: 'Horário de entrada do primeiro período.'
                  example: '08:00.'
                  nullable: false
                first_period_out:
                  type: Hour
                  description: 'Horário de saída do primeiro período.'
                  example: '08:00.'
                  nullable: false
                second_period_in:
                  type: Hour
                  description: 'Horário de entrada do segundo período.'
                  example: '08:00.'
                  nullable: false
                second_period_out:
                  type: Hour
                  description: 'Horário de saída do segundo período.'
                  example: '08:00.'
                  nullable: false
                calender_id:
                  type: integer
                  description: 'ID do calendário do usuário.'
                  example: 123
                  nullable: false
                force_password_change:
                  type: boolean
                  description: 'Forçar troca de senha.'
                  example: false
                  nullable: 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
            nullable: false
        -
          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'
            nullable: 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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[contracts]'
          description: 'Retorna os contrato.'
          example: 'id,name'
          required: false
          schema:
            type: string
            description: 'Retorna os contrato.'
            example: 'id,name'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Usuários
    put:
      summary: Alterar
      operationId: alterar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de Alteração de Usuários</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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: 13
                  nullable: false
                team_id:
                  type: integer
                  description: 'ID da equipe que o corretor pertence.'
                  example: 14
                  nullable: false
                login:
                  type: string
                  description: 'Login de acesso ao sistema.'
                  example: consectetur
                  nullable: false
                person_id:
                  type: integer
                  description: 'ID da pessoa cadastrada no sistema que corresponde ao corretor.'
                  example: 1
                  nullable: false
                password:
                  type: string
                  description: 'Senha de acesso ao sistema, devendo ter Carácter especial, letra e número.'
                  example: Usuario@8532
                  nullable: false
                name:
                  type: string
                  description: 'Nome do usuário.'
                  example: sunt
                  nullable: false
                name_public:
                  type: string
                  description: 'Nome para ser exibido no site.'
                  example: qui
                  nullable: false
                description:
                  type: string
                  description: 'Descrição para a página do corretor.'
                  example: 'Tempora et nobis est id eveniet soluta velit.'
                  nullable: false
                creci:
                  type: integer
                  description: 'Número do CRECI.'
                  example: 5555
                  nullable: false
                email:
                  type: string
                  description: 'E-mail de contato.'
                  example: contato@contato.com
                  nullable: false
                phone:
                  type: integer
                  description: 'Telefone de contato.'
                  example: 47988888888
                  nullable: false
                image_path:
                  type: string
                  description: 'Caminho da foto de perfil.'
                  example: url.com
                  nullable: false
                active:
                  type: boolean
                  description: 'Status do usuário.'
                  example: true
                  nullable: false
                public:
                  type: boolean
                  description: 'Mostrar o usuário no site.'
                  example: false
                  nullable: false
                notes:
                  type: string
                  description: 'Observações do usuário.'
                  example: quo
                  nullable: false
                not_notify:
                  type: boolean
                  description: 'Não notificar. Example true'
                  example: false
                  nullable: false
                position:
                  type: integer
                  description: 'Ordem de exibição dos corretores no site.'
                  example: 19
                  nullable: false
                facebook_id:
                  type: string
                  description: 'Link do perfil do Facebook.'
                  example: molestiae
                  nullable: false
                instagram_id:
                  type: string
                  description: 'Link do perfil do Instagram.'
                  example: non
                  nullable: false
                google_id:
                  type: integer
                  description: 'ID do google do usuário que cadastrou.'
                  example: 6
                  nullable: false
                first_period_in:
                  type: Hour
                  description: 'Horário de entrada do primeiro período.'
                  example: '08:00.'
                  nullable: false
                first_period_out:
                  type: Hour
                  description: 'Horário de saída do primeiro período.'
                  example: '08:00.'
                  nullable: false
                second_period_in:
                  type: Hour
                  description: 'Horário de entrada do segundo período.'
                  example: '08:00.'
                  nullable: false
                second_period_out:
                  type: Hour
                  description: 'Horário de saída do segundo período.'
                  example: '08:00.'
                  nullable: false
                calender_id:
                  type: integer
                  description: 'ID do calendário do usuário.'
                  example: 123
                  nullable: false
                force_password_change:
                  type: boolean
                  description: 'Forçar troca de senha.'
                  example: false
                  nullable: false
    parameters:
      -
        in: path
        name: id
        description: 'ID do Usuário'
        example: 18
        required: true
        schema:
          type: integer
  '/inspect/environments/{environment_id}/duplicate':
    post:
      summary: Duplicar
      operationId: duplicar
      description: ''
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: ''
                  example: Banheiro
                  nullable: false
                inspect_id:
                  type: integer
                  description: ''
                  example: 1
                  nullable: false
                icon:
                  type: string
                  description: ''
                  example: 'ics ic-address-book'
                  nullable: false
                condition:
                  type: string
                  description: ''
                  example: good
                  nullable: false
                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
                  nullable: false
    parameters:
      -
        in: path
        name: environment_id
        description: 'The ID of the environment.'
        example: 6
        required: true
        schema:
          type: integer
      -
        in: path
        name: environment
        description: 'Id do Ambiente'
        example: 6
        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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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%'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    post:
      summary: Criar
      operationId: criar
      description: 'Cria um novo ambiente de vistoria.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do ambiente.'
                  example: Banheiro
                  nullable: false
                inspect_id:
                  type: integer
                  description: 'ID da vistoria vinculada.'
                  example: 1
                  nullable: false
                icon:
                  type: string
                  description: 'Ícone do ambiente.'
                  example: 'ics ic-address-book'
                  nullable: false
                condition:
                  type: string
                  description: 'Condição do ambiente. Valores: new, good, regular, used, bad, terrible.'
                  example: good
                  nullable: false
                notes:
                  type: array
                  description: 'Observações do ambiente (array JSON).'
                  example: null
                  items:
                    type: string
              required:
                - description
                - inspect_id
  '/inspect/environments/{id}':
    get:
      summary: Obter
      operationId: obter
      description: 'Obtém os detalhes de um ambiente de vistoria específico.'
      parameters:
        -
          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'
            nullable: false
        -
          in: query
          name: 'include[items]'
          description: 'Inclui itens do ambiente.'
          example: 'id,description'
          required: false
          schema:
            type: string
            description: 'Inclui itens do ambiente.'
            example: 'id,description'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    put:
      summary: Alterar
      operationId: alterar
      description: 'Altera os dados de um ambiente de vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do ambiente.'
                  example: Banheiro
                  nullable: false
                inspect_id:
                  type: integer
                  description: 'ID da vistoria vinculada.'
                  example: 1
                  nullable: false
                icon:
                  type: string
                  description: 'Ícone do ambiente.'
                  example: 'ics ic-address-book'
                  nullable: false
                condition:
                  type: string
                  description: 'Condição do ambiente. Valores: new, good, regular, used, bad, terrible.'
                  example: good
                  nullable: false
                notes:
                  type: array
                  description: 'Observações do ambiente (array JSON).'
                  example: null
                  items:
                    type: string
    delete:
      summary: Excluir
      operationId: excluir
      description: 'Exclui um ambiente de vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the environment.'
        example: nihil
        required: true
        schema:
          type: string
      -
        in: path
        name: environment
        description: 'Id do Ambiente.'
        example: 1
        required: true
        schema:
          type: integer
  /inspect/items:
    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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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%'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          in: query
          name: 'filter[type]'
          description: 'Filtra por tipo de item. Padrão: item. Valores: item, key, meter, environment.'
          example: item
          required: false
          schema:
            type: string
            description: 'Filtra por tipo de item. Padrão: item. Valores: item, key, meter, environment.'
            example: item
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    post:
      summary: Criar
      operationId: criar
      description: 'Cria um novo item de vistoria.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do item.'
                  example: Lampada
                  nullable: false
                environment_id:
                  type: integer
                  description: 'ID do ambiente vinculado.'
                  example: 1
                  nullable: false
                icon:
                  type: string
                  description: 'Ícone do item.'
                  example: 'ics ic-address-book'
                  nullable: false
                condition:
                  type: string
                  description: 'Condição do item. Valores: new, good, regular, used, bad, terrible.'
                  example: good
                  nullable: false
                notes:
                  type: array
                  description: 'Observações do item (array JSON).'
                  example: null
                  items:
                    type: string
              required:
                - description
                - environment_id
  '/inspect/items/{id}':
    get:
      summary: Obter
      operationId: obter
      description: 'Obtém os detalhes de um item de vistoria específico.'
      parameters:
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    put:
      summary: Alterar
      operationId: alterar
      description: 'Altera os dados de um item de vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: 'Descrição do item.'
                  example: Lampada
                  nullable: false
                environment_id:
                  type: integer
                  description: 'ID do ambiente vinculado.'
                  example: 1
                  nullable: false
                icon:
                  type: string
                  description: 'Ícone do item.'
                  example: 'ics ic-address-book'
                  nullable: false
                condition:
                  type: string
                  description: 'Condição do item. Valores: new, good, regular, used, bad, terrible.'
                  example: good
                  nullable: false
                notes:
                  type: array
                  description: 'Observações do item (array JSON).'
                  example: null
                  items:
                    type: string
    delete:
      summary: Excluir
      operationId: excluir
      description: 'Exclui um item de vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the item.'
        example: qui
        required: true
        schema:
          type: string
      -
        in: path
        name: item
        description: 'Id do Item.'
        example: 1
        required: true
        schema:
          type: integer
  /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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    post:
      summary: Criar
      operationId: criar
      description: 'Cria uma nova vistoria.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reference:
                  type: string
                  description: 'Referência única da vistoria.'
                  example: VIS-2024-01
                  nullable: false
                type:
                  type: string
                  description: 'Tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.'
                  example: entrance
                  nullable: false
                status:
                  type: string
                  description: 'Status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.'
                  example: pending
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do contrato vinculado.'
                  example: 123
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do imóvel vinculado.'
                  example: 456
                  nullable: false
                user_id:
                  type: integer
                  description: 'Responsável pela vistoria.'
                  example: 3
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa vinculada.'
                  example: 1
                  nullable: false
                date:
                  type: string
                  description: 'Data da vistoria (YYYY-MM-DD).'
                  example: '2025-05-01'
                  nullable: false
                area:
                  type: number
                  description: 'Metragem da vistoria.'
                  example: 120.5
                  nullable: false
                furniture:
                  type: string
                  description: 'Mobília. Valores possíveis: furnished, semi_furnished, unfurnished.'
                  example: furnished
                  nullable: false
                tag:
                  type: integer
                  description: 'ID da tag vinculada.'
                  example: 7
                  nullable: false
                notes:
                  type: array
                  description: 'Observações gerais (array JSON).'
                  example:
                    - 'Obs. 1'
                    - 'Obs. 2'
                  items:
                    type: string
                father_id:
                  type: integer
                  description: 'ID da vistoria principal (quando esta for uma reedição).'
                  example: 10
                  nullable: false
                environments:
                  type: array
                  description: 'Ambientes da vistoria.'
                  example:
                    - et
                  items:
                    type: string
                keys:
                  type: array
                  description: 'Itens do tipo chave.'
                  example:
                    -
                      description: 'Chave da porta da frente'
                  items:
                    type: string
                meters:
                  type: array
                  description: 'Itens do tipo medidor.'
                  example:
                    -
                      description: 'Medidor de água'
                  items:
                    type: string
                files:
                  type: array
                  description: 'Arquivos relacionados à vistoria.'
                  example:
                    - cum
                  items:
                    type: string
              required:
                - reference
                - type
                - status
  '/inspects/{id}':
    get:
      summary: Obter
      operationId: obter
      description: 'Obtém os detalhes de uma vistoria específica.'
      parameters:
        -
          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'
            nullable: false
        -
          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
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
        -
          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'
            nullable: false
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    put:
      summary: Alterar
      operationId: alterar
      description: 'Altera os dados de uma vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                reference:
                  type: string
                  description: 'Referência única da vistoria.'
                  example: VIS-2024-01
                  nullable: false
                type:
                  type: string
                  description: 'Tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.'
                  example: entrance
                  nullable: false
                status:
                  type: string
                  description: 'Status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.'
                  example: pending
                  nullable: false
                contract_id:
                  type: integer
                  description: 'ID do contrato vinculado.'
                  example: 123
                  nullable: false
                building_id:
                  type: integer
                  description: 'ID do imóvel vinculado.'
                  example: 456
                  nullable: false
                user_id:
                  type: integer
                  description: 'Responsável pela vistoria.'
                  example: 3
                  nullable: false
                business_id:
                  type: integer
                  description: 'ID da empresa vinculada.'
                  example: 1
                  nullable: false
                date:
                  type: string
                  description: 'Data da vistoria (YYYY-MM-DD).'
                  example: '2025-05-01'
                  nullable: false
                area:
                  type: number
                  description: 'Metragem da vistoria.'
                  example: 120.5
                  nullable: false
                furniture:
                  type: string
                  description: 'Mobília. Valores possíveis: furnished, semi_furnished, unfurnished.'
                  example: furnished
                  nullable: false
                tag:
                  type: integer
                  description: 'ID da tag vinculada.'
                  example: 7
                  nullable: false
                notes:
                  type: array
                  description: 'Observações gerais (array JSON).'
                  example:
                    - 'Obs. 1'
                    - 'Obs. 2'
                  items:
                    type: string
                father_id:
                  type: integer
                  description: 'ID da vistoria principal (quando esta for uma reedição).'
                  example: 10
                  nullable: false
                environments:
                  type: array
                  description: 'Ambientes da vistoria.'
                  example:
                    - consequuntur
                  items:
                    type: string
                keys:
                  type: array
                  description: 'Itens do tipo chave.'
                  example:
                    -
                      description: 'Chave da porta da frente'
                  items:
                    type: string
                meters:
                  type: array
                  description: 'Itens do tipo medidor.'
                  example:
                    -
                      description: 'Medidor de água'
                  items:
                    type: string
                files:
                  type: array
                  description: 'Arquivos relacionados à vistoria.'
                  example:
                    - a
                  items:
                    type: string
    delete:
      summary: Excluir
      operationId: excluir
      description: 'Exclui uma vistoria existente.'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      tags:
        - Vistorias
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the inspect.'
        example: unde
        required: true
        schema:
          type: string
      -
        in: path
        name: inspect
        description: 'Id da Vistoria.'
        example: 1
        required: true
        schema:
          type: integer
  '/inspect/{inspect_id}/duplicate':
    post:
      summary: Duplicar
      operationId: duplicar
      description: '<aside>🔒 Para acessar essa rota é necessária a permissão de cadastro de Vistorias</aside>'
      parameters: []
      responses:
        404:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  return: false
                  message: 'Este recurso não foi encontrado.'
                  status: 404
                  errors: []
                properties:
                  return:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Este recurso não foi encontrado.'
                  status:
                    type: integer
                    example: 404
                  errors:
                    type: array
                    example: []
      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: true
                  nullable: false
                keys:
                  type: boolean
                  description: 'Define se duplica as chaves da vistoria'
                  example: false
                  nullable: false
                meters:
                  type: boolean
                  description: 'Define se duplica os medidores da vistoria'
                  example: true
                  nullable: false
                persons:
                  type: boolean
                  description: 'Define se duplica as pessoas da vistoria'
                  example: true
                  nullable: false
                medias:
                  type: boolean
                  description: 'Define se duplica as fotos da vistoria'
                  example: true
                  nullable: false
    parameters:
      -
        in: path
        name: inspect_id
        description: 'The ID of the inspect.'
        example: 9
        required: true
        schema:
          type: integer
      -
        in: path
        name: inspect
        description: 'ID da Vistoria'
        example: 11
        required: true
        schema:
          type: integer
tags:
  -
    name: 'Classificação dos Imóveis'
    description: ''
  -
    name: Condomínios
    description: ''
  -
    name: Construtoras
    description: ''
  -
    name: 'Equipes de Usuários'
    description: ''
  -
    name: Eventos
    description: ''
  -
    name: Financeiro
    description: ''
  -
    name: 'Grupos de Usuários'
    description: ''
  -
    name: Históricos
    description: ''
  -
    name: Imóveis
    description: ''
  -
    name: Leads
    description: ''
  -
    name: Localizações
    description: ''
  -
    name: Negócios
    description: ''
  -
    name: Pessoas
    description: ''
  -
    name: Propostas
    description: ''
  -
    name: 'Regras para Rodízio de Leads'
    description: ''
  -
    name: Tickets
    description: ''
  -
    name: Usuários
    description: ''
  -
    name: Vistorias
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: '<aside class="notice">Para gerar seu Token de API entre em contato com o suporte da <a href="https://web.whatsapp.com/send?l=pt_br&phone=5547989050935&text=Preciso%20gerar%20um%20token%20de%20API%20da%20Apresenta.me" target="whatsapp">Apresenta.me</a></aside>'
security:
  -
    default: []