# Estrutura envio de vendas.

Estrutura envio de vendas PDV Avanço Informática.

# Integração de Envio de Vendas

# Documentação Técnica — Integração de Envio de Vendas do PDV Avanço para ERP Parceiro

## 1. Visão Geral da Integração

O **PDV Avanço** é responsável por realizar o **envio das vendas concluídas** para o **ERP Parceiro**, por meio de um **endpoint HTTP (POST)** que será desenvolvido pelo ERP, com base na estrutura e regras de preenchimento do payload descritas neste documento.

Cada requisição conterá **uma única venda**, no formato **JSON**, contendo todas as informações fiscais no xml, itens, pagamentos, e dados complementares necessários para o controle contábil e gerencial.   
  
Os campos que estão como opcionais é que podem e não conter na venda.  
  
Os campos que estão como obrigatórios é que sempre irão conter na venda.  
  
<span style="text-decoration: underline;">Importante: Todos os dados fiscais devem ser buscados pelo ERP no XML que está sendo fornecido no JSON de venda. </span>

O ERP deverá receber, validar e armazenar essas informações, podendo processá-las de forma assíncrona ou síncrona, conforme sua arquitetura.

## 2. Estrutura geral do payload. 

##### 2.1. Exemplo Simplificado de Estrutura

```json


{
    "softHouse":"AVANCO",			// Obrigatório
    "modeloDocumentoFiscal":"65",	// Obrigatório
    "chaveAcesso":"",				// Obrigatório
    "chaveBusca":"",				// Obrigatório
    "cnpjLoja":"",					// Obrigatório
    "numeroLoja":0,					// Obrigatório
    "numeroSerie":"",				// Obrigatório
    "numeroPdv":0,					// Obrigatório
    "numeroCupom":233,				// Obrigatório
    "numeroNota":267,				// Obrigatório
    "dataHoraVenda":"2024-09-10 11:11:11",	// Obrigatório
    "dataMovimento":"2024-09-10",			// Obrigatório
    "versaoPdv":"",							// Obrigatório
    "contingencia":"N", -> S ou N			// Obrigatório
    "cancelado":"N",  -> S ou N				// Obrigatório
    "dataCancelamento":"2024-09-10 11:11:11",	// Opcional
    "chaveSubstituta":"",						// Opcional
    "protocoloCancelamento":"",					// Opcional
    "xmlCancelamento":"",						// Opcional
    "xml":"",									// Obrigatório
    "cabecalho":{
        "doctoCliente":"",				// Opcional
        "numeroVendedor":0,				// Opcional
        "tokenScanntech": "50d7f6db-2edd-415c-ac2d-87470a2db43d", //Opcional
        "numeroDeItens":0,				// Obrigatório
        "totalDaVenda":0.00,			// Obrigatório
        "descontoSubtotal":0.00,		// Opcional
        "acrescimoSubtotal":0.00,		// Opcional
        "troco":0.00,					// Opcional			
        "descontoItens":0.00,			// Opcional
        "acrescimoItens":0.00,			// Opcional
        "descontosFormas":0.00,			// Opcional
        "acrescimosFormas":0.00,		// Opcional
        "contraVale":"N", -> S ou N		// Obrigatório
        "codigoOperador":"",			// Obrigatório
        "nomeOperador":"",				// Obrigatório
        "cpfOperador":"",				// Opcional
        "numeroDav":"",					// Opcional
        "valorSaqueTef":0.00,			// Opcional
        "numeroPrevenda":"",			// Opcional
        "numeroControlePrevenda":"",	// Opcional
        "numeroControleconta":"",		// Opcional
        "cartaoInforCard":"",			// Opcional
        "totalPontosDotz":0,			// Opcional
        "trocoSolidario":0.00,			// Opcional
        "cnpjTrocoSolidario":"",		// Opcional
        "codigoOperadorLiberacaoDescontoAcrescimoSubtotal":"",	// Opcional
        "nomeOperadorLiberacaoDescontoAcrescimoSubtotal":"",	// Opcional
        "cpfSocioTorcedor":"",								// Opcional
        "codigoMotivoAcrescimoDescontoSubtotal":"",			// Opcional
        "codigoTipoMotivoAcrescimoDescontoSubtotal":"",		// Opcional
        "descricaoMotivoAcrescimoDescontoSubtotal":""		// Opcional
        "cpfBeblue":"",										// Opcional
        "valorTrocoSimples":0.00,							// Opcional
        "cpfDotz":"",										// Opcional
        "cpfPromocoesParceiros":"",							// Opcional
        "cpfCnpjClienteMercafacil":"",						// Opcional
        "valorDescontoMercafacilRateado":0.00,				// Opcional
        "idMercafacil":"",									// Opcional
        "cupomVerde":"N", -> S ou N							// Obrigatório
        "informouCpfCupomVerde":"N" -> S ou N				// Opcional
    },
    "pagamento":[{
        "codigoFormaPagamento":0,					// Obrigatório
        "vendaPrazo": "N", -> S ou N			    // Obrigatório
        "descricaoFormaPagamento":"",				// Obrigatório
        "dataVencimento":"2024-09-10",				// Obrigatório
        "valorPago":0.00,							// Obrigatório
        "acrescimo":0.00,							// Opcional
        "desconto":0.00,							// Opcional
        "documentoCliente":"",						// Opcional 
        "numeroDoctoPagamento":"",					// Opcional
        "numeroParcelas": 1,						// Obrigatório
        "documentoIdentificacaoCliente": "",		// Opcional
        "codigoInternoCliente": "0",				// Opcional
        "clienteDigitouSenha": "N", -> S ou N		// Opcional
        "teveContraVale": "N", -> S ou N			// Obrigatório
        "codigoConvenio": "",						// Opcional
		"tefTipoCartao": "",						// Opcional
		"textoModalidadePagamento": "",				// Opcional
		"idCarteiraDigital": "",					// Opcional
		"nomeCarteiraDigital": "",					// Opcional
		"nsuSitef": "",								// Opcional
		"codigoAutorizacao": "",					// Opcional
		"tefBin": "",								// Opcional
		"produtoSitef": "",							// Opcional
		"nsuHostCompleto": "",                      // Opcional
		"descricaoBandeiraTef",                     // Opcional
		"tefRede": "",								// Opcional
		"tefBandeira": "",							// Opcional
		"embossoCartao": "",						// Opcional
		"nsuHost": "",								// Opcional
		"codigoFormaPagamentoScanntech": 9,			// Opcional
		"valorParcela": 0.00,						// Opcional
        "pontosDotzAdquiridos":0,					// Opcional
        "codigoOperadorLiberacaoImpedimento":"",	// Opcional
        "nomeOperadorLiberacaoImpedimento":"",		// Opcional
        "tipoImpedimento":0,						// Opcional
        "valorLiberado":0.00,						// Opcional
        "clienteDigitouSenha":"N",					// Opcional
        "numeroParcelasPos":0,						// Opcional
        "codigoTipoTransacaoPos":0,					// Opcional
        "descricaoTipoTransacaoPos":"",				// Opcional
        "codigoBandeiraPos":0,						// Opcional
        "descricaoBandeiraPos":"",					// Opcional
        "nsuTransacaoPos":"",						// Opcional
        "autorizacaoTransacaoPos":"" 				// Opcional
        "codigoVoucher": ""                         // Opcional
    }],
    "itensVendidos":[{
        "itemCancelado": "S",					// Obrigatório
        "numeroItem": 1,						// Obrigatório
        "codigoBarras": "00000000000109",		// Obrigatório
		"codigoCategoria": "000",                // Opcional
		"codigoDepartamento": "000",             // Opcional
		"codigoFamiliaPrecosIguais": "00000",     // Opcional
		"codigoSegmento": "000",                 // Opcional
		"codigoSubCategoria": "000",             // Opcional
		"codigoSubSegmento": "000"              // Opcional
        "quantidade": 1.0,						// Obrigatório
        "precoUnitario": 18.99,					// Obrigatório
        "valorTotalItem": 18.99,				// Obrigatório
        "tipoItem": "P",						// Obrigatório
        "situacaoTributaria": "F",				// Obrigatório
        "aliquotaReal":18,						// Opcional
        "aliquotaEfetiva":18,					// Opcional
        "codigoInterno": 109,					// Obrigatório
        "codigoAlternativo": "0000000000000",	// Obrigatório	
        "precoReal": 18.99,						// Obrigatório
        "descontoDireto": 0.0,					// Opcional
        "acrescimoDireto": 0.0,					// Opcional
        "vendidoPrecoPromocional": "N",			// Obrigatório
        "registradorAliquota": "F1",			// Obrigatório
        "dadoComplementar": "",					// Opcional
        "codigoOperadorCancelamento": "",		// Opcional
        "nomeOperadorCancelamento": "",			// Opcional
        "aliquotaIbptFederal": 13.45,			// Obrigatório
        "valorAproximadoFederal": 2.55,			// Obrigatório
        "aliquotaIbptEstadual": 18.0,			// Obrigatório
        "valorAproximadoEstadual": 3.42,		// Obrigatório
        "aliquotaIbptMunicipal": 0.0,			// Obrigatório
        "valorAproximadoMunicipal": 0.0,		// Obrigatório
        "descontoSocioTorcedor": "N",			// Opcional
        "descontoPromocaoEspecial": "N",		// Opcional
        "pontosDotz": 0,						// Opcional
        "idPromocao": "",						// Opcional
        "tipoPromocao": "S", -> A,S,F,V,D,M,T ou vazio	// Obrigatório
        "unidadeMedida": "",							// Obrigatório
        "quantidadeUsadaPromocao": 0,					// Opcional
		"codigoTabelaPrecosAtacado": "",				// Opcional
        "descricaoResumida": "",						// Obrigatório
        "fatorConversao": 1,							// Obrigatório
        "codigoOperadorLiberacaoDescontoAcrescimoItem":"",	// Opcional
        "nomeOperadorLiberacaoDescontoAcrescimoItem":"",	// Opcional
        "descontoRateado":0.00,							// Opcional
        "acrescimoRateado":0.00,						// Opcional
        "baseCalculo":0.00,								// Obrigatório
        "valorIcms":0.00,								// Obrigatório
        "totalBruto":0.00,								// Obrigatório
        "aliquotaPis":0.00,								// Opcional
        "valorPis":0.00,								// Opcional
        "aliquotaCofins":0.00,							// Opcional
        "valorCofins":0.00,								// Opcional
        "cfop":"",										// Obrigatório
        "cstPis":"",									// Obrigatório
        "cstCofins":"",									// Obrigatório
        "ncm":"",										// Obrigatório
        "cest":"",										// Obrigatório
        "grupoTributacao":"",							// Obrigatório (00,60,20,40, etc)
        "codigoMotivoAcrescimoDescontoCancelamento":"",			// Opcional
        "codigoTipoMotivoAcrescimoDescontoCancelamento":"",		// Opcional
        "descricaoMotivoAcrescimoDescontoCancelamento":"",		// Opcional
        "cpfCnpjClienteMercafacil":"",					// Opcional
        "icmsRetiradoBasePisCofins":"N",				// Opcional
        "codigoQuemPesou":""							// Opcional
    }],
    "cashback":{	//Opcional  Essa propriedade só é preenchida quando houver		
        "codigoFormaPagamento":0,
        "descricaoFormaPagamento":"",
        "cpfCliente":"",
        "valorTransacao":0,
        "nsuTransacao":"",
        "idTransacao":"",
        "idPagamento":""
    },
    "entrega":{		//Opcional  Essa propriedade só é preenchida quando houver 
        "documentoCliente":"",
        "nomeCliente":"",
        "tipoLogradouro":"",
        "logradouro":"",
        "numeroLogradouro":"",
        "complemento":"",
        "telefone":"",
        "bairro":"",
        "cidade":"",
        "uf":"",
        "cep":"",
        "referencia":"",
        "dataentrega":"20250910",
        "horaInicial":"10:00:00",
        "horaFinal":"13:00:00",
        "qtdeCaixas":0,
        "observacoesCaixas":"",
        "qtdeEngradados":0,
        "observacoesEngradados":"",
        "qtdevasilhames":0,
        "observacoesVasilhames":"",
        "qtdeFrios":0,
        "observacoesFrios":"",
        "qtdeCongelados":0,
        "observacoesCongelados":"",
        "buscarDeposito":"N",
        "observacoesDeposito":""
    },

```

