Workspace Financial Endpoints (v1)

This section documents all workspace financial management endpoints including income, expenses, and financial analytics.

Income Management

• List Incomes - Get list of workspace incomes with filters
• Get Income - Get income by ID
• Create Income - Create a new income record
• Update Income - Update an existing income record
• Delete Income - Delete an income record
• Get Income Stats - Get income statistics
• Upload Income Receipt - Upload receipt image for income

Expenses Management

• List Expenses - Get list of workspace expenses with filters
• Get Expense - Get expense by ID
• Create Expense - Create a new expense record
• Update Expense - Update an existing expense record
• Delete Expense - Delete an expense record
• Get Expense Stats - Get expense statistics
• Upload Expense Receipt - Upload receipt image for expense

Financial Analytics

• Get Financial Overview - Get financial overview with charts data
• Get Revenue Analytics - Get revenue analytics
• Get Financial Summary - Get financial summary

Authentication

All endpoints require workspace authentication. Users must be authenticated as either:

• Workspace Owner: Full access to all financial data
• Staff with Financial Permissions: Access based on role permissions

Base Path

All endpoints use the base path:

/api/v1/client/workspace/:workspaceId

Common Features

• Date Filtering: All list endpoints support date range filtering
• Pagination: List endpoints support pagination with configurable page size
• Receipt Images: Income and expense records can have receipt images attached
• Statistics: Separate endpoints provide aggregated statistics
• Subscription Check: All endpoints verify workspace subscription status