Skip to main content

Fields

averageMonthlyCharge : Int

The combined average montly cost for all markets based on usage.

balanceAdjustment : Int

Suggested temporary adjustment to ongoing usage amount to cover debt or overpayment.

Breakdown of customer's estimated or real usage per market and per month.

Arguments
after : String
before : String
first : Int
last : Int
currentBalance : Int

The balance the ledger has at the time of review.

existingMonthlyAmount : Int

The amount the customer is paying monthly at the time of the review.

reviewedOn : Date

The date that we used to calculate the review of the ledger.

suggestedNewMonthlyAmount : Int

The suggested monthly payment amount in minor currency following the payment adequacy review.

targetBalance : Int

The balance we expect the ledger to have at the end period of the review.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "averageMonthlyCharge": 47, "balanceAdjustment": 20, "consumption": ConsumptionBreakdownConnectionTypeConnection, "currentBalance": 34, "existingMonthlyAmount": 73, "reviewedOn": "1985-10-25", "suggestedNewMonthlyAmount": 23, "targetBalance": 100 }