Get a bank account transaction assignment

GET

payment

bank-account-transaction-assignments

{id}

curl -X GET \
 /payment/bank-account-transaction-assignments/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer": {},
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {},
      "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": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "referencedInvoice": {},
    "type": "TYPE_INVOICE",
    "currencyCode": "EUR",
    "number": "RE-0000000001",
    "status": "STATUS_DRAFT",
    "creationDate": "2023-11-07T05:31:56Z",
    "finalizationDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "lastReminderDate": "2023-11-07T05:31:56Z",
    "lastSentAt": "2023-11-07T05:31:56Z",
    "dunningLevel": 123,
    "dunningStatus": "none",
    "payDate": "2023-11-07T05:31:56Z",
    "invoiceAddress": "<any>",
    "internalNote": "This invoice is with a special discount.",
    "title": "<string>",
    "introduction": "<string>",
    "closing": "<string>",
    "netAmount": {},
    "grossAmount": {},
    "taxAmount": {},
    "discountAmount": {},
    "file": {
      "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
      "isPrivate": true,
      "mimeType": "image/jpeg",
      "fileExtension": "jpg",
      "fileName": "invoice.jpg",
      "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
      "createdAt": "2021-01-01T00:00:00+00:00"
    },
    "xmlFile": {
      "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
      "isPrivate": true,
      "mimeType": "image/jpeg",
      "fileExtension": "jpg",
      "fileName": "invoice.jpg",
      "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
      "createdAt": "2021-01-01T00:00:00+00:00"
    },
    "positions": [
      {
        "id": {},
        "position": 123,
        "quantity": 1,
        "unit": {
          "id": {},
          "name": "Stück"
        },
        "unitPrice": {},
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "discountAmount": {},
        "discountPercentage": 10,
        "name": "My subscription product",
        "description": "* my subscription product",
        "taxGroup": {
          "id": "00000000-0000-0000-0000-000000000000",
          "internalDescription": "19%",
          "reverseChargeType": "REVERSE_CHARGE",
          "type": "standard"
        },
        "tax": {
          "id": "00000000-0000-0000-0000-000000000000",
          "description": "19%",
          "code": "19",
          "rate": 19
        },
        "type": "product",
        "parent": {},
        "group": {
          "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
          "ranking": 1,
          "name": "Subscription #12345"
        },
        "createdAt": "2020-01-01T00:00:00+00:00",
        "product": "https://example.com/",
        "subscriptionItem": "https://example.com/",
        "serviceDateFrom": "2020-01-01T00:00:00+00:00",
        "serviceDateTo": "2020-01-01T00:00:00+00:00"
      }
    ],
    "applicatedExchangeRates": [
      {
        "sourceCurrencyCode": "EUR",
        "destinationCurrencyCode": "CHF",
        "exchangeRate": "1.135",
        "exchangeRateDate": "2023-11-07T05:31:56Z"
      }
    ],
    "eInvoiceType": "<any>",
    "leitwegId": "1234567890123",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "serviceDateFrom": "2023-11-07T05:31:56Z",
    "serviceDateTo": "2023-11-07T05:31:56Z",
    "unpaidAmount": {},
    "usageBreakdownUrl": "<string>",
    "cancellationDocument": {
      "number": "R2021-0001",
      "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
    },
    "dunningDisabled": true,
    "sourceType": "<any>"
  },
  "transaction": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "customer": {},
    "type": "payment",
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {},
      "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": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "gateway": "<any>",
    "status": "<any>",
    "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",
    "failReason": "The payment method was not valid.",
    "authorized": true,
    "refundable": true,
    "processing": true,
    "captured": true,
    "invoice": {
      "id": "00000000-0000-0000-0000-000000000000",
      "customer": {},
      "paymentMethod": {
        "id": "<string>",
        "gatewayName": "wallet",
        "type": "sepa_debit",
        "referenceId": "<string>",
        "default": true,
        "status": "active",
        "source": "api",
        "enabled": true,
        "name": "<string>",
        "data": [
          "<string>"
        ],
        "creationDate": "2023-11-07T05:31:56Z",
        "expirationDate": "2023-11-07T05:31:56Z",
        "sepaMandate": {},
        "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": "max@mustermann.de",
          "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
        }
      },
      "referencedInvoice": {},
      "type": "TYPE_INVOICE",
      "currencyCode": "EUR",
      "number": "RE-0000000001",
      "status": "STATUS_DRAFT",
      "creationDate": "2023-11-07T05:31:56Z",
      "finalizationDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "lastReminderDate": "2023-11-07T05:31:56Z",
      "lastSentAt": "2023-11-07T05:31:56Z",
      "dunningLevel": 123,
      "dunningStatus": "none",
      "payDate": "2023-11-07T05:31:56Z",
      "invoiceAddress": "<any>",
      "internalNote": "This invoice is with a special discount.",
      "title": "<string>",
      "introduction": "<string>",
      "closing": "<string>",
      "netAmount": {},
      "grossAmount": {},
      "taxAmount": {},
      "discountAmount": {},
      "file": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "isPrivate": true,
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg",
        "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
        "createdAt": "2021-01-01T00:00:00+00:00"
      },
      "xmlFile": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "isPrivate": true,
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg",
        "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
        "createdAt": "2021-01-01T00:00:00+00:00"
      },
      "positions": [
        {
          "id": {},
          "position": 123,
          "quantity": 1,
          "unit": {
            "id": {},
            "name": "Stück"
          },
          "unitPrice": {},
          "netAmount": {},
          "grossAmount": {},
          "taxAmount": {},
          "discountAmount": {},
          "discountPercentage": 10,
          "name": "My subscription product",
          "description": "* my subscription product",
          "taxGroup": {
            "id": "00000000-0000-0000-0000-000000000000",
            "internalDescription": "19%",
            "reverseChargeType": "REVERSE_CHARGE",
            "type": "standard"
          },
          "tax": {
            "id": "00000000-0000-0000-0000-000000000000",
            "description": "19%",
            "code": "19",
            "rate": 19
          },
          "type": "product",
          "parent": {},
          "group": {
            "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
            "ranking": 1,
            "name": "Subscription #12345"
          },
          "createdAt": "2020-01-01T00:00:00+00:00",
          "product": "https://example.com/",
          "subscriptionItem": "https://example.com/",
          "serviceDateFrom": "2020-01-01T00:00:00+00:00",
          "serviceDateTo": "2020-01-01T00:00:00+00:00"
        }
      ],
      "applicatedExchangeRates": [
        {
          "sourceCurrencyCode": "EUR",
          "destinationCurrencyCode": "CHF",
          "exchangeRate": "1.135",
          "exchangeRateDate": "2023-11-07T05:31:56Z"
        }
      ],
      "eInvoiceType": "<any>",
      "leitwegId": "1234567890123",
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      },
      "serviceDateFrom": "2023-11-07T05:31:56Z",
      "serviceDateTo": "2023-11-07T05:31:56Z",
      "unpaidAmount": {},
      "usageBreakdownUrl": "<string>",
      "cancellationDocument": {
        "number": "R2021-0001",
        "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
      },
      "dunningDisabled": true,
      "sourceType": "<any>"
    },
    "referenceId": "ch_1J3AJ2"
  },
  "amount": {},
  "fee": {},
  "matchedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

