BankTransactions

Transaktionen

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/transactions/{id}

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:11.703Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:11.703Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountId": 1,
  "parentId": 1,
  "valueDate": "2026-02-10T14:43:11.703Z",
  "bookingDate": "2026-02-10T14:43:11.703Z",
  "amount": 1,
  "updatedAccountBalance": 1,
  "currency": "text",
  "purpose": "text",
  "name": "text",
  "iban": "text",
  "bic": "text",
  "accountNumber": "text",
  "blz": "text",
  "bankName": "text",
  "mandateReference": "text",
  "customerReference": "text",
  "creditorId": "text",
  "debitorId": "text",
  "transactionType": "text",
  "transactionCodeZKA": "text",
  "transactionCodeSWIFT": "text",
  "purposeCode": "text",
  "primanota": "text",
  "endToEndId": "text",
  "compensationAmount": 1,
  "originalAmount": 1,
  "originalCurrency": "text",
  "userComment": "text",
  "matchingState": "MATCHED",
  "direction": "INCOMING",
  "openItemRecordRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ]
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

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

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/bank/transactions/{id}

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {},
  "id": "text",
  "accountId": 1,
  "parentId": 1,
  "valueDate": "2026-02-10T14:43:11.703Z",
  "bookingDate": "2026-02-10T14:43:11.703Z",
  "amount": 1,
  "updatedAccountBalance": 1,
  "currency": "text",
  "purpose": "text",
  "name": "text",
  "iban": "text",
  "bic": "text",
  "accountNumber": "text",
  "blz": "text",
  "bankName": "text",
  "mandateReference": "text",
  "customerReference": "text",
  "creditorId": "text",
  "debitorId": "text",
  "transactionType": "text",
  "transactionCodeZKA": "text",
  "transactionCodeSWIFT": "text",
  "purposeCode": "text",
  "primanota": "text",
  "endToEndId": "text",
  "compensationAmount": 1,
  "originalAmount": 1,
  "originalCurrency": "text",
  "userComment": "text",
  "direction": "INCOMING"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:11.703Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:11.703Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountId": 1,
  "parentId": 1,
  "valueDate": "2026-02-10T14:43:11.703Z",
  "bookingDate": "2026-02-10T14:43:11.703Z",
  "amount": 1,
  "updatedAccountBalance": 1,
  "currency": "text",
  "purpose": "text",
  "name": "text",
  "iban": "text",
  "bic": "text",
  "accountNumber": "text",
  "blz": "text",
  "bankName": "text",
  "mandateReference": "text",
  "customerReference": "text",
  "creditorId": "text",
  "debitorId": "text",
  "transactionType": "text",
  "transactionCodeZKA": "text",
  "transactionCodeSWIFT": "text",
  "purposeCode": "text",
  "primanota": "text",
  "endToEndId": "text",
  "compensationAmount": 1,
  "originalAmount": 1,
  "originalCurrency": "text",
  "userComment": "text",
  "matchingState": "MATCHED",
  "direction": "INCOMING",
  "openItemRecordRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ]
}

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/transactions/{id}

HTTPcURLJavaScriptPython

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

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

Create new Resource

post

Body

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

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

422

Resource was not valid to process

application/json

post

