GET /api/v3/costCenter/{costCenterId}/digest/actual/yearly

Retrieves yearly billing digest data for a single cost center

GetCostCenterActualYearlyV3 Permissions: CostCenters (View)
Use this endpoint to display a yearly billing summary for a specific cost center. Returns total cost, usage, and unit cost per year, plus a commodity-level breakdown rolling up all accounts under this cost center. Results are ordered by year ascending. Returns null/204 if no billing data exists. For the paginated multi-cost-center version, use GET /costCenter/digest/actual/yearly. For monthly granularity for this cost center, use GET /costCenter/{costCenterId}/digest/actual/monthly.
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

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
costCenterId The unique numeric identifier of the cost center 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
pageSize The number of elements to return in a page integer (int32) Optional
pageNumber The current page number integer (int32) Optional

Response Headers

This endpoint returns pagination metadata in the response headers.

Header Type Description
PageNumber integer The current page number (1-based).
PageSize integer The maximum number of items per page.
TotalNumberOfRecords integer The total number of records matching the query across all pages.
TotalPages integer The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

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

Response Body Parameters

CostCenterDigestActualYearlyResponse
Property Description Type
commodities An array of yearly data per commodity CostCenterDigestActualYearlyResponse+CommodityData[]
CostCenterDigestActualYearlyResponse+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 CostCenterDigestActualYearlyResponse+CommodityResults[]
CostCenterDigestActualYearlyResponse+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
costCenterCode The costCenter code string
costCenterId The costCenter identifier integer (int32)
costCenterInfo The costCenter 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
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 CostCenterDigestActualYearlyResponse+Results[]
CostCenterDigestActualYearlyResponse+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 
{  "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"
    }
    ]
  }
  ],  "costCenterCode": "string",  "costCenterId": 1,  "costCenterInfo": "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.