Configuring third-parties interfaces from the Administration console

The configuration parameters for CHORUS PRO are used to automatically transfer the dematerialized invoices generated by Akuiteo to the CHORUS PRO portal. It makes it possible to generate and then automatically transfer dematerialized invoices from the Desktop Application, without having to use an external tool or to transfer the invoices manually.

The automatic transfer of dematerialized invoices is set up from the Administration Console, from the menu Third-party interfaces > Dematerialization.

Notes

For SaaS customers, the setup of the Administration console is done by Akuiteo.

Reference

The login information to CHORUS PRO must be specified from the setup of the Desktop Application to enable you to use different CHORUS PRO accounts depending on each company. For more information, refer to Setting up the login information per company.

1 Fill in the following fields to configure the connection to CHORUS PRO:
Field Description
Chorus Active Check this box to activate the connection to CHORUS PRO.
Chorus Authentication URL

Specify the URL to authenticate to CHORUS PRO:
URL

Specify the URL to connect to CHORUS PRO:
2 Fill in the following fields to configure the interface between Akuiteo and CHORUS PRO:
Field Description
Akuiteo user Specify the login of the Akuiteo's technical user.
Akuiteo user's password Specify the password associated with the Akuiteo login.
Akuiteo user's company code Specify the code of the company used for connection.
Number of successive test runs in case of an error

The number of successive test runs enables to specify, in case of an error when transferring dematerialized invoices, the number of times that Akuiteo will re-run the transfer.

By default, Akuiteo performs 3 successive test runs in case of an error.
Time period in seconds between two successive test runs

The time period between two successive test runs enables to specify, in seconds, the waiting period before another transfer is attempted in case of an error.

By default, Akuiteo waits 10 seconds between two successive test runs
Maximum number of calls to Chorus per second

Specify a maximum number of simultaneous calls to CHORUS PRO per second.

By default, there is a maximum of 20 calls per second. For a test environment, the number must be set on maximum 1 call per second.

Note

The CHORUS PRO portal has quotas for transferring dematerialized invoices:

  • On the test environment: 5 queries per second with a maximum of 50,000 queries per day
  • On the production environment: 20 queries per second with a maximum of 1 million queries per day

When these quotas are reached, the invoices can no longer be transferred. You should adapt the values in the Number of successive test runs in case of an error and Time period in seconds between two successive test runs fields if you regularly have errors when transferring invoices.

3 Click on Save for each field that is filled in or modified to take into account the value specified.

OCR (Optical Character Recognition) is a technology used to convert different types of documents, such as scanned paper documents, PDF files or numeric photos, into modifiable and searchable files. An OCR software is able to recognize letters included in images, and to build entire words or sentences with these letters.

Akuiteo integrates an OCR feature to simplify the process of adding expenses to an expense report from the Web Portal and the Akuiteo Mobile application. When a receipt is photographed, the characters are automatically recognized and are then added in the expense's relevant fields.

OCR is configured from the Administration console, from the Configuration > OCR menu.

1 In the OCR configuration screen, select OCR_MINDEE from the drop-down list of the provider field.
2 Fill in the following fields to configure OCR:
Field Description
OCR enabled Check this box to globally enable OCR.
Mindee enabled Check this box to enable the Mindee OCR on the Web Portal and the Akuiteo Mobile application.
Mindee rest url Specify the URL to connect to the web service, provided by Akuiteo.
Mindee Token Fill in the token provided by Akuiteo to access the web service.
Akuiteo user

Fill in the Akuiteo login to connect to the web service.

This user is used to differentiate expenses generated with OCR from the ones manually added by employees. When an expense is generated with OCR, the Akuiteo user is specified in the expense's history.
Akuiteo password Fill in the password associated with the Akuiteo login.
3 Click on Save for each field that is filled in or modified to take into account the value specified.
4 Click on the Test button to test the connection to Mindee's OCR interface using the values specified.

The SIRENE API is used to automatically fill in information when creating a prospect, a customer or a supplier thanks to the specified SIRET or SIREN number. If the SIRET or SIREN number specified is known by the SIRENE API, the relevant fields (such as the call name or the address) will be filled in automatically.

The Java Runtime Environment (JRE) has a configuration file (keystore) that includes root certificates from the different renowned certification authorities. When a connection is established to another system using https, this list of certificates is used to validate the secured connection.

