GET Listar Movimentações
Retorna a lista de movimentações com filtros opcionais e paginação baseada em cursor.
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Exige a permissão read_movements.
Endpoint
GET https://api-dev.imagemais.com.br/api/movements
Parâmetros de Query
| Nome | Tipo | Obrigatório | Valores válidos | Descrição |
|---|---|---|---|---|
limit | number | ❌ | 0–100 | Itens por página |
cursor | number | ❌ | qualquer | Cursor para paginação |
search | string | ❌ | qualquer | Busca por nome ou CPF (11 dígitos) |
dateInitial | string | ❌ | YYYY-MM-DD | Data inicial do filtro |
dateFinal | string | ❌ | YYYY-MM-DD | Data final do filtro |
user | number | ❌ | qualquer | ID do usuário que abriu o caixa |
paymentMethod | string (enum) | ❌ | Ver Métodos de pagamento | Método de pagamento |
status | string (enum) | ❌ | PAID, PENDING, CANCELLED | Status da movimentação |
edited | boolean | ❌ | true, false | Filtrar apenas movimentações editadas |
offset | number | ❌ | inteiro; mín. 0 | Número da página atual |
A busca considera apenas o nome do paciente ou o CPF (quando o valor tem exatamente 11 dígitos). Não há busca por telefone.
Métodos de pagamento
O filtro paymentMethod aceita qualquer um dos valores abaixo:
BOLETO_BANCARIO, CARTAO_CREDITO, CARTAO_DEBITO, CARTEIRA_DIGITAL, CASHBACK, CHEQUE, CREDITO_LOJA, CREDITO_VIRTUAL, DEPOSITO_BANCARIO, DINHEIRO, OUTRO, DEBITO_AUTOMATICO, CARTAO_CREDITO_VIA_LINK, PIX_PAGAMENTO_INSTANTANEO, PIX_COBRANCA, PROGRAMA_FIDELIDADE, SEM_PAGAMENTO, TRANSFERENCIA_BANCARIA, VALE_ALIMENTACAO, VALE_COMBUSTIVEL, VALE_PRESENTE, VALE_REFEICAO
O campo aggregateByPaymentMethod da resposta sempre retorna apenas os 4 métodos principais: DINHEIRO, CARTAO_CREDITO, CARTAO_DEBITO e PIX_PAGAMENTO_INSTANTANEO.
Requisição
curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/movements?limit=50&cursor=1&dateInitial=2025-01-01&dateFinal=2025-01-01&user=1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'
Respostas
200 Sucesso
{
"data": [
{
"id": 1,
"value": "60",
"createdAt": "2026-07-17T19:06:31.283Z",
"cancellationReason": "Teste",
"editReason": "Teste de validação",
"paymentMethod": {
"name": "PIX_PAGAMENTO_INSTANTANEO"
},
"movementsOptions": null,
"status": {
"name": "CANCELLED"
},
"cashManagement": {
"id": 1,
"userOpening": {
"name": "Ana Ferreira Souza"
}
},
"budgets": [
{
"id": 13,
"patient": {
"name": "Maria Oliveira Santos",
"cpf": "12345678900"
},
"budgetsProcedures": [
{
"procedure": {
"name": "IGE ESP F14 - ALIMENTOS - SOJA - PF14 - SORO - QUIMIOLUMINESCENCIA"
}
}
]
}
],
"contaAzulDelivery": null,
"appointments": []
}
],
"aggregate": {
"_count": {
"_all": 80
},
"_sum": {
"value": "8894"
}
},
"aggregateByPaymentMethod": [
{
"paymentMethod": "DINHEIRO",
"aggregate": {
"_sum": {
"value": "188"
}
}
},
{
"paymentMethod": "CARTAO_CREDITO",
"aggregate": {
"_sum": {
"value": "144"
}
}
}
],
"pagination": {
"nextCursor": 1
}
}