Account Balances API

Handle Excess Funds

handleExcessFunds

PATCH /billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
currency	query	string?	optional

Response:AccountExcessHandlingResult

Security Group:account-balances Permission:write

AccountExcessHandlingResult

¶

required
accountLocator string
currency string
accountCreditBalance number
excludedDebitsAmountResult ExcludedDebitsAmountResult
errors string[]

optional
createDisbursementResult ExcessCreditCreateDisbursementResult?
thresholdUsed number?

ExcludedDebitsAmountResult

¶

required
currency string
amountToExclude number
calculationType Enum none | pastDueInvoices | allInvoices | invoicesAndUnbilledInstallments
entitiesUsedInCalculation ExcludedDebit[]

ExcludedDebit

¶

required
entityLocator string
type Enum invoice | installment

ExcessCreditCreateDisbursementResult

¶

required
disbursementLocator string
disbursementState Enum draft | validated | approved | executed | reversed | rejected | discarded
disbursedAmount number

optional
validationResult ValidationResult?