Recebimento
/v1/documentos-recebidos/{id}Um documento recebido, com o motivo de ter parado
- 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/documentos-recebidos/cmf3k2x9a0001aut \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | DocumentoRecebido | O recurso. Os campos estão na tabela abaixo. |
Tudo que chegou, por portal ou por upload — inclusive o que NÃO virou dado. Medido: de 14.838 arquivos, 1.413 pararam (946 sem identificação da operadora, 455 com erro, 12 rejeitados).
Campos de DocumentoRecebido
| Campo | Tipo | O que é |
|---|---|---|
| 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. |
| nomeArquivo | texto | O nome do arquivo como a fonte o nomeou. |
| extensao | texto | O invólucro. formato é o que conseguimos ler dele. |
| formato | texto | Em que formato o dado chegou. |
| tipoDocumento | texto | O que o identificador reconheceu no arquivo (ex. DEMONSTRATIVO_ANALISE). Nulo quando ele não reconheceu — e esses 946 arquivos são o motivo de esta rota existir. |
| tamanhoBytes | inteiro | Tamanho do arquivo em bytes. |
| situacao | objeto | Quatro valores públicos sobre quinze estados internos: a esteira é nossa, a pergunta é sua. |
| codigo | texto um de: EM_ANDAMENTO, PROCESSADO, PENDENTE, FALHOU | PROCESSADO virou dado consultável. PENDENTE parou esperando gente. FALHOU quebrou. Os dois últimos somam parados no resumo. |
| descricao | texto | O mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar. |
| estadoInterno | texto | Não é contrato — pode mudar. É o que o suporte pede quando algo trava. |
| operadora | objeto | 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. |
| competencia | texto | Mês AAAA-MM da data de NEGÓCIO do documento, em UTC — crédito na retenção, protocolo na glosa. NUNCA a data de emissão: o portal renderiza o documento no download, então a emissão é o dia em que nós baixamos. |
| recebidoEm | texto | Quando o arquivo chegou ao Miydas, em ISO 8601 com fuso. |
| processadoEm | texto | Quando o arquivo virou dado consultável, em ISO 8601 com fuso. null = ainda não virou. |
| totais | objeto | O que o leitor extraiu. Nulo em documento que não virou dado. |
| guias | inteiro | As guias do documento. |
| itens | inteiro | Quantas linhas de item o leitor extraiu do documento. |
| faturado | texto | Decimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes. |
| pago | 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. |
| confianca | número | Quanto o identificador confiou no palpite, de 0 a 1. |
| erro | texto | Prefixado pela FASE em que parou: triagem, processamento ou distribuição. |
| avisos | — | Avisos do leitor, no formato que o handler produziu. |
Exemplo de retorno
{
"data": {
"id": "cmf3k2x9a0001inb",
"nomeArquivo": "demonstrativo_202607.xml",
"extensao": "xml",
"formato": "XML_TISS_FORMAT",
"tipoDocumento": "DEMONSTRATIVO_PAGAMENTO",
"tamanhoBytes": 274732,
"situacao": {
"codigo": "PROCESSADO",
"descricao": "O documento virou dado: demonstrativo, guia e glosa já estão consultáveis.",
"estadoInterno": "INBOX_DISTRIBUIDO"
},
"operadora": {
"registroANS": "334561"
},
"competencia": "2026-07",
"recebidoEm": "2026-08-02T11:04:19.000Z",
"processadoEm": "2026-08-02T11:05:02.000Z",
"totais": {
"guias": 42,
"itens": 318,
"faturado": "12840.55",
"pago": "12104.31",
"glosa": "736.24"
},
"confianca": 0.98,
"erro": null,
"avisos": null
}
}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/documentos_obterA 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.