Kuenta Docs

Appearance

Crear nueva cuenta por cobrar​

POST
/receivables

Crea una nueva cuenta por cobrar (receivable) en el sistema Kuenta.

📊 Estados del Crédito (CreditStatus):

Los créditos pueden tener los siguientes estados (valores numéricos):

  • 0 - InProcess: En proceso de análisis y aprobación
  • 1 - Pending: Pendiente de aprobación manual
  • 2 - Approved: Aprobado, listo para formalización
  • 3 - Rejected: Rechazado por políticas o scoring
  • 4 - Failed: Fallido en el proceso
  • 5 - Formalized: Formalizado, listo para desembolso
  • 6 - Disbursing: En proceso de desembolso
  • 7 - Disbursed: Desembolsado al deudor
  • 8 - Paid: Completamente pagado
  • 9 - Desisted: Desistido por el cliente
  • 10 - Delinquent: En mora o incumplimiento
  • 11 - Undelivered: No reclamado
  • 12 - Simulation: Simulación (no real)
  • 13 - AwaitingForm: Incompleto, esperando formularios
  • 14 - AwaitingCheck: En verificación
  • 15 - NonPerformingLoan: Castigado
  • 16 - AwaitingPayment: Pago pendiente
  • 17 - Colateral: Esperando garantías

Proceso de creación:

  1. Validación: Se validan los datos de entrada contra el schema del crédito
  2. Asignación automática: El CreditorID se asigna automáticamente desde la sesión
  3. Creación: Se crea el crédito con estado inicial (InProcess = 0)
  4. Análisis: Se inicia automáticamente el proceso de análisis crediticio

Campos requeridos:

  • debtorID: Debe corresponder a una entidad previamente registrada
  • creditLineID: Línea de crédito que autoriza esta operación
  • principal: Monto del crédito (validado contra límites de la línea)
  • time: Plazo en días
  • rate: Tasa de interés mensual

Estados iniciales:

  • Estado: InProcess (0) - En proceso de análisis
  • CreditorID: Asignado automáticamente desde la sesión autenticada
  • Fechas: CreatedAt y UpdatedAt establecidas automáticamente

Flujo posterior:

Después de la creación, el crédito pasa por análisis automático que puede resultar en:

  • Aprobación automática: Estado 2 (Approved) - Si cumple todas las políticas
  • Pendiente manual: Estado 1 (Pending) - Si requiere revisión humana
  • Rechazo automático: Estado 3 (Rejected) - Si no cumple criterios básicos

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

Config-Organization-ID*

ID de configuración de la organización.
Formato: UUID v4

Typestring
Required
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
Organization-ID*

ID de la organización que está creando el crédito.
Formato: UUID v4

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

Request Body​

application/json

Ejemplo de crédito comercial con configuración mínima

JSON
{
"debtorID": "789e1234-e89b-12d3-a456-426614174002",
"creditLineID": "456e7890-e89b-12d3-a456-426614174001",
"principal": 50000,
"time": 30,
"rate": 0.025,
"debtRate": 0.035,
"reference": "CRE-2023-001234",
"source": "web"
}

Responses​

Crédito creado exitosamente. El crédito se crea con estado inicial `InProcess (0)` y se inicia automáticamente el proceso de análisis crediticio.
application/json

Ejemplo de crédito creado exitosamente en estado inicial de análisis

JSON
{
"data": {
"credit": {
"ID": "123e4567-e89b-12d3-a456-426614174000",
"creditorID": "012e5678-e89b-12d3-a456-426614174003",
"debtorID": "789e1234-e89b-12d3-a456-426614174002",
"creditLineID": "456e7890-e89b-12d3-a456-426614174001",
"creditAnalysisID": "123e4567-e89b-12d3-a456-426614174005",
"principal": "50000.00",
"time": 30,
"rate": "0.025",
"debtRate": "0.035",
"status": 0,
"reference": "CRE-2023-001234",
"consecutive": 1234,
"source": "web",
"amortizationMethod": "VarPrincipalInterestV3",
"userLastActionID": "123e4567-e89b-12d3-a456-426614174008",
"createdAt": "2023-12-01T10:30:00Z",
"updatedAt": "2023-12-01T10:30:00Z"
},
"message": "Crédito creado exitosamente. Análisis crediticio iniciado."
}
}

Playground​

Server
Authorization
Headers
Body

Samples​

Powered by VitePress OpenAPI