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. |
Connection Type | Select the API that has been configured in CiA:
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:
|
Authentication Type | Select the authentication type:
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 |
Validation Type | The validation type to apply. This should be |
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 |
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 |
DocumentReference1 | The invoice number. |
DocumentReference2 | Secondary invoice reference. |
DocumentDate1 | The invoice date formatted as |
DocumentId | The unique document identifier. For example, |
DocumentType | The document type to apply. Defaults to |
ExternalDocumentTypeCode | The external document type code to apply. Defaults to |
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 asyyyy-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 textTime
- a time formatted asHH: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.
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:
Click on the add button
[+]
at the bottom of the current view.Select the
DocumentLine
option.Enter a name into the Target Field column to differentiate it from other lines.
Enable the field set so it will be emitted when uploading.
Source Mapping
Document line field sets can be populated either statically or dynamically:
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.
Target Field | Description |
---|---|
LineSequenceNumber | The line sequence number starting at 1. Leave blank to auto increment. |
LedgerCode | The ledger code. For example, |
AccountNumberInternal | The supplier account number. For example, |
Amount1 | The line amount. |
VatType |
|
VatRateCode | The tax rate code. For example, |
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 asyyyy-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 textTime
- a time formatted asHH: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.
To add a new order match item:
Click on the add button
[+]
at the bottom of the current view.Select the
OrderMatch
option.Enter a name into the Target Field column to differentiate it from other items.
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, |
SystemCiAPurchaseOrderNumber | String | The purchase order number. For example, |
SystemCiAPurchasingSystemCode | String |
|
Available data types are:
Date
- a date formatted asyyyy-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 textTime
- a time formatted asHH: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. |