Ogmma Revenue

Beneficiário

GET/v1/beneficiarios/{carteira}/linha-do-tempo

Tudo da carteirinha em ordem, de trás para frente

Cada elo tem o instante em que o fato ACONTECEU, não em que foi registrado: a guia entra pela data de execução, o pagamento pela data do crédito. Ordenar por registro poria a importação do demonstrativo depois do atendimento que ela descreve. Elo sem data é omitido.

Escopo:
beneficiario:ler
Resposta:
200

Pedido

Caminho

{carteira}*Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.

Parâmetros de query

CampoTipoO que é
limiteinteiro
1–200 · padrão 100
Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo.

* 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/beneficiarios/0012345678901234/linha-do-tempo \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

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

Um elo com o instante em que o fato ACONTECEU, não em que foi registrado — guia pela execução, pagamento pelo crédito. Elo sem data é omitido em vez de receber data inventada.

Campos de EloDaLinhaDoTempo

CampoTipoO que é
emtextoQuando este fato foi registrado, em ISO 8601 com fuso.
tipotexto
um de: GUIA_EXECUTADA, GUIA_PAGA, GLOSA, ELEGIBILIDADE, AUTORIZACAO
Que fato é este elo.
titulotextoO fato em uma linha, pronto para exibir na linha do tempo.
valortextoDecimal em string. null = a fonte não informou; "0.00" = informou zero. Os dois são diferentes.
referenciatextoO número de guia, quando há. Senão o id do recurso.

Exemplo de retorno

{
  "data": [
    {
      "em": "2026-09-12T00:00:00.000Z",
      "tipo": "GUIA_EXECUTADA",
      "titulo": "Atendimento executado",
      "valor": "240.00",
      "referencia": "000123"
    }
  ]
}

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/beneficiarios_linhaDoTempo

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.