Histórico da Página

...

Disponibilizar um endpoint na ChefWebAPI para que seja possível consultar notas fiscais de entrada.

03. SOLUÇÃO

...

Foi criado um endpoint na ChefWebAPI para que seja possível realizar a consulta de notas fiscais de entrada, conforme especificações abaixo:

03.01. AUTENTICAÇÃO NA API

Geração Token

Para realizar qualquer acesso às consultas disponibilizadas é necessário solicitar um Token de autenticação, através da API "Gerar Token".

Nessa chamada devem ser informados o usuário, a senha e o número de série do cliente que deseja consultar.

O método retornará Token de acesso, com duração de 2 minutos.

Este Token será composto de um código aleatório, do tipo string (Exemplo: ZQGL16Q3D43mhSi8nw8s3j2HhZPQ9Ei6), que deverá ser utilizado em uma chamada da API.

Não é possível reutilizar o Token de autenticação, sendo assim para cada chamada, dos métodos da API, deverá ser solicitado um novo.

Caso o Token gerado não seja utilizado em até 2 minutos ele estará automaticamente cancelado. 

URL do Serviço: POST:http://{url_do_servidor}/api/Token/GerarToken

Request

"Usuario": Usuário utilizado para acessar o ambiente no ChefWeb

“Senha”: Senha utilizada do usuário para acessar o ChefWeb

"NumeroSerialLoja": Informar o Diretório Site do ambiente que deseja realizar o cadastro

"Chave": Manter Padrão "Chave"

Response

O serviço retorna um JSON no formato abaixo:
1- Válido

03.02. REQUISIÇÃO PARA CONSUTAR NOTAS FISCAIS DE ENTRADA

Endpoint: (GET)  http://{url_do_servidor}/chefwebapi/api/fiscal/ListNotasFiscaisEntrada

Request

A requisição deve ser preenchida obedecendo os seguintes critérios:

Token: Token de autenticação - Obrigatório - gerado no item 03.01 deste documento.

DiretorioSite: Número serial de identificação da base da loja - Obrigatório.

DataInicial:   Data inicial do período para consulta. 

DataFinal: Data final do período para consulta. 

TipoData: Parâmetro que irá determinar o tipo de data a ser considerado na consulta, para filtrar por data de entrada deve ser informado 0 (zero), para filtrar por data de lançamento 1 (um).

Payload Request (exemplo):

{
            "Token": "36099857-20d3-454d-96e0-51cec596b1fb",
            "CodigoLoja": "3",            
            "DataInicial": "2019-04-25T00:00:00",
            "DataFinal": "2019-04-25T23:59:59" ,
            "TipoData":0
}

Validações:

• O período permitido para consulta é de 31 dias,
• não é possível filtrar períodos somente anteriores a implementação desta funcionalidade (20/07/2022)

Payload Response (exemplo):

"NotasFicaisEntrada": [
        {
            "Id": "8a1bda3c-656b-4ee3-b7d3-2bd275cf5ecd",
            "NumeroNota": "12146",
            "Serie": "1",
            "ChaveDeAcesso": "50190123456789123245555211225544411122",
            "DtLancamento": "2019-04-17T04:00:00",
            "DtEntrada": "2019-04-25T14:59:00",
            "Exclusao": false,
            "XMLNota": "<nfeProc versao=\"4.00\"><NFe><infNFe Id=\"NF123456789123245555211225544411122\" versao=\"4.00\"> (CONTEUDO DO XML ...)</protNFe></nfeProc>"
        }
    ],
    "Sucesso": true,
    "Erros": []
}

04. DEMAIS INFORMAÇÕES

Não se aplica

...