Account Balances API

Action	Endpoint
Handle Excess Funds	PATCH/billing/{tenantLocator}/accountBalances/{locator}/handleExcessFunds

Handle Excess FundshandleExcessFunds

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`currency`	query	`string?`	No

Response:AccountExcessHandlingResult

Security Group:account-balances

Permission:

write

AccountExcessHandlingResult

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`currency`	`string`
`accountCreditBalance`	`number`
`excludedDebitsAmountResult`	`ExcludedDebitsAmountResult`
`errors`	`string[]`

Optional properties

Property	Type	Description
`createDisbursementResult`	`ExcessCreditCreateDisbursementResult?`
`thresholdUsed`	`number?`

ExcludedDebitsAmountResult

Required properties

Property	Type	Description
`currency`	`string`
`amountToExclude`	`number`
`calculationType`	`Enum none \| pastDueInvoices \| allInvoices \| invoicesAndUnbilledInstallments`
`entitiesUsedInCalculation`	`ExcludedDebit[]`

ExcludedDebit

Required properties

Property	Type	Description
`entityLocator`	`ulid`
`type`	`Enum invoice \| installment`

ExcessCreditCreateDisbursementResult

Required properties

Property	Type	Description
`disbursementLocator`	`ulid`
`disbursementState`	`Enum draft \| validated \| approved \| executed \| reversed \| rejected \| discarded`
`disbursedAmount`	`number`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`