PIpismo
Bank statements

Get account balance history config by ID v2

Get the current account balance history configuration by ID.

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

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

Request

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

Path parameters

balanceHistoryConfigIdstring uuid required

Balance history configuration ID

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.

Response

OK

idstring uuid required

Balance history configuration ID

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

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

target_idstring required

Target ID (org_id, program_id, or division_id)

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 response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "target_type": "ORGANIZATION",
  "target_id": "my-org-123",
  "cycle_closing_time": "23:00:00",
  "cycle_event_delay": 15,
  "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.