## 3. Estrutura Detalhada do Payload  


##### Estrutura do Payload – Identificação da Venda

<table id="bkmrk-campo-tipo-obrigat%C3%B3r" style="width: 100%; height: 727.141px;"><thead><tr style="height: 29.7969px;"><th style="width: 17.64%; height: 29.7969px;">**Campo**</th><th style="width: 22.8844%; height: 29.7969px;">**Tipo**</th><th style="width: 13.9406%; height: 29.7969px;">**Obrigatório**</th><th style="width: 45.5349%; height: 29.7969px;">**Descrição / Observações**</th></tr></thead><tbody><tr style="height: 46.9062px;"><td style="width: 17.64%; height: 46.9062px;">softHouse</td><td style="width: 22.8844%; height: 46.9062px;">String</td><td style="width: 13.9406%; height: 46.9062px;">✅</td><td style="width: 45.5349%; height: 46.9062px;">Identificação da software house responsável pelo PDV. Valor fixo `"AVANCO"`.</td></tr><tr style="height: 46.9062px;"><td style="width: 17.64%; height: 46.9062px;">modeloDocumentoFiscal</td><td style="width: 22.8844%; height: 46.9062px;">String</td><td style="width: 13.9406%; height: 46.9062px;">✅</td><td style="width: 45.5349%; height: 46.9062px;">Código do modelo fiscal do documento. Exemplo: `"65"` (NFC-e).</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">chaveAcesso</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Chave de acesso da NFC-e (44 dígitos).</td></tr><tr style="height: 46.5938px;"><td style="width: 17.64%; height: 46.5938px;">chaveBusca</td><td style="width: 22.8844%; height: 46.5938px;">String</td><td style="width: 13.9406%; height: 46.5938px;">✅</td><td style="width: 45.5349%; height: 46.5938px;">Chave utilizada internamente para rastreamento ou pesquisa da venda.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">cnpjLoja</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">CNPJ da loja emissora da venda.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">numeroLoja</td><td style="width: 22.8844%; height: 29.7969px;">Integer</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Identificador numérico da loja no sistema ERP.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">numeroSerie</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Número de série fiscal da nota.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">numeroPdv</td><td style="width: 22.8844%; height: 29.7969px;">Integer</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Número do terminal de PDV que emitiu a venda.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">numeroCupom</td><td style="width: 22.8844%; height: 29.7969px;">Integer</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Número sequencial do cupom no PDV.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">numeroNota</td><td style="width: 22.8844%; height: 29.7969px;">Integer</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Número da nota fiscal (NFC-e).</td></tr><tr style="height: 46.5938px;"><td style="width: 17.64%; height: 46.5938px;">dataHoraVenda</td><td style="width: 22.8844%; height: 46.5938px;">String (YYYY-MM-DD HH:MM:SS)</td><td style="width: 13.9406%; height: 46.5938px;">✅</td><td style="width: 45.5349%; height: 46.5938px;">Data e hora exatas da venda.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">dataMovimento</td><td style="width: 22.8844%; height: 29.7969px;">String (YYYY-MM-DD)</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Data de movimento contábil da venda.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">versaoPdv</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Versão do software PDV responsável pela emissão.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">contingencia</td><td style="width: 22.8844%; height: 29.7969px;">String ("S" ou "N")</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Indica se a nota foi emitida em contingência.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">cancelado</td><td style="width: 22.8844%; height: 29.7969px;">String ("S" ou "N")</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">Indica se a venda foi cancelada.</td></tr><tr style="height: 46.5938px;"><td style="width: 17.64%; height: 46.5938px;">dataCancelamento</td><td style="width: 22.8844%; height: 46.5938px;">String (YYYY-MM-DD HH:MM:SS)</td><td style="width: 13.9406%; height: 46.5938px;">❌</td><td style="width: 45.5349%; height: 46.5938px;">Data e hora de cancelamento da venda, quando aplicável.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">chaveSubstituta</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">❌</td><td style="width: 45.5349%; height: 29.7969px;">Chave de acesso da nota fiscal substituta, quando houver.</td></tr><tr style="height: 46.5938px;"><td style="width: 17.64%; height: 46.5938px;">protocoloCancelamento</td><td style="width: 22.8844%; height: 46.5938px;">String</td><td style="width: 13.9406%; height: 46.5938px;">❌</td><td style="width: 45.5349%; height: 46.5938px;">Protocolo de cancelamento retornado pela SEFAZ.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">xmlCancelamento</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">❌</td><td style="width: 45.5349%; height: 29.7969px;">XML completo do evento de cancelamento da NFC-e.</td></tr><tr style="height: 29.7969px;"><td style="width: 17.64%; height: 29.7969px;">xml</td><td style="width: 22.8844%; height: 29.7969px;">String</td><td style="width: 13.9406%; height: 29.7969px;">✅</td><td style="width: 45.5349%; height: 29.7969px;">XML completo da NFC-e emitida.</td></tr></tbody></table>

