Skip to main content

ReverseBenefitFundingForIndividualInput

An input type used when reversing a previous funding transaction for a benefit and individual.

input ReverseBenefitFundingForIndividualInput {
  amount: MoneyInput
  benefitId: ID!
  description: String
  fundingTransactionId: ID!
  idempotencyKey: String!
  individualId: ID!
}

Fields​

ReverseBenefitFundingForIndividualInput.amount ● MoneyInput input​

Optional partial reversal amount. When omitted, the original funding amount is reversed in full. When provided, must be a positive non-zero USD amount no greater than the original funding amount.

ReverseBenefitFundingForIndividualInput.benefitId ● ID! non-null scalar​

The ID of the benefit the individual is enrolled in

ReverseBenefitFundingForIndividualInput.description ● String scalar​

Optional human-readable description recorded on the reversal entry.

ReverseBenefitFundingForIndividualInput.fundingTransactionId ● ID! non-null scalar​

The transaction ID of the prior fundBenefitForIndividual call to reverse. This is the value returned as 'transactionId' on the original FundBenefitForIndividualResult.

ReverseBenefitFundingForIndividualInput.idempotencyKey ● String! non-null scalar​

A unique idempotency key for this reversal request. Repeated calls with the same key return the prior result.

ReverseBenefitFundingForIndividualInput.individualId ● ID! non-null scalar​

The ID of the individual whose funding is being reversed

Member Of​

reverseBenefitFundingForIndividual mutation