Event Name
updateContractBalances.contractBalancesUpdated
Domain
holdings
Description

Event indicating that static or balances information is updated in the contract.

Properties
{
    "accountingCompany": {
        "type": "string",
        "description": "Indicates the accounting company of the account record"
    },
    "sourceSystem": {
        "type": "string",
        "description": "Specifies an alternative short name to refer the current backend system"
    },
    "balanceUpdateStage": {
        "type": "string",
        "description": "Indicates the process which updates the balances in the account or contract. Example of stages: Forward exposure date reached."
    },
    "onlineClearedBalance": {
        "type": "string",
        "description": "Indicates the available balance allowed to use"
    },
    "onlineActualBalance": {
        "type": "string",
        "description": "Real-time balance including all authorised transactions posted against the account, excluding any entries with a future processing date."
    },
    "workingBalance": {
        "type": "string",
        "description": "Real-time balance including all authorised transactions posted against the account and, unless it is a nostro or internal account, unauthorised debit entries."
    },
    "contractId": {
        "type": "string",
        "description": "Indicates the unique identifier of the transaction or contract which initiated the activity"
    },
    "companyId": {
        "type": "string",
        "description": "Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."
    },
    "customerId": {
        "type": "string",
        "description": "Identifier of the customer"
    },
    "currency": {
        "type": "string",
        "description": "Identifies the currency. E.g. USD, GBP etc"
    },
    "contractSystemId": {
        "type": "string",
        "description": "The system identifier of the contract to which transaction is initiated"
    },
    "exposureDate": {
        "type": "string",
        "description": "Contains the date on which the amount is available to the customer for withdrawal/usage"
    },
    "processingDate": {
        "type": "string",
        "description": "The date when payment instruction is processed in system."
    },
    "balanceDateTime": {
        "type": "string",
        "description": "Indicates the time in which balances are updated in the account or contract."
    },
    "contractInformation": {
        "type": "array",
        "description": "Contains the details of the contract such as contract identifier, customer identifier, arrangement identifier, contract currency, alternate references, and consolidation key.",
        "items": {
            "id": "urn:jsonschema:ContractInformation",
            "properties": {
                "companyId": {
                    "type": "string",
                    "description": "Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."
                },
                "contractId": {
                    "type": "string",
                    "description": "Indicates the unique identifier of the transaction or contract which initiated the activity"
                },
                "contractSystemId": {
                    "type": "string",
                    "description": "The system identifier of the contract to which transaction is initiated"
                },
                "arrangementId": {
                    "type": "string",
                    "description": "Indicates an unique identifier of an account"
                },
                "currency": {
                    "type": "string",
                    "description": "Identifies the currency. E.g. USD, GBP etc"
                },
                "customerId": {
                    "type": "string",
                    "description": "Identifier of the customer"
                },
                "consolidationKey": {
                    "type": "string",
                    "description": "Indicates the key into which the details of the contract will be consolidated. This will be used for general ledger reporting."
                },
                "alternateReferences": {
                    "type": "array",
                    "description": "If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will be mapped to ALTERNATE.ID field in arrangement activity and ensure that this Account doesn't already exist in T24 with another reference (because ALTERNATE.ID would be configured to be unique across T24).",
                    "items": {
                        "id": "urn:jsonschema:AlternateReferences",
                        "properties": {
                            "alternateReferenceType": {
                                "type": "string",
                                "description": "Contains the alternate account system identifier used for defining the alternate account id."
                            },
                            "alternateId": {
                                "type": "string",
                                "description": "An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."
                            }
                        }
                    }
                }
            }
        }
    },
    "contractBalances": {
        "type": "array",
        "description": "Contains the details of the contract with its balance such as working balance, online actual balance, online cleared balance, payable balance, receivable balance, consolidation key, available balances, balance type balances, high volume session key and unmerged balances information of an high volume account.",
        "items": {
            "id": "urn:jsonschema:ContractBalances",
            "properties": {
                "contractId": {
                    "type": "string",
                    "description": "Indicates the unique identifier of the transaction or contract which initiated the activity"
                },
                "onlineClearedBalance": {
                    "type": "string",
                    "description": "Indicates the available balance allowed to use"
                },
                "onlineActualBalance": {
                    "type": "string",
                    "description": "Real-time balance including all authorised transactions posted against the account, excluding any entries with a future processing date."
                },
                "workingBalance": {
                    "type": "string",
                    "description": "Real-time balance including all authorised transactions posted against the account and, unless it is a nostro or internal account, unauthorised debit entries."
                },
                "payableBalance": {
                    "type": "string",
                    "description": "Payable balance is available balance of an account excluding Locked amount and including floatBalance."
                },
                "receivableBalance": {
                    "type": "string",
                    "description": "Contains the total of the future dated credit movements that are to be reflected as non-contingent receivable balances in the General Ledger."
                },
                "balanceTypeBalances": {
                    "type": "array",
                    "description": "Contains the details of balance types and its respective balances which is used for reporting and information purpose.",
                    "items": {
                        "id": "urn:jsonschema:BalanceTypeBalances",
                        "properties": {
                            "balanceType": {
                                "type": "string",
                                "description": "Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."
                            },
                            "balanceAmount": {
                                "type": "string",
                                "description": "Amount of the balance"
                            },
                            "unmergedBalanceAmount": {
                                "type": "string",
                                "description": "A signed floating number which indicates the balance movement amount which is not yet merged in high volume transaction account. This is the balance movement that has happened as part of this single business event and not the net result. The currency of this figure is always assumed to be the contract currency."
                            }
                        }
                    }
                },
                "availableBalances": {
                    "type": "array",
                    "description": "Available balance of the account which is the projected balance which includes the net movements of both debits and credits against the account.",
                    "items": {
                        "id": "urn:jsonschema:AvailableBalances",
                        "properties": {
                            "availableBalance": {
                                "type": "string",
                                "description": "Available balance of the account which is the projected balance which includes the net movements of both debits and credits against the account."
                            },
                            "availableDate": {
                                "type": "string",
                                "description": "Indicates the date in which the forward dated, value dated, and forward exposure dated balances are held."
                            },
                            "unmergedAvailableBalance": {
                                "type": "string",
                                "description": "Indicates the debit movements which is not merged yet in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                            }
                        }
                    }
                },
                "unmergedOnlineClearedBalance": {
                    "type": "string",
                    "description": "Indicates the online cleared balance which is not merged yet in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                },
                "unmergedWorkingBalance": {
                    "type": "string",
                    "description": "Indicates the working balance which is not merged yet in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                },
                "unmergedOnlineActualBalance": {
                    "type": "string",
                    "description": "Indicates the online actual balance which is not yet merged in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                },
                "highVolumeSessionKey": {
                    "type": "string",
                    "description": "Indicates the key generated as part of transaction to a high volume transaction account. The session key will be of format accountId!sessionId!systemDate!systemTime. Example: 11029!66396!20230418!0510."
                },
                "exposureDate": {
                    "type": "string",
                    "description": "Contains the date on which the amount is available to the customer for withdrawal/usage"
                },
                "processingDate": {
                    "type": "string",
                    "description": "The date when payment instruction is processed in system."
                },
                "balanceDateTime": {
                    "type": "string",
                    "description": "Indicates the time in which balances are updated in the account or contract."
                }
            }
        }
    },
    "accountActivityBalances": {
        "type": "array",
        "description": "Indicates the date when the activity balance is updated based on the activity balance type. If the activity balance type is BOOK then the activity date will be the processing date, if activity balance type is VALUE then the activity date will contain the accountId-currentMonth:valueDay. Example: 101000101-20091215",
        "items": {
            "id": "urn:jsonschema:AccountActivityBalances",
            "properties": {
                "contractId": {
                    "type": "string",
                    "description": "Indicates the unique identifier of the transaction or contract which initiated the activity"
                },
                "activityBalanceDateType": {
                    "type": "string",
                    "description": "Indicates the balance type based on which the activity balance is updated. Valid values are BOOK - Book dated, VALUE - Value dated."
                },
                "activityBalanceDate": {
                    "type": "string",
                    "description": "Indicates the date when the activity balance is updated based on the activity balance type. If the activity balance type is BOOK then the activity date will be the processing date, if activity balance type is VALUE then the activity date will contain the accountId-currentMonth:valueDay. Example: 101000101-20091215"
                },
                "activityBalance": {
                    "type": "string",
                    "description": "Indicates the activity based balance of the contract. The balance will be based on activity balance type and activity balance date."
                },
                "creditMovement": {
                    "type": "string",
                    "description": "Indicates an account’s credit movement’s for a specific booking date which will not include any of the credit movements that are masked"
                },
                "debitMovement": {
                    "type": "string",
                    "description": "Indicates an account’s debit movement’s for a specific booking date which will not include any of the debit movements that are masked."
                },
                "highVolumeSessionKey": {
                    "type": "string",
                    "description": "Indicates the key generated as part of transaction to a high volume transaction account. The session key will be of format accountId!sessionId!systemDate!systemTime. Example: 11029!66396!20230418!0510."
                },
                "unmergedCreditMovement": {
                    "type": "string",
                    "description": "Indicates the credit movements which is not merged yet in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                },
                "unmergedDebitMovement": {
                    "type": "string",
                    "description": "Indicates the debit movements which is not merged yet in the high volume transaction account. High volume transaction account provides standard account functionality in a seamless manner, avoiding any concurrency issues and allows the system to be scalable."
                },
                "unmergedActivityBalance": {
                    "type": "string",
                    "description": "Indicates the activity based balance of the contract which is not yet merged in high volume transaction account. The balance will be based on activity balance type and activity balance date."
                },
                "balanceType": {
                    "type": "string",
                    "description": "Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."
                },
                "companyId": {
                    "type": "string",
                    "description": "Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."
                }
            }
        }
    },
    "highVolumeSessionKeys": {
        "type": "array",
        "description": "Indicates the key generated as part of transaction to a high volume transaction account. The session key will be of format accountId!sessionId!systemDate!systemTime. Example: 11029!66396!20230418!0510.",
        "items": {
            "id": "urn:jsonschema:HighVolumeSessionKeys",
            "properties": []
        }
    },
    "debitLockedAmounts": {
        "type": "array",
        "description": "Indicates the reserved amount for a given arrangement account and balance reservation event. It's a debit type of transaction",
        "items": {
            "id": "urn:jsonschema:DebitLockedAmounts",
            "properties": {
                "fromDate": {
                    "type": "string",
                    "description": "Indicates the business date from when the balance reservation event is active."
                },
                "debitLockedAmount": {
                    "type": "string",
                    "description": "Indicates the reserved amount for a given arrangement account and balance reservation event. It's a debit type of transaction"
                }
            }
        }
    },
    "creditLockedAmounts": {
        "type": "array",
        "description": "Indicates the reserved amount for a given arrangement account and balance reservation event. It's a credit type of transaction",
        "items": {
            "id": "urn:jsonschema:CreditLockedAmounts",
            "properties": {
                "fromDate": {
                    "type": "string",
                    "description": "Indicates the business date from when the balance reservation event is active."
                },
                "creditLockedAmount": {
                    "type": "string",
                    "description": "Indicates the reserved amount for a given arrangement account and balance reservation event. It's a credit type of transaction"
                }
            }
        }
    }
}