Agreements
Agreements represent the contractual relationship between a customer and the energy supplier for a specific property or supply point. Each agreement contains details about the tariff, billing settings, and consent preferences.
Agreements list
This page displays all active agreements for a property. Each agreement shows:
- Agreement ID - Unique identifier
- Address - The supply point address
- Tariff - The current tariff/product name
- Max Power - For electricity meters, the subscribed maximum power (e.g., 9kVA)
- Product Code - The product code identifier
- Valid From - When the agreement became active
From each agreement, users can:
- View and download agreement documents
- Navigate to view payments for the property
- Navigate to manage industry consents
Agreement payments
For a given property, users can view the transaction history showing all payments and charges. This includes:
- Type - Payment type (Direct Debit, Card Payment, Refund, etc.)
- Date - When the transaction occurred
- Amount - The transaction amount
- Status - Current status (Completed, Pending, Refunded, etc.)
Industry consents
Each agreement may have associated industry consents that control data sharing preferences. Users can manage consents such as:
- Daily consumption data - Permission to collect daily usage data
- Half-hourly consumption data - Permission to collect granular half-hourly readings
See the Consent page for more details on consent management.
Key hooks and components
| Hook/Component | Description |
|---|---|
useActiveAgreements | Fetches active agreements for a property with pagination |
useAgreementDocuments | Fetches downloadable documents for an agreement |
useTransactions | Fetches transaction history for a property |
AccountAgreement | Component for displaying agreement details |