##### objeto cabecalho: 

<table id="bkmrk-campo-tipo-obrigat%C3%B3r-1" style="width: 100%;"><thead><tr><th style="width: 29.6782%;">**Campo**</th><th style="width: 11.5614%;">**Tipo**</th><th style="width: 13.4632%;">**Obrigatório**</th><th style="width: 45.2973%;">**Descrição / Observações**</th></tr></thead><tbody><tr><td style="width: 29.6782%;">doctoCliente</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Documento do cliente vinculado à venda (CPF/CNPJ), quando informado.</td></tr><tr><td style="width: 29.6782%;">numeroVendedor</td><td style="width: 11.5614%;">Integer</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Código do vendedor responsável pela venda.</td></tr><tr><td style="width: 29.6782%;">tokenScanntech</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Token de identificação do PDV na plataforma Scanntech (quando aplicável).</td></tr><tr><td style="width: 29.6782%;">numeroDeItens</td><td style="width: 11.5614%;">Integer</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Quantidade total de itens registrados na venda.</td></tr><tr><td style="width: 29.6782%;">totalDaVenda</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Valor total bruto da venda (soma de todos os itens antes de descontos gerais).</td></tr><tr><td style="width: 29.6782%;">descontoSubtotal</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor total de descontos aplicados sobre o subtotal da venda.</td></tr><tr><td style="width: 29.6782%;">acrescimoSubtotal</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor total de acréscimos aplicados sobre o subtotal.</td></tr><tr><td style="width: 29.6782%;">troco</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor de troco devolvido ao cliente.</td></tr><tr><td style="width: 29.6782%;">descontoItens</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Total de descontos concedidos diretamente nos itens.</td></tr><tr><td style="width: 29.6782%;">acrescimoItens</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Total de acréscimos aplicados diretamente nos itens.</td></tr><tr><td style="width: 29.6782%;">descontosFormas</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor de desconto originado em uma forma de pagamento (ex: convênio, vale).</td></tr><tr><td style="width: 29.6782%;">acrescimosFormas</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor de acréscimo originado em uma forma de pagamento (ex: juros).</td></tr><tr><td style="width: 29.6782%;">contraVale</td><td style="width: 11.5614%;">String ("S" ou "N")</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Indica se há contravale relacionado à venda.</td></tr><tr><td style="width: 29.6782%;">codigoOperador</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Código do operador que efetuou a venda.</td></tr><tr><td style="width: 29.6782%;">nomeOperador</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Nome do operador do PDV.</td></tr><tr><td style="width: 29.6782%;">cpfOperador</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF do operador (quando informado).</td></tr><tr><td style="width: 29.6782%;">numeroDav</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Número do Documento Auxiliar de Venda, quando aplicável.</td></tr><tr><td style="width: 29.6782%;">valorSaqueTef</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor de saque realizado através do TEF (Transação Eletrônica Financeira).</td></tr><tr><td style="width: 29.6782%;">numeroPrevenda</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Número da pré-venda associada.</td></tr><tr><td style="width: 29.6782%;">numeroControlePrevenda</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Número de controle da pré-venda.</td></tr><tr><td style="width: 29.6782%;">numeroControleconta</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Número de controle da conta vinculada à operação (utilizado em restaurantes, comandas, etc).</td></tr><tr><td style="width: 29.6782%;">cartaoInforCard</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Número do cartão InforCard, se utilizado.</td></tr><tr><td style="width: 29.6782%;">totalPontosDotz</td><td style="width: 11.5614%;">Integer</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Quantidade total de pontos Dotz acumulados na venda.</td></tr><tr><td style="width: 29.6782%;">trocoSolidario</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor do troco destinado ao troco solidário (doação).</td></tr><tr><td style="width: 29.6782%;">cnpjTrocoSolidario</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CNPJ da instituição beneficiária do troco solidário.</td></tr><tr><td style="width: 29.6782%;">codigoOperadorLiberacaoDescontoAcrescimoSubtotal</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Código do operador que autorizou desconto/acréscimo no subtotal.</td></tr><tr><td style="width: 29.6782%;">nomeOperadorLiberacaoDescontoAcrescimoSubtotal</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Nome do operador que liberou desconto/acréscimo no subtotal.</td></tr><tr><td style="width: 29.6782%;">cpfSocioTorcedor</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF do cliente vinculado ao programa Sócio Torcedor.</td></tr><tr><td style="width: 29.6782%;">codigoMotivoAcrescimoDescontoSubtotal</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Código do motivo de acréscimo/desconto aplicado no subtotal.</td></tr><tr><td style="width: 29.6782%;">codigoTipoMotivoAcrescimoDescontoSubtotal</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Tipo do motivo (classificação interna de desconto/acréscimo).</td></tr><tr><td style="width: 29.6782%;">descricaoMotivoAcrescimoDescontoSubtotal</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Descrição textual do motivo de acréscimo/desconto no subtotal.</td></tr><tr><td style="width: 29.6782%;">cpfBeblue</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF do cliente associado ao programa Beblue (cashback).</td></tr><tr><td style="width: 29.6782%;">valorTrocoSimples</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor de troco simples devolvido (sem troco solidário).</td></tr><tr><td style="width: 29.6782%;">cpfDotz</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF do cliente cadastrado no programa Dotz.</td></tr><tr><td style="width: 29.6782%;">cpfPromocoesParceiros</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF informado em promoções de parceiros.</td></tr><tr><td style="width: 29.6782%;">cpfCnpjClienteMercafacil</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">CPF ou CNPJ do cliente no programa Mercafacil.</td></tr><tr><td style="width: 29.6782%;">valorDescontoMercafacilRateado</td><td style="width: 11.5614%;">Decimal</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Valor do desconto Mercafacil rateado entre os itens.</td></tr><tr><td style="width: 29.6782%;">idMercafacil</td><td style="width: 11.5614%;">String</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Identificador interno do cliente no Mercafacil.</td></tr><tr><td style="width: 29.6782%;">cupomVerde</td><td style="width: 11.5614%;">String ("S" ou "N")</td><td style="width: 13.4632%;">✅</td><td style="width: 45.2973%;">Indica se a venda participa do programa Cupom Verde.</td></tr><tr><td style="width: 29.6782%;">informouCpfCupomVerde</td><td style="width: 11.5614%;">String ("S" ou "N")</td><td style="width: 13.4632%;">❌</td><td style="width: 45.2973%;">Indica se o CPF foi informado especificamente para o Cupom Verde.</td></tr></tbody></table>

