Artigos sobre: Configurações

API Groner — campos e tipos: SimulacaoGeracaoMensal a VisitaTecnicaInputDTO

Dicionário de campos dos contratos usados na referência. Nomes são os da propriedade C# ou do JsonProperty explícito; respeite o schema da operação.


Guia principal · Exemplo completo · Campos


Índice clicável


SimulacaoGeracaoMensal · SimulacaoInputDTO · SimulacaoPayBackAno · SincronizarRecebimentosCrmInputDTO · StatusAtuaisProjeto · StatusCompra · StatusLead · StatusLeadInputDTO · StatusOrdemServico · StatusPreProposta · StatusProjeto · StatusTarefa · StatusTarefaInputDto · StatusVenda · SubstituirItemSeparacaoInputDTO · TabelaInssInputDTO · TabelaIrrfInputDTO · TabelaSalarioFamiliaInputDTO · Tarefa · TarefaEtiqueta · TarefaInputDTO · TarefaPendencia · TarefaVinculadaResumoDTO · Tarefa_Status · TipoAlerta · TipoAlertaInputDTO · TipoContato · TipoEdificacao · TipoEntregaCompra · TipoPendencia · TipoProjeto · TipoServico · TipoTarefa · TipoTarefaAgenteConfig · TipoTarefaInputDTO · TipoTelhado · TipoVenda · TituloPagarInputDTO · TituloReceberInputDTO · TituloRecorrenteInputDTO · ToggleEmAtendimentoSafeZapInputDTO · TrancheFinanciamentoInputDTO · TransferenciaEstoqueInputDTO · TransporteNotaInputDTO · UnidadeConsumidora · UnidadeConsumidoraInputDTO · UserClickSignOutputDTO · Usuario · UsuarioTarefa · ValorExtraAplicado · VeiculoInputDTO · Venda · VerificarConflitoOrdemServicoInputDTO · VincularCalendarioGoogleInputDTO · VincularCatalogoInputDTO · VincularNotaRecebidaInputDTO · VincularPedidosInputDTO · VinculoCatalogoItemInputDTO · VisitaTecnica · VisitaTecnicaInputDTO



Como interpretar os campos


? indica anulável; List<T>/T[] são arrays; long/int são inteiros; double/decimal são números JSON. DateTime segue o contrato de fuso da action. [Required] não cobre todas as validações de negócio. Campos ignorados por JSON foram excluídos. Tipos homônimos exigem conferir o namespace da operação.


Exemplo de uso


Consultar a frota de usinas


Requisição completa (Bash):


curl --request GET \
  --url "$MONITORAMENTO_URL/api/v1/plants?page=1&limit=20" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Accept: application/json"


Resposta ilustrativa — HTTP 200:


{
  "success": true,
  "data": {
    "data": [],
    "total": 0,
    "page": 1,
    "limit": 20,
    "totalPages": 0,
    "hasNextPage": false,
    "hasPreviousPage": false
  },
  "timestamp": 1791979200000
}


A lista está em data.data; page e limit não são PageNumber e PageSize. IDs de usina e equipamentos são UUIDs do Monitoramento. O vínculo com o negócio usa external_project_id, não uma substituição direta de UUID por ProjetoId.


O exemplo é fictício, baseado no contrato conferido no código. As respostas não foram coletadas em produção.


Contratos


SimulacaoGeracaoMensal


  • Id: long.
  • Mes: string.
  • RadiacaoSolar: double.
  • Geracao: double.
  • Consumo: double.
  • ConsumoInstantaneo: double.
  • GeracaoInjetada: double.
  • Porcentagem: double.


Voltar ao índice


SimulacaoInputDTO


  • projetoId: long?.
  • Projeto: Projeto — Projeto.
  • Nome: string.
  • Celular: string.
  • Email: string.
  • Latitude: string.
  • Longitude: string.
  • TipoEstrutura: TipoEstruturaSimulador.
  • FaceTelhado: string.
  • Endereco: Endereco — Endereco.
  • TipoLead: TipoLead?.
  • Nota: string.
  • FinanciamentosIds: List<long>.
  • QuantidadePlacas: double?.
  • TodosFinanciamentos: bool.
  • CustosExtras: List<CustoExtraPropostaInputDTO> — CustoExtraPropostaInputDTO.
  • PorcentagemDesconto: double.


Voltar ao índice


SimulacaoPayBackAno


  • Id: long.
  • Ano: int.
  • ValorProduzidoAnualmente: double.
  • CustoManutencao: double.
  • TarifaMinima: double.
  • FluxoCaixa: double.
  • VPL: double.
  • Sobra: double.
  • ValorPoupanca: double.
  • Saldo: double.
  • ContaComEnergiaAnual: double.
  • ValorInjetadoAnualmente: double.
  • GeracaoAnual: double.
  • ContaSemEnergiaAnual: double.
  • ContaComEnergiaAnualAntes: double.
  • EconomiaAnual: double.
  • EconomiaAnualAntes: double.
  • PorcentagemEficiencia: double.
  • PorcentagemEficienciaAntes: double.
  • ContaComEnergiaMensal: double.
  • ContaComEnergiaMensalAntes: double.
  • EconomiaMensal: double.
  • EconomiaMensalAntes: double.
  • ValorInjetadoMensalmente: double.
  • ValorInjetadoDiariamente: double.
  • AnoDescrito: int.
  • ContaSemEnergiaMensal: double.
  • ValorDisponibilidade: double.
  • ValorkWh: double.
  • ValorTUSDFioB: double.
  • PorcentagemEscalaTUSDFioB: double.
  • ValorTUSDFioBComDesconto: double.
  • ValorkWhPonta: double.
  • LucroAnual: double.
  • LucroMensal: double.
  • FluxoCaixaLucro: double.


Voltar ao índice


SincronizarRecebimentosCrmInputDTO


  • ConfirmarDadosFinanceiros: bool.
  • AtivarSincronizacao: bool.
  • ContaBancariaId: long?.


Voltar ao índice


StatusAtuaisProjeto


  • ProjetoId: long.
  • EtapaId: long.
  • StatusId: long.
  • Projeto: Projeto — Projeto.
  • Etapa: EtapaLead — EtapaLead.
  • Status: StatusProjeto — StatusProjeto.
  • Data: DateTime.


