DevelopersAPIReferencedata
PlanVsActual
PlanVsActual (data endpoint) in the Walletguide REST API. Parameters, response fields, and a playground you can run.
POST
bearerAuthheader
Authorization<token>A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.
walletId*stringThe wallet id (row uuid)
Format
uuidapplication/json- body
monthPeriod?The planning window. Omit for the default ±10 years around now.
scenarioId?stringRestrict plan items to this scenario; omit for the whole plan.
planVsActual result
application/json- response
notImplemented*falseValue in
falsecategories*unassigned*currencyChangeEffectPerMonth*netWorthStartPerMonth*netWorthEndPerMonth*netWorthChangePerMonth*refGraph*array<>curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/planVsActual' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "notImplemented": false, "categories": { "property1": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "property2": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } } }, "unassigned": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "currencyChangeEffectPerMonth": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "netWorthStartPerMonth": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "netWorthEndPerMonth": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "netWorthChangePerMonth": { "property1": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true }, "property2": { "actual": 0, "plan": 0, "planItem": { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" }, "inactivePlanItems": [ { "scenarioId": "string", "month": "string", "categoryOrCategoryGroupId": "string", "amount": { "type": "fixed", "amount": { "value": 0, "currency": "EUR" }, "relativeChange": 0 }, "duration": 0, "frequency": 0, "createdTime": "2019-08-24T14:15:22Z", "createdUserId": "string", "lastUpdatedTime": "2019-08-24T14:15:22Z", "lastUpdatedUserId": "string", "id": "string" } ], "planUnresolvable": true } }, "refGraph": [ { "source": { "id": "string", "month": "string" }, "target": { "id": "string", "month": "string" }, "planItemId": "string" } ]}