XML eGateway Import: Transaction Entity:
The Transaction Entity represents Exchequer Software Transaction Header, which has many lines on transaction. The following Element names are mapped to Enterprise COM Toolkit fields, the Exchequer COM Toolkit automatically fills in most defaults, similar to entering the transaction manually. The Account Entity fields are also encapsulated within this entity for extra flexibility.
FieldName |
DataType |
Length |
DefaultValue |
Notes |
thAcCode |
String |
20 |
This can be matched on acAltCode according to settings |
|
thADJDescription |
String |
20 |
Stock Adjustment Description on Header |
|
thAnalysisCode |
String |
10 |
Default Exchequer Job Analysis code |
|
thCompanyRate |
Decimal |
|
Company exchange rate |
|
thControlGL |
Integer |
|
† |
Exchequer Control GL if need to overide |
thCostCentre |
String |
3 |
† |
Lines will default to this value |
thCurrency |
Integer |
|
† |
0-29,1=Sterling |
thDailyRate |
Decimal |
|
Daily exchange rate |
|
thDatedNotes_AlarmDate |
Date |
|
Add date notes to account |
|
thDatedNotes_Note |
String |
65 |
Add date notes to account |
|
thDatedNotes_User |
String |
10 |
Add date notes to account |
|
thDelAddress1 |
String |
30 |
Delivery address on Transaction, If over 30 chars will word wrap to next line |
|
thDelAddress2 |
String |
30 |
Delivery address on Transaction, If over 30 chars will word wrap to next line |
|
thDelAddress3 |
String |
30 |
Delivery address on Transaction, If over 30 chars will word wrap to next line |
|
thDelAddress4 |
String |
30 |
Delivery address on Transaction, If over 30 chars will word wrap to next line |
|
thDelAddress5 |
String |
30 |
Delivery address on Transaction |
|
thDelPostcode |
String |
20 |
Delivery address Postcode |
|
thDelCountryCode |
String |
30 |
Delivery address Country Code. GB,US etc Deafults to GB |
|
thDeliveryTerms |
Integer |
|
Intrastat |
|
thDepartment |
String |
3 |
† |
Lines will default to this value |
thDocType |
String |
3 |
SIN |
can be SRI,SIN … |
thDueDate |
Date |
|
Due date of invoice or delivery date of order |
|
thGeneralNoteLine1 |
String |
65 |
General specific Line |
|
thGeneralNoteLine10 |
String |
65 |
General specific Line |
|
thGeneralNoteLine11 |
String |
65 |
General specific Line |
|
thGeneralNoteLine12 |
String |
65 |
General specific Line |
|
thGeneralNoteLine13 |
String |
65 |
General specific Line |
|
thGeneralNoteLine14 |
String |
65 |
General specific Line |
|
thGeneralNoteLine15 |
String |
65 |
General specific Line |
|
thGeneralNoteLine2 |
String |
65 |
General specific Line |
|
thGeneralNoteLine3 |
String |
65 |
General specific Line |
|
thGeneralNoteLine4 |
String |
65 |
General specific Line |
|
thGeneralNoteLine5 |
String |
65 |
General specific Line |
|
thGeneralNoteLine6 |
String |
65 |
General specific Line |
|
thGeneralNoteLine7 |
String |
65 |
General specific Line |
|
thGeneralNoteLine8 |
String |
65 |
General specific Line |
|
thGeneralNoteLine9 |
String |
65 |
General specific Line |
|
thGeneralNotes |
String |
999 |
General notes This gets appended to notes on every update |
|
thGLCode |
Integer |
|
† |
Lines will default to this value |
thHoldFlag |
Integer |
|
0 |
0=Auth,1=Query Tag <AllImportOnHold> in system settings enforces all transactions on hold |
thJobCode |
String |
10 |
Default for All lines |
|
thLinkDoc1_Description |
String |
60 |
Add Linked document |
|
thLinkDoc1_FileName |
String |
84 |
Add Linked document |
|
thLinkDoc2_Description |
String |
60 |
Add Linked document |
|
thLinkDoc2_FileName |
String |
84 |
Add Linked document |
|
thLocation |
String |
3 |
† |
Lines will default to this value |
thLongYourRef |
String |
20 |
AltRef Tag <thLongYourRefMustBeUnique> in system settings enforces this to be unique |
|
thNoLabels |
Integer |
|
0 |
No Labels to print |
thManualVAT |
Boolean |
|
|
If set then will use the VAT Amount specified on the lines. You must make sure this is correct as it is not validated. Use this to get around rounding issues with external systems. Note: This has implications on partially delivered Orders This should be on for SRI transactions otherwise potential rounding differences may stop the SRI posting |
thMatchByExternalRef |
Boolean |
If Yes then: |
||
thNOMAutoReversing |
Boolean |
|
|
If yes then auto reversing on Nominal Journal |
thNOMDescription |
String |
20 |
Nominal Description on Header |
|
thOLECode |
String |
6 |
If different from system settings then will change company |
|
thPeriod |
Integer |
|
Period if not set automatically |
|
thSettleDiscDays |
Integer |
|
Settlement discount days (will default to account settings) |
|
thSettleDiscPerc |
Integer |
|
Settlement discount percent (will default to account settings) |
|
thTagNo |
Integer |
|
0 |
Tag no |
thTransDate |
Date |
|
Date of transaction Tag <thTransDateMustBeCurrentMonth> in system settings enforces transaction in this month only |
|
thTransportMode |
Integer |
|
Intrastat |
|
thTransportNature |
Integer |
|
Intrastat |
|
thTSHDescription |
String |
20 |
Exchequer Timesheet Description on Header |
|
thTSHEmployee |
String |
6 |
Exchequer |
|
thTSHWeekMonth |
Integer |
|
Exchequer Timesheet Week no |
|
thUserField1-10 |
String |
30 |
User field |
|
thVATCode |
String |
1 |
† |
Lines will default to this value |
thYear |
Long |
|
Year if not set automatically |
|
thYourRef |
String |
10 |
Your Ref Tag <thYourRefMustBeUnique> in system settings enforces this to be unique |
† = These fields are defined as string in DTD to allow for conversion in PostTrans
The following fields have been added to allow up to three extra lines (thExtraLine1, thExtraLine2 and thExtraLine3) to be added to a transaction from the Transaction Header Entity. This would be instead if expressing them as a Transaction Line.
The tag <TransactionExtraLinesBeforeOrAfter> in system settings controls if these lines should be before or after Transaction lines.
FieldName |
DataType |
Length |
DefaultValue |
Notes |
thExtraLine1_GLCode |
Integer |
|
Extra Line expressed in Header:required Exchequer GL code (but set to default if on stock record) |
|
thExtraLine1_Desc |
String |
55 |
Extra Line expressed in Header:Description A value must exist in this field to create line |
|
thExtraLine1_Qty |
Double |
|
Extra Line expressed in Header:Qty |
|
thExtraLine1_NetValue |
Double |
|
Extra Line expressed in Header:Unit Price, Nom value, TSH charge |
|
thExtraLine1_CostCentre |
String |
3 |
Extra Line expressed in Header:Analysis |
|
thExtraLine1_Cost |
Double |
|
Extra Line expressed in Header:Cost price per unit |
|
thExtraLine1_Department |
String |
3 |
Extra Line expressed in Header:Analysis |
|
thExtraLine1_VATAmount |
Double |
20 |
Extra Line expressed in Header:VAT Amount |
|
thExtraLine1_VATCode |
String |
1 |
Extra Line expressed in Header:S,Z,E,1,2,3,4,5,6,7,8,9,A,D,T,X |
|
thExtraLine1_UserField1 |
String |
30 |
Extra Line expressed in Header:User field |
|
thExtraLine1_UserField2 |
String |
31 |
Extra Line expressed in Header:User field |
|
thExtraLine1_UserField3 |
String |
32 |
Extra Line expressed in Header:User field |
|
thExtraLine1_UserField4 |
String |
33 |
Extra Line expressed in Header:User field |
|
thExtraLine1_StockCode |
String |
16 |
Extra Line expressed in Header:Stock code |
|
thExtraLine1_Location |
String |
3 |
Extra Line expressed in Header:Loaction if multi location system |
Long external account numbers
if <MatchOnID>acAltCode</MatchOnID> is on system settings, then XML eGateway will lookup the Exchequer account code for the customer/supplier based on the customer/supplier Alt code.
<TransactionHeader>
<thDocType>SOR</thDocType>
<thAcCode>
<thTransDate>1/11/2005</thTransDate>
<thDueDate>1/12/2005</thDueDate>
More examples included with test program
TransactionLine Entity:
The TransactionLine Entity represents a Exchequer Software Transaction Lines, which is on a Transaction.
FieldName |
DataType |
Length |
DefaultValue |
Notes |
tlADJBuild |
Boolean |
|
Build flag on stock adjustment |
|
tlADJQtyIN |
Decimal |
|
Stock Adjustment QtyIN |
|
tlADJQtyOUT |
Decimal |
|
Stock Adjustment QtyOUT |
|
tlAnalysisCode |
String |
10 |
Exchequer Job Anaysis code |
|
tlChequeNo |
String |
55 |
Payment Line : ChequeNo |
|
tlCost |
Decimal |
|
Cost price per unit |
|
tlCostCentre |
String |
3 |
† |
Analysis |
tlCurrency |
Integer |
|
1 † |
Currency of line, else header value |
tlDailyRate |
Decimal |
|
Daily Exchange rate if diff from header |
|
tlDepartment |
String |
3 |
Analysis |
|
tlDescr |
String |
55 + |
Line Description (each lines is 55 chars long) DO NOT specify to get the description from Enterprise Stock Module FOR STOCK CODE LINE ONLY:
Therefore it is possible to have extra long descriptions on a transaction. Use "|" to start a new line FOR NON STOCK CODE ITEMS: Set up a description only stock item and push text in against that stock item |
|
tlDiscFlag |
String |
1 |
If % then discount is a percentage |
|
tlDiscount |
Decimal |
|
Discount for line as amount or percent(tlDiscFlag) |
|
tlGLCode |
Integer |
|
† |
required GL code (but set to default if on stock record) |
tlInclusiveVATCode |
String |
1 |
Inclusive VAT code if inclusive of VAT |
|
tlJobCode |
String |
10 |
Exchequer Job code to book too |
|
tlLineDate |
Date |
|
Line date |
|
tlLineType |
Integer |
|
Type of line classification. Usually 0 0-4 |
|
tlLocation |
String |
3 |
† |
Loaction if multi location system |
tlNetValue |
Decimal |
|
Unit Price, Nom value, TSH charge |
|
tlNOMCredit |
Decimal |
|
Mininal Journal Credit |
|
tlNOMDebit |
Decimal |
|
Mininal Journal Debit |
|
tlPayInRef |
String |
16 |
Payment Line : Paying In Ref (Line is flaged as payment if has value) |
|
tlQty |
Decimal |
|
Qty |
|
tlQtyMul |
Decimal |
|
Used for pack quantities |
|
tlSSDCommodCode |
String |
8 |
Instrastat if needed to overide |
|
tlSSDCountry |
String |
5 |
Instrastat if needed to overide |
|
tlSSDSalesUnit |
Decimal |
|
Instrastat if needed to overide |
|
tlSSDUpliftPerc |
Decimal |
|
Instrastat if needed to overide |
|
tlSSDUseLineValues |
Boolean |
|
Intratstat taken from line flg |
|
tlStockCode |
String |
16 |
Stock code |
|
tlTSHChargeCurrency |
Integer |
|
1 |
Charge Currency on TSH |
tlTSHChargeOutRate |
Decimal |
|
TimeSheet Chargeout rate per hour |
|
tlTSHCostPerHour |
Decimal |
|
TimeSheet cost rate per hour |
|
tlTSHHours |
Decimal |
|
TimeSheet Hours |
|
tlTSHRateCode |
String |
10 |
TimeSheet Rate code |
|
tlUnitWeight |
Decimal |
|
Weight of line |
|
tlUserField1-10 |
String |
30 |
User field |
|
tlVATAmount |
Decimal |
20 |
Total VAT Amount for line. Used for Manual VAT ONLY (header tag thManualVAT=Yes) This is NOT validated by COM Toolkit, which get round rounding problems with external systems |
|
tlVATCode |
String |
1 |
† |
Exchequer VAT code S,Z,E,1,2,3,4,5,6,7,8,9,A,D,T,X |
† = These fields are defined as string in DTD to allow for co nversi on in PostTrans
For Example, for Exchequer Software SOR, in XML:
<?xml version="1.0" ?>
<ExchequerData>
<TransactionHeader>
<!-- Create Exchequer SIN Transaction, from XML file -->
<thDocType>SIN</thDocType>
<thAcCode>SAM01</thAcCode>
<thTransDate>2005-05-31</thTransDate>
<thDueDate>2005-06-31</thDueDate>
<thYourRef>4571025</thYourRef>
<thCostCentre>East Division</thCostCentre>
<thDepartment>Jane Smith</thDepartment>
<thLocation>Main warehouse</thLocation>
<TransactionLine>
<!-- This line specifies Stock code and Price and VAT -->
<tlStockCode>ALARMSYS-DOM-1</tlStockCode>
<tlQty>1</tlQty>
<tlDescr>Labour2</tlDescr>
<tlNetValue>57.45</tlNetValue>
<tlVATCode>Standard</tlVATCode>
<tlVATAmount>10.05</tlVATAmount >
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
<TransactionLine>
<!-- All price, VAT will be automatically calculated -->
<tlStockCode>CAMERA-BRACKET</tlStockCode>
<tlQty>5</tlQty>
</TransactionLine>
<TransactionLine>
<!-- This line specifies Stock code and Price, but Exchequer calcs VAT
if CalculateVATAutomatically setting is on -->
<tlStockCode>BAT-1.5AA-ALK</tlStockCode>
<tlQty>2</tlQty>
<tlDescr>Two Batteries</tlDescr>
<tlNetValue>50.00</tlNetValue>
<tlVATCode>Standard</tlVATCode>
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
</TransactionHeader>
</ExchequerData>
More examples included with test program
For Example, for Exchequer Software SOR and insert/update Account, in XML:
<?xml version="1.0" ?>
<ExchequerData>
<TransactionHeader>
<!-- Account entities are included in Transaction Header, so account can be created -->
<!-- Create/Update Exchequer Account record, in XML -->
<acAltCode>COMTLONGCODE198</acAltCode>
<acCompany>Comtek Accounts</acCompany >
<acAddress1>Venture House</acAddress1>
<acAddress2>Venture Court</acAddress2>
<acAddress3>Bolness Rd.</acAddress3>
<acAddress4>Wisbech</acAddress4>
<acAddress5>Cambs</acAddress5>
<acPostCode>PE13 2QL</acPostCode>
<acContact>Sam Smith</acContact>
<acGeneralNotes>General Note can be imported against the
Account/Transaction </acGeneralNotes>
<!-- Create Exchequer SIN Transaction, in XML -->
<thDocType>SIN</thDocType>
<thAcCode>SAM01</thAcCode>
<thTransDate>2005-05-31</thTransDate>
<thDueDate>2005-06-31</thDueDate>
<thYourRef>4571025</thYourRef>
<thCostCentre>East Division</thCostCentre>
<thDepartment>Jane Smith</thDepartment>
<thLocation>Main warehouse</thLocation>
<TransactionLine>
<!-- This line specifies Stock code and Price and VAT -->
<tlStockCode>ALARMSYS-DOM-1</tlStockCode>
<tlQty>1</tlQty>
<tlDescr>Labour2</tlDescr>
<tlNetValue>57.45</tlNetValue>
<tlVATCode>Standard</tlVATCode>
<tlVATAmount>10.05</tlVATAmount >
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
<TransactionLine>
<!-- All price, VAT will be automatically calculated -->
<tlStockCode>CAMERA-BRACKET</tlStockCode>
<tlQty>5</tlQty>
</TransactionLine>
<TransactionLine>
<!-- This line specifies Stock code and Price, but Exchequer calcs
VAT if CalculateVATAutomatically setting is on -->
<tlStockCode>BAT-1.5AA-ALK</tlStockCode>
<tlQty>2</tlQty>
<tlDescr>Two Batteries</tlDescr>
<tlNetValue>50.00</tlNetValue>
<tlVATCode>Standard</tlVATCode>
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
</TransactionHeader>
</ExchequerData>
More examples included with test program
For Example, for Exchequer Software ADJ, in XML
<?xml version="1.0" ?>
<ExchequerData>
<TransactionHeader>
<!-- Move ALARMSYS-DOM-1 from main location to the VAN -->
<!-- Create Exchequer ADJ Transaction, in XML -->
<thDocType>ADJ</thDocType>
<thADJDescription>Description</thADJDescription>
<TransactionLine>
<tlStockCode>ALARMSYS-DOM-1</tlStockCode>
<tlADJQtyOUT>1</tlADJQtyOUT>
<tlLocation>Main warehouse</tlLocation>
</TransactionLine>
<TransactionLine>
<tlStockCode>ALARMSYS-DOM-1</tlStockCode>
<tlADJQtyIN>1</tlADJQtyIN>
<tlLocation>VAN</tlLocation>
</TransactionLine>
<thGeneralNotes>General Note can be imported against the Transaction
</thGeneralNotes>
</TransactionHeader>
</ExchequerData>
More examples included with test program
For Example, for Exchequer Software NOM, in XML
<?xml version="1.0" ?>
<ExchequerData>
<TransactionHeader>
<!-- Create Exchequer NOM Transaction, in XML -->
<thDocType>NOM</thDocType>
<thTransDate>2005-05-31</thTransDate>
<thNOMDescription>My Test TSH</thNOMDescription>
<!-- This line specifies Exchequer Credit Line -->
<TransactionLine>
<tlNOMCredit>10.00</tlNOMCredit>
<tlDescr>Charges</tlDescr>
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
<!-- This line specifies Exchequer Debit Line -->
<TransactionLine>
<tlNOMDebit>10.00</tlNOMDebit>
<tlDescr>Charges</tlDescr>
<tlGLCode>BANK</tlGLCode>
</TransactionLine>
<!-- This line specifies it Line -->
<TransactionLine>
<tlNetValue>-15.00</tlNetValue>
<tlDescr>Charges</tlDescr>
<tlGLCode>SALES</tlGLCode>
</TransactionLine>
<!-- This line specifies Line -->
<TransactionLine>
<tlNetValue>15.00</tlNetValue>
<tlDescr>Charges</tlDescr>
<tlGLCode>BANK</tlGLCode>
</TransactionLine>
</TransactionHeader>
</ExchequerData>
More examples included with test program
Export notes:
After many years of experience writing links between Exchequer and external systems we have added the following fields to our data export. More information about exporting data
Exchequer Transaction Header
FieldName | DataType | Length | Notes |
thDatedNotes |
String |
999 |
Last 5 lines of dataed notes |
thHoldFlagSt |
String |
12 |
Text version of Transaction Status |
thOurRef |
String |
|
Transaction ID |
thTotalCost |
Double |
|
Total Cost in Base Currency |
thTotalOrderOS |
Double |
|
|
thTotalVAT |
Double |
|
Total VAT in Base Currency |
thTotNetInBase |
Double |
|
Total Nett in Base Currency |
thTotNetInCcy |
Double |
|
Total Net in Trans Currency |
thTotOutstandingInBase |
Double |
|
Total Outstanding in Base Currency |
thTotOutstandingInCcy |
Double |
|
Total Outstanding in Trans Currency |
Exchequer Transaction Lines
FieldName | DataType | Length | Notes |
tlLineNumber |
Integer |
|
Sort by this to get lines in correct order |
tlOurRef |
String |
9 |
ID Relates to header |
tlQtyDel |
Double |
|
Qty that has been delivered |
tlQtyOutstanding |
Double |
|
Qty waiting to be delivered |
The two tables are related by thOurRef (in Transaction Header), and tlOurRef (in Transaction Lines). The Transaction Lines table should then be sorted by tlLineNumber to give correct order.