v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

spending goals

Retrieve all spending goals for a user

Requires spending_goals:read scope.

get/spending-goals

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

Response

Successful Spending Goals Response

metaobject

Example response

{
  "data": [
    {
      "categoryId": "std:4b0255f0-0309-4509-9e05-4b4e386f9b0d",
      "dateCreated": "2018-07-11T00:00:00.000Z",
      "periodType": "monthly",
      "periodStart": "01",
      "id": "0b4e6488-6de0-420c-8f56-fee665707d57",
      "amount": {
        "value": 40000,
        "majorUnits": 400,
        "currency": "GBP"
      },
      "spending": [
        {
          "date": "2018-07",
          "spent": -35000
        }
      ]
    }
  ]
}