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

Operation: GetCostCenterActualMonthlyV3 Permissions: CostCenters (View)

Summary

Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly 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 24 months integer Query

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: CostCenterDigestActualMonthlyResponse

Parameter Description Type
costCenterCode The costCenter code string
costCenterInfo The costCenter info string
costCenterId The costCenter identifier integer
updated The date and time the data was updated string
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
commodities An array of monthly data per commodity CostCenterDigestActualMonthlyResponseCommodityData [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 commodity monthly data CostCenterDigestActualMonthlyResponseCommodityResults [Array]
      periodName Calendar Period Name string
      calendarPeriod Calendar Period integer
      calendarYear Calendar Year integer
      fiscalPeriod Fiscal Period integer
      fiscalYear Fiscal Year integer
      totalCost Total Cost number
      commonUse Common Use number
      commonUseUnitCost Common Use Unit Cost number
      globalUse Global Use number
      globalUseUnitCost Global Use Unit Cost number
results An array of monthly data CostCenterDigestActualMonthlyResponseResults [Array]
   periodName Calendar Period Name string
   calendarPeriod Calendar Period integer
   calendarYear Calendar Year integer
   fiscalPeriod Fiscal Period integer
   fiscalYear Fiscal Year integer
   totalCost Total 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

Body

Content Type: application/json
{
  "costCenterCode": "string",
  "costCenterInfo": "string",
  "costCenterId": 1,
  "updated": "2025-03-20",
  "globalUseUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "costUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "commodities": [
    {
      "commodityCode": "string",
      "commodityInfo": "string",
      "commodityId": 1,
      "commonUseUnit": {
        "unitId": 1,
        "unitCode": "string",
        "unitInfo": "string"
      },
      "costUnit": {
        "unitId": 1,
        "unitCode": "string",
        "unitInfo": "string"
      },
      "results": [
        {
          "periodName": "string",
          "calendarPeriod": 1,
          "calendarYear": 1,
          "fiscalPeriod": 1,
          "fiscalYear": 1,
          "totalCost": 1.0,
          "commonUse": 1.0,
          "commonUseUnitCost": 1.0,
          "globalUse": 1.0,
          "globalUseUnitCost": 1.0
        }
      ]
    }
  ],
  "results": [
    {
      "periodName": "string",
      "calendarPeriod": 1,
      "calendarYear": 1,
      "fiscalPeriod": 1,
      "fiscalYear": 1,
      "totalCost": 1.0,
      "globalUse": 1.0,
      "globalUseUnitCost": 1.0
    }
  ]
}

HTTP 204