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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body

Create account balance history configuration request object.

string
enum
required

Account balance history config target type

Allowed:
string
required
length ≤ 60

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.

string
required
length ≤ 8
^(?:([01]?\d|2[0-3]):([0-5]?\d):)?([0-5]?\d)$

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.

int32
required
≥ 5

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.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json