/erp/bank/transactions

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {},
  "id": "text",
  "accountId": 1,
  "parentId": 1,
  "valueDate": "2026-02-10T14:43:11.703Z",
  "bookingDate": "2026-02-10T14:43:11.703Z",
  "amount": 1,
  "updatedAccountBalance": 1,
  "currency": "text",
  "purpose": "text",
  "name": "text",
  "iban": "text",
  "bic": "text",
  "accountNumber": "text",
  "blz": "text",
  "bankName": "text",
  "mandateReference": "text",
  "customerReference": "text",
  "creditorId": "text",
  "debitorId": "text",
  "transactionType": "text",
  "transactionCodeZKA": "text",
  "transactionCodeSWIFT": "text",
  "purposeCode": "text",
  "primanota": "text",
  "endToEndId": "text",
  "compensationAmount": 1,
  "originalAmount": 1,
  "originalCurrency": "text",
  "userComment": "text",
  "direction": "INCOMING"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:11.703Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:11.703Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "accountId": 1,
  "parentId": 1,
  "valueDate": "2026-02-10T14:43:11.703Z",
  "bookingDate": "2026-02-10T14:43:11.703Z",
  "amount": 1,
  "updatedAccountBalance": 1,
  "currency": "text",
  "purpose": "text",
  "name": "text",
  "iban": "text",
  "bic": "text",
  "accountNumber": "text",
  "blz": "text",
  "bankName": "text",
  "mandateReference": "text",
  "customerReference": "text",
  "creditorId": "text",
  "debitorId": "text",
  "transactionType": "text",
  "transactionCodeZKA": "text",
  "transactionCodeSWIFT": "text",
  "purposeCode": "text",
  "primanota": "text",
  "endToEndId": "text",
  "compensationAmount": 1,
  "originalAmount": 1,
  "originalCurrency": "text",
  "userComment": "text",
  "matchingState": "MATCHED",
  "direction": "INCOMING",
  "openItemRecordRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ]
}

post

weist eine Transaction einem anderen OP zu

Path parameters

transactionIdinteger · int64Required

openItemRecordIdinteger · int64Required

Body

application/json

targetOpenItemIdinteger · int64Optional

neuer OP dem die Transaction zugewiesen werden soll

Responses

200

OK

application/json

post

/erp/bank/transactions/{transactionId}/{openItemRecordId}/reassignTransaction

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/{openItemRecordId}/reassignTransaction HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "targetOpenItemId": 1
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T14:43:11.703Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T14:43:11.703Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "order": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "invoice": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "creditNote": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "account": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "number": "text",
  "externalNumber": "text",
  "depositPaymentAmount": 1,
  "depositPaymentDate": "2026-02-10",
  "depositPayed": false,
  "balancedDate": "2026-02-10",
  "balanceState": "OPEN",
  "balance": 1,
  "sumPayments": 1,
  "sumDunnings": 1,
  "sumTotalAmount": 1,
  "sumDiscountableAmount": 1,
  "sumFee": 1,
  "records": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:11.703Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:11.703Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "recordDate": "2026-02-10",
      "totalAmount": 1,
      "discountableAmount": 1,
      "amount": 1,
      "discountAmount": 1,
      "bookingRecordId": 1,
      "origin": "DOCUMENT",
      "document": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "paymentMethod": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "accountBankdetailsRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "transactionRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "bankAccountRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "businessTransaction": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "revertedByRecordId": 1,
      "transactionId": 1,
      "qualifier": "PAYABLE",
      "number": "text",
      "comment": "text",
      "locked": true,
      "revertable": true,
      "recordReferenceNumber": "text",
      "dunningLvl": 1,
      "currencyCode": "text",
      "exchangeRate": 1,
      "baseCurrencyCode": "text",
      "baseAmount": 1,
      "baseDiscountAmount": 1,
      "baseTotalAmount": 1,
      "baseDiscountableAmount": 1,
      "baseDunningFee": 1,
      "baseDunningInterest": 1
    }
  ],
  "basisPaymentTermRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentMethodRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "paymentDays1": 1,
  "paymentDiscount1": 1,
  "paymentDiscount1DueDate": "2026-02-10",
  "paymentDays2": 1,
  "paymentDiscount2": 1,
  "paymentDiscount2DueDate": "2026-02-10",
  "qualifier": "PAYABLE",
  "fullPaymentAmount": 1,
  "paymentAmount": 1,
  "paymentKind": "PREPAYMENT",
  "refundType": "DISBURSE",
  "dunningBlock": false,
  "paymentState": "NO_PAYMENT",
  "dunningState": "IN_DUNNING",
  "dunningLevel": 1,
  "dunningCount": 1,
  "originalPaymentDueDate": "2026-02-10",
  "paymentDaysNet": 1,
  "paymentDueDate": "2026-02-10",
  "valueDate": "2026-02-10",
  "paymentDiscount1Amount": 1,
  "paymentDiscount2Amount": 1,
  "paymentTemplateRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "purpose": "text",
  "comment": "text",
  "paymentBlock": false,
  "tags": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:11.703Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:11.703Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "type": "COMMON",
      "label": "text",
      "color": "text",
      "editColor": "text",
      "searchColor": "text",
      "tagGroup": {
        "id": "text",
        "label": "text",
        "description": "text"
      }
    }
  ],
  "paymentPlan": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T14:43:11.703Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T14:43:11.703Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "paymentPlanType": "RULE",
    "dueDateCalculation": "text",
    "amount": 1,
    "startDate": "2026-02-10",
    "endDate": "2026-02-10",
    "description": "text",
    "active": true,
    "dueDate": "2026-02-10",
    "manualRuleEntries": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:11.703Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:11.703Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "dueDate": "2026-02-10",
        "amount": 1,
        "processed": true,
        "currencyCode": "text",
        "exchangeRate": 1,
        "baseCurrencyCode": "text",
        "baseAmount": 1
      }
    ],
    "currencyCode": "text",
    "exchangeRate": 1,
    "baseCurrencyCode": "text",
    "baseAmount": 1
  },
  "valueDateReadOnly": false,
  "canBeReopened": false,
  "currencyCode": "text",
  "exchangeRate": 1,
  "baseCurrencyCode": "text",
  "baseDepositPaymentAmount": 1,
  "baseSumPayments": 1,
  "baseSumDiscount": 1,
  "baseSumDunnings": 1,
  "baseSumTotalAmount": 1,
  "baseSumDiscountableAmount": 1,
  "baseBalance": 1,
  "baseSumFee": 1,
  "blockedByDocument": false,
  "balanced": true
}

