Portal de Documentación de Logicware CRM

Stock de Unidades

Obtiene el inventario disponible de unidades para un proyecto y etapa específicos, incluyendo información detallada de dimensiones, precios y estado de disponibilidad.

Consultar Stock de Unidades

GET /external/units/stock?projectCode={code}&stageId={id}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros Query

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Product stock retrieved successfully",
  "data": {
    "properties": [
      {
        "id": 1223,
        "stageName": "ETAPA 2",
        "blockName": "MZ E2",
        "code": "E2-01",
        "description": "",
        "remarks": "",
        "areaSqm": 108.00,
        "dimensions": {
          "front": 6.00,
          "right": 18.00,
          "left": 18.00,
          "back": 6.00
        },
        "pricePerSqm": 520.93,
        "totalPrice": 56260.58,
        "currency": "PEN",
        "status": "Disponible"
      },
      {
        "id": 1224,
        "stageName": "ETAPA 2",
        "blockName": "MZ E2",
        "code": "E2-02",
        "description": "Lote esquinero con vista panorámica",
        "remarks": "Ubicación privilegiada, frente a parque",
        "areaSqm": 120.00,
        "dimensions": {
          "front": 8.00,
          "right": 15.00,
          "left": 15.00,
          "back": 8.00
        },
        "pricePerSqm": 520.83,
        "totalPrice": 62500.00,
        "currency": "PEN",
        "status": "Reservado"
      }
    ],
    "summary": {
      "total": 2,
      "available": 1,
      "reserved": 1,
      "sold": 0
    }
  },
  "statusCode": 200
}

Campos de la Unidad

Estados de Unidad

• Disponible: Unidad lista para venta, sin restricciones
• Reservado: Unidad con reserva activa de un cliente
• Vendido: Unidad ya vendida, no disponible
• Bloqueado: Unidad temporalmente no disponible para venta

Campos del Resumen (Summary)

Códigos de Error Comunes

Parámetros Faltantes (400)

{
  "succeeded": false,
  "message": "Parámetros requeridos faltantes",
  "errors": [
    "El parámetro projectCode es obligatorio",
    "El parámetro stageId es obligatorio"
  ],
  "data": null,
  "statusCode": 400
}

Proyecto No Encontrado (404)

{
  "succeeded": false,
  "message": "Proyecto no encontrado",
  "data": null,
  "statusCode": 404
}

Etapa No Encontrada (404)

{
  "succeeded": false,
  "message": "Etapa no encontrada para el proyecto especificado",
  "data": null,
  "statusCode": 404
}

Sin Unidades en la Etapa (200)

{
  "succeeded": true,
  "message": "Product stock retrieved successfully",
  "data": {
    "properties": [],
    "summary": {
      "total": 0,
      "available": 0,
      "reserved": 0,
      "sold": 0
    }
  },
  "statusCode": 200
}

Etapas de Proyecto

Obtiene todas las etapas disponibles para un proyecto inmobiliario específico, incluyendo fechas de entrega y configuración.

Consultar Etapas

GET /external/stages?projectCode={code}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros Query

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Stages retrieved successfully",
  "data": [
    {
      "stageId": 1,
      "stageName": "Etapa 1",
      "projectCode": "CASABONITA",
      "deliveryDate": "2025-06-30T00:00:00"
    },
    {
      "stageId": 2,
      "stageName": "Etapa 2",
      "projectCode": "CASABONITA",
      "deliveryDate": "2026-03-15T00:00:00"
    },
    {
      "stageId": 3,
      "stageName": "Etapa 3",
      "projectCode": "CASABONITA",
      "deliveryDate": "2026-12-20T00:00:00"
    }
  ],
  "statusCode": 200
}

Campos de la Etapa

Códigos de Error Comunes

Parámetro Faltante (400)

{
  "succeeded": false,
  "message": "Parámetro requerido faltante",
  "errors": [
    "El parámetro projectCode es obligatorio"
  ],
  "data": null,
  "statusCode": 400
}

Proyecto No Encontrado (404)

{
  "succeeded": false,
  "message": "Proyecto no encontrado",
  "data": null,
  "statusCode": 404
}

Proyecto sin Etapas (200)

{
  "succeeded": true,
  "message": "Stages retrieved successfully",
  "data": [],
  "statusCode": 200
}

Manzanas de Proyecto

Obtiene todas las manzanas (bloques) disponibles para un proyecto inmobiliario específico, útil para organizar y consultar unidades por sectores.

Consultar Manzanas

GET /external/blocks?projectCode={code}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros Query

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Blocks retrieved successfully",
  "data": [
    {
      "blockId": 101,
      "blockName": "MZ A",
      "projectCode": "CASABONITA",
      "deliveryDate": "2025-08-15T00:00:00"
    },
    {
      "blockId": 102,
      "blockName": "MZ B",
      "projectCode": "CASABONITA",
      "deliveryDate": "2025-08-15T00:00:00"
    },
    {
      "blockId": 103,
      "blockName": "MZ C",
      "projectCode": "CASABONITA",
      "deliveryDate": "2026-02-28T00:00:00"
    }
  ],
  "statusCode": 200
}

Campos de la Manzana

Códigos de Error Comunes

Parámetro Faltante (400)

{
  "succeeded": false,
  "message": "Parámetro requerido faltante",
  "errors": [
    "El parámetro projectCode es obligatorio"
  ],
  "data": null,
  "statusCode": 400
}

Proyecto No Encontrado (404)

{
  "succeeded": false,
  "message": "Proyecto no encontrado",
  "data": null,
  "statusCode": 404
}

Proyecto sin Manzanas (200)

{
  "succeeded": true,
  "message": "Blocks retrieved successfully",
  "data": [],
  "statusCode": 200
}

Información de Lead

Obtiene información completa de un lead específico, incluyendo datos personales, vendedor asignado, proyecto de interés, canales de adquisición y estado actual.

Consultar Lead por ID

