Walletguide
DevelopersAPIReferenceplanItems

Retrieve plan item

Retrieve one plan item by id with the Walletguide REST API. Parameters, response fields, and a playground you can run.

GET
/wallets/{walletId}/planItems/{id}

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

Row uuid

Formatuuid
id*string

Row uuid

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/planItems/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",  "firestoreId": "string",  "scenarioId": "e28e2f4c-7202-4457-b0d8-c4c537f7bff6",  "month": "string",  "categoryOrCategoryGroupId": "ede83f0b-08f4-4cfa-bc06-98787e881327",  "amount": "string",  "duration": -2147483648,  "frequency": -2147483648,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Create plan item

For duration = 1, an existing single-month item for the same month and target is replaced (legacy addPlanItem semantics).

Update plan item

Update a plan item with the Walletguide REST API. Parameters, response fields, and a playground you can run.