Kuenta Docs

Appearance

Listar todas las facturas​

GET
/bills

Obtiene la lista de todas las facturas generadas para la organización. Permite filtros avanzados por fechas, estados, montos y paginación para gestionar grandes volúmenes de datos de facturación.

Authorizations​

bearerAuth

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

TypeHTTP (bearer)

Parameters​

Query Parameters

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
startDate

Fecha de inicio para filtrar facturas (formato YYYY-MM-DD)

Typestring
Example2024-01-01
formatdate
endDate

Fecha de fin para filtrar facturas (formato YYYY-MM-DD)

Typestring
Example2024-01-31
formatdate
status

Estado de la factura

Typestring
Enum
pendingpaidoverduecancelledrefunded
Examplepaid
subscriptionId

ID de la suscripción específica

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

Monto mínimo de la factura

Typestring
Example100000.00
pattern^\d+(\.\d{1,2})?$
maxAmount

Monto máximo de la factura

Typestring
Example5000000.00
pattern^\d+(\.\d{1,2})?$
billingPeriod

Período de facturación (formato YYYY-MM)

Typestring
Example2024-01
pattern^\d{4}-\d{2}$
serviceType

Tipo de servicio facturado

Typestring
Enum
credit_analysisdocument_verificationidentity_checkliveness_detectionapi_usagesubscription
Examplecredit_analysis
sortBy

Campo para ordenar los resultados

Typestring
Enum
billDatedueDateamountstatussubscriptionId
ExamplebillDate
defaultbillDate
sortOrder

Orden de clasificación

Typestring
Enum
ascdesc
Exampledesc
defaultdesc

Responses​

Lista de facturas obtenida exitosamente
application/json
JSON
{
"success": true,
"message": "success",
"data": {
"bills": [
{
"billId": "456b7890-c123-45d6-e789-012345678901",
"billNumber": "BILL-20240115-0001",
"subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
"subscriptionName": "Plan Empresarial Premium",
"billingPeriod": {
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"description": "Enero 2024"
},
"billDate": "2024-02-01",
"dueDate": "2024-02-15",
"status": "string",
"serviceBreakdown": [
{
"serviceType": "credit_analysis",
"serviceName": "Análisis de Crédito Premium",
"quantity": 150,
"unitPrice": "5000.00",
"totalAmount": "750000.00",
"period": "2024-01-01 al 2024-01-31"
}
],
"amounts": {
"subtotal": "1150000.00",
"discounts": "115000.00",
"taxAmount": "196650.00",
"taxRate": 19,
"totalAmount": "1231650.00",
"currency": "COP"
},
"paymentInfo": {
"paymentDate": "2024-02-10T14:30:00Z",
"paymentMethod": "bank_transfer",
"transactionId": "TXN-240210-456789",
"paymentReference": "REF-240210-KUENTA-001"
},
"organizationInfo": {
"organizationId": "789f0123-4567-89ab-cdef-012345678901",
"organizationName": "Fintech Innovadora S.A.S.",
"taxId": "900123456-7",
"billingAddress": "Calle 100 #15-20, Bogotá, Colombia"
},
"downloadUrls": {
"pdf": "https://api.kuenta.co/bills/456b7890-c123-45d6-e789-012345678901/pdf",
"xml": "https://api.kuenta.co/bills/456b7890-c123-45d6-e789-012345678901/xml"
},
"createdAt": "2024-02-01T09:00:00Z",
"updatedAt": "2024-02-10T14:30:00Z"
}
],
"pagination": {
"currentPage": 1,
"totalPages": 8,
"totalRecords": 156,
"hasNextPage": true,
"hasPreviousPage": false
},
"summary": {
"totalAmount": "15678450.00",
"paidAmount": "12540000.00",
"pendingAmount": "3138450.00",
"overdueAmount": "456200.00",
"statusCounts": {
"pending": 12,
"paid": 140,
"overdue": 3,
"cancelled": 1
}
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI