Tungsten AutomationReadSoft Invoices API Help
×
  • Introduction
  • Typographical conventions
  • Get started
    • Customize ReadSoft Invoices
    • Migrate ReadSoft Invoices customizations to recent operating systems
    • Events in ReadSoft Invoices
    • OLE API versus COM API
    • Return values
    • Event handlers
      • Four types of event handlers
      • VBA and DLL evet handlers
        • VBA and DLL event handlers: Overview
        • VBA event handlers
        • Where to place event handlers
        • Define event handlers
        • Access event handlers
        • Edit event handlers
        • Delete event handlers
        • The Visual Basic Edit dialog box
        • Disabling events
        • Specify location of DLLs in Eilocal.ini
        • Initialize DLL extensions
        • DLL event handlers
        • Example of an event DLL with a function
      • Event server
        • Use an ActiveX object as Tungsten ReadSoft Invoices' event server
        • Registering ActiveX objects in Windows
        • Setting an ActiveX object as ReadSoft Invoices' event server
      • Plugins
        • Event order
        • Use an ActiveX object as a Tungsten ReadSoft Invoices extension
        • Registering ActiveX objects in Windows
        • Set an ActiveX object as a Tungsten ReadSoft Invoices extension
        • Initialize ReadSoft Invoices extensions
        • Get list of ReadSoft Invoices and configure extensions
        • Prevent modules from starting without extensions
        • Plug-in methods used in Tungsten ReadSoft Invoices extensions
        • Connect (ByRef ehApp As Object, ByRef strInifile As String, ByRef strIniSection As String) As Long
        • Disconnect(ehApp as Object) As Long
        • Configuration object
        • ConfigurationSegment object
        • IsVistaConverted method
        • ConfigurePlugin method
        • Calling conventions
        • Example of how to configure ReadSoft Invoices extensions
  • Collections
    • Batches collection
    • Buyers collection
    • FieldDefinitions collection
    • FieldProfiles collection
    • Identifiers collection
    • InvoiceDefinitions collection
    • InvoiceFields collection
    • InvoicePages collection
    • InvoiceProfiles collection
    • Invoices collection
    • JobDescriptions collection
    • LineItemRows collection
    • Plugins collection
    • PluginSelection collection
    • Queues collection
    • TransactionDescriptions collection
    • TransactionFieldDefinitions collection
    • TransactionFieldDefTemplates collection
    • TransactionFields collection
    • TransactionItems collection
    • TransactionRows collection
    • UserDefinedVariables collection
    • UserDefinitions collection
    • WordCollection collection
  • Objects
    • Object maps
      • Object map: InvoiceProfiles
      • Object map: Invoices
      • Object map: ManagerApp
    • COM objects and the events they subscribe to
    • Application object
    • ApplicationEx object
    • Batch object
    • Buyer object
    • Configuration object
    • ConfigurationSegment object
    • DocumentInfo object
    • FieldDefinition object
    • FieldProfile object
    • Identifier object
    • InterpretApp object
    • Invoice object (COM)
    • InvoiceDefinition object
    • InvoiceField object
    • InvoicePage object
    • InvoiceProfile object
    • Job object
    • JobDescription object
    • JobSettingsInterpret object
    • JobSettingsScan object
    • JobSettingsTransfer object
    • JobSettingsVerify object
    • LineItemRow object
    • ManagerApp object
    • OptimizerApp object
    • Plugin object
    • Queue object
    • ScanApp object
    • Selection object
    • Transaction object
    • TransactionDescription object
    • TransactionField object
    • TransactionFieldDefinition object
    • TransactionItem object
    • TransactionRow object
    • TransferApp object
    • UserDefinedVariable object
    • UserDefinition object
    • UserInterface object
    • VerifyApp object
    • Word object
  • Methods
    • Add method
    • AddAPIProcessMessage method
    • AddCommand method
    • AddCommandToMenu method
    • AddCustom method
    • AddFromFile method
    • AddFromTemplate method
    • AddToQueue method
    • CancelEventChain method
    • Clear method
    • Close method
    • Delete method
    • DeleteAll method (COM API)
    • DeleteCommand method
    • ExportToMultiTiff method
    • GetClassicObject method
    • GetTitleRectBounds method
    • GetUserDefinedMenuPos method
    • GetValueRectBounds method
    • InitUserDefinedMenu method
    • IsVistaConverted()
    • LoadJob method
    • Login method
    • Pause method
    • Ping method
    • ReadTIFFTag method
    • Refresh method
    • RemoveFromQueue method
    • RetrieveSharedObject method
    • RetrieveSharedVariable method
    • Select method
    • SetDefault method
    • SetEventReturnValue method
    • SetEventServerObject method
    • SetHeartbeat method
    • SetLoggingProperties method
    • SetTimer method
    • Show method
    • Sleep method
    • Start method
    • Stop method
    • StoreSharedObject method
    • StoreSharedVariable method
    • Subscribe method
    • Wakeup method
    • WriteTIFFTag method
  • Events
    • Event reference
    • Event flow charts
      • Event flowcharts
      • Scan event flowchart
      • Interpret event flowchart
      • Verify event flowchart
      • Transfer event flowchart
      • Optimize: Flow for Known or Unknown invoice definitions
      • Optimize: Flow for Learned invoice definitions
      • Optimize: Learn fields flow
    • Application events
      • Application events
      • AppCanClose event
      • AppConnect event
      • DisplayField event
      • AppDisconnect event
      • AppEnd event
      • AppError event
      • AppHeartBeat event
      • AppJobHasChangedSave event
      • AppJobLoad event
      • AppJobLoaded event
      • AppPing event
      • AppStart event
      • AppStarted event
      • AppTimer event
      • AppUserLoggedIn event
      • AppUserLogin event
      • InvoiceProfileDeleted event
      • MngrClearDatabase event
      • VeriHandleValidationError event
    • Field events
      • Field events
      • ClassificationFieldInterpreted event
      • ClassificationFieldInterpretedEx event
      • DisplayField event
      • FieldAnalyze event
      • FieldAnalyzed event
      • FieldComplete event
      • FieldInterpreted event
      • FieldTranslate event
      • FieldValidate event
      • FieldValidateError event
      • InvoiceFieldValidationDone event
      • VeriHandleValidationError event
    • Field profile events
      • Field profile events
      • BarcodeInterpreted event
      • FieldProfileEdit event
      • ImageIdentFieldProfileEdit event
      • LineItemFieldProfileEdit event
      • ValueIdentFieldProfileEdit event
      • BarcodeFieldProfileEdit event
    • Field definition events
      • Field definition events
      • FieldDefinitionEdit event
      • IdentifierFieldChanged event
      • InvoiceFieldDefinitionChanged event
    • Invoice events
      • Invoice events
      • InvoiceAdjust event
      • InvoiceAdjusted event
      • InvoiceAfterReadDB event
      • InvoiceApprove event
      • InvoiceApproved event
      • InvoiceArchTransfer event
      • InvoiceArchTransferred event
      • InvoiceBeforeReadDB event
      • InvoiceBuyerChanged
      • InvoiceComplete event
      • InvoiceDeleted event
      • InvoiceFormComplete event
      • InvoiceIdentified event
      • InvoiceIdentify event
      • InvoiceInformation event
      • InvoiceInterpret event
      • InvoiceInterpretationDone event
      • InvoiceInterpreted event
      • InvoicePageRotated()
      • InvoiceReinterpretOnSetLastInvoicePage
      • InvoiceReinterpretQuestion
      • InvoiceReject event
      • InvoiceRejected event
      • InvoiceReroute event
      • InvoiceRerouted event
      • InvoiceReturnedToPageGrouping event
      • InvoiceReturnToPageGrouping event
      • InvoiceSaved event
      • InvoiceScan event
      • InvoiceScanError event
      • InvoiceScanned event
      • InvoiceSkipped event
      • InvoiceSupplierChanged event
      • InvoiceTransfer event
      • InvoiceTransferred event
      • InvoiceTransferSkipUpdateStatistics event
      • InvoiceValidate event
      • InvoiceValidated event
      • InvoiceValidateError event
      • InvoiceVerify event
      • InvoiceWriteToDB event
      • InvoiceWrittenToDB event
      • PrepareTransfer event
    • Invoice profile events
      • Invoice profile events
      • InvoiceProfileChanged event
      • InvoiceProfileDeleted event
      • InvoiceProfileEdit event
      • InvoiceReinterpretOnSetLastInvoicePage
      • InvoiceReinterpretQuestion
      • UpdateInvoiceDefinitions event
    • Invoice definition events
      • Invoice definition events
      • FieldDefinitionEdit event
      • IdentifierFieldChanged event
      • InvoiceDefinitionApproved event
      • InvoiceDefinitionChanged event
      • InvoiceDefinitionDeleted event
      • InvoiceDefinitionEdit event
      • InvoiceDefinitionWriteToDB event
      • InvoiceFieldDefinitionChanged event
      • InvoiceReinterpretOnSetLastInvoicePage
      • InvoiceReinterpretQuestion
      • UpdateInvoiceDefinitions event
    • Batch events
      • Batch events
      • BatchCreatedFromMultiTiff event
      • BatchDeleted events
      • BatchInterpreted events
      • BatchScanned events
      • BatchTransferred events
      • BatchVerified events
    • Job events
      • Job events
      • JobBatchChoice event
      • JobDocumentComplete event
      • JobDocumentRetrieve event
      • JobDocumentError event
      • JobLoad event
      • JobLoaded event
      • JobNoMoreInvoices event
      • JobPaused event
      • JobResumed event
      • JobStart event
      • JobStarted event
      • JobStopped event
      • PageScanned event
      • PageScannedFromMultiTiff event
    • Job description events
      • Job description events
      • AppJobHasChangedSave event
      • JobConfigure event
      • JobDefinitionEdit event
      • JobDefinitionSaved event
    • MngrInvoiceProfileTransDefault event
    • ScanBatchDialogShow event
  • Constants
    • Batch status constants (EiBatchStatus)
    • Field type constants (EIFieldType)
    • Field definition status constants (EIFieldDefinitionStatus)
    • Field placement constants (EIFieldPlacement)
    • Field rotation constants (EIFieldRotation)
    • Field separator constants (EIFieldSeparator)
    • Field status constants (EIFieldStatus)
    • Identifier type constants (EIIdentifierType)
    • Interpret data source constants (EIInterpretDataSource)
    • Invoice definition status constants (EIInvoiceDefinitionStatus)
    • Invoice profile status constants (EIInvoiceProfileStatus)
    • Invoice status constants (EIInvoiceStatusEx)
    • Invoice type constants (EIInvoiceType)
    • Plug-in type constants (EIPluginType)
    • Transaction item type constants (EITransactionItemType)
  • Examples
    • Hello World tutorial
    • Deleting objects using .NET
    • Export images to multi-TIFF format
    • Validation tutorial
    • Work with line item tables, bank account tables, and tax tables
    • InfoString property
    • IdentifierField property
    • Using WordCollection
    • Example of the GetTitleRectBounds and GetValueRectBounds methods
  • OLE API
    • Objects
      • Objects in Tungsten ReadSoft Invoices' OLE API
      • The Application object (OLE)
      • The Definition object (OLE)
      • The Field object (OLE)
      • The Invoice object (OLE)
      • The Job object (OLE)
      • The Profile object (OLE)
      • The Scan, Interpret, Verify, and Transfer Application objects (OLE)
      • The TransactionDefinition object (OLE)
      • The TransactionFieldDefinition object (OLE)
      • SetType(Type As Integer)
    • Constants
      • Statuses
      • Extended statuses (OLE)
    • Examples
      • Creating the ActiveX event server object
      • Creating and registering an external event server object
      • Customization example: Inserting data into a database
      • Saving field information in a Microsoft Access database
      • Setting a COM object as the active server object
      • Setting queues
      • Customization example: Step-by-step implementation
      • Terminating a database connection
      • Connecting Transfer to an outside application
  • Troubleshooting
    • Cannot access all items in the InvoiceTransfer event from the COM API
    • ReadSoft Invoices modules start without their extensions
    • Disabling events
    • Problems iterating through invoices using the COM API
    • Deleting objects using .NET
  • Methods As Objects
    • Methods in Application object
      • CloseApp()
      • Connect(Client As Object) As Integer
      • Definition As Object
      • Disconnect(Client As Object)
      • Field As Object
      • FireEvent(EventName As String)
      • GetAppName() As String
      • GetCurrDBName() As String
      • GetErrorCode() As Long
      • GetErrorType() As Long
      • GetSharedObject(Variable As String, Release As Integer) As Object
      • GetSharedVariable(Variable As String) As String
      • GetUserAccess() As Integer
      • GetUserJobAccess() As Integer
      • GetUserName() As String
      • GetVersion() As String
      • GetWindowsUserName() As String
      • Invoice As Object
      • Job As Object
      • Ping(Client As Object) As Integer
      • PlaySound(WAVFileName As String)
      • Profile As Object
      • ReadTiffTag(FileName As String, PageNo, Tag No, TagType As Integer, TagLen, TagValue As Long) As String
      • SetEventServerObject (EventServer As Object)
      • SetHeartBeat(Client As Object, Interval As Integer) As Integer
      • SetLogDevice(Device As Long)
      • SetLogMask(LogMask As Long)
      • SetReturnValue(ArgNo As Integer, Value As String)
      • SetSharedObject(Variable As String, COMObject As Object)
      • SetSharedVariable(Variable As String, Value As String)
      • SetTimer(Interval As Integer) As Integer
      • SetUserAccess(AccessMode As Integer)
      • SetUserJobAccess(AccessMode As Integer)
      • SetUserName(UserName As String)
      • WriteTiffTag(FileName As String, PageNo, TagType As Integer, TagValue As Long, TagString As String) As Integer
    • Methods in Definition object
      • GetFieldDefNo() As Integer
      • GetProfileName() As String
      • GetStatus() As Integer
    • Methods in Field object
      • GetFieldNo() as Integer
      • GetName() As String
      • GetValueStr() As String
      • IsProposal() As BOOL
      • SetStatus(Status As Integer)
      • SetValueStr(Value As String)
    • Methods in Invoice object
      • GetAppendiceFileNames(Seperator as String) As String
      • GetBundleIndex() As Integer
      • GetBundlePrefix() As String
      • GetBundleValue(Var As String) As String
      • GetField(FieldName As String) As Object
      • GetFirstField() As Object
      • GetNextField() As Object
      • GetNoOfFields() As Integer
      • GetProposalFieldNo(Index As Integer, Proposal As Integer) As Object
      • GetScanDate() As String
      • GetStatus() As Integer
      • SetBundleNo(No As Integer)
      • SetStatus( Status As Integer )
      • SetEndorserString() As String
      • GetBundleDate() As String
      • GetBundleNo() As Integer
      • GetBundleTime() As String
      • GetEndorserString() As String
      • GetFieldNo(Index As Integer) As Object
      • GetImageFile() As String
      • GetNoOfAppendices() As Integer
      • GetProposalField(FieldName As String, Proposal As Integer) As Object
      • GetQueues() as Long
      • GetScanTime() As String
      • GetUserRemark() As String
      • SetQueues(SelectedQueues as Long)
      • SetUserRemark(Remark As String)
    • Methods in Job object
      • GetDataSourceConfiguration() As String
      • GetName() As String
      • GetProfileName() As String
      • SetDataSourceConfiguration() As String
    • Methods in Profile object
      • GetName() As String
      • GetNoOfDefinitions() As Integer
    • Methods in Scan, Interpret, Verify, and Transfer Application objects
      • LoadJob(JobFileName As String) As Integer
      • StartJob() As Integer
      • StopJob() As Integer
    • Methods in TransactionDefinition object
      • GetBatchFileName() As String
      • GetFieldByNo(int FieldNo) As Object
      • GetSeparationChar() As String
      • GetTransFieldNo() As Integer
      • IsCommaSeparated() As Boolean
      • IsOtherSeparated() As Boolean
      • IsSeparated() As Boolean
      • IsTabSeparated() As Boolean
      • SetCommaSeparated(Value As Boolean)
      • SetOtherSeparated(Value As Boolean)
      • SetSeparationChar(SepChar As String)
      • GetFieldByName(BSTR FAR* FieldName) As Object
      • GetFirstField() As Object
      • HasQuotationmark() As Boolean
      • IsCompact() As Boolean
      • SetBatchFileName(FileName As String)
      • SetCompact(Value As Boolean)
      • SetQuotationmark(Value As Boolean)
      • SetTabSeparated(Value As Boolean)
    • Methods in TransactionFieldDefinition object
      • GetFormat() As String
      • GetLength() As Integer
      • GetPadAlways() As Integer
      • GetFillerChar() As String
      • GetValue() As String
      • SetFormat(NewFormat As String)
      • SetLength(Length As Integer)
      • SetPosition(Position As Integer)
      • SetType(Type As Integer)
      • GetIndex() As Integer
      • GetPosition() As Integer
      • GetType() As Integer
      • SetFieldDefNo(FieldNo As Integer)
      • SetIndex(Index As Integer)
      • SetPadAlways(PadAlways As Integer)
      • SetTransFieldNo(FieldNo As Integer)
      • SetValue(NewValue As String)
  • Methods As Integer
    • GetExtStatus() As Integer
    • SetExtStatus( Status As Integer )
    • GetNoOfDefinitions() As Integer
  • Method properties
    • KeyValue property
    • ObjectData property
    • Segment property
    • Configuration property
    • Batches property
    • Count property
    • Item property
    • Buyer property
    • FieldDefinitions property
    • FieldProfiles property
    • Identifiers property
    • Fields property
    • Proposals property
    • InvoiceDefinitions property
    • Pages property
    • Appendices property
    • InvoiceProfiles property
    • Invoices property
    • LearningInvoices property
    • JobDescriptions property
    • BankAccountRows property
    • LineItemRows property
    • LineItemPageNum property
    • VATRows property
    • Plugins property
    • ExistsByTitle property
    • Queues property
    • TransactionDescriptions property
    • ActiveFieldDefinitions property
    • Items property
    • Rows property
    • UserDefinedVariables property
    • UserDefinitions property
    • Buyers property
    • CurrentBatch property
    • CurrentField property
    • CurrentFieldDefinition property
    • CurrentFieldProfile property
    • CurrentInvoice property
    • CurrentInvoiceDefinition property
    • CurrentInvoiceProfile property
    • CurrentJobDescription property
    • CurrentPlugin property
    • CurrentTransactionDescription property
    • CurrentUser property
    • DBIdentifier property
    • DebugLevel property
    • HasFeature property
    • HelpFileName property
    • Info property
    • Name property
    • VersionString property
    • ModuleType property
    • ProcessID property
    • UserInterface property
    • InfoString property
    • Status property
    • BatchNumber property
    • BuyerNumber property
    • InvoiceProfile property
    • Prefix property
    • ScanTime property
    • BuyerID property
    • BuyerName property
    • Description property
    • DocumentInfo property
    • Identification property
    • Originator property
    • Title property
    • ActiveValidation property
    • FirstSideOccurence property
    • FormatString property
    • InvoiceDefinition property
    • LastSideOccurence property
    • Mandatory property
    • Optional property
    • Placement property
    • Rotation property
    • TableType property
    • FieldType property
    • LeadTexts property
    • FormatType property
    • Type property
    • Value property
    • Values property
    • CurrentJob property
    • BarcodeSeparator property
    • ElapsedFocusTime property
    • EndorserString property
    • GUID property
    • InvoiceType property (Invoice object)
    • InvoiceTypeOverride property
    • ProcessMessages property
    • SupplierDescription property
    • SupplierName property
    • SupplierNumber property
    • UserRemark property
    • XMLTransferOutput property
    • DisplayString property
    • FieldTypeName property
    • Invoice property
    • IsProposal property
    • LineItemRowNum property
    • CountryProfileVersion property
    • DefaultTransactionDescription property
    • BatchingEnabled property
    • JobSettingsInterpret property
    • JobSettingsScan property
    • JobSettingsTransfer property
    • JobSettingsVerify property
    • DataSource property
    • DataSourcePlugin property
    • IsDataSourcePlugin property
    • OLEServer property
    • ProgName property
    • EndDate property
    • IdentityRange property
    • Selection property
    • StartDate property
    • UseBatchSelect property
    • UseDateRange property
    • UseVariableSelect property
    • CurrentTransaction property
    • TransactionString property
    • AvailableFieldDefinitions property
    • Compact property
    • PadCharacter property
    • PadAlways property
    • CustomSeparationChar property
    • FieldSeparator property
    • OutputFileName property
    • Quotation property
    • Field property
    • Expression property
    • Format property
    • Definition property
    • Justification property
    • Length property
    • Position property
    • IsMultiLine property
    • Rect property
    • String property
  • Commands
    • Built-in commands in Scan
    • Built-in commands in Interpret and Transfer
    • Built-in commands in Optimize
    • Built-in commands in Verify
    • Built-in commands in Manager
  • References
    • List of APIs using configuration property method
    • List of APIs using KeyValue property
    • List of APIs using Batches collection
    • List of APIs using Count property
    • File
    • Compile
    • Help
    • Maximum size of VBA code
  • Glossary
 ›

The TransactionDefinition object (OLE)

This object is associated with a ReadSoft Invoices transaction description. These methods are available:

  • GetBatchFileName
  • GetFieldByNo
  • GetName
  • GetSeparationChar
  • GetTransFieldNo
  • IsCommaSeparated
  • IsOtherSeparated
  • IsSeparated
  • IsTabSeparated
  • SetCommaSeparated
  • SetOtherSeparated
  • SetSeparationChar
  • GetFieldByName
  • GetFirstField
  • GetNextField
  • HasQuotationmark
  • IsCompact
  • SetBatchFileName
  • SetCompact
  • SetQuotationmark
  • SetTabSeparated

Search resultsSearch tips

×

Search tips

The search returns topics that contain terms you enter. If you type more than one term, an OR is assumed, which returns topics where any of the terms are found. Enclose your search terms in quotes for exact-phrase matching.

The search also uses fuzzy matching to account for partial words (such as install and installs). The results appear in order of relevance, based on how many search terms occur per topic. Exact matches are highlighted.

To refine the search, you can use the following operators:

  • Type + in front of words that must be included in the search or - in front of words to exclude. (Example: user +shortcut –group finds shortcut and user shortcut, but not group or user group.)
  • Use * as a wildcard for missing characters. The wildcard can be used anywhere in a search term. (Example: inst* finds installation and instructions.)
  • Type title: at the beginning of the search phrase to look only for topic titles. (Example: title:configuration finds the topic titled “Changing the software configuration.”)
  • For multi-term searches, you can specify a priority for terms in your search. Follow the term with ^ and a positive number that indicates the weight given that term. A higher number indicates more weight. (Example: shortcut^10 group gives shortcut 10 times the weight as group.)
  • To use fuzzy searching to account for misspellings, follow the term with ~ and a positive number for the number of corrections to be made. (Example: port~1 matches fort, post, or potr, and other instances where one correction leads to a match.)

Note that operators cannot be used as search terms: + - * : ~ ^ ' "