BankAccountTransactionAssignment identifier

Response

200

application/json

BankAccountTransactionAssignment resource

string

Example:

"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"

invoice

object

invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

invoice.customer

object

The customer of the invoice.

invoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

invoice.paymentMethod.id

string

invoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.paymentMethod.referenceId

string | null

invoice.paymentMethod.default

boolean

invoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

invoice.paymentMethod.enabled

boolean

invoice.paymentMethod.name

string | null

invoice.paymentMethod.data

string[]

invoice.paymentMethod.creationDate

string

invoice.paymentMethod.expirationDate

string | null

invoice.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

invoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

invoice.referencedInvoice

object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.

invoice.referencedInvoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

invoice.referencedInvoice.customer

object

The customer of the invoice.

invoice.referencedInvoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

invoice.referencedInvoice.paymentMethod.id

string

invoice.referencedInvoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.referencedInvoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.referencedInvoice.paymentMethod.referenceId

string | null

invoice.referencedInvoice.paymentMethod.default

boolean

invoice.referencedInvoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.referencedInvoice.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

invoice.referencedInvoice.paymentMethod.enabled

boolean

invoice.referencedInvoice.paymentMethod.name

string | null

invoice.referencedInvoice.paymentMethod.data

string[]

invoice.referencedInvoice.paymentMethod.creationDate

