Manual de Plantillas para Notificaciones de Crédito

Este documento explica cómo utilizar los campos disponibles en las plantillas de notificaciones (correos electrónicos y SMS) utilizadas por el servicio de notificaciones de crédito.

Estructura de Datos Disponibles

Las plantillas tienen acceso a diferentes estructuras según el tipo de notificación:

Para Correos Electrónicos

Las plantillas de correo electrónico tienen acceso a las siguientes variables:

.Organization  - La organización (acreedor o deudor dependiendo del contexto)
.URL           - La URL del dominio configurado
.Credit        - El objeto de crédito completo

Para SMS

Las plantillas de SMS tienen acceso a:

.URL     - La URL del dominio configurado
.Credit  - El objeto de crédito

Objetos y Campos Principales

Objeto Credit

El objeto Credit contiene toda la información relacionada con el crédito:

.Credit.ID                  - ID del crédito
.Credit.Status              - Estado del crédito (ApprovedCredit, RejectedCredit, PendingCredit, etc.)
.Credit.Amount              - Monto del crédito
.Credit.Principal           - Monto principal del crédito
.Credit.Rate                - Tasa de interés
.Credit.Term                - Plazo del crédito
.Credit.Time                - Duración del crédito en días
.Credit.Frequency           - Frecuencia de pago
.Credit.CreatedAt           - Fecha de creación
.Credit.UpdatedAt           - Fecha de actualización
.Credit.StartDate           - Fecha de inicio
.Credit.ApprovedAt          - Fecha de aprobación
.Credit.CancelledAt         - Fecha de cancelación
.Credit.ApprovedRuleID      - ID de la regla de aprobación
.Credit.Debtor              - Objeto del deudor
.Credit.Creditor            - Objeto del acreedor
.Credit.ConfigOrgID         - ID de la organización de configuración
.Credit.UserLastAction      - Usuario que realizó la última acción
.Credit.FeesAmount          - Monto de comisiones
.Credit.FeesSellPrice       - Precio de venta de comisiones
.Credit.FeesIva             - IVA de comisiones
.Credit.Installments        - Cuotas del crédito
.Credit.Summary             - Resumen del crédito
.Credit.Summary.Interest    - Interés total
.Credit.Summary.Subtotal    - Subtotal
.Credit.Summary.Total       - Total a pagar
.Credit.Summary.Detail.Costs - Costos detallados
.Credit.Summary.Detail.Taxes - Impuestos detallados
.Credit.Summary.DisbursementValue - Valor de desembolso

Objetos de Organización (Deudor y Acreedor)

Tanto .Credit.Debtor como .Credit.Creditor tienen una estructura similar:

.ID              - ID de la organización
.Phone           - Número de teléfono
.Email           - Correo electrónico
.Nickname        - Apodo o alias
.Verified        - Si está verificado
.Type            - Tipo de entidad (natural o legal)
.IDType          - Tipo de identificación
.IDNumber        - Número de identificación
.Profile         - Perfil con datos personales
.ImportID        - ID de importación

Acceso a Datos del Perfil con commonData

La función commonData está diseñada específicamente para acceder a campos comunes entre perfiles de tipo Natural y Legal. Esta función sólo permite acceder a un conjunto limitado de campos, y es la forma recomendada de obtener estos datos ya que maneja automáticamente las diferencias entre tipos de perfil.

Campos disponibles a través de commonData

La función commonData solo permite acceder a los siguientes campos:

{{ commonData .Profile "Name" }}        - Nombre (persona completo o empresa)
{{ commonData .Profile "Email" }}       - Correo electrónico
{{ commonData .Profile "Address" }}     - Dirección
{{ commonData .Profile "AddressCity" }} - Ciudad de la dirección
{{ commonData .Profile "IDNumber" }}    - Número de identificación
{{ commonData .Profile "Initials" }}    - Iniciales

Para acceder a estos campos desde el deudor o acreedor:

{{ commonData .Credit.Debtor.Profile "Name" }}
{{ commonData .Credit.Creditor.Profile "Email" }}

IMPORTANTE: Si intentas acceder a un campo que no está en la lista anterior usando commonData, el resultado será una cadena vacía. La función commonData no da acceso directo a todos los campos del perfil, solo a estos 6 campos comunes.

Campos del Objeto Installment (Cuotas)

Cada cuota del crédito tiene los siguientes campos:

.Installment.Number       - Número de cuota
.Installment.Date         - Fecha de pago
.Installment.Quote        - Cuota base
.Installment.Capital      - Capital amortizado
.Installment.Interest     - Interés
.Installment.Taxes        - Impuestos
.Installment.Costs        - Costos
.Installment.Payment      - Cuota a pagar
.Installment.FinalBalance - Saldo final
.Installment.Payments     - Pagos realizados
.Installment.Status       - Estado de la cuota

Funciones Disponibles en Plantillas

pin

Obtiene el PIN de autenticación (OTP) de un desembolso:

{{ pin }}

summary

Genera un resumen HTML del crédito:

{{ summary }}

amortization

Genera una tabla HTML de amortización del crédito:

{{ amortization }}

commonData

Accede a datos comunes de un perfil (solo los 6 campos listados anteriormente):

{{ commonData .Organization.Profile "Name" }}
{{ commonData .Organization.Profile "Email" }}

creditLimit

Formatea y muestra los límites de crédito:

