Event Name
generatePackageReport.packagereportGenerated
Domain
enterprise
Description

An event to hold the package statement report

Properties
{
    "header": {
        "type": "array",
        "description": "Contains the details of id, status, transaction status and audit fields,etc",
        "items": {
            "id": "urn:jsonschema:Header",
            "properties": {
                "audit": {
                    "type": "array",
                    "description": "Contains the details of processing time, version number, request  and response time",
                    "items": {
                        "id": "urn:jsonschema:Audit",
                        "properties": {
                            "T24_time": {
                                "type": "string",
                                "description": "Time taken to response by Transact"
                            },
                            "versionNumber": {
                                "type": "string",
                                "description": "Current number of the record"
                            },
                            "requestParse_time": {
                                "type": "string",
                                "description": "Time taken to parse the request by IRIS"
                            },
                            "responseParse_time": {
                                "type": "string",
                                "description": "Time taken to parse the response by IRIS"
                            }
                        }
                    }
                },
                "status": {
                    "type": "string",
                    "description": "Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."
                },
                "page_size": {
                    "type": "string",
                    "description": "The total number of records per page"
                },
                "page_start": {
                    "type": "string",
                    "description": "The record from which the response should be displayed"
                },
                "total_size": {
                    "type": "string",
                    "description": "The total number of records present"
                },
                "page_token": {
                    "type": "string",
                    "description": "Unique id expected to get as part of response from Transact on every enquiry request"
                }
            }
        }
    },
    "body": {
        "type": "array",
        "description": "Contains the schema that describes the body data type and structure",
        "items": {
            "id": "urn:jsonschema:Body",
            "properties": {
                "packagePricing": {
                    "type": "array",
                    "description": "Contains the pricing details of package such as base value, adjust value, net value. It may also include arrangement id, product line and benefits",
                    "items": {
                        "id": "urn:jsonschema:PackagePricing",
                        "properties": {
                            "date": {
                                "type": "string",
                                "description": "Indicates the date on which activity was performed"
                            },
                            "arrangementId": {
                                "type": "string",
                                "description": "Indicates the unique identifier for the arrangement contract and can be used to get the values for the criterion. These criterion values along with pricing grid product will be used to fetch the details of the corresponding rate from pricing grid index."
                            },
                            "productLine": {
                                "type": "string",
                                "description": "The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined by the institution to manage external products."
                            },
                            "pricingType": {
                                "type": "string",
                                "description": "Indicates the pricing type such as Debit,Credit"
                            },
                            "propertyName": {
                                "type": "string",
                                "description": "Indicates the  property description to which benefit has been applied"
                            },
                            "baseValue": {
                                "type": "string",
                                "description": "Indicates the base value for which benefit has been applied"
                            },
                            "adjustValue": {
                                "type": "string",
                                "description": "Indicates the value by which base value has to be adjusted"
                            },
                            "netValue": {
                                "type": "string",
                                "description": "Indicates the final adjusted net value. For example NetValue is  sum or difference of BaseValue and AdjustValue"
                            },
                            "packageBenefitValue": {
                                "type": "string",
                                "description": "Indicates the total  benefit amount when packaged"
                            },
                            "packageBenefitName": {
                                "type": "string",
                                "description": "Indicates the benefit names when packaged"
                            }
                        }
                    }
                },
                "totalPackageFees": {
                    "type": "string",
                    "description": "Indicates the net pricing benefit amount  of package when pricing type is debit"
                },
                "totalPackageCredits": {
                    "type": "string",
                    "description": "Indicates the net pricing benefit amount of package when pricing type is credit"
                },
                "netPackageSavings": {
                    "type": "string",
                    "description": "Indicates the  total  benefit amount of the package"
                },
                "totalOriginalFees": {
                    "type": "string",
                    "description": "Indicates the summation  of baseValue, adjustvalue, package benefit Value when pricing type is debit"
                },
                "totalFeeBenefits": {
                    "type": "string",
                    "description": "Indicates the total  Package benefit amount  when pricing type is debit."
                },
                "totalOriginalCredits": {
                    "type": "string",
                    "description": "Indicates the summation  of baseValue, adjustvalue, package benefit Value when pricing type is credit."
                },
                "totalCreditBenefits": {
                    "type": "string",
                    "description": "Indicates the total  Package benefit amount  when pricing type is credit"
                },
                "netOriginalCost": {
                    "type": "string",
                    "description": "Indicates the net original cost i.e difference of fees and credits"
                },
                "totalBenefits": {
                    "type": "string",
                    "description": "Indicates the total benefit value when the contracts are not part of the package"
                },
                "netSavings": {
                    "type": "string",
                    "description": "Indicates the summation of total pricing values and benefit values  when the contracts are packaged"
                },
                "totalPackageSavings": {
                    "type": "string",
                    "description": "Indicates the summation between net savings and net package savings"
                },
                "previousPeriodTotalPackageFees": {
                    "type": "string",
                    "description": "Indicates the net pricing benefit amount of package when pricing type is debit for the previous period statement."
                },
                "previousPeriodTotalPackageCredits": {
                    "type": "string",
                    "description": "Indicates the net pricing benefit amount of package when pricing type is credit for the previous period statement."
                },
                "previousPeriodNetPackageSavings": {
                    "type": "string",
                    "description": "Indicates the total benefit amount of the package for the previous period statement."
                },
                "previousPeriodTotalOriginalFees": {
                    "type": "string",
                    "description": "Indicates the summation of basevalue, adjustvalue, package benefit value when pricing type is debit for the previous period statement."
                },
                "previousPeriodTotalFeeBenefits": {
                    "type": "string",
                    "description": "Indicates the total package benefit amount when pricing type is debit for the previous period statement"
                },
                "previousPeriodTotalOriginalCredits": {
                    "type": "string",
                    "description": "Indicates the summation of basevalue, adjustvalue, package benefit value when pricing type is credit for the previous period statement"
                },
                "previousPeriodTotalCreditBenefits": {
                    "type": "string",
                    "description": "Indicates the total package benefit amount when pricing type is credit for the previous period statement"
                },
                "previousPeriodNetOriginalCost": {
                    "type": "string",
                    "description": "Indicates the net original cost i.e difference of fees and credits for the previous period statement"
                },
                "previousPeriodTotalBenefits": {
                    "type": "string",
                    "description": "Indicates the total benefit value when the contracts are not part of the package for the previous period statement"
                },
                "previousPeriodNetSavings": {
                    "type": "string",
                    "description": "Indicates the summation of total pricing values and benefit values when the contracts are packaged for the previous period statement"
                },
                "previousPeriodTotalPackageSavings": {
                    "type": "string",
                    "description": "Indicates the summation between net savings and net package savings for the previous period statement"
                }
            }
        }
    }
}