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

Bank Transactions

Transaktionen

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

accountIdinteger · int64Optional

id of the account

parentIdinteger · int64Optional

id of the parent transaction

valueDatestring · date-timeOptional

value date

bookingDatestring · date-timeOptional

booking date

amountnumberOptional

amount

updatedAccountBalancenumberOptional

updated account balance

currencystringOptional

amount currency

purposestringOptional

purpose text

namestringOptional

counterpart name

ibanstringOptional

counterpart iban

bicstringOptional

counterpart bic

accountNumberstringOptional

counterpart account number

blzstringOptional

counterpart bank number

bankNamestringOptional

counterpart bank name

mandateReferencestringOptional

mandate reference

customerReferencestringOptional

customer reference

creditorIdstringOptional

creditor id

debitorIdstringOptional

debitor id

transactionTypestringOptional

transaction type (text)

transactionCodeZKAstringOptional

transaction type (ZKA-code)

transactionCodeSWIFTstringOptional

transaction type (SWIFT-code)

purposeCodestringOptional

purpose code

primanotastringOptional

primanota

endToEndIdstringOptional

End-To-End-Id

compensationAmountnumberOptional

compensation amount (i.e. return debit fees)

originalAmountnumberOptional

original amount

originalCurrencystringOptional

currency of original amount

userCommentstringOptional

manual comments added by the user

isPotentialDuplicatebooleanRead-onlyOptional

potentielles Duplikat

matchingStatestring · enumRead-onlyOptional

whether the transaction has been completely or partially matched with open items or not matched at all

Possible values:
directionstring · enumOptional

whether this transaction was incoming or outgoing

Possible values:
get/erp/bank/transactions/{id}

Update existing Resource

put
Path parameters
idinteger · int64Required

an identifier

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

accountIdinteger · int64Optional

id of the account

parentIdinteger · int64Optional

id of the parent transaction

valueDatestring · date-timeOptional

value date

bookingDatestring · date-timeOptional

booking date

amountnumberOptional

amount

updatedAccountBalancenumberOptional

updated account balance

currencystringOptional

amount currency

purposestringOptional

purpose text

namestringOptional

counterpart name

ibanstringOptional

counterpart iban

bicstringOptional

counterpart bic

accountNumberstringOptional

counterpart account number

blzstringOptional

counterpart bank number

bankNamestringOptional

counterpart bank name

mandateReferencestringOptional

mandate reference

customerReferencestringOptional

customer reference

creditorIdstringOptional

creditor id

debitorIdstringOptional

debitor id

transactionTypestringOptional

transaction type (text)

transactionCodeZKAstringOptional

transaction type (ZKA-code)

transactionCodeSWIFTstringOptional

transaction type (SWIFT-code)

purposeCodestringOptional

purpose code

primanotastringOptional

primanota

endToEndIdstringOptional

End-To-End-Id

compensationAmountnumberOptional

compensation amount (i.e. return debit fees)

originalAmountnumberOptional

original amount

originalCurrencystringOptional

currency of original amount

userCommentstringOptional

manual comments added by the user

isPotentialDuplicatebooleanRead-onlyOptional

potentielles Duplikat

matchingStatestring · enumRead-onlyOptional

whether the transaction has been completely or partially matched with open items or not matched at all

Possible values:
directionstring · enumOptional

whether this transaction was incoming or outgoing

Possible values:
Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

accountIdinteger · int64Optional

id of the account

parentIdinteger · int64Optional

id of the parent transaction

valueDatestring · date-timeOptional

value date

bookingDatestring · date-timeOptional

booking date

amountnumberOptional

amount

updatedAccountBalancenumberOptional

updated account balance

currencystringOptional

amount currency

purposestringOptional

purpose text

namestringOptional

counterpart name

ibanstringOptional

counterpart iban

bicstringOptional

counterpart bic

accountNumberstringOptional

counterpart account number

blzstringOptional

counterpart bank number

bankNamestringOptional

counterpart bank name

mandateReferencestringOptional

mandate reference

customerReferencestringOptional

customer reference

creditorIdstringOptional

creditor id

debitorIdstringOptional

debitor id

transactionTypestringOptional

transaction type (text)

