GET /api/v3/costCenter/digest/actual/monthly

Retrieves a paginated list of monthly billing digest data across all accessible cost centers

GetCostCenterActualMonthlyListV3 Permissions: CostCenters (View)
Use this endpoint to display a dashboard or grid of cost center billing summaries by month. Each cost center’s response includes total cost, usage, and unit cost per month, plus a commodity-level breakdown. Covers the most recent N years of monthly data. Results are scoped to the user’s topmost node and support pagination. Returns null/204 if no billing data exists. For a single cost center’s monthly digest, use GET /costCenter/{costCenterId}/digest/actual/monthly. For yearly granularity, use GET /costCenter/digest/actual/yearly.
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.

Query Parameters

Name Description Type Required
numberOfYears Number of years of monthly data to return, including the current year. Defaults to 2 (24 months) 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

Array of:

CostCenterDigestActualMonthlyResponse
Property Description Type
commodities An array of monthly data per commodity CostCenterDigestActualMonthlyResponse+CommodityData[]
CostCenterDigestActualMonthlyResponse+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 commodity monthly data CostCenterDigestActualMonthlyResponse+CommodityResults[]
CostCenterDigestActualMonthlyResponse+CommodityResults properties
Property Description Type
calendarPeriod Calendar Period integer (int32)
calendarYear Calendar Year integer (int32)
commonUse Common Use number (double)
commonUseUnitCost Common Use Unit Cost number (double)
fiscalPeriod Fiscal Period integer (int32)
fiscalYear Fiscal Year integer (int32)
globalUse Global Use number (double)
globalUseUnitCost Global Use Unit Cost number (double)
periodName Calendar Period Name string
totalCost Total Cost number (double)
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 monthly data CostCenterDigestActualMonthlyResponse+Results[]
CostCenterDigestActualMonthlyResponse+Results properties
Property Description Type
calendarPeriod Calendar Period integer (int32)
calendarYear Calendar Year integer (int32)
fiscalPeriod Fiscal Period integer (int32)
fiscalYear Fiscal Year integer (int32)
globalUse Global Use number (double)
globalUseUnitCost Global Use Unit Cost number (double)
periodName Calendar Period Name string
totalCost Total Cost number (double)
updated The date and time the data was updated string (date-time)
Example Response application/json 
[
  {    "commodities": [
      {      "commodityCode": "string",      "commodityId": 1,      "commodityInfo": "string",      "commonUseUnit": {},      "costUnit": {},      "results": []
    }
    ],    "costCenterCode": "string",    "costCenterId": 1,    "costCenterInfo": "string",    "costUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "globalUseUnit": {      "unitCode": "string",      "unitId": 1,      "unitInfo": "string"
    },    "results": [
      {      "calendarPeriod": 1,      "calendarYear": 1,      "fiscalPeriod": 1,      "fiscalYear": 1,      "globalUse": 1.0,      "globalUseUnitCost": 1.0,      "periodName": "string",      "totalCost": 1.0
    }
    ],    "updated": "2026-06-29"
  }
]
204 No Content The request succeeded. No content is returned in the response body.