Billing Notifications

This functionality helps insurers to send notifications to the customers, regarding the status of their invoices. The notifications functionality can be toggled on and off by modifying the BillingNotification system parameter - where 0 is Off and 1 is On.

Server Side Script Libraries

FTOS_INSP_CoreInsuranceNotification - This library contains methods that help in the process of notifying the customers about their invoices. From this library the following functions are used: 

This function returns different attributes from the FTOS_CMB_Currency entity, based on the currency Id.

Input parameters: currencyId - (string) - The Id of the FTOS_CMB_Currency entity.

Output parameters: query - Array that contains an object with the following results: Code.

This function returns different attributes from the Account entity, based on the account Id.

Input parameters: accountId - (string) - The Id of the Account entity.

Output parameters: query - Array that contains an object with the following results: FirstName, LastName, Email, dateOfBirthInv.

This function returns different attributes from the FTOS_INSPA_Policy entity, based on the statement detail Id.

Input parameters: statement - (string) - The Id of the FTOS_PYMT_StatementDetail entity.

Output parameters: query - Array that contains an object with the following results: PolicyNo, policyBeginDate, insuranceTypeId.

This function returns different attributes from the FTOS_IP_InsuranceType entity, based on the insurance type Id.

Input parameters: typeId - (string) - The Id of the FTOS_IP_InsuranceType entity.

Output parameters: query - Array that contains an object with the following results: Name.

This function returns different attributes from the FTOS_PYMT_Statement entity, based on the statement Id.

Input parameters: statementId - (string) - The Id of the FTOS_PYMT_Statement entity.

Output parameters: query - Array that contains an object with the following results: customerId, statementNo.

This function encrypt a .pdf file, using the date of birth from the Account entity. If the account doesn’t have a date of birth registered, the file will not be encrypted.

Input parameters:

  • dob - (Invariant Date) - The date of birth from the Account entity.

  • fileName - The Id of the .pdf file.

Output parameters: N/A

This function returns the data needed to populate the InvoicePaymentConfirmation email template, based on the context.

Input parameters: context - (object) - The context object received.

Output parameters: tokens - Object that contains the following information: InvoiceDate, FirstName, LastName, InvoiceNumber, PolicyType, PolicyNo, BeginDate, Email, Attachments.

This function returns the data needed to populate the InvoiceGeneratedNotification email template, based on the context.

Input parameters: context - (object) - The context object received.

Output parameters: tokens - Object that contains the following information: InvoiceDate, FirstName, LastName, InvoiceNumber, PolicyType, PolicyNo, BeginDate, Email, Attachments.

This function returns the data needed to populate the InvoiceFollowUp email template, based on the Id of the invoice.

Input parameters: statementId - (string) - The Id of the FTOS_PYMT_Statement entity.

Output parameters: tokens - Object that contains the following information: InvoiceDate, FirstName, LastName, InvoiceNumber, PolicyType, PolicyNo, BeginDate, Email, Attachments.

This function sends the notifications, based on the type of the email. If the account doesn’t have an email registered, the notification will not be sent.

Input parameters:

  • emailDetails - (object) - Object containing the information to populate the email templates.

  • type - (string) - The type of notification to be sent.

Output parameters: N/A.

Processors

The FTOS_INSP_CoreInsuranceNotification processor is used for setting the NotificationConfiguration parameter. This parameter is an object containing the following settings:

  • followUp - Follow up notification,

  • invoiceGenerated - Invoice Generated notification,

  • paymentConfirmation - Payment Confirmation notification.

Business Workflow Configuration Actions

GenerateInvoiceNotification Action

It calls getInvoiceGeneratedDetails(context) and sendClientNotification(emailDetails, type) functions from FTOS_INSP_CoreInsuranceNotification server side script library in order to get the data needed to populate the email template and send the notification to the customer.

It calls the getFlowProcessorSettingsByType(flowSettingsName, processorSettingsType, processorSettingsName) function from the FTOS_DFP_FlowProcessorSettings server side library, in order to get the processor settings.

The notification is sent if the payment type is different than the broker collection payment type and if the BillingNotification system parameter is set to1.

PaymentConfirmationNotification Action

It calls getPaymentConfirmationDetails(context) and sendClientNotification(emailDetails, type) functions from FTOS_INSP_CoreInsuranceNotification server side script library in order to get the data needed to populate the email template and send the notification to the customer.

It calls the getFlowProcessorSettingsByType(flowSettingsName, processorSettingsType, processorSettingsName) function from the FTOS_DFP_FlowProcessorSettings server side library, in order to get the processor settings.

The notification is sent if the payment type is different than the broker collection payment type and if the BillingNotification system parameter is set to1.

On Demand Scripts

JOB FTOS_PYMT_FollowUpInvoice - on demand script which calls the getFollowUpDetails(statementId) and sendClientNotification(emailDetails, type) functions from the FTOS_INSP_CoreInsuranceNotification server side script library in order to get the data needed to populate the email template and send the notification to the customer.

It calls the getFlowProcessorSettingsByType(flowSettingsName, processorSettingsType, processorSettingsName) function from the FTOS_DFP_FlowProcessorSettings server side library, in order to get the processor settings.

It calls the getValues(code) function from the FTOS_PA_FlowParameter server side library in order to get the insurance parameter.

The notification is sent if the payment type is other than broker collection payment and if the BillingNotification system parameter is set to1.

Input parameters: N/A

Output parameters: N/A

Scheduled jobs

FTOS_PYMT_FollowUpInvoice -

This job is scheduled to run every day at 6:00 AM in order to send notifications to invoices that are still in status Generated x days before the invoice’s due date. The number of days is determined by the NoOfDaysFollowUpInvoice insurance parameter.

Schedule Services - FTOS_PYMT_FollowUpInvoice, on demand server automation script.