Registros Contábeis Empresas - Envio assíncrono

Owned by EDILSON SOARES DE OLIVEIRA JUNIOR (Unlicensed)
Last updated: Oct 21, 2024
4 min read

Para o módulo Registros Contábeis Empresas, disponibilizamos para os registros de Lançamentos Contábeis, serviço de envio parcial de lotes, que serão processados de forma assíncrona.

O Fluxo permanece semelhante ao envio de modo síncrono, Iniciar envio, Enviar Parcial Lote e Finalizar Envio.

Após o e-Sfinge Online receber o envio parcial dos registros enviados, será gerado um número de lote e adicionado esses registros em uma fila de processamento, com esse número de lote a aplicação das empresas pode consultar o status de processamento.

Será possível enviar quantos lotes forem necessários para uma chave de pacote iniciada.

image-20241018-140802.png
image-20241021-143556.png

 

Serviços da API Swagger UI

 

  • Iniciar Envio

/v5/registroscontabeis/empresas/iniciarEnvio

  • Enviar Parcial em Lote

/v5/registroscontabeis/empresas/enviarParcialLote

Observação sobre os envios dos lotes:

  • As Contas Contábeis continuarão sendo processadas de forma síncrona, ou seja, qualquer inconsistência que tiver em alguma conta irá gerar um erro de regra de negócio, a remessa irá ser cancelada automaticamente e os lançamentos contábeis não irão para a fila de processamento (não retornará um número de lote)

  • Consultar Por Número de Lote

/v5/registroscontabeis/empresas/consultarPorNumeroLote/{numeroLote}

Quais situações o lote pode assumir?

  • RECEBIDO

Lote foi recebido pelo e-Sfinge Online e está aguardando processamento.

  • EM_PROCESSAMENTO

Lote sendo processado pelo e-Sfinge Online.

  • PROCESSADO_SUCESSO

Todos os registros do lote foram processados com sucesso.

  • PROCESSADO_ERRO_NEGOCIO

Foram processados os registros e concatenados os erros de negócio encontrados pelo e-Sfinge Online.

Quando um lote é processado com esse status, a chave de pacote é automaticamente cancelada e todos os lotes enviados anteriormente são descartados (mesmo que processados com status PROCESSADO_SUCESSO), sendo necessário iniciar uma nova remessa através do iniciarEnvio e após a correção do dado enviado incorretamente deve ser realizado envio de todos os lotes novamente.

  • PROCESSADO_ERRO_INTERNO

Algo inesperado aconteceu no processamento do lote, código da remessa foi cancelado. Favor abrir chamado para nosso helpdesk com o detalhe do erro e identificador da remessa.

Quando um lote é processado com esse status, a chave de pacote é automaticamente cancelada e todos os lotes enviados anteriormente são descartados (mesmo que processados com status PROCESSADO_SUCESSO), sendo necessário iniciar uma nova remessa através do iniciarEnvio e após a correção do dado enviado incorretamente deve ser realizado envio de todos os lotes novamente.

  • ABORTADO_ERRO_LOTE_ANTERIOR

Quando um dos lotes anteriores da mesma "chave de pacote" tenha sido processado com uma das situações PROCESSADO_ERRO_NEGOCIO ou PROCESSADO_ERRO_INTERNO.

  • Finalizar Envio

Serviço igual aos outros módulos, porem somente é possível finalizar uma transmissão depois que todos os lotes enviados estiverem na situação  "PROCESSADO_SUCESSO"

 

  • O envio de Registros Contábeis Empresas no modo SÍNCRONO continuará disponível seguindo o mesmo fluxo de sempre:

Iniciar Envio, Enviar Parcial e Finalizar Envio.