Some certification authorities are not included in the file provided by default with the JRE, so they must be added manually. In the SIRENE API's context, you must add the Certigna certificate to certify connections.

Note

For SaaS customers, this certificate is added by Akuiteo.

Identifying the JRE's location

1 Connect to the server that hosts the Akuiteo environment.
2 Launch the Tomcat Manager for that environment.
3 From the Java tab, take note of the location of the JRE used by Tomcat.

Retrieving the Certigna's Racine certificate

1 Go to the Certigna's website: https://www.certigna.com/autorite-crl.
2 Download the Certigna's authority certificate: certigna.der.

Importing the certificate into the JRE's keystore

1 Launch the command prompt as an administrator.
2 Launch the following command:

"[JRE_LOCATION]\bin\keytool.exe" -import -alias "certigna" -keystore "[JRE_LOCATION]\lib\security\cacerts" -trustcacerts -file "[CERTIFICATE_LOCATION]\certigna.der" -storepass changeit

In this command, you must replace:

  • [JRE_LOCATION] with the location of the JRE used by Tomcat
  • [CERTIFICATE_LOCATION] with the location of the certigna.der certificate downloaded.

Example

"C:\Program Files\Java\jdk1.8.0_22\jre\bin\keytool.exe" -import -alias "certigna" -keystore "C:\Program Files\Java\jdk1.8.0_22\jre\lib\security\cacerts" -trustcacerts -file "C:\Users\XXX\Documents\certigna.der" -storepass changeit

3 Restart the Tomcat server of the targeted Akuiteo environment to take into account the new certificate.

The connection to the SIRENE API is configured from the Administration console, from the Configuration > API Sirene menu.

1 Fill in the following fields to configure the connection:
Field Description
SIRENE API use Check the box to use the SIRENE API.
Token for SIRENE API

Specify the token generated from https://portail-api.insee.fr/.

To manually retrieve that token:

  1. As an administrator, create an account on portail-api.insee.fr.
  2. Enable the Sirene API for the application (Akuiteo).
  3. Generate a token for that application.

Reference

For more information about the new portal and the generation of the token, refer to the official documentation about connecting to the SIRENE API.
2 Click on Save for each field that is filled in or modified to take into account the value specified.
3 Click on the Test button to test the connection to the SIRENE API using the values specified.

The connection parameters to the Exchange server are used to synchronize schedules or appointments from Akuiteo into a Microsoft Outlook calendar.

The connection to the Exchange server is configured in the Administration console, from the Third-party interfaces > Exchange menu.

1 Fill in the following fields to configure the connection to the Exchange server:
Field Description
Delegated user

Fill in the login of the Exchange user to connect to the server.

If you are using Exchange 365, this user must have a delegation to have complete access over other user accounts.
Linked password Specify the password associated with the login of the Exchange user.
EWS service URL

Fill in the URL to connect to the Exchange server.

Example

https://outlook.office365.com/EWS/exchange.asmx
Exchange server version Select the Exchange server version from the drop-down list.
Maximum number of threads for synchronizing Specify a maximum number for simultaneous synchronizations.
Use impersonation

If you are using Exchange 365, check this box. Office 365 enforces a limit on the number of web service calls a given user can make. Impersonation is used to assign a role to an Exchange user and bypass this limit.

To be able to use impersonation, you must:

Delete all account delegations for the Exchange technical user

1. Download and install PowerShell.

2. From PowerShell, run the following command lines:

$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic –AllowRedirection This command establishes a connection to the Exchange server. The administrator's login and password are required.
Import-PSSession $Session This command gathers the commands needed to delete delegations.
foreach ($mailbox in Get-Mailbox) { Remove-MailboxPermission $mailbox.PrimarySmtpAddress -user user@domain -Accessright FullAccess -Confirm: $false}

Replace user@domain with the login of the current Akuiteo technical user who owns the delegation right.

This command deletes the delegation role for all users.

Give the impersonation right to the Exchange technical user

1. Connect to the Exchange Admin Center from the Office 365 portal.

2. Go to the Permissions > Admin Roles menu.

3. Create a new role by filling the following information:

  • Name: Application Impersonation
  • Assigned roles: Add the ApplicationImpersonation, Legal Hold and Mailbox Search roles
  • Members: Add the current Akuiteo technical user
