Installment advanced

Event generated when an installment is advanced.

Type: object
Domain: balance
Event: installment_advancement
Version: 1

org_id required

Description: Organization ID
Type: string
Example:
TN-cc8f8b89-233a-4582-9f36-63ee85278d6d

program_id required

Description: Program ID
Type: integer
Example:
1122

program_type_id required

Description: Program type ID
Type: integer
Example:
1

account_id required

Description: Account ID
Type: integer
Example:
9832195123

event_date_time required

Description: Date and time when event generated in ISO-8601 format
Type: string
Format: date-time
Example:
2021-10-18T15:23:17Z

transactions required

Type: array

transaction_id required

Description: Advanced transaction ID
Type: integer
Example:
2306505

old_statement_id required

Description: ID of transaction statement before advancement
Type: integer
Example:
51131651

new_statement_id required

Description: ID of transaction statement after advancement
Type: integer
Example:
51131651

transaction_type_id required

Description: Transaction type ID
Type: integer
Example:
122

old_amount required

Description: Transaction amount before the advancement
Type: number
Format: double
Example:
40.3

new_amount required

Description: Transaction amount after advancement
Type: number
Format: double
Example:
40.3

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Installment advanced",
    "description": "Event generated when an installment is advanced.",
    "required": [
        "org_id",
        "program_id",
        "program_type_id",
        "account_id",
        "event_date_time",
        "transactions"
    ],
    "properties": {
        "org_id": {
            "type": "string",
            "description": "Organization ID",
            "examples": [
                "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
            ]
        },
        "program_id": {
            "type": "integer",
            "description": "Program ID",
            "examples": [
                1122
            ]
        },
        "program_type_id": {
            "type": "integer",
            "description": "Program type ID",
            "examples": [
                1
            ]
        },
        "account_id": {
            "type": "integer",
            "description": "Account ID",
            "examples": [
                9832195123
            ]
        },
        "event_date_time": {
            "type": "string",
            "description": "Date and time when event generated in ISO-8601 format",
            "format": "date-time",
            "examples": [
                "2021-10-18T15:23:17Z"
            ]
        },
        "transactions": {
            "type": "array",
            "title": "Advanced transactions",
            "items": {
                "type": "object",
                "required": [
                    "transaction_id",
                    "old_statement_id",
                    "new_statement_id",
                    "transaction_type_id",
                    "old_amount",
                    "new_amount"
                ],
                "properties": {
                    "transaction_id": {
                        "type": "integer",
                        "description": "Advanced transaction ID",
                        "examples": [
                            2306505
                        ]
                    },
                    "old_statement_id": {
                        "type": "integer",
                        "description": "ID of transaction statement before advancement",
                        "examples": [
                            51131651
                        ]
                    },
                    "new_statement_id": {
                        "type": "integer",
                        "description": "ID of transaction statement after advancement",
                        "examples": [
                            51131651
                        ]
                    },
                    "transaction_type_id": {
                        "type": "integer",
                        "description": "Transaction type ID",
                        "examples": [
                            122
                        ]
                    },
                    "old_amount": {
                        "type": "number",
                        "description": "Transaction amount before the advancement",
                        "format": "double",
                        "examples": [
                            40.3
                        ]
                    },
                    "new_amount": {
                        "type": "number",
                        "description": "Transaction amount after advancement",
                        "format": "double",
                        "examples": [
                            40.3
                        ]
                    }
                }
            }
        }
    }
}

{
    "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
    "program_id": 1122,
    "program_type_id": 1,
    "account_id": 9832195123,
    "event_date_time": "2021-10-18T15:23:17Z",
    "transactions": {
        "transaction_id": 2306505,
        "old_statement_id": 51131651,
        "new_statement_id": 51131651,
        "transaction_type_id": 122,
        "old_amount": 40.3,
        "new_amount": 40.3
    }
}

Updated 3 days ago