Put /api/v3/account/{accountId}/meter/{meterId}/calculatedBill/{versionId}/accountLineItem

Operation: ManageAccountLineItemsV3 Permissions: Chargebacks (Manage)

Summary

Manage calculated bill account line items
The order of items in the list defines the calculation order
All line items to save should be passed
If a line currently exists and is not passed in it will be deleted
If any part of the create, update, or delete process fails, the entire process is rolled back

Path and Query Parameters

Parameter Description Type Location
accountId ID of the account to receive calculated bill detailsRequired integer Path
meterId ID of the meter to receive calculated bill detailsRequired integer Path
versionId ID of the calculated bill distribution versionRequired integer Path

Request Body Parameters

Content-Type: application/json

Type Reference: GenericBodylineRequest [Array]

Parameter Description Type
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
caption The caption Must be between 0 and 100 characters Required when CalculationType is set to Fixed, or Percentage, or Subtotal string
calculationType The calculation type for the line item One of ‘Fixed’, ‘Percentage’, ‘Subtotal’ Required (defined) string
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
Request Body Array object [Array]

Request Body

[
  {
    "observationTypeId": 1,
    "caption": "string",
    "calculationType": "string",
    "value": 1.0
  }
]

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: GenericBodylineResponse [Array]

Parameter Description Type
array
   observationType ObservationTypeChild
      nounId The identifier for the observation type’s noun integer
      nounCode The observation type’s noun code string
      credit Indicates the type of credit for the observation type. Possible values include: 1 (Credit), 2 (Debit), 3 (Ignore) integer
      observationTypeId The observation type identifier integer
      observationTypeCode The observation type code string
      observationTypeInfo The observation type info string
   caption The caption string
   calculationType The calculation type for the line item. Either “Fixed”, “Percentage”, or “Subtotal” string
   value The bodyline’s value number

Responses

HTTP 200

Body

Content Type: application/json
[
  {
    "observationType": {
      "nounId": 1,
      "nounCode": "string",
      "credit": 1,
      "observationTypeId": 1,
      "observationTypeCode": "string",
      "observationTypeInfo": "string"
    },
    "caption": "string",
    "calculationType": "string",
    "value": 1.0
  }
]