​Listar Depósitos por Colaborador

Este endpoint permite listar os depósitos de um colaborador específico. Você pode filtrar por status (atualmente apenas "pending" é suportado) ou buscar todos os depósitos. Esta funcionalidade é especialmente útil para empresas que precisam realizar o cancelamento preventivo de benefícios para funcionários desligados.

URL: /api/deposits/employees/{employeeId}
Método: GET
Descrição: Lista os depósitos de um colaborador específico. Por padrão, retorna todos os depósitos. Use o parâmetro status=pending para filtrar apenas depósitos com status SCHEDULED (pendentes). Retorna 204 No Content caso o colaborador não possua depósitos.

Headers:

• x-flash-auth: <chave_api>

Parâmetros de Rota:

• employeeId - NanoID do colaborador

Parâmetros de Query:

• status - Status do depósito (opcional, valores aceitos: pending)
• page - Número da página (padrão: 1, mínimo: 1)
• limit - Número de itens por página (padrão: 100, mínimo: 1)

​Exemplos de Uso

​Exemplo 1: Buscar apenas depósitos pendentes

GET /api/deposits/employees/dKVK5lXpCQ6yxrApPqdl1?status=pending
bash

Resposta (200 OK):

{
  "data": [
    {
      "depositId": "INBmNtsWN0z2sjSxbW_ot",
      "orderId": "bwfxVpDph98tK8k2t0ecV",
      "employeeId": "dKVK5lXpCQ6yxrApPqdl1",
      "amount": 15000,
      "createdAt": "2025-12-01T10:30:00.000Z",
      "creditDate": "2025-12-20T00:00:00.000Z"
    }
  ],
  "page": 1,
  "limit": 100,
  "count": 1
}
json

​Exemplo 2: Buscar todos os depósitos (sem filtro)

GET /api/deposits/employees/dKVK5lXpCQ6yxrApPqdl1
bash

Resposta (200 OK):

{
  "data": [
    {
      "depositId": "INBmNtsWN0z2sjSxbW_ot",
      "orderId": "bwfxVpDph98tK8k2t0ecV",
      "employeeId": "dKVK5lXpCQ6yxrApPqdl1",
      "amount": 15000,
      "createdAt": "2025-12-01T10:30:00.000Z",
      "creditDate": "2025-12-20T00:00:00.000Z",
      "status": "scheduled"
    },
    {
      "depositId": "yGIeoX-UQgz3SrVE82gZy",
      "orderId": "PndDpsA1xWJ1jz4Y8e2D",
      "employeeId": "dKVK5lXpCQ6yxrApPqdl1",
      "amount": 20000,
      "createdAt": "2025-11-15T14:20:00.000Z",
      "creditDate": "2025-12-25T00:00:00.000Z",
      "status": "transferred"
    }
  ],
  "page": 1,
  "limit": 100,
  "count": 2
}
json

Campos da Resposta:

• data - Array de depósitos pendentes
  • depositId - NanoID do depósito
  • orderId - NanoID do pedido associado
  • employeeId - NanoID do colaborador
  • amount - Valor do depósito em centavos (ex: 15000 = R$ 150,00)
  • createdAt - Data de criação/solicitação do depósito (ISO 8601)
  • creditDate - Data prevista para pagamento/creditação (ISO 8601, opcional)
• page - Página atual
• limit - Limite de itens por página
• count - Total de depósitos pendentes encontrados

Resposta Sem Conteúdo (204 No Content): Retornado quando o colaborador não possui depósitos (ou não possui depósitos pendentes, se o filtro status=pending for usado).

​Notas Importantes

• ⚙️ Filtro Opcional: O parâmetro status é opcional. Se omitido, retorna todos os depósitos do colaborador.
• 🔍 Status Suportado: Atualmente, apenas o status pending é aceito como filtro.
• 📄 Paginação: Use os parâmetros page e limit para controlar a paginação dos resultados.
• ⚠️ Compatibilidade: Esta é uma versão atualizada do endpoint. O endpoint anterior /orders/deposits/pending/employee/{employeeId} está obsoleto.

​Casos de Uso

1. Cancelamento Preventivo: Use status=pending para identificar depósitos que ainda podem ser cancelados antes do desligamento de um colaborador.
2. Auditoria Completa: Omita o parâmetro status para visualizar todo o histórico de depósitos de um colaborador.
3. Reconciliação: Busque todos os depósitos para validar valores creditados versus planejados.

---