Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decision Proposal 116 - Billing Data Payloads #116

Closed
CDR-API-Stream opened this issue Apr 13, 2020 · 15 comments
Closed

Decision Proposal 116 - Billing Data Payloads #116

CDR-API-Stream opened this issue Apr 13, 2020 · 15 comments
Labels
Category: API A proposal for a decision to be made for the API Standards made Industry: Electricity This proposal impacts the electricity industry sector Status: No Decision Taken No determination for this decision has been made

Comments

@CDR-API-Stream
Copy link
Contributor

CDR-API-Stream commented Apr 13, 2020

The decision proposal for Energy Billing data payloads is attached below:
Decision Proposal 116 - Billing Data Payloads.pdf

Feedback is welcome on this proposal. This thread will remain open for feedback until the 9th of November.

As previously discussed in various forums, the practice of the DSB is to respond to feedback incrementally before the consultation is complete to promote an interactive style of consultation.
Participants are therefore encouraged to provide feedback earlier in the consultation process so that the community can work together to a consensus outcome.

@CDR-API-Stream CDR-API-Stream added Category: API A proposal for a decision to be made for the API Standards made Status: Proposal Pending A proposal for the decision is still pending Industry: Electricity This proposal impacts the electricity industry sector labels Apr 13, 2020
@CDR-API-Stream CDR-API-Stream added Status: Open For Feedback Feedback has been requested for the decision and removed Status: Proposal Pending A proposal for the decision is still pending labels Oct 19, 2020
@SArn-erg
Copy link

I note the usage lines do not have the facility for metering charges or daily connection charges. These are separate from the usage calculation.

@SArn-erg
Copy link

Time of Use type does not have an allowance for season. There are some seasonal TOU tariffs in Regional Queensland.

@SArn-erg
Copy link

Tariff 14 – Residential Demand
This is a ‘Demand tariff’, which is new type of tariff only available to customers with smart meters. Essentially, customers receive lower supply and usage charges, however a ‘demand charge’ is incurred in the peak summer months. A demand charge is a daily charge that reflects a customer’s peak time usage in a 30-minute period between 4pm and 8pm. For example, if you’re charged a 20c/kWh demand tariff, and you use a maximum of 3kWh of electricity in a 30 minute period, you will be charged 60c per day. This charge resets every month.

@SelenaLiuEA
Copy link

Hi All,

EA’s response below relates to mass market and small business customers. It is not yet clear whether large commercial and industrial customers will be in scope for the CDR and this will be determined by the ACCC in their CDR Rules. We will need to confirm large customer billing data payloads if this is looking likely.

We also note that the overall purpose of the billing data is unclear. Beyond total billed amount, the billing items are very complex and non-standardised (other than what is required by regulation). It will be highly unlikely that the billing items can be combined with usage data and tariff data, to produce reliable bill estimates. We question the utility of requiring the specific billing data. We note that this issue will be determined by the ACCC at a policy level but that the DSB’ work on billing data payloads will need to follow this direction. It's also unclear how the different retailer provided data sets will be used together.

Invoice Common Type

  1. How do the invoice common types relate to the billing transaction types? Is the former a high level description of the latter?
  2. invoiceNumber – Is this the same as a bill ID number i.e. unique number for a bill? Our bill numbers do not show on the bill, but our system can produce this number. However, other retailers may not be able to produce this and so I suggest this be changed to Optional.
  3. issueDate – the National Energy Retail Rules and Energy Retail Code specify regulated contents of a bill and that a bill must contain the “bill issue date”. We suggest that this should be the data that meets this Object Type and that this be clarified in the payload description. This is to cover situations where the bill generation and bill issue date may be different. Links to relevant regulations follow - Rule 25 is the main section for billing contents: https://www.esc.vic.gov.au/electricity-and-gas/codes-guidelines-and-policies/energy-retail-code and https://www.aemc.gov.au/regulation/energy-rules/national-energy-retail-rules/current
  4. period – Again, it would make sense that this means billing period as per the regulations. We also assume that the startDate and endDate correspond with this period
  5. amountDue for the invoice - This could be taken to mean the account balance as at the date the bill is issued (including that bill) with adjustments applied, or it could mean the amount for that single, current bill.
  • EA can produce both data points but this should be clarified.
  • Pay on time discounts also present a unique issue – as this affects the amount of the bill depending on whether the customer pays on time (during the short period it’s unknown whether the customer will pay on time). Our system calculates the bill amount that’s payable but then the pay on time discount amount is separately calculated and presented on the bill.
  • We would prefer that the current bill amount does not include the deduction for the pay on time discount (remembering that it would be uncertain whether the customer will actually pay on time).
  • Payment plans also present another issue, as a separate amount that the customer has to pay, which is likely to be different from the bill amount again. This is not necessarily an issue but I wanted to point this out so the DSB can clarify that payment plan amounts are not what the DSB is alluding to in their billing payload definitions.
  1. BalanceAtIssue – we take this to mean the account balance at the time of the bill, including the current bill amount and adjustments on the account. This could overlap with amountDue as discussed above, and can be resolved by changing the definition and making this clear.
  2. electricity is defined as charges and credits related to energy usage. We note that Daily Supply Charges are another typical and key category of charge that could be separated out, and to a lesser extent, Demand charges.
  3. totalAccountDiscounts – we point out that some discounts will not be whole of bill but only relate to discounts of usage charges. This seems like it can be reflected in this data object, but we just point out the complexities if this data were used to try to recreate or estimate what a bill should have been. Other variations of discounts to be aware of:
  • Ongoing vs one off discounts
  • Fixed rate (dollar amount) discounts vs percentage based discounts.
  1. All charges and credits should be optional as it is possible that an innovative product may not charge a Usage charges or Daily Supply Charge for instance, and may structure their prices in a completely different way.
  2. How will bill reversals be treated i.e. what is the bill for the purposes of billing data under the CDR?

Billing Transaction Common Type

  1. transactionUType – is defined as the Indicator of the type of transaction object: (1) usage (2) onceOff (3) payment. Our way of thinking about billing transactions is higher level and different:
  • Bill segment (billing item charges) which can include once off charges and regular charges (usage or daily supply charges for instance)
  • Adjustments which can be additions or deductions (credits) on an account. They can include charges for services though.
  • Payments which we assume are payments by the customer – but which won’t necessarily correspond to a bill. i.e. one Payment made by the customer may be paid over multiple bills or only pay part of a bill.
  1. Usage –
  • usage – definition reflects the period in kWh. This seems to be accumulated and will not reflect usage during different time of use periods which may be relevant for time of use pricing.
  1. timeOfUseType – This category likely needs further work to ensure that all different tariffs are reflected. We will come back on this next week.

  2. Tariff information (i.e. $ per kWh) doesn’t appear to have been included in these billing data payloads – which seems logical as it would better fit in tariff payloads, but this means it may not be apparent which tariffs apply to a particular bill. Even if historical tariff data was delivered under tailored tariff payloads, it would be difficult to reconcile which tariffs apply to each bill.

Cheers
Selena

@CDR-API-Stream
Copy link
Contributor Author

I note the usage lines do not have the facility for metering charges or daily connection charges. These are separate from the usage calculation.

These are expected to be included in the totalOnceOffCharges and totalOnceOffDiscounts fields in the invoice structure and in the onceOff object in the transaction structure.

@CDR-API-Stream
Copy link
Contributor Author

Time of Use type does not have an allowance for season. There are some seasonal TOU tariffs in Regional Queensland.

The structures in the billing proposal do not seek to contain tariff information, only the resulting charges. As these are time dependent it is assumed that seasonal pricing will be applied at the time of the charge or invoice being generated.

@CDR-API-Stream
Copy link
Contributor Author

Hi @SArn-erg, in response to this comment:

Tariff 14 – Residential Demand
This is a ‘Demand tariff’, which is new type of tariff only available to customers with smart meters. Essentially, customers receive lower supply and usage charges, however a ‘demand charge’ is incurred in the peak summer months. A demand charge is a daily charge that reflects a customer’s peak time usage in a 30-minute period between 4pm and 8pm. For example, if you’re charged a 20c/kWh demand tariff, and you use a maximum of 3kWh of electricity in a 30 minute period, you will be charged 60c per day. This charge resets every month.

Could you expand on the applicability of this to the payloads in the proposal? It isn't clear as to what part of the proposed standard this is a comment on or what the impact would be.

@CDR-API-Stream
Copy link
Contributor Author

In respons to @SelenaLiuEA:

Thanks for the comprehensive feedback. Detailed responses are below. The general notes around utility of billing data and the applicability to large corporate customers is more policy related so will be left to the ACCC rules consultation and potentially to Treasury. Any feedback on how you see the introduction of large commercial customers may potentially impact the standards would, however, be beneficial as it would test the future flexibility of the standard.

Invoice Common Type

  1. How do the invoice common types relate to the billing transaction types? Is the former a high level description of the latter?

Yes. That is the intent.

  1. invoiceNumber – Is this the same as a bill ID number i.e. unique number for a bill? Our bill numbers do not show on the bill, but our system can produce this number. However, other retailers may not be able to produce this and so I suggest this be changed to Optional.

Thank you for this feedback, it was intended that it was the bill ID assigned by the retailer and it was assumed that all invoices would have this. The need for optionality will be considered.

  1. issueDate – the National Energy Retail Rules and Energy Retail Code specify regulated contents of a bill and that a bill must contain the “bill issue date”. We suggest that this should be the data that meets this Object Type and that this be clarified in the payload description. This is to cover situations where the bill generation and bill issue date may be different. Links to relevant regulations follow - Rule 25 is the main section for billing contents: https://www.esc.vic.gov.au/electricity-and-gas/codes-guidelines-and-policies/energy-retail-code and https://www.aemc.gov.au/regulation/energy-rules/national-energy-retail-rules/current
  2. period – Again, it would make sense that this means billing period as per the regulations. We also assume that the startDate and endDate correspond with this period

Thank you. This is helpful feedback.

  1. amountDue for the invoice - This could be taken to mean the account balance as at the date the bill is issued (including that bill) with adjustments applied, or it could mean the amount for that single, current bill.
  • EA can produce both data points but this should be clarified.

