Loan simulation created

Event generated when a loan simulation is created.

Type: object
Domain: lending
Event: loan_simulation_creation
Version: 1

org_id required

Title: The org identifier
Description: This field identifies the organization of the simulation.
Type: string
Example:
89e56522-726a-453e-ba6d-796b03245128

simulation_id required

Title: The simulation identifier
Description: This field identifies the simulation.
Type: string
Example:
afedc8b0-86b2-41ca-87a3-3481df17261b

product_id required

Title: The product identifier
Description: This field identifies the id of the product.
Type: string
Example:
89e56522-726a-453e-ba6d-796b03245128
BNPL_PRODUCT_2022

product_version required

Title: The product version
Description: This field identifies the version of the product.
Type: string
Example:
1
2
3

loan_amount required

Title: The simulated amount
Description: This field identifies the simulated amount.
Type: number
Example:
1000.0

start_date required

Title: The loan start date
Description: This field identifies the loan start date.
Type: string
Format: date
Example:
2022-10-24

disbursement_schedule required

Type: array

date required

Title: The disbursement date
Description: This field identifies the disbursement date.
Type: string
Format: date
Example:
2022-10-24

stages required

Type: array

period required

Type: object

value required

Title: Stage period
Type: number
Example:
12

interest_rate required

Type: object

unit required

Title: Interest rate unit
Type: string
Example:
YEAR
MONTH

value required

Title: Interest rate percentage
Type: number
Example:
0.12

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "title": "Loan simulation created",
    "description": "Event generated when a loan simulation is created.",
    "required": [
        "org_id",
        "simulation_id",
        "product_id",
        "product_version",
        "loan_amount",
        "start_date",
        "disbursement_schedule",
        "stages"
    ],
    "properties": {
        "org_id": {
            "$id": "#/properties/org_id",
            "type": "string",
            "title": "The org identifier",
            "description": "This field identifies the organization of the simulation.",
            "examples": [
                "89e56522-726a-453e-ba6d-796b03245128"
            ]
        },
        "simulation_id": {
            "$id": "#/properties/simulation_id",
            "type": "string",
            "title": "The simulation identifier",
            "description": "This field identifies the simulation.",
            "examples": [
                "afedc8b0-86b2-41ca-87a3-3481df17261b"
            ]
        },
        "product_id": {
            "$id": "#/properties/product_id",
            "type": "string",
            "title": "The product identifier",
            "description": "This field identifies the id of the product.",
            "examples": [
                "89e56522-726a-453e-ba6d-796b03245128",
                "BNPL_PRODUCT_2022"
            ]
        },
        "product_version": {
            "$id": "#/properties/product_version",
            "type": "string",
            "title": "The product version",
            "description": "This field identifies the version of the product.",
            "examples": [
                "1",
                "2",
                "3"
            ]
        },
        "loan_amount": {
            "$id": "#/properties/loan_amount",
            "type": "number",
            "title": "The simulated amount",
            "description": "This field identifies the simulated amount.",
            "examples": [
                1000.0
            ]
        },
        "start_date": {
            "$id": "#/properties/start_date",
            "type": "string",
            "format": "date",
            "title": "The loan start date",
            "description": "This field identifies the loan start date.",
            "examples": [
                "2022-10-24"
            ]
        },
        "disbursement_schedule": {
            "$id": "#/properties/disbursement_schedule",
            "type": "array",
            "title": "The disbursement schedule",
            "description": "This field identifies the disbursement schedule.",
            "items": {
                "type": "object",
                "required": [
                    "date"
                ],
                "properties": {
                    "date": {
                        "$id": "#/properties/disbursement_schedule/date",
                        "type": "string",
                        "format": "date",
                        "title": "The disbursement date",
                        "description": "This field identifies the disbursement date.",
                        "examples": [
                            "2022-10-24"
                        ]
                    }
                }
            }
        },
        "stages": {
            "$id": "#/properties/stages",
            "type": "array",
            "title": "The simulation stages",
            "description": "This field identifies the simulation stages.",
            "items": {
                "type": "object",
                "required": [
                    "period",
                    "interest_rate"
                ],
                "properties": {
                    "period": {
                        "$id": "#/properties/stages/period",
                        "type": "object",
                        "required": [
                            "value"
                        ],
                        "properties": {
                            "value": {
                                "$id": "#/properties/stages/period/value",
                                "type": "number",
                                "title": "Stage period",
                                "examples": [
                                    12
                                ]
                            }
                        }
                    },
                    "interest_rate": {
                        "$id": "#/properties/stages/interest_rate",
                        "type": "object",
                        "required": [
                            "unit",
                            "value"
                        ],
                        "properties": {
                            "unit": {
                                "$id": "#/properties/stages/interest_rate/unit",
                                "type": "string",
                                "title": "Interest rate unit",
                                "examples": [
                                    "YEAR",
                                    "MONTH"
                                ]
                            },
                            "value": {
                                "$id": "#/properties/stages/interest_rate/value",
                                "type": "number",
                                "title": "Interest rate percentage",
                                "examples": [
                                    0.12
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}

{
    "org_id": "89e56522-726a-453e-ba6d-796b03245128",
    "simulation_id": "afedc8b0-86b2-41ca-87a3-3481df17261b",
    "product_id": "89e56522-726a-453e-ba6d-796b03245128",
    "product_version": "1",
    "loan_amount": 1000.0,
    "start_date": "2022-10-24",
    "disbursement_schedule": {
        "date": "2022-10-24"
    },
    "stages": {
        "period": {
            "value": 12
        },
        "interest_rate": {
            "unit": "YEAR",
            "value": 0.12
        }
    }
}

Updated 10 days ago