transactionCodeZKAstringOptional

transaction type (ZKA-code)

transactionCodeSWIFTstringOptional

transaction type (SWIFT-code)

purposeCodestringOptional

purpose code

primanotastringOptional

primanota

endToEndIdstringOptional

End-To-End-Id

compensationAmountnumberOptional

compensation amount (i.e. return debit fees)

originalAmountnumberOptional

original amount

originalCurrencystringOptional

currency of original amount

userCommentstringOptional

manual comments added by the user

isPotentialDuplicatebooleanRead-onlyOptional

potentielles Duplikat

matchingStatestring · enumRead-onlyOptional

whether the transaction has been completely or partially matched with open items or not matched at all

Possible values:
directionstring · enumOptional

whether this transaction was incoming or outgoing

Possible values:
put/erp/bank/transactions/{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/transactions/{id}

Create new Resource

post
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

accountIdinteger · int64Optional

id of the account

parentIdinteger · int64Optional

id of the parent transaction

valueDatestring · date-timeOptional

value date

bookingDatestring · date-timeOptional

booking date

amountnumberOptional

amount

updatedAccountBalancenumberOptional

updated account balance

currencystringOptional

amount currency

purposestringOptional

purpose text

namestringOptional

counterpart name

ibanstringOptional

counterpart iban

bicstringOptional

counterpart bic

accountNumberstringOptional

counterpart account number

blzstringOptional

counterpart bank number

bankNamestringOptional

counterpart bank name

mandateReferencestringOptional

mandate reference

customerReferencestringOptional

customer reference

creditorIdstringOptional

creditor id

debitorIdstringOptional

debitor id

transactionTypestringOptional

transaction type (text)

transactionCodeZKAstringOptional

transaction type (ZKA-code)

transactionCodeSWIFTstringOptional

transaction type (SWIFT-code)

purposeCodestringOptional

purpose code

primanotastringOptional

primanota

endToEndIdstringOptional

End-To-End-Id

compensationAmountnumberOptional

compensation amount (i.e. return debit fees)

originalAmountnumberOptional

original amount

originalCurrencystringOptional

currency of original amount

userCommentstringOptional

manual comments added by the user

isPotentialDuplicatebooleanRead-onlyOptional

potentielles Duplikat

matchingStatestring · enumRead-onlyOptional

whether the transaction has been completely or partially matched with open items or not matched at all

Possible values:
directionstring · enumOptional

whether this transaction was incoming or outgoing

Possible values:
Responses
200

successful operation

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

accountIdinteger · int64Optional

id of the account

parentIdinteger · int64Optional

id of the parent transaction

valueDatestring · date-timeOptional

value date

bookingDatestring · date-timeOptional

booking date

amountnumberOptional

amount

updatedAccountBalancenumberOptional

updated account balance

currencystringOptional

amount currency

purposestringOptional

purpose text

namestringOptional

counterpart name

ibanstringOptional

counterpart iban

bicstringOptional

counterpart bic

accountNumberstringOptional

counterpart account number

blzstringOptional

counterpart bank number

bankNamestringOptional

counterpart bank name

mandateReferencestringOptional

mandate reference

customerReferencestringOptional

customer reference

creditorIdstringOptional

creditor id

debitorIdstringOptional

debitor id

transactionTypestringOptional

transaction type (text)

transactionCodeZKAstringOptional

transaction type (ZKA-code)

transactionCodeSWIFTstringOptional

transaction type (SWIFT-code)

purposeCodestringOptional

purpose code

primanotastringOptional

primanota

endToEndIdstringOptional

End-To-End-Id

compensationAmountnumberOptional

compensation amount (i.e. return debit fees)

originalAmountnumberOptional

original amount

originalCurrencystringOptional

currency of original amount

userCommentstringOptional

manual comments added by the user

isPotentialDuplicatebooleanRead-onlyOptional

potentielles Duplikat

matchingStatestring · enumRead-onlyOptional

whether the transaction has been completely or partially matched with open items or not matched at all

Possible values:
directionstring · enumOptional

whether this transaction was incoming or outgoing

Possible values:
post/erp/bank/transactions
post

weist eine Transaction einem anderen OP zu

Path parameters
transactionIdinteger · int64Required
openItemRecordIdinteger · int64Required
Body
targetOpenItemIdinteger · int64Optional

neuer OP dem die Transaction zugewiesen werden soll

Responses
200

OK

application/json
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

numberstringRead-onlyRequired

OP-Nummer

externalNumberstringRead-onlyOptional

Externe OP-Nummer

depositPaymentAmountnumberRead-onlyOptional

agreed Deposit payment amount

depositPaymentDatestring · dateRead-onlyOptional

agreed Deposit payment date

depositPayedbooleanRead-onlyOptional

is the agreed deposit payed?

Default: false
balancedDatestring · dateRead-onlyOptional

balanced date of this open item (calculated)

balanceStatestring · enumRead-onlyOptional

whether this open item is balanced, partially paid or open

Possible values:
balancenumberRead-onlyOptional

saldo

sumPaymentsnumberRead-onlyOptional

Summe gebuchte Zahlungen

sumDunningsnumberRead-onlyOptional

Summe Mahngebühren und Zinsen

sumTotalAmountnumberRead-onlyOptional

Rechnungsbetrag

sumDiscountableAmountnumberRead-onlyOptional

skontierbarer Rechnungsbetrag

sumFeenumberRead-onlyOptional

allgemeine Gebühren

paymentDays1integer · int32Read-onlyOptional

How many days are given for using the first discount rule

paymentDiscount1numberRead-onlyOptional

How much discount can be given for speedy payment, rule 1

paymentDiscount1DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto1)

paymentDays2integer · int32Read-onlyOptional

How many days are given for using the second discount rule

paymentDiscount2numberRead-onlyOptional

How much discount can be given for speedy payment, rule 2

paymentDiscount2DueDatestring · dateRead-onlyOptional

Fälligkeitsdatum (Skonto2)

paymentDiscountOriginstring · enumOptional

Ursprung der Skontowerte (Tage und Prozentsätze)

Possible values:
qualifierstring · enumRead-onlyOptional

Does this open item belong to accounts payable or accounts receivable

Possible values:
fullPaymentAmountnumberRead-onlyOptional

The full amount of the payment

paymentAmountnumberRead-onlyOptional

Der momentan gültige zu zahlende Betrag

paymentKindstring · enumRead-onlyOptional

The kind of payment

Possible values:
refundTypestring · enumOptional

how should a refund be done?

Possible values:
dunningBlockbooleanOptional

Mahnsperre

Default: false
paymentStatestring · enumOptional

Der Zustand der Zahlung

Possible values:
dunningStatestring · enumOptional

Der Mahnzustand

Possible values:
dunningLevelinteger · int32Read-onlyOptional

Die Mahnstufe

dunningCountinteger · int32Read-onlyOptional

Anzahl Mahnpositionen/Mahnungen für diesen OP

originalPaymentDueDatestring · dateRead-onlyOptional

Ursprüngliches Fälligkeitsdatum

paymentDaysNetinteger · int32Optional

Fälligkeit in Tagen

paymentDueDatestring · dateOptional

Fälligkeitsdatum

valueDatestring · dateOptional

Valutadatum

paymentDiscount1AmountnumberOptional

Skontobetrag 1

paymentDiscount2AmountnumberOptional

Skontobetrag 2

purposestringOptional

Verwendungszweck

commentstringOptional

Kommentar

paymentBlockbooleanOptional

Zahlungssperre

Default: false
valueDateReadOnlybooleanOptional

Valutadatum schreibgeschützt

Default: false
canBeReopenedbooleanOptional

kann wiedereröffet werden

Default: false
currencyCodestringOptional

Währung des offenen Postens (ISO-A3)

exchangeRatenumberOptional

Kurs der Währung zu Basiswährung

baseCurrencyCodestringOptional

Basiswährung des offenen Postens (ISO-A3)

baseDepositPaymentAmountnumberOptional

Vereinbarter Anzahlungsbetrag in Basiswährung

baseSumPaymentsnumberOptional

Summe der Zahlungen in Basiswährung

baseSumDiscountnumberOptional

Summe der Abzüge (Skonto usw.) in Basiswährung

baseSumDunningsnumberOptional

