Skip to content

Commit

Permalink
Merge pull request #337 from ConsumerDataStandardsAustralia/maintenan…
Browse files Browse the repository at this point in the history
…ce/587

Standards Maintenance Issue #587
  • Loading branch information
JamesMBligh authored Dec 20, 2023
2 parents 0e56710 + ea6b06f commit 930ead6
Show file tree
Hide file tree
Showing 8 changed files with 2,502 additions and 13 deletions.
21 changes: 21 additions & 0 deletions slate/source/includes/_energy_apis.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,25 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
<tr><td><a href='./includes/swagger/cds_energy.yaml'>Energy OpenAPI Specification (YAML)</a></td></tr>
</table>

```diff
Added following ENUM field to EnergyBillingDemandTransaction:
+ measureUnit

Updated the versions of the following APIs:
+ Get Billing For Account from v2 to v3
+ Get Billing For Specific Accounts from v2 to v3
+ Get Bulk Billing from v2 to v3

Updated the following structures
from:
- EnergyBillingListResponseV2
- EnergyBillingTransactionV2
- EnergyBillingDemandTransactionV2
to:
+ EnergyBillingListResponseV3
+ EnergyBillingTransactionV3
+ EnergyBillingDemandTransactionV3

```

<%= partial "includes/cds_energy.md" %>
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@
| Energy APIs | Get Bulk Invoices | ``/energy/accounts/invoices`` | <span class="method get">GET</span> | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A |
| Energy APIs | Get Invoices For Specific Accounts | ``/energy/accounts/invoices`` | <span class="method post">POST</span> | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A |
| Energy APIs | Get Billing For Account | ``/energy/accounts/{accountId}/billing`` | <span class="method get">GET</span> | V1 | 2022-11-15 | 2024-09-09 | 2021-10-29, V1.14.0| 2023-07-08, V1.25.0 |
| Energy APIs | Get Billing For Account | ``/energy/accounts/{accountId}/billing`` | <span class="method get">GET</span> | V2 | 2023-11-01 | N/A | 2023-07-08, V1.25.0| N/A |
| Energy APIs | Get Billing For Account | ``/energy/accounts/{accountId}/billing`` | <span class="method get">GET</span> | V2 | 2023-11-01 | N/A | 2023-07-08, V1.25.0| TBC, V1.29.0 |
| Energy APIs | Get Billing For Account | ``/energy/accounts/{accountId}/billing`` | <span class="method get">GET</span> | V3 | TBC | N/A | TBC, V1.29.0 | N/A |
| Energy APIs | Get Bulk Billing | ``/energy/accounts/billing`` | <span class="method get">GET</span> | V1 | 2022-11-15 | 2024-09-09 | 2021-10-29, V1.14.0| 2023-07-08, V1.25.0 |
| Energy APIs | Get Bulk Billing | ``/energy/accounts/billing`` | <span class="method get">GET</span> | V2 | 2023-11-01 | N/A | 2023-07-08, V1.25.0| N/A |
| Energy APIs | Get Bulk Billing | ``/energy/accounts/billing`` | <span class="method get">GET</span> | V3 | TBC | N/A | TBC, V1.29.0 | N/A |
| Energy APIs | Get Billing For Specific Accounts | ``/energy/accounts/billing`` | <span class="method post">POST</span> | V1 | 2022-11-15 | 2024-09-09 | 2021-10-29, V1.14.0| 2023-07-08, V1.25.0 |
| Energy APIs | Get Billing For Specific Accounts |``/energy/accounts/billing`` | <span class="method post">POST</span> | V2 | 2023-11-01 | N/A | 2023-07-08, V1.25.0| N/A |
| Energy APIs | Get Billing For Specific Accounts | ``/energy/accounts/billing`` | <span class="method post">POST</span> | V3 | TBC | N/A | TBC, V1.29.0 | N/A |


## Energy Shared Responsibility APIs
Expand Down
3 changes: 3 additions & 0 deletions slate/source/includes/introduction/_fdo.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ The table below highlights these areas of the standards.
|[Get Scheduled Payments For Specific Accounts V2](#get-scheduled-payments-for-specific-accounts)|<ul><li>Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024**</li><li>Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024**</li></ul> | March 11th 2024 |
|[Get Metrics V3](#get-metrics)|<ul><li>Data Holders **MAY** retire v3 of this endpoint by the earlier of **13th May 2024** or when the ACCC announce that this version is no longer being called</li><li>Data Holders going live on, or after, 1st November 2023 are not required to support this version</li></ul>| May 13th 2024 |
|[Get Metrics v5](#get-metrics)|<ul><li>Data Holders **MUST** implement v5 of this endpoint by **May 13th 2024**</li><li>Data Holders **MAY** deprecate v4 of this endpoint once v5 is implemented</li></ul>| May 13th 2024 |
|[Get Billing For Account](#get-billing-for-account)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Bulk Billing](#get-bulk-billing)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Billing For Specific Accounts](#get-billing-for-specific-accounts)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
Loading

0 comments on commit 930ead6

Please sign in to comment.