string

invoice.referencedInvoice.paymentMethod.expirationDate

string | null

invoice.referencedInvoice.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

invoice.referencedInvoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.referencedInvoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.referencedInvoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

referencedInvoice

object

invoice.referencedInvoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

invoice.referencedInvoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

invoice.referencedInvoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

invoice.referencedInvoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

invoice.referencedInvoice.creationDate

string

invoice.referencedInvoice.finalizationDate

string | null

invoice.referencedInvoice.dueDate

string | null

invoice.referencedInvoice.lastReminderDate

string | null

invoice.referencedInvoice.lastSentAt

string | null

invoice.referencedInvoice.dunningLevel

integer

invoice.referencedInvoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

invoice.referencedInvoice.payDate

string | null

invoice.referencedInvoice.invoiceAddress

any | null

The invoice address of the invoice.

invoice.referencedInvoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

invoice.referencedInvoice.title

string | null

invoice.referencedInvoice.introduction

string | null

invoice.referencedInvoice.closing

string | null

invoice.referencedInvoice.netAmount

object

The net amount of the invoice.

invoice.referencedInvoice.grossAmount

object

invoice.referencedInvoice.taxAmount

object

invoice.referencedInvoice.discountAmount

object

The total net discount amount of the invoice.

invoice.referencedInvoice.file

object | null

invoice.referencedInvoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

invoice.referencedInvoice.positions

object[]

The positions of the invoice.

invoice.referencedInvoice.positions.id

object

invoice.referencedInvoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.referencedInvoice.positions.quantity

object

The quantity of the invoice position item.

invoice.referencedInvoice.positions.unit

object | null

The unit of the invoice position item.

invoice.referencedInvoice.positions.unitPrice

object

The unit price of the invoice position item.

invoice.referencedInvoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

invoice.referencedInvoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.discountAmount

object

The discount amount of the invoice position item.

invoice.referencedInvoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.referencedInvoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.referencedInvoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.referencedInvoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.referencedInvoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.referencedInvoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.referencedInvoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

invoice.referencedInvoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

invoice.referencedInvoice.positions.parent.id

object

invoice.referencedInvoice.positions.parent.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.referencedInvoice.positions.parent.quantity

object

The quantity of the invoice position item.

invoice.referencedInvoice.positions.parent.unit

object | null

The unit of the invoice position item.

invoice.referencedInvoice.positions.parent.unitPrice

object

The unit price of the invoice position item.

invoice.referencedInvoice.positions.parent.netAmount

object

The net amount of the invoice position item, before discount.

invoice.referencedInvoice.positions.parent.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.parent.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.parent.discountAmount

object

The discount amount of the invoice position item.

invoice.referencedInvoice.positions.parent.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.referencedInvoice.positions.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.referencedInvoice.positions.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.referencedInvoice.positions.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.referencedInvoice.positions.parent.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.referencedInvoice.positions.parent.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.referencedInvoice.positions.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

invoice.referencedInvoice.positions.parent.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.referencedInvoice.positions.parent.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.parent.product

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.parent.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.referencedInvoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.product

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

invoice.referencedInvoice.eInvoiceType

any

The einvoice generated xml file format.

invoice.referencedInvoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

invoice.referencedInvoice.customFields

object | null

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

Example:

{ "field1": "value1", "field2": "value2" }

invoice.referencedInvoice.serviceDateFrom

string | null

The earliest service date of all positions.

invoice.referencedInvoice.serviceDateTo

string | null

The latest service date of all positions.