Summe der Mahngebühren und Zinsen in Basiswährung

baseSumTotalAmountnumberOptional

Gesamtsumme der Rechnungsbeträge in Basiswährung

baseSumDiscountableAmountnumberOptional

Summe der skontierbaren Rechnungsbeträge in Basiswährung

baseBalancenumberOptional

Offener Betrag (Saldo) in Basiswährung

baseSumFeenumberOptional

allgemeine Gebühren in Basiswährung

blockedByDocumentbooleanOptional

Ist der OP durch ein Dokument geblockt?

Default: false
bookingAccountTypestring · enumRead-onlyOptional

Buchung auf Lieferant oder Kunde bei manuellen OPs

Possible values:
taxPerformanceLocationstring · enumOptional

Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:
taxStatestring · enumOptional

Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)

Possible values:
performanceCountryCodestringOptional

Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

sourceCountryCodestringOptional

Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)

performanceDatestring · dateOptional

Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)

balancedbooleanOptional
post/erp/bank/transactions/{transactionId}/{openItemRecordId}/reassignTransaction
200

OK

post
Path parameters
transactionIdinteger · int64Required
Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/transactions/{transactionId}/recalculate
200

OK

post
Path parameters
transactionIdinteger · int64Required
paymentIdinteger · int64Required
Body
paymentIdinteger · int64Optional

Id der Sammellastschrift

commentstringOptional

Kommentar zur Buchung

forceCompletebooleanOptional

Soll die Transaktion abgeschlossen und ein Restbetrag als irrelevant verbuicht werden?

Responses
200

OK

application/json
typestring · enumOptional

The result type of the attempt to match open item with transaction

Possible values:
amountnumberOptional

If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant

post/erp/bank/transactions/{transactionId}/match_with_payment/{paymentId}
200

OK

post
Path parameters
transactionIdinteger · int64Required
Bodyobject · erp-bank-OpenItemDistribution[]
openItemIdinteger · int64Required

The ID of the open item to be matched with the transaction

forceCompletebooleanOptional

The total amount to be booked against this combination of open item and transaction

Responses
200

OK

application/json
typestring · enumOptional

The result type of the attempt to match open item with transaction

Possible values:
amountnumberOptional

If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant

post/erp/bank/transactions/{transactionId}/match_with_open_item
200

OK

post
Path parameters
transactionIdinteger · int64Required
Responses
200

OK

application/json
typestring · enumOptional

The result type of the attempt to manually book transaction

Possible values:
amountnumberOptional

If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant

bookingIdsinteger · int64[]Optional

The ids of the manual bookings if successful

irrelevantBookingIdinteger · int64Optional

The id of the irrelevancy marker booking if applicable

post/erp/bank/transactions/{transactionId}/mark_as_relevant
200

OK

post
Path parameters
transactionIdinteger · int64Required
Body
commentstringRequired

commentary

forceCompletebooleanOptional

Unbooked value should be marked as irrelevant

notRelevantbooleanOptional

transaction is not relevant for business

templateIdinteger · int64Optional

Template Vorlage

Responses
200

OK

application/json
typestring · enumOptional

The result type of the attempt to manually book transaction

Possible values:
amountnumberOptional

If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant

bookingIdsinteger · int64[]Optional

The ids of the manual bookings if successful

irrelevantBookingIdinteger · int64Optional

The id of the irrelevancy marker booking if applicable

post/erp/bank/transactions/{transactionId}/manual_booking
200

OK

post
Path parameters
transactionIdinteger · int64Required
Body
commentstringOptional

the comment to be added to the transaction

replacebooleanOptional

whether the comment of the transaction should be replaced or added onto

Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/transactions/{transactionId}/add_comment
200

OK

post
Responses
200

OK

application/json
booleanOptional
post/erp/bank/transactions/reset_state
200

OK

post

markiert alle Transaktionen für einen Account bis zum angegebenen Datum als nicht relevant

Query parameters
accountIdinteger · int64Required
toDatestring · dateRequired
Responses
200

OK

application/json
contextstringOptional

message context

messageValuestringOptional

message

post/erp/bank/transactions/mark_as_not_relevant
200

OK

Last updated

Was this helpful?