Voltar ao índice


StatusCompra


  • Id: long.
  • Nome: string.
  • Tipo: TipoEnumStatusCompra.


Voltar ao índice


StatusLead


  • Id: long.
  • Ativo: bool.
  • Excluido: bool.
  • DataExclusao: DateTime?.
  • Nome: string.
  • Cor: string.
  • Tempo: int.
  • Ordem: int.
  • Etapa: EtapaLead — EtapaLead.
  • Funcoes: IList<FuncaoStatusLead> — FuncaoStatusLead.
  • FuncoesNotificar: IList<FuncaoNotificarStatusLead> — FuncaoNotificarStatusLead.
  • StatusDisponiveis: string.
  • ModeloEmailNotificarLead: ModeloEmail — ModeloEmail.
  • TempoDiasEmailNotificarLead: int.
  • ModeloEmailNotificarResponsavel: ModeloEmail — ModeloEmail.
  • TempoDiasEmailNotificarResponsavel: int.
  • ModeloEmailNotificarEmails: ModeloEmail — ModeloEmail.
  • TempoDiasEmailNotificarEmails: int.
  • EmailsNotificar: string.
  • Notificacao: string.


Voltar ao índice


StatusLeadInputDTO


  • EtapaId: long.
  • Nome: string.
  • Tempo: int.
  • TipoTempo: TipoTempoEnum.


Voltar ao índice


StatusOrdemServico


  • Id: long.
  • Nome: string.
  • Cor: string.
  • Tipo: TipoStatusOrdemServicoEnum.


Voltar ao índice


StatusPreProposta


Herança: BaseStatusModel — BaseStatusModel.


  • SePropostaAceita: bool.


Voltar ao índice


StatusProjeto


  • Id: long.
  • Ativo: bool.
  • Excluido: bool.
  • Tipo: TipoStatusEnumProjeto.
  • DataExclusao: DateTime?.
  • Nome: string.
  • Cor: string.
  • ExternalId: string.
  • WebhookUrl: string.
  • Tempo: int.
  • PorcentagemPrevisao: double.
  • Ordem: int.
  • NaoGerarProposta: bool.
  • NaoAceitarProposta: bool.
  • NaoGerarVenda: bool.
  • NaoAlterarPagamento: bool.
  • TemProposta: bool.
  • TemPropostaAceita: bool.
  • TemVenda: bool.
  • TemTecnico: bool.
  • TemTipoTelhado: bool.
  • TemConcessionaria: bool.
  • TemConsumo: bool.
  • TemCelular: bool.
  • TemEmail: bool.
  • TemArquivos: bool.
  • TemDocumentos: bool.
  • TemUnidadeConsumidora: bool.
  • TemEndereco: bool.
  • TemFaceTelhado: bool.
  • TemFotoContaEnergia: bool.
  • NaoTemTarefaPendentes: bool.
  • NaoTemPendenciasObrigatoriasAbertas: bool.
  • CamposPersonalizadosObrigatorios: string.
  • CategoriaArquivosObrigatorios: string.
  • StatusObrigatorios: string.
  • TipoCondicaoEnumStatusObrigatorios: TipoCondicaoEnumStatusObrigatorios.
  • Etapa: EtapaLead — EtapaLead.
  • EtapaId: long?.
  • Funcoes: IList<FuncaoStatusProjeto> — FuncaoStatusProjeto.
  • FuncoesVisualizar: IList<FuncaoVisualizarStatusProjeto> — FuncaoVisualizarStatusProjeto.
  • FuncoesNotificar: IList<FuncaoNotificarStatusProjeto> — FuncaoNotificarStatusProjeto.
  • StatusLeadGatilho: StatusLead — StatusLead.
  • StatusDisponiveis: string.
  • ModeloEmailNotificarLead: ModeloEmail — ModeloEmail.
  • ModeloEmailNotificarResponsavel: ModeloEmail — ModeloEmail.
  • ModeloEmailNotificarEmails: ModeloEmail — ModeloEmail.
  • EmailsNotificar: string.
  • NotificacaoVendedor: string.
  • NotificacaoTecnico: string.
  • NotificacaoPreVendedor: string.
  • NotificacaoFuncoes: string.
  • NotificacaoCelulares: string.
  • CelularesNotificar: string.
  • NotificacaoUrlAudio: string.
  • NotificacaoUrlImagem: string.
  • NotificacaoUrlVideo: string.
  • NotificacaoUrlDocumento: string.
  • NotificarComMeta: bool.
  • NotificacaoInstanceId: string.
  • NotificacaoTemplateId: string.
  • NotificacaoVariaveisJson: string.
  • NotificacaoInstanceIdComum: string.
  • NotificacaoTemFallback: bool.
  • NotificacoesMeta: IList<NotificacaoMetaStatusProjeto> — NotificacaoMetaStatusProjeto.
  • Notificacao: string.
  • Descricao: string.
  • StatusAutomaticos: string.
  • RemoverAoMover: bool.
  • TemFaseEnergetica: bool.
  • TemDocumentoCPFCNPJ: bool.
  • TemDataNascimento: bool.
  • TemNota: bool.


Voltar ao índice


StatusTarefa


  • Id: long.
  • Nome: string.
  • Cor: string.
  • Posicao: int.
  • Tipo: TipoStatusTarefaEnum.
  • StatusLeadGatilho: StatusLead — StatusLead.
  • StatusProjetoGatilho: StatusProjeto — StatusProjeto.
  • DisparaAnalisador: bool. Quando uma Tarefa entra neste status, dispara o Analisador (se TipoTarefaAgenteConfig.AnalisadorHabilitado).
  • DisparaExecutor: bool. Quando uma Tarefa entra neste status, dispara o Executor (se TipoTarefaAgenteConfig.ExecutorHabilitado).
  • ReservadoSistema: bool. Status criado via seed do sistema (não pode ser editado/excluído pelo admin). Vinculado aos valores 10–19 do TipoStatusTarefaEnum.


Voltar ao índice


StatusTarefaInputDto


  • Nome: string.
  • Cor: string.
  • Tipo: TipoStatusTarefaEnum?.


Voltar ao índice


StatusVenda


  • Id: long.
  • Nome: string.
  • Tipo: TipoStatusVendaEnum.
  • Cor: string.
  • Ordem: int. Ordem de exibição no seletor.


Voltar ao índice


SubstituirItemSeparacaoInputDTO


  • ItemId: long. Trocar um item por outro: o do pedido acabou e vai o equivalente. Quantidade null = troca tudo o que resta previsto.
  • NovoInsumoId: long.
  • Quantidade: decimal?.
  • Motivo: string. Por que trocou — vira a observação do evento na trilha.


Voltar ao índice


TabelaInssInputDTO


  • Competencia: DateTime. Corpo de criação de tabela de INSS com suas faixas (RH/Folha).
  • Descricao: string.
  • Faixas: List<FaixaInssInputDTO> — FaixaInssInputDTO.


Voltar ao índice


TabelaIrrfInputDTO


  • Competencia: DateTime. Corpo de criação de tabela de IRRF com suas faixas (RH/Folha).
  • Descricao: string.
  • DeducaoPorDependente: double.
  • DescontoSimplificado: double.
  • Faixas: List<FaixaIrrfInputDTO> — FaixaIrrfInputDTO.


Voltar ao índice


TabelaSalarioFamiliaInputDTO


  • Competencia: DateTime. Corpo de criação de tabela de salário-família com faixas (RH/Folha).
  • Descricao: string.
  • Faixas: List<FaixaSalarioFamiliaInputDTO> — FaixaSalarioFamiliaInputDTO.


Voltar ao índice


Tarefa


Herança: BaseModel — BaseModel.


  • Posicao: int.
  • Titulo: string.
  • Descricao: string.
  • DataInicial: DateTime.
  • DataEntrega: DateTime.
  • DataConclusao: DateTime?.
  • Prioridade: PrioridadeTarefaEnum.
  • Projeto: Projeto — Projeto.
  • ProjetoId: long?.
  • StatusLeadRegra: StatusLead — StatusLead.
  • StatusProjetoRegra: StatusProjeto — StatusProjeto.
  • Usuario: Usuario — Usuario.
  • Usuarios: IList<UsuarioTarefa> — UsuarioTarefa.
  • Status: StatusTarefa — StatusTarefa.
  • StatusId: long?.
  • Historico: IList<Tarefa_Status> — Tarefa_Status.
  • Comentarios: IList<ComentarioTarefa> — ComentarioTarefa.
  • Checklist: IList<Checklist> — Checklist.
  • Arquivos: IList<Arquivo> — Arquivo.
  • Etiquetas: IList<TarefaEtiqueta> — TarefaEtiqueta.
  • Pendencias: IList<TarefaPendencia> — TarefaPendencia.
  • Tipo: TipoTarefa — TipoTarefa.
  • TipoId: long?.
  • OrdemServico: OrdemServico — OrdemServico.
  • OrdemServicoId: long?.
  • VisitaTecnica: VisitaTecnica — VisitaTecnica.
  • VisitaTecnicaId: long?.
  • Compra: Compra — Compra.
  • CompraId: long?.
  • Reuniao: Reuniao. Reunião de origem. Mesmo padrão dos vínculos acima: cobre tanto a tarefa que agendou a reunião quanto os próximos passos que a IA cria a partir dela (esses nascem com CriadaPorAgente = true).
  • ReuniaoId: long?.
  • ReuniaoTitulo: string.
  • Bloqueado: bool.
  • DependenciaId: long?.
  • Dependencia: Tarefa — Tarefa.
  • Dependentes: ICollection<Tarefa> — Tarefa.
  • TarefaPaiId: long?.
  • TarefaPai: Tarefa — Tarefa.
  • Subtarefas: ICollection<Tarefa> — Tarefa.
  • QuantidadeCamposTotais: int.
  • QuantidadeCamposRespondidos: int.
  • PeriodoMinutos: int?.
  • FinalizadoPor: Usuario — Usuario.
  • BriefingHtml: string. HTML renderizado pelo Analisador (briefing final). NULL se nunca analisado.
  • CriadaPorAgente: bool. True quando a tarefa foi criada por um Executor (subtarefa automática).


Voltar ao índice


TarefaEtiqueta


  • Data: DateTime.
  • Tarefa: Tarefa — Tarefa.
  • TarefaId: long.
  • Etiqueta: EtiquetaTarefa — EtiquetaTarefa.
  • EtiquetaId: long.


Voltar ao índice


TarefaInputDTO


  • Descricao: string.
  • Titulo: string.
  • DataInicial: DateTime.
  • DataEntrega: DateTime.
  • ProjetoId: long?.
  • StatusLeadId: long?.
  • StatusId: long?.
  • DependenciaTarefaId: long?.
  • TipoId: long.
  • OrdemServicoId: long?.
  • VisitaTecnicaId: long?.
  • ReuniaoId: long?. Reunião de onde a tarefa saiu. Mesmo desenho de OrdemServicoId: quem cria já diz a que a tarefa pertence, em vez de ligar depois — e o vínculo é o que faz "o que ficou combinado" ter para onde voltar.
  • UsuariosIds: List<long>.
  • EtiquetasIds: List<long>.
  • Prioridade: PrioridadeTarefaEnum.
  • RespostasCamposPersonalizados: List<RespostaCampoPersonalizadoTarefaInputDTO> — RespostaCampoPersonalizadoTarefaInputDTO.
  • TarefaPaiId: long?.
  • ArquivosIds: List<long>.
  • PendenciaIds: List<long>. Pendências a vincular (N:N) — concluir a tarefa auto-resolve elas.


Voltar ao índice


TarefaPendencia


  • TarefaId: long. Vínculo N:N entre Tarefa e Pendência. Concluir a tarefa auto-resolve as pendências vinculadas ainda abertas (ver TarefaService.AoFinalizarTarefaAsync). Chave composta (TarefaId, PendenciaId) — espelho do join TarefaEtiqueta.
  • Tarefa: Tarefa — Tarefa.
  • PendenciaId: long.
  • Pendencia: Pendencia — Pendencia.
  • DataInclusao: DateTime.


