Voucher
Represents details about a voucher that’s issued to a customer or a loyalty program member. This object is available in API version 51.0 and later.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: The ID of the account to which the voucher is issued. This field is available in API version 62.0 and later.
This field is a relationship field.
Relationship Name: Account
Refers To: Account
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the benefit associated with the voucher.
This is a relationship field.
Relationship Name: Benefit
Relationship Type: Lookup
Refers To: Benefit
Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: ID of the contact to which the voucher is issued.
This is a relationship field.
Relationship Name: Contact
Relationship Type: Lookup
Refers To: Contact
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The discount percentage of the voucher.
Type: date
Properties: Create, Filter, Group, Sort, Update
Description: Required. The date the voucher goes into effect.
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time from when the voucher is available for redemption. This field is available in API version 62.0 and later.
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date the voucher expires.
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the voucher expires and is no longer available for redemption. This field is available in API version 62.0 and later.
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The value of the voucher.
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced this record.
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed this record.
Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: ID of the loyalty program member who the voucher was issued to.
This is a relationship field.
Relationship Name: LoyaltyProgramMember
Relationship Type: Lookup
Refers To: LoyaltyProgramMember
Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The autogenerated number of the voucher.
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this record.
This is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the promotion associated with the voucher.
This is a relationship field.
Relationship Name: Promotion
Relationship Type: Lookup
Refers To: Promotion
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason why the voucher was issued.
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The voucher balance that was redeemed. This field is available in API version 53.0 and later.
Type: currency
Properties: Filter, Nillable, Sort
Description: The remaining value of the voucher after partial redemption. This field is available in API version 53.0 and later.
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The key that’s used to redeem a reserved voucher. This field is available in API version 62.0 and later.
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when the voucher is reserved for redemption. This field is available in API version 62.0 and later.
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The value of the voucher reserved by the customer. This field is available in API version 62.0 and later.
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. The status of the voucher.
Possible values are:
CancelledExpiredIssuedRedeemed
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the transaction journal associated with the voucher.
This is a relationship field.
Relationship Name: TransactionJournal
Relationship Type: Lookup
Refers To: TransactionJournal
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date the voucher was used.
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The voucher identifier generated by an external system.
Type: reference
Properties: Create, Filter, Group, Nillable, Sort
Description: ID of the voucher definition associated with the voucher.
This is a relationship field.
Relationship Name: VoucherDefinition
Relationship Type: Lookup
Refers To: VoucherDefinition
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
VoucherChangeEvent (API Version 63.0): Change events are available for the object.
VoucherHistory (API version 52.0): History is available for tracked fields of the object.
VoucherShare (API version 52.0): Sharing is available for the object.