Funds View Summary
This API provides a summarized view of the user's available and utilized funds, including deposits, collateral, credit for sale, margins, P&L, and net available funds. It is useful for displaying overall financial standing in a particular periodicity and product context.
🛣️Path Parameters
| Parameter | Type | Required | Description | Example |
|---|
| tenantid | string | Yes | Unique id provided for the tenant by SIPL | "TEN123" |
| Header | Type | Description | Example |
|---|
| Authorization | string | Bearer token for authentication | Bearer {{access_token}} |
| x-api-key | string | API key for access control | {{x-api-key}} |
📦Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|
| userId | string | Yes | Unique Client Code(UCC) of the user | "USR789" |
| groupId | string | Yes | Group ID associated with the user | "GRP001" |
| periodicityName | string | Yes | Name of the periodicity | "All Exchange Combined" |
| productType | integer | Yes | Product type ID | 2 |
🟢Success Response - 200 Ok
| Field | Type | Description | Example/ENUM |
|---|
| status | boolean | Status of API call | true |
| result | object | Funds Summary Object | See below |
💰Fund Summary Object Fields
| Field | Type | Description | Example/ENUM |
|---|
| Product | string | Product | "1" |
| Deposit | string | Total deposit | "500000.00" |
| Funds Transferred Today | string | Amount transferred today | "20000.00" |
| Collateral | string | Collateral amount | "100000.00" |
| Credit for Sale | string | Credit received from sales | "50000.00" |
| Option CFS | string | Option Credit for Sale | "15000.00" |
| Total Trading Power Limit | string | Combined trading limit | "650000.00" |
| Limit Utilization | string | Current limit used | "400000.00" |
| Booked P&L | string | Profit & Loss that is booked | "12000.00" |
| MTM P&L | string | Mark-to-Market Profit & Loss | "-8000.00" |
| Total Utilization | string | Total amount utilized | "520000.00" |
| Net Available Funds | string | Funds available for use | "130000.00" |
| For Allocation/Withdrawal | string | Eligible amount for allocation/withdrawal | "100000.00" |
| Exposure Margin | string | Margin used for exposure calculation | "75000.00" |
| Cash Deposit | string | Actual cash deposited | "400000.00" |
| Adhoc Deposit | integer | Temporary deposit | 10000 |
| NotionalDeposit | integer | Virtual deposit (for reporting) | 5000 |