Entity Attributes Data File

The Entity Attributes Data file lists the attributes and their respective values. The table below defines the elements that must be included in the columns of the file.

Field

Description

entity_id

Entity identifier. The entity ID should be established following the rules and requirements in the Legacy Billing Data File Specifications.

Type: VARCHAR

Can Be Empty?: No.

entity_type

The core entity type for the key.

Supported Values:

  • CUSTOMER

    Attribute key associated with CUSTOMER.

  • UTILITY_ACCT

    Attribute key associated with UTILITY_ACCT.

  • SERVICE_POINT

    Attribute key associated with SERVICE_POINT.

  • PERSON

    Attribute key associated with PERSON.

  • ACCOUNT

    Attribute key associated with ACCOUNT.

  • SERVICE_AGREEMENT

    Attribute key associated with SERVICE_AGREEMENT.

Type: VARCHAR

Can Be Empty?: No.

Default: Not applicable.

key

Key identifying the attribute. See Example Entity Attributes Data File for common use cases, such as for solar customers and low-income customers.

Type: VARCHAR

Can Be Empty?: No.

Default: Not applicable.

value

Value for the attribute. See Example Entity Attributes Data File for common use cases. 

If you are not using enumerated values, then use one of the reserved keywords to define the type of value. See RESERVED Keywords in Definition File for details.

Enumerated values are any fixed sets of known values. For example, for the attribute key LANGUAGE, known enumerated values could be ENGLISH, FRENCH.

Type: VARCHAR

Can Be Empty?: No.

start_datetime

The effective start date and time of the specified attribute value. This field may be left NULL if the value is effective from the beginning of time. 

The start datetime value is inclusive (for example, from 2019-02-27T00:00:00-America/New_York, and onwards).

See Date and Time Handling for more guidance.

Type: DATETIME (YYYY-MM-DD<T>hh:mm:ss-<timezone>)

Can Be Empty?: Yes.

end_datetime

The date and time on which the specified attribute value is no longer effective. This datetime value is not part of the period covered by the attribute key. This field may be left NULL if the value is effective indefinitely. 

The end datetime value is exclusive (for example, until 2024-04-13T00:00:00-America/New_York, excluding that instant).

See Date and Time Handling for more guidance.

Type: DATETIME (YYYY-MM-DD<T>hh:mm:ss-<timezone>)

Can Be Empty?: Yes.

source

Source of the key. For example, this should be UTILITY if the utility is sending the data.

Type: VARCHAR.

Can Be Empty?: No.

Default: Not applicable.

Back to Top