IssueVoucherInputBuilder Class

Contains methods to build an instance of the LoyaltyManagement.IssueVoucherInput class.

LoyaltyManagement

• IssueVoucherInputBuilder Methods

The following are methods for IssueVoucherInputBuilder.

• build()

  Returns an instance of the LoyaltyManagement.IssueVoucherInput object.

• setAdditionalNotes(additionalNotes)

  Represents extra information about the voucher.

• setBenefitId(benefitId)

  Represents the benefit associated with the voucher.

• setContactId(contactId)

  Represents the contact associated with the loyalty program member.

• setDiscountPercent(discountPercent)

  Represents the discount percentage provided by the voucher.

• setEffectiveDate(effectiveDate)

  Represents the start date of the validity of the voucher.

• setExpiryDate(expiryDate)

  Represents the expiry date of the voucher.

• setFaceValue(faceValue)

  Represents the amount of discount provided by the voucher.

• setJournalId(journalId)

  Represents the transaction journal associated with the member voucher when the voucher results from accrual of points.

• setLoyaltyProgramMemberId(loyaltyProgramMemberId)

  Represents the ID of the loyalty program member to issue the voucher.

• setProgramName(programName)

  Represents the name of the loyalty program associated with the voucher.

• setPromotionId(promotionId)

  Represents the promotion associated with the voucher.

• setVoucherCode(voucherCode)

  Represents the voucher identifier generated by an external system. This is a required field.

• setVoucherDefinitionName(voucherDefinitionName)

  Represents the name of the voucher definition associated with the voucher code. This is a required field.

Returns an instance of the LoyaltyManagement.IssueVoucherInput object.

public LoyaltyManagement.IssueVoucherInput build()

Type: LoyaltyManagement.IssueVoucherInput

Represents extra information about the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setAdditionalNotes(String additionalNotes)

additionalNotes

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the benefit associated with the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setBenefitId(String benefitId)

benefitId

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the contact associated with the loyalty program member.

public LoyaltyManagement.IssueVoucherInputBuilder setContactId(String contactId)

contactId

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the discount percentage provided by the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setDiscountPercent(Integer discountPercent)

discountPercent

Type: Integer

The discount percentage provided by the voucher. Specify a value to override the discount percentage specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Discount Percentage. This field is available in API version 53.0 and later.

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the start date of the validity of the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setEffectiveDate(String effectiveDate)

effectiveDate

Type: String

The supported date format is YYYY-MM-DD.

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the expiry date of the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setExpiryDate(String expiryDate)

expiryDate

Type: String

The supported date format is YYYY-MM-DD.

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the amount of discount provided by the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setFaceValue(Double faceValue)

faceValue

Type: Double

The amount of discount provided by the voucher. Specify a value to override the face value specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Fixed Value. This field is available in API version 53.0 and later.

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the transaction journal associated with the member voucher when the voucher results from accrual of points.

public LoyaltyManagement.IssueVoucherInputBuilder setJournalId(String journalId)

journalId

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the ID of the loyalty program member to issue the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setLoyaltyProgramMemberId(String loyaltyProgramMemberId)

loyaltyProgramMemberId

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the name of the loyalty program associated with the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setProgramName(String programName)

programName

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the promotion associated with the voucher.

public LoyaltyManagement.IssueVoucherInputBuilder setPromotionId(String promotionId)

promotionId

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the voucher identifier generated by an external system. This is a required field.

public LoyaltyManagement.IssueVoucherInputBuilder setVoucherCode(String voucherCode)

voucherCode

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder

Represents the name of the voucher definition associated with the voucher code. This is a required field.

public LoyaltyManagement.IssueVoucherInputBuilder setVoucherDefinitionName(String voucherDefinitionName)

voucherDefinitionName

Type: String

Type: LoyaltyManagement.IssueVoucherInputBuilder