Ogmma Revenue

Guias

GET/v1/guias/{id}/itens

O item pelas três camadas, com o veredito da conciliação

O que saiu daqui contra o que voltou, item a item: a chave que casou, a diferença, o split (a operadora liberou parte da quantidade) e a decisão do faturista. semPar=ENVIO acha o item que a operadora julgou e que não saiu daqui; semPar=RETORNO, o que saiu e ela não mencionou. comDivergencia=true traz só o que não bate — e diferença ausente é diferente de zero: item nunca comparado não entra nesse filtro.

Escopo:
guia: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.
comDivergenciatexto
um de: true, false
Só os itens em que o liberado não bate com o cobrado. É o recorte de quem trabalha a fila de conferência.
semPartexto
um de: ENVIO, RETORNO
O que não casou dos dois lados. ENVIO: a operadora respondeu sobre um item que não saiu daqui. RETORNO: o item saiu e não voltou resposta nenhuma sobre ele.

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

Resposta 200

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

O item pelas três camadas, com o veredito do motor: a chave que casou, a diferença, o split e a decisão do faturista. É o cruzamento que o Revenue faz, não o que a operadora disse.

Campos de ItemConciliado

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.
chavetextoA chave que casou os dois lados: operadora + guia + código.
tipoDeMatchtextoComo os dois lados casaram: pelo código do procedimento, pela sequência na guia, ou por aproximação. Casamento fraco merece conferência antes de virar decisão.
envioobjetoNulo é o caso dominante: o portal devolve julgamento, não o arquivo que o prestador mandou.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tipotextoNatureza da linha enviada: PROCEDIMENTO ou DESPESA.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoO código que VOCÊ cobrou.
descricaotextoA descrição que você enviou. Compare com a da análise: operadora que renomeia costuma ter traduzido para o código dela.
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.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
executadoEmtextoQuando a execução ocorreu, em ISO 8601 com fuso.
analiseobjetoNulo quando o item saiu daqui e a operadora não o mencionou.
sequencialinteiroA ordem do registro dentro do documento, como a operadora a numerou.
tabelatextoQual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22.
codigotextoO código que a OPERADORA devolveu. Diferente do enviado quando ela traduziu para a tabela dela.
descricaotextoA descrição que a operadora devolveu.
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.
informadotextoDecimal 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.
realizadoEmtextoQuando o procedimento foi realizado.
pagamentoobjetoVem da GUIA de pagamento: o demonstrativo de pagamento desce até a guia em 2.929 de 2.929 documentos, nunca até o item.
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.
diferencatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
splitobjetoA operadora quebrou o item em dois — liberou parte da quantidade.
detectadobooleanoA operadora liberou parte da quantidade e cortou o resto, quebrando a linha em duas.
detalhetextoDetalhe em texto livre, para humano. Não é contrato.
decisaoobjetoDo faturista, não da operadora: ACEITA | EM_RECURSO. A glosa mora no item, e o recurso TISS é item a item.
valortextoValor em reais, decimal em string com duas casas — dinheiro não trafega como number.
emtextoQuando este fato foi registrado, em ISO 8601 com fuso.
notatextoA nota escrita por quem registrou o fato — fica no histórico do recurso.

Exemplo de retorno

{
  "data": [
    {
      "id": "cmf3k2x9a0001icl",
      "chave": "334561|000123|40301591",
      "tipoDeMatch": "EXATO",
      "envio": null,
      "analise": {
        "sequencial": 3,
        "tabela": "22",
        "codigo": "40301591",
        "descricao": "COLESTEROL LDL",
        "quantidade": "1",
        "informado": "8.94",
        "processado": "8.94",
        "liberado": "0.00",
        "realizadoEm": "2026-07-02"
      },
      "pagamento": {
        "processado": "226.29",
        "liberado": "214.80",
        "glosa": "11.26"
      },
      "diferenca": "8.94",
      "split": {
        "detectado": false,
        "detalhe": null
      },
      "decisao": {
        "valor": "EM_RECURSO",
        "em": "2026-08-05T13:20:00.000Z",
        "nota": "Valor conforme tabela vigente"
      }
    }
  ],
  "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/guias_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.