VoucherProduct

Contents

General
CloudAssessSpec
CollegePreferenceService
CsvBuilder
DocumentService
DocumentSpec
EmailSpec
ExportSpec
MailchimpSpec
Mask
Money
Preferences
QualityResultSpec
ReportSpec
SmsSpec
SystemUserService
Database objects
ACLAccessKey
ACLRole
Account
AccountTransaction
Application
Article
ArticleProduct
Assessment
AssessmentClass
AssessmentSubmission
AttachmentData
Attendance
Banking
Certificate
ClassCost
ConcessionType
Contact
ContactRelation
ContactRelationType
CorporatePass
CorporatePassCourseClass
CorporatePassProduct
Country
Course
CourseClass
CourseClassTutor
CourseModule
CustomField
CustomFieldType
DefinedTutorRole
Discount
DiscountConcessionType
DiscountCourseClass
DiscountMembership
DiscountMembershipRelationType
Document
DocumentVersion
EmailTemplate
Enrolment
EntityRelation
ExportTemplate
Field
FieldConfiguration
FieldConfigurationScheme
FieldHeading
FundingSource
FundingUpload
FundingUploadOutcome
Import
Invoice
InvoiceDueDate
InvoiceLine
InvoiceLineDiscount
Language
Membership
MembershipProduct
Message
MessagePerson
Module
Note
Outcome
PayLine
PayRate
PaymentIn
PaymentInLine
PaymentMethod
PaymentOut
PaymentOutLine
Payslip
Preference
PriorLearning
Product
ProductItem
Qualification
Report
ReportOverlay
Room
SavedFind
Script
Session
SessionModule
Site
Student
StudentConcession
Survey
SystemUser
Tag
TagRelation
TagRequirement
Tax
TrainingPackage
Tutor
TutorAttendance
UnavailableRule
Voucher
VoucherPaymentIn
VoucherProduct
WaitingList
Enumerations
AccountTransactionType
AccountType
ApplicationStatus
AttachmentInfoVisibility
AttachmentSpecialType
AttendanceType
AvetmissStudentDisabilityType
AvetmissStudentEnglishProficiency
AvetmissStudentIndigenousStatus
AvetmissStudentLabourStatus
AvetmissStudentPriorEducation
AvetmissStudentSchoolLevel
ClassCostFlowType
ClassCostRepetitionType
ClassFundingSource
ClientIndustryEmploymentType
ClientOccupationIdentifierType
ConfirmationStatus
ContactDuplicateStatus
CourseClassAttendanceType
CourseEnrolmentType
CreditCardType
CreditLevel
CreditProviderType
CreditType
DeliveryMode
DeliverySchedule
DiscountType
EnrolmentStatus
EnrolmentVETFeeHelpStatus
EntityRelationType
ExpiryType
FieldConfigurationType
InvoiceType
KeyCode
KeyCollision
MessageStatus
MessageType
MoneyRounding
NodeSpecialType
OutcomeStatus
PaymentSource
PaymentStatus
PaymentType
PayslipStatus
PostcodeType
ProductStatus
ProductType
QualificationType
RecognitionOfPriorLearningIndicator
StudentCitizenship
StudentStatusForUnitOfStudy
StudyReason
SurveyTypeSource
SurveyVisibility
TriggerType
UsiStatus
VETFeeExemptionType
VoucherPaymentStatus

The Voucher Product represents an item available for sale (through the office or on the website). When sold, a Voucher is created for the contact. So think of VoucherProduce as the template for what that voucher will look like once sold. A voucher may be for a dollar amount or for a certain number of enrolments in particular courses. Vouchers should be thought of as a storage of value. When sold, they do not create a tax invoice since they aren't a taxable sale. They are only a way for a customer to store value with the college, similar to the student storing value in a bank account. For this reason, income is not posted to the GL on sale. Instead a liability is created which is extinguished only when the student redeems the voucher or the voucher expires.

 
        public 
        VoucherProduct
     {
}

Instance methods

courseRelations

Returns Not null List<CourseProductRelation>

courses related to this product type

createdOn

Returns Date

the date and time this record was created

description

Returns String

description of this product type

expiryDays

Returns Integer

number of days after purchase product is valid

expiryType

Returns ExpiryType

expiry type of this product type

feeGST

Returns Money

GST tax amount for this product type

incomeAccount

Returns Not null Account

income account linked to this product type

isOnSale

Returns Not null Boolean

true if this product can be currently purchased

isWebVisible

Returns Not null Boolean

true if this product type can be purchased on website

liabilityAccount

VoucherProducts are a liability when created. This method can return the account of the general ledger these liabilities are created in

Returns Not null Account

the account joined to this voucher product

maxCoursesRedemption

If this value is not null, the voucher can be redeemed for one or more enrolments. If this value is not null, then getValue() will be null.

Returns Integer

the maximum number of enrolments which can be redeemed with this voucher

modifiedOn

Returns Date

the date and time this record was modified

name

Returns String

name of this product type

notes

Returns String

private notes associated with product types

priceExTax

Returns Money

price for this product type excluding tax

productItems

Returns Not null List<ProductItem>

product items of this product type

sku

Returns Not null String

SKU of this product type

tax

Returns Not null Tax

tax linked to this product type

taxAdjustment

Returns Not null Money

tax adjustment value (used for rounding)

value

If this value is not null, the voucher can be redeemed for a specific dollar value. If this value is not null, then getMaxCoursesRedemption() will be null. If getMaxCoursesRedemption() is null and getValue() is also null, then the value of the Voucher on creation will be equal to the sale price. For example, if the voucher is sold for $100 then it will also be worth $100 in redemption value. This allows you to create VoucherProduct records which can be sold for any arbitrary value.

Returns Money

a dollar value for this voucher