​Listar Depósitos

Este endpoint permite listar depósitos com diversos filtros opcionais, incluindo filtros por empresa, colaborador, pedido, status e intervalo de datas.

URL: /corporate-card/v1/deposits
Método: GET
Descrição: Lista depósitos com base nos filtros fornecidos.

Headers:

• Content-Type: 'application/json'
• x-flash-auth: <chave_de_api>

Parâmetros de Query:

• companyId: string (ID da empresa) *
• id: string | string[] (ID do depósito do colaborador) - Pode ser um único ID ou um array de IDs.
• status: 'PAID' | 'CANCELLED' | 'TRANSFERRED' | 'DEBITED' | Array - Status do depósito. Pode ser um único status ou um array de status.
• employeeId: string | string[] (ID do colaborador) - Pode ser um único ID ou um array de IDs.
• orderId: string | string[] (ID do pedido) - Pode ser um único ID ou um array de IDs.
• creditDateFrom: string (Data de início do intervalo de crédito) - (ex: 2025-01-01).
• creditDateTo: string (Data de fim do intervalo de crédito) - (ex: 2025-12-31).
• pageNumber: number (Número da página) - Padrão: 0.
• pageSize: number (Limite de registros por página) - Padrão: 10. Mínimo: 1. Máximo: 1000.

[*] Campo obrigatório

Exemplo de Requisição:

GET /corporate-card/v1/deposits?companyId=xwOztUdgSiNxEwc9R8Z2h&status=PAID&pageNumber=0&pageSize=10
bash

Exemplo com Múltiplos Filtros:

GET /corporate-card/v1/deposits?companyId=xwOztUdgSiNxEwc9R8Z2h&employeeId=TSA3fTuqfMYHfAtYNgpe7&status=PAID&status=TRANSFERRED&creditDateFrom=2025-01-01&creditDateTo=2025-12-31&pageNumber=0&pageSize=20
bash

Valores de Status:

• PAID - Pago
• CANCELLED - Cancelado
• TRANSFERRED - Transferido
• DEBITED - Debitado

Notas:

• O parâmetro companyId é obrigatório.
• Para filtrar por múltiplos valores (IDs, status, etc.), repita o parâmetro na query string ou passe como array.
• O intervalo de datas (creditDateFrom e creditDateTo) filtra depósitos pela data de crédito.
• A paginação começa em 0 para pageNumber.
• O pageSize máximo é 1000 registros por página.