Date Fields
| Type | Example | API Timezone | Dashboard Timezone | Recommendation for your UI implementation |
|---|---|---|---|---|
Date | statementDate | UTC | Not converted to the user's local timezone. | Display as-is without any timezone offsets |
DateTime | createdAt | UTC | Converted to the Dashboard user's local timezone (based on the timezone of the browser). | Convert to local timezone of the UI user. |
Field Size Limits
Unless otherwise noted, the maximum field size for any String fields is 255 characters.
Address Fields
The Plug API normalizes all addresses that are pulled from the utility provider website. This process is part of parsing addresses into their subcomponents (city, state, etc.). Address normalization enables several features of the Plug platform including site-to-meter mapping recommendations and more consistent meter reconciliation over time. Some of the mappings that are performed during normalization are:
Street name abbreviations
123 Main Street would be normalized to 123 MAIN ST.
Street direction abbreviations
123 Peachtree St Northeast would be normalized to 123 PEACHTREE ST NE
Countries and states are abbreviated when specified
123 Main Street, Atlanta, Georgia, United States would be normalized to 123 MAIN ST, ATLANTA GA, USA