API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
Payment
Customer
Billing
Dunning
Subscription
Offers
Catalogue
Checkout
curl -X PUT \
/payment/bank-account-transactions/{id}/assign-invoices \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"invoiceIds": [
""
]
}'{
"id": "<string>",
"suggestedInvoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "[email protected]",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"unpaidAmount": {}
},
"suggestedCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"valueDate": "2023-11-07T05:31:56Z",
"bookingDate": "2023-11-07T05:31:56Z",
"paymentDate": "2023-11-07T05:31:56Z",
"usageDescription": "Kundennummer 1234567890 Rechnung 1234567890",
"endToEndId": "1234567890",
"counterParty": {
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"alias": "Girokonto",
"iban": "DE12500105170648489890",
"bic": "PBNKDEFFXXX",
"accountHolder": "Max Mustermann",
"bankName": "Commerzbank"
},
"amount": {},
"fee": {},
"status": "STATUS_RECEIVED",
"receivedAt": "2023-11-07T05:31:56Z",
"bookedAt": "2023-11-07T05:31:56Z",
"mandateId": "MAN1234567890",
"source": "klarna",
"type": "debit",
"transactionCode": "RCDT",
"assignments": [
{
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"invoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "[email protected]",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"unpaidAmount": {}
},
"transaction": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"type": "payment",
"status": "new",
"description": "Payment for invoice #123",
"documentNumber": "123456789",
"currencyCode": "EUR",
"amount": 500,
"refundedAmount": 123,
"chargedAmount": 500,
"feeAmount": 50,
"createdAt": "2023-11-07T05:31:56Z",
"paidAt": "2023-11-07T05:31:56Z"
},
"amount": {},
"fee": {},
"matchedAt": "2023-11-07T05:31:56Z"
}
],
"unassignedAmount": {}
}Assign invoices to the bank account transaction.
Assign invoices to the bank account transaction. This will create a new transaction with the remaining bank transaction amount upto the unpaid invoice amount. When the bank transaction has a remaining amount, you can assign that to other invoices.
Required permissions:bank-account-transaction:writecurl -X PUT \
/payment/bank-account-transactions/{id}/assign-invoices \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"invoiceIds": [
""
]
}'{
"id": "<string>",
"suggestedInvoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "[email protected]",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"unpaidAmount": {}
},
"suggestedCustomer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"valueDate": "2023-11-07T05:31:56Z",
"bookingDate": "2023-11-07T05:31:56Z",
"paymentDate": "2023-11-07T05:31:56Z",
"usageDescription": "Kundennummer 1234567890 Rechnung 1234567890",
"endToEndId": "1234567890",
"counterParty": {
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"alias": "Girokonto",
"iban": "DE12500105170648489890",
"bic": "PBNKDEFFXXX",
"accountHolder": "Max Mustermann",
"bankName": "Commerzbank"
},
"amount": {},
"fee": {},
"status": "STATUS_RECEIVED",
"receivedAt": "2023-11-07T05:31:56Z",
"bookedAt": "2023-11-07T05:31:56Z",
"mandateId": "MAN1234567890",
"source": "klarna",
"type": "debit",
"transactionCode": "RCDT",
"assignments": [
{
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"invoice": {
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"default": true,
"status": "active",
"enabled": true,
"name": "<string>",
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "[email protected]",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<unknown>",
"internalNote": "This invoice is with a special discount.",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"customFields": {
"field1": "value1",
"field2": "value2"
},
"unpaidAmount": {}
},
"transaction": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"type": "payment",
"status": "new",
"description": "Payment for invoice #123",
"documentNumber": "123456789",
"currencyCode": "EUR",
"amount": 500,
"refundedAmount": 123,
"chargedAmount": 500,
"feeAmount": 50,
"createdAt": "2023-11-07T05:31:56Z",
"paidAt": "2023-11-07T05:31:56Z"
},
"amount": {},
"fee": {},
"matchedAt": "2023-11-07T05:31:56Z"
}
],
"unassignedAmount": {}
}Authorizations
Value for the Authorization header parameter.
Path Parameters
BankAccountTransaction identifier
Body
The updated BankAccountTransaction resource
1["ad8f1b9e-1b9e-4c4c-8f1b-9e1b9e4c4c8f"]Response
BankAccountTransaction resource updated
Show child attributes
Show child attributes
The unique identifier of the invoice.
"00000000-0000-0000-0000-000000000000"
The customer of the invoice.
Show child attributes
Show child attributes
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
The payment method which should be used to fullfill the payment of the invoice.
Show child attributes
Show child attributes
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider, active, action_required, expired, revoked, gateway_unconfigured "active"
The card data of the payment method, if the type is "card"
Show child attributes
Show child attributes
The brand of the card
"Visa"
The last 4 digits of the card
"4242"
The expiration month of the card
12
The expiration year of the card
2022
The card holder name
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
Show child attributes
Show child attributes
The iban of the sepa mandate
"DE8937*********3232"
The bic of the sepa mandate
"COBADEFFXXX"
The mandate reference of the sepa mandate
"MNDT-2021-123456"
The signing date of the sepa mandate
"2021-01-01T00:00:00+00:00"
The paypal data of the payment method, if the type is "paypal"
Show child attributes
Show child attributes
The email of the paypal account
The billing agreement id of the paypal account
"I-1J5gqz2eZvKYlo2C2X2X2X2X"
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING "TYPE_INVOICE"
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
"EUR"
The document id of the invoice. This will be generated, when the invoice will be finalized.
"RE-0000000001"
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none "none"
The invoice address of the invoice.
The notice of the invoice.
"This invoice is with a special discount."
The net amount of the invoice.
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
Show child attributes
Show child attributes
{ "field1": "value1", "field2": "value2" }Show child attributes
Show child attributes
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
"Kundennummer 1234567890 Rechnung 1234567890"
"1234567890"
Show child attributes
Show child attributes
"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"
"Girokonto"
"DE12500105170648489890"
"PBNKDEFFXXX"
"Max Mustermann"
"Commerzbank"
STATUS_RECEIVED, STATUS_BOOKED, STATUS_MANUAL_MATCHING_REQUIRED, STATUS_IGNORED, outstanding_amount, suggestions_available "MAN1234567890"
The source of the bank account transaction.
klarna "klarna"
The type of the bank account transaction.
debit, credit "debit"
The transaction code as defined in ISO 20022. See: https://www.iso20022.org/sites/default/files/2020-08/BTC_ExternalCodeListDescription_31Aug2020.doc
"RCDT"
All assignments to invoices and their transactions. Can be one or multiple, if the bank transaction was split into multiple invoices. Use case: A customer pays multiple invoices with one bank transaction.
Show child attributes
Show child attributes
"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"
Show child attributes
Show child attributes
The unique identifier of the invoice.
"00000000-0000-0000-0000-000000000000"
The customer of the invoice.
Show child attributes
Show child attributes
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
The payment method which should be used to fullfill the payment of the invoice.
Show child attributes
Show child attributes
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider, active, action_required, expired, revoked, gateway_unconfigured "active"
The card data of the payment method, if the type is "card"
Show child attributes
Show child attributes
The brand of the card
"Visa"
The last 4 digits of the card
"4242"
The expiration month of the card
12
The expiration year of the card
2022
The card holder name
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
Show child attributes
Show child attributes
The iban of the sepa mandate
"DE8937*********3232"
The bic of the sepa mandate
"COBADEFFXXX"
The mandate reference of the sepa mandate
"MNDT-2021-123456"
The signing date of the sepa mandate
"2021-01-01T00:00:00+00:00"
The paypal data of the payment method, if the type is "paypal"
Show child attributes
Show child attributes
The email of the paypal account
The billing agreement id of the paypal account
"I-1J5gqz2eZvKYlo2C2X2X2X2X"
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING "TYPE_INVOICE"
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
"EUR"
The document id of the invoice. This will be generated, when the invoice will be finalized.
"RE-0000000001"
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none "none"
The invoice address of the invoice.
The notice of the invoice.
"This invoice is with a special discount."
The net amount of the invoice.
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
Show child attributes
Show child attributes
{ "field1": "value1", "field2": "value2" }Show child attributes
Show child attributes
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
payment, refund "payment"
The status of the transaction.
Possible values:
new: The transaction is new and not yet processed. A new transaction is created when a payment is initiated.authorized: The transaction is authorized and can be captured.authorizing: The transaction is authorizing. No actions can be performed on the transaction.waiting: The transaction is waiting for a response from the payment provider, or a customer input. No actions can be performed on the transaction.offsite_authorization_required: The transaction requires an offsite authorization, e.g. 3D Secure. The customer is informed about the required authorization and redirected to the payment provider.booked: The transaction is captured and booked on the account.captured: The transaction is captured and will be booked on the account.dispute: The transaction is disputed.manual: Legacy status. Do not use.canceled: The transaction is canceled, e.g. by the customer during the payment process, or by the merchant.pending: The transaction is pending, and will be processed soon by the payment provider.expired: The transaction is expired, e.g. because the customer did not complete the payment process in time.processing: The transaction is processing, e.g. because the payment provider is currently processing the payment.failed: The transaction failed, e.g. because the payment provider could not process the payment.unknown: The transaction status is unknown.refunded: The transaction is fully refunded.payedout: The transaction was a payout.partial_refunded: The transaction is partially refunded.refund_failed: The transaction refund failed.
"new"
The description of the transaction.
"Payment for invoice #123"
The internal reference number of the transaction.
"123456789"
The currency code of the transaction.
"EUR"
The original amount which was requested.
500
The amount which was refunded.
The amount which was charged to the payment method.
500
The amount of the transaction fee.
50
The date when the transaction was created.
The date when the transaction was charged.
The amount that is not assigned to any invoice or transaction. Can be negative if the bank transaction is assigned to invoices and transactions with a higher amount than the bank transaction amount.
Was this page helpful?