Transaction import

Api operations involved  

In the frondend application the following API operations are involved:

• POST /v2/api/batch-importer-config, for creating a new import configuration.
• POST /v2/api/batch-importer, for creating a new import job.
• GET /v2/api/batch-importer/{slug}/tasks, for fetching the active pending task requiring user interaction.
• POST /v2/api/batch-importer/{slug}/tasks, for providing the user input required for the task.

Creating configuration  

When calling the POST /v2/api/batch-importer-config API operation, the user must provide the following information:

{
  "name": "A logical name",
  "type": "csv",
  "fileCode": "unique-code-returned-by-upload-api-operation"
}

Make sure to store the returned id of the configuration, as it will be required when creating the import job.

More details on this can be found in the Create batch import configuration.

Creating the import job  

When calling the POST /v2/api/batch-importer API operation, the user must provide the following information:

{
  "configuration": "the-id-of-the-configuration",
  "fileTokens": "unique-code-returned-by-upload-api-operation"
}

More details on this can be found in the Create batch import job.

Available user task  

When calling the GET /v2/api/batch-importer/{slug}/tasks API operation, the user will be presented with the following information.

  Warning

This will return a BAD REQUEST if the import job is not in a state that requires user interaction.

{
  "id": "logical-id",
  "name": "name of the task",
  "variables": {}
}

There are essentially two types of tasks:

Import configuration  

This allows the user to change the default configuration for this specific import job.

{
  "importerConfiguration" : {},
  "accountId": 1,
  "applyRules": true,
  "generateAccounts": true
}

Account mapping  

This allows the user to map account names to existing accounts in the system.

{
  "name": "The account name"
}

The business process  

Below is a business process diagram of the transaction import process. This diagram only contains those phases that do not require user interaction.