Open navigation

Introducing Staging API

Modified on Tue, 18 Feb at 10:44 AM

The Aico staging API is a technical interface that allows customers to import documents into Aico for processing. 


Customers can implement automated software to send data for financial documents into Aico. In Aico, existing or new document templates, can be configured to receive this financial data. When financial documents arrive in the Aico staging API, the data is temporarily stored in a staging database from where the Aico staging service reads these staging documents and stores them into complete Aico financial documents and processes them through the Aico document workflow. This process is either fully automated or includes human intervention, which depends on the configuration and workflow needs.


The Aico staging API is a technical interface that allows customers to import documents into Aico for processing. It is implemented as a RESTful interface that has a OpenApi specification. Customers can implement automated software to send data for financial documents into Aico. 



In Aico, existing or new document templates, can be configured to receive this data. When staging documents arrive in the Aico staging API, the data is stored in a staging database from where the Aico staging service reads these staging documents and saves them into Aico documents. It can then send them through the Aico document workflow to a predefined workflow phase e.g. Approval, Completion. This process can either be fully automated or include human intervention depending on the defined configuration and workflow.

Implementing the staging API requires an agreement with the customer which document templates and which header and column fields in those documents should be made available for the customer calling the staging API. 

The staging API uses the concept of staging API clients ("staging client(s)") which can be configured differently to use different Aico document templates, mappings (between the staging data fields and the Aico document headers and rows) as well as sending the documents to different workflow statuses.

Configuration steps

Implementing the staging API requires the following:

  1. Set up (or adapt existing) Aico document template(s) which will be used by the staging clients.
  2. Create one or more clients for the customer.
  3. Configure each staging client's settings
  4. Name, default values, mappings etc. these are described in more detail in the sections below.
  5. It is expected that the customer will be able to create their own new staging clients on an ongoing basis.
  6. Test the staging import process using Excel test data.
  7. Share API details including authentication with the customer.
  8. Test the API with the customer.


The articles in this section deal with each of these steps.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article