VISÃO GERALA API Autorizações por Período tem o objetivo de buscar e acompanhar as autorizações dando uma maior visibilidade para o cliente da situação da guia. Nessa API constarão os campos com o motivo da negativa para serem disponibilizados aos beneficiários, de acordo com as regras da RN. Para utilização da API, deve-se informar a seguinte rota: http://<servidor>:<porta>/api/hat/v1/authorizationPeriods Método HTTP: GET Exemplo de rota completa: http://totvs-datasul:80/api/hat/v1/authorizationPeriods?dtInicio=30/04/2025&dtFim=13/05/2025 Autenticação: - A autenticação para o consumo da API é feita por Basic Auth informando o usuário e senha respectivos do sistema.
Image Removed
Cabeçalho: - No cabeçalho da requisição é possível informar parâmetros que servirão como filtro no consumo da API.
| Parâmetros | Descrição |
|---|
| x-carteira | Carteira do beneficiário | | x-cpf | CPF do beneficiário |
Image Removed
Parâmetros para busca e consumo: - Além dos parâmetros de filtro utilizados no cabeçalho da requisição é necessário a utilização dos parâmetros dtInicio e dtFim via path parameters.
| Parâmetros | Descrição |
|---|
| dtInicio | Data de inicial das solicitações de guias | | dtFim | Data final da solicitações de guias |
Image Removed
REGRAS DE NEGÓCIO APLICADAS
- A conversão da situação da guia é realizada conforme a tabela abaixo:
Status da Guia | Descrição no TOTVS | Descrição no APP |
|---|
1 | DIGITADA | DIGITADA | 2 | AUTORIZADA | AUTORIZADA | 3 | CANCELADA | CANCELADA | 4 | PROCESSADO PELO CONTAS | EM EXECUÇÃO | 5 | FECHADO | FECHADA | 6 | ORÇAMENTO | ORÇAMENTO | 7 | FATURADA | FATURADA | 8 | NEGADA | NEGADA | 9 | PENDENTE AUDITORIA | EM ANÁLISE | 10 | PENDENTE LIBERAÇÃO | EM ANÁLISE | 11 | PENDENTE LAUDO MÉDICO | EM ANÁLISE | 12 | PENDENTE JUSTIFICATIVA | EM ANÁLISE | 13 | PENDENTE PERICIA | EM ANÁLISE | 14 | AUTORIZADA PARCIAL | AUTORIZADA PARCIAL | 19 | EM AUDITORIA | EM ANÁLISE | 20 | GUIA EM ATENDIMENTO | EM ANÁLISE | 23 | EM PERICIA MÉDICA | EM ANÁLISE |
- Além da situação da guia, a API retorna a situação individual dos movimentos.
| Situação Guia | Descrição Situação | Situação Movimento |
|---|
| 1 | DIGITADA | DIGITADO | | 2 | AUTORIZADA | AUTORIZADO Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. | | 3 | CANCELADA | CANCELADO | | 4 | PROCESSADO PELO CONTAS | Se todas as quantidades do movimento já estiverem executadas pelo Contas, será considerado o status EXECUTADO. Se nenhuma quantidade do movimento estiver executada, será considerado o status AUTORIZADO. Se, pelo menos, uma quantidade do movimento tenha sido executada, porém ainda existe quantidade de procedimento para ser executada será considerado o status EM EXECUÇÃO. Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. | | 8 | NEGADA | NEGADO | | 14 | AUTORIZADO PARCIAL | AUTORIZADA PARCIAL Obs: Caso o procedimento conter a quantidade zerada o status do movimento será considerado NEGADO. | | Quando o procedimento não se enquadrar nas situação acima, será considerado o status EM ANALISE. |
Os resultados apresentados pela API podem ser validados e visualizados nos seguintes programas/relatórios: Pesquisa e Listagem das GuiasAo acessar o programa na tela inicial está disponível a opção de Busca Avançada: Image Modified
Através da Busca Avançada é possível pesquisar o beneficiário pelo CPF ou pela Carteira do Beneficiário: Image Modified
Ao informar um dos campos e clicar em buscar será retornado os dados do beneficiário e habilitado a opção Autorização: Image Modified
Ao clicar em Autorização abrirá uma tela onde é possível selecionar o intervalo inicial e final. Ao clicar em pesquisar será retornado uma lista com todas as guias do beneficiário no período determinado: Image Modified
Situação das GuiasAo realizar a pesquisa através do programa Consulta Unificada de Pessoas ficará disponibilizado a opção Autorizações no menu. Ao clicar nesta opção o programa permitirá visualizar as guias de atendimento que estão associados ao beneficiário. Nesta tela estará presente o status da guia através da coluna Situação. Image Modified
Ao clicar no número da guia será aberta o programa Manutenção Autorização Guias AT0110Z onde é possível verificar os dados da guia e seu status. Esta tela é apenas para consulta. Image Modified
Mais detalhes sobre o programa Consulta Unificada de Pessoas pode ser visto através da documentação: https://tdn.totvs.com/x/oHQxHQ. Manutenção Autorização Guias (AT0110Z)Situação das GuiasAo clicar em Autorização e pesquisar uma guia será exibido os detalhes e disponibilizado a opção F8 - Infor. Adic: Image Modified
Ao apertar F8 aparecerá a opção Mov AT: Image Modified
Ao clicar nessa opção será exibida um filtro para selecionar as situações das guias. No caso deste exemplo serão retornadas as guias com as situações de 1- Digitada até 23 - Em Pericia: Image Modified
Após a escolha serão exibidas todas as guias do beneficiário com sua situação: Image Modified
Histórico das GuiasAo clicar em Autorização e pesquisar uma guia será exibido os detalhes e disponibilizado a opção F3 - Inf. Guia: Image Modified
Ao apertar F3 irá aparecer a opção Guia: Image Modified
Ao apertar na opção Guia irá aparecer uma dela com as informações sobre a guia e a opção Histórico: Image Modified
Ao selecionar a opção será exibido uma tela com o histórico da situação da guia contendo todos os status e descrições que a guia teve: Image Modified
Será exibido também a data de atualização de cada status: Image Modified
Mais detalhes sobre o programa Manutenção Autorização Guias pode ser visto através da documentação: https://tdn.totvs.com/x/CfhYDQ Exemplo de como pode ser realizada a validação da Listagem e Busca de Guias, explicada na sessão 3. Como Validar as Informações, que utiliza o programa Consulta Unificada de Pessoas (hvp.personInformation). Para isso, foi realizada uma requisição na API utilizando a carteira do beneficiário, a data inicial e final do período desejado. Para uma melhor visualização foi utilizada a mesma data inicial e final para retornar apenas as guias de um dia, neste caso do dia 01/07/2020. Os parâmetros utilizados podem ser visualizados abaixo: Image Modified
Image Modified
A API retornou os seguintes dados:
Image Modified
Pode-se observar que o retorno contém 3 guias: 202500001977, 202500001979 e 202500001992. No programa Consulta Unificada de Pessoas foram utilizados os mesmos parâmetros da requisição da API, ou seja, a carteira do beneficiário, data inicial e final. O resultado pode ser visto abaixo: Image Modified
Observando o retorno da API e da Consulta Unificada de Pessoas vemos que as guias retornadas e seus dados são os mesmos. |