Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Configurações API
  3. Verbos
  4. Path Param
  5. Exemplos de Jsons de Resposta


01. VISÃO GERAL

A API auditCarolPos auditPos 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.

...

    https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPosauditPos? + parâmetros de busca (especificados na seção abaixo)

...

  1. Selecionar o Método de GET
  2. Configurar sua autenticação para requisiçãoNa aba 

       Na aba HEADERS:

KeyValue
AuthorizationValor presente no parâmetro MV_

...

PHATTOK no PLS
tenantNameValor presente no parâmetro MV_

...

PHATNMT no PLS
idTenant

Valor presente no parâmetro MV_

...

PHATQTD no PLS



Image Added


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/auditCarolPosauditPos

auditCarolPos auditPos é 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/auditCarolPosauditPos

04.PATH PARAMS - GET

Lista de query params OBRIGATÓRIOS:

...

https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPosauditPos?dateFrom=2025-05-01&dateTo=2025-09-01

...

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 APICampoDescrição
healthProviderIdCódigo Prestador (RDA)Código do Prestador Executante da Operadora
auditorEmailEmail do AuditorEmail do Auditor
batchNúmero LoteNú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.

...

https://hat.totvs.com.br/api/healthcare/hatfaturamento/v1/auditCarolPosauditPos?
dateFrom=2025-05-01&dateTo=2025-09-01&healthProviderId=000005&[email protected]&batch=298374&page=1&pageSize=50


Image RemovedImage Added

05. EXEMPLOS DE JSONS DE RESPOSTA

...


{
    "items": [
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "1499959",
            "protocol": "00029010",
            "batch": "3539",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:32:20",
            "action": "4",
            "actionDescription": "Analise salva"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "1499959",
            "protocol": "00029010",
            "batch": "3539",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:32:00",
            "action": "2",
            "actionDescription": "Negou o item 0029-18-60004746"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "1499959",
            "protocol": "00029010",
            "batch": "3539",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:30:57",
            "action": "1",
            "actionDescription": "Iniciou a analise"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:28",
            "action": "5",
            "actionDescription": "Analise finalizada"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:20",
            "action": "2",
            "actionDescription": "Adicionou o item 0005-22-10101012"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:17",
            "action": "2",
            "actionDescription": "Adicionou o item 0004-00-10101013"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:12",
            "action": "2",
            "actionDescription": "Aprovou o item 0001-22-10101039"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:10",
            "action": "2",
            "actionDescription": "Negou o item 0002-22-10101012"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:22:06",
            "action": "2",
            "actionDescription": "Negou o item 0003-00-10101013"
        },
        {
            "healthProviderId": "000005",
            "idOnHealthInsurer": "528731",
            "protocol": "00029149",
            "batch": "3214",
            "name": "isDevMode",
            "auditorEmail": "isDevMode@carolpos.com.br",
            "TransactionDate": "12/03/2025",
            "transactionTime": "15:21:48",
            "action": "1",
            "actionDescription": "Iniciou a analise"
        }
    ],
    "hasNext": false,
    "message": ""
}

...