##### objeto pagamento:   
  


<table id="bkmrk-campo-tipo-obrigat%C3%B3r-2" style="width: 100%;"><thead><tr><th style="width: 23.0036%;">**Campo**</th><th style="width: 13.826%;">**Tipo**</th><th style="width: 15.0109%;">**Obrigatório**</th><th style="width: 48.1595%;">**Descrição / Observações**</th></tr></thead><tbody><tr><td style="width: 23.0036%;">codigoFormaPagamento</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Código interno da forma de pagamento utilizada.</td></tr><tr><td style="width: 23.0036%;">vendaPrazo</td><td style="width: 13.826%;">String ("S" ou "N")</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Indica se a venda foi a prazo.</td></tr><tr><td style="width: 23.0036%;">descricaoFormaPagamento</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Descrição textual da forma de pagamento (ex: “DINHEIRO”, “CARTÃO CRÉDITO”).</td></tr><tr><td style="width: 23.0036%;">dataVencimento</td><td style="width: 13.826%;">String (YYYY-MM-DD)</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Data de vencimento da parcela, usada para vendas a prazo.</td></tr><tr><td style="width: 23.0036%;">valorPago</td><td style="width: 13.826%;">Decimal</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Valor pago pelo cliente nesta forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">acrescimo</td><td style="width: 13.826%;">Decimal</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Valor de acréscimo aplicado na forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">desconto</td><td style="width: 13.826%;">Decimal</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Valor de desconto aplicado na forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">documentoCliente</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Documento do cliente vinculado a esta forma de pagamento (CPF, CNPJ, etc).</td></tr><tr><td style="width: 23.0036%;">numeroDoctoPagamento</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Número de controle do documento da forma de pagamento (ex: número do cheque, convênio etc).</td></tr><tr><td style="width: 23.0036%;">numeroParcelas</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Número total de parcelas para esta forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">documentoIdentificacaoCliente</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Documento de identificação do cliente (ex: RG, CNH), quando coletado.</td></tr><tr><td style="width: 23.0036%;">codigoInternoCliente</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código interno do cliente vinculado à operação.</td></tr><tr><td style="width: 23.0036%;">clienteDigitouSenha</td><td style="width: 13.826%;">String ("S" ou "N")</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Indica se o cliente digitou senha (transações TEF ou POS).</td></tr><tr><td style="width: 23.0036%;">teveContraVale</td><td style="width: 13.826%;">String ("S" ou "N")</td><td style="width: 15.0109%;">✅</td><td style="width: 48.1595%;">Indica se houve contravale vinculado a esta forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">codigoConvenio</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código do convênio utilizado (ex: plano de saúde, empresa conveniada).</td></tr><tr><td style="width: 23.0036%;">tefTipoCartao</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Tipo de cartão utilizado no TEF (ex: crédito, débito, voucher).</td></tr><tr><td style="width: 23.0036%;">textoModalidadePagamento</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Descrição da modalidade de pagamento (ex: “Crédito 2x”, “Pix QRCode”).</td></tr><tr><td style="width: 23.0036%;">idCarteiraDigital</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Identificador interno da carteira digital utilizada.</td></tr><tr><td style="width: 23.0036%;">nomeCarteiraDigital</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome da carteira digital (ex: PicPay, Ame, Mercado Pago).</td></tr><tr><td style="width: 23.0036%;">nsuSitef</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Número sequencial único da transação retornado pelo SiTef.</td></tr><tr><td style="width: 23.0036%;">codigoAutorizacao</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código de autorização retornado pela operadora TEF.</td></tr><tr><td style="width: 23.0036%;">tefBin</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">BIN (primeiros dígitos do cartão) usado na transação TEF.</td></tr><tr><td style="width: 23.0036%;">produtoSitef</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Produto de transação retornado pelo SiTef.</td></tr><tr><td style="width: 23.0036%;">nsuHostCompleto</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Identificador completo da transação no host do adquirente.</td></tr><tr><td style="width: 23.0036%;">descricaoBandeiraTef</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome da bandeira do cartão retornada pelo TEF (ex: Visa, Mastercard).</td></tr><tr><td style="width: 23.0036%;">tefRede</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome da rede de processamento TEF (ex: Rede, GetNet, Cielo).</td></tr><tr><td style="width: 23.0036%;">tefBandeira</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código da bandeira do cartão (interno ou do adquirente).</td></tr><tr><td style="width: 23.0036%;">embossoCartao</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome impresso no cartão (embossado).</td></tr><tr><td style="width: 23.0036%;">nsuHost</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">NSU simplificado retornado pelo host.</td></tr><tr><td style="width: 23.0036%;">codigoFormaPagamentoScanntech</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código da forma de pagamento conforme integração Scanntech.</td></tr><tr><td style="width: 23.0036%;">valorParcela</td><td style="width: 13.826%;">Decimal</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Valor unitário da parcela, quando parcelado.</td></tr><tr><td style="width: 23.0036%;">pontosDotzAdquiridos</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Quantidade de pontos Dotz adquiridos nesta transação.</td></tr><tr><td style="width: 23.0036%;">codigoOperadorLiberacaoImpedimento</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código do operador que liberou pagamento com impedimento.</td></tr><tr><td style="width: 23.0036%;">nomeOperadorLiberacaoImpedimento</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome do operador que autorizou o pagamento impedido.</td></tr><tr><td style="width: 23.0036%;">tipoImpedimento</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Tipo de impedimento aplicado à forma de pagamento.</td></tr><tr><td style="width: 23.0036%;">valorLiberado</td><td style="width: 13.826%;">Decimal</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Valor liberado pelo operador após impedimento.</td></tr><tr><td style="width: 23.0036%;">numeroParcelasPos</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Número de parcelas informado no POS.</td></tr><tr><td style="width: 23.0036%;">codigoTipoTransacaoPos</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código do tipo de transação no POS.</td></tr><tr><td style="width: 23.0036%;">descricaoTipoTransacaoPos</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Descrição textual do tipo de transação (ex: “Crédito à vista”).</td></tr><tr><td style="width: 23.0036%;">codigoBandeiraPos</td><td style="width: 13.826%;">Integer</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código interno da bandeira utilizada no POS.</td></tr><tr><td style="width: 23.0036%;">descricaoBandeiraPos</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Nome da bandeira informada pelo POS.</td></tr><tr><td style="width: 23.0036%;">nsuTransacaoPos</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">NSU da transação capturada no POS.</td></tr><tr><td style="width: 23.0036%;">autorizacaoTransacaoPos</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código de autorização da transação do POS.</td></tr><tr><td style="width: 23.0036%;">codigoVoucher</td><td style="width: 13.826%;">String</td><td style="width: 15.0109%;">❌</td><td style="width: 48.1595%;">Código do voucher vinculado ao pagamento, quando aplicável.</td></tr></tbody></table>

