Saltar al contenido principal
GET
Obtener cuentas de un usuario

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de ruta

email
string<email>
requerido

Email del usuario. Si el email contiene el carácter +, envíalo codificado como %2B.

Respuesta

Lista de cuentas del usuario.

businessName
string
requerido

Razón social de la empresa de la cuenta.

Ejemplo:

"Cliente Ejemplo SpA"

id
string
requerido

Identificador tributario de la empresa (RUT o Nit, sin puntos y con guion). Es igual a identifier.

Ejemplo:

"76111111-6"

identifier
string
requerido

Identificador tributario de la empresa (RUT o Nit, sin puntos y con guion).

Ejemplo:

"76111111-6"

country
enum<string>
requerido

País de la empresa (código ISO 3166-1 alpha-2).

Opciones disponibles:
CL,
CO,
PE
Ejemplo:

"CL"

active
boolean
requerido

Indica si la cuenta está conectada, es decir, si la empresa ya enroló sus credenciales y Pruff puede extraer sus datos.

Ejemplo:

true

pausedAt
string<date-time> | null
requerido

Fecha y hora (ISO 8601, UTC) en que la cuenta se eliminó. Es null si la cuenta no está eliminada.

Ejemplo:

null

deactivatedAt
string<date-time> | null
requerido

Fecha y hora (ISO 8601, UTC) en que la cuenta se desconectó. Es null si no se ha desconectado.

Ejemplo:

null

createdAt
string<date-time>
requerido

Fecha y hora (ISO 8601, UTC) en que se creó la cuenta.

Ejemplo:

"2025-03-04T15:10:41.905Z"

lastExtraction
string<date-time>
requerido

Fecha y hora (ISO 8601, UTC) de la última extracción de facturas de la empresa. Si aún no hay extracciones, es la fecha de creación de la cuenta.

Ejemplo:

"2025-03-04T15:14:09.552Z"

status
enum<string>
requerido

Estado de la cuenta: No Conectado si la cuenta no está activa, Eliminado si está activa pero fue eliminada, y Conectado en otro caso.

Opciones disponibles:
Conectado,
No Conectado,
Eliminado
Ejemplo:

"Conectado"

activatedAt
string<date-time> | null

Fecha y hora (ISO 8601, UTC) en que la cuenta se conectó. Es null si aún no se conecta. Solo viene cuando el usuario puede ver todas las cuentas de tu empresa.

Ejemplo:

"2025-03-04T15:10:42.318Z"

enrolledPath
string | null

Canal por el que se enroló la cuenta (por ejemplo public o api). Es null si no se registró. Solo viene cuando el usuario puede ver todas las cuentas de tu empresa.

Ejemplo:

"public"

enrolledBy
string | null

Nombre del usuario que enroló la cuenta. No viene si no se registró quién la enroló, y es null si ese usuario no tiene nombre. Solo viene cuando el usuario puede ver todas las cuentas de tu empresa.

Ejemplo:

"Ana Pérez"

users
string

Nombres de los usuarios comerciales asignados a la cuenta, separados por coma. Es una cadena vacía si no hay ninguno. Solo viene cuando el usuario puede ver todas las cuentas de tu empresa.

Ejemplo:

"Ana Pérez"