Skip to main content
Skip table of contents

Energy Star - API Troubleshooting

Common Data Issues

If the web service API failed to get a valid Energy Star Score, check the followings:-

To Check


Is utility data available for the specified 12 months period?

ENERGY STAR(R)  Score is based on a 12 months' period so if there are data missing within the 12 months' period in any of the accounts, you may not be able to get a valid score.

Is Location address missing in Envizi?

The post code in the Location address is required when calculating the score as it determines the weather factors to be used in the score calculation.

Has Location's Region been set up correctly?

The 'Region' of the Location must be set up and be a valid region.

Do you have special character such as '&' in the Account name?

Special character such as '&' is not supported by the API and hence can cause the API to fail. Remove or replace the special character and then try again.

Is property use details missing in Envizi?

Property details such as floor area sq ft, % air conditioned area etc. should be kept up-to-date in Envizi in order to get a valid score.

Is property use details available or up-to-date for the selected rating end month?

Property details such as floor area sq ft, % air conditioned area etc. should be available for the selected month. The API does not use account accruals in stats, but relying on account records captured.

Have the mapping between Envizi's Locations/Accounts/Meters and PM's Properties/Meters been established in Envizi?

This is important especially when you have properties in PM and have granted Envizi's access to them. Envizi needs to update the data in PM in order to get a valid score.

Is Portfolio Manager website in maintenance mode?

Go to the Portfolio Manager website and check whether there is any system maintenance going on.

Is weather data available in PM?

Weather data in Portfolio Manager is typically updated on the 15th of each month for the month before. Requesting a score before the 15th of the month for the month before may result in an error.

Has Envizi been granted Full Data Access permission for all applicable meters in Portfolio Manager?

If Full Data Access rights are not granted for the property and applicable Meters in Portfolio Manager, it will result in failure of the API job. This includes both Energy and Water meters.

Are there any negative consumption values entered incorrectly in Water accounts in Envizi?

ESPM does not accept negative consumption values for Water accounts. Negative values in Water accounts will cause API request to fail.


Log in to your Portfolio Manager account and check the error there - in most cases it will tell you why the score was not calculated.

Special or non-English characters in Location Address

Some special or non-English characters in the Location Address may cause the API to fail to upload property details to ESPM. e.g. double spaces, UTF-16 format characters, or other format other than UTF-8. Remove or replace these with more commonly used English characters.

Envizi should have been granted ‘Full’ access to all Energy and Water meters of an ESPM location

If the API failed with a “Meter Property association has NOT been set-up properly!” error, it is likely due to a permission issue that Envizi does not have full access to all Energy (excluding IT UPS meters) and Water meters in ESPM.

It is a rule by ESPM that full access to all Energy and Water meters would be required for Envizi’s API to edit meters that contribute to metrics. Refer to the Energy Star permission FAQ article for more details.

If you can confirm the error is due to a ‘403 Access Denied’ code in the API Transaction Log, login to your Portfolio Manager account and grant Envizi full access to other Energy and Water meters for this location in ESPM. It is also important that once the you have granted Envizi full access, you would need to inform Envizi to accept the sharing of meters in ESPM under the ‘Notifications’ section before the error can be resolved.

Common Error Codes and Possible Root Causes

ESPM Returned Error Code and Message

Possible Root Causes

Please select your property's primary function (Error -200)

Property’s primary function is not sent to ESPM or ESPM is not able to determine the primary function of the property based on data supplied.

Envizi determines primary function of a property by looking at property use with the highest gross floor area number from all property use details accounts in the location.

Check if all property use details accounts have records that cover the API sync end period. For example, a data sync of 12 months ending Sep-2023 would require at least one property use details record covering the month of Sep-2023.

Energy Star API Transaction Logs

If none of the above is able to resolve the problem, you can further review the underlying original Energy Star API Transactions Logs for data transfer and data connectivity issues between Envizi and ENERGY STAR Portfolio Manager®. The page is accessible from the following menus:

  • On Location summage page → Benchmark → Energy Star API Transaction Logs, or

  • On Locations grid page → right click → Energy Star API Transaction Logs

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.