Connecting to Rossum (extractor)

Important

Any references to third-party products or services do not constitute Celonis Product Documentation nor do they create any contractual obligations. This material is for informational purposes only and is subject to change without notice.

Celonis does not warrant the availability, accuracy, reliability, completeness, or usefulness of any information regarding the subject of third-party services or systems.

The Celonis Rossum extractor integrates the Celonis Platform with your Rossum instances to retrieve document and invoice data via the REST API. It supports the following basic features:

Prerequisites

This section details important prerequisites or prerequisite knowledge for using this extractor.

Rossum authentication methods

The Rossum extractor uses basic authentication. You must provide a username and password to connect to your Rossum instance when configuring the data connection.

Note

The user account must have sufficient permissions to access the data you want to extract, including the following API endpoints:

Authentication endpoint:
```
POST /api/v1/auth/login
```
Data extraction endpoint:
```
POST /api/v1/queues/{queue_id}/export
```

Rossum configuration inputs

When configuring the connection between your Rossum instance and the Celonis Platform, you must provide the following inputs:

Region: Specify the region where your Rossum instance is hosed. The definition of your region specifies the Base URL the extractor uses for all API requests. The following regions are available for selection:
- EU: https://celonis.api.rossum.ai/v1/
- US: https://us.app.rossum.ai/api/v1/
- Custom: If your Rossum instance using a custom URL (such as https://elis.rossum.ai/api/v1/ or https://<workspace>.app.rossum.ai/api/v1 ), select this option provide your URL in the Host URL field.
Queue: The queue from which you want to extract data, such as 81867.
Status: The document statuses you would like to extract. This can be a single value or a comma-separated list of values, such as confirmed, exported.

Rossum data extraction endpoints

After successful authentication, the Rossum extractor uses the following REST API endpoint to extract data from your Rossum instance:

Table 2. Rossum data extraction endpoint

Endpoint	Description
`POST /api/v1/queues/{queue_id}/export`	Exports document data from the specified queue for extraction.

Configuring the Rossum extractor

This section describes the basic setup of configuring the Rossum extractor. To configure the extractor: