Skip to main content
GET
Get Accounting Overview
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get Accounting Overview Consolidated endpoint that returns all data needed for the accounting dashboard in a single call. Replaces the need to call 6+ separate endpoints on page load. Returns: current period summary, previous period comparison with deltas, total due across all users, recent activity (top 5 revenues, expenses, payments), top payees by amount due, and monthly trends. Method: GET Authorization:
  • Required role: admin or higher
Query Parameters:

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

months
integer
default:6

Number of months of trend data to include

Required range: 1 <= x <= 24

Response

Accounting overview retrieved successfully

message
string
Example:

"success"

data
object