Devolução de Venda - NFC-e

Informações Gerais

Para realizar o cancelamento de uma venda acobertada por NFC-e após 30 minutos, é necessário emitir uma nota de devolução. A devolução irá gerar uma nota de modelo 55 (NF-e) e, devido ao fato deste documento possuir características distintas da NFC-e, criamos a rota de devolução de venda, para otimizar o processo de devolução.   

Autenticação

Para utilizar a rota de devolução de venda NFC-e é necessário realizar autenticação, conforme detalhado na documentação de Autenticação do Emissor

---

API Devolução de Venda

• Endpoint: /Middleware/Sale/Return
• Método: POST
• Header:
  • Authorization: Token de autorização
  • Content-Type: application/json 

Dados dos parâmetros de envio:

Campo	Descrição	Obrigatório	Grupo e Tag do XML que irá alimentar
Id	Id único da venda. Não poderá se repetir. Recomendado utilizar um GUID	Sim	-
SaleId	ID gerado no momento da venda	Sim	-
Cnpj	CNPJ do emissor	Sim	-
NumeroSerie	Número de série do documento fiscal. Recomendado um por PDV	Sim	serie
tpDANFE	Tipo de Danfe a ser retornado 1 - Retrato 5 - Simplificado  6 - Simplificado SC 7 - Etiqueta 8 - Paisagem	Sim	-
indIntermed	Indicador de intermediador/marketplace 0=Operação sem intermediador (em site ou plataforma  própria)  1=Operação em site ou plataforma de terceiros  (intermediadores/marketplace)	Não	indIntermed
dest	Grupo de informações do destinatário	Sim	-
dest.xNome	Nome do destinatário	Sim	xNome
dest.TIPOIDCONS	Tipo de consumidor	Sim
dest.IDCONS	Identificação do consumidor (CNPJ, CPF ou ID Estrangeiro)	Sim	CNPJ ou CPF ou idEstrangeiro
dest.enderDest	Informação do endereço	Sim	-
enderDest.xLgr	Logradouro	Sim	xLgr
enderDest.nro	Número	Sim	nro
enderDest.xCpl	Complemento	Não	xCpl
enderDest.xBairro	Bairro	Sim	xBairro
enderDest.cMun	Código IBGE do município	Sim	cMun
enderDest.CEP	CEP	Não	CEP
enderDest.fone	Telefone	Não	fone
Items	Array de itens a serem desenvolvidos	Sim	-
Items.cProd	Código do produto informado na venda	Sim	cProd
Items.qCom	Quantidade a ser devolvida	Sim	qCom
Items.qTrib	Quantidade tributada a ser devolvida	Não	qTrib

---

Exemplo Payload de Envio

{
  "Id": "90ba0336-0b84-4bcd-a8ea-ae54a16be6cc",
  "NumeroSerie": "1",
  "SaleId": "00ba0000-0b84-4bcd-a8ea-ae54a16be6cc ",
  "Cnpj": "99999999999999",
  "tpDANFE": 1,
  "indIntermed": 0,
  "infCpl": "Observações",
  "dest": {
    "xNome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL",
    "TIPOIDCONS": "1",
    "IDCONS": "99999999999",
    "enderDest": {
      "xLgr": "Rua Olavo Barreto Viana",
      "nro": "63",
      "xCpl": "",
      "xBairro": "Pinheiros",
      "cMun": 4314902,
      "CEP": "05425-902",
      "fone": "+55 (11) 000-0000"
     }
   },
   "Items": [
    {
     "cProd": "1",
     "qCom": 1,
     "qTrib": 1
    }
  ]
}

---

O retorno da API poderá ser o documento autorizado ou a rejeição do documento.

Segue o detalhamento dos parâmetros retornados:

Tag	Descrição
chNFe	Chave da nota fiscal
cStat	Status vinculado ao documento. Os possíveis status serão detalhados em tópico específico.
xMotivo	Descrição do status do documento
danfe	DANFE em PNG. Deverá decodificar de Base64
nNF	Número do documento fiscal
xUrlDanfe	URL de consulta do documento fiscal na Sefaz

---

Exemplo Payload de Retorno

{
 "chNFe": "43241050354031000119650020000001241662936290",
 "cStat": "100",
 "danfe": "Base64",
 "nNF": 124,
 "xMotivo": "Autorizado o uso da NF-e",
"xUrlDanfe":null
}

---

Detalhamento campo cStat

Neste campo poderão haver retornos de status da SEFAZ e da Solução Fiscal, conforme segue

Retornos da SEFAZ

• Autorização:
  • 100 – Autorizado
• Rejeições:
  • Consultar todos os códigos de rejeição vinculados a emissão de documento no manual de orientação ao contribuinte (MOC – Anexo I) disponível no item “4.4.2. Tabela de Códigos de Rejeição”

Retornos da Solução Fiscal

• Rejeições

Retorno	Como Resolver
M0001 - O CNPJ não está cadastro para emissão.	Necessário cadastrar o CNPJ emissor na Solução Fiscal (Cadastro Emissor/Empresa). Após cadastrar o Emissor e gerar chave para ele autenticar, basta realizar a devolução novamente.
M0002 - O CNPJ está inativo para emissão.	Necessário vincular produto de emissão de NF-e no cadastro do CNPJ emissor na Solução Fiscal. Campos Produto e Produtos ID. (Cadastro Emissor/Empresa). Após realizar este ajuste, basta realizar a venda novamente.
M0003 - Não existe um certificado cadastrado para o CNPJ.	Necessário realizar upload de Certificado Digital para o CNPJ Emissor, conforme descrito na documentação Gestão Certificado Digital. Após enviar o Certificado basta realizar a devolução novamente.
M0004 - O certificado está inativo para este CNPJ.	Isso significa que o certificado vinculado ao CNPJ emissor foi revogado ou venceu. Para resolver é necessário que o Certificado Digital seja substituído e enviado para Solução Fiscal. Após substituir o Certificado basta realizar a venda novamente.
M0013 - Nota já autorizada com data de emissão.	A nota referente a esta venda já foi emitida. Para obter o documento emitido basta acionar a API de Consulta (Consulta Venda - NFC-e)

---

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviadas, causando falha na Solução Fiscal ou rejeição pela Sefaz
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable