Orders
Orders: Test Accounts
- New guide documenting the hardcoded test accounts in the test environment. Each account is pinned to a single order/contract state, so you can exercise every stage of the lifecycle — including denial, revocation, cancellation and the
Unspecifiededge case — without creating real orders.
Orders
Orders: Mandatory, Optional, Conditional Fields
- Requirement levels now distinguish fields required to create an order from fields required to complete the supplier change process. Orders missing a change process field are still created, but supply cannot start until it is provided. Rabot’s customer service team will collect the missing information from the customer directly and update the contracts accordingly.
- Clarified:
order.deliveryState.startDateandendDateare the delivery start and end dates, not the change process dates. - Corrected: the
denialReasonvalueOtheris returned asUnknown, meaning the market partner has not yet given a reason. It may update within 3 days; contact Integration Management if it is stillUnknownafter that. - Documented the three delivery states for
order.state: Cancelled:CancelledPendingDelivery,CancelledDeliveryandCancelled. - Added the
Unspecified↔Unknownstate mapping, for when the market partner returns no state or one that cannot be interpreted. - Added
denialReasonvaluesDunningandDuplicate. A change indenialReasoncounts as an update forfilter.fromUpdatedAt, even when the state staysDenied. - New
cancellationReasonreference. Handle unrecognised values gracefully.
Orders
- Contracts for dynamic tariffs created via the create order endpoint now receive fixed pre-payment conditions on the contract draft at creation.
- The fixed pre-payment amount is calculated by Rabot and applied automatically. It is designed to match the customer’s expectation at signing and avoid negative surprises on the first or annual bill.
- No changes to the request body are required.
OrdersPricing & Tariffs
- Introduced new optional
bdewCodefield in the Request Body of the calculate offer price and create order endpoints.- Allows the distribution system operator (DSO) to be specified by its BDEW code, ensuring accurate grid fee pricing where a postcode is served by more than one DSO.
Day-Ahead
- Improved error handling for the day-ahead working price endpoint. Requests missing the
fromortoquery parameters now return a descriptive client error instead of an HTTP/500.
Customers & Contracts
- Fixed an issue where requests to the list documents endpoint filtered by
documentType=ContractConfirmationreturned an HTTP/500. Contract confirmations are now returned as expected.
Day-Ahead
- Fixed an issue where the
dataAvailableAtfield in the day-ahead working price response returned an incorrect value.
Orders
- The
previousYearConsumptionfield returned by the get order and list orders endpoints now returnsnullwhen no previous year consumption value has been provided by the grid operator.- Previously, this field was populated with the estimated consumption provided at order submission when no grid operator value was available.
Day-Ahead
- Added day-ahead working price endpoint. This allows you to retrieve the 15-Minute interval working price for a contract, including a full breakdown of energy price, procurement costs, grid fees, and levies and taxes.
- Available for dynamic tariff contracts only.
- Day-ahead prices are available from 4pm on the preceding day. If requested before then, the
messagefield indicates that today’s prices are being returned instead.
OrdersDocs
- API Documentation review and updates to reflect recent deployments and include optimization feedback from users completed.
- New guides added:
- Orders: Mandatory, Optional, Conditional Fields
- Offer Order Contract Lifecycle
- Expanded guide:
- Order Status & Change Process Detailed
Orders
- Introduced new
salesPersonIdfield to thecontractobject within the Request Body in the create order call to enhance analytics capabilities for API integrated sales affiliates. - The transmitted value is returned as
salesPersonIdentifierin the get order and list orders responses.
Orders
- Introduced new
legalStructurefield to thecontractobject within the Request Body in the create order call to enhance insolvency check capabilities of business tariffs. - Mandatory field for the transmission of
contract.type: Business.
Pricing & Tariffs
- Enhanced Pricing Details available from the calculate offer price endpoint to provide sufficient information for §41a EnWG pre-contractual information regulations related to the sale of energy tariffs.
- Added breakdowns for base price and work price components.
- Base price details: grid fee and metering fee (monthly).
- Work price details: service fee, risk premium fee, average exchange price, green certificate surcharge, power fee, grid fee, power heat coupling fee, concession fee, offshore fee, P19 fee, and effective work price adjustment.
Orders
- Introduced new
industryfield to thecontractobject within the Request Body in the create order call. - Mandatory field for the transmission of
contract.type: Business(B2B energy contracts).
Docs
- API Documentation review and updates to reflect recent deployments and include optimization feedback from users completed.
Customers & ContractsPricing & Tariffs
- Deployment of new computation logic for
WorkingPricevalues to reflect switchover to 15-Minute interval billing. Values returned when calling the contract metrics endpoint now accurately provide 15-Minute values of Spot Price + Contract Costs.
Customers & Contracts
- Introduced new
valueStatefield to the Records DTO returned in the contract metrics endpoint to externalise the state of values returned in the response, specificallyConsumptionvalues, to avoid potential breaking changes on integration.
Orders
- Introduced new functionality to the create order endpoint, whereby when
passwordis null, the email provided in the order is enrolled in a password set flow to optimize customer onboarding experience via Self-Build funnels and Affiliate integrations.
Orders
- The Orders DTO under the list orders endpoint now returns extended
deliveryStateinformation to externalise more detailed change process status information.
Orders
- The list orders endpoint now has additional filtering functionalities.
filter.fromUpdatedAt-> Enables querying orders that have a change process status update since their creationfilter.partnershipType-> Enables querying orders based on the partnership type, e.g. Whitelabel
Customers & Contracts
- The Contract DTO under the list contracts endpoint now returns §14a Module information. See endpoint here.
Day-Ahead
- The Day-Ahead market prices endpoint was updated to externalise 15-Minute interval Day-Ahead prices.
- Additionally, a granularity parameter was added to allow hourly prices to be queried also.
OrdersCustomers & Contracts
- The create order endpoint now allows for an
offerDateto be transmitted, ensuring accurate tariff pricing for thecontractDraftgeneration. See orders guide. - Updated documentation in contract metrics guide with information about availability of forecasted data.
Customers & Contracts
- Added
authAsparameter to create customer link call. - Extended customer linking guide accordingly.
Customers & ContractsDocs
- Improved documentation on customer linking.
- Improved documentation on contract information.
OrdersDocs
- Improved documentation on order states.
Customers & Contracts
- Added contract cost endpoint. This allows you to retrieve details about the different cost components for a contract at the time period of the call.
OrdersCustomers & Contracts
- The list orders endpoint now allows to filter by customer number to only retrieve orders for a particular customer.
- The list customers endpoint now allows to filter by external id.
- List endpoints now provide a
hasMoreItemsflag in the response to indicate if more items are available beyond the end of the list. See pagination for more info. - Improved error handling for the contract metrics endpoint. Now returns an empty response if no data is available, and a HTTP/404 status code if an invalid customer number or contract number is used.