Billing Accounts

This is the object representing a utility billing account.


Attribute Format Description Example
uid UID String Unique identifier of the Billing Account. These uids may appear as integers, but they are not guaranteed to stay that way, so you should treat them as strings. "12345b"
authorization_uid UID String The UID of the Authorization this Billing Account belongs to "abc123"
meter_uids List(UID String) A list of the UIDs of the meters that belong to this Billing Account [ "12345a", "12345b", "33701f" ]
statement_dates List(ISO8601) Timestamps of the statement dates of the Bills the Billing Account data was pulled from. ["2016-01-05T12:35:24.653422+00:00"]
blocks List(BillingAccountBlockType) A list of the blocks available for this Billing Account. [ "base", "sources" ]
{block_type} BillingAccountBlock The contents of a Billing Account Block listed in the blocks list. { "billing_contact": "Nobody", ... }
// Billing account with base and sources blocks
{
    "uid": "20113",
    "authorization_uid": "221389",
    "meter_uids": [
        "112311",
        "112312",
        "112313",
        "112314"
    ],
    "statement_dates": [
        "2018-05-01T04:00:00.000000+00:00",
        "2018-04-01T04:00:00.000000+00:00",
        "2018-03-01T04:00:00.000000+00:00",
        "2018-02-01T04:00:00.000000+00:00",
        "2018-01-01T04:00:00.000000+00:00",
    ],
    "blocks": [
        "base",
        "sources"
    ],
    "base": {
        "billing_contact": "General Services Corporation",
        "billing_address": "123 Fake St, Anytown, NJ, 07001",
        "billing_account": "194500235561"
    },
    "sources": [
        {
            "type": "pdf",
            "raw_url": "https://utilityapi.com/api/v2/files/here_is_a_file.pdf"
        }
    ]
}