GET Listar Movimentações

Retorna a lista de movimentações com filtros opcionais e paginação baseada em cursor.

Autenticação necessária

Esta rota requer o header Authorization: Bearer {accessToken}

---

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

Sobre o parâmetro search

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

Agregação por método

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": 43,
      "value": "7",
      "createdAt": "2025-12-22T11:39:45.101Z",
      "cancellationReason": null,
      "editReason": null,
      "paymentMethod": {
        "name": "PIX_PAGAMENTO_INSTANTANEO"
      },
      "movementsOptions": null,
      "status": {
        "name": "PAID"
      },
      "cashManagement": {
        "id": 12,
        "userOpening": {
          "name": "Roberto Luis"
        }
      },
      "budgets": [
        {
          "id": 25266,
          "patient": {
            "name": "ROBERT",
            "cpf": "45645645601"
          },
          "budgetsProcedures": [
            {
              "procedure": {
                "name": "TC - TEMPO DE COAGULACAO"
              }
            }
          ]
        }
      ],
      "appointments": []
    },
    {
      "id": 44,
      "value": "12",
      "createdAt": "2025-12-22T11:44:19.893Z",
      "cancellationReason": null,
      "editReason": "Correção de valor informado pelo cliente",
      "paymentMethod": {
        "name": "CARTAO_CREDITO"
      },
      "movementsOptions": {
        "flag": "Visa",
        "installments": 3
      },
      "status": {
        "name": "PAID"
      },
      "cashManagement": {
        "id": 12,
        "userOpening": {
          "name": "Roberto Luis"
        }
      },
      "budgets": [
        {
          "id": 25267,
          "patient": {
            "name": "ROBERT JR",
            "cpf": "00000000000"
          },
          "budgetsProcedures": [
            {
              "procedure": {
                "name": "VHS VELOCIDADE DE HEMOSSEDIMENTACAO"
              }
            }
          ]
        }
      ],
      "appointments": []
    }
  ],
  "aggregate": {
    "_count": {
      "_all": 4
    },
    "_sum": {
      "value": "219"
    }
  },
  "aggregateByPaymentMethod": [
    {
      "paymentMethod": "DINHEIRO",
      "aggregate": {
        "_sum": {
          "value": null
        }
      }
    },
    {
      "paymentMethod": "CARTAO_CREDITO",
      "aggregate": {
        "_sum": {
          "value": "200"
        }
      }
    },
    {
      "paymentMethod": "CARTAO_DEBITO",
      "aggregate": {
        "_sum": {
          "value": null
        }
      }
    },
    {
      "paymentMethod": "PIX_PAGAMENTO_INSTANTANEO",
      "aggregate": {
        "_sum": {
          "value": "19"
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": 44
  }
}