Initial data availability

After a customer connects their utility account, Bayou fetches all utility bill data available. After all fetched bills are available, the bills_ready webhook is sent. Individual bills will be sent in the new_bill or new_unparsed_bill webhooks.

For convenience within the webhook body, all bill data is categorized:

bills_parsed: All parsed bills available
bills_unparsed: Bills that were fetched but haven't yet been parsed by Bayou.
available_data: Provides a hierarchical summary of the account numbers, meters and corresponding time periods from which bill data is available for the customer. Each meter also shows its type of service (electric or gas).

{
  "event": "bills_ready",
  "object": {
    "id": 12345,
    "external_id": "MSCOTT123",
    "bills_parsed": [
			{
        "external_id": "BILL_123",
        "id": 12345,
        "status": "unlocked",
        "customer_id": 12345,
        "customer_external_id": "MSCOTT123",
        "billed_on": "2022-08-01",
        "past_due": false,
        "outstanding_balance": 1200,
        "billing_period_from": "2022-07-01",
        "billing_period_to": "2022-07-31",
        "utility": "con_edison",
        "account_number": 123456,
        "electricity_consumption": 900,
        "electricity_amount": 9060,
        "delivery_charge": 5060,
        "supply_charge": 4000,
        "community_solar_bill_credit": -6440,
        "gas_consumption": 90,
        "gas_consumption_unit": "therms",
        "gas_amount": 2940,
        "total_amount": 12000,
        "meters": [
          {
            "id": "XYZ12345",
            "type": "gas",
            "billing_period_from": "2022-07-01",
            "billing_period_to": "2022-07-31",
            "consumption": 12345,
            "tariff": "123 Residential"
          }
        ],
        "file_url": "https://private.bayou.energy/bills/12345.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XYZ&X-Amz-Date=20220701T000000Z&X-Amz-Expires=1800&X-Amz-Signature=ABCEF0123456&X-Amz-SignedHeaders=host"
      }
    ],
    "bills_unparsed": [
      {
        "id": 12346
      }
    ],
    "available_data": {
      "account_numbers": [
        {
          "id": "MSCOTT123",
          "meters": [
            {
              "id": "XYZ12345",
              "type": "gas",
              "periods": [
                {
                  "period_from": "2022-07-01",
                  "period_to": "2022-07-31"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Bill data updates

After initial connection, Bayou will provide webhooks for any newly discovered bills in the new_bill or new_unparsed_bill webhooks. Any updates to existing bills will be sent via the updated_bill webhook.