Passar para o conteúdo principal

API EVO – Exportar para Excel

Escrito por Cecilia Marin

Com base na necessidade de algumas empresas de exportar os dados em massa do EVO, de todas as unidades, desenvolvemos algumas funcionalidades novas em nossa API que possibilitam baixar um arquivo XLS diretamente do navegador.

Procuramos disponibilizar o máximo de informações no arquivo para utilizarem da maneira mais adequada.

Funcionamento

Para baixar o arquivo com os dados desejados, basta copiar a URL (endereço) informada aqui, colar no seu navegador (Chrome é o indicado), alterar os parâmetros (quando necessário) e apertar a tecla ENTER para iniciar o processo.

O navegador solicitará uma autenticação. Neste momento, coloque o DNS e a chave

secreta encontrada no seu EVO, em Configurações - Integrações – API EVO. Caso queira acessar os dados de todas as unidades ao mesmo tempo, utilize a chave que está no seu módulo Administração Geral.

Ao fazer isso, o navegador salva esses dados e não pedirá mais nas próximas consultas. Caso utilize um computador compartilhado para baixar os arquivos, recomendamos que utilize uma janela anônima. Desta forma, o navegador NÃO salvará a autenticação.

Feito isso, o arquivo começará a ser baixado automaticamente.

1 – Dados de clientes

Para este arquivo, não será necessário informar nenhum parâmetro. A API irá sempre retornar todos os clientes ativos, suspensos, VIPs no momento da consulta.

2 – Recebimentos

Para este arquivo, é NECESSÁRIO informar pelo menos um parâmetro de data. O exemplo acima usa a Data de Recebimento, mas é possível buscar usando outras datas, além de filtrar também pelo tipo de recebimento, listados a seguir. Os parâmetros são informados no endereço após o sinal de interrogação (?), e para separar os parâmetros você usará o sinal &.

Para filtrar por um tipo de DATA, é sempre necessário usar DE e ATÉ.

Por exemplo:

Quer consultar todos os recebimentos com vencimento no mês de abril de 2021.

Irá usar ?dtVencimentoDe=2021-04-01&dtVencimentoAte=2021-04-30. Ficaria assim:

Parâmetros:

• Data de Lançamento (dtLancamentoDe / dtLancamentoAte)

• Data de Vencimento (dtVencimentoDe / dtVencimentoAte)

• Data de Recebimento (dtRecebimentoDe / dtRecebimentoAte)

• Data da Venda (dtVendaDe / dtVendaAte)

• Tipo de Recebimento (idTipoRecebimento)

Tipos de recebimento

• Dinheiro=1

• Cartão de crédito=2

• Cartão de débito=3

• Cheque=4

• Boleto=5

• PagSeguro=6

• Depósito=7

• Débito em conta=8

• Internet=9

• Crédito de venda=11

• Cartão de crédito online=12

• Transferência=13

Por fim, deixamos um exemplo da URL com todos os parâmetros incluídos.

3 – Notas fiscais (XLS)

Para este arquivo, é necessário informar o período de consulta, por data de

envio ou de emissão. Não é necessário informar os dois parâmetros.

O parâmetro Status pode ser usado para filtrar. Caso queira trazer todas as notas enviadas, com todos os status, utilizar 0.

0 = todos os resultados

1 = aguardando envio

2 = aguardando retorno

3 = cancelada

4 = erro

Os parâmetros de data de envio (dtEnvioInício/dtEnvioFim) e data de emissão

(dtEmissaoInicio/dtEmissaoFim), podem ser usados nos formatos AAAAMMDD ou DD-MMAAAA.

Caso esteja utilizando um token do Administração Geral, poderá filtrar pelas unidades ou deixar como 0 o parâmetro idFilial.

4 – Notas fiscais (CSV)

Esse link pode ser utilizado para baixar um arquivo .CSV com todas as notas fiscais emitidas em determinado período. O parâmetro informado no link é a data de emissão.  

Para receber informações de uma filial específica, deve-se autenticar com o token dessa filial. 

Para receber de todas as unidades, ou de um grupo de filiais, utilizar o token gerado no Administração Geral ou em algum outro agrupador (centrais).

Qualquer dúvida, estamos aqui para apoiá-los!

Para consultar a documentação de API acesse api.abcevo.com

Respondeu à sua pergunta?