GET /external/leads/{leadId}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Lead retrieved successfully",
  "data": {
    "id": 12345,
    "documentNumber": "72845936",
    "firstName": "Carlos",
    "paternalSurname": "Mendoza",
    "maternalSurname": "Rivera",
    "fullName": "Carlos Mendoza Rivera",
    "phone": "+51987654321",
    "email": "carlos.mendoza@example.com",
    "createdAt": "2025-03-15T10:30:00",
    "firstEntryDate": "2025-03-15T10:30:00",
    "createdMonth": "March",
    "status": "Activo",
    "segmentName": "Calificados",
    "projectName": "Residencial Vista Hermosa",
    "stageName": "Etapa 2",
    "quotationPortal": "WHATSAPP MANTRA",
    "acquisitionChannel": "Publicidad Digital",
    "entryChannel": "WhatsApp",
    "utmCampaign": "verano2025",
    "utmContent": "lotes-norte",
    "utmMedium": "social",
    "utmSource": "facebook",
    "utmTerm": "wpp",
    "seller": {
      "firstName": "Andrea",
      "paternalSurname": "Vargas",
      "maternalSurname": "Mendoza",
      "fullName": "Andrea Vargas Mendoza",
      "email": "andrea.vargas@inmobiliaria.com",
      "phone": "+51960859432"
    }
  },
  "statusCode": 200
}

Campos del Lead

Campos del Vendedor

Estados de Lead

• Activo: Lead activo en proceso de seguimiento
• Cerrado: Lead cerrado sin conversión
• Cerrado por duplicado: Lead duplicado, cerrado automáticamente

Crear Lead

Crea un nuevo lead en el sistema con información del prospecto, origen de marketing y preferencias de contacto.

Crear Nuevo Lead

POST /external/leads/create

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Cuerpo de la Solicitud (JSON)

{
  "portalCode": "LOGICWAREBOT",
  "projectCode": "ALAMEDA2",
  "documentType": 1,
  "documentNumber": "12345678",
  "firstName": "Carlos",
  "paternalLastname": "Rodriguez",
  "maternalLastname": "Lopez",
  "email": "carlos.rodriguez@email.com",
  "phoneNumber": "+51987654321",
  "comments": "Interesado en departamentos de 3 dormitorios",
  "availabilityType": "1month",
  "preferredContactTime": "afternoon",
  "marketingConsent": "si",
  "interestedProperties": "Departamentos 3 dorm",
  "budgetRange": "150000-200000",
  "utmCampaign": "verano2025",
  "utmContent": "chat",
  "utmMedium": "social",
  "utmSource": "facebook",
  "utmTerm": "departamentos lima",
  "codSeller": 0,
  "emailSeller": "",
  "udfField1": null,
  "udfField2": null,
  "udfField3": null,
  "udfField4": null,
  "udfField5": null
}

Respuesta Exitosa - Nuevo Lead (201 Created)

{
  "succeeded": true,
  "message": "Lead created successfully",
  "data": {
    "leadId": 1523,
    "assignedTo": "Maria Fernandez Torres",
    "createdAt": "2025-10-27T14:30:00"
  },
  "statusCode": 201
}

Campos de la Solicitud

Información Básica (Requeridos)

* Al menos uno de los dos campos (email o phoneNumber) debe ser proporcionado. Se recomienda enviar ambos cuando estén disponibles.

Información Adicional (Opcionales)

Parámetros UTM (Tracking)

Asignación de Vendedor y Campos Personalizados

Tipos de Documento Válidos

Códigos de Error

Campos Requeridos Faltantes (400)

{
  "succeeded": false,
  "message": "Validation failed",
  "errors": [
    "El campo firstName es obligatorio",
    "Debe proporcionar al menos email o phoneNumber"
  ],
  "data": null,
  "statusCode": 400
}

{
  "succeeded": false,
  "message": "Lead no encontrado",
  "data": null,
  "statusCode": 404
}

Ventas de Clientes

Obtiene datos de ventas de todos los clientes con filtros de fecha, útil para consultar documentos separación y venta en un rango temporal específico.

Consultar Ventas de Clientes

GET /external/clients/sales?startDate={startDate}&endDate={endDate}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros Query

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Client sales data retrieved successfully",
  "data": [
    {
      "documentNumber": "12345678",
      "fullName": "JUAN CARLOS GARCIA LOPEZ",
      "firstName": "JUAN CARLOS",
      "paternalSurname": "GARCIA",
      "maternalSurname": "LOPEZ",
      "phone": "+51987654321",
      "email": "jgarcia@email.com",
      "gender": "Masculino",
      "birthDate": "1985-05-15T00:00:00",
      "address": "AV. PRINCIPAL 123",
      "department": "LIMA",
      "province": "LIMA",
      "district": "MIRAFLORES",
      "documents": [
        {
          "proformaId": 1001,
          "correlative": "202510-000000123",
          "status": "En Proceso Separación",
          "startDate": "2025-10-15T10:30:00",
          "endDate": null,
          "proformaStartDate": "2025-10-15T10:20:00",
          "separationStartDate": "2025-10-15T10:30:00",
          "separationEndDate": null,
          "saleStartDate": null,
          "saleEndDate": null,
          "seller": "MARIA FERNANDEZ TORRES",
          "project": "RESIDENCIAL VERDE",
          "stage": "ETAPA 1",
          "units": [
            {
              "unitNumber": "B-15",
              "unitArea": 85.50,
              "basePrice": 45000.00,
              "unitPrice": 42000.00,
              "discountPercentage": 6.67,
              "discount": 3000.00,
              "total": 42000.00
            }
          ],
          "financing": {
            "financingType": "Financiado",
            "currency": "PEN",
            "initialInstallments": 2,
            "financingInstallments": 24,
            "totalInstallments": 26,
            "reservationAmount": 500.00,
            "downPayment": 4200.00,
            "amountToFinance": 37300.00,
            "totalPaid": 500.00,
            "totalPending": 41500.00
          }
        }
      ]
    },
    {
      "documentNumber": "87654321",
      "fullName": "ANA LUCIA MARTINEZ SILVA",
      "firstName": "ANA LUCIA",
      "paternalSurname": "MARTINEZ",
      "maternalSurname": "SILVA",
      "phone": "+51912345678",
      "email": "amartinez@email.com",
      "gender": "Femenino",
      "birthDate": "1990-08-22T00:00:00",
      "address": "CALLE LAS FLORES 456",
      "department": "AREQUIPA",
      "province": "AREQUIPA",
      "district": "CAYMA",
      "documents": [
        {
          "proformaId": 1002,
          "correlative": "202510-000000124",
          "status": "Venta",
          "startDate": "2025-10-10T14:15:00",
          "endDate": "2025-10-18T16:00:00",
          "proformaStartDate": "2025-10-10T14:00:00",
          "separationStartDate": "2025-10-10T14:15:00",
          "separationEndDate": "2025-10-18T15:45:00",
          "saleStartDate": "2025-10-18T15:45:00",
          "saleEndDate": "2025-10-18T16:00:00",
          "seller": "CARLOS MENDOZA RUIZ",
          "project": "MIRADOR DEL SUR",
          "stage": "ETAPA 2",
          "units": [
            {
              "unitNumber": "C-08",
              "unitArea": 72.00,
              "basePrice": 38500.00,
              "unitPrice": 35000.00,
              "discountPercentage": 9.09,
              "discount": 3500.00,
              "total": 35000.00
            }
          ],
          "financing": {
            "financingType": "Contado",
            "currency": "USD",
            "initialInstallments": 1,
            "financingInstallments": 0,
            "totalInstallments": 1,
            "reservationAmount": 0.00,
            "downPayment": 35000.00,
            "amountToFinance": 0.00,
            "totalPaid": 35000.00,
            "totalPending": 0.00
          }
        }
      ]
    }
  ],
  "statusCode": 200
}

Estructura de Datos del Cliente

Estructura del Documento de Venta

Estructura de Unidad

Estructura de Financiamiento

Códigos de Error Comunes

Rango de Fechas Inválido (400)

{
  "succeeded": false,
  "message": "El rango de fechas no puede exceder 1 año",
  "data": null,
  "statusCode": 400
}

Sin Ventas en el Período (200)

{
  "succeeded": true,
  "message": "Client sales data retrieved successfully",
  "data": [],
  "statusCode": 200
}

Ventas de Cliente por Documento

Obtiene todos los datos de ventas asociados a un cliente específico utilizando su número de documento, incluyendo todas sus proformas, separaciones y ventas históricas.

Consultar Ventas por Documento

GET /external/clients/{documentNumber}/sales

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Ejemplo de Solicitud

GET /external/clients/12345678/sales

Headers:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
X-Subdomain: miempresa

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Client sales data retrieved successfully",
  "data": {
    "documentNumber": "12345678",
    "fullName": "ROBERTO CARLOS MENDEZ VARGAS",
    "firstName": "ROBERTO CARLOS",
    "paternalSurname": "MENDEZ",
    "maternalSurname": "VARGAS",
    "phone": "+51998765432",
    "email": "rmendez@email.com",
    "gender": "Masculino",
    "birthDate": "1982-11-08T00:00:00",
    "address": "JR. LOS PINOS 789",
    "department": "CUSCO",
    "province": "CUSCO",
    "district": "WANCHAQ",
    "documents": [
      {
        "proformaId": 2001,
        "correlative": "202509-000000567",
        "status": "Separación",
        "startDate": "2025-09-20T11:30:00",
        "endDate": "2025-09-25T14:20:00",
        "proformaStartDate": "2025-09-20T11:15:00",
        "separationStartDate": "2025-09-20T11:30:00",
        "separationEndDate": "2025-09-25T14:20:00",
        "saleStartDate": null,
        "saleEndDate": null,
        "seller": "PATRICIA GOMEZ RIOS",
        "project": "CIUDAD JARDÍN",
        "stage": "ETAPA 3",
        "units": [
          {
            "unitNumber": "E-22",
            "unitArea": 68.00,
            "basePrice": 36500.00,
            "unitPrice": 33850.00,
            "discountPercentage": 7.26,
            "discount": 2650.00,
            "total": 33850.00
          }
        ],
        "financing": {
          "financingType": "Financiado",
          "currency": "PEN",
          "initialInstallments": 1,
          "financingInstallments": 48,
          "totalInstallments": 49,
          "reservationAmount": 200.00,
          "downPayment": 3385.00,
          "amountToFinance": 30265.00,
          "totalPaid": 3585.00,
          "totalPending": 30265.00
        }
      },
      {
        "proformaId": 2102,
        "correlative": "202510-000000789",
        "status": "Venta",
        "startDate": "2025-10-05T09:45:00",
        "endDate": "2025-10-22T16:30:00",
        "proformaStartDate": "2025-10-05T09:30:00",
        "separationStartDate": "2025-10-05T09:45:00",
        "separationEndDate": "2025-10-22T16:15:00",
        "saleStartDate": "2025-10-22T16:15:00",
        "saleEndDate": "2025-10-22T16:30:00",
        "seller": "PATRICIA GOMEZ RIOS",
        "project": "CIUDAD JARDÍN",
        "stage": "ETAPA 3",
        "units": [
          {
            "unitNumber": "E-23",
            "unitArea": 72.00,
            "basePrice": 38900.00,
            "unitPrice": 35010.00,
            "discountPercentage": 10.00,
            "discount": 3890.00,
            "total": 35010.00
          }
        ],
        "financing": {
          "financingType": "Financiado",
          "currency": "PEN",
          "initialInstallments": 2,
          "financingInstallments": 36,
          "totalInstallments": 38,
          "reservationAmount": 300.00,
          "downPayment": 3501.00,
          "amountToFinance": 31209.00,
          "totalPaid": 7302.00,
          "totalPending": 27708.00
        }
      }
    ]
  },
  "statusCode": 200
}

Estructura de la Respuesta

La estructura de datos es idéntica al endpoint de ventas generales, pero retorna la información de un único cliente en lugar de un array.

Información del Cliente

El objeto data contiene los siguientes campos del cliente:

• documentNumber: Número de documento
• fullName: Nombre completo
• firstName: Nombres
• paternalSurname: Apellido paterno
• maternalSurname: Apellido materno
• phone: Teléfono con código de país
• email: Correo electrónico
• gender: Género (Masculino/Femenino)
• birthDate: Fecha de nacimiento
• address: Dirección completa
• department: Departamento
• province: Provincia
• district: Distrito
• documents: Array de documentos de venta

Estados de Documento

Los documentos pueden tener los siguientes estados en su ciclo de vida:

Flujo Principal

Flujo de Devolución

Códigos de Error Comunes

Documento Inválido (400)

{
  "succeeded": false,
  "message": "Número de documento inválido",
  "errors": [
    "El número de documento debe contener solo dígitos"
  ],
  "data": null,
  "statusCode": 400
}

Cliente sin Documentos de Venta (200)

{
  "succeeded": true,
  "message": "Client sales data retrieved successfully",
  "data": {
    "documentNumber": "12345678",
    "fullName": "LUIS ALBERTO TORRES DIAZ",
    "firstName": "LUIS ALBERTO",
    "paternalSurname": "TORRES",
    "maternalSurname": "DIAZ",
    "phone": "+51987654321",
    "email": "ltorres@email.com",
    "gender": "Masculino",
    "birthDate": "1995-03-15T00:00:00",
    "address": "AV. PRINCIPAL 123",
    "department": "LIMA",
    "province": "LIMA",
    "district": "SAN ISIDRO",
    "documents": []
  },
  "statusCode": 200
}

Cronograma de Pagos

Obtiene el cronograma completo de pagos mediante el correlativo de proforma, incluyendo el encabezado del cronograma, todas las cuotas y la próxima cuota por vencer.

Consultar Cronograma de Pagos

GET /external/payment-schedules/{correlative}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Ejemplo de Solicitud

GET /external/payment-schedules/202510-000000123

Headers:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
X-Subdomain: miempresa

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Payment schedule retrieved successfully",
  "data": {
    "scheduleId": 501,
    "proformaId": 1001,
    "correlative": "202510-000000123",
    "productPrice": 42000.00,
    "initialFeePercentage": 10.00,
    "initialGross": 4200.00,
    "reservationAmount": 500.00,
    "netInitial": 3700.00,
    "numberInitialInstallments": 2,
    "downPaymentInitial": 1850.00,
    "dateBeginInitial": "2025-11-01T00:00:00",
    "tea": 12.50,
    "tem": 0.99,
    "numberFinancingInstallments": 24,
    "amountToFinance": 37300.00,
    "downPaymentFinancing": 1621.83,
    "dateBeginFinancing": "2026-01-01T00:00:00",
    "totalPrincipal": 37300.00,
    "totalInterest": 5412.00,
    "totalPayment": 42712.00,
    "totalPaid": 3850.00,
    "totalPending": 38862.00,
    "overdueCuotas": 1,
    "installmentCount": 26,
    "paymentFrequency": "MONTHLY",
    "firstPaymentDate": "2025-11-01T00:00:00",
    "currency": "PEN",
    "createdBy": "MARIA FERNANDEZ TORRES",
    "createdAt": "2025-10-15T10:30:00",
    "installments": [
      {
        "scheduleDetId": 5001,
        "scheduleId": 501,
        "label": "Cuota Inicial",
        "installmentNumber": 1,
        "dueDate": "2025-11-01T00:00:00",
        "balance": 42000.00,
        "principal": 1850.00,
        "interest": 0.00,
        "payment": 1850.00,
        "paidPrincipal": 1850.00,
        "paidInterest": 0.00,
        "paidPenalty": 0.00,
        "totalPaidAmount": 1850.00,
        "remainingBalance": 40150.00,
        "status": "PAID",
        "paymentDate": "2025-10-28T14:30:00"
      },
      {
        "scheduleDetId": 5002,
        "scheduleId": 501,
        "label": "Cuota Inicial",
        "installmentNumber": 2,
        "dueDate": "2025-12-01T00:00:00",
        "balance": 40150.00,
        "principal": 1850.00,
        "interest": 0.00,
        "payment": 1850.00,
        "paidPrincipal": 1850.00,
        "paidInterest": 0.00,
        "paidPenalty": 0.00,
        "totalPaidAmount": 1850.00,
        "remainingBalance": 38300.00,
        "status": "PAID",
        "paymentDate": "2025-11-29T16:45:00"
      },
      {
        "scheduleDetId": 5003,
        "scheduleId": 501,
        "label": "Saldo a Financiar",
        "installmentNumber": 3,
        "dueDate": "2026-01-01T00:00:00",
        "balance": 38300.00,
        "principal": 1552.17,
        "interest": 69.66,
        "payment": 1621.83,
        "paidPrincipal": 150.00,
        "paidInterest": 0.00,
        "paidPenalty": 25.00,
        "totalPaidAmount": 175.00,
        "remainingBalance": 36747.83,
        "status": "PARTIAL",
        "paymentDate": "2026-01-15T10:20:00"
      },
      {
        "scheduleDetId": 5004,
        "scheduleId": 501,
        "label": "Saldo a Financiar",
        "installmentNumber": 4,
        "dueDate": "2026-02-01T00:00:00",
        "balance": 36747.83,
        "principal": 1567.52,
        "interest": 54.31,
        "payment": 1621.83,
        "paidPrincipal": 0.00,
        "paidInterest": 0.00,
        "paidPenalty": 0.00,
        "totalPaidAmount": 0.00,
        "remainingBalance": 36747.83,
        "status": "OVERDUE",
        "paymentDate": null
      },
      {
        "scheduleDetId": 5005,
        "scheduleId": 501,
        "label": "Saldo a Financiar",
        "installmentNumber": 5,
        "dueDate": "2026-03-01T00:00:00",
        "balance": 35180.31,
        "principal": 1582.98,
        "interest": 38.85,
        "payment": 1621.83,
        "paidPrincipal": 0.00,
        "paidInterest": 0.00,
        "paidPenalty": 0.00,
        "totalPaidAmount": 0.00,
        "remainingBalance": 35180.31,
        "status": "PENDING",
        "paymentDate": null
      }
    ],
    "nextInstallmentDue": {
      "scheduleDetId": 5004,
      "scheduleId": 501,
      "label": "Saldo a Financiar",
      "installmentNumber": 4,
      "dueDate": "2026-02-01T00:00:00",
      "balance": 36747.83,
      "principal": 1567.52,
      "interest": 54.31,
      "payment": 1621.83,
      "status": "OVERDUE"
    }
  },
  "statusCode": 200
}

