API Groner — campos e tipos: FiltroFinanceiroInputDTO a ImportarOfxInputDTO
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
FiltroFinanceiroInputDTO · FiltroHistoricoStatusLeadInputDTO · FiltroInstalacoesInputDTO · FiltroInsumoInputDTO · FiltroInventarioEstoqueInputDTO · FiltroKitGeradorInputDTO · FiltroLeadInputDTO · FiltroLoteDistribuicaoInputDTO · FiltroMetasPorMesInputDTO · FiltroModeloDocumentoInputDTO · FiltroModeloPropostaAtivasInputDTO · FiltroMovimentoEstoqueInputDTO · FiltroNotaRecebidaInputDTO · FiltroOrdemServicoAFaturarInputDTO · FiltroOrdemServicoErpInputDTO · FiltroOrdemServicoInputDTO · FiltroPagamentoInputDTO · FiltroPendenciaEntregaInputDTO · FiltroPendenciaInputDTO · FiltroPrePropostaAceitaInputDTO · FiltroPrePropostaInputDTO · FiltroProjetoEngenhariaInputDTO · FiltroProjetoInputDTO · FiltroRespostaCampoPersonalizadoInputDTO · FiltroSaldoEstoqueInputDTO · FiltroServicoRecebidoInputDTO · FiltroStatusLeadProjetoInputDTO · FiltroTarefaInputDTO · FiltroTipoTarefaInputDTO · FiltroTituloInputDTO · FiltroUnidadeEstoqueInputDTO · FiltroUsuarioInputDTO · FiltroVendaInputDTO · FiltroVendasPorPeriodoInputDTO · FiltroVisitaTecnicaInputDTO · FinanciamentoSimulador · FluentFormInputDTO · FluxoCaixaInputDTO · FollowUpCadenciaInputDTO · FollowUpIniciarInputDTO · FollowUpIniciarLoteInputDTO · FollowUpPassoInputDTO · FormaPagamentoInputDTO · FormularioCampoInputDTO · FormularioCampoPersonalizado · Fornecedor · FornecedorInputDTO · FuncaoNotificarStatusLead · FuncaoNotificarStatusProjeto · FuncaoStatusLead · FuncaoStatusProjeto · FuncaoUsuario · FuncaoVisualizarStatusProjeto · FuncionarioInputDTO · Gerador · GeradorInputDTO · GerarContasPagarServicoInputDTO · GerarLoteComissaoInputDTO · GerarPagamentosReceberInputDTO · GerarPedidosCompraInputDTO · GerarPedidosVendaInputDTO · GerarPendenciaSeparacaoInputDTO · GerarRepassesEquipeInputDTO · GerarReposicaoInputDTO · GerarSpedInputDTO · GerarTarefasDePendenciasInputDTO · GerarTituloComissaoDaVendaInputDTO · GerarTituloNotaInputDTO · GerarTitulosComissaoInputDTO · GerarTitulosFinanciamentoInputDTO · GerarTitulosFolhaInputDTO · GrupoADadosSimulacao · HistoricoAlteracaoPreProposta · HistoricoStatusPreProposta · HomologacaoVistoriaInputDTO · HorarioFuncionamento · IdentificacaoUnidadeInputDTO · IdentificarUnidadesInputDTO · IgnorarNotaRecebidaInputDTO · ImportarContagemInputDTO · ImportarCsvInputDTO · ImportarEventoInputDTO · ImportarExtratoInputDTO · ImportarOfxInputDTO
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 o resumo dos projetos de engenharia
Requisição completa (Bash):
curl --request GET \
--url "$API_URL/api/AbaComplementar/ProjetosEngenharia/Summary" \
--header "Authorization: Bearer $TOKEN" \
--header "Accept: application/json"Resposta ilustrativa — HTTP 200:
{
"Version": "1.0.0.0",
"StatusCode": 200,
"Message": "Requisição efetuada com suceesso.",
"Content": {
"totalProjetos": 0,
"totalAprovados": 0,
"totalPendentes": 0,
"totalCancelados": 0,
"totalReprovados": 0,
"totalAguardando": 0,
"valorTotal": 0,
"valorAguardando": 0,
"valorPendente": 0,
"valorCancelado": 0,
"valorReprovado": 0,
"valorAprovado": 0,
"totalEmAndamento": 0,
"valorEmAndamento": 0
}
}O DTO de criação de projeto de engenharia recebe ProjetoId e StatusId opcional. O status técnico é independente de StatusProjeto comercial. A criação exige negócio existente e status de engenharia configurado. Visita técnica e homologação são processos técnicos; instalação e OS têm referência própria em Serviços/OS.
O exemplo é fictício, baseado no contrato conferido no código. As respostas não foram coletadas em produção.
Contratos
FiltroFinanceiroInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
TratamentoFiscal:TratamentoFiscalEnum?. Classificação informada no título a pagar. Nulo = todos.Situacao:string. Aberto | ParcialmentePago | Pago | Cancelado.Vencimento:string. Atalho de vencimento: Vencidos | Hoje | AVencer.FornecedorId:long?.LeadId:long?. Cliente (Lead) — usado no Contas a Receber.CategoriaFinanceiraId:long?.CentroCustoId:long?.ContaBancariaId:long?.FormaPagamentoId:long?.PedidoVendaId:long?.VencimentoInicio:DateTime?.VencimentoFim:DateTime?.EmissaoInicio:DateTime?. Data de lançamento (emissão do título).EmissaoFim:DateTime?.DataPedidoInicio:DateTime?.DataPedidoFim:DateTime?.ValorMin:decimal?.ValorMax:decimal?.StatusAprovacaoPagarId:long?. Etapa de aprovação do título — só Contas a Pagar. Aceita o sentinela com o sentido de "fora do fluxo": contas sem etapa, que pagam sem aprovação (as anteriores ao fluxo e as da empresa que não usa).TipoAprovacao:Safeleads.Models.Financeiro.TipoStatusAprovacaoPagarEnum?. Atalho do cartão "Aguardando aprovação": o TIPO da etapa, e só o que ainda está em aberto — como nos atalhos de vencimento, parcela paga ou cancelada não espera decisão de ninguém.
FiltroHistoricoStatusLeadInputDTO
StatusId:long?.EtapaId:long?.ResponsavelId:long?.Ordenar:OrdernarHistoricoStatusPor?.
FiltroInstalacoesInputDTO
IdProjeto:long?.DataInicial:DateTime?.DataFinal:DateTime?.DataPrevisaoConclusaoInicial:DateTime?.DataPrevisaoConclusaoFinal:DateTime?.DataConclusaoInicial:DateTime?.DataConclusaoFinal:DateTime?.Status:StatusInstalacaoEnum?.StatusNegocioId:long?.ComObra:bool?.Entrega:EntregaSituacaoEnum?.Query:string.Cidade:string.Bairro:string.LojaId:long?.LojaIds:List<long>.VendedorId:long?.TecnicoId:long?.EquipeId:long?.OrdenarPor:InstalacaoEnumOrder.SomenteExcluidas:bool?.
FiltroInsumoInputDTO
Query:string.CategoriaId:long?.GrupoId:long?.FamiliaId:long?.Excluido:bool?.SomenteOrcamento:bool?.Tipo:TipoInsumoEnum?. Filtra pela classe do item (Modulo/Inversor/Bateria/...). Null = todos.ExcluirTiposSolar:bool?. Exclui Modulo/Inversor/Bateria — a tela "Insumos" do ERP lista o resto, já que esses três têm tela própria. Null/false = não filtra.PrecoZerado:bool?. Lista apenas insumos sem preço utilizável: sem nenhum preço cadastrado ou com todos os preços zerados. Serve para achar o que falta precificar. Null/false = não filtra.SemPrecoLojaId:long?. Lista apenas insumos que NÃO têm preço válido para esta loja, para facilitar o preenchimento do preço por loja. Um preço sem lojas definidas vale para todas, então quem tem preço global não entra. Null = não filtra.
FiltroInventarioEstoqueInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
DepositoId:long?.Status:StatusInventarioEstoqueEnum?.
FiltroKitGeradorInputDTO
PotenciaAlvoKwp:double. Potência alvo (kWp) do gerador — usada p/ dimensionar a faixa de kits. 0 = usa o consumo da UC.MarcaPainel:string.MarcaInversor:string.Fase:string.TensaoSaida:string.Categoria:string.Query:string.ModuleId:string. Código do módulo (Placa.Codigo p/ Kit Customizado; id do módulo Helte p/ HelteCustomizado).TipoInversor:string. Tipo de inversor (Inversor.Tipo) — OBRIGATÓRIO no Kit Customizado.InverterBrandsId:string. Id da marca/fabricante do inversor — OBRIGATÓRIO no HelteCustomizado.StructureBrandId:string.TensionId:int?. Id da tensão — OBRIGATÓRIO no HelteCustomizado.Distribuidor:string. Distribuidor (nome do enum DistribuidorIntegracao). Vazio/inválido = Proprio.OnGrid:bool.OffGrid:bool.Hibrido:bool.CodigoKit:string. Código do kit (busca direta por código — usado por distribuidores como Aldo).Regiao:string. Frete/região da Weg (Regioes.Cod do opcoesParaFiltroGerarKits).RegiaoTelhado:string. Região do telhado da Weg (RegioesTelhado.Cod).CodigosInversores:List<string>. Códigos dos inversores Weg; ["0"] = todos (mesmo contrato do groner-light).
FiltroLeadInputDTO
DataInicial:DateTime?.DataFinal:DateTime?.LojaId:long?.OrigemId:long?.OrigensIds:List<long>.ResponsavelId:long?.ResponsaveisIds:List<long>.QueryContatoSecundario:string.PreVendedorId:long?.PreVendedoresIds:List<long>.Tipo:TipoLead?.Tipos:List<TipoLead>.Query:string.Cidade:string.UF:string.OrdenarPor:LeadEnumOrder?.
FiltroLoteDistribuicaoInputDTO
Query:string. Busca livre — casa com o nome de quem disparou a rodada ou com o nome do status que a recortou.DataInicial:DateTime?. Recorte por data de início da rodada (inclusive).DataFinal:DateTime?. Recorte por data de início da rodada (inclusive).UsuarioId:long?. Quem disparou a rodada.StatusProjetoId:long?. Status que recortou a rodada (só existe nas rodadas por status).Gatilho:GatilhoFilaEnum?.Finalizado:bool?. True = só rodadas já fechadas; false = só as em andamento.Tipo:string. Geral ou PorStatus — mesmo valor devolvido em LoteDistribuicaoOutputDTO.Tipo.
FiltroMetasPorMesInputDTO
DataInicial:DateTime?.DataFinal:DateTime?.Objetivo:ObjetivoMetaEnum.EntidadeId:long?.
FiltroModeloDocumentoInputDTO
Query:string.Tipo:TipoModeloDocumento?.SomenteAtivos:bool.SomenteExcluidas:bool?.
FiltroModeloPropostaAtivasInputDTO
TipoGrupo:TipoGrupoEnum?.LojaId:long?.IncluirInativos:bool?.
FiltroMovimentoEstoqueInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
DepositoId:long?. Restringe a um depósito. Null = todos.InsumoId:long?. Restringe a um produto — o extrato de um item só. Null = todos.Tipo:TipoMovimentoEstoqueEnum?. Restringe ao tipo do movimento (Entrada, Saida, …). Null = todos.Fonte:FonteMovimentoEstoqueEnum?. Restringe à origem (PedidoVenda, Inventario, …). Null = todas.DataInicio:System.DateTime?. Período do movimento (inclusivo nas duas pontas). A data final vale até o fim do dia — quem filtra "até 04/08" espera ver o que aconteceu às 17h de 04/08.
FiltroNotaRecebidaInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
Situacao:SituacaoNotaRecebidaEnum?. Filtro da caixa de entrada fiscal. Herda Query/Loja(s).Manifestacao:ManifestacaoNfeEnum?.StatusTratamento:StatusTratamentoNotaRecebidaEnum?.EmissaoInicio:DateTime?.EmissaoFim:DateTime?.PedidoCompraId:long?. Notas de UM pedido de compra — a aba "Notas fiscais" do detalhe do pedido.
FiltroOrdemServicoAFaturarInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
FinalizadaDe:DateTime?. Recorte por data de FINALIZAÇÃO da OS.FinalizadaAte:DateTime?.DiasParadaMin:int?. Só as paradas há mais de N dias.
FiltroOrdemServicoErpInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
Situacao:string. Situação financeira: AFaturar | Faturadas | SemValor. Vazio = todas. AFaturar é a mesma régua da fila (finalizada, sem título a receber vivo, mão de obra + materiais faturáveis acima de zero).StatusOsId:long?. Status da OS (cadastro do tenant).TipoServicoId:long?.CampoData:string. Qual data o período DataIni/DataFim recorta: Cadastro (padrão) | Agendamento | Finalizacao.
FiltroOrdemServicoInputDTO
DataInclusaoInicial:DateTime?.DataInclusaoFinal:DateTime?.DataAgendamentoInicial:DateTime?.DataAgendamentoFinal:DateTime?.DataFinalizadaInicial:DateTime?.DataFinalizadaFinal:DateTime?.TipoServicoId:long?.TiposServicosIds:List<long>.EquipeId:long?.TecnicoId:long?.Query:string.ProjetoId:long?.CompraId:long?.StatusId:long?.TipoStatus:TipoStatusOrdemServicoEnum?.OrdenarPor:OrdemServicoOrder?.LojaId:long?.LojasIds:List<long>.
FiltroPagamentoInputDTO
ProjetoId:long?.DataVencimentoInicial:DateTime?.DataVencimentoFinal:DateTime?.DataPagamentoInicial:DateTime?.DataPagamentoFinal:DateTime?.DataCadastroInicial:DateTime?.DataCadastroFinal:DateTime?.DataVendaInicial:DateTime?.DataVendaFinal:DateTime?.Query:string.TipoStatus:TipoStatusPagamentoEnum?.StatusId:long?.OrdenarPor:PagamentoEnumOrder.
FiltroPendenciaEntregaInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
Etapa:EtapaPendenciaEntrega?. Filtro da lista de pendências de entrega. Estende o filtro padrão (Query + escopo de loja) — a loja vem da ENTREGA (snapshot LojaId).Motivo:MotivoPendenciaEntrega?.InsumoId:long?.ProjetoId:long?.EntregaProjetoId:long?.
FiltroPendenciaInputDTO
ProjetoId:long?.Situacao:SituacaoPendenciaEnum?.Obrigatoria:bool?.Query:string.ItemModeloPendenciaId:long?. Filtra pelas pendências geradas por um modelo (configuração automática) específico.TituloExato:string. Match EXATO por título (drill-down do agrupamento por título). Diferente de Query, que é "contém".SetorId:long?. Filtra pelo setor dono da pendência.TipoPendenciaId:long?. Filtra pelo tipo de pendência (catálogo).ResponsavelUsuarioId:long?. Filtra por quem responde — "minhas pendências".
FiltroPrePropostaAceitaInputDTO
Query:string.
FiltroPrePropostaInputDTO
ProjetoId:long?.LeadId:long?.DataInicial:DateTime?.DataFinal:DateTime?.ConsumoInicial:double?.ConsumoFinal:double?.GeracaoInicial:double?.GeracaoFinal:double?.ValorInicial:double?.ValorFinal:double?.PotenciaCCInicial:double?.PotenciaCCFinal:double?.PotenciaCAInicial:double?.PotenciaCAFinal:double?.StatusIds:List<long>.OrigensIds:List<long>.LojasIds:List<long>.ApenasAceitas:bool.Query:string.Fornecedores:List<string>.Ordenar:OrdenarPropostaPor?.ModeloId:long?.TipoSimulacao:TipoSimulacaoEnum?.ConcessionariaId:long?.UsuarioId:long?.
FiltroProjetoEngenhariaInputDTO
ProjetoId:long?.DataInicioInicial:DateTime?.DataInicioFinal:DateTime?.DataFinalizacaoInicial:DateTime?.DataFinalizacaoFinal:DateTime?.Query:string.Protocolo:string.TipoStatus:TipoStatusEnumProjetoEngenharia?.StatusId:long?.UsuarioId:long?.SemProjetista:bool?. true = só negócios SEM projetista (a faixa de carga "Sem projetista").ConcessionariaId:long?.LojaId:long?. Loja do lead do negócio.ComPendencia:bool?. true = só negócios com pendência em aberto; false = só sem pendência em aberto; null = todos.TiposServicoIds:string. Tipos de serviço da OS do negócio, separados por vírgula (ex.: "2,5"). Junto com StatusOrdemServicoIds, casa quando UMA mesma OS do negócio atende os dois.StatusOrdemServicoIds:string. Status da OS do negócio, separados por vírgula.SemOrdemServico:bool?. true = só negócios SEM OS dos tipos escolhidos (ou sem OS nenhuma, se nenhum tipo).OrdenarPor:OrdenarProjetoEngenhariaPor?.
FiltroProjetoInputDTO
FiltroAplicado:bool.Query:string.Criterio:CriterioConsultaEnum?.TipoProjetoId:long?.TipoProjetoIds:List<long>.EtapaId:long?.EtapaLeadId:long?.StatusId:long?.StatusLeadId:long?.VendedorResponsavelId:long?.TecnicoResponsavelId:long?.ProjetistaId:long?.HomologadorId:long?.ResponsavelCSId:long?.PreVendedorId:long?.LeadId:long?.LojaIds:List<long>.EquipesIds:List<long>.Cidade:string.Bairro:string.UF:string.PotenciaInicial:double?.PotenciaFinal:double?.ValorInicial:double?.ValorFinal:double?.ConsumoInicial:double?.ConsumoFinal:double?.EtiquetasIds:List<long>.OrigensIds:List<long>.StatusHistoricoIds:List<long>.NStatusHistoricoIds:List<long>.NTipoServicoIds:List<long>.TipoServicoIds:List<long>.DataInicial:DateTime?.DataFinal:DateTime?.DataAtualizacaoInicial:DateTime?.DataAtualizacaoFinal:DateTime?.DataPrevisaoFechamentoInicial:DateTime?.DataPrevisaoFechamentoFinal:DateTime?.DataPropostaAceitaInicial:DateTime?.DataPropostaAceitaFinal:DateTime?.DataVendaInicial:DateTime?.DataVendaFinal:DateTime?.DataPerdaInicial:DateTime?.DataPerdaFinal:DateTime?.OrdenarPor:ProjetoEnumOrder.QualificacaoInicial:int?.QualificacaoFinal:int?.Indicador:string.DonoContatoId:long?.Campanha:string.Anuncio:string.ConjuntoAnuncios:string.SemEtiqueta:bool.ProjetoId:long?.TempoPermanencia:TempoPermanenciaOpcaoEnum?.TempoPermanenciaEtapaId:long?. Fluxo aberto no kanban. Vale para TempoPermanencia, AtrasoFluxo e a ordenação por status ou atraso.AtrasoFluxo:AtrasoFluxoOpcaoEnum?. Contador acumulado: atraso somado das colunas do fluxo (TempoPermanenciaEtapaId), que não zera ao mudar de coluna.DataAssinaturaContratoInicial:DateTime?.DataAssinaturaContratoFinal:DateTime?.SomenteAtribuiveis:bool?.WhatsApp:string.ProjetosIds:List<long>.UsuarioId:long?.Pesquisa:string.TemEstudo:bool?. Filtra por ter (ou não) Estudo Solar — projeto com geradores não-excluídos. null = todos.
FiltroRespostaCampoPersonalizadoInputDTO
EtapaId:long?.AbaDinamicaId:long?.TipoServicoId:long?.TipoTarefaId:long?.StatusId:long?.ProjetoId:long?.LeadId:long?.Query:string.TipoCampo:TipoCampoPersonalizadoEnum?.
FiltroSaldoEstoqueInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
Tipo:TipoInsumoEnum?. Classe do item (Modulo/Inversor/Bateria/...). Null = todos.ExcluirTiposSolar:bool?. Exclui Modulo/Inversor/Bateria (tela "Insumos" = o resto).CategoriaId:long?.DepositoId:long?.InsumoId:long?. Restringe a um único insumo — usado pela tela de detalhe do produto, que mostra o saldo dele em cada depósito. Null = todos.DiasConsumo:int?. Sugestão de Compra: janela do consumo médio, em dias. Null = 90 (um trimestre — aguenta a sazonalidade do setor sem virar média histórica que ignora a tendência atual).SomenteAComprar:bool?. Sugestão de Compra: true = só o que precisa comprar.
FiltroServicoRecebidoInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
Situacao:SituacaoServicoRecebidoEnum?. Filtro da lista de serviços tomados. Herda Query/Loja(s).EmissaoInicio:DateTime?.EmissaoFim:DateTime?.
FiltroStatusLeadProjetoInputDTO
Query:string.EtapaId:long?.
FiltroTarefaInputDTO
DataInicial:DateTime?.DataFinal:DateTime?.DataConclusaoInicial:DateTime?.DataConclusaoFinal:DateTime?.LeadId:long?.ProjetoId:long?.StatusId:long?.StatusIds:List<long>.UsuarioId:long?.UsuariosIds:List<long>.DonoTarefaId:long?.FinalizadoPorId:long?.LojasIds:List<long>.EquipeId:long?. Equipe técnica do dono da tarefa (Usuario.EquipeId) ou de algum dos responsáveis (Usuarios[].Usuario.EquipeId).TipoId:long?.SemFinalizadas:bool.Query:string.Criterio:CriterioTarefasEnum.OrdenarPor:TarefaEnumOrder.TipoStatus:TipoStatusTarefaEnum?.Prioridade:PrioridadeTarefaEnum?.OrdemServicoId:long?.VistoriaId:long?.CompraId:long?.ObjetivoTarefa:ObjetivoTarefaEnum?.ProjetoEtapaId:long?.ProjetoStatusId:long?.SetoresIds:List<long>.EtiquetasIds:List<long>.SemEtiqueta:bool?.TarefaPaiId:long?.SemSubtarefas:bool?.SomenteAtrasadas:bool?.IncluirStatusAgente:bool?.
FiltroTipoTarefaInputDTO
Query:string.SetoresIds:List<long>.
FiltroTituloInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
CompetenciaInicio:DateTime?. Filtro da listagem de títulos. Herda Query/LojaIds e acrescenta a janela de COMPETÊNCIA — é o que permite a DRE pedir só o período em vez de baixar todos os títulos de todos os tempos.CompetenciaFim:DateTime?.GrupoRecorrenciaId:Guid?. Todas as ocorrências de uma recorrência.PedidoVendaId:long?. Obra (Pedido de Venda) do custo — só o Contas a Pagar usa (a aba "A pagar" do pedido lista por aqui). O Contas a Receber ignora: lá o vínculo com o pedido é Fonte+FonteId.PedidoCompraId:long?. Pedido de COMPRA que originou o título (aba "A pagar" do detalhe do pedido). Aqui o vínculo é Fonte=PedidoCompra + FonteId, e não uma coluna dedicada como no Pedido de Venda.
FiltroUnidadeEstoqueInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
InsumoId:long?. Restringe a um produto. Null = todos.DepositoId:long?. Restringe a um depósito. Null = todos.StatusUnidade:StatusUnidadeEstoqueEnum?. Situação da unidade (Disponivel, Consumida, Defeito…). Chama-se StatusUnidade e não Status porque a base já tem um Status (string) e duas propriedades de mesmo nome derrubam o Swagger.ApenasPendentes:bool?. true = só o que entrou sem identificação (série/lote em branco) e ainda espera alguém preencher.OcultarConsumidas:bool?. true = esconde o que já saiu (Consumida), que é o padrão de quem está olhando "o que eu tenho".PedidoVendaId:long?.OrdemServicoId:long?.
FiltroUsuarioInputDTO
Query:string.PerfilId:long?.FuncaoId:long?.LojaId:long?.EquipeId:long?.SomenteAtivos:bool.
FiltroVendaInputDTO
Query:string.ValorInicial:double?.ValorFinal:double?.DataInicial:DateTime?.DataFinal:DateTime?.LeadId:long?.ProjetoId:long?.PrePropostaAceitaId:long?.VendedorId:long?.VendedorIds:List<long>.LojaId:long?.EquipeId:long?.TipoNegocioId:long?.TipoVendaId:long?.StatusId:long?.Criterio:CriterioConsultaVendaEnum?.OrdenarPor:OrdenarVendaPor?.SomenteAvulsas:bool?.
FiltroVendasPorPeriodoInputDTO
LojaId:long?.VendedorId:long?.UsuarioId:long?.TipoNegocioId:long?.TipoProjetoIds:List<long>.DataInicial:DateTime?.DataFinal:DateTime?.OrigensIds:List<long>.EquipeId:long?.HomologadorId:long?.ProjetistaId:long?.ResponsavelCSId:long?.TipoVendaId:long?.VendedorIds:List<long>.
FiltroVisitaTecnicaInputDTO
ProjetoId:long?.DataDaVistoriaInicial:DateTime?.DataDaVistoriaFinal:DateTime?.TipoTelhadoId:long?.TipoEdificacaoId:long?.UsuarioId:long?.EntradaRamal:EntradaRamalEnum?.TipoEntrada:TipoEntradaEnum?.Status:StatusVistoriaEnum?.Query:string.
FinanciamentoSimulador
Id:long.Nome:string.ValorTotal:double.TaxaJurosMensal:double.TaxaJurosAnual:double.QuantidadeMeses:int.IOF:double.TAC:double.ValorMensal:double.ValorAnual:double.PorcentagemEntrada:double.ValorEntrada:double.CarenciaMeses:int.NomeBanco:string.SiglaBanco:string.UrlLogoBanco:string.
FluentFormInputDTO
nome:string.email:string.telefone:string.cidade:string.valorConta:string.documento:string.tipoPessoa:string.nota:string.url:string.origemId:long?.emailResponsavel:string.responsavelId:long?.campanha:string.anuncio:string.conjuntoAnuncios:string.codigoLeadTracking:string.nomeFantasia:string.segmento:string.tipoProjetoId:long?.uf:string.indicadoPor:string.imagemContaEnergiaId:long?.cep:string.notas:string.camposPersonalizados:string.
FluxoCaixaInputDTO
DataInicio:DateTime. Parâmetros do fluxo de caixa (P7): período, agrupamento e se inclui o previsto (parcelas em aberto por vencimento) além do realizado (baixas efetivas).DataFim:DateTime.LojaId:long?.Agrupamento:AgrupamentoFluxoCaixa.IncluirPrevisto:bool. Quando true, projeta entradas/saídas a partir das parcelas em aberto.
FollowUpCadenciaInputDTO
AgenteConversacionalId:long. Payload de criação/edição de uma cadência (whitelist editável + passos aninhados).Nome:string.Habilitado:bool.Modo:FollowUpModoEnum. Reativação (0) ou Prospecção ativa (1).GatilhoInatividade:bool.InatividadeHorasSemResposta:int.GatilhoCadencia:bool.GatilhoEvento:bool.EventosJson:string.MaxTentativas:int.PararAoResponder:bool.Fuso:string.HorarioInicioHora:int.HorarioFimHora:int.DiasSemanaJson:string.AcaoAoEsgotar:FollowUpAcaoEsgotarEnum.AcaoEsgotarStatusProjetoId:long?. StatusProjeto a aplicar quando AcaoAoEsgotar = MudarStatusProjeto.AudienciaFiltroJson:string.MetaInstanceId:string. Instância OFICIAL (Meta) por onde a cadência dispara. Vazio = canal não-oficial (GronerZap) e os templates dos passos são ignorados.Passos:List<FollowUpPassoInputDTO>— FollowUpPassoInputDTO.
FollowUpIniciarInputDTO
CadenciaId:long. Inicia (ou reusa) uma execução de follow-up pra um lead/conversa numa cadência.LeadId:long?.ConversaWhatsAppId:long?.IdentificadorCanal:string. InstanceId do canal (opcional — resolvido da conversa quando ausente).
FollowUpIniciarLoteInputDTO
CadenciaId:long. Prospecção por lista: dispara a cadência pra um conjunto de leads de uma vez.LeadIds:List<long>.IdentificadorCanal:string.
FollowUpPassoInputDTO
Ordem:int. Passo de uma cadência — entrada (sem Id; o Id é resolvido por Ordem no upsert).DelayHoras:int. Atraso em horas relativo ao passo anterior (ou ao marco, no passo 1).Objetivo:string.InstrucaoExtra:string.MetaTemplateName:string. Template aprovado na Meta usado neste passo (null = texto livre).MetaTemplateLanguage:string. Idioma do template (ex.: "pt_BR").MetaVariaveisJson:string. JSON de List<VariavelTemplateMetaDTO> — a fonte de cada {{n}}.
FormaPagamentoInputDTO
Nome:string. Cadastro da forma de pagamento. A modalidade agrupa a forma no fechamento (À vista/Parcelado) e a taxa de juros pré-preenche o parcelamento.Descricao:string.Tipo:TipoFormaPagamentoEnum?.TaxaJuros:double?.
FormularioCampoInputDTO
Label:string. Definição de um campo do Formulário (criação/edição em lote).Campo:string. Chave do campo (mapeia para o FluentForm: nome, email, telefone...).Tipo:TipoCampoFormularioEnum.Mascara:string.Placeholder:string.Obrigatorio:bool.Ordem:int.ValorPadrao:string.OpcoesJson:string. Opções (JSON) para campos do tipo Seleção.
FormularioCampoPersonalizado
CampoId:long.Resposta:dynamic.
Fornecedor
Id:long.RazaoSocial:string.NomeFantasia:string.CNPJ:string.Telefone:string.Endereco:Endereco— Endereco.InscricaoEstadual:string.InscricaoMunicipal:string.IndicadorIE:IndicadorIEDestinatario?. indIE — indicador da Inscrição Estadual do fornecedor.
FornecedorInputDTO
NomeFantasia:string.CNPJ:string.RazaoSocial:string.
FuncaoNotificarStatusLead
Funcao:FuncaoUsuario— FuncaoUsuario.FuncaoId:long.Status:StatusLead— StatusLead.StatusId:long.
FuncaoNotificarStatusProjeto
Funcao:FuncaoUsuario— FuncaoUsuario.FuncaoId:long.Status:StatusProjeto— StatusProjeto.StatusId:long.
FuncaoStatusLead
Funcao:FuncaoUsuario— FuncaoUsuario.FuncaoId:long.Status:StatusLead— StatusLead.StatusId:long.
FuncaoStatusProjeto
Funcao:FuncaoUsuario— FuncaoUsuario.FuncaoId:long.Status:StatusProjeto— StatusProjeto.StatusId:long.
FuncaoUsuario
Id:long.Nome:string.OrdemAbasJson:string.SetorId:long?.Setor:Setor— Setor.Permissoes:string.SetoresAcesso:string.InstanciasSemResponsabilidadeCrm:string.FuncoesAgendaVisivel:string.
FuncaoVisualizarStatusProjeto
Funcao:FuncaoUsuario— FuncaoUsuario.FuncaoId:long.Status:StatusProjeto— StatusProjeto.StatusId:long.
FuncionarioInputDTO
Nome:string. Corpo de criação de Funcionário (RH/Folha).Cpf:string.Rg:string.DataNascimento:DateTime?.Email:string.Celular:string.Pis:string.CtpsNumero:string.CtpsSerie:string.TipoVinculo:TipoVinculoEnum.Cargo:string.Departamento:string.DataAdmissao:DateTime?.SalarioBase:double.JornadaSemanalHoras:double.DiaPagamento:int.Banco:string.Agencia:string.Conta:string.ChavePix:string.CentroCustoId:long?.UsuarioId:long?.LojaId:long?.
Gerador
Herança: BaseModel — BaseModel.
ProjetoId:long. Unidade geradora do estudo solar avançado. Um Projeto pode ter N Geradores, cada um com localização própria (telhado de uma UC, solo, usina remota etc.). Aditivo: NÃO substitui os campos solares legados de Projeto — coexiste com eles.Projeto:Projeto— Projeto.UnidadeConsumidoraId:long?. UC onde o gerador está fisicamente instalado (null = usina/solo independente).UnidadeConsumidora:UnidadeConsumidora— UnidadeConsumidora.Nome:string.Ordem:int.Latitude:string.Longitude:string.PlusCode:string.TipoTelhadoId:long?.TipoTelhado:TipoTelhado— TipoTelhado.PotenciaCcKwp:double.PotenciaCaKw:double.QuantidadeModulos:int.QuantidadeInversores:int.Inclinacao:int.Azimute:double.IrradiacaoSolar:double.TipoSimulacao:TipoSimulacaoEnum.BateriaId:long?.QuantidadeBaterias:int.EnergiaUtilBancoKwh:double.AutonomiaHorasBateria:double.ValorBaterias:double.LayoutMapaJson:string. Layout dos módulos desenhado no mapa (array de módulos {lat,lng,rotacao,larguraM,alturaM} serializado).Faces:IList<FaceTelhado>— FaceTelhado.Layouts:IList<LayoutModulo>— LayoutModulo.ItensKit:IList<KitCarrinhoItem>— KitCarrinhoItem.Rateios:IList<RateioGeracaoUC>— RateioGeracaoUC.
GeradorInputDTO
ProjetoId:long.UnidadeConsumidoraId:long?.Nome:string.Ordem:int.Latitude:string.Longitude:string.PlusCode:string.TipoTelhadoId:long?.PotenciaCcKwp:double.PotenciaCaKw:double.QuantidadeModulos:int.QuantidadeInversores:int.Inclinacao:int.Azimute:double.IrradiacaoSolar:double.TipoSimulacao:TipoSimulacaoEnum.BateriaId:long?.QuantidadeBaterias:int.EnergiaUtilBancoKwh:double.AutonomiaHorasBateria:double.ValorBaterias:double.
GerarContasPagarServicoInputDTO
CategoriaFinanceiraId:long?.ContaBancariaId:long?.CriarFornecedor:bool. Prestador sem cadastro: criar um fornecedor mínimo (razão social + documento da nota).Parcelas:List<ParcelaPagarInputDTO>— ParcelaPagarInputDTO.
GerarLoteComissaoInputDTO
Comissoes:List<ComissaoDoLoteInputDTO>— ComissaoDoLoteInputDTO.DataVencimento:DateTime?. Vencimento do título do lote. Obrigatório: o lote existe porque alguém combinou uma data de pagamento.CategoriaFinanceiraId:long?.CentroCustoId:long?.ContaBancariaId:long?. Conta sugerida para a baixa (opcional).Contabilizar:bool.Observacao:string.
GerarPagamentosReceberInputDTO
PagamentoId:long?. Parâmetros da geração de Títulos a Receber a partir dos Pagamentos do CRM. Individual (PagamentoId) ou lote retroativo (período + loja opcional).DataInicio:DateTime?.DataFim:DateTime?.LojaId:long?.
GerarPedidosCompraInputDTO
CompraId:long?. Modo individual: gera o pedido apenas desta Compra.DataInicio:DateTime?. Modo lote: início do período (por DataSolicitacao da Compra).DataFim:DateTime?. Modo lote: fim do período (por DataSolicitacao da Compra).LojaId:long?. Modo lote: restringe às Compras de uma loja (via Projeto.Lead.LojaId).
GerarPedidosVendaInputDTO
VendaId:long?. Modo individual: gera o pedido de uma venda específica.DataInicio:DateTime?. Modo lote: início do período (por DataVenda). Use junto com DataFim.DataFim:DateTime?. Modo lote: fim do período (por DataVenda). Use junto com DataInicio.LojaId:long?. Filtro opcional de loja (resolvida do vendedor/lead da venda).
GerarPendenciaSeparacaoInputDTO
Itens:System.Collections.Generic.List<ItemGerarPendenciaInputDTO>— ItemGerarPendenciaInputDTO. Null/vazio = toda a falta de todos os itens (Prevista − separado/conferido).Motivo:MotivoPendenciaEntrega?. Default: SemEstoque (é a falta de galpão).Observacao:string.GerarReposicao:bool. true = já cria a entrega de reposição (a "divisão em 2").
GerarRepassesEquipeInputDTO
DataInicio:DateTime?. Período da finalização (DataFinalizada) das OS.DataFim:DateTime?.OrdemServicoIds:List<long>. Opcional: gera só destas OS (ignora o período).CategoriaFinanceiraId:long?.CentroCustoId:long?. Vazio: usa o centro de custo da própria OS.LojaId:long?.DataVencimento:DateTime?. Vencimento FIXO para o lote inteiro; vazio = finalização da OS + PrazoDias.PrazoDias:int.
GerarReposicaoInputDTO
PendenciaIds:System.Collections.Generic.List<long>. Gera a entrega de reposição a partir de pendências ABERTAS — uma filha por entrega-mãe, itens com PendenciaOrigemId (o entregue da filha abate a mãe). A filha nasce fora de rota e cai na fila normal.
GerarSpedInputDTO
DataInicio:DateTime. Parâmetros para geração de um arquivo SPED (ECD/ECF/EFD) de um período.DataFim:DateTime.LojaId:long?.Finalidade:int. 0 = arquivo original (padrão) · 1 = substituto/retificador. Vai no COD_FIN da EFD ICMS/IPI e no TIPO_ESCRIT da EFD-Contribuições — retransmitir um período corrigido exige o arquivo marcado assim.GerarBlocoH:bool. true = incluir o Bloco H (inventário físico) na EFD ICMS/IPI, montado a partir dos saldos de estoque NA DATA FINAL do período (saldo atual retrocedido pelos movimentos posteriores).
GerarTarefasDePendenciasInputDTO
PendenciaIds:List<long>. Geração de tarefa(s) a partir de pendências selecionadas (vínculo N:N). AgruparEmUma=true → 1 tarefa vinculada a todas (exige mesmo ProjetoId); false → 1 tarefa por pendência (cada uma no ProjetoId da sua pendência).AgruparEmUma:bool.TipoId:long.StatusId:long?.UsuariosIds:List<long>.DataInicial:DateTime.DataEntrega:DateTime.Prioridade:PrioridadeTarefaEnum.Titulo:string.Descricao:string.
GerarTituloComissaoDaVendaInputDTO
VendaId:long.Tipo:string. "Vendedor" ou "Pré-vendedor".DataVencimento:DateTime?. Vencimento do título — o combinado com quem recebe.CategoriaFinanceiraId:long?.CentroCustoId:long?.Observacao:string.
GerarTituloNotaInputDTO
CategoriaFinanceiraId:long?. O que a pessoa completa na tela.CentroCustoId:long?.ContaBancariaId:long?.DataVencimento:DateTime?.DataCompetencia:DateTime?.PedidoVendaId:long?.UsarValorLiquido:bool. Falso lança pelo bruto — quando a contabilidade prefere a receita cheia e trata a retenção à parte.Observacao:string.
GerarTitulosComissaoInputDTO
VendaId:long?. Gera para uma venda específica. Nulo = todas as vendas do período.DataInicio:DateTime?.DataFim:DateTime?.LojaId:long?.CategoriaFinanceiraId:long?. Categoria financeira (despesa de comissão) atribuída aos títulos. Recomendado preencher para a contabilização resolver a conta de despesa correta.CentroCustoId:long?. Centro de custo dos títulos (opcional).DiasVencimento:int?. Dias entre a data da venda e o vencimento da comissão (padrão 30). Ignorado quando vier preenchida.DataVencimento:DateTime?.IncluirPreVendedor:bool. Inclui a comissão do pré-vendedor (quando houver). Padrão true.Beneficiario:string. Gera SÓ a comissão deste papel: "Vendedor" ou "Pré-vendedor". Nulo = os dois (o lote de sempre). É o que o botão "Gerar a pagar" da linha usa: a linha é de uma pessoa, e gerar a comissão do outro beneficiário junto é surpresa.Contabilizar:bool. Contabiliza a provisão (D Despesa / C Fornecedores). Padrão true.
GerarTitulosFinanciamentoInputDTO
FinanciamentoId:long.GerarEntrada:bool. Gera o título de entrada contra o cliente (quando houver).ValorEntrada:decimal?. Valor da entrada; default = Financiamento.Entrada.DataVencimentoEntrada:DateTime?.ParcelasEntrada:List<ParcelaEntradaFinanciamentoInputDTO>— ParcelaEntradaFinanciamentoInputDTO. Parcelas da entrada — o cliente pode pagar em 2x+ (pedido do catarinnasolar). Vazio = parcela única com ValorEntrada/DataVencimentoEntrada; presente, a SOMA vira o valor da entrada.Tranches:List<TrancheFinanciamentoInputDTO>— TrancheFinanciamentoInputDTO. Tranches do repasse do banco (1..N). A soma vira o valor do título de repasse.VencimentosRepasseAConfirmar:bool. O banco ainda não confirmou as datas do repasse: as parcelas nascem com a marca "vencimento a confirmar" (fora do vencido/aging) até alguém definir a data real.IgnorarDivergenciaValores:bool. Override consciente da conferência de valores: quando a soma a gerar não fecha com nenhuma referência (aprovado/financiado/venda), o gerar bloqueia — a menos que isto venha true COM justificativa.JustificativaDivergencia:string.ContaBancariaEntradaId:long?. Contas separadas por destino (ymtenergiasolar: a entrada cai numa conta, o repasse do banco noutra). Nulas = ContaBancariaId.ContaBancariaRepasseId:long?.CategoriaFinanceiraId:long?.CentroCustoId:long?.ContaBancariaId:long?.LojaId:long?.Contabilizar:bool. Contabiliza a provisão (D Clientes / C Receita) dos títulos gerados, reusando o motor de postagem.
GerarTitulosFolhaInputDTO
CategoriaFinanceiraId:long?. Categoria dos líquidos (salários). É também o padrão das guias quando as categorias específicas vêm vazias.CategoriaInssId:long?. Categorias das guias — cada tipo cai na sua linha da DRE (pedido do Igor Mota, YMT, 02/09/2026). Vazio = a dos salários.CategoriaFgtsId:long?.CategoriaIrrfId:long?.CentroCustoId:long?.ContaBancariaId:long?.
GrupoADadosSimulacao
Id:long.ConsumoForaPonta:double.ConsumoPonta:double.FatorCorrecao:double.GeracaoNecessaria:double.EnergiaNecessariaCompensarPonta:double.DemandaContratada:double.EnergiaCompensadaForaPonta:double.EnergiaCompensadaPonta:double.EnergiaCompensadaPontaV2:double.CreditoEnergiaPonta:double.EnergiaNaoCompensadaForaPonta:double.EnergiaNaoCompensadaPonta:double.Maior500kW:bool.DemandaSemICMS:double.DemandaGeracao:double.TotalDemanda:double.TUSDForaPonta:double.TUSDPonta:double.TEForaPonta:double.TEPonta:double.ValorIluminacaoPublica:double.ValorDemandaContratada:double.ValorDemandaSemICMS:double.ValorDemandaGeracao:double.ValorTotalDemandaContratada:double.ValorTotalDemandaGeracao:double.ValorTotalDemandaSemICMS:double.ValorTotalEnergiaNaoCompensadaForaPonta:double.ValorTotalEnergiaNaoCompensadaPonta:double.ValorTotalContaSemEnergiaSolar:double.ValorTotalContaComEnergiaSolar:double.ValorTotalEconomia:double.ValorTotalContaSemEnergiaSolarAnual:double.ValorTotalContaComEnergiaSolarAnual:double.ValorTotalEconomiaAnual:double.GeracaoAnual:double.GeracaoNecessariaAnual:double.ValorTotalDemandas:double.ValorTotalDemandasAnual:double.PorcentagemEficiencia:double.
HistoricoAlteracaoPreProposta
Id:long.Valor:string.Propriedade:string.Usuario:Usuario— Usuario.Data:DateTime.ModeloPreProposta:ModeloPreProposta— ModeloPreProposta.
HistoricoStatusPreProposta
Herança: BaseHistoricoStatusModel — BaseHistoricoStatusModel.
Status:StatusPreProposta— StatusPreProposta.
HomologacaoVistoriaInputDTO
Herança: AbaComplementarInputDTO — AbaComplementarInputDTO.
unidadeGeradora:string.statusHomologacao:string.statusVistoria:string.dataEnvio:DateTime.dataAprovacao:DateTime.dataPedidoVistoria:DateTime.dataVistoriaConcessionaria:DateTime.dataTrocaMedidor:DateTime.observacoes:string.arquivoParecerAcesso:string.
HorarioFuncionamento
Id:long.DiaSemana:DayOfWeek.HoraAbertura:string.HoraFechamento:string.
IdentificacaoUnidadeInputDTO
UnidadeId:long.NumeroSerie:string.Lote:string.DataValidade:DateTime?.Observacao:string.
IdentificarUnidadesInputDTO
Unidades:List<IdentificacaoUnidadeInputDTO>— IdentificacaoUnidadeInputDTO. Preenche a série/lote de unidades que entraram sem identificação. É o que faz a entrada funcionar em QUALQUER lugar: o saldo entra na hora, a identidade se completa quando a etiqueta estiver na mão.
IgnorarNotaRecebidaInputDTO
Motivo:string.
ImportarContagemInputDTO
Itens:List<ItemPlanilhaBaixaInputDTO>— ItemPlanilhaBaixaInputDTO. Contagem importada de planilha — reusa a linha Código/Nome/Qtd da baixa (ItemPlanilhaBaixaInputDTO). Só preenche contagens; nada de saldo.
ImportarCsvInputDTO
ContaBancariaId:long. Importação de extrato a partir de CSV. Colunas por índice (0-based). Valor COM sinal; aceita pt-BR (1.234,56) ou invariante (1234.56).Conteudo:string.Delimitador:string. Separador de colunas. Default ";" se vazio.TemCabecalho:bool.ColunaData:int.ColunaDescricao:int.ColunaValor:int.ColunaDocumento:int?. Coluna opcional do identificador do banco (FITID/documento).FormatoData:string. Formato da data. Default "dd/MM/yyyy" se vazio.
ImportarEventoInputDTO
GoogleEventId:string. Input para importar manualmente um evento do Google como Tarefa. O usuário escolhe o TipoTarefa no momento da importação — usado para eventos retroativos que não viriam pelo fluxo automático.TipoTarefaId:long.
ImportarExtratoInputDTO
ContaBancariaId:long. Importação estruturada de extrato (linhas já parseadas).Linhas:List<ExtratoBancarioLinhaInputDTO>— ExtratoBancarioLinhaInputDTO.
ImportarOfxInputDTO
ContaBancariaId:long. Importação de extrato a partir do conteúdo de um arquivo OFX. Extrai os blocos STMTTRN (DTPOSTED, TRNAMT, FITID, MEMO/NAME).Conteudo:string.
Veja também
Atualizado em: 14/10/2026
Obrigado!
