Manages the meter-level line items for a calculated bill version (create, update, delete)
Use this endpoint to define meter-level bodylines that appear on the calculated bill. The order of items
in the list defines the calculation order. Pass all line items that should exist — items in the database
but not in the request are deleted. The entire operation is transactional.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| accountId | Unique numeric identifier of the account | integer (int32) | Required |
| meterId | Unique numeric identifier of the meter | integer (int32) | Required |
| versionId | Unique numeric identifier of the calculated bill distribution version | integer (int32) | Required |
Request Body
Array of:
GenericBodylineRequest
| Property | Description | Type |
|---|---|---|
| calculationType | The calculation type for the line item One of ‘Fixed’, ‘Percentage’, ‘Subtotal’ Required (defined) | string |
| caption | The caption Must be between 0 and 100 characters Required when CalculationType is set to Fixed, or Percentage, or Subtotal | string |
| observationTypeId | The observation type For account body lines the observation type must be a charge type Required when CalculationType is set to Fixed, or Percentage | integer (int32) |
| value | The bodyline’s value When CalculationType is Fixed. Precision max is 2 When CalculationType is Percentage. Precision max is 8 Required when CalculationType is set to Fixed, or Percentage | number (double) |
Example Request Body
[
{ "calculationType": "string", "caption": "string", "observationTypeId": 1, "value": 1.0
}
]
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
GenericBodylineResponse
| Property | Description | Type | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| calculationType | The calculation type for the line item. Either “Fixed”, “Percentage”, or “Subtotal” | string | |||||||||||||||||||||
| caption | The caption | string | |||||||||||||||||||||
| observationType | ObservationTypeChild | ||||||||||||||||||||||
|
ObservationTypeChild properties
|
|||||||||||||||||||||||
| value | The bodyline’s value | number (double) | |||||||||||||||||||||
Example Response
[
{ "calculationType": "string", "caption": "string", "observationType": { "credit": 1, "nounCode": "string", "nounId": 1, "observationTypeCode": "string", "observationTypeId": 1, "observationTypeInfo": "string"
}, "value": 1.0
}
]