Walletguide
DevelopersAPIReferencescenarios

CategoryBase

Merges { categoryId, amount } into the scenario startingBasePerCategory jsonb; an amount value of 0 removes the entry (legacy updateCategoryBase…

POST
/wallets/{walletId}/scenarios/{id}/categoryBase

Authorization

bearerAuth
headerAuthorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

Path Parameters

walletId*string

Row uuid

Formatuuid
id*string

Row uuid

Formatuuid

Request Body

application/json
  1. body
categoryId*string

Category row uuid or a system-category sentinel ('transfer'/'balance'/'offset')

amount*

Response Body

The updated scenario

application/json
  1. response
id*string
Formatuuid
walletId*string
Formatuuid
firestoreId*string|null
name*string
startDate*string
endMonth*string|null
startingBasePerCategory*string|number|boolean|null||array<unknown>
expectedAnnualReturn*number
Range-140737488355328 <= value <= 140737488355327
assetIds*array<>|null
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenarios/497f6eca-6276-4993-bfeb-53cbbbba6f08/categoryBase' \  -H 'Content-Type: application/json' \  -d '{  "categoryId": "string",  "amount": {    "value": 0,    "currency": "string"  }}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",  "firestoreId": "string",  "name": "string",  "startDate": "string",  "endMonth": "string",  "startingBasePerCategory": "string",  "expectedAnnualReturn": -140737488355328,  "assetIds": [    "96fa1cd8-4f1c-475e-ac07-c52694e711b7"  ],  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

ChangeEvents

Takes the whole desired change-event map (keyed by change-event id) and diffs it against the stored rows: new keys are created, changed entries updated…

CategoryBases

Merges a { categoryId: amount } map into startingBasePerCategory; an amount value of 0 removes that entry (legacy bulkUpdateCategoryBases, taking proper…