Accrual status changed
This event is generated when an account's accrual status changes. For example, Overdue start, Refinancing start, etc
Type: object
Domain: balance
Event: accrual_status
Version: 1
|
accrual_status required
Description: Account accrual status
Type: string
Example:
OVERDUE_START
OVERDUE_CHANGE
OVERDUE_STOP
OVERDUE_UNDERPAID
REFINANCING_START
REFINANCING_CHANGE
REFINANCING_STOP
STOP_ACCRUAL
balance_due required
Description: Balance when event was generated
Type: number
Example:
120.0
account_id
Description: Account ID
Type: integer
program_id
Description: Program ID
Type: integer
statement_id
Description: Statement ID
Type: integer
open_due_date
Description: Open due date
Type: string
Format: date
Example:
2021-06-21
amount_paid
Description: Amount Paid
Type: number
credit_transaction_id
Description: Credit Transaction ID
Type: integer
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Accrual status changed",
"description": "This event is generated when an account's accrual status changes. For example, Overdue start, Refinancing start, etc",
"required": [
"accrual_status",
"balance_due"
],
"properties": {
"accrual_status": {
"type": "string",
"description": "Account accrual status",
"examples": [
"OVERDUE_START",
"OVERDUE_CHANGE",
"OVERDUE_STOP",
"OVERDUE_UNDERPAID",
"REFINANCING_START",
"REFINANCING_CHANGE",
"REFINANCING_STOP",
"STOP_ACCRUAL"
]
},
"balance_due": {
"type": "number",
"description": "Balance when event was generated",
"examples": [
120.0
]
},
"account_id": {
"type": "integer",
"description": "Account ID"
},
"program_id": {
"type": "integer",
"description": "Program ID"
},
"statement_id": {
"type": "integer",
"description": "Statement ID"
},
"open_due_date": {
"type": "string",
"description": "Open due date",
"format": "date",
"examples": [
"2021-06-21"
]
},
"amount_paid": {
"type": "number",
"description": "Amount Paid"
},
"credit_transaction_id": {
"type": "integer",
"description": "Credit Transaction ID"
}
}
}
Updated 3 days ago