Skip to content

Commit

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

Standards Maintenance Issue #592
  • Loading branch information
@JamesMBligh
JamesMBligh authored Jul 6, 2023
2 parents 1584518 + aadfbec commit 1038ba8
Show file tree
Hide file tree
Showing 8 changed files with 2,451 additions and 21 deletions.
28 changes: 27 additions & 1 deletion slate/source/includes/_energy_apis.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,32 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.

```diff
Updated description of `EnergyPaymentSchedule.isTokenised` field to further clarify when it can be used

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

Updated the following structures
from:
- EnergyBillingListResponse
- EnergyBillingTransaction
- EnergyBillingDemandTransaction
- EnergyBillingUsageTransaction

to:
+ EnergyBillingListResponseV2
+ EnergyBillingTransactionV2
+ EnergyBillingDemandTransactionV2
+ EnergyBillingUsageTransactionV2


Added following ENUM values to EnergyBillingDemandTransaction.timeOfUseType field:
+ ALL_DAY
+ EXCESS

Added following ENUM values to EnergyBillingUsageTransaction.timeOfUseType field:
+ ALL_DAY
```

<%= partial "includes/cds_energy.md" %>
<%= partial "includes/cds_energy.md" %>
11 changes: 7 additions & 4 deletions slate/source/includes/endpoint-version-schedule/includes/_energy-dh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,13 @@
| Energy APIs | Get Balances For Specific Energy Accounts | ``/energy/accounts/balances`` | <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 Account | ``/energy/accounts/{accountId}/invoices`` | <span class="method get">GET</span> | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A |
| 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 | N/A | 2021-10-29, V1.14.0| N/A |
| Energy APIs | Get Bulk Billing | ``/energy/accounts/billing`` | <span class="method get">GET</span> | V1 | 2022-11-15 | N/A | 2021-10-29, V1.14.0| N/A |
| Energy APIs | Get Billing For Specific Accounts | ``/energy/accounts/billing`` | <span class="method post">POST</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| TBC, 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 | TBC, V1.25.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| TBC, V1.25.0 |
| Energy APIs | Get Bulk Billing | ``/energy/accounts/billing`` | <span class="method get">GET</span> | V2 | 2023-11-01 | N/A | TBC, V1.25.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| TBC, 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 | TBC, V1.25.0| N/A |


## Energy Shared Responsibility APIs
Expand Down
3 changes: 3 additions & 0 deletions slate/source/includes/introduction/_fdo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@ The table below highlights these areas of the standards.
|[Private Key JWT Client Authentication](#https://consumerdatastandardsaustralia.github.io/standards/?examples#client-authentication) | Change to support [**[RFC7521]**](#nref-RFC7521) such that, until November 13th 2023, clients authenticating using Private Key JWT are _recommended_ to provide the `client_id`, but no longer required. From November 13th 2023, it is then _optional_ to provide the `client_id`. This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter. | November 13th 2023 |
|[Get Accounts V1](#get-account-detail)|Data Holders **MAY** decommission v1 of this end point from March 11th 2024| March 11th 2024 |
|[Get Account Detail V2](#get-account-detail)|Data Holders **MAY** decommission v2 of this end point from March 11th 2024| March 11th 2024 |
|[Get Billing For Account V2](#get-billing-for-account)|<ul><li>Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**</li><li>Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**</li></ul>| November 1st 2023 |
|[Get Bulk Billing V2](#get-bulk-billing)|<ul><li>Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**</li><li>Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**</li></ul>| November 1st 2023 |
|[Get Billing For Specific Accounts V2](#get-billing-for-specific-accounts)|<ul><li>Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**</li><li>Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**</li></ul>| November 1st 2023 |
Loading

0 comments on commit 1038ba8

Please sign in to comment.