Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Finance Management.Savings Goals
ENTERPRISE

List periods progress

Get a list of periodProgresses, based on Users <code>periodMode</code> between the Savings Goal <code>createTime</code> and <code>targetDate</code>.<br />If no targetDate is set on the Savings Goal, it will return PeriodProgresses between createTime and the current date

get/api/v1/savings-goals/{id}/period_progress

Path parameters

idstring required

The Savings Goal ID

Query parameters

page_sizeinteger

(Optional) Size of the page to fetch.

page_tokenstring

(Optional) The first token is presented on the response of the first call if there are multiple pages.

Response

List of PeriodProgresses between the createTime and targetDate.

nextPageTokenstring

Next page token to be used for pagination, use it with the next request parameter <code>page_token</code> to request the next page of the list.

Example response

{
  "periodProgresses": [
    {
      "amountSavedThisPeriod": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 2000
      },
      "periodEndDate": "2020-02-25",
      "periodStartDate": "2020-01-25",
      "reachedAmountForSavingsGoalThisPeriod": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 2000
      }
    }
  ]
}