Account Balances API
PATCH /billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
currency | query | string? | optional |
Response:AccountExcessHandlingResult
Security Group:account-balances  Permission:write
AccountExcessHandlingResult
¶requiredaccountLocator locatorcurrency stringaccountCreditBalance numberexcludedDebitsAmountResult ExcludedDebitsAmountResulterrors string[]optionalcreateDisbursementResult ExcessCreditCreateDisbursementResult?thresholdUsed number?
ExcludedDebitsAmountResult
¶requiredcurrency stringamountToExclude numbercalculationType Enum none | pastDueInvoices | allInvoices | invoicesAndUnbilledInstallmentsentitiesUsedInCalculation ExcludedDebit[]
ExcludedDebit
¶requiredentityLocator locatortype Enum invoice | installment
ExcessCreditCreateDisbursementResult
¶requireddisbursementLocator locatordisbursementState Enum draft | validated | approved | executed | reversed | rejected | discardeddisbursedAmount numberoptionalvalidationResult ValidationResult?