Test user Specify an existing email address to make sure that Akuiteo can access the corresponding account using the impersonation.
Use OAUTH authentication (Exchange 365 only)

Enable or disable OAUTH authentication to connect to Exchange.

This option must be enabled if Exchange 365 is used by Akuiteo in your organization. Otherwise, it must be disabled.
Use Graph API Library

Check this box if you use the Microsoft Graph API.

For more information about Microsoft graph configuration, refer to Configuration for Microsoft Graph.
Tenant ID

This field must be entered if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled.

Enter the tenant ID provided by Microsoft for the OAUTH authentication.
Client ID

This field must be entered if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled.

Enter the client ID for the OAUTH authentication.
Client Secret

This field must be entered if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled.

Enter the client secret for the OAUTH authentication.
2 Click on Save for each field that is filled in or modified to take into account the value specified.
3 Click on the Test button to test the connection to the Exchange interface using the values specified.

Accessing the Azure portal

1 In a web browser, enter the following address https://portal.azure.com/ and log in as an administrator.
2 In the home page, click on Microsoft Entra ID.

Registering Akuiteo in the Azure AD's directory

1 Click on App registrations from the left menu, then click on New registration.
2 Give a Name to this new registration (for example Akuiteo Microsoft Graph Exchange) and leave the Accounts in this organizational directory only (XXX only - Single tenant) option checked. Click on Register.

The app page is displayed.

3 Copy the following information:
  • Application ID (customer)
  • Directory ID (tenant)

To do so, hover over each field then click on the icon that enables you to copy the information to the clipboard. Keep this information in a separate document.

Creating a "client secret" to identify the Akuiteo server

1 Click on Certificates & secrets from the left menu, then click on New client secret.
2 Enter a Description ( Secret client Akuiteo for example) then select an Expiration date for the key, depending on your security policy. Click on Add.

Important

When the expiration date is reached, you must create a new "client secret".

3 Hover over the Value field then click on the button to copy the information to the clipboard. Keep this information in a separate document.

Important

You must copy these values right after creating the client secret because the information will not be accessible afterward and you must generate a new client secret.

Requesting API permissions

1 From the API permissions menu, click on Add an authorization then on Microsoft Graph API.
2 Click on Application permissions.
3 From the authorizations list, check the Calendars.ReadWrite authorization then click on the Add authorizations button.
4 From the Configured permissions page, click on the Grant admin consent for XXX button, then click on Yes to confirm.

Configuring the Administration console in Akuiteo

In the Administration console, from Third-party interfaces > Exchange, specify the required information (see Configuring the connection to the Exchange server).

The configuration parameters of the Universign APIs are used for signing quotations and sales delivery notes electronically. Using these APIs makes it possible to send quotations and delivery notes out for electronic signature directly from the Desktop Application, without having to use an additional interface.

The electronic signature is configured from the Administration console, from the Third-party Interfaces > Electronic signature menu.

1 Fill in the following fields to configure the electronic signature:
Field Description
Enable electronic signature Check this box to enable the electronic signature.
Universign URL Specify the URL provided by Akuiteo to connect to the Universign APIs.
Universign user Fill in the login of the Universign user, provided by Akuiteo.
Universign password Specify the password associated with the login of the Universign user, provided by Akuiteo.
Akuiteo user

Specify the login of the Akuiteo technical user used to connect to the APIs.
Akuiteo password Specify the password associated with the login of the Akuiteo technical user.
Time range for retrieving signatures

A scheduled task is executed as a background task to search for signature statuses (whether the recipients for electronic signing have signed or not) and, once all signatures have been made, to retrieve the signed documents.

The time range for retrieving signatures is used to define, in seconds, the time range for executing this scheduled task.

By default, the task is executed every 21600 seconds, that is to say every 6 hours.

Note

It is not recommended to specify a small time range so as to not overload the calls.
Start period

The start period is used to define, in seconds, the time before executing the first scheduled task after the Akuiteo server has been launched.

By default, the task is executed for the first time 20 seconds after the server is launched.
2 Click on Save for each field that is filled in or modified to take into account the value specified.
3 Click on the Test button to test the connection to the Universign APIs using the values specified.

