Available in version 0.8.4 and later.
Quick overview
- Purpose: Records a daily snapshot of each balance to preserve historical data, enabling users to review past financial states for auditing, reporting, or analytical purposes.
-
Frequency:
- Blnk takes one snapshot per day per balance when triggered.
- If the snapshot is called multiple times in a single day, it records only the first instance, capturing the state of all balances at that time.
- Subsequent calls on the same day will not create additional snapshots for balances already captured but will record snapshots for any new balances that lack a snapshot for that day.
- The next snapshot for all balances can only be captured on the following day.
-
Recommended timing: It’s best to take snapshots at midnight or at the user’s defined end-of-day period for consistency, as this minimizes disruptions and aligns with typical business closing times, providing a clear picture of daily financial positions.
Users have flexibility in determining when to trigger snapshots, but each balance is limited to one snapshot per day.
Triggering a snapshot
Call the Balance Snapshots endpoint. This action initiates a snapshot of all balances, capturing their current state at the time of the request for future reference.Response
Historical balances
Learn how to use balance snapshots to retrieve historical balances at a point in time.
Key considerations
- Daily snapshots and reconstruction: Since snapshots are taken once per day per balance, balances between snapshots are reconstructed using transaction data.
- Optimal snapshot timing: Choosing the right time to trigger snapshots is crucial for maintaining consistency and accuracy. Users should initiate snapshots at their preferred end-of-day period, such as midnight or another consistent business closing time.