Account balance statement update completed
Type: object
Domain: migration
Event: account_balance_statement_update_outgoing
Version: 1
operation required
Title: Balance Statement Update Operation
Type: string
Must be one of the following:
UPDATE
Example:
CREATION
status required
Title: Migration status
Description: If the result of the balance statement update was a success or not
Type: string
Must be one of the following:
SUCCESS
FAIL
Example:
SUCCESS
FAIL
message required
Title: The message schema
Description: Message of balance statement update result
Type: string
Example:
Account migrated with success
migration required
Title: Balance statement update identifiers object
Type: object
Additional properties: false
Example:{ "id": "migration-id", "version_date": "2021-08-11T11:25:00.000Z" }id required
Title: Migration Identifier
Description: Balance statement update uses the Pismo's account_id as migration_id
Type: string
Example:
8511542424version_date required
Title: Date and time of balance statement update
Type: string
Example:
2021-08-11T11:25:00.000Z
entity required
Title: The entity Schema
Type: objectaccount_id required
Description: Account identifier generated by Pismo
Type: integer
Example:
9999program_due_date_id
Title: The program_due_date_id of the updated account
Type: integer
Example:
4033collection_status
Title: The collection_status of the updated account
Type: string
Example:
NORMALcurrent_cycle
Title: The current_cycle of the updated account
Type: integer
Example:
2open_due_date
Title: The opend_due_date of the updated account
Type: string
Example:
2024-12-18statements required
Description: Updates statements of the account
Type: array
Example:[ { "statement_id": 1952499422, "cycle": 2, "cycle_closing_date": "2025-01-02", "due_date": "2025-01-12", "real_due_date": "2025-01-13", "previous_balance": 847.18, "debits": 444.66, "credits": 0.0, "current_balance": 1291.84 }, { "statement_id": 1952499937, "cycle": 44, "cycle_closing_date": "2024-12-02", "due_date": "2024-12-12", "previous_balance": 180.52, "debits": 0.0, "credits": 0.0, "current_balance": 180.52 } ]statement_id required
Title: Pismo's statement id
Type: integer
Example:
1952499422
1952499937cycle
Title: Cycle of the updated statement
Type: integer
Example:
2
44cycle_closing_date
Title: Cycle closing date of the updated statement
Type: string
Example:
2025-01-02
2024-12-02due_date
Title: Due date of the updated statement
Type: string
Example:
2025-01-12
2024-12-12real_due_date
Title: Real due date of the updated statement
Type: string
Example:
2025-01-13previous_balance
Title: Previous balance of the updated statement
Type: number
Example:
847.18
180.52debits
Title: Debits of the updated statement
Type: number
Example:
444.66
nullcredits
Title: Credits of the updated statement
Type: number
Example:
nullcurrent_balance
Title: Current balance of the updated statement
Type: number
Example:
1291.84
180.52
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://pismo.io/events/migration/account_balance_statement_update_outgoing-1.json",
"title": "Account balance statement update completed",
"type": "object",
"required": [
"operation",
"status",
"message",
"migration",
"entity"
],
"properties": {
"operation": {
"$id": "#/properties/operation",
"type": "string",
"title": "Balance Statement Update Operation",
"enum": [
"UPDATE"
],
"examples": [
"CREATION"
]
},
"status": {
"$id": "#/properties/status",
"type": "string",
"title": "Migration status",
"description": "If the result of the balance statement update was a success or not",
"enum": [
"SUCCESS",
"FAIL"
],
"examples": [
"SUCCESS",
"FAIL"
]
},
"message": {
"$id": "#/properties/message",
"type": "string",
"title": "The message schema",
"description": "Message of balance statement update result",
"default": "",
"examples": [
"Account migrated with success"
]
},
"migration": {
"$id": "#/properties/migration",
"type": "object",
"title": "Balance statement update identifiers object",
"default": {},
"examples": [
{
"id": "migration-id",
"version_date": "2021-08-11T11:25:00.000Z"
}
],
"required": [
"id",
"version_date"
],
"properties": {
"id": {
"$id": "#/properties/migration/properties/id",
"type": "string",
"title": "Migration Identifier",
"description": "Balance statement update uses the Pismo's account_id as migration_id",
"examples": [
"8511542424"
]
},
"version_date": {
"$id": "#/properties/migration/properties/version_date",
"type": "string",
"title": "Date and time of balance statement update",
"examples": [
"2021-08-11T11:25:00.000Z"
]
}
},
"additionalProperties": false
},
"entity": {
"type": "object",
"default": {},
"title": "The entity Schema",
"required": [
"account_id",
"statements"
],
"properties": {
"account_id": {
"$id": "#/properties/entity/properties/account_id",
"type": "integer",
"description": "Account identifier generated by Pismo",
"examples": [
9999
]
},
"program_due_date_id": {
"$id": "#/properties/entity/properties/program_due_date_id",
"type": "integer",
"title": "The program_due_date_id of the updated account",
"examples": [
4033
]
},
"collection_status": {
"$id": "#/properties/entity/properties/collection_status",
"type": "string",
"title": "The collection_status of the updated account",
"examples": [
"NORMAL"
]
},
"current_cycle": {
"$id": "#/properties/entity/properties/current_cycle",
"type": "integer",
"title": "The current_cycle of the updated account",
"examples": [
2
]
},
"open_due_date": {
"$id": "#/properties/entity/properties/open_due_date",
"type": "string",
"title": "The opend_due_date of the updated account",
"examples": [
"2024-12-18"
]
},
"statements": {
"$id": "#/properties/entity/properties/statements",
"type": "array",
"description": "Updates statements of the account",
"items": {
"type": "object",
"description": "Statement data",
"required": [
"statement_id"
],
"properties": {
"statement_id": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/statement_id",
"type": "integer",
"title": "Pismo's statement id",
"examples": [
1952499422,
1952499937
]
},
"cycle": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/cycle",
"type": "integer",
"title": "Cycle of the updated statement",
"examples": [
2,
44
]
},
"cycle_closing_date": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/cycle_closing_date",
"type": "string",
"title": "Cycle closing date of the updated statement",
"examples": [
"2025-01-02",
"2024-12-02"
]
},
"due_date": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/due_date",
"type": "string",
"title": "Due date of the updated statement",
"examples": [
"2025-01-12",
"2024-12-12"
]
},
"real_due_date": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/real_due_date",
"type": "string",
"default": "",
"title": "Real due date of the updated statement",
"examples": [
"2025-01-13"
]
},
"previous_balance": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/previous_balance",
"type": "number",
"title": "Previous balance of the updated statement",
"examples": [
847.18,
180.52
]
},
"debits": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/debits",
"type": "number",
"title": "Debits of the updated statement",
"examples": [
444.66,
0.0
]
},
"credits": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/credits",
"type": "number",
"title": "Credits of the updated statement",
"examples": [
0.0
]
},
"current_balance": {
"$id": "#/properties/entity/properties/statements/items/anyOf/0/properties/credits",
"type": "number",
"title": "Current balance of the updated statement",
"examples": [
1291.84,
180.52
]
},
"additionalItems": true
},
"examples": [
{
"statement_id": 1952499422,
"cycle": 2,
"cycle_closing_date": "2025-01-02",
"due_date": "2025-01-12",
"real_due_date": "2025-01-13",
"previous_balance": 847.18,
"debits": 444.66,
"credits": 0.0,
"current_balance": 1291.84
},
{
"statement_id": 1952499937,
"cycle": 44,
"cycle_closing_date": "2024-12-02",
"due_date": "2024-12-12",
"previous_balance": 180.52,
"debits": 0.0,
"credits": 0.0,
"current_balance": 180.52
}
]
},
"examples": [
[
{
"statement_id": 1952499422,
"cycle": 2,
"cycle_closing_date": "2025-01-02",
"due_date": "2025-01-12",
"real_due_date": "2025-01-13",
"previous_balance": 847.18,
"debits": 444.66,
"credits": 0.0,
"current_balance": 1291.84
},
{
"statement_id": 1952499937,
"cycle": 44,
"cycle_closing_date": "2024-12-02",
"due_date": "2024-12-12",
"previous_balance": 180.52,
"debits": 0.0,
"credits": 0.0,
"current_balance": 180.52
}
]
]
},
"additionalItems": true
},
"additionalItems": false
}
},
"examples": [
{
"operation": "UPDATE",
"status": "SUCCESS",
"message": "Account balance statement updated",
"migration": {
"id": "235771468",
"version_date": "2024-12-18T21:22:35.256106Z"
},
"entity": {
"account_id": 235771468,
"program_due_date_id": 4033,
"collection_status": "NORMAL",
"current_cycle": 2,
"statements": [
{
"statement_id": 1952499422,
"cycle": 2,
"cycle_closing_date": "2025-01-02",
"due_date": "2025-01-12",
"real_due_date": "2025-01-13",
"previous_balance": 847.18,
"debits": 444.66,
"credits": 0.0,
"current_balance": 1291.84
},
{
"statement_id": 1952499937,
"cycle": 44,
"cycle_closing_date": "2024-12-02",
"due_date": "2024-12-12",
"previous_balance": 180.52,
"debits": 0.0,
"credits": 0.0,
"current_balance": 180.52
}
]
}
}
]
}
{
"operation": "UPDATE",
"status": "SUCCESS",
"message": "Account balance statement updated",
"migration": {
"id": "235771468",
"version_date": "2024-12-18T21:22:35.256106Z"
},
"entity": {
"account_id": 235771468,
"program_due_date_id": 4033,
"collection_status": "NORMAL",
"current_cycle": 2,
"statements": [
{
"statement_id": 1952499422,
"cycle": 2,
"cycle_closing_date": "2025-01-02",
"due_date": "2025-01-12",
"real_due_date": "2025-01-13",
"previous_balance": 847.18,
"debits": 444.66,
"credits": 0.0,
"current_balance": 1291.84
},
{
"statement_id": 1952499937,
"cycle": 44,
"cycle_closing_date": "2024-12-02",
"due_date": "2024-12-12",
"previous_balance": 180.52,
"debits": 0.0,
"credits": 0.0,
"current_balance": 180.52
}
]
}
}
Updated 2 days ago