Company settings for unlocking data

Users can specify their default policy for what data is unlocked for all newly created customers in the Customer data section of settings in the dashboard.

• What historical data is fetched by default for new customers. Options are:
  • All (all historical data made available by the utility will be fetched)
  • A predefined time period measured in months. Example (1 month, 12 months, 24 months)
  • None (No historical data made available by the utility will be fetched)
• Continuous fetching of data for existing customers:
  • Enable: On an ongoing basis, all new customer data will be unlocked by default
    • This means as a customer receives a new utility bill and corresponding data, that data will be fetched and unlocked
  • Disable continuous data: No new customer data will be unlocked on an ongoing basis by default

Data provided for locked bills

For locked data, the below information will be provided:

• Unique identifier
  • Bill id
  • Bill external id
  • Customer id
  • Customer external id
• Utility
• Utility account number
• Time stamps:
  • Billed on
  • Billing period from
  • Billing period to

Here's an example locked bill object:

{
  "external_id": null,
  "id": 13991,
  "customer_id": 993,
  "customer_external_id": null,
  "billed_on": "2022-12-29",
  "utility": "seattle_city_light",
  "account_number": "43576123213218",
  "billing_period_from": "2022-10-27",
  "billing_period_to": "2022-12-29",
  "meters": [
    {
      "id": "221323123213",
      "type": "electric",
      "tariff": "Unspecified",
      "billing_period_to": "2022-12-29",
      "billing_period_from": "2022-10-27"
    }
  ]
}

Unlocking data from an individual bill object

At any time the default company settings for unlocked data can be over-ridden for an individual bill object by its unique identifier.

Via API

This API call outlines how to unlock an individual bill.

Via the Bayou dashboard (no code)

To unlock any given bill, the user can simply click the gray "Unlock this bill" button.