Settlement API¶

Base path: /core/api/communities/{community_id}/sessions

Get Settlement Data for a Session¶

GET /core/api/communities/{community_id}/sessions/settlements/{session_id}

Returns full settlement results for the session:

Member-level revenue breakdown
Resource-level revenue breakdown
CPE-level grid interaction results
REC-level aggregates

Get Settlement KPIs¶

GET /core/api/communities/{community_id}/sessions/settlement/metrics/kpis
  ?start_datetime=2024-01-01&end_datetime=2024-01-31

Get Member Settlement Metrics¶

GET /core/api/communities/{community_id}/sessions/settlement/metrics/members
  ?start_datetime=2024-01-01&end_datetime=2024-01-31

Generate Billing Guide (Excel)¶

curl

curl -X POST \
  https://<host>/core/api/communities/{community_id}/sessions/settlement/billing-guides/excel \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "start_date": "2024-01-01",
    "end_date": "2024-01-31",
    "user_ids": [],
    "sheets": ["summary", "transactions"]
  }'

This is an async operation. Poll GET /core/api/communities/{community_id}/sessions/settlement/billing-guides to check when the file is ready.

List Billing Guides¶

GET /core/api/communities/{community_id}/sessions/settlement/billing-guides

Download Billing Guide¶

GET /core/api/communities/{community_id}/sessions/settlement/billing-guides/{file_name}