Skip to main content

reverseBenefitFundingForIndividual

Reverses a funding deposit for an Individual. A deposit can be reversed whether it was made by 'fundBenefitForIndividual' or by a payroll contribution. The deposit is identified by its Transaction.id, as listed on the Individual's Account.transactions. On success, the total funds available to the Individual in this Benefit is decreased by the amount specified in the request (or, when 'amount' is omitted, the full original funding amount). Supports partial reversals. The reversals of one deposit cannot exceed its amount in total, so after a partial reversal, name the remaining 'amount' explicitly.

Reversed funds are returned to the funding source for the Benefit. Subsequent return of funds further upstream, where applicable, is handled separately and is not in the scope of this mutation.

Available for all Benefit types.

reverseBenefitFundingForIndividual(
  input: ReverseBenefitFundingForIndividualInput!
): ReverseBenefitFundingForIndividualResponse

Arguments​

reverseBenefitFundingForIndividual.input ● ReverseBenefitFundingForIndividualInput! non-null input​

Type​

ReverseBenefitFundingForIndividualResponse union​

A union representing the possible return types when reversing a benefit funding for an individual.