post

Path parameters

transactionIdinteger · int64Required

Responses

200

OK

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/recalculate HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

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

post

Path parameters

transactionIdinteger · int64Required

paymentIdinteger · int64Required

Body

application/json

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

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/match_with_payment/{paymentId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "paymentId": 1,
  "comment": "text",
  "forceComplete": true
}

200

OK

{
  "type": "DONE",
  "amount": 1,
  "overpaidOpenItems": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:11.703Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:11.703Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "order": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "invoice": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "creditNote": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "account": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "number": "text",
      "externalNumber": "text",
      "depositPaymentAmount": 1,
      "depositPaymentDate": "2026-02-10",
      "depositPayed": false,
      "balancedDate": "2026-02-10",
      "balanceState": "OPEN",
      "balance": 1,
      "sumPayments": 1,
      "sumDunnings": 1,
      "sumTotalAmount": 1,
      "sumDiscountableAmount": 1,
      "sumFee": 1,
      "records": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:11.703Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:11.703Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "recordDate": "2026-02-10",
          "totalAmount": 1,
          "discountableAmount": 1,
          "amount": 1,
          "discountAmount": 1,
          "bookingRecordId": 1,
          "origin": "DOCUMENT",
          "document": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "paymentMethod": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "accountBankdetailsRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "transactionRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "bankAccountRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "businessTransaction": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "revertedByRecordId": 1,
          "transactionId": 1,
          "qualifier": "PAYABLE",
          "number": "text",
          "comment": "text",
          "locked": true,
          "revertable": true,
          "recordReferenceNumber": "text",
          "dunningLvl": 1,
          "currencyCode": "text",
          "exchangeRate": 1,
          "baseCurrencyCode": "text",
          "baseAmount": 1,
          "baseDiscountAmount": 1,
          "baseTotalAmount": 1,
          "baseDiscountableAmount": 1,
          "baseDunningFee": 1,
          "baseDunningInterest": 1
        }
      ],
      "basisPaymentTermRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "paymentMethodRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "paymentDays1": 1,
      "paymentDiscount1": 1,
      "paymentDiscount1DueDate": "2026-02-10",
      "paymentDays2": 1,
      "paymentDiscount2": 1,
      "paymentDiscount2DueDate": "2026-02-10",
      "qualifier": "PAYABLE",
      "fullPaymentAmount": 1,
      "paymentAmount": 1,
      "paymentKind": "PREPAYMENT",
      "refundType": "DISBURSE",
      "dunningBlock": false,
      "paymentState": "NO_PAYMENT",
      "dunningState": "IN_DUNNING",
      "dunningLevel": 1,
      "dunningCount": 1,
      "originalPaymentDueDate": "2026-02-10",
      "paymentDaysNet": 1,
      "paymentDueDate": "2026-02-10",
      "valueDate": "2026-02-10",
      "paymentDiscount1Amount": 1,
      "paymentDiscount2Amount": 1,
      "paymentTemplateRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "purpose": "text",
      "comment": "text",
      "paymentBlock": false,
      "tags": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:11.703Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:11.703Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "type": "COMMON",
          "label": "text",
          "color": "text",
          "editColor": "text",
          "searchColor": "text",
          "tagGroup": {
            "id": "text",
            "label": "text",
            "description": "text"
          }
        }
      ],
      "paymentPlan": {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:11.703Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:11.703Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "paymentPlanType": "RULE",
        "dueDateCalculation": "text",
        "amount": 1,
        "startDate": "2026-02-10",
        "endDate": "2026-02-10",
        "description": "text",
        "active": true,
        "dueDate": "2026-02-10",
        "manualRuleEntries": [
          {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T14:43:11.703Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T14:43:11.703Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "dueDate": "2026-02-10",
            "amount": 1,
            "processed": true,
            "currencyCode": "text",
            "exchangeRate": 1,
            "baseCurrencyCode": "text",
            "baseAmount": 1
          }
        ],
        "currencyCode": "text",
        "exchangeRate": 1,
        "baseCurrencyCode": "text",
        "baseAmount": 1
      },
      "valueDateReadOnly": false,
      "canBeReopened": false,
      "currencyCode": "text",
      "exchangeRate": 1,
      "baseCurrencyCode": "text",
      "baseDepositPaymentAmount": 1,
      "baseSumPayments": 1,
      "baseSumDiscount": 1,
      "baseSumDunnings": 1,
      "baseSumTotalAmount": 1,
      "baseSumDiscountableAmount": 1,
      "baseBalance": 1,
      "baseSumFee": 1,
      "blockedByDocument": false,
      "balanced": true
    }
  ]
}

