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 · Exemplo completo · Campos
Índice clicável
ImportarXmlNotaRecebidaInputDTO · IncluirFuncionariosFolhaInputDTO · InstalacaoInputDTO · InsumoAplicadoInputDTO · InsumoAplicadoSimulacao · InsumoImportarInputDTO · InsumoInputDTO · InterpolarTextoInputDTO · ItemBaixaInputDTO · ItemCriarEntregaPedidoInputDTO · ItemDevolucaoInputDTO · ItemEntregarInputDTO · ItemGerarPendenciaInputDTO · ItemModeloTarefaFiltroInputDTO · ItemModeloTarefaInputDTO · ItemNotaFiscalInputDTO · ItemPedidoCompraInputDTO · ItemPedidoDaNotaInputDTO · ItemPedidoVendaInputDTO · ItemPlanilhaBaixaInputDTO · ItemRecebimentoCompraInputDTO · ItemServicoFiscalInputDTO · ItensExtraGestaoInputDTO · JustificarDivergenciaInputDTO · KitCarrinhoItem · KitCarrinhoItemInputDTO · KitSelecionadoInputDTO · KitSnapshotInputDTO · LancamentoContabilInputDTO · LancamentoHoleriteInputDTO · LayoutMapaInputDTO · LayoutModulo · LayoutModuloInputDTO · Lead · LeadAlterarOrigemEmLoteInputDTO · LeadCamposAnaliseIAInputDTO · LeadInputDTO · LeadUsuario · Lead_Status · Lembrete · LiberarPagamentoComissaoInputDTO · Localizacao · Loja · LojaDadosProposta · LojaInputDTO · LojasAtendidasInputDTO · ManifestarNotaRecebidaInputDTO · MarcacaoComentarioTarefa · MarcacaoInputDTO · MarcacaoUsuarioInputDTO · MigrarEntregasInputDTO · ModeloDocumentoInputDTO · ModeloEmail · ModeloPendenciaResumoDTO · ModeloPreProposta · MonitoramentoInputDTO · MontarKitInputDTO · MotivoPerda · MoverAprovacaoPagarInputDTO · MovimentacaoMassaInputDTO · MovimentarMultiplosCardsInputDTO · MovimentoEstoqueInputDTO · NaturezaOperacaoInputDTO · NomeInputDto · NotaFiscalFiltroInputDTO · NotaFiscalInputDTO · NotificacaoMetaInputDTO · NotificacaoMetaStatusProjeto · ObterMetaInputDTO · OpcaoCampoInputDTO · OpcaoPagamentoConfiguracaoSimulador · OpcaoPagamentoSimulador · OrdemServico · OrdemServicoInputDTO · Origem · OtimizarRotasInputDTO · PagamentoComissao · PagamentoInputDTO · PagarLoteInputDTO · PagarParcelaInputDTO · ParcelaEntradaFinanciamentoInputDTO · ParcelaPagamentoInputDTO · ParcelaPagarInputDTO · ParcelaReceberInputDTO · ParcelasLoteInputDTO · PartidaContabilInputDTO · PaybackAnoEstudoInputDTO · PedidoCompraInputDTO
Como interpretar os campos
? indica anulável; List<T>/T[] são arrays; long/int são inteiros; double/decimal são números JSON. DateTime segue o contrato de fuso da action. [Required] não cobre todas as validações de negócio. Campos ignorados por JSON foram excluídos. Tipos homônimos exigem conferir o namespace da operação.
Exemplo de uso
Consultar conexões sociais
Requisição completa (Bash):
curl --request GET \
--url "$API_URL/api/EditorSocial/conexoes" \
--header "Authorization: Bearer $TOKEN" \
--header "Accept: application/json"Resposta ilustrativa — HTTP 200:
{
"Version": "1.0.0.0",
"StatusCode": 200,
"Message": "Requisição efetuada com suceesso.",
"Content": {
"conexoes": []
}
}Solicitar publicação e interpretar erro de negócio
Requisição completa (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:
{
"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.
IncluirFuncionariosFolhaInputDTO
FuncionarioIds:List<long>. Quem entra numa folha já aberta. Lista vazia = todos os ativos com vínculo na competência que ainda estão fora dela.
InstalacaoInputDTO
Herança: AbaComplementarInputDTO — AbaComplementarInputDTO.
dataInicio:DateTime.dataTerminoGarantia:DateTime.dataPrevisaoConclusao:DateTime.dataConclusao:DateTime.garantiaModulo:string.garantiaInversor:string.
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.
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?.
InsumoImportarInputDTO
Nome:string.Descricao:string.Codigo:string.Categoria:string.Fornecedor:string.ValorVenda:double.ValorCusto:double.Lojas:string.
InsumoInputDTO
Nome:string.UnidadeMedidaId:long.CategoriaId:long.GrupoId:long?.ArquivoId:long?.Codigo:string.Descricao:string.Tipo:TipoInsumoEnum.ModoKit:ModoKitEnum.Rastreamento:RastreamentoEstoqueEnum.Composicao:IList<ComposicaoKitItemInputDTO>— ComposicaoKitItemInputDTO. Composição (BOM) quando Tipo=Kit. Opcional na criação.
InterpolarTextoInputDTO
Texto:string.
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<string>. Números de série que estão saindo. Produto rastreado por série exige tantas quantas a quantidade baixada.UnidadeIds:List<long>. 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).
ItemCriarEntregaPedidoInputDTO
InsumoId:long.Quantidade:decimal.
ItemDevolucaoInputDTO
InsumoId:long.DepositoId:long.Quantidade:decimal.UnidadeIds:List<long>. 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<string>. 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.
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.
ItemGerarPendenciaInputDTO
ItemId:long.Quantidade:decimal?. Null = a falta inteira do item.
ItemModeloTarefaFiltroInputDTO
Query:string.StatusId:long?.
ItemModeloTarefaInputDTO
Descricao:string.Titulo:string.Tempo:int.TipoTempo:TipoTempoEnum.StatusId:long.TipoId:long.DependenciaId:long?.
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?.
ItemPedidoCompraInputDTO
InsumoId:long?.Descricao:string.Quantidade:decimal.ValorUnitario:decimal.Desconto:decimal.
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.
ItemPedidoVendaInputDTO
InsumoId:long?.Descricao:string.Quantidade:decimal.ValorUnitario:decimal.Desconto:decimal.
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.
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).
ItemServicoFiscalInputDTO
Codigo:string. Item da lista de serviço (LC 116) a vincular a uma ConfiguracaoFiscal.Descricao:string.Cnae:string.PercentualTributos:double.
ItensExtraGestaoInputDTO
Quantidade:int.Codigo:string.
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.
KitCarrinhoItem
Herança: BaseModel — 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.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.
KitCarrinhoItemInputDTO
GeradorId:long.CodigoKit:string.Fonte:string.Quantidade:int.PotenciaKwp:double.ValorUnitario:double.ValorTotal:double.SnapshotJson:string.
KitSelecionadoInputDTO
Codigo:string.Quantidade:int.Snapshot:KitSnapshotInputDTO— KitSnapshotInputDTO.
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.
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>— PartidaContabilInputDTO.
LancamentoHoleriteInputDTO
HoleriteFuncionarioId:long. Lançamento manual (rubrica variável) em um holerite (RH/Folha).RubricaId:long.Valor:double.Referencia:string.
LayoutMapaInputDTO
Json:string.
LayoutModulo
Herança: BaseModel — 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.GeradorId:long.Gerador:Gerador— 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).
LayoutModuloInputDTO
FaceTelhadoId:long.GeradorId:long.QuantidadeModulos:int.Linhas:int.Colunas:int.OrientacaoModulo:string.PosicoesJson:string.
Lead
Herança: BaseModel — 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.OrigemId:long?.Endereco:Endereco— Endereco.Responsavel:Usuario— Usuario.ResponsavelId:long?.PreVendedor:Usuario— Usuario.PreVendedorId:long?.ImagemPerfil:Arquivo— Arquivo.Tipo:TipoLead.Loja:Loja— Loja.LojaId:long?.Atividades:IList<Acao>— Acao.Seguidores:IList<LeadUsuario>— LeadUsuario.Status:StatusLead— StatusLead.Historico:IList<Lead_Status>— Lead_Status.Projetos:IList<Projeto>— Projeto.Vendas:IList<Venda>— Venda.Simulacaos:IList<Simulacao>— Simulacao.Contatos:IList<Contato>— Contato.CodigoLeadTracking:string.ExternalId:string.Atribuir:bool.ProcuracaoAssinadaUrl:string.CartaoCnpjUrl:string.DocumentoSocioAdminUrl:string.ContratoSocialUrl:string.
LeadAlterarOrigemEmLoteInputDTO
OrigemId:long?.Ids:List<long>.
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?.
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?.
LeadUsuario
Lead_Status
Id:long.DataStatus:DateTime.Observacao:string.Status:StatusLead— StatusLead.Lembretes:IList<Lembrete>— Lembrete.Usuario:Usuario— Usuario.
Lembrete
Id:long.Status:Lead_Status— Lead_Status.StatusProjeto:Projeto_Status— Projeto_Status.DataCriacao:DateTime.DataLembrete:DateTime.DataEnvio:DateTime?.Nota:string.
LiberarPagamentoComissaoInputDTO
Herança: PagarParcelaInputDTO — PagarParcelaInputDTO.
Justificativa:string. Por que está pagando sem lastro. Obrigatória.
Localizacao
Herança: BaseModel — BaseModel.
Latitude:string.Longitude:string.Velocidade:double.DataCapturada:DateTime?.Status:string.Provider:string.Accuracy:double.
Loja
Herança: BaseModel — BaseModel.
Nome:string.CNPJ:string.RazaoSocial:string.InscricaoEstadual:string.Telefone:string.Endereco:Endereco— Endereco.Fachada:Arquivo— 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>— 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.ValorPorDiaria:double.
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.
LojaInputDTO
Nome:string.Endereco:Endereco— Endereco.ArquivoId:long?.
LojasAtendidasInputDTO
LojaIds:List<long>. 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.
ManifestarNotaRecebidaInputDTO
Tipo:string. ciencia | confirmacao | desconhecimento | nao_realizadaJustificativa:string. Obrigatória (15–255) só em nao_realizada.
MarcacaoComentarioTarefa
Id:long.Data:DateTime.Marcacao:string.Usuario:Usuario— Usuario.UsuarioId:long?.
MarcacaoInputDTO
Marcacao:string.UsuarioId:long.
MarcacaoUsuarioInputDTO
UsuarioId:long.Texto:string.
MigrarEntregasInputDTO
CategoriaIds:List<long>. Categorias de Compra que representam ENTREGA. Vazio/null = só as Compras já em rota (estar numa rota de entrega é inequívoco).
ModeloDocumentoInputDTO
Nome:string.Ativo:bool.Texto:string.EditorAvancado:bool.Tipo:TipoModeloDocumento?.
ModeloEmail
Herança: BaseModel — BaseModel.
Ativo:bool.Nome:string.Assunto:string.Corpo:string.
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>— CondicaoResumoDTO.
ModeloPreProposta
Herança: BaseModel — BaseModel.
Ativo:bool.EditorAvancado:bool.Paisagem:bool.Titulo:string.URLCapa:string.Texto:string.Loja:Loja— Loja.TipoGrupo:TipoGrupoEnum.StatusLeadGatilho:StatusLead— StatusLead.HistoricoAlteracao:IList<HistoricoAlteracaoPreProposta>— HistoricoAlteracaoPreProposta.Ordem:int.PrefixoPadrao:string.
MonitoramentoInputDTO
Herança: AbaComplementarInputDTO — AbaComplementarInputDTO.
previsaoEntrega:DateTime.entregaRealizada:DateTime.usuario:string.senha:string.urlMonitoramento:string.modeloModulo:string.qtdModulos:int.potenciaModulo:double.modeloInversor:string.qtdInversores:int.potenciaInversor:double.
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.
MotivoPerda
Id:long.Ativo:bool.Nome:string.Descricao:string.Status:string.
MoverAprovacaoPagarInputDTO
ParcelaIds:List<long>. 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<long>.StatusAprovacaoPagarId:long.Observacao:string. Motivo ou comentario. Obrigatorio para mandar a um status Reprovado.
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<long>. 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<long>. Alvos escolhidos à mão. Ignorado quando é true.UsarFiltro:bool. Quando true, os alvos saem do filtro (query string) em vez de .
MovimentarMultiplosCardsInputDTO
Ids:List<long>.StatusId:long.StatusOrigemId:long?.
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<string>. Números de série (Rastreamento=Serie). Entrada: cria 1 UnidadeEstoque por série; Saída: baixa essas séries. Opcional.UnidadeIds:IList<long>. 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).
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.
NomeInputDto
Nome:string.
NotaFiscalFiltroInputDTO
Herança: QueryFiltroInputDTO — QueryFiltroInputDTO.
PedidoVendaId:long?. Notas de um pedido de venda específico.Modelo:ModeloDocumentoFiscal?.Status:StatusNotaFiscal?.
NotaFiscalInputDTO
Herança: TransporteNotaInputDTO — 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>— ItemNotaFiscalInputDTO.
NotificacaoMetaInputDTO
Tipo:TipoNotificacaoMeta.NotificarComMeta:bool.InstanceId:string.TemplateId:string.VariaveisJson:string.
NotificacaoMetaStatusProjeto
Id:long.Status:StatusProjeto— StatusProjeto.StatusId:long.Tipo:TipoNotificacaoMeta.NotificarComMeta:bool.InstanceId:string.TemplateId:string.VariaveisJson:string.
ObterMetaInputDTO
Mes:int?.Ano:int?.Objetivo:ObjetivoMetaEnum?.TipoVendaId:long?.VendedorIds:List<long>.
OpcaoCampoInputDTO
Opcao:string.
OpcaoPagamentoConfiguracaoSimulador
Id:long.PorcentagemEntrada:double.QuantidadeParcelas:int.PorcentagemJuros:double.PorcentagemDesconto:double.QuantidadeParcelasServico:int.PorcentagemDescontoServico:double.PorcentagemEntradaServico:double.PorcentagemJurosServico:double.
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.
OrdemServico
Herança: AbaComplementar — 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.TipoServico:TipoServico— TipoServico.Status:StatusOrdemServico— StatusOrdemServico.Tarefas:ICollection<Tarefa>— Tarefa.Tecnico:Usuario— 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.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.
OrdemServicoInputDTO
Herança: AbaComplementarInputDTO — AbaComplementarInputDTO.
numero:string.dataPedido:DateTime.titulo:string.tipoServicoId:long?.equipeId:long?.dataAgendamentoInicial:DateTime.dataAgendamentoFinal:DateTime?.valor:double.arquivos:List<string>.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.
Origem
Id:long.Nome:string.Tipo:TipoOrigemEnum.StatusInicial:StatusProjeto— StatusProjeto.Lojas:string.
OtimizarRotasInputDTO
ComprasIds:List<long>. Entregas (Compras) a rotear.VeiculosIds:List<long>. 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.
PagamentoComissao
Herança: BaseModel — BaseModel.
Vendedor:Usuario— Usuario.ValorPago:double.Descricao:string.Comprovante:Arquivo— Arquivo.Venda:Venda— Venda.PagamentoParcelaId:long?.
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?.
PagarLoteInputDTO
Herança: ParcelasLoteInputDTO — ParcelasLoteInputDTO.
ContaBancariaId:long.FormaPagamentoId:long?.DataPagamento:DateTime?.Observacao:string.
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.
ParcelaEntradaFinanciamentoInputDTO
Valor:decimal. Uma parcela da entrada do cliente (entrada dividida).DataVencimento:DateTime.
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.
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.
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.
ParcelasLoteInputDTO
ParcelaIds:List<long>.
PartidaContabilInputDTO
ContaContabilId:long. Linha (débito ou crédito) de um lançamento contábil.Tipo:TipoPartidaEnum.Valor:decimal.CentroCustoId:long?.HistoricoComplementar:string.
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.
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>— ItemPedidoCompraInputDTO.
Veja também
Atualizado em: 14/10/2026
Obrigado!
