Skip to main content
Skip table of contents

TechnologyOne Financials CiA

This integration provides Accounts Payable query and upload functionality for TechnologyOne Ci Anywhere (CiA). Both the Data Model and Business View APIs are supported for querying data, and optionally ITP API for invoice uploads.

Configuration

It is assumed that TechnolgyOne has configured the respective Data Model or Business View API endpoints in your CiA environment, and provided the respective connection details. If not, please reach out to your TechnologyOne project manager before proceeding.

Option

Description

Service URL

The base address of the CiA environment.
For example:
https://xxx.t1cloud.com/T1Default/CiAnywhere/Web/XXX/

Connection Type

Select the API that has been configured in CiA:

  • Data Model

  • Business View

Business View is provided for backward compatibility for existing installs only. Data Model must be used for all new installs.

Company Region

Select the region of the company. This will be used to localise naming of properties in the user interface.

Options are:

  • AU - Australia

  • NZ - New Zealand

  • UK - United Kingdom

Authentication Type

Select the authentication type:

  • OAuth - OAuth 2.0 Client Credential flow

  • Login - Basic credentials

Login is provided for backward compatibility for existing installs only. OAuth must be used for all new installs.

OAuth Authentication

Option

Description

Client ID

Client ID of the OAuth application registered in CiA.

Client Secret

Client Secret of the OAuth application registered in CiA.

User ID

Not applicable.

Password

Not applicable.

Login Authentication

Option

Description

User ID

The username of the CiA user to authenticate as.

Password

The password of the CiA user to authenticate as.

Client ID

Not applicable.

Client Secret

Not applicable.

Upload Functions

The following functions are available via the Integration Upload stage on both DFA and RIA pages. Select the TechnologyOne Financials CiA integration and then the desired function from the Action dropdown.

Import AP Invoice

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

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

Upload Settings

Option

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 to apply.

This should be none so that validation can be handled directly within CiA rather than failing invoice uploads.

Attach Document

Include document as attachment.

Document File Document Type

The document file document type that was provided by T1, or leave blank to omit. This is typically APINV.

Document Fields

The following built-in upload fields will populate the document entry.

Target Field

Description

Title

Required. The type of document to be upload.

Usually Invoice or Credit Note

DocumentReference1

The invoice number.

DocumentReference2

Secondary invoice reference.

DocumentDate1

The invoice date formatted as yyyy-MM-dd

DocumentId

The unique document identifier.

For example, C0000345

DocumentType

The document type to apply.

Defaults to APINV.

ExternalDocumentTypeCode

The external document type code to apply.

Defaults to APINV.

Additional Document Fields

The built-in fields only provides a small subset of the document fields that can be passed to the ITP web service. Additional document fields can be added as required using the [+] button at the bottom of the upload fields grid. Change the Target Field value to match the document field name, and the Type to the respective data type.

Available data types are:

  • Date - a date formatted as yyyy-MM-dd

  • Decimal - a number with optional decimal places (e.g. 100.45)

  • Integer - a whole number without decimal places (e.g. 12)

  • String - plain text

  • Time - a time formatted as HH:mm:ss

Here are some of the additional document fields supported by the ITP web service:

  • BankCode

  • BankAccountName

  • BankAccountNumber

  • SystemCiAPurchasingSystemCode

  • SystemCiAPurchaseOrderNumber

  • SystemCiAGoodsReceiptNumber

Document Lines

One or more document lines are required to upload an invoice or credit note. These will be included in the document entry when the DocumentLines and child field sets are enabled (disabled field sets will be ignored).

To see configured document lines navigate into the DocumentLines field set using the -> button.

image-20240912-002737.png

There is a built-in Line[1] document line in this view. This is provided for convenience to populate the first document line however can be left as disabled if not wanted.

To add a new document line:

  1. Click on the add button [+] at the bottom of the current view.

  2. Select the DocumentLine option.

    image-20240912-002926.png
  3. Enter a name into the Target Field column to differentiate it from other lines.

  4. Enable the field set so it will be emitted when uploading.

Source Mapping

Document line field sets can be populated either statically or dynamically:

image-20240912-012727.png
  • Static - The line has no source column mapping. This will produce a single line entry and is useful for uploads a fixed number of lines are needed.

    Fields configured within the document line can be populated using hardcoded values, or document placeholder mappings (e.g. {{metadata["description"]}}).

  • Dynamic - The line has grid field placeholder mapping as its source (e.g. {{metadata["invoice_lines"]}}). This will emit a line for each row of the respective grid field when uploading.

    For example: if the grid field has 2 rows, then 2 document lines will be emitted; if the grid field has 0 rows, then no document lines will be emitted.

    Fields configured within the document line can be populated using hardcoded values, property placeholders for respective row (e.g. {{property("description")}}) , or document placeholder mappings (e.g. {{metadata["description"]}}).

Built-in Fields

The following fields are built-in to the DocumentLine field set.

image-20240912-012952.png

Target Field

Description

LineSequenceNumber

The line sequence number starting at 1. Leave blank to auto increment.

LedgerCode

The ledger code. For example, AP.

AccountNumberInternal

The supplier account number. For example, 10644.

Amount1

The line amount.

VatType

I for inclusive, E for exclusive.

VatRateCode

The tax rate code. For example, C.

DocumentLineNarration1

Line description.

DocumentLineNarration2

UserField1

UserField2

UserField3

Additional Fields

Additional fields can be added as required using the [+] button at the bottom of the upload fields grid. Change the Target Field value to match the line field name, and the Type to the respective data type.

Available data types are:

  • Date - a date formatted as yyyy-MM-dd

  • Decimal - a number with optional decimal places (e.g. 100.45)

  • Integer - a whole number without decimal places (e.g. 12)

  • String - plain text

  • Time - a time formatted as HH:mm:ss

Here are some of the additional line fields supported by the ITP web service:

  • DueDate

  • DiscountAmount1

  • DiscountDate

  • AssetNumber

  • AssetDescription

  • ItemType

  • ItemCode

Order Matches

One or more order matches can included with the document entry.

To see configured document lines navigate into the OrderMatches field set using the -> button.

image-20240912-013417.png

To add a new order match item:

  1. Click on the add button [+] at the bottom of the current view.

  2. Select the OrderMatch option.

    image-20240912-013835.png
  3. Enter a name into the Target Field column to differentiate it from other items.

  4. Enable the field set so it will be emitted when uploading.

Order Match Fields

Fields can be added as required using the [+] button. The ITP web service supports the following properties and respective data types.

Target 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

 

Available data types are:

  • Date - a date formatted as yyyy-MM-dd

  • Decimal - a number with optional decimal places (e.g. 100.45)

  • Integer - a whole number without decimal places (e.g. 12)

  • String - plain text

  • Time - a time formatted as HH:mm:ss

Batch

Add properties at the root of the ITP web service request.

Some of the available properties include:

Option

Description

DocumentFileDate

Invoice tax point date.

DocumentFilePeriod

Fiscal period generated from the tax point date.

CalendarName

Name of calendar.

ProcessingGroupName

Name of processing group.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.