DevelopersAPIReferencedata
PlanVsActual
PlanVsActual (data endpoint) in the Walletguide REST API. Parameters, response fields, and a playground you can run.
Authorization
bearerAuth Authorization<token>
A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.
In: header
Path Parameters
walletId*string
The wallet id (row uuid)
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/planVsActual" \ -H "Content-Type: application/json" \ -d '{}'{ "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" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } } }, "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" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } }, "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" } ] }, "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" } ] } }, "refGraph": [ { "source": { "id": "string", "month": "string" }, "target": { "id": "string", "month": "string" } } ]}