Voltar ao índice


TarefaVinculadaResumoDTO


  • Id: long. Resumo de uma tarefa vinculada a uma pendência (para a UI mostrar o status). Não mapeado.
  • Titulo: string.
  • StatusNome: string.
  • Finalizada: bool.
  • DataConclusao: DateTime?.


Voltar ao índice


Tarefa_Status


  • Id: long.
  • DataStatus: DateTime.
  • Observacao: string.
  • Usuario: Usuario — Usuario.
  • Status: StatusTarefa — StatusTarefa.
  • StatusId: long?.
  • Tarefa: Tarefa — Tarefa.
  • Lembretes: IList<Lembrete> — Lembrete.


Voltar ao índice


TipoAlerta


  • Id: long.
  • Nome: string.
  • Cor: string.
  • Mensagem: string.
  • StatusNegocioId: long?.


Voltar ao índice


TipoAlertaInputDTO


  • nome: string.
  • cor: string.
  • statusNegocioId: long?.
  • mensagem: string.


Voltar ao índice


TipoContato


  • Id: long.
  • Nome: string.


Voltar ao índice


TipoEdificacao


  • Id: long.
  • Nome: string.


Voltar ao índice


TipoEntregaCompra


  • Id: long.
  • Nome: string.
  • EntregaImediata: bool.
  • EntregaAgendada: bool.
  • RetiradaLoja: bool.


Voltar ao índice


TipoPendencia


  • Id: long.
  • Nome: string.
  • Cor: string.
  • UrlIcone: string.
  • TituloPadrao: string. Preenche o Título da pendência ao selecionar o tipo (opcional).
  • TextoPadrao: string. Preenche a Descrição da pendência ao selecionar o tipo (opcional).
  • ExigirConferencia: bool. false → resolver a pendência já a marca como Conferida (pula a fila de conferência). Default true: comportamento atual preservado.
  • SetorId: long?.
  • Setor: Setor — Setor.
  • CadenciaAtiva: bool.
  • CadenciaIntervaloDias: int.
  • CadenciaMaxLembretes: int.
  • CadenciaAlvo: AlvoPendenciaEnum. Interna → cobra os usuários do time; Externa → cobra o Lead/Cliente (WhatsApp).
  • NotificarAoCriar: bool.
  • NotificacaoWhatsApp: bool.
  • NotificacaoEmail: bool.
  • NotificacaoInApp: bool.
  • NotificacaoResponsaveisNegocio: bool.
  • NotificacaoLead: bool.
  • NotificacaoSetor: bool.
  • NotificacaoUsuarios: string. CSV de UsuarioIds destinatários. Exposto no JSON via NotificacaoUsuarioIds.
  • NotificacaoMensagem: string. Texto com placeholders ({titulo}, {negocio}, {lead}, {link}); null = padrão do sistema.
  • NotificacaoGerarIA: bool. true → gera o texto por IA no momento do envio (ignora NotificacaoMensagem).
  • MetaInstanceId: string.
  • MetaTemplateId: string.
  • MetaVariaveisJson: string. JSON [{Posicao, Valor}] das variáveis {{n}} do template.
  • NotificacaoInstanceIdComum: string.
  • NotificacaoTemFallback: bool.


Voltar ao índice


TipoProjeto


  • Id: long.
  • Nome: string.
  • AbasEscondidas: string. Abas do detalhe do negócio escondidas para este tipo de projeto (chaves de aba separadas por ';', ex.: "monitoramento;financiamentos"). Null/vazio = nenhuma aba escondida.
  • PorcentagemSimultaneidade: double.
  • ConfiguracaoSimulador: ConfiguracaoSimulador — ConfiguracaoSimulador.
  • Ordem: int.


Voltar ao índice


TipoServico


  • DataCadastro: DateTime.
  • Id: long.
  • Nome: string.
  • Cor: string.
  • DuracaoTempoEsperaEstimadoMinutos: int.
  • DuracaoTempoServicoEstimadoMinutos: int.
  • FormulaComplexidade: string.
  • Funcoes: string.
  • SetorId: long?.
  • Setor: Setor — Setor.
  • MateriaisFaturaveis: bool. Quando true, os materiais (insumos) consumidos na OS deste tipo são faturados ao cliente (somados por cima da mão de obra). Quando false, materiais entram apenas como custo.
  • Finalidade: FinalidadeTipoServicoEnum. Papel do tipo no ciclo da instalação (Instalação/Entrega/Vistoria) — vincula as OS do negócio à Instalação nos indicadores/detalhe. Nenhuma = comum.


Voltar ao índice


TipoTarefa


  • Id: long.
  • Nome: string.
  • TituloPadrao: string.
  • TempoEstimado: int.
  • Usuarios: string.
  • UrlIcone: string.
  • Cor: string.
  • TextoPadrao: string.
  • Objetivo: ObjetivoTarefaEnum.
  • SetorId: long?.
  • Setor: Setor — Setor.
  • Funcoes: string.
  • SincronizarGoogleCalendar: bool.
  • NomeCalendarioGoogle: string.
  • ImportarEventosNovosAutomaticamente: bool.


Voltar ao índice


