API : domain_product_nfse_query_for_file
PRODUTO: NF-e

Funcionalidade: A Dokfile, através da chave de acesso do arquivo fiscal passada como argumento, busca uma NF-e armazenada e retorna um resultado, sendo este resultado algumas breves informações ou o próprio XML completo.

Método: GET

Retorno: XML


Parâmetros

Token

Neste parâmetro deve ser passado a sua chave de acesso para autenticar o uso da API.

Chave de acesso

Neste parâmetro deve ser passado a Chave de acesso referente ao arquivo desejado.

Retorno de arquivo

Com este parâmetro é definido se o retorno irá ter o XML completo do arquivo, caso não tenha será retornado algumas informações básicas.

Consulta na SEFAZ

Neste parâmetro é informado para o sistema buscar informações referentes ao status da nota diretamente na SEFAZ.


Exemplo e Estrutura de uma chamada:

Método: 

URL: https://Base/domain_product_nfe_query_for_file?access-key=SEUTOKEN&nfe-key=CHAVEDOARQUIVO&return-full-file=false&gov-check=true

Base: Domínio da api (entre em contato para receber o domínio)

API: /domain_product_nfe_query_for_file

Token: ?access-key=SEUTOKEN

Chave de acesso: &nfe-key=CHAVEDOARQUIVO

Retorno do arquivo: &return-full-file=false (true ou false)

Consulta SEFAZ: &gov-check=true ( true ou false )


Exemplo de Retorno

OBS: Por motivo de praticidade, o exemplo não será da busca de XML completo.


<?xml version="1.0" encoding="UTF-8"?>
    <QueryForFileResult>
        <rid>fbe28c85-0520-48ea-bf7a-7156d79ca983</rid>
        <Error>
            <Code>0</Code>
            <Message>Success!</Message>
        </Error>
        <Nfe>
            <NfeKey>35180303476811034722550010000027081396952565</NfeKey>
            <Exist>true</Exist>
            <OnCloud>true</OnCloud>
            <CdP>PENDENTE</CdP>
            <Gov>
                <cStat>100</cStat>
                <xMotivo>Autorizado o uso da NF-e</xMotivo>
                <DateOfCheck>2018-03-28 21:00:09</DateOfCheck>
                <From>1</From>
                <FromStatus>Success!</FromStatus>
                <manifestCode>210200</manifestCode>
            </Gov>
        </Nfe>
    </QueryForFileResult>

Onde:

QueryForFileListResult
tag pai que englobará toda a resposta;

rid
id do retorno obtido;

Error
Status de erro do arquivo

  • Code -> Código do erro
    • 101: Key to Access(access-key) does not exist -> Chave passada não existe;
    • 102: Required parameter (access-key) not supplied -> Chave não fornecida;
    • 103: Composed parameter find is bad formed -> Falha nos parâmetro passados;
    • 0: Success -> Sucesso na requisição;
  • Message: Mensagem de retorno da API;

Nfe
tag pai da NF-e onde terá as informações do arquivo

  • NfeKey: Chave de acesso da Nota Fiscal;
  • Exist: Arquivo está ou não armazenado;
  • OnCLoud: sempre será true;
  • CdP: Status do Controle de Portaria para a Nota buscada;
  • Gov: Tag pai para o resultado do status da nota na SEFAZ
    • cStat: Código do status;
    • xMotivo: Descrição do status de operação da nota na SEFAZ;
    • DateOfCheck: Data que foi registrado a ciência da operação da nota na SEFAZ;
    • From: Indica “2” quando houve consulta no SEFAZ e “1” quando não houve;
    • FromStatus: Descrição do Código do Status;
    • manifestCode: Código de Manifesto do arquivo;

Performance nas buscas

Esta API tem por finalidade lhe trazer as informações de uma NF-e específica, funcionando muito bem quando chamada através dos dados obtidos pela API domain_product_nfe_query_for_file! Permite ainda haver uma consulta personalizada para o seu ERP, já que, através do parâmetro return-full-file é possível buscar o XML Completo da nota ou apenas conferir algumas informações.

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *