Bill Notes

You will see these Bill notes in the Bill['notes'] list.

We do our best to automatically check the values we find on utility bills but sometimes the structure of a particular bill makes this impossible. In these situations, we add a note to the bill to make it clear that the math is a little strange so that you can double-check the source document to make sure the data is correct.

Attribute Format Description Example
type Note Type The type of note. See list below for list of types. "audit_failed_on_tiers"
msg String A human readable description of the note. It may be tweaked often, so don't rely on it always staying the same for a given type. "The tiers items for this bill do not add up to the total usage."
ts ISO8601 The timestamp of the note. "2018-04-24T12:34:56.102359+00:00"
// Example line items audit failure note
{
    "type": "audit_failed_on_line_items",
    "msg": "The line items on this bill do not add up to the bill total.",
    "ts": "2017-01-21T12:32:42.102367+00:00",
}
// Example tier audit failure note
{
    "type": "audit_failed_on_tiers",
    "msg": "The usage tiers on this bill do not add up to the total usage.",
    "ts": "2018-03-01T17:04:21.502339+00:00",
}
Type Description Additional Attributes
audit_failed_on_line_items This bill's line items don't add up to the total dollar amount on the bill.
audit_failed_on_tiers The usage tiers on this bill does not make sense (e.g. may not add up to the total usage).
audit_failed_on_tou The Time of Use data on this bill does not make sense (e.g. may not add up to the total usage).
audit_failed_on_demand The demand value on this bill does not make sense.
supplier_said_mismatch The suppliers block for this bill indicates a different SAID but we're farily sure that it's for the correct serivce.
unknown_tariff This bill has a tariff we don't recognize.
... We may add other types in the future, so be able to handle unknown types gracefully.