Bank Accounts

Gather endpoints that provide functionalities for managing bank accounts. These functionalities include reading bank account data, upserting bank account data, deleting bank account data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

Import Bank Accounts

-> Start a job to import bank account records from a previously uploaded CSV file, identified by the storage ID in the request object.

SecurityapiKey
Request
path Parameters
storageId
required
string^[a-fA-F0-9]{24}$

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Request Body schema:
required

Identifies a previously uploaded CSV file with bank accounts to import.

featuresOn
Array of strings (BankAccountImportJobFeatureParam)

Feature(s) to be used during the import job:

  • CLEAR_STORAGE - Removes all existing data in the storage before the file is imported.
  • MERGE_PAYMENTS - Allows to import a file that contains payments (e.g. SAP REGUH data).
Items Enum: Description
CLEAR_STORAGE

Removes all existing data in the storage before the file is imported.

MERGE_PAYMENTS

Allows to import a file that contains payments (e.g. SAP REGUH data).

Example: ["CLEAR_STORAGE"]
url
required
string

-> Url to file which will be used to import data from. Recommended. The file can be uploaded via File Upload passing through url from the result object.

Example: "customer-uploads/bankaccountdata.csv"
Responses
200

Bank account import job started

400

Bad Request

post/bankaccountstorages/{storageId}/import
Request samples
{
  • "url": "customer-uploads/bankaccountdata.csv",
  • "featuresOn": [
    ]
}
Response samples
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "parameters": {
    }
}

Import Job Progress

Get bank account import job progress. It contains information about request that started the job.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

Job ID.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
storageId
required
string^[a-fA-F0-9]{24}$

ID of the bank account storage.

Example: 652697d8eb91545eb14e64e6
Responses
200

Bank account import job results

400

Bad Request

get/bankaccountstorages/{storageId}/import/{id}
Request samples 
Response samples 
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "progress": "77",
  • "status": "RUNNING",
  • "statusMessage": "The job failed because storage is empty.",
  • "parameters": {
    }
}