Put /api/v3/unit/rollup

Operation: UpdateUseRollupUnitsV3 Permissions: ApplicationSettings (Manage)

Summary

Update common and global use units

Request Body Parameters

Content-Type: application/json

Type Reference: RollupUnitUpdate

Parameter Description Type
commonRollups List of commodities and their rollup units to update Required (defined) RollupUnitUpdateCommonUnit [Array]
   commodityId The commodity identifier Required (defined) integer
   commonRollupUnitId The unit identifier that this commodity will roll up to Required (defined) integer
globalRollupUnitId The global rollup unit. Automatically assigned to ENERGY commodity. Pass in null to leave alone. Required (defined) integer

Request Body

{
  "commonRollups": [
    {
      "commodityId": 1,
      "commonRollupUnitId": 1
    }
  ],
  "globalRollupUnitId": 1
}

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: TaskResponse

Parameter Description Type
hasAttachments Deprecated property - HasAttachments always returns true boolean
taskId integer
taskGUId The task guid string
taskType TaskType
   taskTypeId The task type identifier integer
   taskTypeCode The code for task type string
   taskTypeInfo The task type information string
beginDate The date and time the task began string
endDate The date and time the task finished. If the task is not finished, endDate will have no value string
user UserChild
   userId The user identifier integer
   userCode The user code string
   fullName The user’s full name string
message The task’s message string
output The task’s output. For certain task types, this field could be sizable object
settings The task’s settings object
status The task’s status string
taskNote User provided note/comment for this Task string
analyzingCount Count of bills that are in the analyzing state, used by bill import tasks only integer
unresolvedFlagCount The count of bills with unresolved flags on this task, used by bill import tasks only integer
currentSuccessCount The count of successful bills that still exist (i.e. have not been deleted), used by bill import tasks only integer
batch BatchChild
   batchId The batch id. integer
   batchCode The batch code. string

Responses

HTTP 200

Body

Content Type: application/json
{
  "hasAttachments": false,
  "taskId": 1,
  "taskGUId": "string",
  "taskType": {
    "taskTypeId": 1,
    "taskTypeCode": "string",
    "taskTypeInfo": "string"
  },
  "beginDate": "2025-03-20",
  "endDate": "2025-03-20",
  "user": {
    "userId": 1,
    "userCode": "string",
    "fullName": "string"
  },
  "message": "string",
  "output": {},
  "settings": {},
  "status": "string",
  "taskNote": "string",
  "analyzingCount": 1,
  "unresolvedFlagCount": 1,
  "currentSuccessCount": 1,
  "batch": {
    "batchId": 1,
    "batchCode": "string"
  }
}