##### objeto itensVendidos:  
  


<table id="bkmrk-campo-tipo-obrigat%C3%B3r-3" style="width: 100%;"><thead><tr><th style="width: 28.3671%;">**Campo**</th><th style="width: 23.3611%;">**Tipo**</th><th style="width: 16.2011%;">**Obrigatório**</th><th style="width: 32.0706%;">**Descrição / Observações**</th></tr></thead><tbody><tr><td style="width: 28.3671%;">itemCancelado</td><td style="width: 23.3611%;">String ("S" ou "N")</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Indica se o item foi cancelado no cupom.</td></tr><tr><td style="width: 28.3671%;">numeroItem</td><td style="width: 23.3611%;">Integer</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Número sequencial do item no cupom.</td></tr><tr><td style="width: 28.3671%;">codigoBarras</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Código de barras do produto.</td></tr><tr><td style="width: 28.3671%;">codigoCategoria</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código da categoria do produto no ERP.</td></tr><tr><td style="width: 28.3671%;">codigoDepartamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do departamento vinculado ao produto.</td></tr><tr><td style="width: 28.3671%;">codigoFamiliaPrecosIguais</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código da família de produtos com preços iguais (quando aplicável).</td></tr><tr><td style="width: 28.3671%;">codigoSegmento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do segmento de produto.</td></tr><tr><td style="width: 28.3671%;">codigoSubCategoria</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código da subcategoria do produto.</td></tr><tr><td style="width: 28.3671%;">codigoSubSegmento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do subsegmento do produto.</td></tr><tr><td style="width: 28.3671%;">quantidade</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Quantidade vendida do produto.</td></tr><tr><td style="width: 28.3671%;">precoUnitario</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor unitário do produto.</td></tr><tr><td style="width: 28.3671%;">valorTotalItem</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor total do item (quantidade × preço unitário).</td></tr><tr><td style="width: 28.3671%;">tipoItem</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Tipo do item — “P” para produto, “S” para serviço.</td></tr><tr><td style="width: 28.3671%;">situacaoTributaria</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Situação tributária do item (ex: F = Tributado).</td></tr><tr><td style="width: 28.3671%;">aliquotaReal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Alíquota nominal do imposto aplicado (ICMS, PIS, COFINS, etc).</td></tr><tr><td style="width: 28.3671%;">aliquotaEfetiva</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Alíquota efetiva resultante após reduções e isenções.</td></tr><tr><td style="width: 28.3671%;">codigoInterno</td><td style="width: 23.3611%;">Integer</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Código interno do produto no sistema.</td></tr><tr><td style="width: 28.3671%;">codigoAlternativo</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Código alternativo ou PLU do produto.</td></tr><tr><td style="width: 28.3671%;">precoReal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Preço real do item, antes de eventuais descontos promocionais.</td></tr><tr><td style="width: 28.3671%;">descontoDireto</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de desconto concedido diretamente no item.</td></tr><tr><td style="width: 28.3671%;">acrescimoDireto</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de acréscimo aplicado diretamente no item.</td></tr><tr><td style="width: 28.3671%;">vendidoPrecoPromocional</td><td style="width: 23.3611%;">String ("S" ou "N")</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Indica se o item foi vendido com preço promocional.</td></tr><tr><td style="width: 28.3671%;">registradorAliquota</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Identificação da alíquota fiscal no registrador (ex: “F1”).</td></tr><tr><td style="width: 28.3671%;">dadoComplementar</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Dados complementares sobre o item (observações fiscais ou gerenciais).</td></tr><tr><td style="width: 28.3671%;">codigoOperadorCancelamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do operador responsável pelo cancelamento do item.</td></tr><tr><td style="width: 28.3671%;">nomeOperadorCancelamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Nome do operador que cancelou o item.</td></tr><tr><td style="width: 28.3671%;">aliquotaIbptFederal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Alíquota federal conforme tabela IBPT.</td></tr><tr><td style="width: 28.3671%;">valorAproximadoFederal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor aproximado de tributos federais embutidos no item.</td></tr><tr><td style="width: 28.3671%;">aliquotaIbptEstadual</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Alíquota estadual conforme tabela IBPT.</td></tr><tr><td style="width: 28.3671%;">valorAproximadoEstadual</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor aproximado de tributos estaduais embutidos no item.</td></tr><tr><td style="width: 28.3671%;">aliquotaIbptMunicipal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Alíquota municipal conforme tabela IBPT.</td></tr><tr><td style="width: 28.3671%;">valorAproximadoMunicipal</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor aproximado de tributos municipais embutidos no item.</td></tr><tr><td style="width: 28.3671%;">descontoSocioTorcedor</td><td style="width: 23.3611%;">String ("S" ou "N")</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Indica se houve desconto por programa Sócio Torcedor.</td></tr><tr><td style="width: 28.3671%;">descontoPromocaoEspecial</td><td style="width: 23.3611%;">String ("S" ou "N")</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Indica se houve desconto de promoção especial.</td></tr><tr><td style="width: 28.3671%;">pontosDotz</td><td style="width: 23.3611%;">Integer</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Pontos Dotz gerados pelo item, se aplicável.</td></tr><tr><td style="width: 28.3671%;">idPromocao</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Identificador da promoção vinculada ao item.</td></tr><tr><td style="width: 28.3671%;">tipoPromocao</td><td style="width: 23.3611%;">String ("A","S","F","V","D","M","T" ou vazio)</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Tipo da promoção aplicada (A=acréscimo, S=desconto simples, etc).</td></tr><tr><td style="width: 28.3671%;">unidadeMedida</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Unidade de medida do produto (ex: UN, KG, LT).</td></tr><tr><td style="width: 28.3671%;">quantidadeUsadaPromocao</td><td style="width: 23.3611%;">Integer</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Quantidade do item utilizada para compor a promoção.</td></tr><tr><td style="width: 28.3671%;">codigoTabelaPrecosAtacado</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código da tabela de preços de atacado aplicada, quando houver.</td></tr><tr><td style="width: 28.3671%;">descricaoResumida</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Descrição resumida do produto.</td></tr><tr><td style="width: 28.3671%;">fatorConversao</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Fator de conversão de unidade (ex: 1 caixa = 12 unidades).</td></tr><tr><td style="width: 28.3671%;">codigoOperadorLiberacaoDescontoAcrescimoItem</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do operador que autorizou desconto/acréscimo no item.</td></tr><tr><td style="width: 28.3671%;">nomeOperadorLiberacaoDescontoAcrescimoItem</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Nome do operador que liberou o desconto/acréscimo no item.</td></tr><tr><td style="width: 28.3671%;">descontoRateado</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de desconto rateado entre os itens (proveniente de totalização).</td></tr><tr><td style="width: 28.3671%;">acrescimoRateado</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de acréscimo rateado entre os itens.</td></tr><tr><td style="width: 28.3671%;">baseCalculo</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Base de cálculo utilizada para apuração de impostos do item.</td></tr><tr><td style="width: 28.3671%;">valorIcms</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor de ICMS incidente sobre o item.</td></tr><tr><td style="width: 28.3671%;">totalBruto</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Valor bruto do item antes de descontos e tributos.</td></tr><tr><td style="width: 28.3671%;">aliquotaPis</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Alíquota de PIS aplicável ao item.</td></tr><tr><td style="width: 28.3671%;">valorPis</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de PIS calculado para o item.</td></tr><tr><td style="width: 28.3671%;">aliquotaCofins</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Alíquota de COFINS aplicável ao item.</td></tr><tr><td style="width: 28.3671%;">valorCofins</td><td style="width: 23.3611%;">Decimal</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Valor de COFINS calculado para o item.</td></tr><tr><td style="width: 28.3671%;">cfop</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">CFOP (Código Fiscal de Operações e Prestações) do item.</td></tr><tr><td style="width: 28.3671%;">cstPis</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Código de Situação Tributária de PIS.</td></tr><tr><td style="width: 28.3671%;">cstCofins</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Código de Situação Tributária de COFINS.</td></tr><tr><td style="width: 28.3671%;">ncm</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">NCM (Nomenclatura Comum do Mercosul) do produto.</td></tr><tr><td style="width: 28.3671%;">cest</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">CEST (Código Especificador da Substituição Tributária) do produto.</td></tr><tr><td style="width: 28.3671%;">grupoTributacao</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">✅</td><td style="width: 32.0706%;">Grupo de tributação (ex: 00, 20, 40, 60).</td></tr><tr><td style="width: 28.3671%;">codigoMotivoAcrescimoDescontoCancelamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do motivo vinculado a acréscimo/desconto/cancelamento do item.</td></tr><tr><td style="width: 28.3671%;">codigoTipoMotivoAcrescimoDescontoCancelamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Tipo do motivo (classificação do acréscimo/desconto/cancelamento).</td></tr><tr><td style="width: 28.3671%;">descricaoMotivoAcrescimoDescontoCancelamento</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Descrição do motivo vinculado ao acréscimo/desconto/cancelamento.</td></tr><tr><td style="width: 28.3671%;">cpfCnpjClienteMercafacil</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">CPF ou CNPJ do cliente vinculado ao programa Mercafacil.</td></tr><tr><td style="width: 28.3671%;">icmsRetiradoBasePisCofins</td><td style="width: 23.3611%;">String ("S" ou "N")</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Indica se o ICMS foi retirado da base de cálculo de PIS/COFINS.</td></tr><tr><td style="width: 28.3671%;">codigoQuemPesou</td><td style="width: 23.3611%;">String</td><td style="width: 16.2011%;">❌</td><td style="width: 32.0706%;">Código do operador responsável pela pesagem (balança integrada).</td></tr></tbody></table>

