Ogmma Revenue

Demonstrativos

GET/v1/demonstrativos/{id}

O documento inteiro: protocolos, guias, glosas e liquidação

A glosa devolvida aqui é a mesma de GET /v1/glosas/{id} — mesmo mapper, não uma segunda leitura. Não existe campo liquido no topo: valorLiquido do documento é o liberado dele menos o imposto do DIA inteiro, e a operadora repete o bloco em cada demonstrativo daquela data (medido: liberado 587,97, débitos do dia 6.313,66, campo = −5.725,69). O líquido sai em liquidacao[], por data de crédito.

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.

Exemplo de chamada

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

Resposta 200

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

O documento inteiro: protocolos, guias e glosas — e a liquidação, quando é documento de pagamento.

Campos de DemonstrativoDetalhado

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.
tipotexto
um de: ANALISE, PAGAMENTO
ANALISE: o julgamento da conta — o que a operadora reconheceu e o que glosou. PAGAMENTO: o caixa — o que ela creditou. Duas respostas distintas, quase sempre em meses distintos.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
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 como a ANS a publica. Informativo — a chave é o registro.
numeroDemonstrativotextoO número que a operadora deu ao demonstrativo. NÃO identifica o documento: ele se repete entre operadoras e entre competências. A identidade de um retorno é o protocolo mais a data.
competenciatextoYYYY-MM (UTC) da data de NEGÓCIO: data do protocolo na análise, data do crédito no pagamento. Nunca da emissão.
creditoEmtextoData em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele.
emitidoEmtextoData que o documento declara como de emissão. Cuidado: em documento de portal, é o dia do download.
completudetextoFULL | ACCEPTED_ONLY | GLOSA_ONLY — o que o conjunto de arquivos permite afirmar. Num GLOSA_ONLY o cobrado e o liberado NÃO chegaram: não são zero.
profundidadetextoAté onde a fonte desce: A (item + motivo) · B (item) · C (guia) · D (protocolo) · E (overlay) · F (só o fechamento financeiro).
versaoTisstextoVersão do padrão TISS do documento (ex. 4.01.00). Quem dita a versão é a operadora.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
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.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
guiasinteiroTotal de guias do documento, inclusive as que a paginação não trouxe.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
avisoslista de textoO que impede ler este documento errado — por exemplo, que um GLOSA_ONLY não declara o cobrado.
fonteslista de objetosOs documentos que compõem este demonstrativo. Mais de um é normal: operadora que manda o aceito e o glosado em arquivos separados aparece aqui com dois.
origemtexto
um de: ARQUIVO, MENSAGEM_TISS
ARQUIVO: um arquivo que chegou à caixa de entrada. MENSAGEM_TISS: a resposta estruturada do webservice. A segunda domina — 2.900 contra 440 na análise.
papeltextoACCEPTED (só o aceito) | GLOSA (só o recusado) | FULL (o documento inteiro).
ordeminteiroA posição deste registro na sequência, a partir de 1.
arquivoobjetoO arquivo de onde o dado veio.
idtextoO id a passar em /demonstrativos/{id}/arquivos/{arquivoId}.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoO invólucro. formato é o que conseguimos ler dele.
formatotextoEm que formato o dado chegou.
tamanhoBytesinteiroTamanho do arquivo em bytes.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
protocoloslista de objetosOs protocolos que este documento cobre.
numeroProtocolotextoO número do protocolo na operadora.
numeroLotePrestadortextoO número que o prestador deu ao lote no arquivo enviado.
dataProtocolotextoA data do protocolo na operadora — a data de NEGÓCIO do documento de análise, e a que define a competência.
situacaotextoO estado do protocolo na língua da operadora, sem tradução.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
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.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de GlosaGlosas de nível PROTOCOLO. Não são distribuídas pelas guias: o documento não as atribuiu.
guiaslista de objetosAs guias do documento.
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.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
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.
senhatextoA senha de autorização que a operadora concedeu. É ela que autoriza a execução.
situacaotextoO estado da guia na língua da operadora, sem tradução — cada uma tem o seu vocabulário.
atendimentoDetextoPrimeiro dia do atendimento coberto pela guia.
atendimentoAtetextoÚltimo dia do atendimento coberto pela guia. Igual a atendimentoDe quando foi um dia só.
fonteOrdeminteiroQual dos arquivos do demonstrativo composto trouxe esta guia. Cruze com fontes[].ordem.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
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.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
glosaslista de GlosaAs glosas desta guia dentro deste documento.
totalDeGuiasinteiroQuantas guias o protocolo tem ao todo — inclusive as que o teto de 200 por resposta não trouxe.
temMaisGuiasbooleanoO protocolo tem mais guias do que o teto de 200 por resposta.
liquidacaolista de objetosO fechamento financeiro, UMA ENTRADA POR DATA DE CRÉDITO. Só em documento de pagamento; vazio na análise.
creditoEmtextoData em que o dinheiro caiu — a data de NEGÓCIO do documento de pagamento, e a que define a competência dele.
formatextoComo o dinheiro foi pago, como a operadora declarou (ex. crédito em conta).
bancotextoBanco do crédito, como o documento o informa.
agenciatextoAgência do crédito, como o documento a informa.
contatextoConta do crédito, como o documento a informa.
valoresobjetoAusência é null, nunca "0.00": zero é valor que a operadora declarou.
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.
glosatextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
debitoslista de objetosO que foi descontado do crédito do dia: impostos, taxas, acertos de período anterior.
tipotextoA natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior).
subtipotextoO detalhamento do tipo, quando a operadora o abre.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
creditoslista de objetosO que foi somado ao crédito do dia, fora as guias.
tipotextoA natureza do lançamento, como a operadora a nomeia (ex. imposto, taxa, glosa de período anterior).
subtipotextoO detalhamento do tipo, quando a operadora o abre.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totalDebitostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
totalCreditostextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
liquidotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.