post

Path parameters

transactionIdinteger · int64Required

Bodyobject[]

application/json

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

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/match_with_open_item HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 182

[
  {
    "openItemId": 1,
    "forceComplete": true,
    "distributionLines": [
      {
        "lineType": "PAYMENT",
        "businessTransactionId": 1,
        "amount": 1,
        "discountOrFeeAmount": 1,
        "comment": "text",
        "dunningRecordId": 1
      }
    ]
  }
]

200

OK

{
  "type": "DONE",
  "amount": 1,
  "overpaidOpenItems": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T14:43:11.703Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T14:43:11.703Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "order": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "invoice": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "creditNote": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "account": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "number": "text",
      "externalNumber": "text",
      "depositPaymentAmount": 1,
      "depositPaymentDate": "2026-02-10",
      "depositPayed": false,
      "balancedDate": "2026-02-10",
      "balanceState": "OPEN",
      "balance": 1,
      "sumPayments": 1,
      "sumDunnings": 1,
      "sumTotalAmount": 1,
      "sumDiscountableAmount": 1,
      "sumFee": 1,
      "records": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:11.703Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:11.703Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "recordDate": "2026-02-10",
          "totalAmount": 1,
          "discountableAmount": 1,
          "amount": 1,
          "discountAmount": 1,
          "bookingRecordId": 1,
          "origin": "DOCUMENT",
          "document": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "paymentMethod": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "accountBankdetailsRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "transactionRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "bankAccountRef": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "businessTransaction": {
            "id": "text",
            "label": "text",
            "description": "text",
            "active": true
          },
          "revertedByRecordId": 1,
          "transactionId": 1,
          "qualifier": "PAYABLE",
          "number": "text",
          "comment": "text",
          "locked": true,
          "revertable": true,
          "recordReferenceNumber": "text",
          "dunningLvl": 1,
          "currencyCode": "text",
          "exchangeRate": 1,
          "baseCurrencyCode": "text",
          "baseAmount": 1,
          "baseDiscountAmount": 1,
          "baseTotalAmount": 1,
          "baseDiscountableAmount": 1,
          "baseDunningFee": 1,
          "baseDunningInterest": 1
        }
      ],
      "basisPaymentTermRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "paymentMethodRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "paymentDays1": 1,
      "paymentDiscount1": 1,
      "paymentDiscount1DueDate": "2026-02-10",
      "paymentDays2": 1,
      "paymentDiscount2": 1,
      "paymentDiscount2DueDate": "2026-02-10",
      "qualifier": "PAYABLE",
      "fullPaymentAmount": 1,
      "paymentAmount": 1,
      "paymentKind": "PREPAYMENT",
      "refundType": "DISBURSE",
      "dunningBlock": false,
      "paymentState": "NO_PAYMENT",
      "dunningState": "IN_DUNNING",
      "dunningLevel": 1,
      "dunningCount": 1,
      "originalPaymentDueDate": "2026-02-10",
      "paymentDaysNet": 1,
      "paymentDueDate": "2026-02-10",
      "valueDate": "2026-02-10",
      "paymentDiscount1Amount": 1,
      "paymentDiscount2Amount": 1,
      "paymentTemplateRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "purpose": "text",
      "comment": "text",
      "paymentBlock": false,
      "tags": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T14:43:11.703Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T14:43:11.703Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "type": "COMMON",
          "label": "text",
          "color": "text",
          "editColor": "text",
          "searchColor": "text",
          "tagGroup": {
            "id": "text",
            "label": "text",
            "description": "text"
          }
        }
      ],
      "paymentPlan": {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T14:43:11.703Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T14:43:11.703Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "paymentPlanType": "RULE",
        "dueDateCalculation": "text",
        "amount": 1,
        "startDate": "2026-02-10",
        "endDate": "2026-02-10",
        "description": "text",
        "active": true,
        "dueDate": "2026-02-10",
        "manualRuleEntries": [
          {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T14:43:11.703Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T14:43:11.703Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "dueDate": "2026-02-10",
            "amount": 1,
            "processed": true,
            "currencyCode": "text",
            "exchangeRate": 1,
            "baseCurrencyCode": "text",
            "baseAmount": 1
          }
        ],
        "currencyCode": "text",
        "exchangeRate": 1,
        "baseCurrencyCode": "text",
        "baseAmount": 1
      },
      "valueDateReadOnly": false,
      "canBeReopened": false,
      "currencyCode": "text",
      "exchangeRate": 1,
      "baseCurrencyCode": "text",
      "baseDepositPaymentAmount": 1,
      "baseSumPayments": 1,
      "baseSumDiscount": 1,
      "baseSumDunnings": 1,
      "baseSumTotalAmount": 1,
      "baseSumDiscountableAmount": 1,
      "baseBalance": 1,
      "baseSumFee": 1,
      "blockedByDocument": false,
      "balanced": true
    }
  ]
}

