Ogmma Revenue

Demonstrativos

GET/v1/retornos-sem-vinculo/resumo

Quanto está solto, e onde

Escopo:
retorno:ler
Resposta:
200

Pedido

Parâmetros de query

CampoTipoO que é
tipotexto
um de: ANALISE, PAGAMENTO
De que tipo de documento veio o retorno órfão: ANALISE ou PAGAMENTO.
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
ou sem-data · 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/retornos-sem-vinculo/resumo \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

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

Quanto está solto, e onde. Não é paginado: somar meia competência daria um total errado.

Campos de ResumoDeRetornosSemVinculo

CampoTipoO que é
totalinteiroO total do recorte pedido.
montantetextoGlosa quando há; senão o liberado — o valor em disputa na linha.
porMotivolista de objetosOs mesmos números, abertos por motivo.
motivotextoO motivo, como a operadora o nomeou.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante deste motivo, em reais, decimal em string.
porOperadoralista de objetosOs mesmos números, abertos por operadora.
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.
nometextoRazão social da operadora, para exibição.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante desta operadora, em reais, decimal em string.
porCompetencialista de objetosOs mesmos números, abertos por mês de competência.
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.
linhasinteiroQuantas linhas o recorte tem.
montantetextoO montante deste mês, em reais, decimal em string.

Exemplo de retorno

{
  "data": {
    "total": 4666,
    "montante": "65244.35",
    "porMotivo": [
      {
        "motivo": "GUIA_DESCONHECIDA",
        "linhas": 4666,
        "montante": "65244.35"
      }
    ],
    "porOperadora": [
      {
        "registroANS": "334561",
        "nome": "Unimed Blumenau",
        "linhas": 2757,
        "montante": "32168.87"
      }
    ],
    "porCompetencia": [
      {
        "competencia": "2026-07",
        "linhas": 612,
        "montante": "21880.33"
      }
    ]
  }
}

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/retornos_sem_vinculo_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.