Emissão de Guias
Emissão de guias por sistemas de Terceiros/Parceiros
O projeto disponibiliza um recurso para que sejam emitidas guias referentes aos lançamentos gerados por sistemas de terceiros (fora do ecossistema Betha Fly/Cloud), os quais, por sua vez, são gerados por serviços da api-integracao-lancamentos .
Para que a emissão ocorra com sucesso, é necessário existir uma configuração cadastrada na Central de Configurações > Integração de lançamentos > Sistemas de terceiros com a mesma chave da configuração utilizada pela api-integracao-lancamentos na geração do lançamento.
O convênio utilizado para emissão é o que está vinculado à configuração, e o modelo de relatório/script a ser executado está vinculado no cadastro de tal convênio.
A requisição de emissão de guia, quando solicitada emissão do documento ( emitirDocumento=true ), inicia a execução do relatório e retorna o atributo urlDocumento com o valor https://consultaexecucoes.plataforma.betha.cloud/#/<protocolo_execucao>/resultado.
A página retornada em urlDocumento demonstra a situação atual da emissão do relatório. Ao ser finalizada a emissão, a página abre o PDF resultante automaticamente. Caso ocorra algum erro na emissão (por parte do gerenciador de relatórios), a página demonstrará a mensagem de erro para que o usuário solicite uma nova emissão ou entre em contato com o suporte técnico.
Utilizando o serviço de consulta da guia emitida, os mesmos atributos são retornados. Quando a execução do relatório é finalizada e o PDF fica disponível, os valores dos atributos são alterados para urlDocumento com o valor https://plataformaexecucoes.betha.cloud/v1/download/api/execucoes/<protocolo_execucao>/resultado, o qual é um link direto para o PDF gerado.
Vale ressaltar que o PDF ficará disponível por 30 dias, após esse período não será mais possível recuperá-lo.
Reserva de número de baixa por sistemas de Terceiros/Parceiros
Em alguns casos específicos, o cliente pode necessitar que exista um número de baixa anteriormente à geração do lançamento e a emissão da guia no sistema Tributos (Cloud). Para esses cenários particulares, existe um recurso de reserva de número de baixa, o qual recebe na URL um parâmetro representando um dos seguintes valores:
- Código numérico do sistema de terceiro ao qual o número de baixa estará vinculado e que solicitará a geração do lançamento;
- Chave de lançamento que será informada na geração do lançamento para esse número de baixa posteriormente à reserva.
Exemplos válidos:
POST https://tributos.suite.betha.cloud/integracoes/v1/guias/numeros-baixa/901 POST https://tributos.suite.betha.cloud/integracoes/v1/guias/numeros-baixa/AUTO_INFRACAO
De acordo com a seguinte configuração (utilizada de exemplo):
|
|---|
