Kuenta Docs

Appearance

Listar deudores​

GET
/debtors

Obtiene la lista de todos los deudores (terceros) asociados a la organización del usuario actual. Permite filtros avanzados y paginación para gestionar grandes volúmenes de datos.

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Query Parameters

query

Texto para búsqueda por nombre, número de documento o email

Typestring
ExampleJuan Pérez
documentType

Tipo de documento

Typestring
Enum
CCCENITPASSPORTTI
ExampleCC
documentNumber

Número de documento específico

Typestring
Example12345678
status

Estado del deudor

Typestring
Enum
activeinactiveblockedpending
Exampleactive
cityCode

Código DANE de la ciudad

Typestring
Example11001
hasActiveCredits

Filtrar deudores con créditos activos

Typeboolean
Exampletrue
page

Número de página para paginación

Typeinteger
Example1
minimum1
default1
limit

Número de registros por página

Typeinteger
Example20
minimum1
maximum100
default20
sortBy

Campo para ordenar los resultados

Typestring
Enum
namedocumentNumbercreatedAtlastActivityAtcreditBalance
Examplename
defaultcreatedAt
sortOrder

Orden de clasificación

Typestring
Enum
ascdesc
Exampleasc
defaultdesc

Responses​

Lista de deudores obtenida exitosamente
application/json
JSON
{
"success": true,
"message": "success",
"data": {
"debtors": [
{
"ID": "123e4567-e89b-12d3-a456-426614174000",
"PersonalInfo": {
"FirstName": "Juan Carlos",
"LastName": "Pérez García",
"FullName": "Juan Carlos Pérez García",
"DocumentType": "CC",
"DocumentNumber": "12345678",
"Email": "[email protected]",
"Phone": "+57 300 123 4567",
"BirthDate": "1990-05-15",
"Gender": "M"
},
"Address": {
"Street": "Calle 123 #45-67",
"CityCode": "11001",
"CityName": "Bogotá",
"StateCode": "11",
"StateName": "Bogotá D.C.",
"CountryCode": "CO",
"PostalCode": "110111"
},
"CreditInfo": {
"TotalCredits": 3,
"ActiveCredits": 1,
"CompletedCredits": 2,
"TotalCreditAmount": "15000000.00",
"OutstandingBalance": "5000000.00",
"LastPaymentDate": "2024-01-10T14:30:00Z",
"CreditScore": 750,
"RiskLevel": "string"
},
"Status": "string",
"CreatedAt": "2023-12-01T10:00:00Z",
"UpdatedAt": "2024-01-15T16:45:00Z",
"LastActivityAt": "2024-01-15T14:30:00Z"
}
],
"pagination": {
"currentPage": 1,
"totalPages": 5,
"totalRecords": 95,
"hasNextPage": true,
"hasPreviousPage": false
},
"filters": {
"query": "Juan",
"status": "active",
"hasActiveCredits": true
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI