CONTEÚDO
- Visão Geral
- Configurações API
- Verbos
- Path Param
- Exemplos de Jsons de Resposta
01. VISÃO GERAL
A API auditCarolPos tem como objetivo fornecer o histórico completo das ações realizadas pelos auditores. Ela registra detalhadamente quais ações foram executadas, por qual auditor, em quais lotes, qual o prestador relacionado, e em qual data e hora.
A API retorna: código do prestador executante na operadora, número do protocolo, número do lote. número da guia do prestador, nome do auditor, email do auditor, data da audição, hora da audição, ação que está sendo tomada pelo auditor e descrição dessa ação (por ex: aprovou o item 123, negou o item 123, iniciou a análise, finalizou a análise).
A API está no ambiente de produção, portanto, a requisição deve apontar para o mesmo.
A URL da requisição será:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos? + parâmetros de busca (especificados na seção abaixo)
02. CONFIGURAÇÕES API
Seguem as configurações que devem ser feitas na plataforma da API antes da requisição.
- Selecionar o Método de GET
- Configurar sua autenticação para requisição
- Na aba HEADERS:
Key Value Authorization Valor presente no parâmetro MV_PHATNMT no PLS tenantName Valor presente no parâmetro MV_PHATQTD no PLS idTenant Valor presente no parâmetro MV_PHATTOK no PLS O token de Authorization deve ser o Master Token, para não expirar.
[ MASTER TOKEN - GERANDO E CONFIGURANDO ]
3.4 - Configurar Chave de Autenticação das Integrações (Master Token) e Dados de integração
- Na aba HEADERS:
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path |
|---|---|
| GET | / |
auditCarolPos é o nome da API, e deve ser colocado logo após a URL e seu complemento indicativo que a API é do HAT:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos
04. PATH PARAMS - GET
Lista de query params OBRIGATÓRIOS:
Parâmetro na API | Campo | Descrição |
|---|---|---|
| dateFrom | Data De | De qual até qual o período que você deseja buscar os detalhes da auditoria. |
| dateTo | Data Até | De qual Até qual o período que você deseja buscar os detalhes da auditoria. |
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom=2025-05-01&dateTo=2025-09-01
Aqui vão ser retornados os registros que estão entre as datas e
As datas devem ser passadas no formato: AAAA-MM-DD.s
Caso não forem passadas as duas data, a API retornará um BadRequest 400 acompanhado de uma mensagem de que é necessário informar ambos os parâmetros.
Lista de query params OPCIONAIS:
| Parâmetro na API | Campo | Descrição |
|---|---|---|
| healthProviderId | Código Prestador (RDA) | Código do Prestador Executante da Operadora |
| auditorEmail | Email do Auditor | Email do Auditor |
| batch | Número Lote | <AQUI> |
| page | ||
| pageSize |
Exemplo de uso:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPos?dateFrom=2025-05-01&dateTo=2025-09-01&healthProviderId=000005&[email protected]&batch=298374&page=1&pageSize=50
05. EXEMPLOS DE JSONS DE RESPOSTA
Sucesso 200
{ |
A API retorna todos os campos da tabela LogCarolPos
Erro 400 Bad Request
1 | { |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas