Walletguide
DevelopersAPIReferencedata

CashFlowByCategory

Whole-wallet figures need the permissions listed without assets:read; scoping the request with assetIds makes it a per-asset breakdown, which needs…

POST
/wallets/{walletId}/data/cashFlowByCategory

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

The wallet id (row uuid)

Formatuuid

Request Body

application/json
  1. body
period*|

Window the per-category income/expense totals are computed for.

assetIds?array<string>

Scope to these asset uuids; omit for whole-wallet.

categoryIds?array<string>

Scope to these category uuids; omit for all categories.

Response Body

cashFlowByCategory result

application/json
  1. response
[key: string]?
Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/cashFlowByCategory' \  -H 'Content-Type: application/json' \  -d '{  "period": "today"}'
Example Response
{  "property1": {    "category": {      "name": "string",      "type": "activeIncome",      "emoji": "string",      "system": true,      "order": 0,      "categoryGroupId": "string",      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "id": "string"    },    "categoryNameWithParentGroups": "string",    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0  },  "property2": {    "category": {      "name": "string",      "type": "activeIncome",      "emoji": "string",      "system": true,      "order": 0,      "categoryGroupId": "string",      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "id": "string"    },    "categoryNameWithParentGroups": "string",    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0  }}