##### objeto cashback:  
  


<table id="bkmrk-campo-tipo-obrigat%C3%B3r-4" style="width: 91.9048%;"><thead><tr><th style="width: 23.8651%;">**Campo**</th><th style="width: 8.69001%;">**Tipo**</th><th style="width: 29.9381%;">**Obrigatório**</th><th style="width: 37.5068%;">**Descrição / Observações**</th></tr></thead><tbody><tr><td style="width: 23.8651%;">codigoFormaPagamento</td><td style="width: 8.69001%;">Integer</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Código interno da forma de pagamento utilizada para o cashback.</td></tr><tr><td style="width: 23.8651%;">descricaoFormaPagamento</td><td style="width: 8.69001%;">String</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Descrição textual da forma de pagamento utilizada no cashback.</td></tr><tr><td style="width: 23.8651%;">cpfCliente</td><td style="width: 8.69001%;">String</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">CPF do cliente participante do programa de cashback.</td></tr><tr><td style="width: 23.8651%;">valorTransacao</td><td style="width: 8.69001%;">Decimal</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Valor total da transação de cashback (valor retornado ou gerado).</td></tr><tr><td style="width: 23.8651%;">nsuTransacao</td><td style="width: 8.69001%;">String</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Número sequencial único da transação de cashback.</td></tr><tr><td style="width: 23.8651%;">idTransacao</td><td style="width: 8.69001%;">String</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Identificador único da transação dentro do sistema de cashback.</td></tr><tr><td style="width: 23.8651%;">idPagamento</td><td style="width: 8.69001%;">String</td><td style="width: 29.9381%;">❌</td><td style="width: 37.5068%;">Identificador do pagamento vinculado à operação de cashback.</td></tr></tbody></table>