invoice.referencedInvoice.unpaidAmount

object

invoice.referencedInvoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

invoice.referencedInvoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

invoice.referencedInvoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

invoice.referencedInvoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

invoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

invoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

invoice.creationDate

string

invoice.finalizationDate

string | null

invoice.dueDate

string | null

invoice.lastReminderDate

string | null

invoice.lastSentAt

string | null

invoice.dunningLevel

integer

invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

invoice.payDate

string | null

invoice.invoiceAddress

any | null

The invoice address of the invoice.

invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

invoice.title

string | null

invoice.introduction

string | null

invoice.closing

string | null

invoice.netAmount

object

The net amount of the invoice.

invoice.grossAmount

object

invoice.taxAmount

object

invoice.discountAmount

object

The total net discount amount of the invoice.

invoice.file

object | null

invoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

invoice.positions

object[]

The positions of the invoice.

invoice.positions.id

object

invoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.positions.quantity

object

The quantity of the invoice position item.

invoice.positions.unit

object | null

The unit of the invoice position item.

invoice.positions.unitPrice

object

The unit price of the invoice position item.

invoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

invoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.positions.discountAmount

object

The discount amount of the invoice position item.

invoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

invoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

invoice.positions.parent.id

object

invoice.positions.parent.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.positions.parent.quantity

object

The quantity of the invoice position item.

invoice.positions.parent.unit

object | null

The unit of the invoice position item.

invoice.positions.parent.unitPrice

object

The unit price of the invoice position item.

invoice.positions.parent.netAmount

object

The net amount of the invoice position item, before discount.

invoice.positions.parent.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.positions.parent.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.positions.parent.discountAmount

object

The discount amount of the invoice position item.

invoice.positions.parent.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.positions.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.positions.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.positions.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.positions.parent.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.positions.parent.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.positions.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

invoice.positions.parent.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.positions.parent.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.parent.product

string | null

Example:

"https://example.com/"

invoice.positions.parent.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.positions.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.product

string | null

Example:

"https://example.com/"

invoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

invoice.eInvoiceType

any

The einvoice generated xml file format.

invoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

invoice.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

invoice.serviceDateFrom

string | null

The earliest service date of all positions.

invoice.serviceDateTo

string | null

The latest service date of all positions.

invoice.unpaidAmount

object

invoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

invoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

invoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

invoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

transaction

object

transaction.id

string

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

transaction.customer

object

The customer which belongs to the transaction.

transaction.type

enum<string>

default:payment

Available options:

payment,

refund

Example:

"payment"

transaction.paymentMethod

object

The payment method which was used for this transaction.

transaction.paymentMethod.id

string

transaction.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

transaction.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

transaction.paymentMethod.referenceId

string | null

transaction.paymentMethod.default

boolean

transaction.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

transaction.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

transaction.paymentMethod.enabled

boolean

transaction.paymentMethod.name

string | null

transaction.paymentMethod.data

string[]

transaction.paymentMethod.creationDate

string

transaction.paymentMethod.expirationDate

string | null

transaction.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

transaction.paymentMethod.card

object

The card data of the payment method, if the type is "card"

transaction.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

transaction.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

transaction.gateway

any

The payment gateway which was used for this transaction.

Possible values:

paypal: PayPal (supports "paypal")
stripe: Stripe (supports "card")
testing: Testing (supports all)
go_cardless: GoCardless (supports "sepa_debit")
bank_transfer: Bank Transfer (supports "bank_transfer")
sepa_debit: SEPA Credit and Debit with xml file (supports "sepa_debit")
wallet: Credit Balance from Wallet (supports "wallet")

transaction.status

any

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.

transaction.description

string

The description of the transaction.

Example:

"Payment for invoice #123"

transaction.documentNumber

string

The internal reference number of the transaction.

Example:

"123456789"

transaction.currencyCode

object

The currency code of the transaction.

transaction.amount

integer

The original amount which was requested.

Example:

500

transaction.refundedAmount

integer

The amount which was refunded.

transaction.chargedAmount

integer

