v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Bank statements

Create account balance history config v2

Create an account balance history configuration by division, organization, or program ID.

The configuration becomes effective on the day after the cycle closing time plus the cycle event delay. Example:

Division timezone: UTC
Create account balance history configuration is called at: 2023-05-01T18:00:00Z
Account balance history configuration cycle_closing_time is: 22:00:00
Account balance history configuration cycle_event_delay is: 10
Account balance history configuration starts at 2023-05-01T22:10:00Z

This endpoint generates an Account balance history configuration created event.

post/bank-statements/v2/account-balances/history/config

Request body

target_type'ORGANIZATION' | 'PROGRAM' | 'DIVISION' required

Account balance history config target type

target_idstring required

Target ID. When target_type is DIVISION, this value is the division code. Likewise, when target_type is PROGRAM, the value is the program ID, and so on.

cycle_closing_timestring time required

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 required

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

{
  "target_type": "DIVISION",
  "target_id": "my-division-code",
  "cycle_closing_time": "23:00:00",
  "cycle_event_delay": 15
}

Response

Created

idstring uuid

Balance history configuration ID

target_type'ORGANIZATION' | 'PROGRAM' | 'DIVISION'

The target type of the balance history configuration, based on the hierarchical level it applies to.

target_idstring

Target ID (org_id, program_id, or division_id)

cycle_closing_timestring time

Time of day the cycle closes for a division. This time follows the timezone configured in division. You can find the division timezone using the Get division by code endpoint.

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 response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "target_type": "ORGANIZATION",
  "target_id": "my-org-123",
  "cycle_closing_time": "22:00:00",
  "cycle_event_delay": 15,
  "cycle_config_validity": {
    "start": "2023-04-01T22:10:00Z",
    "end": "2023-05-01T22:10:00Z"
  }
}