API : domain_product_nfe_query_for_file_list
PRODUTO: NFS-e

Funcionalidade: A Dokfile, através de uma data e de um Sub-tipo(entrada ou saída) passada como argumento, busca todas as NF-es armazenadas e retorna uma lista em que, para cada item desta lista, existem 4 campos com informações da nota.

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.

Data

Neste parâmetro é escolhido uma data para referência na busca dos arquivos.

Sub-tipo

Neste parâmetro deve ser definido um sub-tipo de arquivo, que pode ser entrada ou saída.


Exemplo e Estrutura de uma chamada:

Método: 

URL: https://Base/domain_product_nfe_query_for_file_list?access-key=SEUTOKEN&find=inPut:d:28:m:03:y:2018

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

API: /domain_product_nfe_query_for_file_list

Token: ?access-key=SEUTOKEN

Sub-tipo: &find=in ( in = entrada; out = saída; )

Data: Put:d:28:m:03:y:2018 ( d = dia; m = mês; y = ano; )


Exemplo de Retorno


<?xml version="1.0" encoding="UTF-8"?>
    <QueryForFileListResult>
        <rid>09ae97bd-b501-4bc9-a79c-3dd2d8c68684</rid>
        <CountFile>2</CountFile>
        <Error>
            <Code>0</Code>
            <Message>Success!</Message>
        </Error>
        <Nfe>
            <NfeKey>35180303476811034722550010000027081396952565</NfeKey>
            <xNome>DIA BRASIL SOCIEDADE LTDA.</xNome>
            <CNPJ>03476811034722</CNPJ>
            <nNF>2708</nNF>
            <OnCloud>true</OnCloud>
        </Nfe>
        <Nfe>
            <NfeKey>35180303476811034722550010000027091461871819</NfeKey>
            <xNome>DIA BRASIL SOCIEDADE LTDA.</xNome>
            <CNPJ>03476811034722</CNPJ>
            <nNF>2709</nNF>
            <OnCloud>true</OnCloud>
        </Nfe>
    </QueryForFileListResult>

Onde:

QueryForFileListResult
tag pai que englobará toda a resposta;

rid
id do retorno obtido;

CountFile
Quantidade de NF-es retornadas;

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;
  • xNome: Nome empresarial;
  • CNPJ: CNPJ da empresa;
  • nNF: Número do documento;
  • OnCLoud: sempre será true;

Performance nas buscas

Esta API tem por finalidade lhe trazer as informações mais cruciais para que o seu sistema possa, de forma mais otimizada, buscar as notas necessárias através da API domain_product_nfe_query_for_file, lhe oferecendo a chance de customizar ainda mais a sua gestão fiscal.

Deixe uma resposta

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