A API auditLog 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/auditLog? + parâmetros de busca (especificados na seção abaixo)
Seguem as configurações que devem ser feitas na plataforma da API antes da requisição.
Na aba HEADERS:
| Key | Value |
|---|---|
| Authorization | Valor presente no parâmetro MV_PHATTOK no PLS |
| tenantName | Valor presente no parâmetro MV_PHATNMT no PLS |
| idTenant | Valor presente no parâmetro MV_PHATQTD 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
Seguem os verbos disponíveis na API:
Verbo | Path |
|---|---|
| GET | / |
auditLog é o nome da API, e deve ser colocado logo após a URL e seu complemento de API:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditLog
Lista de query params OBRIGATÓRIOS:
Parâmetro na API | Campo | Descrição |
|---|---|---|
| dateFrom | Data De | De qual Até qual o período você desejar buscar os detalhes da auditoria. |
| dateTo | Data Até | De qual Até qual o período você desejar buscar os detalhes da auditoria. |
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditLog?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.
Caso não forem passadas as duas datas, a API retornará um BadRequest 400 acompanhado de uma mensagem de que é necessário informar ambos os parâmetros.
Lista de query params OPCIONAIS:
Como existem os parâmetros obrigatórios, se forem colocados somente eles, o filtro é feito somente com base neles, mas caso você queira complementar o filtro com mais parâmetros, é possível com os que estão na tabela abaixo.
| 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 | Número do Lote |
| page | Página de busca | |
| pageSize | Quantidade de Registros por página |
Caso não for informado nenhum page ou pageSize, como padrão irá buscar os 50 primeiros registros na página 1 de busca.
Exemplo de uso:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditLog?
dateFrom=2025-05-01&dateTo=2025-09-01&healthProviderId=000005&[email protected]&batch=298374&page=1&pageSize=50
Além do código de sucesso ou BadRequest, a API retorna dois atributos no final do corpo do JSON: hasNext e message
Sucesso 200
{ |
A API retorna todos os campos da tabela LogCarolPos
Erro 400 Bad Request
1 | { |