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

Operation: GetCostCenterActualYearlyV3 Permissions: CostCenters (View) Paginated

ℹ️ NOTE
This API is paginated. Note that the initial response may not represent all available records.
Please see the paging tutorial for more information.

Summary

Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up.

Path and Query Parameters

Parameter Description Type Location
costCenterId The costCenter to retrieve data forRequired integer Path
numberOfYears Number of years of data to return includes the current year - Defaults to 4 integer Query
pageSize The number of elements to return in a page integer Query
pageNumber The current page number integer Query

Response Parameters

HTTP 200

Header Parameters

Header Description Type
PageNumber The current page number integer
TotalPages The total number of pages available given the current page size integer
PageSize The current page size integer
TotalNumberOfRecords The total number of records available integer


Body Parameters

Content Type: application/json

Type Reference: CostCenterDigestActualYearlyResponse

Parameter Description Type
costCenterCode The costCenter code string
costCenterInfo The costCenter info string
costCenterId The costCenter identifier integer
globalUseUnit UnitChild
   unitId The unit identifier integer
   unitCode The unit code string
   unitInfo The unit info string
costUnit UnitChild
   unitId The unit identifier integer
   unitCode The unit code string
   unitInfo The unit info string
updated The date and time the data was updated string
results An array of yearly data CostCenterDigestActualYearlyResponseResults [Array]
   year Year string
   totalCost Total Cost number
   globalUse Global Use number
   globalUseUnitCost Global Use Unit Cost number
commodities An array of yearly data per commodity CostCenterDigestActualYearlyResponseCommodityData [Array]
   commodityCode The commodity code string
   commodityInfo The commodity info string
   commodityId The commodity identifier integer
   commonUseUnit UnitChild
      unitId The unit identifier integer
      unitCode The unit code string
      unitInfo The unit info string
   costUnit UnitChild
      unitId The unit identifier integer
      unitCode The unit code string
      unitInfo The unit info string
   results An array of yearly data CostCenterDigestActualYearlyResponseCommodityResults [Array]
      year year string
      totalCost Total Cost number
      commonUse Common Use number
      commonUseUnitCost Common Use Unit Cost number
      globalUse Global Use number
      globalUseUnitCost Global Use Unit Cost number

Response Parameters

HTTP 204


Body Parameters

Content Type: application/json

Responses

HTTP 200

Header

{
  "PageNumber": 1,
  "TotalPages": 1,
  "PageSize": 1,
  "TotalNumberOfRecords": 1
}

Body

Content Type: application/json
{
  "costCenterCode": "string",
  "costCenterInfo": "string",
  "costCenterId": 1,
  "globalUseUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "costUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "updated": "2025-12-19",
  "results": [
    {
      "year": "string",
      "totalCost": 1.0,
      "globalUse": 1.0,
      "globalUseUnitCost": 1.0
    }
  ],
  "commodities": [
    {
      "commodityCode": "string",
      "commodityInfo": "string",
      "commodityId": 1,
      "commonUseUnit": {
        "unitId": 1,
        "unitCode": "string",
        "unitInfo": "string"
      },
      "costUnit": {
        "unitId": 1,
        "unitCode": "string",
        "unitInfo": "string"
      },
      "results": [
        {
          "year": "string",
          "totalCost": 1.0,
          "commonUse": 1.0,
          "commonUseUnitCost": 1.0,
          "globalUse": 1.0,
          "globalUseUnitCost": 1.0
        }
      ]
    }
  ]
}

HTTP 204