Bank statements

Get account balance history config v1

Get the current account balance history configuration by division code.

Also returns previous configurations if you pass the query parameter showPrevious set to true.

get/bank-statements/v1/account-balances/history/config/{divisionCode}

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/bank-statements/v1/account-balances/history/config/{divisionCode}
  • Auth
    none declared

Path parameters

divisionCodestring required

Division code registered in the Create division endpoint.

Query parameters

showPreviousboolean

Should the previous account balances history by division code be returned?
If true, returns the previous account balances history configuration by division code. Default is false.
For example, if you use Update account balance history config to update an existing balance history configuration, specifying true in this field returns both the current balance history configuration and the previous ones.
There is no limit to how many previous balance history configurations can be returned.

offsetinteger

Starting point for the results list. Default is 0

limitinteger

Maximum results to return. Default is 20. Maximum is 200.

Response

OK

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

{
  "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"
  },
  "previous": [
    {
      "cycle_closing_time": "22:00:00",
      "cycle_event_delay": 15,
      "updated_at": "2025-05-19T12:41:18.373248Z",
      "cycle_config_validity": {
        "start": "2023-04-01T22:10:00Z",
        "end": "2023-05-01T22:10:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.