# Account Balances API



<EndpointIndex names={['handleExcessFunds']} />

Handle Excess Funds [#handle-excess-funds]

<ApiEndpoint name="handleExcessFunds" />

<ApiSchema name="AccountExcessHandlingResult" />

<ApiSchema name="ExcludedDebitsAmountResult" />

<ApiSchema name="ExcludedDebit" />

<ApiSchema name="ExcessCreditCreateDisbursementResult" />


## API Reference

PATCH /billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds — handleExcessFunds
Tags: account-balances-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
  currency (string, query)
Responses:
  200 AccountExcessHandlingResult — OK

AccountExcessHandlingResult
Properties:
  accountLocator (ulid, required)
  currency (string, required)
  accountCreditBalance (number, required)
  excludedDebitsAmountResult (ExcludedDebitsAmountResult, required)
  thresholdUsed (number)
  createDisbursementResult (ExcessCreditCreateDisbursementResult)
  errors (string[], required)

ExcludedDebitsAmountResult
Properties:
  calculationType (Enum none | pastDueInvoices | allInvoices | invoicesAndUnbilledInstallments, required)
  entitiesUsedInCalculation (ExcludedDebit[], required)
  currency (string, required)
  amountToExclude (number, required)

ExcludedDebit
Properties:
  entityLocator (ulid, required)
  type (Enum invoice | installment, required)

ExcessCreditCreateDisbursementResult
Properties:
  disbursementLocator (ulid, required)
  disbursementState (Enum draft | validated | approved | executed | reversed | rejected | discarded, required)
  disbursedAmount (number, required)
  validationResult (ValidationResult)