post

Path parameters

transactionIdinteger · int64Required

Responses

200

OK

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/mark_as_relevant HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "type": "DONE",
  "amount": 1,
  "bookingIds": [
    1
  ],
  "irrelevantBookingId": 1
}

post

Path parameters

transactionIdinteger · int64Required

Body

application/json

commentstringRequired

commentary

forceCompletebooleanOptional

Unbooked value should be marked as irrelevant

notRelevantbooleanOptional

transaction is not relevant for business

Responses

200

OK

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/manual_booking HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "ledgerBookingAccountDistributions": [
    {
      "ledgerNumber": "text",
      "transactionKey": "text",
      "costCenter1": "text",
      "documentField1": "text",
      "distributionAmount": 1
    }
  ],
  "comment": "text",
  "forceComplete": true,
  "notRelevant": true
}

200

OK

{
  "type": "DONE",
  "amount": 1,
  "bookingIds": [
    1
  ],
  "irrelevantBookingId": 1
}

post

Path parameters

transactionIdinteger · int64Required

Body

application/json

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

post

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

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/{transactionId}/add_comment HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "comment": "text",
  "replace": true
}

200

OK

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

post

Responses

200

OK

application/json

Responseboolean

post

/erp/bank/transactions/reset_state

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/reset_state HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

true

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

post

/erp/bank/transactions/mark_as_not_relevant

HTTPcURLJavaScriptPython

POST /api/erp/bank/transactions/mark_as_not_relevant?accountId=1&toDate=2026-02-10 HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

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