> ## Knowledge Base Index > Fetch the complete knowledge base index at: https://ajuda.groner.app/sitemap.xml > Use this file to discover available pages before exploring further. > Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash). # 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](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/) · [Exemplo completo](#2-exemplo-de-uso) · [Campos](#2-contratos) ## Índice clicável [AbaComplementar](#3-abacomplementar) · [AbaComplementarInputDTO](#3-abacomplementarinputdto) · [AbrirFolhaInputDTO](#3-abrirfolhainputdto) · [AbrirInventarioEstoqueInputDTO](#3-abririnventarioestoqueinputdto) · [Acao](#3-acao) · [AcaoCustomizadaAuth](#3-acaocustomizadaauth) · [AcaoCustomizadaGovernanca](#3-acaocustomizadagovernanca) · [AcaoCustomizadaInputDTO](#3-acaocustomizadainputdto) · [AcaoCustomizadaParametro](#3-acaocustomizadaparametro) · [AcaoCustomizadaRequest](#3-acaocustomizadarequest) · [AcaoCustomizadaResposta](#3-acaocustomizadaresposta) · [AcaoCustomizadaTestarInputDTO](#3-acaocustomizadatestarinputdto) · [AccountClickSignOutputDTO](#3-accountclicksignoutputdto) · [AceitarConciliacaoManualInputDTO](#3-aceitarconciliacaomanualinputdto) · [AceitarConciliacaoManualItemDTO](#3-aceitarconciliacaomanualitemdto) · [AcessoUsuario](#3-acessousuario) · [AddArquivoInputDTO](#3-addarquivoinputdto) · [AddAutomacaoStatusBaseInputDTO](#3-addautomacaostatusbaseinputdto) · [AddAutomacaoStatusHomologacaoVistoriaInputDTO](#3-addautomacaostatushomologacaovistoriainputdto) · [AddAutomacaoStatusInstalacaoInputDTO](#3-addautomacaostatusinstalacaoinputdto) · [AddAutomacaoStatusMonitoramentoInputDTO](#3-addautomacaostatusmonitoramentoinputdto) · [AddAutomacaoStatusOrdemServicoInputDTO](#3-addautomacaostatusordemservicoinputdto) · [AddAutomacaoStatusProjetoEngenhariaInputDTO](#3-addautomacaostatusprojetoengenhariainputdto) · [AddAutomacaoStatusVisitaTecnicaInputDTO](#3-addautomacaostatusvisitatecnicainputdto) · [AddChecklistInputDTO](#3-addchecklistinputdto) · [AddComentarioInputDTO](#3-addcomentarioinputdto) · [AddEquipeInputDTO](#3-addequipeinputdto) · [AddHorarioInputDTO](#3-addhorarioinputdto) · [AddItemOrcamentoInputDTO](#3-additemorcamentoinputdto) · [AddLembreteInputDTO](#3-addlembreteinputdto) · [AddModeloPrePropostaInputDTO](#3-addmodeloprepropostainputdto) · [AddOcorrenciaInputDTO](#3-addocorrenciainputdto) · [AddPagamentoInputDTO](#3-addpagamentoinputdto) · [AddPrecoInsumoInputDTO](#3-addprecoinsumoinputdto) · [AddStatusInputDTO](#3-addstatusinputdto) · [AddVendaInputDTO](#3-addvendainputdto) · [AdicionarBateriaPrePropostaInputDTO](#3-adicionarbateriaprepropostainputdto) · [AdicionarCheckListModeloTarefaInputDTO](#3-adicionarchecklistmodelotarefainputdto) · [AdicionarItemEntregaInputDTO](#3-adicionaritementregainputdto) · [AdicionarItemFilaInputDTO](#3-adicionaritemfilainputdto) · [AdicionarItemInventarioInputDTO](#3-adicionariteminventarioinputdto) · [AdicionarItemSeparacaoInputDTO](#3-adicionaritemseparacaoinputdto) · [AdicionarPedidosVendaInputDTO](#3-adicionarpedidosvendainputdto) · [AgendarCampanhaEmailInputDTO](#3-agendarcampanhaemailinputdto) · [AgenteConversacionalCanalInputDTO](#3-agenteconversacionalcanalinputdto) · [AgenteConversacionalInputDTO](#3-agenteconversacionalinputdto) · [AgenteInternoInputDTO](#3-agenteinternoinputdto) · [AgenteQnaConfig](#3-agenteqnaconfig) · [AgingInputDTO](#3-aginginputdto) · [AjusteEstoqueInputDTO](#3-ajusteestoqueinputdto) · [AlertaInputDTO](#3-alertainputdto) · [AlterarProximasRecorrenciaInputDTO](#3-alterarproximasrecorrenciainputdto) · [AlterarStatusOrdemServicoEmLoteInputDTO](#3-alterarstatusordemservicoemloteinputdto) · [AlterarStatusProjetoInputDTO](#3-alterarstatusprojetoinputdto) · [AlterarTarefasEtiquetasInputDTO](#3-alterartarefasetiquetasinputdto) · [AlterarTarefasNegocioEmLoteInputDTO](#3-alterartarefasnegocioemloteinputdto) · [AlterarUnidadeEstoqueInputDTO](#3-alterarunidadeestoqueinputdto) · [AlterarUsuarioLoteInputDTO](#3-alterarusuarioloteinputdto) · [AlterarValorLoteInputDTO](#3-alterarvalorloteinputdto) · [AlterarVencimentoLoteInputDTO](#3-alterarvencimentoloteinputdto) · [AplicarOtimizacaoInputDTO](#3-aplicarotimizacaoinputdto) · [AplicarOtimizacaoRotaDTO](#3-aplicarotimizacaorotadto) · [Arquivo](#3-arquivo) · [AtribuirLojaLoteInputDTO](#3-atribuirlojaloteinputdto) · [AtualizarArquivosNotaInputDTO](#3-atualizararquivosnotainputdto) · [AtualizarSegmentacaoInputDTO](#3-atualizarsegmentacaoinputdto) · [AtualizarTextosNotaInputDTO](#3-atualizartextosnotainputdto) · [BaixarUnidadesInputDTO](#3-baixarunidadesinputdto) · [BaseHistoricoStatusModel](#3-basehistoricostatusmodel) · [BaseModel](#3-basemodel) · [BaseStatusModel](#3-basestatusmodel) · [CadastrarEmpresaFiscalInputDTO](#3-cadastrarempresafiscalinputdto) · [CalcularTotalInputDTO](#3-calculartotalinputdto) · [CalculateOptimizedServiceOrdersRouteInputDTO](#3-calculateoptimizedserviceordersrouteinputdto) · [CallbackSocialInputDTO](#3-callbacksocialinputdto) · [CampoPersonalizadoInputDTO](#3-campopersonalizadoinputdto) · [CancelarNotaFiscalInputDTO](#3-cancelarnotafiscalinputdto) · [CargaPrioritariaInputDTO](#3-cargaprioritariainputdto) · [CategoriaArquivo](#3-categoriaarquivo) · [CategoriaCompra](#3-categoriacompra) · [CategoriaFinanceiraInputDTO](#3-categoriafinanceirainputdto) · [CentroCustoInputDTO](#3-centrocustoinputdto) · [CheckItem](#3-checkitem) · [Checklist](#3-checklist) · [ComentarioTarefa](#3-comentariotarefa) · [ComissaoDoLoteInputDTO](#3-comissaodoloteinputdto) · [ComparativoInvestimentoConfiguracao](#3-comparativoinvestimentoconfiguracao) · [ComparativoInvestimentoSimulador](#3-comparativoinvestimentosimulador) · [ComposicaoKitItemInputDTO](#3-composicaokititeminputdto) · [Compra](#3-compra) · [Concessionaria](#3-concessionaria) · [ConcessionariaInputDTO](#3-concessionariainputdto) · [ConciliarComissaoCrmInputDTO](#3-conciliarcomissaocrminputdto) · [ConciliarInputDTO](#3-conciliarinputdto) · [ConciliarTransferenciaInputDTO](#3-conciliartransferenciainputdto) · [ConcluirInventarioEstoqueInputDTO](#3-concluirinventarioestoqueinputdto) · [ConcluirSeparacaoInputDTO](#3-concluirseparacaoinputdto) · [CondicaoResumoDTO](#3-condicaoresumodto) · [ConferirItensNotaInputDTO](#3-conferiritensnotainputdto) · [ConfigFiscalInputDTO](#3-configfiscalinputdto) · [ConfigMetaInputDTO](#3-configmetainputdto) · [ConfiguracaoMetaFiltroInputDTO](#3-configuracaometafiltroinputdto) · [ConfiguracaoSimulador](#3-configuracaosimulador) · [ContaBancariaInputDTO](#3-contabancariainputdto) · [ContaContabilInputDTO](#3-contacontabilinputdto) · [ContabilizarLoteInputDTO](#3-contabilizarloteinputdto) · [ContactActiveCampaignInputDTO](#3-contactactivecampaigninputdto) · [ContarItemInventarioInputDTO](#3-contariteminventarioinputdto) · [Contato](#3-contato) --- ## Como interpretar os campos `?` indica anulável; `List`/`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):** ```bash curl --request GET \ --url "$API_URL/api/Lead/DocumentoDisponivel?documento=00000000000" \ --header "Authorization: Bearer $TOKEN" \ --header "Accept: application/json" ``` **Resposta ilustrativa — HTTP 200:** ```json { "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):** ```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:** ```json { "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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Projeto`: `Projeto` — [Projeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-projeto). * `ProjetoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### AbaComplementarInputDTO * `projetoId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### Acao * `Id`: `long`. * `Data`: `DateTime`. * `Tipo`: `TipoAcaoEnum`. * `Tarefa`: `Tarefa` — [Tarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefa). * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `Lead`: `Lead` — [Lead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-lead). * `Projeto`: `Projeto` — [Projeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-projeto). * `Descricao`: `string`. * `Json`: `string`. * `AcaoId`: `long?`. * `ExternalId`: `string`. [Voltar ao índice](#2-indice-clicavel) ### 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"). [Voltar ao índice](#2-indice-clicavel) ### 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). [Voltar ao índice](#2-indice-clicavel) ### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadaparametro). * `Request`: `AcaoCustomizadaRequest` — [AcaoCustomizadaRequest](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadarequest). * `Resposta`: `AcaoCustomizadaResposta` — [AcaoCustomizadaResposta](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadaresposta). * `Governanca`: `AcaoCustomizadaGovernanca` — [AcaoCustomizadaGovernanca](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadagovernanca). * `DominiosPermitidos`: `List`. * `Secrets`: `Dictionary`. nome→valor. Nunca retornado. Ausente/null mantém os já salvos. [Voltar ao índice](#2-indice-clicavel) ### 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`. Opcional: restringe a valores fixos (vira enum no schema). [Voltar ao índice](#2-indice-clicavel) ### AcaoCustomizadaRequest * `Metodo`: `string`. GET | POST | PUT | PATCH | DELETE. * `Url`: `string`. URL (template). O host precisa estar nos DominiosPermitidos. * `Headers`: `Dictionary`. Headers (template nos valores). * `Query`: `Dictionary`. 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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. [Voltar ao índice](#2-indice-clicavel) ### 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`. 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. [Voltar ao índice](#2-indice-clicavel) ### AcaoCustomizadaTestarInputDTO * `Id`: `long?`. Se informado, parte da ação salva (e usa os secrets dela). * `Definicao`: `AcaoCustomizadaInputDTO` — [AcaoCustomizadaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadainputdto). A definição a testar (permite testar antes de salvar). * `Params`: `Dictionary`. Valores de teste pros parâmetros (params.*). * `LeadId`: `long?`. * `ProjetoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### AccountClickSignOutputDTO * `key`: `string`. [Voltar ao índice](#2-indice-clicavel) ### AceitarConciliacaoManualInputDTO * `Itens`: `List` — [AceitarConciliacaoManualItemDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### AcessoUsuario * `Id`: `long`. * `DataAcesso`: `DateTime`. * `IPAddress`: `string`. * `Localizacao`: `string`. * `InformacoesExtras`: `string`. [Voltar ao índice](#2-indice-clicavel) ### AddArquivoInputDTO * `CategoriaId`: `long?`. * `ProjetoId`: `long?`. * `CampoId`: `long?`. * `OrdemServicoId`: `long?`. * `TarefaId`: `long?`. * `Nome`: `string`. * `ArquivoUnico`: `bool`. * `Comprimir`: `bool`. * `ExternalId`: `string`. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusHomologacaoVistoriaInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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?`. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusInstalacaoInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addautomacaostatusbaseinputdto). * `StatusInstalacao`: `StatusInstalacaoEnum`. * `StatusObra`: `StatusObraEnum`. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusMonitoramentoInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addautomacaostatusbaseinputdto). * `Status`: `StatusMonitoramentoEnum`. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusOrdemServicoInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusProjetoEngenhariaInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addautomacaostatusbaseinputdto). * `StatusId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### AddAutomacaoStatusVisitaTecnicaInputDTO **Herança:** `AddAutomacaoStatusBaseInputDTO` — [AddAutomacaoStatusBaseInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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). [Voltar ao índice](#2-indice-clicavel) ### AddChecklistInputDTO * `Nome`: `string`. [Voltar ao índice](#2-indice-clicavel) ### AddComentarioInputDTO * `Comentario`: `string`. * `ComentarioPaiId`: `long?`. * `Marcacoes`: `IList` — [MarcacaoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-marcacaoinputdto). [Voltar ao índice](#2-indice-clicavel) ### AddEquipeInputDTO * `Nome`: `string`. * `SetorId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### AddHorarioInputDTO * `HoraFechamento`: `string`. * `HoraAbertura`: `string`. * `DiaSemana`: `DayOfWeek`. [Voltar ao índice](#2-indice-clicavel) ### AddItemOrcamentoInputDTO * `PrecoInsumoId`: `long`. * `Quantidade`: `double`. [Voltar ao índice](#2-indice-clicavel) ### AddLembreteInputDTO * `Nota`: `string`. * `DataLembrete`: `DateTime`. * `UsuarioId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### AddModeloPrePropostaInputDTO * `Nome`: `string`. * `Ativo`: `bool`. * `Texto`: `string?`. * `EditorAvancado`: `bool`. * `Loja`: `long?`. * `Paisagem`: `bool`. * `TipoGrupo`: `TipoGrupoEnum`. * `URLCapa`: `string?`. [Voltar ao índice](#2-indice-clicavel) ### AddOcorrenciaInputDTO * `Ocorrencia`: `string`. * `Marcacoes`: `List` — [MarcacaoUsuarioInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-marcacaousuarioinputdto). [Voltar ao índice](#2-indice-clicavel) ### AddPagamentoInputDTO * `Descricao`: `string`. * `ValorPagamento`: `double`. * `VendaId`: `long?`. * `ArquivoId`: `long?`. * `DataPagamento`: `DateTime?`. [Voltar ao índice](#2-indice-clicavel) ### AddPrecoInsumoInputDTO * `PrecoAtacado`: `double`. * `PrecoCusto`: `double`. * `PrecoVenda`: `double`. * `FornecedorId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### AddStatusInputDTO * `StatusId`: `long`. * `Obs`: `string`. * `ProjectExternalId`: `string`. * `StatusExternalId`: `string`. * `ProcessarRegras`: `bool`. * `ValidaStatusDisponivel`: `bool`. * `StatusOrigemId`: `long?`. * `Automatico`: `bool`. * `MovimentacaoMassa`: `bool`. [Voltar ao índice](#2-indice-clicavel) ### 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?`. [Voltar ao índice](#2-indice-clicavel) ### AdicionarBateriaPrePropostaInputDTO * `BateriaId`: `long`. DTO para adicionar/alterar bateria em uma pré-proposta existente. * `HorasAutonomia`: `double`. * `ProfundidadeDescargaOverride`: `double?`. * `EficienciaOverride`: `double?`. * `SimultaneidadeCargas`: `double?`. * `CargasPrioritarias`: `List` — [CargaPrioritariaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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). [Voltar ao índice](#2-indice-clicavel) ### AdicionarCheckListModeloTarefaInputDTO * `Nome`: `string`. * `Itens`: `string`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### AdicionarItemFilaInputDTO * `UsuarioId`: `long`. * `Peso`: `int`. [Voltar ao índice](#2-indice-clicavel) ### AdicionarItemInventarioInputDTO * `InsumoId`: `long`. Item achado na prateleira sem linha no sistema ("item surpresa") — entra com a posição atual do saldo (normalmente zero). [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### AdicionarPedidosVendaInputDTO * `PedidoVendaIds`: `List`. [Voltar ao índice](#2-indice-clicavel) ### AgendarCampanhaEmailInputDTO * `DataAgendamento`: `DateTime`. [Voltar ao índice](#2-indice-clicavel) ### AgenteConversacionalCanalInputDTO * `Canal`: `CanalAgenteEnum`. * `IdentificadorCanal`: `string`. [Voltar ao índice](#2-indice-clicavel) ### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteconversacionalcanalinputdto). [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### AgingInputDTO * `DataBase`: `DateTime?`. Data de referência para classificar vencido/a vencer. Nulo = hoje. * `LojaId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### AlertaInputDTO * `nome`: `string`. * `descricao`: `string`. * `data`: `DateTime`. * `tipoId`: `long`. * `monitoramentoId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### 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`. 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?`. [Voltar ao índice](#2-indice-clicavel) ### AlterarStatusOrdemServicoEmLoteInputDTO * `Ids`: `List`. * `StatusId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### AlterarStatusProjetoInputDTO * `DeStatusId`: `long`. * `ParaStatusId`: `long`. * `DeEtapaId`: `long`. * `ParaEtapaId`: `long`. * `ProjetoIds`: `List`. [Voltar ao índice](#2-indice-clicavel) ### AlterarTarefasEtiquetasInputDTO * `Ids`: `List`. * `EtiquetasIds`: `List`. [Voltar ao índice](#2-indice-clicavel) ### AlterarTarefasNegocioEmLoteInputDTO * `Ids`: `List`. * `ProjetoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### 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). [Voltar ao índice](#2-indice-clicavel) ### AlterarUsuarioLoteInputDTO * `ids`: `IList`. * `usuarioId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### AlterarValorLoteInputDTO **Herança:** `ParcelasLoteInputDTO` — [ParcelasLoteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-parcelasloteinputdto). * `NovoValor`: `decimal?`. Novo valor fixo para cada parcela. * `PercentualAjuste`: `decimal?`. Alternativa: reajuste percentual (ex.: 10 = +10%). [Voltar ao índice](#2-indice-clicavel) ### AlterarVencimentoLoteInputDTO **Herança:** `ParcelasLoteInputDTO` — [ParcelasLoteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-parcelasloteinputdto). * `NovaData`: `DateTime?`. Nova data para TODAS as parcelas selecionadas. * `DeslocarDias`: `int?`. Alternativa: deslocar N dias (+ adia, − antecipa), preservando o intervalo entre parcelas. [Voltar ao índice](#2-indice-clicavel) ### AplicarOtimizacaoInputDTO * `Rotas`: `List` — [AplicarOtimizacaoRotaDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-aplicarotimizacaorotadto). Aplicação do plano otimizado: cria as rotas e vincula as entregas. [Voltar ao índice](#2-indice-clicavel) ### AplicarOtimizacaoRotaDTO * `VeiculoId`: `long`. * `Nome`: `string`. * `ComprasIds`: `List`. Compras na ordem final da rota. * `DataPrevista`: `DateTime?`. * `DataFimPrevista`: `DateTime?`. * `DistanciaKm`: `double`. * `DuracaoMin`: `int`. [Voltar ao índice](#2-indice-clicavel) ### Arquivo **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Nome`: `string`. * `Tamanho`: `long`. * `Url`: `string`. * `Extensao`: `string`. * `Legenda`: `string`. * `Principal`: `bool`. * `Categoria`: `CategoriaArquivo` — [CategoriaArquivo](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-categoriaarquivo). * `ProdutoSolar`: `ProdutoSolar` — [ProdutoSolar](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-produtosolar). * `Projeto`: `Projeto` — [Projeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-projeto). * `ProjetoId`: `long?`. * `Tarefa`: `Tarefa` — [Tarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefa). * `TarefaId`: `long?`. * `Pendencia`: `Pendencia` — [Pendencia](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-pendencia). * `PendenciaId`: `long?`. * `CategoriaId`: `long?`. * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `UsuarioId`: `long?`. * `ChaveS3`: `string`. * `Hash`: `string`. * `Visibilidade`: `VisibilidadeArquivoEnum?`. * `OrigemTipo`: `TipoReferenciaArquivoEnum?`. * `OrigemId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### AtribuirLojaLoteInputDTO * `TituloIds`: `List`. 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`. [Voltar ao índice](#2-indice-clicavel) ### AtualizarArquivosNotaInputDTO * `UrlXml`: `string`. Anexar/substituir arquivos de uma nota registrada externa. Só o que vier preenchido é gravado. * `UrlDanfe`: `string`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-descricaoitemnotainputdto). [Voltar ao índice](#2-indice-clicavel) ### BaixarUnidadesInputDTO * `UnidadeIds`: `List`. 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. [Voltar ao índice](#2-indice-clicavel) ### BaseHistoricoStatusModel * `Id`: `long`. * `DataStatus`: `DateTime`. * `Obs`: `string`. * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). [Voltar ao índice](#2-indice-clicavel) ### BaseModel * `Id`: `long`. * `Excluido`: `bool`. * `DataInclusao`: `DateTime`. * `DataAlteracao`: `DateTime?`. * `DataExclusao`: `DateTime?`. [Voltar ao índice](#2-indice-clicavel) ### BaseStatusModel * `Id`: `long`. * `Nome`: `string`. * `Ordem`: `int`. * `ModeloEmail`: `ModeloEmail` — [ModeloEmail](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-modeloemail). * `TemplateNotificacao`: `string`. * `GatilhoStatusProjeto`: `StatusProjeto` — [StatusProjeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statusprojeto). * `GatilhoStatusLead`: `StatusLead` — [StatusLead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statuslead). [Voltar ao índice](#2-indice-clicavel) ### CadastrarEmpresaFiscalInputDTO * `CertificadoBase64`: `string`. Arquivo do certificado A1 (.pfx/.p12) codificado em base64. * `SenhaCertificado`: `string`. Senha do certificado A1. [Voltar ao índice](#2-indice-clicavel) ### CalcularTotalInputDTO * `Propriedade`: `string`. * `CustoExtraId`: `long`. * `RecalcularCustoMaoObra`: `bool`. * `RecalcularCustoPorPotencia`: `bool`. [Voltar ao índice](#2-indice-clicavel) ### CalculateOptimizedServiceOrdersRouteInputDTO * `ProjetoIds`: `List` — 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. [Voltar ao índice](#2-indice-clicavel) ### CallbackSocialInputDTO * `Code`: `string`. * `State`: `string`. [Voltar ao índice](#2-indice-clicavel) ### CampoPersonalizadoInputDTO * `Ativo`: `bool`. * `Titulo`: `string`. * `EtapaId`: `long?`. * `StatusId`: `long?`. * `AbaDinamicaId`: `long?`. * `TipoServicoId`: `long?`. * `TipoTarefaId`: `long?`. * `StatusAutomaticoId`: `long?`. * `TipoCampo`: `TipoCampoPersonalizadoEnum`. * `Mascara`: `string`. * `Opcoes`: `List`. * `FuncoesEditar`: `List`. * `FuncoesVisualizar`: `List`. * `Formula`: `string?`. * `PropriedadesVinculadas`: `List`. * `ValorPadrao`: `string`. * `GrupoId`: `long?`. * `CondicaoJson`: `string`. * `Largura`: `int?`. [Voltar ao índice](#2-indice-clicavel) ### CancelarNotaFiscalInputDTO * `Justificativa`: `string`. Cancelamento de NotaFiscal autorizada (justificativa SEFAZ ≥ 15 chars). [Voltar ao índice](#2-indice-clicavel) ### CargaPrioritariaInputDTO * `Nome`: `string`. * `Quantidade`: `int`. * `PotenciaW`: `double`. * `RelacaoIpIn`: `double`. * `FatorPotencia`: `double`. * `HorasUso`: `double`. [Voltar ao índice](#2-indice-clicavel) ### CategoriaArquivo **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Ordem`: `int`. * `Nome`: `string`. * `Tipo`: `TipoCategoriaArquivoEnum`. * `Funcoes`: `string`. * `CategoriaPai`: `CategoriaArquivo` — [CategoriaArquivo](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-categoriaarquivo). * `CategoriaPaiId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### CategoriaCompra * `Id`: `long`. * `Nome`: `string`. * `Aprovador`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `ObrigatorioAprovacao`: `bool`. * `ObrigatorioPagamento`: `bool`. * `ObrigatorioNegocio`: `bool`. * `SetorId`: `long?`. * `Setor`: `Setor` — [Setor](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-setor). [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### CentroCustoInputDTO * `Codigo`: `string`. * `Nome`: `string`. * `CentroCustoPaiId`: `long?`. * `LojaId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### CheckItem **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Nome`: `string`. * `Status`: `StatusCheckItemEnum`. * `Checklist`: `Checklist` — [Checklist](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-checklist). * `ChecklistId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### Checklist **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Nome`: `string`. * `Items`: `IList` — [CheckItem](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-checkitem). * `Tarefa`: `Tarefa` — [Tarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefa). * `TarefaId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### ComentarioTarefa **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Descricao`: `string`. * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `Tarefa`: `Tarefa` — [Tarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefa). * `TarefaId`: `long?`. * `Marcacoes`: `IList` — [MarcacaoComentarioTarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-marcacaocomentariotarefa). * `Respostas`: `IList` — [ComentarioTarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-comentariotarefa). Navigation reversa do ComentarioPaiId. [Voltar ao índice](#2-indice-clicavel) ### ComissaoDoLoteInputDTO * `VendaId`: `long`. Uma comissão escolhida para o lote: a venda e o papel. * `Tipo`: `string`. "Vendedor" ou "Pré-vendedor". [Voltar ao índice](#2-indice-clicavel) ### ComparativoInvestimentoConfiguracao * `Id`: `long`. * `Nome`: `string`. * `Cor`: `string`. * `Porcentagem`: `double`. [Voltar ao índice](#2-indice-clicavel) ### ComparativoInvestimentoSimulador * `Id`: `long`. * `Nome`: `string`. * `Cor`: `string`. * `Porcentagem`: `double`. * `ValorMensal`: `double`. * `ValorAnual`: `double`. * `PorcentagemAnual`: `double`. [Voltar ao índice](#2-indice-clicavel) ### ComposicaoKitItemInputDTO * `ComponenteInsumoId`: `long`. Item da composição (BOM) de um Kit: componente + quantidade por kit. * `Quantidade`: `decimal`. [Voltar ao índice](#2-indice-clicavel) ### Compra **Herança:** `AbaComplementar` — [AbaComplementar](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-abacomplementar). * `Solicitante`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `CodigoPedido`: `string`. * `CodigoRastreamento`: `string`. * `UrlPedido`: `string`. * `UrlNotaFiscal`: `string`. * `DataSolicitacao`: `DateTime`. * `DataCotacao`: `DateTime?`. * `DataAprovacao`: `DateTime?`. * `DataPagamento`: `DateTime?`. * `DataPrevisaoEntrega`: `DateTime?`. * `DataEntrega`: `DateTime?`. * `Fornecedor`: `Fornecedor` — [Fornecedor](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-fornecedor). * `Descricao`: `string`. * `Categoria`: `CategoriaCompra` — [CategoriaCompra](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-categoriacompra). * `TipoEntrega`: `TipoEntregaCompra` — [TipoEntregaCompra](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipoentregacompra). * `StatusCompra`: `StatusCompra` — [StatusCompra](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-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. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### ConciliarComissaoCrmInputDTO * `Aplicar`: `bool`. false (padrão) = só lista os candidatos, sem tocar em nada. true = cancela os títulos listados em . * `TituloIds`: `List`. 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?`. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### ConcluirSeparacaoInputDTO * `Observacao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### CondicaoResumoDTO * `Tipo`: `TipoRegraEnum`. Uma regra do filtro do modelo (mesmo formato das Regras Condicionais). * `Propriedade`: `string`. * `Condicao`: `CondicaoRegraStatusEnum`. * `Valor`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ConferirItensNotaInputDTO * `Itens`: `List` — [ItemPedidoDaNotaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-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. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### ConfigMetaInputDTO * `Nome`: `string`. * `DataInclusao`: `DateTime`. * `DataInicial`: `DateTime`. * `DataFinal`: `DateTime`. * `Objetivo`: `ObjetivoMetaEnum`. * `UsuarioId`: `long?`. * `LojaId`: `long?`. * `TipoTarefaId`: `long?`. * `Meta`: `double`. [Voltar ao índice](#2-indice-clicavel) ### ConfiguracaoMetaFiltroInputDTO * `Query`: `string`. * `UsuarioId`: `long?`. * `LojaId`: `long?`. * `DataInicial`: `DateTime?`. * `DataFinal`: `DateTime?`. [Voltar ao índice](#2-indice-clicavel) ### ConfiguracaoSimulador **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-origem). * `OrigemFormulario`: `Origem` — [Origem](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-origem). * `Loja`: `Loja` — [Loja](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-loja). * `Lojas`: `string`. * `FasesEnergeticas`: `string`. * `Tensoes`: `string`. * `OpcoesPagamentos`: `IList` — [OpcaoPagamentoConfiguracaoSimulador](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-opcaopagamentoconfiguracaosimulador). * `ComparativosInvestimento`: `IList` — [ComparativoInvestimentoConfiguracao](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-comparativoinvestimentoconfiguracao). * `IrradiacaoSolar12Meses`: `string`. * `CotacaoDolar`: `double`. * `PrecosClienteFinal`: `IList` — [PrecoClienteFinal](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-precoclientefinal). * `CoeficienteVeiculos`: `double`. * `CoeficienteCO2`: `double`. * `CoeficienteArvores`: `double`. * `ModeloEmail`: `ModeloEmail` — [ModeloEmail](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-modeloemail). * `ModeloEmailFormulario`: `ModeloEmail` — [ModeloEmail](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-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`. [Voltar ao índice](#2-indice-clicavel) ### 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. [Voltar ao índice](#2-indice-clicavel) ### 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?`. [Voltar ao índice](#2-indice-clicavel) ### 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?`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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`. [Voltar ao índice](#2-indice-clicavel) ### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-endereco). * `ValorPatrimonio`: `double`. * `ValorRendaMensal`: `double`. * `Banco1Nome`: `string`. * `Banco1Agencia`: `string`. * `Banco1Conta`: `string`. * `Banco2Nome`: `string`. * `Banco2Agencia`: `string`. * `Banco2Conta`: `string`. * `ExternalId`: `string`. * `Lead`: `Lead` — [Lead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-lead). * `CategoriaContato`: `TipoContato` — [TipoContato](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipocontato). * `CategoriaContatoId`: `long?`. * `DocumentoUrl`: `string`. * `ProcuracaoAssinadaUrl`: `string`. * `CartaoCnpjUrl`: `string`. * `DocumentoSocioAdminUrl`: `string`. * `ContratoSocialUrl`: `string`. [Voltar ao índice](#2-indice-clicavel) ## Veja também * [Guia principal, autenticação e coleção Postman](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/) * [Como gerar token de API](https://ajuda.groner.app/pt-br/article/como-gerar-um-token-de-api-para-integrar-o-groner-com-outros-sistemas-2okhj6/) * [Limites de requisições](https://ajuda.groner.app/pt-br/article/limites-de-requisicoes-da-api-da-groner-1cwtj65/)