Ogmma Revenue

Demonstrativos

GET/v1/demonstrativos/{id}/itens

O que a operadora declarou item a item, com o motivo da recusa junto

O nível mais fundo do retorno, e o maior volume do sistema: 310.760 linhas. A glosa pende de ITEM em 56.709 das 56.971 medidas — recorrer da guia inteira quando um procedimento foi recusado é pedir de volta o que já foi pago, e o recurso TISS é item a item. motivos[] vem na própria linha, incluindo a nota do auditor quando a operadora a mandou. Buscar em /v1/glosas depois, item a item, seria N+1 do lado de quem integra. Só documento de ANÁLISE tem itens: o de pagamento desce até a guia em 2.929 de 2.929 documentos, e pedir itens dele responde 404 dizendo isso.

Escopo:
retorno:ler
Resposta:
200

Pedido

Caminho

{id}*Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.

Parâmetros de query

CampoTipoO que é
codigotexto
1–20 caracteres
O código do procedimento ou da despesa na linha, na tabela que o documento declara.
tipotexto
um de: PROCEDIMENTO, DESPESA
PROCEDIMENTO ou DESPESA (material, medicamento, taxa). A despesa costuma ser onde a glosa se esconde.
comGlosatexto
um de: true, false
Só as linhas com glosa (true) ou só as sem (false). Omitido, traz as duas.
limiteinteiro
1–200 · padrão 100
Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.
deslocamentointeiro
padrão 0
Quantos registros pular, para a página seguinte. Use com paginacao.total da resposta; paginacao.temMais diz se vale pedir mais.
numeroGuiaPrestadortexto
1–20 caracteres
O número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.

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

Resposta 200

datalista de ItemDoDemonstrativoO recurso. Os campos estão na tabela abaixo.
paginacaoPaginacaoOnde esta página está no total. Vem fora de data.

O item como a operadora o declarou — o nível mais fundo do retorno, e onde a glosa mora em 56.709 das 56.971 glosas medidas. O motivo vai junto, e não num segundo pedido.

Campos de ItemDoDemonstrativo

CampoTipoO que é
idtextoIdentificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.
guiaobjetoA guia a que este registro pertence.
numeroGuiaPrestadortextoO número que VOCÊ deu à guia. O TISS não deixa repetir dentro do prestador, e é por ele que você reencontra a guia aqui.
numeroGuiaOperadoratextoO número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela.
beneficiariotextoO nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tipotextoPROCEDIMENTO | DESPESA (material, medicamento, taxa).
procedimentoobjetoO procedimento a que a linha se refere.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoO que a operadora escreveu.
termoOficialtextoO termo da TUSS. Divergir do anterior é informação, não erro.
despesaobjetoSó em item do tipo DESPESA: procedimento não tem código de despesa nem registro ANVISA.
codigotextoCódigo do material, medicamento ou taxa na tabela declarada.
registroANVISAtextoRegistro do produto na ANVISA, quando a linha é material ou medicamento.
grauParticipacaotextoO papel do profissional no procedimento, no código TISS (ex. 00 = cirurgião).
unidadeMedidatextoUnidade em que a quantidade é contada, no código de TRÊS dígitos da tabela 60 do TUSS (001 a 061). Obrigatória em despesa — o padrão TISS recusa despesa sem ela, e texto livre como "ampola" não serve.
realizadoEmtextoQuando o procedimento foi realizado.
quantidadetextoQuantas unidades, como o documento declarou. Vem em texto porque a operadora às vezes manda fracionado (1,5) e arredondar aqui mudaria o valor da conta.
valorUnitariotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
valoresobjetoA glosa é a SOMA das glosas do item — não há coluna de glosa no item, a recusa mora na tabela de glosas.
informadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totaltextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
processadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liberadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
fonteOrdeminteiroQual dos arquivos do demonstrativo composto trouxe esta linha. Cruze com fontes[].ordem do detalhe.
motivoslista de objetosPor que esta linha foi cortada, na palavra da operadora e no termo oficial. Vem junto, e não num segundo pedido — é o insumo do recurso.
codigotextoO código do motivo, como a operadora o emitiu. Na glosa, é o código da Tabela 38 da ANS quando ela usa o oficial.
significadotextoO termo oficial da Tabela 38 da ANS, quando o código existe nela.
tipotexto
um de: TABELA_ANS, CODIGO_OPERADORA, CATEGORIA, TEXTO_LIVRE, NENHUM
Que espécie de motivo é este, derivado do que veio preenchido. NENHUM = cortaram sem dizer por quê.
codigoOperadoratextoO código do prestador NA operadora. Cada operadora tem o seu, e é ele que a operadora exige no documento — não o CNPJ.
categoriatextoO agrupamento que a operadora deu ao motivo, quando ela agrupa.
notaAuditortextoO argumento do auditor. Insumo direto do recurso.
descricaotextoO motivo em texto, na língua da operadora — não traduzido.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

Exemplo de retorno

{
  "data": [
    {
      "id": "cmf3k2x9a0001ite",
      "guia": {
        "numeroGuiaPrestador": "000123",
        "numeroGuiaOperadora": "18700001",
        "beneficiario": "PACIENTE EXEMPLO",
        "carteira": "00000000000000000",
        "protocolo": "PROTO-18700001"
      },
      "sequencial": 3,
      "tipo": "PROCEDIMENTO",
      "procedimento": {
        "tabela": "22",
        "codigo": "40301591",
        "descricao": "COLESTEROL LDL",
        "termoOficial": "Colesterol LDL, dosagem"
      },
      "despesa": null,
      "grauParticipacao": null,
      "unidadeMedida": null,
      "realizadoEm": "2026-07-02",
      "quantidade": "1",
      "valorUnitario": "8.94",
      "valores": {
        "informado": "8.94",
        "total": "8.94",
        "processado": "8.94",
        "liberado": "0.00",
        "glosa": "8.94"
      },
      "fonteOrdem": 0,
      "motivos": [
        {
          "codigo": "1705",
          "significado": "VALOR APRESENTADO A MAIOR",
          "tipo": "TABELA_ANS",
          "codigoOperadora": null,
          "categoria": null,
          "notaAuditor": null,
          "descricao": "Item não liberado na análise",
          "valor": "8.94"
        }
      ]
    }
  ],
  "paginacao": {
    "total": 1,
    "limite": 20,
    "deslocamento": 0,
    "temMais": false
  }
}

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

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

CódigoHTTPQuandoO que fazer
RECURSO_NAO_ENCONTRADO404O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.Confira o id.

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.