Accrual created

Event generate when an accrual is created.

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

program_id required

Description: Program ID
Type: integer
Example:
1010

account_id required

Description: Account ID
Type: integer
Example:
1010

statement_id required

Description: Statement ID
Type: integer
Example:
1010

transaction_id required

Description: Transaction ID
Type: integer
Example:
1010

transaction_balance required

Description: Transaction balance
Type: number
Example:
540.45

interest_rate required

Description: Accrual interest rate
Type: number
Example:
1e-05

accrual_day required

Description: Accrual day
Type: integer
Example:
21

accrual_type required

Description: Accrual type.
Type: string
Example:
REFINANCING
OVERDUE
DAILY_IOF
FINE
DEFAULT_INTEREST
FIXED_IOF

status required

Description: Status
Type: string
Example:
PENDING
STOP_ACCRUAL

accrual_value required

Description: Accrual value
Type: number
Example:
1.2

event_date required

Description: Event date, format = yyyy-mm-dd
Type: string
Format: date
Example:
2021-06-21

accrual_date required

Description: The reference date of the accrual. It may be in the future for projection. Format = yyyy-mm-dd
Type: string
Format: date
Example:
2021-06-21

created_at required

Description: Accrual created at, format = yyyy-MM-ddTHH:mm:ss.fffZ
Type: string
Format: datetime
Example:
2023-04-14T15:15:40.123Z

additional_info

Type: object

account_financial_classification

Description: Customer-defined number representing the financial classification of the account. (Default: 0)
Type: integer
Example:
2

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Accrual created",
    "description": "Event generate when an accrual is created.",
    "required": [
        "program_id",
        "account_id",
        "statement_id",
        "transaction_id",
        "transaction_balance",
        "interest_rate",
        "accrual_day",
        "accrual_type",
        "status",
        "accrual_value",
        "event_date",
        "accrual_date",
        "created_at"
    ],
    "properties": {
        "program_id": {
            "type": "integer",
            "description": "Program ID",
            "examples": [
                1010
            ]
        },
        "account_id": {
            "type": "integer",
            "description": "Account ID",
            "examples": [
                1010
            ]
        },
        "statement_id": {
            "type": "integer",
            "description": "Statement ID",
            "examples": [
                1010
            ]
        },
        "transaction_id": {
            "type": "integer",
            "description": "Transaction ID",
            "examples": [
                1010
            ]
        },
        "transaction_balance": {
            "type": "number",
            "description": "Transaction balance",
            "examples": [
                540.45
            ]
        },
        "interest_rate": {
            "type": "number",
            "description": "Accrual interest rate",
            "examples": [
                1e-05
            ]
        },
        "accrual_day": {
            "type": "integer",
            "description": "Accrual day",
            "examples": [
                21
            ]
        },
        "accrual_type": {
            "type": "string",
            "description": "Accrual type.",
            "examples": [
                "REFINANCING",
                "OVERDUE",
                "DAILY_IOF",
                "FINE",
                "DEFAULT_INTEREST",
                "FIXED_IOF"
            ]
        },
        "status": {
            "type": "string",
            "description": "Status",
            "examples": [
                "PENDING",
                "STOP_ACCRUAL"
            ]
        },
        "accrual_value": {
            "type": "number",
            "description": "Accrual value",
            "examples": [
                1.2
            ]
        },
        "event_date": {
            "type": "string",
            "description": "Event date, format = yyyy-mm-dd",
            "format": "date",
            "examples": [
                "2021-06-21"
            ]
        },
        "accrual_date": {
            "type": "string",
            "description": "The reference date of the accrual. It may be in the future for projection. Format = yyyy-mm-dd",
            "format": "date",
            "examples": [
                "2021-06-21"
            ]
        },
        "created_at": {
            "type": "string",
            "description": "Accrual created at, format = yyyy-MM-ddTHH:mm:ss.fffZ",
            "format": "datetime",
            "examples": [
                "2023-04-14T15:15:40.123Z"
            ]
        },
        "additional_info": {
            "type": "object",
            "properties": {
                "account_financial_classification": {
                    "type": "integer",
                    "description": "Customer-defined number representing the financial classification of the account. (Default: 0)",
                    "examples": [
                        2
                    ]
                }
            }
        }
    }
}

{
    "program_id": 1010,
    "account_id": 1010,
    "statement_id": 1010,
    "transaction_id": 1010,
    "transaction_balance": 540.45,
    "interest_rate": 1e-05,
    "accrual_day": 21,
    "accrual_type": "REFINANCING",
    "status": "PENDING",
    "accrual_value": 1.2,
    "event_date": "2021-06-21",
    "accrual_date": "2021-06-21",
    "created_at": "2023-04-14T15:15:40.123Z",
    "additional_info": {
        "account_financial_classification": 2
    }
}

Updated 7 days ago