Bank

Banks and accounts

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/erp/bank/{id}

HTTPcURLJavaScriptPython

GET /api/erp/bank/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.121Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.121Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true,
      "externalReferenceId": "text"
    }
  ],
  "providerId": 1,
  "active": true,
  "logoUrl": "text"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

ID der Bank

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Gläubiger-Identifikationsnummer

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Ist die Bank aktiv

Default: true

logoUrlstringOptional

URL des Bank-Logos

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/bank/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/bank/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text"
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "accounts": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true
    }
  ],
  "providerId": 1,
  "logoUrl": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.121Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.121Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true,
      "externalReferenceId": "text"
    }
  ],
  "providerId": 1,
  "active": true,
  "logoUrl": "text"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/erp/bank/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/bank/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/bank/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/erp/bank/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.121Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.121Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true,
      "externalReferenceId": "text"
    }
  ],
  "providerId": 1,
  "active": true,
  "logoUrl": "text"
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/bank/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/erp/bank/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.121Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.121Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true,
      "externalReferenceId": "text"
    }
  ],
  "providerId": 1,
  "active": true,
  "logoUrl": "text"
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstringRequired

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

externalIdstringOptional

External BankID

creditorIdstringOptional

Gläubiger-Identifikationsnummer

userActionRequiredbooleanRead-onlyOptional

Wether a call to bank init is needed.

providerIdinteger · int64Optional

ID of the banking provider

activebooleanRead-onlyOptional

Ist die Bank aktiv

Default: true

logoUrlstringOptional

URL des Bank-Logos

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/erp/bank

HTTPcURLJavaScriptPython

POST /api/erp/bank HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text"
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "accounts": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true
    }
  ],
  "providerId": 1,
  "logoUrl": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "bankingBackend": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "externalId": "text",
  "creditorId": "text",
  "userActionRequired": true,
  "accounts": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:00.121Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:00.121Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "bankId": 1,
      "label": "text",
      "iban": "text",
      "accountNumber": "text",
      "subAccountNumber": "text",
      "holderName": "text",
      "currency": "text",
      "accountCredit": 1,
      "sortOrder": 1,
      "defaultBankAccount": false,
      "active": true,
      "externalReferenceId": "text"
    }
  ],
  "providerId": 1,
  "active": true,
  "logoUrl": "text"
}

post

Path parameters

idinteger · int64Required

ID der Bank

Responses

200

OK

application/json

post

/erp/bank/{id}/new_connection

HTTPcURLJavaScriptPython

POST /api/erp/bank/{id}/new_connection HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

post

Path parameters

idinteger · int64Required

ID der Bank

Responses

200

OK

application/json

Responseboolean

post

/erp/bank/{id}/authentication_status

HTTPcURLJavaScriptPython

POST /api/erp/bank/{id}/authentication_status HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

true

get

Path parameters

idinteger · int64Required

ID der Bank

Responses

200

OK

application/json

get

/erp/bank/{id}/accounts

HTTPcURLJavaScriptPython

GET /api/erp/bank/{id}/accounts HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.121Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.121Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "bankId": 1,
    "label": "text",
    "iban": "text",
    "accountNumber": "text",
    "subAccountNumber": "text",
    "holderName": "text",
    "currency": "text",
    "accountCredit": 1,
    "sortOrder": 1,
    "defaultBankAccount": false,
    "active": true,
    "externalReferenceId": "text"
  }
]

post

Path parameters

idinteger · int64Required

ID der Bank

Body

application/json

accounts

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bankIdinteger · int64Optional

id of the bank

labelstringOptional

description

ibanstringOptional

IBAN

accountNumberstringOptional

account number

subAccountNumberstringOptional

sub account number

holderNamestringOptional

account holder

currencystringOptional

currency

accountCreditnumberOptional

Kontokorrent-Betrag

sortOrderinteger · int32Optional

Konto-Position

defaultBankAccountbooleanOptional

Standard-Konto

Default: false

activebooleanOptional