Estructura del Cronograma de Pagos

Encabezado del Cronograma

Estructura de Cuota (Installment)

Próxima Cuota por Vencer (NextInstallmentDue)

Estados de Cuota

Las cuotas pueden tener los siguientes estados:

Códigos de Error Comunes

Cronograma No Encontrado (400)

{
  "succeeded": false,
  "message": "El documento especificado no existe o está inactiva",
  "data": null,
  "statusCode": 400
}

Gestión de Actividades

Permite crear y gestionar actividades de seguimiento para leads. El sistema automáticamente asigna la actividad al vendedor del lead.

Crear Actividad

POST /external/leads/{leadId}/activities

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "activityType": 1,
  "levelInterest": 2,
  "description": "Llamar al cliente para confirmar interés en departamentos",
  "scheduledAt": "2025-10-20T15:00:00",
  "notes": "Cliente mencionó preferencia por zona norte, 3 dormitorios"
}

Parámetros del Body

Respuesta exitosa (201)

{
  "succeeded": true,
  "message": "Activity created successfully",
  "data": {
    "id": 40323,
    "activityType": "Llamada",
    "description": "Llamar al cliente para confirmar interés en departamentos",
    "notes": "Cliente mencionó preferencia por zona norte, 3 dormitorios",
    "scheduledAt": "2025-10-20T15:00:00",
    "status": "Pendiente",
    "completedComments": null,
    "completedAt": null,
    "userCompleted": null,
    "createdAt": "2025-10-05T22:08:05.69",
    "updatedAt": null,
    "seller": {
      "firstName": "María",
      "paternalSurname": "González",
      "maternalSurname": "Rojas",
      "fullName": "María González Rojas",
      "email": "maria.gonzalez@inmobiliaria.com",
      "phone": "+51960859432"
    }
  },
  "statusCode": 201
}

Estados de Actividad

• Pendiente: Actividad programada, aún no completada
• Completada: Actividad realizada exitosamente
• Vencida: Actividad no completada en la fecha programada

Consultar Actividades de un Lead

GET /external/leads/{leadId}/activities

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Activities retrieved successfully",
  "data": {
    "lead": {
      "id": 19902,
      "fullName": "Carlos Ramírez Torres",
      "phone": "+51928519178",
      "email": "carlos.ramirez@example.com"
    },
    "activities": [
      {
        "id": 40278,
        "activityType": "Llamada",
        "description": "Llamada",
        "notes": "<p>INTERACCIÓN 1 Y SEGUIMIENTO</p>",
        "scheduledAt": "2025-09-19T15:00:00",
        "status": "Vencida",
        "completedComments": null,
        "completedAt": null,
        "userCompleted": null,
        "createdAt": "2025-09-18T21:15:37.583",
        "updatedAt": null,
        "seller": {
          "firstName": "Ana",
          "paternalSurname": "Martínez",
          "maternalSurname": "Silva",
          "fullName": "Ana Martínez Silva",
          "email": "ana.martinez@inmobiliaria.com",
          "phone": "+51924212619"
        }
      },
      {
        "id": 39639,
        "activityType": "Llamada",
        "description": "Llamada",
        "notes": "Se ha creado la actividad Llamada con fecha de vencimiento 18/09/2025 a las 13:14",
        "scheduledAt": "2025-09-18T13:14:14.467",
        "status": "Completada",
        "completedComments": "Contacto establecido exitosamente",
        "completedAt": "2025-09-18T21:15:37.38",
        "userCompleted": "Ana Martínez Silva",
        "createdAt": "2025-09-18T11:14:14.467",
        "updatedAt": "2025-09-18T21:15:37.38",
        "seller": {
          "firstName": "Ana",
          "paternalSurname": "Martínez",
          "maternalSurname": "Silva",
          "fullName": "Ana Martínez Silva",
          "email": "ana.martinez@inmobiliaria.com",
          "phone": "+51924212619"
        }
      }
    ]
  },
  "statusCode": 200
}

Campos de la Actividad

Actualizar Actividad

PUT /external/leads/{leadId}/activities/{activityId}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "levelInterest": 3,
  "description": "Seguimiento de propuesta enviada",
  "scheduledAt": "2025-10-15T16:00:00",
  "notes": "Cliente solicitó información adicional sobre financiamiento"
}

Parámetros de Ruta

Parámetros del Body

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Activity updated successfully",
  "data": {
    "id": 40322,
    "activityType": "Llamada",
    "description": "Seguimiento de propuesta enviada",
    "notes": "Cliente solicitó información adicional sobre financiamiento",
    "scheduledAt": "2025-10-15T16:00:00",
    "status": "Pendiente",
    "completedComments": null,
    "completedAt": null,
    "userCompleted": null,
    "createdAt": "2025-10-05T19:54:16.4",
    "updatedAt": "2025-10-05T22:10:45.827",
    "seller": {
      "firstName": "Roberto",
      "paternalSurname": "Vega",
      "maternalSurname": "López",
      "fullName": "Roberto Vega López",
      "email": "roberto.vega@inmobiliaria.com",
      "phone": "+51923634231"
    }
  },
  "statusCode": 200
}

Códigos de Error Comunes

Ejemplos de Error (400)

{
  "succeeded": false,
  "message": "Conflicto: El cliente potencial tiene una actividad pendiente. Complétela antes de crear una nueva.",
  "data": null,
  "statusCode": 400
}

{
  "succeeded": false,
  "message": "Errores de validación.",
  "errors": [
    "La descripción es requerida",
    "La fecha programada debe ser futura"
  ],
  "data": null,
  "statusCode": 400
}

Gestión de Citas

Permite crear y gestionar citas para leads. El sistema automáticamente asigna la cita al vendedor del lead.

Crear Cita

POST /external/leads/{leadId}/appointments

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "scheduledAt": "2025-10-18T17:30:00",
  "mediumType": "P",
  "medium": "PRESENCIAL",
  "location": "Oficina de ventas - Sede Central",
  "meetingUrl": null,
  "notes": "Cliente interesado en departamentos de 3 dormitorios"
}

Parámetros del Body

Respuesta exitosa (201)

{
  "succeeded": true,
  "message": "Appointment created successfully",
  "data": {
    "id": 2614,
    "medium": "PRESENCIAL",
    "description": "Cliente interesado en departamentos de 3 dormitorios",
    "location": "Oficina de ventas - Sede Central",
    "createdAt": "2025-10-05T22:32:24.077",
    "scheduledAt": "2025-10-18T17:30:00",
    "status": "Pendiente",
    "completedComments": null,
    "completedAt": null,
    "userCompleted": null,
    "seller": {
      "firstName": "Andrea",
      "paternalSurname": "Vargas",
      "maternalSurname": "Mendoza",
      "fullName": "Andrea Vargas Mendoza",
      "email": "andrea.vargas@inmobiliaria.com",
      "phone": "+51960859432"
    }
  },
  "statusCode": 201
}

Estados de Cita

• Pendiente: Cita creada, esperando ejecución
• Completada: Cita realizada exitosamente
• Vencida: Cita no gestionada en la fecha programada

Tipos de Medio

Consultar Citas de un Lead

GET /external/leads/{leadId}/appointments

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Appointments retrieved successfully",
  "data": {
    "lead": {
      "id": 19985,
      "fullName": "Patricia Flores Gutiérrez",
      "phone": "+51906250790",
      "email": "patricia.flores@example.com"
    },
    "appointments": [
      {
        "id": 2601,
        "medium": "PRESENCIAL",
        "description": "<p>Cliente muy interesado para adquirir su casa</p>",
        "location": "Oficina Santa Isabel",
        "createdAt": "2025-09-18T19:58:33.14",
        "scheduledAt": "2025-09-27T19:57:00",
        "status": "Vencida",
        "completedComments": null,
        "completedAt": null,
        "userCompleted": null,
        "seller": {
          "firstName": "Jorge",
          "paternalSurname": "Salazar",
          "maternalSurname": "Cruz",
          "fullName": "Jorge Salazar Cruz",
          "email": "jorge.salazar@inmobiliaria.com",
          "phone": "+51924124093"
        }
      },
      {
        "id": 2599,
        "medium": "ZOOM",
        "description": "<p>Presentación virtual del proyecto residencial</p>",
        "location": null,
        "createdAt": "2025-09-15T14:30:00",
        "scheduledAt": "2025-09-20T16:00:00",
        "status": "Completada",
        "completedComments": "Cita exitosa, cliente solicitó cotización",
        "completedAt": "2025-09-20T17:15:00",
        "userCompleted": "Jorge Salazar Cruz",
        "seller": {
          "firstName": "Jorge",
          "paternalSurname": "Salazar",
          "maternalSurname": "Cruz",
          "fullName": "Jorge Salazar Cruz",
          "email": "jorge.salazar@inmobiliaria.com",
          "phone": "+51924124093"
        }
      }
    ]
  },
  "statusCode": 200
}

Campos de la Cita

Actualizar Cita

PUT /external/leads/{leadId}/appointments/{appointmentId}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "scheduledAt": "2025-10-20T15:00:00",
  "mediumType": "D",
  "medium": "MEET",
  "location": null,
  "meetingUrl": "https://meet.google.com/xyz-abcd-efg",
  "notes": "Cambio a modalidad virtual por solicitud del cliente"
}

Parámetros de Ruta

Parámetros del Body

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Appointment updated successfully",
  "data": {
    "id": 2613,
    "medium": "MEET",
    "description": "Cambio a modalidad virtual por solicitud del cliente",
    "location": null,
    "createdAt": "2025-10-05T21:39:22.367",
    "scheduledAt": "2025-10-20T15:00:00",
    "status": "Pendiente",
    "completedComments": null,
    "completedAt": null,
    "userCompleted": null,
    "seller": {
      "firstName": "Luis",
      "paternalSurname": "Morales",
      "maternalSurname": "Ríos",
      "fullName": "Luis Morales Ríos",
      "email": "luis.morales@inmobiliaria.com",
      "phone": "+51960859432"
    }
  },
  "statusCode": 200
}

Códigos de Error Comunes

Cita Pendiente Existente (400)

{
  "succeeded": false,
  "message": "El lead ya tiene una cita pendiente programada para 18/10/2025 17:30. Debe completar la cita existente (Exitosa/Fallida) antes de crear una nueva.",
  "data": null,
  "statusCode": 400
}

Errores de Validación (400)

{
  "succeeded": false,
  "message": "Errores de validación.",
  "errors": [
    "El medio de contacto es requerido",
    "Para citas digitales, el medio debe ser uno de: ZOOM, TEAMS, MEET, VIDEO-WHATSAPP"
  ],
  "data": null,
  "statusCode": 400
}

Ejemplos de Errores de Validación

• Medio inválido para citas digitales: "Para citas digitales, el medio debe ser uno de: ZOOM, TEAMS, MEET, VIDEO-WHATSAPP"
• Falta ubicación para presencial: "Para citas presenciales, la ubicación es requerida"
• Falta URL para digital: "Para citas digitales, la URL de reunión es requerida"
• Fecha inválida: "La fecha de la cita debe ser futura"

Ejemplo de Cita Virtual

POST /external/leads/8870/appointments

Body:
{
  "scheduledAt": "2025-10-25T10:00:00",
  "mediumType": "D",
  "medium": "ZOOM",
  "location": null,
  "meetingUrl": "https://zoom.us/j/123456789",
  "notes": "Presentación de opciones de financiamiento"
}

Respuesta:
{
  "succeeded": true,
  "message": "Appointment created successfully",
  "data": {
    "id": 2615,
    "medium": "ZOOM",
    "description": "Presentación de opciones de financiamiento",
    "location": null,
    "scheduledAt": "2025-10-25T10:00:00",
    "status": "Pendiente",
    "seller": {
      "fullName": "Sofía Herrera Campos",
      "email": "sofia.herrera@inmobiliaria.com",
      "phone": "+51945123789"
    }
  },
  "statusCode": 201
}

Gestión de Notas

Permite agregar, actualizar y consultar notas asociadas a un lead para registro de interacciones y seguimiento.

Crear Nota

POST /external/leads/{leadId}/notes

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "Title": "Seguimiento importante",
  "Content": "Cliente interesado en lotes de 150m², consultar disponibilidad en Manzana C. Solicita información sobre financiamiento directo."
}

Parámetros del Body

Respuesta exitosa (201)

{
  "succeeded": true,
  "message": "Note created successfully",
  "data": {
    "id": 39,
    "title": "Seguimiento importante",
    "content": "Cliente interesado en lotes de 150m², consultar disponibilidad en Manzana C. Solicita información sobre financiamiento directo.",
    "createdAt": "2025-10-05T22:41:25.9579501-05:00",
    "updatedAt": null
  },
  "statusCode": 201
}

Consultar Notas de un Lead

GET /external/leads/{leadId}/notes

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros de Ruta

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Notes retrieved successfully",
  "data": {
    "lead": {
      "id": 8869,
      "fullName": "Carmen Rodríguez Vargas",
      "phone": "+51924156656",
      "email": "carmen.rodriguez@example.com"
    },
    "notes": [
      {
        "id": 38,
        "title": "Actualización de preferencias",
        "content": "Cliente confirma interés en zona norte, prefiere lotes con vista al parque",
        "createdAt": "2025-10-05T21:58:03.7",
        "updatedAt": "2025-10-05T21:58:49.54",
        "createdBy": "Roberto Vega López"
      },
      {
        "id": 37,
        "title": "Primera llamada",
        "content": "Contacto inicial exitoso, cliente solicita información sobre proyecto residencial",
        "createdAt": "2025-10-04T15:30:22.45",
        "updatedAt": null,
        "createdBy": "Ana Martínez Silva"
      }
    ]
  },
  "statusCode": 200
}

Campos de la Nota

Actualizar Nota

PUT /external/leads/{leadId}/notes/{noteId}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}
Content-Type: application/json

Body:
{
  "Title": "Seguimiento actualizado",
  "Content": "Cliente decidió por lote esquinero en Manzana D, coordinar visita para esta semana"
}

Parámetros de Ruta

Parámetros del Body

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Notes updated successfully",
  "data": {
    "id": 34,
    "title": "Seguimiento actualizado",
    "content": "Cliente decidió por lote esquinero en Manzana D, coordinar visita para esta semana",
    "createdAt": "2025-10-05T11:26:08.197",
    "updatedAt": "2025-10-05T22:42:47.3860893-05:00"
  },
  "statusCode": 200
}

Códigos de Error Comunes

Errores de Validación (400)

{
  "succeeded": false,
  "message": "Errores de validación.",
  "errors": [
    "El campo Title es obligatorio.",
    "El campo Content es obligatorio."
  ],
  "data": null,
  "statusCode": 400
}

Lead No Encontrado (404)

{
  "succeeded": false,
  "message": "Lead no encontrado",
  "data": null,
  "statusCode": 404
}

Nota No Encontrada (404)

{
  "succeeded": false,
  "message": "Nota no encontrada",
  "data": null,
  "statusCode": 404
}

Lead sin Notas (200)

{
  "succeeded": true,
  "message": "Notes retrieved successfully",
  "data": {
    "lead": {
      "id": 8869,
      "fullName": "Carmen Rodríguez Vargas",
      "phone": "+51924156656",
      "email": "carmen.rodriguez@example.com"
    },
    "notes": []
  },
  "statusCode": 200
}

Tipos de Financiamiento

Obtiene el catálogo de opciones de financiamiento disponibles para informar a los clientes sobre las modalidades de pago, con opción de incluir cuotas personalizadas (condiciones de pago).

Consultar Tipos de Financiamiento

GET /external/catalogs/financing-types?includeConditionalPayments={true|false}

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Parámetros Query

Respuesta sin Condiciones de Pago (includeConditionalPayments=false)

{
  "succeeded": true,
  "message": "Financing types retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Financiado",
      "requiresBankApproval": false,
      "isActive": true,
      "createdAt": "2024-07-19T05:04:07.273",
      "conditionalPayments": []
    },
    {
      "id": 3,
      "name": "Contado",
      "requiresBankApproval": false,
      "isActive": true,
      "createdAt": "2025-01-05T22:42:34.05",
      "conditionalPayments": []
    },
    {
      "id": 4,
      "name": "Hipotecario",
      "requiresBankApproval": true,
      "isActive": false,
      "createdAt": "2025-01-05T22:42:44.863",
      "conditionalPayments": []
    }
  ],
  "statusCode": 200
}

Respuesta con Condiciones de Pago (includeConditionalPayments=true)

