Statement cycle closed

Event generated when a statement cycle is closed.

Type: object
Domain: statements
Event: cycle_closing
Version: 1

|
account_id required

Description: Account ID
Type: integer

statement_id required

Description: Statement ID
Type: integer

program_id required

Description: Program ID
Type: integer

program_name

Description: Program name
Type: string

cycle required

Description: Sequential number that identifies the current account cycle
Type: integer

statement_cycle

Description: Sequential number that identifies the cycle that was just processed
Type: integer

cycle_closing_date required

Description: Billing cycle end date
Type: string
Format: date
Example:
2019-07-20

due_date required

Description: Due date for monthly credit card payment, format = yyyy-mm-dd
Type: string
Format: date
Example:
2019-07-20

real_due_date required

Description: Next working day after due_date, format = yyyy-mm-dd
Type: string
Format: date
Example:
2019-07-20

opening_date required

Description: Billing cycle start date, format = yyyy-mm-dd
Type: string
Format: date
Example:
2019-07-20

credits required

Description: Credit total value
Type: number
Example:
100.0

debits required

Description: Debit total value
Type: number
Example:
300.0

balance required

Description: Balance value
Type: number
Example:
200.0

minimum_payment required

Description: Minimum payment value
Type: number
Example:
30.0

{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "Statement cycle closed",
    "description": "Event generated when a statement cycle is closed.",
    "required": [
        "account_id",
        "statement_id",
        "program_id",
        "cycle",
        "cycle_closing_date",
        "due_date",
        "real_due_date",
        "opening_date",
        "credits",
        "debits",
        "balance",
        "minimum_payment"
    ],
    "properties": {
        "account_id": {
            "type": "integer",
            "description": "Account ID"
        },
        "statement_id": {
            "type": "integer",
            "description": "Statement ID"
        },
        "program_id": {
            "type": "integer",
            "description": "Program ID"
        },
        "program_name": {
            "type": "string",
            "description": "Program name"
        },
        "cycle": {
            "type": "integer",
            "description": "Sequential number that identifies the current account cycle"
        },
        "statement_cycle": {
            "type": "integer",
            "description": "Sequential number that identifies the cycle that was just processed"
        },
        "cycle_closing_date": {
            "type": "string",
            "description": "Billing cycle end date",
            "examples": [
                "2019-07-20"
            ],
            "format": "date"
        },
        "due_date": {
            "type": "string",
            "description": "Due date for monthly credit card payment, format = yyyy-mm-dd",
            "examples": [
                "2019-07-20"
            ],
            "format": "date"
        },
        "real_due_date": {
            "type": "string",
            "description": "Next working day after `due_date`, format = yyyy-mm-dd",
            "examples": [
                "2019-07-20"
            ],
            "format": "date"
        },
        "opening_date": {
            "type": "string",
            "description": "Billing cycle start date, format = yyyy-mm-dd",
            "examples": [
                "2019-07-20"
            ],
            "format": "date"
        },
        "credits": {
            "type": "number",
            "description": "Credit total value",
            "examples": [
                100.0
            ]
        },
        "debits": {
            "type": "number",
            "description": "Debit total value",
            "examples": [
                300.0
            ]
        },
        "balance": {
            "type": "number",
            "description": "Balance value",
            "examples": [
                200.0
            ]
        },
        "minimum_payment": {
            "type": "number",
            "description": "Minimum payment value",
            "examples": [
                30.0
            ]
        }
    }
}