It is intended to be the former. The amount due with current balance incorporated.

  • Pay on time discounts also present a unique issue – as this affects the amount of the bill depending on whether the customer pays on time (during the short period it’s unknown whether the customer will pay on time). Our system calculates the bill amount that’s payable but then the pay on time discount amount is separately calculated and presented on the bill.
  • We would prefer that the current bill amount does not include the deduction for the pay on time discount (remembering that it would be uncertain whether the customer will actually pay on time).
  • Payment plans also present another issue, as a separate amount that the customer has to pay, which is likely to be different from the bill amount again. This is not necessarily an issue but I wanted to point this out so the DSB can clarify that payment plan amounts are not what the DSB is alluding to in their billing payload definitions.

The intention of this payload is that the information included on the bill at issue is presented. If discounts for on time payment are not included in the amount due on the issued bill then it is reasonable to exclude it. This detail would be picked up under the transaction end points so is still shareable.

  1. BalanceAtIssue – we take this to mean the account balance at the time of the bill, including the current bill amount and adjustments on the account. This could overlap with amountDue as discussed above, and can be resolved by changing the definition and making this clear.

That is the intent. We can clarify the descriptions.

  1. electricity is defined as charges and credits related to energy usage. We note that Daily Supply Charges are another typical and key category of charge that could be separated out, and to a lesser extent, Demand charges.

This could be reasonably accommodated as account level once off charges or usage based once off charges. It would be at the discretion of the retailer as to how they categorise each charge.

  1. totalAccountDiscounts – we point out that some discounts will not be whole of bill but only relate to discounts of usage charges. This seems like it can be reflected in this data object, but we just point out the complexities if this data were used to try to recreate or estimate what a bill should have been. Other variations of discounts to be aware of:
  • Ongoing vs one off discounts
  • Fixed rate (dollar amount) discounts vs percentage based discounts.

Thanks you for this feedback. If there are any that cannot specifically be accommodated in the proposed structure please let us know as this may warrant changes to accommodate the specific variation.

  1. All charges and credits should be optional as it is possible that an innovative product may not charge a Usage charges or Daily Supply Charge for instance, and may structure their prices in a completely different way.

It is expected that, under the invoice structure, this would be accommodated by having a zero value against the appropriate field.

  1. How will bill reversals be treated i.e. what is the bill for the purposes of billing data under the CDR?

Bill reversals are a new topic so this may require some thought. The intent of the invoice APIs is to show the billing history for a customer (according to the requirements of the designation instrument). In this context a reversed bill could be handled in multiple ways:

  • We could include a flag indicating a bill was reversed
  • The reversed bill could be simply excluded as it is, presumably, no longer part of the history
  • We could accommodate the reversal, and new invoice information, in the same structure which would accommodate partial reversal
  • There could be another approach more reflective of the standard approach in the electricity sector

Which option would be most appropriate?

@CDR-API-Stream
Copy link
Contributor Author

In respons to @SelenaLiuEA:

Billing Transaction Common Type

  1. transactionUType – is defined as the Indicator of the type of transaction object: (1) usage (2) onceOff (3) payment. Our way of thinking about billing transactions is higher level and different:
  • Bill segment (billing item charges) which can include once off charges and regular charges (usage or daily supply charges for instance)
  • Adjustments which can be additions or deductions (credits) on an account. They can include charges for services though.

It is expected that each retailer would conceptualise their billing charges differently depending on their technical implementation and policies. The structure proposed is an attempt to create a generic structure that would accommodate many different variations. The proposed structures would appear to be able to accommodate the model you describe. Are there specific issues in the structure that would prevent your charge history from being represented correctly?

  • Payments which we assume are payments by the customer – but which won’t necessarily correspond to a bill. i.e. one Payment made by the customer may be paid over multiple bills or only pay part of a bill.

This is expected. The payment structure does not include a link to a specific invoice.

  1. Usage –
  • usage – definition reflects the period in kWh. This seems to be accumulated and will not reflect usage during different time of use periods which may be relevant for time of use pricing.

The intention is that different periods, where different TOU pricing would apply, would be separated into other charge records.

  1. timeOfUseType – This category likely needs further work to ensure that all different tariffs are reflected. We will come back on this next week.

That would be appreciated.

  1. Tariff information (i.e. $ per kWh) doesn’t appear to have been included in these billing data payloads – which seems logical as it would better fit in tariff payloads, but this means it may not be apparent which tariffs apply to a particular bill. Even if historical tariff data was delivered under tailored tariff payloads, it would be difficult to reconcile which tariffs apply to each bill.

As the tariffs are presented in a separate data cluster there has been no accommodation included to make the connection between pricing and charging. Should this link be included? If so, what would be the best way to achieve that without including the same data available in the account detail end point?

@Mark-Lee-Momentum-Energy

Hello,

Feedback from Momentum Energy:

Invoice Common Type

  • Doesn't accommodate for dual-fuel products: there is a section for electricity charges but not for gas charges. If the intention is to omit gas charge information, then the total of charges provided in the electricity section may not reconcile with the amountDue field. Suggest adding a section for gas charges, or alternatively an flag that indicates the invoice includes additional charges that are not for electricity supply.

  • totalAccountDiscounts: Recommend updating the description to indicate if pay-on-time discounts should be included or excluded here. Note that the discount might be valid when the invoice is generated but - depending on if the customer pays on time - may no longer be valid after the due date.

  • Payload does not include a field for 'invoice due date'.

  • amountDue: Suggest being careful with using 'due' here as is ambiguous. Perhaps replace with invoiceAmount or invoiceTotalAmount.

  • balanceAtIssue: Suggest indicating in the description if this should include or exclude the invoice amount.

  • electricity: totalUsageCharges: Assuming this includes energy consumption, demand, and metering/supply charges.

  • totalAccountCharges & totalAccountDiscounts: Unsure what charges are expected here - suggest providing clarity on what "account level" means. All our charges and discounts must be invoiced, and would be considered "invoice level", so expectation is that nothing would ever be populated in these two fields, which is clearly the wrong interpretation.

Billing Transaction Type

  • transactionUType: Assumption is that 'usage' would include all recurring charges related to the supply of electricity (and possibly gas for dual fuel invoice). e.g., metering charges, demand charges).

  • usage: timeOfUseType: This list doesn't account for seasonal times (e.g., Summer/Winter Peak/Off-Peak/Shoulder), and doesn't account for demand (e.g., Summer/Winter Peak/Off-Peak/Shoulder Demand, Contract/Actual Demand, etc).

  • usage: usage: Unsure how demand charges should be populated based on this proposed payload, assuming it should be included in the 'usage' section. If so, this field description states the uom is kWh. For demand, the uom is kVa.

  • isEstimate: Is there a reason this is Optional and not Mandatory?

@ghost
Copy link

ghost commented Nov 5, 2020

Hello,

Feedback from AGL Energy on behalf of AGL Energy CDR technical working group

AGL concours with the feedback provide by Energy Australia above and would like to additional raise the following. At AGL, a bill is issued at an account level that holds one or many arrangements. These arrangements can be electricity and non-electricity products/services that may not always be associated with a NMI (or MIRN in the gas use case).

Subsequently the broader intent of the designation instrument to support item “3(c) information used to calculate a bill” may not be achievable through this technical proposal due to the following:

  • An AGL customer can have many accounts that can have many arrangements.
  • Data clusters focus on electricity and associates service point ids reflecting only a subset of the billed items.
  • Ability to support for account level charges such as payment late fees or other charges that are not related to electricity services.

Invoice Common Type

  • We need more clarification or examples on how retailers can represent historical adjustments into an invoice.
  • Given we have accounts where both electricity and non-electricity services are items in the same invoice; what's the expected behavior of properties like amountDue, totalAccountCharges, totalAccountDiscounts which sets outside of electricity object? should these represent only electricity ? or energy i.e. electricity and gas or any product regardless of its industry? noting that its quite hard to change these properties to only represent electricity if that's the intention.
  • balanceAtIssue: A typo in description The account balance at the time the account was issued, we think its meant to be: The account balance at the time the invoice was issued
  • isPaid: With AGL providing budget planning features and payment plans to customers, we are thinking that a basic isPaid = false, might not be enough for ADRs to present relevant value to customers.
  • servicePoints: Given this is a mandatory array of strings, we are assuming this can be an empty array. i.e. an invoice issued for an account where all charges are not related to any service point. Please confirm.

Billing Transaction Common Type

  • onceOff: We think that servicePointId property should not be mandatory, assuming this should be used to describe something like late payment fees that is at the account level.
  • timeOfUseType: We recommend this enum to have "Other" value to support retailer custom types if it exists in future.

@SelenaLiuEA
Copy link

Hi again,

Re Tariff information, our feedback is the data object structure seems suitable for most customers today. But it would need to evolve for new tariff types as they are introduced e.g. the direction the AER and others are going with the introduction of Demand charging for Residential customers. Nor does it appear to support multiple dedicated circuits appropriately (unless that’s why there are three shoulder figures – but it’s hard to see how they’d be used consistently).

Cheers
Selena

@CDR-API-Stream
Copy link
Contributor Author

A request for an extension to this consultation has been received so the consultation will be extended to close of business, Monday 9th November

@PratibhaOrigin
Copy link

Feedback from Origin Energy on DP-116

Invoice Common Type

  1. Service Order charges - Where will the service order charges like metering works , connection, disconnection fees etc. need to be incorporated ? Are these part of ‘totalOnceOffCharges’ ?
  2. Supply Charges - Where will the supply charges need to be incorporated ? Are these part of ‘totalOnceOffCharges’ too ?
  3. isPaid - Origin concurs with AGL's feedback on this field. With the scenarios like payment plan and hardship payment arrangements , a true or false value here might not give the correct value to ADRs and customers. ‘ispaid’ is more of a payment related parameter than billing payload related.
  4. Bill Reversals - How do we want to treat bill reversals/amended invoice scenarios ? The amended bills often refer the previous reversed invoice for amended charges etc. A guidance from DSB on the treatment of these scenarios would be appreciated.
  5. servicePoints - We do issue non-energy invoice at times which may be not specific to a site/NMI and are applicable at account/customer level. Considering this is defined as mandatory array of strings , is it supposed to be left blank for the above mentioned scenario or can it be updated as optional ?
  6. Issuedate - Origin concurs with EA’s feedback on this field to consider the National Energy Retail Rules and Energy Retail Code in defining this field.
  7. Multiple service invoice - If an invoice is related to multiple services like dual fuel scenarios, is there a DSB suggested way to handle the charges related to each service in the payload ? The payload mentions only electricity charges which may not reconcile with overall invoice amount in such cases if the charges related to other services are not taken into account.

Billing Transaction Common Type

  1. Timeofuse - With this field, there are other possible values of demand, solar etc. Is it possible to include to ‘Other’ as a one of the values to handle any other value which is not in the defined list of values ?
  2. Multi meter scenarios - A guidance on the following fields in multi-meter scenarios from DSB is requested -
  • For a site with multiple meters, there is a possibility of different values for each meter corresponding to the ‘Timeofuse’ field. How do we intend to use it for multi meter scenarios corresponding to one NMI/servicepointID?
  • Similarly, its possible in multi-meter scenario to have Actual read for one meter and estimated for other meter. How do we intend to incorporate that in this field being at NMI level ?
  1. ServicepointID - A billing transaction can be for once off charges/settlement/credit. Request DSB to consider the same along with below pointers -
  • A transaction can be applied across multiple NMIs . Do we need to consider an array rather than a single string servicepointID here ?
  • Also, a billing transaction may not be applied to any specific site/NMI/servicepointID and rather at account/customer level, for example few once off charges. So, considering those scenarios this field should not be mandatory.

Generic Comment

Overall the payload seems more tailored to mass market bundled charges. Has the unbundled charging model of the large commercial and industrial customers been considered for these payloads or will it be submitted for consultation at a later stage after the confirmation of ACCC rule regarding inclusion of the large customers ?

Cheers!
Prats

@ConsumerDataStandardsAustralia ConsumerDataStandardsAustralia locked and limited conversation to collaborators Nov 10, 2020
@CDR-API-Stream CDR-API-Stream added Status: Feedback Period Closed The feedback period is complete and a final decision is being formulated and removed Status: Open For Feedback Feedback has been requested for the decision labels Nov 10, 2020
@ConsumerDataStandardsAustralia ConsumerDataStandardsAustralia unlocked this conversation Nov 12, 2020
@SelenaLiuEA
Copy link

Hi All, please see further feedback from EA below:

EA’s responses:

5.	amountDue for the invoice - This could be taken to mean the account balance as at the date the bill is issued (including that bill) with adjustments applied, or it could mean the amount for that single, current bill.
•	EA can produce both data points but this should be clarified.
It is intended to be the former. The amount due with current balance incorporated.
•	Pay on time discounts also present a unique issue – as this affects the amount of the bill depending on whether the customer pays on time (during the short period it’s unknown whether the customer will pay on time). Our system calculates the bill amount that’s payable but then the pay on time discount amount is separately calculated and presented on the bill.
•	We would prefer that the current bill amount does not include the deduction for the pay on time discount (remembering that it would be uncertain whether the customer will actually pay on time).
•	Payment plans also present another issue, as a separate amount that the customer has to pay, which is likely to be different from the bill amount again. This is not necessarily an issue but I wanted to point this out so the DSB can clarify that payment plan amounts are not what the DSB is alluding to in their billing payload definitions.
The intention of this payload is that the information included on the bill at issue is presented. If discounts for on time payment are not included in the amount due on the issued bill then it is reasonable to exclude it. This detail would be picked up under the transaction end points so is still shareable.

EA can provide both amountDue including pay on time discount and without it (the first would take more data work to provide it though). Our bill presents both. It is important to note that different retailers may take different approaches re including and not including pay on time discounts in their amount due, and so we recommend that this be clarified in the standards.

2.	electricity is defined as charges and credits related to energy usage. We note that Daily Supply Charges are another typical and key category of charge that could be separated out, and to a lesser extent, Demand charges.
This could be reasonably accommodated as account level once off charges or usage based once off charges. It would be at the discretion of the retailer as to how they categorise each charge.

Just a general question - why are the billing charges and tariffs in Tailored Data payloads so different? The latter specifies the different fees and charges in a lot more detail. It may matter if ADRs try to use tailored tariff data (if historical tailored tariffs are in scope) to analyse bills.

3.	totalAccountDiscounts – we point out that some discounts will not be whole of bill but only relate to discounts of usage charges. This seems like it can be reflected in this data object, but we just point out the complexities if this data were used to try to recreate or estimate what a bill should have been. Other variations of discounts to be aware of:
•	Ongoing vs one off discounts
•	Fixed rate (dollar amount) discounts vs percentage based discounts.
Thanks you for this feedback. If there are any that cannot specifically be accommodated in the proposed structure please let us know as this may warrant changes to accommodate the specific variation. 

Fine if this is just a dollar amount.

1.	All charges and credits should be optional as it is possible that an innovative product may not charge a Usage charges or Daily Supply Charge for instance, and may structure their prices in a completely different way.
It is expected that, under the invoice structure, this would be accommodated by having a zero value against the appropriate field.

It is fine for a zero value to be returned for the data fields that the data will not “fit”, but the data will still have to be returned and it may not be clear which field applies. For example, a subscription type plan – may involve just one aggregated charge for a month. This may not technically fall under a usage charge, as it might cover both usage, supply, and other charges, for example. The standards should clarify what should happen in this scenario and for other non-conventional tariff structures. This is also an issue for tailored tariff data.