The amount which was charged to the payment method.

Example:

500

transaction.feeAmount

integer | null

The amount of the transaction fee.

Example:

50

transaction.createdAt

string

The date when the transaction was created.

transaction.paidAt

string | null

The date when the transaction was charged.

transaction.failReason

string | null

The reason why the transaction failed.

Example:

"The payment method was not valid."

transaction.authorized

boolean

Describes if the transaction is authorized and can be captured.

Example:

true

transaction.refundable

boolean

Describes if the transaction is refundable.

Example:

true

transaction.processing

boolean

Describes if the transaction is currently processing and cannot perform any actions.

Example:

true

transaction.captured

boolean

Describes if the transaction is sucessful processed.

Example:

true

transaction.invoice

object | null

The invoice which belongs to the transaction. Can be null if the transaction is not related to an invoice.

transaction.invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

transaction.invoice.customer

object

The customer of the invoice.

transaction.invoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

transaction.invoice.paymentMethod.id

string

transaction.invoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

transaction.invoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

transaction.invoice.paymentMethod.referenceId

string | null

transaction.invoice.paymentMethod.default

boolean

transaction.invoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

transaction.invoice.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

transaction.invoice.paymentMethod.enabled

boolean

transaction.invoice.paymentMethod.name

string | null

transaction.invoice.paymentMethod.data

string[]

transaction.invoice.paymentMethod.creationDate

string

transaction.invoice.paymentMethod.expirationDate

string | null

transaction.invoice.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

transaction.invoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

transaction.invoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

transaction.invoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

transaction.invoice.referencedInvoice

object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.

transaction.invoice.referencedInvoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

transaction.invoice.referencedInvoice.customer

object

The customer of the invoice.

transaction.invoice.referencedInvoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

referencedInvoice

object

transaction.invoice.referencedInvoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

transaction.invoice.referencedInvoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

transaction.invoice.referencedInvoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

transaction.invoice.referencedInvoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

transaction.invoice.referencedInvoice.creationDate

string

transaction.invoice.referencedInvoice.finalizationDate

string | null

transaction.invoice.referencedInvoice.dueDate

string | null

transaction.invoice.referencedInvoice.lastReminderDate

string | null

transaction.invoice.referencedInvoice.lastSentAt

string | null

transaction.invoice.referencedInvoice.dunningLevel

integer

transaction.invoice.referencedInvoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

transaction.invoice.referencedInvoice.payDate

string | null

transaction.invoice.referencedInvoice.invoiceAddress

any | null

The invoice address of the invoice.

transaction.invoice.referencedInvoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

transaction.invoice.referencedInvoice.title

string | null

transaction.invoice.referencedInvoice.introduction

string | null

transaction.invoice.referencedInvoice.closing

string | null

transaction.invoice.referencedInvoice.netAmount

object

The net amount of the invoice.

transaction.invoice.referencedInvoice.grossAmount

object

transaction.invoice.referencedInvoice.taxAmount

object

transaction.invoice.referencedInvoice.discountAmount

object

The total net discount amount of the invoice.

transaction.invoice.referencedInvoice.file

object | null

transaction.invoice.referencedInvoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

transaction.invoice.referencedInvoice.positions

object[]

The positions of the invoice.

transaction.invoice.referencedInvoice.positions.id

object

transaction.invoice.referencedInvoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

transaction.invoice.referencedInvoice.positions.quantity

object

The quantity of the invoice position item.

transaction.invoice.referencedInvoice.positions.unit

object | null

The unit of the invoice position item.

transaction.invoice.referencedInvoice.positions.unitPrice

object

The unit price of the invoice position item.

transaction.invoice.referencedInvoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

transaction.invoice.referencedInvoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

transaction.invoice.referencedInvoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

transaction.invoice.referencedInvoice.positions.discountAmount

object

The discount amount of the invoice position item.

transaction.invoice.referencedInvoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

transaction.invoice.referencedInvoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

transaction.invoice.referencedInvoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

transaction.invoice.referencedInvoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

transaction.invoice.referencedInvoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

transaction.invoice.referencedInvoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

