spending goals

Update a single spending goal

Requires spending_goals:read spending_goals:write scope.

patch/spending-goals/{goalId}

Request

  • Base URL
    https://api.moneyhub.co.uk/v3
  • URL
    https://api.moneyhub.co.uk/v3/spending-goals/{goalId}
  • Auth
    API key in header Authorization

Path parameters

goalIdstring uuid required

The Goal Id

Request body

categoryIdstring

The id of the category the spending goal should be created for

Example request

{
  "categoryId": "std:379c7ed2-27f3-401f-b581-f6507934f0f0",
  "amount": {
    "value": 300
  }
}

Response

Successful Spending Goal 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
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.