Aktiv?

externalReferenceIdstringRead-onlyOptional

Referenz ID aus externem System

Responses

200

OK

application/json

post

/erp/bank/{id}/accounts

HTTPcURLJavaScriptPython

POST /api/erp/bank/{id}/accounts HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "version": "text",
  "info": {},
  "id": "text",
  "bankId": 1,
  "label": "text",
  "iban": "text",
  "accountNumber": "text",
  "subAccountNumber": "text",
  "holderName": "text",
  "currency": "text",
  "accountCredit": 1,
  "sortOrder": 1,
  "defaultBankAccount": false,
  "active": true
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:00.121Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:00.121Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankId": 1,
  "label": "text",
  "iban": "text",
  "accountNumber": "text",
  "subAccountNumber": "text",
  "holderName": "text",
  "currency": "text",
  "accountCredit": 1,
  "sortOrder": 1,
  "defaultBankAccount": false,
  "active": true,
  "externalReferenceId": "text"
}

post

Path parameters

idinteger · int64Required

ID der Bank

Bodystring[]

application/json

string[]Optional

Save sync

Responses

200

OK

application/json

post

/erp/bank/{id}/accounts/sync

HTTPcURLJavaScriptPython

POST /api/erp/bank/{id}/accounts/sync HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

200

OK

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.121Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.121Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "bankId": 1,
    "label": "text",
    "iban": "text",
    "accountNumber": "text",
    "subAccountNumber": "text",
    "holderName": "text",
    "currency": "text",
    "accountCredit": 1,
    "sortOrder": 1,
    "defaultBankAccount": false,
    "active": true,
    "externalReferenceId": "text"
  }
]

post

Path parameters

bankIdinteger · int64Required

bankId

Body

application/json

importNewAccountsbooleanOptional

Sollen neue Bankkonten importiert werden?

Default: false

manageSavedSettingsstring · enumOptional

Sollen die gespeicherten Einwilligungen bearbeitet werden?

Default: NONEPossible values:

Responses

200

OK

application/json

post

/erp/bank/update_connection/{bankId}

HTTPcURLJavaScriptPython

POST /api/erp/bank/update_connection/{bankId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "importNewAccounts": false,
  "manageSavedSettings": "NONE"
}

200

OK

{
  "id": "text",
  "createdAt": "2026-02-10T14:43:00.121Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-02-10T14:43:00.121Z",
    "createdAt": "2026-02-10T14:43:00.121Z",
    "url": "text"
  }
}

post

Path parameters

backendTypestring · enumRequired

Bankschnittstelle

Possible values:

providerIdinteger · int64Required

ID des Banking-Providers

Responses

200

OK

application/json

post

/erp/bank/sync/{backendType}/{providerId}

HTTPcURLJavaScriptPython

POST /api/erp/bank/sync/{backendType}/{providerId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:00.121Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:00.121Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "label": "text",
    "bankingBackend": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "bankName": "text",
    "bic": "text",
    "blz": "text",
    "externalId": "text",
    "creditorId": "text",
    "userActionRequired": true,
    "accounts": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:00.121Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:00.121Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "bankId": 1,
        "label": "text",
        "iban": "text",
        "accountNumber": "text",
        "subAccountNumber": "text",
        "holderName": "text",
        "currency": "text",
        "accountCredit": 1,
        "sortOrder": 1,
        "defaultBankAccount": false,
        "active": true,
        "externalReferenceId": "text"
      }
    ],
    "providerId": 1,
    "active": true,
    "logoUrl": "text"
  }
]

post

Path parameters

bankIdinteger · int64Required

bankId

Responses

200

OK

application/json

post

/erp/bank/start_transaction_download/{bankId}

HTTPcURLJavaScriptPython

POST /api/erp/bank/start_transaction_download/{bankId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "id": "text",
  "createdAt": "2026-02-10T14:43:00.121Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-02-10T14:43:00.121Z",
    "createdAt": "2026-02-10T14:43:00.121Z",
    "url": "text"
  }
}

