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.

Authentication

AuthorizationBearer

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

Query Parameters

entityIdstringRequired

The ID of the entity

startDatestringOptionalformat: "date"

Start date for the summary (ISO 8601 format)

endDatestringOptionalformat: "date"

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

periodStartstring or nullformat: "date-time"

Start of the summary period

periodEndstring or nullformat: "date-time"

End of the summary period

totalExpensesdouble or null

Total expenses across all categories

totalRevenuedouble or null

Total revenue across all categories

1	import requests
2
3	url = "https://api-staging.openledger.com/v1/categories/summary"
4
5	querystring = {"entityId":"ent_1234567890abcdef","startDate":"2024-01-01","endDate":"2024-12-31"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"summary": [
3	{
4	"categoryId": "acc_1234567890abcdef",
5	"categoryName": "Meals and Entertainment",
6	"categoryType": "ASSET",
7	"transactionCount": 15,
8	"totalAmount": 1250,
9	"averageAmount": 83.4,
10	"percentage": 12.5
11	}
12	],
13	"periodStart": "2024-01-15T09:30:00Z",
14	"periodEnd": "2024-01-15T09:30:00Z",
15	"totalExpenses": 5250,
16	"totalRevenue": 12500
17	}

Authentication

Query Parameters

Response

Errors