Get budget summary for user

get

https://api.pocketsmith.com/v2/users/{id}/budget_summary

Get the user's budget summary, containing an expense and income analysis for all categories (excluding transfer categories) for the given period and date range. Akin to the overall budget shown on the Budget page in PocketSmith.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The unique identifier of the user.

Query Params

period

string

enum

required

The period to analyse in, one of weeks, months or years. Also supported is event, although event period analysis is only possible when the budget events gathered align, so in this case where all categories are analysed together, it's highly unlikely that event period analysis will be possible.

Allowed:

interval

integer

required

The period interval, e.g. if the interval is 2 and the period is weeks, the budget will be analysed fortnightly.

start_date

string

required

The date to start analysing the budget from. This will be bumped out to make full periods as necessary.

end_date

string

required

The date to stop analysing the budget from. This will be bumped out to make full periods as necessary.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

403Not Allowed

404Not Found