Standards Maintenance Issue #530: Added general note to Get Invoices …

…for Account API clarifying issueDate will be used as effective date for filtering/ordering
ConsumerDataStandardsAustralia · Nov 2, 2022 · 57c6043 · 57c6043
1 parent 4966f91
commit 57c6043
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb
@@ -12,5 +12,7 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
 
 ```diff
 Aligned description of response headers to be consistent with Banking APIs.
+
+Added general note to Get Invoices for Account API clarifying `issueDate` will be used as effective date for filtering/ordering
 ```
 <%= partial "includes/cds_energy.md" %>
diff --git a/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.20.0.html.md
@@ -48,6 +48,7 @@ This release addresses the following Decision Proposals published on [Standards]
 
 |Change|Description|Link|
 |------|-----------|----|
+| Clarified effective date for Energy Invoices API | Added note in the description of Get Invoice for Account energy API clarifying `issueDate` will be used as effective date for filtering/ordering. Addresses [Issue 530 comment](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/530#issuecomment-1219499185) | [Energy APIs](../../#energy-apis). |
 | Fixed Energy Respose Headers | Included descriptions for response headers in the Energy APIs to be consistent with the presentation of the Banking APIs. Addresses [Issue 530 comment](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/530#issuecomment-1238967968) | [Participant Endpoints](../../#energy-apis). |
 
 

diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
@@ -6337,7 +6337,7 @@
 			"get": {
 				"summary": "Get Invoices For Account",
 				"operationId": "getInvoicesForAccount",
-				"description": "Obtain the invoices for a specific account",
+				"description": "Obtain the invoices for a specific account. \n\nSome general notes that apply to all end points that retrieve invoices:\n\n- For the purpose of filtering and ordering it is expected that the data holder will use the `issuedate` as the \"effective\" date",
                 "x-scopes": [
                     "energy:billing:read"
                 ],