voltar

API Referências: Aluguel | AtualizarTitulo

post /api/Aluguel/AtualizarTitulo?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Aluguel: varchar,
     Empresa: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | AvisoAntecedenciaVencimento

post /api/Aluguel/AvisoAntecedenciaVencimento?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: AvisoAntecedenciaVencimento não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | ListarRelatorioPrincipal

post /api/Aluguel/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Aluguel: uniqueidentifier,
          AutonumeracaoEmpresa: int,
          Cidade: string,
          Cliente: string,
          ClienteValor: uniqueidentifier,
          Email: string,
          Hash: uniqueidentifier,
          Imovel: string,
          Imovel: string,
          ImovelValor: uniqueidentifier,
          Inicio: smalldatetime,
          Periodo: string,
          Termino: smalldatetime,
          Valor: decimal(18,2),
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | ReportReciboMensalidade

post /api/Aluguel/ReportReciboMensalidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdAluguelMensalidade: varchar,
     IdEmpresa: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AluguelMensalidade: uniqueidentifier,
          Cliente: string,
          Codigo: string,
          DespesaDsTitulo: string,
          DespesaNrValor: string,
          Endereco: string,
          Hoje: string,
          Incidencia: string,
          Loja: string,
          Pagamento: string,
          Parcela: int,
          Periodo: string,
          ValorAluguel: string,
          ValorFinal: string,
          ValorTotalDespesas: string,
          Vigencia: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | Consultar

post /api/Aluguel/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: smalldatetime,
          Categoria: int,
          Cliente: uniqueidentifier,
          DiasNotificacaoClienteVencimentoAluguel: int,
          DiasNotificacaoCorretorVencimentoAluguel: int,
          DiasNotificacaoGrupoVencimentoAluguel: int,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Imovel: uniqueidentifier,
          Inicio: smalldatetime,
          Notificavel: bit,
          Observacao: string,
          ObservacoesAdicionais: text,
          Periodicidade: int,
          Privado: bit,
          Recorrencia: uniqueidentifier,
          ReferenteGrupoUsuarioResponsavel: uniqueidentifier,
          ReferenteGrupoUsuarioResponsavelDescricao: string,
          ReferenteGrupoUsuarioResponsavelTipo: string,
          Termino: smalldatetime,
          Titulo: string,
          Unidade: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          Valor: decimal(18,2),
          VirtualAluguelComissao: text,
          VirtualAluguelDespesa: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | Excluir

post /api/Aluguel/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | Listar

post /api/Aluguel/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: smalldatetime,
          Categoria: int,
          Cliente: uniqueidentifier,
          DiasNotificacaoClienteVencimentoAluguel: int,
          DiasNotificacaoCorretorVencimentoAluguel: int,
          DiasNotificacaoGrupoVencimentoAluguel: int,
          Empresa: uniqueidentifier,
          Frequencia: int,
          Hash: uniqueidentifier,
          Imovel: uniqueidentifier,
          Inicio: smalldatetime,
          Notificavel: bit,
          Observacao: string,
          ObservacoesAdicionais: text,
          Periodicidade: int,
          Privado: bit,
          Recorrencia: uniqueidentifier,
          ReferenteGrupoUsuarioResponsavel: uniqueidentifier,
          Termino: smalldatetime,
          Titulo: string,
          Unidade: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          Valor: decimal(18,2),
          VirtualAluguelComissao: text,
          VirtualAluguelDespesa: text,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluguel | Salvar

post /api/Aluguel/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cliente: uniqueidentifier,
     ConsultarPorCampo: varchar,
     DiasNotificacaoClienteVencimentoAluguel: int,
     DiasNotificacaoCorretorVencimentoAluguel: int,
     DiasNotificacaoGrupoVencimentoAluguel: int,
     Empresa: varchar,
     Frequencia: int,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Imovel: uniqueidentifier,
     Inicio: smalldatetime,
     Modo: varchar,
     Notificavel: bit,
     Observacao: varchar,
     ObservacoesAdicionais: text,
     Periodicidade: int,
     Privado: bit,
     Recorrencia: uniqueidentifier,
     ReferenteGrupoUsuarioResponsavel: uniqueidentifier,
     RetornarDataSet: bit,
     Termino: smalldatetime,
     Titulo: varchar,
     Unidade: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     Valor: decimal,
     ValorConsultaPorCampo: varchar,
     VirtualAluguelComissao: text,
     VirtualAluguelDespesa: text,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/aluguel?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token