# Devolução Nota Fiscal devolucaoNota ## GET /devolucaoNota > Obter Listagem de Devolução de Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Devolução Nota Fiscal","description":"devolucaoNota"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ListaNotasDevolucao":{"type":"object","properties":{"continuationToken":{"type":"string"},"notasDevolucao":{"type":"array","description":"Notas de Devolução","items":{"$ref":"#/components/schemas/NotaDevolucao"}}}},"NotaDevolucao":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"notasDevolvidas":{"type":"array","description":"Notas Fiscais Devolvidas","items":{"$ref":"#/components/schemas/NotasDevolvidasDev"}},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucaoGet"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"NotasDevolvidasDev":{"type":"object","properties":{"dataNotaDev":{"type":"string","description":"Data da Nota Fiscal Devolvida"},"codNotaDev":{"type":"integer","description":"Código da Nota Fical Devolvida"}}},"ItensDevolucaoGet":{"type":"object","properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/devolucaoNota":{"get":{"summary":"Obter Listagem de Devolução de Nota Fiscal","operationId":"ObterListaDevolucaoNotaFiscal","tags":["Devolução Nota Fiscal"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaNotasDevolucao"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"type":"integer"}},{"name":"dataInicio","in":"query","description":"Data de Emissão da Devolução Início (YYYY-MM-DD)","required":false,"schema":{"type":"string","nullable":true}},{"name":"dataFim","in":"query","description":"Data de Emissão da Devolução Término (YYYY-MM-DD)","required":false,"schema":{"type":"string","nullable":true}},{"name":"clientes","in":"query","required":false,"description":"Lista de Códigos de Clientes","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"motivosDevolucao","in":"query","required":false,"description":"Lista de Códigos de Motivos de Devolução","schema":{"type":"array","nullable":true,"items":{"type":"string"}}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","required":false,"schema":{"type":"string","nullable":true}}]}}}} ``` ## PUT /devolucaoNota > Devolução Nota Fiscal ```json {"openapi":"3.0.1","info":{"title":"Comercial","version":"1.0"},"tags":[{"name":"Devolução Nota Fiscal","description":"devolucaoNota"}],"servers":[{"url":"https://localhost/comercial/v10"},{"url":"http://localhost/comercial/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}},"NotaDevolucaoPut":{"type":"object","required":["numeroDocumento","dataEntrada","CNPJCPFCliente"],"properties":{"numeroDocumento":{"type":"integer","maximum":999999999,"description":"Número do Documento"},"dataEntrada":{"type":"string","format":"date","description":"Data de Entrada (YYYY-MM-DD)"},"CNPJCPFCliente":{"type":"string","minLength":11,"maxLength":14,"description":"Código do CPF/CNPJ do Cliente"},"chaveNFeNFCe":{"type":"string","description":"Chave de Acesso NF-e/NFC-e","minLength":44},"serieFiscal":{"type":"integer","maximum":999,"description":"Código da Série Fiscal"},"parametroDevolucao":{"type":"integer","maximum":999,"description":"Código do Parâmetro da Devolução"},"motivoDevolucao":{"type":"integer","minimum":1,"maximum":99,"description":"Código do Motivo da Devolução"},"itensDevolucao":{"type":"array","description":"Itens da Devolução","items":{"$ref":"#/components/schemas/ItensDevolucao"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ItensDevolucao":{"type":"object","required":["numeroDocumento","codProduto","quantidade"],"properties":{"sequenciaItem":{"type":"integer","maximum":999,"description":"Sequência do Item da Devolução"},"codProduto":{"type":"string","description":"Código do Produto (Reduzido do item)"},"quantidade":{"type":"number","maximum":999999999.999,"multipleOf":0.01,"description":"Quantidade a ser Devolvida"},"precoUnitarioLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Preço Unitário Liquido"},"vlrTotalLiquido":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Total Líquido"},"vlrDesconto":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do Desconto"},"cfop":{"type":"integer","minimum":1,"maximum":9999,"description":"Código da CFOP"},"baseICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do ICMS"},"aliquotaICMS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do ICMS"},"vlrICMS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS"},"vlrICMSIsenta":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Isenta"},"vlrICMSOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do ICMS Outras"},"cstICMS":{"type":"string","maxLength":3,"description":"Código da Situação Tributária - ICMS"},"baseIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do IPI"},"aliquotaIPI":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do IPI"},"vlrIPI":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI"},"vlrIPIIsentas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Isentas"},"vlrIPIOutras":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do IPI Outras"},"cstIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - IPI"},"cstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - PIS"},"basePIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base do PIS"},"aliquotaPIS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota do PIS"},"vlrPIS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor do PIS"},"cstCofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária - COFINS"},"baseCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base de COFINS"},"aliquotaCOFINS":{"type":"number","maximum":99.99,"multipleOf":0.01,"description":"Alíquota de COFINS"},"vlrCOFINS":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de COFINS"},"vlrDIFALRemetente":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALDestinario":{"type":"number","maximum":999999999.99,"multipleOf":0.01},"vlrDIFALFCP":{"type":"number","description":"Valor DIFAL FCP","maximum":999999999.99,"multipleOf":0.01},"vlrFrete":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor de Frete"},"baseST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Base ICMS Substituição Tributária"},"vlrST":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor ICMS Substituição Tributária"},"outrasDespesas":{"type":"number","maximum":999999999.99,"multipleOf":0.01,"description":"Valor Outras Despesas"},"dataEmissaoNotaDevolvida":{"type":"string","format":"date","description":"Data de Emissão da Nota Devolvida (YYYY-MM-DD)"},"numeroNotaDevolvida":{"type":"string","maxLength":20,"description":"Número da Nota Devolvida"},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"type":"object","required":["campo","valor"],"properties":{"campo":{"type":"string"},"valor":{"type":"string"}}}}},"paths":{"/devolucaoNota":{"put":{"summary":"Devolução Nota Fiscal","operationId":"DevolucaoNotaFiscal","deprecated":true,"tags":["Devolução Nota Fiscal"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}},"parameters":[{"name":"empresa","in":"header","description":"Empresa para Importação da Devolução","required":true,"schema":{"type":"integer","minimum":1,"maximum":99999}}],"requestBody":{"description":"Nota Fiscal","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaDevolucaoPut"}}}}}}}} ``` --- # 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-v1.0/devolucao-nota-fiscal.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.