Update account balance history config v1

Update the account balance history configuration for a division code.

If this endpoint is called when the current datetime is greater than 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 36

Division code registered in the Create division endpoint.

Body Params

Request body

string
length ≤ 8

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.

int32
≥ 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
204

No Content

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