Financial summary report

GET

/api-v1/reports/summary

Reports

Generate a financial summary with income, expenses, and category breakdown.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Summary report

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gvazyknvkqdeuzmrnuwu.supabase.co/functions/v1/api-v1/reports/summary?date_from=2025-01-01&date_to=2025-01-31&bank_account_id' \
--header 'X-API-Key: <api-key>'

Response Example

{
    "success": true,
    "data": {
        "period": {
            "from": "2025-01-01",
            "to": "2025-01-31"
        },
        "total_income": 150000,
        "total_expenses": -85000,
        "net": 65000,
        "transaction_count": 234,
        "by_category": {
            "Sales": 145000,
            "Other Income": 5000,
            "Payroll": -45000,
            "Office Supplies": -8000,
            "Software Subscriptions": -12000,
            "Utilities": -5000,
            "Professional Services": -15000
        },
        "by_accounting_category": {
            "Net Sales": 145000,
            "Other Income": 5000,
            "Administrative Expenses": -35000,
            "Sales Expenses": -20000,
            "Technology Tools Expenses": -15000,
            "General Expenses": -15000
        }
    }
}

Modified at 2025-12-30 00:32:01

Cash flow report

Get company details