transaction.invoice.referencedInvoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

transaction.invoice.referencedInvoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

transaction.invoice.referencedInvoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

transaction.invoice.referencedInvoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.referencedInvoice.positions.product

string | null

Example:

"https://example.com/"

transaction.invoice.referencedInvoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

transaction.invoice.referencedInvoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.referencedInvoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.referencedInvoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

transaction.invoice.referencedInvoice.eInvoiceType

any

The einvoice generated xml file format.

transaction.invoice.referencedInvoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

transaction.invoice.referencedInvoice.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

transaction.invoice.referencedInvoice.serviceDateFrom

string | null

The earliest service date of all positions.

transaction.invoice.referencedInvoice.serviceDateTo

string | null

The latest service date of all positions.

transaction.invoice.referencedInvoice.unpaidAmount

object

transaction.invoice.referencedInvoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

transaction.invoice.referencedInvoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

transaction.invoice.referencedInvoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

transaction.invoice.referencedInvoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

transaction.invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

transaction.invoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

transaction.invoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

transaction.invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

transaction.invoice.creationDate

string

transaction.invoice.finalizationDate

string | null

transaction.invoice.dueDate

string | null

transaction.invoice.lastReminderDate

string | null

transaction.invoice.lastSentAt

string | null

transaction.invoice.dunningLevel

integer

transaction.invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

transaction.invoice.payDate

string | null

transaction.invoice.invoiceAddress

any | null

The invoice address of the invoice.

transaction.invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

transaction.invoice.title

string | null

transaction.invoice.introduction

string | null

transaction.invoice.closing

string | null

transaction.invoice.netAmount

object

The net amount of the invoice.

transaction.invoice.grossAmount

object

transaction.invoice.taxAmount

object

transaction.invoice.discountAmount

object

The total net discount amount of the invoice.

transaction.invoice.file

object | null

transaction.invoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

transaction.invoice.positions

object[]

The positions of the invoice.

transaction.invoice.positions.id

object

transaction.invoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

transaction.invoice.positions.quantity

object

The quantity of the invoice position item.

transaction.invoice.positions.unit

object | null

The unit of the invoice position item.

transaction.invoice.positions.unitPrice

object

The unit price of the invoice position item.

transaction.invoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

transaction.invoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

transaction.invoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

transaction.invoice.positions.discountAmount

object

The discount amount of the invoice position item.

transaction.invoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

transaction.invoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

transaction.invoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

transaction.invoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

transaction.invoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

transaction.invoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

transaction.invoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

transaction.invoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

transaction.invoice.positions.parent.id

object

transaction.invoice.positions.parent.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

transaction.invoice.positions.parent.quantity

object

The quantity of the invoice position item.

transaction.invoice.positions.parent.unit

object | null

The unit of the invoice position item.

transaction.invoice.positions.parent.unitPrice

object

The unit price of the invoice position item.

transaction.invoice.positions.parent.netAmount

object

The net amount of the invoice position item, before discount.

transaction.invoice.positions.parent.grossAmount

object

The gross amount of the invoice position item, after discount.

transaction.invoice.positions.parent.taxAmount

object

The tax amount of the invoice position item, after discount.

transaction.invoice.positions.parent.discountAmount

object

The discount amount of the invoice position item.

transaction.invoice.positions.parent.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

transaction.invoice.positions.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

transaction.invoice.positions.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

transaction.invoice.positions.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

transaction.invoice.positions.parent.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

transaction.invoice.positions.parent.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

transaction.invoice.positions.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

transaction.invoice.positions.parent.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

transaction.invoice.positions.parent.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.positions.parent.product

string | null

Example:

"https://example.com/"

transaction.invoice.positions.parent.subscriptionItem

string | null

Example:

"https://example.com/"

transaction.invoice.positions.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.positions.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

transaction.invoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.positions.product

string | null

Example:

"https://example.com/"

transaction.invoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

transaction.invoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

transaction.invoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

transaction.invoice.eInvoiceType

any

The einvoice generated xml file format.

transaction.invoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

