GET /api/v3/account/{accountId}/digest/actual/yearly

Retrieves yearly billing digest data for a single account

GetAccountActualYearlyV3 Permissions: Accounts (View)
Use this endpoint to display a yearly billing summary for a specific account. Returns total cost, usage, and unit cost per year, plus a commodity-level breakdown. Results are ordered by year ascending. Returns null/204 if no billing data exists. For the paginated multi-account version, use GET /account/digest/actual/yearly. For monthly granularity for this account, use GET /account/{accountId}/digest/actual/monthly.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
accountId The unique numeric identifier of the account to retrieve digest data for integer (int32) Required

Query Parameters

Name Description Type Required
numberOfYears Number of years of data to return, including the current year. Defaults to 4 if not specified. integer (int32) Optional

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

AccountDigestActualYearlyResponse
Property Description Type
accountCode The account code string
accountId The account identifier integer (int32)
accountInfo The account info string
commodities An array of yearly data per commodity AccountDigestActualYearlyResponse+CommodityData[]
AccountDigestActualYearlyResponse+CommodityData properties
Property Description Type
commodityCode The commodity code string
commodityId The commodity identifier integer (int32)
commodityInfo The commodity info string
commonUseUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
costUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
results An array of yearly data AccountDigestActualYearlyResponse+CommodityResults[]
AccountDigestActualYearlyResponse+CommodityResults properties
Property Description Type
commonUse Common Use number (double)
commonUseUnitCost Common Use Unit Cost number (double)
globalUse Global Use number (double)
globalUseUnitCost Global Use Unit Cost number (double)
totalCost Total Cost number (double)
year year string
costUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
globalUseUnit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
results An array of yearly data AccountDigestActualYearlyResponse+Results[]
AccountDigestActualYearlyResponse+Results properties
Property Description Type
globalUse Global Use number (double)
globalUseUnitCost Global Use Unit Cost number (double)
totalCost Total Cost number (double)
year Year string
updated The date and time the data was updated string (date-time)
Example Response application/json 
{  "accountCode": "string",  "accountId": 1,  "accountInfo": "string",  "commodities": [
    {    "commodityCode": "string",    "commodityId": 1,    "commodityInfo": "string",    "commonUseUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "costUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "results": [
      {      "commonUse": 1.0,      "commonUseUnitCost": 1.0,      "globalUse": 1.0,      "globalUseUnitCost": 1.0,      "totalCost": 1.0,      "year": "string"
    }
    ]
  }
  ],  "costUnit": {    "unitCode": "string",    "unitId": 1,    "unitInfo": "string"
  },  "globalUseUnit": {    "unitCode": "string",    "unitId": 1,    "unitInfo": "string"
  },  "results": [
    {    "globalUse": 1.0,    "globalUseUnitCost": 1.0,    "totalCost": 1.0,    "year": "string"
  }
  ],  "updated": "2026-06-29"
}
204 No Content The request succeeded. No content is returned in the response body.