EzeScan Desktop/Server
EzeScan Desktop/Server
Breadcrumbs

TechnologyOne Financials CiA

KFI Providers:

The action providers follow a typical structure for searching for various item types.

Filter Expression

In the image below, the red area shows settings related to the Filter Expression which is used perform searches beyond what is provided in the search field settings.

image-20230404-015028.png

The fields that can be searched can be determined by browsing either the Display Value Format and Output Value Format settings.

The Filter Expression follows the format of:

{FieldName} operator {SearchValue}

Placeholders can also be used in this setting. A typical example would be:

{FieldName} operator {<<F1>>}

The supported Search operators are:

Search Operator

Search symbol

Equals

eq

=

==

Not Equals

neq

<>

!=

Contains

contains

Starts With

startswith

Ends With

endswith

The Filter Expression can also use search condition groupings, such as:

Search Grouping

Example

And

{FieldName1} operator {SearchValue1} and {FieldName2} operator {SearchValue2}

Or

{FieldName1} operator {SearchValue1} or {FieldName2} operator {SearchValue2}

The “Use the Filter Epxression in the Search Window” checkbox makes searches in the done Search Window combine with the Filter Expression. This allows for greater search flexibility.

Search Fields

In the image below, the red area shows search fields which can be preconfigured to perform an equals search during the search.

image-20230404-014719.png

These fields vary for each Search type.


image-20230403-235940.png
image-20230403-235947.png
image-20230403-235954.png

Search Component Charts

This action type supports displaying and searching the following Component Chart fields:

  • Account

  • AccountName

  • AccountName2

  • ChartName

  • DataEntryStatusCode

  • ShortName

Search Contracts

This action type supports displaying and searching the following Contract fields:

  • AmountExclusive

  • AmountInclusive

  • ContractNumber

  • ContractSystem

  • Description

  • Narration

  • PaymentTerms Added: 5.0.114

  • StatusCode

  • StatusDescription

Search Contract Claims

Added: 5.0.113

This action type supports displaying and searching the following Contract Claim fields:

  • ClaimAmountExclusive

  • ClaimAmountInclusive

  • ClaimDate

  • ClaimDescription

  • ClaimNumber

  • ClaimReference

  • ContractNumber

  • ContractSystem

  • StatusDescription

Search Contract Parties

Added: 5.0.113

This action type supports displaying and searching the following Contract Party fields:

  • ContractNumber

  • ContractSystem

  • Description

  • MoreInformation

  • Party

  • PartySystem

  • StatusCode

  • StatusDescription

  • SupplierAccountInternal

  • SupplierLedgerCode

Search Purchase Order Dissections

Added: 5.0.127

This action type supports displaying and searching the following Purchase Order Dissection fields:

  • AccountNumber

  • AmountExclusive

  • AmountInclusive

  • FundAccountNumber

  • FundLedgerName

  • GstAmount

  • GstCode

  • LedgerCode

  • LedgerName

  • LineNumber

  • OrderNumber

  • PurchaseSystem

  • ResourceCode

  • ResourceGroup

Search Selection Codes

This action type supports displaying and searching the following Selection Code fields:

  • SelectionType

  • SelectionCode

  • StatusCode

  • ShortDescription

  • Description

  • Narration1

  • Narration2

  • Narration3

  • UserField1

  • UserField2

  • UserField3

  • UserField4

  • UserField5

  • UserField6

  • UserField7

  • UserField8

  • UserField9

  • UserField10

  • UserField11

  • UserField12

  • UserField13

  • UserField14

  • UserField15

  • UserField16

  • UserField17

  • UserField18

  • UserField19

  • UserField20

Search Suppliers

This action type supports supports displaying and searching the following Supplier fields:

  • AccountNumberInternal

  • AccountType

  • Address1

  • Address2

  • Address3

  • AddressConcat

  • BankAccount

  • BankName

  • BsbCode

  • BusinessRegisterNumber

  • BusinessRegisterNumber2

  • CertificateNumber

  • ChartName

  • ChartType

  • City

  • CountryCode

  • DefaultAccount

  • DefaultLedgerCode

  • Description

  • EftReferenceCode

  • EmailAddress

  • EntryOption

  • EntryOptionCode

  • PayAccount

  • PaymentMethodCode

  • PostCode

  • SelectionType10Code

  • SelectionType11Code

  • SelectionType12Code

  • SelectionType13Code

  • SelectionType14Code

  • SelectionType15Code

  • SelectionType16Code

  • SelectionType17Code

  • SelectionType18Code

  • SelectionType19Code

  • SelectionType1Code

  • SelectionType20Code

  • SelectionType21Code

  • SelectionType22Code

  • SelectionType23Code

  • SelectionType24Code

  • SelectionType25Code

  • SelectionType26Code

  • SelectionType27Code

  • SelectionType28Code

  • SelectionType29Code

  • SelectionType2Code

  • SelectionType30Code

  • SelectionType31Code

  • SelectionType32Code

  • SelectionType33Code

  • SelectionType34Code

  • SelectionType35Code

  • SelectionType36Code

  • SelectionType37Code

  • SelectionType38Code

  • SelectionType39Code

  • SelectionType3Code

  • SelectionType40Code

  • SelectionType4Code

  • SelectionType5Code

  • SelectionType6Code

  • SelectionType7Code

  • SelectionType8Code

  • SelectionType9Code

  • StatementDay

  • Status

  • TermsDays

  • UserDateTime1

  • UserDateTime10

  • UserDateTime2

  • UserDateTime3

  • UserDateTime4

  • UserDateTime5

  • UserDateTime6

  • UserDateTime7

  • UserDateTime8

  • UserDateTime9

  • UserField1

  • UserField10

  • UserField2

  • UserField3

  • UserField4

  • UserField5

  • UserField6

  • UserField7

  • UserField8

  • UserField9

  • UserNumber1

  • UserNumber10

  • UserNumber2

  • UserNumber3

  • UserNumber4

  • UserNumber5

  • UserNumber6

  • UserNumber7

  • UserNumber8

  • UserNumber9

  • VatRateCodeDef

