Pular para o conteúdo principal

Integração de Notas Fiscais com sistema Parceiro de BI

Objetivo

A presente documentação visa a apresentar o processo de integração (carga inicial e carga incremental) com um sistema parceiro de BI. O serviço de carga inicial utiliza como referência a dataFatoGerador, e o serviço de carga incremental utiliza o registro mais atualizado de inclusão ou atualização da nota fiscal.

Processo

O objetivo é gerar uma carga inicial e, posteriormente, cargas incrementais que contemplem apenas as alterações nos dados armazenados e/ou novas notas emitidas após o processo de carga inicial.

Liberação dos serviços

Para que a liberação dos serviços seja efetivada, entre em contato com o gestor do setor de marketing a fim de que seja realizada as tratativas de acordo de parceria.

Processo de Integração dos Dados

Carga Inicial dos dados dos serviços disponíveis

Parâmetro: Esse endpoint possui como parâmetro obrigatório a dataFatoGeradorInicial. O endpoint buscará os registros de notas fiscais da data deste parâmetro até a data atual. Este mesmo valor é representado pelo campo dhFatoGerador no Json.

Limitação de Registros: Caso não seja informado um valor, o valor padrão será 100, com o limite de até 1000 registros.

Carga Incremental após a Carga Inicial

Parâmetro: Esse endpoint possui como parâmetros obrigatórios os campos dataRegistroInicial e dataRegistroFinal. O endpoint buscará os registros de notas fiscais pelas datas de inclusão ou última alteração do registro da nota fiscal.

Limitação de Registros: Caso não seja informado um valor, o valor padrão será 100, com o limite de até 1000 registros.

Execução Periódica: Executar o processo de carga incremental periodicamente para manter o sistema do parceiro atualizado, sempre utilizando como referência os campos dhCriacao e dhAlteracao.

Documentação dos serviços

https://aplicacoes.studio.betha.cloud/aplicacoes/swagger-ui/index.html?api=352