Recebimento
/v1/documentos-recebidos/resumoDe tudo que chegou, quanto virou dado
- Escopo:
- retorno:ler
- Resposta:
- 200
Pedido
Parâmetros de query
| Campo | Tipo | O que é |
|---|---|---|
| situacao | texto 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. |
| registroANS | texto 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. |
| tipoDocumento | texto 1–40 caracteres | O tipo que o Miydas reconheceu no arquivo (ex. DEMONSTRATIVO_ANALISE, DEMONSTRATIVO_PAGAMENTO). Arquivo não identificado não tem tipo. |
| formato | texto 1–40 caracteres | Em que formato o dado chegou. |
| recebidoDe | texto formato AAAA-MM-DD | Recebidos a partir deste dia, AAAA-MM-DD. O intervalo é fechado: o dia informado entra. |
| recebidoAte | texto formato AAAA-MM-DD | Recebidos até este dia, AAAA-MM-DD, inclusive — o dia inteiro entra. |
| busca | texto 2–120 caracteres | Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa. |
| limite | inteiro 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. |
| deslocamento | inteiro 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/resumo \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | ResumoDeDocumentos | O recurso. Os campos estão na tabela abaixo. |
De tudo que chegou, quanto virou dado — e quanto parou.
Campos de ResumoDeDocumentos
| Campo | Tipo | O que é |
|---|---|---|
| total | inteiro | O total do recorte pedido. |
| parados | inteiro | PENDENTE + FALHOU: chegou e não virou dado. É o número que importa. |
| porSituacao | lista de objetos | Os mesmos números, abertos por situação. |
| situacao | texto | A situação, no código que a rota devolve. |
| documentos | inteiro | Quantos documentos estão nesta situação. |
| porEstadoInterno | lista de objetos | A mesma contagem pelos quinze estados da nossa esteira. Não é contrato — serve para pedir suporte sabendo onde parou. |
| estadoInterno | texto | O estado da esteira interna. Pode mudar sem aviso. |
| documentos | inteiro | Quantos documentos estão neste estado interno. |
Exemplo de retorno
{
"data": {
"total": 14838,
"parados": 1413,
"porSituacao": [
{
"situacao": "EM_ANDAMENTO",
"documentos": 1
},
{
"situacao": "PROCESSADO",
"documentos": 13424
},
{
"situacao": "PENDENTE",
"documentos": 946
},
{
"situacao": "FALHOU",
"documentos": 467
}
],
"porEstadoInterno": [
{
"estadoInterno": "INBOX_DISTRIBUIDO",
"documentos": 12591
},
{
"estadoInterno": "INBOX_PENDENTE_IDENTIFICACAO",
"documentos": 946
}
]
}
}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_resumoA 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.