Charge plan created

Event generated when a charge plan is created.

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

org_id required

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

name required

Title: The charge plan name
Description: This field identifies the name of the charge plan.
Type: string
Example:
Acquisition tax

code required

Title: The charge plan code
Description: This field identifies the code of the charge plan.
Type: string
Example:
TAC2022

type required

Title: The charge plan type
Description: This field identifies the type of the charge plan.
Type: string
Example:
FEE
TAX
CHARGE

fixed_amount

Title: The charge plan fixed amount
Type: object

value

Title: The fixed amount value
Type: number
Example:
9000.0

percentage

Title: The charge plan percentage amount
Type: object

max_charged_amount

Title: The max charged amount
Type: number
Example:
500.0

min_charged_amount

Title: The min charged amount
Type: number
Example:
100.0

value

Title: The percentage amount value
Type: number
Example:
0.012

collection_method required

Title: The charge plan collection method
Description: This field identifies the collection method of the charge plan.
Type: string
Example:
DEDUCT
UPFRONT
AMORTISED

status required

Title: The charge plan status
Description: This field identifies the status of the charge plan.
Type: string
Example:
ENABLED
DISABLED

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "title": "Charge plan created",
    "description": "Event generated when a charge plan is created.",
    "required": [
        "org_id",
        "name",
        "code",
        "type",
        "collection_method",
        "status"
    ],
    "oneOf": [
        {
            "required": [
                "fixed_amount"
            ]
        },
        {
            "required": [
                "percentage"
            ]
        }
    ],
    "properties": {
        "org_id": {
            "$id": "#/properties/org_id",
            "type": "string",
            "title": "The org identifier",
            "description": "This field identifies the organization of the charge plan.",
            "examples": [
                "89e56522-726a-453e-ba6d-796b03245128"
            ]
        },
        "name": {
            "$id": "#/properties/name",
            "type": "string",
            "title": "The charge plan name",
            "description": "This field identifies the name of the charge plan.",
            "examples": [
                "Acquisition tax"
            ]
        },
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "The charge plan code",
            "description": "This field identifies the code of the charge plan.",
            "examples": [
                "TAC2022"
            ]
        },
        "type": {
            "$id": "#/properties/type",
            "type": "string",
            "title": "The charge plan type",
            "description": "This field identifies the type of the charge plan.",
            "examples": [
                "FEE",
                "TAX",
                "CHARGE"
            ]
        },
        "fixed_amount": {
            "$id": "#/properties/fixed_amount",
            "type": "object",
            "title": "The charge plan fixed amount",
            "properties": {
                "value": {
                    "$id": "#/properties/fixed_amount/value",
                    "type": "number",
                    "title": "The fixed amount value",
                    "examples": [
                        9000.0
                    ]
                }
            }
        },
        "percentage": {
            "$id": "#/properties/percentage",
            "type": "object",
            "title": "The charge plan percentage amount",
            "properties": {
                "max_charged_amount": {
                    "$id": "#/properties/percentage/max_charged_amount",
                    "type": "number",
                    "title": "The max charged amount",
                    "examples": [
                        500.0
                    ]
                },
                "min_charged_amount": {
                    "$id": "#/properties/percentage/min_charged_amount",
                    "type": "number",
                    "title": "The min charged amount",
                    "examples": [
                        100.0
                    ]
                },
                "value": {
                    "$id": "#/properties/percentage/value",
                    "type": "number",
                    "title": "The percentage amount value",
                    "examples": [
                        0.012
                    ]
                }
            }
        },
        "collection_method": {
            "$id": "#/properties/collection_method",
            "type": "string",
            "title": "The charge plan collection method",
            "description": "This field identifies the collection method of the charge plan.",
            "examples": [
                "DEDUCT",
                "UPFRONT",
                "AMORTISED"
            ]
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "The charge plan status",
            "description": "This field identifies the status of the charge plan.",
            "examples": [
                "ENABLED",
                "DISABLED"
            ]
        }
    }
}

{
    "org_id": "89e56522-726a-453e-ba6d-796b03245128",
    "name": "Acquisition tax",
    "code": "TAC2022",
    "type": "FEE",
    "fixed_amount": {
        "value": 9000.0
    },
    "percentage": {
        "max_charged_amount": 500.0,
        "min_charged_amount": 100.0,
        "value": 0.012
    },
    "collection_method": "DEDUCT",
    "status": "ENABLED"
}

Updated 10 days ago