Interest accrual succeeded

This event occurs when a quota is accrual with product interest-management.

Type: object
Domain: interest-management
Event: interest_accrual_success
Version: 1

external_account_id required

Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string
Example:
999999999

accrual_date required

Title: Accrual date
Description: Date asset was effectively issued by client.
Type: string
Format: date
Example:
2020-12-01

accrual_net_amount required

Title: Accrual Net Amount
Description: Net Value to be redeemed from quota.
Type: number
Format: double
Example:
100.0

accrual_gross_amount required

Title: Accrual Gross Amount
Description: Accrual Gross Amount.
Type: number
Format: double
Example:
100.0

total_accrual_daily_net_amount required

Title: Accrual Daily Net Amount
Description: Accrual Daily Net Amount.
Type: number
Format: double
Example:
100.0

total_accrual_daily_gross_amount required

Title: Accrual Daily Gross Amount
Description: Accrual Daily Gross Amount.
Type: number
Format: double
Example:
100.0

assets required

Title: List of assets
Description: Asset.
Type: array

asset_id required

Title: Asset ID
Description: Asset ID generated by pismo.
Type: string
Example:
12323a52-d7dc-410e-88de-0777772a345d

external_asset_id required

Title: External asset ID
Description: Unique asset short identifier defined by Pismo.
Type: string or null
Example:
kxBHNMCAYDnQav

external_quota_id required

Title: External ID
Description: Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3

issuing_date required

Title: Issuing date
Description: Date asset was effectively issued by client.
Type: string
Format: date
Example:
2020-12-01

maturity_date required

Title: Maturity date
Description: Date asset expires, finishing issued_units cycle.
Type: string
Format: date
Example:
2022-12-01

issued_units required

Title: Issued units
Description: Number of units asset can support.
Type: number
Format: double
Example:
100.0

current_units required

Title: Current units
Description: Number of units asset has.
Type: number
Format: double
Example:
100.0

accrual_daily_net_amount required

Title: Accrual Daily Net Amount
Description: Accrual Daily Net Amount.
Type: number
Format: double
Example:
100.0

accrual_daily_gross_amount required

Title: Accrual Daily Gross Amount
Description: Accrual Daily Gross Amount.
Type: number
Format: double
Example:
100.0

net_unit_value required

Title: Net Unit Value
Description: Accrued net unit value by quota.
Type: number
Format: double
Example:
0.01

gross_unit_value required

Title: Gross Unit Value
Description: Accrued gross unit value by quota.
Type: number
Format: double
Example:
0.01

accrual_accum_net_amount required

Title: Accrual Accum Net Amount
Description: Accrual Accum Net Amount.
Type: number
Format: double
Example:
100.0

accrual_accum_gross_amount required

Title: Accrual Accum Gross Amount
Description: Accrual Accum Gross Amount.
Type: number
Format: double
Example:
100.0

taxes required

Title: List of taxes
Description: Tax.
Type: array

name required

Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOF

amount required

Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
0.15

unit_value required

Title: Tax Unit Value
Description: Tax Unit Value.
Type: number
Format: double
Example:
1.49e-05

rate required

Title: Tax Rate
Description: Tax Rate.
Type: number
Format: double
Example:
22.5

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Interest accrual succeeded",
    "description": "This event occurs when a quota is accrual with product interest-management.",
    "required": [
        "external_account_id",
        "accrual_date",
        "accrual_net_amount",
        "accrual_gross_amount",
        "total_accrual_daily_net_amount",
        "total_accrual_daily_gross_amount",
        "assets"
    ],
    "properties": {
        "external_account_id": {
            "type": "string",
            "title": "External account identifier",
            "description": "A custom account ID string that uniquely identifies the account within your organization.",
            "examples": [
                "999999999"
            ]
        },
        "accrual_date": {
            "type": "string",
            "title": "Accrual date",
            "description": "Date asset was effectively issued by client.",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "accrual_net_amount": {
            "type": "number",
            "title": "Accrual Net Amount",
            "description": "Net Value to be redeemed from quota.",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "accrual_gross_amount": {
            "type": "number",
            "title": "Accrual Gross Amount",
            "description": "Accrual Gross Amount.",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "total_accrual_daily_net_amount": {
            "type": "number",
            "title": "Accrual Daily Net Amount",
            "description": "Accrual Daily Net Amount.",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "total_accrual_daily_gross_amount": {
            "type": "number",
            "title": "Accrual Daily Gross Amount",
            "description": "Accrual Daily Gross Amount.",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "assets": {
            "type": "array",
            "title": "List of assets",
            "items": {
                "$ref": "#/definitions/asset"
            }
        }
    },
    "definitions": {
        "asset": {
            "type": "object",
            "title": "Asset",
            "description": "Asset.",
            "required": [
                "asset_id",
                "external_asset_id",
                "external_quota_id",
                "issuing_date",
                "maturity_date",
                "issued_units",
                "current_units",
                "accrual_daily_net_amount",
                "accrual_daily_gross_amount",
                "net_unit_value",
                "gross_unit_value",
                "accrual_accum_net_amount",
                "accrual_accum_gross_amount",
                "taxes"
            ],
            "properties": {
                "asset_id": {
                    "type": "string",
                    "title": "Asset ID",
                    "description": "Asset ID generated by pismo.",
                    "examples": [
                        "12323a52-d7dc-410e-88de-0777772a345d"
                    ]
                },
                "external_asset_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "External asset ID",
                    "description": "Unique asset short identifier defined by Pismo.",
                    "examples": [
                        "kxBHNMCAYDnQav"
                    ]
                },
                "external_quota_id": {
                    "type": "string",
                    "title": "External ID",
                    "description": "Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.",
                    "examples": [
                        "d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
                    ]
                },
                "issuing_date": {
                    "type": "string",
                    "title": "Issuing date",
                    "description": "Date asset was effectively issued by client.",
                    "format": "date",
                    "examples": [
                        "2020-12-01"
                    ]
                },
                "maturity_date": {
                    "type": "string",
                    "title": "Maturity date",
                    "description": "Date asset expires, finishing `issued_units` cycle.",
                    "format": "date",
                    "examples": [
                        "2022-12-01"
                    ]
                },
                "issued_units": {
                    "type": "number",
                    "title": "Issued units",
                    "description": "Number of units asset can support.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "current_units": {
                    "type": "number",
                    "title": "Current units",
                    "description": "Number of units asset has.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "accrual_daily_net_amount": {
                    "type": "number",
                    "title": "Accrual Daily Net Amount",
                    "description": "Accrual Daily Net Amount.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "accrual_daily_gross_amount": {
                    "type": "number",
                    "title": "Accrual Daily Gross Amount",
                    "description": "Accrual Daily Gross Amount.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "net_unit_value": {
                    "type": "number",
                    "title": "Net Unit Value",
                    "description": "Accrued net unit value by quota.",
                    "format": "double",
                    "examples": [
                        0.01
                    ]
                },
                "gross_unit_value": {
                    "type": "number",
                    "title": "Gross Unit Value",
                    "description": "Accrued gross unit value by quota.",
                    "format": "double",
                    "examples": [
                        0.01
                    ]
                },
                "accrual_accum_net_amount": {
                    "type": "number",
                    "title": "Accrual Accum Net Amount",
                    "description": "Accrual Accum Net Amount.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "accrual_accum_gross_amount": {
                    "type": "number",
                    "title": "Accrual Accum Gross Amount",
                    "description": "Accrual Accum Gross Amount.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "taxes": {
                    "type": "array",
                    "title": "List of taxes",
                    "items": {
                        "$ref": "#/definitions/tax"
                    }
                }
            }
        },
        "tax": {
            "type": "object",
            "title": "Tax",
            "description": "Tax.",
            "required": [
                "name",
                "amount",
                "unit_value",
                "rate"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Tax Name",
                    "description": "Tax Name.",
                    "examples": [
                        "IR",
                        "IOF"
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "Tax Amount",
                    "description": "Tax Amount.",
                    "format": "double",
                    "examples": [
                        0.15
                    ]
                },
                "unit_value": {
                    "type": "number",
                    "title": "Tax Unit Value",
                    "description": "Tax Unit Value.",
                    "format": "double",
                    "examples": [
                        1.49e-05
                    ]
                },
                "rate": {
                    "type": "number",
                    "title": "Tax Rate",
                    "description": "Tax Rate.",
                    "format": "double",
                    "examples": [
                        22.5
                    ]
                }
            }
        }
    }
}

{
    "external_account_id": "999999999",
    "accrual_date": "2020-12-01",
    "accrual_net_amount": 100.0,
    "accrual_gross_amount": 100.0,
    "total_accrual_daily_net_amount": 100.0,
    "total_accrual_daily_gross_amount": 100.0,
    "assets": {
        "asset_id": "12323a52-d7dc-410e-88de-0777772a345d",
        "external_asset_id": "kxBHNMCAYDnQav",
        "external_quota_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
        "issuing_date": "2020-12-01",
        "maturity_date": "2022-12-01",
        "issued_units": 100.0,
        "current_units": 100.0,
        "accrual_daily_net_amount": 100.0,
        "accrual_daily_gross_amount": 100.0,
        "net_unit_value": 0.01,
        "gross_unit_value": 0.01,
        "accrual_accum_net_amount": 100.0,
        "accrual_accum_gross_amount": 100.0,
        "taxes": {
            "name": "IR",
            "amount": 0.15,
            "unit_value": 1.49e-05,
            "rate": 22.5
        }
    }
}

Updated 4 days ago