Below you can find explanations of breaking and otherwise notable changes in this release. For a complete list of changes please refer to 📖 CHANGELOG.md and 📚 openapi.yaml in the repository.
For the planned release timeline and a full list of changes (including GUI features) please refer to the 📄 Release Notes article in the ❓Help / FAQ of Empire.
🚨 Breaking Changes
Finance / Invoicing structure
Invoice line items are sorted into different invoice types: Standard invoice (SI), Sales Credit (SC), Self-Billing invoice (SB), and Netting Statement document (NS). The latter aggregates the values of each previous invoice documents.
The getFinanceInvoices endpoint now retrieves all the invoice document types resulting in changes in the response structure, e.g the concept of Invoice Groups has been introduced. Please study the response carefully to prepare for the changes.
Finance / Extended Overview information
The getParticipantDashboardFinanceOverview and getParticipantOverview endpoints are extended with the values of the unpaid invoices (including SI, SB, SC, and total values), and the Credit Utilization (including un-invoiced liability, un-invoiced compensation, pending bids price and credit utilization) resulting in changes in the response structure.
Finance / Settlement parameter changes
When querying the getFinanceSettlementPerDay or getFinanceSettlementPerSource endpoints the productTypes query parameter became optional which itself won't cause a breaking change.
On the other hand the optional timescale query parameter name has been changed to timescales (plural) to allow filtering for a list of Timescales (Long Term, Day Ahead, Intraday) instead of one, which is a potential breaking change.
Secondary Market / Participant ID parameter change in Return Requests
When querying Return Requests on the Secondary Market using the getSecondaryMarketReturnRequests operation, the X-Participant-Id parameter name has changed to X-Participant-Ids (plural) but Participants are still required to submit their own single Participant ID.
New Features
Auctions / Previous and next Auction ID
For usability purposes, to step between Intraday and Day Ahead auctions, the getDayAheadAuction, getPublicDayAheadAuction, getIntraDayAuction, getPublicIntraDayAuction endpoints retrieve the IDs of the previous and next Auctions on the same timescale in the previousAuctionId and nextAuctionId properties.
Besides the extra properties, the response structure has not been changed.
Auctions / Extended Allocated Auction filters with Bidding Period
The following endpoints have new filter parameters added for the Bidding Period: getAllocatedAuctions, getPublicAllocatedAuctions, getAggregatedAllocatedAuctions, and getPublicAggregatedAllocatedAuctions.
You can use the optional biddingPeriodStart and biddingPeriodEnd query parameters for filtering.
Finance / Download PDFs for an Invoice Group
Along with the change in the invoicing structure it became possible to download all documents (SI, SC, SB, NS) in a ZIP archive that belong to a specific Invoice Group using the new downloadAllFinanceInvoiceGroupPdfs endpoint which only requires the ID of the Invoice Group which can be queried using the getFinanceInvoices operation.
Buy-Now Offers / Fetch a single Buy-Now Offer
A new endpoint called getBuyNowOffer has been added to query the information for a single Buy-Now Offer by its ID.
New Reports
The following reports became available for the Participants:
| Name | Operation ID | Description |
|---|---|---|
| Auction Bids Report | getAuctionsBidsReport |
Lists all Bids for a Participant for a given timeframe in an Excel file |
| Download Invoice Documents | getFinanceInvoicePdfs |
Generates a ZIP file, including the invoice files generated within the selected period: Standard invoice (SI), Sales Credit (SC), Self-Billing invoice (SB), and Netting Statement document (NS) |