2.	How will bill reversals be treated i.e. what is the bill for the purposes of billing data under the CDR?
Bill reversals are a new topic so this may require some thought. The intent of the invoice APIs is to show the billing history for a customer (according to the requirements of the designation instrument). In this context a reversed bill could be handled in multiple ways:
•	We could include a flag indicating a bill was reversed
•	The reversed bill could be simply excluded as it is, presumably, no longer part of the history
•	We could accommodate the reversal, and new invoice information, in the same structure which would accommodate partial reversal
•	There could be another approach more reflective of the standard approach in the electricity sector
Which option would be most appropriate? 

We would suggest exclude showing them; having a flag could be even more confusing.

In respons to @SelenaLiuEA:
Billing Transaction Common Type
1.	transactionUType – is defined as the Indicator of the type of transaction object: (1) usage (2) onceOff (3) payment. Our way of thinking about billing transactions is higher level and different:
•	Bill segment (billing item charges) which can include once off charges and regular charges (usage or daily supply charges for instance)
•	Adjustments which can be additions or deductions (credits) on an account. They can include charges for services though.
It is expected that each retailer would conceptualise their billing charges differently depending on their technical implementation and policies. The structure proposed is an attempt to create a generic structure that would accommodate many different variations. The proposed structures would appear to be able to accommodate the model you describe. Are there specific issues in the structure that would prevent your charge history from being represented correctly?

The proposed categories might have gaps (1) usage (2) onceOff (3) payment – e.g. what about non-usage charges that are not once off charges?

2.	Tariff information (i.e. $ per kWh) doesn’t appear to have been included in these billing data payloads – which seems logical as it would better fit in tariff payloads, but this means it may not be apparent which tariffs apply to a particular bill. Even if historical tariff data was delivered under tailored tariff payloads, it would be difficult to reconcile which tariffs apply to each bill.
As the tariffs are presented in a separate data cluster there has been no accommodation included to make the connection between pricing and charging. Should this link be included? If so, what would be the best way to achieve that without including the same data available in the account detail end point?

This only matters if ADRs wish to use tailored tariff data to analyse bills for example. One theoretical use case is a bill check for an issued bill – which we don’t think is likely anyway. It could also possibly be used for a bill estimate – if previous bills and the tariffs that applied to that bill are used to formulate a bill estimate. I think this is a policy issue which needs to be tested further.

Cheers
Selena

@CDR-API-Stream CDR-API-Stream added Status: No Decision Taken No determination for this decision has been made and removed Status: Feedback Period Closed The feedback period is complete and a final decision is being formulated labels Aug 29, 2021
JamesMBligh pushed a commit that referenced this issue Feb 4, 2022
JamesMBligh added a commit that referenced this issue Feb 4, 2022
CDR-API-Stream added a commit that referenced this issue Feb 4, 2022
* Standards Staging Issue #115: Update text description of bulk balance for energy in endpoint version schedule

* Cleared out the diff comments presented on the Version Delta tab

* Added an empty release 1.16.0 release notes page

* Incremented version numbers for swagger files to 1.16.0

* Added archive link to 1.15.0

* Reverted back to standard (non-festive) logo

* Incremented version number in introduction

* Added normative reference link to RFC9126

* Added link to 1.16.0 release notes

* Corrected link for RFC2119

* Clarified requirements for Data Recipient Software Products S256 code challenge method by removing the redundant \'if supported\' text

* Standards Staging Issue #116 Change type of page and page-size in Energy APIs to PositiveInteger

* Updates for DP166

* Updates for DP166

* Removed duplicate section: Data Holders calling Data Recipients

* Corrected GetProducts response reference from ResponseBankingProductList to ResponseBankingProductListV2

* Removed the unintended additional formatting from the cds_banking.json to make diffs easier

* Corrected Register Discovery Document definition defect renaming request_object_signing_alg_values_supported to token_endpoint_auth_signing_alg_values_supported

* Corrected GetDataHolderBrands RegisterDataHolderAuth and jwksEndpoint schema definitions to clarify their usage in DH to ADR client authentication

* Standards Staging Issue #115: Updated release notes for this change

* fixed typos and ordering

* Removed tables

* Rechanged ordering

* Build and final checks

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Co-authored-by: Kirkycdr <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: James Bligh <[email protected]>
CDR-API-Stream added a commit that referenced this issue Mar 22, 2022
* Standards Staging Issue #115: Update text description of bulk balance for energy in endpoint version schedule

* Cleared out the diff comments presented on the Version Delta tab

* Added an empty release 1.16.0 release notes page

* Incremented version numbers for swagger files to 1.16.0

* Added archive link to 1.15.0

* Reverted back to standard (non-festive) logo

* Incremented version number in introduction

* Added normative reference link to RFC9126

* Added link to 1.16.0 release notes

* Corrected link for RFC2119

* Clarified requirements for Data Recipient Software Products S256 code challenge method by removing the redundant \'if supported\' text

* Standards Staging Issue #116 Change type of page and page-size in Energy APIs to PositiveInteger

* Updates for DP166

* Updates for DP166

* Removed duplicate section: Data Holders calling Data Recipients

* Corrected GetProducts response reference from ResponseBankingProductList to ResponseBankingProductListV2

* Removed the unintended additional formatting from the cds_banking.json to make diffs easier

* Corrected Register Discovery Document definition defect renaming request_object_signing_alg_values_supported to token_endpoint_auth_signing_alg_values_supported

* Corrected GetDataHolderBrands RegisterDataHolderAuth and jwksEndpoint schema definitions to clarify their usage in DH to ADR client authentication

* Standards Staging Issue #115: Updated release notes for this change

* fixed typos and ordering

* Removed tables

* Rechanged ordering

* Build and final checks

* Convert swagger to OAS
Remove 4xx error codes

* Rebuild

* Fix json typos
Update error codes for energy OAS

* Rebuild

* Added tooltip support for RFCs and normative/informative references. Also fixed invalid or missing RFC links

* Fixed markdown issue with normative references table

* Converted more normative reference links to dynamic tooltips

* Updated FAPI informative reference

* - Formatting improvements. - Added additional tooltip references

* - Moved normative references out of the Security section into the Introduction. - Added additional tooltip references

* Updated code generation for normative and informative references

* Added link to the endpoint versioning schedule to the high level standards

* Added 1.16.1 release notes

* Added release notes for Standards Staging issue 130

* Added release notes for Standards Staging issue 132

* Updated RFC4122 links in Banking and Common schemas to include tooltips

* poc secondary-dataholder-apis: Added changes to include Energy Secondary Data Holder OAS in standards

* Fix for staging 139

* fix #138

* Fix for #137

* Fix #136

* Fix #135

* Fix #134

* Initial build for review

* Update version number everywhere

* Add archive entry for 1.16.0
Clean up diff statements
Update release notes

* Fixes to SR swagger

* Update Swagger to OAS in markdown

* Updated Energy SDH swagger file to lastest version with fixes applied for error codes and attribute types

* Remove known issues that are resolved
Full rebuild

* Version bumps to address GitHub security notices

* Updated additional informative references to include tooltips

* Fix SDH security

* Fix for controlledLoad flag in energy
Rebuild

* Minor release notes and diff fixes

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Co-authored-by: Kirkycdr <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: Mark Verstege <[email protected]>
CDR-API-Stream added a commit that referenced this issue May 23, 2022
* Standards Staging Issue #115: Update text description of bulk balance for energy in endpoint version schedule

* Cleared out the diff comments presented on the Version Delta tab

* Added an empty release 1.16.0 release notes page

* Incremented version numbers for swagger files to 1.16.0

* Added archive link to 1.15.0

* Reverted back to standard (non-festive) logo

* Incremented version number in introduction

* Added normative reference link to RFC9126

* Added link to 1.16.0 release notes

* Corrected link for RFC2119

* Clarified requirements for Data Recipient Software Products S256 code challenge method by removing the redundant \'if supported\' text

* Standards Staging Issue #116 Change type of page and page-size in Energy APIs to PositiveInteger

* Updates for DP166

* Updates for DP166

* Removed duplicate section: Data Holders calling Data Recipients

* Corrected GetProducts response reference from ResponseBankingProductList to ResponseBankingProductListV2

* Removed the unintended additional formatting from the cds_banking.json to make diffs easier

* Corrected Register Discovery Document definition defect renaming request_object_signing_alg_values_supported to token_endpoint_auth_signing_alg_values_supported

* Corrected GetDataHolderBrands RegisterDataHolderAuth and jwksEndpoint schema definitions to clarify their usage in DH to ADR client authentication

* Standards Staging Issue #115: Updated release notes for this change

* fixed typos and ordering

* Removed tables

* Rechanged ordering

* Build and final checks

* Convert swagger to OAS
Remove 4xx error codes

* Rebuild

* Fix json typos
Update error codes for energy OAS

* Rebuild

* Added tooltip support for RFCs and normative/informative references. Also fixed invalid or missing RFC links

* Fixed markdown issue with normative references table

* Converted more normative reference links to dynamic tooltips

* Updated FAPI informative reference

* - Formatting improvements. - Added additional tooltip references

* - Moved normative references out of the Security section into the Introduction. - Added additional tooltip references

* Updated code generation for normative and informative references

* Added link to the endpoint versioning schedule to the high level standards

* Added 1.16.1 release notes

* Added release notes for Standards Staging issue 130

* Added release notes for Standards Staging issue 132

* Updated RFC4122 links in Banking and Common schemas to include tooltips

* poc secondary-dataholder-apis: Added changes to include Energy Secondary Data Holder OAS in standards

* Fix for staging 139

* fix #138

* Fix for #137

* Fix #136

* Fix #135

* Fix #134

* Initial build for review

* Update version number everywhere

* Add archive entry for 1.16.0
Clean up diff statements
Update release notes

* Fixes to SR swagger

* Update Swagger to OAS in markdown

* Updated Energy SDH swagger file to lastest version with fixes applied for error codes and attribute types

* Remove known issues that are resolved
Full rebuild

* Version bumps to address GitHub security notices

* Updated additional informative references to include tooltips

* Fix SDH security

* Fix for controlledLoad flag in energy
Rebuild

* Minor release notes and diff fixes

* Standards Release 1.17.0: Added release notes file

* Standards Maintenance Issue #448: Changed percentOfBill, percentOfUse, fixedAmount and percentOverThreshold attributes from optional to conditional within EnergyPlanDiscounts schema

* Standards Release 1.17.0: Removed version deltas, incremented version numbers in swagger files, added archieve entry for 1.16.1

* Updates to baseline 1.17.0 to remove legacy diffs and include a link to the release notes

* Standards Maintenance Issue 503: Fixed documentation for CDR Arrangement Form Parameter and JWT method requirements

* Added scrollabe diffs and examples to support previous and next scrolling

* Added release notes

* Updated prev/next button titles

* Minor refactoring to remove unused vars

* Standards Maintenance Issue 504: Corrected the profile scope data language to clarify request of individual claims

* Added diff

* Standards Maintenance Issue #449: Made EnergyPlanSolarFeedInTariff.timeVaryingTariffs.timeVariations.days field mandatory

* Added proof of concept to highlight obligations in the endpoint versioning schedule based on a selected mileston date

* Added release notes

* Removed diff comments

* Fix for padding of last input field in datepicker

* Added collapsible obligations that hide any future, retired, and inactive obligations

* Tweaks to collapsed highlighting

* Updated release notes to include standards maintenance issue number

* Corrected release description

* Updated CDR Arrangement Recovation JWT documentation to articulate requirements in accordance to self signed JWTs

* Added a new section to summarise all change requests in the release notes

* Added headings

* Added obligation milestones

* Improvement to wording of profile scope data language based on commmunity feedback

* Updated diff

* corrected non-normative examples using the unsupported HS256 alg. Changed examples to PS256 to align with FAPI requirements

* Added 482 descriptions to the release notes

* Updated release notes

* Update dcr OAS so it compiles

* Standards Maintenance Issue #457: Made EnergyServicePointDetail.meters.registers.registerSuffix field optional

* Updated release notes to contain links to the associated change request

* Updated Register swagger to addres empty content fields causing compilation issues

* header requirements for versioned Register APIs moved from mandatory to optional

* Standards Maintenance Issue #438: Added calculationFactors and adjustments objects to EnergyBillingOtherTransaction model

* Added version delta comments

* Rebuild
Fix minor typos in diffs

* Removed debugging output for date picker

* Standards Maintenance Issue #439: Added timezone field to EnergyPlanTariffPeriod

* Fixed compile issues for date picker scripts

* Added Register dependency schedule table to differentiate Register delivery from Participant future dated obligations

* Added requirement for data holders to ignore unsupported authorisation scopes

* Updated endpoint version schedule to 2022-11-15 for register API versions where binding date was subject to ACCC review

* Standards Maintenance Issue #476: Updated EnergyConcession model to cater for variable concessions. Changed RateString to represent generic percentages.

* Standards Maintenance Issue #476: Moved RateString change description to High Level Standards in Release Notes. Move RateString diff in High Level Standards

* Moved change description to API Endpoints sections in Release Notes

* Set retirement dates for outstanding deprecated Register APIs

* Added standards maintenance issue reference to release notes

* Added standards maintenance issue reference to release notes

* New authenticated endpoints only require cdr-register:read as the authorisation scope

* Added clarification that when statuses are not received or recognised from the CDR Register, the ACCC can inform Data Holders of statuses to trust using an alternative mechanism

* Added GetDataHolderBrandsSummary API to expose public details of Data Holder Brands from the CDR Register to public clients

* Standards Maintenance Issue #478: Made EnergyServicePointDetail.meters and EnergyServicePointDetail.meters.registers fields optional and updated their descriptions

* Documented scopes usage for the authenticated Register endpoint versions

* Changed formatting of dependency dates to remove leading zero

* XV header is a required field

* Made SHOULD requirement bold

* Added version-deltas for register scope usage

* Standards Staging Issue #133: Corrected description of 'oldest-date' by removing the word 'days'

* Standards Staging Issue #170: Documentation fix - EnergyServicePointDetail.meters and EnergyServicePointDetail.meters.registers have been converted into arrays

* Standards Maintenance Issue #439: Updated description of EnergyPlanContract.timezone and EnergyPlanTariffPeriod.timezone to specify default values

* Standards Staging Issue #131: Minor edit- clarification added that ServicePointId to be replaced with NMI in path param as well

* Corrected version delta presentation

* Added Get Data Holder Brands Summary to the endpoints table

* Corrected whitespacing in version deltas

* Standards Staging Issue #153: Modified Energy location to be a CommonPhysicalAddress model

* Added support for 404 response code

* Full rebuild

* Add release date
Reorder release notes

* Standards Staging Issue #167: Corrected x-fapi-interaction-id header to be mandatory for Energy SDH APIs

* Fix to force version delta code blocks to break at word boundaries not at overflow

* 404 now only applies when industry is not found

* Cosmetic improvements in the release notes

* Cleaned up version deltas to follow conventions

* Removed reference to the ACCC delivery schedule

* Full rebuild

* Correct change for staging issue 170

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Co-authored-by: Kirkycdr <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: James Bligh <[email protected]>
Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Ivan Hosgood <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: API A proposal for a decision to be made for the API Standards made Industry: Electricity This proposal impacts the electricity industry sector Status: No Decision Taken No determination for this decision has been made
Projects
None yet
Development

No branches or pull requests

5 participants