Kuenta Docs

Appearance

Listar mis créditos por pagar​

GET
/payables

Retorna la lista paginada de créditos que el usuario logueado debe pagar.
Incluye créditos en cualquier estado (activos, pagados, vencidos, etc.).

Nota: el endpoint de resumen agregado (/payables/summary) fue removido.
Para construir tarjetas tipo “estado de cuenta / home”, use este listado con:

  • status=5,6,7,10
  • include=summary,installmentInfo,phone

Authorizations​

test

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://test-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
stage

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://stage-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
demo

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://demo-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
prod

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones

Parameters​

Query Parameters

offset

Offset para paginación

Typeinteger
Example0
limit

Límite para paginación

Typeinteger
Example10
order

Ordenamiento del listado.

Formato recomendado: {field}:{asc|desc} (server-side validated).
Ej: updated_at:desc.

Campos permitidos: created_at, updated_at, principal, status, rate, consecutive, reference,
disbursed_at, released_date, credit_line_id_foreign_key.

Typestring
Exampleupdated_at:desc
q

Búsqueda por palabras clave (incluye documento y referencia).
Ej: q=1128467190.

Typestring
status

Estados del crédito. Permite un valor o lista separada por coma.
Ej: status=5,6,7,10 (FORMALIZADO, DESEMBOLSANDO, DESEMBOLSADO, MORA).

Typestring
Example5,6,7,10
include

Lista separada por coma para incluir campos opcionales:

  • parentID
  • summary
  • phone (teléfono del acreedor en creditor.phone)
  • installmentInfo (incluye nextInstallment.installmentId y nextInstallment.link)
Typestring
Examplesummary,installmentInfo,phone
statusCounts

Incluir conteo por estado en la respuesta

Typeboolean
Examplefalse
hasOverdueInstallments

Filtrar por créditos con mora (debt > 0 y debtDays > 0)

Typeboolean
hasPendingInstallment

Filtrar por créditos con cuota pendiente (balance > 0 y debt = 0)

Typeboolean

Responses​

Lista de payables obtenida exitosamente
application/json
JSON
{
"data": {
"credits": [
],
"statusCounts": {
"additionalProperties": 0
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI