Operation: GetCalculatedBillsV3
Get a list of calculated bill versions on a meter
| Parameter | Description | Type | Location |
|---|---|---|---|
| meterId | ID of the meter to get all assigned calculated bill versionsRequired | integer | Path |
Type Reference: DistributionVersionResponse [Array]
| Parameter | Description | Type |
|---|---|---|
| array | ||
| versionId | Identifier for the version | integer |
| versionInfo | Name given to a version | string |
| chargebackType | The chargeback type. Either “Split” or “Calculation” | string |
| beginPeriod | Begin period for the version | integer |
| endPeriod | End period for the version null value means continuing indefinitely |
integer |
| account | AccountChildWithType | |
| accountType | AccountTypeChild | |
| accountTypeId | The account type identifier | integer |
| accountTypeCode | The account type code | string |
| accountTypeInfo | The account type info | string |
| accountId | integer | |
| accountCode | string | |
| accountInfo | string | |
| vendor | VendorChild | |
| vendorId | The vendor identifier | integer |
| vendorCode | The vendor code | string |
| vendorInfo | The vendor info | string |
| active | boolean | |
| hasCalculatedMeter | boolean | |
| hasSplitParentMeter | boolean | |
| hasSplitChildMeter | boolean | |
| isSubAccount | boolean | |
| hasSubAccount | boolean | |
| meter | MeterChild | |
| meterId | The meter identifier | integer |
| meterCode | The meter code | string |
| meterInfo | The meter info | string |
| meterType | MeterTypeChild | |
| meterTypeId | integer | |
| meterTypeCode | string | |
| meterTypeInfo | string | |
| commodity | CommodityChild | |
| commodityId | The commodity identifier Required (defined) | integer |
| commodityCode | The commodity code Required (defined) | string |
| commodityInfo | The commodity info Required (defined) | string |
| commodityIcon | Icon | |
| code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
| color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
| active | Indicates whether the Meter is Active | boolean |
| isCalculatedMeter | Indicates whether the meter is a calculated meter | boolean |
| isSplitParentMeter | Indicates whether the meter is a parent of a split | boolean |
| isSplitChildMeter | Indicates whether the meter is a child of a split | boolean |
| serialNumber | The meter’s current serial number | string |
| 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 |
| hasBills | Do any bills exist that were created by this version? A version cannot be deleted if there are any existing bills that were created using this version |
boolean |
[
{
"versionId": 1,
"versionInfo": "string",
"chargebackType": "string",
"beginPeriod": 1,
"endPeriod": 1,
"account": {
"accountType": {
"accountTypeId": 1,
"accountTypeCode": "string",
"accountTypeInfo": "string"
},
"accountId": 1,
"accountCode": "string",
"accountInfo": "string",
"vendor": {
"vendorId": 1,
"vendorCode": "string",
"vendorInfo": "string"
},
"active": false,
"hasCalculatedMeter": false,
"hasSplitParentMeter": false,
"hasSplitChildMeter": false,
"isSubAccount": false,
"hasSubAccount": false
},
"meter": {
"meterId": 1,
"meterCode": "string",
"meterInfo": "string",
"meterType": {
"meterTypeId": 1,
"meterTypeCode": "string",
"meterTypeInfo": "string"
},
"commodity": {
"commodityId": 1,
"commodityCode": "string",
"commodityInfo": "string",
"commodityIcon": {
"code": "string",
"color": "string"
}
},
"active": false,
"isCalculatedMeter": false,
"isSplitParentMeter": false,
"isSplitChildMeter": false,
"serialNumber": "string"
},
"workflow": {
"chargebackWorkflowStepId": 1,
"chargebackWorkflowStepInfo": "string",
"chargebackWorkflowStepDescription": "string",
"chargebackWorkflowStepType": "string",
"chargebackWorkflowStepOrder": 1,
"chargebackWorkflow": {
"chargebackWorkflowId": 1,
"chargebackWorkflowInfo": "string"
}
},
"hasBills": false
}
]