# Models ## The NotaDevolucaoPut object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"NotaDevolucaoPut":{"required":["codParametro","codRepresentante","cpfCnpjCliente","dataEmissao","dataEntrada","ipiBaseICMS","motivoDev","numeroDocumento","serieFiscal","tipoDocumento"],"type":"object","properties":{"numeroDocumento":{"maximum":999999999,"type":"integer","description":"Número do Documento"},"serieFiscal":{"maximum":9999,"type":"integer","description":"Código da Série Fiscal"},"cpfCnpjCliente":{"maxLength":14,"minLength":11,"type":"string","description":"Código do CPF/CNPJ do Cliente"},"codParametro":{"maximum":99,"type":"integer","description":"Código do Parâmetro de Devolução"},"dataEntrada":{"type":"string","description":"Data da Entrada da Nota (YYYY-MM-DD)","format":"date"},"dataEmissao":{"type":"string","description":"Data de Emissão da Nota (YYYY-MM-DD)","format":"date"},"motivoDev":{"maximum":9999,"type":"integer","description":"Motivo da Devolução"},"codRepresentante":{"type":"integer","description":"Código do Representante"},"codAtendente":{"type":"integer","description":"Código da Atendente"},"tipoDocumento":{"type":"integer","description":"Tipo de Documento"},"chaveNFe":{"maxLength":44,"type":"string","description":"Chave Nf-e"},"estruturaComercial":{"maxLength":35,"type":"string","description":"Estrutura Comercial"},"ipiBaseICMS":{"type":"integer","description":"IPI Soma na Base do ICMS (0 - Não, 1 - Sim)","enum":[0,1]},"observacao":{"maxLength":100,"type":"string","description":"Observação"},"valorTotal":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Total"},"valorFrete":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Frete"},"valorSeguro":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Seguro"},"valorOutrasDesp":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Outras Despesas"},"descontoEspecial":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Especial"},"descontoZonaFranca":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Desconto Zona Franca"},"valorISS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Iss"},"valorDescontoDuplicata":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Desconto Duplicata"},"valorPISRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Pis Retido"},"valorCOFINSRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Cofins Retido"},"valorCSLLRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Csll Retido"},"valorIRRetido":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor ir Retido"},"dataVencimento":{"type":"string","description":"Data de Vencimento (YYYY-MM-DD)","format":"date"},"documento":{"maxLength":10,"type":"string","description":"Documento"},"historico":{"maxLength":100,"type":"string","description":"Histórico"},"notasDevolvidas":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/NotasDevolvidas"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidas":{"required":["dataEmissaoNotaDevolvida","numeroNotaDevolvida"],"type":"object","properties":{"numeroNotaDevolvida":{"maxLength":20,"type":"string","description":"Número da Nota Devolvida"},"dataEmissaoNotaDevolvida":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"}}},"ItensDevolucao":{"required":["cfop","codProduto","cstCOFINS","cstICMS","cstIPI","cstPIS","motivoDevItem","precoUnitario","quantidade"],"type":"object","properties":{"codProduto":{"maxLength":20,"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"maximum":999999.999,"type":"number","description":"Quantidade de Produtos"},"precoUnitario":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Preço Unitário do Produto"},"valorTotal":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total"},"cfop":{"maxLength":5,"type":"string","description":"Código da CFOP"},"motivoDevItem":{"maximum":9999,"type":"integer","description":"Motivo Devolução do Item"},"parametroItem":{"maxLength":2,"type":"string","description":"Parâmetro Devolução Item"},"codFinalidadeProd":{"maxLength":6,"type":"string","description":"Código da Finalidade do Produto"},"percentualComisRep":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante"},"valorComisRep":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Representante"},"percentualComisAtend":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual da Comissão do Atendente"},"valorComisAtend":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Atendente"},"cstICMS":{"maxLength":3,"type":"string","description":"Código de Situação Tributária ICMS (CST ICMS)"},"baseICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base do ICMS"},"aliquotaICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do ICMS"},"ICMSIsentas":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Isentas ou Não Tributárias"},"ICMSOutras":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Outras"},"fcpICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP ICMS"},"difalRemetente":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Remetente"},"difalDestinatario":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Destinatário"},"FCPDifal":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP Difal"},"baseST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base da Substituição Tributária"},"valorST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Substituição Tributária"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota Substituição Tributária"},"valorFcpST":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Fcp Retido Por Substituição Tributária"},"situacaoST":{"type":"integer","description":"Tipo de Substituição Tributária do ICMS (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"cstIPI":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - IPI"},"baseIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do IPI"},"valorIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor IPI"},"IPIIsentas":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Isentas"},"IPIOutras":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Outras"},"cstPIS":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - PIS"},"basePIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base PIS"},"aliquotaPIS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS"},"valorPIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do PIS"},"tipoBasePIS":{"type":"integer","description":"Tipo de Base de Crédito do Pis (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"cstCOFINS":{"maxLength":3,"type":"string","description":"Código da Situação Tributária COFINS"},"baseCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base COFINS"},"aliquotaCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota do COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do COFINS"},"tipoBaseCOFINS":{"type":"integer","description":"Tipo de Base de Crédito do Cofins (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"cClassTribIS":{"type":"string","maxLength":6,"description":"cClassTrib do IS"},"cstIS":{"type":"string","maxLength":3,"description":"CST do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The ItensDevolucao object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"ItensDevolucao":{"required":["cfop","codProduto","cstCOFINS","cstICMS","cstIPI","cstPIS","motivoDevItem","precoUnitario","quantidade"],"type":"object","properties":{"codProduto":{"maxLength":20,"type":"string","description":"Código do Produto"},"quantidade":{"multipleOf":0.001,"maximum":999999.999,"type":"number","description":"Quantidade de Produtos"},"precoUnitario":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Preço Unitário do Produto"},"valorTotal":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor Total"},"cfop":{"maxLength":5,"type":"string","description":"Código da CFOP"},"motivoDevItem":{"maximum":9999,"type":"integer","description":"Motivo Devolução do Item"},"parametroItem":{"maxLength":2,"type":"string","description":"Parâmetro Devolução Item"},"codFinalidadeProd":{"maxLength":6,"type":"string","description":"Código da Finalidade do Produto"},"percentualComisRep":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual de Comissão do Representante"},"valorComisRep":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Representante"},"percentualComisAtend":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Percentual da Comissão do Atendente"},"valorComisAtend":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor da Comissão do Atendente"},"cstICMS":{"maxLength":3,"type":"string","description":"Código de Situação Tributária ICMS (CST ICMS)"},"baseICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base do ICMS"},"aliquotaICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do ICMS"},"valorICMS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do ICMS"},"ICMSIsentas":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Isentas ou Não Tributárias"},"ICMSOutras":{"multipleOf":0.01,"maximum":999999999999.99,"type":"number","description":"ICMS Outras"},"fcpICMS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP ICMS"},"difalRemetente":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Remetente"},"difalDestinatario":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Difal Destinatário"},"FCPDifal":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"FCP Difal"},"baseST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Base da Substituição Tributária"},"valorST":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor Substituição Tributária"},"aliquotaST":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota Substituição Tributária"},"valorFcpST":{"multipleOf":0.01,"maximum":99999999999.99,"type":"number","description":"Valor do Fcp Retido Por Substituição Tributária"},"situacaoST":{"type":"integer","description":"Tipo de Substituição Tributária do ICMS (0 - Não Possui, 1 - Com Crédito, 2 - Sem Crédito)","enum":[0,1,2]},"cstIPI":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - IPI"},"baseIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base IPI"},"aliquotaIPI":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota do IPI"},"valorIPI":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor IPI"},"IPIIsentas":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Isentas"},"IPIOutras":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"IPI Outras"},"cstPIS":{"maxLength":2,"type":"string","description":"Código da Situação Tributária - PIS"},"basePIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base PIS"},"aliquotaPIS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Alíquota PIS"},"valorPIS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do PIS"},"tipoBasePIS":{"type":"integer","description":"Tipo de Base de Crédito do Pis (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"cstCOFINS":{"maxLength":3,"type":"string","description":"Código da Situação Tributária COFINS"},"baseCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Base COFINS"},"aliquotaCOFINS":{"multipleOf":0.01,"maximum":99.99,"type":"number","description":"Aliquota do COFINS"},"valorCOFINS":{"multipleOf":0.01,"maximum":9999999999.99,"type":"number","description":"Valor do COFINS"},"tipoBaseCOFINS":{"type":"integer","description":"Tipo de Base de Crédito do Cofins (01 - Aquisição bens para revenda, 02 - Aquisição bens util. insumo, 03 - Aquisição serviços util. insumo, 04 - Energia elétrica e térmica, 05 - Aluguéis de prédios, 06 - Aluguéis de máquinas/equipamentos, 07 - Armaz. mercad./frete oper. venda, 08 - Contraprest. arrend. mercantil, 09 - Imobilizado (créd. depreciação), 10 - Imobilizado (créd. aquisição), 11 - Amort./Depreciação imóveis, 12 - Devol. Vendas Incid. Não-Cumulativa, 13 - Outras Oper. com Direito Crédito, 14 - Transporte Cargas, 15 - Subcontratação, 16 - Imobiliária, 17 - Custo Incorrido por unidade, 18 - Imobiliária)","enum":["01","02","03","04","05","06","07","08","09",10,11,12,13,14,15,16,17,18]},"valorBaseIBSCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base do IBS/CBS"},"aliquotaIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Estadual"},"valorIBSEstadual":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Estadual"},"aliquotaIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IBS Municipal"},"valorIBSMunicipal":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IBS Municipal"},"aliquotaCBS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do CBS"},"valorCBS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do CBS"},"cClassTribIBSCBS":{"type":"string","maxLength":6,"description":"cClassTrib do IBS/CBS"},"cstIBSCBS":{"type":"string","maxLength":3,"description":"CST do IBS/CBS"},"valorBaseIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Base Cálculo do IS"},"aliquotaIS":{"type":"number","multipleOf":0.01,"maximum":99.99,"description":"Alíquota do IS"},"valorIS":{"type":"number","multipleOf":0.01,"maximum":9999999999.99,"description":"Valor do IS"},"cClassTribIS":{"type":"string","maxLength":6,"description":"cClassTrib do IS"},"cstIS":{"type":"string","maxLength":3,"description":"CST do IS"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The NotasDevolvidas object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"NotasDevolvidas":{"required":["dataEmissaoNotaDevolvida","numeroNotaDevolvida"],"type":"object","properties":{"numeroNotaDevolvida":{"maxLength":20,"type":"string","description":"Número da Nota Devolvida"},"dataEmissaoNotaDevolvida":{"type":"string","description":"Data de Entrada (YYYY-MM-DD)","format":"date"}}}}}} ``` ## The DadosCustomizados object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}}} ``` ## The Erro object ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"2.0"},"components":{"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/comercial-v2.0/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.