transaction.invoice.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

transaction.invoice.serviceDateFrom

string | null

The earliest service date of all positions.

transaction.invoice.serviceDateTo

string | null

The latest service date of all positions.

transaction.invoice.unpaidAmount

object

transaction.invoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

transaction.invoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

transaction.invoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

transaction.invoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

transaction.referenceId

string | null

The reference id of the payment provider.

Example:

"ch_1J3AJ2"

amount

object

fee

object

matchedAt

string

Disconnect open banking account Get bank account transactions

curl -X GET \
 /payment/bank-account-transaction-assignments/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer": {},
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {},
      "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": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "referencedInvoice": {},
    "type": "TYPE_INVOICE",
    "currencyCode": "EUR",
    "number": "RE-0000000001",
    "status": "STATUS_DRAFT",
    "creationDate": "2023-11-07T05:31:56Z",
    "finalizationDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "lastReminderDate": "2023-11-07T05:31:56Z",
    "lastSentAt": "2023-11-07T05:31:56Z",
    "dunningLevel": 123,
    "dunningStatus": "none",
    "payDate": "2023-11-07T05:31:56Z",
    "invoiceAddress": "<any>",
    "internalNote": "This invoice is with a special discount.",
    "title": "<string>",
    "introduction": "<string>",
    "closing": "<string>",
    "netAmount": {},
    "grossAmount": {},
    "taxAmount": {},
    "discountAmount": {},
    "file": {
      "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
      "isPrivate": true,
      "mimeType": "image/jpeg",
      "fileExtension": "jpg",
      "fileName": "invoice.jpg",
      "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
      "createdAt": "2021-01-01T00:00:00+00:00"
    },
    "xmlFile": {
      "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
      "isPrivate": true,
      "mimeType": "image/jpeg",
      "fileExtension": "jpg",
      "fileName": "invoice.jpg",
      "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
      "createdAt": "2021-01-01T00:00:00+00:00"
    },
    "positions": [
      {
        "id": {},
        "position": 123,
        "quantity": 1,
        "unit": {
          "id": {},
          "name": "Stück"
        },
        "unitPrice": {},
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "discountAmount": {},
        "discountPercentage": 10,
        "name": "My subscription product",
        "description": "* my subscription product",
        "taxGroup": {
          "id": "00000000-0000-0000-0000-000000000000",
          "internalDescription": "19%",
          "reverseChargeType": "REVERSE_CHARGE",
          "type": "standard"
        },
        "tax": {
          "id": "00000000-0000-0000-0000-000000000000",
          "description": "19%",
          "code": "19",
          "rate": 19
        },
        "type": "product",
        "parent": {},
        "group": {
          "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
          "ranking": 1,
          "name": "Subscription #12345"
        },
        "createdAt": "2020-01-01T00:00:00+00:00",
        "product": "https://example.com/",
        "subscriptionItem": "https://example.com/",
        "serviceDateFrom": "2020-01-01T00:00:00+00:00",
        "serviceDateTo": "2020-01-01T00:00:00+00:00"
      }
    ],
    "applicatedExchangeRates": [
      {
        "sourceCurrencyCode": "EUR",
        "destinationCurrencyCode": "CHF",
        "exchangeRate": "1.135",
        "exchangeRateDate": "2023-11-07T05:31:56Z"
      }
    ],
    "eInvoiceType": "<any>",
    "leitwegId": "1234567890123",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "serviceDateFrom": "2023-11-07T05:31:56Z",
    "serviceDateTo": "2023-11-07T05:31:56Z",
    "unpaidAmount": {},
    "usageBreakdownUrl": "<string>",
    "cancellationDocument": {
      "number": "R2021-0001",
      "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
    },
    "dunningDisabled": true,
    "sourceType": "<any>"
  },
  "transaction": {
    "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
    "customer": {},
    "type": "payment",
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "referenceId": "<string>",
      "default": true,
      "status": "active",
      "source": "api",
      "enabled": true,
      "name": "<string>",
      "data": [
        "<string>"
      ],
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "sepaMandate": {},
      "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": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "gateway": "<any>",
    "status": "<any>",
    "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",
    "failReason": "The payment method was not valid.",
    "authorized": true,
    "refundable": true,
    "processing": true,
    "captured": true,
    "invoice": {
      "id": "00000000-0000-0000-0000-000000000000",
      "customer": {},
      "paymentMethod": {
        "id": "<string>",
        "gatewayName": "wallet",
        "type": "sepa_debit",
        "referenceId": "<string>",
        "default": true,
        "status": "active",
        "source": "api",
        "enabled": true,
        "name": "<string>",
        "data": [
          "<string>"
        ],
        "creationDate": "2023-11-07T05:31:56Z",
        "expirationDate": "2023-11-07T05:31:56Z",
        "sepaMandate": {},
        "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": "max@mustermann.de",
          "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
        }
      },
      "referencedInvoice": {},
      "type": "TYPE_INVOICE",
      "currencyCode": "EUR",
      "number": "RE-0000000001",
      "status": "STATUS_DRAFT",
      "creationDate": "2023-11-07T05:31:56Z",
      "finalizationDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "lastReminderDate": "2023-11-07T05:31:56Z",
      "lastSentAt": "2023-11-07T05:31:56Z",
      "dunningLevel": 123,
      "dunningStatus": "none",
      "payDate": "2023-11-07T05:31:56Z",
      "invoiceAddress": "<any>",
      "internalNote": "This invoice is with a special discount.",
      "title": "<string>",
      "introduction": "<string>",
      "closing": "<string>",
      "netAmount": {},
      "grossAmount": {},
      "taxAmount": {},
      "discountAmount": {},
      "file": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "isPrivate": true,
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg",
        "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
        "createdAt": "2021-01-01T00:00:00+00:00"
      },
      "xmlFile": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "isPrivate": true,
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg",
        "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
        "createdAt": "2021-01-01T00:00:00+00:00"
      },
      "positions": [
        {
          "id": {},
          "position": 123,
          "quantity": 1,
          "unit": {
            "id": {},
            "name": "Stück"
          },
          "unitPrice": {},
          "netAmount": {},
          "grossAmount": {},
          "taxAmount": {},
          "discountAmount": {},
          "discountPercentage": 10,
          "name": "My subscription product",
          "description": "* my subscription product",
          "taxGroup": {
            "id": "00000000-0000-0000-0000-000000000000",
            "internalDescription": "19%",
            "reverseChargeType": "REVERSE_CHARGE",
            "type": "standard"
          },
          "tax": {
            "id": "00000000-0000-0000-0000-000000000000",
            "description": "19%",
            "code": "19",
            "rate": 19
          },
          "type": "product",
          "parent": {},
          "group": {
            "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
            "ranking": 1,
            "name": "Subscription #12345"
          },
          "createdAt": "2020-01-01T00:00:00+00:00",
          "product": "https://example.com/",
          "subscriptionItem": "https://example.com/",
          "serviceDateFrom": "2020-01-01T00:00:00+00:00",
          "serviceDateTo": "2020-01-01T00:00:00+00:00"
        }
      ],
      "applicatedExchangeRates": [
        {
          "sourceCurrencyCode": "EUR",
          "destinationCurrencyCode": "CHF",
          "exchangeRate": "1.135",
          "exchangeRateDate": "2023-11-07T05:31:56Z"
        }
      ],
      "eInvoiceType": "<any>",
      "leitwegId": "1234567890123",
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      },
      "serviceDateFrom": "2023-11-07T05:31:56Z",
      "serviceDateTo": "2023-11-07T05:31:56Z",
      "unpaidAmount": {},
      "usageBreakdownUrl": "<string>",
      "cancellationDocument": {
        "number": "R2021-0001",
        "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
      },
      "dunningDisabled": true,
      "sourceType": "<any>"
    },
    "referenceId": "ch_1J3AJ2"
  },
  "amount": {},
  "fee": {},
  "matchedAt": "2023-11-07T05:31:56Z"
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get a bank account transaction assignment

Authorizations

Path Parameters

Response