Ogmma Revenue

Recebimento

GET/v1/documentos-recebidos

Tudo que chegou — e o que não virou dado

O documento antes de virar demonstrativo: o que o portal baixou e o que alguém subiu pela tela. O VALOR DESTA ROTA É O QUE FALHOU. Medido: de 14.838 arquivos recebidos, 12.591 viraram demonstrativo e 1.413 pararam — 946 sem identificação da operadora, 455 com erro de processamento, 12 rejeitados. Esse é o buraco invisível: o dado chegou, ninguém leu, e até agora não existia pergunta que o encontrasse. situacao tem quatro valores públicos sobre quinze estados internos. PENDENTE é o que parou esperando uma decisão; FALHOU é leitura que quebrou. situacao=PENDENTE é a fila de trabalho.

Escopo:
retorno:ler
Resposta:
200

Pedido

Parâmetros de query

CampoTipoO que é
situacaotexto
um de: EM_ANDAMENTO, PROCESSADO, PENDENTE, FALHOU
Onde o arquivo parou. PROCESSADO virou dado consultável; PENDENTE parou esperando alguém (não identificado, ou rejeitado); FALHOU quebrou no processamento. Os dois últimos são o valor desta rota.
registroANStexto
1–20 caracteres
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.
tipoDocumentotexto
1–40 caracteres
O tipo que o Miydas reconheceu no arquivo (ex. DEMONSTRATIVO_ANALISE, DEMONSTRATIVO_PAGAMENTO). Arquivo não identificado não tem tipo.
formatotexto
1–40 caracteres
Em que formato o dado chegou.
recebidoDetexto
formato AAAA-MM-DD
Recebidos a partir deste dia, AAAA-MM-DD. O intervalo é fechado: o dia informado entra.
recebidoAtetexto
formato AAAA-MM-DD
Recebidos até este dia, AAAA-MM-DD, inclusive — o dia inteiro entra.
buscatexto
2–120 caracteres
Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.
limiteinteiro
1–100 · padrão 50
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.

* 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/documentos-recebidos \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

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

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

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.
nomeArquivotextoO nome do arquivo como a fonte o nomeou.
extensaotextoO invólucro. formato é o que conseguimos ler dele.
formatotextoEm que formato o dado chegou.
tipoDocumentotextoO 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.
tamanhoBytesinteiroTamanho do arquivo em bytes.
situacaoobjetoQuatro valores públicos sobre quinze estados internos: a esteira é nossa, a pergunta é sua.
codigotexto
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.
descricaotextoO mesmo estado de situacao.codigo, em português, para mostrar a gente. O contrato é o código; esta frase pode mudar.
estadoInternotextoNão é contrato — pode mudar. É o que o suporte pede quando algo trava.
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.
competenciatextoMê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.
recebidoEmtextoQuando o arquivo chegou ao Miydas, em ISO 8601 com fuso.
processadoEmtextoQuando o arquivo virou dado consultável, em ISO 8601 com fuso. null = ainda não virou.
totaisobjetoO que o leitor extraiu. Nulo em documento que não virou dado.
guiasinteiroAs guias do documento.
itensinteiroQuantas linhas de item o leitor extraiu do documento.
faturadotextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
pagotextoDecimal 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.
confiancanúmeroQuanto o identificador confiou no palpite, de 0 a 1.
errotextoPrefixado 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
    }
  ],
  "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/documentos_listar

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

Esta rota não tem erro próprio: só os comuns a qualquer chamada com chave — chave ausente ou inválida, escopo insuficiente, parâmetro recusado e erro interno.

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.