Kuenta Docs

Appearance

Obtener cuenta por cobrar específica​

GET
/receivable/{id}

Obtiene los detalles completos de una cuenta por cobrar específica incluyendo información del crédito y perfil del deudor.

Información incluida:

  • Datos del crédito: Estado, montos, fechas, términos
  • Perfil del deudor: Información personal o empresarial
  • Historial de estados: Log de cambios (si está disponible)
  • Análisis crediticio: Resultados del scoring (si existe)

Casos de uso típicos:

  • Revisar detalles de un crédito específico
  • Verificar estado actual y historial
  • Obtener información del deudor para contacto
  • Preparar documentos de desembolso o cobranza

Resolución de configuración

La configuración de marca blanca se resuelve automáticamente a partir del contexto del crédito,
con la siguiente prioridad:

  1. credit.ConfigurationID (almacenado directamente)
  2. Configuración asociada via línea de crédito
  3. Entidad con una sola configuración
  4. Fallback a la organización de configuración

El campo configurationID se incluye en la respuesta del crédito.

Permisos requeridos:

  • read:receivables: Para acceso a datos del crédito
  • Usuario debe tener acceso a la organización propietaria

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​

Header Parameters

Configuration-ID

UUID de la configuración de marca blanca. Recomendado para resolución determinística.
Se resuelve automáticamente por hostname o entidad única si no se envía.

Typestring
Examplea1b2c3d4-e5f6-7890-abcd-ef1234567890
formatuuid
Organization-ID

UUID de la entidad activa. Opcional si el usuario tiene un solo rol.

Typestring
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Path Parameters

id*

ID único del crédito a obtener.

Formato: UUID v4
Validación: Debe corresponder a un crédito existente y accesible

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid

Query Parameters

include

Campos adicionales a incluir en la respuesta.

Opciones disponibles:

  • installments: Incluir cronograma de cuotas
  • logs: Incluir historial de cambios de estado
  • disbursements: Incluir información de desembolsos
  • analysis: Incluir resultados del análisis crediticio

Múltiples valores: Separar con comas

Typearray
Exampleinstallmentslogs

Responses​

Cuenta por cobrar obtenida exitosamente. La respuesta incluye todos los detalles del crédito y el perfil del deudor asociado.
application/json

Ejemplo de crédito en estado Approved con perfil completo del deudor

JSON
{
"data": {
"credit": {
"ID": "123e4567-e89b-12d3-a456-426614174000",
"creditorID": "456e7890-e89b-12d3-a456-426614174001",
"debtorID": "789e0123-e89b-12d3-a456-426614174002",
"creditLineID": "def5678e-e89b-12d3-a456-426614174004",
"creditAnalysisID": "123e4567-e89b-12d3-a456-426614174005",
"status": 2,
"principal": "50000.00",
"time": 30,
"rate": "0.025",
"debtRate": "0.035",
"source": "web",
"amortizationMethod": "VarPrincipalInterestV3",
"reference": "CRE-2023-001234",
"consecutive": 1234,
"note": "Cliente con historial crediticio favorable",
"userLastActionID": "123e4567-e89b-12d3-a456-426614174008",
"createdAt": "2023-12-01T10:30:00Z",
"updatedAt": "2023-12-01T15:45:30Z",
"releasedDate": "2023-12-02T09:00:00Z",
"documentsSigned": true,
"formsCompleted": true
},
"profile": {
"ID": "789e0123-e89b-12d3-a456-426614174002",
"type": "natural",
"entityID": "789e0123-e89b-12d3-a456-426614174002",
"natural": {
"profileID": "789e0123-e89b-12d3-a456-426614174002",
"status": true,
"firstName": "Juan Carlos",
"lastName": "Pérez García",
"email": "[email protected]",
"homePhone": "3001234567",
"idType": 1,
"idNumber": "12345678"
}
}
}
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI