Table Lists

Table Lists

There are 2 types of documents: Master Documents and Standard Paragraphs.

Standard Paragraphs are normal Word documents.
They do not refer to any tables or fields.
For a full explanation of how these work, please see Enrolment Standard Paragraphs

All Master Documents work in the same way.
As enrolment documents are the most common, these are explained in detail in Enrolment Master Documents

Enrolments and groups can have additional documents relating to invoices, credits and proformas.
Memo documents are also available for enrolments. These documents work in the same way to master documents, except standard paragraphs cannot be included.

Each master document has different tables associated with it, and hence the fields that can be included.

Here is a list of the tables associated with each master document.

Accommodation

Accommodation Fields
Accommodation
Accommodation Room
Accommodation School
Accommodation Preference
Accommodation Office
Booking Fields
Booking
Booking Enrolment
Booking Student
Booking Transfer
Booking Adjustment
Booking Payment
Special Fields

Agent

Agent Fields
Agent
Contact Fields
Contact
Enrolment Fields
Enrolment
Student
Special Fields

Enrolments

Enrolment Fields
Enrolment
Student
School
Group
Main Agent
Commission Agent
Student Contracts
Course Header Fields
Course Header
Course Header Booking
Course Header Booking Class
Course Header Adjustment
Course Booking Fields
Course Booking
Course Booking Class
Course Booking Adjustments
Teacher Fields
Teacher
Transfer Fields
Transfer
Accommodation Header Fields
Accommodation Header
Accommodation Header Preference
Accommodation Header Booking
Accommodation Header Booking Adjustments
Accommodation Header Host
Sundry Fields
Sundry
Invoicing Fields
Invoice Header
Invoice Header Invoice Currency
Invoice Header Memo Currency
Invoice Package
Invoice Package Line
Invoice Standard Line
Invoice Package Cancelled
Invoice Package Line Cancelled
Invoice Standard Line Cancelled
Invoice Comment Line
Package Fields
Package
Package Course
Package Accommodation
Package Transfer
Package Sundry
Special Fields

Enrolment Invoices

Enrolment Fields
Enrolment
Student
School
Group
Main Agent
Commission Agent
Student Contacts
Invoicing Fields
Invoice Header
Invoice Header Invoice Currency
Invoice Header Memo Currency
Invoice Payment Message
Invoice Memo Payment Message
Invoice Lines
Special Fields

Enrolment Proformas

Enrolment Fields
Enrolment
Student
School
Group
Main Agent
Commission Agent
Student Contacts
Invoicing Fields
Invoice Header
Invoice Header Invoice Currency
Invoice Header Memo Currency
Invoice Payment Message
Invoice Memo Payment Message
Invoice Lines
Special Fields

Enrolment Memos

Enrolment Fields
Enrolment
Student
School
Group
Main Agent
Commission Agent
Student Contacts
Invoicing Fields
Invoice Header
Invoice Header Invoice Currency
Invoice Header Memo Currency
Invoice Payment Message
Invoice Memo Payment Message
Invoice Lines
Special Fields

Enrolment Credits

Groups

Group Fields
Group
Agent
School
Enrolment Fields
Enrolment
Student
Course Header
Course Booking
Course Booking Course
Accommodation Header
Accommodation Booking
Accommodation Booking Host
Transfer
Sundry
Enrolment Summary Fields
Accommodation Header Summary
Accommodation Booking Summary
Course Header Summary
Course Booking Summary
Transfer Summary
Sundry Summary
Special Fields

Group Invoices

Group Fields
Group
Agent
School
Invoicing Fields
Invoice Header
Invoice Header Currency
Invoice Payment Message
Invoice Memo Payment Message
Group Invoice Lines
Special Fields

Group Proformas

Group Fields
Group
Agent
School
Invoicing Fields
Invoice Header
Invoice Header Currency
Invoice Payment Message
Invoice Memo Payment Message
Group Invoice Lines
Special Fields

Group Credits

Group Fields
Group
Agent
School
Invoicing Fields
Invoice Header
Invoice Header Currency
Invoice Payment Message
Invoice Memo Payment Message
Group Invoice Lines
Special Fields

Schools

School Fields
School
Contact Fields
Contact
Special Fields

Students

Student Fields
Student
Enrolments
Special Fields

Standard Paragraphs
These are available for each master document once they have been set up.
The exceptions to this are the financial documents (invoices, credits, proformas and memos).
Only those standard paragraphs defined for each category may be included in a master document.

Special Fields
These are available on all master documents.

Today's Date (Short)
Today's Date (Long)
User Name
User Title
User Telephone
User Fax
User Email
Company Name
Company Address 1
Company Address 2
Company Town
Company Region
Company Country
Company Address Postal Code
Company Telephone
Company Fax
Company Email

Special fields are self-explanatory.
All other categories list fields in a table. The contents of each field can be easily deduced from its name.
eg. txtSurname in sub-category Student

The first 3 characters of a field name indicate the type of data held.

bln = Boolean (True or False)
cur = Currency (number with 2 decimal places and currency symbol)
dec = Decimal (number with decimal places)
dte = Date/Time
int = Integer (number with no decimal places)
mem = Memo (variable size text fields used for notes)
txt = Text

Record ID Numbers

All fields with names similar to"intXXXXId" are pointers to records in a table, and are not usually required on documents.
Exceptions to this being:

Student ID =intStudentId
Agent ID =intAgentId
Accommodation ID = intHostId

Addresses

Agents, accommodations and students each have 3 addresses.
The field intAddressIDdetermines which is the default

"0" = Main Address
"1" = Statements Address
"2" = Other Address

Invoice Headers

Field txtInvoiceType indicates the document type.

"D" = Invoice
"C" = Credit Note
"P" = Proforma
"PC" = Proforma Credit
"PD" = Proforma Debit

Note:Types "PC" and "PD" only occur when a student has been credited and re-invoiced.

FieldtxtCreditAgainst only applies to credits. It is the number of the invoice being credited.

FieldblnDirect indicates who has been invoiced.

True = Invoices the student
False = Invoices the agent

Invoice Lines

FieldtxtInvoiceType indicates the line type.

"D" = Debit item
"C" = Credit item
"N" = Narrative (comment line)

FieldintDiscountPercent is rounded to the nearest whole number

FieldtxtAmended is set to an asterisk " * " if this line has been amended.