##### objeto entrega:  
  


<table id="bkmrk-campo-tipo-obrigat%C3%B3r-5" style="width: 100%;"><thead><tr><th style="width: 19.0703%;">Campo</th><th style="width: 16.2098%;">Tipo</th><th style="width: 16.3226%;">Obrigatório</th><th style="width: 48.3973%;">Descrição / Observações</th></tr></thead><tbody><tr><td style="width: 19.0703%;">documentoCliente</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Documento do cliente destinatário da entrega (CPF ou CNPJ).</td></tr><tr><td style="width: 19.0703%;">nomeCliente</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Nome completo do cliente destinatário.</td></tr><tr><td style="width: 19.0703%;">tipoLogradouro</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Tipo de logradouro (ex: Rua, Avenida, Estrada).</td></tr><tr><td style="width: 19.0703%;">logradouro</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Nome da rua ou avenida de entrega.</td></tr><tr><td style="width: 19.0703%;">numeroLogradouro</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Número do endereço de entrega.</td></tr><tr><td style="width: 19.0703%;">complemento</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Complemento do endereço (ex: apartamento, bloco, ponto de referência).</td></tr><tr><td style="width: 19.0703%;">telefone</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Telefone de contato do cliente para entrega.</td></tr><tr><td style="width: 19.0703%;">bairro</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Bairro do endereço de entrega.</td></tr><tr><td style="width: 19.0703%;">cidade</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Nome da cidade do endereço de entrega.</td></tr><tr><td style="width: 19.0703%;">uf</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Unidade Federativa (UF) do endereço de entrega (ex: “MG”).</td></tr><tr><td style="width: 19.0703%;">cep</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Código de Endereçamento Postal (CEP) do endereço de entrega.</td></tr><tr><td style="width: 19.0703%;">referencia</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Ponto de referência adicional para facilitar a entrega.</td></tr><tr><td style="width: 19.0703%;">dataentrega</td><td style="width: 16.2098%;">String (YYYYMMDD)</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Data prevista para entrega.</td></tr><tr><td style="width: 19.0703%;">horaInicial</td><td style="width: 16.2098%;">String (HH:MM:SS)</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Horário inicial previsto para entrega.</td></tr><tr><td style="width: 19.0703%;">horaFinal</td><td style="width: 16.2098%;">String (HH:MM:SS)</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Horário final previsto para entrega.</td></tr><tr><td style="width: 19.0703%;">qtdeCaixas</td><td style="width: 16.2098%;">Integer</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Quantidade de caixas envolvidas na entrega.</td></tr><tr><td style="width: 19.0703%;">observacoesCaixas</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações adicionais sobre as caixas transportadas.</td></tr><tr><td style="width: 19.0703%;">qtdeEngradados</td><td style="width: 16.2098%;">Integer</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Quantidade de engradados incluídos na entrega.</td></tr><tr><td style="width: 19.0703%;">observacoesEngradados</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações adicionais sobre os engradados transportados.</td></tr><tr><td style="width: 19.0703%;">qtdevasilhames</td><td style="width: 16.2098%;">Integer</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Quantidade de vasilhames entregues.</td></tr><tr><td style="width: 19.0703%;">observacoesVasilhames</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações sobre os vasilhames.</td></tr><tr><td style="width: 19.0703%;">qtdeFrios</td><td style="width: 16.2098%;">Integer</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Quantidade de produtos frios incluídos na entrega.</td></tr><tr><td style="width: 19.0703%;">observacoesFrios</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações relacionadas aos produtos frios.</td></tr><tr><td style="width: 19.0703%;">qtdeCongelados</td><td style="width: 16.2098%;">Integer</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Quantidade de produtos congelados incluídos na entrega.</td></tr><tr><td style="width: 19.0703%;">observacoesCongelados</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações sobre os produtos congelados.</td></tr><tr><td style="width: 19.0703%;">buscarDeposito</td><td style="width: 16.2098%;">String ("S" ou "N")</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Indica se a mercadoria deve ser buscada no depósito antes da entrega.</td></tr><tr><td style="width: 19.0703%;">observacoesDeposito</td><td style="width: 16.2098%;">String</td><td style="width: 16.3226%;">❌</td><td style="width: 48.3973%;">Observações gerais sobre o depósito, retirada ou logística da entrega.</td></tr></tbody></table>