TransmiteNota Documentação API

Função ConsultarCartaCorrecaoNfe ( )

Abaixo seguem os parâmetros necessários para a consulta da carta de correção da NF-e.

POST/ConsultarCartaCorrecaoNfe/

Campo Tipo Obrigatório Descrição
searchkey Texto Sim Código gerado pela API ao enviar a Carta de Correção

										

Exemplo de JSon

{
   "ApiKey":"xxxapikeyhashxxx",
   "Cnpj":"00.000.000/0000-00",
   "Dados":{  
      "searchkey":"xxxhashkeyxxx"
   }
}

Retornos e Erros

Todos os códigos de erros com os três primeiros dígitos sendo 160 são associados a função: ConsultarCartaCorrecaoNfe

Código Campo Mensagem de retorno
1601 searchkey - É preciso informar a Searckey da nota fiscal para consulta
- Não foi localizada nenhuma nota através da Searchkey informada
1602 Retorno com erro
1603 Retorno com sucesso

Retornos de JSON

Retorno com erro de parametros
{
    "Status": "Erro",
    "codigo": "codigo_erro",
    "campo": "campo_com_erro",
    "descricao": "descricao_erro"
}

Retorno com erro
{
    "status": "Erro",
    "codigo": "1602",
    "descricao": "Esta nota encontra-se com o status: status_nfe, por isto não é possível enviar a solicitação de cancelamento"
}

Retorno com sucesso
Se a Nota Fiscal não estiver com status de:
APROVADA, APROVADA COM CORRECAO ou CANCELADA
{
    "status": "OK",
    "codigo": "1603",
    "descricao": "Consulta realizada com sucesso!",
    "resultado": {
        "status": "status_nfe",
        "numero": "numero_nfe",
        "serie": "serie_nfe",
        "destinatario": "nome_destinatario_nfe"
    }
}

Retorno com sucesso
Se a Nota Fiscal não estiver com status de:
APROVADA, APROVADA COM CORRECAO ou CANCELADA
{
    "status": "OK",
    "codigo": "1603",
    "descricao": "Consulta realizada com sucesso!",
    "resultado": {
        "status": "status_nfe",
        "numero": "numero_nfe",
        "serie": "serie_nfe",
        "destinatario": "nome_destinatario_nfe",
        "link_pdf": "link_pdf_nfe",
        "link_xml": "link_xml_nfe"
    }
}