{
  "succeeded": true,
  "message": "Financing types retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Financiado",
      "requiresBankApproval": false,
      "isActive": true,
      "createdAt": "2024-07-19T05:04:07.273",
      "conditionalPayments": [
        {
          "code": "CUOTA_BALON",
          "name": "C. Balón 1",
          "currency": "PEN",
          "amount": 3000.00,
          "validFrom": "2025-09-03T00:00:00",
          "validTo": null,
          "isActive": true,
          "createdAt": "2025-09-03T01:35:06.533"
        },
        {
          "code": "CUOTA_BUEN_PAGADOR",
          "name": "B. Pagador",
          "currency": "PEN",
          "amount": 3000.00,
          "validFrom": "2025-09-03T00:00:00",
          "validTo": null,
          "isActive": true,
          "createdAt": "2025-09-03T01:35:18.847"
        }
      ]
    },
    {
      "id": 3,
      "name": "Contado",
      "requiresBankApproval": false,
      "isActive": true,
      "createdAt": "2025-01-05T22:42:34.05",
      "conditionalPayments": []
    },
    {
      "id": 6,
      "name": "Techo Propio",
      "requiresBankApproval": false,
      "isActive": true,
      "createdAt": "2025-09-07T02:21:26.493",
      "conditionalPayments": []
    }
  ],
  "statusCode": 200
}

Estructura de Datos

Tipo de Financiamiento

Condición de Pago (ConditionalPayment)

Tipos de Financiamiento Comunes

• Contado: Pago total al momento de la compra, sin financiamiento
• Financiado: Financiamiento directo con la inmobiliaria, sin banco intermediario
• Hipotecario: Crédito hipotecario con entidad bancaria, requiere aprobación
• Techo Propio: Programa estatal de vivienda para sectores de bajos recursos
• Fondo MIVIVIENDA: Fondo estatal que facilita el acceso a crédito hipotecario

Condiciones de Pago Personalizadas

Las condiciones de pago son cuotas especiales que pueden aplicarse a ciertos tipos de financiamiento:

• Cuota Balón: Pago único de un monto mayor en una fecha específica del cronograma
• Bono Buen Pagador: Descuento o beneficio por cumplir con los pagos puntualmente

Códigos de Error Comunes

Sin Tipos Configurados (200)

{
  "succeeded": true,
  "message": "Financing types retrieved successfully",
  "data": [],
  "statusCode": 200
}

Parámetros de Financiamiento

Obtiene todos los parámetros de financiamiento disponibles en el sistema, organizados por proyecto inmobiliario.

Consultar Parámetros de Financiamiento

GET /external/catalogs/financing-parameters

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Financing parameters retrieved successfully",
  "data": [
    {
      "projectCode": "VERDE2024",
      "projectName": "RESIDENCIAL VERDE",
      "reservationAmount": 500.00,
      "initialFeePercent": 10.00,
      "financedBalancePercent": 90.00,
      "isActive": true,
      "createdAt": "2024-01-15T10:30:00"
    },
    {
      "projectCode": "MIRADOR2024",
      "projectName": "MIRADOR DEL SUR",
      "reservationAmount": 750.00,
      "initialFeePercent": 15.00,
      "financedBalancePercent": 85.00,
      "isActive": false,
      "createdAt": "2024-03-20T14:15:00"
    },
    {
      "projectCode": "JARDIN2023",
      "projectName": "CIUDAD JARDÍN",
      "reservationAmount": 300.00,
      "initialFeePercent": 20.00,
      "financedBalancePercent": 80.00,
      "isActive": false,
      "createdAt": "2023-11-08T09:45:00"
    },
    {
      "projectCode": "PLAZA2022",
      "projectName": "PLAZA CENTRAL",
      "reservationAmount": 1000.00,
      "initialFeePercent": 25.00,
      "financedBalancePercent": 75.00,
      "isActive": false,
      "createdAt": "2022-06-12T16:20:00"
    }
  ],
  "statusCode": 200
}

Estructura de Parámetros de Financiamiento

Casos de Uso

1. Calcular Plan de Pagos

Utilice los parámetros para calcular automáticamente el desglose de pagos de una unidad:

• Precio de venta: S/ 50,000
• Parámetros del proyecto: initialFeePercent = 10%, reservationAmount = 500
• Cuota inicial bruta: S/ 5,000
• Menos reserva: S/ 500
• Cuota inicial neta: S/ 4,500
• Monto a financiar: S/ 45,000 (90%)

Códigos de Respuesta

Sin Parámetros Configurados (200)

{
  "succeeded": true,
  "message": "Financing parameters retrieved successfully",
  "data": [],
  "statusCode": 200
}

Tipos de Actividad

Obtiene el catálogo de tipos de actividad disponibles para clasificar las interacciones y gestiones con clientes potenciales.

Consultar Tipos de Actividad

GET /external/catalogs/activity-types

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Activity types retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Llamada",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    },
    {
      "id": 2,
      "name": "Correo Electrónico",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    },
    {
      "id": 4,
      "name": "WhatsApp",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    }
  ],
  "statusCode": 200
}

Campos del Tipo de Actividad

Tipos de Actividad Comunes

• Llamada: Contacto directo por voz con el cliente
• Correo Electrónico: Envío de información o cotizaciones por email
• WhatsApp: Mensajería instantánea y compartir multimedia
• Otros

{
  "succeeded": true,
  "message": "Activity types retrieved successfully",
  "data": [],
  "statusCode": 200
}

Niveles de Interés

Obtiene el catálogo de niveles de interés disponibles para clasificar y priorizar clientes potenciales según su grado de intención de compra.

Consultar Niveles de Interés

GET /external/catalogs/interest-levels

Headers:
Authorization: Bearer {accessToken}
X-Subdomain: {su-subdomain}

Respuesta exitosa (200)

{
  "succeeded": true,
  "message": "Interest levels retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Alto",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    },
    {
      "id": 2,
      "name": "Medio",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    },
    {
      "id": 3,
      "name": "Bajo",
      "isActive": true,
      "createdAt": "2025-03-15T10:30:00"
    }

  ],
  "statusCode": 200
}

Campos del Nivel de Interés

Niveles de Interés Comunes

• Alto: Cliente muy interesado, evaluación avanzada
• Medio: Cliente interesado, comparando opciones
• Bajo: Cliente en fase exploratoria inicial

Códigos de Error Comunes

Sin Niveles Configurados (200)

{
  "succeeded": true,
  "message": "Interest levels retrieved successfully",
  "data": [],
  "statusCode": 200
}