Search Tasks

Added: 5.0.127

This action type supports displaying and searching the following Task fields:

  • Description

  • EditedTaskNumber

  • Narration

  • PercentComplete

  • StageCode

  • StageDescription

  • Status

  • StatusDescription

  • TaskNumber

  • TypeCode

  • TypeDescription

  • WorkSystem

Search Users

This action type supports displaying and searching the following User fields:

  • AccountDisabled

  • Email

  • FamilyName

  • GivenName

  • Portal

  • UserId

Validation Functions

Validate Account Number By Ledger Name

Added: 5.1.0

Validate an account number is valid for the given ledger name.

Option

Description

Account Number

Required. The account number to be validated (for example, 123.1234.12345). Use a field placeholder such as <<F1>> to pass through the value from KFI.

Ledger Name

Required. The name of the ledger to validate against (for example, 25GLA).

Import AP Invoice

This upload action allows an invoice entry and optional attachment to be uploaded to the server for document import.

Requires TechnologyOne CiA version 2023B (or higher) and ITP module must be licensed.

Upload Settings

Name

Description

Source Identifier

The source identifier (Guid) that was provided by T1. This is unique to each environment.

Source Identifier Reference

The source identifier reference that was provided by T1.

This is typically EzeScan.

Validation Type

The validation type that was provided by T1.

Attach Document

Check to include the document as attachment when importing invoice or credit note.

Document Fields

The following properties can be populated on the document entry by adding a field with the respective name and type. Some of these are already built in for convenience (such as DocumentId and DocumentDate1).

Field Name

Field Type

Description

CiAGoodsReceiptReference

String


CiAPuchaseOrderReference

String


DocumentDate1

Date

Invoice date.

Use ISO date format yyyy-MM-dd to ensure date can be reliably parsed regardless of the current user’s locale.

DocumentDate2

Date


DocumentDate3

Date


DocumentDate4

Date


DocumentId

String

The unique document identifier.

DocumentReference1

String

Supplier invoice number.

DocumentReference2

String


DocumentReference3

String


SystemCiAGoodsReceiptNumber

String


SystemCiAPurchaseOrderNumber

String


SystemCiAPurchasingSystemCode

String


Title

String

The entry format.

For example, Tax Invoice or Credit Note.

Document Lines Fields

The below properties can be populated on each document line.

Field names should be formatted as Line[{LineNo}]:{Property} where:

  • {LineNo} is the line number (starting at 1); and

  • {Property} is the name of the property to be populated on the respective line.

A number of these properties are already included as built-in fields for line 1 (e.g. Line[1]:LedgerCode). You can set the source field to (ignored) if the respective property is not needed.

Field Name

Field Type

Description

AccountNumberExternal

String


AccountNumberInternal

String

The supplier account number. For example, 10644.

Amount1

Decimal

The line amount.

Amount2

Decimal


Amount3

Decimal


Amount4

Decimal


DiscountAmount1

Decimal


DiscountAmount2

Decimal


DiscountCurrencyAmount

Decimal


DiscountDate

Date


DocumentLineNarration1

String

Line description.

DocumentLineNarration2

String


DocumentLineNarration3

String


DueDate

Date


ItemCode

String


ItemRateAmount

Decimal


ItemType

String


LedgerCode

String

The ledger code. For example, AP.

LineSequenceNumber

Integer

The line sequence number starting at 1, and should increment for each line.

UserField1

String


UserField10

String


UserField2

String


UserField3

String


UserField4

String


UserField5

String


UserField6

String


UserField7

String


UserField8

String


UserField9

String


VatAmount

Decimal


VateRateAmount

Decimal


VatRateCode

String

The tax rate code. For example, C.

VatType

String

I for inclusive, E for exclusive.

Order Matches Fields

Available in version 5.0.112 and higher.

The below properties can be populated on each order match item.

Field names should be formatted as OrderMatches[{LineNo}]:{Property} where:

  • {LineNo} is the order match line number (starting at 1); and

  • {Property} is the name of the property to be populated on the respective line.

Field Name

Field Type

Description

CiAGoodsReceiptReference

String


CiAPurchaseOrderReference

String


OrderLineAdditionalCostExclusiveAmount

Decimal


OrderLineAdditionalCostInclusiveAmount

Decimal


OrderLineDetailsLine1

String


OrderLineDetailsLine2

String


OrderLineInvoiceExclusiveAmount

Decimal


OrderLineInvoiceInclusiveAmount

Decimal


SystemCiAGoodsReceiptNumber

String

The goods receipt number. For example, GR060197

SystemCiAPurchaseOrderNumber

String

The purchase order number. For example, PU022147

SystemCiAPurchasingSystemCode

String