Saltar al contenido principal
GET
Obtener deuda cliente

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de ruta

identifier
string
requerido

RUT del cliente, sin puntos, con guion y con la K del dígito verificador en mayúscula (por ejemplo 76111111-6). También se acepta un NIT colombiano con el formato XXXXXXXXX-Y. Un identificador que no es un RUT ni un NIT válido responde 400. Envía el RUT con su dígito verificador correcto.

Pattern: ^(\d{1,8}-[\dK]|\d{1,15}-\d)$
Ejemplo:

"76111111-6"

Respuesta

Deuda del cliente, o respuesta vacía si no hay consulta registrada.

data
object | null
requerido

Todos los períodos de deuda que Pruff tiene registrados para el cliente, acumulados de todas sus consultas. null si el cliente nunca ha sido consultado o si la consulta no trajo filas de deuda.

lastUpdate
string<date-time> | null
requerido

Fecha y hora de la última consulta de deuda realizada para el cliente (no la de tu solicitud), en ISO 8601. null si nunca ha sido consultado.