Get /api/v3/account/{accountId}/meter/{meterId}/calculatedBill/{versionId}/chargebackTask

Operation: GetCalculatedBillChargebackTaskByVersionV3

Summary

Get all chargeback tasks with details for a specific version on an account and meter

Path and Query Parameters

Parameter Description Type Location
accountId ID of the accountRequired integer Path
meterId ID of the meterRequired integer Path
versionId ID of the distribution versionRequired integer Path

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: ChargebackTaskVersionResponse [Array]

Parameter Description Type
array
   versionId The specific version id within the task we are reporting on integer
   numberOfBillsCreated The number of bills created for this version within the task integer
   errorMessage Error that may have occurred when running this version within the task string
   destinationBillIds The billids of all the destination bills created by this version within the task array
   sourceBillId If this was a bill split task, then ID of the bill that was split by this version within the task integer
   taskId Identifier for the task integer
   workflow ChargebackWorkflowStepChild
      chargebackWorkflowStepId Identifier for the chargeback workflow step integer
      chargebackWorkflowStepInfo Name given to the chargeback workflow step string
      chargebackWorkflowStepDescription Description for the chargeback workflow step string
      chargebackWorkflowStepType The chargeback type that can be assign to this chargeback workflow step. One of ‘Split’, ‘Calculation’ One of ‘Split’, ‘Calculation’ string
      chargebackWorkflowStepOrder The order for this step within the chargeback workflow integer
      chargebackWorkflow ChargebackWorkflowBase
         chargebackWorkflowId Identifier for the chargeback workflow integer
         chargebackWorkflowInfo Name given to the chargeback workflow string
   taskBegin Begin date when the task started string
   taskEnd End date when the task ended string
   user UserChild
      userId The user identifier integer
      userCode The user code string
      fullName The user’s full name string
   billingPeriod The billing period the task was run for integer
   batch BatchChild
      batchId The batch id. integer
      batchCode The batch code. string
   settings The task’s settings object
   comment User comments on the task string
   status Current status of the task string
   chargebackType The chargeback type. Either “Split” or “Calculation” string
   reversedBy UserChild
      userId The user identifier integer
      userCode The user code string
      fullName The user’s full name string
   reversedDate The date when all bills generated by the task were voided or deleted string
   numberOfAnalyzingBills The number of bills that are currently analyzing within the task integer
   numberOfUnresolvedFlags The number of unresolved flags on bills within the task integer

Responses

HTTP 200

Body

Content Type: application/json
[
  {
    "versionId": 1,
    "numberOfBillsCreated": 1,
    "errorMessage": "string",
    "destinationBillIds": [
      1
    ],
    "sourceBillId": 1,
    "taskId": 1,
    "workflow": {
      "chargebackWorkflowStepId": 1,
      "chargebackWorkflowStepInfo": "string",
      "chargebackWorkflowStepDescription": "string",
      "chargebackWorkflowStepType": "string",
      "chargebackWorkflowStepOrder": 1,
      "chargebackWorkflow": {
        "chargebackWorkflowId": 1,
        "chargebackWorkflowInfo": "string"
      }
    },
    "taskBegin": "2025-12-17",
    "taskEnd": "2025-12-17",
    "user": {
      "userId": 1,
      "userCode": "string",
      "fullName": "string"
    },
    "billingPeriod": 1,
    "batch": {
      "batchId": 1,
      "batchCode": "string"
    },
    "settings": {},
    "comment": "string",
    "status": "string",
    "chargebackType": "string",
    "reversedBy": {
      "userId": 1,
      "userCode": "string",
      "fullName": "string"
    },
    "reversedDate": "2025-12-17",
    "numberOfAnalyzingBills": 1,
    "numberOfUnresolvedFlags": 1
  }
]