Event Name
calculatePeriodicPricing.periodicPricingCalculated
Domain
enterprise
Description

Event is triggered to communicate fee/charge information for periodic fee along with details on breakdown of individual charges.

Properties
{
    "periodStartDate": {
        "type": "string",
        "description": "Indicates the date which can be used as the start date for computing the period charge"
    },
    "chargeCurrency": {
        "type": "string",
        "description": "Contains the identifier for the currency in which charge is calculated"
    },
    "baseContractDetails": {
        "type": "array",
        "description": "Indicates the identifier for base details in which system reference, base contract reference, event name, effective date and other contract related details are defined for a contract from enterprise product pricing system",
        "items": {
            "id": "urn:jsonschema:BaseContractDetails",
            "properties": {
                "contractReference": {
                    "type": "string",
                    "description": "Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract/account in the system."
                },
                "systemReference": {
                    "type": "string",
                    "description": "Contains the identifier for the system in which the event originated from. For ex, ‘Hogan’ or ‘TransactAccounts’ etc"
                },
                "companyReference": {
                    "type": "string",
                    "description": "Contains the identifier of the underlying Entity or Company or Branch"
                },
                "eventName": {
                    "type": "string",
                    "description": "Indicates the name of the event that is understood by the Enterprise product pricing system."
                },
                "baseEventIdentifier": {
                    "type": "string",
                    "description": "Indicates the name of the event that is happening in the core system"
                },
                "effectiveDate": {
                    "type": "string",
                    "description": "Contains the identifier for the transaction date. Dates are expected in ‘YYYYMMDD’ format"
                },
                "bookingDate": {
                    "type": "string",
                    "description": "Indicates the date on which this business activity is booked in the underlying system. The effective date and booking date could be different if systems allow forward/backdating business transactions. Dates are expected in YYYYMMDD format. If Booking date is not passed, effective date would be assumed as booking date."
                },
                "contractCurrency": {
                    "type": "string",
                    "description": "Indicates the currency associated with the contract"
                },
                "channel": {
                    "type": "string",
                    "description": "Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"
                },
                "branch": {
                    "type": "string",
                    "description": "Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"
                },
                "lineOfBusiness": {
                    "type": "string",
                    "description": "Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"
                },
                "transactionReference": {
                    "type": "string",
                    "description": "Contains the identifier for the transaction in the core system"
                },
                "reversalIndicator": {
                    "type": "boolean",
                    "description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
                },
                "variation": {
                    "type": "array",
                    "description": "Additional product specification based on particular criteria for example the account was opened on-line and attracted a higher interest rate. Drop down list to select appropriate variation or applied automatically",
                    "items": {
                        "type": "string"
                    }
                },
                "party": {
                    "type": "array",
                    "description": "Identifier of individuals in terms of Customers or Person or Entities with reference to the bank",
                    "items": {
                        "id": "urn:jsonschema:PartyDetails",
                        "properties": {
                            "party": {
                                "type": "string",
                                "description": "Identifier of individuals in terms of Customers or Person or Entities with reference to the bank"
                            },
                            "partyRole": {
                                "type": "string",
                                "description": "Contains the identifier used for the role played by the party or customer in the contract or account"
                            }
                        }
                    }
                },
                "eligibility": {
                    "type": "array",
                    "description": "Contains the details of rules associated with the customer, rule results, action and variation.",
                    "items": {
                        "id": "urn:jsonschema:Eligibility",
                        "properties": {
                            "variation": {
                                "type": "string",
                                "description": "Additional product specification based on particular criteria for example the account was opened on-line and attracted a higher interest rate. Drop down list to select appropriate variation or applied automatically"
                            },
                            "actionContext": {
                                "type": "string",
                                "description": "It indicates the action to be performed based on the eligibility evaluation result."
                            },
                            "failureType": {
                                "type": "string",
                                "description": "The failure type for an eligibility rule can be either one of two values, error or override/warning."
                            },
                            "eligibilityRule": {
                                "type": "array",
                                "description": "Contains the eligibility rule details such as party role rule, party role rule expression and evaluation result.",
                                "items": {
                                    "id": "urn:jsonschema:EligibilityRule",
                                    "properties": {
                                        "ruleName": {
                                            "type": "string",
                                            "description": "Name of the validation rule to be checked against an online or periodic activity."
                                        },
                                        "customerRole": {
                                            "type": "string",
                                            "description": "Indicates role of a customer for an arrangement."
                                        },
                                        "roleRuleName": {
                                            "type": "string",
                                            "description": "It indicates the rule to be evaluated based on the customer role."
                                        },
                                        "failureAction": {
                                            "type": "string",
                                            "description": "During the close of business dependent on value set and change in customer static data, an action will occur. Standard set of values are change product, close or ignore."
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "feeProcessDetails": {
        "type": "array",
        "description": "Indicates the identifier for fee details in which fee name,description,original fee,final fee,fee type,fee application type along with  fee adjusted  are defined for a contract in enterprise product pricing system",
        "items": {
            "id": "urn:jsonschema:FeeProcessDetails",
            "properties": {
                "feeName": {
                    "type": "string",
                    "description": "Indicates the identifier for the fee(s) associated with the event. If a fee is already computed by the core system, then that fee name could be passed here."
                },
                "feeDescription": {
                    "type": "string",
                    "description": "Indicates the description of the fee name"
                },
                "originalFee": {
                    "type": "string",
                    "description": "Indicates the standard fee amount before pricing evaluation. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "feeAdjusted": {
                    "type": "string",
                    "description": "Indicates the total signed adjustment amount which is calculated during pricing evaluation. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "finalFee": {
                    "type": "string",
                    "description": "Indicates the final fee after pricing evaluation. This would typically be unsigned. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "feeType": {
                    "type": "string",
                    "description": "Indicates the type of fee which is applied for payment instruction"
                },
                "feeApplicationType": {
                    "type": "string",
                    "description": "Indicates whether the fee needs to be made Due or Pay or Capitalise. Allowed values are DUE, PAY or CAPITALISE"
                },
                "benefitDetails": {
                    "type": "array",
                    "description": "Indicates the identifier for pricing benefit details in which benefit program, benefit amount and benefit type are defined. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts",
                    "items": {
                        "id": "urn:jsonschema:BenefitDetails",
                        "properties": {
                            "benefitProgram": {
                                "type": "string",
                                "description": "Indicates the pricing program under which benefit was offered. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts"
                            },
                            "benefitType": {
                                "type": "string",
                                "description": "Indicates the nature of benefit. It can be adjust, override or waive"
                            },
                            "benefitAmount": {
                                "type": "string",
                                "description": "Indicates the quantum of benefit for the benefit type. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts"
                            }
                        }
                    }
                },
                "individualFeeDetails": {
                    "type": "array",
                    "description": "Indicates the identifier for individual fee details in which base fee name, fee description, fee amount, fee adjusted and fee net amount are defined",
                    "items": {
                        "id": "urn:jsonschema:IndividualFeeDetails",
                        "properties": {
                            "baseFeeName": {
                                "type": "string",
                                "description": "Indicates the individual fee name for the periodic charge. Periodic charge can be calculated based on the individual fee amount and pricing benefit also applied on it if defined. Pricing benefit defines the benefits applied for the fee or interest amount calculated which can be waived, adjusted or override their original amounts"
                            },
                            "baseFeeDescription": {
                                "type": "string",
                                "description": "Indicates the individual fee name description for the periodic charge. Periodic charge can be calculated based on the individual fee amount and pricing benefit also applied on it if defined. Pricing benefit defines the benefits applied for the fee or interest amount calculated which can be waived, adjusted or override their original amounts"
                            },
                            "baseFeeAmount": {
                                "type": "string",
                                "description": "Indicates the individual fee amount for the periodic charge. Periodic charge can be calculated based on the individual fee amount and pricing benefit also applied on it if defined. Pricing benefit defines the benefits applied for the fee or interest amount calculated which can be waived, adjusted or override their original amounts"
                            },
                            "baseFeeAdjustment": {
                                "type": "string",
                                "description": "Indicates the final adjusted amount for the periodic charge. Periodic charge can be calculated based on the individual fee amount and pricing benefit also applied on it if defined. Pricing benefit defines the benefits applied for the fee or interest amount calculated which can be waived, adjusted or override their original amounts"
                            },
                            "baseFeeNetAmount": {
                                "type": "string",
                                "description": "Indicates the final amount after adjustments are applied for the periodic charge. Periodic charge can be calculated based on the individual fee amount and pricing benefit also applied on it if defined. Pricing benefit defines the benefits applied for the fee or interest amount calculated which can be waived, adjusted or override their original amounts"
                            }
                        }
                    }
                }
            }
        }
    }
}