Skip to main content
Una cartera agrupa las cuentas de deuda que QCobro gestiona para un cliente. El recurso client.portfolios expone las operaciones sobre carteras como métodos tipados. Todos los métodos están acotados al workspace activo: necesitas un Client autenticado con un workspace seleccionado. Las entradas se validan en el cliente contra los esquemas compartidos de @qcobro/common antes de enviar la petición: una entrada inválida lanza un ValidationError y nunca llega a la red.

​
Lista las carteras

list devuelve las carteras del workspace activo. Por defecto omite las archivadas; pasa includeArchived: true para incluirlas. 
const portfolios = await client.portfolios.list();

// Incluye también las archivadas.
const all = await client.portfolios.list({ includeArchived: true });

​
Obtén una cartera

get devuelve una sola cartera por su id dentro del workspace activo. 
const portfolio = await client.portfolios.get({ id: "ptf_123" });

​
Crea una cartera

create necesita un name y un clientId (tu identificador del cliente al que pertenece la cartera). 
const portfolio = await client.portfolios.create({
  name: "Morosidad Q3",
  clientId: "acme"
});
​
name
string
required
Nombre visible de la cartera (1–120 caracteres).
​
clientId
string
required
Tu identificador del cliente al que pertenece la cartera (1–120 caracteres).

​
Actualiza o archiva una cartera

update cambia el nombre de una cartera o alterna su estado de archivado. Pon archived: true para archivarla y archived: false para restaurarla. 
// Renombra una cartera.
await client.portfolios.update({ id: "ptf_123", name: "Morosidad Q4" });

// Archívala.
await client.portfolios.update({ id: "ptf_123", archived: true });

// Restáurala.
await client.portfolios.update({ id: "ptf_123", archived: false });
​
id
string
required
Id de la cartera a actualizar.
​
name
string
Nuevo nombre (1–120 caracteres).
​
archived
boolean
true archiva la cartera; false la restaura.

​
Elimina una cartera

delete elimina una cartera del workspace activo. 
await client.portfolios.delete({ id: "ptf_123" });
Para retirar una cartera de la vista operativa conservando su historial, prefiere archivarla (update con archived: true) en lugar de eliminarla.

​
Lista las cuentas de una cartera

listAccounts devuelve una página de las cuentas de una cartera junto con el total. Acota la página con limit (1–200) y offset. 
const { accounts, total } = await client.portfolios.listAccounts({
  portfolioId: "ptf_123",
  limit: 50,
  offset: 0
});
​
portfolioId
string
required
Id de la cartera cuyas cuentas listar.
​
limit
number
Número máximo de cuentas a devolver (1–200).
​
offset
number
Número de cuentas a omitir desde el inicio (para paginar).

​
Siguientes pasos

Sincronizar cuentas

Carga y mantiene las cuentas de una cartera por lotes desde tu sistema de origen.

Validación y errores

Captura los fallos de validación del cliente y lee el detalle por campo.