Guias
/v1/guias/{id}/procedenciaDe 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
| data | ProcedenciaDaGuia | O 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
| Campo | Tipo | O que é |
|---|---|---|
| guia | objeto | A guia a que este registro pertence. |
| id | texto | 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. |
| numeroGuiaPrestador | texto | 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. |
| numeroGuiaOperadora | texto | O número que a OPERADORA deu à guia. Só existe depois que ela respondeu, e é o número que vale numa discussão com ela. |
| numeroLote | texto | O número do lote, como ele foi transmitido à operadora. |
| numeroProtocolo | texto | O número do protocolo na operadora. |
| operadora | texto | A operadora do documento, identificada pelo registro ANS. |
| registroANS | texto | 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. |
| beneficiario | texto | O 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. |
| carteirinha | texto | Número da carteirinha do beneficiário na operadora, como está no cartão. |
| dataExecucao | texto | Data em que o procedimento foi executado, AAAA-MM-DD. |
| statusConciliacao | inteiro | O veredito do motor de conciliação sobre esta guia. |
| conciliadaEm | texto | Quando a conciliação rodou sobre este registro, em ISO 8601 com fuso. |
| justificativa | texto | A justificativa registrada, em texto livre. |
| observacao | texto | Observação registrada, em texto livre. |
| envio | objeto | Nulo quando a guia nasceu do retorno: o portal não guarda o arquivo que o prestador mandou. |
| cobrado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| itens | inteiro | Quantas linhas o arquivo de envio trazia para esta guia. |
| arquivo | objeto | O arquivo de onde o dado veio. |
| id | texto | 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. |
| nome | texto | Nome do arquivo de onde o dado veio, como a operadora o nomeou. |
| extensao | texto | Extensão do arquivo, sem o ponto. |
| formato | texto | Em que formato o dado chegou. |
| importadoEm | texto | Quando este documento entrou no Miydas, em ISO 8601 com fuso. |
| analise | lista de objetos | Cada documento de ANÁLISE que falou desta guia. Mais de um é normal: a operadora reemite, e cada reemissão é uma linha aqui. |
| protocolo | texto | O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois. |
| demonstrativo | texto | O número do demonstrativo de onde este número veio. |
| emitidoEm | texto | A data do PROTOCOLO, não a emissão do demonstrativo — essa é o dia do download. |
| informado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| processado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| liberado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| glosa | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| completude | texto | O 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. |
| profundidade | texto | Até onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item. |
| fontes | lista de objetos | Os arquivos que compõem este documento — é o caminho de volta ao papel. |
| papel | texto | O que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro). |
| arquivo | objeto | O arquivo de onde o dado veio. |
| id | texto | 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. |
| nome | texto | Nome do arquivo de onde o dado veio, como a operadora o nomeou. |
| extensao | texto | Extensão do arquivo, sem o ponto. |
| formato | texto | Em que formato o dado chegou. |
| importadoEm | texto | Quando este documento entrou no Miydas, em ISO 8601 com fuso. |
| pagamento | lista de objetos | Cada documento de PAGAMENTO que falou desta guia. Mais de uma linha com datas de crédito diferentes é parcela; com a mesma data, é reemissão. |
| protocolo | texto | O protocolo que a operadora devolveu ao receber. É o número que prova a entrega e por onde se consulta o andamento depois. |
| demonstrativo | texto | O número do demonstrativo de onde este número veio. |
| pagoEm | texto | Sem reserva: ausente é ausente. |
| processado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| liberado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| glosa | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| liquidoDoDemonstrativo | texto | NÃO é o líquido desta guia. É o do documento, e os débitos são do DIA inteiro — costuma vir negativo. |
| completude | texto | O 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. |
| profundidade | texto | Até onde o documento desce: PROTOCOLO, GUIA ou ITEM. Documento que para na guia não permite recurso item a item. |
| fontes | lista de objetos | Os arquivos que compõem este documento — é o caminho de volta ao papel. |
| papel | texto | O que este arquivo carrega: ACCEPTED (só o aceito), GLOSA (só o recusado) ou FULL (o documento inteiro). |
| arquivo | objeto | O arquivo de onde o dado veio. |
| id | texto | 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. |
| nome | texto | Nome do arquivo de onde o dado veio, como a operadora o nomeou. |
| extensao | texto | Extensão do arquivo, sem o ponto. |
| formato | texto | Em que formato o dado chegou. |
| importadoEm | texto | Quando 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_procedenciaA 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ódigo | HTTP | Quando | O que fazer |
|---|---|---|---|
| RECURSO_NAO_ENCONTRADO | 404 | O 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.