TipoTarefaAgenteConfig


  • Id: long. Configuração 1:1 com TipoTarefa que liga/desliga e parametriza os agentes (Analisador e Executor). Lambda Node/TS lê esta config via /api/internal/agentes/contexto e executa de forma estritamente declarativa.
  • TipoTarefaId: long.
  • TipoTarefa: TipoTarefa — TipoTarefa.
  • LlmProvider: string.
  • LlmModelo: string.
  • LlmEndpointUrl: string.
  • LlmApiKeySecretArn: string.
  • LlmTemperature: decimal?.
  • LlmMaxOutputTokens: int?.
  • LlmTimeoutSeconds: int.
  • LlmMaxRetries: int.
  • LlmExtraConfigJson: string.
  • AnalisadorHabilitado: bool.
  • AnalisadorSystemPrompt: string.
  • AnalisadorContextoQuery: string.
  • AnalisadorOutputJsonSchema: string.
  • AnalisadorMaxRoundsPergunta: int.
  • AnalisadorPermiteAnexos: bool.
  • AnalisadorMascararPII: bool.
  • AnalisadorStatusInicialId: long?.
  • AnalisadorStatusInicial: StatusTarefa — StatusTarefa.
  • AnalisadorStatusConcluidoId: long?.
  • AnalisadorStatusConcluido: StatusTarefa — StatusTarefa.
  • AnalisadorStatusBloqueioCreditoId: long?.
  • AnalisadorStatusBloqueioCredito: StatusTarefa — StatusTarefa.
  • ExecutorHabilitado: bool.
  • ExecutorSystemPrompt: string.
  • ExecutorOutputJsonSchema: string.
  • ExecutorAcoesPermitidasJson: string.
  • ExecutorMcpServersJson: string.
  • ExecutorApisExternasJson: string.
  • ExecutorRequerAprovacaoHumana: bool.
  • ExecutorDryRunFirst: bool.
  • ExecutorRollbackHabilitado: bool.
  • ExecutorStatusInicialId: long?.
  • ExecutorStatusInicial: StatusTarefa — StatusTarefa.
  • ExecutorStatusAguardandoAprovacaoId: long?.
  • ExecutorStatusAguardandoAprovacao: StatusTarefa — StatusTarefa.
  • ExecutorStatusConcluidoId: long?.
  • ExecutorStatusConcluido: StatusTarefa — StatusTarefa.
  • ExecutorStatusFalhaId: long?.
  • ExecutorStatusFalha: StatusTarefa — StatusTarefa.
  • CustoEmCreditosAnalise: decimal.
  • CustoEmCreditosExecucao: decimal.
  • CustoEmCreditosPorPasso: decimal.
  • CustoEmCreditosMcpInvocacao: decimal.
  • MarkupTokensCreditosJson: string.
  • DryRunGratuito: bool.
  • CallbackUrlAposExecucao: string.
  • CallbackSecretArn: string.
  • RateLimitPorHora: int?.
  • Versao: int.
  • AtualizadoPorUsuarioId: long?.
  • AtualizadoPorUsuario: Usuario — Usuario.
  • DataInclusao: DateTime.
  • DataAlteracao: DateTime.


Voltar ao índice


TipoTarefaInputDTO


  • Nome: string.
  • Cor: string.
  • UrlIcone: string.
  • Objetivo: ObjetivoTarefaEnum.
  • SetorId: long?.
  • Funcoes: string.
  • TempoEstimado: int.
  • TextoPadrao: string.
  • TituloPadrao: string.
  • Usuarios: string.


Voltar ao índice


TipoTelhado


  • Id: long.
  • Ordem: int.
  • Nome: string.
  • TipoEstruturaSimulador: TipoEstruturaSimulador.
  • PorcentagemPerdas: double.
  • CodigoPHB: int.
  • CodigoEcori: int.
  • CodigoAcroni: string.
  • CodigoSouEnergy: int.
  • TelhadoProprio: string.
  • TelhadoAldo: string.
  • TelhadoEdeltec: string.
  • TelhadoAdiasSolar: string.
  • CodigoRenovigi: int.
  • CodigoHelte: int.
  • CodigoFortLev: string.
  • CodigoTelhadoSolfacil: string.
  • CodigoJNG: string.
  • CodigoTelhadoEnergyBrasil: string.
  • CodigoTelhadoBoldEnergy: long.
  • CodigoTelhadoFotus: int.
  • CodigoTelhadoOurolux: int.
  • CodigoTelhadoSolMais: string.
  • CodigoTelhadoVertys: int.
  • CodigoSafeZap: string.
  • CodigoTelhadoJNG: int.
  • CodigoTelhadoGoSolar: int.
  • CodigoWEG: string.
  • CodigoTelhadoAvtEnergy: int.
  • CodigoTelhadoKomeco: string.
  • CodigoTelhadoBelEnergy: string.
  • CodigoTelhadoElgin: string.
  • CodigoTelhadoMRT: string.
  • CodigoTelhadoConectoWay: string. Estrutura correspondente na ConectoWay (plataforma Pieta). É o _id (MongoID) da structureName, vindo de productsBaseLoad/kitExpress. O recommendations exige o objeto de estrutura montado a partir dele.


Voltar ao índice


TipoVenda


  • Id: long.
  • Nome: string.
  • StatusProjetoId: long?. Gatilho de status do negócio ao cadastrar uma venda DESTE tipo. Sobrepõe o Configuracao.GatilhoVendaStatusProjetoId — vazio (null ou 0) mantém o gatilho global.


Voltar ao índice


TituloPagarInputDTO


  • TratamentoFiscal: TratamentoFiscalEnum.
  • Numero: string.
  • Descricao: string.
  • FornecedorId: long?.
  • DataEmissao: DateTime?.
  • DataCompetencia: DateTime?. Mês a que o valor pertence (competência). Vazio = a emissão.
  • ValorTotal: decimal.
  • CategoriaFinanceiraId: long?.
  • CentroCustoId: long?.
  • ContaBancariaId: long?.
  • LojaId: long?.
  • Fonte: FonteTituloPagarEnum.
  • FonteId: long?.
  • PedidoVendaId: long?. Obra (Pedido de Venda) desta despesa — DRE por pedido.
  • OrdemServicoId: long?. OS desta despesa (custo da empresa na OS) — DRE por pedido.
  • Observacao: string.
  • ExternalId: string.
  • Parcelas: List<ParcelaPagarInputDTO> — ParcelaPagarInputDTO.


Voltar ao índice


TituloReceberInputDTO


  • Numero: string.
  • Descricao: string.
  • LeadId: long?.
  • DataEmissao: DateTime?.
  • DataCompetencia: DateTime?. Mês a que o valor pertence (competência). Vazio = a emissão.
  • ValorTotal: decimal.
  • CategoriaFinanceiraId: long?.
  • CentroCustoId: long?.
  • ContaBancariaId: long?.
  • LojaId: long?.
  • Fonte: FonteTituloEnum.
  • FonteId: long?.
  • PedidoVendaId: long?. Pedido de Venda de origem (vínculo direto, além da Fonte).
  • Observacao: string.
  • ExternalId: string.
  • Parcelas: List<ParcelaReceberInputDTO> — ParcelaReceberInputDTO.


