Fund

Feed balance summary by feed

Request

Retrieves a report of feed and ledger balances for a specific feed within a fund, including aggregate counts of how many accounts are balanced, unbalanced, or have no data.

Security

Class_oAuth(Required scopes: fund.details.read)

Path

businessCodestringrequired

Class business code

Example:demo-business

fundCodestringrequired

Class entity code

Example:demo-fund

feedIdstringrequired

The unique GUID identifier of the feed to retrieve balance data for.

Example:c5d0f34e-6d7a-6e8b-1f9c-0a1b2c3d4e5f

Query

includeHoldingBalanceboolean

Include holding balance details in the response.

Default:false

asAtDatestring

The date for which to retrieve balance data.

Example:asAtDate=2024-07-01

curl -i -X GET \
  'https://api.class-pie.com.au/api/1.0/f/demo-business/demo-fund/feed-data/balance-summary/c5d0f34e-6d7a-6e8b-1f9c-0a1b2c3d4e5f?includeHoldingBalance=false&asAtDate=2024-07-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json

DataArray of objectsrequired

ErrorsArray of objectsrequired

Response

{
  "Data": [
    {
      "FeedId": "a8275e0c-f5b7-4097-ac8e-4f40cd7a22df",
      "DefaultDisplayName": "CBA Savings Account - 000-111/11111111",
      "BalancedAccounts": 1,
      "UnbalancedAccounts": 0,
      "OtherAccounts": 0,
      "Status": "Balanced",
      "Balances": [
        {
          "SecurityIssueCode": "CASH",
          "HoldingAccountCode": "ha-cba-001",
          "HoldingAccountId": "d4e5f678-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
          "HoldingAccountDescription": "CBA Cash Holdings",
          "LedgerBalance": 125000.5,
          "LedgerBalanceDate": "2025-03-15T08:30:00",
          "FeedBalance": 125000.5,
          "FeedBalanceDate": "2025-03-15T08:30:00",
          "Status": "Balanced"
        }
      ]
    }
  ],
  "Errors": []
}