Configuration parameters for Akuiteo Connect are used to connect to the Bridge connector in order to automatically and securely retrieve bank transactions in Akuiteo. The Bridge connection makes it possible to retrieve bank transactions directly from your bank, without having to manually import bank statement files.

The connection to Akuiteo Connect is configured from the Administration Console, from the Third-party interfaces > Akuiteo Connect menu.

Important

First, Akuiteo must set up the login information of your Bridge account in order for you to activate and configure Akuiteo Connect.

Configuring the connection to Akuiteo Connect

1 In the Akuiteo Connect section, fill in the following fields to configure the connection:
Field Description
Activate Akuiteo Connect Check this box to activate the connection to Akuiteo Connect.
Akuiteo user Specify the login of the Akuiteo's technical user. This user will be used to create new statements from retrieved bank transactions.
Akuiteo password Specify the password associated with the Akuiteo login.
Email Enter the email address to which execution logs of the scheduled task will be sent.
Time range for retrieving statements

A scheduled task is executed as a batch process to retrieve transactions from the connected bank accounts. The transactions are stored in an intermediate table until a statement is generated.

The time range for retrieving statements is used to define, in seconds, the time range for executing this scheduled task.

By default, the task is executed every 21,600 seconds.

Note

It is not recommended to specify a small time range so as to not overload the calls.
Start period (20s by default)

The start period is used to define, in seconds, the time before executing the first scheduled task after the Akuiteo server has been launched.

By default, the task is executed for the first time 20 seconds after the server is launched.
2 Click on Save for each field that is filled in or modified to take into account the value specified.
3 Click on the Test button to test the connection to Akuiteo Connect using the values specified.

Adding a Bridge user

Note

You can only add one Bridge user. Indeed, an Akuiteo customer is associated with only one Bridge account/user.

The user of the account created from Bridge must be added to the Administration console to link the bank accounts associated with that Bridge user in Akuiteo. This Bridge user is namely linked to the bank accounts of all the companies; however, access to these bank accounts remains subject to the authentication of each account's owner.

1 In the Bridge user section, click on New Bridge user.
2 In the window, fill in the Name, Email and Password used to create the Bridge account.
3 Click on Create.

The Bridge user is added to the Administration console.

To modify the user's information, click on , modify the desired information then click on Update.

To delete the user, delete all the associated banks then click on and confirm the deletion.

The connection to the Gmail server must be configured in order to use Gmail as email application on Akuiteo.

Important

The GOOGLE_MAIL management rule must be enabled.

Gmail must be the email application selected from the Akuiteo preferences (see Office automation).

The connection to the Gmail server is configured in the Administration console, from the Third-party interfaces > Gmail configuration menu.

1 Specify the location of the Gmail credential key provided by Google from https://console.cloud.google.com/.

Ex: c:/keys/gmail.json

2 Click on Save to take into account the specified value.

Important

In order to use the Google APIs, please contact your Akuiteo project manager.

Google APIs are used to make entering the number of kilometers when creating expenses in expense reports on the new Web Portal and Akuiteo Mobile.

The following APIs are available:

  • Place Autocomplete which is used to specify a departure address and an arrival address from a free input.
  • Distance Matrix which allows you to quickly calculate the number of kilometers depending on the departure and arrival addresses specified beforehand.

Important

Place Autocomplete can be used without enabling Distance Matrix. However, Distance Matrix cannot be used alone and requires enabling Place Autocomplete.

Google APIs are configured in the Administration console, from the Third-party interfaces > Google API menu.

Specify the following information to configure the Place Autocomplete API :

Field Description
Enable Place Autocomplete API

Check this box to enable the Google Place Autocomplete API.
Place Autocomplete API Key

Specify the Place Autocomplete API Key.

The API key is provided by Google from https://console.cloud.google.com/.

Click on Save for each field specified or modified.

To test your connection to the Place Autocomplete API with the specified values, click on the Test button.

Specify the following information to configure the Distance Matrix API :

Field Description
Enable Distance Matrix API

Check this box to enable the Distance Matrix API.
Distance Matrix API Key

Specify the Distance Matrix API Key.

The API key is provided by Google from https://console.cloud.google.com/.

Click on Save for each field specified or modified.

To test your connection to the Distance Matrix API with the specified values, click on the Test button.