Voltar ao índice


TituloRecorrenteInputDTO


  • TratamentoFiscal: TratamentoFiscalEnum. Classificação das contas a pagar criadas. Receber ignora.
  • Numero: string. Base do número — cada ocorrência vira "ALUGUEL (1/12)".
  • Descricao: string.
  • FornecedorId: long?. Contas a pagar.
  • LeadId: long?. Contas a receber.
  • CategoriaFinanceiraId: long?.
  • CentroCustoId: long?.
  • ContaBancariaId: long?.
  • LojaId: long?.
  • FormaPagamentoId: long?.
  • Observacao: string.
  • PedidoVendaId: long?.
  • ValorOcorrencia: decimal. Valor de CADA ocorrência — não o total da recorrência.
  • Quantidade: int. Quantas ocorrências gerar.
  • Periodicidade: PeriodicidadeRecorrenciaEnum.
  • IntervaloDias: int. Usado só quando a periodicidade é ACadaNDias.
  • PrimeiroVencimento: DateTime. Vencimento da primeira ocorrência. As demais andam pelo passo da periodicidade a partir DESTA data (nunca em cadeia), para "todo dia 31" não virar dia 28 para sempre depois de fevereiro.
  • PrimeiraCompetencia: DateTime?. Competência da primeira ocorrência. Vazio = o próprio mês do primeiro vencimento.


Voltar ao índice


ToggleEmAtendimentoSafeZapInputDTO


  • ProjetoId: long?.
  • LeadId: long?.
  • EmAtendimento: bool.


Voltar ao índice


TrancheFinanciamentoInputDTO


  • Descricao: string. Marco da liberação (ex.: "Assinatura", "Homologação").
  • Valor: decimal.
  • DataVencimento: DateTime.
  • OrigemVencimento: OrigemVencimentoEnum. Marcada pela tela a partir da sugestão: diz se a data foi informada por gente ou calculada pelo prazo do banco. Ausente (0), o serviço decide sozinho — ver PrevisaoRepasse.


Voltar ao índice


TransferenciaEstoqueInputDTO


  • InsumoId: long. Transferência de um Insumo entre dois Depósitos. Gera dois movimentos: TransferenciaSaida na origem e TransferenciaEntrada no destino, preservando o custo médio.
  • DepositoOrigemId: long.
  • DepositoDestinoId: long.
  • Quantidade: decimal.
  • Observacao: string.
  • UnidadeIds: System.Collections.Generic.List<long>.


Voltar ao índice


TransporteNotaInputDTO


  • ModalidadeFrete: int.
  • TransportadorNome: string.
  • TransportadorDocumento: string.
  • TransportadorIE: string.
  • TransportadorEndereco: string.
  • TransportadorMunicipio: string.
  • TransportadorUF: string.
  • VolumeQuantidade: int?.
  • VolumeEspecie: string.
  • VolumeMarca: string.
  • VolumeNumeracao: string.
  • PesoLiquido: decimal?.
  • PesoBruto: decimal?.


Voltar ao índice


UnidadeConsumidora


  • Id: long.
  • Projeto: Projeto — Projeto.
  • ProjetoId: long?.
  • Nome: string.
  • Descricao: string.
  • Endereco: Endereco — Endereco.
  • EnderecoId: long?.
  • TipoGrupo: TipoGrupoEnum.
  • NumeroMedidor: string.
  • DisjuntorEntrada: double.
  • PorcentagemCreditoAlocado: double.
  • PorcentagemCustoManutencao: double.
  • Faces: IList<FaceTelhado> — FaceTelhado.
  • Rateios: IList<RateioGeracaoUC> — RateioGeracaoUC.
  • DemandaContratada: double.
  • DemandaEspecial: double.
  • ValorkWDemanda: double.
  • ValorkWDemandaGeracao: double.
  • ValorkWDemandaEspecial: double.
  • Consumo: double.
  • Consumo12Meses: string.
  • ValorkWh: double.
  • ValorForaPontaTUSD: double.
  • ValorkWhTUSD: double.
  • ConsumoPonta: double.
  • Consumo12MesesPonta: string.
  • ValorkWhTEPonta: double.
  • ValorkWhTUSDPonta: double.
  • PorcentagemAliquota: double.
  • Concessionaria: Concessionaria — Concessionaria.
  • TipoEdificacao: TipoEdificacao — TipoEdificacao.
  • FaseEnergetica: string.
  • TensaoSaida: int.
  • ValorDisponibilidadeContaEnergia: double.
  • ValorIluminacaoPublica: double.
  • ValorOutros: double.
  • ValorContaEnergia: double.
  • ValorTotalContaEnergia: double.
  • ImagemContaEnergia: Arquivo — Arquivo.
  • TrocaTitularidade: bool.
  • NovoTitular: Contato — Contato.
  • NovoTitularId: long?.
  • ValorTESCEE: double.
  • ValorTUSDSCEE: double.


Voltar ao índice


UnidadeConsumidoraInputDTO


  • Nome: string.
  • UnidadeConsumidora: string.
  • ConcessionariaId: long?.
  • Consumo: double.
  • ProjetoId: long.


Voltar ao índice


UserClickSignOutputDTO


  • email: string.
  • name: string.


Voltar ao índice


Usuario


