Ogmma Revenue

Glosas

GET/v1/glosas/motivos

O catálogo do que esta clínica recebeu, traduzido e ordenado por valor

Reúne os motivos dos quatro tipos que a base conhece — código da ANS, código próprio da operadora, categoria em texto e sem motivo — numa lista só. A ordem é por valor, porque a pergunta de quem abre isto é o que custa mais.

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.
limiteinteiro
1–200 · padrão 50
Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.

* 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/motivos \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

datalista de MotivoDeGlosaO recurso. Os campos estão na tabela abaixo.

Um motivo distinto recebido por esta clínica, com quanto custou. Ordenado por valor.

Campos de MotivoDeGlosa

CampoTipoO que é
codigotextoO código do motivo. Nulo é o agrupamento de tudo que veio sem código.
significadotextoDa Tabela 38, ou o texto da categoria quando o motivo veio sem código.
tipotexto
um de: TABELA_ANS, CODIGO_OPERADORA, CATEGORIA
De onde o código vem: a tabela oficial da ANS, a tabela própria da operadora, ou só uma categoria.
glosasinteiroQuantas glosas esta clínica recebeu com este motivo.
valorTotaltextoDecimal em string, duas casas — dinheiro não é number.

Exemplo de retorno

{
  "data": [
    {
      "codigo": "1705",
      "significado": "VALOR APRESENTADO A MAIOR",
      "tipo": "TABELA_ANS",
      "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_motivos

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.