Devedores

Visao geral

Rotas para criar, listar, obter, atualizar e excluir (soft delete) devedores.

• Base: https://api.ascendteam.cloud/api/v1/debtors
• Autenticacao: requer sessao/credenciais validas do Better Auth (ver /docs/api/auth).

Modelo (campos principais)

• id (UUID)
• userId (UUID)
• name
• phone (opcional)
• email (opcional)
• city (opcional)
• state (opcional)
• deletedAt (opcional)
• createdAt
• updatedAt

Endpoints

POST /

Cria um novo devedor.

Body

• name (string, obrigatorio)
• phone (string, opcional)
• email (string, opcional)
• city (string, opcional)
• state (string, opcional)

Respostas

• 201: devedor criado
• 400: dados invalidos

GET /

Lista devedores (paginado).

Query

• search (string, opcional) - busca por nome, telefone ou email
• page (number, opcional, default 1)
• pageSize (number, opcional, default 20, max 100)
• includeDeleted (boolean, opcional, default false)

Resposta 200

• total, page, pageSize, items (array de devedores)

GET /export

Exporta clientes em CSV ou PDF.

Query

• search (string, opcional)
• includeDeleted (boolean, opcional, default false)
• format (csv | pdf, opcional, default csv)
• fields (lista separada por virgula; ex.: name,email,city)

Resposta 200

• Buffer do arquivo
• Content-Type: text/csv ou application/pdf
• Content-Disposition: attachment; filename="clientes-..."

GET /:id

Busca um devedor por ID.

Params

• id (UUID)

Respostas

• 200: devedor encontrado
• 404: devedor nao encontrado

PATCH /:id

Atualiza campos do devedor.

Params

• id (UUID)

Body

• name (string, opcional)
• phone (string, opcional)
• email (string, opcional)
• city (string, opcional)
• state (string, opcional)

Respostas

• 200: devedor atualizado
• 404: devedor nao encontrado

DELETE /:id

Soft delete do devedor.

Params

• id (UUID)

Respostas

• 200: devedor deletado
• 404: devedor nao encontrado

Observacoes

• Soft delete preenche deletedAt. Para listar excluidos, use includeDeleted=true.
• Quando campos opcionais nao sao informados na criacao, eles sao persistidos como null.