Documentation Index
Fetch the complete documentation index at: https://api-docs.rabot.energy/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This documentation package contains two complementary diagrams that illustrate the complete customer lifecycle when using the RABOT Partner API for electricity tariff contract processing.Diagram 1: Customer Lifecycle Swim-lane Diagram
Purpose
Shows the optimal happy path flow across all actors (Partner, Customer, RABOT, Market Communication Partner) from initial offer generation through to contract activation.Key Features
- Swim-lanes represent each actor’s responsibilities
- Sequential flow shows the chronological progression
- Data requirements are annotated at each stage
- Optimal approach assumes all contract data is collected upfront during quote preparation
How to Read
- Follow the flow from top to bottom
- Each colored section represents a major phase
- Arrows show interactions between systems
- Notes indicate critical data requirements and decision points
Important Note
This diagram shows the STREAMLINED flow for a Telesales operating partner. Partners can alternatively collect order data AFTER offer acceptance, but this approach lengthens deal velocity and is not recommended.Diagram 2: Contract State Transition Diagram
Purpose
Shows all possible states a contractDraft can transition through, including error states and terminal conditions.States Explained
| State | Type | Description | Action Required |
|---|---|---|---|
| Open | Initial | ContractDraft created, awaiting pre-validation | None (automated) |
| Processing | Active | Pre-validation passed, transmitted to Market Partners | None (automated) |
| Denied | Recoverable | Issue during change process | Support intervention |
| Rejected | Terminal | Order rejected (insolvency/timing) | None |
| Revoked | Terminal | Customer cancelled during change | None |
| Contract | Success | Change process completed successfully | None |
| Cancelled | Terminal | Customer cancelled after delivery started | Optional: Winback |
Transition Triggers
- Solid arrows: Standard transitions
- Notes: Explain trigger conditions and required actions
- Return paths: Show recoverable error states (e.g., Denied → Processing)
Key Integration Points for Partners
1. Order Submission (POST /orders)
When: After customer accepts offerRequirements:
- Email address (verified)
- Delivery address (must be findable in RABOT database)
- Meter number
- Tariff details (working price, base price)
- Personal details (userAccount DTO)
- Previous supplier (for supplier changes)
- Move-in date (for new move-ins)
- Bank details
- Invoice address (if different from delivery address)
2. Pre-validation Checks
What RABOT validates:- Email address format and validity
- Delivery address exists in database
- Meter number is present
3. State Monitoring
Partners should monitor contract states via:- API polling
Open→ no change after 24 hours? Check support ticketsDenied→ review issue message, customer support will contact customerContract→ celebrate! Inform customer of delivery start date
For Energy Market Newcomers
What is the “Change Process”?
When a customer switches electricity suppliers, a formal market process coordinates:- The customer’s current supplier
- The new supplier (you/RABOT)
- The grid operator
- The metering company
Typical Timeline
- Offer to Acceptance: Hours to days (partner-dependent)
- Acceptance to Processing: Minutes (if data complete)
- Processing to Contract: Weeks (market-dependent, typically 2-6 weeks)
Common Failure Scenarios
Scenario 1: Pre-validation Failure (State: Open)
Common causes:- Invalid email format
- Delivery address not in database
- Missing meter number
Scenario 2: Denied During Change Process
Common causes:- Market Location cannot be identified
- Existing contract end date is too far in future
- Data mismatches with existing supplier
Scenario 3: Rejected Order
Common causes:- Customer has insolvency proceedings
- Existing contract end date is too far in future
Optimization Tips for Partners
- Collect Complete Data Upfront
- Gather ALL order data during quote preparation
- Validate email, address, and meter number before submission
- Reduces processing time from weeks to days
- Automate Offer Acceptance Tracking
- Use unique CTA links with order identifiers
- Trigger POST /orders automatically upon acceptance
- Minimize manual intervention
- Monitor State Transitions
- Set up alerts for
Deniedstates - Track time-in-state metrics
- Identify bottlenecks in your process
- Set up alerts for