Herança: BaseModel — BaseModel.


  • Ativo: bool.
  • IsSystem: bool. True para usuários do sistema (ex: "Agente IA"). Não pode logar, não aparece em listas de atribuição, mas é usado como autor de comentários e ações automáticas.
  • Nome: string.
  • CPF: string.
  • Email: string.
  • Senha: string.
  • Celular: string.
  • Endereco: string.
  • ZenviaJSON: string.
  • PermitirAgendamento: bool.
  • CanaisStatus: CanalNotificacao.
  • CanaisCriacaoTarefas: CanalNotificacao.
  • CanaisMensagensEnviadas: CanalNotificacao.
  • CanaisTarefaAtribuida: CanalNotificacao.
  • CanaisNegocioAtribuido: CanalNotificacao.
  • CanaisConversaAtribuida: CanalNotificacao.
  • CanaisAberturaPropostas: CanalNotificacao.
  • CanaisComentarios: CanalNotificacao. Menção em comentário de tarefa, resposta a comentário, nota no negócio e menção em nota.
  • CanaisLembretes: CanalNotificacao. Lembretes e cobranças das rotinas: lembrete de negócio, tarefa atrasada ou a vencer, negócio sem atualização e agendamentos.
  • CanaisDocumentos: CanalNotificacao. Ciclo de assinatura de documentos (enviado, assinado, recusado, cancelado, prazo expirado, finalizado).
  • CanaisOperacional: CanalNotificacao. Avisos operacionais e administrativos: ordem de serviço, transferência de negócios em lote, importação, cadastro de usuário, créditos, metas de gamificação e leads vindos do simulador.
  • Perfil: Perfil — Perfil.
  • Funcao: FuncaoUsuario — FuncaoUsuario.
  • ImagemPerfil: Arquivo — Arquivo.
  • Loja: Loja — Loja.
  • LojaId: long?.
  • RamalApi4Com: string. Ramal (extension) do usuário na Api4Com — usado pelo click-to-call e webphone. Ver PRD-integracao-api4com.md.
  • Latitude: string.
  • Longitude: string.
  • Equipe: EquipeTecnica — EquipeTecnica.
  • EquipeId: long?.
  • Acessos: IList<AcessoUsuario> — AcessoUsuario.
  • Localizacoes: IList<Localizacao> — Localizacao.
  • Pagamentos: IList<PagamentoComissao> — PagamentoComissao.
  • TimeZone: TimeZoneInfo.
  • TimeZoneText: string.
  • Tenant: TenantInfo.
  • CodigoOperadorPlugChat: string.
  • AccessTokenPlugChat: string.
  • CodigoDepartamentoPlugChat: string.
  • Lojas: string.
  • EquipesGerenciadas: string.
  • ExternalId: string.
  • ExternalCode: string.
  • CodigoGoogle: string.
  • JsonGoogle: string.
  • UltimaSincronizacaoGoogle: DateTime?.
  • SincronizarReuniaoGoogle: bool.
  • GoogleCalendarIdReuniao: string.
  • GoogleCalendarNomeReuniao: string.
  • ImportarReuniaoMeet: bool.
  • GoogleEventsSubscription: string.
  • GoogleEventsExpiraEm: DateTime?.
  • PorcentagemAlteracaoMaxima: double.
  • HorariosFuncionamento: IList<HorarioFuncionamento> — HorarioFuncionamento.
  • RefreshToken: string.
  • RefreshTokenExpiryTime: DateTime.
  • DataStatus: DateTime.
  • UltimoAcesso: DateTime?. Último acesso (login) do usuário. Usado para o bloqueio por inatividade e exibição na tela de usuários. Null = nunca acessou.
  • Criptografado: bool.
  • PontosSaldo: long. Saldo atual de pontos disponível para gastar na loja de recompensas. Aumenta ao ganhar pontos (metas, bonificações) e diminui ao resgatar recompensas.
  • PontosTotalAcumulado: long. Total acumulado de pontos ganhos pelo usuário desde o início. Nunca diminui — usado para ranking, badges de lifetime e relatórios históricos.


Voltar ao índice


UsuarioTarefa


  • Id: long.
  • Usuario: Usuario — Usuario.
  • UsuarioId: long?.
  • Tarefa: Tarefa — Tarefa.
  • TarefaId: long.
  • DataInclusao: DateTime.


Voltar ao índice


ValorExtraAplicado


  • Id: long.
  • Descricao: string.
  • Operacao: OperacaoItemTabelaValorExtraEnum.
  • TipoValor: TipoValorItemTabelaValorExtraEnum.
  • Sobre: SobreValorItemTabelaValorExtraEnum.
  • ValorAplicado: double.


Voltar ao índice


VeiculoInputDTO


  • Nome: string. Corpo de criação de Veículo (frota de entregas).
  • Placa: string.
  • ValorDiariaPadrao: double.
  • CustoPorKm: double.
  • CapacidadeModulos: int?.
  • MotoristaPadraoId: long?.
  • PontoPartidaLat: string.
  • PontoPartidaLng: string.
  • LojaId: long?.
  • Ativo: bool?.
  • Tara: int?.
  • CapacidadeKg: int?.
  • UfLicenciamento: string.
  • TipoRodado: string.
  • TipoCarroceria: string.
  • Rntrc: string.
  • Renavam: string.


Voltar ao índice


Venda


Herança: BaseModel — BaseModel.


  • DataVenda: DateTime.
  • DataPagamento: DateTime.
  • Vendedor: Usuario — Usuario.
  • PreVendedor: Usuario — Usuario.
  • Lead: Lead — Lead.
  • Descricao: string.
  • PrePropostaAceita: PrePropostaAceita — PrePropostaAceita.
  • Projeto: Projeto — Projeto.
  • ProjetoId: long?.
  • Loja: Loja — Loja.
  • LojaId: long?.
  • Origem: Origem — Origem.
  • OrigemId: long?.
  • TipoVenda: TipoVenda — TipoVenda.
  • TipoVendaId: long?.
  • Status: StatusVenda — StatusVenda.
  • StatusId: long?.
  • ValorTotal: double.
  • ValorTotalPagamento: double.
  • ValorServico: double.
  • ValorProduto: double.
  • ValorEntrada: double.
  • ValorFinanciado: double.
  • ValorComissao: double.
  • ValorComissaoPreVendedor: double.
  • PorcentagemComissao: double.
  • PorcentagemComissaoPreVendedor: double.
  • StatusProjeto: StatusProjeto — StatusProjeto.
  • StatusLead: StatusLead — StatusLead.
  • Pagamentos: List<PagamentoComissao> — PagamentoComissao.
  • ValorTotalPago: double.


Voltar ao índice


VerificarConflitoOrdemServicoInputDTO


  • TecnicoId: long.
  • EquipeId: long.
  • DataAgendamentoInicial: DateTime.
  • DataAgendamentoFinal: DateTime?.


