Skip to main content
El recurso client.recovery responde a una pregunta: ¿cuánto se recuperó en un período, y qué lo explica? Expone tres métodos de solo lectura: summary, breakdown y list. Todos los métodos están acotados al workspace activo y validan su entrada en el cliente antes de enviar la petición: una entrada inválida lanza un ValidationError y nunca llega a la red. Un período son dos fechas from y to en formato YYYY-MM-DD, ambas incluidas, en la zona horaria del workspace. from debe ser igual o anterior a to.

Qué cuenta como una recuperación

QCobro registra una recuperación cuando una sincronización de cuentas muestra que se pagaron cuotas vencidas. Hay tres tipos (kind): En las salidas, missedInstallments son las cuotas que estaban vencidas y ahora están pagadas, y termsAmount es el importe de cada cuota. Consulta Sincronizar cuentas para enviarlas. Al registrar una recuperación, QCobro guarda una instantánea de las gestiones que tuvo la cuenta entre la sincronización anterior y la que la detectó: canal, resultado, campañas activas y días desde la última gestión. Esa instantánea nunca se recalcula, aunque después edites o elimines las campañas que nombra. Una recuperación cuenta en el período en que se detectó. Hay una excepción: si das motivo CAUGHT_UP o PAID_OFF a una salida que se registró sin motivo (UNKNOWN), la recuperación cuenta en la fecha en que la cuenta salió. Por eso la cifra de un período ya cerrado puede subir al clasificar salidas (ver Clasifica las salidas sin motivo).
QCobro solo ve lo que le envían tus exportaciones. Si no envías missedInstallments en las filas ni motivos en las salidas, no detecta ninguna recuperación.

Obtén el resumen de un período

summary devuelve el importe recuperado en el período, separado según la cuenta tuviera o no una gestión entre sincronizaciones, y cuántas salidas esperan todavía un motivo.
string
required
Fecha de inicio, incluida (YYYY-MM-DD).
string
required
Fecha de fin, incluida (YYYY-MM-DD).
string
Limita el resultado a una cartera.
number
Suma de las recuperaciones detectadas en el período cuya cuenta tuvo al menos una gestión entre sincronizaciones. Es la cifra de Recuperado.
number
Número de esas recuperaciones.
number
Suma de las recuperaciones del período sin ninguna gestión entre sincronizaciones.
number
Número de esas recuperaciones.
number
Salidas sin motivo (UNKNOWN) que siguen abiertas ahora, con el mismo filtro de cartera. No depende del período.
string
La moneda del workspace (por ejemplo DOP).

Desglosa lo recuperado

breakdown reparte la cifra de Recuperado (solo las recuperaciones con gestión) según una dimensión by. Las filas vienen ordenadas de mayor a menor importe.
string
required
Dimensión por la que agrupar. Ver la tabla de abajo.
string
required
Fecha de inicio, incluida (YYYY-MM-DD).
string
required
Fecha de fin, incluida (YYYY-MM-DD).
string
Limita el resultado a una cartera.
boolean
true cuando la suma de las filas es el total recuperado. Es false solo con CAMPAIGN.
array
Una fila por valor de la dimensión, con key, name (el nombre de la campaña con CAMPAIGN, null en las demás), amount (suma de importes) y count (número de recuperaciones).
Con CAMPAIGN, cada campaña activa en una cuenta recibe el importe completo de su recuperación. Una recuperación con dos campañas cuenta en las dos filas, así que no sumes las filas para obtener el total: usa summary.

Lista las recuperaciones

list devuelve una página de las recuperaciones detectadas en el período, de la más reciente a la más antigua, junto con el total.
string
required
Fecha de inicio, incluida (YYYY-MM-DD).
string
required
Fecha de fin, incluida (YYYY-MM-DD).
string
Limita el resultado a una cartera.
string
Solo las recuperaciones de este tipo: PARTIAL, CAUGHT_UP o PAID_OFF.
boolean
true para solo las que tuvieron una gestión entre sincronizaciones; false para solo las que no. Omítelo para todas.
number
default:"50"
Número máximo de recuperaciones a devolver (1–200).
number
default:"0"
Número de recuperaciones a omitir desde el inicio (para paginar).
Cada elemento de items describe una recuperación:
string
Id de la recuperación.
string
Id de la cartera.
string
Id de la cuenta en QCobro.
string
Tu identificador de la cuenta.
string
Nombre completo del titular.
string
PARTIAL, CAUGHT_UP o PAID_OFF.
number
Cuotas recuperadas.
number
Importe recuperado: installments × termsAmount.
string
Cuándo se detectó (ISO 8601). En una salida clasificada más tarde, la fecha en que la cuenta salió.
string
La sincronización anterior (ISO 8601): el inicio del intervalo de la instantánea.
object
La instantánea de las gestiones entre previousSyncAt y detectedAt:
  • hasGestion: si hubo al menos una gestión.
  • touches: número de gestiones.
  • activeCampaigns: las campañas de esas gestiones, cada una con id y name.
  • lastTouch: la última gestión (contactLogId, agentType, delivery, path, outcome, contactedAt), o null si no hubo ninguna.
  • daysSinceLastTouch: días enteros desde la última gestión hasta la sincronización, o null.

Siguientes pasos

Sincronizar cuentas

Envía las filas y las salidas de las que salen las recuperaciones.

Gestionar carteras

Lista las salidas de una cartera y clasifica las que salieron sin motivo.