Account balance history configuration changed

Type: object
Domain: account-balances
Event: balance_history_config_change
Version: 1

|
division_code required

Title: Division code unique identifier
Description: Code string that uniquely identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123

cycle_closing_time required

Title: Determines the closing date to set the balances for the following day.
Type: string
Max length: 8
Example:
20:10:05

cycle_event_delay required

Title: The time in minutes the balance history events will be sent after the cycle_closing_datetime.
Type: integer
Example:
15

cycle_config_validity required

Title: Cycle date validity
Description: Object for the validity date of the configuration.
Type: object

start required

Title: Cycle date validity start
Description: The effective date of the configuration in the division's timezone.
Type: string
Max length: 25
Example:
2023-02-01T22:07:00-03:00

previous

Title: Cycle date validity
Description: Object for the validity date of the configuration.
Type: object

cycle_closing_time

Title: Determines the closing date to set the balances for the following day.
Type: string
Max length: 8
Example:
20:10:05

cycle_event_delay

Title: The time in minutes the balance history events will be sent after the cycle_closing_datetime.
Type: integer
Example:
15

cycle_config_validity

Title: Cycle date validity
Description: Object for the validity date of the configuration.
Type: object

start required

Title: Cycle date validity start
Description: The effective date of the configuration in the division's timezone.
Type: string
Max length: 25
Example:
2023-02-01T22:07:00-03:00

end

Title: Cycle date validity end
Description: The end date of the configuration in the division's timezone.
Type: string
Max length: 25
Example:
2023-03-01T22:07:00-03:00

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Account balance history configuration changed",
    "required": [
        "division_code",
        "cycle_closing_time",
        "cycle_event_delay",
        "cycle_config_validity"
    ],
    "properties": {
        "division_code": {
            "type": "string",
            "title": "Division code unique identifier",
            "description": "Code string that uniquely identifies the division within your organization.",
            "maxLength": 36,
            "examples": [
                "division-code-123"
            ]
        },
        "cycle_closing_time": {
            "type": "string",
            "title": "Determines the closing date to set the balances for the following day.",
            "maxLength": 8,
            "examples": [
                "20:10:05"
            ]
        },
        "cycle_event_delay": {
            "type": "integer",
            "title": "The time in minutes the balance history events will be sent after the cycle_closing_datetime.",
            "maximum": 59,
            "examples": [
                15
            ]
        },
        "cycle_config_validity": {
            "type": "object",
            "title": "Cycle date validity",
            "description": "Object for the validity date of the configuration.",
            "required": [
                "start"
            ],
            "properties": {
                "start": {
                    "type": "string",
                    "title": "Cycle date validity start",
                    "description": "The effective date of the configuration in the division's timezone.",
                    "maxLength": 25,
                    "examples": [
                        "2023-02-01T22:07:00-03:00"
                    ]
                }
            }
        },
        "previous": {
            "type": "object",
            "title": "Cycle date validity",
            "description": "Object for the validity date of the configuration.",
            "properties": {
                "cycle_closing_time": {
                    "type": "string",
                    "title": "Determines the closing date to set the balances for the following day.",
                    "maxLength": 8,
                    "examples": [
                        "20:10:05"
                    ]
                },
                "cycle_event_delay": {
                    "type": "integer",
                    "title": "The time in minutes the balance history events will be sent after the cycle_closing_datetime.",
                    "maximum": 59,
                    "examples": [
                        15
                    ]
                },
                "cycle_config_validity": {
                    "type": "object",
                    "title": "Cycle date validity",
                    "description": "Object for the validity date of the configuration.",
                    "required": [
                        "start"
                    ],
                    "properties": {
                        "start": {
                            "type": "string",
                            "title": "Cycle date validity start",
                            "description": "The effective date of the configuration in the division's timezone.",
                            "maxLength": 25,
                            "examples": [
                                "2023-02-01T22:07:00-03:00"
                            ]
                        },
                        "end": {
                            "type": "string",
                            "title": "Cycle date validity end",
                            "description": "The end date of the configuration in the division's timezone.",
                            "maxLength": 25,
                            "examples": [
                                "2023-03-01T22:07:00-03:00"
                            ]
                        }
                    }
                }
            }
        }
    }
}
{
    "division_code": "division-code-123",
    "cycle_closing_time": "20:10:05",
    "cycle_event_delay": 15,
    "cycle_config_validity": {
        "start": "2023-02-01T22:07:00-03:00"
    },
    "previous": {
        "cycle_closing_time": "20:10:05",
        "cycle_event_delay": 15,
        "cycle_config_validity": {
            "start": "2023-02-01T22:07:00-03:00",
            "end": "2023-03-01T22:07:00-03:00"
        }
    }
}