Exemplo de retorno

{
  "data": {
    "id": "cmf3k2x9a0001dem",
    "tipo": "PAGAMENTO",
    "operadora": {
      "registroANS": "334561",
      "nome": "Unimed Blumenau"
    },
    "numeroDemonstrativo": "202607150001",
    "competencia": "2026-07",
    "creditoEm": "2026-07-15",
    "emitidoEm": "2026-08-02",
    "completude": "FULL",
    "profundidade": "C",
    "versaoTiss": "4.01.00",
    "valores": {
      "informado": "3.65",
      "processado": "3.65",
      "liberado": "3.56",
      "glosa": "0.09"
    },
    "protocolos": [
      {
        "numeroProtocolo": "4530775",
        "numeroLotePrestador": "2026070112",
        "dataProtocolo": "2026-07-10",
        "situacao": null,
        "valores": {
          "informado": "3.65",
          "processado": "3.65",
          "liberado": "3.56",
          "glosa": "0.09"
        },
        "glosas": [],
        "guias": [
          {
            "numeroGuiaPrestador": "000123",
            "numeroGuiaOperadora": "18700001",
            "carteira": null,
            "beneficiario": null,
            "senha": "18700001",
            "situacao": null,
            "atendimentoDe": null,
            "atendimentoAte": null,
            "fonteOrdem": null,
            "valores": {
              "informado": null,
              "processado": "3.65",
              "liberado": "3.56",
              "glosa": "0.09"
            },
            "glosas": []
          }
        ],
        "totalDeGuias": 42,
        "temMaisGuias": false
      }
    ],
    "guias": 42,
    "importadoEm": "2026-08-02T11:04:19.000Z",
    "liquidacao": [
      {
        "creditoEm": "2026-07-15",
        "forma": "CREDITO_EM_CONTA",
        "banco": "756",
        "agencia": "0101",
        "conta": "000000-0",
        "valores": {
          "informado": "3.65",
          "processado": "3.65",
          "liberado": "3.56",
          "glosa": "0.09"
        },
        "debitos": [
          {
            "tipo": "IMPOSTO",
            "subtipo": "ISS",
            "valor": "0.11"
          }
        ],
        "creditos": [],
        "totalDebitos": "0.11",
        "totalCreditos": "0.00",
        "liquido": "3.45"
      }
    ],
    "avisos": [],
    "fontes": [
      {
        "origem": "MENSAGEM_TISS",
        "papel": "FULL",
        "ordem": 0,
        "arquivo": {
          "id": "cmf3k2x9a0001tis",
          "nome": "demonstrativoRetorno-202607150001.xml",
          "extensao": "xml",
          "formato": "TISS_XML",
          "tamanhoBytes": null,
          "importadoEm": "2026-08-02T11:04:19.000Z"
        }
      }
    ]
  }
}

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_detalhe

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.