Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações API
- Verbos
- Path Param
- Exemplos de Jsons de Resposta
01. VISÃO GERAL
A API auditCarolPos 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 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/auditCarolPosauditLog? + 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çãoNa aba
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
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path |
|---|---|
| GET | / |
auditLog é auditCarolPos é o nome da API, e deve ser colocado logo após a URL e seu complemento indicativo que a API é do HATde API:
https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/
...
auditLog04.PATH PARAMS - GET
Lista de query params OBRIGATÓRIOS:
Parâmetro na API | Campo | Descrição |
|---|---|---|
| dateFrom | Data De | De qual até Até qual o período que você deseja desejar buscar os detalhes da auditoria. |
| dateTo | Data Até | De qual Até qual o período que você deseja 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.s
Caso não forem passadas as duas datadatas, 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/auditCarolPosauditLog?
dateFrom=2025-05-01&dateTo=2025-09-01&healthProviderId=000005&[email protected]&batch=298374&page=1&pageSize=50
05. EXEMPLOS DE JSONS DE RESPOSTA
Além do código de sucesso ou BadRequest, a API retorna dois atributos no final do corpo do JSON: hasNext e message
- hasNext: Indica se existe ou não uma próxima com registros para serem retornados
- Caso der True, se na primeira requisição foi colocado page=1 e pageSize=50, é possível colocar page=2 na próxima requisição, e a API irá buscar os registros subsequentes dos 50 primeiros registros que foram retornados na page = 1
- message: Em caso de erro na requisição, o atributo message retorna a mensagem de erro.
Sucesso 200
{ |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas