Events
About PismoContact Us

Delinquency bucket migration completed

Event generated when a delinquency bucket is migrated.

Type: object
Additional properties: true
Domain: migration
Event: delinquency_bucket_outgoing
Version: 1

|
status required

Title: Migration status
Description: Result of delinquency bucket migration
Type: string
Must be one of the following:
SUCCESS
FAIL
Example:
SUCCESS
FAIL

message

Title: The message schema
Description: Message of delinquency bucket migration result
Type: string
Example:
Delinquency bucket migrated with success

code

Title: Migration message code
Description: System code for migration message
Type: string
Example:
MIGR-0001

operation

Title: Migration Operation
Description: Delinquency bucket migration operation type
Type: string
Must be one of the following:
CREATION
UPDATE
UNKNOWN
Example:
UPDATE
CREATION
UNKNOWN

migration required

Title: Migration identifiers object
Description: Migration identifiers object for delinquency bucket
Type: object
Additional properties: true
Example: 

{
    "id": "migration-id",
    "version_date": "2024-04-30T11:25:00.000Z"
}
id required

Title: Migration identifier
Type: string
Example:
migration-id

version_date required

Title: Version date of migration identifier
Type: string
Format: date-time
Example:
2024-04-30T11:25:00.000Z

entity

Title: Pismo-generated delinquency bucket information
Type: object
Example: 

{
    "statement_id": 22944079,
    "due_date": "2024-04-30",
    "delinquency_bucket_id": 1,
    "bucket_amount": 200,
    "bucket_balance": 100,
    "overdue_amount": 50,
    "created_at": "2024-04-30T22:00:00",
    "metadata": {
        "key": "value"
    },
    "account_id": 102186558
}
account_id

Title: Account identifier
Description: Account Pismo Id used to create/update delinquency bucket.
Type: number
Example:
127116016

statement_id

Title: Statement identifier
Description: Statement Pismo Id used to create/update delinquency bucket.
Type: number
Example:
7510352

delinquency_bucket_id

Title: Delinquency bucket identifier
Description: Delinquency bucket identifier generated by pismo.
Type: integer
Example:
82547101

due_date

Title: Due Date
Description: Due date from statement calendar.
Type: string
Format: date
Example:
2024-04-30

bucket_amount

Title: Delinquency bucket amount
Description: Bucket amount is the statement minimum amount due (MAD) subtracted by the previous bucket balance.
Type: number
Format: double
Example:
40.3

bucket_balance

Title: Delinquency bucket balance
Description: Current bucket balance. It starts as equal as the bucket amount and will decrease if the account receives any credit.
Type: number
Format: double
Example:
60.0

overdue_amount

Title: Overdue amount
Description: The outstanding balance after the due date considering only the minimum amount due (MAD) of the statement.
Type: number
Format: double
Example:
140.11

created_at

Title: Creation Date
Description: Delinquency bucket creation date, format = yyyy-MM-ddTHH:mm:ss.fffZ
Type: string
Format: datetime
Example:
2024-05-01T15:15:40.123Z

updated_at

Title: Update date
Description: Delinquency bucket update date, format = yyyy-MM-ddTHH:mm:ss.fffZ
Type: string
Format: datetime
Example:
2024-05-01T16:30:22.123Z

metadata

Description: Delinquency bucket metadata
Type: object
Additional properties: true
Example: 

{
    "key1": "value1",
    "key2": "value2"
}

{
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "$id": "https://pismo.io/events/migration/delinquency_bucket_outgoing-1.json",
    "type": "object",
    "default": {},
    "title": "Delinquency bucket migration completed",
    "description": "Event generated when a delinquency bucket is migrated.",
    "required": [
        "status",
        "migration"
    ],
    "properties": {
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "Migration status",
            "description": "Result of delinquency bucket migration",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "title": "The message schema",
            "description": "Message of delinquency bucket migration result",
            "examples": [
                "Delinquency bucket migrated with success"
            ]
        },
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "Migration message code",
            "description": "System code for migration message",
            "examples": [
                "MIGR-0001"
            ]
        },
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "title": "Migration Operation",
            "description": "Delinquency bucket migration operation type",
            "enum": [
                "CREATION",
                "UPDATE",
                "UNKNOWN"
            ],
            "examples": [
                "UPDATE",
                "CREATION",
                "UNKNOWN"
            ]
        },
        "migration": {
            "$id": "#/properties/migration",
            "type": "object",
            "title": "Migration identifiers object",
            "description": "Migration identifiers object for delinquency bucket",
            "examples": [
                {
                    "id": "migration-id",
                    "version_date": "2024-04-30T11:25:00.000Z"
                }
            ],
            "required": [
                "id",
                "version_date"
            ],
            "properties": {
                "id": {
                    "$id": "#/properties/migration/properties/id",
                    "type": "string",
                    "title": "Migration identifier",
                    "examples": [
                        "migration-id"
                    ]
                },
                "version_date": {
                    "$id": "#/properties/migration/properties/version_date",
                    "type": "string",
                    "format": "date-time",
                    "title": "Version date of migration identifier",
                    "examples": [
                        "2024-04-30T11:25:00.000Z"
                    ]
                }
            },
            "additionalProperties": true
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "title": "Pismo-generated delinquency bucket information",
            "properties": {
                "account_id": {
                    "$id": "#/properties/entity/properties/account_id",
                    "type": "number",
                    "title": "Account identifier",
                    "description": "Account Pismo Id used to create/update delinquency bucket.",
                    "examples": [
                        127116016
                    ]
                },
                "statement_id": {
                    "$id": "#/properties/entity/properties/statement_id",
                    "type": "number",
                    "title": "Statement identifier",
                    "description": "Statement Pismo Id used to create/update delinquency bucket.",
                    "examples": [
                        7510352
                    ]
                },
                "delinquency_bucket_id": {
                    "$id": "#/properties/entity/properties/delinquency_bucket_id",
                    "type": "integer",
                    "title": "Delinquency bucket identifier",
                    "description": "Delinquency bucket identifier generated by pismo.",
                    "examples": [
                        82547101
                    ]
                },
                "due_date": {
                    "$id": "#/properties/entity/properties/due_date",
                    "type": "string",
                    "title": "Due Date",
                    "description": "Due date from statement calendar.",
                    "format": "date",
                    "examples": [
                        "2024-04-30"
                    ]
                },
                "bucket_amount": {
                    "$id": "#/properties/entity/properties/bucket_amount",
                    "type": "number",
                    "title": "Delinquency bucket amount",
                    "description": "Bucket amount is the statement minimum amount due (MAD) subtracted by the previous bucket balance.",
                    "format": "double",
                    "examples": [
                        40.3
                    ]
                },
                "bucket_balance": {
                    "$id": "#/properties/entity/properties/bucket_balance",
                    "type": "number",
                    "title": "Delinquency bucket balance",
                    "description": "Current bucket balance. It starts as equal as the bucket amount and will decrease if the account receives any credit.",
                    "format": "double",
                    "examples": [
                        60.0
                    ]
                },
                "overdue_amount": {
                    "$id": "#/properties/entity/properties/overdue_amount",
                    "type": "number",
                    "title": "Overdue amount",
                    "description": "The outstanding balance after the due date considering only the minimum amount due (MAD) of the statement.",
                    "format": "double",
                    "examples": [
                        140.11
                    ]
                },
                "created_at": {
                    "$id": "#/properties/entity/properties/created_at",
                    "type": "string",
                    "title": "Creation Date",
                    "description": "Delinquency bucket creation date, format = yyyy-MM-ddTHH:mm:ss.fffZ",
                    "format": "datetime",
                    "examples": [
                        "2024-05-01T15:15:40.123Z"
                    ]
                },
                "updated_at": {
                    "$id": "#/properties/entity/properties/updated_at",
                    "type": "string",
                    "title": "Update date",
                    "description": "Delinquency bucket update date, format = yyyy-MM-ddTHH:mm:ss.fffZ",
                    "format": "datetime",
                    "examples": [
                        "2024-05-01T16:30:22.123Z"
                    ]
                },
                "metadata": {
                    "$id": "#/properties/entity/properties/metadata",
                    "type": "object",
                    "description": "Delinquency bucket metadata",
                    "default": {},
                    "examples": [
                        {
                            "key1": "value1",
                            "key2": "value2"
                        }
                    ],
                    "additionalProperties": true
                }
            },
            "examples": [
                {
                    "statement_id": 22944079,
                    "due_date": "2024-04-30",
                    "delinquency_bucket_id": 1,
                    "bucket_amount": 200,
                    "bucket_balance": 100,
                    "overdue_amount": 50,
                    "created_at": "2024-04-30T22:00:00",
                    "metadata": {
                        "key": "value"
                    },
                    "account_id": 102186558
                }
            ]
        }
    },
    "examples": [
        {
            "operation": "CREATION",
            "status": "SUCCESS",
            "code": "MIGR-0001",
            "message": "Delinquency bucket migrated with success",
            "migration": {
                "id": "0000002835685292023076",
                "version_date": "2024-04-30T09:44:55Z"
            },
            "entity": {
                "statement_id": 22944079,
                "due_date": "2024-04-30",
                "delinquency_bucket_id": 1,
                "bucket_amount": 200,
                "bucket_balance": 100,
                "overdue_amount": 50,
                "created_at": "2023-04-30T22:00:00",
                "metadata": {
                    "key": "value"
                },
                "account_id": 102186558
            }
        }
    ],
    "additionalProperties": true
}

{
    "operation": "CREATION",
    "status": "SUCCESS",
    "code": "MIGR-0001",
    "message": "Delinquency bucket migrated with success",
    "migration": {
        "id": "0000002835685292023076",
        "version_date": "2024-04-30T09:44:55Z"
    },
    "entity": {
        "statement_id": 22944079,
        "due_date": "2024-04-30",
        "delinquency_bucket_id": 1,
        "bucket_amount": 200,
        "bucket_balance": 100,
        "overdue_amount": 50,
        "created_at": "2023-04-30T22:00:00",
        "metadata": {
            "key": "value"
        },
        "account_id": 102186558
    }
}

Updated 2 days ago