API Groner — campos e tipos: AbaComplementar a Contato
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
AbaComplementar · AbaComplementarInputDTO · AbrirFolhaInputDTO · AbrirInventarioEstoqueInputDTO · Acao · AcaoCustomizadaAuth · AcaoCustomizadaGovernanca · AcaoCustomizadaInputDTO · AcaoCustomizadaParametro · AcaoCustomizadaRequest · AcaoCustomizadaResposta · AcaoCustomizadaTestarInputDTO · AccountClickSignOutputDTO · AceitarConciliacaoManualInputDTO · AceitarConciliacaoManualItemDTO · AcessoUsuario · AddArquivoInputDTO · AddAutomacaoStatusBaseInputDTO · AddAutomacaoStatusHomologacaoVistoriaInputDTO · AddAutomacaoStatusInstalacaoInputDTO · AddAutomacaoStatusMonitoramentoInputDTO · AddAutomacaoStatusOrdemServicoInputDTO · AddAutomacaoStatusProjetoEngenhariaInputDTO · AddAutomacaoStatusVisitaTecnicaInputDTO · AddChecklistInputDTO · AddComentarioInputDTO · AddEquipeInputDTO · AddHorarioInputDTO · AddItemOrcamentoInputDTO · AddLembreteInputDTO · AddModeloPrePropostaInputDTO · AddOcorrenciaInputDTO · AddPagamentoInputDTO · AddPrecoInsumoInputDTO · AddStatusInputDTO · AddVendaInputDTO · AdicionarBateriaPrePropostaInputDTO · AdicionarCheckListModeloTarefaInputDTO · AdicionarItemEntregaInputDTO · AdicionarItemFilaInputDTO · AdicionarItemInventarioInputDTO · AdicionarItemSeparacaoInputDTO · AdicionarPedidosVendaInputDTO · AgendarCampanhaEmailInputDTO · AgenteConversacionalCanalInputDTO · AgenteConversacionalInputDTO · AgenteInternoInputDTO · AgenteQnaConfig · AgingInputDTO · AjusteEstoqueInputDTO · AlertaInputDTO · AlterarProximasRecorrenciaInputDTO · AlterarStatusOrdemServicoEmLoteInputDTO · AlterarStatusProjetoInputDTO · AlterarTarefasEtiquetasInputDTO · AlterarTarefasNegocioEmLoteInputDTO · AlterarUnidadeEstoqueInputDTO · AlterarUsuarioLoteInputDTO · AlterarValorLoteInputDTO · AlterarVencimentoLoteInputDTO · AplicarOtimizacaoInputDTO · AplicarOtimizacaoRotaDTO · Arquivo · AtribuirLojaLoteInputDTO · AtualizarArquivosNotaInputDTO · AtualizarSegmentacaoInputDTO · AtualizarTextosNotaInputDTO · BaixarUnidadesInputDTO · BaseHistoricoStatusModel · BaseModel · BaseStatusModel · CadastrarEmpresaFiscalInputDTO · CalcularTotalInputDTO · CalculateOptimizedServiceOrdersRouteInputDTO · CallbackSocialInputDTO · CampoPersonalizadoInputDTO · CancelarNotaFiscalInputDTO · CargaPrioritariaInputDTO · CategoriaArquivo · CategoriaCompra · CategoriaFinanceiraInputDTO · CentroCustoInputDTO · CheckItem · Checklist · ComentarioTarefa · ComissaoDoLoteInputDTO · ComparativoInvestimentoConfiguracao · ComparativoInvestimentoSimulador · ComposicaoKitItemInputDTO · Compra · Concessionaria · ConcessionariaInputDTO · ConciliarComissaoCrmInputDTO · ConciliarInputDTO · ConciliarTransferenciaInputDTO · ConcluirInventarioEstoqueInputDTO · ConcluirSeparacaoInputDTO · CondicaoResumoDTO · ConferirItensNotaInputDTO · ConfigFiscalInputDTO · ConfigMetaInputDTO · ConfiguracaoMetaFiltroInputDTO · ConfiguracaoSimulador · ContaBancariaInputDTO · ContaContabilInputDTO · ContabilizarLoteInputDTO · ContactActiveCampaignInputDTO · ContarItemInventarioInputDTO · Contato
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
Verificar duplicidade de um cliente
Requisição completa (Bash):
curl --request GET \
--url "$API_URL/api/Lead/DocumentoDisponivel?documento=00000000000" \
--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": {
"disponivel": true,
"leadId": null,
"leadNome": null
}
}A consulta verifica documento normalizado; o exemplo utiliza documento fictício. disponivel: false exige conferir o contato existente, não criar automaticamente outro.
Listar contatos com paginação
Requisição completa (Bash):
curl --request GET \
--url "$API_URL/api/Lead?PageNumber=1&PageSize=25" \
--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": {
"summary": null,
"totalItems": 0,
"pageNumber": 1,
"pageSize": 25,
"ids": null,
"list": [],
"totalPages": 0,
"hasPreviousPage": false,
"hasNextPage": false,
"nextPageNumber": 0,
"previousPageNumber": 1
}
}O exemplo é fictício, baseado no contrato conferido no código. As respostas não foram coletadas em produção.
Contratos
AbaComplementar
Herança: BaseModel — BaseModel.
Projeto:Projeto— Projeto.ProjetoId:long?.
AbaComplementarInputDTO
projetoId:long.
AbrirFolhaInputDTO
Competencia:DateTime. Abre uma folha de competência (RH/Folha).Tipo:TipoFolhaEnum.LojaId:long?. Quando informada, cobre só os funcionários dessa loja.Descricao:string.
AbrirInventarioEstoqueInputDTO
DepositoId:long. Abre um inventário: congela a posição do depósito e o bloqueia para movimentos até concluir/cancelar.ContagemCega:bool. Esconde o saldo do sistema durante a contagem.Observacao:string.
Acao
Id:long.Data:DateTime.Tipo:TipoAcaoEnum.Tarefa:Tarefa— Tarefa.Usuario:Usuario— Usuario.Lead:Lead— Lead.Projeto:Projeto— Projeto.Descricao:string.Json:string.AcaoId:long?.ExternalId:string.
AcaoCustomizadaAuth
Tipo:string. "none" | "bearer" | "basic" | "apiKeyHeader".Valor:string. bearer: o token. apiKeyHeader: o valor do header.Usuario:string. basic: usuário.Senha:string. basic: senha.Header:string. apiKeyHeader: nome do header (ex.: "X-API-Key").
AcaoCustomizadaGovernanca
RequerAprovacao:bool. Se true, a execução fica como sugestão aguardando aprovação.CustoCreditos:decimal. Créditos a cobrar por chamada (enforcement em fase 2).RateLimitPorMinuto:int. Teto de chamadas por minuto por ação (0 = sem limite extra).
AcaoCustomizadaInputDTO
Nome:string. Entrada de criação/edição. Secrets é write-only (nome→valor): ausente = mantém os atuais; presente = substitui.Descricao:string.Ativo:bool.Parametros:List<AcaoCustomizadaParametro>— AcaoCustomizadaParametro.Request:AcaoCustomizadaRequest— AcaoCustomizadaRequest.Resposta:AcaoCustomizadaResposta— AcaoCustomizadaResposta.Governanca:AcaoCustomizadaGovernanca— AcaoCustomizadaGovernanca.DominiosPermitidos:List<string>.Secrets:Dictionary<string, string>. nome→valor. Nunca retornado. Ausente/null mantém os já salvos.
AcaoCustomizadaParametro
Nome:string. Nome do parâmetro (chave no JSON do tool-call e em {{params.X}}).Tipo:string. "string" | "integer" | "number" | "boolean". Default string.Obrigatorio:bool. Se o LLM é obrigado a fornecer.Descricao:string. Descrição pro LLM saber o que/quando preencher.Enum:List<string>. Opcional: restringe a valores fixos (vira enum no schema).
AcaoCustomizadaRequest
Metodo:string. GET | POST | PUT | PATCH | DELETE.Url:string. URL (template). O host precisa estar nos DominiosPermitidos.Headers:Dictionary<string, string>. Headers (template nos valores).Query:Dictionary<string, string>. Query string (template nos valores).Body:string. Corpo (template). Para BodyTipo "json", é uma string JSON.BodyTipo:string. "none" | "json" | "form" | "text". Default json quando há Body.Auth:AcaoCustomizadaAuth— AcaoCustomizadaAuth.TimeoutMs:int. Timeout por chamada. Default 8000, teto aplicado no runtime.Retries:int. Re-tentativas em falha de rede/5xx. Default 0, teto no runtime.
AcaoCustomizadaResposta
SucessoQuando:string. Critério de sucesso. Suporta "status:200-299" (faixa de status) e/ou uma condição JSONPath de verdade (ex.: "$.ok"). Vazio = 2xx.Extrair:Dictionary<string, string>. Mapa variável → JSONPath (Newtonsoft SelectToken). As variáveis extraídas ficam disponíveis no FormatarParaIA.FormatarParaIA:string. Template do texto entregue ao agente. Pode usar as variáveis extraídas e {{params.X}}. Se vazio, devolve o JSON extraído.QuandoVazio:string. Texto quando a resposta é sucesso mas vem vazia/sem match.QuandoErro:string. Texto quando dá erro (status fora da faixa, timeout, exceção). O agente recebe isto — nunca o payload/stack cru.LimiteCaracteres:int. Teto de caracteres do texto entregue ao LLM. Default 1500.
AcaoCustomizadaTestarInputDTO
Id:long?. Se informado, parte da ação salva (e usa os secrets dela).Definicao:AcaoCustomizadaInputDTO— AcaoCustomizadaInputDTO. A definição a testar (permite testar antes de salvar).Params:Dictionary<string, object>. Valores de teste pros parâmetros (params.*).LeadId:long?.ProjetoId:long?.
AccountClickSignOutputDTO
key:string.
AceitarConciliacaoManualInputDTO
Itens:List<AceitarConciliacaoManualItemDTO>— AceitarConciliacaoManualItemDTO. Aceite manual de conciliação em conta SEM extrato (ControleManual): cada item gera a linha de extrato sintética já casada com a baixa ou com a ponta da transferência.
AceitarConciliacaoManualItemDTO
Fonte:string. "Recebimento", "Pagamento" ou "Transferencia".BaixaId:long. Id da baixa — ou da transferência lançada.ContaBancariaId:long?. Conta da ponta aceita. Só a transferência precisa: ela passa por DUAS contas, e as duas podem ser sem extrato (dinheiro → permuta). A baixa tem conta única e ignora o campo.
AcessoUsuario
Id:long.DataAcesso:DateTime.IPAddress:string.Localizacao:string.InformacoesExtras:string.
AddArquivoInputDTO
CategoriaId:long?.ProjetoId:long?.CampoId:long?.OrdemServicoId:long?.TarefaId:long?.Nome:string.ArquivoUnico:bool.Comprimir:bool.ExternalId:string.
AddAutomacaoStatusBaseInputDTO
Mensagem:string.StatusNegocioId:long?.UrlWebhook:string.NotificarComMeta:bool.NotificacaoInstanceId:string.NotificacaoTemplateId:string.NotificacaoVariaveisJson:string.NotificacaoInstanceIdComum:string. Numero que envia a notificacao em texto livre (instanceId no gronerzap). Vazio = selecao on-demand por loja.NotificacaoTemFallback:bool. Se a notificacao em texto livre pode sair por outro numero quando o escolhido esta desconectado. Nasce true para preservar a entrega.
AddAutomacaoStatusHomologacaoVistoriaInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
StatusHomologacao:StatusHomologacaoEnum?. Automação de status da Homologação e Vistoria. Os três status são opcionais (null = qualquer), mas ao menos um precisa vir preenchido.StatusVistoria:StatusVistoriaEnum?.StatusAumentoCarga:StatusAumentoCargaEnum?.
AddAutomacaoStatusInstalacaoInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
StatusInstalacao:StatusInstalacaoEnum.StatusObra:StatusObraEnum.
AddAutomacaoStatusMonitoramentoInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
Status:StatusMonitoramentoEnum.
AddAutomacaoStatusOrdemServicoInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
StatusId:long.TipoServicoId:long.StatusInstalacaoDestino:StatusInstalacaoEnum?. Opcional: status para o qual mover a Instalação do negócio ao atingir este status de OS.CriarInstalacao:bool. Cria a Instalação do negócio (se não existir) ao atingir este status.DiasInicioInstalacao:int.DiasPrevisaoConclusao:int.CriarProjetoEngenharia:bool. Cria o Projeto de Engenharia do negócio (se não existir) ao atingir este status.EtiquetasIds:string. Etiquetas a adicionar ao negócio — ids separados por ';' (ex.: "3;7").EtiquetasRemoverIds:string. Etiquetas a remover do negócio — ids separados por ';'.GerarContaPagar:bool. Gera o Conta a Pagar do custo da equipe (CustoEquipe) ao atingir este status.FaturarContaReceber:bool. Fatura a OS (Título a Receber) ao atingir este status.
AddAutomacaoStatusProjetoEngenhariaInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
StatusId:long.
AddAutomacaoStatusVisitaTecnicaInputDTO
Herança: AddAutomacaoStatusBaseInputDTO — AddAutomacaoStatusBaseInputDTO.
Status:Safeleads.Models.Enums.Abas_Complementares.StatusVistoriaEnum. Automação de status da Visita Técnica. Além do que as demais fazem, aceita CONDIÇÕES sobre os campos da visita — sem elas, dispara sempre.EtiquetasIds:string. Etiquetas a adicionar ao negócio — ids separados por ponto e vírgula.EtiquetasRemoverIds:string. Etiquetas a remover do negócio — mesmo formato.CondicoesJson:string. Condições em JSON (List de CondicaoAutomacaoDTO). Vazio = sem condição.CondicoesExigeTodas:bool. true = todas as condições (E); false = qualquer uma (OU).
AddChecklistInputDTO
Nome:string.
AddComentarioInputDTO
Comentario:string.ComentarioPaiId:long?.Marcacoes:IList<MarcacaoInputDTO>— MarcacaoInputDTO.
AddEquipeInputDTO
Nome:string.SetorId:long?.
AddHorarioInputDTO
HoraFechamento:string.HoraAbertura:string.DiaSemana:DayOfWeek.
AddItemOrcamentoInputDTO
PrecoInsumoId:long.Quantidade:double.
AddLembreteInputDTO
Nota:string.DataLembrete:DateTime.UsuarioId:long?.
AddModeloPrePropostaInputDTO
Nome:string.Ativo:bool.Texto:string?.EditorAvancado:bool.Loja:long?.Paisagem:bool.TipoGrupo:TipoGrupoEnum.URLCapa:string?.
AddOcorrenciaInputDTO
Ocorrencia:string.Marcacoes:List<MarcacaoUsuarioInputDTO>— MarcacaoUsuarioInputDTO.
AddPagamentoInputDTO
Descricao:string.ValorPagamento:double.VendaId:long?.ArquivoId:long?.DataPagamento:DateTime?.
AddPrecoInsumoInputDTO
PrecoAtacado:double.PrecoCusto:double.PrecoVenda:double.FornecedorId:long.
AddStatusInputDTO
StatusId:long.Obs:string.ProjectExternalId:string.StatusExternalId:string.ProcessarRegras:bool.ValidaStatusDisponivel:bool.StatusOrigemId:long?.Automatico:bool.MovimentacaoMassa:bool.
AddVendaInputDTO
Descricao:string.ValorTotal:double.ValorServico:double.ValorProduto:double.ValorEntrada:double.ValorFinanciamento:double.leadId:long?.projetoId:long?.prePropostaId:long?.usuarioId:long?.TipoComissao:TipoComissaoVendaEnum.porcentagemComissao:double?.porcentagemComissaoPreVendedor:double?.ColetarComissaoProposta:bool.TipoVendaId:long?.
AdicionarBateriaPrePropostaInputDTO
BateriaId:long. DTO para adicionar/alterar bateria em uma pré-proposta existente.HorasAutonomia:double.ProfundidadeDescargaOverride:double?.EficienciaOverride:double?.SimultaneidadeCargas:double?.CargasPrioritarias:List<CargaPrioritariaInputDTO>— CargaPrioritariaInputDTO.Remover:bool. Se true, remove a bateria da proposta ao invés de adicionar.TipoSimulacao:TipoSimulacaoEnum?. Tipo de simulação resultante após adicionar a bateria. Quando nulo, mantém o tipo atual da proposta; se ele era OnGrid, o código eleva para Hibrido como default. Valores aceitos: Hibrido, OffGrid, GridZero, Autoconsumo.ReservaSoCPercentual:double?. Reserva de SoC percentual (0-DoD). Default 0.TemperaturaAmbienteCelsius:double?. Temperatura ambiente média do local em °C (0 = ignorada).
AdicionarCheckListModeloTarefaInputDTO
Nome:string.Itens:string.
AdicionarItemEntregaInputDTO
InsumoId:long. Acrescentar um item À ENTREGA pelo detalhe (admin). Quando a entrega já foi confirmada, o material que entra agora também já saiu do depósito — daí o , que é o que autoriza o movimento de estoque.Quantidade:decimal.DepositoId:long?. Null = depósito padrão, resolvido como nos itens do pedido.JaEntregue:bool. true = este material JÁ foi para a obra: entra como despachado e entregue, e a saída de estoque é registrada agora. false = entra só como previsto, e segue o fluxo normal.Motivo:string.
AdicionarItemFilaInputDTO
UsuarioId:long.Peso:int.
AdicionarItemInventarioInputDTO
InsumoId:long. Item achado na prateleira sem linha no sistema ("item surpresa") — entra com a posição atual do saldo (normalmente zero).
AdicionarItemSeparacaoInputDTO
InsumoId:long. Acrescentar um item que não estava na lista da entrega.Quantidade:decimal.DepositoId:long?. Null = depósito padrão resolvido na confirmação, como nos itens que vêm do pedido.Motivo:string.
AdicionarPedidosVendaInputDTO
PedidoVendaIds:List<long>.
AgendarCampanhaEmailInputDTO
DataAgendamento:DateTime.
AgenteConversacionalCanalInputDTO
Canal:CanalAgenteEnum.IdentificadorCanal:string.
AgenteConversacionalInputDTO
Nome:string. Whitelist de campos editáveis ao criar/atualizar um agente. Não inclui Status/Versao/Auditoria — esses são controlados pelo service (Status muda via endpoints específicos de ativar/pausar).Descricao:string.PapelEFuncao:string.Objetivo:ObjetivoAgenteEnum.PublicoAlvo:string.Tom:TomDeVozEnum.EstilosJson:string.Emoji:UsoEmojiEnum.TamanhoRespostaPadrao:TamanhoRespostaEnum.PrimeiraAbordagem:string.ComoLidarComObjecoes:string.GatilhosEscalonamentoJson:string.MensagemHandoff:string.EscalacaoFilaAtendimentoId:long?. Fila de atendimento que decide quem recebe a conversa ao escalar (precisa estar no gatilho GronerBot). Null = escala pra fila genérica e notifica o responsável do lead.TemasProibidosJson:string.HorarioAtendimentoJson:string.ForaHorario:ComportamentoForaHorarioEnum.NaoAtenderUsuariosGroner:bool.UsarKnowledgeBase:bool.ConhecimentosEssenciaisJson:string.AcoesPermitidasJson:string.AcoesQueExigemAprovacaoJson:string.ModeloPreferido:string.InstrucoesAdicionais:string.FewShotsJson:string.Canais:List<AgenteConversacionalCanalInputDTO>— AgenteConversacionalCanalInputDTO.
AgenteInternoInputDTO
Nome:string. Whitelist de campos editáveis ao criar/atualizar um agente interno. Não inclui Status/Versao/Auditoria — controlados pelo service (Status muda via endpoints de ativar/pausar).Descricao:string.PapelEFuncao:string.Tom:TomDeVozEnum.Emoji:UsoEmojiEnum.TamanhoRespostaPadrao:TamanhoRespostaEnum.UsarKnowledgeBase:bool.ConhecimentosEssenciaisJson:string.AcoesPermitidasJson:string.AcoesQueExigemAprovacaoJson:string.RespeitarPermissoesPerfil:bool.ModeloPreferido:string.InstrucoesAdicionais:string.Canal:CanalAgenteEnum.IdentificadorCanal:string.
AgenteQnaConfig
Id:long.Habilitado:bool.SystemPromptTarefa:string. System prompt em comentários de TAREFA. Vazio = padrão da Groner.SystemPromptProjeto:string. System prompt em ocorrências de PROJETO. Vazio = padrão da Groner.AcoesPermitidasJson:string. JSON array com os nomes das ações que o Q&A pode executar (ex.: ["AdicionarComentarioTarefa","CriarSubtarefa"]). Vazio/null = nenhuma (só responde em texto).CustoEmCreditos:decimal.AtualizadoPorUsuarioId:long?.DataInclusao:DateTime.DataAlteracao:DateTime.
AgingInputDTO
DataBase:DateTime?. Data de referência para classificar vencido/a vencer. Nulo = hoje.LojaId:long?.
AjusteEstoqueInputDTO
InsumoId:long. Ajuste de inventário: define o saldo do Insumo no Depósito para QuantidadeNova. O serviço calcula o delta e gera um movimento AjustePositivo ou AjusteNegativo.DepositoId:long.QuantidadeNova:decimal.CustoUnitario:decimal?. Custo unitário do ajuste de entrada (opcional). Se nulo, usa o custo médio atual.Motivo:MotivoAjusteEstoqueEnum?. Por que o saldo está sendo corrigido à mão. OBRIGATÓRIO: mexer no saldo sem dizer por quê é o buraco de auditoria do estoque — seis meses depois ninguém reconstrói se aquelas 40 placas sumiram, quebraram ou nunca existiram.Observacao:string. Detalhe livre. Obrigatório quando o motivo é Outro — senão "Outro" viraria o atalho para não explicar nada.
AlertaInputDTO
nome:string.descricao:string.data:DateTime.tipoId:long.monitoramentoId:long.
AlterarProximasRecorrenciaInputDTO
APartirDoTituloId:long?. Aplica desta ocorrência em diante (inclusive). Vazio = de todas as que ainda estão em aberto. Ignorado quando vêm TituloIds.TituloIds:List<long>. Ocorrências escolhidas a dedo. Quando vem preenchido, manda nele: nem toda mudança é "daqui em diante" — às vezes só dois meses do contrato mudam.ValorOcorrencia:decimal?. Novo valor de CADA ocorrência (o reajuste do contrato).DiaVencimento:int?. Novo dia do vencimento (1–31). Cada mês é calculado por si: dia 31 vira 30 em abril e 28 em fevereiro, sem "grudar" no dia menor nos meses seguintes.CategoriaFinanceiraId:long?.CentroCustoId:long?.
AlterarStatusOrdemServicoEmLoteInputDTO
Ids:List<long>.StatusId:long.
AlterarStatusProjetoInputDTO
DeStatusId:long.ParaStatusId:long.DeEtapaId:long.ParaEtapaId:long.ProjetoIds:List<long>.
AlterarTarefasEtiquetasInputDTO
Ids:List<long>.EtiquetasIds:List<long>.
AlterarTarefasNegocioEmLoteInputDTO
Ids:List<long>.ProjetoId:long?.
AlterarUnidadeEstoqueInputDTO
NumeroSerie:string. Correção pontual de uma unidade (série digitada errada, marcar defeito, anotar observação).Lote:string.DataValidade:DateTime?.Observacao:string.Status:StatusUnidadeEstoqueEnum?. Situação nova. Não aceita Consumida — sair do estoque é movimento, não edição de campo (use Baixar).
AlterarUsuarioLoteInputDTO
ids:IList<long>.usuarioId:long.
AlterarValorLoteInputDTO
Herança: ParcelasLoteInputDTO — ParcelasLoteInputDTO.
NovoValor:decimal?. Novo valor fixo para cada parcela.PercentualAjuste:decimal?. Alternativa: reajuste percentual (ex.: 10 = +10%).
AlterarVencimentoLoteInputDTO
Herança: ParcelasLoteInputDTO — ParcelasLoteInputDTO.
NovaData:DateTime?. Nova data para TODAS as parcelas selecionadas.DeslocarDias:int?. Alternativa: deslocar N dias (+ adia, − antecipa), preservando o intervalo entre parcelas.
AplicarOtimizacaoInputDTO
Rotas:List<AplicarOtimizacaoRotaDTO>— AplicarOtimizacaoRotaDTO. Aplicação do plano otimizado: cria as rotas e vincula as entregas.
AplicarOtimizacaoRotaDTO
VeiculoId:long.Nome:string.ComprasIds:List<long>. Compras na ordem final da rota.DataPrevista:DateTime?.DataFimPrevista:DateTime?.DistanciaKm:double.DuracaoMin:int.
Arquivo
Herança: BaseModel — BaseModel.
Nome:string.Tamanho:long.Url:string.Extensao:string.Legenda:string.Principal:bool.Categoria:CategoriaArquivo— CategoriaArquivo.ProdutoSolar:ProdutoSolar— ProdutoSolar.Projeto:Projeto— Projeto.ProjetoId:long?.Tarefa:Tarefa— Tarefa.TarefaId:long?.Pendencia:Pendencia— Pendencia.PendenciaId:long?.CategoriaId:long?.Usuario:Usuario— Usuario.UsuarioId:long?.ChaveS3:string.Hash:string.Visibilidade:VisibilidadeArquivoEnum?.OrigemTipo:TipoReferenciaArquivoEnum?.OrigemId:long?.
AtribuirLojaLoteInputDTO
TituloIds:List<long>. Atribuição de loja em lote a Títulos a Pagar. Usada para corrigir títulos criados sem loja (que ficam invisíveis para usuários de loja restrita). Ação de Administrador.LojaId:long.
AtualizarArquivosNotaInputDTO
UrlXml:string. Anexar/substituir arquivos de uma nota registrada externa. Só o que vier preenchido é gravado.UrlDanfe:string.
AtualizarSegmentacaoInputDTO
TipoSegmentacao:TipoSegmentacaoCampanhaEnum. Atualiza o público-alvo de uma campanha: o tipo (Lead/Negócio) e o filtro correspondente (FiltroLeadInputDTO ou FiltroProjetoInputDTO), serializado como JSON.Filtro:object.
AtualizarTextosNotaInputDTO
InformacoesComplementares:string. Ajuste dos textos da nota ANTES de transmitir: a descrição de cada item (o que sai impresso no DANFE) e as informações adicionais. Depois de autorizada a nota é imutável — só carta de correção.Itens:List<DescricaoItemNotaInputDTO>— DescricaoItemNotaInputDTO.
BaixarUnidadesInputDTO
UnidadeIds:List<long>. Saída de unidades escolhidas a dedo (avaria, perda, uso interno). Gera movimento de estoque de verdade — um por depósito envolvido.MotivoAjuste:MotivoAjusteEstoqueEnum?.Observacao:string.PedidoVendaId:long?. Quando informado, registra saída da venda em vez de ajuste.
BaseHistoricoStatusModel
Id:long.DataStatus:DateTime.Obs:string.Usuario:Usuario— Usuario.
BaseModel
Id:long.Excluido:bool.DataInclusao:DateTime.DataAlteracao:DateTime?.DataExclusao:DateTime?.
BaseStatusModel
Id:long.Nome:string.Ordem:int.ModeloEmail:ModeloEmail— ModeloEmail.TemplateNotificacao:string.GatilhoStatusProjeto:StatusProjeto— StatusProjeto.GatilhoStatusLead:StatusLead— StatusLead.
CadastrarEmpresaFiscalInputDTO
CertificadoBase64:string. Arquivo do certificado A1 (.pfx/.p12) codificado em base64.SenhaCertificado:string. Senha do certificado A1.
CalcularTotalInputDTO
Propriedade:string.CustoExtraId:long.RecalcularCustoMaoObra:bool.RecalcularCustoPorPotencia:bool.
CalculateOptimizedServiceOrdersRouteInputDTO
ProjetoIds:List<long>— obrigatório por atributo.TipoServicoId:long— obrigatório por atributo.DataAgendamento:DateTime— obrigatório por atributo.TecnicoId:long?. ID do técnico responsável (opcional, não pode ser usado com EquipeId).EquipeId:long?. ID da equipe técnica responsável (opcional, não pode ser usado com TecnicoId).OptimizationType:string.ConsiderTraffic:bool. Indica se deve considerar o tráfego no cálculo da rota. Padrão: true.
CallbackSocialInputDTO
Code:string.State:string.
CampoPersonalizadoInputDTO
Ativo:bool.Titulo:string.EtapaId:long?.StatusId:long?.AbaDinamicaId:long?.TipoServicoId:long?.TipoTarefaId:long?.StatusAutomaticoId:long?.TipoCampo:TipoCampoPersonalizadoEnum.Mascara:string.Opcoes:List<string>.FuncoesEditar:List<long>.FuncoesVisualizar:List<long>.Formula:string?.PropriedadesVinculadas:List<string>.ValorPadrao:string.GrupoId:long?.CondicaoJson:string.Largura:int?.
CancelarNotaFiscalInputDTO
Justificativa:string. Cancelamento de NotaFiscal autorizada (justificativa SEFAZ ≥ 15 chars).
CargaPrioritariaInputDTO
Nome:string.Quantidade:int.PotenciaW:double.RelacaoIpIn:double.FatorPotencia:double.HorasUso:double.
CategoriaArquivo
Herança: BaseModel — BaseModel.
Ordem:int.Nome:string.Tipo:TipoCategoriaArquivoEnum.Funcoes:string.CategoriaPai:CategoriaArquivo— CategoriaArquivo.CategoriaPaiId:long?.
CategoriaCompra
Id:long.Nome:string.Aprovador:Usuario— Usuario.ObrigatorioAprovacao:bool.ObrigatorioPagamento:bool.ObrigatorioNegocio:bool.SetorId:long?.Setor:Setor— Setor.
CategoriaFinanceiraInputDTO
Codigo:string.Nome:string.Tipo:TipoCategoriaFinanceiraEnum.CategoriaPaiId:long?.Sintetica:bool.ExibirNaDre:bool. False = fora da DRE/painéis (movimentação, não resultado).GrupoDre:GrupoDreEnum?. Seção da DRE. Nulo = automático pelo Tipo.
CentroCustoInputDTO
Codigo:string.Nome:string.CentroCustoPaiId:long?.LojaId:long?.
CheckItem
Herança: BaseModel — BaseModel.
Nome:string.Status:StatusCheckItemEnum.Checklist:Checklist— Checklist.ChecklistId:long?.
Checklist
Herança: BaseModel — BaseModel.
ComentarioTarefa
Herança: BaseModel — BaseModel.
Descricao:string.Usuario:Usuario— Usuario.Tarefa:Tarefa— Tarefa.TarefaId:long?.Marcacoes:IList<MarcacaoComentarioTarefa>— MarcacaoComentarioTarefa.Respostas:IList<ComentarioTarefa>— ComentarioTarefa.ComentarioPaiId:long?. FK explícita para o comentário-pai quando este é uma resposta. Usado pelo hook do agente (TarefaService.AdicionarComentario) para detectar que esta é uma resposta a uma pergunta do Agente IA. Pode ser NULL para comentários top-level.ComentarioPai:ComentarioTarefa— ComentarioTarefa. Navigation reversa do ComentarioPaiId.
ComissaoDoLoteInputDTO
VendaId:long. Uma comissão escolhida para o lote: a venda e o papel.Tipo:string. "Vendedor" ou "Pré-vendedor".
ComparativoInvestimentoConfiguracao
Id:long.Nome:string.Cor:string.Porcentagem:double.
ComparativoInvestimentoSimulador
Id:long.Nome:string.Cor:string.Porcentagem:double.ValorMensal:double.ValorAnual:double.PorcentagemAnual:double.
ComposicaoKitItemInputDTO
ComponenteInsumoId:long. Item da composição (BOM) de um Kit: componente + quantidade por kit.Quantidade:decimal.
Compra
Herança: AbaComplementar — AbaComplementar.
Solicitante:Usuario— Usuario.CodigoPedido:string.CodigoRastreamento:string.UrlPedido:string.UrlNotaFiscal:string.DataSolicitacao:DateTime.DataCotacao:DateTime?.DataAprovacao:DateTime?.DataPagamento:DateTime?.DataPrevisaoEntrega:DateTime?.DataEntrega:DateTime?.Fornecedor:Fornecedor— Fornecedor.Descricao:string.Categoria:CategoriaCompra— CategoriaCompra.TipoEntrega:TipoEntregaCompra— TipoEntregaCompra.StatusCompra:StatusCompra— StatusCompra.ValorTotal:double.RotaId:long?. Rota de entrega à qual esta Compra pertence (null = sem rota).Rota:RotaEntrega.OrdemNaRota:int. Ordem desta Compra (parada) dentro da rota.JanelaEntregaInicio:string. Janela de entrega — hora inicial em que o cliente recebe ("HH:mm"). Opcional; usada pela roteirização automática (sem janela = sem restrição).JanelaEntregaFim:string. Janela de entrega — hora final ("HH:mm"). Opcional.
Concessionaria
Id:long.DataCadastro:DateTime.Ordem:int.Nome:string.ValorkWh:double.ValorkWhTUSD:double.ValorkWhTEPonta:double.ValorkWhTUSDPonta:double.B1TE:double.B1TUSD:double.B1FIOB:double.ImpostoConfins:double.ImpostoICMS:double.ImpostoPIS:double.ValorTESCEE:double.ValorTUSDSCEE:double.TUSDG:double.VerdeForaPontaDemandaTaxada:double.VerdeForaPontaTeTaxada:double.VerdeForaPontaTusdTaxada:double.VerdePontaDemandaTaxada:double.VerdePontaTeTaxada:double.VerdePontaTusdTaxada:double.AzulForaPontaDemandaTaxada:double.AzulForaPontaTeTaxada:double.AzulForaPontaTusdTaxada:double.AzulPontaDemandaTaxada:double.AzulPontaTeTaxada:double.AzulPontaTusdTaxada:double.ValorIluminacaoPublica:double.PorcentagemAliquota:double.TaxaDisponibilidade:bool.Lojas:string.CodigoEnergyBrasil:string.NomeEnergyBrasil:string.
ConcessionariaInputDTO
Nome:string.ValorkWh:double.ValorFioB:double.B1TE:double.B1TUSD:double.B1FIOB:double.ImpostoConfins:double.ImpostoICMS:double.ImpostoPIS:double.TUSDG:double.VerdeForaPontaDemandaTaxada:double.VerdeForaPontaTeTaxada:double.VerdeForaPontaTusdTaxada:double.VerdePontaDemandaTaxada:double.VerdePontaTeTaxada:double.VerdePontaTusdTaxada:double.AzulForaPontaDemandaTaxada:double.AzulForaPontaTeTaxada:double.AzulForaPontaTusdTaxada:double.AzulPontaDemandaTaxada:double.AzulPontaTeTaxada:double.AzulPontaTusdTaxada:double.PorcentagemAliquota:double.
ConciliarComissaoCrmInputDTO
Aplicar:bool. false (padrão) = só lista os candidatos, sem tocar em nada. true = cancela os títulos listados em .TituloIds:List<long>. Títulos a cancelar. Vazio nunca significa "todos": sem id nenhum, a chamada só lista.DataIni:DateTime?. Recorte pela data da VENDA (o mesmo do fechamento).DataFim:DateTime?.
ConciliarInputDTO
ExtratoBancarioId:long. Casa uma linha de extrato com uma baixa interna (Recebimento/Pagamento), com uma parcela em aberto (dando a baixa) ou marca conciliação Manual.Fonte:FonteConciliacaoEnum.FonteId:long?. Id da baixa (RecebimentoParcela/PagamentoParcela) ou da transferência lançada (Fonte TransferenciaLancada). Nulo se Manual ou se DarBaixa = true (a baixa será criada agora).Valor:decimal?. Se nulo, usa o valor da linha do extrato.Observacao:string.DarBaixa:bool. Quando true, dá a baixa da parcela em aberto (ParcelaId) usando a conta/data/valor da linha do extrato e depois concilia.ParcelaId:long?. Parcela (ParcelaReceber/ParcelaPagar) a baixar quando DarBaixa.
ConciliarTransferenciaInputDTO
ExtratoBancarioId:long. A linha a partir da qual o usuário está conciliando.ExtratoEspelhoId:long. A linha espelho, na OUTRA conta, com o tipo OPOSTO.Observacao:string.
ConcluirInventarioEstoqueInputDTO
ZerarNaoContados:bool. Trata itens NÃO contados como contados em zero (gera ajuste negativo do saldo inteiro). Padrão false: não contado fica de fora.Observacao:string.
ConcluirSeparacaoInputDTO
Observacao:string.
CondicaoResumoDTO
Tipo:TipoRegraEnum. Uma regra do filtro do modelo (mesmo formato das Regras Condicionais).Propriedade:string.Condicao:CondicaoRegraStatusEnum.Valor:string.
ConferirItensNotaInputDTO
Itens:List<ItemPedidoDaNotaInputDTO>— ItemPedidoDaNotaInputDTO. Conferência dos itens ANTES de criar o pedido: devolve a mesma prévia, com os itens informados já casados com o Estoque e os avisos de divergência de total.
ConfigFiscalInputDTO
LojaId:long. Criação de uma ConfiguracaoFiscal — basta a Loja; os demais campos (emitente, regime, séries, CSC, NFS-e) são preenchidos por edição-por-propriedade, no mesmo padrão da ConfiguracaoOmie.
ConfigMetaInputDTO
Nome:string.DataInclusao:DateTime.DataInicial:DateTime.DataFinal:DateTime.Objetivo:ObjetivoMetaEnum.UsuarioId:long?.LojaId:long?.TipoTarefaId:long?.Meta:double.
ConfiguracaoMetaFiltroInputDTO
Query:string.UsuarioId:long?.LojaId:long?.DataInicial:DateTime?.DataFinal:DateTime?.
ConfiguracaoSimulador
Herança: BaseModel — BaseModel.
Ativo:bool.Nome:string.CorGraficoPrimaria:string.CorGraficoSecundaria:string.CorTabela:string.RadiacaoSolar:double.PlacaNome:string.PlacaPotencia:double.PlacaProducaoMensal:double.PlacaPorcentagemPerdas:double.PlacaTamanho:double.PlacaPeso:double.ValorkWh:double.ReajusteAnual:double.TaxaPoupanca:double.TaxaManutencao:double.QuantidadeAnosPayBack:int.PlacaPorcentagemEficiencia:double.PorcentagemEficienciaSistema:double.PorcentagemAumentoConsumo:double.ModeloFormulaSimulador:int.OrigemSimulador:Origem— Origem.OrigemFormulario:Origem— Origem.Loja:Loja— Loja.Lojas:string.FasesEnergeticas:string.Tensoes:string.OpcoesPagamentos:IList<OpcaoPagamentoConfiguracaoSimulador>— OpcaoPagamentoConfiguracaoSimulador.ComparativosInvestimento:IList<ComparativoInvestimentoConfiguracao>— ComparativoInvestimentoConfiguracao.IrradiacaoSolar12Meses:string.CotacaoDolar:double.PrecosClienteFinal:IList<PrecoClienteFinal>— PrecoClienteFinal.CoeficienteVeiculos:double.CoeficienteCO2:double.CoeficienteArvores:double.ModeloEmail:ModeloEmail— ModeloEmail.ModeloEmailFormulario:ModeloEmail— ModeloEmail.QuantidadePlacasSomentePar:bool.QuantidadePlacasArrendondarParaCima:bool.DescontarTaxaDisponibilidade:bool.ArredondarPotencia:bool.TipoRadiacao:string.PorcentagemPerdasFaceTelhadoSul:double.PorcentagemPerdasFaceTelhadoNorte:double.PorcentagemPerdasFaceTelhadoLeste:double.PorcentagemPerdasFaceTelhadoOeste:double.PorcentagemPerdasFaceTelhadoNordeste:double.PorcentagemPerdasFaceTelhadoSudeste:double.PorcentagemPerdasFaceTelhadoNoroeste:double.PorcentagemPerdasFaceTelhadoSudoeste:double.PorcentagemEspacamentoPlaca:double.ValidadePropostaDias:int.PrecoPorQuantidadePlacas:bool.SobraParaRecalculoContaSemEnergiaSolar:double.Latitude:string.Longitude:string.PorcentagemDepreciacaoPrimeiroAno:double.PorcentagemDepreciacaoDemaisAnos:double.
ContaBancariaInputDTO
Nome:string.Banco:string.CodigoBanco:string.Agencia:string.Conta:string.DigitoConta:string.TipoConta:TipoContaBancariaEnum.SaldoInicial:decimal.DataSaldoInicial:DateTime?.ChavePix:string.TaxaOperadora:decimal?. Taxa padrão da operadora (%) — contas de cartão.CategoriaTarifaId:long?. Categoria (despesa) do título de tarifa gerado na baixa.DiaFechamento:int?. Só para TipoConta = CartaoCorporativo.DiaVencimento:int?.LimiteCartao:decimal?.Observacao:string.LojaId:long?.ControleManual:bool. Conta SEM extrato bancário (dinheiro, permuta…): a conciliação é por aceite manual.
ContaContabilInputDTO
Codigo:string. Criação de conta do plano de contas contábil.Nome:string.Tipo:TipoContaContabilEnum.Natureza:NaturezaSaldoEnum.Grau:int.Sintetica:bool.ContaPaiId:long?.CodigoContaReferencial:string.ExigeCentroCusto:bool.LojaId:long?.
ContabilizarLoteInputDTO
DataInicio:DateTime. Solicita a contabilização em lote dos eventos financeiros (provisões, pagamentos e recebimentos) cuja competência caia no intervalo informado. Idempotente: documentos já contabilizados são ignorados.DataFim:DateTime.LojaId:long?.
ContactActiveCampaignInputDTO
id:string.email:string.first_name:string.last_name:string.phone:string.ip:string.tags:string.fields:dynamic.customer_acct_name:string.orgname:string.
ContarItemInventarioInputDTO
QuantidadeContada:decimal?. Contagem de um item. QuantidadeContada null LIMPA a contagem (volta a "não contado") — é o caminho da recontagem.CustoInformado:decimal?. Custo unitário para item SEM valorização (congelado = 0); ignorado quando o congelado já tem custo.Observacao:string.
Contato
Id:long.DataCadastro:DateTime.Nome:string.Tipo:TipoLead.InscricaoEstadual:string.CPF:string.CNPJ:string.Sexo:string.RG:string.RGOrgaoExpedidor:string.RGUF:string.DataExpedicaoRG:DateTime.EstadoCivil:string.Profissao:string.NomePai:string.NomeMae:string.TipoContato:string.Celular:string.WhatsAppLid:string.WhatsAppTratado:string.DDICelular:string.DDDCelular:string.Email:string.DataNascimento:DateTime.Endereco:Endereco— Endereco.ValorPatrimonio:double.ValorRendaMensal:double.Banco1Nome:string.Banco1Agencia:string.Banco1Conta:string.Banco2Nome:string.Banco2Agencia:string.Banco2Conta:string.ExternalId:string.Lead:Lead— Lead.CategoriaContato:TipoContato— TipoContato.CategoriaContatoId:long?.DocumentoUrl:string.ProcuracaoAssinadaUrl:string.CartaoCnpjUrl:string.DocumentoSocioAdminUrl:string.ContratoSocialUrl:string.
Veja também
Atualizado em: 14/10/2026
Obrigado!
