Loan repayment status changed

Event generated when the status of a loan repayment changes.

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

loan_id required

Title: The identifier of a loan
Description: This field identifes the loan associated with this repayment.
Type: string
Example:
89e56522-726a-453e-ba6d-796b03245128

org_id required

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

repayment_id required

Title: The repayment identifier
Description: This field identifies the id of the repayment.
Type: string
Example:
7da3db3b-400d-4851-a362-2022dab27284

previous_repayment_status required

Title: The previous repayment status
Description: This field identifies the previous status.
Type: string
Example:
SCHEDULED
PAID
PAST_DUE

current_repayment_status required

Title: The current repayment status
Description: This field identifies the current status.
Type: string
Example:
SCHEDULED
PAID
PAST_DUE

due_date required

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

amount required

Title: The repayment original amount
Type: object

principal required

Title: Principal amount
Type: number

charge required

Title: Charge amount
Type: number

interest required

Title: Interest amount
Type: number

penalty required

Title: Penalty amount
Type: number

fee required

Title: Fee amount
Type: number

tax required

Title: Tax amount
Type: number

amount_paid required

Title: The repayment paid amount
Type: object

principal required

Title: Principal amount
Type: number

charge required

Title: Charge amount
Type: number

interest required

Title: Interest amount
Type: number

penalty required

Title: Penalty amount
Type: number

fee required

Title: Fee amount
Type: number

tax required

Title: Tax amount
Type: number

amount_due required

Title: The repayment due amount
Type: object

principal required

Title: Principal amount
Type: number

charge required

Title: Charge amount
Type: number

interest required

Title: Interest amount
Type: number

penalty required

Title: Penalty amount
Type: number

fee required

Title: Fee amount
Type: number

tax required

Title: Tax amount
Type: number

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "title": "Loan repayment status changed",
    "description": "Event generated when the status of a loan repayment changes.",
    "required": [
        "loan_id",
        "org_id",
        "repayment_id",
        "previous_repayment_status",
        "current_repayment_status",
        "due_date",
        "amount",
        "amount_paid",
        "amount_due"
    ],
    "properties": {
        "loan_id": {
            "$id": "#/properties/loan_id",
            "type": "string",
            "title": "The identifier of a loan",
            "description": "This field identifes the loan associated with this repayment.",
            "examples": [
                "89e56522-726a-453e-ba6d-796b03245128"
            ]
        },
        "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"
            ]
        },
        "repayment_id": {
            "$id": "#/properties/repayment_id",
            "type": "string",
            "title": "The repayment identifier",
            "description": "This field identifies the id of the repayment.",
            "examples": [
                "7da3db3b-400d-4851-a362-2022dab27284"
            ]
        },
        "previous_repayment_status": {
            "$id": "#/properties/previous_repayment_status",
            "type": "string",
            "title": "The previous repayment status",
            "description": "This field identifies the previous status.",
            "examples": [
                "SCHEDULED",
                "PAID",
                "PAST_DUE"
            ]
        },
        "current_repayment_status": {
            "$id": "#/properties/current_repayment_status",
            "type": "string",
            "title": "The current repayment status",
            "description": "This field identifies the current status.",
            "examples": [
                "SCHEDULED",
                "PAID",
                "PAST_DUE"
            ]
        },
        "due_date": {
            "$id": "#/properties/due_date",
            "type": "string",
            "format": "date",
            "title": "The repayment due date",
            "description": "This field identifies the repayment due date.",
            "examples": [
                "2022-10-24"
            ]
        },
        "amount": {
            "$id": "#/properties/amount",
            "title": "The repayment original amount",
            "$ref": "#/$defs/balance"
        },
        "amount_paid": {
            "$id": "#/properties/amount_paid",
            "title": "The repayment paid amount",
            "$ref": "#/$defs/balance"
        },
        "amount_due": {
            "$id": "#/properties/amount_due",
            "title": "The repayment due amount",
            "$ref": "#/$defs/balance"
        }
    },
    "$defs": {
        "balance": {
            "type": "object",
            "title": "Balance object",
            "required": [
                "principal",
                "charge",
                "interest",
                "penalty",
                "fee",
                "tax"
            ],
            "properties": {
                "principal": {
                    "$id": "#/properties/balance/principal",
                    "type": "number",
                    "title": "Principal amount"
                },
                "charge": {
                    "$id": "#/properties/balance/charge",
                    "type": "number",
                    "title": "Charge amount"
                },
                "interest": {
                    "$id": "#/properties/balance/interest",
                    "type": "number",
                    "title": "Interest amount"
                },
                "penalty": {
                    "$id": "#/properties/balance/penalty",
                    "type": "number",
                    "title": "Penalty amount"
                },
                "fee": {
                    "$id": "#/properties/balance/fee",
                    "type": "number",
                    "title": "Fee amount"
                },
                "tax": {
                    "$id": "#/properties/balance/tax",
                    "type": "number",
                    "title": "Tax amount"
                }
            }
        }
    }
}

Updated 7 days ago