{{ creditLimit "max" }} - Muestra el límite máximo de crédito
{{ creditLimit "min" }} - Muestra el límite mínimo de crédito

Otras Funciones Útiles

Estas funciones están disponibles en algunas plantillas y pueden ser utilizadas:

{{ currency .Credit.Amount }}        - Formatea un valor como moneda (Ej: $1,000,000)
{{ percentage .Credit.Rate }}        - Formatea un valor como porcentaje (Ej: 12.5%)
{{ date .Credit.CreatedAt }}         - Formatea una fecha (Ej: 01/01/2023)
{{ divide .Credit.Time .Credit.Frequency }} - Divide dos números (útil para calcular el número de cuotas)
{{ frecuencyUnit .Credit.Frequency }} - Muestra la unidad de frecuencia (Ej: días, meses)

Ejemplos de Uso Común

Acceder al Nombre del Deudor

{{ commonData .Credit.Debtor.Profile "Name" }}

Acceder al Número de Identificación del Deudor

{{ commonData .Credit.Debtor.Profile "IDNumber" }}

Acceder al Correo Electrónico del Acreedor

{{ commonData .Credit.Creditor.Profile "Email" }}

Mostrar el Estado del Crédito

{{ .Credit.Status }}

Mostrar el Monto del Crédito

{{ .Credit.Amount }}

Incluir la URL del Sistema

{{ .URL }}

Mostrar el Resumen del Crédito

{{ summary }}

Mostrar la Tabla de Amortización

{{ amortization }}

Mostrar la Fecha de Aprobación Formateada

{{ date .Credit.ApprovedAt }}

Mostrar el Valor de Desembolso Formateado

{{ currency .Credit.Summary.DisbursementValue }}

Casos Específicos

Plantillas para Notificaciones a Entidades

Las plantillas para entidades tienen acceso a:

.Organization - La entidad que recibe la notificación
.URL          - La URL del dominio
.Credit       - El objeto de crédito completo

Notificaciones de Aprobación

Propiedades útiles para notificaciones de aprobación:

.Credit.Status    - Debe ser "ApprovedCredit"
.Credit.ApprovedAt - Fecha de aprobación
.Credit.Summary.DisbursementValue - Valor a desembolsar

Notificaciones de Rechazo

Propiedades útiles para notificaciones de rechazo:

.Credit.Status      - Debe ser "RejectedCredit"
.Credit.CancelledAt - Fecha de rechazo

Notificaciones de Desembolso

Propiedades útiles para notificaciones de desembolso:

.Credit.Status - Debe ser "DisbursingCredit"
{{ pin }}      - PIN para autorización del desembolso

Solución de Problemas Comunes

Acceso a Datos del Perfil

Para acceder correctamente al número de identificación del deudor, use:

{{ commonData .Credit.Debtor.Profile "IDNumber" }}

Nota: Observe que el nombre del campo es "IDNumber" (con las letras ID en mayúsculas), no "IdNumber".

Diferencias Entre Plantillas

Recuerde que las diferentes plantillas (deudor, acreedor, entidades) pueden tener contextos ligeramente diferentes, por lo que asegúrese de usar las rutas correctas para cada tipo de plantilla.

Formato de Valores Monetarios

Para formatear valores monetarios correctamente, utilice la función currency:

{{ currency .Credit.Amount }}

Verificar el Valor de la Variable

Para validar que un campo tiene valor antes de usarlo:

{{if .Credit.UserLastAction}}
  Última acción por: {{commonData .Credit.UserLastAction.Profile "Name"}}
{{else}}
  Automático
{{end}}

Tabla de Campos Disponibles con commonData

Campos comunes disponibles a través de commonData

Campo	Descripción	Ejemplo de uso
Name	Nombre	{{ commonData .Credit.Debtor.Profile "Name" }}
Email	Correo electrónico	{{ commonData .Credit.Debtor.Profile "Email" }}
Address	Dirección	{{ commonData .Credit.Debtor.Profile "Address" }}
AddressCity	Ciudad	{{ commonData .Credit.Debtor.Profile "AddressCity" }}
IDNumber	Número de identificación	{{ commonData .Credit.Debtor.Profile "IDNumber" }}
Initials	Iniciales	{{ commonData .Credit.Debtor.Profile "Initials" }}

Estados del Crédito

Los posibles valores para .Credit.Status son:

Estado	Descripción
ApprovedCredit	Crédito aprobado
RejectedCredit	Crédito rechazado
PendingCredit	Crédito pendiente
DisbursingCredit	Crédito en desembolso
DelinquentCredit	Crédito moroso
PaidCredit	Crédito pagado
DesistedCredit	Crédito desistido
UndeliveredCredit	Crédito no entregado
Colateral	Garantía
Formalized	Formalizado

Consejos Importantes

1. Utilice ÚNICAMENTE la función commonData para acceder a los campos comunes entre perfiles, y recuerde que solo los 6 campos listados están disponibles a través de esta función.

2. Utilice los métodos directos para acceder a otras propiedades del crédito, como .Credit.Status, .Credit.Amount, etc.

3. Use las funciones de formato (currency, date, etc.) para mostrar valores correctamente formateados.

4. Para datos anidados o complejos, verifique primero que existan antes de acceder a ellos para evitar errores.

5. Los campos disponibles pueden cambiar según el contexto de la notificación (deudor, acreedor o entidad).