Ogmma Revenue

Guias

GET/v1/guias/{id}/procedencia

De onde veio cada número desta guia

O arquivo de envio e os documentos de retorno, com o que cada um sabia (completude e profundidade). É o que separa "a operadora não glosou" de "o arquivo que declara glosa não chegou". envio é nulo em quase toda guia, e não é defeito: o portal devolve o JULGAMENTO da operadora, ele não guarda o arquivo que o prestador mandou. Medido, 14 das 40.760 guias têm camada de envio.

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.

Exemplo de chamada

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

Resposta 200

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

De onde veio cada número desta guia — o arquivo de envio e os documentos de retorno, com o que cada um sabia.

Campos de ProcedenciaDaGuia

CampoTipoO que é
guiaobjetoA guia a que este registro pertence.
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.
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.
numeroLotetextoO número do lote, como ele foi transmitido à operadora.
numeroProtocolotextoO número do protocolo na operadora.
operadoratextoA 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.
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.
carteirinhatextoNúmero da carteirinha do beneficiário na operadora, como está no cartão.
dataExecucaotextoData em que o procedimento foi executado, AAAA-MM-DD.
statusConciliacaointeiroO veredito do motor de conciliação sobre esta guia.
conciliadaEmtextoQuando a conciliação rodou sobre este registro, em ISO 8601 com fuso.
justificativatextoA justificativa registrada, em texto livre.
observacaotextoObservação registrada, em texto livre.
envioobjetoNulo quando a guia nasceu do retorno: o portal não guarda o arquivo que o prestador mandou.
cobradotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
itensinteiroQuantas linhas o arquivo de envio trazia para esta guia.
arquivoobjetoO arquivo de onde o dado veio.
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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
analiselista de objetosCada documento de ANÁLISE que falou desta guia. Mais de um é normal: a operadora reemite, e cada reemissão é uma linha aqui.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
demonstrativotextoO número do demonstrativo de onde este número veio.
emitidoEmtextoA data do PROTOCOLO, não a emissão do demonstrativo — essa é o dia do download.
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.
completudetextoO quanto do documento a operadora mandou: FULL (a conta toda), ACCEPTED_ONLY (só o aceito) ou GLOSA_ONLY (só o recusado). Somar valores de documentos de completudes diferentes dá número errado.
profundidadetextoAté onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item.
fonteslista de objetosOs arquivos que compõem este documento — é o caminho de volta ao papel.
papeltextoO que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro).
arquivoobjetoO arquivo de onde o dado veio.
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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.
pagamentolista de objetosCada documento de PAGAMENTO que falou desta guia. Mais de uma linha com datas de crédito diferentes é parcela; com a mesma data, é reemissão.
protocolotextoO protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois.
demonstrativotextoO número do demonstrativo de onde este número veio.
pagoEmtextoSem reserva: ausente é ausente.
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.
liquidoDoDemonstrativotextoNÃO é o líquido desta guia. É o do documento, e os débitos são do DIA inteiro — costuma vir negativo.
completudetextoO quanto do documento a operadora mandou: FULL (a conta toda), ACCEPTED_ONLY (só o aceito) ou GLOSA_ONLY (só o recusado). Somar valores de documentos de completudes diferentes dá número errado.
profundidadetextoAté onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item.
fonteslista de objetosOs arquivos que compõem este documento — é o caminho de volta ao papel.
papeltextoO que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro).
arquivoobjetoO arquivo de onde o dado veio.
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.
nometextoNome do arquivo de onde o dado veio, como a operadora o nomeou.
extensaotextoExtensão do arquivo, sem o ponto.
formatotextoEm que formato o dado chegou.
importadoEmtextoQuando este documento entrou no Miydas, em ISO 8601 com fuso.

Exemplo de retorno

{
  "data": {
    "guia": {
      "id": "cmf3k2x9a0001gui",
      "numeroGuiaPrestador": "000123",
      "numeroGuiaOperadora": "18700001",
      "numeroLote": "2026070112",
      "numeroProtocolo": "4530775",
      "operadora": "Unimed Blumenau",
      "registroANS": "334561",
      "beneficiario": "PACIENTE EXEMPLO",
      "carteirinha": "00000000000000000",
      "dataExecucao": "2026-07-02T00:00:00.000Z",
      "statusConciliacao": 1,
      "conciliadaEm": "2026-08-02T11:05:00.000Z",
      "justificativa": null,
      "observacao": null
    },
    "envio": null,
    "analise": [
      {
        "protocolo": "4530775",
        "demonstrativo": "202607100001",
        "emitidoEm": "2026-07-10T00:00:00.000Z",
        "informado": "3.65",
        "processado": "3.65",
        "liberado": "3.56",
        "glosa": "0.09",
        "completude": "FULL",
        "profundidade": "A",
        "fontes": [
          {
            "papel": "FULL",
            "arquivo": {
              "id": "cmf3k2x9a0001inb",
              "nome": "dem_4530775.xml",
              "extensao": "xml",
              "formato": "TISS_XML",
              "importadoEm": "2026-07-11T08:12:44.000Z"
            }
          }
        ]
      }
    ],
    "pagamento": []
  }
}

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_procedencia

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.