0% found this document useful (0 votes)
183 views440 pages

User Guide

Uploaded by

ra
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
183 views440 pages

User Guide

Uploaded by

ra
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 440

User Guide

MYOB ODBC Direct v8

[MYOMY0801, MYOSG0801]
MYOB Asia Sdn Bhd
MYOB Singapore Pte Ltd

Website: myob.com/developers
© MYOB Technology Pty Ltd 2008
All rights reserved.
Disclaimer
Information supplied by the member companies of the MYOB group (whether in user documentation and other
literature, video or audio material, training courses, websites, advice given by staff, or provided by other means) is
intended only to illustrate general principles, and may not be complete, accurate or free of error. As accounting
standards, taxation requirements, legislation and the circumstances of individual businesses vary widely, this information
cannot be considered authoritative and may not apply to your specific situation. You should obtain competent advice
from a qualified accounting, taxation, information-technology or legal professional before acting on such information. To
the extent permitted by law, member companies of the MYOB group are not liable for any special, consequential, direct
or indirect damages arising from loss of function, profits or data resulting from your application of such information. In
the event that any of the above limitations are found to be unenforceable, the MYOB member company's liability is
limited to the return of any fees or monies paid for the purchase of the product or service.
Trademarks
MYOB, MYOB AccountEdge, MYOB Premier Accounting, MYOB BusinessBasics, MYOB FirstEdge, MYOB Plus, MYOB
ODBC DeveloperPack, MYOB ODBC Direct, AccountEdge, BusinessBasics, ODBC DeveloperPack, ODBC Direct and Small
Business. Smart Solutions. are trademarks, registered trademarks or service marks of MYOB Technology Pty Ltd and their
use is prohibited without prior written consent. Aatrix is a registered trademark of Aatrix Software, Inc.
Adobe, Acrobat, Acrobat Reader, Adobe Reader, PDF and PostScript are trademarks or registered trademarks of Adobe
Systems Incorporated. QuickTime and the QuickTime logo are trademarks or registered trademarks of Apple Computer,
Inc. registered in the USA and other countries, and used under license. American Express and AmEx are registered
trademarks of American Express Company, its subsidiaries and affiliates. Brio Intelligence and Hyperion Intelligence are
trademarks or registered trademarks of Hyperion Solutions Corporation. Intuit, Quicken and QuickBooks are registered
trademarks of Intuit Inc. Mastercard is a registered trademark of MasterCard International Inc. Microsoft, Access,
Entourage, Excel, Internet Explorer, Office, Outlook, Smart Tags, Windows, Windows Server and Word are trademarks or
registered trademarks of Microsoft Corporation in the USA or other countries. vCard is a registered trademark of the
Internet Mail Consortium. VISA is a registered trademark of Visa International Service Association. Other products and
services mentioned may be trademarks, registered trademarks or service marks of their respective owners.

2
Contents

CONTENTS
1 Installation ................................................................................. 9
System Requirements .....................................................................................9
Installing MYOB ODBC Direct .......................................................................10
Registering a company file to enable ODBC access .......................................11
Defining a company file as an ODBC data source .........................................12
Testing an ODBC data source connection .....................................................15
Troubleshooting a connection ......................................................................16
Getting help for MYOB ODBC Direct ............................................................16

2 How to read ............................................................................. 17


Connecting to a company file .......................................................................17
Connection string keywords and supported values .......................................19
User access rights recognition on Read tables ...............................................21
Examples of how to read from an MYOB company file .................................22
Using Microsoft Word to read data ...............................................................25
Using Microsoft Excel to read data ................................................................29
Advanced SQL techniques ............................................................................32
Native commands ........................................................................................34

3 Read tables ............................................................................... 35


Card Information ................................................................................. 36
Cards ............................................................................................................36
Customers ....................................................................................................38
Suppliers ......................................................................................................42
Employees ....................................................................................................45
PersonalCards ...............................................................................................49
CardActivities ...............................................................................................51
Miscellaneous Information .................................................................. 52
DataFileInformation ......................................................................................52
PayrollInformation ........................................................................................57
LinkedAccounts ............................................................................................59
Terms ...........................................................................................................61
Address ........................................................................................................62
Currency ......................................................................................................64
Accounts ......................................................................................................66
AccountActivities ..........................................................................................68
AccountBudgets ...........................................................................................69
PaymentMethods .........................................................................................70
Users ............................................................................................................71
ContactLog ..................................................................................................72
AuditTrail ......................................................................................................73
ImportantDates ............................................................................................74

3
Journal Records and Transactions ....................................................... 75
JournalRecords ............................................................................................. 75
JournalSets ................................................................................................... 77
GeneralJournals ............................................................................................ 79
GeneralJournalLines ...................................................................................... 80
MoneySpent ................................................................................................ 81
MoneySpentLines ......................................................................................... 83
MoneyReceived ............................................................................................ 84
MoneyReceivedLines .................................................................................... 86
Sales ............................................................................................................. 87
SaleLines ...................................................................................................... 90
ServiceSaleLines ........................................................................................... 91
ItemSaleLines ............................................................................................... 92
ProfessionalSaleLines .................................................................................... 94
TimeBillingSaleLines ..................................................................................... 96
MiscSaleLines ............................................................................................... 98
Purchases ..................................................................................................... 99
PurchaseLines ............................................................................................. 102
ServicePurchaseLines .................................................................................. 103
ItemPurchaseLines ...................................................................................... 105
ProfessionalPurchaseLines ........................................................................... 107
MiscPurchaseLines ...................................................................................... 109
CustomerPayments .................................................................................... 110
CustomerPaymentLines .............................................................................. 112
CustomerFinanceCharges ........................................................................... 113
CustomerDiscounts .................................................................................... 115
CustomerDiscountLines .............................................................................. 117
CustomerDeposits ...................................................................................... 118
SupplierPayments ....................................................................................... 120
SupplierPaymentLines ................................................................................ 122
SupplierFinanceCharges ............................................................................. 123
SupplierDiscounts ...................................................................................... 125
SupplierDiscountLines ................................................................................ 127
SupplierDeposits ........................................................................................ 128
SettledCredits ............................................................................................. 130
SettledCreditLines ...................................................................................... 132
CreditRefunds ............................................................................................ 133
SettledDebits .............................................................................................. 135
SettledDebitLines ....................................................................................... 137
DebitRefunds ............................................................................................. 138
InventoryAdjustments ................................................................................ 140
InventoryAdjustmentLines .......................................................................... 141
InventoryTransfers ...................................................................................... 143
InventoryTransferLines ............................................................................... 144
BankDeposits ............................................................................................. 145
BankDepositLines ....................................................................................... 146
TransferMoney ........................................................................................... 147
Recurring Journal Records and Transactions .................................... 148
RecurringMoneySpent ................................................................................ 148
RecurringMoneySpentLines ........................................................................ 152
RecurringMoneyReceived ........................................................................... 153
RecurringMoneyReceivedLines ................................................................... 157
RecurringTransferMoney ............................................................................ 158

4
RecurringGeneralJournals ........................................................................... 161
RecurringGeneralJournalLines ..................................................................... 164
RecurringSales ............................................................................................ 165
RecurringSaleLines ...................................................................................... 170
RecurringServiceSaleLines ........................................................................... 171
RecurringItemSaleLines ............................................................................... 172
RecurringProfessionalSaleLines .................................................................... 174
RecurringTimeBillingSaleLines .................................................................... 176
RecurringMiscSaleLines .............................................................................. 178
RecurringPurchases .................................................................................... 180
RecurringPurchaseLines .............................................................................. 185
RecurringServicePurchaseLines ................................................................... 186
RecurringItemPurchaseLines ....................................................................... 188
RecurringProfessionalPurchaseLines ............................................................ 190
RecurringMiscPurchaseLines ....................................................................... 192
Sales and Purchases Information ...................................................... 194
SalesHistory ................................................................................................ 194
PurchasesHistory ........................................................................................ 195
SalespersonHistory ..................................................................................... 196
Comments ................................................................................................. 197
Methods .................................................................................................... 198
ReferralSources ........................................................................................... 199
Job Information ................................................................................. 200
Jobs ............................................................................................................ 200
JobAccounts ............................................................................................... 201
JobAccountActivities ................................................................................... 202
JobBudgets ................................................................................................. 203
JobJournalRecords ...................................................................................... 204
Category Information........................................................................ 206
Categories .................................................................................................. 206
CategoryAccounts ...................................................................................... 207
CategoryAccountActivities .......................................................................... 208
CategoryJournalRecords ............................................................................. 209
Tax Records........................................................................................ 210
TaxCodes ................................................................................................... 210
TaxCodeConsolidations .............................................................................. 212
TaxInformation ........................................................................................... 213
TaxInformationConsolidations .................................................................... 215
Item and Activity Information........................................................... 217
Items .......................................................................................................... 217
MoveItems ................................................................................................. 220
Locations .................................................................................................... 221
ItemLocations ............................................................................................. 222
ItemPrices .................................................................................................. 223
ItemMovement .......................................................................................... 224
ItemOpeningBalance .................................................................................. 225
ItemSalesHistory ......................................................................................... 226
ItemPurchasesHistory ................................................................................. 227
BuiltItems ................................................................................................... 228
BuildComponents ...................................................................................... 229
NegativeInventory ...................................................................................... 230
Activities ..................................................................................................... 232

5
ActivitySalesHistory .................................................................................... 233
ActivitySlips ................................................................................................ 234
ActivitySlipInvoiced .................................................................................... 236
CustomLists ................................................................................................ 237
Payroll Information Tables ................................................................ 238
Wages ........................................................................................................ 238
EPF ............................................................................................................. 239
CPF ............................................................................................................ 240
CPF Deduction ........................................................................................... 241
Deductions ................................................................................................. 242
EmployerExpenses ...................................................................................... 244
Entitlements ............................................................................................... 246
LinkedEmployees ........................................................................................ 247
WageHourHistory ....................................................................................... 248
WageDollarHistory ..................................................................................... 249
WageDayHistory ........................................................................................ 250
EPFHistory .................................................................................................. 251
SOCSOHistory ............................................................................................ 252
TaxHistory .................................................................................................. 253
CPFHistory ................................................................................................. 254
DeductionHistory ....................................................................................... 255
EmployerExpenseHistory ............................................................................ 256
EntitlementHistory ...................................................................................... 257
EntitlementCarryOver ................................................................................. 258
EntitlementServiceYears .............................................................................. 259
Timesheets ................................................................................................. 260
ContributionTypes ..................................................................................... 261
EmploymentClassifications ......................................................................... 262
EmploymentDepartment ............................................................................ 263
Definitions.......................................................................................... 264
JournalTypes .............................................................................................. 264
TaxCodeTypes ........................................................................................... 265
PriceLevels .................................................................................................. 266
Identifiers ................................................................................................... 267
TermsOfPayment ....................................................................................... 268
CardTypes .................................................................................................. 269
AccountClassification ................................................................................. 270
AccountType .............................................................................................. 271
InvoiceType ................................................................................................ 272
Status ......................................................................................................... 273
BillingRateUsed .......................................................................................... 274
ReconciliationStatus ................................................................................... 275
DepositStatus ............................................................................................. 276
LimitTypes .................................................................................................. 277
PayBasis ..................................................................................................... 278
Frequencies ................................................................................................ 279
BasisTypes .................................................................................................. 280
LinkedWages .............................................................................................. 281
PayrollCategoryTypes ................................................................................. 282
MaritalStatus .............................................................................................. 283
Rounding ................................................................................................... 284
SubAccountTypes ....................................................................................... 285
CashFlowClassifications .............................................................................. 286

6
LineType .................................................................................................... 287
PaymentTypes ............................................................................................ 288
InvoiceDelivery ........................................................................................... 289
AuditTypes ................................................................................................. 290
DayNames ................................................................................................. 291
OrderStatus ................................................................................................ 292
Schedule .................................................................................................... 293
Alerts .......................................................................................................... 294
AlertTypes .................................................................................................. 295
NumberingTypes ....................................................................................... 296
EmploymentCategory ................................................................................ 297
EmploymentStatus ..................................................................................... 298
SOCSOSchemeTypes .................................................................................. 299
TaxTypes .................................................................................................... 300
CPFSchemeTypes ....................................................................................... 301
Password Restrictions ........................................................................ 302

4 How to write ...........................................................................313


Connecting to a data source ...................................................................... 314
Structuring the SQL INSERT command ....................................................... 315
Stored procedures ...................................................................................... 318
Enabling and disabling conditional indexes ................................................ 318
Card identification methods ....................................................................... 319
Terminal Server session detection ............................................................... 319
Licence count incrementing on multi-user products ................................... 320

5 Write tables ............................................................................321


Import Account Budgets ............................................................................ 321
Import Accounts ......................................................................................... 323
Import Activities ......................................................................................... 325
Import Activity Slips ................................................................................... 326
Import Consolidated Tax Codes ................................................................. 327
Import Contact Log .................................................................................... 328
Import Custom List .................................................................................... 329
Import Customer Cards .............................................................................. 330
Import Employee Cards .............................................................................. 335
Import Item Purchases ................................................................................ 341
Import Inventory Adjustments .................................................................... 343
Import Item Sales ....................................................................................... 344
Import Items .............................................................................................. 347
Import Jobs ................................................................................................ 350
Import Miscellaneous Purchases ................................................................. 351
Import Miscellaneous Sales ......................................................................... 353
Import NonConsolidated Tax Codes .......................................................... 355
Import Pay Bills .......................................................................................... 356
Import Personal Cards ................................................................................ 357
Import Professional Purchases ..................................................................... 361
Import Professional Sales ............................................................................ 363
Import Receive Money ............................................................................... 365
Import Receive Payments ........................................................................... 367
Import Service Purchases ............................................................................ 368
Import Service Sales ................................................................................... 370
Import Spend Money ................................................................................. 372

7
Import Supplier Cards ................................................................................ 374
Import Time Billing Sales ............................................................................ 379
Import Timesheets ..................................................................................... 382
Import Transaction Journals ........................................................................ 383
Import General Journals ............................................................................. 384
Password Restrictions ........................................................................ 385

6 ODBC test applications .......................................................... 387


SQL Tester .................................................................................................. 388
BatchTester ................................................................................................ 393

7 Testing error codes ................................................................ 399


Example test code ...................................................................................... 400

8 Errors and warnings tables .................................................... 403


ImportWarnings table ................................................................................ 403
ImportErrors table ...................................................................................... 428
InternalODBCErrors table ........................................................................... 437

8
1 Installation

INSTALLATION
MYOB ODBC Direct is an ODBC driver that makes your MYOB company file information
accessible from other applications. The driver acts as an interface between the MYOB database
and the other applications, interpreting requests to, and providing information from, the
database using ODBC—a standard database access method.
This chapter contains instructions that will help you:
„ install MYOB ODBC Direct
„ define a company file as an ODBC data source
„ register a company file to enable ODBC access
„ test an ODBC data source connection
„ get help for MYOB ODBC Direct.

System Requirements

Before you install MYOB ODBC Direct, ensure your system meets the following requirements:

Recommended System Requirements


„ Pentium IV processor (or equivalent) @ 2GHz, or faster
„ 512 MB or more of RAM
„ 350 MB or more of free hard disk space
„ Windows 2000 Professional or Server (Service Pack 3), Windows XP Home or Professional
(32 bit), Windows Server 2003 Standard Edition (32 bit), or Windows Vista.

Minimum system requirements


„ Pentium III processor (or equivalent) @ 1GHz
„ 256 MB RAM
„ 350 MB of free hard disk space
„ Windows 2000 Professional or Server, Windows XP Home or Professional (32 bit), Windows
Server 2003 (32 bit), or Windows Vista.

NOTE : ODBC Performance The MYOB ODBC Direct driver will only perform as well as the system
it runs on, and the above specifications are only a guide. If performance is lacking, increase the
amount of available RAM or try using a faster processor.

9
Installing MYOB ODBC Direct

When you install your MYOB accounting software, the MYOB ODBC Direct driver is installed
automatically. If you have uninstalled the driver, and need to reinstall it, complete the
following procedure.

Before you install MYOB ODBC Direct When you install your MYOB software, the MYOB
NOTE :
ODBC Direct driver that is installed with it will override earlier versions that exist on the system.

To install MYOB ODBC Direct


1 Log in to Windows as the Administrator or Power User if your computer only allows people
with administrator privileges to install programs.
2 Using Windows Explorer, open your MYOB accounting software’s program folder, and
open the ODBCDirect subfolder.
3 Double-click the setup.exe installer file.
The Welcome window appears.
4 Click Next. The License Agreement window appears.
5 Read the agreement and if you accept it, select the I accept the terms of the license
agreement option.
6 Click Next. The Choose Destination Location window appears.
7 Select the folder into which you want to install the driver. If you want to select:
„ the default folder, continue with step 8 below.

„ a different folder, click Browse, locate and select the desired installation folder, and then
proceed with step 8 below.
8 Click Next. The Select Program Folder window appears.
9 Click Next. The Start Copying Files window appears.
10 To accept the installation settings, click Next. When the installation is complete, the
InstallShield Wizard Complete window appears.
11 Click Finish.

10 CHAPTER 1 INSTALLATION
Registering a company file to enable ODBC
access

Registering a company file for ODBC access will give you full read access.

To register a company file for ODBC access


1 Activate the company file. For instructions on how to activate a company file, see the
documentation that came with your MYOB software.
2 Contact MYOB Customer Service on 1 300 88 0883 (Malaysia) or (65) 6505 6582
(Singapore) to register the company file for ODBC access.
3 Open the company file, go to the Setup menu and choose Company Information.
4 Click the License button and confirm the company file online or call the phone number
that appears in the License window.
You will now have full ODBC read access to the company file.

ODBC write access for developers


If you are a member of the MYOB Developer program, you should have received an ODBC
registration key or key file.
You will need to complete the Developer Access section of the ODBC MYOB Setup
Configuration window for the data source to enable full write access to the company file. See
‘Defining a company file as an ODBC data source’ on page 12 for instructions on how to
access this window.
1 In the Developer Access section, mark the Enable checkbox.
2 In the MYOB Application Path section, click Browse. The Select MYOB Application File
window appears.
3 Navigate to your MYOB program folder, select the MYOB program’s executable file, for
example MYOB.exe or MYOBP.exe, and then click Open.
4 If you selected the sample file as your company file, leave the Key Value field blank. If you
are connecting to a registered company file, click Browse next to the Key Value field. The
Select Key File window appears.
5 Navigate to the folder in which your key file is located and then click OK.
6 Click OK to close the ODBC MYOB Setup Configuration window.

REGISTERING A COMPANY FILE TO ENABLE ODBC ACCESS 11


Defining a company file as an ODBC data
source

To connect to a company file using the MYOB ODBC Direct driver, you must first define the file
as a data source and set up a Data Source Name (DSN). A DSN identifies your company file as
a database to which other ODBC-compatible applications can connect.

To define a company file as an ODBC data source

NOTE : If you are using the 64-bit version of Windows Vista... Do not complete the first two
steps in this procedure. To access the ODBC Data Source Administrator window, you will need to
open the C:\WINDOWS\SysWOW64\ folder on your hard drive and double-click the odbcad32.exe
file. You can then continue with step 3 below.

1 Go to the Start menu and choose Control Panel.


2 Double-click Administrative Tools and then double-click Data Sources (ODBC).
The ODBC Data Source Administrator window appears.

12 CHAPTER 1 INSTALLATION
3 Click Add. The Create New Data Source window appears.

4 Select MYOMY0801 (Malaysia) or MYOSG0801 (Singapore) and then click Finish.


The ODBC MYOB Setup Configuration window appears.

5 In the top section of the ODBC MYOB Setup Configuration window, enter a unique Data
Source Name and a description. (For example, you could enter “Clearwater” as the Data
Source Name and “MYOB company file” as the description.)

DEFINING A COMPANY FILE AS AN ODBC DATA SOURCE 13


6 In the MYOB Company File section of the ODBC MYOB Setup Configuration window,
click Browse. The Select file for ODBC source window appears.

7 Locate and select the MYOB company file you want to connect to.
8 Click Open. The ODBC MYOB Setup Configuration window appears showing the
company file’s path.
9 In the User Name field, enter a user name that you have set up in the company file.

NOTE : To gain full access to the company file... Enter a user name that is not restricted from
accessing any windows or functions in the company file, for example, Administrator.
If you enter a user name that has been restricted from accessing windows and functions, the user
will not be able to access the tables related to those functions via ODBC.

10 If you have set a password for the user name entered in the previous step, enter it in the
Password field. If you have not set a password, leave the field blank.
11 Click OK. The ODBC Data Source Administrator window appears.
12 Click OK.

14 CHAPTER 1 INSTALLATION
Testing an ODBC data source connection

The MYOB ODBC TestConnection utility checks that your MYOB ODBC Direct driver is
installed correctly and that your data source is accessible.

To use the TestConnection utility


1 Using Windows Explorer, go to the MYOBODBCMY8\bin\iwinnt (Malaysia) or
MYOBODBCSG8\bin\iwinnt (Singapore) folder on your hard disk and double-click
TestConnection.exe. The MYOB ODBC TestConnection window appears.

2 Select the DSN option and then select the appropriate name from the Driver Name list.

NOTE :ADO If you are connecting to your company file without a DSN, select the ActiveX Data
Objects (ADO) option, enter the required details and click Test.

3 Select the DSN you created for your MYOB company file from the MYOB Data Source
Name (DSN) drop-down list and then click Test.
If the connection is:
„ successful, the bottom section of the MYOB ODBC TestConnection window will
display details of the company file you have connected to.
„ unsuccessful, see ‘Troubleshooting a connection’, on page 16 for help checking your
installation and data source setup.

TESTING AN ODBC DATA SOURCE CONNECTION 15


Troubleshooting a connection

If you have installed MYOB ODBC Direct and have defined your company file as a data source
but you are unable to connect to your company file, review the following troubleshooting list:
„ Ensure the DSN you created matches the name you selected in the MYOB ODBC
TestConnection utility. To check the DSN, see ‘To define a company file as an ODBC data
source’ on page 12.
„ Ensure the company file that you have defined as a data source is located in the correct
folder. To check the folder path, go to the ODBC Data Source Administration window,
select the DSN you are testing and then click Configure. Click Browse and verify that the
company file is still located in the selected path. If not, locate the file and then click OK.
„ Check the version of the MYOB ODBC Direct driver. You may have upgraded your MYOB
company file and not your MYOB ODBC Direct driver. Locate the latest version of the
MYOB ODBC Direct driver and upgrade your version to this one.
If you are still having problems connecting to your MYOB company file, check with your local
consultant, or if you are installing MYOB ODBC Direct as part of a business solution, you
should contact your provider for support.

Getting help for MYOB ODBC Direct

If you have subscribed to a support plan for your MYOB software, MYOB can help you install
the MYOB ODBC Direct driver and perform a successful test connection to your company file.
Call MYOB Technical Support on 1 300 88 6962 (Malaysia) or (65) 6505 6584 (Singapore) for
installation enquiries. Otherwise, call 1 300 88 0883 (Malaysia) or (65) 6505 6582 (Singapore)
for registration enquiries.
Before you call, ensure you have performed the installation and setup procedures outlined in
this chapter. If you are unable to perform a successful test connection to your MYOB company
file, ensure you have attempted all suggestions listed in ‘Troubleshooting a connection’ above.
When calling MYOB for support, please have your MYOB software serial number on hand and
be close to the computer on which you are installing the MYOB ODBC Direct driver.
Note that MYOB cannot provide support for third-party applications that you want to connect
to your MYOB company file. Contact the supplier or developer of the third-party application if
you require support or training for their product.

16 CHAPTER 1 INSTALLATION
2 How to read

HOW TO READ
Connecting to a company file

You can connect to and read from an MYOB company file with or without configuring an
ODBC User data source for the file. You can also modify the way you connect by using
connection strings. Information about connection strings provided in this section will only be
useful if you have an advanced knowledge of ODBC and connecting to data sources.

Connection strings
Connection strings can be used to override values set in the data source configuration, or to
establish a company file connection without having to set up an ODBC User data source and
Data Source Name (DSN).
A connection string is not required for read operations where a DSN has been set up for an
MYOB company file.

Connection string keywords


Parameters within the connection string, defined by keywords and their assigned values,
override the default ODBC User data source values.
A connection string is a concatenation of a number of keywords and assigned values in the
format [KEYWORD]=[VALUE];
Keyword and assigned value statements are separated using a semicolon, and terminated
using a semicolon.
For further information about connection string keyword values, see ‘Connection string
keywords and supported values’ on page 19.

17
Connecting to a company file that has been defined as an
ODBC data source
By setting up an ODBC User data source for your company file that contains all the ODBC
connection settings, an appropriate SQL tool can use those settings to relay and interpret SQL
queries and the resultant data from an SQL query.
When connecting to a company file for reading purposes only, a connection string is not
required as the default vales within the ODBC User data source will be used.

Connecting to a company file that has not been defined as


an ODBC data source
Using the DRIVER keyword set with the value DRIVER={MYOMY0801} (Malaysia) or
DRIVER={MYOSG0801} (Singapore) you can connect to a company file without the need to
set up an ODBC User data source for the file.
When connecting to a company file for reading purposes without using an ODBC User data
source, the following keywords must be set:
Type=MYOB;
UID=<user ID>;
PWD or PASSWORD=<password>;
DATABASE=<path and name of company file>;
HOST_EXE_PATH=<path and name of MYOB application>;
A number of optional keyword values are available. See ‘Connection string keywords and
supported values’ on page 19 for more information.

An example connection string


An example connection string is shown below:
" Driver={MYOMY0801}; TYPE=MYOB; UID=Administrator; PWD=MyPassword;
DATABASE=C:\Premier\Test.myo; HOST_EXE_PATH=C:\Premier\MYOBP.exe;
NETWORK_PROTOCOL=NONET; DRIVER_COMPLETION=DRIVER_NOPROMPT; ";

18 CHAPTER 2 HOW TO READ


Connection string keywords and supported
values

The following table describes connection string keywords and values that are supported by the
MYOB ODBC Direct driver.

Mandatory keywords
When using a connection without passing a DSN name, certain keywords must be assigned
values.
For a read connection, DRIVER; TYPE; DATABASE; UID; and if there is a password, PWD; must
have assigned values.
For a write connection, HOST_EXE; ACCESS_TYPE; DRIVER; TYPE; DATABASE; UID; KEY; and if
there is a password, PWD; must have assigned values.

Keyword Attribute value description Values Example

READ – Connect with read access READ ACCESS_TYPE=READ_WRITE;


ACCESS_TYPE

only. The default value is READ. READ_WRITE

READ_WRITE – Connect with both


read and write access.

Setting the ACCESS_TYPE to


READ_WRITE will force
NETWORK_PROTOCOL to NoNET

Explicit path, including the filename Value is the location DATABASE=C:\Premier\Test.myo;


DATABASE

where the MYOB company file is of company file


located.

Name of the driver. {MYOMY0801} DRIVER={MYOMY0801};


DRIVER

(Malaysia)
If DRIVER keyword is set, DATABASE
keyword must also be set. or
{MYOSG0801}
(Singapore)

DRIVER_NOPROMPT – Do not DRIVER_NOPROMPT DRIVER_COMPLETION=DRIVER_NOPROMPT;


DRIVER_COMPLETION

prompt the user for additional DRIVER_PROMPT


connection information. Instead an
error will be returned. The default
value is DRIVER_NOPROMPT.

DRIVER_PROMPT – Display the


dialog box prompting the user for
additional connection information.

Use only if a DSN has been set up for Value is the DSN DSN=<DSN name>;
DSN

a data source. If a DSN is set, do not name.


use the DATABASE keyword, as it will
override the DSN value.

CONNECTION STRING KEYWORDS AND SUPPORTED VALUES 19


Keyword Attribute value description Values Example

Explicit path to the location of the Value is the location HOST_EXE_PATH=C:\Premier\MYOBP.exe;


HOST_EXE_PATH

MYOB executable. This executable of MYOB executable


must be compatible with the
company file (that is, same country
code and same version number).

Note: Should the application already


be running, it must be using the
same company file as that specified
in the DATABASE keyword.

Use only if using a valid developer Value is either a key KEY=C:\Premier\123456700000.key;


KEY

key, provided by MYOB as a key file. value or the explicit


The key file contains the 128 bit key path and filename of or
value. a key file containing
the key value. KEY=<key value>;
By using the explicit path and
filename of a key file: OEMs must use the
• the contents of a key file can be key value, not the
changed without needing to path and filename.
recompile an application or
modify a connection string.
• the key value is hidden when
used within a DSN setup.

By using the key value, a key file


does not need to be installed on a
client machine.

Network Protocol to be used while NONET NETWORK_PROTOCOL=NONET;


NETWORK_PROTOCOL

using the MYOB application. NETBIOS


TCPIP
Setting the ACCESS_TYPE to
READ_WRITE will force the
NETWORK_PROTOCOL to NONET

The password corresponding to the Value is the password PWD=MyPassword;


PWD or Password

DSN set up for the user ID (UID), or as set up in the MYOB


an empty string if there is no application or
password.
PWD;
Note: If this value is not NULL, it will
override the password entered when
setting up a DSN.

If this keyword is set each individual 0 SQL_ATTR_AUTOCOMMIT=0;


SQL_ATTR_AUTOCOMMIT

statement is automatically 1 SQL_ATTR_AUTOCOMMIT=1;


committed when it completes
successfully. No explicit transaction
management functions are
necessary. However, the return code
from the function must still be
checked as it is possible for the
implicit transaction to fail.

This keyword value defaults to 0


(manual commit). With manual
commit all executed statements are
included in the same transaction
until calling END TRANSACTION
specifically completes it.

20 CHAPTER 2 HOW TO READ


Keyword Attribute value description Values Example

Connection timeout in seconds.


SQL_LOGIN_TIMEOUT

This value cannot be less than 10


seconds as the MYOB application
needs a significant amount of time to
initialise its Java libraries when it
launches.

If a warning message is issued after TRUE SUPPRESS_WARNINGS=TRUE;


SUPPRESS_WARNINGS

an import statement, the error buffer FALSE


is not automatically cleared. To clear
the buffer, a rollback statement is
required.

If a second import is attempted


without using a rollback statement,
where a warning was received from
the initial import, the second import
will not go ahead.

Setting this keyword to the value of


TRUE (SUPPRESS_WARNINGS=TRUE;)
enables consecutive import warnings
to occur without requiring the
rollback statement to be applied
after each warning.

Set this value to "MYOB". MYOB TYPE=MYOB;


TYPE

A user ID. Note: If this value is not Value is the user ID UID=Administrator;
UID

NULL, it will override the username set up in the MYOB


entered in the DSN. company file

User access rights recognition on Read tables

MYOB ODBC Direct checks the access rights that apply to the supplied username (as set up in
the company file) before access is given to a table.
To ensure a balance between security and performance, access validation is performed on a
table-by-table basis (not field-by-field). If the user is restricted from using a function in their
MYOB software, they will be unable to view the tables related to that area using MYOB ODBC
Direct.

USER ACCESS RIGHTS RECOGNITION ON READ TABLES 21


Examples of how to read from an MYOB
company file

This section provides examples of how to read data from the MYOB Clearwater sample
company file. The first part of this section shows you how to define the sample company file as
a data source and is followed by connection examples using Microsoft Word and Microsoft
Excel.

Defining the Clearwater sample company file as a data


source
The following procedure provides the steps required to create an ODBC User data source for
the Clearwater sample company file, which is installed with your MYOB accounting software.
If you want to access information from a company file that you have set up using your MYOB
accounting software, the company file must first be activated and then registered for ODBC
access.

To define the sample Clearwater company file as a data source

NOTE : If you are using the 64-bit version of Windows Vista... Do not complete the first two
steps in this procedure. To access the ODBC Data Source Administrator window, you will need to
open the C:\WINDOWS\SysWOW64\ folder on your hard drive and double-click the odbcad32.exe
file. You can then continue with step 3 below.

1 Go to the Start menu and choose Control Panel.


2 Double-click Administrative Tools and then double-click Data Sources (ODBC).
The ODBC Data Source Administrator window appears.

22 CHAPTER 2 HOW TO READ


3 Click Add. The Create New Data Source window appears.

4 Select MYOMY0801 (Malaysia) or MYOSG0801 (Singapore) and then click Finish.


The ODBC MYOB Setup Configuration window appears.

5 In the Data Source Name field, type TEST and press TAB.
6 In the Description field, type Test DSN for Clearwater.
7 Click Browse. The Select file for ODBC source window appears.
8 Locate your MYOB accounting software’s program folder.

EXAMPLES OF HOW TO READ FROM AN MYOB COMPANY FILE 23


9 Double-click the Clearwater.myo file. The ODBC MYOB Setup Configuration window
now displays a User Name and Password field in the MYOB Company File section.

10 In the User Name text box, enter a user name that has been set up in the company file.

NOTE : To gain full access to the company file... Enter a user name that is not restricted from
accessing any windows or functions in the company file, for example, Administrator.
If you enter a user name that has been restricted from accessing windows and functions, the user
will not be able to access the tables related to those functions via ODBC.

11 In the Password text box, enter the password for the user name you entered in the
previous step, or if you have not set a password, leave the password field blank.
12 In the Developer Access section, mark the Enable checkbox.
13 Next to MYOB Application Path field, click Browse. The Select MYOB Application File
window appears.
14 Browse to your MYOB software folder, select the application file (for example,
MYOBP.exe) and click Open.
15 As you have selected the sample company file, leave the Key Value field blank. (If you are
connecting to a registered company file, click the Browse button beside the Key Value
field. The Select Key file window appears. Browse to where you installed your key file.)
16 Click OK. The ODBC Data Source Administrator window appears. The DSN you just
created appears in the list of User Data Sources.
17 Click OK to close the ODBC Data Source Administrator window.

24 CHAPTER 2 HOW TO READ


Using Microsoft Word to read data

The following procedure provides the steps required to read data from the Clearwater sample
company file using a DSN, Microsoft Word, Microsoft Query and the MYOB ODBC Direct
driver. It uses Microsoft Word and MS Query to build a list of all employee names and
associated notes from the Clearwater sample company file.

To integrate MYOB data into a Microsoft Word (2000 or 2003) table


1 If you do not have the database toolbar displayed in your Microsoft Word window, go to
the View menu, choose Toolbars, and then Database. The database toolbar appears.

2 Click the Insert Database icon (highlighted above). The Database window appears.

3 Click Get Data. The Select Data Source window appears.

4 Go to the Tools menu and choose MS Query.

USING MICROSOFT WORD TO READ DATA 25


Microsoft Query starts and the Choose Data Source window appears.

5 Select the Data Source Name (DSN) for this query in the Databases tab. For this
procedure, use the Test DSN created earlier. See ‘To define the sample Clearwater
company file as a data source’ on page 22.
6 Ensure that the Use the Query Wizard to create/edit queries option is selected. This
enables you to select individual column fields and to optimise your query.
7 Click OK. The Query Wizard - Choose Columns window appears.

8 Locate the Cards entry and click + to expand the list of fields available for the table.
9 Click Name and click the > button. The Name field appears in the Columns in your query
section.
Use the same method to select the CardTypeID, IsInactive and Notes fields.
10 Click Next. The Query Wizard - Filter Data window appears.

26 CHAPTER 2 HOW TO READ


11 Click Next to skip the filtering option. The Query Wizard - Sort Order window appears.

This window enables you to sort your query in ascending or descending order on any field.
12 Select Name from the Sort By drop-down list.
13 Select the Ascending Order option.
14 Click Next. The Query Wizard - Finish window appears.

This window gives you the option to return your query data back to Microsoft Word, edit
the query or save it as a query for later use. If you save the query, you can avoid manually
building the query every time you need to make some modification to the data range or
data fields associated with this query.
15 Select the View data or edit query in Microsoft Query option.
16 Click Finish. The main MS Query window appears.
17 Go to the Criteria menu and choose Add Criteria. The Add Criteria window appears.

You use this window to define criteria that enable you to limit the data you select in a
query. For this example, you only want to display information about employees. The
following steps show you how to limit the data you select to employee cards. Information
about the card type is stored in the field CardTypeID. You can find more information
about card fields in Chapter 3, ’Read tables,’ starting on page 35.
18 Select CardTypeID from the Field list.

USING MICROSOFT WORD TO READ DATA 27


19 Select equals from the Operator list.
20 Click Values. A list appears, showing all the CardTypeId values for your current query: C, E,
P, and S.
There are two methods for specifying the values for criteria. If you already know what the
available values for a field are, then you can manually type the value or values in the Values
text box. If you are unsure of the values associated with a particular field, click the Values
button to show and select available values.
21 Select E for Employees and click OK.
22 Click Add. The list of records displayed by MS Query is now limited to those with E in the
CardTypeID column. The criteria window is still displayed enabling you to add more
filtering options.
23 Click Close.
24 Go to the File menu and choose Return Data to Microsoft Word. The Microsoft Word
document with the Database window appears.

25 Click Insert Data. The Insert Data window appears

26 Select the All option.


27 Select the Insert data as field option.
28 Click OK.
The query is inserted directly into your Word document using the {DATABASE} field
command. Any changes that occur in the database will automatically appear the next time
you print or manually refresh your document.
You will notice that all the data fields within the table have a light grey background to
indicate they are merged data fields. To see the Microsoft Word field code associated with
the table, right-click the table and select Toggle Field Codes. A field code similar to that
displayed below will replace the table.
{DATABASE \c "DSN=Test;" \s "SELECT Cards.Name, Cards.Notes FROM
MYOB.Cards Cards WHERE (Cards.CardTypeID='E') ORDER BY
Cards.LastName" \l "1" \b "191" \h}
To return to the table view, select Toggle Field Codes again. The table appears with its
original formatting.

28 CHAPTER 2 HOW TO READ


You can refresh the data so that the latest information is brought into your Microsoft Word
file by right-clicking the table and selecting Update Field. The time taken for the update
varies depending on the size and complexity the data query.
You can directly edit SQL queries within the DATABASE field definition.

Using Microsoft Excel to read data

The following procedure provides the steps required to read data from the Clearwater sample
company file using a DSN, Microsoft Excel, Microsoft Query and the MYOB ODBC Direct
driver. It uses Microsoft Excel and MS Query to build a list of all employee names and
associated notes from the Clearwater sample company file.
This example is an Excel equivalent of the previous Word example.

To integrate MYOB data into a Microsoft Excel (2000 or 2003) table


1 In a new Excel workbook, click cell A1.
2 Go to the Data menu, choose Import External Data, and then choose New Database
Query. Microsoft Query starts and the Choose Data Source window appears.

3 Select the Data Source Name (DSN) for this query in the Databases tab. For this
procedure, use the Test DSN created earlier. See ‘To define the sample Clearwater
company file as a data source’ on page 22.
4 Ensure that the Use the Query Wizard to create/edit queries option is selected. This
enables you to select individual column fields and optimise your query.
5 Click OK. The Query Wizard - Choose Columns window appears.

USING MICROSOFT EXCEL TO READ DATA 29


6 Locate the Cards entry and click + to expand the list of fields available for the table.

7 Click Name and click the > button. The Name field appears in the Columns in your query
list.

Use the same method to select the CardTypeID, IsInactive and Notes fields.
8 Click Next. The Query Wizard - Filter Data window appears.

9 Click Next. The Query Wizard - Sort Order window appears.

This window enables you to sort your query in ascending or descending order on any field.
10 Select Name from the Sort by list.
11 Select the Ascending option.

30 CHAPTER 2 HOW TO READ


12 Click Next. The Query Wizard - Finish window appears.

This window gives you the options to return your query data to Microsoft Excel, edit the
query or save it as a query for later use. If you save the query you can avoid manually
building the query every time you need to make some modification to the data range or
data fields associated with this query.
13 Select the View data or edit query in MS Query option.
14 Click Finish. The main MS Query window appears.
15 Go to the Criteria menu and choose Add Criteria. The Add Criteria window appears.

You use this window to define criteria that enable you to limit the data you select in a
query. For this example, you only want to display information about employees. The
following steps show you how to limit the data you select to employee cards. Information
about the card type is stored in the field CardTypeID. Find out more about card fields in
Chapter 3, ’Read tables,’ starting on page 35.
16 Select CardTypeID from the Field list.
17 Select equals from the Operator list.
18 Click Values. A list appears, showing all the CardTypeId values for your query: C, E, P, S.
There are two methods for specifying the values for criteria. If you already know what the
available values for a field are, then you can manually type the value or values in the Values
text box. If you are unsure of the values associated with a particular field, click the Values
button to show and select available values.
19 Select E for Employees and click OK.

USING MICROSOFT EXCEL TO READ DATA 31


20 Click Add. The list of records displayed by MS Query is now limited to those with E in the
CardTypeID column.
21 Click Close. Go to the File menu and choose Return data to Microsoft Excel. The Import
Data window appears.

22 Click OK. The results of the query are inserted into the Excel spreadsheet.

Advanced SQL techniques

Indexed fields
The MYOB ODBC Direct driver provides indexes with a number of fields. Using indexed fields
can reduce the amount of time a query takes to complete. Each indexed field is marked with
‘***’ in Chapter 3, ’Read tables,’ starting on page 35.

Query building
When building queries, note that:
„ Only left and equal joins are supported; right joins are not supported.
„ Nested queries are not supported.

32 CHAPTER 2 HOW TO READ


Scalar functions with MYOB ODBC Direct
The MYOB ODBC Direct driver supports a number of SQL Scalar functions. Scalar functions
enable you to create refined SQL queries. Refer to the following table for information about
the scalar functions that MYOB ODBC Direct supports.

Scalar Function Example

String Functions

ascii Select * from customers where ascii(left(lastname, 1)) = 119 - returns all customers
where the lastname begins with 'w'

char Select * from customers where left(lastname, 1) = char(119) - returns all customers
where the lastname begins with 'w'

concat Select * from customers where concat(lastname, firstname) = 'WrightTim'

lcase and lower Select * from customers where lower(lastname) = 'johnson'

left Select * from customers where left(lastname, 3) = 'joh'

length Select * from customers where length(lastname) > 10

locate Select * from customers where locate('Tim', lastname, 1) = 7 - returns all customers
where the character sequence 'Tim' begins at the seventh position of the lastname
field.

ltrim Select * from customers where ltrim(lastname) = 'johnson' - return all customers with
lastname = 'johnson' or ' johnson'

repeat Select * from customers where lastname = repeat('A', 3) - returns all customers from
the customers table where the lastname = 'AAA'

rtrim Select * from customers where rtrim(lastname) = 'johnson' - return all customers with
lastname = 'johnson' or 'johnson '

ucase and upper Select * from customers where upper(lastname) = 'JOHNSON'

Date Functions

curdate Select * from employees where startdate = curdate() - return all employees that
started today

dayname Select * from employees where dayname(startdate) = 'Thursday' - returns all


employees where the employee started on a Thursday

dayofmonth Select * from employees where dayofmonth(startdate) = 11 - returns all employees


where the employee started on the 11th day of the month

monthname Select * from employees where monthname(startdate) = 'February' - returns all


employees where the employee started in the month of February

year Select * from employees where year(startdate) = 2000 - returns all employees where
the employee started in the year 2000

Numeric The Mod function is the only numeric function that the driver supports
Functions

ADVANCED SQL TECHNIQUES 33


Native commands

Native commands determine how the ODBC driver identifies duplicate records when
importing information in the MYOB company file. The identification method you can use
depends on the import routine in the MYOB application.
Note that all native commands are executed as text. For example, when using the “ADD
DUPLICATES” command: myobConnection.ExecuteNonQuery(Command)
The MYOB ODBC Direct driver supports the following dynamic native commands.

Command Read or Write Description

ADD DUPLICATES * Write This command enables imported records that are
duplicates to be added.

DELETE DUPLICATES * Write This command enables imported records that are
duplicates to be deleted.

END TRANSACTION Write This command is used as a transaction break to indicate


to the driver that all the lines of the current transaction
set have been processed and that any subsequent
transaction lines belong to the next transaction set.

IDENTIFYBY CARD * Write This command enables a card to be identified by the


content of the Co./Last Name, Card ID and Card
Record ID fields.

IDENTIFYBY CARDID Write This command enables a card to be identified by the


content of the Card ID field.

IDENTIFYBY CARDNAME * Write This command enables a card to be identified by the


content of the Co./Last Name field.

IDENTIFYBY RECORDID Write This command enables a card to be identified by the


content of the Record ID field.

NO CONDINDX * Read This command disables index searches that are


conditional during the execution of a query.

REJECT DUPLICATES * Write This command enables imported records that are
duplicates to be rejected.

UPDATE DUPLICATES * Write This command enables imported records that are
duplicates to be updated.

USE CONDINDX * Read This command enables index searches that are
conditional to be used during the execution of a query.

* These native commands remain active until disabled or replaced with another value.

34 CHAPTER 2 HOW TO READ


3 Read tables

READ TABLES
This chapter provides a listing of MYOB accounting software read tables and their record
structure.
Within each table:
„ The format and type of each record field is given.
„ Foreign keys are highlighted in blue and the source tables that each foreign key references
are listed below each read table.
„ Indexed records are marked with “***”
„ Conditional indexed records are marked with “^^^”. A conditional index excludes null
records and can be deactivated when connecting to the database or when performing
WHERE clauses on the particular field. By default, all conditional indexes are active.

35
Card Information

Cards

Overview
The Cards table contains limited information that is generic to all card types. It contains a CardType so the user can
determine what other card-related tables they need to use in their query if they need more details. The
CardRecordID is essentially a foreign key to the CustomerID, SupplierID, EmployeeID and PersonalCardID in their
respective tables.
All address, phone, email, salutation and contact information relevant to the card is stored within the Address table.
Up to 5 different combinations of address, phone, e-mail, salutation and contact can be recorded against each card.
The storage of address information within an external table will reduce the size of the Card Information tables
significantly and greatly improve efficiency when reports are produced on address variables.

Record Field Information


Field Name Type Format Description

*** CardRecordID Integer 10xN Unique Identifier.

CardTypeID Text 1xAN CardTypeID (CardTypes) of the record containing the full card type
definition.
C = (Customer)
S = (Supplier)
E = (Employee)
P = (Personal)

*** CardIdentification Text 16xAN User defined unique CardID.

*** Name Text 52xAN If the card is a company: company name. If the card is an individual: last
name followed by a comma, a space and the first name.

LastName Text 52xAN The company name if the card record represents a company, otherwise the
individual’s last name.

FirstName Text 20xAN Blank if the card record represents a company, otherwise the first name of
the individual.

ChangeControl Text 10xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

IsIndividual Text 1xAN Whether the card record represents an individual.


Company = ‘N’, Individual = ‘Y’.

IsInactive Text 10xN Whether the company or individual represented by the card record is
inactive. Active = ‘N’, Inactive = ‘Y’.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency information
for this card.

Notes Text 255xAN Notes for this card.

36 CHAPTER 3 READ TABLES


Field Name Type Format Description

IdentifierID Text 26xAN The IdentifierID (Identifiers) of the record(s) containing the full identifier
description. Mirrors information reported within the Identifiers field.
Multiple foreign keys will exist within this field if more than one identifier is
attached to this card.

^^^ CustomList1ID Integer 10xN The CustomListID (CustomList) of the record containing the Custom List 1
selection for this card.

^^^ CustomList2ID Integer 10xN The CustomListID (CustomList) of the record containing the Custom List 2
selection for this card.

^^^ CustomList3ID Integer 10xN The CustomListID (CustomList) of the record containing the Custom List 3
selection for this card.

CustomField1 Text 30xAN Custom Field 1 text attached to this card.

CustomField2 Text 30xAN Custom Field 2 text attached to this card.

CustomField3 Text 30xAN Custom Field 3 text attached to this card.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing the full
Payment Notification Delivery Status assigned to Spend Money, Pay Bill
and Credit Refund transactions when this card is applied to the
transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

Foreign Keys Table sourced

CardTypeID CardTypes

CurrencyID Currency

IdentifierID Identifiers

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

PaymentDeliveryID InvoiceDelivery

CARDS 37
Customers

Record Field Information


Field Name Type Format Description

*** CustomerID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID of the record within the Card table
containing information about the same card.

*** CardIdentification Text 16xAN User defined unique CardID.

*** Name Text 52xAN If the card is a company: company name.


If the card is an individual: last name followed by a
comma, a space and the first name.

LastName Text 52xAN The company name if the card record represents a
company, otherwise the individual’s last name.

FirstName Text 20xAN Blank if the card record represents a company, otherwise
the first name of the individual.

IsIndividual Text 1xAN Whether the card record represents an individual.


Company = ‘N’, Individual = ‘Y’.

IsInactive Text 1xAN Whether the company or individual represented by the


card record is inactive. Active = ‘N’, Inactive = ‘Y’.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this card.

Picture Text 255xAN Name of bitmap attached to card.

Notes Text 255xAN Notes for this card.

IdentifierID Text 26xAN Mirrors information reported within the Identifiers field.
Multiple foreign keys will exist within this field if more than
one identifier is attached to this card.

^^^ CustomList1ID Integer 10xN The CustomListID of the record containing the Custom
List 1 selection for this card.

^^^ CustomList2ID Integer 10xN The CustomListID of the record containing the Custom
List 2 selection for this card.

^^^ CustomList3ID Integer 10xN The CustomListID of the record containing the Custom
List 3 selection for this card.

CustomField1 Text 30xAN Custom Field 1 text attached to this card.

CustomField2 Text 30xAN Custom Field 2 text attached to this card.

CustomField3 Text 30xAN Custom Field 3 text attached to this card.

*** TermsID Integer 10xN The TermsID of the record containing credit terms for this
customer.

PriceLevelID Text 3xAN PriceLevelID of the record containing the full price level
definition.

38 CHAPTER 3 READ TABLES


Field Name Type Format Description

TaxIDNumber Text 19xAN Tax ID number.

*** TaxCodeID Integer 10xN TaxCodeID of the record containing the tax code for this
card.

*** FreightTaxCodeID Integer 10xN TaxCodeID of the record containing the default Freight
Tax Code of this card.

UseCustomerTaxCode Text 1xA Use the customer’s Tax code.


Deselected = ‘N’, Selected = ‘Y’

CreditLimit Double 7.2xN The customer’s credit limit.

OnHold Text 1xAN Indicates if customer is on credit hold. N = No, Y= Yes.

VolumeDiscount Double 99.99% Volume customer discount.

CurrentBalance Double 13.2xN A/R balance.

TotalDeposits Double 13.2xN Deposits total.

CustomerSince Date Formatted by the Date entered within Customer Since field.
operating system

LastSaleDate Date Formatted by the The most recent sale date recorded within the data file for
operating system this customer.

LastPaymentDate Date Formatted by the The most recent customer payment within the data file for
operating system this customer.

TotalReceivableDays Integer 10xN Total days until final payment received for all closed sale
invoices.

TotalPaidInvoices Integer 9xN Total number of closed sale invoices for this customer.

HighestInvoiceAmount Double 13.2xN The highest $ value sales invoice recorded against this
customers card.

HighestReceivableAmount Double 13.2xN The highest $ value account receivable balance assigned
to this customer’s card.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID of the record containing the
default Method of Payment.

PaymentCardNumber Text 25xAN Default Card Number.

PaymentNameOnCard Text 50xAN Default Name on Card.

PaymentExpiryDate Text mm/yy Default Expiry Date.

PaymentNotes Text 255xAN Default Payment Notes.

HourlyBillingRate Double 11.4xN The customer’s Hourly Billing Rate.

SaleLayoutID Text 1xAN InvoiceTypeID (InvoiceType) of the record containing the


full default Sale Layout definition.
N = No Default
S = Service
I = Item
P = Professional
T = Time Billing
M = Miscellaneous

PrintedForm Text 34xAN Named form selected as default printed form.

CUSTOMERS 39
Field Name Type Format Description

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record


containing the full default Invoice Delivery method.
P = To be printed
E = To be emailed
B = To be printed and emailed
A = Already printed or sent

^^^ IncomeAccountID Integer 10xN The AccountID of the record containing account
information for the default Income Account.

ReceiptMemo Text 255xAN Default Receipt Memo.

^^^ SalespersonID Integer 10xN The CardRecordID or EmployeeID of the record


containing the default Salesperson.

^^^ SaleCommentID Integer 10xN The CommentID of the record containing the default Sale
Comment.

^^^ ShippingMethodID Integer 10xN The ShippingMethodID of the record containing the
default shipping method.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record


containing the full Payment Notification Delivery Status
assigned to Spend Money and Credit Refund transactions
when this customer is applied to the transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

ChangeControl Text 15xAN Number used to control change within the record. Value is
incremented whenever the record is updated.

Foreign Keys Table sourced

CardRecordID Cards

CurrencyID Currency

IdentifierID Identifiers

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

TermsID Terms

TaxCodeID TaxCodes

MethodOfPaymentID PaymentMethods

CodeID TaxCodes

SaleLayoutID InvoiceType

PriceLevelID PriceLevels

40 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

SalespersonID Cards
Employees

SaleCommentID Comments

InvoiceDeliveryID InvoiceDelivery

IncomeAccountID Accounts

ShippingMethodID Methods

PaymentDeliveryID InvoiceDelivery

CUSTOMERS 41
Suppliers

Record Field Information


Field Name Type Format Description

*** SupplierID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) of the record within the Cards
table containing information about the same card.

*** CardIdentification Text 16xAN User defined unique CardID.

*** Name Text 52xAN If the card is a company: company name.


If the card is an individual: last name followed by a comma,
a space and the first name.

LastName Text 52xAN The company name if card is a company, or last name if
card is an individual.

FirstName Text 20xAN Blank if the card is a company, or first name if card is an
individual.

IsIndividual Text 1xAN Whether the card record represents an individual. Company
= ‘N’, Individual = ‘Y’.

IsInactive Text 1xAN Whether the company or individual represented by the card
record is inactive. Active = ‘N’, Inactive = ‘Y’.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this card.

Picture Text 255xAN Name of bitmap file attached to this card.


The picture will be stored within the Graphics sub-folder.

Notes Text 255xAN Notes for this card.

IdentifierID Text 26xAN The IdentifierID (Identifiers) of the record(s) containing the
full identifier description.

^^^ CustomList1ID Integer 10xN The CustomListID (CustomLists) of the record containing
the Custom List 1 selection for this card.

^^^ CustomList2ID Integer 10xN The CustomListID (CustomLists) of the record containing
the Custom List 2 selection for this card.

^^^ CustomList3ID Integer 10xN The CustomListID (CustomLists) of the record containing
the Custom List 2 selection for this card.

CustomField1 Text 30xAN Custom Field 1 text attached to this card.

CustomField2 Text 30xAN Custom Field 2 text attached to this card.

CustomField3 Text 30xAN Custom Field 3 text attached to this card.

*** TermsID Integer 10xN The TermsID (Terms) of the record containing credit terms
for this supplier.

TaxIDNumber Text 19xAN Tax ID number.

42 CHAPTER 3 READ TABLES


Field Name Type Format Description

*** TaxCodeID Integer 10xN TaxCodeID (Tax Codes) of the record containing the tax
code for this card.

*** FreightTaxCodeID Integer 10xN TaxCodeID of the record containing the default Freight Tax
Code of this card.

UseSupplierTaxCode Text 1xA Yes/No flag. Y=Yes, N=No.

CreditLimit Double 7.2xN Credit limit.

VolumeDiscount Double 99.99% Volume supplier discount.

CurrentBalance Double 13.2xN A/P balance.

TotalDeposits Double 13.2xN Deposits balance. Total payments made.

SupplierSince Date Formatted by the Date entered within SupplierSince field.


operating system

LastPuchaseDate Date Formatted by the Most recent purchase date recorded within the data file for
operating system this supplier.

LastPaymentDate Date Formatted by the Most recent payment date recorded within the data file for
operating system this supplier.

TotalPayableDays Integer 10xN Total days until final payment made for all closed purchase
orders.

TotalPaidPurchases Integer 9xN Total number of closed purchase orders for this supplier.

HighestPurchaseAmount Double 13.2xN The highest dollar value purchase order recorded against
this supplier’s card.

HighestPayableAmount Double 13.2xN The highest dollar value account payable balance assigned
to this supplier’s card.

EstimatedCostPerHour Double 13.2xN The estimated cost per hour of providing this supplier’s
services when generating an activity slip.

HourlyBillingRate Double 13.2xN The supplier’s hourly billing rate.

PurchaseLayoutID Text 1xAN InvoiceTypeID (InvoiceType) of the record containing the


full default Purchase Layout definition.

PrintedForm Text 34xAN Name of form selected as default Printed Form.

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record


containing the full default Invoice Delivery method.

^^^ ExpenseAccountID Integer 10xN The AccountID (Accounts) of the record containing account
information for the default Expense Account.

PaymentMemo Text 255xAN Default Payment memo.

^^^ PurchaseCommentID Integer 10xN The CommentID (Comments) of the record containing the
default Purchase Comment.

^^^ ShippingMethodID Integer 10xN The ShippingMethodID (ShippingMethods) of the record


containing the default shipping method.

SUPPLIERS 43
Field Name Type Format Description

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record


containing the full Payment Notification Delivery Status
assigned to Spend Money and Pay Bill transactions when
this supplier is applied to the transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

ChangeControl Integer 15xN Number used to control change within the record. Value is
incremented whenever the record is updated.

Foreign Keys Table sourced

CardRecordID Cards

CurrencyID Currency

IdentifierID Identifiers

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

TermsID Terms

TaxCodeID TaxCodes

PurchaseLayoutID InvoiceType

PurchaseCommentID Comments

InvoiceDeliveryID InvoiceDelivery

ExpenseAccountID Accounts

ShippingMethodID Methods

PaymentDeliveryID InvoiceDelivery

44 CHAPTER 3 READ TABLES


Employees

Record Field Information


Field Name Type Format Description

*** EmployeeID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The card record ID of the record within the Card table
containing information about the same card.

*** CardIdentification Text 16xAN User defined unique card ID.

*** Name Text 52xAN If the card is a company: company name. If the card is an
individual: last name followed by a comma, a space and the first
name.

LastName Text 52xAN The company name if the card record represents a company,
otherwise the individual’s last name.

FirstName Text 20xAN Blank if the card record represents a company, otherwise the first
name of the individual.

Designation Text 1xAN Whether the card record represents an individual.


Company = ‘N’, Individual = ‘Y’.

IsInactive Text 1xAN Whether the company or individual represented by the card
record is inactive. Active = ‘N’, Inactive = ‘Y’.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this card.

Gender Text 1xA The employee’s gender/sex. M or F.

Picture Text 255xAN Name of the bitmap file attached to this card.

Notes Text 255xAN Notes for this card.

IdentifierID Text 26xAN The IdentifierID (Identifiers) of the record(s) containing the full
identifier description.

^^^ CustomList1ID Integer 10xN The CustomListID (CustomList) of the record containing the
Custom List 1 selection for this card.

^^^ CustomList2ID Integer 10xN The CustomListID (CustomList) of the record containing the
Custom List 2 selection for this card.

^^^ CustomList3ID Integer 10xN The CustomListID (CustomList) of the record containing the
Custom List 3 selection for this card.

CustomField1 Text 30xAN Custom Field 1 text attached to this card.

CustomField2 Text 30xAN Custom Field 2 text attached to this card.

CustomField3 Text 30xAN Custom Field 3 text attached to this card.

PaymentTypeID Text 1xA PaymentTypeID of the record containing the full definition of
the default Payment Method assigned to the employee card.

BankAccountNumber Text 20xAN Bank Account Number.

BankAccountName Text 32xAN Bank Account Name.

EMPLOYEES 45
Field Name Type Format Description

HourlyBillingRate Double 13.2xN The employee’s hourly billing rate.

StatementText Text 18xAN The default Statement Text value assigned when electronic
disbursements are created.

EstimatedCostPerHour Double 13.2xN The estimated cost per hour for providing this employee’s
services when generating an activity slip.

EmploymentCategoryID Text 1xA EmploymentCategoryID (EmploymentCategory) of the record


containing the full Employment Category definition.
P = Permanent
T = Temporary
C = Contract

EmploymentStatusID Text 1xA EmploymentStatusID (EmploymentStatus) of the record


containing the full Employment Status definition.
F = Full Time
P = Part Time
O = Other
C = Casual

StartDate Date Formatted by the Date the employee began employment.


operating system

TerminationDate Date Formatted by the Date the employee’s employment was terminated.
operating system

TerminationReason Text 45xAN The reason why the employee was terminated.

WagesExpenseAccountID Integer 5xN The AccountID of the record containing account information for
the Wages Expense Account.

PayBasisID Text 1xA PayBasisID of the record containing the full Pay Basis definition.

BasePay Double 13.2xN If Pay Basis is Salary, this field contains the employee’s monthly
Base Pay. If Pay Basis is Hourly, this field contains the employee’s
Hourly Base Pay.
The value of this field is always in local currency.

PayFrequencyID Text 1xA The FrequencyID of the record containing the full Pay Frequency
definition.

TaxFileNumber Text 20xAN Employee’s Tax File Number.

DateOfBirth Date Formatted by the The employee’s date of birth.


operating system

HoursInFullTimeWorkWeek Double 3.3xN The number of hours in the pay period.

DefaultWagesID Integer 15xN The WageID (Wages) containing full details of the default wage
category assigned when this employee is used with an activity
slip.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing the


full Payment Notification Delivery Status assigned to Spend
Money transactions when this employee is applied to the
transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

46 CHAPTER 3 READ TABLES


Field Name Type Format Description

PaySlipDelType Text 1xA The method by which the payslip will be sent.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

Passport Text 9xAN

MaritalStatus Text 1xA

DepartmentID Text 10xN

PositionID Text 10xAN

DailyRate Double 13.2xN

HourlyRate Double 13.2xN

WorkHourInDay Double 2.2xN

IsTaxBorneByEmployer Text 1xA (Singapore) Y=Yes, N=No

ResidentialStatus Text 20xAN The Employee Residential Status value can be:
• Citizen
• Permanent Resident
• Foreigner

Religion Text 15xAN The employee’s religion

Race Text 15xAN The employee’s race

Nationality Text 15xAN The employee’s nationality

OfficialLastDay Text 10xAN The employee’s official last date

NewICNo Integer 12xN (Malaysia) New Identity number

OldICNo Text 15xAN (Malaysia) Old Identity number

ASBNo Text 15xAN (Malaysia) The employee’s Amanah Saham number

LUTHNo Text 25xAN (Malaysia) The employee’s Tabung Haji number

SOCSONo Text 20xAN (Malaysia) The employee’s SOCSO number

SOCSOSchemeID Text 1xAN (Malaysia) The employee’s SOCSO scheme:


0=Not Applicable
1=1st Category
2 =2nd Category

EPFNo Text 20xAN (Malaysia) The employee’s Employment Provident Fund number

LHDNMBranch Text 30xAN (Malaysia) The employee’s Tax branch code

TaxTypeID Text 1xAN (Malaysia) The employee’s tax category:


0=Not Taxable
1=Category 1
2=Category 2
3=Category 3
4=Full Rate

NoOfChildRelief Double 2.2xN (Malaysia) Number of Child Relief for the tax calculation

CountryCode Text 2xA (Malaysia) Country code for tax statutory forms

EMPLOYEES 47
Field Name Type Format Description

ICNo Text 12xAN (Singapore) Identity number for Singaporean

FINNo Text 15xAN (Singapore) Identity number for non-Singaporean

PRNo Text 15xAN (Singapore) The employee’s Permanent Resident Number

PRStartDate Text 10xAN (Singapore) The employee’s Permanent Resident Start Date

CPFSchemeID Text 1xAN (Singapore) The employee’s CPF scheme:


0=Not Applicable
1=Singaporean
2=Graduated PR 1st Year
3=Graduated PR 2nd Year
4=Full and Graduated PR 1st Year
5=Full and Graduated PR 2nd Year

CPFNumber Text 20xAN (Singapore) The employee’s CPF number

ChangeControl Text 20xAN Number used to control change within the record. Value is
incremented whenever the record is updated.

Foreign Keys Table sourced

CardRecordID Cards

CurrencyID Currency

IdentifierID Identifiers

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

EmploymentCategoryID EmploymentCategory

Employment StatusID EmploymentStatus

WagesExpenseAccountID Accounts

PayBasisID PayBasis

PayFrequencyID Frequencies

DefaultWagesID Wages

PaymentDeliveryID InvoiceDelivery

PaySlipDelType InvoiceDelivery

DepartmentID EmploymentDepartment

PositionID EmploymentClassifications

SOCSOSchemeID SOCSOSchemeTypes

TaxTypeID TaxTypes

CPFSchemeID CPFSchemeTypes

48 CHAPTER 3 READ TABLES


PersonalCards

Record Field Information


Field Name Type Format Description

*** PersonalCardID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) of the record within the cards table containing
information about the same card.

*** CardIdentification Text 16xAN User defined unique CardID.

*** Name Text 52xAN If the card is a company: company name. If the card is an individual: last
name followed by a comma, a space and the first name.

LastName Text 52xAN The company name if card is a company, or last name if card is an individual.

FirstName Text 20xAN Blank if the card is a company, or first name if card is an individual.

ChangeControl Text 10xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

IsIndividual Text 1xAN Whether the card record represents an individual.


Company = ‘N’, Individual = ‘Y’.

IsInactive Text 1xAN Whether the company or individual represented by the card record is
inactive. Active = ‘N’, Inactive = ‘Y’.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency information
for this card.

Notes Text 255xAN Notes for this card.

IdentifierID Text 26xAN The IdentifierID (Identifiers) of the record(s) containing the full identifier
description.

^^^ CustomList1ID Integer 10xN The CustomListID (CustomLists) of the record containing the Custom List 1
selection for this card.

^^^ CustomList2ID Integer 10xN The CustomListID (CustomLists) of the record containing the Custom List 2
selection for this card.

^^^ CustomList3ID Integer 10xN The CustomListID (CustomLists) of the record containing the Custom List 2
selection for this card.

CustomField1 Text 30xAN Custom Field 1 text attached to this card.

CustomField2 Text 30xAN Custom Field 2 text attached to this card.

CustomField3 Text 30xAN Custom Field 3 text attached to this card.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing the full
Payment Notification Delivery Status assigned to Spend Money transactions
when this personal card is applied to the transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

Picture Text 255xAN Name of bitmap file attached to this card.

PERSONALCARDS 49
Foreign Keys Table sourced

CardRecordID Cards

CurrencyID Currency

IdentifierID Identifiers

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

PaymentDeliveryID InvoiceDelivery

50 CHAPTER 3 READ TABLES


CardActivities

Overview
The CardActivities table holds information regarding sales activity for customers, purchase activity for suppliers and
salesperson history for employees. Activity history is stored for the current financial year, next financial year and the
five financial years immediately preceding the current financial year.

Record Field Information


Field Name Type Format Description

CardActivityID Integer 12xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) or SupplierID
(Suppliers) or EmployeeID (Employees) of the card record to that this
historical information applies.

FinancialYear Integer 4xN Financial year in which this activity occurred.

Period Integer 2xN The period of the financial year in which this activity occurred.

DollarsSold Double 13.2xN Net activity within profit & loss accounts or net movement within
balance sheet accounts.

Foreign Keys Table sourced Notes

CardRecordID Cards Activity could be the activity of a


Customers customer, supplier, employee or
Suppliers personal card. The Cards table
Employees contains all cards so, therefore, the
CardRecordID will always have a
PersonalCards
match in the Cards table

CARDACTIVITIES 51
Miscellaneous Information

DataFileInformation

Overview
The DataFileInformation table presents generic information stored within the Company Information and Bank
Information windows and the internal data file itself. The DataFileInformation table does not have a primary key.

Record Field Information


Field Name Type Format Description

CompanyName Text 40xAN Company name as entered within the Company


Information window.

Address Text 255xAN Address as entered within the Company Information


window.

Phone Text 20xAN Phone number as entered within the Company


Information window.

FaxNumber Text 20xAN Fax number as entered within the Company


Information window.

IRDNumber Text 255xAN I.R.D. No. as entered within the Company Information
window

ServiceTaxNumber Text 255xAN Service Tax No. as entered within the Company
Information window

CompanyNumber Text 19xAN Company No. / BR Number as entered within the


Company Information window

SalesTaxNumber Text 19xAN Sales Tax No. / Tax File Number as entered within the
Company Information window

Email Text 255xAN Email address as entered within the Company


Information window.

CurrentFinancialYear Integer 4xN Current financial year as displayed within the Company
Information window.

LastMonthInFinancialYear Integer 2xN Last month in financial year as displayed in the


Company Information window.

ConversionDate Date Formatted by the The conversion date of this file.


operating system

PeriodsPerYear Integer 2xN The accounting periods per year as displayed in the
company information window.

52 CHAPTER 3 READ TABLES


Field Name Type Format Description

LastPurgeDate Date Formatted by the The date representing the point at that transactions on
operating system or after this date have not been purged. Closed
transactions before this date may have been purged
from the data file.

LastBackupDate Date Formatted by the The session date that the file was last backed up.
operating system

DatabaseVersion Text 99.99.99 MYOB data file version number.

DataFileCountry Text 3xAN The country for which this data file is meant.
If Australia = AUS
If UK = UK
If New Zealand = NZ
If United States = US
If Malaysia = MY
If Hong Kong = HK
If International = INT
If Philippines = PH
If Singapore = SG

DriverBuildNumber Integer 5xN The driver build number, can be used for checking the
driver version number.

SerialNumber Integer 12xN The company file Serial Number as displayed within the
Company Information window.

UseRetailManagerLink Text 1xAN Y/N flag used to determine if the company file uses the
RetailManager Link.

UseMultipleCurrencies Text 1xAN Y/N flag used to determine if multiple currencies are
used in the company file.

UseCategories Text 1xAN Y/N flag used to determine if category tracking has
been turned on.

CategoriesRequired Text 1xAN Y/N flag used to determine if a category allocation is


required for every transaction.

UseDailyAgeing Text 1xAN Y/N flag used to determine if debtors are aged daily or
monthly.

FirstAgeingPeriod Integer 3xN Number of days in the first daily ageing period.

SecondAgeingPeriod Integer 3xN Number of days in the second daily ageing period.

ThirdAgeingPeriod Integer 3xN Number of days in the third daily ageing period.

IdentifyAgeByName Text 1xAN Y/N flag indicates if the monthly ageing periods are
identified by the month names or the number of
months overdue.

LockPeriodIsActive Text 1xAN Y/N flag indicates if the Locked Periods preference is
active.

LockPeriodDate Date Formatted by the The first date from which transactions can be entered
operating system or imported into the company file.

LockThirteenthPeriod Text 1xAN Y/N flag indicates if the Locked Period date is the
thirteenth period.

DATAFILEINFORMATION 53
Field Name Type Format Description

DefaultCustomerTermsID Integer 10xN The TermsID to use when creating a new Customer
card.

DefaultCustomerPriceLevelID Text 3xAN The PriceLevelID to use for new customer cards.

DefaultCustomerTaxCodeID Integer 10xN The TaxCodeID to use when creating a new Customer
card.

DefaultUseCustomerTaxCode Text 1xA Y/N flag indicates if the customer’s Tax code should be
used when creating new customers.

DefaultCustomerFreightTaxCodeID Integer 10xN The TaxCodeID to use as the default Customer Freight
TaxCode for new Customer cards.

DefaultCustomerCreditLimit Double 7.2xN The default customer credit limit to use for new
customers.

DefaultSupplierTermsID Integer 10xN The TermsID to use as the default when creating a new
supplier card.

DefaultSupplierTaxCodeID Integer 10xN The TaxCodeID to use when creating a new supplier
card.

DefaultUseSupplierTaxCode Text 1xA Y/N flag indicates if the supplier’s tax code should be
used when creating a new supplier card.

DefaultSupplierFreightTaxCodeID Integer 10xN The TaxCodeID to use as the Supplier Freight Tax code
when creating a new supplier card.

DefaultSupplierCreditLimit Double 7.2xN The default supplier credit limit to use for new
suppliers.

InvoiceSubject Text 255xAN The default subject applied when emailing an invoice

InvoiceMessage Text 255xAN The default message applied when emailing an invoice

IncludeInvoiceNumber Text 1xAN If the Invoice # is included in the Invoice Subject.


N = No, Y = Yes

InvoiceQuoteSubject Text 255xAN The default subject applied when emailing an invoice
quote.

InvoiceQuoteMessage Text 255xAN The default message applied when emailing an invoice
quote.

IncludeInvoiceQuoteNumber Text 1xAN If the Invoice Quote # is included in the Invoice Quote
Subject. N = No, Y = Yes

InvoiceOrderSubject Text 255xAN The default subject applied when emailing an invoice
order.

InvoiceOrderMessage Text 255xAN The default message applied when emailing an invoice
order.

IncludeInvoiceOrderNumber Text 1xAN If the Invoice Order # is included in the Invoice Order
Subject. N = No, Y = Yes

PurchaseSubject Text 255xAN The default subject applied when emailing a purchase.

PurchaseMessage Text 255xAN The default message applied when emailing a


purchase.

IncludePurchaseNumber Text 1xAN If the Purchase # is included in the Purchase Subject.


N = No, Y = Yes

54 CHAPTER 3 READ TABLES


Field Name Type Format Description

PurchaseQuoteSubject Text 255xAN The default message applied when emailing a purchase
quote.

PurchaseQuoteMessage Text 255xAN The default subject applied when emailing a purchase
quote.

IncludePurchaseQuoteNumber Text 1xAN If the Purchase Quote # is included in the Purchase


Quote Subject. N = No, Y = Yes

PurchaseOrderSubject Text 255xAN The default subject applied when emailing a purchase
order.

PurchaseOrderMessage Text 255xAN The default message applied when emailing a purchase
order

IncludePurchaseOrderNumber Text 1xAN If the Purchase Order # is included in the Purchase


Order Subject. N = No, Y = Yes

StatementSubject Text 255xAN The default subject applied when emailing a statement.

StatementMessage Text 255xAN The default message applied when emailing a


statement

PaymentSubject Text 255xAN The default subject applied when emailing a payment
notification.

PaymentMessage Text 255xAN The default message applied when emailing a payment
notification.

UseAuditTracking Text 1xAN If the data file uses Audit Trail Tracking. N = No, Y = Yes

UseCreditLimitWarning Text 1xAN If a warning is displayed when the customer's credit


limit is exceeded on a sale. N=No, Y=Yes

LimitTypeID Text 1xAN LimitTypeID (LimitTypes) of the record containing the


full definition of the exceed credit limit action.
W = Warn and continue
P = Prevent unless overwritten

ChangeControl Text 15xAN Number used to control change within the record.
Value is incremented whenever the record is updated.
Value is reported as a 3 * 5 digit numbers. Value is
packed with leading zeroes if less than 5 digits.

UseStandardCost Text 1xAN Use Standard Cost as the Default Price on Purchase
Orders and Bills. N = No, Y = Yes

UseReceivablesFreight Text 1xAN Indicates whether freight is charged on sales.


N = No, Y = Yes
UseReceivablesDeposits Text 1xAN Indicates whether deposits collected from customers
are tracked. N = No, Y = Yes

UseReceivablesDiscounts Text 1xAN Indicates whether discounts for early payment are
given. N = No, Y = Yes

UseReceivablesLateFees Text 1xAN Indicates whether charges for late payment are
assessed. N = No, Y = Yes

UsePayablesInventory Text 1xAN Indicates whether stock can be received without a


supplier bill. N = No, Y = Yes

UsePayablesFreight Text 1xAN Indicates whether freight is paid on purchases.


N = No, Y = Yes

DATAFILEINFORMATION 55
Field Name Type Format Description

UsePayablesDeposits Text 1xAN Indicates whether deposits paid to suppliers are


tracked. N = No, Y = Yes

UsePayablesDiscounts Text 1xAN Indicates whether discounts for early payment are
taken. N = No, Y = Yes

UsePayablesLateFees Text 1xAN Indicates whether late payment charges are paid.
N = No, Y = Yes

Foreign Keys Table sourced Notes

DefaultCustomerTermsID Terms

DefaultCustomerPriceLevelID PriceLevels

DefaultCustomerTaxCodeID TaxCodes

DefaultCustomerFreightTaxCodeID TaxCodes

DefaultSupplierTermsID Terms

DefaultSupplierTaxCodeID TaxCodes

DefaultSupplierFreightTaxCodeID TaxCodes

LimitTypeID LimitTypes

56 CHAPTER 3 READ TABLES


PayrollInformation

Overview
The PayrollInformation table presents generic information stored within the General Payroll Information window.

Record Field Information


Field Name Type Format Description

CurrentPayrollYear Integer 4xN Current Payroll Year as displayed within the General Payroll
Information window.

HoursInWorkWeek Double 3.2xN The Number of Hours in a Full-Time Work Week.

HoursInWorkDay Double 3.2xN The Number of Hours in a Full-Time Day.

TaxTableRevisionDate Date Formatted by the The Tax Table Revision Date as displayed in the General Payroll
operating system Information window. This is the same date as the one displayed
in the Tax Table Information window.

BaseSalaryWageID Integer 10xN WagesID (Wages) of the wage category containing the Base
Salary wage category.

BaseHourlyWageID Integer 10xN WagesID (Wages) of the wage category containing the Base
Hourly wage category.

BaseDailyWageID Integer 10xN WagesID (Wages) of the wage category containing the Base
Daily wage category.

UseTimesheets Text 1xA N = No, Y = Yes

IncludeTimeBillingInTimesheets Text 1xA Indicates whether time billing information is included in the
preparation of timesheet entries. N = No, Y = Yes

TimesheetWeekStartID Text 3xA The DayNamesID (DayNames) of the record containing the full
definition of the day of the week upon which the timesheet
starts.

EmployerTaxFileNo Text 20xAN (Malaysia) Employer Tax File Reference Number

EmployerTaxRefNo Text 20xAN (Singapore) Employer Tax File Reference Number

EmployerEPFNo Text 20xAN (Malaysia) Employer Employment Provident Fund Number

EmployerSocsoNo Text 20xAN (Malaysia) Employer Social Security Number

EmployerCPFRefNo Text 20xAN (Singapore) Employer Central Provident Fund Number

SocsoTableRevisionDate Date Formatted by the (Malaysia) The SOCSO Table Revision Date as displayed in the
operating system General Payroll Information window

CPFTableRevisionDate Date Formatted by the (Singapore) The CPF Table Revision Date as displayed in the
operating system General Payroll Information window

PAYROLLINFORMATION 57
Foreign Keys Table sourced

BaseSalaryWageID Wages

BaseHourlyWageID Wages

BaseDailyWageID Wages

TimesheetWeekStartID DayNames

58 CHAPTER 3 READ TABLES


LinkedAccounts

Overview
The LinkedAccounts table reports Links and Defaults presented within the following windows:
„ Accounts & Banking Linked Accounts
„ Sales Linked Accounts
„ Purchases Linked Accounts

Record Field Information


Field Name Type Format Description

CurrentEarningsID Integer 10xN AccountID of Equity Account for Current Earnings

RetainedEarningsID Integer 10xN AccountID of Equity Account for Retained Earnings

HistoricalBalancingID Integer 10xN AccountID of Equity Account for Historical Balancing

UndepositedFundsID Integer 10xN AccountID of the cheque account for Undeposited Funds

CurrencyGainLossID Integer 10xN AccountID of Account for Currency Gains/Losses

ReceivablesAccountID Integer 10xN AccountID of Asset Account for Tracking Receivables

ReceivablesChequeID Integer 10xN AccountID of the cheque account for Receipts

ReceivablesFreightID Integer 10xN AccountID of Income Account for Freight

ReceivablesDepositsID Integer 10xN AccountID of Liability Account for Customer Deposits

ReceivablesDiscountsID Integer 10xN AccountID of Expense or Cost of Sales Account for Discounts

ReceivablesLateFeesID Integer 10xN AccountID of Income Account for Late Charges

PayablesAccountID Integer 10xN AccountID of Liability Account for Tracking Payables

PayablesChequeID Integer 10xN AccountID of the cheque account for Paying Bills

PayablesFreightID Integer 10xN AccountID of Expense or Cost of Sales Account for Freight

PayablesDepositsID Integer 10xN AccountID of Asset Account for Supplier Deposits

PayablesDiscountsID Integer 10xN AccountID of Expense or (Contra) Account for Discounts

PayablesLateFeesID Integer 10xN AccountID of Expense Account for Late Charges

PayablesInventoryID Integer 10xN AccountID of Liability Account for Item Receipts

WithholdingPayableID Integer 10xN AccountID of Default Withholding Payable Account

EmployerEPFExpenseID Integer 10xN (Malaysia) AccountID of Default Employer EPF Expense Account

WithholdingEPFPayableID Integer 10xN (Malaysia) AccountID of Default Withholding EPF Payable Account

EmployerSOCSOExpenseID Integer 10xN (Malaysia) AccountID of Default Employer SOCSO Expense Account

WithholdingSOCSOPayableID Integer 10xN (Malaysia) AccountID of Default Withholding SOCSO Payable Account

EmployerCPFExpenseID Integer 10xN (Singapore) AccountID of Default Employer CPF Expense Account

LINKEDACCOUNTS 59
Field Name Type Format Description

WithholdingCPFPayableID Integer 10xN (Singapore) AccountID of Default Withholding CPF Payable Account

EmployerFWLExpenseID Integer 10xN (Singapore) AccountID of Default Employer FWL Expense Account

WithholdingFWLPayableID Integer 10xN (Singapore) AccountID of Default Withholding FWL Payable Account

EmployerSDLExpenseID Integer 10xN (Singapore) AccountID of Default Employer SDL Expense Account

WithholdingSDLPayableID Integer 10xN (Singapore) AccountID of Default Withholding SDL Payable Account

ChangeControl Text 6xAN Number used to control change within the record. Value is
incremented whenever the record is updated.

All foreign keys in this table link to the Accounts table.

60 CHAPTER 3 READ TABLES


Terms

Overview
The Terms table provides information about default credit terms attached to customer and supplier cards, and credit
terms attached to sale invoices and purchase orders. Each record contains a single credit terms set applicable to the
card or transaction. Multiple customer cards, supplier cards, sale invoices and purchase orders may reference one
record in this table.

Record Field Information


Field Name Type Format Description

*** TermsID Integer 10xN Unique Identifier.

LatePaymentChargePercent Double 99.99% % monthly charge for late payment.

EarlyPaymentDiscountPercent Double 99.99% % discount for early payment.

TermsOfPaymentID Text 4xAN TermsOfPaymentID (TermsOfPayment) of the record


containing the terms of payment definition.

DiscountDays Integer 3xN Number early payment discount days.

BalanceDueDays Integer 3xN Number of days until due.

*** ImportPaymentIsDue Integer 1xN Import definition

DiscountDate Text 2xN The discount date.


EOM

BalanceDueDate Text 2xN The balance due date.


EOM

Foreign Keys Table sourced

TermsOfPaymentID TermsOfPayment

TERMS 61
Address

Overview
The Address table displays address and contact information reported within the Profile tab of the Card Information
window of all Customer, Supplier, Employee and Personal cards. Each Customer, Supplier, Employee or Personal
card can have up to five addresses and contacts. A separate record is generated within the Address table for each
Location with non-zero entries. Effectively one card could have up to five records within the Address table.

Record Field Information


Field Name Type Format Description

*** AddressID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID of Cards, Customers, Suppliers, Employees, PersonalCards
record that owns this information.

Location Integer 1xN 1 = Address 1


2 = Address 2
3 = Address 3
4 = Address 4
5 = Address 5

Street Text 255xAN Full content of Address or Ship To Address field.

StreetLine1 Text 255xAN First line of cards Address or Ship To Address. Text reported sources from the
first character in the field to the last character before the first carriage return.

StreetLine2 Text 255xAN Second line of cards Address or Ship To Address. Text reported sources from
the first character after the first carriage return in the field to the last character
before the second carriage return.

StreetLine3 Text 255xAN Third line of cards Address or Ship To Address. Text reported sources from the
first character after the second carriage return in the field to the last character
before the third carriage return.

StreetLine4 Text 255xAN Fourth line of cards Address or Ship To Address. Text reported sources from
the first character after the third carriage return in the field to the last
character before the fourth carriage return. Any subsequent text after the
fourth carriage return is not reported.

City Text 255xAN City or ship to City of card.

State Text 255xAN State or ship to State of card.

Postcode Text 10xAN Postcode or Ship To Postcode of card.

Country Text 255xAN Country of location address.

Phone1 Text 21xAN Phone number 1 of card.

Phone2 Text 21xAN Phone number 2 of card.

Phone3 Text 21xAN Phone number 3 of card.

Fax Text 21xAN Fax number of card.

62 CHAPTER 3 READ TABLES


Field Name Type Format Description

Email Text 255xAN Email address of card.

Salutation Text 15xAN Salutation of card.

ContactName Text 25xAN Contact name of card.

ChangeControl Text 5xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

WWW Text 255xAN World Wide Web address.

Foreign Keys Table sourced Notes

CardRecordID Cards Address could be the address of a customer, supplier,


Suppliers employee or personal card. The Cards table contains all
Employees cards so, therefore, the CardRecordID will always have a
PersonalCards match in the Cards table.

ADDRESS 63
Currency

Overview
The Currency table contains information about the local and foreign currencies used within the data file. Information
contained within each record includes parenthesis, linked receivable accounts and linked payable accounts. The
Currency table will report one record per currency.

Record Field Information


Field Name Type Format Description

*** CurrencyID Integer 10xN Unique Identifier.

*** CurrencyCode Text 3xAN 1-3 character code used to identify the currency in MYOB.

*** CurrencyName Text 30xAN The name used to identify the currency.

ExchangeRate Double 6.6xN Rate to exchange this currency into local currency. Local
currency is always 1.

CurrencySymbol Text 4xAN The symbol used to identify the currency.

DigitGroupingSymbol Text 1xAN

SymbolPosition Text 13xAN

DecimalPlaces Integer 2xN

NumberDigitsInGroup Integer 1xN

DecimalPlaceSymbol Text 1xAN

NegativeFormat Text 25xAN

UseLeadingZero Text 1xAN

^^^ LinkedReceivablesAccountID Integer 10xN Asset Account for Tracking Receivables in this Currency.
AccountID (Accounts) of linked account.

*** LinkedReceivablesChequeID Integer 10xN Cheque Account for Customer Receipts in this Currency.
AccountID (Accounts) of linked account.

^^^ LinkedReceivablesFreightID Integer 10xN Income Account for Freight in this Currency. AccountID
(Accounts) of linked account.

^^^ LinkedReceivablesDepositsID Integer 10xN Liability Account for Deposits Received in this Currency.
AccountID (Accounts) of linked account.

^^^ LinkedReceivablesDiscountsID Integer 10xN Expense or Cost of Sales Account for Discounts in this Currency.
AccountID (Accounts) of linked account.

^^^ LinkedReceivablesLateFeesID Integer 10xN Income Account for Late Charges in this Currency. AccountID
(Accounts) of linked account.

^^^ LinkedPayablesAccountID Integer 10xN Liability Account for Tracking Payables in this Currency.
AccountID (Accounts) of linked account.

64 CHAPTER 3 READ TABLES


Field Name Type Format Description

*** LinkedPayablesChequeID Integer 10xN Cheque Account for Paying Bills in this Currency. AccountID
(Accounts) of linked account.

^^^ LinkedPayablesFreightID Integer 10xN Expense or Cost of Sales Account for Freight in this Currency.
AccountID (Accounts) of linked account.

^^^ LinkedPayablesDepositsID Integer 10xN Asset Account for Deposits in this Currency. AccountID
(Accounts) of linked account.

^^^ LinkedPayablesDiscountsID Integer 10xN Expense or (Contra) Account for Discounts in this Currency.
AccountID (Accounts) of linked account.

^^^ LinkedPayablesLateFeesID Integer 10xN Expense Account for Late Charges in this Currency. AccountID
(Accounts) of linked account.

^^^ LinkedPayablesInventoryID Integer 10xN Liability Account for Item Receipts in this Currency. AccountID
(Accounts) of linked account.

All foreign keys in this table link to the Accounts table.

CURRENCY 65
Accounts

Overview
Account activity for prior to last year and after this year is contained within the accounts table. Each account will only
have one (if any) prior to last year value and one post this year (if any).
To save space within the Account table and also to assist the user in preparing reports, activity and budget
information is stored within separate tables. All account activity information is stored within the AccountActivity
table. All account budget information is stored within the AccountBudgets table.

Record Field Information


Field Name Type Format Description

*** AccountID Integer 10xN Unique Identifier.

*** ParentAccountID Integer 10xN AccountID (Accounts) of accounts record that is this
account’s parent account.

IsInactive Text 1xAN Active = 0 (N), Inactive = 1 (Y)

*** AccountName Text 30xAN The account name.

AccountNumber Text 9-9999 The account number.

TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this card.

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing
currency information for this account.

*** CurrencyExchangeAccountID Integer 10xN AccountID (Accounts) of the record that is this account’s
currency exchange account.

AccountClassificationID Text 4xAN AccountClassificationID (AccountClassification) of the


record containing the full account classification
definition.

SubAccountClassificationID Text 4xAN SubAccountClassificationID (SubAccountTypes) of the


record containing the full sub-account classification
definition.

AccountLevel Integer 1xN The level of the account {0,1,2,3,4}. Only top-level
balance sheet and P & L accounts are 0, the rest have a
number in the level.

AccountTypeID Text 1xAN AccountTypeID (AccountType) of the record containing


the full account type definition.

LastChequeNumber Text 8xN Last cheque number used for this account.

IsReconciled Text 1xAN Flag for whether the account has been reconciled. ‘Y’ is
reconciled, otherwise ‘N’.

LastReconciledDate Date Formatted by the Last successful reconciliation statement date.


operating system.

66 CHAPTER 3 READ TABLES


Field Name Type Format Description

StatementBalance Double 13.2xN Balance as of the last reconciled date.

IsCreditBalance Text 1xAN Normal sign of balances for this account (a negative
balance is displayed as a positive number). Debit = ‘N’,
Credit = ‘Y’

OpeningAccountBalance Double 13.2xN Opening balance as shown in edit account and account
opening balances windows.

CurrentAccountBalance Double 13.2xN Current balance of this account. For balance sheet
accounts, includes all pre last year, last year, this year and
post this year activity. For profit & loss accounts, includes
all this year and after this year activity.

PreLastYearActivity Double 13.2xN Net activity within profit & loss account or net movement
within balance sheet accounts prior to the beginning of
last financial year.

LastYearOpeningBalance Double 13.2xN Balance at the beginning of the last financial year.

ThisYearOpeningBalance Double 13.2xN Balance at the beginning of this financial year.

PostThisYearActivity Double 13.2xN Net activity within profit & loss account or net movement
within balance sheet accounts after the end of this
financial year.

AccountDescription Text 255xAN Description of the account

IsTotal Text 1xAN If when reporting, a subtotal is generated for the header.

CashFlowClassificationID Text 3xAN CashFlowClassification ID (CashFlowClassifications) of the


record containing the full Classification for Statement of
Cash.

BankAccountNumber Text 20xAN Bank Account Number as entered within the Banking tab
of the Edit Accounts window.

BankAccountName Text 32xAN Bank Account Name as entered within the Banking tab of
the Edit Accounts window.

Foreign Keys Table sourced

ParentAccountID Accounts

CurrencyID Currency

CurrencyExchangeAccountID Accounts

AccountClassificationID AccountClassification

SubAccountClassificationID SubAccountTypes

CashFlowClassificationID CashFlowClassifications

AccountTypeID AccountType

ACCOUNTS 67
AccountActivities

Overview
The AccountActivities table holds information regarding account activity. AccountActivities records are generated
for every activity period including those with a zero balance.

Record Field Information


Field Name Type Format Description

AccountActivityID Integer 12xN Unique Identifier.

*** AccountID Integer 10xN AccountID (Accounts) or accounts record that owns this information.

FinancialYear Integer 4xN Financial year in which the activity was generated.

Period Integer 2xN The period of the financial year in which the activity was generated.

Amount Double 13.2xN Net activity within profit & loss account or net movement within
balance sheet accounts.

Foreign Keys Table sourced

AccountID Accounts

68 CHAPTER 3 READ TABLES


AccountBudgets

Overview
The AccountBudgets table holds information regarding account budgets. AccountBudgets records are generated for
every budget period including those with a zero balance.
All AccountBudgets records are for the current financial year. MYOB does not provide a user with the ability to store
budgets for several years.

Record Field Information


Field Name Type Format Description

AccountBudgetID Integer 12xN Unique Identifier.

*** AccountID Integer 10xN AccountID (Accounts) of accounts record that owns this information.

Period Integer 2xN The period of the financial year to which the budget information is
associated.

Amount Double 13.2xN Budgeted activity within profit & loss accounts or budgeted balance
of balance sheet accounts.

FinancialYear Integer 4xN Financial year to which the budget value relates.

Foreign Keys Table sourced

AccountID Accounts

ACCOUNTBUDGETS 69
PaymentMethods

Overview
Payment Methods can be linked to Customer cards to act as the default Payment Method. Additionally payment
methods can be assigned against receipt transactions such as MoneyReceived, CustomerPayments and
DebitRefunds.

Record Field Information


Field Name Type Format Description

*** PaymentMethodID Integer 10xN Unique identifier (recordID)

PaymentMethod Text 255xAN Description of payment method

MethodType Text 11xAN Method Type of payment method:

If paymentType=0, Cash
If paymentType=1, Cheque
If paymentType=2, Credit Card
If paymentType=3, Debit Card
If paymentType=4, Other

The PaymentMethods table contains no foreign keys.

70 CHAPTER 3 READ TABLES


Users

Overview
By linking the Users table back to the JournalRecords table, a user can ascertain the creator of every transaction
within the data file.

Record Field Information


Field Name Type Format Description

*** UserID Integer 10xN Unique Identifier.

UserName Text 26xAN User name for this UserID.

UseTimeslipsLink Text 1xAN Y/N flag indicates if the data file uses the Timeslips Accounting Link.

UseBillingUnits Text 1xAN Y/N flag indicates if activity slips are created using Billing Units.

BillingUnit Integer 2xN The number of minutes in each billing unit:


1
6
10
12
15
30

RoundCalculatedTime Text 1xAN Y/N flag indicates if the timer is rounded.

RoundToID Text 1xAN The method used when rounding timer-calculated times to a full minute
increment.

MinuteIncrement Integer 3xN The full minute multiple used when rounding timer-calculated times.

IncludeItemsInTimeBilling Text 1xAN Y/N flag indicates if the user includes items on Time billing invoices.
When set as 1 (Yes), a number of additional fields within the
Import_TimeBilling_Sales write routine become available.

Foreign Keys Table sourced

RoundToID Rounding

USERS 71
ContactLog

Overview
The ContactLog table contains one record for each contact log created. Each card may contain multiple contact logs
entries.

Record Field Information


Field Name Type Format Description

*** ContactLogID Integer 10xN Unique identifier for each contact log.

*** CardRecordID Integer 10xN The ID of the card to which the contact log is attached.

Contact Text 255xAN The contact assigned to the Contact Log Entry.

Date Date Formatted by the Date of the Contact Log Entry.


operating system To avoid SQL reserved word conflicts, use the LogDate field
below.

LogDate Date Formatted by the Date of this entry. This field contains the same data as the Date
operating system field above.

Notes Text 255xAN Notes assigned to the Contact Log Entry.

ElapsedTime Text 6xAN Elapsed Time in Hours and Minutes.

^^^ RecontactDate Date Formatted by the The Recontact Date.


operating system

ChangeControl Text 10xAN Number used to record changes to the record. Value is
incremented whenever the record is updated.
The value is reported as 2 * 5 digit numbers and is packed with
leading zeroes if less than 5 digits.

Foreign Keys Table sourced

CardRecordID Cards
Customers
Employees
PersonalCards
Suppliers

72 CHAPTER 3 READ TABLES


AuditTrail

The AuditTrail table provides details of changes to recorded transactions, tax values, accounts and system settings.
AuditTrail records are only generated when the Security preference Use Audit Trail Tracking is selected.

Record Field Information


Field Name Type Format Description

*** AuditTrailID Integer 10xN Unique identifier (recordID)

AuditTypeID Text 1xAN AuditTypeID (AuditTypes) of the record containing the full
audit type definition.
T = Transaction Audit Trail Entry
X = Tax Audit Trail Entry
A = Account Audit Trail Entry
S = System Setting Audit Trail Entry

TransactionNumber Text 10xAN ID # of the transaction changed (if available)

*** ChangeDate Date Formatted by the Date this event occurred.


operating system

OriginalDate Date Formatted by the Date of the original transaction


operating system

WasThirteenthPeriod Text 1xAN Y/N flag indicating whether the date originally assigned to
the transaction was a thirteenth period date

IsReconciled Text 1xAN Y/N flag indicating whether the original transaction is
reconciled.

*** UserID Integer 10xN UserID (Users) of the record containing the User ID for the
creator of this AuditTrail record.

Description Text 255xAN Description of the change made.

Foreign Keys Table sourced

UserID Users

AUDITTRAIL 73
ImportantDates

The ImportantDates table displays Important Dates information displayed within the Business Calendar window.

Record Field Information


Field Name Type Format Description

*** ImportantDatesID Integer 10xN Unique identifier (recordid)

*** CalendarYear Integer 4xN Calendar year to which these details belong.

JanuaryDetails Text 255xAN January Important Dates

FebruaryDetails Text 255xAN February Important Dates

MarchDetails Text 255xAN March Important Dates

AprilDetails Text 255xAN April Important Dates

MayDetails Text 255xAN May Important Dates

JuneDetails Text 255xAN June Important Dates

JulyDetails Text 255xAN July Important Dates

AugustDetails Text 255xAN August Important Dates

SeptemberDetails Text 255xAN September Important Dates

OctoberDetails Text 255xAN October Important Dates

NovemberDetails Text 255xAN November Important Dates

DecemberDetails Text 255xAN December Important Dates

74 CHAPTER 3 READ TABLES


Journal Records and Transactions

JournalRecords

Overview
The JournalRecords table provides transaction journal details for all transaction types. The JournalRecords table
replicates information displayed within the Transaction Journal window.
In addition to information displayed within the Transaction Journal window, the JournalRecords table provides the
reconciliation status of the transaction and information about who created the transaction and when the transaction
was created.

Record Field Information


Field Name Type Format Description

*** JournalRecordID Integer 10xN Unique Identifier.

*** SetID Integer 10xN SetID (JournalSets) of the record containing the journal type
and the link to the transaction record.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word
operating system. conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data
operating system. as the Date field above.

IsThirteenthPeriod Text 1xAN Y/N flag

*** AccountID Integer 10xN AccountID (Accounts) of the record containing information
about the account associated with this amount.

TaxExclusiveAmount Double 13.2xN Debit or credit amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the
journal set.

IsMultipleJob Text 1xAN Yes/No flag indicating if multiple job allocations are applicable
to this journal record.

EntryIsPurged Text 1xAN Defines if a source window exists for the transaction in the data
file. If entry is purged a source window is not available.

IsForeignTransaction Text 1xAN If the transaction is non-local.

IsExchangeConversion Text 1xAN Amount is added to non-local amount to convert it back to the
local currency.

ReconciliationStatusID Text 1xAN ReconciliationStatusID (ReconciliationStatus) of the record


containing the full reconciliation status definition.

JOURNAL RECORDS AND TRANSACTIONS 75


Field Name Type Format Description

DateReconciled Date Formatted by the Bank statement date at that the journal record was reconciled.
operating system

*** UserID Integer 10xN UserID (Users) of the record containing the UserID for the
creator of the journal record.

RecordSessionDate Date Formatted by the System date at time of session launch when this record was
operating system created.

RecordSessionTime Text hh:mm:ss System time at point of session launch in that this record was
created. Stored as seconds after midnight. Required to be
converted into usable format.

Foreign Keys Table sourced

SetID JournalSets

AccountID Accounts

JobID Jobs

ReconciliationStatusID ReconciliationStatus

UserID Users

76 CHAPTER 3 READ TABLES


JournalSets

Overview
The JournalSets table provides a link between the JournalRecords table and the following tables:
„ General Journals
„ Money Spent
„ Money Received
„ Sale Invoices
„ Purchase Orders
„ Customer Payments
„ Customer Finance Charges
„ Customer Discounts
„ Customer Deposits
„ Supplier Payments
„ Supplier Finance Charges
„ Supplier Discounts
„ Supplier Deposits
„ Inventory Adjustments
„ Inventory Transfers
The JournalSets table can be linked with the JournalRecords table via the SetID foreign key within the JournalRecords
table.

Record Field Information


Field Name Type Format Description

*** SetID Integer 10xN Unique Identifier.

JournalTypeID Text 3xAN JournalTypeID (JournalTypes) of the record containing the full journal
type definition. (See the JournalTypes Table for more information).

SourceID Integer 10xN SourceID of the record containing more information about the journal
record.

TransactionNumber Text 10xAN ID# of the transaction.

Memo Text 255xAN Memo of the transaction.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this transaction.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

JOURNALSETS 77
Foreign Keys Table sourced Notes

JournalTypeID JournalTypes

SourceID Source ID could be linked to any of the


following tables:
GeneralJournals
MoneySpent
MoneyReceived
BankDeposits
Sales
CustomerPayments
CustomerFinanceCharges
CustomerDiscounts
CustomerDeposits
SettledCredits
CreditRefunds
Purchases
SupplierPayments
SupplierFinanceCharges
SupplierDiscounts
SupplierDeposits
SettledDebits
DebitRefunds
InventoryAdjustments
InventoryTransfers

CurrencyID Currency

78 CHAPTER 3 READ TABLES


GeneralJournals

Overview
The GeneralJournals table displays information that is static to all lines of a General Journal transaction. Details about
entries made within the allocation table are detailed within the GeneralJournalLines table.
Only one GeneralJournals record is required for each General Journal cash set.

Record Field Information


Field Name Type Format Description

*** GeneralJournalID Integer 10xN Unique Identifier.

GeneralJournalNumber Text 10xAN General journal number of transaction.

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period transaction.

Memo Text 255xAN Memo of the General journal entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive.

IsAutoRecorded Text 1xAN Yes/No flag indicating if the General journal entry was
automatically recorded.

CurrencyID Integer 10xN The CurrencyID of the record containing currency information for
this General journal entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

CategoryID Integer 10xN The CategoryID assigned to the General Journal entry.

Foreign Keys Table sourced

CurrencyID Currency

CategoryID Categories

GENERALJOURNALS 79
GeneralJournalLines

Overview
The GeneralJournalLines table produces a listing of allocation lines displayed within the allocation table of the
General Journal Entry window.
Only entries within the allocation table of the General Journal entry are reported in the GeneralJournalLines table.
Entries within the GeneralJournalLines table are displayed in the originating currency.
Information static to all entries within the GeneralJournalLines table is contained within the GeneralJournals table.
The GeneralJournals table is accessed via the GeneralJournalID foreign key within the GeneralJournalLines table.

Record Field Information


Field Name Type Format Description

*** GeneralJournalLineID Integer 10xN Unique Identifier.

*** GeneralJournalID Integer 10xN GeneralJournalID of the record containing the header information
such as memo, and date for this line of the General Journal entry.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** AccountID Integer 10xN The AccountID of the record containing account information for this
line of the General Journal entry.

^^^ JobID Integer 10xN JobID of the record containing the job for this line of the General
Journal entry.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the
General Journal line.

TaxExclusiveAmount Double 13.2xN Tax-exclusive debit or credit amount.

TaxInclusiveAmount Double 13.2xN Debit amounts are reported in the positive parenthesis and credit
amounts are reported in the negative parenthesis. The amounts here
are displayed in their originating currencies. The transaction
exchange rate is found within the GeneralJournals table.

LineMemo Text 255xAN Memo assigned to the allocation line.

^^^ TaxCodeID Integer 10xN TaxCodeID of the record containing the Tax Code for this line of the
General Journal Entry.

Foreign Keys Table sourced

GeneralJournalID GeneralJournals

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

80 CHAPTER 3 READ TABLES


MoneySpent

Overview
The MoneySpent table displays information that is static to all lines of a Spend Money transaction. Details about
entries made within the allocation table are detailed within the MoneySpentLines table.
Only one MoneySpent record is required for each Spend Money cash set.

Record Field Information


Field Name Type Format Description

*** MoneySpentID Integer 10xN Unique Identifier.

ChequeNumber Text 10xAN Cheque number of transaction.

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

*** IssuingAccountID Integer 10xN The AccountID (Accounts) of the record containing account
information about the cheque account or credit card account
assigned as the issuing cheque/credit card account for this
transaction.

TotalSpentAmount Double 13.2xN Net amount of the cheque.

^^^ CardRecordID Integer 10xN The card attached to this transaction found within the Cards,
Customers, Suppliers, Employees or PersonalCards tables.

Payee Text 255xAN Payee text.

PayeeLine1 Text 255xAN First line of Payee text

PayeeLine2 Text 255xAN Second line of Payee text

PayeeLine3 Text 255xAN Third line of Payee text

PayeeLine4 Text 255xAN Fourth line of Payee text

Memo Text 255xAN Memo text of the entry.

IsTaxInclusive Text 1xA Yes/No flag indicating if the transaction is tax inclusive

IsAutoRecorded Text 1xAN Y/N flag indicating if the money spent entry was
automatically recorded.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this General Journal entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

IsPrinted Text 1xAN Cheque transaction is marked as Already Printed.

MONEYSPENT 81
Field Name Type Format Description

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing


the full Payment Notification Delivery Status assigned to the
Spend Money transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

CategoryID Integer 10xN The CategoryID assigned to the Spend Money entry.

Foreign Keys Table sourced Notes

IssuingAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card could be that of a customer, supplier, employee or a


Customers personal card. The Cards table contains all cards so therefore
Suppliers the CardRecordID will always have a match in the Cards table.
Employees
PersonalCards

PaymentDeliveryID InvoiceDelivery

CategoryID Categories

82 CHAPTER 3 READ TABLES


MoneySpentLines

Overview
The MoneySpentLines table produces a listing of allocation lines displayed within the allocation table of the Spend
Money entry window. Only entries within the allocation table of the Spend Money entry are reported in the
MoneySpentLines table
Entries within the MoneySpentLines table is displayed in their originating currency.
Information static in all entries within the MoneySpentLines table are contained within the MoneySpent table. The
MoneySpent table is accessed via the MoneySpentID foreign key within the MoneySpentLines table.

Record Field Information


Field Name Type Format Description

*** Integer 10xN Unique Identifier.


MoneySpentLineID

*** MoneySpentID Integer 10xN MoneySpentID (MoneySpent) of the record containing the header information
such as memo, and date for this line of the Spend Money transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** AccountID Integer 10xN The AccountID (Accounts) of the record containing account information for this
line of the Spend Money transaction.

TaxExclusiveAmount Double 13.2xN Tax exclusive amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the Spend Money
transaction.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the money spent
line

^^^ CodeID Integer 10xN CodeID (Codes) of the record containing the code for this line of the Spend
Money transaction.

LineMemo Text 255xAN Memo assigned to the allocation line

Foreign Keys Table sourced

MoneySpentID MoneySpent

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

MONEYSPENTLINES 83
MoneyReceived

Overview
The MoneyReceived table displays information that is static to all lines of a Receive Money transaction. Details about
entries made within the allocation table are detailed within the MoneyReceivedLines table.
Only one MoneyReceived record is required for each Receive Money cash set.

Record Field Information


Field Name Type Format Description

*** MoneyReceivedID Integer 10xN Unique Identifier.

*** DepositNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** RecipientAccountID Integer 10xN The AccountID (Accounts) of the record containing
account information about the cheque account or credit
card account assigned as the depositing cheque/credit
card account for this transaction.

TotalAmountReceived Double 13.2xN Net amount of the deposit.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID (PaymentMethods) of the record


containing the Method of Payment

PaymentCardNumber Text 25xAN Card Number

PaymentNameOnCard Text 50xAN Name on Card

PaymentExpirationDate Text mm/yy Expiration Date on card

PaymentAuthorisationNumber Text 255xAN Authorisation Number for card transaction

PaymentBankAccountNumber Text 11xAN

PaymentBankAccountName Text 32xAN Valid characters are 0-9 A-Z & - / . '

PaymentChequeNumber Text 25xAN The payment’s cheque number

PaymentNotes Text 255xAN Payment Notes

^^^ CardRecordID Integer 10xN The payer attached to this makes a deposit transaction
found within the Cards, Customers, Suppliers, Employees
or PersonalCards table.

Memo Text 255xAN Memo text of the make a deposit entry.

84 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsTaxInclusive Text 1xA Yes/No flag indicating if the transaction is Tax inclusive

IsAutoRecorded Text 1xa Y/N flag to indicate if the money received was
automatically recorded.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this Make a Deposit entry

DepositStatusID Text 1xAN (DepositStatus) of the record containing the full deposit
status definition

CategoryID Integer 10xN The CategoryID assigned to the Receive Money entry

Foreign Keys Table sourced Notes

RecipientAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card could be that of a customer, supplier, employee or a


Customers personal card. The Cards table contains all cards so therefore
Suppliers the CardRecordID will always have a match in the Cards
Employees table.
PersonalCards

MethodOfPaymentID PaymentMethods

DepositStatusID DepositStatus

CategoryID Categories

MONEYRECEIVED 85
MoneyReceivedLines

Overview
The MoneyReceivedLines table produces a listing of allocation lines displayed within the allocation table of the
Receive Money entry window. Only entries within the allocation table of the Receive Money entry are reported in the
MoneyReceivedLines table.
Entries within the MoneyReceivedLines table are displayed in their originating currency.
Information static in all entries within the MoneyReceivedLines table is contained within the MoneyReceived table.
The MoneyReceived table is accessed via the MoneyReceivedID foreign key within the MoneyReceivedLines table.

Record Field Information


Field Name Type Format Description

*** MoneyReceivedLineID Integer 10xN Unique Identifier.

*** MoneyReceivedID Integer 10xN MoneyReceivedID (MoneyReceived) of the record containing the header
information such as memo, and date for this line of the make a deposit
transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** AccountID Integer 10xN The AccountID (Accounts) of the record containing account information for
this line of the make a deposit entry.

TaxExclusiveAmount Double 13.2xN Tax exclusive amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive amount.

IsMultipleJob Text 1xAN Y/N flag to indicate if multiple job allocations are applicable to the money
received line.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the make a
deposit.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line.

LineMemo Text 255xAN Memo assigned to the allocation line

Foreign Keys Table sourced

MoneyReceivedID MoneyReceived

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

86 CHAPTER 3 READ TABLES


Sales

Overview
The Sales table displays information that is static to all lines of a Sale Invoice transaction. Details about entries made
within the allocation table are detailed within the SaleLines table.
The Sales table contains one record for each sale created. This includes any Open, Closed, Credit, Quote or Order
invoices.
Both historical and post conversion sales is included in the Sales table. Historical sale invoices contain only a fraction
of the information contained within a post conversion sale invoice, therefore a large number of fields will report as 0
within historical sale records.

Record Field Information


Field Name Type Format Description

*** SaleID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) of the
record containing customer information for this sale invoice entry.

*** InvoiceNumber Text 8xAN The sale invoice number.

^^^ CustomerPONumber Text 20xAN The customer PO number.

IsHistorical Text 1xAN If the sale invoice was generated through the historical sale
window.

*** BackorderSaleID Integer 10xN The set number to which this sale invoice belongs. Used to link
sale invoices together.

Date Date Formatted by the Date of the sale invoice entry. To avoid SQL reserved word
operating system conflicts, use the InvoiceDate field below.

InvoiceDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period transaction.

ShipToAddress Text 255xAN ShipTo address of the sale invoice.

ShipToAddressLine1 Text 255xAN First line of the ShipTo address text. Only relevant when the Type
is Service or Item.

ShipToAddressLine2 Text 255xAN Second line of the ShipTo address text. Only relevant when the
Type is Service or Item.

ShipToAddressLine3 Text 255xAN Third line of the ShipTo address text. Only relevant when the Type
is Service or Item.

ShipToAddressLine4 Text 255xAN Fourth line of the ShipTo address text. Only relevant when the
Type is Service or Item.

InvoiceTypeID Text 1xAN InvoiceTypeID (InvoiceType) of the record containing the full sale
type definition.

SALES 87
Field Name Type Format Description

InvoiceStatusID Text 2xAN StatusID (Status) of the record containing the full sale invoice
status definition.

*** TermsID Integer 10xN The TermsID (Terms) of the record containing terms information
for this sale entry.

TotalLines Double 13.2xN The sum of all tax exclusive line amounts applicable to this sale
invoice.

TaxExclusiveFreight Double 13.2xN The Tax exclusive freight amount applicable to this sale invoice.

TaxInclusiveFreight Double 13.2xN The Tax inclusive freight amount applicable to this sale invoice.

^^^ FreightTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code
applied against the Freight amount on this sale invoice.

TotalTax Double 13.2xN The total of all tax amounts applicable to this sale invoice.

TotalPaid Double 13.2xN The total of all payments made against this sale invoice.

TotalDeposits Double 13.2xN The total of all deposit payments made against a sale invoice. This
field can only have a non-zero balance when the status is pending.

TotalCredits Double 13.2xN The total credits applied against this sale invoice from another sale
invoice, OR The total credits applied from this sale invoice to
another sale invoice.

TotalDiscounts Double 13.2xN The total amount of discounts applied against this sale invoice.

OutstandingBalance Double 13.2xN The amount still payable on the sale invoice.

^^^ SalesPersonID Integer 10xN The CardRecordID (Cards) or EmployeeID (Employees) of the
record containing salesperson information for this sale invoice
entry.

Memo Text 255xAN Journal memo of the sale invoice.

Comment Text 255xAN Comment of the sale invoice.

^^^ ShippingMethodID Integer 10xN The Shipping MethodID (ShippingMethods) of the record
containing Shipping information for this sale invoice entry.

PromisedDate Date Formatted by the Promised date of the sale invoice.


operating system

^^^ ReferralSourceID Integer 10xN The ReferralSourceID (ReferralSources) of the record containing
referral source for this sale invoice entry.

IsAutoRecorded Text 1xAN Y/N flag to indicate if the sale invoice was automatically recorded.

IsPrinted Text 1xAN Sale Invoice is marked as Already Printed or Sent

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record containing the


full Invoice Delivery Status assigned to the sale.

DaysTillPaid Integer 10xN Number of days taken until the sale invoice was paid in full.

CurrencyID Long 10xN The CurrencyRecordID (Currency) of the record containing


Integer currency information for this sale entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

^^^ CategoryID Integer 10xN The CategoryID assigned to the Sale Invoice.

88 CHAPTER 3 READ TABLES


Field Name Type Format Description

LinesPurged Text 1xAN Y/N flag indicates if the sale lines have been purged.

PreAuditTrail Text 1xAN Y/N flag indicates if the invoice involves inventoried stock items
and was recorded using a non inventory audit trail version of
MYOB accounting software.

Foreign Keys Table sourced Notes

CardRecordId Cards Cards are contained in both the Customers and the Cards tables
Customers

InvoiceTypeID InvoiceType

InvoiceStatusID Status

TermsID Terms

SalespersonID Cards Cards are contained in both the Employees and the Cards tables
Employees

ReferralSourceID ReferralSources

TaxCodeID TaxCodes

ShippingMethodID Methods

InvoiceDeliveryID InvoiceDelivery

CurrencyID Currency

CategoryID Categories

SALES 89
SaleLines

Overview
The SaleLines table contains information that is static to invoice lines of all invoice types. Further detailed information
generic to a particular type of invoice is stored within the ServiceSaleLines table, the ItemSaleLines table, the
ProfessionalSaleLines table, the TimeBillingSaleLines table or the MiscSaleLines table. This includes any Open,
Closed, Credit, Quote or Order invoices.
Both historical and post conversion sales is included in the SaleLines table. Historical sale invoice lines contain only a
fraction of the information contained within a post conversion sale invoice line, therefore a large number of fields
will report as 0 within historical sale line records.

Record Field Information


Field Name Type Format Description

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only (Data).

Description Text 255xAN Description text of the sale line.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax for this line of the sales invoice.

TaxBasisAmountIsInclusive Text 1xA Yes/No flag indicating if tax basis amount is inclusive. Note: To provide
consistency between comparisons the TaxBasisAmount should be
converted to a common basis of either all inclusive or all exclusive.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the sale line.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the sale invoice.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the sale invoice.

Foreign Keys Table sourced

SaleID Sales

LineTypeID LineType

JobID Jobs

TaxCodeID TaxCodes

90 CHAPTER 3 READ TABLES


ServiceSaleLines

Overview
The ServiceSaleLines table contains information that is static to lines of Service type sale invoices. Historical sale
invoices are classified as Service sale invoices. Therefore, if historical sale invoices are recorded within the company
file, they are displayed within the ServiceSaleLines table.

Record Field Information


Field Name Type Format Description

*** ServiceSaleLineID Integer 10xN Unique Identifier.

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to that this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only.

Description Text 255xAN Description text of the sale line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information
for this line of the sale invoice.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax for this line of the sales invoice.

TaxBasisAmountIsInclusive Text 1xA Yes/No flag indicating if tax basis amount is inclusive. Note: To provide
consistency between comparisons the TaxBasisAmount should be
converted to a common basis of either all inclusive or all exclusive.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the sale line.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the sale invoice.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the Tax code for this line
of the sale invoice.

Foreign Keys Table sourced

SaleLineID SaleLines

SaleID Sales

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

SERVICESALELINES 91
ItemSaleLines

Overview
The ItemSaleLines table contains information that is static to lines of Item type sale invoices.
Historical sale invoices are not reported in the ItemSaleLines table.

Record Field Information


Field Name Type Format Description

*** ItemSaleLineID Integer 10xN Unique Identifier.

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to that this line
belongs.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full
line type definition. Value of D only (Data).

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

Description Text 255xAN Description text of the sale line.

TaxExclusiveTotal Double 13.2xN Tax exclusive line total.

TaxInclusiveTotal Double 13.2xN Tax inclusive line total.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are
applicable to the sale line.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this
line of the sale invoice.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the
tax code for this line of the sale invoice.

TaxBasisAmount Double 13.2xN The taxable amount used to calculate tax upon this
line of the sale invoice.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is
stored as a tax inclusive or a tax exclusive value.

Quantity Double 8.3xN The quantity of goods shipped or backordered.

^^^ ItemID Integer 10xN The ItemID (Items) of the record containing item
information for this line of the sale invoice.

92 CHAPTER 3 READ TABLES


Field Name Type Format Description

SalesTaxCalBasisID Text 3xA PriceLevelID (PriceLevels) of the record containing the


full Sales Tax Calculation Basis definition.
ASP = Actual Selling Price
LC = Last Cost
AC = Average Cost
BSP = Base Selling Price
PLA = Price Level A
PLB = Price Level B
PLC = Price Level C
PLD = Price Level D
PLE = Price Level E
PLF = Price Level F

TaxExclusiveUnitPrice Double 11.4xN Tax exclusive line price.

TaxInclusiveUnitPrice Double 11.4xN Tax inclusive line price.

Discount Double 9xN (with a maximum Discount rate applicable to the line of the sale invoice.
of two decimal places.
Decimal point counts
as one place.)

CostOfGoodsSoldAmount Double 13.2xN The cost of goods sold amount attributable to this line
of the sale invoice.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record


containing full details of the location assigned to this
line of the item order

Foreign Keys Table sourced

SaleLineID SaleLines

SaleID Sales

LineTypeID LineType

ItemID Items

JobID Jobs

TaxCodeID TaxCodes

SalesTaxCalBasisID PriceLevels

LocationID Locations

ITEMSALELINES 93
ProfessionalSaleLines

Overview
The ProfessionalSaleLines table contains information that is static to lines of Professional type sale invoices. Historical
sale invoices are not reported in the ProfessionalSaleLines table.

Record Field Information


Field Name Type Format Description

*** ProfessionalSaleLineID Integer 10xN Unique Identifier.

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to that this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line
type definition. Value of D only (Data).

LineDate Date Formatted by the Date attached to the line entry.


operating system

Description Text 255xAN Description text of the sale line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account
information for this line of the sale invoice.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax for this line of the sales
invoice.

TaxBasisAmountIsInclusive Text 1xA Yes/No flag indicating if tax basis amount is inclusive. Note:
To provide consistency between comparisons the
TaxBasisAmount should be converted to a common basis of
either all inclusive or all exclusive.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of
the sale invoice.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to
the sale line.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code
for this line of the sale invoice.

94 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

SaleLineID SaleLines

SaleID Sales

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

PROFESSIONALSALELINES 95
TimeBillingSaleLines

Overview
The TimeBillingSaleLines table contains information that is static to lines of Time Billing type sale invoices.
Historical sale invoices are not reported in the TimeBillingSaleLines table.

Record Field Information


Field Name Type Format Description

*** TimeBillingSaleLineID Integer 10xN Unique Identifier.

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type
definition. Value of D only (Data).

LineDate Date Formatted by the Date attached to the line entry.


operating system

HoursUnits Double 8.3xN The Hours/Units of activities supplied.

^^^ ActivityID Integer 10xN The ActivityID (Activities) of the record containing activity
information for this line of the sale invoice.

Notes Text 255xAN

TaxExclusiveRate Double 11.4xN Tax exclusive line rate.

TaxInclusiveRate Double 11.4xN Tax inclusive line rate.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the sale
invoice.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is stored as a tax
inclusive or a tax exclusive value.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the
sale invoice.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to
the sale line.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for
this line of the sale invoice.

EstimatedCost Double 13.2xN The estimated cost attributable to this line of the sale invoice.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record containing full
details of the location assigned to this line of the item order.

96 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

SaleLineID SaleLines

SaleID Sales

LineTypeID LineType

ActivityID Activities

JobID Jobs

TaxCodeID TaxCodes

LocationID Locations

TIMEBILLINGSALELINES 97
MiscSaleLines

Overview
The MiscSaleLines table contains information that is static to lines of Miscellaneous type sale invoices. Historical sale
invoices are not reported in the MiscSaleLines table.

Record Field Information


Field Name Type Format Description

*** MiscSaleLineID Integer 10xN Unique Identifier.

*** SaleLineID Integer 10xN Unique Identifier.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice to that this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only.

Description Text 255xAN Description text of the sale line.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the sale invoice.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the sale line.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the sale invoice.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is stored as a tax inclusive
or a tax exclusive value.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the sale invoice.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information
for this line of the sale invoice.

Foreign Keys Table sourced

SaleLineID SaleLines

SaleID Sales

LineTypeID LineType

JobID Jobs

AccountID Accounts

TaxCodeID TaxCodes

98 CHAPTER 3 READ TABLES


Purchases

Overview
The Purchases table displays information that is static to all lines of a Purchase Order transaction. Details about
entries made within the allocation table are detailed within the PurchaseLines table.
The Purchases table contains one record for each Purchase created. This includes any Open, Closed, Credit, Quote
or Order purchases.
Both historical and post conversion purchases are included in the Purchases table. Historical purchase orders contain
only a fraction of the information contained within a post conversion purchase order, therefore, a large number of
fields will report as 0 within historical purchase records.

Record Field Information


Field Name Type Format Description

*** PurchaseID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or SupplierID (Suppliers) of the
record containing supplier information for this purchase order
entry.

*** PurchaseNumber Text 8xAN The purchase number.

^^^ SupplierInvoiceNumber Text 20xAN The supplier invoice number.

IsHistorical Text 1xAN If the purchase order was generated via the Historical
Purchase window.

*** BackorderPurchaseID Integer 10xN The set number to which this purchase order belongs. Used to
link purchase orders together.

Date Date Formatted by the Date of the purchase order entry. To avoid SQL reserved word
operating system conflicts, use the PurchaseDate field below.

PurchaseDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

ShipToAddress Text 255xAN ShipTo address of the purchase order.

ShipToAddressLine1 Text 255xAN First line of the ShipTo address text.

ShipToAddressLine2 Text 255xAN Second line of the ShipTo address text.

ShipToAddressLine3 Text 255xAN Third line of the ShipTo address text.

ShipToAddressLine4 Text 255xAN Fourth line of the ShipTo address text.

PurchaseTypeID Text 1xAN The InvoiceTypeID (InvoiceType) of the record containing the
full purchase type definition.

PurchaseStatusID Text 2xAN The StatusID (Status) of the record containing the full
purchase order status definition.

PURCHASES 99
Field Name Type Format Description

OrderStatusID Text 2xAN The OrderStatusID (OrderStatus) of the record containing the
full Order Status of the purchase.

ReversalLinkID Integer 10xN The PurchaseID (Purchases) of the record that is the reversal of
the receive item purchase order.

*** TermsID Integer 10xN The TermsID (Terms) of the record containing terms
information for this purchase entry.

TotalLines Double 13.2xN The sum of all tax exclusive line amounts applicable to this
purchase order.

TaxExclusiveFreight Double 13.2xN The tax exclusive Freight amount applicable to this purchase
order.

TaxInclusiveFreight Double 13.2xN The tax inclusive Freight amount applicable to this purchase
order.

^^^ FreightTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the Tax Code
applied against the Freight amount on this purchase order.

TotalTax Double 13.2xN The total of all Tax amounts applicable to this purchase order.

TotalPaid Double 13.2xN The total of all payments made against this purchase order.

TotalDeposits Double 13.2xN The total of all deposit payments made against a purchase
order.

TotalDebits Double 13.2xN The total debits applied against this purchase order from
another purchase order, OR the total debits applied from this
purchase order to another purchase order.

TotalDiscounts Double 13.2xN The total amount of discounts applied against this purchase
order.

OutstandingBalance Double 13.2xN The amount still payable on the purchase order.

Memo Text 255xAN Journal memo of the purchase order.

Comment Text 255xAN Comment of the purchase order.

^^^ ShippingMethodID Integer 10xN The ShippingID (Shipping) of the record containing ship via
information for this purchase order entry.

PromisedDate Date Formatted by the Promised date of the purchase order.


operating system

IsPrinted Text 1xAN Purchase Order is marked as Already Printed or Sent.

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record containing


the full bill delivery status assigned to the purchase.

IsAutoRecorded Text 1xAN Y/N flag indicating if the purchase order was automatically
recorded.

DaysTillPaid Integer 10xN Number of days taken until the purchase order was paid in
full.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing the
currency information for this order entry.

IsTaxInclusive Text 1xA Y/N flag indicating if the transaction status is tax inclusive.
Note: Historical Purchases can only be recorded as tax
inclusive. All historical purchases should therefore report as Y.

100 CHAPTER 3 READ TABLES


Field Name Type Format Description

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

^^^ CategoryID Integer 10xN The CategoryID assigned to the Purchase Order.

LinesPurged Text 1xAN Y/N flag indicates if the lines of the purchase have been
purged.

PreAuditTrail Text 1xAN Y/N flag indicates if the purchase order involves inventoried
stock items and was recorded using a non inventory audit trail
version of MYOB accounting software.

Foreign Keys Table sourced Notes

CardRecordID Cards Cards are contained in both the Suppliers and the Cards tables.
Suppliers

PurchaseTypeID InvoiceType

PurchaseStatusID Status

OrderStatusID OrderStatus

ReversalLinkID Purchases

TermsID Terms

FreightTaxCodeID TaxCodes

ShippingMethodID Methods

InvoiceDeliveryID InvoiceDelivery

CurrencyID Currency

CategoryID Categories

PURCHASES 101
PurchaseLines

Overview
The PurchaseOrderLines table contains information that is static to purchase lines of all purchase order types. Further
detailed information generic to a particular type of invoice is stored within either the ServicePurchaseLines table, the
ItemPurchaseLines table, the ProfessionalPurchaseLines table, the TimeBillingPurchaseLines table or the
MiscPurchaseLines table. This includes any Open, Closed, Credit, Quote or Order purchases.
Both historical and post conversion purchases are included in the PurchaseLines table. Historical purchase order lines
contain only a fraction of the information contained within a post conversion purchase order line, so many fields will
report as 0 within historical purchase line records.

Record Field Information


Field Name Type Format Description

*** PurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order to that this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only (Data).

Description Text 255xAN Description text of the purchase line.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the purchase
line. Multiple jobs cannot be assigned to Purchase Orders. IsMultipleJob will
always be N within PurchaseLines.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the purchase
order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the Purchase Order.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is stored as a tax inclusive or
a tax exclusive value.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the purchase order.

Foreign Keys Table sourced

PurchaseID Purchases

LineTypeID LineType

JobID Jobs

TaxCodeID TaxCodes

102 CHAPTER 3 READ TABLES


ServicePurchaseLines

Overview
The ServicePurchaseLines table contains information that is static to lines of Service type purchase orders.
Historical purchase orders are classified as Service purchase orders. Therefore, if historical purchase orders are
recorded within the data file, they are displayed within the ServicePurchaseLines table.

Record Field Information


Field Name Type Format Description

*** ServicePurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseLineID Integer 10xN The PurchaseLineID (PurchaseLines) of the corresponding record within the
PurchaseLines table.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only.

Description Text 255xAN Description text of the purchase line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information for
this line of the purchase order.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the service
purchase line.
Multiple jobs cannot be assigned to ServicePurchase Orders. IsMultipleJob will
always be N within ServicePurchaseLines.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the purchase order.

TaxBasisAmountIsInclusiv Text 1xA Y/N flag indicating if the tax calculation amount is stored as a tax inclusive or a
e tax exclusive value.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the purchase order.

Foreign Keys Table sourced

PurchaseLineID PurchaseLines

PurchaseID Purchases

LineTypeID LineType

SERVICEPURCHASELINES 103
Foreign Keys Table sourced

JobID Jobs

AccountID Accounts

TaxCodeID TaxCodes

104 CHAPTER 3 READ TABLES


ItemPurchaseLines

Overview
The ItemPurchaseLines table contains information that is static to lines of Item type purchase orders.
Historical purchase orders are not reported in the ItemPurchaseLines table.

Record Field Information


Field Name Type Format Description

*** ItemPurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseID Integer 10xN The PurchaseID of the purchase order to which this
line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order
set.

LineTypeID Text 1xAN LineTypeID of the record containing the full line type
definition. Value of D only.

^^^ ItemID Integer 10xN The ItemID of the record containing item information
for this line of the purchase order.

Description Text 255xAN Description text of the purchase line.

Quantity Double 8.3xN The quantity of goods shipped or backordered.

TaxExclusiveUnitPrice Double 11.4xN Tax exclusive line price.

TaxInclusiveUnitPrice Double 11.4xN Tax inclusive line price.

TaxExclusiveTotal Double 13.2xN Tax exclusive line total.

TaxInclusiveTotal Double 13.2xN Tax inclusive line total.

Discount Double 9xN (with a maximum Discount rate applicable to the line of the purchase
of two decimal places. order.
Decimal point counts
as one place.)

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are
applicable to the purchase line. Multiple jobs cannot
be assigned to Item Purchase Orders. IsMultipleJob
will always be N within ItemPurchaseLines.

^^^ JobID Integer 10xN JobID of the record containing the job for this line of
the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of
the Purchase Order.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is
stored as a tax inclusive or a tax exclusive value.

ITEMPURCHASELINES 105
Field Name Type Format Description

^^^ TaxCodeID Integer 10xN TaxCodeID of the record containing the Tax code for
this line of the purchase order.

Received Double 8.3xN The quantity of items received. Positive quantities are
reported in the positive parenthesis and negative
quantities are reported in the negative parenthesis.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record


containing full details of the location assigned to this
line of the item order.

Foreign Keys Table sourced

PurchaseLineID PurchaseLines

PurchaseID Purchases

LineTypeID LineType

ItemID Items

JobID Jobs

TaxCodeID TaxCodes

LocationID Locations

106 CHAPTER 3 READ TABLES


ProfessionalPurchaseLines

Overview
The ProfessionalPurchaseLines table contains information that is static to lines of Professional type purchase orders.
Historical purchase orders are not reported in the ProfessionalPurchaseLines table.

Record Field Information


Field Name Type Format Description

*** ProfessionalPurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order to which
this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line
type definition. Value of D only (Data).

Description Text 255xAN Description text of the purchase line.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are
applicable to the purchase line. Multiple jobs cannot be
assigned to Professional Purchase Orders. IsMultipleJob
will always be N within ProfessionalPurchaseLines.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of
the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the purchase order.

LineDate Date Formatted by the Date attached to the line entry.


operating system

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the
Purchase Order.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is stored
as a tax inclusive or a tax exclusive value.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing
account information for this line of the purchase order.

Foreign Keys Table sourced

PurchaseLineID PurchaseLines

PurchaseID Purchases

PROFESSIONALPURCHASELINES 107
Foreign Keys Table sourced

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

108 CHAPTER 3 READ TABLES


MiscPurchaseLines

Overview
The MiscPurchaseLines table contains information that is static to lines of Miscellaneous type purchase orders.
Historical purchase orders are not reported in the MiscellaneousPurchaseLines table.

Record Field Information


Field Name Type Format Description

*** MiscPurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseLineID Integer 10xN Unique Identifier.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order to that this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
Value of D only (Data).

Description Text 255xAN Description text of the purchase line.

TaxExclusiveAmount Double 13.2xN Tax exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax inclusive line amount.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the purchase
line. Multiple jobs cannot be assigned to Miscellaneous Purchase Orders.
IsMultipleJob will always be N within MiscPurchaseLines.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the job for this line of the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the Purchase Order.

TaxBasisAmountIsInclusive Text 1xA Y/N flag indicating if the tax calculation amount is stored as a tax inclusive or a
tax exclusive value.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information for
this line of the purchase order.

Foreign Keys Table sourced

PurchaseLineID PurchaseLines

PurchaseID Purchases

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

MISCPURCHASELINES 109
CustomerPayments

Overview
The Customer Payments table produces a summary of information that is static to all transaction lines within
Customer Payment entries. The CustomerPayments table should reflect what is displayed within the header of the
Customer Payment window.
Only one Customer Payment record is required for each Customer Payment cash set. The CustomerPayment record
is sourced from the first record in the customer payment cash set.
Included in the Customer Payments table is the FinanceCharge field and the ExchangeGainLoss field. When the user
records a finance charge within a Customer Payment entry, a Sales Journal entry is created that defines that accounts
are affected by the additional income. These records are contained within the CustomerFinanceCharges table
below.
The CustomerFinanceCharges table cannot be linked with the CustomerPayments table as no invoicePrt or
CustomerPayment link exists within the Finance Charge record.

Record Field Information


Field Name Type Format Description

*** CustomerPaymentID Integer 10xN Unique Identifier.

*** CustomerPaymentNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the customer payment entry. To avoid SQL
operating system reserved word conflicts, use the TransactionDate field
below.

TransactionDate Date Formatted by the Date of this transaction entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the customer payment entry.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID of the record containing the
Method of Payment.

PaymentCardNumber Text 25xAN Card Number.

PaymentNameOnCard Text 50xAN Name on Card.

PaymentExpirationDate Text mm/yy Expiration Date on card.

PaymentAuthorisationNumber Text 255xAN Authorisation Number for card transaction.

PaymentBankAccountNumber Text 11xA Account Number.

PaymentBankAccountName Text 32xAN Account Name.

PaymentChequeNumber Text 25xAN

110 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status
is tax inclusive. Note: Customer Payment entries and thus
customer finance charge entries cannot be recorded as tax
inclusive. IsTaxInclusive should always be N for customer
finance charge entries.

PaymentNotes Text 255xAN Payment Notes

FinanceCharge Double 13.2xN Finance Charge amount applicable to the deposit. All
amounts within the CustomerPayments table are displayed
in their originating currency.

CurrencyID Integer 10xN The CurrencyID of the record containing currency


information for this customer payment entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** RecipientAccountID Integer 10xN The cheque account or credit card account assigned as the
depositing cheque/credit card account for this transaction.

TotalCustomerPayment Double 13.2xN Net amount of the deposit.

ExchangeGainLoss Double 13.2xN Foreign exchange gain or loss.

CardRecordID Integer 10xN The customer attached to this customer payment


transaction.

DepositStatusID Text 1xAN DepositStatus of the record containing the full deposit
status definition.
D = Direct
U = Unselected
S = Selected
T = Transferred

Foreign Keys Table sourced Notes

RecipientAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card will be contained in both the Customers and the
Customers Cards tables.

MethodOfPaymentID PaymentMethods

DepositStatusID DepositStatus

CUSTOMERPAYMENTS 111
CustomerPaymentLines

Overview
The CustomerPaymentLines table produces a listing of entries displayed within the allocation table of the Customer
Payment entry window.
Entries within the CustomerPaymentLines table are displayed in their originating currency.
Information static in all entries within the CustomerPaymentLines table is contained within the CustomerPayments
table. The CustomerPayments table is accessed via the CustomerPaymentID foreign key within the
CustomerPaymentLines table.

Record Field Information


Field Name Type Format Description

*** CustomerPaymentLineID Integer 10xN Unique identifier.

*** CustomerPaymentID Integer 10xN CustomerPaymentID of the record containing the header
information such as memo, and date for this line of the
Customer Payment transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice record to which this
amount was applied against.

AmountApplied Double 13.2xN Amount applied.

IsDepositPayment Text 1xAN Yes/No flag to determine if the payment is made against a
pending invoice, the payment is a deposit. N = No, Y = Yes.

Foreign Keys Table sourced

CustomerPaymentID CustomerPayments

SaleID Sales

112 CHAPTER 3 READ TABLES


CustomerFinanceCharges

Overview
The Customer Finance Charges table produces details of Customer Finance Charge applied within the Customer
Payment entry window. There can only be Customer Finance Charge per Customer Payment. It is, therefore, not
necessary to generate a Customer Finance Charges Lines table.
Only one Customer Finance Charge record is required for each Customer Finance Charge cash set. The
CustomerFinanceCharges record is sourced from the first record in the cash set.
Entries within the CustomerPaymentLines table are displayed in their originating currency.

Record Field Information


Field Name Type Format Description

*** CustomerFinanceChargeID Integer 10xN Unique Identifier.

CustomerFinanceChargeNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the customer finance charge entry. To avoid
operating system SQL reserved word conflicts, use TransactionDate.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the
operating system same data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the customer finance charge entry.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this customer finance charge
entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** LateChargesAccountID Integer 10xN The account (Accounts) debited or credited with the
finance charge.

FinanceCharge Double 13.2xN The finance charge amount.

CardRecordID Integer 10xN The customer (Cards or Customers) attached to this


finance charge transaction.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.


Gains are reported as a positive AmountApplied.
Losses are reported as a negative amount applied.
All amounts within the CustomerFinanceCharges table
are displayed in their originating currency.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID (PaymentMethods) of the


record containing the Method of Payment.

PaymentCardNumber Text 25xAN Card Number.

CUSTOMERFINANCECHARGES 113
Field Name Type Format Description

PaymentNameOnCard Text 50xAN Name on Card.

PaymentExpirationDate Text 10xAN Expiration Date on card.

PaymentAuthorisationNumber Text 255xAN Authorisation Number for card transaction.

PaymentBankAccountNumber Integer 9xN Account Number.

PaymentBankAccountName Text 32xAN Account Name.

PaymentChequeNumber Text 25xAN The payment cheque number

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default
status is Tax inclusive. Note: Customer Payment
entries and thus customer finance charge entries
cannot be recorded as Tax inclusive. IsTaxInclusive
should always be N for customer finance charge
entries.

PaymentNotes Text 255xAN Payment Notes.

Foreign Keys Table sourced Notes

LateChargesAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card will be contained in both the Customers and the
Customers Cards tables.

MethodOfPaymentID PaymentMethods

114 CHAPTER 3 READ TABLES


CustomerDiscounts

Overview

NOTE : The CustomerDiscounts table will only display early payment discounts generated by versions prior to MYOB
Premier v7 or MYOB Accounting/Plus v13. Early payment discounts applied using MYOB Premier v7 or MYOB
Accounting/Plus v13 or later will be reported within the SettledCredits table.

The CustomerDiscounts table displays information that is static to all lines of a CustomerDiscount transaction.
Details about discounts provided within the allocation table are detailed within the CustomerDiscountLines table.
Only one CustomerDiscounts record is required for each Customer Discount cash set.
The CustomerDiscounts table cannot be linked with the CustomerPayments table as no invoicePrt or
CustomerPayment link exists within the Discount record. Both the Customer Payment and the Customer Discount
have a common point in that they will both point to the same invoice record. Only one discount can be applied
against a sale invoice. The same invoice could however have an unlimited number of customer payments made
against it. Transaction dates can assist us in matching discounts with customer payments but if more than one
customer payment was made against the same invoice on the same day, it is impossible to match the discount with
its original customer payment record.
Entries within the CustomerDiscounts table are displayed in their originating currency.

Record Field Information


Field Name Type Format Description

*** CustomerDiscountID Integer 10xN Unique Identifier.

CustomerDiscountNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the customer discount entry. To avoid SQL
operating system reserved word conflicts, use the TransactionDate field
below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the
operating system same data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID (PaymentMethods) of the


record containing the Method of Payment.

PaymentCardNumber Text 25xAN Card Number.

PaymentNameOnCard Text 50xAN Name on Card.

PaymentExpirationDate Text mm/yy Expiration Date on card.

PaymentAuthorisationNumber Text 255xAN Authorisation Number for card transaction.

PaymentBankAccountNumber Text 11xA Account Number.

CUSTOMERDISCOUNTS 115
Field Name Type Format Description

PaymentBankAccountName Text 32xAN Account Name.

PaymentChequeNumber Text 25xAN Payment cheque number

PaymentNotes Text 255xAN Payment Notes.

Memo Text 255xAN Memo text of the customer discount entry.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this customer discount entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** DiscountAccountID Integer 10xN The account debited or credited with the discount.

TotalDiscount Double 13.2xN Net amount of the discount.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default
status is tax inclusive. Note: Customer Payment entries
and thus customer discount entries cannot be recorded
as tax inclusive. IsTaxInclusive should always be N for
customer discount entries.

CardRecordID Integer 10xN The customer attached to this customer discount


transaction.

Foreign Keys Table sourced Notes

DiscountsAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card will be contained in both the Customers and the
Customers Cards tables.

MethodOfPaymentID PaymentMethods

116 CHAPTER 3 READ TABLES


CustomerDiscountLines

Overview

NOTE : The CustomerDiscountLines table will only display early payment discounts generated by versions prior to MYOB
Premier v7 or MYOB Accounting/Plus v13. Early payment discounts applied using MYOB Premier v7 or MYOB
Accounting/Plus v13 or later will be reported within the SettledCreditLines table.

The CustomerDiscountLines table produces a listing of discount amounts displayed within the allocation table of the
Customer Payment entry window.
Entries within the CustomerDiscountLines table are displayed in their originating currency.
Information static in all entries within the CustomerDiscountLines table is contained within the CustomerDiscounts
table. The CustomerDiscounts table is accessed via the CustomerDiscountID foreign key within the
CustomerDiscountLines table.

Record Field Information


Field Name Type Format Description

*** CustomerDiscountLineID Integer 10xN Unique Identifier.

*** CustomerDiscountID Integer 10xN CustomerDiscountID (CustomerDiscounts) of the record


containing the header information such as memo, and date for
this line of the customer discount transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice record to that this amount
was applied against.

AmountApplied Double 13.2xN Amount applied.

Foreign Keys Table sourced

CustomerDiscountID CustomerDiscounts

SaleID Sales

CUSTOMERDISCOUNTLINES 117
CustomerDeposits

Overview
The Customer Deposits table produces details of deposit amounts transferred from the deposit control account and
applied against an invoice. Only one Customer Deposit record is created for all previous deposits made. It is,
therefore, not necessary to generate a Customer Deposit Lines table.
Entries within the CustomerDeposits table are displayed in their originating currency.
The CustomerDeposits table cannot be linked with the original Customer Payment record as no CustomerPayment
link exists within the Deposit applied record. Both the Customer Payment and the Customer Deposit have a
common point in that they will both point to the same invoice record. More than one deposit can be applied against
a pending sale invoice but when the pending sale invoice is converted into an actual invoice and the deposits are
applied, all previous deposits are applied in one lump sum.

Record Field Information


Field Name Type Format Description

*** CustomerDepositID Integer 10xN Unique Identifier.

CustomerDepositNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the customer deposit application. To avoid SQL
operating system reserved word conflicts, use the TransactionDate field
below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the customer deposit applied entry.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this customer deposit applied
entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** CustomerDepositsAccountID Integer 10xN The account debited or credited when the deposit was
released.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice record to that the
deposit amount was applied against.

*** CardRecordID Integer 10xN The customer attached to this deposit application.

DepositApplied Double 13.2xN The deposit applied.

118 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status
is Tax inclusive. Note: Customer Payment entries and thus
customer deposit applied entries cannot be recorded as
Tax inclusive. IsTaxInclusive should always be N for
customer deposit applied entries.

ExchangeGainLoss Double 13.2xN Gains are reported as a positive amount applied. Losses are
reported as a negative amount applied.

Foreign Keys Table sourced Notes

CurrencyID Currency

CustomerDepositsAccountID Accounts

CardRecordID Cards Card will be contained in both the Customers and the
Customers Cards tables

SaleID Sales

CUSTOMERDEPOSITS 119
SupplierPayments

Overview
The Supplier Payments table produces a summary of information that is static to all transaction lines within Supplier
Payment entries. The SupplierPayments table should reflect what is displayed within the header of the Supplier
Payment window.
Included in the Supplier Payments table are the FinanceCharge field and the ExchangeGainLoss field. When the user
records a finance charge within a Supplier Payment entry, a Purchases Journal entry is created that defines that
accounts are affected by the additional expense. These records are contained within the SupplierFinanceCharges
table below. The SupplierFinanceCharges table is unable to be linked with the SupplierPayments table as no
invoicePrt or SupplierPayment link exists within the Finance Charge record.

Record Field Information


Field Name Type Format Description

*** SupplierPaymentID Integer 10xN Unique Identifier.

SupplierPaymentNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the Supplier payment entry.


operating system To avoid SQL reserved word conflicts, use the
TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Payee Text 255xAN Payee text of the Supplier Payment entry.

PayeeLine1 Text 255xAN First line of Payee text.

PayeeLine2 Text 255xAN Second line of Payee text.

PayeeLine3 Text 255xAN Third line of Payee text.

PayeeLine4 Text 255xAN Fourth line of Payee text.

Memo Text 255xAN Memo text of the supplier payment entry.

IsTaxInclusive Text 1xA

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this supplier payment entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** IssuingAccountID Integer 10xN The cheque account or credit card account assigned as the
issuing cheque/credit card account for this transaction.

CardRecordID Integer 10xN The supplier attached to this supplier payment transaction.

TotalSupplierPayment Double 13.2xN Net amount of the payment.

120 CHAPTER 3 READ TABLES


Field Name Type Format Description

FinanceCharge Double 13.2xN Finance charge amount applicable to the deposit.

ExchangeGainLoss Double 13.2xN Foreign exchange gain or loss.

IsPrinted Text 1xAN Cheque transaction is marked as already printed.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing


the full Payment Notification Delivery Status assigned to the
supplier transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

Foreign Keys Table sourced Notes

IssuingAccountID Accounts

CardRecordID Cards Cards are contained in both the Supplier and the Cards tables
Suppliers

CurrencyID Currency

PaymentDeliveryID InvoiceDelivery

SUPPLIERPAYMENTS 121
SupplierPaymentLines

Overview
The SupplierPaymentLines table produces a listing of entries displayed within the allocation table of the Supplier
Payment entry window. Entries within the SupplierPaymentLines table is displayed in their originating currency.
Information static to all entries within the SupplierPaymentLines table is contained within the SupplierPayments
table. The SupplierPayments table is accessed via the SupplierPaymentID foreign key within the
SupplierPaymentLines table.
The SupplierPaymentLines table produces a listing of allocation lines within a Supplier Payment entry. It should
reflect what is displayed within the allocation table of the Supplier Payments window.

Record Field Information


Field Name Type Format Description

*** SupplierPaymentLineID Integer 10xN Unique Identifier.

*** SupplierPaymentID Integer 10xN Link to the SupplierPayments table.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** PurchaseID Integer 10xN PurchaseID of the purchase order record to which this amount was
applied against.

AmountApplied Double 13.2xN Amount applied.

IsDepositPayment Text 1xAN If the payment is made against an order, the payment is a deposit.

Foreign Keys Table sourced

SupplierPaymentID SupplierPayments

PurchaseID Purchases

122 CHAPTER 3 READ TABLES


SupplierFinanceCharges

Overview
The Supplier Finance Charges table produces details of Supplier Finance Charge applied within the Supplier
Payment entry window. There can only be Supplier Finance Charge per Supplier Payment. It is, therefore, not
necessary to generate a Supplier Finance Charges Lines table.
Only one Supplier Finance Charge record is required for each Supplier Finance Charge cash set. The
SupplierFinanceCharges record is sourced from the first record in the cash set.
Entries within the SupplierPaymentLines table is displayed in their originating currency.

Record Field Information


Field Name Type Format Description

*** SupplierFinanceChargeID Integer 10xN Unique Identifier.

SupplierFinanceChargeNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the supplier finance charge entry. To avoid SQL
operating system reserved word conflicts, use TransactionDate.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the supplier finance charge entry.

IsTaxInclusive Text 1xA If the transactions default status is tax inclusive. Supplier
payment entries and thus supplier finance charge entries
cannot be recorded as tax inclusive. IsTaxInclusive should
always be N for supplier finance charge entries.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this supplier finance charge entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** LateChargesAccountID Integer 10xN The account debited or credited with the finance charge.

CardRecordID Integer 10xN The supplier attached to this finance charge transaction.

FinanceCharge Double 13.2xN The finance charge amount.

SUPPLIERFINANCECHARGES 123
Foreign Keys Table sourced Notes

LateChargesAccountID Accounts

CardRecordID Cards Cards are contained in both the


Suppliers Suppliers and the Cards tables

CurrencyID Currency

124 CHAPTER 3 READ TABLES


SupplierDiscounts

Overview

NOTE : The SupplierDiscounts table will only display early payment discounts generated by versions prior to MYOB Premier
v7 or MYOB Accounting/Plus v13. Early payment discounts applied using MYOB Premier v7 or MYOB Accounting/Plus v13 or
later will be reported within the SettledDebits table.

The SupplierDiscounts table displays information that is static to all lines of a SupplierDiscount transaction. Details
about discounts provided within the allocation table are detailed within the SupplierDiscountLines table.
Only one SupplierDiscounts record is required for each Supplier Discount cash set.
The SupplierDiscounts table cannot be linked with the Payments table as no invoicePrt or SupplierPayment link
exists within the Discount record. Both the Supplier Payment and the Supplier Discount have a common point in
that they will both point to the same purchase record. Only one discount can be applied against a purchase order.
The same purchase could, however, have an unlimited number of Supplier Payments made against it. Transaction
dates can assist us in matching discounts with Supplier Payments, but if more than one Supplier Payment was made
against the same purchase on the same day it is impossible to match the discount with its original Supplier Payment
record.
Entries within the SupplierDiscounts table is displayed in the originating currency.

Record Field Information


Field Name Type Format Description

*** SupplierDiscountID Integer 10xN Unique Identifier.

SupplierDiscountNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the supplier discount entry. To avoid SQL reserved
operating system word conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data
operating system as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the supplier discount entry.

IsTaxInclusive Text 1xA If the transactions default status is tax inclusive. Supplier
payment entries and thus supplier discount entries cannot be
recorded as tax inclusive. IsTaxInclusive should always be N for
supplier discount entries.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this supplier discount entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** DiscountAccountID Integer 10xN The account debited or credited with the discount.

SUPPLIERDISCOUNTS 125
Field Name Type Format Description

CardRecordID Integer 10xN The supplier attached to this supplier discount transaction.

TotalDiscount Double 13.2xN Net amount of the discount.

Foreign Keys Table sourced Notes

DiscountAccountID Accounts

CardRecordID Cards Cards are contained in both the


Suppliers Suppliers and the Cards tables

CurrencyID Currency

126 CHAPTER 3 READ TABLES


SupplierDiscountLines

Overview

NOTE : The SupplierDiscountLines table will only display early payment discounts generated by versions prior to MYOB
Premier v7 or MYOB Accounting/Plus v13. Early payment discounts applied using MYOB Premier v7 or MYOB
Accounting/Plus v13 or later will be reported within the SettledDebitLines table.

The SupplierDiscountLines table produces a listing of discount amounts displayed within the allocation table of the
Supplier Payment entry window.
Entries within the SupplierDiscountLines table is displayed in their originating currency.
Information static to all entries within the SupplierDiscountLines table is contained within the SupplierDiscounts
table. The SupplierDiscounts table is accessed via the SupplierDiscountID foreign key within the
SupplierDiscountLines table.

Record Field Information


Field Name Type Format Description

*** SupplierDiscountLineID Integer 10xN Unique Identifier.

*** SupplierDiscountID Integer 10xN SupplierDiscountID (SupplierDiscounts) of the record containing the
header information such as memo, and date for this line of the
Supplier Discount Transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order record against
which this amount was applied.

AmountApplied Double 13.2xN Amount applied.

Foreign Keys Table sourced

SupplierDiscountID SupplierDiscounts

PurchaseID Purchases

SUPPLIERDISCOUNTLINES 127
SupplierDeposits

Overview
The Supplier Deposits table produces details of deposit amounts transferred from the deposit control account and
applied against a purchase. Only one Supplier Deposit record is created for all previous deposits made. It is,
therefore, not necessary to generate a Supplier Deposit Lines table.
Entries within the SupplierDeposits table is displayed in their originating currency.
The SupplierDeposits table is unable to be linked with the original Supplier Payment record as no SupplierPayment
link exists within the Deposit applied record. Both the Supplier Payment and the Supplier Deposit have a common
point in that they will both point to the same purchase record. More than one deposit can be applied against a
pending purchase order, but when the pending purchase order is converted into an actual purchase and the
deposits are applied, all previous deposits are applied in one lump sum.

Record Field Information


Field Name Type Format Description

*** SupplierDepositID Integer 10xN Unique Identifier.

SupplierDepositNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the supplier deposit application. To avoid SQL
operating system reserved word conflicts, use the TransactionDate field
below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the
operating system same data as the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period


transaction.

Memo Text 255xAN Memo text of the supplier deposit applied entry.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing


currency information for this supplier deposit applied
entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

*** SupplierDepositAccountID Integer 10xN The account debited or credited when the deposit is
released.

*** CardRecordID Integer 10xN The supplier attached to this deposit application.

PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order


record to which the deposit amount was applied
against.

128 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsTaxInclusive Text 1xA Y/N flag indicating if the transaction default status is
tax inclusive. Supplier payment entries and thus
supplier deposits applied entries cannot be recorded
as tax inclusive. IsTaxInclusive should always be N for
supplier deposits applied entries.

DepositApplied Double 13.2xN The deposit applied.

Foreign Keys Table sourced Notes

SupplierDepositAccountID Accounts

PurchaseID Purchases

CardRecordID Cards Cards are contained in both the Supplier and the
Suppliers Cards tables

CurrencyID Currency

SUPPLIERDEPOSITS 129
SettledCredits

Overview

NOTE : The SettledCredits table will only display early payment discounts generated by MYOB Premier v7 or MYOB
Accounting/Plus v13 or later. Early payment discounts applied using an earlier version will be reported within the
CustomerDiscounts table.

The SettledCredits table produces a summary of information that is static to all allocation lines within Settle Returns & Credit entries. The
SettledCredits table reflects the contents of the header of the Settle Returns & Credits window.
Only one SettledCredit record is required for each Settled Return & Credit cash set. The SettledCredit record is sourced from the first record
in the settled credit cash set.

Record Field Information


Field Name Type Format Description

*** SettledCreditID Integer 10xN Unique identifier (SetID).

SettledCreditNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the Credit Settlement. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN Yes/No flag identifying if the transaction was recorded as a
thirteenth period transaction. N = No, Y = Yes.

*** CreditNoteID Integer 10xN The SaleID (Sales) of the credit note being settled.

AmountSettled Double 13.2xN Net amount of credit being settled.

IsDiscount Text 1xAN The Y/N flag indicates if the credit is for an early payment
discount settlement.

FinanceCharge Double 13.2xN Finance Charge amount applicable to the credit note settlement.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** CardRecordID Integer 10xN The Customer attached to this Settled Credit transaction. Only
one card is applicable to the same cashset. The CardRecordID
applicable to the cashset is contained in Line 0.

Memo Text 255xAN Memo text of the Settled Credit entry.

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record containing


currency information for this settled credit entry.

IsTaxInclusive Text 1xA Y/N flag indicating if the transaction default status is tax inclusive.
Note: Settled Credit entries cannot be recorded as tax inclusive.
IsTaxInclusive should always be N for settled credit entries.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

130 CHAPTER 3 READ TABLES


Foreign Keys Table sourced Notes

CardRecordId Cards Cards are contained in both the


Customers Customers and the Cards tables.

CreditNoteID Sales

CurrencyID Currency

SETTLEDCREDITS 131
SettledCreditLines

Overview

NOTE : The SettledCreditLines table will only display early payment discounts generated by MYOB Premier v7 or MYOB
Accounting/Plus v13 or later. Early payment discounts applied using an earlier version will be reported within the
CustomerDiscountLines table.

The SettledCreditLines table produces a listing of entries displayed within the allocation table of the Settle Returns &
Credits entry window. Entries within the SettledCreditLines table are displayed in their originating currency.
Information static to all entries within the SettledCreditLines table is contained within the SettledCredits table. The
SettledCredits table is accessed via the SettledCreditID foreign key within the SettledCreditLines table.

Record Field Information


Field Name Type Format Description

*** SettledCreditLineID Integer 10xN Unique identifier (recordID).

*** SettledCreditID Integer 10xN SettledCreditID (SettledCredits) of the record containing the header
information such as memo, and date for this line of the Settled Credit
transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** SaleID Integer 10xN The SaleID (Sales) of the sale invoice record to which this credit
amount was applied against.

AmountApplied Double 13.2xN Amount applied.

IsDepositPayment Text 1xAN Yes/No flag identifying if the payment is made against an Order.
N = No, Y = Yes.

IsDiscount Text 1xAN Y/N flag indicates if the settlement is for an early payment discount.

Foreign Keys Table sourced

SettledCreditID SettledCredits

SaleID Sales

132 CHAPTER 3 READ TABLES


CreditRefunds

Overview
The CreditRefunds table produces a listing of Credit Notes refunded to Customers. No allocation table is attached to
a Credit Refund transaction, therefore, all details regarding the credit refund are contained within the CreditRefunds
table.

Record Field Information


Field Name Type Format Description

*** CreditRefundID Integer 10xN Unique identifier (setID).

ChequeNumber Text 10xAN Cheque No of transaction.

Date Date Formatted by the Date of the credit refund. To avoid SQL reserved word conflicts,
operating system use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN Yes/No flag identifying if the transaction was recorded as a
thirteenth period transaction. N = No, Y = Yes.

*** IssuingAccountID Integer 10xN The AccountID (Accounts) of the record containing information
about the cheque account or credit card account assigned as the
issuing account upon this transaction.

AmountRefunded Double 13.2xN Net amount of credit being refunded.

*** CreditNoteID Integer 10xN The SaleID (Sales) of the credit note being refunded.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** CardRecordID Integer 10xN The Customer attached to this Credit Refund transaction.

Payee Text 255xAN Payee text of the Credit Refund entry.

Memo Text 255xAN Memo text of the Credit Refund entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive. Note: Credit Refund entries cannot be recorded as tax
inclusive. IsTaxInclusive should always be N for settled credit
entries.

IsPrinted Text 1xAN Yes/No flag identifying if a cheque transaction is marked as


Already Printed. N = Not Printed, Y = Printed.

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing the


full Payment Notification Delivery Status assigned to the credit
refund transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

CREDITREFUNDS 133
Field Name Type Format Description

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record containing


currency information for this credit refund entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

Foreign Keys Table sourced Notes

IssuingAccountID Accounts

CreditNoteID Sales

CardRecordID Cards Card will be contained in both the


Customers Customers and the Cards tables.

PaymentDeliveryID InvoiceDelivery

CurrencyID Currency

134 CHAPTER 3 READ TABLES


SettledDebits

Overview

NOTE : The SettledDebits table will only display early payment discounts generated by MYOB Accounting/Plus v13 or later.
Early payment discounts applied using an earlier version will be reported within the SuppliersDiscounts table.

The SettledDebits table produces a summary of information that is static to all allocation lines within Settle Returns
& Debit entries. The SettledDebits table reflects the contents of the header of the Settle Returns & Debits window.
Only one SettledDebit record is required for each Settled Return & Debit cash set. The SettledDebit record is sourced
from the first record in the settled debit cash set.

Record Field Information


Field Name Type Format Description

*** SettledDebitID Integer 10xN Unique identifier (SetID).

SettledDebitNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the Debit Settlement. To avoid SQL reserved word conflicts,
operating system use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN Yes/No flag identifying if the transaction was recorded as a
thirteenth period transaction. N = No, Y = Yes.

*** DebitNoteID Integer 10xN The PurchaseID (Purchases) of the debit note being settled.

AmountSettled Double 13.2xN Net amount of debit being settled.

IsDiscount Text 1xAN Y/N flag indicates if the settlement is for an early payment discount.

FinanceCharge Double 13.2xN Finance Charge amount applicable to the credit note settlement.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** CardRecordID Integer 10xN The supplier attached to this Settled Debit transaction.

Memo Text 255xAN Memo text of the Settled Debit entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive. Note: Settled Debit entries and thus customer deposit
applied entries cannot be recorded as tax inclusive. IsTaxInclusive
should always be N for Settled Debit entries.

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record containing


currency information for this settled debit entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

SETTLEDDEBITS 135
Foreign Keys Table sourced Notes

CardRecordID Cards Cards are contained in both the


Suppliers Suppliers and the Cards tables.

DebitNoteID Purchases

CurrencyID Currency

136 CHAPTER 3 READ TABLES


SettledDebitLines

Overview

NOTE : The SettledDebitLines table will only display early payment discounts generated by MYOB Premier v7 or MYOB
Accounting/Plus v13 or later. Early payment discounts applied using an earlier version will be reported within the
SuppliersDiscountLines table.

The SettledDebitLines table produces a listing of entries displayed within the allocation table of the Settle Returns &
Debits entry window. Entries within the SettledDebitLines table are displayed in their originating currency.
Information static to all entries within the SettledDebitLines table is contained within the SettledDebits table. The
SettledDebits table is accessed via the SettledDebitID foreign key within the SettledDebitLines table.

Record Field Information


Field Name Type Format Description

*** SettledDebitLineID Integer 10xN Unique identifier (recordID).

*** SettledDebitID Integer 10xN SettledDebitID (SettledDebits) of the record containing the header
information such as memo, and date for this line of the Settled Debit
transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** PurchaseID Integer 10xN The PurchaseID (Purchases) of the purchase order record against which this
debit amount was applied.

AmountApplied Double 13.2xN Amount applied.

IsDepositPayment Text 1xAN Yes/No flag identifying if the payment is made against an Order.

IsDiscount Text 1xAN Y/N flag indicates if the settlement is for an early payment discount.

Foreign Keys Table sourced

SettledDebitID SettledDebits

PurchaseID Purchases

SETTLEDDEBITLINES 137
DebitRefunds

Overview
The DebitRefunds table produces a listing of Debit Notes refunded to suppliers. No allocation table is attached to a
Debit Refund transaction, therefore, all details regarding the debit refund are contained within the DebitRefunds
table.

Record Field Information


Field Name Type Format Description

*** DebitRefundID Integer 10xN Unique identifier (setID).

DebitRefundNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the debit refund. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the
operating system same data as the Date field above.

IsThirteenthPeriod Text 1xAN Yes/No flag identifying if the transaction was recorded as
a thirteenth period transaction. N = No, Y = Yes.

*** RecipientAccountID Integer 10xN The AccountID (Accounts) of the record containing
information about the Cheque account or credit card
account assigned as the recipient account upon this
transaction.

AmountRefunded Double 13.2xN Net amount of debit being refunded.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID (PaymentMethods) of the


record containing the Method of Payment.

PaymentCardNumber Text 25xAN Card Number.

PaymentNameOnCard Text 50xAN Name on Card.

PaymentExpirationDate Text 10xAN Expiration Date.

PaymentAuthorisationNumber Text 255xAN Authorisation Number.

PaymentBankAccountNumber Text 11xA

PaymentBankAccountName Text 32xAN Valid characters are 0-9 A-Z & - / . '

PaymentChequeNumber Text 25xAN Payment Cheque Number.

PaymentNotes Text 255xAN Payment Notes.

138 CHAPTER 3 READ TABLES


Field Name Type Format Description

DepositStatusID Text 1xAN Defines whether the receipt was deposited directly to a
bank account, or the receipt was deposited into
undeposited funds. If the latter is true, this field also
defines the status of the undeposited fund.
D = Direct
U = Unselected
S = Selected
T = Transferred

DebitNoteID Integer 10xN The PurchaseID (Purchases) of the debit note being
refunded.

ExchangeGainLoss Double 13.2xN Foreign Exchange Gain or Loss.

*** CardRecordID Integer 10xN The supplier attached to this Debit Refund transaction.

Memo Text 255xAN Memo text of the Debit Refund entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default
status is Tax inclusive. Note: Debit Refund entries cannot
be recorded as Tax inclusive. IsTaxInclusive should
always be N for settled debit entries.

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record


containing currency information for this debit refund
entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of
recording.

Foreign Keys Table sourced Notes

RecipientAccountID Accounts

CurrencyID Currency

CardRecordID Cards Card will be contained in both


Suppliers the Suppliers and the Cards
tables.

MethodOfPaymentID PaymentMethods

DebitNoteID Purchases

DepositStatusID DepositStatus

DEBITREFUNDS 139
InventoryAdjustments

Overview
The InventoryAdjustments table displays information that is static to all lines of an Inventory Adjustment transaction.
Entries within the allocation table of an Inventory Adjustment are not stored within the data file, consequently no
detail table can be provided.
Only one Inventory Adjustment record is required for each Inventory Adjustment cash set.
The InventoryAdjustments table does not allow the user to display line by line information regarding recorded
Inventory Adjustments. The InventoryAdjustment table simply displays generic information to the transaction such
as date, memo and Inventory journal number.

Record Field Information


Field Name Type Format Description

*** InventoryAdjustmentID Integer 10xN Unique Identifier.

InventoryJournalNumber Text 10xAN Identification number of the transaction.

Date Date Formatted by the Date of the inventory adjustment entry. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as the
operating system Date field.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period transaction.

Memo Text 255xAN Memo text of the inventory adjustment.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive. Note: Inventory Adjustments cannot be recorded as tax
inclusive. IsTaxInclusive should always be N for inventory adjustments.

CurrencyID Integer 10xN The CurrencyID of the record containing currency information for this
inventory adjustment entry. Inventory Adjustments cannot be
recorded in non-local currencies. CurrencyID should always be 0 for
inventory adjustments.

CategoryID Integer 10xN The CategoryID of the record containing the CategoryID assigned to
the Inventory transfer.

TransactionExchangeRate Double 6.6xN The exchange rate at the time of recording. Inventory Adjustments
cannot be recorded in non-local currencies, so
TransactionExchangeRate is 1.000000.

Foreign Keys Table sourced

CurrencyID Currency

CategoryID Categories

140 CHAPTER 3 READ TABLES


InventoryAdjustmentLines

Overview
The InventoryAdjustmentLines table is a listing of allocation lines displayed within the allocation table of the Adjust
Inventory entry window.

Record Field Information


Field Name Type Format Description

*** InventoryAdjustmentLineID Integer 10xN Unique identifier for the line.

*** InventoryAdjustmentID Integer 10xN The ID for the inventory adjustment.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** ItemID Integer 10xN The ID of the item used in the adjustment line.

Quantity Double 11.3xN The quantity adjusted.

UnitCost Double 11.2 The Unit Cost assigned to the item adjustment.

Amount Double 13.2 The Amount assigned to the item adjustment.

AccountID Integer 10xN The ID of the account used in the adjustment line.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the
inventory adjustment line. Multiple jobs cannot be assigned to
Inventory adjustment transactions. IsMultipleJob will always be N
within InventoryAdjustmentLines.

IsCOGSAdjustment Text 1xA Y/N flag indicating if the sale invoice that generated the Cost of
Goods Sold Adjustment has been deleted. N=No, Y.=Yes

^^^ SaleID Integer 10xN The SaleID (Sales) of the sale invoice that generated the Cost of
Goods Sold Adjustment.

SaleLineID Integer 10xN The SaleLinesID (SaleLines) or ItemSaleLineID (ItemSaleLines) of


the line of the sale invoice that generated the line of the Cost of
Goods Sold Adjustment.

JobID Integer 10xN The ID of the job assigned to the adjustment line.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record containing full details
of the location

Foreign Keys Table sourced

InventoryAdjustmentID InventoryAdjustments

ItemID Items

AccountID Accounts

INVENTORYADJUSTMENTLINES 141
Foreign Keys Table sourced

SaleID Sales

SaleLineID SaleLines
ItemSaleLines

JobID Jobs

LocationID Locations

142 CHAPTER 3 READ TABLES


InventoryTransfers

Overview
The InventoryTransfers table displays information that is static to all lines of an Inventory Transfer transaction. Entries
within the allocation table of an Inventory Transfer are not stored within the data file, consequently no detail table
can be provided.
Only one InventoryTransfer record is required for each Inventory Transfer cash set.
The InventoryTransfers table does not allow the user to display line by line information regarding recorded Inventory
Transfers. The InventoryTransfers table simply displays generic information to the transaction such as date, memo,
and Inventory journal number.

Record Field Information


Field Name Type Format Description

*** InventoryTransferID Integer 10xN Unique Identifier.

InventoryJournalNumber Text 10xAN Identification number of the transaction.

Date Date Formatted by the Date of the Inventory transfer entry. To avoid SQL reserved word
operating system conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field above.

IsThirteenthPeriod Text 1xAN If the transaction was recorded as a thirteenth period transaction.

Memo Text 255xAN Memo text of the end of year adjustment entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive. Note: Inventory Transfers cannot be recorded as tax
inclusive. IsTaxInclusive should always be N for Inventory transfers.

CurrencyID Integer 10xN The CurrencyID of the record containing currency information for
this Inventory Transfer.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

CategoryID Integer 10xN The ID of the record containing the CategoryID assigned to the
Transfer

Foreign Keys Table sourced

CurrencyID Currency

ID Categories

INVENTORYTRANSFERS 143
InventoryTransferLines

Overview
The InventoryTransferLines table lists the allocation lines displayed within the allocation table of the Transfer
Inventory entry window.

Record Field Information


Field Name Type Format Description

*** InventoryTransferLineID Integer 10xN Unique identifier.

*** InventoryTransferID Integer 10xN The ID of the Inventory Transfer.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

*** ItemID Integer 10xN The ID of the item used in the transfer line.

Quantity Double 11.3xN The quantity transferred.

UnitCost Double 11.2 The Unit Cost assigned to the item transfer.

Amount Double 13.2 The Amount assigned to the item transfer.

IsMultipleJob Text 1xAN Y/N flag indicating if multiple job allocations are applicable to the
Inventory adjustment line. Multiple jobs cannot be assigned to
Inventory transfer transactions. IsMultipleJob will always be N within
InventoryTransferLines.

^^^ JobID Integer 10xN The ID of the job assigned to the transfer line.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record containing full details
of the location

Foreign Keys Table sourced

InventoryTransferID InventoryTransfers

ItemID Items

JobID Jobs

LocationID Locations

144 CHAPTER 3 READ TABLES


BankDeposits

Overview
The BankDeposits table produces a summary of information that is static to all allocation lines within Bank Deposit
entries. The BankDeposits table reflects the contents of the header of the Prepare Bank Deposit window.
Bank Deposits can only be generated with local currency transactions, therefore, all amounts displayed within the
BankDeposits table are of the local currency.

Record Field Information


Field Name Type Format Description

*** BankDepositID Integer 10xN Unique identifier (SetID).

BankDepositNumber Text 10xAN ID# of transaction.

Date Date Formatted by the Date of the bank deposit. To avoid SQL reserved word conflicts,
operating system use TransactionDate.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as
operating system the Date field.

IsThirteenthPeriod Text 1xAN Yes/No flag identifying if the transaction was recorded as a
thirteenth period transaction. N = No, Y = Yes.

*** RecipientAccountID Integer 10xN The AccountID (Accounts) of the record containing information
about the recipient deposit account of this transaction.

AmountDeposited Double 13.2xN Net amount being deposited.

Memo Text 255xAN Memo text of the Bank Deposit entry.

IsTaxInclusive Text 1xA Y/N flag used to determine if the transaction default status is tax
inclusive. Note: Bank Deposit cannot be recorded as tax
inclusive. IsTaxInclusive should always be N for Bank Deposit.

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record containing


currency information for this bank deposit entry.

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording.

Foreign Keys Table sourced

RecipientAccountID Accounts

CurrencyID Currency

BANKDEPOSITS 145
BankDepositLines

Overview
The BankDepositLines table produces a listing of entries displayed within the allocation table of the Prepare Bank
Deposit window. Bank Deposits can only be generated with local currency transactions, therefore, all amounts
displayed within the BankDepositLines table are of the local currency.
Information static in all entries within the BankDepositLines table is contained within the BankDeposits table. The
BankDeposits table is accessed via the BankDepositID foreign key within the BankDepositLines table.

Record Field Information


Field Name Type Format Description

*** BankDepositLineID Integer 10xN Unique identifier.

*** BankDepositID Integer 10xN BankDepositID (BankDeposits) of the record containing the header information
such as memo, and date for this line of the Bank Deposit transaction.

LineNumber Integer 10xN The sequence of the entry within the journal record set.

SourceID Integer 10xN The MoneyReceivedID (MoneyReceived), or CustomerPaymentID


(CustomerPayments) or DebitRefundID (DebitRefunds) of the undeposited fund
transaction transferred in this bank deposit.

JournalTypeID Text 3xAN JournalTypeID (JournalTypes) of the record containing the full journal type
definition of the undeposited fund transaction transferred in this bank deposit.
MR = Money Received
CP = Customer Payments.
DRD = Debit Refund Deposit.

AmountDeposited Double 13.2xN Amount applied.

DepositStatusID Text 1xAN (DepositStatus) Defines whether the receipt was deposited directly to a bank
account, or the receipt was deposited into undeposited funds. If the latter is true,
this field also defines the status of the undeposited fund.
D = Direct
U = Unselected
S = Selected
T = Transferred

Foreign Keys Table sourced

BankDepositID BankDeposits

SourceID MoneyReceived
DebitRefunds
CustomerPayments

JournalTypeID JournalTypes

DepositStatusID DepositStatus

146 CHAPTER 3 READ TABLES


TransferMoney

Overview
The TransferMoney table displays information reported within the Transfer Money window. Both the From Account
and To Account details are displayed within the TransferMoney Table.

Record Field Information


Field Name Type Format Description

*** TransferMoneyID Integer 10xN Unique identifier (recordid)

TransferNumber Text 10xAN Transfer Number of transaction

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word conflicts,
operating system use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data as the
operating system Date field above.

*** FromAccountID Integer 10xN The AccountID (Accounts) of the record containing information
about the cheque account or credit card account assigned as the
Transfer Money From selection within this transaction.

*** ToAccountID Integer 10xN The AccountID (Accounts) of the record containing information
about the cheque account or credit card account assigned as the
Transfer Money To selection within this transaction.

Amount Double 13.2xN Transfer amount.

Memo Text 255xAN Memo text of the Transfer Money entry

IsTaxInclusive Text 1xA Yes/No flag indicating if the transaction status is Tax inclusive

IsAutoRecorded Text

CurrencyID Integer 10xN The CurrencyRecordID (Currency) of the record containing currency
information for this Transfer Money entry

TransactionExchangeRate Double 6.6xN The exchange rate of this transaction at the time of recording

CategoryID Integer 10xN The CategoryID (Categories) of the record containing the Category
assigned to the Transfer Money entry

Foreign Keys Table sourced

FromAccountID Accounts

ToAccountID Accounts

CurrencyID Currency

CategoryID Categories

TRANSFERMONEY 147
Recurring Journal Records and
Transactions

RecurringMoneySpent

The RecurringMoneySpent table displays header and schedule information which is static to all lines of a Recurring
Spend Money transaction. Details about recurring Money Spent allocation lines are detailed within the
RecurringMoneySpentLines table.

Record Field Information


Field Name Type Format Description

*** RecurringMoneySpentID Integer 10xN Unique identifier.

*** IssuingAccountID Integer 10xN The AccountID (Accounts) of the record containing account
information about the cheque account or credit card account
assigned as the issuing cheque/credit card account for this
transaction.

TotalSpentAmount Double 13.2xN Net amount of the cheque.

^^^ CardRecordID Integer 10xN The card attached to this Write Cheque transaction found
within the Cards, Customers, Suppliers, Employees or Personal
Cards table

Payee Text 255xAN Payee text of this transaction.

PayeeLine1 Text 255xAN First line of Payee text, which is sourced from the first character
in the field to the last character before the first carriage return.

PayeeLine2 Text 255xAN Second line of Payee text, which is sourced from the first
character after the first carriage return in the field to the last
character before the second carriage return.

PayeeLine3 Text 255xAN Third line of Payee text, which is sourced from the first character
after the second carriage return in the field to the last character
before the third carriage return.

PayeeLine4 Text 255xAN Fourth line of Payee text, which is sourced from the first
character after the third carriage return in the field to the last
character before the fourth carriage return. Any subsequent text
after the fourth carriage return is not reported.

Memo Text 255xAN Memo text of this entry.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is Tax inclusive.
N = No, Y = Yes.

148 CHAPTER 3 READ TABLES


Field Name Type Format Description

PaymentDeliveryID Text 1xA InvoiceDeliveryID (InvoiceDelivery) of the record containing the


full Payment Notification Delivery Status assigned to the
recurring Spend Money transaction.
P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this entry.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the Spend Money entry.

*** RecurringName Text 30xAN The Recurring Transaction Name as entered within the Edit
Recurring Schedule window.

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing the full
definition of the frequency selected within the Edit Recurring
Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring Schedule
operating system. window.

*** NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring Schedule
operating system. window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is T.

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition of how
long the recurring transaction is scheduled to be performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled to be
operating system. notified / recorded. Only used when the ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled to be
notified / recorded. Only used when the ScheduleID is P.

RECURRINGMONEYSPENT 149
Field Name Type Format Description

RemainingTime Integer 2xN The number of times that the transaction is still required to be
notified / recorded. Only used when the ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how the user
is alerted that a transaction is required to be recorded or that a
transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of the
person notified that a transaction is required to be recorded or
has been recorded.

If AlertID is R, the AlertUserID is the UserID of the person


reminded that the transaction is to be recorded.

If AlertID is A, the AlertUserID is the UserID of the person


notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full definition of
when the user is reminded to record this transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified that
they need to record this transactions. Only used when the
AlertID is R and the AlertTypeID is A.

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing the full


definition of what Cheque # is assigned to the transaction.

N = Use the next sequential number


S = Use the same number

AppliedNumber Text 8xAN The Cheque # applied to all transactions. Only applies to
transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring transaction
are saved when the user records a transaction.
N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction was
operating system. recorded using this recurring template.

150 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

IssuingAccountID Accounts

CardRecordID Cards
Customers
Employees
Suppliers
PersonalCards

CurrencyID Currency

PaymentDeliveryID InvoiceDelivery

CategoryID Categories

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

RECURRINGMONEYSPENT 151
RecurringMoneySpentLines

The RecurringMoneySpentLines table produces a list of allocation lines applicable to a recurring Spend Money
transaction.

Record Field Information


Field Name Type Format Description

*** RecurringMoneySpentLineID Integer 10xN Unique identifier.

*** RecurringMoneySpentID Integer 10xN RecurringMoneySpentID (RecurringMoneySpent) of the


record containing header and schedule information for this
recurring Money Spent line.

LineNumber Integer 10xN The sequence of the entry within the allocation line table.

*** AccountID Integer 10xN The AccountID (Accounts) of the record containing account
information for this line of the allocation table.

TaxExclusiveAmount Double 13.2xN Tax Exclusive amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of
the allocation table.

LineMemo Text 255xAN Memo assigned to the allocation line.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code
for this line of the allocation table.

Foreign Keys Table sourced

RecurringMoneySpentID RecurringMoneySpent

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

152 CHAPTER 3 READ TABLES


RecurringMoneyReceived

The RecurringMoneyReceived table displays header and schedule information which is static to all lines of a
Recurring Receive Money transaction. Details about recurring Receive Money allocation lines are detailed within the
RecurringMoneyReceivedLines table.

Record Field Information


Field Name Type Format Description

*** Integer 10xN Unique identifier.


RecurringMoneyReceivedID

*** RecipientAccountID Integer 10xN The AccountID (Accounts) of the record containing
account information about the cheque account or credit
card account assigned as the depositing cheque/credit
card account for this transaction.

TotalAmountReceived Double 13.2xN Net amount of the deposit.

^^^ MethodOfPaymentID Integer 10xN The PaymentMethodID (PaymentMethods) of the


record containing the Method of Payment.

PaymentCardNumber Text 25xAN Card number.

PaymentNameOnCard Text 50xAN Name on card

PaymentExpirationDate Text 5xAN Expiration date

PaymentNotes Text 255xAN Payment notes.

^^^ CardRecordID Integer 10xN The Payor attached to this Make a Deposit transaction
found within the Cards, Customers, Suppliers,
Employees or Personal cards table

Memo Text 255xAN Memo text of this entry.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is tax


inclusive. N = No, Y = Yes.

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing
currency information for this entry.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the entry.

*** RecurringName Text 30xAN The Recurring Transaction Name as entered within the
Edit Recurring Schedule window.

RECURRINGMONEYRECEIVED 153
Field Name Type Format Description

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing


the full definition of the frequency selected within the
Edit Recurring Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring
operating system. Schedule window.

*** NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring
operating system. Schedule window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is
T.

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition
of how long the recurring transaction is scheduled to be
performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled
operating system. to be notified / recorded. Only used when the
ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled to
be notified / recorded. Only used when the ScheduleID
is P.

RemainingTime Integer 2xN The number of times that the transaction is still required
to be notified / recorded. Only used when the
ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how
the user is alerted that a transaction is required to be
recorded or that a transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

154 CHAPTER 3 READ TABLES


Field Name Type Format Description

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of
the person notified that a transaction is required to be
recorded or has been recorded.

If AlertID is R, the AlertUserID is the UserID of the person


reminded that the transaction is to be recorded.

If AlertID is A, the AlertUserID is the UserID of the person


notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full


definition of when the user is reminded to record this
transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified
that they need to record this transactions. Only used
when the AlertID is R and the AlertTypeID is A.

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing


the full definition of what Cheque # is assigned the
transaction.

N = Use the next sequential number


S = Use the same number

AppliedNumber Text 8xAN The Cheque # applied to all transactions. Only applies to
transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring


transaction are saved when the user records a
transaction. N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction was
operating system. recorded using this recurring template.

Foreign Keys Table sourced

RecipientAccountID Accounts

MethodofPaymentID PaymentMethods

CardRecordID Cards
Customers
Employees
Suppliers
PersonalCards

CurrencyID Currency

CategoryID Categories

RECURRINGMONEYRECEIVED 155
Foreign Keys Table sourced

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

156 CHAPTER 3 READ TABLES


RecurringMoneyReceivedLines

The RecurringMoneyReceivedLines table will produce a listing of allocation lines applicable to a recurring Receive
Money transaction.

Record Field Information


Field Name Type Format Description

*** RecurringMoneyReceivedLineID Integer 10xN Unique identifier.

*** RecurringMoneyReceivedID Integer 10xN RecurringMoneyReceivedID (RecurringMoneyReceived) of


the record containing header and schedule information for
this line.

LineNumber Integer 10xN The sequence of the entry within the allocation line table.

*** AccountID Integer 10xN The AccountID (Accounts) of the record containing
account information for this line of the allocation table.

TaxExclusiveAmount Double 13.2xN Tax Exclusive amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of
the allocation table.

LineMemo Text 255xAN Memo assigned to the allocation line.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the allocation table.

Foreign Keys Table sourced

RecurringMoneyReceivedID RecurringMoneyReceived

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

RECURRINGMONEYRECEIVEDLINES 157
RecurringTransferMoney

The RecurringTransferMoney table displays recurring Transfer Money details. Both the From Account and To
Account details are displayed within the RecurringTransferMoney table.

Record Field Information


Field Name Type Format Description

*** RecurringTransferMoneyID Integer 10xN Unique identifier.

*** FromAccountID Integer 10xN The AccountID (Accounts) of the record containing
information about the account assigned as the Transfer
Money From selection within this transaction.

*** ToAccountID Integer 10xN The AccountID (Accounts) of the The AccountID
(Accounts) of the record containing information about
account assigned as the Transfer Money To selection
within this transaction.

Amount Double 13.2xN Transfer amount

Memo Text 255xAN Memo text of this entry.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is tax


inclusive. N = No, Y = Yes.

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing
currency information for this Write Cheque entry.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the entry.

*** RecurringName Text 30xAN The Recurring Transaction Name as entered within the
Edit Recurring Schedule window.

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing


the full definition of the frequency selected within the
Edit Recurring Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

158 CHAPTER 3 READ TABLES


Field Name Type Format Description

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring
operating system. Schedule window.

*** NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring
operating system. Schedule window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is
T.

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition
of how long the recurring transaction is scheduled to be
performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled
operating system. to be notified / recorded. Only used when the
ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled
to be notified / recorded. Only used when the
ScheduleID is P.

RemainingTime Integer 2xN The number of times that the transaction is still required
to be notified / recorded. Only used when the
ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how
the user is alerted that a transaction is required to be
recorded or that a transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of
the person notified that a transaction is required to be
recorded or has been recorded.
If AlertID is R, the AlertUserID is the UserID of the person
reminded that the transaction is to be recorded.
If AlertID is A, the AlertUserID is the UserID of the person
notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full


definition of when the user is reminded to record this
transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified
that they need to record this transactions. Only used
when the AlertID is R and the AlertTypeID is A.

RECURRINGTRANSFERMONEY 159
Field Name Type Format Description

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing


the full definition of what Cheque # is assigned the
transaction.
N = Use the next sequential number
S = Use the same number

AppliedNumber Text 8xAN The Cheque # applied to all transactions. Only applies
to transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring


transaction are saved when the user records a
transaction. N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction
operating system. was recorded using this recurring template.

Foreign Keys Table sourced

FromAccountID Accounts

ToAccountID Accounts

CurrencyID Currency

CategoryID Categories

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

160 CHAPTER 3 READ TABLES


RecurringGeneralJournals

The RecurringGeneralJournals table displays header and schedule information which is static to all lines of a recurring
General Journal transaction. Details about entries made within the allocation table are detailed within the
RecurringGeneralJournalLines table.

Record Field Information


Field Name Type Format Description

*** RecurringGeneralJournalID Integer 10xN Unique identifier.

Memo Text 255xAN Memo text of this entry.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is Tax


inclusive. N = No, Y = Yes.

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing
currency information for this Write Cheque entry.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the entry.

*** RecurringName Text 30xAN The Recurring Transaction Name as entered within the
Edit Recurring Schedule window.

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing


the full definition of the frequency selected within the
Edit Recurring Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring
operating system. Schedule window.

*** NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring
operating system. Schedule window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is T.

RECURRINGGENERALJOURNALS 161
Field Name Type Format Description

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition
of how long the recurring transaction is scheduled to be
performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled
operating system. to be notified / recorded. Only used when the
ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled to
be notified / recorded. Only used when the ScheduleID
is P.

RemainingTime Integer 2xN The number of times that the transaction is still required
to be notified / recorded. Only used when the
ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how
the user is alerted that a transaction is required to be
recorded or that a transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of
the person notified that a transaction is required to be
recorded or has been recorded.

If AlertID is R, the AlertUserID is the UserID of the person


reminded that the transaction is to be recorded.

If AlertID is A, the AlertUserID is the UserID of the person


notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full


definition of when the user is reminded to record this
transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified
that they need to record this transactions. Only used
when the AlertID is R and the AlertTypeID is A.

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing


the full definition of what Cheque # is assigned the
transaction.

N = Use the next sequential number


S = Use the same number

162 CHAPTER 3 READ TABLES


Field Name Type Format Description

AppliedNumber Text 8xAN The Cheque # applied to all transactions. Only applies to
transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring


transaction are saved when the user records a
transaction. N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction was
operating system. recorded using this recurring template.

Foreign Keys Table sourced

CurrencyID Currency

CategoryID Categories

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

RECURRINGGENERALJOURNALS 163
RecurringGeneralJournalLines

The RecurringGeneralJournalLines table produces a listing of allocation lines applicable to a recurring General
Journal transaction.

Record Field Information


Field Name Type Format Description

*** RecurringGeneralJournalLineID Integer 10xN Unique identifier.

*** RecurringGeneralJournalID Integer 10xN RecurringGeneralJournalID (RecurringGeneralJournals) of


the record containing header and schedule information for
this line.

LineNumber Integer 10xN The sequence of the entry within the allocation line table.

*** AccountID Integer 10xN The AccountID (Accounts) of the record containing account
information for this line of the allocation table.

TaxExclusiveAmount Double 13.2xN Tax Exclusive amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of
the allocation table.

LineMemo Text 255xAN Memo assigned to the allocation line.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the allocation table.

Foreign Keys Table sourced

RecurringGeneralJournalID RecurringGeneralJournals

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

164 CHAPTER 3 READ TABLES


RecurringSales

The RecurringSales table displays header and schedule information which is static to all lines of a recurring Sale
Invoice transaction. Details about entries made within the allocation table are detailed within the RecurringSaleLines
table.

Record Field Information


Field Name Type Format Description

*** RecurringSaleID Integer 10xN Unique identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) of the
record containing customer information for this sale invoice
entry.

ShipToAddress Text 255xAN Ship To address of the sale invoice. Only relevant when the
InvoiceTypeID is S or I.

ShipToAddressLine1 Text 255xAN First line of the Ship To address text, which is sourced from the
first character in the field to the last character before the first
carriage return. Only relevant when the InvoiceTypeID is S or I.

ShipToAddressLine2 Text 255xAN Second line of the Ship To address text, sourced from the first
character after the first carriage return in the field to the last
character before the second carriage return. Only relevant
when the InvoiceTypeID is S or I.

ShipToAddressLine3 Text 255xAN Third line of the Ship To address text, which is sourced from the
first character after the second carriage return in the field to the
last character before the third carriage return. Only relevant
when the InvoiceTypeID is S or I.

ShipToAddressLine4 Text 255xAN Fourth line of the Ship To address text, which is sourced from
the first character after the third carriage return in the field to
the last character before the fourth carriage return. Any
subsequent text after the fourth carriage return is not reported.
Only relevant when the InvoiceTypeID is S or I.

InvoiceTypeID Text 1xAN InvoiceTypeID (InvoiceType) of the


record containing the full sale type
definition.

S = Service
I = Item
P = Professional
T = Time Billing
M = Miscellaneous

InvoiceStatusID Text 2xAN StatusID (Status) of the record containing the full sale invoice
status definition.

Q = Quote
OR = Order
O = Open

RECURRINGSALES 165
Field Name Type Format Description

*** TermsID Integer 10xN The TermsID (Terms) of the record containing terms
information for this sale entry.

TaxExclusiveFreight Double 13.2xN The Tax exclusive freight amount applicable to this sale invoice.
Only relevant when the InvoiceTypeID is S or I.

TaxInclusiveFreight Double 13.2xN The Tax inclusive freight amount applicable to this sale invoice.
Only relevant when the InvoiceTypeID is S or I.

^^^ FreightTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the code
applied against the freight amount on this sale invoice. Only
relevant when the InvoiceTypeID is S or I.

^^^ SalesPersonID Integer 10xN The CardRecordID (Cards) or EmployeeID (Employees) of the
record containing salesperson information for this sale invoice
entry. Only relevant when the InvoiceTypeID is S, I or M.

Memo Text 255xAN Memo text of this entry.

Comment Text 255xAN Comment of the sale invoice. Only relevant when the
InvoiceTypeID is S, I P or T.

^^^ ShippingMethodID Integer 10xN The ShippingMethodID (ShippingMethods) of the record


containing Ship information for this sale invoice entry. Only
relevant when the InvoiceType is S or I.

^^^ ReferralSourceID Integer 10xN The ReferralSourceID (ReferralSources) of the record containing
Referral Source for this sale invoice entry.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is Tax inclusive.
N = No, Y = Yes

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record containing


the full Invoice Delivery Status assigned to the sale

P = To be printed
E = To be emailed
B = To be printed and emailed
A = Already printed or sent

*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this entry.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the entry.

RecurringName Text 30xAN The Recurring Transaction Name as entered within the Edit
Recurring Schedule window.

166 CHAPTER 3 READ TABLES


Field Name Type Format Description

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing the full
definition of the frequency selected within the Edit Recurring
Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring Schedule
operating system. window.

NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring Schedule
operating system. window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is T.

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition of how
long the recurring transaction is scheduled to be performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled to be
operating system. notified / recorded. Only used when the ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled to be
notified / recorded. Only used when the ScheduleID is P.

RemainingTime Integer 2xN The number of times that the transaction is still required to be
notified / recorded. Only used when the ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how the
user is alerted that a transaction is required to be recorded or
that a transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

RECURRINGSALES 167
Field Name Type Format Description

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of the
person notified that a transaction is required to be recorded or
has been recorded.

If AlertID is R, the AlertUserID is the UserID of the person


reminded that the transaction is to be recorded.

If AlertID is A, the AlertUserID is the UserID of the person


notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full definition of
when the user is reminded to record this transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified that
they need to record this transactions. Only used when the
AlertID is R and the AlertTypeID is A.

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing the full


definition of what Cheque # is assigned the transaction.

N = Use the next sequential number


S = Use the same number

AppliedNumber Text 8xAN The Invoice # applied to all transactions. Only applies to
transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring transaction
are saved when the user records a transaction. N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction was
operating system. recorded using this recurring template.

Foreign Keys Table sourced

CardRecordID Cards
Customers

InvoiceTypeID InvoiceType

InvoiceStatusID Status

TermsID Terms

FreightTaxCodeID TaxCodes

SalesPersonID Cards
Employees

ShippingMethodID Methods

ReferralSourceID ReferralSources

168 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

InvoiceDeliveryID InvoiceDelivery

CurrencyID Currency

CategoryID Categories

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

RECURRINGSALES 169
RecurringSaleLines

The RecurringSaleLines table contains information which is static to invoice lines of a recurring sale for all invoice
types. Further detailed information generic to a particular type of invoice is stored within either the
RecurringServiceSaleLines table, the RecurringItemSaleLines table, the RecurringProfessionalSaleLines table, the
RecurringTimeBillingSaleLines table or the RecurringMiscSaleLines table.

Record Field Information


Field Name Type Format Description

*** RecurringSaleLineID Integer 10xN Unique identifier.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the recurring sale template to
which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the allocation line table.

LineTypeID Text 1xAN LineTypeID (LineType) of the


record containing the full line type
definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

Description Text 255xAN Description text of the sale line.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of the sales
invoice.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line
of the sales invoice.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the sale invoice.
The TaxBasisAmt can be stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax exclusive value
N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleID RecurringSales

LineTypeID LineType

JobID Jobs

TaxCodeID TaxCodes

170 CHAPTER 3 READ TABLES


RecurringServiceSaleLines

The RecurringServiceSaleLines table contains recurring service sale invoice line details.

Record Field Information


Field Name Type Format Description

*** RecurringServiceSaleLineID Integer 10xN Unique identifier.

*** RecurringSaleLineID Integer 10xN The RecurringSaleLineID (RecurringSaleLines) of the corresponding record
within the RecurringSaleLines table.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the recurring sale template to
which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information
for this line of the sale invoice.

Description Text 255xAN Description text of the sale line.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of the sale.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the Tax code for this line
of the sale invoice.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the sale invoice. The
TaxBasisAmount can be stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax exclusive value.
N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleLineID RecurringSaleLines

RecurringSaleID RecurringSales

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

RECURRINGSERVICESALELINES 171
RecurringItemSaleLines

The RecurringItemSaleLines table contains recurring Item sale invoice line details.

Record Field Information


Field Name Type Format Description

*** RecurringItemSaleLineID Integer 10xN Unique identifier.

*** RecurringSaleLineID Integer 10xN The RecurringSaleLineID (RecurringSaleLines) of the


corresponding record within the RecurringSaleLines
table.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the recurring


sale template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full
line type definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

Quantity Double 8.3xN The quantity of goods shipped or backordered.

^^^ ItemID Integer 10xN The ItemID (Items) of the record containing item
information for this line of the sale invoice.

Description Text 255xAN Description text of the sale line.

^^^ LocationID Integer 10xN LocationID (Locations) of the location record containing
the full details of the location assigned to this line of the
item sales invoice.

TaxExclusiveUnitPrice Double 11.4xN Tax Exclusive line price.

TaxInclusiveUnitPrice Double 11.4xN Tax Inclusive line price.

Discount 9xN (with a maximum Discount rate applicable to the line of the sale invoice.
of two decimal places. Discount can be greater than 100% only if the rate is
Decimal point counts negative.
as one place.)

TaxExclusiveTotal Double 13.2xN Tax exclusive line total.

TaxInclusiveTotal Double 13.2xN Tax inclusive line total.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line
of the sale.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the sale invoice.

172 CHAPTER 3 READ TABLES


Field Name Type Format Description

SalesTaxCalBasisID Text 3xA PriceLevelID (PriceLevels) of the record containing the full
Sales Tax Calculation Basis definition:

ASP = Actual Selling Price


LC = Last Cost
AC = Average Cost
BSP = Base Selling Price
PLA = Price Level A
PLB = Price Level B
PLC = Price Level C
PLD = Price Level D
PLE = Price Level E
PLF = Price Level F

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the
sale invoice. The TaxBasisAmount can be stored as either
a tax exclusive or a tax inclusive amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax


exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleLineID RecurringSaleLines

RecurringSaleID RecurringSales

LineTypeID LineType

ItemID Items

LocationID Locations

JobID Jobs

TaxCodeID TaxCodes

SalesTaxCalBasisID PriceLevels

RECURRINGITEMSALELINES 173
RecurringProfessionalSaleLines

The RecurringProfessionalSaleLines table contains recurring Professional sale invoice line details.

Record Field Information


Field Name Type Format Description

*** Integer 10xN Unique identifier.


RecurringProfessionalSaleLineID

*** RecurringSaleLineID Integer 10xN The RecurringSaleLineID (RecurringSaleLines) of the


corresponding record within the RecurringSaleLines table.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the recurring sale
template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full
line type definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

LineDate Date Formatted by the Date attached to the line entry. It is not compulsory that
operating system. each professional line entry has a date attached.

Description Text 255xAN Description text of the sale line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing
account information for this line of the sale invoice.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of
the sale.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the sale invoice.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the
sale invoice. The TaxBasisAmount can be stored as either a
tax exclusive or a tax inclusive amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax


exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleLineID RecurringSaleLines

RecurringSaleID RecurringSales

174 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

RECURRINGPROFESSIONALSALELINES 175
RecurringTimeBillingSaleLines

The RecurringTimeBillingSaleLines table contains recurring Time Billing sale invoice line details.

Record Field Information


Field Name Type Format Description

*** RecurringTimeBillingSaleLineID Integer 10xN Unique identifier.

*** RecurringSaleLineID Integer 10xN The RecurringSaleLineID (RecurringSaleLines) of


the corresponding record within the
RecurringSaleLines table.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the


recurring sale template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice
set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the


full line type definition.

D = Data
H = Header
S = Subtotal
W = Without item or account

LineDate Date Formatted by the Date attached to the line entry. It is not compulsory
operating system. that each professional line entry has a date
attached

HoursUnits Double 8.3xN The Hours/Units of activities supplied.

^^^ ActivityID Integer 10xN The ActivityID (Activities) of the record containing
activity information for this line of the sale invoice.

Notes Text 255xAN Notes text of the sale line.

^^^ LocationID Integer 10xN LocationID (Locations) of the Location record


containing full details of the location assigned to
this line of the item sales invoice.

TaxExclusiveRate Double 11.4xN Tax Exclusive line rate.

TaxInclusiveRate Double 11.4xN Tax Inclusive line rate.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for
this line of the sale.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing


the tax code for this line of the sale invoice.

176 CHAPTER 3 READ TABLES


Field Name Type Format Description

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line
of the sale invoice. The TaxBasisAmount can be
stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or


a tax exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleLineID RecurringSaleLines

RecurringSaleID RecurringSales

LineTypeID LineType

ActivityID Activities

LocationID Locations

JobID Jobs

TaxCodeID TaxCodes

RECURRINGTIMEBILLINGSALELINES 177
RecurringMiscSaleLines

The RecurringMiscSaleLines table contains recurring Miscellaneous sale invoice line details.

Record Field Information


Field Name Type Format Description

*** RecurringMiscSaleLineID Integer 10xN Unique identifier.

*** RecurringSaleLineID Integer 10xN The RecurringSaleLineID (RecurringSaleLines) of the corresponding record
within the RecurringSaleLines table.

*** RecurringSaleID Integer 10xN The RecurringSaleID (RecurringSales) of the recurring template to which the
line belongs.

LineNumber Integer 10xN The sequence of the entry within the sale invoice set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

Description Text 255xAN Description text of the Sale Line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account information for
this line of the sale invoice.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of the sale.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this line of
the sale invoice.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the sale invoice. The
TaxBasisAmount can be stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax exclusive value.
N = No, Y = Yes.

Foreign Keys Table sourced

RecurringSaleLineID RecurringSaleLines

RecurringSaleID RecurringSales

LineTypeID LineType

AccountID Accounts

178 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

JobID Jobs

TaxCodeID TaxCodes

RECURRINGMISCSALELINES 179
RecurringPurchases

The RecurringPurchases table displays header and schedule information which is static to all lines of a recurring
Purchase Order transaction. Details about entries made within the allocation table are detailed within the
RecurringPurchaseLines table. The RecurringPurchases table contains one record for each recurring purchase
template. This includes all Quote, Order or Invoice templates.

Record Field Information


Field Name Type Format Description

*** RecurringPurchaseID Integer 10xN Unique identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or SupplierID (Suppliers) of the
record containing customer information for this purchase order
entry.

ShipToAddress Text 255xAN Ship To address of the purchase order. Only relevant when the
PurchaseTypeID is S or I.

ShipToAddressLine1 Text 255xAN First line of the Ship To address text, which is sourced from the
first character in the field to the last character before the first
carriage return. Only relevant when the PurchaseTypeID is S or
I.

ShipToAddressLine2 Text 255xAN Second line of the Ship To address text, sourced from the first
character after the first carriage return in the field to the last
character before the second carriage return. Only relevant
when the PurchaseTypeID is S or I.

ShipToAddressLine3 Text 255xAN Third line of the Ship To address text, which is sourced from the
first character after the second carriage return in the field to the
last character before the third carriage return. Only relevant
when the PurchaseTypeID is S or I.

ShipToAddressLine4 Text 255xAN Fourth line of the Ship To address text, which is sourced from
the first character after the third carriage return in the field to
the last character before the fourth carriage return. Any
subsequent text after the fourth carriage return is not reported.
Only relevant when the PurchaseTypeID is S or I.

PurchaseTypeID Text 1xAN PurchaseTypeID (InvoiceType) of the record containing the full
purchase type definition.

S = Service
I = Item
P = Professional
M = Miscellaneous
PurchaseStatusID Text 2xAN StatusID (Status) of the record containing the full sale purchase
order status definition.

Q = Quote
OR = Order
O = Open

180 CHAPTER 3 READ TABLES


Field Name Type Format Description

*** TermsID Integer 10xN The TermsID (Terms) of the record containing terms
information for this purchase entry.

TaxExclusiveFreight Double 13.2xN The Tax exclusive freight amount applicable to this purchase
order. Only relevant when the PurchaseTypeID is S or I.

TaxInclusiveFreight Double 13.2xN The Tax inclusive freight amount applicable to this purchase
order. Only relevant when the PurchaseTypeID is S or I.

^^^ FreightTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the code
applied against the freight amount on this purchase order.
Only relevant when the PurchaseTypeID is S or I.

Memo Text 255xAN Memo text of this entry.

Comment Text 255xAN Comment of the purchase order. Only relevant when the
PurchaseTypeID is S, I or P.

^^^ ShippingMethodID Integer 10xN The ShippingMethodID (ShippingMethods) of the record


containing Ship information for this purchase order entry. Only
relevant when the PurchaseType is S or I.

IsTaxInclusive Text 1xA Indicates whether the transaction’s status is Tax inclusive
N = No, Y = Yes.

InvoiceDeliveryID Text 1xAN InvoiceDeliveryID (InvoiceDelivery) of the record containing


the full Bill Delivery Status assigned to the purchase

P = To be printed
E = To be emailed
B = To be printed and emailed
A = Already printed or sent
*** CurrencyID Integer 10xN The CurrencyID (Currency) of the record containing currency
information for this entry.

If CurrencyRecordID=0, then is LocalCurrencyRecordID.

If CurrencyRecordID does not equal 0, then is


CurrencyRecordID.

^^^ CategoryID Integer 10xN The CategoryID (Category) of the record containing the
Category assigned to the entry.

RecurringName Text 30xAN The Recurring Transaction Name as entered within the Edit
Recurring Schedule window.

RECURRINGPURCHASES 181
Field Name Type Format Description

FrequencyID Text 2xAN The FrequencyID (Frequencies) of the record containing the
full definition of the frequency selected within the Edit
Recurring Schedule window.

V = Never
D = Daily
W = Weekly
F = Every two weeks
T = Twice a month
3W = Every three weeks
4W = Every four weeks
M = Monthly
O = Every other month
Q = Quarterly
4M = Every four months
6M = Every six months
A = Annually

StartingOn Date Formatted by the Starting on date as assigned within the Edit Recurring Schedule
operating system. window.

NextDue Date Formatted by the Next Due date as assigned within the Edit Recurring Schedule
operating system. window.

RepeatedOn Date Formatted by the Repeated on date as assigned within the Edit Recurring
operating system. Schedule window. Only used when the FrequencyID is T.

ScheduleID Text 1xAN The ScheduleID (Schedule) containing the full definition of
how long the recurring transaction is scheduled to be
performed.

I = Continue Indefinitely
U = Continue until a date
P = Perform a number of times

ContinueUntil Date Formatted by the The date that the recurring transaction is last scheduled to be
operating system. notified / recorded. Only used when the ScheduleID is U.

PerformTimes Integer 2xN The number of times that the transaction is scheduled to be
notified / recorded. Only used when the ScheduleID is P.

RemainingTime Integer 2xN The number of times that the transaction is still required to be
notified / recorded. Only used when the ScheduleID is P.

AlertID Text 1xAN The AlertID (Alerts) containing the full definition of how the
user is alerted that a transaction is required to be recorded or
that a transaction has been recorded.

R = Remind user to record


A = Automatically record and notify user

182 CHAPTER 3 READ TABLES


Field Name Type Format Description

^^^ AlertUserID Integer 10xN UserID (Users) of the record containing user details of the
person notified that a transaction is required to be recorded or
has been recorded.

If AlertID is R, the AlertUserID is the UserID of the person


reminded that the transaction is to be recorded.

If AlertID is A, the AlertUserID is the UserID of the person


notified that a transaction has been recorded.

AlertTypeID Text 1xAN The AlertTypeID (AlertTypes) containing the full definition of
when the user is reminded to record this transaction.

N = Never
D = On its due date
A = # days in advance

Only used when the AlertID is R.

DaysInAdvance Integer 2xN The number of days in advance that the user is notified that
they need to record this transactions. Only used when the
AlertID is R and the AlertTypeID is A.

NumberingTypeID Text 1xAN The NumberingTypeID (NumberingTypes) containing the full


definition of what cheque # is assigned to the transaction.

N = Use the next sequential number


S = Use the same number

AppliedNumber Text 8xAN The Purchase # applied to all transactions. Only applies to
transactions when the NumberingTypeID is S.

RetainChanges Text 1xAN Indicates whether changes made to the recurring transaction
are saved when the user records a transaction. N = No, Y = Yes.

LastPosted Date Formatted by the Transaction date assigned the last time a transaction was
operating system. recorded using this recurring template.

Foreign Keys Table sourced

CardRecordID Cards
Suppliers

PurchaseTypeID InvoiceType

PurchaseStatusID Status

TermsID Terms

FreightTaxCodeID TaxCodes

SalesPersonID Cards
Employees

ShippingMethodID Methods

InvoiceDeliveryID InvoiceDelivery

CurrencyID Currency

RECURRINGPURCHASES 183
Foreign Keys Table sourced

CategoryID Categories

FrequencyID Frequencies

ScheduleID Schedule

AlertID Alerts

AlertUserID Users

AlertTypeID AlertTypes

NumberingTypeID NumberingTypes

184 CHAPTER 3 READ TABLES


RecurringPurchaseLines

The RecurringPurchaseLines table contains information which is static to lines of a recurring purchase order for all
invoice types. Further detailed information generic to a particular type of purchase order is stored within either the
RecurringServicePurchaseLines table, the RecurringItemPurchaseLines table, the RecurringProfessionalPurchaseLines
table or the RecurringMiscPurchaseLines table.

Record Field Information


Field Name Type Format Description

*** RecurringPurchaseLineID Integer 10xN Unique identifier.

*** RecurringPurchaseID Integer 10xN The RecurringPurchaseID (RecurringPurchases) of the recurring


purchase template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line type
definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

Description Text 255xAN Description text of the purchase line.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of the
purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax code for this
line of the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the purchase
order. The TaxBasisAmount can be stored as either a tax exclusive or a
tax inclusive amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax exclusive
value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringPurchaseID RecurringPurchases

LineTypeID LineType

JobID Jobs

TaxCodeID TaxCodes

RECURRINGPURCHASELINES 185
RecurringServicePurchaseLines

The RecurringServicePurchaseLines table contains recurring service purchase order line details.

Record Field Information


Field Name Type Format Description

*** RecurringServicePurchaseLineID Integer 10xN Unique identifier.

*** RecurringPurchaseLineID Integer 10xN The RecurringPurchaseLineID (RecurringPurchaseLines) of


the corresponding record within the
RecurringPurchaseLines table.

*** RecurringPurchaseID Integer 10xN The RecurringPurchaseID (RecurringPurchases) of the


recurring purchase template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full
line type definition.

D = Data
H = Header
S = Subtotal
W = Without item or account

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing
account information for this line of the purchase order.

Description Text 255xAN Description text of the purchase line.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line
of the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the
purchase order. The TaxBasisAmount can be stored as
either a tax exclusive or a tax inclusive amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax


exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringPurchaseLineID RecurringPurchaseLines

RecurringPurchaseID RecurringPurchases

LineTypeID LineType

186 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

RECURRINGSERVICEPURCHASELINES 187
RecurringItemPurchaseLines

The RecurringItemSaleLines table contains recurring Item purchase order line details.

Record Field Information


Field Name Type Format Description

*** RecurringItemPurchaseLineID Integer 10xN Unique identifier.

*** RecurringPurchaseLineID Integer 10xN The RecurringPurchaseLineID


(RecurringPurchaseLines) of the corresponding record
within the RecurringPurchaseLines table.

*** RecurringPurchaseID Integer 10xN The RecurringPurchaseID (RecurringPurchases) of the


recurring purchase order template to which this line
belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order
set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the


full line type definition.

D = Data
H = Header
S = Subtotal
W = Without item or account

Quantity Double 8.3xN The quantity of goods shipped or backordered.

^^^ ItemID Integer 10xN The ItemID (Items) of the record containing item
information for this line of the purchase order.

Description Text 255xAN Description text of the purchase line.

^^^ LocationID Integer 10xN LocationID (Locations) of the location record


containing the full details of the location assigned to
this line of the item purchase order.

TaxExclusiveUnitPrice Double 11.4xN Tax Exclusive line price.

TaxInclusiveUnitPrice Double 11.4xN Tax Inclusive line price.

Discount 9xN (with a maximum Discount rate applicable to the line of the purchase
of two decimal places. order. Discount can be greater than 100% only if the
Decimal point counts rate is negative.
as one place.)

TaxExclusiveTotal Double 13.2xN Tax exclusive line total.

TaxInclusiveTotal Double 13.2xN Tax inclusive line total.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this
line of the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the
tax code for this line of the purchase order.

188 CHAPTER 3 READ TABLES


Field Name Type Format Description

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of
the purchase order. The TaxBasisAmount can be
stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a


tax exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringPurchaseLineID RecurringPurchaseLines

RecurringPurchaseID RecurringPurchases

LineTypeID LineType

ItemID Items

LocationID Locations

JobID Jobs

TaxCodeID TaxCodes

RECURRINGITEMPURCHASELINES 189
RecurringProfessionalPurchaseLines

The RecurringProfessionalPurchaseLines table contains recurring Professional purchase order line details.

Record Field Information


Field Name Type Format Description

*** RecurringProfessionalPurchaseLineID Integer 10xN Unique identifier.

*** RecurringPurchaseLineID Integer 10xN The RecurringPurchaseLineID


(RecurringPurchaseLines) of the corresponding
record within the RecurringPurchaseLines table.

*** RecurringPurchaseID Integer 10xN The RecurringPurchaseID (RecurringPurchases) of


the recurring purchases template to which this line
belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase
order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the


full line type definition.

D = Data
H = Header
S = Subtotal
W = Without item or account

LineDate Date Formatted by the Date attached to the line entry. It is not compulsory
operating system. that each professional line entry has a date attached

Description Text 255xAN Description text of the purchase line.

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing
account information for this line of the purchase
order.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this
line of the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the
tax code for this line of the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line
of the purchase order. The TaxBasisAmount can be
stored as either a tax exclusive or a tax inclusive
amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or


a tax exclusive value. N = No, Y = Yes.

190 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

RecurringPurchaseLineID RecurringPurchaseLines

RecurringPurchaseID RecurringPurchases

LineTypeID LineType

AccountID Accounts

JobID Jobs

TaxCodeID TaxCodes

RECURRINGPROFESSIONALPURCHASELINES 191
RecurringMiscPurchaseLines

The RecurringMiscPurchaseLines table contains recurring Miscellaneous purchase order line details.

Record Field Information


Field Name Type Format Description

*** RecurringMiscPurchaseLineID Integer 10xN Unique identifier.

*** RecurringPurchaseLineID Integer 10xN The RecurringPurchaseLineID (RecurringPurchaseLines) of


the corresponding record within the
RecurringPurchaseLines table.

*** RecurringPurchaseID Integer 10xN The RecurringPurchaseID (RecurringPurchases) of the


recurring sale template to which this line belongs.

LineNumber Integer 10xN The sequence of the entry within the purchase order set.

LineTypeID Text 1xAN LineTypeID (LineType) of the record containing the full line
type definition.
D = Data
H = Header
S = Subtotal
W = Without item or account

Description Text 255xAN Description text of the purchase line

^^^ AccountID Integer 10xN The AccountID (Accounts) of the record containing account
information for this line of the purchase order.

TaxExclusiveAmount Double 13.2xN Tax Exclusive line amount.

TaxInclusiveAmount Double 13.2xN Tax Inclusive line amount.

^^^ JobID Integer 10xN JobID (Jobs) of the record containing the Job for this line of
the purchase order.

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the tax
code for this line of the purchase order.

TaxBasisAmount Double 13.2xN The tax amount used to calculate tax upon this line of the
purchase order. The TaxBasisAmount can be stored as either
a tax exclusive or a tax inclusive amount.

TaxBasisAmountIsInclusive Text 1xA If the TaxBasisAmount is stored as a tax inclusive or a tax


exclusive value. N = No, Y = Yes.

Foreign Keys Table sourced

RecurringPurchaseLineID RecurringPurchaseLines

RecurringPurchaseID RecurringPurchases

LineTypeID LineType

AccountID Accounts

192 CHAPTER 3 READ TABLES


Foreign Keys Table sourced

JobID Jobs

TaxCodeID TaxCodes

RECURRINGMISCPURCHASELINES 193
Sales and Purchases Information

SalesHistory

Record Field Information


Field Name Type Format Description

SalesHistoryID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) of the record
containing customer history information.

FinancialYear Integer 4xN Financial year in which the sales occurred.

Period Integer 2xN The period of the financial year in which the sales occurred.

SaleAmount Double 13.2xN Net sales that occurred during the period.

Foreign Keys Table sourced Notes

CardRecordID Cards Cards are contained in both the Customers and the Cards tables
Customers

194 CHAPTER 3 READ TABLES


PurchasesHistory

Overview
The PurchasesHistory table displays total monthly purchase history for suppliers. Supplier purchase history is stored
and thus reportable for the current financial year, next financial year and the previous five financial years.

Record Field Information


Field Name Type Format Description

PurchasesHistoryID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or SupplierID (Suppliers) of the record
containing supplier history information.

FinancialYear Integer 4xN Financial year in which the purchases occurred.

Period Integer 2xN The period of the financial year in which the purchases occurred.

PurchaseAmount Double 13.2xN Net purchases that occurred during the period.

Foreign Keys Table sourced Notes

CardRecordID Cards Cards are contained in both the Suppliers and the Cards tables
Suppliers

PURCHASESHISTORY 195
SalespersonHistory

Overview
The SalespersonHistory table displays total monthly sales history for employees (salesperson). Salesperson sales
history is stored and thus reportable for the current financial year, next financial year and the previous five financial
years.

Record Field Information


Field Name Type Format Description

SalespersonHistoryID Integer 10xN Unique Identifier.

*** CardRecordID Integer 10xN The CardRecordID (Cards) or EmployeeID (Employees) of the record
containing salesperson history information.

FinancialYear Integer 4xN Financial year in which the sales occurred.

Period Integer 2xN The period of the financial year in which the sales occurred.

SoldAmount Double 13.2xN Net sales which occurred during the period.

Foreign Keys Table sourced Notes

CardRecordID Cards Cards are contained in both the Employees and the Cards tables
Employees

196 CHAPTER 3 READ TABLES


Comments

Overview
Comments can be selected when the user is recording a Service, Item, Professional or Time Billing Sale Invoice or a
Service, Item or Professional Purchase Order. Once the Comment has been selected within the body of the sale
invoice or purchase order, the text of the comment can be edited on the transaction entry window.
The Comments list is purely a list of default comments. There is no direct link between the comment stored within
the body of a sale invoice or purchase order and the default list of comments.

Record Field Information


Field Name Type Format Description

***CommentID Integer 10xN Unique Identifier.

Comment Text 255xAN Comment text.

The Comments table contains no foreign keys.

COMMENTS 197
Methods

Overview
The Shipping Method is directly linked with the sale invoice or purchase order. A Shipping Method selected on a sale
invoice or purchase order will always attach itself to the list of Shipping Methods. If the text of a Shipping Method is
edited, then all existing sale invoices and purchase orders attached to this Shipping Method will also be impacted.

Record Field Information


Field Name Type Format Description

*** ShippingMethodID Integer 10xN Unique Identifier.

ShippingMethod Text 255xAN Shipping method text.

The ShippingMethods table contains no foreign keys.

198 CHAPTER 3 READ TABLES


ReferralSources

Overview
Referral Sources can be selected when the user is recording a Sale Invoice. The Referral Source is selected via the
Referral Source field within the Sale Invoice entry window.
The Referral Source is directly linked with the sale invoice. A Referral Source selected on a sale invoice will always
attach itself to the list of Referral Sources. If the text of a Referral Source is edited, then all existing sale invoices
attached to this Referral Source will also be affected.

Record Field Information


Field Name Type Format Description

*** ReferralSourceID Integer 10xN Unique Identifier.

ReferralSouce Text 20xAN Referral source text.

The ReferralSources table contains no foreign keys.

REFERRALSOURCES 199
Job Information

Jobs

Record Field Information


Field Name Type Format Description

*** JobID Integer 10xN Unique Identifier.

*** ParentJobID Integer 10xN JobsID (Jobs) of the record that is the header to this job.

IsInactive Text 1xAN If the job is active.

JobName Text 25xAN The job name.

*** JobNumber Text 5xAN The job number.

IsHeader Text 1xAN If the job is a header.

JobLevel Integer 1xN The level of the job.

IsTrackingReimburseable Text 1xAN If reimbursable expenses are tracked against this job.

JobDescription Text 255xAN The job description.

ContactName Text 25xAN The job contact.

Manager Text 25xAN The manager of the job.

PercentCompleted Double 99.99 Percent of job completed.

StartDate Date Formatted by the The date the job started, user entered.
operating system

FinishDate Date Formatted by the The date the job was completed, user entered.
operating system

^^^ CustomerID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) or the
customer card assigned as the Linked Customer for this job.

Foreign Keys Table sourced Notes

ParentJobID Jobs Recursive relationship.

CustomerID Cards Card will be contained in both the Customers and the Cards
Customers tables.

200 CHAPTER 3 READ TABLES


JobAccounts

Record Field Information


Field Name Type Format Description

*** JobAccountID Integer 10xN Unique Identifier.

*** JobID Integer 10xN The JobID (Jobs) of the job that owns this job account information.

*** AccountID Integer 10xN The AccountID (Accounts) of the account that owns this job account
information.

OpeningBalance Double 13.2xN The opening balance (user entered) amount for this account within
this job.

CurrentBalance Double 13.2xN All activity assigned to this account within this job. Includes all opening
balance, pre last year, last year, this year and post this year activity.

PreLastYearActivity Double 13.2xN All activity assigned to this account within this job that occurred earlier
than the beginning of last year.

LastYearOpeningBalance Double 13.2xN The balance of this account within this job at the beginning of last
financial year.

ThisYearOpeningBalance Double 13.2xN The balance of this account within this job at the beginning of this
financial year.

PostThisYearActivity Double 13.2xN All activity assigned to this account within this job that occurred after
the end of this year.

Foreign Keys Table sourced

JobID Jobs

AccountID Accounts

JOBACCOUNTS 201
JobAccountActivities

Record Field Information


Field Name Type Format Description

JobAccountActivityID Integer 12xN Unique Identifier.

*** JobID Integer 10xN The JobID (Jobs) of the job that owns this job account information.

*** AccountID Integer 10xN The AccountID (Accounts) of the account that owns this job account
information.

FinancialYear Integer 4xN Financial year in that the activity was generated.

Period Integer 2xN The period of the financial year in that the activity was generated.

Amount Double 13.2xN Net activity within the account for this job.

Foreign Keys Table sourced

JobID Jobs

AccountID Accounts

202 CHAPTER 3 READ TABLES


JobBudgets

Overview
The JobBudgets table displays information regarding job budgets. Each Job Account represented in the JobAccounts
table will only have one budget figure representing the budget value of this job account for the lifetime of the job.
Each account could be represented several times within JobAccounts table but each representation is linked to a
different JobID.
JobBudget records are generated for every account including those whereby a zero value is budgeted.

Record Field Information


Field Name Type Format Description

*** JobBudgetID Integer 10xN Unique Identifier.

*** JobID Integer 10xN The JobID (Jobs) of the job that owns this budget information.

*** AccountID Integer 10xN The AccountID (Accounts) of the account to which this budget amount relates.

Amount Double 13.2xN Budgeted activity within profit and loss accounts or budgeted balance of
balance sheet accounts.

Foreign Keys Table sourced

JobID Jobs

AccountID Accounts

JOBBUDGETS 203
JobJournalRecords

Overview
The JobJournalRecords table contains job allocation postings.
Each JobJournalRecord record links back to a record within the JournalRecord table. Sale Invoice and Purchase Order
JournalRecords can have more than the one JobJournalRecord pointing to the same JournalRecord transaction. Sale
invoice and purchase order transactions are consolidated before posting to the JournalRecords table. The sum of Sale
Invoice and Purchase Order JobJournalRecords allocated to the same JournalRecord transaction should equal the
amount of the JournalRecord.
JobJournalRecords sourced from sale invoice or purchase order transactions also have a direct link with the SaleLines
or PurchaseLines table. This link is presented via the SalePurchaseLineID field.

Record Field Information


Field Name Type Format Description

*** JobJournalRecordID Integer 10xN Unique Identifier.

Date Date Formatted by the Transaction date of this entry.


operating system To avoid SQL reserved word conflicts, use the TransactionDate
field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same data
operating system as the Date field above.

IsThirteenthPeriod Text 1xAN Y/N flag.

*** JobID Integer 10xN The JobID (Jobs) of the job attached to this journal record.

TaxExclusiveAmount Double 13.2xN The amount of this allocation.

*** JournalRecordID Integer 10xN The JournalRecordID (JournalRecords) of the journal record to
which this job journal record applies.

*** SalePurchaseLineID Integer 10xN If the JournalTypeID = SI:

The SaleLineID (SaleLines) of the sale invoice line for this


allocation. Will also have a corresponding entry within either the
ServiceSaleLines, or ItemSaleLines, or ProfessionalSaleLines, or
TimeBillingSaleLines, or Miscellaneous SaleLines tables.

If the JournalTypeID = PO:

The PurchaseLineID (PurchaseLines) of the purchase order line


for this allocation. Will also have a corresponding entry within
either the ServicePurchaseLines, or ItemPurchaseLines, or
ProfessionalPurchaseLines, or MiscPurchaseLines tables.

JournalTypeID Text 3xAN JournalTypeID (JournalTypes) of the record containing the full
journal type definition.

204 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsReimbursed Text 1xAN Flag field to indicate whether the entry has been reimbursed or
removed from the list of reimbursable expenses.

TransactionNumber Text 10xAN Journal ID# of this transaction.

*** AccountID Integer 10xN The AccountID of the account associated with this amount.

Foreign Keys Table sourced Notes

JobID Jobs

JournalRecordID JournalRecords

SalePurchaseLineID GeneralJournals Source ID could be linked to any of the


MoneySpent following tables:
MoneyReceived
SaleLines GeneralJournals
ServiceSaleLines MoneySpent
ItemSaleLines MoneyReceived
ProfessionalSaleLines SaleInvoices
TimeBillingSaleLines PurchaseOrders
MiscSaleLines InventoryAdjustments
PurchaseLines InventoryTransfers
ServicePurchaseLines
ItemPurchaseLines
ProfessionalPurchaseLines
MiscPurchaseLines
InventoryAdjustmentLines
InventoryTransfers

JournalTypeID JournalTypes

AccountID Accounts

JOBJOURNALRECORDS 205
Category Information

Categories

Overview
The Categories table contains details of each category created in the company file.

Record Field Information


Field Name Type Format Description

*** CategoryID Integer 10xN The unique identifier for the category.

CategoryName Text 30xAN The category name.

*** CategoryIdentification Text 15xAN The category identification.

CategoryDescription Text 255xAN The description text for the category.

IsInactive Text 1xAN Y/N flag indicates if the category inactive.

The Categories table contains no foreign keys.

206 CHAPTER 3 READ TABLES


CategoryAccounts

Overview
The CategoryAccounts table presents the account–category relationship.

Record Field Information


Field Name Type Format Description

*** CategoryAccountID Integer 10xN The unique identifier for the category account.

*** CategoryID Integer 10xN The category ID.

*** AccountID Integer 10xN The ID of the account.

CurrentBalance Double 13.2xN All activity assigned to this account within this cost centre.
Includes all opening balance, pre last year, last year, this
year and post this year activity.

PreLastYearActivity Double 13.2xN All activity assigned to this account within this cost centre
that occurred earlier than the beginning of last year.

LastYearOpeningBalance Double 13.2xN The balance of this account within this cost centre at the
beginning of last financial year.

ThisYearOpeningBalance Double 13.2xN The balance of this account within this cost centre at the
beginning of this financial year.

PostThisYearActivity Double 13.2xN All activity assigned to this account within this cost centre
that occurred after the end of this year.

Foreign Keys Table sourced

CategoryID Categories

AccountID Accounts

CATEGORYACCOUNTS 207
CategoryAccountActivities

Overview
The CategoryAccountActivities table contains details of the account activity for each category created in the
company file.

Record Field Information


Field Name Type Format Description

CategoryAccountActivityID Integer 12xN This unique identifier is assigned by ODBC.

*** CategoryID Integer 10xN The Category ID.

*** AccountID Integer 10xN The ID of the account

FinancialYear Integer 4xN Financial year in which the activity was generated.

Period Integer 2xN The period of the financial year in which the activity was generated,
1-13.

Amount Double 13.2xN Net activity within the account for this category.

Foreign Keys Table sourced

CategoryID Categories

AccountID Accounts

208 CHAPTER 3 READ TABLES


CategoryJournalRecords

Overview
The CategoryJournalRecords table contains details of the account activity for each category created in the company
file.

Record Field Information


Field Name Type Format Description

*** CategoryJournalRecordID Integer 10xN This unique identifier is for the category Journal Record.

TransactionNumber Text 10xAN Journal ID# of this transaction.

Date Date Formatted by the Transaction date of this entry. To avoid SQL reserved word
operating system. conflicts, use the TransactionDate field below.

TransactionDate Date Formatted by the Transaction date of this entry. This field contains the same
operating system. data as the Date field above.

IsThirteenthPeriod Text 1xAN Y/N flag indicates if the transaction was recorded as a
thirteenth period transaction.

*** CategoryID Integer 10xN The category ID.

*** AccountID Integer 10xN The ID of the account assigned to the journal.

TaxExclusiveAmount Double 13.2xN The amount of this allocation.

*** JournalRecordID Integer 10xN The ID of the journal record.

JournalTypeID Text 3xAN The ID of the journal type.

Foreign Keys Table sourced

CategoryID Categories

AccountID Accounts

JournalRecordID JournalRecords

JournalTypeID JournalTypes

CATEGORYJOURNALRECORDS 209
Tax Records

TaxCodes

Overview
The TaxCodes table displays all consolidated and non-consolidated Tax codes. Information regarding sub-taxes that
make up a consolidated Tax code is presented within the TaxCodeConsolidations table.
The TaxCodes table contains one record for each Tax Code in the company file. The TaxCodes table contains all
information presented within the Tax Code Information window.

Record Field Information


Field Name Type Format Description

*** TaxCodeID Integer 10xN Unique Identifier.

*** TaxCode Text 3xAN The up to 3 digit code assigned to the tax code.

TaxCodeDescription Text 30xAN The description given to the tax code.

TaxPercentageRate Double 8.4xN The rate of tax expressed as a percentage.

TaxCodeTypeID Text 3xAN The TaxType of the tax code.


C = Consolidated
ID = Import Duty
ST = Sales Tax
GST = Goods and Services Tax
IT = Input Taxed

^^^ TaxCollectedAccountID Integer 10xN The AccountID (Accounts) of the record containing account
information about the Linked Account for Tax Collected or information
about the Account for Withholding Credits.

^^^ TaxPaidAccountID Integer 10xN The AccountID (Accounts) of the record containing account
information about the Linked Account for Tax Paid.

^^^ LinkedCardID Integer 10xN The CardRecordID (Cards) or SupplierID (Suppliers) of the record
containing Suppliers information about the Linked Card.

Foreign Keys Table sourced Notes

TaxCodeTypeID TaxCodeConsolidations

TaxCollectedAccountID Accounts

210 CHAPTER 3 READ TABLES


Foreign Keys Table sourced Notes

TaxPaidAccountID Accounts

LinkedCardID Cards Cards are contained in both the Supplier


Suppliers and the Cards tables

TAXCODES 211
TaxCodeConsolidations

Overview
The TaxCodeConsolidations table displays a listing of non-consolidated tax codes that make up a consolidated tax
code. The TaxCodeConsolidations table contains one record for each element Tax Code within a consolidation.

Record Field Information


Field Name Type Format Description

*** TaxCodeConsolidationID Integer 10xN Unique Identifier.

*** ConsolidatedTaxCodeID Integer 10xN The TaxCodeID (TaxCodes) of the record that is the consolidated
tax code of the tax code element.

*** ElementTaxCodeID Integer 10xN The TaxCodeID (TaxCodes) of the record that is the tax code
element of the consolidated tax code.

Foreign Keys Table sourced

ConsolidatedTaxCodeID TaxCodes

ElementTaxCodeID TaxCodes

212 CHAPTER 3 READ TABLES


TaxInformation

Overview
TaxInformation records are only available in transactions whereby the user has the ability to assign a tax code to a
line of the transaction, thus the following types of transactions can have a Tax information record:
„ Sale Invoices (all types)
„ Purchase Orders (all types)
„ Money Spent
„ Money Received
„ General Journal
The TaxInformation record can be linked back to its originating transaction via the TransactionID record within the
table. As the TaxInformation record could be linked to one of five tables, the TransactionID must be read in
conjunction with the TransactionType field. The TransactionType field indicates the originating source of the
TaxInformation record. Below is a summary of TransactionType entries and appropriate ODBC table containing
details of the originating transaction:

TransactionType ODBC Table Primary Key

SI Sales SaleID

PO Purchases PurchaseID

GJ GeneralJournals GeneralJournalID

MS MoneySpent MoneySpentID

MR MoneyReceived MoneyReceivedID

Record Field Information


Field Name Type Format Description

*** TaxInformationID Integer 10xN Unique Identifier.

*** TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing information about the
Tax Code.

JournalTypeID Text 2xAN JournalTypeID (JournalTypes) of the record containing the full journal
type definition.

TransactionID Integer 10xN The SalesID (or PurchaseID, GeneralJournalID, MoneySpentID,


MoneyReceivedID) of the transaction that generated the tax information
record.

TaxPercentageRate Double 8.4xN The tax rate applicable to this tax code at the time this tax information
record was produced.

TaxableAmount Double 13.2xN The total of all tax exclusive line amounts applied with this tax code or a
consolidation that contains this tax code.

TaxBasisAmount Double 13.2xN The tax exclusive amount used when calculating the tax amount.

TAXINFORMATION 213
Field Name Type Format Description

TaxAmount Double 13.2xN The amount of tax applied against transactions lines with this tax code.

TaxAmountIsChanged Text 1xAN If the user has manually edited the tax amount within the Tax Information
window from its calculated amount.

Foreign Keys Table sourced Notes

JournalTypeID JournalTypes

TransactionID GeneralJournals TransactionID could be linked to any of the following tables:


MoneySpent GeneralJournals
MoneyReceived MoneySpent
Sales MoneyReceived
Purchases SalesInvoices
PurchaseOrders

TaxCodeID TaxCodes

214 CHAPTER 3 READ TABLES


TaxInformationConsolidations

Overview
Whenever a consolidated tax code is used on a transaction, a break-up occurs from the consolidated tax code to the
consolidation elements. The TaxInformationConsolidations table displays the component of an element displayed
within the TaxInformation table towards the consolidated tax code.

Record Field Information


Field Name Type Format Description

*** TaxInformationConsolidationID Integer 10xN Unique Identifier.

*** ConsolidationTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing information
about the consolidation tax code.

*** ElementTaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing information
about the element tax code.

JournalTypeID Text 2xAN The type of transaction that generated the TaxInformation record.

TransactionID Integer 10xN The SalesID (or PurchaseID, GeneralJournalID, MoneySpentID,


MoneyReceivedID) of the transaction that generated the tax
information record.

ElementTaxableAmount Double 13.2xN Tax Information records generated by Purchase Orders, Spend
Money and General Journals are stored in the negative
parenthesis. To correct, the TaxableAmount stored within the tax
information record should be reversed when its creator is one of
the above mentioned transaction types.

ElementTaxBasisAmount Double 13.2xN Tax Information records generated by Purchase Orders, Spend
Money and General Journals whereby the Display in GST [BAS]
radio button selection is Purchase (Acquisition) are stored in the
negative parenthesis. To correct, the TaxBasisAmount stored
within the tax information record should be reversed when its
creator is one of the above mentioned transaction types.

ElementTaxAmount Double 13.2xN Tax Information records generated by Purchase Orders, Spend
Money and General Journals whereby the Display in GST [BAS]
radio button selection is Purchase (Acquisition) are stored in the
negative parenthesis. To correct, the TaxAmount stored within
the tax information record should be reversed when its creator is
one of the above mentioned transaction types.

Foreign Keys Table sourced Notes

JournalTypeID JournalTypes

ConsolidationTaxCodeID TaxCodes

TAXINFORMATIONCONSOLIDATIONS 215
Foreign Keys Table sourced Notes

TransactionID GeneralJournals TransactionID could be linked to any of the following tables:


MoneySpent GeneralJournals
MoneyReceived MoneySpent
Sales MoneyReceived
Purchases SalesInvoices
PurchaseOrders

ElementTaxCodeID TaxCodes

216 CHAPTER 3 READ TABLES


Item and Activity Information

Items

Overview
The Items table contains one record for each inventory item. The Items table reports all information that can be
assigned within the Item Information window.

Record Field Information


Field Name Type Format Description

*** ItemID Integer 10xN Unique Identifier.

IsInactive Text 1xANN Indicates if item is inactive.

*** ItemName Text 30xAN The item name.

*** ItemNumber Text 30xAN The item number.

QuantityOnHand Double 12.3xN The quantity of units held in inventory.

ValueOnHand Double 21.2xN The dollar value of units held in inventory.

PositiveAverageCost Double 21.2xN The item’s average cost displayed in the Item Information window
when the quantity on hand is equal to or greater than zero.

SellOnOrder Double 12.3xN The quantity of this item held in pending sale invoices.

PurchaseOnOrder Double 12.3xN The quantity of this item held in pending purchase orders.

ReceivedOnOrder Double 12.3xN The quantity of received items contained within purchase orders of
the status Order.

QuantityAvailable Double 12.3xN The calculated quantity of this item available for sale.

LastUnitPrice Double 11.4xN The last tax exclusive unit price assigned to this item on a Sale
Invoice or Purchase Order.

NegativeQuantityOnHand Double 12.3xN The number of items received into inventory whilst the
QuantityOnHand is less than zero.

NegativeValueOnHand Double 21.2xN This field is no longer used.

NegativeAverageCost Double 21.2xN The item’s average cost displayed within the Profile tab of the Item
Information window when the QuantityOnHand is less than zero.

ItemIsSold Text 1xAN Indicates if the item is sold.

ItemIsBought Text 1xAN Indicates if the item is bought.

ItemIsInventoried Text 1xAN Indicates if the item is inventoried.

^^^ IncomeAccountID Integer 10xN The AccountID of the record containing the income account for
tracking sales.

ITEM AND ACTIVITY INFORMATION 217


Field Name Type Format Description

^^^ ExpenseAccountID Integer 10xN The AccountID of the record containing either the expense
account for tracking expenses (non-inventoried item) or the cost of
sales Account (inventoried item).

^^^ InventoryAccountID Integer 10xN The AccountID of the record containing the asset account for item
inventory.

ItemDescription Text 255xAN Extended Description of the item.

UseDescription Text 1xAN Use description text instead of item name on sale invoices and
purchase orders. Is only used within the Premier release.

^^^ CustomList1ID Integer 10xN The CustomListID of the record containing the Custom List 1
selection for this inventory item. Is only used within the Premier
release.

^^^ CustomList2ID Integer 10xN The CustomListID (CustomLists) of the record containing the
Custom List 2 selection for this inventory item. Is only used within
the Premier release.

^^^ CustomList3ID Integer 10xN The CustomListID of the record containing the Custom List 3
selection for this inventory item. Is only used within the Premier
release.

CustomField1 Text 30xAN Custom Field 1 text attached to this item. Custom Field 1 is only
used within the Premier release.

CustomField2 Text 30xAN Custom Field 2 text attached to this item. Custom Field 2 is only
used within the Premier release.

CustomField3 Text 30xAN Custom Field 3 text attached to this item. Custom Field 3 is only
used within the Premier release.

BaseSellingPrice Double 11.4xN The item’s base selling price.

PriceIsInclusive Text 1xAN Y/N flag indicating whether the selling prices attached to this item
are quoted inclusive of tax.

^^^ SellTaxCodeID Integer 10xN TaxCodeID of the record containing the Tax Code When Sold for
this inventory item. Note: The SellTaxCode will not always be the
default tax code used when generating a sale invoice. The
SellTaxCode must be read in conjunction with the
UseCustomerTaxCode selection within the Customer table.

SalesTaxCalcBasisID Text 3xAN PriceLevelID of the record containing the full Sales Tax Calculation
Basis Definition.

SellUnitMeasure Text 5xAN Selling unit of measure.

SellUnitQuantity Integer 4xN Number of items per selling unit.

TaxInclusiveLastPurchasePrice Double 11.4xN The item’s price per unit when last purchased.

TaxExclusiveLastPurchasePrice Double 11.4xN The item’s tax exclusive price per unit when last purchased.

TaxInclusiveStandardCost Double 11.4xN The item’s Standard Cost.

TaxExclusiveStandardCost Double 11.4xN The item’s tax exclusive Standard Cost.

^^^ BuyTaxCodeID Integer 10xN TaxCodeID of the record containing the Tax Code When Bought
for this inventory item. Note: The BuyTaxCode will not always be
the default tax code used when generating a purchase order. The
BuyTaxCode must be read in conjunction with the
UseSupplierTaxCode selection within the Supplier table.

218 CHAPTER 3 READ TABLES


Field Name Type Format Description

BuyUnitMeasure Text 5xAN Buying unit of measure.

BuyUnitQuantity Integer 4xN Number of items per buying unit.

^^^ PrimarySupplierID Integer 10xN The CardRecordID or SupplierID or the record containing
information about the primary supplier for reorders.

SupplierItemNumber Text 30xAN The Supplier item number.

MinLevelBeforeReorder Double 10.3xN The minimum number of items on hand before needing to reorder.

DefaultReorderQuantity Double 10.3xN Default number of units to buy on auto reorder.

DefaultSellLocationID Integer 10xN LocationID (Locations) of the record containing full details of the
default location assigned to the item within the Sales window or
assigned to the item with a negative quantity within the Build Items
window.

DefaultReceiveLocationID Integer 10xN LocationID (Locations) of the record containing full details of the
default location assigned to the item within the Purchases window
or assigned to the item with a positive quantity within the Build
Items window.

ChangeControl Text 10xAN Number used to control change within the record. Value is
incremented whenever the record is updated.

Picture Text 255xAN Name of bitmap file attached to this item.

Foreign Keys Table sourced Notes

IncomeAccountID Accounts

ExpenseAccountID Accounts

InventoryAccountID Accounts

CustomList1ID CustomLists

CustomList2ID CustomLists

CustomList3ID CustomLists

DefaultSellLocationID Locations

DefaultReceiveLocationID Locations

PrimarySupplierID Cards Card will be contained in both the Suppliers and the Cards tables.
Suppliers

SellTaxCodeID TaxCodes

SalesTaxCalcBasisID PriceLevels

BuyTaxCodeID TaxCodes

ITEMS 219
MoveItems

Overview
The Move Items table provides details of move item transactions. A MoveItem record is generated for each line of
the Move Items window which contains a cell with an item movement.

Record Field Information


Field Name Type Format Description

MoveItemsID Integer 10xN Unique identifier.

MoveDate Date Formatted by the Session date the movement occurred.


operating system

*** ItemID Integer 10xN The ItemID (Items) of the record containing information for the
item that was moved.

Description Text 255xAN Description of the move item change.

UserID Integer 10xN UserID (Users) for the creator of this MoveItem record.

Foreign Keys Table sourced

ItemID Items

UserID Users

220 CHAPTER 3 READ TABLES


Locations

Overview
The Locations table contains information about locations displayed within the Location Information window.

Record Field Information


Field Name Type Format Description

*** LocationID Integer 10xN Unique identifier.

IsInactive Text 1xAN Indicates if the location is active. N = No, Y = Yes.

CanBeSold Text 1xAN If items can be sold or shipped from this location. N = No, Y = Yes.

*** LocationIdentification Text 10xAN The Location ID

LocationName Text 30xAN The name of the location.

Street Text 255xAN Address of the location.

City Text 255xAN City of the location.

State Text 255xAN State of the location.

Postcode Text 11xAN Postcode of the location.

Country Text 255xAN Country of the location.

Contact Text 255xAN Contact of the location.

ContactPhone Text 21xAN Contact phone number of the location.

Notes Text 255xAN Notes for the location.

The Locations Table contains no foreign keys.

LOCATIONS 221
ItemLocations

Overview
Items can be stored in multiple locations. The ItemLocations table provides a breakdown of quantities stored within
each location.

Record Field Information


Field Name Type Format Description

*** ItemLocationID Integer 10xN Unique identifier.

*** ItemID Integer 10xN ItemID (Items) of the Item record containing full details of the item.

*** LocationID Integer 10xN LocationID (Locations) of the location record containing full details of
the location.

QuantityOnHand Double 12.3xN The quantity of units held in inventory at this location.

SellOnOrder Double 12.3xN The quantity of this item in Order sale invoices at this location.

PurchaseOnOrder Double 12.3xN The quantity of this item in Order purchases at this location.

Foreign Keys Table sourced

ItemID Items

LocationID Locations

222 CHAPTER 3 READ TABLES


ItemPrices

Overview
The ItemPrices table has removed the selling price matrix from the Items table to generate its own table. Note that
the selling price matrix feature is only available in certain versions of MYOB business management software.
QuantityBreak and QuantityBreakAmount fields have been included. The QuantityBreak field provides the user with
a value of 1 to 5 whereas the QuantityBreakAmount field provides the user with the numeric amount from where the
level commences. Additionally, the PriceLevel and PriceLevelName fields have been included. The PriceLevel field
provides the user with an A to F value whereas the PriceLevelName field provides the user with a link to the user
defined field name. User-defined field names are reported within the table PriceLevels.

Record Field Information


Field Name Type Format Description

ItemPriceID Integer 12xN Unique Identifier.

*** ItemID Integer 10xN ItemID of item record that owns this selling price.

QuantityBreak Integer 1xN Quantity break level applicable to this selling price.

QuantityBreakAmount Double 10.3xN The quantity break amount applicable to this selling price.

PriceLevel Text 1xAN The price level applicable to this selling price.

PriceLevelNameID Text 3xAN PriceLevelID of the record containing the full Price Level
definition.

SellingPrice Double 11.4xN The items selling price from the price matrix. All item selling
prices are stored in the local currency.

PriceIsInclusive Text 1xA Y/N flag indicating if item selling price is tax inclusive.

ChangeControl Text 5xAN Number used to control change within the record. Value is
incremented whenever the record is updated.

Foreign Keys Table sourced

ItemID Items

PriceLevelNameID PriceLevels

ITEMPRICES 223
ItemMovement

Overview
The ItemMovement table displays monthly movement within an item’s Quantity On Hand and Current Value. Item
movement may be stored and thus reportable for the current financial year, the next financial year and the previous
four financial years.

Record Field Information


Field Name Type Format Description

ItemMovementID Integer 10xN Unique identifier.

*** ItemID Integer 10xN Id of the Item.

FinancialYear Integer 4xN Financial year in which the movement occurred.

Period Integer 2xN The period of the financial year in which the movement occurred, 1-13.

UnitChange Double 10.3xN The change in the items Quantity on Hand which occurred during the
period.

DollarChange Double 13.2xN The change in the items Current Value which occurred during the period.

Foreign Keys Table sourced

ItemID Items

224 CHAPTER 3 READ TABLES


ItemOpeningBalance

Overview
The ItemOpeningBalance table displays an item’s Quantity On Hand and Current Value at the beginning of the
financial year.

Record Field Information


Field Name Type Format Description

*** ItemOpeningBalanceID Integer 10xN Unique identifier.

*** ItemID Integer 10xN ID of the Item.

FinancialYear Integer 4xN The applicable financial year.

Units Double 10.3xN The item’s quantity on hand at the beginning of the financial year.

Dollars Double 13.2xN The item’s current value at the beginning of the financial year.

Foreign Keys Table sourced

ItemID Items

ITEMOPENINGBALANCE 225
ItemSalesHistory

Overview
The ItemSalesHistory table displays total monthly unit sales, dollar sales and cost of sales for items. Item sales history
is stored and thus reportable for the current financial year, next financial year and the previous five financial years.

Record Field Information


Field Name Type Format Description

ItemSalesHistoryID Integer 10xN Unique Identifier.

*** ItemID Integer 10xN ItemID of the item record that owns this sale activity.

FinancialYear Integer 4xN Financial year in that the sales occurred.

Period Integer 2xN The period of the financial year in that the sales occurred.

UnitsSold Double 10.2xN The number of units sold during the period.

SaleAmount Double 13.2xN The dollar value of sales that occurred during the period.

CostOfSalesAmount Double 13.2xN The dollar cost of sales value of inventoried goods sold during the
reporting period.

Foreign Keys Table sourced

ItemID Items

226 CHAPTER 3 READ TABLES


ItemPurchasesHistory

Overview
The ItemPurchasesHistory table displays total monthly unit purchases and dollar purchases for items. Item purchase
history is stored and thus reportable for the current financial year, next financial year and the previous five financial
years.

Record Field Information


Field Name Type Format Description

ItemPurchasesHistoryID Integer 10xN Unique Identifier.

*** ItemID Integer 10xN ItemID of item record that owns this purchase activity.

FinancialYear Integer 4xN Financial year in that the purchases occurred.

Period Integer 2xN The period of the financial year in that the purchases occurred.

UnitsBought Double 10.2xN The number of units bought during the period.

PurchaseAmount Double 13.2xN The dollar value of purchases that occurred during the period.

Foreign Keys Table sourced

ItemID Items

ITEMPURCHASESHISTORY 227
BuiltItems

Record Field Information


Field Name Type Format Description

*** BuiltItemID Integer 10xN Unique Identifier.

*** ItemID Integer 10xN The ItemID of the inventoried item that is being built.

QuantityBuilt Double 11.3xN The minimum quantity that can be built of this item. Additional quantities can
be built provided they are in multiples of the QuantityBuilt.

Foreign Keys Table sourced

ItemID Items

228 CHAPTER 3 READ TABLES


BuildComponents

Overview
The BuildComponents table can be linked with the BuiltItems table via the BuiltItemID foreign key within the
BuildComponents table.

Record Field Information


Field Name Type Format Description

*** BuildComponentID Integer 10xN Unique Identifier.

*** BuiltItemID Integer 10xN The BuiltItemID of the built item to that this item is a component.

SequenceNumber Integer 10xN The sequence of the component within the bill of materials.

*** ComponentID Integer 10xN The ItemID of the record containing item details about this bill of
material.

QuantityNeeded Double 11.3xN The quantity of this component used in making the specified
QuantityBuilt of the BuiltItem.

Foreign Keys Table sourced

BuiltItemID BuiltItems

ComponentID Items

BUILDCOMPONENTS 229
NegativeInventory

Overview
The NegativeInventory table provides a link between the SaleLines record that resulted in an item obtaining a
negative on-hand quantity and ItemPurchaseLines, InventoryAdjustmentLines and InventoryTransferLines records
that utilised the negative on-hand quantity.
The link between the negative on-hand generating SaleLine record and those records that utilise the negative
on-hand quantity is used to calculate differences between the UnitCost value assigned to the originating SaleLine
record and the record that utilises the negative on-hand quantity.

Record Field Information


Field Name Type Format Description

*** NegativeInventoryID Integer 10xN Unique identifier.

SaleLineID Integer 10xN The SaleLineID (SaleLines) of the sale invoice line for this allocation. Will
also have a corresponding entry within the ItemSaleLines, or
ProfessionalSaleLines, or TimeBillingSaleLines, or
MiscellaneousSaleLines tables.

Quantity Double 8.3xN The Quantity of the item not yet offset, or the quantity being used.

IsCreditOffset Text 1xA Indicates if the negative inventory record has been offset by a credit
note: N = No, Y = Yes.

UnitCost Double 13.4xN The last average cost value applied.

ActualCost Double 13.4xN The current average cost value.

BaseCost Double 13.4xN The average cost value applied at the time that the negative inventory
record was created.

LineCost Double 13.4xN The cost used on the purchase order.

ItemID Integer 10xN The ItemID (Items) of the record containing item information.

LocationID Integer 10xN LocationID (Locations) of the record containing full details of the
location assigned to the SaleLineID record.

^^^ TransactionID Integer 10xN The SaleLineID (SaleLines) or InventoryAdjustmentLineID


(InventoryAdjustmentLines) or InventoryTransferLineID
(InventoryTransferLines) of the line of the transaction that generated
the record.

SaleLineIsPurged Text 1xAN Indicates whether the SaleLineID record has been purged:
N = No, Y = Yes.

230 CHAPTER 3 READ TABLES


Field Name Type Format Description

TransactionIsPurged Text 1xAN Indicates whether the TransactionID record has been purged:
N = No, Y = Yes.

JournalTypeID Text 3xAN The JournalTypeID (JournalTypes) of the transaction that caused the
item on hand to go into negative:

SI = Sales Invoice
PO = Purchase Order
IA= Inventory Adjustment
IT = Inventory Transfer

Foreign Keys Table sourced

SaleLineID SaleLines

ItemID Items

LocationID Locations

TransactionID SaleLines
InventoryAdjustmentLines
InventoryTransfers

JournalTypeID JournalTypes

NEGATIVEINVENTORY 231
Activities

Overview
The Activities table contains one record for each activity. The Activities table contains all information displayed within
the Activity Information window. Activities can be sold but cannot be purchased.

Record Field Information


Field Name Type Format Description

*** ActivityID Integer 10xN Unique Identifier.

IsInactive Text 1xAN Y/N flag indicating if this activity is inactive.

*** ActivityName Text 30xAN The Activity name.

*** ActivityNumber Text 30xAN The Activity ID

^^^ IncomeAccountID Integer 10xN The AccountID (Accounts) of the record containing the Income Account.

IsHourly Text 1xAN Y/N flag indicating if the Activity Type is hourly.

IsChargeable Text 1xAN Y/N flag indicating if the Activity Status is chargeable.

BillingRateUsedID Text 1xAN (BillingRateUsed) Indicates whether to use the employee, customer or
activity billing rate.
E = Employee
C = Customer
A = Activity

ActivityDescription Text 255xAN Description of the item.

UseDescription Text 1xAN Use description text instead of activity name on sale invoices.
N = No, Y = Yes.

ActivityRate Double 11.4xN The Activity Rate

^^^ TaxCodeID Integer 10xN TaxCodeID (TaxCodes) of the record containing the Tax Code When Sold
for this activity.

SellUnitMeasure Text 5xAN The unit of measure.

ChangeControl Integer 10xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

Foreign Keys Table sourced

IncomeAccountID Accounts

BillingRateUsedID BillingRateUsed

CodeID TaxCodes

232 CHAPTER 3 READ TABLES


ActivitySalesHistory

Overview
The ActivitySalesHistory table displays total monthly unit sales, dollar sales and estimated cost of sales for activities.
Activity sales history is stored and thus reportable for the current financial year, next financial year and the previous
five financial years.

Record Field Information


Field Name Type Format Description

ActivitySalesHistoryID Integer 10xN Unique Identifier.

*** ActivityID Integer 10xN ActivityID (Activities) of Activity record that owns this sale
activity.

FinancialYear Integer 4xN Financial year in that the sales occurred.

Period Integer 2xN The period of the financial year in that the sales occurred.

UnitsSold Double 10.2xN The number of units sold during the period.

SaleAmount Double 13.2xN The dollar value of sales that occurred during the period.

EstimatedCostOfSalesAmount Double 13.2xN The estimated dollar cost of sales value.

Foreign Keys Table sourced

ActivityID Activities

ACTIVITYSALESHISTORY 233
ActivitySlips

Overview
The ActivitySlips table contains one record for each activity slip created. The ActivitySlips table includes both
chargeable and non-chargeable activity slips.

Record Field Information


Field Name Type Format Description

*** ActivitySlipID Integer 10xN Unique identifier

*** ActivityID Integer 10xN The ActivityID (Activities) of the record containing activity
information for this activity slip.

*** EmployeeSupplierID Integer 10xN The CardRecordID (Cards) or SupplierID (Suppliers) or EmployeeID
(Employees) of the record containing supplier or employee
information for this activity slip entry.

CardTypeID Text 1xAN CardTypeID (CardTypes) of the record containing the full card type
definition.

S = Supplier
E = Employee

*** CustomerID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) of the record
containing customer information for this activity slip entry.

*** ActivitySlipNumber Text 8xAN The CardRecordID (Cards) or CustomerID (Customers) of the record
containing customer information for this activity slip entry.

Date Date Formatted by the Date of Activity Slip Entry. To avoid SQL reserved word conflicts, use
operating system the ActivityDate field below.

*** ActivityDate Date Formatted by the Date of Activity Slip Entry. This field contains the same data as the
operating system Date field above.

Units Double 11.2xN The quantity of activity provided.

^^^ JobID Integer 10xN The JobID (Jobs) of the record containing job information for this
activity slip.

Rate Double 11.4xN The Billing Rate

AlreadyBilledUnits Double 11.2xN The quantity of the activity already billed.

AlreadyBilledAmount Double 11.4xN The dollar value of the activity already billed.

AdjustmentUnits Double 11.2xN The quantity written off against this activity.

AdjustmentAmount Double 11.4xN The dollar value written off against this activity.

Notes Text 255xAN Notes attached to the activity slip.

StartTime Text HH:MM The time that the Start button was first depressed within this activity
slip.

234 CHAPTER 3 READ TABLES


Field Name Type Format Description

StopTime Text HH:MM The time that the Stop button was last depressed within this activity
slip.

ElapsedTime Integer 5xN Time that the job was in Start mode. Measured in seconds.
ElapsedTime will not always equal the difference between the
StopTime and the StartTime. ElapsedTime equals the total time the
activity was in Start mode.

SlipStatusID Text 1xAN StatusID (Status) of the record containing the full activity slip status
definition
O = Open
N = Non-chargeable
C = Closed

Foreign Keys Table sourced Notes

ActivityID Activities

EmployeeSupplierID Cards Supplier cards are contained in both the Suppliers and the Cards tables.
Suppliers Employee cards are contained in both the employees and Cards tables.
Employees

CardTypeID CardTypes

CustomerID Cards Card is contained in both the Customers and the Cards tables.
Customers

JobID Jobs

SlipStatusID Status

ACTIVITYSLIPS 235
ActivitySlipInvoiced

Overview
Activity slips generated within the data file can be invoiced over one or more time billing sale invoices. The
ActivitySlipInvoiced table provides a link between the ActivitySlips table and the SaleInvoices table in that the user
can see that sale invoice the activity slip was billed upon.

Record Field Information


Field Name Type Format Description

*** ActivitySlipInvoicedID Integer 10xN Unique Identifier.

*** ActivitySlipID Integer 10xN The ActivitySlipID (ActivitySlips) of the activity slip that was invoiced
in part or in whole in this transaction.

*** SaleID Integer 10xN The SaleID (Sales) of the time billing sale invoice that was used to
invoice part of, or all of, the activity slip.

InvoicedUnits Double 11.2xN The quantity of the activity slip invoiced.

InvoicedDollars Double 11.2xN The dollar value of the activity invoiced.

Foreign Keys Table sourced

ActivitySlipID ActivitySlips

SaleID Sales

236 CHAPTER 3 READ TABLES


CustomLists

Record Field Information


Field Name Type Format Description

*** CustomListID Integer 10xN Unique Identifier.

*** CustomListText Text 30xAN Custom List text

CustomListNumber Integer 1xN The number of the custom list to which this record belongs.

CustomListName Text 30xAN The name of the custom list applicable to the custom list text.

ChangeControl Text 5xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

CustomListType Text 10xAN The type of custom list to which this record belongs.

The CustomList table contains no foreign keys

CUSTOMLISTS 237
Payroll Information Tables

Wages

Record Field Information


Field Name Type Format Description

*** WageID Integer 10xN Unique identifier.

WagesName Text 31xAN Name of the wage category.

PayBasisID Text 1xA S=Salary, H=Hourly, D=Daily

UseFixedRate Text 13.4xN Indicates whether the pay rate is a multiple of the regular rate or a fixed
hourly rate. If the value is "Y", the pay rate is a multiple of the regular
rate; if the value is "N", the pay rate is a fixed hourly rate.

RegularRateMultiplier Double 3.4xN The pay rate multiplier for calculating the paycheque extension based
upon the number of hours applied. Used only when UseFixedRate=N.

FixedRate Double 13.4xN

^^^ OverideAccountID Integer 10xN The account ID of the record to use as the expense account for this
wages category.

LinkEntitlement Integer 10xN The number of entitlement categories that are linked to this wage
category.

IsBonusLumpSumPayment Text 1xA (Malaysia) Indicates whether the wages type is a Lump Sum Payment.
Y=Yes, N=No.

IsCalTaxBaseOnPrevYrRate Text 1xA (Malaysia) Indicates whether to use the previous year’s rate for the tax
calculation of a lump sum payment. Y=Yes, N=No.

IncomeType Text 1xA (Singapore) Classifies the income type as ordinary or additional:
O=Ordinary
A=Additional

Foreign Keys Table sourced

PayBasisID PayBasis

OverideAccountID Accounts

238 CHAPTER 3 READ TABLES


EPF

This table is applicable to the Malaysian releases only.

Record Field Information


Field Name Type Format Description

*** EPFID Integer 10xN Unique identifier.

EPFName Text 31xAN Name of the EPF payroll category.

*** ExpenseAccountID Integer 10xN The AccountID (Accounts) of the record to use as the linked expense
account for this EPF payroll category.

*** PayableAccountID Integer 10xN The AccountID (Accounts) of the record to use as the linked payable
account for this EPF payroll category.

ContributionTypeID Text 2xA ContributionTypeID (ContributionTypes) of the record containing the


full definition of the contribution type.
EE = Employee Contribution
ER = Employer Contribution

BasisTypeID Text 1xA P=Percentage


D=Fixed Ringgit

TotalWagesPercent Double 3.5xN Percentage of total wages

AmountPerMonth Double 13.5xN Amount per month

PrintOnPayAdvice Text 1xA If EPF is printed upon the Pay Advice stub. N = No, Y = Yes.

Foreign Keys Table sourced

ExpenseAccountID Accounts

PayableAccountID Accounts

ContributionTypeID ContributionTypes

BasisTypeID BasisTypes

EPF 239
CPF

This table is applicable to the Singaporean releases only.

Record Field Information


Field Name Type Format Description

*** CPFID Integer 10xN Unique identifier.

CPFName Text 31xAN Name of the CPF payroll category.

*** ExpenseAccountID Integer 10xN The AccountID (Accounts) of the record to use as the linked expense
account for this CPF payroll category.

*** PayableAccountID Integer 10xN The AccountID (Accounts) of the record to use as the linked payable
account for this CPF payroll category.

ContributionTypeID Text 2xA ContributionTypeID (ContributionTypes) of the record containing the


full definition of the contribution type.
EE = Employee Contribution
ER = Employer Contribution

BasisTypeID Text 1xA P=Percentage


D=Fixed Ringgit

TotalWagesPercent Double 3.5xN Percentage of total wages

AmountPerPeriod Double 8.2xN Amount per month

MinimumAmount Double 2.2xN Minimum contribution amount per month

MaximumAmount Double 8.2xN Maximum Wage Threshold per month

PrintOnPayAdvice Text 1xA If CPF is printed upon the Pay Advice stub. N = No, Y = Yes.

Foreign Keys Table sourced

ExpenseAccountID Accounts

PayableAccountID Accounts

ContributionTypeID ContributionTypes

BasisTypeID BasisTypes

240 CHAPTER 3 READ TABLES


CPF Deduction

This table is applicable to the Singaporean releases only.

Record Field Information


Field Name Type Format Description

*** CPFID Integer 10xN Unique identifier.

GrossWageIndex Double 5.2xN

RateValue Double 3.2xN

IsValid Text 1xA Y=Yes, N=No

CPF DEDUCTION 241


Deductions

Record Field Information


Field Name Type Format Description

*** DeductionID Integer 10xN Unique identifier.

DeductionName Text 31xAN Name of the deduction category.

*** PayableAccountID Integer 10xN The account ID of the record to use as the linked payable account for
this deduction category.

DeductionBasisID Text 1xA The basis type ID of the record containing the full definition of the
type of deduction. Possible values include
U = User-entered,
P = Percentage
D = Fixed Dollar
N = No Limit
H = Fixed Hours
Y = Service Years

DeductionPercent Double 3.5xN The percentage to deduct. This field is valid only when the
DeductionBasisID value is P.

DeductionPercentBaseID Integer 10xN The wage ID of the wages category chosen in the Percent Of popup
list. This field is valid only when the DeductionBasisID value is P.

DeductionAmount Double 13.5xN The dollar amount to deduct. This field is valid only when the
DeductionBasisID value is D.

DeductionAmountFrequencyID Text 1xA The frequency ID of the record containing the full definition of the
frequency chosen in the Dollars Per popup list. This field is valid only
when the DeductionBasisID value is D.

LimitBasisID Text 1xA The basis type ID of the record containing the full definition of the
deduction limit. Possible values include
N = No Limit
P = Percentage
D = Fixed DollarU = User-Entered
H = Fixed Hours
Y = Service Years

LimitPercent Double 3.5xN The percent limit. This field is valid only when the LimitBasisID value is
P.

LimitPercentBaseID Integer 10xN The wage ID of the wages category chosen in the Percent Of popup
list. This field is valid only when the LimitBasisID value is P.

LimitAmount Double 13.5xN The dollar limit. This field is valid only when the LimitBasisID value is
D.

LimitAmountFrequencyID Text 1xA The frequency ID of the record containing the full definition of the
frequency chosen in the Dollars Per popup list.
This field is valid only when the LimitBasisID value is D.

242 CHAPTER 3 READ TABLES


Field Name Type Format Description

IsWithheldThirdparty Text 1xA Y=Yes, N=No.

IsTaxDeductible Text 1xA Used for Zakat deduction type to cater for Zakat relief from Tax
amount. Y=Yes, N=No.

Foreign Keys Table sourced

PayableAccountID Accounts

DeductionBasisID BasisTypes

DeductionPercentBaseID Wages

DeductionAmountFrequencyID Frequencies

LimitBasisID BasisTypes

LimitPercentBasisID Wages

LimitAmountFrequencyID Frequencies

DEDUCTIONS 243
EmployerExpenses

Record Field Information


Field Name Type Format Description

*** EmployerExpenseID Integer 10xN Unique identifier.

EmployerExpenseName Text 31xAN Name of the employer expense category.

*** ExpenseAccountID Integer 10xN The account ID of the record to use as the expense account for this employer
expense category.

*** PayableAccountID Integer 10xN The account ID of the record to use as the linked payable account for this
employer expense category.

ExpenseBasisID Text 1xA The basis type ID of the record containing the full definition of the expense
basis.

ExpensePercent Double 3.5xN The Expense Basis Percentage. This field is valid only if the ExpenseBasisID
value is P.

ExpensePercentBaseID Integer 10xN The wage ID, CPF/EPF ID or deduction ID of the category used in the
percentage calculation. This field is valid only if the ExpenseBasisID value is P.

ExpensePercentBaseTypeID Text 1xA CategoryTypesID (PayrollCategoryTypes) of the ExpensePercentBase Wage,


Deduction or CPF/EPF payroll category.
W = Wage
D = Deduction
S = CPF (Singapore) or EPF (Malaysia)

ExpenseAmount Double 13.5xN The dollar amount used in the employer expense. This field is valid only if the
ExpenseBasisID value is D.

ExpenseAmountFrequencyID Text 1xA The frequency ID of the record containing the full definition of the frequency
chosen in the Dollars Per popup list. Possible values include:
P = Pay Period
M = Monthly
Y = Yearly

LimitBasisID Text 1xA The basis type ID of the record containing the full definition of the expense
limit. Possible values include:
N = No Limit
P = Percentage
D = Fixed Dollar
U = User-Entered
H = Fixed Hours
Y = Service Years

LimitPercent Double 3.5xN The percentage limit of the expense. This field is valid only if the LimitBasisID
value is P.

LimitPercentBaseID Integer 10xN The wage ID, CPF/EPF ID or deduction ID of the category chosen in the
Percent Of popup list. This field is valid only if the LimitBasisID value is P.

244 CHAPTER 3 READ TABLES


Field Name Type Format Description

LimitPercentBaseTypeID Text 1xA CategoryTypesID (CategoryTypes) of the LimitPercentBase Wage, Deduction


or CPF/EPF payroll category.
W = Wage
D = Deduction
S = CPF (Singapore) or EPF (Malaysia)

LimitAmount Double 13.5xN The dollar limit of the expense. This field is valid only if the LimitBasisID value
is D.

LimitAmountFrequencyID Text 1xA The frequency ID of the record containing the full definition of the frequency
chosen in the Dollars Per popup list.
Possible values include
P = Pay Period
M = Monthly
Y = Yearly

This field is valid only if the LimitBasisID value is D.

WageThreshold Double 13.2xN

PrintOnPayAdvice Text 1xA Indicates whether the employer expense is printed on the pay advice.

Foreign Keys Table sourced

ExpenseAccountID Accounts

PayableAccountID Accounts

ExpenseBasisID BasisTypes

ExpensePercentBaseID Wages
Deductions

CPF
EPF

ExpensePercentBaseTypeID PayrollCategoryTypes

ExpenseAmountFrequencyID Frequencies

LimitBasisID BasisTypes

LimitPercentBaseID Wages
Deductions

CPF
EPF

LimitPercentBaseTypeID PayrollCategoryTypes

LimitAmountFrequencyID Frequencies

EMPLOYEREXPENSES 245
Entitlements

Record Field Information


Field Name Type Format Description

*** EntitlementID Integer 10xN Unique identifier.

EntitlementName Text 31xAN Name of the entitlement category.

EntitlementBasisID Text 1xA Basis type ID of the record containing the full definition of the type of
Entitlement.

PrintOnPayAdvice Text 1xA Indicates whether the entitlement is printed upon the pay advice.

CarryOver Text 1xA Indicates whether remaining entitlement are carried over to the next
payroll year.

LinkedWagesAccountID Integer 10xN

Foreign Keys Table sourced

EntitlementBasisID BasisTypes

LinkedWagesAccountID Wages

246 CHAPTER 3 READ TABLES


LinkedEmployees

The LinkedEmployees table displays a listing of all employees that are linked to the parent payroll category.

Record Field Information


Field Name Type Format Description

LinkedEmployeesID Integer 10xN Unique identifier assigned by ODBC.

*** PayrollCategoryID Integer 10xN The ID of the record containing full details of the parent payroll
category.

CategoryTypeID Text 1xA PayrollCategoryTypeID (PayrollCategoryTypes) of the record containing


the full payroll category definition.
W = Wage
D = Deduction
T = Tax
X = Employer Expense
N = Entitlement
S = EPF (Malaysia) or CPF (Singapore)
C= SOCSO (Malaysia)

CardRecordID Integer 10xN The parent employee card found within the Cards or Employees table.

Foreign Keys Table sourced

PayrollCategoryID Wages
Entitlements
Deductions
EmployerExpenses
EPF
CPF

PayrollCategoryTypeID PayrollCategoryTypes

CardRecordID Cards
Employees

LINKEDEMPLOYEES 247
WageHourHistory

Record Field Information


Field Name Type Format Description

WageHourHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC. For ODBC
purposes, wage history will be presented on a record-by-record
basis. ODBC is required to generate a unique identifier for each
record created in the WageHourHistory table.

*** WageID Integer 10xN The wage ID of the wage category associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated
with this history.

Period Integer 4xN The period of the payroll year in which the activity occurred.
Possible values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred. (Payroll history is
stored only for the current payroll year.)

Hours Double 12.2xN Hours of activity that occurred during the period of the payroll
year.
A positive value in this field indicates that hours have been added
to a paycheque. A negative value indicates that hours have been
deducted from a paycheque.

Foreign Keys Table sourced

WageID Wages

CardRecordID Cards
Employees

248 CHAPTER 3 READ TABLES


WageDollarHistory

Record Field Information


Field Name Type Format Definition and values

WageDollarHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC. For ODBC
purposes, wage history will be presented on a record-by-record basis.
ODBC is required to generate a unique identifier for each record created
in the WageDollarHistory table.

*** WageID Integer 10xN The wage ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred. (Payroll history is stored only
for the current payroll year.)

Dollars Double 12.2xN Dollar amount of activity which occurred during the specific payroll
period.
A positive value represents an addition to a paycheque. A negative value
represents a withholding from a paycheque.

Foreign Keys Table sourced

WageID Wages

CardRecordID Cards
Employees

WAGEDOLLARHISTORY 249
WageDayHistory

Record Field Information


Field Name Type Format Definition and values

WageDayHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC.

*** WageID Integer 10xN The wage ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred.

Days Double 12.3xN

Foreign Keys Table sourced

WageID Wages

CardRecordID Cards
Employees

250 CHAPTER 3 READ TABLES


EPFHistory

This table is applicable to the Malaysian releases only.

Record Field Information


Field Name Type Format Definition and values

EPFHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC.

*** EPFID Integer 10xN The EPF ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred.

EmyerDollars Double 12.2xN The EPF contribution amount for Employer

EmyeeDollars Double 12.2xN The EPF contribution amount for Employee

Foreign Keys Table sourced

EPFID EPF

CardRecordID Cards
Employees

EPFHISTORY 251
SOCSOHistory

This table is applicable to the Malaysian releases only.

Record Field Information


Field Name Type Format Definition and values

SOCSOHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC.

*** SOCSOID Integer 10xN The SOCSO ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred.

EmyerDollars Double 12.2xN The SOCSO contribution amount for Employer

EmyeeDollars Double 12.2xN The SOCSO contribution amount for Employee

Foreign Keys Table sourced

SOCSOID SOCSOSchemeTypes

CardRecordID Cards
Employees

252 CHAPTER 3 READ TABLES


TaxHistory

This table is applicable to the Malaysian releases only.

Record Field Information


Field Name Type Format Definition and values

TAXHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC.

*** TAXID Integer 10xN The TAX ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred.

EmyeeDollars Double 12.2xN The tax contribution amount for Employee

Foreign Keys Table sourced

TAXID TaxTypes

CardRecordID Cards
Employees

TAXHISTORY 253
CPFHistory

This table is applicable to the Malaysian releases only.

Record Field Information


Field Name Type Format Definition and values

CPFHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC.

*** CPFID Integer 10xN The CPF ID associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred.

EmyerDollars Double 12.2xN The CPF contribution amount for Employer

EmyeeDollars Double 12.2xN The CPF contribution amount for Employee

Foreign Keys Table sourced

CPFID CPFSchemeTypes

CardRecordID Cards
Employees

254 CHAPTER 3 READ TABLES


DeductionHistory

Record Field Information


Field Name Type Format Description

DeductionHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC. For ODBC
purposes, deduction history will be presented on a record-by-record
basis. ODBC is required to generate a unique identifier for each record
created in the DeductionHistory table.

*** DeductionID Integer 10xN The deduction ID of the deduction category associated with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year the activity occurred. (Payroll history is stored only for the
current payroll year.)

Dollars Double 12.2xN Value of activity which occurred during the specific payroll period. A
positive value in this field indicates that an amount has been withheld
from a paycheque. A negative value indicates that an amount has been
added to a paycheque.

Foreign Keys Table sourced

DeductionID Deductions

CardRecordID Cards
Employees

DEDUCTIONHISTORY 255
EmployerExpenseHistory

Record Field Information


Field Name Type Format Description

EmployerExpenseHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC. For ODBC
purposes, employer expense history will be presented on a
record-by-record basis. ODBC is required to generate a unique identifier
for each record created in the EmployerExpenseHistory table.

*** EmployerExpenseID Integer 10xN The employer expense ID of the employer expense category associated
with this history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred. (Payroll history is stored only
for the current payroll year.)

Dollars Double 12.2xN Value of activity which occurred during the specific payroll period.
A positive value in this field indicates that an amount has been withheld
from a paycheque. A negative value indicates that an amount has been
added to a paycheque.

Foreign Keys Table sourced

EmployerExpenseID EmployerExpenses

CardRecordID Cards
Employees

256 CHAPTER 3 READ TABLES


EntitlementHistory

Record Field Information


Field Name Type Format Definition and values

EntitlementHistoryID Integer 12xN Unique identifier. This value is to be assigned by ODBC. For ODBC
purposes, entitlement history will be presented on a record-by-record
basis. ODBC is required to generate a unique identifier for each record
created in the EntitlementHistory table.

*** EntitlementID Integer 10xN The Entitlement ID of the entitlement category associated with this
history.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with this
history.

Period Integer 4xN The period of the payroll year in which the activity occurred. Possible
values include numbers 1 through 12.

PayrollYear Integer 4xN Payroll year in which the activity occurred. (Payroll history is stored only
for the current payroll year.)

Day Double 12.2xN Days accrued during the period of the payroll year. A positive value in this
field indicates that entitlements have been added to a paycheque. A
negative value indicates that entitlements have been deducted from a
paycheque.

Foreign Keys Table sourced

EntitlementID Entitlements

CardRecordID Cards
Employees

ENTITLEMENTHISTORY 257
EntitlementCarryOver

Record Field Information


Field Name Type Format Description

*** EntitlementCarryOverID Integer 12xN Unique identifier.

*** EntitlementID Integer 10xN The Entitlement ID of the entitlement category associated with these
carryover days.

*** CardRecordID Integer 10xN The card record ID or employee ID of the employee associated with
these carryover hours.

Day Double 12.3xN Days of entitlement that were carried over.

PayrollYear Integer 4xN Payroll year in which the activity occurred. Carry-over history is stored
only for the previous two payroll years.

Foreign Keys Table sourced

EntitlementID Entitlements

CardRecordID Cards
Employees

258 CHAPTER 3 READ TABLES


EntitlementServiceYears

Record Field Information


Field Name Type Format Description

*** EntitlementID Integer 10xN Unique identifier.

YearIndex Integer 10xN

Value Integer 10xN

IsValid Text 1xA Y=Yes, N=No

ENTITLEMENTSERVICEYEARS 259
Timesheets

Record Field Information


Field Name Type Format Description

*** TimesheetID Integer 10xN Unique identifier.

*** TimesheetDate Text 8xAN Date of the timesheet entry.

*** EmployeeID Integer 10xN The CardRecordID (Cards) or EmployeeID (Employees) of the
record containing employee information for this timesheet entry.

*** WagesID Integer 10xN The WageID (Wages) containing full details of the wage category
assigned to the timesheet entry.

^^^ JobID Integer 10xN The JobID (Jobs) of the record containing job information for this
timesheet entry.

*** CustomerID Integer 10xN The CardRecordID (Cards) or CustomerID (Customers) of the
record containing customer information for this timesheet entry.

Notes Text 255xAN Notes attached to the timesheet entry.

Units Double 11.2xN The value assigned within the cell of the Enter Timesheet window.

PayrollStatusID Text 1xA StatusID (Status) of the record containing the full payroll
processing status of the timesheet
U = Unselected
S = Selected
R = Ready to pay
P = Paid

^^^ JournalRecordID Integer 10xN The JournalRecordID (JournalRecords) or the


WritePaychequeLineID (WritePaychequeLines) of the record upon
which this timesheet entry was paid

*** SetID Integer 10xN Links timesheet entries with like attributes together allowing rows
to be generated within the Enter Timesheet window

Foreign Keys Table sourced

EmployeeID Cards
Employees

WagesID Wages

JobID Jobs

CustomerID Cards
Customers

PayrollStatusID Status

JournalRecordID JournalRecords
TransferMoney

SetID JournalSets

260 CHAPTER 3 READ TABLES


ContributionTypes

Record Field Information


Field Name Type Format Description

ContributionTypeID Text 2xA Unique identifier, either EE, ER, ED or RE.

Description Text 24xA EE - Employee Contribution


ER - Employer Contribution
ED - Employee Deduction
RE - Employer Expenses

The ContributionTypes table contains no foreign keys.

CONTRIBUTIONTYPES 261
EmploymentClassifications

Record Field Information


Field Name Type Format Description

*** EmploymentClassificationID Integer 10xN Unique identifier

*** EmploymentClassificationName Text 255xAN Employment Classification Name

The EmploymentClassifications Table contains no foreign keys.

262 CHAPTER 3 READ TABLES


EmploymentDepartment

Record Field Information


Field Name Type Format Description

*** EmploymentDepartmentID Integer 10xN Unique identifier

*** EmploymentDepartmentName Text 255xAN Employment Department Name

The EmploymentDepartment Table contains no foreign keys.

EMPLOYMENTDEPARTMENT 263
Definitions

JournalTypes

Record Field Information


Field Name Type Format Description

JournalTypeID Text 3xAN Unique Identifier. Predefined from the following list: GJ, BD, MS, MR, SI, CP, CFC,
CDC, CDP, PO,SP, SFC, SDC, SDP, CRC, SC, SD, DRD, IA, IT, EP, TM, N/A

Description Text 23xA Definition of the JournalType ID:


GJ General Journals
BD Bank Deposit
MS Money Spent
MR Money Received
SI Sale Invoice
CP Customer Payment
CFC Customer Finance Charge
CDC Customer Discount
CDP Customer Deposit
PO Purchase Order
SP Supplier Payment
SFC Supplier Finance Charge
SDC Supplier Discount
SDP Supplier Deposit
CRC Credit Refund Cheque
SC Settled Credit
SD Settled Debit
DRD Debit Refund Deposit
IA Inventory Adjustment
IT Inventory Transfer
EP Electronic Payment
TM Transfer Money
N/A Not Applicable

The JournalType table contains no foreign keys.

264 CHAPTER 3 READ TABLES


TaxCodeTypes

Overview
The JournalTypes table provides a full definition of the TaxCodeTypeID. The TaxCodeTypeID is used within the
TaxCodes table in order to reduce memory usage, provide shorter string comparison and promote database
normalisation. By providing definitions as a separate table, the description of the Tax code type can be changed
without affecting existing queries as the TaxCodeTypeID reported information stays the same in TaxCodes table.
The TaxCodeTypes table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

TaxCodeTypeID Text 3xAN Unique Identifier. Predefined from the following list; C, ID, ST, GST, IT

Description Text 22xA Consolidated


Import Duty
Sales Tax
Goods and Services Tax
Input Taxed

ImportTaxType Text 1xA Import definition.

Import Duty =1
Sales Tax = 2
Goods and Services Tax = 3
Input Taxed = 4
Luxury Car Tax = 6
Voluntary Withholdings = 7
No ABN/TFN = 8

The TaxCodesTypes table contains no foreign keys.

TAXCODETYPES 265
PriceLevels

Overview
The PriceLevels table provides a full definition of the price levels. The PriceLevelID (or SalesTaxCalculationBasisID) is
used within the Customers, ItemPrices, ItemSaleLines and Items tables in order of reducing memory usage,
providing shorter string comparison and promoting database normalisation.
By providing definitions as a separate table, the description of the price level can be changed without affecting
existing queries as the PriceLevelID (or SalesTaxCalculationBasisID) reported information stays the same in the
tables.

Record Field Information


Field Name Type Format Description

PriceLevelID Text 3xAN Unique Identifier. Predefined from the following list; ASP BSP, PLA, PLB,
PLC, PLD, PLE, PLF

Description Text 30xAN Actual Selling Price; Base Selling Price; Price Level {A, B, C, D, E, F}

ImportPriceLevel Text 1xAN Import Definition

ImportSalesTaxCalcMethod Text 1xA Import Definition

The PriceLevel table contains no foreign keys.

266 CHAPTER 3 READ TABLES


Identifiers

Overview
The Identifiers table provides the description attached to the identifier code. The IdentifierID is used within the
Cards, Customers, Suppliers, Employees and PersonalCards tables to reduce memory usage, providing shorter string
comparison and promoting database normalisation. By providing identifier descriptions within a separate table,
descriptions can be changed without affecting existing queries as the IdentifierID reported within the Cards,
Customers, Suppliers, Employees or PersonalCards table will remain the same. The Identifiers table derives its
information from information stored within the ALPHAFILEID filette. Contents of the list are presented in the table
below:

Record Field Information


Field Name Type Format Description

IdentifierID Text 3xAN Each of the 26 letters in the alphabet can be used.

Description Text 30xAN Description attached to the identification code.

ChangeControl Text 5xAN Number used to control change within the record. Value is incremented
whenever the record is updated.

The Identifiers table contains no foreign keys

IDENTIFIERS 267
TermsOfPayment

Overview
The TemsOfPayment table provides a full definition of the TermsOfPaymentID field. The TermsOfPaymentID field is
found within the Terms table. Use of the TermsOfPaymentID within the Terms table reduces memory usage,
provides shorter string comparison and promotes database normalisation.
The TermsOfPayment table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

TermsOfPaymentID Text 4xAN Unique Identifier. Predefined from the following list: COD, PPD, GND, DOM,
NDAE, DMAE

Description Text 52xAN Cash On Delivery


Prepaid
In a Given Number of Days
On a Day of the Month
In a Given Number of Days After the End of the Month
On a Day of the Month After the End of the Month

The TermsOfPayment Table contains no foreign keys.

268 CHAPTER 3 READ TABLES


CardTypes

Overview
The CardTypes table provides a full definition of the CardTypeID field. The CardTypeID field is found within the
Cards table. Use of the CardTypeID within the Cards table reduces memory usage, provides shorter string
comparison and promotes database normalisation.

Record Field Information


Field Name Type Format Description

CardTypeID Text 1xAN Unique Identifier. Predefined from the following list; C, S, E, P

Description Text 8xAN Customer; Supplier; Employee; Personal

The CardTypes table contains no foreign keys.

CARDTYPES 269
AccountClassification

Overview
The AccountClassification table provides a full definition of the AccountClassificationID field. The
AccountClassificationID field is found within the Accounts table. Use of the AccountClassificationID within the
Accounts table reduces memory usage, provides shorter string comparison and promotes database normalisation.
The AccountClassification table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

AccountClassificationID Text 4xAN Unique Identifier. Predefined from the following list; A, L, EQ, I, COS,
EXP, OI, OEXP

Description Text 13xAN Asset; Liability; Equity; Income; Cost of Sales; Expense; Other Income;
Other Expense

The AccountClassification table contains no Foreign Keys.

270 CHAPTER 3 READ TABLES


AccountType

Overview
The AccountType table provides a full definition of the AccountTypeID field. The AccountTypeID field is found within
the Accounts table. Use of the AccountTypeID within the Accounts table reduces memory usage, provides shorter
string comparison and promotes database normalisation.
The AccountType table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

AccountTypeID Text 1xAN Unique Identifier. Predefined from the following list; S, B, H, D, N

Description Text 14xAN System; Bank; Header; Detail; Not Applicable

The AccountType table contains no foreign keys.

ACCOUNTTYPE 271
InvoiceType

Overview
The InvoiceType table provides a full definition of the InvoiceTypeID field. The InvoiceTypeID foreign key field found
within the Sales table links to the InvoiceTypeID primary key within the InvoiceType table. The PurchaseTypeID
foreign key field found within the Purchases table links to the InvoiceTypeID primary key within the InvoiceType
table. Use of the InvoiceTypeID field within the Sales table and the PurchaseTypeID field within the Purchases table
reduces memory usage, provides shorter string comparison and promotes database normalisation.

Record Field Information


Field Name Type Format Description

InvoiceTypeID Text 1xAN Unique Identifier. Predefined from the following list; S, I, P, T, M, N.

Description Text 13xAN Service; Item; Professional; Time Billing; Miscellaneous; No Default.

The InvoiceType table contains no foreign keys.

272 CHAPTER 3 READ TABLES


Status

Overview
The Status table provides a full definition of the StatusID field.
„ The InvoiceStatusID foreign key field found within the Sales table links to the StatusID primary key within the
Status table.
„ The PurchaseStatusID foreign key field found within the Purchases table links to the StatusID primary key within
the Status table.
„ The SlipStatusID foreign key field found within the ActivitySlips table links to the StatusID primary key within the
Status table.
Use of the InvoiceStatusID field within the Sales table, the PurchaseStatusID field within the Purchases table and the
SlipStatusID field within the ActivitySlips table reduces memory usage, provides shorter string comparison and
promotes database normalisation.
The Status table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

StatusID Text 2xAN Unique Identifier. Predefined from the following list:
O
C
Q
OR
DR
CR
N
U
S
R
P
CP

Description Text 14xAN O = Open


C = Closed
Q = Quote
OR = Order
DR = Debit
CR = Credit
N = Non-Chargeable
U = Unselected
S = Selected
R = Ready to Pay
P = Paid
CP = Closed Pending

The Status table contains no foreign keys.

STATUS 273
BillingRateUsed

Overview
The BillingRateUsed table provides a full definition of the BillingRateUsedID field. The BillingRateUsedID field is found
within the Activities table. Use of the BillingRateUsedID within the Activities table reduces memory usage, provides
shorter string comparison and promotes database normalisation.
The BillingRateUsed table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

BillingRateUsedID Text 2xAN Unique Identifier. Predefined from the following list:
E, C, A.

Description Text 7xAN E = Employee


C = Customer
A = Activity

The BillingRateUsed table contains no foreign keys.

274 CHAPTER 3 READ TABLES


ReconciliationStatus

Overview
The ReconciliationStatus table provides a full definition of the ReconciliationStatusID field. The
ReconciliationStatusID field is found within the JournalRecords table.
Use of the ReconciliationStatusID within the JournalRecords table reduces memory usage, provides shorter string
comparison and promotes database normalisation.
The ReconciliationStatus table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

ReconciliationStatusID Text 1xAN Unique Identifier. Predefined from the following list; D, S, R

Description Text 10xAN Definition of the ReconciliationStatusID:

D = Deselected
S = Selected
R = Reconciled

The ReconciliationStatus table contains no foreign keys.

RECONCILIATIONSTATUS 275
DepositStatus

Overview
The DepositStatus table provides a full definition of the status of a number of deposit transactions. The
DepositStatusID is used within the MoneyReceived and CustomerPayments tables to reduce memory usage, provide
shorter string comparison and promote database normalisation. By providing definitions as a separate table, the
description of the deposit status can be changed without affecting existing queries as the DepositStatusID stays the
same within the MoneyReceived and CustomerPayments tables.
The DepositStatus table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

DepositStatusID Text 1xAN Unique identifier. Possible values include D, S, T and U.

Description Text 11xAN Definition of DepositStatusID. Possible values include:

D = Direct
S = Selected
T = Transferred
U = Unselected

The DepositStatus table contains no foreign keys.

276 CHAPTER 3 READ TABLES


LimitTypes

The LimitTypes table provides a full definition of the exceed credit limit action combo-box selection within the Sales
tab of the Preferences window. The LimitTypeID is used within the DataFileInformation table in order to reduce
memory usage, provide shorter string comparison and promote database normalisation.
By providing definitions as a separate table, the description of the LimitType can be changed without affecting
existing queries as the LimitTypeID reported information will stay the same in the DataFileInformation table.

Record Field Information


Field Name Type Format Description

LimitTypeID Text 1xAN Unique identifier. Predefined from the following list: W, P

Description Text 30xA Definition of the LimitTypeID. Predefined value:

W=Warn and Continue.


P=Prevent Unless Overridden

The LimitType Table contains no foreign keys.

LIMITTYPES 277
PayBasis

Overview
The PayBasis table provides a full definition of the PayBasisID field.

Record Field Information


Field Name Type Format Description

PayBasisID Text 1xA Unique identifier. Possible values are H, S and D.

Description Text 7xA Definition of the PayBasisID:


H=Hourly
S=Salary
D=Daily

The PayBasis table contains no foreign keys.

278 CHAPTER 3 READ TABLES


Frequencies

Overview
The Frequencies table provides a full definition of the FrequencyID field. FrequencyID is used within tables in order
to reduce memory usage, provide shorter string comparison and promote database normalisation.
The Frequencies table derives its information from a predefined list.

Record Field Information


Field Name Type Format Definition and values

FrequencyID Text 1xA Unique identifier.

Description Text 19xA Definition of the FrequencyID. Possible values include:


M = Monthly

The Frequencies table contains no foreign keys.

FREQUENCIES 279
BasisTypes

Overview
The BasisTypes table provides a full definition of the BasisTypeID field.

Record Field Information


Field Name Type Format Description

BasisTypeID Text 1xA Unique identifier. Possible values include U, P, F, N, H


and Y.

Description Text 13xA Definition of the BasisTypeID:


U=User-Entered
P=Percent
F=Fixed Dollar
N=No Limit
H=Fixed Hours
Y=Service Years
S=Schedule Rate.

The BasisTypes table contains no foreign keys.

280 CHAPTER 3 READ TABLES


LinkedWages

Record Field Information


Field Name Type Format Description

LinkedEntitlementID Integer 12xN

EntitlementID Integer 10xN

WageID Integer 4xN

Foreign Keys Table sourced

EntitlementID Entitlements

WageID Wages

LINKEDWAGES 281
PayrollCategoryTypes

Overview
The PayrollCategoryTypes table provides a full definition of the PayrollCategoryTypeID field.

Record Field Information


Field Name Type Format Definition and values

PayrollCategoryTypeID Text 1xA Unique identifier.


W
D
T
X
N
S
C

Description Text 17xA Definition of the CategoryTypeID:


W = Wage
D = Deduction
T = Tax
X = Employer Expense
N = Entitlement
S = EPF (Malaysia) or CPF (Singapore)
C = SOCSO (Malaysia)

The PayrollCategoryTypes table contains no foreign keys.

282 CHAPTER 3 READ TABLES


MaritalStatus

The MaritalStatus table provides a full definition of the MaritalStatusID field.

Record Field Information


Field Name Type Format Description

MaritalStatusID Text 1xA Unique identifier. Predefined values include: M, S, W, D and


P.

Description Text 30xA Definition of the MaritalStatusID:


M = Married
S = Single
W = Widowed
D = Divorced
P = Separated

The MaritalStatus table contains no foreign keys.

MARITALSTATUS 283
Rounding

Overview
The Rounding table provides a full definition of the RoundToID field.

Record Field Information


Field Name Type Format Description

RoundingID Text 1xAN Unique identifier. Predefined from the following list: U, D, N

Description Text 255xAN Definition of the RoundingID:


U =Up to Next
D =Down to Previous
N = To Nearest

The Rounding table contains no foreign keys.

284 CHAPTER 3 READ TABLES


SubAccountTypes

Overview
The SubAccountType table provides a full definition of the SubAccountTypeID field. SubAccountTypeID is used
within tables to reduce memory usage, provide shorter string comparison and promote normalisation.
SubAccountTypeID is the equivalent of SubAccountTypeID within the Accounts table.

Record field information


Field Name Type Format Description

SubAccountTypeID Text 3xAN Unique identifier. Predefined from the following list: B, AR,
OCA, FA, OA, CC, AP, OCL, LTL, OL, EQ, I, COS, EXP, OI,
OE

Description Text 23xA Definition of the SubAccountTypeID. Predefined value.


B = Bank
AR = Accounts Receivable
OCA = Other Current Asset
FA = Fixed Asset
OA = Other Asset
CC = Credit Card
AP = Accounts Payable
OCL = Other Current Liability
LTL = Long Term Liability
OL = Other Liability
EQ = Equity
I = Income
COS = Cost of Sales
EXP = Expense
OI = Other Income
OE = Other Expense

The SubAccountTypes table contains no foreign keys.

SUBACCOUNTTYPES 285
CashFlowClassifications

Overview
The CashFlowClassifications table provides a full definition of the CashFlowClassificationsID field.
CashFlowClassificationsID is used within tables to reduce memory usage, provide shorter string comparison and
promote database normalisation.
The CashFlowClassifications table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

CashFlowClassID Text 3xAN Unique identifier. Predefined from the following list:

N/A
NI
C
O
I
F
E

Description Text 35xAN Definition of the CashFlowClassificationID. Predefined value:

N/A = Not Applicable


NI = Net Income
C = Cash or Cash Equivalent
O = Operating
I = Investing
F = Financing
E = Exclude from Statement of Cash Flow

The CashFlowClassifications table contains no foreign keys.

286 CHAPTER 3 READ TABLES


LineType

Overview
The LineType table provides a full definition of the LineTypeID field. The LineTypeID is used within a number of
tables to reduce memory usage, provide shorter string comparison and promote database normalisation.
By providing definitions as a separate table, the description of the line type can be changed without affecting
existing queries as the LineTypeID stays the same within all tables.
The LineType table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

LineTypeID Text 1xAN Unique identifier. Predefined from the following list:

D
H
S
W

Description Text 23xA Definition of DepositStatusID. Predefined value.

D = Data
H = Header
S = Subtotal
W = Without Item or Account

The LineType table contains no foreign keys.

LINETYPE 287
PaymentTypes

The PaymentTypes table provides a full definition of the Payment Type option within the Pay Employee window. The
PaymentTypeID is used within the WritePaycheque table in order to reduce memory usage, provide shorter string
comparison and promote database normalisation.
By providing definitions as a separate table, the description of the PaymentType can be changed without affecting
existing queries as the PaymentTypeID reported information will stay the same in the WritePaycheque table.

Record Field Information


Field Name Type Format Description

PaymentTypeID Text 1xA Unique identifier. Predefined from the following list: C, Q, B.

Description Text 30xA Definition of the PaymentTypeID:


C=Cash.
Q=Cheque.
B=Bank Instructions.

The PaymentTypes Table contains no foreign keys.

288 CHAPTER 3 READ TABLES


InvoiceDelivery

The InvoiceDelivery table provides a full definition of the Invoice Delivery combo-box selection within an Employees
card, the Invoice Delivery Status within the Sales window or the Bill Delivery Status within the Purchases window.
The InvoiceDeliveryID is used within a number of tables in order to reduce memory usage, provide shorter string
comparison and promote database normalisation.
By providing definitions as a separate table, the description of the InvoiceDelivery can be changed without affecting
existing queries as the InvoiceDeliveryID reported information will stay the same in the applicable tables.

Record Field Information


Field Name Type Format Description

InvoiceDeliveryID Text 1xAN Unique identifier. Predefined from the following list: P, E, B, A

Description Text 30xA Definition of the InvoiceDeliveryID. Predefined value:

P = To be Printed
E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

The InvoiceDelivery Table contains no foreign keys.

INVOICEDELIVERY 289
AuditTypes

The AuditTypes table provides a full definition of the audit record type. The AuditTypeID is used within the AuditTrail
table in order to reduce memory usage, provide shorter string comparison and promote database normalisation.
By providing definitions as a separate table, the description of the AuditType can be changed without affecting
existing queries as the AuditTypeID reported information will stay the same in the applicable tables.

Record Field Information


Field Name Type Format Description

AuditTypeID Text 1xAN Unique identifier. Predefined from the following list: T, X, A, S

Description Text 35xAN Definition of the AuditTypeID. Predefined value:

T= Transaction Audit Trail entry


X = Tax Audit Trail entry
A = Account Audit Trail entry
S = System Setting Audit Trail entry

The AuditTypes Table contains no foreign keys.

290 CHAPTER 3 READ TABLES


DayNames

Record Field Information


Field Name Type Format Description

DayNamesID Text 3xA Unique identifier. Predefined from the following list:

MON
TUE
WED
THU
FRI
SAT
SUN

Description Text 23xA Definition of DayNamesID. Predefined value.

MON = Monday
TUE = Tuesday
WED = Wednesday
THU = Thursday
FRI = Friday
SAT = Saturday
SUN = Sunday

The DayNames Table contains no foreign keys.

DAYNAMES 291
OrderStatus

The OrderStatus table provides a full definition of the OrderStatusID field. The OrderStatusID foreign key field found
within the Purchases table links to the OrderStatusID primary key within the OrderStatus table.
Use of the OrderStatusID field within the Purchases table reduces memory usage, provides shorter string comparison
and promotes database normalisation.
The OrderStatus table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

OrderStatusID Text 2xAN Unique identifier. Predefined from the following list:

T
N
S
A
B
F
CR
RR

Description Text 14xAN Definition of OrderStatusID:

T = Not An Order
N = No Items Received
S = Some Items Received
A = All Items Received
B = Billed from Partially Received Order
F= Billed from Fully Received Order
CR= Receive Item Converted to a Bill
RR= Reversal of Receive Item

The OrderStatus Table contains no foreign keys.

292 CHAPTER 3 READ TABLES


Schedule

The Schedule table provides a full definition of the ScheduleID field. The ScheduleID foreign key links to the
ScheduleID primary key within the Schedule table. The ScheduleID foreign key field is found within the following
tables:
„ RecurringSales
„ RecurringPurchases
„ RecurringSpendMoney
„ RecurringReceiveMoney
„ RecurringTransferMoney
„ RecurringGeneralJournals
Use of the ScheduleID foreign key within a number of tables reduces memory usage, provides shorter string
comparison and promotes database normalisation. The Schedule table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

ScheduleID Text 3xAN Unique identifier. Predefined from the following list:

I
U
P

Description Text 14xAN Definition of ScheduleID:

I = Continue Indefinitely
U = Continue Until a Date
P = Perform a Number of Times

The Schedule Table contains no foreign keys.

SCHEDULE 293
Alerts

The Alerts table provides a full definition of the AlertID field. The AlertID foreign key links to the AlertID primary key
within the Alerts table. The AlertID foreign key field is found within the following tables:
„ RecurringSales
„ RecurringPurchases
„ RecurringSpendMoney
„ RecurringReceiveMoney
„ RecurringTransferMoney
„ RecurringGeneralJournals
Use of the AlertID foreign key within a number of tables reduces memory usage, provides shorter string comparison
and promotes database normalisation. The Alerts table derives its information from a predefined list.

Record Field Information


Field Name Type Format Description

AlertID Text 3xAN Unique identifier. Predefined from the following list:

R
A

Description Text 14xAN Definition of AlertID:

R= Remind User to Record.


A= Automatically Record and Notify User.

The Alerts Table contains no foreign keys.

294 CHAPTER 3 READ TABLES


AlertTypes

The AlertTypes table provides a full definition of the AlertTypeID field. The AlertTypeID foreign key links to the
AlertTypeID primary key within the AlertTypes table. The AlertTypeID foreign key field is found within the following
tables:
„ RecurringSales
„ RecurringPurchases
„ RecurringSpendMoney
„ RecurringReceiveMoney
„ RecurringTransferMoney
„ RecurringGeneralJournals
Use of the AlertTypeID foreign key within a number of tables reduces memory usage, provides shorter string
comparison and promotes database normalisation. The AlertTypes table derives its information from a predefined
list.

Record Field Information


Field Name Type Format Description

AlertTypeID Text 3xAN Unique identifier. Predefined from the following list:

N
D
A

Description Text 14xAN Definition of AlertTypeID:

N = Never.
D = On Its Due Date.
A = # Days in Advance.

The AlertTypes Table contains no foreign keys.

ALERTTYPES 295
NumberingTypes

The NumberTypes table provides a full definition of the NumberingTypeID field. The NumberingTypeID foreign key
links to the NumberingTypeID primary key within the NumberingTypes table. The NumberingTypeID foreign key
field is found within the following tables:
„ RecurringSales
„ RecurringPurchases
„ RecurringSpendMoney
„ RecurringReceiveMoney
„ RecurringTransferMoney
„ RecurringGeneralJournals
Use of the NumberingTypeID foreign key within a number of tables reduces memory usage, provides shorter string
comparison and promotes database normalisation. The NumberingTypes table derives its information from a
predefined list.

Record Field Information


Field Name Type Format Description

NumberingTypeID Text 3xAN Unique identifier. Predefined from the following list:

N
S

Description Text 14xAN Definition of NumberingTypeID:

N = Use the Next Sequential Number.


S = Use the Same Number.

The NumberingTypes table contains no foreign keys.

296 CHAPTER 3 READ TABLES


EmploymentCategory

The EmploymentCategory table provides a full definition of the EmploymentCategoryID field.

Record Field Information


Field Name Type Format Description

EmploymentCategoryID Text xAN Unique identifier. Predefined from the following list: P, T, C

Description Text 14xA Definition of EmploymentCategoryID:


P = Permanent.
T = Temporary.
C = Contract.

The EmploymentCategory table contains no foreign keys.

EMPLOYMENTCATEGORY 297
EmploymentStatus

The EmploymentStatus table provides a full definition of the EmploymentStatusID field. The EmploymentStatusID
foreign key field found within the Employees table links to the EmploymentStatusID primary key within the
EmploymentStatus table.

Record Field Information


Field Name Type Format Description

EmploymentStatusID Text 1xAN Unique identifier. Predefined from the following list: F, P, O, C

Description Text 14xAN Definition of EmploymentStatusID:

F = Full Time
P = Part Time
O = Other
C = Casual

The EmploymentStatus table contains no foreign keys.

298 CHAPTER 3 READ TABLES


SOCSOSchemeTypes

This table applies to the Malaysian releases only.

Record Field Information


Field Name Type Format Description

SOCSOSchemeID Text 1xA Unique identifier. Predefined from the following list: 0, 1, 2

Description Text 30xA Definition of SOCSOSchemeID:


0=Not Applicable
1=1st Category
2=2nd Category

The SOCSOSchemeTypes table contains no foreign keys.

SOCSOSCHEMETYPES 299
TaxTypes

This table applies to the Malaysian releases only.

Record Field Information


Field Name Type Format Description

TaxID Text 1xA Unique identifier. Predefined from the following list: 0, 1, 2, 3, 4

Description Text 30xA Definition of TaxID:


0=Not Taxable
1=Category 1
2=Category 2
3=Category 3
4=Full Rate

The TaxTypes table contains no foreign keys.

300 CHAPTER 3 READ TABLES


CPFSchemeTypes

This table applies to the Singaporean releases only.

Record Field Information


Field Name Type Format Description

CPFSchemeID Text 1xA Unique identifier. Predefined from the following list: 0, 1, 2, 3, 4, 5

Description Text 30xA Definition of CPFSchemeID:


0=Not Applicable
1=Singaporean
2=Graduated PR 1st Year
3=Graduated PR 2nd Year
4=Full and Graduated PR 1st Year
5=Full and Graduated PR 2nd Year

The CPFSchemeTypes table contains no foreign keys.

CPFSCHEMETYPES 301
Password Restrictions
If a user is restricted from accessing an MYOB software function or window, for example the Spend Money window,
they will also be unable to access the table information relating to the function when using the MYOB ODBC Direct
driver.
The following table lists which ODBC tables and fields are restricted from a user when the related function has been
restricted in the company file.

Restricted function Tables impacted Restricted fields

Accounts List N/A

Account Information Accounts All


AccountActivities
AccountBudgets

Banking Accounts BankAccountNumber


BankAccountName

Budgets AccountBudgets All

Combine Accounts N/A

Company Data Auditor N/A

Jobs List N/A

Add/Edit a Job Jobs All


JobBudgets

Job Reimbursable Expenses N/A

Job Budgets by Account JobBudgets All

Record Journal Entry GeneralJournals All


GeneralJournalLines
RecurringGeneralJournals
RecurringGeneralJournalLines

Transfer Money TransferMoney All

Analyse Balance Sheet N/A

Analyse Profit & Loss N/A

Analyse Jobs N/A

Spend Money MoneySpent All


MoneySpentLines
RecurringMoneySpent
RecurringMoneySpentLines

Print Cheques N/A

Print/Email Payment Notifications N/A

302 CHAPTER 3 READ TABLES


Restricted function Tables impacted Restricted fields

Receive Money MoneyReceived All


MoneyReceivedLines
RecurringMoneyReceived
RecurringMoneyReceivedLines

Prepare Bank Deposit BankDeposits All


BankDepositLines

Reconcile Accounts N/A

Undo Last Reconciliation N/A N/A

Bank and Deposit Adjustments N/A

Bank Register N/A

Get Statement N/A

Match Transaction N/A

Analyse Cash Flow N/A

Enter Sales Sales All


SaleLines
ServiceSaleLines
ItemSaleLines
ProfessionalSaleLines
TimeBillingSaleLines
MiscSaleLines
RecurringSales
RecurringSaleLines
RecurringServiceSaleLines
RecurringItemSaleLines
RecurringProfessionalSaleLines
RecurringTimeBillingSaleLines
RecurringMiscSaleLines

Credit Limit & Hold Customers CreditLimit


OnHold

Customer Reimbursable Expenses N/A

Markup Information N/A

PASSWORD RESTRICTIONS 303


Restricted function Tables impacted Restricted fields

Print/Email Invoices DataFileInformation InvoiceSubject


InvoiceMessage
IncludeInvoiceNumber
InvoiceQuoteSubject
InvoiceQuoteMessage
IncludeInvoiceQuoteNumber
InvoiceOrderSubject
InvoiceOrderMessage
IncludeInvoiceOrderNumber
PurchaseSubject
PurchaseMessage
IncludePurchaseNumber
PurchaseQuoteSubject
PurchaseQuoteMessage
IncludePurchaseQuoteNumber
PurchaseOrderSubject
PurchaseOrderMessage
IncludePurchaseOrderNumber
StatementSubject
StatementMessage

Print/Email Statements DataFileInformation InvoiceSubject


InvoiceMessage
IncludeInvoiceNumber
InvoiceQuoteSubject
InvoiceQuoteMessage
IncludeInvoiceQuoteNumber
InvoiceOrderSubject
InvoiceOrderMessage
IncludeInvoiceOrderNumber
PurchaseSubject
PurchaseMessage
IncludePurchaseNumber
PurchaseQuoteSubject
PurchaseQuoteMessage
IncludePurchaseQuoteNumber
PurchaseOrderSubject
PurchaseOrderMessage
IncludePurchaseOrderNumber
StatementSubject
StatementMessage

Print Receipts N/A

Receive Payments CustomerPayments All


CustomerPaymentLines
CustomerFinanceCharges
CustomerDiscounts
CustomerDiscountLines
CustomerDeposits

304 CHAPTER 3 READ TABLES


Restricted function Tables impacted Restricted fields

Settle Returns & Credits CustomerFinanceCharges All


CustomerDiscounts
CustomerDiscountLines
SettledCredits
SettledCreditLines
CreditRefunds

Sales Register N/A

Analyse Sales N/A

Analyse Receivables N/A

Activities List N/A

Activity Information Activities All


ActivitySalesHistory

Enter Activity Slip ActivitySlips All


ActivitySlipInvoiced

View Activity Log N/A

Time Billing Customers N/A

Prepare Time Billing Invoice N/A

Enter Purchases Purchases All


PurchaseLines
ServicePurchaseLines
ItemPurchaseLines
ProfessionalPurchaseLines
MiscPurchaseLines
RecurringPurchases
RecurringPurchaseLines
RecurringServicePurchaseLines
RecurringItemPurchaseLines
RecurringProfessionalPurchaseLines
RecurringMiscPurchaseLines

PASSWORD RESTRICTIONS 305


Restricted function Tables impacted Restricted fields

Print/Email Purchase Orders DataFileInformation InvoiceSubject


InvoiceMessage
IncludeInvoiceNumber
InvoiceQuoteSubject
InvoiceQuoteMessage
IncludeInvoiceQuoteNumber
InvoiceOrderSubject
InvoiceOrderMessage
IncludeInvoiceOrderNumber
PurchaseSubject
PurchaseMessage
IncludePurchaseNumber
PurchaseQuoteSubject
PurchaseQuoteMessage
IncludePurchaseQuoteNumber
PurchaseOrderSubject
PurchaseOrderMessage
IncludePurchaseOrderNumber
StatementSubject
StatementMessage

Pay Bills SupplierPayments All


SupplierPaymentLines
SupplierFinanceCharges
SupplierDiscounts
SupplierDiscountLines
SupplierDeposits

Settle Returns & Debits SupplierFinanceCharges All


SupplierDiscounts
SupplierDiscountLines
SettledDebits
SettledDebitLines
DebitRefunds

Purchases Register N/A

Analyse Payables N/A

Credit Terms Terms All

DataFileInformation DefaultCustomerPriceLevelID
DefaultCustomerTaxCodeID
DefaultUseCustomerTaxCode
DefaultCustomerFreightTaxCodeID
DefaultCustomerCreditLimit
DefaultSupplierTaxCodeID
DefaultUseSupplierTaxCode
DefaultSupplierFreightTaxCodeID
DefaultSupplierCreditLimit

Sales & Purchases Information N/A

Add/Edit a Comment Comments All

Add/Edit a Shipping Method ShippingMethods All

306 CHAPTER 3 READ TABLES


Restricted function Tables impacted Restricted fields

Add/Edit a Referral Source ReferralSources All

Items List N/A

Item Information Items All


ItemLocations
ItemPrices
ItemOpeningBalance
ItemSalesHistory
ItemPurchasesHistory
BuiltItems
BuildComponents

Auto-Build Information BuiltItems All


BuildComponents

Locations List N/A

Location Information Locations All

Adjust Inventory InventoryAdjustments All


InventoryAdjustmentLines

Build Items InventoryTransfers All


InventoryTransferLines

Auto-Build Inventory N/A

Set Item Prices N/A

Count Inventory N/A

Items Register N/A

Analyse Inventory N/A

Move Items MoveItems All

Cards List N/A

Card Information Cards All


Customers
Suppliers
Employees
PersonalCards
CardActivities
SalesHistory
PurchaseHistory
SalespersonHistory

EPF Information (Malaysia) N/A All

CPF Information (Singapore) N/A All

Tax Tables Information (Malaysia) N/A All

Print Tax Forms (Malaysia) N/A All

Print Tax/CPF Forms (Singapore) N/A All

Print/Email Pay Slips N/A All

PASSWORD RESTRICTIONS 307


Restricted function Tables impacted Restricted fields

Load Tax/SOSCSO Table N/A All


(Malaysia)

Load CPF Table (Singapore) N/A All

Bank Instructions Register N/A All

Statement of Employee's N/A All


Remuneration

Billing Details Employees HourlyBillingRate


EstimatedCostPerHour

Combine Cards N/A

Synchronise Cards N/A

Advanced Card Search N/A

View Contact Log N/A

Contact Log Entry ContactLog All

Identifiers Identifiers All

Print Mailing Labels N/A

Create Personalised Letters N/A

Categories List N/A

Edit Category Categories All

Tax Codes N/A

Tax Code Information TaxCodes All


TaxCodeConsolidations

Recurring Transaction List N/A

Custom List and Field Names N/A

Currencies List N/A

Currency Information/Exchange Currency All


Rate

Easy Setup Assistant N/A

308 CHAPTER 3 READ TABLES


Restricted function Tables impacted Restricted fields

Preferences DataFileInformation UseRetailManagerLink


UseMultipleCurrencies
UseCategories
CategoriesRequired
UseAuditTracking
UseCreditLimitWarning
LimitTypeID
UseDailyAgeing
FirstAgeingPeriod
SecondAgeingPeriod
ThirdAgeingPeriod
IdentifyAgeByName
LockPeriodIsActive
LockPeriodDate
LockThirteenthPeriod
DefaultCustomerTermsID
DefaultCustomerPriceLevelID
DefaultCustomerTaxCodeID
DefaultUseCustomerTaxCode
DefaultCustomerFreightTaxCodeID
DefaultCustomerCreditLimit
DefaultSupplierTermsID
DefaultSupplierTaxCodeID
DefaultUseSupplierTaxCode
DefaultSupplierFreightTaxCodeID
DefaultSupplierCreditLimit
InvoiceSubject
InvoiceMessage
IncludeInvoiceNumber
InvoiceQuoteSubject
InvoiceQuoteMessage
IncludeInvoiceQuoteNumber
InvoiceOrderSubject
InvoiceOrderMessage
IncludeInvoiceOrderNumber
PurchaseSubject
PurchaseMessage
IncludePurchaseNumber
PurchaseQuoteSubject
PurchaseQuoteMessage
IncludePurchaseQuoteNumber
PurchaseOrderSubject
PurchaseOrderMessage
IncludePurchaseOrderNumber
StatementSubject
StatementMessage
UseStandardCost

PASSWORD RESTRICTIONS 309


Restricted function Tables impacted Restricted fields

Company Information DataFileInformation CompanyName


Address
Phone
FaxNumber
Email
IRDNumber
ServiceTaxNumber
CompanyNumber
SalesTaxNumber
CurrentFinancialYear
LastMonthInFinancialYear
ConversionDate
PeriodsPerYear

Business Calendar ImportantDates All

MYOB Business Services Setup N/A

Linked Accounts DataFileInformation UseReceivablesFreight


UseReceivablesDeposits
UseReceivablesDiscounts
UseReceivablesLateFees
UsePayablesInventory
UsePayablesFreight
UsePayablesDeposits
UsePayablesDiscounts
UsePayablesLateFees

LinkedAccounts All

Account Opening Balances N/A

Job Opening Balances N/A

Customer Opening Balances N/A

Supplier Opening Balances N/A

Add an Historical Sale N/A

Add an Historical Purchase N/A

Transaction Journal JournalRecords All


JournalSets

To Do List N/A

Find Transactions N/A

Advanced Filters N/A

CustomiseForms N/A

Custom List N/A

Add/Edit a Custom List Entry CustomLists All

310 CHAPTER 3 READ TABLES


Restricted function Tables impacted Restricted fields

Exchange Rate JournalSets TransactionExchangeRate


GeneralJournals
MoneySpent
MoneyReceived
Sales
Purchases
CustomerPayments
CustomerFinanceCharges
CustomerDiscounts
CustomerDeposits
SupplierPayments
SupplierFinanceCharges
SupplierDiscounts
SupplierDeposits
SettledCredits
CreditRefunds
SettledDebits
DebitRefunds
InventoryAdjustments
InventoryTransfers
BankDeposits
TransferMoney

Payment Details MoneyReceived PaymentCardNumber


CustomerPayments PaymentNameOnCard
CustomerFinanceCharges PaymentExpirationDate
CustomerDiscounts PaymentAuthorisationNumber
DebitRefunds PaymentBankAccountNumber
PaymentBankAccountName
PaymentChequeNumber
PaymentNotes

RecurringMoneyReceived PaymentCardNumber
PaymentNameOnCard
PaymentExpirationDate
PaymentNotes

Start a New Year N/A

Optimise Company File N/A

Purge Journal Entries N/A

Purge Closed Invoices N/A

Purge Activity Slips N/A

Purge Closed Bills N/A

Purge Contact Log N/A

Default Font Selections N/A

Verify Company File N/A

Active Workstations N/A

PASSWORD RESTRICTIONS 311


312 CHAPTER 3 READ TABLES
4 How to write

HOW TO WRITE
This section provides an overview of writing and committing information to an MYOB
company file.

Writing to an MYOB company file


To write to an MYOB company file, first connect to the file, then use SQL insert statements to
insert information into import tables. The import tables are write-only. Information is
committed by importing it from the import tables into an MYOB company file.

NOTE : Note: There are differences in the import routine fields available in the multi-user and
single-user MYOB products. Ensure that when you develop applications or solutions using the
MYOB ODBC Direct driver that these solutions take into account the field differences between the
multi-user and the single-user products.

Before you can write to a company file, the file must have been activated. The driver will check
that the company file has been activated before importing any data. If the company file has
not been activated, the import will not proceed and the driver will return an error code.
For more information about:
„ connecting to a company file, see ‘Connecting to a data source’ on page 314
„ structuring the SQL insert statements, see ‘Structuring the SQL INSERT command’ on
page 315
„ connection keywords and supported values, see ‘Connection string keywords and
supported values’ on page 19
„ native commands, see ‘Native commands’ on page 34.

Committing information to an MYOB company file


Information is written to the company file after each insert statement or after a commit,
depending on the SQL_ATTR_AUTOCOMMIT setting. For information about setting the
commit method, see ‘Setting the commit method’ on page 317.

Errors and warnings


The MYOB ODBC Direct driver returns a code on completion of each SQL command.
For more information about MYOB ODBC import errors and warnings, see ‘Testing error
codes’ on page 399.

313
Connecting to a data source

You can connect to an MYOB company file (the data source) for read and write access in two
ways: either by setting up a Data Source Name (DSN) for the file using the Data Sources
(ODBC) administrative tool in the Windows Control Panel, or without a DSN.
When connecting to the data source for writing, a connection string is required. The
parameters within the connection string, defined by keywords and their assigned values,
override default DSN values.
A connection string is a concatenation of a number of keywords and assigned values in the
format of [KEYWORD]=[VALUE];
Keywords and their assigned values are separated from other keyword/value pairs with
semi-colons. A semi-colon is also required to terminate a connection string.
Connection strings can be used when connecting to a data source with a DSN or, when the
DRIVER keyword is set, connecting directly to the data source.
For more information, see ‘Connection string keywords and supported values’ on page 19

Connecting using a DSN


To connect to a data source for writing using a DSN, the following keywords must be set:
DSN=<dsn name>;
ACCESS_TYPE=READ_WRITE

NOTE :Note: When connecting using a DSN, keywords and values in a connection string take
precedence over the equivalent values set in the DSN.

Connecting without using a DSN


To connect to a data source without a DSN, use the DRIVER keyword and set the following
additional keywords:
ACCESS_TYPE=READ_WRITE
TYPE=MYOB;
UID=<user ID>;
PWD or PASSWORD=<password>;
DATABASE=<path and name of company file>;
HOST_EXE_PATH=<path and name of MYOB application>;
KEY=<complete path and file name of key file>;
or
KEY=<key>;
Example:
" Driver={MYOMY0801}; TYPE=MYOB; UID=Administrator; PWD=MyPassword;
KEY=C:\Premier\123456700000.key; DATABASE
=C:\Premier\Test.myo;HOST_EXE_PATH=C:\Premier\MYOBP.exe;
NETWORK_PROTOCOL=NONET; DRIVER_COMPLETION=DRIVER_NOPROMPT; ACCESS_TYPE
=READ_WRITE; "

314 CHAPTER 4 HOW TO WRITE


NOTE :Note: The driver name will depend on the version of the driver. A connection string
can be a maximum of 16k (16384) characters in length. A password can be a maximum length of 31
characters.

For more information, see ‘Connection string keywords and supported values’ on page 19

Structuring the SQL INSERT command

When structuring the INSERT command, the MYOB file import structure must be observed.
Refer to Chapter 5, ’Write tables,’ starting on page 321 for information about structuring an
import record set for an import table.
The INSERT command is in the standard SQL format for single and multiple line inserts.
However, when there are several transactions, such as sales or invoices, the individual
transactions need to be separated by executing the END TRANSACTION command.
The END TRANSACTION command allows the addition of multiple transactions. This
command cannot be parsed to the ODBC driver as part of an insert statement block, but must
be parsed separately. The ODBC driver buffers all insert statement blocks to the driver, only
committing them to the import routines of the MYOB application when a COMMIT is called.

Example: Multiple INSERT into the Tax Code table (.NET)


The following code snippet demonstrates a .NET Tax Code table INSERT that passes multiple
items to the driver and commits them in one action.
cmdSQLInsert.CommandText = "INSERT INTO Import_Consolidated_TaxCodes
VALUES ('TST','','WET')";
cmdSQLInsert.ExecuteNonQuery();

cmdSQLInsert.CommandText = "END TRANSACTION";


cmdSQLInsert.ExecuteNonQuery();

cmdSQLInsert.CommandText = "INSERT INTO Import_Consolidated_TaxCodes


VALUES ('TST','','GST')";
cmdSQLInsert.ExecuteNonQuery();

cmdSQLInsert.CommandText = "END TRANSACTION";


cmdSQLInsert.ExecuteNonQuery();

cmdSQLInsert.CommandText = "INSERT INTO Import_Consolidated_TaxCodes


VALUES ('XXP','','GST')";
cmdSQLInsert.ExecuteNonQuery();

myTrans.Commit();

NOTE :MYTRANS is an ODBC transaction object in the .NET environment. For information
regarding the MYTRANS ODBC transaction object, refer to the MSDN help files. A full example on
how to create the transaction object is available within the sample source code examples.

STRUCTURING THE SQL INSERT COMMAND 315


Example: Multiple INSERT into the Miscellaneous Purchases
table (SQL)
The following example assigns values to both mandatory and non-mandatory fields in the
Import_Miscellaneous_Purchases table.
As in the above example, INSERT statement blocks are separated by an END TRANSACTION
statement block, enabling the driver to identify and buffer the two separate insert statements
for execution when COMMIT is called.

INSERT INTO Import_Miscellaneous_Purchases


(CoLastName, FirstName, PurchaseNumber, PurchaseDate, SuppliersNumber,
Inclusive, Memo, Description, AccountNumber, ExTaxAmount, IncTaxAmount,
Job, TaxCode, NonGSTImportAmount, GSTAmount, ImportDutyAmount,
PurchaseStatus, CurrencyCode, ExchangeRate, PaymentIsDue, DiscountDays,
BalanceDueDays, PercentDiscount, AmountPaid, Category)
VALUES
((‘Mountain Spring’, ‘’, ‘PJ000001’, ‘05/05/2007’, ‘Supplier Num’, ‘X’,
‘Purchase; Mountain Spring’, ‘Description Line 1’, ‘61100’, 90.91, 100.00,
‘’, ‘GST’, 0.00, 9.09, 0.00, ‘B’, ‘AUD’, 1.000000, 5, 1, 30, 0, 0.00, ‘’),
(‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘Description Line 2’, ‘62100’, 181.82, 200.00,
‘’, ‘GST’, 0.00, 18.18, 0.00, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’),
(‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘Description Line 3’, ‘62100’, 272.72, 300.00,
‘’, ‘GST’, 0.00, 27.28, 0.00, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’, ‘’));
END TRANSACTION
INSERT INTO Import_Miscellaneous_Purchases
(CoLastName, FirstName, PurchaseNumber, PurchaseDate, SuppliersNumber,
Inclusive, Memo, Description, AccountNumber, ExTaxAmount, IncTaxAmount,
Job, TaxCode, NonGSTImportAmount, GSTAmount, ImportDutyAmount,
PurchaseStatus, CurrencyCode, ExchangeRate, PaymentIsDue, DiscountDays,
BalanceDueDays, PercentDiscount, AmountPaid, Category)
VALUES
(‘Supplier’, ‘’, ‘PJ000002’, ‘05/05/2007’, ‘XYZ’, ‘X’, ‘Purchase;
Supplier’, ‘Description Line 1’, ‘91000’, 123.45, 123.45, ‘’, ‘N-T’, 0.00,
0.00, 0.00, ‘B’, ‘AUD’, 1.000000, 5, 1, 30, 0, 0.00, ‘’)
COMMIT

316 CHAPTER 4 HOW TO WRITE


Rules for writing to an MYOB company file
When inserting records via SQL, the following rules must be observed:
„ Mandatory fields must be included.
„ General fields are only required within the first line of a record set, or the Total Line. Refer
to Chapter 5, ’Write tables,’ starting on page 321 for information about general fields for
an import record set.
„ All records inserted into an import table are loaded into the company file via an import
function. The records must comply with the import file format. Some import files require a
double carriage return to indicate the end of one record set and the start of a new record
set. To indicate the end of a record set and the start of a new record set, use the END
TRANSACTION command.
„ The driver only provides for the INSERT of records via SQL (UPDATE is not supported).
„ DO NOT apply currency formatting to currency values.
„ When AUTO COMMIT is turned on, only one import transaction can be performed at a
time.
„ When AUTO COMMIT is turned off, all inserts for the transaction must be to the same
table.
„ An END TRANSACTION statement only marks the end of a set of records.
„ A COMMIT or ROLLBACK must be sent before INSERT parameters can be changed (e.g.
change table, or change field selections).
„ The driver can handle a maximum of 32k (32768) characters in an SQL statement block.

Use of the NULL keyword

NOTE : The NULL keyword must only be used with MYOB ODBC Direct v6.0.13 or later. Using the
NULL keyword with earlier versions will cause an unrecoverable error.

If you don’t want an integer or a double field to be altered when importing data, use the NULL
keyword in the insert statement.
The following example shows the result of using 0, ‘’, and NULL in an insert statement. Assume
that c2 is an integer field.
insert into T(c1, c2) values (1, 0); => Column c2 will be passed value 0
insert into T(c1, c2) values (1, ‘’); => Column c2 will be passed value 0
insert into T(c1, c2) values (1, NULL); => Column c2 will be passed value NULL

Setting the commit method


Data is committed to the company file either after each SQL statement (auto commit) or as a
batch of transactions (manual commit). The commit method is set using the
SQL_ATTR_AUTOCOMMIT keyword in the connection string, sent when you connect to the
company file.
For more information, see ‘Connection string keywords and supported values’ on page 19

STRUCTURING THE SQL INSERT COMMAND 317


Stored procedures

The MYOB ODBC Direct driver supports the following stored procedures.

Procedure Usage Possible results

GetProductID(); call GetProductID() Eg. “ACCOUNTING”,


“ACCOUNTING_PLUS”,
“PREMIER” or “ENTERPRISE”.
Returns the name of the MYOB
product used to create the company
file you are connecting to. Note: The possible results
depend on the region.

GetIsTBOnInv(); call GetIsTBOnInv() “Y” or “N”

Checks if the Use Time Billing option


has been selected in the company
file you are connecting to.

GetIsMultiCurrencyLoaded(); call GetIsMultiCurrencyLoaded() “Y” or “N”

Checks if the Use Multicurrency


option has been selected in the
company file you are connecting to.

Enabling and disabling conditional indexes

Conditional indexes can be enabled or disabled depending on the behaviour required.


For example, if you perform a SELECT query where a secondary or conditional index is used to
limit the results (eg. SELECT * FROM MoneySpent where TaxCodeID = 0), the ODBC driver will
return an empty record set.
This is due to limitations in the OpenAccess SDK which will only return results if a record exists,
matching the condition uniquely. A record with a value of 0 would be required for results to be
returned.
To cater for this type of SELECT statement, the conditional indexes can be disabled upon
connection or using the following connection string parameter or native commands:
Connection String Parameter:
„ Parameter: USE_CONDITIONAL_INDEXES=
„ Values: YES or NO
Native Commands:
„ To enable conditional indexes: USE CONDINDX
„ To disable conditional indexes: NO CONDINDX
Note that the conditional indexing option will be enabled by default unless specified.

318 CHAPTER 4 HOW TO WRITE


Card identification methods

When inserting a sale, purchase, banking transaction or updating a card record, an ‘identify
by’ method is available using the CardRecordID (user assigned). In addition, the unique
RecordID of any card can also be used. The IDENTIFY_BY option can still be set in the
connection string, however, when using the new native commands listed in this document,
the INDENTIFY_BY parameter can be set as required.

NOTE : The IDENTIFY_BY option will only take effect on import routines that support the
identification method.

Terminal Server session detection

When connecting to a company file in a Terminal Server environment, a Terminal Server


session user cannot see the processes of other Terminal Server session users on the server. This
is due to security restrictions applied by the Terminal Services security template.
As a result, issues can arise when attempting to connect to a company file that has been
opened by another user or when an ODBC connection has already been established.
There are two methods you can use to overcome these issues:
1 Reference the file path from a UNC path or network drive. This causes the driver to treat
the connection as a ‘network connection’ and bypass the check to see if the file is locked
for exclusive access by another process.
2 Enable the driver can detect if it is running within a Terminal Server session and bypass the
file-locking check. This enables the company file path to be set as the local path, which
reduces the load on the server’s network card and improve connection stability.

NOTE : The driver can only detect the Terminal Server environment if the process using the
ODBC driver is running within the Terminal Server session.

CARD IDENTIFICATION METHODS 319


Licence count incrementing on multi-user
products

The licence count will not increment when using MYOB ODBC v8 with the 2008 release of
MYOB Premier and MYOB Premier Enterprise. The maximum number of users allowed by a
client’s licence can connect to the company file, in addition to any ODBC connections.
The username that is used to connect to the company file via MYOB ODBC Direct will be
shown as being connected and will be tracked by the audit tracking features, however, the
licence count will not increment.

NOTE : Due to technical limitations, users must connect to the company file before the additional
ODBC connections are made.

0<2%3UHPLHU 0<2%2'%&'LUHFW
XVHUFRQQHFWLRQV FRQQHFWLRQV

XVHU RGEF

0<2%3UHPLHU
XVHU FRPSDQ\ILOH
OLFHQFHFRXQW 

RGEF
XVHU

320 CHAPTER 4 HOW TO WRITE


5 Write tables

WRITE TABLES
Import Account Budgets

Field Name Type Format Notes

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is
optional.

AccountName Text 30xAN

ThisYearPeriod1 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod2 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod3 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod4 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod5 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod6 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod7 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod8 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod9 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod10 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod11 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

ThisYearPeriod12 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod1 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod2 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod3 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

321
Field Name Type Format Notes

NextYearPeriod4 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod5 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod6 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod7 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod8 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod9 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod10 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod11 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

NextYearPeriod12 Double 13.2xN Negative values are indicated as such by way of a leading
negative sign. Currency formatting must not be applied.

322 CHAPTER 5 WRITE TABLES


Import Accounts

Field Name Type Format Notes

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is optional.

AccountName Text 30xAN

Header Text 1xAN Any non-zero value indicates that the account is a Header. A Details
account can be converted to a Header account via importing. A
Header account cannot be converted to a Detail account via
importing.

Balance Double 13.2xN Negative values are indicated as such by way of a leading negative
sign. Currency formatting must not be applied.

AccountType Text 23xA Account Types cannot be updated via importing. The Account Type
of new accounts can be set using the following rules:
If Asset account:
- If Header, the AccountType can only be "Asset"
- If Non-Header, the following values can be assigned:
• Bank
• Accounts Receivable
• Other Current Asset
• Fixed Asset
• Other Asset
If Liability account:
- If Header, the AccountType can only be "Liability"
- If Non-Header, the following values can be assigned:
• Credit Card
• Accounts Payable
• Other Current Liability
• Long Term Liability
• Other Liability
If Equity account, the AccountType can only be "Equity"
If Income account, the AccountType can only be "Income"
If Cost of Sales account, the AccountType can only be "Cost of Sales"
If Expense account, the AccountType can only be "Expense"
If Other Income account, the AccountType can only be "Other
Income"
If Other Expense account, the AccountType can only be "Other
Expense"

LastChequeNumber Integer 7xN

TaxCode Text 3xAN

CurrencyCode Text 3xA Only available in multi-user version

ExchangeAccount Integer 6xN Only available in multi-user version. The account separator is
optional.

InactiveAccount Text 1xA Y = Checkbox selected


N = Checkbox deselected

BankAccountNumber Text 20xAN

IMPORT ACCOUNTS 323


Field Name Type Format Notes

BankAccountName Text 32xAN Valid characters are 0-9 A-Z & * . / -

Description Text 255xAN

CashFlowClassification Text 1xA F = Financing


I = Investing
O = Operating

ReportSubtotal Text 1xA Y = Checkbox selected


N = Checkbox deselected

324 CHAPTER 5 WRITE TABLES


Import Activities

Field Name Type Format Notes

ActivityID Text 30xAN Entry in this field is mandatory.

ActivityName Text 30xAN

Description Text 255xAN

UseDescriptionOnSale Text 1xAN Any non-zero value indicates that the Activity Description is used on
Sales. The Use Description on Sales checkbox cannot be deselected
via importing.

NonHourly Text 1xAN Any non-zero value indicates that the Activity is Non-hourly. The
Hourly/Non-hourly status of an existing activity cannot be updated
through importing. The Hourly/Non-hourly status can only be set
when importing a new activity record.

NonChargeable Text 1xAN Any non-zero value indicates that the Activity is Non-chargeable. The
Chargeable/Non-chargeable status of an existing activity cannot be
updated through importing. The Chargeable/Non-chargeable status
can only be set when importing a new activity record.

UseRate Text 1xA E = Use Employee Billing Rate


C = Use Customer Billing Rate
A = Use Activity Rate

ActivityRate Double 11.4xN Currency formatting must not be applied.

IncomeAccount Integer 6xN The account separator is optional.

TaxCodeWhenSold Text 3xAN Y = Checkbox selected


N = Checkbox deselected

UnitOfMeasure Text 5xAN

InactiveActivity Text 1xA Y = Checkbox selected


N = Checkbox deselected

IMPORT ACTIVITIES 325


Import Activity Slips

Field Name Type Format Notes

EmpCoLastName Text 30xAN A value must exist within this field if no value exists within the EmpCardID and
EmpRecordID fields.

EmpFirstName Text 20xAN

SlipID Text 9xAN

SlipDate Text 11xAN Date format is controlled within the Regional Settings of the operating system

ActivityID Text 30xAN Entry in this field is mandatory.

CustCoLastName Text 50xAN

CustFirstName Text 20xAN When the card is Individual, the format of the CustCoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company. When
the card is Company, the format of the CustCoLastName field is 50xAN.

Units Double 11.2xN Negative values are indicated as such by way of a leading negative sign.

Rate Double 11.4xN Currency formatting must not be applied.

Job Text 15xAN

Notes Text 255xAN

AdjustmentDollars Double 11.2xN Negative values are indicated as such by way of a leading negative sign.
Currency formatting must not be applied.

AdjustmentUnits Double 11.2xN Negative values are indicated as such by way of a leading negative sign.

BilledDollars Double 11.2xN Negative values are indicated as such by way of a leading negative sign.
Currency formatting must not be applied.

BilledUnits Double 11.2xN Negative values are indicated as such by way of a leading negative sign.

StartTime Text 11xAN Field is to be formatted HH:MM:SS AM/PM. It is not necessary to include
AM/PM if the time is reported in 24 hour time.

StopTime Text 11xAN Field is to be formatted HH:MM:SS AM/PM. It is not necessary to include
AM/PM if the time is reported in 24 hour time.

EmpCardID Text 15xAN A value must exist within this field if no value exists within the
EmpCoLastName and EmpRecordID fields.

EmpRecordID Text 10xAN A value must exist within this field if no value exists within the
EmpCoLastName and EmpCardID fields.

326 CHAPTER 5 WRITE TABLES


Import Consolidated Tax Codes

Field Name Type Format Notes

TaxCode Text 3xAN Entry in this field is mandatory.

Description Text 30xAN

SubTaxCode Text 3xAN Entry in this field is mandatory.

IMPORT CONSOLIDATED TAX CODES 327


Import Contact Log

Field Name Type Format Notes

CoLastName Text 50xAN Entry in this field is conditional. A value must exist
within this field if no value exists within the CardID and
CardRecordID fields.

FirstName Text 20xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist
within this field if no value exists within the CoLastName
and CardRecordID fields.

CardRecordID Integer 10xN Entry in this field is conditional. A value must exist
within this field if no value exists within the CoLastName
and CardID fields.

Contact Text 255xAN

LogDate Text 10xAN Date format is controlled within the Regional Settings of
the operating system.

Notes Text 255xAN

ElapsedTime Text 5xAN Field can be formatted in hours and minutes (HH:MM)
or minutes only (NNNN).

RecontactDate Text 10xAN Date format is controlled within the Regional Settings of
the operating system.

RemoveFromContactAlert Text 1xA Y = Remove from contact alert.


Any other value = Do not remove from contact alert.

ContactLogRecordID Integer 10xN A value must exist within this field if attempting to
update an existing contact log record.

328 CHAPTER 5 WRITE TABLES


Import Custom List

Field Name Type Format Notes

CustomListName Text 30xAN Entry in this field is mandatory.

Type Text 1xA Entry in this field is mandatory.

I = Item
C = Customer
S = Supplier
E = Employee
P = Personal

Number Integer 1xN Entry in this field is mandatory.

1 = Custom List 1
2 = Custom List 2
3 = Custom List 3

UpdateCustomListName Text 30xAN A value must exist within this field if attempting to
update an existing custom list record.

IMPORT CUSTOM LIST 329


Import Customer Cards

Field Name Type Format Notes

CoLastName Text 50xAN Entry in this field is conditional. A value must exist within this field
if no value exists within the CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field
if no value exists within the CoLastName and RecordID fields.

CardStatus Text 1XAN Y = Checkbox selected


N = Checkbox deselected

CurrencyCode Text 3xA Only available in multi-user version

Address1AddressLine1 Text 255xAN

Address1AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

Address1AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address1AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Address1City Text 255xAN

Address1State Text 255xAN

Address1PostCode Text 10xAN

Address1Country Text 255xAN

Address1Phone1 Text 21xAN

Address1Phone2 Text 21xAN

Address1Phone3 Text 21xAN

Address1Fax Text 21xAN

Address1Email Text 255xAN

Address1Website Text 255xAN

Address1ContactName Text 25xAN

Address1Salutation Text 15xAN

Address2AddressLine1 Text 255xAN

Address2AddressLine2 Text 253xAN The maximum length of Address2AddressLine2 is reduced by any


content existing within field Address2AddressLine1.

330 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address2AddressLine3 Text 251xAN The maximum length of Address2AddressLine3 is reduced by any


content existing within fields Address2AddressLine1 and
Address2AddressLine2.

Address2AddressLine4 Text 249xAN The maximum length of Address2AddressLine4 is reduced by any


content existing within fields Address2AddressLine1,
Address2AddressLine2 and Address2AddressLine3.

Address2City Text 255xAN

Address2State Text 255xAN

Address2PostCode Text 10xAN

Address2Country Text 255xAN

Address2Phone1 Text 21xAN

Address2Phone2 Text 21xAN

Address2Phone3 Text 21xAN

Address2Fax Text 21xAN

Address2Email Text 255xAN

Address2Website Text 255xAN

Address2ContactName Text 25xAN

Address2Salutation Text 15xAN

Address3AddressLine1 Text 255xAN

Address3AddressLine2 Text 253xAN The maximum length of Address3AddressLine2 is reduced by any


content existing within field Address3AddressLine1.

Address3AddressLine3 Text 251xAN The maximum length of Address3AddressLine3 is reduced by any


content existing within fields Address3AddressLine1 and
Address3AddressLine2.

Address3AddressLine4 Text 249xAN The maximum length of Address3AddressLine4 is reduced by any


content existing within fields Address3AddressLine1,
Address3AddressLine2 and Address3AddressLine3.

Address3City Text 255xAN

Address3State Text 255xAN

Address3PostCode Text 10xAN

Address3Country Text 255xAN

Address3Phone1 Text 21xAN

Address3Phone2 Text 21xAN

Address3Phone3 Text 21xAN

Address3Fax Text 21xAN

Address3Email Text 255xAN

Address3Website Text 255xAN

Address3ContactName Text 25xAN

IMPORT CUSTOMER CARDS 331


Field Name Type Format Notes

Address3Salutation Text 15xAN

Address4AddressLine1 Text 255xAN

Address4AddressLine2 Text 253xAN The maximum length of Address4 Line 2 is reduced by any content
existing within field Address1AddressLine1.

Address4AddressLine3 Text 251xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address4AddressLine4 Text 249xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1, Address1AddressLine2
and Address1AddressLine3.

Address4City Text 255xAN

Address4State Text 255xAN

Address4PostCode Text 10xAN

Address4Country Text 255xAN

Address4Phone1 Text 21xAN

Address4Phone2 Text 21xAN

Address4Phone3 Text 21xAN

Address4Fax Text 21xAN

Address4Email Text 255xAN

Address4Website Text 255xAN

Address4ContactName Text 25xAN

Address4Salutation Text 15xAN

Address5AddressLine1 Text 255xAN

Address5AddressLine2 Text 253xAN The maximum length of Address5AddressLine2 is reduced by any


content existing within field Address5AddressLine1.

Address5AddressLine3 Text 251xAN The maximum length of Address5AddressLine3 is reduced by any


content existing within fields Address5AddressLine1 and
Address5AddressLine2.

Address5AddressLine4 Text 249xAN The maximum length of Address5AddressLine4 is reduced by any


content existing within fields Address5AddressLine1,
Address5AddressLine2 and Address5AddressLine3.

Address5City Text 255xAN

Address5State Text 255xAN

Address5PostCode Text 10xAN

Address5Country Text 255xAN

Address5Phone1 Text 21xAN

Address5Phone2 Text 21xAN

Address5Phone3 Text 21xAN

Address5Fax Text 21xAN

332 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address5Email Text 255xAN

Address5Website Text 255xAN

Address5ContactName Text 25xAN

Address5Salutation Text 15xAN

Picture Text 255xAN

Notes Text 255xAN

Identifiers Text 10xA

CustomList1 Text 30xAN

CustomList2 Text 30xAN

CustomList3 Text 30xAN

CustomField1 Text 255xAN

CustomField2 Text 255xAN

CustomField3 Text 255xAN

BillingRate Double 10.4xN Only available in multi-user version


Currency formatting must not be applied.

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

TaxCode Text 3xAN

CreditLimit Double 7.2xN

TaxIDNumber Text 19xAN

VolumeDiscount Double 2.2xN Percent formatting must not be applied.

SaleLayout Text 1xA S = Service


I = Item
P = Purchase
T = Time Billing
M = Miscellaneous
Any other value = No Default

IMPORT CUSTOMER CARDS 333


Field Name Type Format Notes

ItemPriceLevel Integer 1xN Only available in multi-user version


0 = Base Selling Price
1 = Price Level A
2 = Price Level B
3 = Price Level C
4 = Price Level D
5 = Price Level E
6 = Price Level F

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Text MM/YY

IncomeAccount Integer 6xN The account separator is optional.

Salesperson Text 50xAN If the Salesperson is an individual, the field should be populated in
the format <Last Name>, <First Name>

SalespersonCardID Text 15xAN

SaleComment Text 255xAN

ShippingMethod Text 20xAN

PrintedForm Text 255xAN

FreightTaxCode Text 3xAN

UseCustomersTaxCode Text 1xAN Y = Checkbox selected


N = Checkbox deselected

ReceiptMemo Text 255xAN

InvoiceDelivery Text 1xA P= To be Printed


E= To be Emailed
B= To be Printed and Emailed
A= Already Printed or Sent

RecordID Text 10xAN A value must exist within this field if no value exists within the
CoLastName and CardID fields.

334 CHAPTER 5 WRITE TABLES


Import Employee Cards

Field Name Type Format Notes

CoLastName Text 30xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CardID and RecordID fields.

FirstName Text 20xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and RecordID fields.

CardStatus Text 1XAN Y = Checkbox selected


N = Checkbox deselected

CurrencyCode Text 3xA Only available in multi-user version

Address1AddressLine1 Text 255xAN

Address1AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

Address1AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address1AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Address1City Text 255xAN

Address1State Text 255xAN

Address1PostCode Text 10xAN

Address1Country Text 255xAN

Address1Phone1 Text 21xAN

Address1Phone2 Text 21xAN

Address1Phone3 Text 21xAN

Address1Fax Text 21xAN

Address1Email Text 255xAN

Address1Website Text 255xAN

Address1Salutation Text 15xAN

Address2AddressLine1 Text 255xAN

Address2AddressLine2 Text 253xAN The maximum length of Address2AddressLine2 is reduced by any


content existing within field Address2AddressLine1.

Address2AddressLine3 Text 251xAN The maximum length of Address2AddressLine3 is reduced by any


content existing within fields Address2AddressLine1 and
Address2AddressLine2.

Address2AddressLine4 Text 249xAN The maximum length of Address2AddressLine4 is reduced by any


content existing within fields Address2AddressLine1,
Address2AddressLine2 and Address2AddressLine3.

IMPORT EMPLOYEE CARDS 335


Field Name Type Format Notes

Address2City Text 255xAN

Address2State Text 255xAN

Address2PostCode Text 10xAN

Address2Country Text 255xAN

Address2Phone1 Text 21xAN

Address2Phone2 Text 21xAN

Address2Phone3 Text 21xAN

Address2Fax Text 21xAN

Address2Email Text 255xAN

Address2Website Text 255xAN

Address2Salutation Text 15xAN

Address3AddressLine1 Text 255xAN

Address3AddressLine2 Text 253xAN The maximum length of Address3AddressLine2 is reduced by any


content existing within field Address3AddressLine1.

Address3AddressLine3 Text 251xAN The maximum length of Address3AddressLine3 is reduced by any


content existing within fields Address3AddressLine1 and
Address3AddressLine2.

Address3AddressLine4 Text 249xAN The maximum length of Address3AddressLine4 is reduced by any


content existing within fields Address3AddressLine1,
Address3AddressLine2 and Address3AddressLine3.

Address3City Text 255xAN

Address3State Text 255xAN

Address3PostCode Text 10xAN

Address3Country Text 255xAN

Address3Phone1 Text 21xAN

Address3Phone2 Text 21xAN

Address3Phone3 Text 21xAN

Address3Fax Text 21xAN

Address3Email Text 255xAN

Address3Website Text 255xAN

Address3Salutation Text 15xAN

Address4AddressLine1 Text 255xAN

Address4AddressLine2 Text 253xAN The maximum length of Address4 Line 2 is reduced by any content
existing within field Address1AddressLine1.

Address4AddressLine3 Text 251xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1 and
Address1AddressLine2.

336 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address4AddressLine4 Text 249xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1, Address1AddressLine2
and Address1AddressLine3.

Address4City Text 255xAN

Address4State Text 255xAN

Address4PostCode Text 10xAN

Address4Country Text 255xAN

Address4Phone1 Text 21xAN

Address4Phone2 Text 21xAN

Address4Phone3 Text 21xAN

Address4Fax Text 21xAN

Address4Email Text 255xAN

Address4Website Text 255xAN

Address4Salutation Text 15xAN

Address5AddressLine1 Text 255xAN

Address5AddressLine2 Text 253xAN The maximum length of Address5AddressLine2 is reduced by any


content existing within field Address5AddressLine1.

Address5AddressLine3 Text 251xAN The maximum length of Address5AddressLine3 is reduced by any


content existing within fields Address5AddressLine1 and
Address5AddressLine2.

Address5AddressLine4 Text 249xAN The maximum length of Address5AddressLine4 is reduced by any


content existing within fields Address5AddressLine1,
Address5AddressLine2 and Address5AddressLine3.

Address5City Text 255xAN

Address5State Text 255xAN

Address5PostCode Text 10xAN

Address5Country Text 255xAN

Address5Phone1 Text 21xAN

Address5Phone2 Text 21xAN

Address5Phone3 Text 21xAN

Address5Fax Text 21xAN

Address5Email Text 255xAN

Address5Website Text 255xAN

Address5Salutation Text 15xAN

Picture Text 255xAN

Notes Text 255xAN

Identifiers Text 10xA

CustomList1 Text 30xAN

IMPORT EMPLOYEE CARDS 337


Field Name Type Format Notes

CustomList2 Text 30xAN

CustomList3 Text 30xAN

CustomField1 Text 255xAN

CustomField2 Text 255xAN

CustomField3 Text 255xAN

BillingRate Double 10.4xN Only available in multi-user version.


Currency formatting must not be applied.

CostPerHour Double 10.4xN Only available in multi-user version.


Currency formatting must not be applied.

BankAccountNumber Text 20xAN

BankAccountName Text 32xAN

StatementText Text 18xAN

PaymentMethod Text 1xA 1 = Cash


2 = Cheque
4 = Bank Instructions

DateOfBirth Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

Gender Text 1xAN M = Male


F = Female

StartDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

TerminationDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

PayBasis Text 1xA S = Salary


H = Hourly

MonthlySalary Double 13.2xN

DailyRate Double 13.2xN

HourlyRate Double 13.2xN

PayFrequency Text 1xA M = Monthly

WorkHourInDay Double 2.2xN

HoursInFullTimeWorkWeek Double 3.3xN The hours the employee works in a week.

WagesExpenseAccount Integer 5xN

TaxFileNumber Integer 20xN

IsTaxBorneByEmployer Text 1xA (Singapore) Y=Yes, N=No.

DefaultCategory Text 15xAN

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and CardID fields.

338 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

EmploymentCategory Text 1xA P = Permanent


T = Temporary
C = Contract

EmploymentStatus Text 1xA F = Full Time


P = Part Time
C = Casual

TerminationReason Text 45xAN

Passport Text 9xAN Entry in this field is conditional.

MaritalStatus Text 9xA S=Single


M=Married
W=Widowed
D=Divorce
P=Separated

Department Text 30xAN Full department name.

Position Text 40xAN Full position name.

PaySlipDelType Text 1xA P=To be Printed


E=To be Emailed
B=To be Printed and Emailed
A=Already Printed or Sent

PaySlipEmail Text 255xAN

ResidentialStatus Employee Residential Status value includes:


• Citizen
• Permanent Resident
• Foreigner

Religion Text 15xAN The employee’s religion

Race Text 15xAN The employee’s race

Nationality Text 15xAN The employee’s nationality

OfficialLastDay Text 10xAN The employee’s official last day

NewICNo Integer 12xN (Malaysia) New Identity Number

OldICNo Text 15xAN (Malaysia) Old Identity Number

ASBNo Text 15xAN (Malaysia) Employee Amanah Saham number

LUTHNo Text 25xAN (Malaysia) Employee Tabung Haji number

SOCSONo Text 20xAN (Malaysia) Employee SOCSO number

SOCSOSchemeID (Malaysia) Employee SOCSO scheme, either:


0=Not Applicable
1=1st Category
2=2nd Category

EPFNo Text 20xAN (Malaysia) Employee Employment Provident Fund number

LHDNMBranch Text 30xAN (Malaysia) Employee Tax branch code

IMPORT EMPLOYEE CARDS 339


Field Name Type Format Notes

TaxTypeID (Malaysia) Employee Tax Category, either:


0=Not Taxable
1=Category 1
2=Category 2
3=Category 3
4=Full Rate

NoofChildRelief Double 2.2xN (Malaysia) Number of Child Relief for the tax calculation

CountryCode Text 2xA (Malaysia) Country code for the tax statutory forms

ICNo Text 12xAN (Singapore) Identity number for Singaporean

FINNo Text 15xAN (Singapore) Identity number for non Singaporean

PRNo Text 15xAN (Singapore) Employee Permanent Resident Number

PRStartDate Text 10xAN (Singapore) Employee Permanent Resident Start Date

CPFSchemeID (Singapore) Employee CPF Scheme, either:


0=Not Applicable
1=Singaporean
2=Graduated PR 1st Year
3=Graduated PR 2nd Year
4=Full and Graduated PR 1st Year
5=Full and Graduated PR 2nd Year

CPFNumber Text 20xAN (Singapore) Employee CPF Number

340 CHAPTER 5 WRITE TABLES


Import Item Purchases

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID
and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is
50xAN.

AddressLine1 Text 255xAN

AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

PurchaseNumber Text 8xAN

PurchaseDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

SuppliersNumber Text 20xAN

ShipVia Text 20xAN

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

ItemNumber Text 30xAN Entry in this field is mandatory.

Quantity Double 8.3xN Negative values are indicated as such by way of a leading negative sign.

Description Text 255xAN

ExTaxPrice Double 13.2xN Currency formatting must not be applied.

IncTaxPrice Double 13.2xN Currency formatting must not be applied.

Discount Double 3.2xN Percent formatting must not be applied.

IncTaxTotal Double 13.2xN Currency formatting must not be applied.

Job Text 15xAN

Comment Text 255xAN

Memo Text 255xAN

IMPORT ITEM PURCHASES 341


Field Name Type Format Notes

ShippingDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

TaxCode Text 3xAN

NonTaxImportAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

ImportDutyAmount Double 13.2xN Currency formatting must not be applied.

FreightExTaxAmount Double 13.2xN Currency formatting must not be applied.

IncTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxCode Text 3xAN

FreightNonTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightImportDutyAmount Double 13.2xN Currency formatting must not be applied.

PurchaseStatus Text 1xA Q = Quote


O = Order
B = Bill

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

AmountPaid Double 13.2xN Currency formatting must not be applied.

Category Text 15xAN

Ordered Double 8.3xN Negative values are indicated as such by way of a leading negative sign.

Received Double 8.3xN Negative values are indicated as such by way of a leading negative sign.

Billed Double 8.3xN Negative values are indicated as such by way of a leading negative sign.

Location Text 10xAN Only available in multi-user version

CardID Text 10xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName and RecordID fields.

RecordID Text 15xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName and CardID fields.

342 CHAPTER 5 WRITE TABLES


Import Inventory Adjustments

Field Name Type Format Notes

JournalNumber Text 8xAN

AdjustmentDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

Memo Text 255xAN

ItemNumber Text 30xAN Entry in this field is mandatory.

Location Text 10xAN

Quantity Double 11.3xN

UnitCost Double 11.4xN

Amount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Account Integer 6xN Do not include the account separator.

Job Text 15xAN

AllocationMemo Text 255xAN

Category Text 15xAN

IMPORT INVENTORY ADJUSTMENTS 343


Import Item Sales

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the
CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

AddressLine1 Text 255xAN

AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

InvoiceNumber Text 8xAN

SaleDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

CustomersNumber Text 20xAN

ShipVia Text 20xAN

ItemNumber Text 30xAN Entry in this field is mandatory.

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

Quantity Double 8.3xN Negative values are indicated as such by way of a leading negative
sign.

Description Text 255xAN

ExTaxPrice Double 13.2xN Currency formatting must not be applied.

IncTaxPrice Double 13.2xN Currency formatting must not be applied.

Discount Double 3.2xN Percent formatting must not be applied.

ExTaxTotal Double 13.2xN Currency formatting must not be applied.

IncTaxTotal Double 13.2xN Currency formatting must not be applied.

Job Text 15xAN

344 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Comment Text 255xAN

Memo Text 255xAN

SalespersonLastName Text 50xAN

SalespersonFirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
SalespersonLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
SalespersonLastName field is 50xAN.

ShippingDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

Amount Double 13.2xN Currency formatting must not be applied.

FreightExTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightIncTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxCode Text 3xAN

FreightNonTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxAmount Double 13.2xN Currency formatting must not be applied.

SaleStatus Text 1xA Q = Quote


O = Order
I = Invoice

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

ReferralSource Text 20xAN

AmountPaid Double 13.2xN

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

IMPORT ITEM SALES 345


Field Name Type Format Notes

CardNumber Text 25xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

DrawerAccountNumber Integer 20xN

DrawerChequeNumber Text 25xAN

Category Text 15xAN

Location Text 10xAN Only available in multi-user version

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field
if no value exists within the CoLastName and RecordID fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field
if no value exists within the CoLastName and CardID fields.

346 CHAPTER 5 WRITE TABLES


Import Items

Field Name Type Format Notes

ItemNumber Text 30xAN Entry in this field is mandatory.

ItemName Text 30xAN

Buy Text 1xAN Any non-zero value indicates that the Item is Bought. The I Buy
checkbox cannot be deselected via importing.

Sell Text 1xAN Any non-zero value indicates that the Item is Sold. The I Sell
checkbox cannot be deselected via importing.

Inventory Text 1xAN Any non-zero value indicates that the Item is Inventoried. The
Inventory checkbox cannot be deselected via importing.

AssetAccount Integer 6xN The account separator is optional.

IncomeAccount Integer 6xN The account separator is optional.

ExpenseAccount Integer 6xN The account separator is optional.

ItemPicture Text 255xAN Only available in multi-user version

Description Text 255xAN Only available in multi-user version

UseDescriptionOnSale Text 1xAN Only available in multi-user version


Any non-zero value indicates that the Item Description is used on
Sales. The Use Item Description on Sales checkbox cannot be
deselected via importing.

CustomList1 Text 30xAN Only available in multi-user version

CustomList2 Text 30xAN Only available in multi-user version

CustomList3 Text 30xAN Only available in multi-user version

CustomField1 Text 255xAN Only available in multi-user version

CustomField2 Text 255xAN Only available in multi-user version

CustomField3 Text 255xAN Only available in multi-user version

PrimarySupplier Text 30xAN Card names can be up to 52 digits in length. The Items import
table within MYOB only provides for card names up to 30
characters in length.

SupplierItemNumber Text 30xAN

TaxCodeWhenBought Text 3xAN

BuyUnitMeasure Text 5xAN

NumberItemsBuyUnit Integer 4xN

ReorderQuantity Double 10.3xN

MinimumLevel Double 10.3xN

SellingPrice Double 11.4xN Currency formatting must not be applied.

SellUnitMeasure Text 5xAN

TaxCodeWhenSold Text 3xAN

IMPORT ITEMS 347


Field Name Type Format Notes

SellPriceInclusive Text 1xAN Any non-zero value indicates that the Base Selling Price is
Tax/GST Inclusive. The Prices are Tax/GST Inclusive checkbox
cannot be deselected via importing.

SalesTaxCalcMethod Integer 1xN 0 = Actual Selling Price


3 = Base Selling Price
4 = Price Level A
5 = Price Level B
6 = Price Level C
7 = Price Level D
8 = Price Level E
9 = Price Level F

NumberItemsSellUnit Integer 4xN

QuantityBreak1 Double 10.3xN Only available in multi-user version

QuantityBreak2 Double 10.3xN Only available in multi-user version

QuantityBreak3 Double 10.3xN Only available in multi-user version

QuantityBreak4 Double 10.3xN Only available in multi-user version

QuantityBreak5 Double 10.3xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelAQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelBQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelCQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelDQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelEQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelFQtyBreak1 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelAQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelBQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelCQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelDQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelEQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelFQtyBreak2 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

348 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

PriceLevelAQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelBQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelCQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelDQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelEQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelFQtyBreak3 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelAQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelBQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelCQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelDQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelEQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelFQtyBreak4 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelAQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelBQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelCQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelDQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelEQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

PriceLevelFQtyBreak5 Double 11.4xN Only available in multi-user version


Currency formatting must not be applied.

InactiveItem Text 1xA Y = Checkbox selected


N = Checkbox deselected

StandardCost Double 11.4xN

DefaultShipSellLocation Text 10xAN Only available in multi-user version

DefaultReceiveAutoBuildLocation Text 10xAN Only available in multi-user version

IMPORT ITEMS 349


Import Jobs

Field Name Type Format Notes

JobNumber Text 15xAN Entry in this field is mandatory.

JobName Text 25xAN

SubJobOf Text 15xAN

Header Text 1xA D = Detail


H = Header

Description Text 255xAN

Contact Text 25xAN

PercentComplete Double 3.2xN

StartDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

FinishDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

Manager Text 25xAN

LinkedCustomer Text 50xAN Card names can be up to 52 digits in length. The Jobs import table
only provides for card names up to 50 characters in length.

InactiveJob Text 1xA Y = Checkbox selected


N = Checkbox deselected

TrackReimburseables Text 1xA Y = Checkbox selected


N = Checkbox deselected

350 CHAPTER 5 WRITE TABLES


Import Miscellaneous Purchases

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the
CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

PurchaseNumber Text 8xAN

PurchaseDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system.

SuppliersNumber Text 20xAN

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax
Inclusive.

Memo Text 255xAN

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is
optional.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not
be applied.

Job Text 15xAN

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TAXAmount Double 13.2xN Currency formatting must not be applied.

ImportDutyAmount Double 13.2xN Currency formatting must not be applied.

PurchaseStatus Text 1xA Q = Quote


O = Order
B = Bill

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

IMPORT MISCELLANEOUS PURCHASES 351


Field Name Type Format Notes

PercentDiscount Double 2.2xN Percent formatting must not be applied.

AmountPaid Double 13.2xN Currency formatting must not be applied.

Category Text 15xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and RecordID
fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and CardID
fields.

352 CHAPTER 5 WRITE TABLES


Import Miscellaneous Sales

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID
or RecordID field.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is
50xAN.

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName or RecordID field.

InvoiceNumber Text 8xAN

SaleDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

CustomersNumber Text 20xAN

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

Memo Text 255xAN

SalespersonLastName Text 50xAN

SalespersonFirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the SalespersonLastName
field is 30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the SalespersonLastName
field is 50xAN.

ReferralSource Text 20xAN

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Job Text 15xAN

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

SaleStatus Text 1xA Q = Quote


O = Order
I = Invoice

CurrencyCode Text 3xA Only available in multi-user version.

IMPORT MISCELLANEOUS SALES 353


Field Name Type Format Notes

ExchangeRate Double 6.6xN Only available in multi-user version.

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

ReferralSource Text 20xAN

AmountPaid Double 13.2xN Currency formatting must not be applied.

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

DrawerAccountName Text 32xAN Valid characters are 0-9 A-Z & ‘ . / -


Alphas must be in upper case.

DrawerChequeNumber Text 25xAN

Category Text 15xAN

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName and CardID fields.

354 CHAPTER 5 WRITE TABLES


Import NonConsolidated Tax Codes

Field Name Type Format Notes

TaxCode Text 3xAN Entry in this field is mandatory.

Description Text 30xAN

TaxType Integer 1xN Entry in this field is mandatory.

1 = Import Duty
2 = Sales Tax
3 = Goods & Services Tax
4 = Input Taxed
6 = Luxury Car Tax
7 = Voluntary Withholding
8 = No ABN/TFN

Rate Double 8.4xN Entry in this field is mandatory.


Percent formatting must not be applied.

TaxCollectedAccount Integer 5xN Do not include the account separator.

TaxPaidAccount Integer 5xN Do not include the account separator.

TaxAuthorityCard Text 30xAN Card names can be up to 52 digits in length. The


Non-Consolidated import table within MYOB only provides for card
names up to 30 characters in length.

IMPORT NONCONSOLIDATED TAX CODES 355


Import Pay Bills

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID and
RecordID fields.

FirstName Text 20xAN When the card is Individual, the format of the CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company. When
the card is Company, the format of the CoLastName field is 50xAN.

PayeeLine1 Text 255xAN

PayeeLine2 Text 253xAN The maximum length of PayeeLine2 is reduced by any content existing
within field PayeeLine1.

PayeeLine3 Text 251xAN The maximum length of PayeeLine3 is reduced by any content existing
within fields PayeeLine1 and PayeeLine2.

PayeeLine4 Text 249xAN The maximum length of PayeeLine4 is reduced by any content existing
within fields PayeeLine1, PayeeLine2 and PayeeLine3.

PaymentAccount Integer 6xN Entry in this field is mandatory. The account separator is optional.

ChequeNumber Text 8xAN

PaymentDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

PurchaseNumber Text 8xAN Entry in this field is conditional. A value must exist within this field if no value
exists within the SuppliersNumber field.

SuppliersNumber Text 20xAN Entry in this field is conditional. A value must exist within this field if no value
exists within the PurchaseNumber field.

BillDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

AmountApplied Double 13.2xN Entry in this field is mandatory. Currency formatting must not be applied.

Memo Text 255xAN

AlreadyPrinted Text 1xAN Any non-zero value indicates that the Pay Bill entry is Already Printed.

CurrencyCode Text 3xAN Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

CardID Text 15xAN A value must exist within this field if no value exists within the CoLastName
and RecordID fields.

RecordID Text 10xAN A value must exist within this field if no value exists within the CoLastName
and CardID fields.

DeliveryStatus Text 1xA P = To be Printed


E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

356 CHAPTER 5 WRITE TABLES


Import Personal Cards

Field Name Type Format Notes

CoLastName Text 50xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is
50xAN.

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName and RecordID fields.

CardStatus Text 1XAN Y = Checkbox selected


N = Checkbox deselected

CurrencyCode Text 3xA Only available in multi-user version

Address1AddressLine1 Text 255xAN

Address1AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

Address1AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address1AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Address1City Text 255xAN

Address1State Text 255xAN

Address1PostCode Text 10xAN

Address1Country Text 255xAN

Address1Phone1 Text 21xAN

Address1Phone2 Text 21xAN

Address1Phone3 Text 21xAN

Address1Fax Text 21xAN

Address1Email Text 255xAN

Address1Website Text 255xAN

Address1Salutation Text 15xAN

Address2AddressLine1 Text 255xAN

Address2AddressLine2 Text 253xAN The maximum length of Address2AddressLine2 is reduced by any


content existing within field Address2AddressLine1.

IMPORT PERSONAL CARDS 357


Field Name Type Format Notes

Address2AddressLine3 Text 251xAN The maximum length of Address2AddressLine3 is reduced by any


content existing within fields Address2AddressLine1 and
Address2AddressLine2.

Address2AddressLine4 Text 249xAN The maximum length of Address2AddressLine4 is reduced by any


content existing within fields Address2AddressLine1,
Address2AddressLine2 and Address2AddressLine3.

Address2City Text 255xAN

Address2State Text 255xAN

Address2PostCode Text 10xAN

Address2Country Text 255xAN

Address2Phone1 Text 21xAN

Address2Phone2 Text 21xAN

Address2Phone3 Text 21xAN

Address2Fax Text 21xAN

Address2Email Text 255xAN

Address2Website Text 255xAN

Address2Salutation Text 15xAN

Address3AddressLine1 Text 255xAN

Address3AddressLine2 Text 253xAN The maximum length of Address3AddressLine2 is reduced by any


content existing within field Address3AddressLine1.

Address3AddressLine3 Text 251xAN The maximum length of Address3AddressLine3 is reduced by any


content existing within fields Address3AddressLine1 and
Address3AddressLine2.

Address3AddressLine4 Text 249xAN The maximum length of Address3AddressLine4 is reduced by any


content existing within fields Address3AddressLine1,
Address3AddressLine2 and Address3AddressLine3.

Address3City Text 255xAN

Address3State Text 255xAN

Address3PostCode Text 10xAN

Address3Country Text 255xAN

Address3Phone1 Text 21xAN

Address3Phone2 Text 21xAN

Address3Phone3 Text 21xAN

Address3Fax Text 21xAN

Address3Email Text 255xAN

Address3Website Text 255xAN

Address3Salutation Text 15xAN

Address4AddressLine1 Text 255xAN

358 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address4AddressLine2 Text 253xAN The maximum length of Address Line 2 is reduced by any content
existing within field Address1AddressLine1.

Address4AddressLine3 Text 251xAN The maximum length of Address Line 2 is reduced by any content
existing within fields Address1AddressLine1 and Address1AddressLine2.

Address4AddressLine4 Text 249xAN The maximum length of Address Line 2 is reduced by any content
existing within fields Address1AddressLine1, Address1AddressLine2 and
Address1AddressLine3.

Address4City Text 255xAN

Address4State Text 255xAN

Address4PostCode Text 10xAN

Address4Country Text 255xAN

Address4Phone1 Text 21xAN

Address4Phone2 Text 21xAN

Address4Phone3 Text 21xAN

Address4Fax Text 21xAN

Address4Email Text 255xAN

Address4Website Text 255xAN

Address4Salutation Text 15xAN

Address5AddressLine1 Text 255xAN

Address5AddressLine2 Text 253xAN The maximum length of Address5AddressLine2 is reduced by any


content existing within field Address5AddressLine1.

Address5AddressLine3 Text 251xAN The maximum length of Address5AddressLine3 is reduced by any


content existing within fields Address5AddressLine1 and
Address5AddressLine2.

Address5AddressLine4 Text 249xAN The maximum length of Address5AddressLine4 is reduced by any


content existing within fields Address5AddressLine1,
Address5AddressLine2 and Address5AddressLine3.

Address5City Text 255xAN

Address5State Text 255xAN

Address5PostCode Text 10xAN

Address5Country Text 255xAN

Address5Phone1 Text 21xAN

Address5Phone2 Text 21xAN

Address5Phone3 Text 21xAN

Address5Fax Text 21xAN

Address5Email Text 255xAN

Address5Website Text 255xAN

Address5Salutation Text 15xAN

IMPORT PERSONAL CARDS 359


Field Name Type Format Notes

Picture Text 255xAN

Notes Text 255xAN

Identifiers Text 10xA

CustomList1 Text 30xAN

CustomList2 Text 30xAN

CustomList3 Text 30xAN

CustomField1 Text 255xAN

CustomField2 Text 255xAN

CustomField3 Text 255xAN

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CoLastName and CardID fields.

360 CHAPTER 5 WRITE TABLES


Import Professional Purchases

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the
CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

PurchaseNumber Text 8xAN

PurchaseDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

SuppliersNumber Text 20xAN

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

Memo Text 255xAN

DetailDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Amount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Job Text 15xAN

Comment Text 255xAN

PromisedDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

ImportDutyAmount Double 13.2xN Currency formatting must not be applied.

PurchaseStatus Text 1xA Q = Quote


O = Order
B = Bill

IMPORT PROFESSIONAL PURCHASES 361


Field Name Type Format Notes

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

AmountPaid Double 13.2xN Currency formatting must not be applied.

Category Text 15xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and RecordID fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and CardID fields.

362 CHAPTER 5 WRITE TABLES


Import Professional Sales

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID
and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is
50xAN.

InvoiceNumber Text 8xAN

SaleDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

CustomersNumber Text 20xAN

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

DetailDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Job Text 15xAN

Comment Text 255xAN

Memo Text 255xAN

PromisedDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

SaleStatus Text 1xA Q = Quote


O = Order
I = Invoice

CurrencyCode Text 3xA Only available in multi-user version

IMPORT PROFESSIONAL SALES 363


Field Name Type Format Notes

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

SalespersonLastName Text 50xAN

SalespersonFirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the SalespersonLastName
field is 30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the SalespersonLastName
field is 50xAN.

ReferralSource Text 20xAN

AmountPaid Double 13.2xN Currency formatting must not be applied.

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Date MM/YY

AuthorisationCode Text 255xAN

DrawerChequeNumber Text 25xAN

Category Text 15xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and RecordID fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and CardID fields.

364 CHAPTER 5 WRITE TABLES


Import Receive Money

Field Name Type Format Description

DepositAccount Integer 6xN Entry in this field is mandatory. The account separator is optional.

TransactionID Text 8xAN

ReceiptDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

CoLastName Text 50xAN Entry in this field is optional. Cards are identified by the CoLastName if a
value exists in the CoLastName field but not the CardID or RecordID fields.

FirstName Text 20xAN When the card is Individual, the format of the CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is 50xAN.

Memo Text 255xAN

Inclusive Text 1xAN Any non-zero value indicates that the Receive Money entry is Tax Inclusive.

AllocationAccount Integer 6xN Entry in this field is mandatory if the record is an Allocation Line. The
account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Do not include the account separator.
Currency formatting must not be applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Do not include the account separator.
Currency formatting must not be applied.

Job Text 15xAN Should only be reported within Allocation lines.

TaxCode Text 3xAN Should only be reported within Allocation lines.

NonTaxAmount Double 13.2xN Should only be reported within Allocation lines. Currency formatting must
not be applied.

TaxAmount Double 13.2xN Should only be reported within Allocation lines. Currency formatting must
not be applied.

CurrencyCode Text 3xAN Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentMethod Text 20xAN

DrawerAccountName Text 32xAN Valid characters are 0-9 A-Z & ‘ . / -


Alphas must be in upper case.

DrawerAccountNumber Integer 20xN

DrawerChequeNumber Text 25xAN

CardNumber Text 25xAN

NameOnCard Text 50xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

PaymentNotes Text 255xAN

IMPORT RECEIVE MONEY 365


Field Name Type Format Description

AllocationMemo Text 255xAN Should only be reported within Allocation lines.

Category Text 15xAN

CardID Text 15xAN Entry in this field is optional. Cards are identified by the CardID if a value
exists in the CardID field but not the RecordID field.

RecordID Text 10xAN Entry in this field is optional. Cards are identified by the RecordID if a value
exists in the RecordID field.

366 CHAPTER 5 WRITE TABLES


Import Receive Payments

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID and
RecordID fields.

FirstName Text 20xAN When the card is Individual, the format of the CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is 50xAN.

DepositAccount Integer 6xN Entry in this field is mandatory. The account separator is optional.

TransactionID Text 8xAN

ReceiptDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

InvoiceNumber Text 8xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the CustomersNumber field.

CustomersNumber Text 20xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the InvoiceNumber field.

InvoiceDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

AmountApplied Double 13.2xN Entry in this field is mandatory. Currency formatting must not be applied.

Memo Text 255xAN

CurrencyCode Text 3xAN Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

DrawerAccountNumber Integer 209xN

DrawerAccountName Text 32xAN Valid characters are 0-9 A-Z & ‘ . / -


Alphas must be in upper case.

DrawerChequeNumber Text 25xAN

CardID Text 15xAN A value must exist within this field if no value exists within the
CoLastName and RecordID fields.

RecordID Text 10xAN A value must exist within this field if no value exists within the
CoLastName and CardID fields.

IMPORT RECEIVE PAYMENTS 367


Import Service Purchases

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the
RecordID and CardID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

AddressLine1 Text 255xAN

AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by


any content existing within field Address1AddressLine1.

AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by


any content existing within fields Address1AddressLine1 and
Address1AddressLine2.

AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by


any content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax
Inclusive.

PurchaseNumber Text 8xAN

PurchaseDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

SuppliersNumber Text 20xAN

ShipVia Text 20xAN

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is
optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be
applied.

Job Text 15xAN

Comment Text 255xAN

Memo Text 255xAN

368 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

ShippingDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

ImportDutyAmount Double 13.2xN Currency formatting must not be applied.

FreightExTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightIncTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxCode Text 3xAN

FreightNonTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightImportDutyAmount Double 13.2xN Currency formatting must not be applied.

PurchaseStatus Text 1xA Q = Quote


O = Order
B = Bill

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

AmountPaid Double 13.2xN Currency formatting must not be applied.

Category Text 15xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and RecordID
fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and CardID fields.

IMPORT SERVICE PURCHASES 369


Import Service Sales

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the CardID and
RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual. When
the card is Individual, the format of the CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company. When
the card is Company, the format of the CoLastName field is 50xAN.

AddressLine1 Text 255xAN

AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any content
existing within field Address1AddressLine1.

AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any content
existing within fields Address1AddressLine1 and Address1AddressLine2.

AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any content
existing within fields Address1AddressLine1, Address1AddressLine2 and
Address1AddressLine3.

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax Inclusive.

InvoiceNumber Text 8xAN

SaleDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

CustomersNumber Text 20xAN

ShipVia Text 20xAN

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

Description Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not be applied.

Job Text 15xAN

Comment Text 255xAN

Memo Text 255xAN

SalespersonLastName Text 50xAN

SalespersonFirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual. When
the card is Individual, the format of the SalespersonLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company. When
the card is Company, the format of the SalespersonLastName field is 50xAN.

370 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

ShippingDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

ReferralSource Text 20xAN

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightExTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightIncTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxCode Text 3xAN

FreightNonTaxAmount Double 13.2xN Currency formatting must not be applied.

FreightTaxAmount Double 13.2xN Currency formatting must not be applied.

SaleStatus Text 1xA Q = Quote


O = Order
I = Invoice

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

AmountPaid Double 13.2xN Currency formatting must not be applied.

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

DrawerChequeNumber Text 25xAN

Category Text 15xAN

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if no value
exists within the CoLastName and RecordID fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if no value
exists within the CoLastName and CardID fields.

IMPORT SERVICE SALES 371


Import Spend Money

Field Name Type Format Notes

ChequeAccount Integer 6xN Entry in this field is mandatory if the record is the Total Line. The account
separator is optional.

ChequeNumber Text 8xAN

PaymentDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system

Inclusive Text 1xAN Any non-zero value indicates that the Spend Money entry is Tax Inclusive.

CoLastName Text 50xAN A value must exist within this field if the payment is electronic and no value
exists within the CardID and RecordID fields.

FirstName Text 20xAN When the card is Individual, the format of the CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CoLastName field is 50xAN.

PayeeLine1 Text 255xAN

PayeeLine2 Text 253xAN The maximum length of PayeeLine2 is reduced by any content existing
within field PayeeLine1.

PayeeLine3 Text 251xAN The maximum length of PayeeLine3 is reduced by any content existing
within fields PayeeLine1 and PayeeLine2.

PayeeLine4 Text 249xAN The maximum length of PayeeLine4 is reduced by any content existing
within fields PayeeLine1, PayeeLine2 and PayeeLine3.

Memo Text 255xAN

AllocationAccount Integer 6xN Entry in this field is mandatory if the record is an Allocation Line. The
account separator is optional.

ExTaxAmount Double 13.2xN Entry in this field is mandatory. Do not include the account separator.
Currency formatting must not be applied.

IncTaxAmount Double 13.2xN Entry in this field is mandatory. Do not include the account separator.
Currency formatting must not be applied.

Job Text 15xAN Should only be reported within Allocation lines.

TaxCode Text 3xAN Should only be reported within Allocation lines.

NonGSTImportAmount Double 13.2xN Should only be reported within Allocation lines.


Included in list of import fields within the NZ build, but a relevant tax code
cannot be created (eg ABN, VWH which are Australia specific). Currency
formatting must not be applied.

TaxAmount Double 13.2xN Should only be reported within Allocation lines. Currency formatting must
not be applied.

ImportDutyAmount Double 13.2xN Should only be reported within Allocation lines. Currency formatting must
not be applied.

AlreadyPrinted Text 1xAN Any non-zero value indicates that the Spend Money entry is Already
Printed.

CurrencyCode Text 3xA Only available in multi-user version

372 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

ExchangeRate Double 6.6xN Only available in multi-user version

AllocationMemo Text 255xAN Should only be reported within Allocation lines.

Category Text 15xAN

CardID Text 15xAN A value must exist within this field if the payment is electronic and no value
exists within the CoLastName and RecordID fields.

RecordID Text 10xAN A value must exist within this field if the payment is electronic and no value
exists within the CoLastName and CardID fields.

DeliveryStatus Text 1xA P = To be Printed


E = To be Emailed
B = To be Printed and Emailed
A = Already Printed or Sent

IMPORT SPEND MONEY 373


Import Supplier Cards

Field Name Type Format Notes

CoLastName Text 50xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is Individual.
When the card is Individual, the format of the CoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

CardID Text 15xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and RecordID fields.

CardStatus Text 1XAN Y = Checkbox selected


N = Checkbox deselected

CurrencyCode Text 3xA Only available in multi-user version

Address1AddressLine1 Text 255xAN

Address1AddressLine2 Text 253xAN The maximum length of Address1AddressLine2 is reduced by any


content existing within field Address1AddressLine1.

Address1AddressLine3 Text 251xAN The maximum length of Address1AddressLine3 is reduced by any


content existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address1AddressLine4 Text 249xAN The maximum length of Address1AddressLine4 is reduced by any


content existing within fields Address1AddressLine1,
Address1AddressLine2 and Address1AddressLine3.

Address1City Text 255xAN

Address1State Text 255xAN

Address1PostCode Text 10xAN

Address1Country Text 255xAN

Address1Phone1 Text 21xAN

Address1Phone2 Text 21xAN

Address1Phone3 Text 21xAN

Address1Fax Text 21xAN

Address1Email Text 255xAN

Address1Website Text 255xAN

Address1ContactName Text 25xAN

Address1Salutation Text 15xAN

Address2AddressLine1 Text 255xAN

Address2AddressLine2 Text 253xAN The maximum length of Address2AddressLine2 is reduced by any


content existing within field Address2AddressLine1.

374 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address2AddressLine3 Text 251xAN The maximum length of Address2AddressLine3 is reduced by any


content existing within fields Address2AddressLine1 and
Address2AddressLine2.

Address2AddressLine4 Text 249xAN The maximum length of Address2AddressLine4 is reduced by any


content existing within fields Address2AddressLine1,
Address2AddressLine2 and Address2AddressLine3.

Address2City Text 255xAN

Address2State Text 255xAN

Address2PostCode Text 10xAN

Address2Country Text 255xAN

Address2Phone1 Text 21xAN

Address2Phone2 Text 21xAN

Address2Phone3 Text 21xAN

Address2Fax Text 21xAN

Address2Email Text 255xAN

Address2Website Text 255xAN

Address2ContactName Text 25xAN

Address2Salutation Text 15xAN

Address3AddressLine1 Text 255xAN

Address3AddressLine2 Text 253xAN The maximum length of Address3AddressLine2 is reduced by any


content existing within field Address3AddressLine1.

Address3AddressLine3 Text 251xAN The maximum length of Address3AddressLine3 is reduced by any


content existing within fields Address3AddressLine1 and
Address3AddressLine2.

Address3AddressLine4 Text 249xAN The maximum length of Address3AddressLine4 is reduced by any


content existing within fields Address3AddressLine1,
Address3AddressLine2 and Address3AddressLine3.

Address3City Text 255xAN

Address3State Text 255xAN

Address3PostCode Text 10xAN

Address3Country Text 255xAN

Address3Phone1 Text 21xAN

Address3Phone2 Text 21xAN

Address3Phone3 Text 21xAN

Address3Fax Text 21xAN

Address3Email Text 255xAN

Address3Website Text 255xAN

Address3ContactName Text 25xAN

IMPORT SUPPLIER CARDS 375


Field Name Type Format Notes

Address3Salutation Text 15xAN

Address4AddressLine1 Text 255xAN

Address4AddressLine2 Text 253xAN The maximum length of Address4 Line 2 is reduced by any content
existing within field Address1AddressLine1.

Address4AddressLine3 Text 251xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1 and
Address1AddressLine2.

Address4AddressLine4 Text 249xAN The maximum length of Address4 Line 2 is reduced by any content
existing within fields Address1AddressLine1, Address1AddressLine2
and Address1AddressLine3.

Address4City Text 255xAN

Address4State Text 255xAN

Address4PostCode Text 10xAN

Address4Country Text 255xAN

Address4Phone1 Text 21xAN

Address4Phone2 Text 21xAN

Address4Phone3 Text 21xAN

Address4Fax Text 21xAN

Address4Email Text 255xAN

Address4Website Text 255xAN

Address4ContactName Text 25xAN

Address4Salutation Text 15xAN

Address5AddressLine1 Text 255xAN

Address5AddressLine2 Text 253xAN The maximum length of Address5AddressLine2 is reduced by any


content existing within field Address5AddressLine1.

Address5AddressLine3 Text 251xAN The maximum length of Address5AddressLine3 is reduced by any


content existing within fields Address5AddressLine1 and
Address5AddressLine2.

Address5AddressLine4 Text 249xAN The maximum length of Address5AddressLine4 is reduced by any


content existing within fields Address5AddressLine1,
Address5AddressLine2 and Address5AddressLine3.

Address5City Text 255xAN

Address5State Text 255xAN

Address5PostCode Text 10xAN

Address5Country Text 255xAN

Address5Phone1 Text 21xAN

Address5Phone2 Text 21xAN

Address5Phone3 Text 21xAN

Address5Fax Text 21xAN

376 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Address5Email Text 255xAN

Address5Website Text 255xAN

Address5ContactName Text 25xAN

Address5Salutation Text 15xAN

Picture Text 255xAN

Notes Text 255xAN

Identifiers Text 10xA

CustomList1 Text 30xAN

CustomList2 Text 30xAN

CustomList3 Text 30xAN

CustomField1 Text 255xAN

CustomField2 Text 255xAN

CustomField3 Text 255xAN

BillingRate Double 10.4xN Only available in multi-user version.


Currency formatting must not be applied.

CostPerHour Double 10.4xN Only available in multi-user version.


Currency formatting must not be applied.

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

TaxCode Text 3xAN

CreditLimit Double 7.2xN Currency formatting must not be applied.

TaxIDNumber Text 19xAN

VolumeDiscount Double 2.2xN Percent formatting must not be applied.

PurchaseLayout Text 1xA S = Service


I = Item
P = Professional
T = Time Billing
M = Miscellaneous
Any other value = No Default

ExpenseAccount Integer 6xN The account separator is optional.

PurchaseComment Text 255xAN

ShippingMethod Text 20xAN

IMPORT SUPPLIER CARDS 377


Field Name Type Format Notes

PrintedForm Text 255xAN

FreightTaxCode Text 3xAN

UseSuppliersTaxCode Text 1xAN Y = Checkbox selected


N = Checkbox deselected

PaymentMemo Text 255xAN

PurchaseDelivery Text 1xA P= To be Printed


E= To be Emailed
B= To be Printed and Emailed
A= Already Printed or Sent

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if
no value exists within the CoLastName and CardID fields.

378 CHAPTER 5 WRITE TABLES


Import Time Billing Sales

Field Name Type Format Notes

CoLastName Text 50xAN A value must exist within this field if no value exists within the
CardID and RecordID fields.

FirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
CoLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
CoLastName field is 50xAN.

InvoiceNumber Text 8xAN

SaleDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

Inclusive Text 1xAN Any non-zero value indicates that the Sale Invoice is Tax
Inclusive.

CustomersNumber Text 20xAN

DeliveryStatus Text 1xA P= To be printed


E = To be emailed
B = To be printed and emailed
A = Already printed or sent

DetailDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

ActivityID Text 30xAN Entry in this field is mandatory.

HoursUnits Double 11.2xN Negative values are indicated as such by way of a leading
negative sign.

Note Text 255xAN

Rate Double 11.4xN Currency formatting must not be applied.

ExTaxAmount Double 11.2xN Currency formatting must not be applied.

Job Text 15xAN

Comment Text 255xAN

Memo Text 255xAN

PromisedDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN Currency formatting must not be applied.

TaxAmount Double 13.2xN Currency formatting must not be applied.

SaleStatus Text 1xA Q = Quote


O = Order
I = Invoice

IMPORT TIME BILLING SALES 379


Field Name Type Format Notes

CurrencyCode Text 3xAN Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

PaymentIsDue Integer 1xN 0 = C.O.D


1 = Prepaid
2 = In a Given # of Days
3 = On a Day of the Month
4 = # of Days after EOM
5 = Day of Month after EOM

DiscountDays Integer 3xN

BalanceDueDays Integer 3xN

PercentDiscount Double 2.2xN Percent formatting must not be applied.

PercentMonthlyCharge Double 2.2xN Percent formatting must not be applied.

SalespersonLastName Text 50xAN

SalespersonFirstName Text 20xAN If a value exists in this field, the Designation of the Card is
Individual. When the card is Individual, the format of the
SalespersonLastName field is 30xAN.
If no value exists in this field, the Designation of the Card is
Company. When the card is Company, the format of the
SalespersonLastName field is 50xAN.

ReferralSource Text 20xAN

AmountPaid Double 13.2xN Currency formatting must not be applied.

PaymentMethod Text 20xAN

PaymentNotes Text 255xAN

NameOnCard Text 50xAN

CardNumber Text 25xAN

ExpiryDate Text MM/YY

AuthorisationCode Text 255xAN

DrawerChequeNumber Text 25xAN

IncTaxAmount Double 11.2xN Currency formatting must not be applied.

Category Text 15xAN

AddressLine1 ^ Text 255xAN

AddressLine2 ^ Text 255xAN The maximum length of Address1AddressLine2 is reduced by


any content existing within field Address1AddressLine1.

AddressLine3 ^ Text 255xAN The maximum length of Address1AddressLine2 is reduced by


any content existing within field Address1AddressLine1 and
AddressLine2.

AddressLine4 ^ Text 255xAN The maximum length of Address1AddressLine2 is reduced by


any content existing within field Address1AddressLine1,
AddressLine2. and AddressLine3.

ShipVia ^ Text 20xAN

380 CHAPTER 5 WRITE TABLES


Field Name Type Format Notes

Amount ^ Double 13.2xAN Currency formatting must not be applied.

FreightTaxCode ^ Text 3xAN

FreightNonTaxAmount ^ Double 13.2xN

FreightTaxAmount ^ Double 13.2xAN Currency formatting must not be applied.

Location ^ Text 10xAN Only available in multi-user version

CardID Text 15xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and RecordID
fields.

RecordID Text 10xAN Entry in this field is conditional. A value must exist within this
field if no value exists within the CoLastName and CardID fields.

(^) Fields marked are only available when the “I Include Items on Time Billing Invoice” is selected within the UserID record.

IMPORT TIME BILLING SALES 381


Import Timesheets

Field Name Type Format Notes

EmpCoLastName Text 50xAN Entry in this field is mandatory.

EmpFirstName Text 20xAN When the card is Individual, the format of the EmpCoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the EmpCoLastName field is
50xAN.

PayrollCategory Text 31xAN

Job Text 15xAN

CustCoLastName Text 50xAN

CustFirstName Text 20xAN When the card is Individual, the format of the CustCoLastName field is
30xAN.
If no value exists in this field, the Designation of the Card is Company.
When the card is Company, the format of the CustCoLastName field is
50xAN.

Notes Text 255xAN

TimesheetDate Text 11xAN Date format is controlled within the Regional Settings of the operating
system.

Units Double 11.2xN Negative values are indicated as such by way of a leading negative sign.

EmpCardID Text 15xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the EmpCoLastName and EmpRecordID fields.

EmpRecordID Text 10xAN Entry in this field is conditional. A value must exist within this field if no
value exists within the EmpCoLastName and EmpCardID fields.

382 CHAPTER 5 WRITE TABLES


Import Transaction Journals

Field Name Type Format Notes

JournalNumber Text 8xAN

JournalDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

Memo Text 255xAN

AccountNumber Integer 6xN Entry in this field is mandatory. The account separator is
optional.

DebitAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not
be applied.

CreditAmount Double 13.2xN Entry in this field is mandatory. Currency formatting must not
be applied.

Job Text 15xAN

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

AllocationMemo Text 255xAN

Category Text 15xAN

IMPORT TRANSACTION JOURNALS 383


Import General Journals

Field Name Type Format Notes

JournalNumber Text 8xAN

JournalDate Text 11xAN Date format is controlled within the Regional Settings of the
operating system

Memo Text 255xAN

Inclusive Text 1xAN

AccountNumber Integer 5xN Entry in this field is mandatory. Do not include the account
separator.

DebitExTaxAmount Double 13.2xN

DebitIncTaxAmount Double 13.2xN

CreditExTaxAmount Double 13.2xN

CreditIncTaxAmount Double 13.2xN

Job Text 15xAN

TaxCode Text 3xAN

NonTaxAmount Double 13.2xN

TaxAmount Double 13.2xN

ImportDutyAmount Double 13.2xN

CurrencyCode Text 3xA Only available in multi-user version

ExchangeRate Double 6.6xN Only available in multi-user version

AllocationMemo Text 255xAN

Category Text 15xAN

384 CHAPTER 5 WRITE TABLES


Password Restrictions
If a user is restricted from accessing an import function in the company file, for example the Import Data function in
the File menu, they will also be unable to access the tables relating to the function when using the MYOB ODBC
Direct driver.
The following table lists which ODBC tables and fields are restricted from a user when the related function has been
restricted in the company file.

Restricted Function Impacted Tables Restricted Fields

Import Data Import_NonConsolidated_TaxCodes All


Import_Consolidated_TaxCodes
Import_Accounts
Import_Account_Budgets
Import_Items
Import_Jobs
Import_Activities
Import_Activity_Slips
Import_Timesheet
Import_General_Journals
Import_Pay_Bills
Import_Spend_Money
Import_Receive_Payments
Import_Receive_Money
Import_Inventory_Adjustments
Import_Transaction_Journals
Import_Customer_Cards
Import_Supplier_Cards
Import_Employee_Cards
Import_Personal_Cards
Import_Service_Sales
Import_Item_Sales
Import_Professional_Sales
Import_TimeBilling_Sales
Import_Miscellaneous_Sales
Import_Service_Purchases
Import_Item_Purchases
Import_Professional_Purchases
Import_Miscellaneous_Purchases
ImportErrors
ImportWarnings

Import TAL N/A

Import Quicken (QIF) file N/A

Import Quickline (QIF) file N/A

Export Data N/A

Export TAL N/A

PASSWORD RESTRICTIONS 385


386 CHAPTER 5 WRITE TABLES
6 ODBC test

ODBC TEST APPLICATIONS


applications
Two test applications for the MYOB ODBC Direct driver are included in the MYOB ODBC
Developer Pack:
„ SQL Tester
„ BatchTester
The two test applications enable you to create and test connection strings and SQL statements
against a company file using a user created DSN based on the MYOB ODBC Direct driver.
The examples in this chapter use the sample company file. They provide instructions on how
to establish a simple read–write connection and how to perform a simple write operation.
Comprehensive information on MYOB ODBC driver connection strings and importing
information to an MYOB company file can be found in the documentation provided with your
Developer Pack.
The test applications will work with registered company files where an appropriate User DSN
has been created.
For the examples in this chapter you need to create a DSN for the sample company file. For
more information, see ‘Defining the Clearwater sample company file as a data source’ on
page 22.

387
SQL Tester

SQL Tester is an MYOB database browsing tool. This tool is part of the ODBC driver download
and is located in the Test Applications folder.
This application allows you to connect to an MYOB company file via the MYOB ODBC Direct
driver. You can configure your connection string in a variety of ways to allow read-only or
read/write access.
This application allows you to read and write to any table described in the MYOB ODBC Data
Dictionary. Samples have been provided.

System Requirements
The following software needs to be installed:
„ A compatible MYOB program, such as MYOB Accounting
„ MYOB ODBC Direct driver.

Dependencies
This sample application references the following libraries and controls:
msvbvm60.dll – Visual Basic for Applications
msvbvm60.dll\3 – Visual Basic runtime objects and procedures
vb6.olb – Visual Basic objects and procedures
stdole2.tlb – OLE Automation
msado27.tlb – Microsoft ActiveX Data Objects 2.7 Library
mshflxgrd.ocx – Microsoft Hierarchical FlexGrid Controls 6.0 (OLEDB)

388 CHAPTER 6 ODBC TEST APPLICATIONS


The SQL Tester window
The SQL Tester tool provides a simple interface to test combinations of connection string
keywords that are used to connect to an MYOB company file. Once a connection has been
established, the SQL Tester tool can be used to create and execute SQL read and write
operations on an MYOB company file.
The SQL Tester tool uses a single window, the SQL Tester window, as shown below.

Section 1

Section 2

Section 3

Section 4

Section 1 is used to set keyword values for a connection string to connect to an MYOB
company file. Once a connection has been established, this section is locked and cannot be
altered until you disconnect from the DSN.
Section 2 is used to type SQL read and write statements to be sent to the MYOB company file.
Section 3 is used to display the results of a read statement in column format.
Section 4 is used to display return codes, error and warning messages and, when an SQL read
statement is executed, the results of the read statement in tab-delimited format.
You can copy information from the section 4 (such as error codes and the results of read
statements) if you need to save this information, for example, to save a particular error code
for investigation.

SQL TESTER 389


To test a connection string
1 Locate and double click the SQLTester.exe application. The SQL Tester window appears.

The first section of the SQL Tester window provides a number of fields that are used to set
connection string keyword values. For more information about connection strings and
keyword values, refer to Chapter 4, ’How to write,’ starting on page 313.
In this example, the keyword values displayed provide enough information to establish a
connection to the sample company file using the DSN created in the procedure “SQL
Tester” on page 388.
2 Click Connect. The bottom section of the SQL Tester window displays a message
informing you if the connection to the MYOB company file DSN the connection was either
successful or unsuccessful.

Once you have established a connection to an MYOB company file using appropriate
connection string keyword values, you can use SQL Tester to check the accuracy of your SQL
read and write statements.

390 CHAPTER 6 ODBC TEST APPLICATIONS


To read from a company file
The SQL Tester includes a sample SQL read statement. The following procedure uses this
statement to read information from the sample company file. It assumes a connection has
already been made and that the SQL Tester window is open. For more information about
connecting to a company file, see “To test a connection string” on page 390.
1 Click Paste Sample Read. The sample SQL statement is displayed in the top frame of the
SQL Tester window.

2 Click Execute Read. The results of the read statement are displayed in the middle section
of the SQL Tester window in column format and also in the bottom section as tab
delimited information.

You can copy and paste information from the bottom section of the window back into your
initial read statement. This enables you to easily refine your SQL query.
For example, you might want to select only the card identification, name and last name
information about customers.
3 Highlight CARDIDENTIFICATION NAME LASTNAME in the tab delimited bottom
section, then copy and paste this back into the top read statement, next to the insert
command. Include commas between the column names.
SELECT CARDIDENTIFICATION, NAME, LASTNAME
FROM Customers

SQL TESTER 391


4 Click Execute Read. The data from your refined read statement appears.

To write to a company file


Ensure you have established a read–write connection to your company file. See ‘To test a
connection string’ on page 390.
You can type your write statement directly into the top frame of SQL Tester window.
SQL Tester includes a sample SQL write statement . The following procedure uses this sample
write statement. It assumes a read–write connection has already been made to the sample
company file and that the SQL Tester window is open.
1 Click Paste Sample Write. The following SQL statement is displayed in the top frame of
the SQL Tester window:
INSERT INTO Import_Customer_Cards (CoLastName, FirstName, CardID)
VALUES (('SMITH', 'TIM' , '123456'), ('JONES', 'JACK' , '12345'))
2 Click Execute Write. If your write statement was successful, the message Successful
Write! is displayed in the bottom section of the SQL Tester window. If the write is
unsuccessful, an error number and message appears.

392 CHAPTER 6 ODBC TEST APPLICATIONS


BatchTester

BatchTester takes connection strings and SQL insert statements from supplied Excel
spreadsheets, and concatenates them in a script (.scr) file. Once a script file has been built,
BatchTester uses the script file to establish a connection to an MYOB company file and execute
the SQL statements.
When you execute a script file, a log file appears, showing the success or otherwise of the
import operation.

System Requirements
The following software must be installed:
„ A compatible MYOB program, such as MYOB Accounting
„ MYOB ODBC Direct driver
„ .Net Framework (If you need to install the .Net Framework, visit the MSDN website.)

Using BatchTester
The following procedures show how to use BatchTester to create a script file with a connection
string, add SQL insert statements to the script file and execute the script file.

To create a script file containing a connection string


1 Locate and double-click BatchTester.exe. The MYOB ODBC BatchTester window appears.

BATCHTESTER 393
2 Go to the Select Tables menu and choose Connect Table. The Open File for CONNECT
Table Table window appears.

3 Select MYOBODBCConnect.xls and click Open. The MYOB ODBC BatchTester window
reappears.

4 Click Connect. The contents of the MYOBODBCConnect.xls file appear.

Each line represents a different connection string and each column represents a
connection string keyword.
5 Select the second line, and expand the DATABASE column. This column holds the
DATABASE connection string keyword value which provides the location of the company
file to which you want to connect.
6 Change the text in this column to reflect the path and name of the sample company file.

394 CHAPTER 6 ODBC TEST APPLICATIONS


7 Click Add to Script. The Open Script File window appears.

8 In the File Name field, type test and click Open. The row you selected is converted to a
connection string and added to the test.scr script file.
See the following procedure, ‘To test the connection string’, for information on testing
your connection string.

To test the connection string


1 Locate and double-click BatchTester.exe. The MYOB ODBC BatchTester window appears.

2 Go to the File menu and choose Run Script or press CTRL + R. The script file is executed and
the Test.log file appears.

The above example shows that the connection to the company file was successful.

BATCHTESTER 395
To add SQL statements to the script file
The following procedure demonstrates how to add import SQL statements from an Excel
spreadsheet to the script file you created in the procedure, ‘To create a script file containing a
connection string’ on page 393.
1 Go to the Select Tables menu and choose Insert Tables. A list of all the MYOB ODBC
import tables appears.
Choose a table to insert information into. For this example, choose Cards and then
Suppliers. The Open File dialog appears.

2 Select MYOBODBCInsert.xls and click Open. The MYOB ODBC BatchTester window
reappears.

3 Click Import Supplier Cards.


4 Select the rows of import statements you want to use. For this example, select the first row.

396 CHAPTER 6 ODBC TEST APPLICATIONS


5 Click Add To Script. The Open Script File window appears.

6 Select Test.scr and click Open. The SQL insert statement is added to the script file.
7 Press CTRL + R to run the script file. The script file is executed, and the test log file appears.

In the above example, the connection to the company file and the import operation were
successful.

BATCHTESTER 397
398 CHAPTER 6 ODBC TEST APPLICATIONS
7 Testing error codes

TESTING ERROR CODES


The MYOB ODBC Direct driver provides information for import errors and warnings,
connection errors and other miscellaneous errors.
Import errors and warnings provide information about problems with the field and record
information within an import statement. Two tables, ImportErrors and ImportWarnings, are
included in an MYOB company file and can be used to provide a detailed description based on
a returned error or warning code.
„ An import warning indicates that, while the import has occurred, some fields may have
been rejected.
„ An import error indicates the import has failed. Errors occur on a per-record basis. Only
records with errors will be rejected from a batch. When an import has failed, the error
description should be determined to correct and resubmit the import.
Connection and miscellaneous errors occur when there is a problem with the connection
string, or the location of a company file, application file or similar problem. The
InternalODBCerrors table, included in an MYOB company file can be used to provide a
detailed description based on a returned error code.

Determining the type of error or warning


„ If an error number is less than 10000 it is an import warning. The ImportWarning table
provides a description for each import warning code.
„ If an error number is greater than or equal to 10000 and less than 20000 it is an import
error. The ImportError table provides a description for each import error code. You need to
subtract 10000 from the import error code and then look up the description in the
ImportErrors table.
„ If an error number is greater than or equal to 20000 it is a connection or miscellaneous
error. The InternalODBCerrors table provides a description for each miscellaneous error
code.
For information about these errors and warnings, see ‘Errors and warnings tables’ on
page 403. To learn how to retrieve a return code and determine the type of error or warning,
see ‘Example test code’ on page 400.

Suppressing warning messages


If a warning message is issued after an import statement, the error buffer is not automatically
cleared. If a second import is attempted without using a rollback statement to clear the error
buffer, the second import will not go ahead.
Setting the connection string keyword SUPPRESS_WARNING to the value of TRUE enables
consecutive import warnings to occur without requiring the rollback statement to be applied
after each warning. For more information, see ‘Connection string keywords and supported
values’ on page 19.

399
Example test code

The following pseudo-code examples provide basic information for looking up return codes,
determining the type of error and finding the description for the error using the appropriate
error or warning table. Working code examples can be found with the installation of the MYOB
ODBC Direct driver.

ActiveX Data Objects (ADO)

Note: you must declare the ADOConnection object with events - Private WithEvents
NOTE :
ADOConnection As ADODB.Connection.

1 Iterate through the ADO.Errors object until the ADO.Errors.Description = “[MYOB ODBC]”
and retrieve the NativeError from the same object.
2 Determine the value of the retrieved NativeError:
„ If the ADO.Errors.NativeError is between 10000 and less than 20000 then a
Transaction Error has occurred. Subtract 10000 from the NativeError and then set up the
following query:
sQuery = "Select Description from ImportErrors where ImportErrorID = " &
Trim(Str(nNativeError))
„ If the ADO.Errors.NativeError is between 1 and less than 10000 then a Transaction
Warning has occurred. Set up the following query:
sQuery = "Select Description from ImportWarnings where ImportWarningID = " &
Trim(Str(nNativeError))
„ If the ADO.Errors.NativeError is greater than 20000 then a Miscellaneous Error has
occurred. Set up the following query:
sQuery = "Select Description from InternalODBCErrors where NativeErrorNumber = "
& Trim(Str(nNativeError))
„ If the ADO.Errors.NativeError does not fall within the ranges listed above, then return
the default Visual Basic Error Description and exit from the function:
GetADO_Error = Err.Description
Exit Function
3 Execute the query set up in Step 2:
Set ADORecordset = ADOConnection.Execute(sQuery)
4 Retrieve the Error Description:
GetADO_Error = ADORecordset.Fields("Description").Value

400 CHAPTER 7 TESTING ERROR CODES


Data Access Objects (DAO)
1 Iterate through the DBEngine.Errors object until the DBEngine.Errors.Description =
"[MYOB ODBC]" and retrieve the Error Number from the same object.
2 Determine the value of the retrieved Error Number:
„ If the DBEngine.Errors.Number is between 10000 and less than 20000 then a
Transaction Error has occurred. Subtract 10000 from the Number and then set up the
following query:
sQuery = "Select Description from ImportErrors where ImportErrorID = " &
Trim(Str(nNativeError))
„ If the DBEngine.Errors.Number is between 1 and less than 10000 then a Transaction
Warning has occurred. Set up the following query:
sQuery = "Select Description from ImportWarnings where ImportWarningID = " &
Trim(Str(nNativeError))
„ If the DBEngine.Errors.Number is greater than 20000 then a Miscellaneous Error has
occurred. Set up the following query:
sQuery = "Select Description from InternalODBCErrors where NativeErrorNumber = "
& Trim(Str(nNativeError))
„ If the DBEngine.Errors.Number does not fall within the ranges listed above then just
return the first description on the DBEngine error object and exit from the function:
GetDAO_Error = DBEngine.Errors(0).Description
Exit Function
3 Execute the query set up in Step 2:
Set DAORecordset = DAOConnection.OpenRecordset(sQuery, dbOpenForwardOnly)
4 Retrieve the Error Description:
GetDAO_Error = DAORecordset.Fields("Description").Value

EXAMPLE TEST CODE 401


C/C++
1 Call SQLError:
SQLError(m_EnvHandle, m_ConHandle, m_StmtHandle, sSQLStatus, &nNativeError, sMsg,
sizeof(sMsg), &nMsgLen);
2 If the string "sMsg" contains "[MYOB ODBC]" then continue, otherwise just return the
value that is already stored in sMsg:
„ If the nNativeError is between 10000 and less than 20000 then a Transaction Error has
occurred. Subtract 10000 from the NativeError - nNativeError = nNativeError - 10000,
then set up the following query:
sExecuteStatement = "Select Description from ImportErrors where ImportErrorID =
";
„ If the nNativeError is between 1 and less than 10000 then a Transaction Warning has
occurred. Set up the following query:
sExecuteStatement = "Select Description from ImportWarnings where ImportWarningID
= ";
„ If the nNativeError is greater than 20000 then a Miscellaneous Error has occurred. Set
up the following query:
sExecuteStatement = "Select Description from InternalODBCErrors where
NativeErrorNumber = ";
3 Convert the nNativeError to a string and concatenate it to the query set up in Step 2:
itoa(nNativeError, sErrNum, 10);
sExecuteStatement+= sErrNum;
4 Execute the query set up in steps 2 and 3:
SQLExecDirect(hStatement, (PUCHAR)sExecuteStatement.c_str(), SQL_NTS) ;
while (SQLFetch(hStatement) != SQL_NO_DATA)
{
SQLGetData(hStatement, 1, SQL_C_CHAR, sErrDesc, sizeof(sErrDesc), &nRetVal);
}
SQLCloseCursor(hStatement);

"sErrDesc" will now contain the Transaction Error Description.

402 CHAPTER 7 TESTING ERROR CODES


8 Errors and

ERRORS AND WARNINGS TABLES


warnings tables
This chapter provides descriptions of the ImportErrors, ImportWarnings and
InternalODBCErrors tables. These tables are used to look up specific descriptions of error and
warning codes returned during an operation on an MYOB company file.
For more information on how to retrieve and interpret error or warning codes, see ‘Testing
error codes’ on page 399.

ImportWarnings table

The ImportWarnings table provides a list of import warnings reported within the error log file.
Data reported within the ImportWarnings table is not stored within the company file. Instead,
data is obtained from the code when generating the error log.

Field Name Type Format Description

ImportWarningID Integer 3xN Predefined list

Description Text 30xAN Individual description for each return code

The following table provides the description of each import warning return code.

ImportWarningID Description

1 Account Name cannot be more than 30 characters; name truncated.

2 Account Name contains invalid characters; name ignored.

3 Last Cheque Number must be less than 10,000,000; number ignored.

4 Last Cheque Number must be numeric; number ignored.

5 Opening balances have been verified; balance ignored.

6 Opening balance must be valid currency value; balance ignored.

7 Opening balance may not be set for Current Earnings account; balance ignored.

8 Opening balance may only be set for detail accounts; balance ignored.

9 P&L Opening balances may only be set for the current financial year; balance ignored.

10 Cannot specify last cheque number for account without cheque privileges; number
ignored.

403
ImportWarningID Description

11 Header accounts may not have cheque privileges; privileges ignored.

12 Cheques/deposits are on file for this account. Cheque privileges may not be removed.

13 This account is being used in Spend Money. Cheque privileges may not be removed.

14 This account is being used in Receive Money. Cheque privileges may not be removed.

15 This account is being used in Print Cheques. Cheque privileges may not be removed.

16 This account is being used in Supplier Payments. Cheque privileges may not be removed.

17 This account is the default bank account for AR. Account Type Bank may not be removed.

18 This account is the default bank account for AP. Account Type Bank may not be removed.

19 Level 4 Accounts may not be headers.

20 Accounts with non-zero current balances may not be headers.

21 Accounts with journal entries may not be headers.

22 Accounts with recurring journal entries may not be headers.

23 Accounts linked to inventory items may not be headers.

24 Accounts linked to sales and/or purchases may not be headers.

25 Accounts with non-zero periodic balances may not be headers.

26 Linked accounts may not be headers.

27 The account being used in Count Inventory may not be a header.

28 An account being used in Journal Entry may not be a header.

29 An account being used in Adjust Inventory may not be a header.

30 An account being used in Spend Money may not be a header.

31 An account being used in Receive Money may not be a header.

32 An account being used in Miscellaneous Sales may not be a header.

33 An account being used in Miscellaneous Purchases may not be a header.

34 An account being used in Invoice Sales may not be a header.

35 An account being used in Purchase Orders may not be a header.

36 An account being used in Reconcile Accounts may not be a header.

37 An account being used in Review Before Printing may not be a header.

38 An account being used in Supplier Payments may not be a header.

39 Account Name may not be blank; default substituted.

40 Account Name may not be blank; ignored.

41 Company Information must be recorded before balances can be set; balance ignored.

42 Item Name cannot be more than 30 characters; name truncated.

43 Item Name contains invalid characters; name ignored.

44 Invalid Account Number; account ignored.

45 Supplier name too long; name truncated.

404 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

46 Supplier name contains invalid characters; name ignored.

47 Supplier number too long; number truncated.

48 Supplier number contains invalid characters; number ignored.

49 Unit of measure too long; unit truncated.

50 Unit of measure contains invalid characters; unit ignored.

51 Items per buying unit must be a number from 1 to 9999; number ignored.

52 Items per selling unit must be a number from 1 to 9999; number ignored.

53 Invalid Reorder Quantity; quantity ignored.

54 Invalid Reorder Level; level ignored.

55 Invalid Selling Price; price ignored.

56 Item Name may not be blank; default substituted.

57 Asset account invalid; item may not be inventoried.

58 Income account invalid; item may not be sold.

59 Expense account invalid; item may not be bought.

60 Cost of Sales account invalid; item may not be sold.

61 Asset Account not found; account ignored.

62 Income Account not found; account ignored.

63 Expense/COS Account not found; account ignored.

64 Income Account must be a P&L account; account ignored.

65 Expense/COS Account must be a P&L account; account ignored.

66 Supplier not found; name ignored.

67 Multiple suppliers found; first supplier used.

68 Tax code not found; default used.

69 Sales history may only be tracked for sold items.

70 Item is not bought; some information ignored.

71 Item is not sold; some information ignored.

72 Item is not inventoried some information ignored.

73 Item is not inventoried and bought; reorder quantity ignored.

74 # Items per buying unit may only specified for items that are bought and inventoried.

75 # Items per selling unit may only specified for items that are sold and inventoried.

76 # Items per buying unit may not be changed; purchases on file.

77 # Items per selling unit may not be changed; sales on file.

78 Expense account invalid; item is not bought.

79 Cost of Sales account invalid; item is not sold.

80 ID # invalid; default assigned.

IMPORTWARNINGS TABLE 405


ImportWarningID Description

81 Memo too long; truncated.

82 Memo contains invalid characters; memo ignored.

83 Job # too long; truncated.

84 Job # invalid; job ignored.

85 Job not found in list of detail jobs; job ignored.

86 Multiple jobs found; first job used.

87 Job allocations for balance sheet accounts invalid; job ignored.

88 Address line too long; truncated.

89 Address line contains invalid characters; ignored.

90 Postcode too long; truncated.

91 Postcode contains invalid characters; ignored.

92 Phone or Fax Number too long; truncated.

93 Phone or Fax Number contains invalid characters; ignored.

94 Salutation too long; truncated.

95 Salutation contains invalid characters; ignored.

96 Contact too long; truncated.

97 Contact contains invalid characters; ignored.

98 Notes too long; truncated.

99 Notes contains invalid characters; ignored.

100 Identifiers too long; truncated.

101 Identifiers contains invalid characters; ignored.

102 Last Name too long; truncated.

103 First Name too long; truncated.

104 Company Name too long; truncated.

105 Address 1 too long; truncated.

106 Address 2 too long; truncated.

107 Tax code invalid; default code used.

108 Invalid tax code; code ignored.

109 Tax code contains invalid characters; ignored.

110 State code not found; ignored.

111 Multiple cards found; first card used.

112 Salesman Name too long; truncated.

113 Invalid characters in Salesman Name; ignored.

114 Salesman not found; ignored.

115 An item may not be changed to "Not Bought" through importing.

406 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

116 An item may not be changed to "Not Sold" through importing.

117 An item may not be changed to "Not Inventoried" through importing.

118 Default account for tax not specified; tax ignored.

119 Accounts linked to employee cards may not be headers.

120 Accounts linked to payroll categories may not be headers.

121 This account is being used in Write Paycheques. Cheque privileges may not be removed.

122 An account being used in Write Paycheques may not be a header.

123 Accounts linked to recurring sales or purchases may not be headers.

124 An account being used in Customer Payments may not be a header.

125 This account is being used in Customer Payments. Account type Bank may not be removed.

126 An account being used in Settle Credits may not be a header.

127 This account is being used in Settle Credits. Account type Bank may not be removed.

128 An account being used in Settle Debits may not be a header.

129 This account is being used in Settle Debits. Cheque privileges may not be removed.

130 City too long; truncated.

131 City contains invalid characters; ignored.

132 State too long; truncated.

133 State contains invalid characters; ignored.

134 Description too long; truncated.

135 Description contains invalid characters; description ignored.

136 Multiple tax codes invalid; first code used.

137 N/A

138 Amount is zero; line ignored.

139 Invoice # too long; number truncated.

140 N/A

141 N/A

142 N/A

143 Customer PO too long; number truncated.

144 Ship Via field too long; field truncated.

145 Price invalid; default used.

146 Discount invalid; ignored.

147 Total does not match; recalculated.

148 Ship Via field not found; ignored.

149 Invalid promised date; date ignored.

150 Comment too long; comment truncated.

IMPORTWARNINGS TABLE 407


ImportWarningID Description

151 Amount and quantity must have same sign; quantity changed.

152 Tax code missing; default Tax code does not allow Non-GST amounts; amount ignored.

153 Tax code missing; default tax code does not allow GST amounts; amount ignored.

154 Tax code missing; default tax code does not allow Import Duty amounts; amount ignored.

155 Freight tax code missing; default tax code does not allow Non-GST amounts; amount
ignored.

156 Freight tax code missing; default tax code does not allow GST amounts; amount ignored.

157 Freight tax code missing; default tax code does not allow Import Duty amounts; amount
ignored.

158 Tax code does not allow Non-GST amounts; amount ignored.

159 Tax code does not allow GST amounts; amount ignored.

160 Tax code does not allow Import Duty amounts; amount ignored.

161 Freight tax code does not allow Non-GST amounts; amount ignored.

162 Freight tax code does not allow GST amounts; amount ignored.

163 Freight tax code does not allow Import Duty amounts; amount ignored.

164 Invalid freight tax code; code ignored.

165 Freight tax code not found; ignored.

166 No default tax code available; tax amount ignored.

167 No default freight tax code available; tax amount ignored.

168 Tax code missing; default code used.

169 Freight tax code missing; default code used.

170 An account being used in Customer Reimbursable Expenses may not be a header.

171 An account with job history records may not be a header.

172 Payee too long; truncated.

173 Account name included header account information; header information ignored.

174 Transfer between accounts; account not used.

175 Accounts with non-zero budget balances may not be headers.

177 Invalid Stop Time; time ignored.

178 Invalid Start Time; time ignored.

179 N/A

180 N/A.

181 N/A

182 N/A

183 N/A

184 N/A

185 N/A

408 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

186 Invalid Activity Rate; rate ignored.

187 Unit of measure contains invalid characters; unit ignored.

188 Activity Status cannot be changed through importing.

189 Activity is not chargeable; income account ignored.

190 Income Account invalid or blank; activity may not be chargeable.

191 Activity Name cannot be blank; default substituted.

192 Activity Name contains invalid characters; name ignored.

193 Activity Name cannot be more that 30 characters; name truncated.

194 The Activity Type cannot be changed through importing.

195 The Activity Status cannot be changed through importing.

196 Invalid Use Rate; E (Use Employee Billing Rate) substituted.

197 Activity Rate specified; A (Use Activity Rate) substituted.

198 Use Rate not specified; E (Use Employee Billing Rate) substituted.

199 Activity must be hourly and chargeable; Use Rate ignored.

200 Activity is not chargeable; rate ignored.

201 Activity is hourly, unit of measure ignored; default substituted.

202 Unit of measure too long; unit truncated.

203 Account number not found in list of postable accounts; activity may not be chargeable.

204 This activity is non-chargeable, data ignored.

205 Rate cannot be blank; default substituted.

206 Rate invalid; default substituted.

207 Activity is non-chargeable; rate ignored.

208 Activity is non-chargeable; job ignored.

209 Adjustment dollars invalid; zero substituted.

210 Activity is non-chargeable; adjustment dollars ignored.

211 Adjustment units invalid; zero substituted.

212 Activity is non-chargeable; adjustment units ignored.

213 Already Billed Dollars invalid; zero substituted.

214 Activity is non-chargeable; already billed dollars ignored.

215 Already Billed Units invalid; zero substituted.

216 Activity is non-chargeable; already billed units ignored.

217 Activity is non-hourly; start time ignored.

218 Activity is non-hourly; stop time ignored.

219 Slip ID number invalid; default assigned.

220 Slip ID cannot be blank; default assigned.

IMPORTWARNINGS TABLE 409


ImportWarningID Description

221 Sales Tax Calculation Method must be numeric; 0 (Actual Selling Price) substituted.

222 Tax Calculation Method must between 0 and 9; 0 (Actual Selling Price) substituted.

223 Item is not sold; Tax Calculation Method ignored.

224 Item is sold; Tax Calculation Method not found; 0 (Actual Selling Price) substituted.

225 Item description too long; description truncated.

226 Item description contains invalid characters; description ignored.

227 Custom List entry not found; entry ignored.

228 Custom Field entry too long; entry truncated.

229 Custom Field entry contains invalid characters; entry ignored.

230 Invalid Quantity Break; Quantity Break ignored.

231 Quantity Break 1 must be zero; 0.000 substituted.

232 Quantity Break 2 must be greater than Quantity Break 1 and less than Quantity Break 3;
Quantity Break ignored.

233 Quantity Break 3 must be greater than Quantity Break 2 and less than Quantity Break 4;
Quantity Break ignored.

234 Quantity Break 4 must be greater than Quantity Break 3 and less than Quantity Break 5;
Quantity Break ignored.

235 Quantity Break 5 must be greater than Quantity Break 4; Quantity Break ignored.

236 Quantity Breaks may only be specified for items that are sold; Quantity Break ignored.

237 N/A

238 Invalid Quantity Break; Selling Price ignored.

239 Selling Price may only be specified for items that are sold; Selling Price ignored.

240 Price Level A, Quantity Break 1 not equal to Base Selling Price; Bases Selling Price
substituted.

241 N/A

242 Invalid Billing Rate, rate ignored.

243 Invalid Cost Per Hour Rate, rate ignored.

244 Price Level must be numeric; 0 (base selling price) substituted.

245 Price Level must be between 0 and 6; 0 (base selling price) substituted.

246 Currency Code blank, local currency substituted.

247 Invalid Exchange Rate; current exchange rate substituted.

248 Exchange Rate too long, exchange rate truncated.

249 Currency Code blank, customer currency code substituted.

250 Currency Code blank, supplier currency code substituted.

251 Foreign currency transaction must specify an exchange rate, current exchange rate
substituted.

252 Invalid or blank Payment is Due; default substituted.

410 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

253 Invalid or blank Discount Days/Date; default substituted.

254 Invalid or blank Balance Due Days/Date; default substituted.

255 Invalid or blank % Discount for Early Payment; default substituted.

256 Invalid or blank % Monthly Charge; default substituted.

257 Invalid tax code; default substituted.

258 Invalid or blank Credit Limit; default substituted.

259 Invalid or blank Tax ID No.; ignored.

260 Invalid or blank Volume Discount %; default substituted.

261 Invalid Payment is Due; ignored.

262 Invalid Discount Days/Date; ignored.

263 Invalid Discount Days/Date; default substituted.

264 Invalid Balance Due Days/Date; ignored.

265 Invalid Balance Due Days/Date; default substituted.

266 Invalid % Discount for Early Pymt; ignored.

267 Invalid % Monthly Charge; ignored.

268 Invalid tax code; ignored.

269 Invalid Credit Limit; ignored.

270 Invalid Volume Discount %; ignored.

273 Multiple exchange rates supplied, used first exchange rate supplied.

275 Multiple Currencies preference not selected; currency information ignored.

276 Blank or Invalid Payment Due; default substituted.

277 Invalid or Blank % Discount for Early Payment; default substituted.

278 Invalid or Blank % Monthly Charge; default substituted.

279 Duplicate Invoice Number.

280 Duplicate Purchase Order Number.

281 Use Activity Rate is not selected; rate ignored.

282 Amount does not match; recalculated.

283 Customer Card not found; card ignored.

284 Currency Code blank, account currency code substituted.

285 Foreign currency account may not be a header account; imported as a detail account.

286 Accounts linked to Tax codes may not be headers.

287 Detailed accounts cannot be subtotaled; checkbox value ignored.

288 Referral source field too long; field truncated.

289 Referral source contains invalid characters; referral source ignored.

290 Referral source field not found; ignored.

IMPORTWARNINGS TABLE 411


ImportWarningID Description

291 "Use "Customer's/Supplier's Tax Code can not be changed through importing.

294 Tax Code When Sold tax type invalid; activity may not be chargeable.

295 Activity is not chargeable; Tax Code When Sold ignored.

300 Ex-Tax Amount contains an invalid or blank amount; amount recalculated.

301 Inc-Tax Amount does not equal sum of Ex-Tax Amount plus Tax Amounts; Ex-Tax Amount
recalculated.

302 Inc-Tax Amount contains an invalid or blank amount; amount recalculated.

303 Ex-Tax and Inc-Tax freight amounts contain an invalid amount; amounts ignored.

304 Ex-Tax freight amount contains an invalid or blank amount; amount recalculated.

305 Inc-Tax freight amount contains an invalid or blank amount; amount recalculated.

306 Inc-Tax freight amount does not equal sum of Ex-Tax freight amount plus freight tax
amounts; Ex-Tax freight amount recalculated.

307 Payments are not allowed on Quotes, Amount Paid is ignored.

308 Address 3 too long; truncated.

309 Address 4 too long; truncated.

310 Address 5 too long; truncated.

311 Card ID too long; truncated.

312 Card ID not unique; default substituted.

313 Invalid Card Sale/Purchase layout; layout ignored.

314 Custom List entry too long; truncated.

315 Custom List entry contains invalid characters; entry ignored.

316 Invalid Custom List entry; entry ignored.

317 Custom Field name too long; truncated.

318 Custom Field name contains invalid characters; name ignored.

319 Card default account contains invalid characters; account ignored.

320 Invalid card default account; account ignored.

321 Card's default salesperson contains invalid characters; salesperson ignored.

322 Card's default salesperson not found; salesperson ignored.

323 Card default shipping method contains invalid characters; shipping method ignored.

324 Invalid card default shipping method; shipping method ignored.

325 Invalid Freight tax code; ignored.

326 Invalid Freight tax code; default substituted.

327 Card default comment contains invalid characters; comment ignored.

328 Invalid card default comment; comment ignored.

329 Payment method field too long; field truncated.

330 Payment method field contains invalid characters; Payment method ignored.

412 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

331 Payment method not found; Payment method ignored.

332 Payment notes too long; truncated.

333 Payment notes contains invalid characters; ignored.

334 Name on card too long; truncated.

335 Name on card contains invalid characters; ignored.

336 Card number too long; truncated.

337 Card number contains invalid characters; ignored.

338 Card expiry date too long; truncated.

339 Card expiry date contains invalid characters; ignored.

340 Authorisation number too long; number truncated.

341 Invalid authorisation number; number ignored.

342 Card picture path name too long; truncated.

343 Card picture path contains invalid characters; picture path ignored.

344 Card default form name too long; truncated.

345 Card default form name contains invalid characters; default form name ignored.

346 Email address too long; truncated.

347 Web site address too long; truncated.

349 Tax codes may only be set for detail accounts; ignored.

350 Invalid Header; ignored.

351 Activity is not chargeable; tax code when sold ignored.

352 Tax code when sold not found in tax code list; activity may not be chargeable.

353 Tax code when sold not found in tax code list; tax code when sold ignored.

354 Invalid tax code when sold; activity may not be chargeable.

355 Invalid tax when sold; ignored.

356 Activity is not chargeable; selection ignored.

357 Linked Card for Tax Authority too long; truncated.

358 Linked Card for Tax Authority not found.

359 Tax Code Description too long; truncated.

360 Consolidated Tax Code Description too long; truncated.

361 Tax Code already exists; ignored.

362 The Tax Code Description contains invalid characters; default substituted.

363 The Consolidated Tax Code Description contains invalid characters; default substituted.

365 Linked card for Tax Authority contains invalid characters.

366 Cheque Account Number not found; default substituted.

367 Duplicate Deposit ID Number.

IMPORTWARNINGS TABLE 413


ImportWarningID Description

368 Invalid or blank Deposit ID Number; default assigned.

369 Invalid or blank Cheque Number; default assigned.

370 Duplicate Cheque Number.

372 Email contains invalid characters; ignored.

373 You cannot change the Tax Type of N-T; ignored.

374 You cannot change the Tax Type of a Tax code which has been used on transactions;
ignored.

375 Import Duty and Input Taxed are invalid tax types for Tax Code When Sold; ignored.

376 Import Duty and Input Taxed are invalid tax types for Customer Cards; ignored.

377 Import Duty and Input Taxed are invalid tax types for new Customer Cards; ignored.

381 Tax Type not found; ignored.

382 You cannot change the Rate of N-T; ignored.

383 Rate invalid. 0% substituted.

384 Rate invalid; ignored.

385 Linked Account for Tax Collected not required; ignored.

386 Linked Account for Tax Paid not required; ignored.

387 Linked Card for Tax Authority not required; ignored.

388 Luxury Car Tax Threshold not required; ignored.

389 Account Name too long; name truncated.

390 Account Name contains invalid characters; name ignored.

391 Account Number too long; name truncated.

392 Account Number contains invalid characters; name ignored.

393 Deposit ID number too long; truncated.

394 Cheque number too long; truncated.

395 The linked account for Tax Collected Field is missing; ignored.

396 The linked account for Accrued Duty is missing; ignored.

397 The linked account for Tax Paid Field is missing; ignored.

398 The linked account for Tax Collected Field is not found in list of postable accounts; ignored.

399 The linked Account for Accrued Duty is not found in list of postable accounts; ignored.

400 The linked Account for Tax Paid is not found in list of postable accounts; ignored.

401 Invalid character for inactive checkbox import; status not changed to inactive.

402 An account being used in Bank Register may not be a header.

410 Deposit Account may not be blank; Default substituted.

411 Payment Account may not be blank; Default substituted.

412 Receipt Date may not be blank; Default substituted.

414 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

413 Payment Date may not be blank; Default substituted.

414 Invoice # too long; truncated.

415 Purchase # too long; truncated.

416 Invoice # contains invalid characters; ignored.

417 Purchase # contains invalid characters; ignored.

418 Customer PO # too long; truncated.

419 Supplier # too long; truncated.

420 Customer PO # contains invalid characters; ignored.

421 Supplier # contains invalid characters; ignored.

422 Memo is blank or contains invalid characters; default substituted.

423 Payment method is missing. Payment notes ignored.

424 Invalid or missing payment method. Name on card ignored.

425 Invalid or missing payment method. Card number ignored.

426 Invalid or missing payment method. Expiry date ignored.

427 Invalid or missing payment method. Authorisation number ignored.

430 Account number too long; truncated.

431 Account number contains invalid characters; ignored.

432 Invalid or missing payment method. Account number ignored.

433 Drawer/Account name too long; truncated.

434 Drawer/Account name contains invalid characters; ignored.

435 Invalid or missing payment method. Drawer/Account name ignored.

436 Cheque number too long; truncated.

437 Cheque number contains invalid characters; ignored.

438 Invalid or missing payment method. Cheque number ignored.

439 The Amount Applied exceeds the Balance Due; credit memo created.

440 The Amount Applied exceeds the Balance Due; debit memo created.

441 Card not found; card ignored.

442 Job not found in list of detail jobs; default assigned.

443 N/A

444 Duplicate Customer PO Number

445 Duplicate Supplier Invoice Number.

454 Item may not be inventoried. You have sales or purchases on file for this item.

455 An account with category history records may not be a header.

456 Category contains invalid characters; ignored.

457 Category may not be more than 15 characters; ignored.

IMPORTWARNINGS TABLE 415


ImportWarningID Description

458 Category could not be found in categories list; ignored.

459 More than one category specified; used first one specified.

460 Category tracking is off; category ignored.

461 Amount Paid cannot be less than zero; ignored.

462 Amount Paid on Credit/debit memo is not allowed; ignored.

463 Card ID not unique; ignored.

464 Job Number may not contain more than 5 characters; truncated.

465 Job Name not specified; default substituted.

466 Job Name cannot be more than 25 characters; name truncated.

467 Job Name contains invalid characters; default substituted.

468 Job Name contains invalid characters; ignored.

469 Level not specified; default level substituted.

470 Level must be numeric; default level substituted.

471 Level must be numeric; ignored.

472 Level must be between 1 and 4; default level substituted.

473 Level must be between 1 and 4; ignored.

474 Level cannot be higher than the preceding job; default level substituted.

475 Level cannot be higher than the preceding job; ignored.

476 Job cannot be 2 or 3 levels higher than its header; default level substituted.

477 Job cannot be 2 or 3 levels higher than its header; ignored.

478 A Detail jobs level cannot be lower than the following job; default level substituted

479 A Detail jobs level cannot be lower than the following job; ignored

480 Linked Customer must be the same as its header; modified.

481 Header not specified; D (Detail Job) substituted.

482 Invalid Header; D (Detail Job) substituted.

483 Level 4 Jobs may not be Header Jobs; D (Detail Job) substituted.

484 Level 4 Jobs cannot be changed to Header Jobs; ignored.

485 Invalid Header; ignored.

486 Job cannot be changed to Detail Job whilst the job is a Header to other jobs; ignored.

487 A Job with balance information cannot be changed to a Header Job; ignored.

488 A Job with transaction allocations cannot be changed to a Header Job; ignored.

489 A Job with activity slip allocations cannot be changed to a header Job; ignored.

490 Description cannot be more than 255 characters; truncated.

491 Description contains invalid characters; ignored.

492 Contact cannot be more than 25 characters; truncated.

416 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

493 Contact contains invalid characters; ignored.

494 Percent Complete cannot be assigned to a header job; ignored.

495 Percent Complete not specified; 0% substituted.

496 Invalid Percent Complete; default substituted.

497 Invalid Percent Complete; ignored.

498 Percent Complete cannot be greater than 100%; 0% substituted.

499 Percent Complete cannot be greater than 100%; ignored.

500 Invalid Start Date; ignored.

501 Invalid Finish Date; ignored.

502 Manager cannot be more than 25 characters; truncated.

503 Manager contains invalid characters; ignored.

504 A Linked Customer cannot be assigned to a Level 2, 3 or 4 jobs; ignored.

505 Linked Customer contains invalid characters; ignored.

506 Customer card not found; Linked Customer ignored.

507 Header jobs cannot be inactive; ignored.

508 Reimbursables cannot be tracked for header jobs; ignored.

509 A Header jobs level cannot be 2 or 3 levels lower than the following job; default level
substituted

510 A Header jobs level cannot be 2 or 3 levels lower than the following job; ignored.

511 Invalid Bank Account Number; ignored.

512 Bank Account Name cannot be more than 32 characters; name truncated.

513 Invalid Bank Account Name; ignored.

517 Invalid Bank Code; ignored.

530 Description cannot be more than 255 characters; truncated.

531 Account Type cannot be specified for header accounts; default substituted.

532 Account Type is not specified; default Other Asset substituted.

533 Account Type is not specified, default Other Liability substituted.

534 Invalid Classification for Statement of Cash Flow; O (Operating) Classification substituted.

535 Invalid Classification for Statement of Cash Flow; E (Exclude from Statement of Cash Flow)
Classification substituted.

536 Classification for Statement of Cash Flow cannot be specified for header accounts; ignored

547 Invalid Account Type; ignored.

552 Payment Memo cannot be more than 256 characters; memo truncated.

553 Payment Memo contains invalid characters; memo ignored.

554 Receipt Memo cannot be more than 256 characters; memo truncated.

555 Receipt Memo contains invalid characters; memo ignored.

IMPORTWARNINGS TABLE 417


ImportWarningID Description

558 Exchange account cannot be a header account; ignored.

559 Exchange account must be a postable account; ignored.

560 Currency Exchange Account not required; ignored.

561 This account is the default Bank account for Undeposited Funds. Account Type Bank may
not be removed.

563 Classification for Statement of Cash Flow cannot be specified for Bank, Income Expense and
Cost of Sales Account Types, classification ignored.

564 Invalid Clasification for Statement of Cash Flow. O (Operating) Classification substituted.

568 An account that is the currency exchange account of another account may not change its
currency.

569 Sub-Job Number may not contain more than 15 characters; truncated.

570 An account being used in Transfer Money may not be a header.

571 An account being used in MoneyController may not be a header.

572 Salesperson Card ID does not match with Employee card; salesperson ignored.

576 Job Number is not specified.

594 Invalid Invoices/Purchase Orders Delivery; current Invoices/Purchase Orders Delivery


substituted.

595 Invalid Delivery Status; current Delivery Status substituted.

596 Invalid character for Use Standard Pay Values checkbox import; checkbox value ignored.

597 I Use Timesheets preference not selected; payroll category ignored.

598 Time Billing and Payroll timesheet preference not selected; payroll category ignored.

599 The Payroll module is required for payroll category import; payroll category ignored.

600 Payroll category requires a non-zero unit; ignored.

601 I Use Timesheets preference not selected; customer ignored.

602 Time Billing and Payroll timesheet preference not selected; customer ignored.

603 N/A

604 Standard Cost field is blank, cost reset to $0.00.

605 Invalid Standard Cost, cost reset to $0.00.

606 Location ID contains invalid characters; default location substituted.

607 Location ID may not be more than 10 characters; default location substituted.

608 Location ID not found in the locations list; default location substituted.

609 No location specified; default location substituted.

610 Location not required for quotes; location ignored

611 Item not inventoried; location ignored

612 Activities do not have locations; location ignored

613 Location ID may not be more than 10 characters; location ignored.

418 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

614 Location ID contains invalid characters; location ignored.

615 Location ID not found in the location list; location ignored.

616 Location ID must be shippable; location ignored.

617 Default location substituted for blank location; results in negative on-hand quantity in
default location.

618 N/A

619 N/A

620 N/A

621 N/A

622 N/A

623 N/A

624 N/A

625 N/A

626 N/A

627 N/A

628 N/A

629 N/A

630 N/A

631 N/A

632 N/A

633 N/A

634 N/A

635 N/A

636 N/A

637 N/A

638 N/A

639 N/A

640 N/A

641 N/A

642 N/A

643 N/A

644 N/A

645 N/A

646 N/A

647 N/A

IMPORTWARNINGS TABLE 419


ImportWarningID Description

648 N/A

649 N/A

650 N/A

651 N/A

652 N/A

653 N/A

654 N/A

655 N/A

656 N/A

657 N/A

658 N/A

659 N/A

660 N/A

661 N/A

662 N/A

663 N/A

664 N/A

665 N/A

666 N/A

667 N/A

668 N/A

669 N/A

670 N/A

671 N/A

672 N/A

673 N/A

674 N/A

675 N/A

676 N/A

677 N/A

678 N/A

679 N/A

680 N/A

681 N/A

682 N/A

420 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

683 N/A

684 N/A

685 N/A

686 N/A

687 N/A

688 N/A

689 N/A

690 N/A

691 N/A

692 N/A

693 N/A

694 N/A

695 N/A

696 N/A

697 N/A

698 N/A

699 N/A

700 N/A

701 N/A

702 N/A

703 N/A

704 N/A

705 N/A

706 N/A

707 N/A

708 General Payroll Information has not been completed within the company file; Total Rebates
ignored.

708 N/A

709 N/A

710 N/A

711 N/A

712 N/A

713 N/A

714 N/A

715 N/A

IMPORTWARNINGS TABLE 421


ImportWarningID Description

716 N/A

717 N/A

718 N/A

719 N/A

720 N/A

721 N/A

722 N/A

723 N/A

724 N/A

725 N/A

726 N/A

727 N/A

728 N/A

729 N/A

730 N/A

731 N/A

732 N/A

733 N/A

734 N/A

735 N/A

736 N/A

737 N/A

738 N/A

739 N/A

740 N/A

741 N/A

742 N/A

743 N/A

744 N/A

745 N/A

746 N/A

747 N/A

748 N/A

749 N/A

750 N/A

422 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

751 N/A

752 N/A

753 N/A

754 N/A

755 N/A

756 N/A

757 N/A

758 N/A

759 N/A

760 N/A

761 N/A

762 N/A

763 N/A

764 N/A

765 N/A

766 N/A

767 N/A

768 N/A

769 N/A

770 N/A

771 N/A

772 N/A

773 N/A

774 N/A

775 N/A

776 N/A

777 N/A

778 N/A

779 N/A

780 N/A

781 N/A

782 N/A

783 N/A

784 N/A

785 N/A

IMPORTWARNINGS TABLE 423


ImportWarningID Description

786 N/A

787 N/A

788 N/A

789 N/A

790 N/A

791 N/A

792 N/A

793 N/A

794 N/A

795 N/A

796 N/A

797 N/A

798 N/A

799 N/A

800 N/A

801 N/A

802 N/A

803 N/A

804 N/A

805 N/A

806 N/A

807 N/A

808 N/A

809 N/A

810 N/A

811 N/A

812 N/A

813 N/A

814 N/A

815 N/A

816 N/A

817 N/A

818 N/A

819 N/A

820 N/A

424 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

821 N/A

822 N/A

823 N/A

824 N/A

825 N/A

826 Invalid Journal Number; default substituted.

827 Journal Number too long; truncated.

828 Invalid Date; default substituted.

829 Location not required; Location ignored.

830 Quantity and Unit Cost invalid or blank; 0 applied to both fields.

831 Quantity is invalid or blank; 0 substituted.

832 Quantity is invalid or blank; recalculated.

833 Unit Cost is invalid or blank; 0 substituted.

834 Unit Cost and Amount invalid or blank; 0 applied to both fields.

835 Unit Cost is invalid or blank; recalculated.

836 Amount is blank or invalid; 0 substituted.

837 Amount is invalid or blank; recalculated.

838 Unit Cost does not match; recalculated.

839 Allocation Memo contains invalid characters; Allocation Memo ignored.

840 Allocation Memo too long; truncated.

841 N/A

842 Bank details do not match number of bank accounts; ignored.

843 Insufficient quantity at Location specified will result in a negative item on-hand quantity.

844 Custom List Name cannot be more than 30 characters; name truncated.

845 Update Custom List Name cannot be more than 30 characters; name truncated.

846 Invalid date; ignored.

847 Elapsed Time is invalid; Elapsed Time ignored.

848 Elapsed Time must be less than 100 hours; Elapsed Time ignored.

849 Invalid Recontact Date; ignored.

850 Invalid or blank Delivery Status; To be Printed substituted.

851 N/A

852 N/A

853 N/A

854 N/A

855 N/A

IMPORTWARNINGS TABLE 425


ImportWarningID Description

856 N/A

857 N/A

858 N/A

859 N/A

860 N/A

861 N/A

862 N/A

863 N/A

864 N/A

865 N/A

866 N/A

867 N/A

868 N/A

869 N/A

870 N/A

871 N/A

872 N/A

873 N/A

874 N/A

960 Invalid Statement Text. Statement Text ignored.

961 Invalid Payment Method. Ignored; Default Cheque payment method substituted.

962 Invalid Payment Method. Ignored; Payment Method Bank Instruction substituted.

963 Invalid Official Last Day, Official Last Day ignored.

964 Official Last Day cannot be earlier than Start Date, Official Last Day ignored.

965 Invalid Hours in a Full Time Work Week.Ignored; Default hours in a Full Time Work Week
substituted.

966 You may not have more than 168 hours in weekly pay period. Default hours in a Full Time
Work Week substituted.

967 Invalid Hours in a Full Time Work Day. Ignored; DefaultTime Work Day Hours substituted.

968 You may not have more than 24 hours in daily. Default Full Time Work Day Hours
substituted.

969 Invalid Pay Slip Delivery ; default Pay Slip Delivery substituted.

970 Pay Slip Delivery To be Printed selected; Pay Slip Email ignored.

971 Pay Slip Email missing; Pay Slip Delivery set to To be Printed.

972 Pay Slip Email cannot be more than 76 characters, Pay Slip Email truncated.

973 Invalid Residential Status; Citizen substituted

426 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportWarningID Description

974 Religion cannot be more than 15 characters, Religion truncated.

975 Race cannot be more than 15 characters, Race truncated.

976 Nationality cannot be more than 15 characters, Nationality truncated.

977 (Malaysia) New IC No cannot be more than 12 digits, New IC No truncated.

978 (Malaysia) New IC No must be in numeric, New IC No ignored.

979 (Malaysia) Old IC No cannot be more than 15 characters, Old IC No truncated.

980 (Malaysia) ASB No cannot be more than 15 characters, ASB No truncated.

981 (Malaysia) LUTH No cannot be more than 25 characters, LUTH No truncated.

982 (Malaysia) SOCSO No cannot be more than 20 characters, SOCSO No truncated.

983 (Malaysia) Invalid SOCSO Scheme; Default SOCSO Scheme substituted.

984 (Malaysia) EPF No cannot be more than 20 characters, EPF No truncated.

985 Tax File Number cannot be more than 20 characters, Tax File Number truncated.

986 (Malaysia) LHDNM Branch cannot be more than 30 characters, LHDNM Branch truncated.

987 (Malaysia) Invalid Tax Category; Default Tax Category substituted.

988 (Malaysia) Tax Category is not Category 2 or Category 3. No of Child Relief ignored.

989 (Malaysia) No of Child Relief is invalid. No of Child Relief ignored.

990 (Malaysia) No of Child Relief contained invalid interval. No of Child Relief is round to the
nearest 0.5 decimal.

991 (Singapore) IC No cannot be more than 12 characters. IC No truncated.

992 (Singapore) FIN No cannot be more than 15 characters, FIN No truncated.

993 (Singapore) PR No cannot be more than 15 characters, PR No truncated.

994 (Singapore) PR No not filled, PR Start Date ignored.

995 (Singapore) Invalid PR Start Date, PR Start Date ignored.

996 (Singapore) Invalid CPF Scheme; Default CPF Scheme substituted.

997 (Singapore) CPF Number cannot be more than 20 characters, CPF Number truncated.

998 Bank Account Number cannot be more than 18 characters; truncated.

IMPORTWARNINGS TABLE 427


ImportErrors table

The ImportErrors table provides a list of import errors reported within the error log file. Data
reported within the ImportErrors table is not stored within the company file. Instead, data is
obtained from the code when generating the error log.

Field Name Type Format Description

ImportErrorID Integer 3xN Predefined list

Description Text 30xAN Individual description for each return code

The following table provides the description of each import error return code.

ImportErrorID Description

1 Account Number may not be blank

2 Account Number is too long.

3 Account Number must be numeric.

4 First digit of Account Number must be 1,2,3,4,5,6,8, or 9.

5 Duplicate Account Number.

6 Item Number may not be blank.

7 Item Number may not be more than 30 characters.

8 Item Number contains invalid characters.

9 Duplicate Item Number.

10 Invalid date.

11 Transactions dated before the beginning of your financial year may not be imported.

12 Transactions dated before your conversion date may not be imported.

13 Transactions dated before your "Posting Complete" date may not be imported.

14 Invalid account number.

15 Account number not found in list of postable accounts.

16 Invalid debit amount.

17 Invalid credit amount.

18 Each line must have debit or credit, but not both.

19 Unbalanced transaction.

20 Company Name contains invalid characters.

21 First Name contains invalid characters.

22 Last Name contains invalid characters.

23 Co./Last Name may not be blank.

428 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportErrorID Description

24 Duplicate card.

25 Invalid amount.

26 Card not found.

27 A non-zero amount requires an account.

28 Item is not sold.

29 Invalid tax amount.

30 Invalid quantity.

31 Insufficient quantity on hand.

32 Item is not bought.

33 Invalid detail date.

34 Not a customer in card file.

35 Not a supplier in card file.

36 Freight amount invalid.

37 Invalid freight tax amount.

38 Default account for freight charges not specified.

39 Income account must be specified for each item.

40 Inventory Asset account must be specified for each inventoried item.

41 Expense account must be specified for each non-inventoried item.

42 Cost of Sales account must be specified for each inventoried item.

43 Tax may not be charged on a 0.00 dollar amount.

44 No account specified for Tax collected.

45 No account specified for Tax paid.

46 Insufficient inventory value.

47 Excessive inventory value.

48 Account Name contains invalid characters.

49 Invalid transaction amount.

50 Activity ID not found.

51 Employee Card not found.

52 Customer not found.

53 Invalid Rate.

54 Invalid Units.

55 Employee may not be blank.

56 Activity ID may not be blank.

57 Date may not be blank.

58 Duplicate Slip ID#.

IMPORTERRORS TABLE 429


ImportErrorID Description

59 Duplicate Activity ID.

60 Activity ID contains invalid characters.

61 Activity ID may not be more than 30 characters.

62 Employee Co./Last Name may not be blank.

63 Employee Co./Last Name is too long or contains invalid characters.

64 Employee First Name is too long or contains invalid characters.

65 Customer Co./Last Name is too long or contains invalid characters.

66 Customer Card not found.

67 Customer Co./Last Name cannot be blank; activity is chargeable.

68 Customer First Name is too long or contains invalid characters.

69 Invalid unit amount.

70 Currency code is too long or contains invalid characters.

71 Transactions in foreign currency attached to card.

72 Currency Code not found in the currency list.

73 Multiple currencies specified.

74 The invoice's currency code is different than the customer's currency code.

75 Transactions in foreign currency attached to account.

76 No exchange account specified.

77 Account type of the exchange account cannot be different than the account type of the foreign
account.

78 Exchange account must be a local currency account.

79 Exchange account is not present in the accounts list.

80 Currency code of transaction cannot be different from the currency code of the allocation
account.

81 Tax account linked account is missing.

82 The PO's currency code is different than the supplier's currency code.

83 Customer and Salesman have different foreign currencies.

84 Foreign currency linked accounts missing.

85 Activity is not chargeable.

86 First digit of Account Number must be 1,2,3.

87 Invalid Tax code for this transaction.

88 Level 1 header account cannot be foreign.

89 Exchange account is already a linked account to a foreign account.

92 Invalid Tax Code when Bought for this Item.

93 Invalid Tax Code when Sold for this Item.

94 Invalid Amount Paid.

430 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportErrorID Description

95 Linked Cheque Account for undeposited funds is missing.

96 Linked Cheque Account for customer receipts is missing.

97 Linked Cheque Account for customer receipts in the foreign currency is missing.

98 Linked Liability Account for customer deposits is missing.

99 Linked Liability Account for customer deposits in the foreign currency is missing.

100 Linked Cheque Account for making supplier payments is missing.

101 Linked Cheque Account for making supplier payments in the foreign currency is missing.

102 Linked Asset Account for paid deposits is missing.

103 Linked Asset Account for deposits paid in the foreign currency is missing.

104 Card ID contains invalid characters.

105 Activity ID or Item Number not found.

106 The Tax Code Field is required for this import.

107 The Tax Code is invalid.

108 The Tax Type Field is required for this import.

109 Tax type not found.

110 The rate for the tax code is required for this import.

111 Invalid tax code rate.

112 The Consolidated Tax Code Field is required for this import.

113 The Consolidated Tax Code is invalid.

114 The Sub-tax Code Field is required for this import.

115 Sub-tax Code not found.

116 A particular tax code may not be included twice in one consolidated code.

117 A consolidated tax code may not be an element of another consolidated code.

119 Duplicate Deposit ID Number.

120 Duplicate Cheque ID Number.

121 The Tax Code is invalid; Importing Cancelled.

124 Tax Code already exists; rejected.

125 This Import requires Time Billing component.

126 Tax Type not found.

127 Transactions dated before your "Lock Period" date may not be imported.

129 Activity ID/Item Number may not be blank.

130 The currency of linked accounts cannot be changed.

132 Invoice # not found.

133 Purchase # not found.

134 Payments are not allowed on quotes & credits.

IMPORTERRORS TABLE 431


ImportErrorID Description

135 Payments are not allowed on quotes & debits.

136 The card attached to the invoice is not the same as the card attached to the payment.

137 The card attached to the purchase is not the same as the card attached to the payment.

138 A value must exist within either the Invoice # or Customer PO # fields.

139 A value must exist within either the Purchase # or Supplier's # fields.

140 Multiple Co/Last Names found.

141 Multiple First Names found.

142 Deposit Account must have cheque privileges.

143 Payment Account must have cheque privileges.

144 The Currency of the Deposit Account # must be local or same as Customer's.

145 The Currency of the Payment Account # must be local or same as Supplier's.

146 Invalid Customer PO #.

147 Invalid Purchase #.

148 The same invoice cannot receive multiple applications within one payment.

149 The same bill cannot receive multiple applications within one bill payment.

150 Invoice date not found.

151 Bill date not found.

152 Customer PO # not found.

153 Supplier # not found.

154 Invalid Customer PO #.

155 Invalid Supplier #.

156 Amount Applied is invalid or blank.

157 The Receive Payments currency code is different than the Customer's currency code.

158 The Pay Bills currency code is different than the Supplier's currency code.

159 Linked Asset Account for customer receivables is missing.

160 Linked Asset Account for customer receivables in the foreign currency is missing.

161 Linked Liability Account for supplier payables is missing.

162 Linked Liability Account for supplier payables in the foreign currency is missing.

163 The customer's number doesn't match number on invoice.

164 The supplier's number doesn't match number on purchase.

165 Linked account for discounts given is missing.

166 Linked account for discounts given in the foreign currency is missing.

167 Linked account for discounts taken is missing.

168 Linked account for discounts taken in the foreign currency is missing.

169 Job not found in list of detail jobs.

432 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportErrorID Description

170 Multiple jobs may not be imported.

171 A category is required.

172 A valid entry must exist within either the Co./Last Name or CardID fields.

173 Duplicate Card ID found, Record not updated.

174 Card ID does not match with a Customer card. Record not updated.

175 Card ID does not match with a Supplier card. Record not updated.

176 Card ID does not match with an Employee card. Record not updated.

177 Card ID does not match with a Personal card. Record not updated.

178 Job Number may not be blank.

179 Job Number contains invalid characters.

180 Duplicate Job Number.

181 File is busy; Import did not start.

182 Account number prefix does not match Account Type

183 Duplicate Invoice Number

184 Duplicate Customer PO number

185 Account Type is too long or contains invalid characters. Duplicate account number

186 Exchange account cannot be a header account.

187 Exchange account must be a postable account

188 Duplicate Purchase Order Number

189 Sub-Job Number contains invalid characters

190 Customer not found. Sale invoice not imported.

191 Card ID does not match with a Customer card. Sale invoice not imported

192 Duplicate Supplier Invoice Number

193 Tax code does not allow Non-GST amounts

194 Tax code does not allow GST amounts

196 Tax code does not allow Freight Non-GST amounts

197 Tax code does not allow Freight GST amounts

199 The Ex-Tax Amount must equal the Inc-tax Amount within the first line of a Spend Money
transaction

200 A Tax Code cannot be applied to the first line of a Spend Money Transaction

201 The Non TAX Amount must be $0.00 within the first line of a Spend Money Transaction

202 The Tax Amount must be $0.00 within the first line of a Spend Money Transaction

203 The Import Duty Amount must be $0.00 within the first line of a Spend Money Transaction

204 The Ex-Tax Amount must equal the Inc-tax Amount within the first line of a Receive Money
transaction

205 A Tax Code cannot be applied to the first line of a Receive Money Transaction

IMPORTERRORS TABLE 433


ImportErrorID Description

206 The Non Tax Amount must be $0.00 within the first line of a Receive Money Transaction

207 The Tax Amount must be $0.00 within the first line of a Receive Money Transaction

209 Account number has no match.

210 Budgets cannot be imported for Header Accounts.

211 Account already has budget information.

212 Payroll Category may not be blank.

213 Employee must be of local currency.

214 Payroll category contains invalid characters.

215 This Import requires Payroll component.

216 Payroll category not found.

217 Payroll category is not linked to employee.

218 Payroll category is not an hourly wage category.

219 Location ID may not be more than 10 characters.

220 Location ID contains invalid characters.

221 Location ID not found in the location list.

222 Order quantity must be numeric.

223 Billed quantity must be numeric.

224 Billed quantity cannot exceed the Received quantity.

225 Insufficient quantity at Location specified.

226 Location ID may not be blank.

227 Location may not be blank.

228 Received quantity must be numeric.

229 Location invalid on Quote.

230 Location invalid on non-inventoried item.

231 Location is not a sell or ship from location.

232 No location specified; default location cannot be substituted due to insufficient quantity.

233 Received quantity on order cannot be less than zero.

234 Received quantity cannot exceed the Ordered quantity.

235 Co/Last Name blank or invalid. Sale invoice not imported.

236 Co/Last Name blank or invalid. Purchase order not imported.

237 Card ID blank or invalid. Sale invoice not imported.

238 Card ID blank or invalid. Purchase order not imported.

239 Record ID blank or invalid. Sale invoice not imported.

240 Record ID blank or invalid. Purchase order not imported.

241 Supplier not found. Purchase order not imported.

434 CHAPTER 8 ERRORS AND WARNINGS TABLES


ImportErrorID Description

242 More than 1 customer found. Sale invoice not imported.

243 More than 1 supplier found. Purchase order not imported.

244 Co/Last Name blank or invalid. Receive payment not imported.

245 Co/Last Name blank or invalid. Pay bill not imported.

246 Card ID blank or invalid. Receive payment not imported.

247 Card ID blank or invalid. Pay bill not imported.

248 Record ID blank or invalid. Receive payment not imported.

249 Record ID blank or invalid. Pay bill not imported.

250 Customer not found. Receive payment not imported.

251 Supplier not found. Pay bill not imported.

252 More than 1 customer found. Receive payment not imported.

253 More than 1 supplier found. Pay bill not imported.

254 Co/Last Name blank or invalid. Spend money transaction not imported.

255 Card ID blank or invalid. Spend money transaction not imported.

256 Record ID blank or invalid. Spend money transaction not imported.

257 Card not found. Spend money transaction not imported.

258 More than 1 card found. Spend money not imported.

259 Emp. Co/Last Name blank or invalid. Activity slip not imported.

260 Emp. Card ID blank or invalid. Activity slip not imported.

261 Emp. Record ID blank or invalid. Activity slip not imported.

262 Employee/Supplier not found. Activity slip not imported.

263 More than 1 employee/supplier found. Activity slip not imported.

264 Co/Last Name blank or invalid. Card not imported/updated.

265 Record ID does not match with a Customer card. Record not updated.

266 Record ID does not match with a Supplier card. Record not updated.

267 Record ID does not match with an Employee card. Record not updated.

268 Record ID does not match with a Personal card. Record not updated.

269 Card ID blank or invalid. Card not imported/updated.

270 Record ID blank or invalid. Card not updated.

271 Item not found.

272 Item is not inventoried.

273 Location not found.

274 The combination of Quantity, Unit Cost and Amounts values is invalid.

275 You may not transfer more items than you have on hand.

276 If an item has a positive on-hand quantity, its value must be positive or zero.

IMPORTERRORS TABLE 435


ImportErrorID Description

277 If you have no items on hand, the value of your stock must be zero.

278 No Account specified.

279 Account not found.

280 Account invalid.

281 Category not found.

282 Custom List Name may not be blank.

283 Custom List Name contains invalid characters.

284 Type may not be blank.

285 Invalid Type.

286 Number may not be blank.

287 Invalid Number.

288 Duplicate Custom List record.

289 Duplicate Custom List record. Update Custom List Name may not be blank.

290 Duplicate Custom List record. Update Custom List Name contains invalid characters.

291 At least one of the fields Co./Last Name, Card ID or Card Record ID must contain a value.
Contact log not imported.

292 Card not found. Contact log not imported.

293 More than 1 card found. Contact log not imported.

294 Contact Log Record ID may not be blank. Contact log not imported.

295 Duplicate Contact Log.

296 Employee not found. Timesheet not imported.

297 More than 1 employee found. Timesheet not imported.

298 Emp. Co./Last Name may not be blank. Timesheet not imported.

299 Emp. Card ID may not be blank. Timesheet not imported.

300 Emp. Record ID may not be blank. Timesheet not imported.

301 Linked Liability account for Item Receipts is missing.

302 Received quantity cannot exceed the Billed quantity.

436 CHAPTER 8 ERRORS AND WARNINGS TABLES


InternalODBCErrors table

The InternalODBCErrors table provides a list of error messages reported when a miscellaneous
error is encountered during the import write process. Data reported within the
InternalODBCErrors table is not stored within the company file. Instead, data is obtained from
code used when generating the applicable error message.

Field Name Type Format Description

NativeErrorNumber Integer 5xN Predefined list, from 20010 to 20101

Description Text 255xAN Individual description for each NativeErrorNumber

The following table provides the description of each internal ODBC error return code.

NativeErrorNumber Description

20010 Error: Invalid unlock key

20011 Registration code mismatch

20013 No access to table

20014 Unable to delete log file

20015 Import file does not exist

20016 Unable to determine if import has finished

20017 Cannot execute an INSERT IN read-only mode

20018 At least one row of data is invalid

20019 Foreign key not found

20020 A transaction has been committed but no query has been processed

20021 Cannot find table

20022 Table does not have write capability

20050 Login details are incorrect

20053 Unable to open data file

20054 No connection to DSN

20055 The password provided for this company file is incorrect

20056 Token in connection string has no value

20057 Cannot connect directly to the driver

20058 Authentication failed

20059 ODBC Connection string has insufficient data

20060 Application specified does not exist

20061 Data file specified does not exist

INTERNALODBCERRORS TABLE 437


NativeErrorNumber Description

20062 Data file specified is not used by MYOB

20063 Executable and Data File specified are not compatible

20064 Error generating map file

20065 Cannot determine if MYOB was AutoStarted

20066 Cannot launch MYOB

20067 Cannot find valid MYOB application running

20068 Cannot register messages with MYOB

20069 Unable to AutoClose MYOB

20070 Application specified does not have writing support

20071 Unable to connect for writing - No MYOB Application has been specified

20072 This company file is unable to be accessed. It may be in use by another application in
single-user mode or it has the read only attribute set

20073 MYOB ODBC does not support this company file version

20074 Information within the DSN is invalid. Unable to access the company file. Create a new
DSN to gain access to the company file

20075 Company file is corrupt. Unable to access the company file

20076 The file type of the company file selected is unknown

20077 Company file does not exist

20078 The company file selected is not supported by this version of ODBC

20079 DSN does not exist

20080 The library files \"ctmyob32.dll\" and \"MYOBSp32.dll\" are missing for this version.
Please make sure that you have the most up-to-date version of the ODBC driver installed.
The latest installer can be found on the MYOB installation CD.

20081 MYOBSp32.dll could not be initialised. Please try connecting again or restart your
machine

20082 The company file could not be opened. Make sure no other applications are using the
company file then try connecting again

20083 The ODBC driver cannot register a session with the company file

20084 An unknown error has occurred with MYOBSp32.dll. Please try connecting again or
restart your machine

20085 You do not have write access to this company file

20086 This company file has not been registered for ODBC access

20087 No company file specified

20088 Internal files could not be opened. The company file and the support libraries are not
compatible

20089 Cannot have more than 50 connections

20090 Unable to launch MYOB - Database specified in the connection string is already opened
exclusively by another application.

438 CHAPTER 8 ERRORS AND WARNINGS TABLES


NativeErrorNumber Description

20091 An initialisation error with the MYOB application has occurred

20092 Invalid Registration Key

20093 Invalid passing of key path form OEM

20094 Registration Key has expired

20095 Registration Key not found

20096 Invalid ODBC driver version

20097 Registration Key file not found or corrupt

20098 Your company file is in read-only mode. Please confirm your company file to gain write
access

20099 <TableName> is not available for MYOB Accounting

20100 User Name restrictions prevent access to data within table <Table Name>.

20101 User Name restrictions prevent the writing of data to the MYOB company file.

INTERNALODBCERRORS TABLE 439


440 CHAPTER 8 ERRORS AND WARNINGS TABLES

You might also like