For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bank

Banks and accounts

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

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

get/erp/bank/{id}

Update existing Resource

put
Path parameters
idinteger · int64Required

ID der Bank

Body
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
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

put/erp/bank/{id}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
200

successful operation

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/erp/bank/{id}

deaktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

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

put/erp/bank/{id}/deactivate

aktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

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

put/erp/bank/{id}/activate

Create new Resource

post
Body
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
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

post/erp/bank
post
Path parameters
idinteger · int64Required

ID der Bank

Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/{id}/new_connection
200

OK

post
Path parameters
idinteger · int64Required

ID der Bank

Responses
200

OK

application/json
booleanOptional
post/erp/bank/{id}/authentication_status
200

OK

get
Path parameters
idinteger · int64Required

ID der Bank

Responses
200

OK

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

get/erp/bank/{id}/accounts
200

OK

post
Path parameters
idinteger · int64Required

ID der Bank

Body

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

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

post/erp/bank/{id}/accounts
200

OK

post
Path parameters
idinteger · int64Required

ID der Bank

Bodystring[]
string[]Optional

Save sync

Responses
200

OK

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

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

OK

post
Path parameters
bankIdinteger · int64Required

bankId

Body
importNewAccountsbooleanOptional

Sollen neue Bankkonten importiert werden?

Default: false
manageSavedSettingsstring · enumOptional

Sollen die gespeicherten Einwilligungen bearbeitet werden?

Default: NONEPossible values:
Responses
200

OK

application/json
idstringOptional

Die ID des externen Tasks

createdAtstring · date-timeOptional

Wann der Task angelegt wurde

statusstring · enumOptional

Was ist der Status des Tasks derzeit

Possible values:
post/erp/bank/update_connection/{bankId}
200

OK

post
Path parameters
backendTypestring · enumRequired

Bankschnittstelle

Possible values:
providerIdinteger · int64Required

ID des Banking-Providers

Responses
200

OK

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

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

OK

post
Path parameters
bankIdinteger · int64Required

bankId

Responses
200

OK

application/json
idstringOptional

Die ID des externen Tasks

createdAtstring · date-timeOptional

Wann der Task angelegt wurde

statusstring · enumOptional

Was ist der Status des Tasks derzeit

Possible values:
post/erp/bank/start_transaction_download/{bankId}
200

OK

get
Path parameters
idinteger · int64Required

ID der Bank

Responses
200

OK

application/json
descriptionstringOptional

Description of the action

typestring · enumOptional

action type

Possible values:
expirationstring · date-timeOptional

Expiration of the action

get/erp/bank/{id}/actions
200

OK

get
Path parameters
backendTypestring · enumRequired

Bankschnittstelle

Possible values:
searchTermstringRequired

Suchbegriff

providerIdinteger · int64Required

ID des Banking-Providers

Responses
200

OK

application/json
referenceIdstringOptional

reference id

labelstringOptional

description

bankNamestringOptional

bank name

bicstringOptional

BIC

blzstringOptional

BLZ

logoUrlstringOptional

URL des Bank-Logos

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

OK

get
Path parameters
bankIdinteger · int64Required

bankId

webformIdstringRequired

webformIdentifier

Responses
200

OK

application/json

Informationen über ein Webform wenn eines angelegt wurde

webformIdstringOptional

web form Id

typestring · enumOptional

web form Type

Possible values:
statusstring · enumOptional

web form Status

Possible values:
expiresAtstring · date-timeOptional

time expires at

createdAtstring · date-timeOptional

time created At

urlstringOptional

web form Url

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

OK

get
Path parameters
bankIdinteger · int64Required

bankId

taskIdstringRequired

taskIdentifier

Responses
200

OK

application/json
idstringOptional

Die ID des externen Tasks

createdAtstring · date-timeOptional

Wann der Task angelegt wurde

statusstring · enumOptional

Was ist der Status des Tasks derzeit

Possible values:
get/erp/bank/get_external_task/{bankId}/{taskId}
200

OK

get
Path parameters
bankIdinteger · int64Required

bankId

Responses
200

OK

application/json
referenceIdstringOptional
bankReferenceIdstringOptional
labelstringOptional
bankNamestringOptional
bicstringOptional
blzstringOptional
lastManualUpdatestring · date-timeOptional
lastManualUpdateMessagestringOptional
lastManualUpdateStatestring · enumOptionalPossible values:
lastAutoUpdatestring · date-timeOptional
lastAutoUpdateMessagestringOptional
lastAutoUpdateStatestring · enumOptionalPossible values:
consentExpiresAtstring · date-timeOptional
get/erp/bank/get_external_state/{bankId}
200

OK

delete
Path parameters
idinteger · int64Required

id

Responses
200

OK

No content

delete/erp/bank/{id}/delete_connection
200

OK

No content

delete
Path parameters
backendTypestring · enumRequiredPossible values:
Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

delete/erp/bank/reset_for_provider_type/{backendType}
200

OK

Last updated

Was this helpful?