Skip to main content

List total balances (shared wallets)

GET 
/total-balances

Returns a paginated list of total balances.

Privileges (one of the following based on the deployment):

  • bulk-billing-cust-sms.view
  • bulk-billing-supplier-sms.view
  • bulk-billing-cust-mnp.view
  • bulk-billing-supplier-mnp.view
  • bulk-billing-cust-sms-own.view
  • bulk-billing-supplier-sms-own.view
  • bulk-billing-cust-mnp-own.view
  • bulk-billing-supplier-mnp-own.view

Audit event

  • total.balance.list

Filter/Sort fields:

  • id
  • instanceId
  • bizPartnerId
  • isDefault
  • currency
  • billingType
  • name
  • status
  • alertsPolicyId
  • alertsBaseAmount
  • alertsPolicyName
  • amount
  • paidTotal
  • unpaidTotal
  • billedTotal
  • accountsTotal
  • smsCount
  • creditLimit
  • debitLimit
  • overdraftLimit
  • debitBalanceThreshold
  • usage
  • availableAmount
  • totalCredit
  • debitTotal
  • bizPartnerName
  • bizPartnerShortName
  • pricePackageMode
  • pricePackageId
  • orderedPrepaidMode
  • overdraftPriceListId
  • currentCreditRecordId
  • firstCreditRecordId
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • alertsLanguage
  • blockOnOutOfCredit

Searchable attributes:

  • name
  • billingTypeName
  • bizPartnerShortName
  • bizPartnerName
  • status
  • alertsPolicyName
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • blockOnOutOfCredit
  • bizPartnerId
  • debitBalanceThreshold
  • overdraftLimit

Errors:

  • NOT_AUTHENTICATED - Not authenticated
  • NOT_AUTHORIZED - Not authorized
  • INT_APP_ERROR - Unexpected internal error

Request​

Responses​

OK — data is an array of total balance objects; meta.pagination describes the page.