> ## 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: ImportarXmlNotaRecebidaInputDTO a PedidoCompraInputDTO 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 [ImportarXmlNotaRecebidaInputDTO](#3-importarxmlnotarecebidainputdto) · [IncluirFuncionariosFolhaInputDTO](#3-incluirfuncionariosfolhainputdto) · [InstalacaoInputDTO](#3-instalacaoinputdto) · [InsumoAplicadoInputDTO](#3-insumoaplicadoinputdto) · [InsumoAplicadoSimulacao](#3-insumoaplicadosimulacao) · [InsumoImportarInputDTO](#3-insumoimportarinputdto) · [InsumoInputDTO](#3-insumoinputdto) · [InterpolarTextoInputDTO](#3-interpolartextoinputdto) · [ItemBaixaInputDTO](#3-itembaixainputdto) · [ItemCriarEntregaPedidoInputDTO](#3-itemcriarentregapedidoinputdto) · [ItemDevolucaoInputDTO](#3-itemdevolucaoinputdto) · [ItemEntregarInputDTO](#3-itementregarinputdto) · [ItemGerarPendenciaInputDTO](#3-itemgerarpendenciainputdto) · [ItemModeloTarefaFiltroInputDTO](#3-itemmodelotarefafiltroinputdto) · [ItemModeloTarefaInputDTO](#3-itemmodelotarefainputdto) · [ItemNotaFiscalInputDTO](#3-itemnotafiscalinputdto) · [ItemPedidoCompraInputDTO](#3-itempedidocomprainputdto) · [ItemPedidoDaNotaInputDTO](#3-itempedidodanotainputdto) · [ItemPedidoVendaInputDTO](#3-itempedidovendainputdto) · [ItemPlanilhaBaixaInputDTO](#3-itemplanilhabaixainputdto) · [ItemRecebimentoCompraInputDTO](#3-itemrecebimentocomprainputdto) · [ItemServicoFiscalInputDTO](#3-itemservicofiscalinputdto) · [ItensExtraGestaoInputDTO](#3-itensextragestaoinputdto) · [JustificarDivergenciaInputDTO](#3-justificardivergenciainputdto) · [KitCarrinhoItem](#3-kitcarrinhoitem) · [KitCarrinhoItemInputDTO](#3-kitcarrinhoiteminputdto) · [KitSelecionadoInputDTO](#3-kitselecionadoinputdto) · [KitSnapshotInputDTO](#3-kitsnapshotinputdto) · [LancamentoContabilInputDTO](#3-lancamentocontabilinputdto) · [LancamentoHoleriteInputDTO](#3-lancamentoholeriteinputdto) · [LayoutMapaInputDTO](#3-layoutmapainputdto) · [LayoutModulo](#3-layoutmodulo) · [LayoutModuloInputDTO](#3-layoutmoduloinputdto) · [Lead](#3-lead) · [LeadAlterarOrigemEmLoteInputDTO](#3-leadalterarorigememloteinputdto) · [LeadCamposAnaliseIAInputDTO](#3-leadcamposanaliseiainputdto) · [LeadInputDTO](#3-leadinputdto) · [LeadUsuario](#3-leadusuario) · [Lead_Status](#3-leadstatus) · [Lembrete](#3-lembrete) · [LiberarPagamentoComissaoInputDTO](#3-liberarpagamentocomissaoinputdto) · [Localizacao](#3-localizacao) · [Loja](#3-loja) · [LojaDadosProposta](#3-lojadadosproposta) · [LojaInputDTO](#3-lojainputdto) · [LojasAtendidasInputDTO](#3-lojasatendidasinputdto) · [ManifestarNotaRecebidaInputDTO](#3-manifestarnotarecebidainputdto) · [MarcacaoComentarioTarefa](#3-marcacaocomentariotarefa) · [MarcacaoInputDTO](#3-marcacaoinputdto) · [MarcacaoUsuarioInputDTO](#3-marcacaousuarioinputdto) · [MigrarEntregasInputDTO](#3-migrarentregasinputdto) · [ModeloDocumentoInputDTO](#3-modelodocumentoinputdto) · [ModeloEmail](#3-modeloemail) · [ModeloPendenciaResumoDTO](#3-modelopendenciaresumodto) · [ModeloPreProposta](#3-modelopreproposta) · [MonitoramentoInputDTO](#3-monitoramentoinputdto) · [MontarKitInputDTO](#3-montarkitinputdto) · [MotivoPerda](#3-motivoperda) · [MoverAprovacaoPagarInputDTO](#3-moveraprovacaopagarinputdto) · [MovimentacaoMassaInputDTO](#3-movimentacaomassainputdto) · [MovimentarMultiplosCardsInputDTO](#3-movimentarmultiploscardsinputdto) · [MovimentoEstoqueInputDTO](#3-movimentoestoqueinputdto) · [NaturezaOperacaoInputDTO](#3-naturezaoperacaoinputdto) · [NomeInputDto](#3-nomeinputdto) · [NotaFiscalFiltroInputDTO](#3-notafiscalfiltroinputdto) · [NotaFiscalInputDTO](#3-notafiscalinputdto) · [NotificacaoMetaInputDTO](#3-notificacaometainputdto) · [NotificacaoMetaStatusProjeto](#3-notificacaometastatusprojeto) · [ObterMetaInputDTO](#3-obtermetainputdto) · [OpcaoCampoInputDTO](#3-opcaocampoinputdto) · [OpcaoPagamentoConfiguracaoSimulador](#3-opcaopagamentoconfiguracaosimulador) · [OpcaoPagamentoSimulador](#3-opcaopagamentosimulador) · [OrdemServico](#3-ordemservico) · [OrdemServicoInputDTO](#3-ordemservicoinputdto) · [Origem](#3-origem) · [OtimizarRotasInputDTO](#3-otimizarrotasinputdto) · [PagamentoComissao](#3-pagamentocomissao) · [PagamentoInputDTO](#3-pagamentoinputdto) · [PagarLoteInputDTO](#3-pagarloteinputdto) · [PagarParcelaInputDTO](#3-pagarparcelainputdto) · [ParcelaEntradaFinanciamentoInputDTO](#3-parcelaentradafinanciamentoinputdto) · [ParcelaPagamentoInputDTO](#3-parcelapagamentoinputdto) · [ParcelaPagarInputDTO](#3-parcelapagarinputdto) · [ParcelaReceberInputDTO](#3-parcelareceberinputdto) · [ParcelasLoteInputDTO](#3-parcelasloteinputdto) · [PartidaContabilInputDTO](#3-partidacontabilinputdto) · [PaybackAnoEstudoInputDTO](#3-paybackanoestudoinputdto) · [PedidoCompraInputDTO](#3-pedidocomprainputdto) --- ## 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 ### Consultar conexões sociais **Requisição completa (Bash):** ```bash curl --request GET \ --url "$API_URL/api/EditorSocial/conexoes" \ --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": { "conexoes": [] } } ``` ### Solicitar publicação e interpretar erro de negócio **Requisição completa (Bash):** ```bash curl --request POST \ --url "$API_URL/api/EditorSocial/publicar" \ --header "Authorization: Bearer $TOKEN" \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --data '{ "ConexaoId": 123, "Rede": "instagram", "Imagens": [ "https://example.com/imagem-exemplo.jpg" ], "Legenda": "Texto fictício para revisão.", "AgendarPara": null }' ``` **Resposta ilustrativa — HTTP 200:** ```json { "Version": "1.0.0.0", "StatusCode": 200, "Message": "Requisição efetuada com suceesso.", "Content": { "status": "erro", "postId": null, "mensagem": "Publicação em configuração (aguardando aprovação da Meta). A captação de leads já está ativa." } } ``` A resposta acima representa a condição **publicação desabilitada** prevista no service. HTTP 200 não significa post publicado: confira `status`. A URL é fictícia e deve ser substituída por arquivo válido. **Editor de modelos** usa `ModeloPreProposta` e `ModeloDocumento`; Estúdio de peças e campanhas usa `Editor*`, LandingPage e CampanhaEmail. O exemplo é fictício, baseado no contrato conferido no código. As respostas não foram coletadas em produção. ## Contratos ### ImportarXmlNotaRecebidaInputDTO * `XmlBase64`: `string`. Os BYTES do arquivo em base64, e não o texto: fornecedor que gera o XML em ISO-8859-1 teria os acentos corrompidos se o front decodificasse como UTF-8 — quem lê o encoding declarado é o servidor. [Voltar ao índice](#2-indice-clicavel) ### IncluirFuncionariosFolhaInputDTO * `FuncionarioIds`: `List`. Quem entra numa folha já aberta. Lista vazia = todos os ativos com vínculo na competência que ainda estão fora dela. [Voltar ao índice](#2-indice-clicavel) ### InstalacaoInputDTO **Herança:** `AbaComplementarInputDTO` — [AbaComplementarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-abacomplementarinputdto). * `dataInicio`: `DateTime`. * `dataTerminoGarantia`: `DateTime`. * `dataPrevisaoConclusao`: `DateTime`. * `dataConclusao`: `DateTime`. * `garantiaModulo`: `string`. * `garantiaInversor`: `string`. [Voltar ao índice](#2-indice-clicavel) ### InsumoAplicadoInputDTO * `PrecoInsumoId`: `long?`. * `Quantidade`: `double`. * `ValorTotal`: `double?`. Valor total da linha. Nulo calcula Quantidade × preço de venda do catálogo — que só funciona com . * `Nome`: `string`. * `Codigo`: `string`. * `Descricao`: `string`. * `CategoriaNome`: `string`. * `Aplicacao`: `AplicacaoCategoriaInsumoEnum?`. Produto ou Serviço. Sem PrecoInsumoId e sem valor aqui, entra como Produto. [Voltar ao índice](#2-indice-clicavel) ### InsumoAplicadoSimulacao * `Id`: `long`. * `InsumoId`: `long?`. Insumo do catálogo, para o BI cruzar com o cadastro atual. Vínculo solto, SEM FK — o insumo pode ser excluído e a proposta continua íntegra (mesmo padrão de ). Null quando o item não veio do catálogo. * `PrecoInsumoId`: `long?`. Preço do insumo (lista/fornecedor) usado no momento da geração. * `Codigo`: `string`. * `Nome`: `string`. * `Descricao`: `string`. * `CategoriaNome`: `string`. * `Aplicacao`: `AplicacaoCategoriaInsumoEnum`. Produto ou Serviço, vindo da categoria do insumo. Congelado porque a precificação parte o total do escopo por ele e a categoria pode trocar de aplicação depois da venda — sem isso o histórico do BI muda retroativamente. * `FornecedorNome`: `string`. * `FornecedorCnpj`: `string`. * `Quantidade`: `double`. * `ValorUnitario`: `double`. Unitário EFETIVO — o que multiplicado pela quantidade fecha o ValorTotal. Não confundir com : o valor do item pode ser sobrescrito, e aí os dois divergem. * `PrecoVendaTabela`: `double`. Preço de venda do cadastro no momento da geração. Só para margem no BI. * `PrecoCusto`: `double`. * `ValorTotal`: `double`. Verdade do dinheiro: é o que soma o preço da proposta. * `Ordem`: `int`. Ordem de exibição nas tabelas da proposta. * `SimulacaoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### InsumoImportarInputDTO * `Nome`: `string`. * `Descricao`: `string`. * `Codigo`: `string`. * `Categoria`: `string`. * `Fornecedor`: `string`. * `ValorVenda`: `double`. * `ValorCusto`: `double`. * `Lojas`: `string`. [Voltar ao índice](#2-indice-clicavel) ### InsumoInputDTO * `Nome`: `string`. * `UnidadeMedidaId`: `long`. * `CategoriaId`: `long`. * `GrupoId`: `long?`. * `ArquivoId`: `long?`. * `Codigo`: `string`. * `Descricao`: `string`. * `Tipo`: `TipoInsumoEnum`. * `ModoKit`: `ModoKitEnum`. * `Rastreamento`: `RastreamentoEstoqueEnum`. * `Composicao`: `IList` — [ComposicaoKitItemInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-composicaokititeminputdto). Composição (BOM) quando Tipo=Kit. Opcional na criação. [Voltar ao índice](#2-indice-clicavel) ### InterpolarTextoInputDTO * `Texto`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ItemBaixaInputDTO * `InsumoId`: `long`. Item EXPLÍCITO da baixa — o que o usuário conferiu na tela é o que sai. Re-resolver no servidor poderia baixar algo diferente do que ele viu. * `Quantidade`: `decimal`. * `NumerosSerie`: `List`. Números de série que estão saindo. Produto rastreado por série exige tantas quantas a quantidade baixada. * `UnidadeIds`: `List`. Unidades escolhidas por id — alcança também as que ainda não têm série preenchida ("a identificar"). * `Lote`: `string`. Lote de onde sai (produto rastreado por lote). [Voltar ao índice](#2-indice-clicavel) ### ItemCriarEntregaPedidoInputDTO * `InsumoId`: `long`. * `Quantidade`: `decimal`. [Voltar ao índice](#2-indice-clicavel) ### ItemDevolucaoInputDTO * `InsumoId`: `long`. * `DepositoId`: `long`. * `Quantidade`: `decimal`. * `UnidadeIds`: `List`. Produto rastreado: QUAIS peças voltam, entre as que saíram por este pedido/entrega (ids da prévia). Vazio = o servidor só decide quando não há o que escolher — tudo que saiu está voltando. * `NumerosSerie`: `List`. Séries das peças que saíram SEM registro de peça (saída anterior ao rastreio). Sem elas a peça volta "a identificar" — ou é recusada, se a empresa exige a série na entrada. [Voltar ao índice](#2-indice-clicavel) ### ItemEntregarInputDTO * `ItemId`: `long`. * `Quantidade`: `decimal?`. Quanto entregar agora (parcial permitido). Null = tudo que falta. * `MotivoPendencia`: `MotivoPendenciaEntrega?`. Por que ficou faltando (estudo 02). OBRIGATÓRIO quando a quantidade explícita é menor que o faltante: a falta vira uma PendenciaEntrega de Rua com este motivo — escolha em lista, vira dado. * `ObservacaoPendencia`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ItemGerarPendenciaInputDTO * `ItemId`: `long`. * `Quantidade`: `decimal?`. Null = a falta inteira do item. [Voltar ao índice](#2-indice-clicavel) ### ItemModeloTarefaFiltroInputDTO * `Query`: `string`. * `StatusId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### ItemModeloTarefaInputDTO * `Descricao`: `string`. * `Titulo`: `string`. * `Tempo`: `int`. * `TipoTempo`: `TipoTempoEnum`. * `StatusId`: `long`. * `TipoId`: `long`. * `DependenciaId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### ItemNotaFiscalInputDTO * `Id`: `long?`. Item existente no rascunho; ignorado na criação. * `InsumoId`: `long?`. * `ItemPedidoVendaId`: `long?`. Item do pedido que originou este item da nota — usado para casar a descrição ajustada na tela de emissão. * `Codigo`: `string`. * `Descricao`: `string`. * `DescricaoManual`: `bool`. Descrição escrita por uma pessoa: o modelo da Configuração Fiscal NÃO reescreve por cima. * `IndicadorFiscal`: `IndicadorFiscalItem?`. * `Quantidade`: `decimal`. * `ValorUnitario`: `decimal`. * `ValorDesconto`: `decimal`. * `UnidadeComercial`: `string`. * `NCM`: `string`. * `CEST`: `string`. * `CFOP`: `string`. * `GTIN`: `string`. * `Origem`: `OrigemMercadoria?`. * `CstCsosn`: `string`. * `CodigoBeneficioFiscal`: `string`. cBenef do item. Vazio = o da mesma origem do CST. * `AliquotaIcms`: `decimal?`. * `CstPis`: `string`. * `AliquotaPis`: `decimal?`. * `CstCofins`: `string`. * `CstIbsCbs`: `string`. CST do IBS/CBS (Reforma Tributária). Vazio = herda da natureza/000. * `ClassTribIbsCbs`: `string`. cClassTrib do IBS/CBS. Vazio = herda da natureza/000001. * `AliquotaCofins`: `decimal?`. * `ItemListaServicoLC116`: `string`. * `CodigoTributacaoMunicipio`: `string`. * `CodigoTributacaoNacional`: `string`. Código de tributação nacional do ISSQN (NFS-e Nacional). * `CodigoNbs`: `string`. Código NBS do serviço (Reforma Tributária). * `AliquotaIss`: `decimal?`. [Voltar ao índice](#2-indice-clicavel) ### ItemPedidoCompraInputDTO * `InsumoId`: `long?`. * `Descricao`: `string`. * `Quantidade`: `decimal`. * `ValorUnitario`: `decimal`. * `Desconto`: `decimal`. [Voltar ao índice](#2-indice-clicavel) ### ItemPedidoDaNotaInputDTO * `Descricao`: `string`. Item informado à mão ou vindo da planilha do fornecedor. Quando vem preenchido, ele manda; senão o servidor casa por GTIN → código → nome, como faz com o XML. * `CodigoFornecedor`: `string`. * `Ean`: `string`. * `Ncm`: `string`. * `Unidade`: `string`. * `Quantidade`: `decimal`. * `ValorUnitario`: `decimal`. * `InsumoId`: `long?`. Produto do Estoque escolhido na tela. Nulo = deixa o servidor casar. [Voltar ao índice](#2-indice-clicavel) ### ItemPedidoVendaInputDTO * `InsumoId`: `long?`. * `Descricao`: `string`. * `Quantidade`: `decimal`. * `ValorUnitario`: `decimal`. * `Desconto`: `decimal`. [Voltar ao índice](#2-indice-clicavel) ### ItemPlanilhaBaixaInputDTO * `Codigo`: `string`. Linha de planilha para resolver contra o Estoque (Código · Nome · Quantidade). O casamento tenta primeiro o Código; sem código (ou sem match), tenta o Nome. Nome ambíguo não é chutado — volta como não resolvido. * `Nome`: `string`. * `Quantidade`: `decimal`. [Voltar ao índice](#2-indice-clicavel) ### ItemRecebimentoCompraInputDTO * `ItemPedidoCompraId`: `long`. * `Quantidade`: `decimal`. Quantidade recebida AGORA (soma-se ao já recebido). * `CustoUnitario`: `decimal?`. * `NumerosSerie`: `string`. Números de série recebidos, separados por ';' (opcional). * `Lote`: `string`. Lote recebido (produto rastreado por lote). Sem isto, a compra de item de lote entrava sempre sem identificação — o número de série tinha caminho e o lote não. * `DataValidade`: `System.DateTime?`. Validade do lote/unidade que chegou (opcional). [Voltar ao índice](#2-indice-clicavel) ### ItemServicoFiscalInputDTO * `Codigo`: `string`. Item da lista de serviço (LC 116) a vincular a uma ConfiguracaoFiscal. * `Descricao`: `string`. * `Cnae`: `string`. * `PercentualTributos`: `double`. [Voltar ao índice](#2-indice-clicavel) ### ItensExtraGestaoInputDTO * `Quantidade`: `int`. * `Codigo`: `string`. [Voltar ao índice](#2-indice-clicavel) ### JustificarDivergenciaInputDTO * `Motivo`: `MotivoDivergenciaPedidoEnum`. Justificativa da diferença entre a soma dos pedidos e o total da venda. Vale para o grupo inteiro de pedidos daquela venda. * `Justificativa`: `string`. [Voltar ao índice](#2-indice-clicavel) ### KitCarrinhoItem **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `GeradorId`: `long`. Item do "carrinho" de kits de um Gerador. Permite compor um gerador com N kits (fechado e/ou customizado), como um carrinho de compras. Referencia os kits do catálogo SafeLeads existente por código — reaproveita kit fechado e customizado. * `Gerador`: `Gerador` — [Gerador](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-gerador). * `CodigoKit`: `string`. Código do kit no catálogo (ex.: PrecificacaoKitFechado.Codigo) ou do kit customizado. * `Fonte`: `string`. Origem do kit: Fechado, Customizado, ou nome do distribuidor (Aldo etc.). * `Quantidade`: `int`. * `PotenciaKwp`: `double`. * `ValorUnitario`: `double`. * `ValorTotal`: `double`. * `SnapshotJson`: `string`. Snapshot completo do kit (composição) serializado. [Voltar ao índice](#2-indice-clicavel) ### KitCarrinhoItemInputDTO * `GeradorId`: `long`. * `CodigoKit`: `string`. * `Fonte`: `string`. * `Quantidade`: `int`. * `PotenciaKwp`: `double`. * `ValorUnitario`: `double`. * `ValorTotal`: `double`. * `SnapshotJson`: `string`. [Voltar ao índice](#2-indice-clicavel) ### KitSelecionadoInputDTO * `Codigo`: `string`. * `Quantidade`: `int`. * `Snapshot`: `KitSnapshotInputDTO` — [KitSnapshotInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-kitsnapshotinputdto). [Voltar ao índice](#2-indice-clicavel) ### KitSnapshotInputDTO * `PrecoVenda`: `double`. Specs/preço mínimos para reconstruir um ProdutoSolar de 1 unidade do kit a partir do estudo. * `PotenciaKwp`: `double`. * `QtdModulos`: `int`. * `PotenciaModuloW`: `double`. * `MarcaModulo`: `string`. * `QtdInversores`: `int`. * `MarcaInversor`: `string`. * `PotenciaInversorKw`: `double`. * `Fase`: `string`. * `Tensao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LancamentoContabilInputDTO * `Data`: `DateTime`. Criação de um lançamento contábil (cabeçalho + partidas). A soma dos débitos deve ser igual à soma dos créditos (partidas dobradas). * `DataCompetencia`: `DateTime`. * `Numero`: `string`. * `Historico`: `string`. * `Origem`: `OrigemLancamentoEnum`. * `OrigemId`: `long?`. * `Status`: `StatusLancamentoEnum`. * `LojaId`: `long?`. * `Partidas`: `List` — [PartidaContabilInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-partidacontabilinputdto). [Voltar ao índice](#2-indice-clicavel) ### LancamentoHoleriteInputDTO * `HoleriteFuncionarioId`: `long`. Lançamento manual (rubrica variável) em um holerite (RH/Folha). * `RubricaId`: `long`. * `Valor`: `double`. * `Referencia`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LayoutMapaInputDTO * `Json`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LayoutModulo **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `FaceTelhadoId`: `long`. Disposição dos módulos de um Gerador sobre uma Face de telhado, desenhada no mapa. Guarda a geometria das posições (retângulos/rotação) para validação de ocupação e geração do desenho técnico. * `FaceTelhado`: `FaceTelhado` — [FaceTelhado](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-facetelhado). * `GeradorId`: `long`. * `Gerador`: `Gerador` — [Gerador](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-gerador). * `QuantidadeModulos`: `int`. * `Linhas`: `int`. * `Colunas`: `int`. * `OrientacaoModulo`: `string`. Retrato/Paisagem. * `PosicoesJson`: `string`. Posições/rotação de cada módulo no mapa (array serializado). [Voltar ao índice](#2-indice-clicavel) ### LayoutModuloInputDTO * `FaceTelhadoId`: `long`. * `GeradorId`: `long`. * `QuantidadeModulos`: `int`. * `Linhas`: `int`. * `Colunas`: `int`. * `OrientacaoModulo`: `string`. * `PosicoesJson`: `string`. [Voltar ao índice](#2-indice-clicavel) ### Lead **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Nome`: `string`. * `NomeFantasia`: `string`. * `InscricaoEstadual`: `string`. * `InscricaoMunicipal`: `string`. * `IndicadorIEDestinatario`: `IndicadorIEDestinatario?`. indIEDest — indicador da IE do destinatário (emissão fiscal). * `ConsumidorFinal`: `bool?`. indFinal — operação destinada a consumidor final. * `Segmento`: `string`. * `Celular`: `string`. * `DDDCelular`: `string`. * `DDICelular`: `string`. * `WhatsAppTratado`: `string`. * `WhatsAppLid`: `string`. * `DocumentoUrl`: `string`. * `AnaliseDocumentoAI`: `string`. * `AnaliseDocumentoAiJson`: `string`. * `Celular2`: `string`. * `DDICelular2`: `string`. * `DDDCelular2`: `string`. * `WhatsAppLid2`: `string`. * `WhatsAppTratado2`: `string`. * `Celular3`: `string`. * `DDICelular3`: `string`. * `DDDCelular3`: `string`. * `WhatsAppLid3`: `string`. * `WhatsAppTratado3`: `string`. * `Telefone`: `string`. * `Nacionalidade`: `string`. * `EstadoCivil`: `string`. * `Profissao`: `string`. * `NomePai`: `string`. * `NomeMae`: `string`. * `Sexo`: `string`. * `Email`: `string`. * `Email2`: `string`. * `Email3`: `string`. * `Documento`: `string`. * `RG`: `string`. * `RGOrgaoExpedidor`: `string`. * `RGUF`: `string`. * `RGDataEmissao`: `DateTime?`. * `ValorPatrimonio`: `double`. * `ValorRendaMensal`: `double`. * `Banco1Nome`: `string`. * `Banco1Agencia`: `string`. * `Banco1Conta`: `string`. * `Banco2Nome`: `string`. * `Banco2Agencia`: `string`. * `Banco2Conta`: `string`. * `ResponsavelLegal`: `string`. * `ResponsavavelLegalCPF`: `string`. * `Indicador`: `string`. * `Grupo`: `string`. * `DataNascimento`: `DateTime?`. * `RDStationURL`: `string`. * `ExactSpotterURL`: `string`. * `RDStationId`: `string`. * `Campanha`: `string`. * `ConjuntoAnuncios`: `string`. * `Anuncio`: `string`. * `AnuncioDescricao`: `string`. * `AnuncioImagemUrl`: `string`. * `AnuncioUrl`: `string`. * `OmieId`: `string`. * `EmAtendimentoSafeZap`: `bool`. * `UltimaMensagemEnviadaSafeZap`: `string`. * `ContadorMenuRepetidoSafeZap`: `int`. * `Origem`: `Origem` — [Origem](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-origem). * `OrigemId`: `long?`. * `Endereco`: `Endereco` — [Endereco](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-endereco). * `Responsavel`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `ResponsavelId`: `long?`. * `PreVendedor`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `PreVendedorId`: `long?`. * `ImagemPerfil`: `Arquivo` — [Arquivo](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-arquivo). * `Tipo`: `TipoLead`. * `Loja`: `Loja` — [Loja](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-loja). * `LojaId`: `long?`. * `Atividades`: `IList` — [Acao](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acao). * `Seguidores`: `IList` — [LeadUsuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-leadusuario). * `Status`: `StatusLead` — [StatusLead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statuslead). * `Historico`: `IList` — [Lead_Status](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-leadstatus). * `Projetos`: `IList` — [Projeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-projeto). * `Vendas`: `IList` — [Venda](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-venda). * `Simulacaos`: `IList` — [Simulacao](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-simulacao). * `Contatos`: `IList` — [Contato](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-contato). * `CodigoLeadTracking`: `string`. * `ExternalId`: `string`. * `Atribuir`: `bool`. * `ProcuracaoAssinadaUrl`: `string`. * `CartaoCnpjUrl`: `string`. * `DocumentoSocioAdminUrl`: `string`. * `ContratoSocialUrl`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LeadAlterarOrigemEmLoteInputDTO * `OrigemId`: `long?`. * `Ids`: `List`. [Voltar ao índice](#2-indice-clicavel) ### LeadCamposAnaliseIAInputDTO * `Type`: `string`. * `Name`: `string`. * `MothersName`: `string`. * `FathersName`: `string`. * `BirthPlace`: `string`. * `BirthDate`: `DateTime?`. * `Cpf`: `string`. * `DocumentNumber`: `string`. * `IdentityDocument`: `string`. * `IssuingBody`: `string`. * `IssueDate`: `DateTime?`. * `ValidityDate`: `DateTime?`. * `Category`: `string`. * `Address`: `string`. * `Observations`: `string`. * `ProjetoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### LeadInputDTO * `Nome`: `string`. * `OrigemId`: `long`. * `Origem`: `string`. * `Campanha`: `string`. * `Anuncio`: `string`. * `ConjuntoAnuncios`: `string`. * `Segmento`: `string`. * `NomeFantasia`: `string`. * `Documento`: `string`. * `CodigoLeadTracking`: `string`. * `DDICelular`: `string`. * `Celular`: `string`. * `Celular2`: `string`. * `DDICelular2`: `string`. * `Email`: `string`. * `ExactSpotterURL`: `string`. * `RDStationURL`: `string`. * `RDStationID`: `string`. * `Tipo`: `TipoLead`. * `UsuarioId`: `long?`. * `LojaId`: `long?`. * `StatusId`: `long?`. * `Nota`: `string`. * `CEP`: `string`. * `Cidade`: `string`. * `UF`: `string`. * `Consumo`: `double`. * `CriarProjeto`: `bool`. * `PreVendedor`: `bool`. * `EmailResponsavel`: `string`. * `RG`: `string`. * `ExternalId`: `string`. * `IndicadoPor`: `string`. * `WhatsAppLid`: `string`. * `NomeFilaDistribuicao`: `string`. * `Notas`: `string`. * `ConverterLojaUsuario`: `bool?`. [Voltar ao índice](#2-indice-clicavel) ### LeadUsuario * `DataCriacao`: `DateTime`. * `LeadId`: `long`. * `Lead`: `Lead` — [Lead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-lead). * `UsuarioId`: `long`. * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). [Voltar ao índice](#2-indice-clicavel) ### Lead_Status * `Id`: `long`. * `DataStatus`: `DateTime`. * `Observacao`: `string`. * `Status`: `StatusLead` — [StatusLead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statuslead). * `Lembretes`: `IList` — [Lembrete](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-lembrete). * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). [Voltar ao índice](#2-indice-clicavel) ### Lembrete * `Id`: `long`. * `Status`: `Lead_Status` — [Lead_Status](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-leadstatus). * `StatusProjeto`: `Projeto_Status` — [Projeto_Status](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-projetostatus). * `DataCriacao`: `DateTime`. * `DataLembrete`: `DateTime`. * `DataEnvio`: `DateTime?`. * `Nota`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LiberarPagamentoComissaoInputDTO **Herança:** `PagarParcelaInputDTO` — [PagarParcelaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-pagarparcelainputdto). * `Justificativa`: `string`. Por que está pagando sem lastro. Obrigatória. [Voltar ao índice](#2-indice-clicavel) ### Localizacao **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Latitude`: `string`. * `Longitude`: `string`. * `Velocidade`: `double`. * `DataCapturada`: `DateTime?`. * `Status`: `string`. * `Provider`: `string`. * `Accuracy`: `double`. [Voltar ao índice](#2-indice-clicavel) ### Loja **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Nome`: `string`. * `CNPJ`: `string`. * `RazaoSocial`: `string`. * `InscricaoEstadual`: `string`. * `Telefone`: `string`. * `Endereco`: `Endereco` — [Endereco](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-endereco). * `Fachada`: `Arquivo` — [Arquivo](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-arquivo). * `TimeZone`: `string`. * `PorcentagemMaximaAlteracao`: `double`. * `PorcentagemMaximaAlteracaoAdmin`: `double`. * `PorcentagemMaximaAlteracaoGerente`: `double`. * `PorcentagemMaximaAlteracaoSupervisor`: `double`. * `PorcentagemMaximaAlteracaoTecnico`: `double`. * `PorcentagemMaximaAlteracaoVendedor`: `double`. * `PorcentagemAumentoPreco`: `double`. * `PorcentagemPerdas`: `double`. * `PorcentagemPerdasFaceTelhadoSul`: `double`. * `PorcentagemPerdasFaceTelhadoNorte`: `double`. * `PorcentagemPerdasFaceTelhadoLeste`: `double`. * `PorcentagemPerdasFaceTelhadoOeste`: `double`. * `PorcentagemPerdasFaceTelhadoNordeste`: `double`. * `PorcentagemPerdasFaceTelhadoSudeste`: `double`. * `PorcentagemPerdasFaceTelhadoNoroeste`: `double`. * `PorcentagemPerdasFaceTelhadoSudoeste`: `double`. * `PrecoPorKm`: `double`. * `HorariosFuncionamento`: `IList` — [HorarioFuncionamento](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-horariofuncionamento). * `ConfiguracaoSimuladorRapidoId`: `long?`. * `Latitude`: `string`. * `Longitude`: `string`. * `TipoRadiacao`: `string`. * `RadiacaoSolar`: `double`. * `IrradiacaoSolar12Meses`: `string`. * `ZenviaJSON`: `string`. * `DepositoSaidaId`: `long?`. Depósito de onde saem venda, OS e entrega desta loja. Null = sem regra: cai na cascata antiga. Vínculo solto (sem FK), como os demais ponteiros do domínio: depósito apagado volta a cair na cascata em vez de travar a operação. * `BaixarEstoqueAoGerarPedido`: `bool?`. * `DadosProposta`: `LojaDadosProposta` — [LojaDadosProposta](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-lojadadosproposta). * `ValorPorDiaria`: `double`. [Voltar ao índice](#2-indice-clicavel) ### LojaDadosProposta * `Id`: `long`. * `UrlImgBanner`: `string`. * `Cor1`: `string`. * `Cor2`: `string`. * `Cor3`: `string`. * `Cor4`: `string`. * `Cor5`: `string`. * `Cor6`: `string`. * `Cor7`: `string`. * `Cor8`: `string`. * `Cor9`: `string`. * `UrlImgComoFunciona`: `string`. * `UrlImgExtra1`: `string`. * `UrlImgExtra2`: `string`. * `UrlImgExtra3`: `string`. * `UrlImgExtra4`: `string`. * `UrlImgExtra5`: `string`. * `UrlImgExtra6`: `string`. * `UrlImgLogo`: `string`. * `GarantiaPlaca`: `string`. * `GarantiaInversor`: `string`. * `GarantiaMicroInversor`: `string`. * `GarantiaServico`: `string`. * `GarantiaEstrutura`: `string`. * `UrlImgBancos`: `string`. * `UrlImgCuidamos`: `string`. * `UrlImgProjeto1`: `string`. * `UrlImgProjeto2`: `string`. * `UrlImgProjeto3`: `string`. * `UrlImgProjeto4`: `string`. * `UrlImgProjeto5`: `string`. * `UrlImgProjeto6`: `string`. * `UrlImgProjeto7`: `string`. * `UrlImgProjeto8`: `string`. * `TextoInstitucional`: `string`. * `TextoInstitucional2`: `string`. * `TextoExtra`: `string`. * `TextoExtra2`: `string`. * `TextoExtra3`: `string`. * `TextoExtra4`: `string`. * `TextoExtra5`: `string`. * `TextoExtra6`: `string`. * `LinkSite`: `string`. * `LinkInstagram`: `string`. * `LinkFacebook`: `string`. * `LinkLinkedin`: `string`. * `LinkExtra`: `string`. * `EmailComercial`: `string`. * `UrlDoc1`: `string`. * `UrlDoc2`: `string`. [Voltar ao índice](#2-indice-clicavel) ### LojaInputDTO * `Nome`: `string`. * `Endereco`: `Endereco` — [Endereco](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-endereco). * `ArquivoId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### LojasAtendidasInputDTO * `LojaIds`: `List`. Lojas que passam a tirar material deste depósito. A lista é EXAUSTIVA: loja que sai daqui e não veio na lista perde o vínculo. [Voltar ao índice](#2-indice-clicavel) ### ManifestarNotaRecebidaInputDTO * `Tipo`: `string`. ciencia | confirmacao | desconhecimento | nao_realizada * `Justificativa`: `string`. Obrigatória (15–255) só em nao_realizada. [Voltar ao índice](#2-indice-clicavel) ### MarcacaoComentarioTarefa * `Id`: `long`. * `Data`: `DateTime`. * `Marcacao`: `string`. * `Usuario`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `UsuarioId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### MarcacaoInputDTO * `Marcacao`: `string`. * `UsuarioId`: `long`. [Voltar ao índice](#2-indice-clicavel) ### MarcacaoUsuarioInputDTO * `UsuarioId`: `long`. * `Texto`: `string`. [Voltar ao índice](#2-indice-clicavel) ### MigrarEntregasInputDTO * `CategoriaIds`: `List`. Categorias de Compra que representam ENTREGA. Vazio/null = só as Compras já em rota (estar numa rota de entrega é inequívoco). [Voltar ao índice](#2-indice-clicavel) ### ModeloDocumentoInputDTO * `Nome`: `string`. * `Ativo`: `bool`. * `Texto`: `string`. * `EditorAvancado`: `bool`. * `Tipo`: `TipoModeloDocumento?`. [Voltar ao índice](#2-indice-clicavel) ### ModeloEmail **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Ativo`: `bool`. * `Nome`: `string`. * `Assunto`: `string`. * `Corpo`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ModeloPendenciaResumoDTO * `Id`: `long`. Resumo do modelo (template) que gerou a pendência + regras. Não mapeado (preenchido no detalhe). * `Titulo`: `string`. * `Descricao`: `string`. * `Obrigatoria`: `bool`. * `ExigeComprovacao`: `bool`. * `StatusGatilhoNome`: `string`. * `TemFiltro`: `bool`. * `FiltroModo`: `ModoFiltroPendenciaEnum`. * `Condicoes`: `List` — [CondicaoResumoDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-condicaoresumodto). [Voltar ao índice](#2-indice-clicavel) ### ModeloPreProposta **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Ativo`: `bool`. * `EditorAvancado`: `bool`. * `Paisagem`: `bool`. * `Titulo`: `string`. * `URLCapa`: `string`. * `Texto`: `string`. * `Loja`: `Loja` — [Loja](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-loja). * `TipoGrupo`: `TipoGrupoEnum`. * `StatusLeadGatilho`: `StatusLead` — [StatusLead](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statuslead). * `HistoricoAlteracao`: `IList` — [HistoricoAlteracaoPreProposta](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-historicoalteracaopreproposta). * `Ordem`: `int`. * `PrefixoPadrao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### MonitoramentoInputDTO **Herança:** `AbaComplementarInputDTO` — [AbaComplementarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-abacomplementarinputdto). * `previsaoEntrega`: `DateTime`. * `entregaRealizada`: `DateTime`. * `usuario`: `string`. * `senha`: `string`. * `urlMonitoramento`: `string`. * `modeloModulo`: `string`. * `qtdModulos`: `int`. * `potenciaModulo`: `double`. * `modeloInversor`: `string`. * `qtdInversores`: `int`. * `potenciaInversor`: `double`. [Voltar ao índice](#2-indice-clicavel) ### MontarKitInputDTO * `KitInsumoId`: `long`. Montagem/Desmontagem de Kit: converte estoque dos componentes em estoque do Kit (Montar) ou o inverso (Desmontar), seguindo a BOM (ComposicaoKit). Aplica-se a Insumo com Tipo=Kit que tenha composição. * `DepositoId`: `long`. * `Quantidade`: `decimal`. * `Observacao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### MotivoPerda * `Id`: `long`. * `Ativo`: `bool`. * `Nome`: `string`. * `Descricao`: `string`. * `Status`: `string`. [Voltar ao índice](#2-indice-clicavel) ### MoverAprovacaoPagarInputDTO * `ParcelaIds`: `List`. Movimentacao de etapa em massa. A lista do Contas a Pagar e por parcela, mas a aprovacao e do titulo: parcelas do mesmo titulo contam uma vez so. * `TituloIds`: `List`. * `StatusAprovacaoPagarId`: `long`. * `Observacao`: `string`. Motivo ou comentario. Obrigatorio para mandar a um status Reprovado. [Voltar ao índice](#2-indice-clicavel) ### MovimentacaoMassaInputDTO * `Tipo`: `int`. 0 = mover de status · 1 = alterar responsável. * `StatusDestinoId`: `long`. Status de destino. Obrigatório quando = 0. * `Propriedade`: `string`. Papel a trocar, em PascalCase: Responsavel, VendedorResponsavel, Tecnico, Projetista, Homologador ou PreVendedor. Obrigatório quando = 1 e validado contra lista fechada. * `UsuarioAlvoId`: `long?`. Quem assume o papel. Null ou 0 = limpar o responsável. * `UsuariosAlvoIds`: `List`. Rodízio: reparte os negócios entre estes usuários, em fatias iguais e na ordem recebida. Quando preenchido, tem precedência sobre . * `ProjetoIds`: `List`. Alvos escolhidos à mão. Ignorado quando é true. * `UsarFiltro`: `bool`. Quando true, os alvos saem do filtro (query string) em vez de . [Voltar ao índice](#2-indice-clicavel) ### MovimentarMultiplosCardsInputDTO * `Ids`: `List`. * `StatusId`: `long`. * `StatusOrigemId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### MovimentoEstoqueInputDTO * `InsumoId`: `long`. Movimento manual de estoque. Tipo deve ser Entrada ou Saida (Ajuste e Transferência têm endpoints próprios). * `DepositoId`: `long`. * `Tipo`: `TipoMovimentoEstoqueEnum`. * `Quantidade`: `decimal`. * `CustoUnitario`: `decimal`. * `Data`: `DateTime?`. * `Observacao`: `string`. * `ExternalId`: `string`. * `NumerosSerie`: `IList`. Números de série (Rastreamento=Serie). Entrada: cria 1 UnidadeEstoque por série; Saída: baixa essas séries. Opcional. * `UnidadeIds`: `IList`. Saída: IDs das unidades escolhidas, inclusive ainda sem série. Opcional para manter compatibilidade com leitores que enviam séries. * `Lote`: `string`. Lote (Rastreamento=Lote). Entrada: cria o lote; Saída: baixa do lote. Opcional. * `DataValidade`: `DateTime?`. Validade do lote/unidade (opcional). [Voltar ao índice](#2-indice-clicavel) ### NaturezaOperacaoInputDTO * `Nome`: `string`. * `Cfop`: `string`. * `CstCsosn`: `string`. * `CodigoBeneficioFiscal`: `string`. cBenef da UF, par do CST (ex.: SC810062). * `CstPis`: `string`. * `CstCofins`: `string`. * `CstIbsCbs`: `string`. CST do IBS/CBS (Reforma Tributária). Vazio = 000. * `ClassTribIbsCbs`: `string`. cClassTrib do IBS/CBS. Vazio = 000001. * `Padrao`: `bool`. [Voltar ao índice](#2-indice-clicavel) ### NomeInputDto * `Nome`: `string`. [Voltar ao índice](#2-indice-clicavel) ### NotaFiscalFiltroInputDTO **Herança:** `QueryFiltroInputDTO` — [QueryFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-queryfiltroinputdto). * `PedidoVendaId`: `long?`. Notas de um pedido de venda específico. * `Modelo`: `ModeloDocumentoFiscal?`. * `Status`: `StatusNotaFiscal?`. [Voltar ao índice](#2-indice-clicavel) ### NotaFiscalInputDTO **Herança:** `TransporteNotaInputDTO` — [TransporteNotaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-transportenotainputdto). * `Modelo`: `ModeloDocumentoFiscal`. Emissão/criação avulsa de NotaFiscal (manual). O serviço completa o snapshot do destinatário (Lead/Fornecedor) e os dados fiscais que faltarem a partir do Insumo. Numeração e ambiente vêm da ConfiguracaoFiscal da Loja. * `TipoOperacao`: `TipoOperacaoFiscal`. * `Finalidade`: `FinalidadeNotaFiscal?`. * `LojaId`: `long?`. * `LeadId`: `long?`. Destinatário (saída → Lead). Um dos dois conforme a operação. * `FornecedorId`: `long?`. Destinatário/remetente (entrada → Fornecedor). * `ContatoDestinatarioId`: `long?`. Contato do cliente que recebe a nota no lugar do titular (tem de ser do mesmo cliente). Nulo = o próprio cliente. * `UsarEnderecoDoTitular`: `bool`. Contato sem endereço completo: usa o endereço do titular. * `NaturezaOperacao`: `string`. * `NaturezaOperacaoId`: `long?`. Natureza de Operação CADASTRADA: quando vem, o nome dela preenche a NaturezaOperacao (se o texto acima estiver vazio) e os CFOP/CSTs dela entram nos itens sem valor próprio — entre o item explícito e o padrão do produto. * `ValorFrete`: `decimal`. * `ValorDesconto`: `decimal`. * `ValorOutrasDespesas`: `decimal`. * `InformacoesComplementares`: `string`. * `IssRetido`: `bool`. ISS retido pelo tomador (NFS-e B2B). * `ValorIrrfRetido`: `decimal`. * `ValorInssRetido`: `decimal`. * `ValorPisRetido`: `decimal`. * `ValorCofinsRetido`: `decimal`. * `ValorCsllRetido`: `decimal`. * `SaidaImediata`: `bool?`. Ver . * `Fonte`: `FonteNotaFiscal?`. * `FonteId`: `long?`. * `Itens`: `List` — [ItemNotaFiscalInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-itemnotafiscalinputdto). [Voltar ao índice](#2-indice-clicavel) ### NotificacaoMetaInputDTO * `Tipo`: `TipoNotificacaoMeta`. * `NotificarComMeta`: `bool`. * `InstanceId`: `string`. * `TemplateId`: `string`. * `VariaveisJson`: `string`. [Voltar ao índice](#2-indice-clicavel) ### NotificacaoMetaStatusProjeto * `Id`: `long`. * `Status`: `StatusProjeto` — [StatusProjeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statusprojeto). * `StatusId`: `long`. * `Tipo`: `TipoNotificacaoMeta`. * `NotificarComMeta`: `bool`. * `InstanceId`: `string`. * `TemplateId`: `string`. * `VariaveisJson`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ObterMetaInputDTO * `Mes`: `int?`. * `Ano`: `int?`. * `Objetivo`: `ObjetivoMetaEnum?`. * `TipoVendaId`: `long?`. * `VendedorIds`: `List`. [Voltar ao índice](#2-indice-clicavel) ### OpcaoCampoInputDTO * `Opcao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### OpcaoPagamentoConfiguracaoSimulador * `Id`: `long`. * `PorcentagemEntrada`: `double`. * `QuantidadeParcelas`: `int`. * `PorcentagemJuros`: `double`. * `PorcentagemDesconto`: `double`. * `QuantidadeParcelasServico`: `int`. * `PorcentagemDescontoServico`: `double`. * `PorcentagemEntradaServico`: `double`. * `PorcentagemJurosServico`: `double`. [Voltar ao índice](#2-indice-clicavel) ### OpcaoPagamentoSimulador * `Id`: `long`. * `ValorEntrada`: `double`. * `PorcentagemEntrada`: `double`. * `ValorParcela`: `double`. * `QuantidadeParcelas`: `int`. * `PorcentagemJurosParcela`: `double`. * `PorcentagemDesconto`: `double`. * `ValorDesconto`: `double`. * `QuantidadeParcelasServico`: `int`. * `ValorDescontoServico`: `double`. * `PorcentagemDescontoServico`: `double`. * `PorcentagemEntradaServico`: `double`. * `PorcentagemJurosParcelaServico`: `double`. * `ValorEntradaServico`: `double`. * `ValorParcelaServico`: `double`. [Voltar ao índice](#2-indice-clicavel) ### OrdemServico **Herança:** `AbaComplementar` — [AbaComplementar](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-abacomplementar). * `Numero`: `string`. * `Titulo`: `string`. * `Descricao`: `string`. * `Observacao`: `string`. * `DataPedido`: `DateTime`. * `DataAgendamentoInicial`: `DateTime`. * `DataAgendamentoFinal`: `DateTime`. * `DataInicioDeslocamento`: `DateTime?`. * `DataFimDeslocamento`: `DateTime?`. * `DataInicioExecucao`: `DateTime?`. * `DataFimExecucao`: `DateTime?`. * `DataFinalizada`: `DateTime?`. * `Valor`: `double`. * `Arquivos`: `string`. * `EquipeTecnica`: `EquipeTecnica` — [EquipeTecnica](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-equipetecnica). * `TipoServico`: `TipoServico` — [TipoServico](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tiposervico). * `Status`: `StatusOrdemServico` — [StatusOrdemServico](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statusordemservico). * `Tarefas`: `ICollection` — [Tarefa](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefa). * `Tecnico`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `LatitudeOrigem`: `string`. * `LongitudeOrigem`: `string`. * `DistanciaMetros`: `double`. * `DuracaoEstimadaDeslocamentoMinutos`: `int`. * `DuracaoEstimadaServicoMinutos`: `int`. * `DuracaoEstimadaEsperaMinutos`: `int`. * `DuracaoEstimadaTotalMinutos`: `int`. * `DuracaoExecutadaDeslocamentoMinutos`: `int`. * `DuracaoExecutadaServicoMinutos`: `int`. * `DuracaoExecutadaEsperaMinutos`: `int`. * `DuracaoExecutadaTotalMinutos`: `int`. * `DepositoId`: `long?`. Depósito padrão de onde os insumos desta OS são baixados na finalização. * `EstoqueBaixado`: `bool`. True quando os insumos já foram baixados do estoque (idempotência da finalização). * `CentroCustoId`: `long?`. Centro de custo (projeto/obra) ao qual o custo dos materiais desta OS é atribuído na contabilização e na rentabilidade por projeto. Opcional. * `CustoEquipe`: `decimal?`. * `CompraId`: `long?`. Compra (entrega) que originou esta OS — usado nas Rotas de Entrega para automatizar o status da Compra conforme a OS progride. Opcional. TRANSIÇÃO (estudo 03 §6.4): vínculo legado; o novo é EntregaProjetoId. * `Compra`: `Compra` — [Compra](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-compra). * `EntregaProjetoId`: `long?`. A ENTREGA que esta OS instala (estudo 01 §6: "ao finalizar a OS de cada parada, ela vai para Entregue"). Reaponta o CompraId legado no modelo novo; backfill via espelho (EntregaProjeto.CompraOrigemId). * `EntregaProjeto`: `EntregaProjeto`. [Voltar ao índice](#2-indice-clicavel) ### OrdemServicoInputDTO **Herança:** `AbaComplementarInputDTO` — [AbaComplementarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-abacomplementarinputdto). * `numero`: `string`. * `dataPedido`: `DateTime`. * `titulo`: `string`. * `tipoServicoId`: `long?`. * `equipeId`: `long?`. * `dataAgendamentoInicial`: `DateTime`. * `dataAgendamentoFinal`: `DateTime?`. * `valor`: `double`. * `arquivos`: `List`. * `statusId`: `long?`. * `tecnicoId`: `long?`. * `ignorarCalculoDeslocamento`: `bool?`. * `ignorarCalculoServico`: `bool?`. * `IgnorarVerificacaoConflito`: `bool`. * `compraId`: `long?`. * `EntregaProjetoId`: `long?`. Parada-pedido (EntregaProjeto pura) que esta OS executa — o equivalente novo do CompraId nas Rotas de Entrega. [Voltar ao índice](#2-indice-clicavel) ### Origem * `Id`: `long`. * `Nome`: `string`. * `Tipo`: `TipoOrigemEnum`. * `StatusInicial`: `StatusProjeto` — [StatusProjeto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statusprojeto). * `Lojas`: `string`. [Voltar ao índice](#2-indice-clicavel) ### OtimizarRotasInputDTO * `ComprasIds`: `List`. Entregas (Compras) a rotear. * `VeiculosIds`: `List`. Veículos disponíveis (a ordem define a prioridade de uso). * `DataPrevista`: `DateTime?`. Data/hora de partida planejada (default: hoje 08:00). * `VelocidadeMediaKmH`: `double?`. Velocidade média considerada no deslocamento (km/h). Default 40. * `TempoParadaMin`: `int?`. Tempo de parada por entrega (minutos). Default 20. [Voltar ao índice](#2-indice-clicavel) ### PagamentoComissao **Herança:** `BaseModel` — [BaseModel](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-basemodel). * `Vendedor`: `Usuario` — [Usuario](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-usuario). * `ValorPago`: `double`. * `Descricao`: `string`. * `Comprovante`: `Arquivo` — [Arquivo](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-arquivo). * `Venda`: `Venda` — [Venda](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-venda). * `PagamentoParcelaId`: `long?`. [Voltar ao índice](#2-indice-clicavel) ### PagamentoInputDTO * `ProjetoId`: `long`. * `StatusId`: `long?`. * `ContratoId`: `long?`. * `FinanciamentoId`: `long?`. * `FormaPagamentoId`: `long?`. * `DataVencimento`: `DateTime`. * `VendaId`: `long?`. Opcional desde o fechamento guiado — o banco sempre foi nullable; a obrigatoriedade era só do fluxo antigo. Pagamento sem venda é vinculado depois, quando a venda é registrada (assinatura do contrato). * `ValorTotal`: `double?`. Valor do pagamento. Quando nulo, o default segue o papel (TipoRecebimento); sem papel e com venda, mantém o legado (total da venda). * `TipoRecebimento`: `TipoRecebimentoEnum?`. [Voltar ao índice](#2-indice-clicavel) ### PagarLoteInputDTO **Herança:** `ParcelasLoteInputDTO` — [ParcelasLoteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-parcelasloteinputdto). * `ContaBancariaId`: `long`. * `FormaPagamentoId`: `long?`. * `DataPagamento`: `DateTime?`. * `Observacao`: `string`. [Voltar ao índice](#2-indice-clicavel) ### PagarParcelaInputDTO * `ParcelaPagarId`: `long`. Baixa (pagamento) de uma ParcelaPagar: debita o valor da ContaBancaria e amortiza a parcela. * `ContaBancariaId`: `long`. * `FormaPagamentoId`: `long?`. * `DataPagamento`: `DateTime?`. * `ValorPago`: `decimal`. * `Juros`: `decimal?`. * `Multa`: `decimal?`. * `Desconto`: `decimal?`. * `Observacao`: `string`. * `ComprovanteUrl`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ParcelaEntradaFinanciamentoInputDTO * `Valor`: `decimal`. Uma parcela da entrada do cliente (entrada dividida). * `DataVencimento`: `DateTime`. [Voltar ao índice](#2-indice-clicavel) ### ParcelaPagamentoInputDTO * `DataVencimento`: `DateTime`. * `DataPagamento`: `DateTime?`. * `ValorParcela`: `double`. * `ValorPago`: `double`. * `Observacoes`: `string`. * `PagamentoId`: `long`. * `StatusId`: `long`. * `FormaPagamentoId`: `long`. * `QuantidadeParcelas`: `int?`. * `IncrementarValorPagamento`: `bool`. Soma o valor das parcelas criadas (a 1ª e as réplicas) ao Valor Total do pagamento. [Voltar ao índice](#2-indice-clicavel) ### ParcelaPagarInputDTO * `Numero`: `int`. * `DataVencimento`: `DateTime`. * `ValorParcela`: `decimal`. * `FormaPagamentoId`: `long?`. * `ContaBancariaId`: `long?`. Conta prevista de saída da parcela (nula = a do título). * `CodigoBarras`: `string`. * `UrlBoleto`: `string`. * `ExternalId`: `string`. [Voltar ao índice](#2-indice-clicavel) ### ParcelaReceberInputDTO * `Numero`: `int`. * `DataVencimento`: `DateTime`. * `ValorParcela`: `decimal`. * `FormaPagamentoId`: `long?`. * `ContaBancariaId`: `long?`. Conta prevista de destino da parcela (nula = a do título). * `VencimentoAConfirmar`: `bool`. O vencimento é estimativa (repasse sem data confirmada): a parcela nasce fora do "vencido" e do aging até confirmarem. * `OrigemVencimento`: `OrigemVencimentoEnum`. De onde veio a data (pessoa, prazo do banco, ou nada). * `UrlFatura`: `string`. * `ExternalId`: `string`. * `ParcelaPagamentoId`: `long?`. Parcela do CRM que originou esta (ponte Pagamento -> Titulo). Mantem a cobranca unica entre os dois lados. [Voltar ao índice](#2-indice-clicavel) ### ParcelasLoteInputDTO * `ParcelaIds`: `List`. [Voltar ao índice](#2-indice-clicavel) ### PartidaContabilInputDTO * `ContaContabilId`: `long`. Linha (débito ou crédito) de um lançamento contábil. * `Tipo`: `TipoPartidaEnum`. * `Valor`: `decimal`. * `CentroCustoId`: `long?`. * `HistoricoComplementar`: `string`. [Voltar ao índice](#2-indice-clicavel) ### PaybackAnoEstudoInputDTO * `Ano`: `int`. Uma linha (ano) da projeção de payback calculada no Estudo (front). * `AnoCalendario`: `int`. * `GeracaoAnual`: `double`. * `EconomiaAnual`: `double`. * `ContaSemAnual`: `double`. * `ContaComAnual`: `double`. * `CustoManutencao`: `double`. * `Vpl`: `double`. * `SaldoAcumulado`: `double`. [Voltar ao índice](#2-indice-clicavel) ### PedidoCompraInputDTO * `Numero`: `string`. * `FornecedorId`: `long?`. * `DataPedido`: `DateTime?`. * `DataPrevisaoEntrega`: `DateTime?`. * `Desconto`: `decimal`. * `ValorFrete`: `decimal`. * `ValorIpi`: `decimal`. * `ValorIcmsSt`: `decimal`. * `ValorOutrasDespesas`: `decimal`. * `CategoriaFinanceiraId`: `long?`. * `CentroCustoId`: `long?`. * `ContaBancariaId`: `long?`. * `LojaId`: `long?`. * `DepositoId`: `long?`. * `Fonte`: `FontePedidoCompraEnum`. * `FonteId`: `long?`. * `PedidoVendaId`: `long?`. Obra (Pedido de Venda) desta compra — DRE por pedido. * `Observacao`: `string`. * `ExternalId`: `string`. * `Itens`: `List` — [ItemPedidoCompraInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-itempedidocomprainputdto). [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/)