get

Path parameters

idinteger · int64Required

ID der Bank

Responses

200

OK

application/json

get

/erp/bank/{id}/actions

HTTPcURLJavaScriptPython

GET /api/erp/bank/{id}/actions HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "description": "text",
    "type": "OPEN_URL",
    "expiration": "2026-02-10T14:43:00.121Z",
    "payload": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

get

Path parameters

backendTypestring · enumRequired

Bankschnittstelle

Possible values:

searchTermstringRequired

Suchbegriff

providerIdinteger · int64Required

ID des Banking-Providers

Responses

200

OK

application/json

get

/erp/bank/search/{backendType}/{searchTerm}/{providerId}

HTTPcURLJavaScriptPython

GET /api/erp/bank/search/{backendType}/{searchTerm}/{providerId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "referenceId": "text",
    "label": "text",
    "bankName": "text",
    "bic": "text",
    "blz": "text",
    "logoUrl": "text"
  }
]

get

Path parameters

bankIdinteger · int64Required

bankId

webformIdstringRequired

webformIdentifier

Responses

200

OK

application/json

get

/erp/bank/get_webform_by_id/{bankId}/{webformId}

HTTPcURLJavaScriptPython

GET /api/erp/bank/get_webform_by_id/{bankId}/{webformId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "webformId": "text",
  "type": "BANK_CONNECTION_IMPORT",
  "status": "NOT_YET_OPENED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "expiresAt": "2026-02-10T14:43:00.121Z",
  "createdAt": "2026-02-10T14:43:00.121Z",
  "url": "text"
}

get

Path parameters

bankIdinteger · int64Required

bankId

taskIdstringRequired

taskIdentifier

Responses

200

OK

application/json

get

/erp/bank/get_external_task/{bankId}/{taskId}

HTTPcURLJavaScriptPython

GET /api/erp/bank/get_external_task/{bankId}/{taskId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "id": "text",
  "createdAt": "2026-02-10T14:43:00.121Z",
  "status": "NOT_YET_STARTED",
  "payload": {
    "bankConnectionId": 1,
    "paymentId": 1,
    "standingOrderId": 1
  },
  "webform": {
    "webformId": "text",
    "type": "BANK_CONNECTION_IMPORT",
    "status": "NOT_YET_OPENED",
    "payload": {
      "bankConnectionId": 1,
      "paymentId": 1,
      "standingOrderId": 1
    },
    "expiresAt": "2026-02-10T14:43:00.121Z",
    "createdAt": "2026-02-10T14:43:00.121Z",
    "url": "text"
  }
}

get

Path parameters

bankIdinteger · int64Required

bankId

Responses

200

OK

application/json

get

/erp/bank/get_external_state/{bankId}

HTTPcURLJavaScriptPython

GET /api/erp/bank/get_external_state/{bankId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "referenceId": "text",
  "bankReferenceId": "text",
  "label": "text",
  "bankName": "text",
  "bic": "text",
  "blz": "text",
  "lastManualUpdate": "2026-02-10T14:43:00.121Z",
  "lastManualUpdateMessage": "text",
  "lastManualUpdateState": "OK",
  "lastAutoUpdate": "2026-02-10T14:43:00.121Z",
  "lastAutoUpdateMessage": "text",
  "lastAutoUpdateState": "OK",
  "consentExpiresAt": "2026-02-10T14:43:00.121Z"
}

delete

Path parameters

idinteger · int64Required

id

Responses

200

OK

No content

delete

/erp/bank/{id}/delete_connection

HTTPcURLJavaScriptPython

DELETE /api/erp/bank/{id}/delete_connection HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

delete

Path parameters

backendTypestring · enumRequiredPossible values:

Responses

200

OK

application/json

delete

/erp/bank/reset_for_provider_type/{backendType}

HTTPcURLJavaScriptPython

DELETE /api/erp/bank/reset_for_provider_type/{backendType} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}