Get Balance Transactions Summary
Get Balance Transactions Summary
Retrieves the Balance Transactions Summary for a given Balance.
The response contains useful recorded and calculated Transaction amounts created for a Balance during the time it is active for the Account, including amounts relevant to any rollover amount configured for a Balance:
totalCreditAmount. The sum of all credits amounts created for the Balance.totalDebitAmount. The sum of all debit amounts created for the Balance.initialCreditAmount. The initial credit amount created for the Balance.expiredBalanceAmount. The amount of the Balance remaining at the time the Balance expires and which is not included in any configured Rollover amount. For example, suppose a Balance reaches its end date and 800, then theexpiredBalanceAmountis calculated as 800 = $200.rolloverConsumed. The sum of debits made against the configured rollover amount. Note that this amount is dynamic relative to when the API call is made until either the rollover end date is reached or the cap configured for the rollover amount is reached, after which it will be unchanged. If no rollover is configured for a Balance, then this is ignored.balanceConsumed. The sum of debits made against the Balance. Note that this amount is dynamic relative to when the API call is made until either the Balance end date is reached or the available Balance amount reaches zero, after which it will be unchanged.
GET
Get Balance Transactions Summary
Authorizations
m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.
The authorizationCode flow controls access for human users via the m3ter Console application.
Path Parameters
UUID of the organization
The UUID of the Balance
Response
Summary of all Balance Transactions
Example:
250
Example:
125.5
Example:
300
Amount of the balance that expired without being used
Example:
50
Amount consumed from rollover credit
Example:
75
Amount consumed from the original balance
Example:
100