Voltar ao índice


VincularCalendarioGoogleInputDTO


  • TipoTarefaId: long. Vincula (ou desvincula, com GoogleCalendarId vazio) um calendário do usuário a um tipo de tarefa.
  • GoogleCalendarId: string. Id do calendário na conta Google do usuário. Vazio = desvincular.
  • NomeCalendario: string.


Voltar ao índice


VincularCatalogoInputDTO


  • Tipo: TipoInsumoEnum. Pares catálogo→Insumo escolhidos na prévia. São explícitos de propósito: reaplicar o casamento aqui poderia gravar algo diferente do que o usuário conferiu na tela.
  • Vinculos: List<VinculoCatalogoItemInputDTO> — VinculoCatalogoItemInputDTO.


Voltar ao índice


VincularNotaRecebidaInputDTO


  • PedidoCompraId: long.


Voltar ao índice


VincularPedidosInputDTO


Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.


  • ApenasSimular: bool. true = só conta o que seria vinculado, sem gravar.
  • DataInicio: DateTime?. Considera só títulos emitidos a partir desta data.
  • Limite: int. Teto de títulos por rodada (padrão 5000).


Voltar ao índice


VinculoCatalogoItemInputDTO


  • CatalogoId: long. Id da Placa/Inversor/Bateria.
  • InsumoId: long. Insumo do Estoque a vincular.


Voltar ao índice


VisitaTecnica


Herança: AbaComplementar — AbaComplementar.


  • ResponsavelVisita: string.
  • TipoDeEdificacao: string.
  • TipoTelhadoId: long?.
  • TipoTelhado: TipoTelhado — TipoTelhado.
  • TipoEdificacao: TipoEdificacao — TipoEdificacao.
  • TipoEdificacaoId: long?.
  • NecessidadeDeTransformador: bool.
  • PotenciaDoTransformador: double.
  • EntradaRamal: EntradaRamalEnum.
  • TipoEntrada: TipoEntradaEnum.
  • DistanciaPaineisInversor: double.
  • DistanciaQuadroInversor: double.
  • DistanciaInversorEnergia: double.
  • AlturaInstalacaoInversor: double.
  • Video1: string.
  • Video2: string.
  • Video3: string.
  • DataDaVistoria: DateTime.
  • Responsavel: Usuario — Usuario.
  • ResponsavelId: long?.
  • Observacoes: string.
  • FotoTelhado1Url: string.
  • FotoTelhado2Url: string.
  • FotoTelhado3Url: string.
  • FotoTelhado4Url: string.
  • AnaliseAIFotoTelhado: string.
  • FotoPadraoEntrada1Url: string.
  • FotoPadraoEntrada2Url: string.
  • AnaliseAIFotoPadraoEntrada: string.
  • FotoFachada1Url: string.
  • FotoFachada2Url: string.
  • AnaliseAIFotoFachada: string.
  • FotoQuadroEnergiaUrl: string.
  • AnaliseAIFotoQuadroEnergia: string.
  • FotoDisjuntorEntradaUrl: string.
  • AnaliseAIFotoDisjuntorEntrada: string.
  • FotoLocalInversor1Url: string.
  • FotoLocalInversor2Url: string.
  • AnaliseAIFotoLocalInversor: string.
  • PertoPraia: bool.
  • Emuc: bool.
  • DisjuntorEmuc: string.
  • CaboEmuc: string.
  • FotoDisjuntorEmucUrl: string.
  • FotoCabeamentoEmucUrl: string.
  • BeneficiarioAreasComuns: bool.
  • AtaEleicaoSindicoUrl: string.
  • AtaAssembleiaInstalacaoUrl: string.
  • DocumentoPosseUrl: string.
  • AmpliacaoSistema: bool.
  • FotoEtiquetaInversorUrl: string.
  • FotoQuadroDisjuntorInversorUrl: string.
  • FotoStringBoxCcUrl: string.
  • FotoParteBaixaInversorUrl: string.
  • FotoQuadroDisjuntoresUrl: string.
  • DistanciaInversorMedidor: double.
  • MedidaReferenciaTelhado: double.
  • QuantidadeModulosAprovados: string.
  • AprovadoPor: Usuario — Usuario. Quem aprovou a visita (usuário do CRM). Fica junto dos demais dados de aprovação; o Status continua sendo a decisão em si.
  • AprovadoPorId: long?.
  • NecessitaAdequacao: bool. Adequação elétrica/civil — quando true, libera a descrição. OBSOLETO na tela: substituído por NecessitaAdequacaoEletrica e NecessitaAdequacaoCivil. Mantido para não perder o histórico (os dois campos novos nascem com este valor).
  • NecessitaAdequacaoEletrica: bool.
  • NecessitaAdequacaoCivil: bool.
  • DescricaoAdequacao: string.
  • NecessitaAdicionalValor: bool. Quando a visita revela custo extra que precisa entrar na proposta. Só com true o ValorAdicional é preenchido.
  • ValorAdicional: double.
  • ResumoAIVisitaTecnicaCompleta: string.
  • Status: StatusVistoriaEnum.


Voltar ao índice


VisitaTecnicaInputDTO


Herança: AbaComplementarInputDTO — AbaComplementarInputDTO.


  • TipoTelhadoId: long?.
  • TipoDeEdificacaoId: long?.
  • NecessidadeDeTransformador: bool.
  • PotenciaDoTransformador: double.
  • EntradaRamal: EntradaRamalEnum.
  • TipoEntrada: TipoEntradaEnum.
  • DistanciaPaineisInversor: double.
  • DistanciaQuadroInversor: double.
  • DistanciaInversorEnergia: double.
  • AlturaInstalacaoInversor: double.
  • Video1: string.
  • Video2: string.
  • Video3: string.
  • DataDaVistoria: DateTime.
  • ResponsavelVisita: string.
  • Observacoes: string.
  • ResponsavelId: long?.


Voltar ao índice



Veja também


Atualizado em: 14/10/2026

Este artigo foi útil?

Compartilhe seu feedback

Cancelar

Obrigado!