PaymentOut

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

A payment or refund from college to someone else. Each payment can be linked to one or more invoices (or credit notes), and may partially pay an invoice or fully discharge the amount owing.

 
        public 
        PaymentOut
     {
}

Instance methods

account

Returns def

account linked with this PaymentOut

accountOut

Returns Not null Account

account linked with this PaymentOut

administrationCentre

Some sites can be designated as "administration centres" meaning that they are allowed to accept payments and perform banking functions. A user can choose their site when they log in and all payments created by them from that point are linked to that Site.

Returns Not null Site

the site which issued the PaymentOut

amount

Returns Not null Money

amount of money paid

chequeBank

Returns String

Documentation not yet available

chequeBranch

Returns String

Documentation not yet available

chequeDrawer

Returns String

Documentation not yet available

chequeNumber

Returns String

Documentation not yet available

confirmationStatus

Returns Not null ConfirmationStatus

confirmation email sending status: not sent, sent or suppressed from sending

contact

Returns Not null ContactInterface

contact who receives the payment

createdBy

Returns Not null SystemUser

user who created this payment

createdOn

Returns Date

the date and time this record was created

dateBanked

Returns Nullable LocalDate

date when payment was banked

gatewayReference

Returns String

payment reference code in the banking system

modifiedOn

Returns Date

the date and time this record was modified

payee

Returns Not null Contact

contact who receives the payment

paymentDate

Returns Not null LocalDate

Documentation not yet available

paymentInGatewayReference

Returns String

Documentation not yet available

paymentLines

Returns Not null List<? extends PaymentLineInterface>

list of linked payment lines

paymentMethod

Returns Not null PaymentMethod

the method used to make this payment

paymentOutLines

Returns Not null List<PaymentOutLine>

list of payment lines linked to this payment

privateNotes

Private notes are typically not to be shared with the customer.

Returns String

any private notes stored on the payment

reconciled

Returns Not null Boolean

true if this payment has been reconciled

status

During processing in onCourse payment undergoes a number of status changes until it settles on one of the final statuses. On creation payment receives NEW status immediately, after payment details are settled and processing begins payment is set to IN TRANSACTION status, then after processing is finished payment receives final status which may be one of the FAILED statuses or a SUCCESSFUL status.

Returns PaymentStatus

current status of processing for this payment

statusString

Returns def

the display name of the PaymentOut status

type

Returns Not null String

payment method name