Ogmma Revenue

Glosas

GET/v1/glosas/resumo

O retrato agregado: quanto, em que nível, e quanto sem motivo

Escopo:
glosa:ler
Resposta:
200

Pedido

Parâmetros de query

CampoTipoO que é
registroANStexto
1–20 caracteres
Registro da operadora na ANS, seis dígitos (ex. 334561). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.
competenciatexto
formato AAAA-MM
Mês AAAA-MM da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.

* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.

Exemplo de chamada

curl -X GET https://api.miydas.com.br/v1/glosas/resumo \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

dataResumoDeGlosasO recurso. Os campos estão na tabela abaixo.

O retrato agregado do recorte: quanto, em que nível, e quanto veio sem motivo.

Campos de ResumoDeGlosas

CampoTipoO que é
recorteobjetoO filtro que produziu estes números, devolvido junto. Total sem recorte ao lado é número solto: é por aqui que você confere que somou o que queria.
registroANStextoRegistro da operadora na ANS, seis dígitos (ex. 334561). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora.
competenciatextoMês AAAA-MM da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos.
glosasinteiroQuantas glosas no recorte.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
comSignificadoOficialobjetoQuantas têm código que existe na Tabela 38. proporcao é 0–1, não percentual.
glosasinteiroQuantas trazem código que existe na Tabela 38 da ANS.
proporcaonúmeroA fração delas sobre o total, de 0 a 1. 0.62 é 62% — não é percentual.
semCodigoobjetoA operadora cortou e não disse por quê. Material de recurso.
glosasinteiroQuantas vieram sem motivo codificado.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
porNivellista de objetosOs mesmos números, abertos pelo nível em que a glosa pende.
niveltextoO nível em que a glosa pende: ITEM, GUIA ou PROTOCOLO.
glosasinteiroQuantas glosas pendem deste nível.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.
maioresPorValorlista de objetosOs motivos que mais custaram, do mais caro para o mais barato. É por onde se começa a recorrer.
codigotextoO código do motivo. Nulo agrupa tudo que veio sem código.
significadotextoO termo da Tabela 38, quando o código existe nela.
glosasinteiroQuantas glosas têm este motivo.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.

Exemplo de retorno

{
  "data": {
    "recorte": {
      "registroANS": "334561",
      "competencia": "2026-09"
    },
    "glosas": 4118,
    "valorTotal": "197344.56",
    "comSignificadoOficial": {
      "glosas": 3964,
      "proporcao": 0.9626
    },
    "semCodigo": {
      "glosas": 154,
      "valorTotal": "21877.90"
    },
    "porNivel": [
      {
        "nivel": "ITEM",
        "glosas": 4092,
        "valorTotal": "197344.56"
      },
      {
        "nivel": "GUIA",
        "glosas": 26,
        "valorTotal": "0.00"
      }
    ],
    "maioresPorValor": [
      {
        "codigo": "1705",
        "significado": "VALOR APRESENTADO A MAIOR",
        "glosas": 2841,
        "valorTotal": "128904.11"
      }
    ]
  }
}

Experimente sem chave

O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.

curl https://api.miydas.com.br/v1/sandbox/glosas_resumo

A chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.

Erros

Esta rota não tem erro próprio: só os comuns a qualquer chamada com chave — chave ausente ou inválida, escopo insuficiente, parâmetro recusado e erro interno.

Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.