Skip to main content

List Income Sources (v1)

Method & Path​

GET /api/v1/client/workspace/:workspaceId/income-sources

Description​

List workspace-defined income sources. Each workspace owner can define custom sources (e.g. manual, invoice, order, other). Used for filtering income and in the Add Income form.

Authentication​

Required: Workspace authentication (Workspace Owner or Staff).

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response 200 OK​

[
  {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "name": "manual",
    "labelAr": "يدوي",
    "order": 0,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  }
]

Common Errors​

401 Unauthorized: Missing or invalid token
404 Not Found: Workspace not found