PaymentIn

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 received by the college. 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 
        PaymentIn
     {
}

Instance methods

account

Returns def

Documentation not yet available

accountIn

This account is copied from the PaymentMethod object when the PaymentIn is created. We keep a copy here because the PaymentMethod account might change from time to time and we need to store the value at time of creation.

Returns Not null Account

this is the asset account into which the payment is deposited

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. This is then used to group payments when performing banking.

Returns Nullable Site

the site which received the payment

amount

Returns Not null Money

amount of money paid

chequeBank

Returns String

bank information of a cheque

chequeBranch

Returns String

branch information for a cheque

chequeDrawer

Returns String

drawer name for a cheque

confirmationStatus

Returns Not null ConfirmationStatus

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

createdBy

Returns Not null SystemUser

user who created this payment

createdOn

Returns Date

the date and time this record was created

creditCardClientReference

Returns Nullable String

the onCourse payment gateway reference. This value will start with "W" for payments taken online.

dateBanked

Returns Nullable LocalDate

date when payment was banked

gatewayReference

Returns String

the reference code returned by the banking system

gatewayResponse

This is typically only useful for debugging since the data here can vary a lot.

Returns String

the details of the response received from the banking system.

invoices

Returns Not null List<Invoice>

list of invoices linked to this payment record

modifiedOn

Returns Date

the date and time this record was modified

payer

Returns Not null Contact

contact who is the payer

paymentInLines

Returns Not null List<PaymentInLine>

list of payment lines linked to this payment

paymentLines

Returns Not null List<? extends PaymentLineInterface>

list of payment lines linked to this payment

paymentMethod

Returns Not null PaymentMethod

the method used to make 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 is reconciled

reversalOf

Returns PaymentIn

another payment instance which current payment reverses, null if this payment is not a reversal

reversedBy

A user can reverse a payment, which cancels it and reverses the general ledger transactions.

Returns Nullable PaymentIn

payment in which reversed this payment, null if payment is not reversed

source

Returns Not null PaymentSource

this records whether the payment was created online or in the office

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

Documentation not yet available

voucherPayments

Returns Not null List<VoucherPaymentIn>

list of vouchers linked to this payments

isFinalised()

See PaymentStatus for a list of statuses which are final.

Returns boolean

true if the payment is in a final state which can no longer be changed