Function: getPaymentsOverpaid()

getPaymentsOverpaid<ThrowOnError>(options?): RequestResult<GetPaymentsOverpaidResponses, GetPaymentsOverpaidErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:729

Retrieves a list of enrollment balances that have been overpaid. The GetOverpaid endpoint is designed for financial reconciliation, highlighting instances where users have paid more than the required amount. This allows administrators to manage refunds or apply credits to future activities, ensuring accurate accounting and member satisfaction.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetPaymentsOverpaidData, ThrowOnError>

Returns

RequestResult<GetPaymentsOverpaidResponses, GetPaymentsOverpaidErrors, ThrowOnError>