v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Bank statements

Update account balance history config v2

Update the account balance history configuration.

When you call this endpoint after cycle_config_validity.start, the new configuration is valid only after the two-cycle closing date. Example:

division timezone: UTC
Update account balance history configuration called at: 2023-05-01T18:00:00Z
current cycle closing time: 22:00:00
current cycle closing date: 2023-04-30 (from 2023-04-30T22:00:00Z to 2023-05-01T22:00:00Z)
cycle config validity start datetime of the new config: 2023-05-02T22:00:00Z
current config stays valid until 2023-05-02T22:00:00Z

If this endpoint is called when the current datetime is less than or equal to cycle_config_validity.start of the most recent configuration, the new configuration overrides the the most recent configuration. Example:

division timezone: UTC
Update account balance history configuration called at: 2023-05-01T19:00:00Z
Cycle config validity start datetime of the most recent configuration: 2023-05-02T22:00:00Z
New config overrides the most recent configuration settings, keeping the same cycle config validity start date: 2023-05-01T22:00:00Z

This endpoint generates an Account balance history configuration changed event.

patch/bank-statements/v2/account-balances/history/config/{balanceHistoryConfigId}

Path parameters

balanceHistoryConfigIdstring uuid required

Balance history configuration ID

Request body

cycle_closing_timestring time

Cycle closing time indicates what time of day the cycle closes for a division, organization, or program. This time uses the timezone configured for the corresponding division, organization, or program.

cycle_event_delayinteger

The cycle event delay specifies how many minutes after cycle_closing_time the account balance history event is issued for each account in the division.

Example request

{
  "cycle_closing_time": "23:00:00",
  "cycle_event_delay": 15
}

Response

No Content