Skip to main content

Get Income (v1)

Method & Path​

GET /api/v1/client/workspace/:workspaceId/incomes/:incomeId

Description​

Retrieve a single income record by ID.

Authentication​

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with financial permissions.

Headers​

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
incomeIdstringYesIncome identifier

Response 200 OK​

{
  "id": "507f1f77bcf86cd799439011",
  "workspaceId": "507f1f77bcf86cd799439012",
  "amount": 500.00,
  "date": "2025-01-15T10:30:00.000Z",
  "time": "10:30",
  "description": "Payment for session #123",
  "paymentMethod": "card",
  "source": "invoice",
  "sourceId": "507f1f77bcf86cd799439013",
  "receiptImage": {
    "url": "https://storage.googleapis.com/bucket/workspace-incomes/income-id/receipt-1234567890-abc123.webp",
    "path": "workspace-incomes/income-id/receipt-1234567890-abc123.webp",
    "width": 1000,
    "height": 1000,
    "sizeBytes": 50000,
    "contentType": "image/webp"
  },
  "notes": "Payment received via Stripe",
  "createdBy": "507f1f77bcf86cd799439014",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Common Errors​

400 Bad Request: Invalid income ID format

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have permission to view financial data

404 Not Found: Income or workspace not found

500 Internal Server Error: Server error occurred while processing the request