Get category spending summary | Open Ledger Documentation

Get a summary of spending/income by category for an entity within a specified date range. This provides insights into transaction patterns and amounts by category.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired

The ID of the entity

startDatedateOptional

Start date for the summary (ISO 8601 format)

endDatedateOptional

End date for the summary (ISO 8601 format)

typeenumOptionalDefaults to ALL

Filter by category type

Allowed values:

Response

Category summary retrieved successfully

summarylist of objects or null

periodStartdatetime or null

Start of the summary period

periodEnddatetime or null

End of the summary period

totalExpensesdouble or null

Total expenses across all categories

totalRevenuedouble or null

Total revenue across all categories

1	curl -G https://api-staging.openledger.com/v1/categories/summary \
2	-H "Authorization: Bearer <token>" \
3	-d entityId=ent_1234567890abcdef \
4	-d startDate=2024-01-01 \
5	-d endDate=2024-12-31

1	{
2	"summary": [
3	{
4	"categoryId": "acc_1234567890abcdef",
5	"categoryName": "Meals and Entertainment",
6	"categoryType": "EXPENSE",
7	"transactionCount": 15,
8	"totalAmount": 1250.75,
9	"averageAmount": 83.38,
10	"percentage": 12.5
11	}
12	],
13	"periodStart": "periodStart",
14	"periodEnd": "periodEnd",
15	"totalExpenses": 5250.75,
16	"totalRevenue": 12500
17	}