logo

Future Balance

Future Balance
The /balance_estimate endpoint allows you to run our Balance Estimator tool and retrieve likely future balances. Pass the  account_id   along with a parameter for the future date for which you’d like a balance estimate: GET https://api.quovo.com/v3//accounts/{account_id}/balance_estimate?date={date}
The date must be formatted in YYYY-MM-DD, and must be 1-30 days in the future from the current date. For optimal results, we recommend you choose a future date within two weeks from the current date. You must pass a date in order to retrieve the likely future balances.
The endpoint will yield a   median_future_balance   based on our simulations, which represents our best overall estimate from our analysis.  Additionally, the endpoint will yield a distribution or histogram of up to ten bins; each represents an upper and lower bound of account balances, along with the percent of simulations that ended up in each bin.  This distribution can be used to get a better understanding of the confidence of our estimation based on the tightness of the bounds, as well as the percentage of simulation outcomes within each set of bounds. You can see a complete list of response fields in our Reference Docs.
{
    "balance_estimate": {
        "account_id": 2651831,
        "current_balance": 10812.84,
        "current_date": "2017-04-18",
        "estimate_date": "2017-04-25",        
        "future_balance_distribution": [
            {
                "lower": 10578.15,
                "percent": 0.789,
                "upper": 11420.81
            },
            {
                "lower": 11420.81,
                "percent": 0.211,
                "upper": 19004.84
            }
        ],
        "median_future_balance": 10798.36
    }
}
Note: The values of the fields as well as the number of buckets in the histogram are based on the selected future date, and may not reflect the values calculated using another date.
Balance Estimator will only work on active accounts with transaction data that have undergone full syncs within the last 30 days. If an account is inactive, does not have transaction history, or has not been synced in the preceding 30 days, we will yield a 400 error. These measures are taken in order to preserve the accuracy and reliability of our projections, which should incorporate recent account activity.