GET/api/movements

Buscar todas as movimentações

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

Nome	Tipo	Obrig.	Descrição
`Authorization`	string	Sim	Token de autenticação no formato Bearer {accessToken}

AuthorizationOBRIGATÓRIO

Tipo:string

Token de autenticação no formato Bearer {accessToken}

Parâmetros

Nome	Tipo	Obrig.	Descrição
`limit`	number	Não	Limite de movimentos a serem retornados
`offset`	number	Não	Offset de movimentos a serem retornados
`cursor`	number	Não	Cursor de paginação
`search`	string	Não	Busca por descrição do movimento
`dataInital`	string	Não	Data inicial da busca (formato: YYYY-MM-DD)
`dataFinal`	string	Não	Data final da busca (formato: YYYY-MM-DD)
`user`	number	Não	ID do caixa

limitOPCIONAL

Tipo:number

Limite de movimentos a serem retornados

offsetOPCIONAL

Tipo:number

Offset de movimentos a serem retornados

cursorOPCIONAL

Tipo:number

Cursor de paginação

searchOPCIONAL

Tipo:string

Busca por descrição do movimento

dataInitalOPCIONAL

Tipo:string

Data inicial da busca (formato: YYYY-MM-DD)

dataFinalOPCIONAL

Tipo:string

Data final da busca (formato: YYYY-MM-DD)

userOPCIONAL

Tipo:number

ID do caixa

Request URL

https://api-dev.imagemais.com/api/movements?limit=50&offset=0&cursor=1&search=1234567890&dateInitial=2025-01-01&dateFinal=2025-01-01&user=1

Respostas

{
  "data": [
    {
  ...

{
  "data": [
    {
      "id": 43,
      "value": "7",
      "createdAt": "2025-12-22T11:39:45.101Z",
      "paymentMethod": {
        "name": "PIX_PAGAMENTO_INSTANTANEO"
      },
      "status": {
        "name": "PAID"
      },
      "cashManagement": {
        "userOpening": {
          "name": "Roberto Luis "
        }
      },
      "budgets": [
        {
          "patient": {
            "name": "ROBERT",
            "cpf": "45645645601"
          },
          "budgetsProcedures": [
            {
              "procedure": {
                "name": "TC - TEMPO DE COAGULACAO"
              }
            }
          ]
        }
      ]
    },
    {
      "id": 44,
      "value": "12",
      "createdAt": "2025-12-22T11:44:19.893Z",
      "paymentMethod": {
        "name": "PIX_PAGAMENTO_INSTANTANEO"
      },
      "status": {
        "name": "PAID"
      },
      "cashManagement": {
        "userOpening": {
          "name": "Roberto Luis "
        }
      },
      "budgets": [
        {
          "patient": {
            "name": "ROBERT JR",
            "cpf": "00000000000"
          },
          "budgetsProcedures": [
            {
              "procedure": {
                "name": "VHS VELOCIDADE DE HEMOSSEDIMENTACAO"
              }
            }
          ]
        }
      ]
    }
  ],
  "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
  }
}

{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
  ...

{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "invalid token"
  ...

{
  "statusCode": 401,
  "message": "invalid token"
}

{
  "statusCode": 401,
  "message": "jwt expired"
  ...

{
  "statusCode": 401,
  "message": "jwt expired"
}

{
  "statusCode": 500,
  "message": "Internal server error"
  ...

{
  "statusCode": 500,
  "message": "Internal server error"
}