Listar Relatórios

Utilize este endpoint para listar relatórios com filtros e paginação.

Ambientes Disponíveis

Produção

https://api.unoip.com.br

Endpoint

• Método: GET
• Endpoint: /report
• Autenticação: Bearer token

Query Params

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

• 2026-03-06T12:00:00.000Z

Nome	Tipo	Obrigatório	Descrição	Validações
page	number	Não	Página	Inteiro entre 1 e 1
perPage	number	Não	Itens por página	Inteiro entre 1 e 50
startDate	string	Não	Data inicial do filtro	Deve ser ISO date string com horário
endDate	string	Não	Data final do filtro	Deve ser ISO date string com horário
status	string[] (enum) - PENDING, PROCESSING, FAILED, PROCESSED	Não	Lista de status	Deve ser um array não vazio e sem duplicados
type	string[] (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT	Não	Lista de tipos de relatório	Deve ser um array não vazio e sem duplicados
origin	string[] (enum) - ADMIN, USER	Não	Origem do relatório	Deve ser um array não vazio e sem duplicados
id	string (UUID v4)	Não	Identificador do relatório	Deve ser UUID v4 válido
userName	string	Não	Nome do usuário	Máximo de 255 caracteres
userEmail	string	Não	E-mail do usuário	Deve ser um e-mail válido

Exemplo de Requisição

cURL

curl --request GET \
--url "https://api.unoip.com.br/report?status=PROCESSED&type=TRANSACTION&origin=USER&page=1&perPage=15" \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const params = new URLSearchParams({
  status: 'PROCESSED',
  type: 'TRANSACTION',
  origin: 'USER',
  page: '1',
  perPage: '15'
});

const response = await fetch(`https://api.unoip.com.br/report?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});
const data = await response.json();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
total	number	Sim	Total de itens
totalPages	number	Sim	Total de páginas
currentPage	number	Sim	Página atual
perPage	number	Sim	Itens por página
data	array	Sim	Lista de relatórios (ver Sub-Objeto Item da Lista)

Sub-Objetos

Item da Lista

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do relatório
status	string (enum)	Sim	Status do relatório (PENDING, PROCESSING, FAILED, PROCESSED)
type	string (enum)	Sim	Tipo do relatório (TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT)
user	object	Sim	Dados do usuário (ver Sub-Objeto Usuário)
origin	string (enum)	Não	Origem do relatório (ADMIN, USER)
filters	object	Sim	Filtros usados no relatório (ver Sub-Objeto Filtros)
file	object	Não	Arquivo do relatório (ver Sub-Objeto Arquivo)
expirationDate	string (ISO)	Não	Data de expiração do arquivo
errorMessage	string	Não	Mensagem de erro
createdAt	string (ISO)	Sim	Data de criação
updatedAt	string (ISO)	Sim	Data da última atualização

Usuário

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do usuário
name	string	Sim	Nome do usuário
email	string	Sim	E-mail do usuário

Filtros

Campo	Tipo	Obrigatório	Descrição
startDate	string	Sim	Data inicial do filtro
endDate	string	Sim	Data final do filtro
storeId	string (UUID v4)	Não	Identificador da loja
userId	string (UUID v4)	Não	Identificador do usuário
status	string[]	Não	Lista de status aplicados
paymentMethod	string[]	Não	Métodos de pagamento
acquirer	string[]	Não	Adquirentes do relatório

Arquivo

Campo	Tipo	Obrigatório	Descrição
key	string	Sim	Chave do arquivo
isPrivate	boolean	Sim	Indica se o arquivo é privado
url	string	Sim	Url para acessar o arquivo

Exemplo de Resposta

{
  "total": 1,
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "status": "PROCESSED",
      "type": "TRANSACTION",
      "user": {
        "id": "553e8400-e29b-41d4-a716-436251480111",
        "name": "Loja Exemplo",
        "email": "contato@lojaexemplo.com"
      },
      "origin": "USER",
      "filters": {
        "startDate": "2026-03-06T00:00:00.000Z",
        "endDate": "2026-03-06T23:59:59.999Z",
        "status": ["PAID"],
        "paymentMethod": ["PIX"]
      },
      "file": {
        "key": "report-2026-03-06-553e8400-e29b-41d4-a716-436251480000-CSV",
        "isPrivate": true,
        "url": "signed-url",
      },
      "expirationDate": null,
      "errorMessage": null,
      "createdAt": "2026-03-06T12:49:04.681Z",
      "updatedAt": "2026-03-06T12:49:04.681Z"
    }
  ]
}

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
422	Dados inválidos ou faltando	Verifique o formato dos dados
422	Validações	Contate o suporte
500	Erro interno	Contate o suporte