Account

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

An Account is a representation of a General Ledger transactional account for the finance backend of onCourse.

 
        public 
        Account
     {
}

Instance methods

accountCode

Returns Not null String

an account code as used in an external accounting system or general ledger

getBalance(until)

LocalDate until

get data up to a given date

Returns Money

balance up until a given

createdOn

Returns Nullable Date

the date and time this record was created

description

Returns Not null String

a description which will appear in the user interface alongside the account code

isEnabled

Accounts cannot be deleted once used, so you can only disable them in order to prevent them from being used in the future. Note that disabling an account doesn't "turn it off", it only hides that account from being selected in the user interface. Existing records already linked to that account will continue to be linked and use that account.

Returns Not null Boolean

whether the account is enabled

modifiedOn

Returns Date

the date and time this record was modified

getMovements(from, to)

LocalDate from

Documentation not yet available

LocalDate to

Documentation not yet available

Returns Money

Documentation not yet available

type

Returns Not null AccountType

the type of account (asset, liability, etc)

isAsset()

Returns boolean

true if the account is an asset type

isCOS()

Returns boolean

true if the account is a cost of sale type (this is a particular type of expense)

isCredit()

Is this account one of the credit types. * LIABILITY * INCOME

Returns boolean

true if the account is an equity type

isDebit()

Is this account one of the debit types. * ASSET * COS * EQUITY * EXPENSE

Returns boolean

true if the account is an equity type

isEquity()

Equity account types are rarely used in onCourse.

Returns boolean

true if the account is an equity type

isExpense()

Returns boolean

true if the account is an expense type

isIncome()

Returns boolean

true if the account is an income type

isLiability()

Returns boolean

true if the account is a liability type