Zum Hauptinhalt springen
PUT
/
payment
/
bank-account-transactions
/
{id}
/
assign-invoices
cURL
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": {}
}

Autorisierungen

​
Authorization
string
header
erforderlich

Value for the Authorization header parameter.

Pfadparameter

​
id
string
erforderlich

BankAccountTransaction identifier

Body

The updated BankAccountTransaction resource

​
invoiceIds
string[]
Minimum array length: 1
Beispiel:
["ad8f1b9e-1b9e-4c4c-8f1b-9e1b9e4c4c8f"]

Antwort

BankAccountTransaction resource updated

​
id
string
​
suggestedInvoice
object
​
suggestedCustomer
object
​
valueDate
string<date-time>
​
bookingDate
string<date-time>
​
paymentDate
string<date-time>
​
usageDescription
string
Beispiel:

"Kundennummer 1234567890 Rechnung 1234567890"

​
endToEndId
string | null
Beispiel:

"1234567890"

​
counterParty
object
​
amount
object
​
fee
object
​
status
enum<string>
Verfügbare Optionen:
STATUS_RECEIVED,
STATUS_BOOKED,
STATUS_MANUAL_MATCHING_REQUIRED,
STATUS_IGNORED,
outstanding_amount,
suggestions_available
​
receivedAt
string<date-time>
​
bookedAt
string<date-time> | null
​
mandateId
string | null
Beispiel:

"MAN1234567890"

​
source
enum<string>

The source of the bank account transaction.

Verfügbare Optionen:
klarna
Beispiel:

"klarna"

​
type
enum<string>

The type of the bank account transaction.

Verfügbare Optionen:
debit,
credit
Beispiel:

"debit"

​
transactionCode
string | null

The transaction code as defined in ISO 20022. See: https://www.iso20022.org/sites/default/files/2020-08/BTC_ExternalCodeListDescription_31Aug2020.doc

Beispiel:

"RCDT"

​
assignments
object[]

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.

​
unassignedAmount
object

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.