Dokumentation
Dokumentation
Analytics-Schema BETA
account account
  • active
    boolean
    Aktiv heisst, dass dieser Account und alle Accounts in der darauffolgenden Hierarchie aktiv sind.
  • activeOrRestrictedActive
    boolean
    Dieses Property ist 'true', sofern alle Accounts in der Hierarchie aktiv sind.
  • createdBy
    bigint
    Die ID des Benutzers, welcher diese Entität erstellt hat.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, wann diese Entität erstellt wurde.
  • deletedBy
    bigint
    Die ID des Benutzers, der diese Entität gelöscht hat.
  • deletedOn
    timestamp
    Das Datum und die Uhrzeit, wann diese Entität gelöscht wurde.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    Das Datum und die Uhrzeit der letzten Änderung des Objekts.
  • name
    string
    Der Name des Accounts identifiziert den Account innerhalb der Administrationsoberfläche.
  • parentAccount
    bigint
    Der Benutzer, welcher für den Account administrieren kann.
  • restrictedActive
    boolean
    Eingeschränkt aktiv heisst, dass mindestens ein account in der Hierarchie eingeschränkt aktiv ist, aber alle Accounts in der Hierarchie sind eingeschränkt aktiv oder voll aktiv.
  • scope
    bigint
    Dies gibt den Scope an, zu welchem der Account gehört.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subaccountLimit
    bigint
    Dieses Feld schränkt die Anzahl möglicher Subaccounts ein.
  • type
    string
    Der Account-Typ definiert, welche Rolle und welche Fähigkeiten der Account hat.
failurereason failurereason
  • category
    string
     
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
labeldescriptor labeldescriptor
  • category
    string
     
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • group
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • weight
    int
     
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • weight
    int
     
space space
  • account
    bigint
    Der Account, zu welchem der Space dazugehört.
  • active
    boolean
    Aktiv heisst, dass dieser Account und alle Accounts in der darauffolgenden Hierarchie aktiv sind.
  • activeOrRestrictedActive
    boolean
    Dieses Property ist 'true', sofern alle Accounts in der Hierarchie aktiv sind.
  • createdBy
    bigint
    Die ID des Benutzers, welcher diese Entität erstellt hat.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, wann diese Entität erstellt wurde.
  • deletedBy
    bigint
    Die ID des Benutzers, der diese Entität gelöscht hat.
  • deletedOn
    timestamp
    Das Datum und die Uhrzeit, wann diese Entität gelöscht wurde.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    Das Datum und die Uhrzeit der letzten Änderung des Objekts.
  • name
    string
    Der Spacename wird nicht extern angezeigt. Er dient zur Identifikation in der Administrationsoberfläche. Er sollte eindeutig sein und sich klar unterscheiden von anderen Spacenamen.
  • postalAddress
    struct
    Diese Adresse wird in der Kommunikation mit Kunden verwendet, zum Beispiel in E-Mails oder in Dokumenten.
  • postalAddress.city
    string
     
  • postalAddress.country
    string
     
  • postalAddress.dependentLocality
    string
     
  • postalAddress.emailAddress
    string
     
  • postalAddress.familyName
    string
     
  • postalAddress.givenName
    string
     
  • postalAddress.mobilePhoneNumber
    string
     
  • postalAddress.organizationName
    string
     
  • postalAddress.phoneNumber
    string
     
  • postalAddress.postalState
    string
     
  • postalAddress.postcode
    string
     
  • postalAddress.salesTaxNumber
    string
     
  • postalAddress.salutation
    string
     
  • postalAddress.sortingCode
    string
     
  • postalAddress.street
    string
     
  • primaryCurrency
    string
    Dies ist die Währung, welche für die Darstellung von aggregierten Währungsbeträgen verwendet wird.
  • requestLimit
    bigint
    Die Request-Limite legt fest, wie viele API Anfragen innerhalb von 2 Minuten für diesen Space akzeptiert werden. Dieses Limit kann nur mittels speziellen Privilegien verändert werden.
  • restrictedActive
    boolean
    Eingeschränkt aktiv heisst, dass mindestens ein account in der Hierarchie eingeschränkt aktiv ist, aber alle Accounts in der Hierarchie sind eingeschränkt aktiv oder voll aktiv.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • technicalContactAddresses
    array
    Die Kontakt-E-Mail-Adresse wird über technische Probleme oder Fehler benachrichtigt, welche im Space auftreten.
  • timeZone
    string
    Die Zeitzone auf dem Space dient dazu Datumsberechnungen durchzuführen. Dies wird primär für Hintergrundprozesse verwendet, welche zu einer bestimmten Zeit des Tages laufen sollen. Das Ändern der Zeitzone auf dem Space ändert die Darstellung der Daten im Space nicht.
legalorganizationform legalorganizationform
  • country
    string
     
  • description
    array
     
  • englishDescription
    string
     
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
     
customer customer
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customerId
    string
     
  • emailAddress
    string
     
  • familyName
    string
     
  • givenName
    string
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Meta Daten erlauben es weitere Informationen mit dem Objekt zusammen abzulegen.
  • preferredCurrency
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
customeraddress customeraddress
  • address
    struct
     
  • address.city
    string
     
  • address.commercialRegisterNumber
    string
     
  • address.country
    string
     
  • address.dateOfBirth
    date
     
  • address.dependentLocality
    string
     
  • address.emailAddress
    string
     
  • address.familyName
    string
     
  • address.gender
    string
     
  • address.givenName
    string
     
  • address.legalOrganizationForm
    bigint
     
  • address.mobilePhoneNumber
    string
     
  • address.organizationName
    string
     
  • address.phoneNumber
    string
     
  • address.postalState
    string
     
  • address.postcode
    string
     
  • address.salesTaxNumber
    string
     
  • address.salutation
    string
     
  • address.socialSecurityNumber
    string
     
  • address.sortingCode
    string
     
  • address.street
    string
     
  • addressType
    string
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customer
    bigint
     
  • defaultAddress
    boolean
     
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
saleschannel saleschannel
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • parent
    bigint
     
  • sortOrder
    int
     
paymentconnector paymentconnector
  • dataCollectionType
    string
     
  • deprecated
    boolean
     
  • deprecationReason
    map
     
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • paymentMethod
    bigint
     
  • paymentMethodBrand
    bigint
     
  • primaryRiskTaker
    string
     
  • processor
    bigint
     
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Dieses Property zeigt an, ob der Connector zurzeit für die Verarbeitung von Transaktionen genutzt werden kann. Wenn weder die zugewiesene Zahlungsmethode noch die zugewiesene Connector-Konfiguration aktiv ist, wird der Verarbeiter nicht genutzt, auch wenn er aktiv ist.
  • connector
    bigint
     
  • enabledSalesChannels
    array
    Definiert die Verkaufskanäle, für die die Connector-Konfiguration aktiviert ist. Wenn keiner angewählt ist, ist die Connector-Konfiguration für alle Verkaufskanäle aktiviert.
  • enabledSpaceViews
    array
    Die Connector-Konfiguration ist nur für ausgewählte Space Views aktiv. Wenn Sie diese Einstellungen leer lassen, ist die Konfiguration für alle Spaces aktiv.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name der Connector-Konfiguration wird intern zur Identifizierung der Konfiguration in administrativen Interfaces verwendet. Beispielsweise in Suchfeldern, weshalb er klar und deskriptiv sein sollte.
  • paymentMethodConfiguration
    bigint
     
  • priority
    int
    Die Priorität definiert die Reihenfolge der Konfigurationen des Connectors. Je tiefer der Wert, desto höher die Priorität. Dieser Wert kann auch eine negative Zahl sein, falls Sie weitere Konfigurationen hinzufügen, die eine hohe Priorität haben sollen, und Sie die Werte aller bestehenden Konfigurationen nicht ändern möchten.
  • processorConfiguration
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
     
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • supportedCurrencies
    array
     
paymentmethodbrand paymentmethodbrand
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • paymentMethod
    bigint
     
paymentmethodconfiguration paymentmethodconfiguration

Die Konfiguration der Zahlungsmethode ist die Voraussetzung, um einen Verarbeiter mit der konkreten Konfiguration zu verbinden.

Die Konfiguration der Zahlungsmethode ist die Voraussetzung, um einen Verarbeiter mit der konkreten Konfiguration zu verbinden.
  • dataCollectionType
    string
    Der Datenerfassungstyp bestimmt, wer die Zahlungsinformationen sammelt. Dies kann entweder durch den Verarbeiter (offsite) oder durch unsere Applikation (onsite) erfolgen.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name der Konfiguration der Zahlart wird intern zur Identifizierung der Konfiguration der Zahlart verwendet. Beispielsweise wird der Name in Suchfeldern verwendet und sollte daher klar und deskriptiv sein.
  • oneClickPaymentMode
    string
    Wenn der Käufer auf der Payment Page die Zahlungsdetails erfasst, können diese automatisch gespeichert werden. Der Käufer kann diese zu einem späteren Zeitpunkt für andere Zahlungen wieder verwenden. Wenn die Transaktion bereits einen Token enthält, dann hat diese Option keinen Einfluss.
  • paymentMethod
    bigint
     
  • resolvedDescription
    map
    Die aufgelöste Beschreibung verwendet die definierte Beschreibung oder, wenn diese nicht definiert wurde, die Standard-Beschreibung.
  • resolvedTitle
    map
    Der aufgelöste Titel verwendet den definierten Titel oder, wenn dieser nicht definiert wurde, den Standard-Titel.
  • sortOrder
    int
    Die Sortierfolge der Zahlungsmethoden definiert, in welcher Reihenfolge die Zahlungsmethoden dem Kunden während des Zahlungsprozesses angezeigt werden.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentprocessor paymentprocessor
  • companyName
    map
     
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • headquartersLocation
    map
     
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
  • productName
    map
     
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    Die Konfiguration wird von der Anwendung verwaltet und kann nicht über die Benutzeroberfläche geändert werden.
  • contractId
    bigint
    Der Vertrag verknüpft die Zahlungsverarbeiterkonfiguration mit dem Vertrag des Zahlungsverarbeiters.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name der Verarbeiterkonfigurationen wird intern zur Identifizierung einer spezifischen Verarbeiterkonfiguration verwendet. Beispielsweise wird der Name in Suchfeldern verwendet und sollte daher klar und deskriptiv sein.
  • processor
    bigint
    Ein Verarbeiter repräsentiert einen Zahlungsverarbeiter (Payment Service Provider) in der Applikation. Sie können für einen Verarbeiter mehrere Konfigurationen für unterschiedliche Zwecke vornehmen.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
refund refund

Eine Gutschrift ist eine Rücküberweisung an den Kunden. Diese kann entweder durch den Händler oder durch den Kunden (Chargeback) ausgelöst werden.

Eine Gutschrift ist eine Rücküberweisung an den Kunden. Diese kann entweder durch den Händler oder durch den Kunden (Chargeback) ausgelöst werden.
  • amount
    decimal
     
  • baseLineItems
    array
     
  • completion
    bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • environment
    string
     
  • externalId
    string
    Die External ID hilft dabei, wiederholte Anrufe an den Gutschriften-Service zu identifizieren. Daher sollte die External ID für jede Transaktion unique sein.
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • labels
    array
     
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • nextUpdateOn
    timestamp
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • reducedLineItems
    array
     
  • reductions
    array
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    Die Summe der Gebühren ist der gesamte Betrag welcher bisher an Gebühren bezahlt wurde.
  • totalSettledAmount
    decimal
    Die Summe der bezahlten Beträge ist der gesamte Betrag welcher bisher bezahlt wurde.
  • transaction
    bigint
     
  • type
    string
     
  • updatedInvoice
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentterminal paymentterminal
  • defaultCurrency
    string
     
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    Die Kennung identifiziert das Terminal eindeutig. Normalerweise ist es auf dem Gerät oder in der Anzeige des Gerätes sichtbar.
  • name
    string
    Der Terminalname wird intern verwendet, um das Terminal in administrativen Schnittstellen zu identifizieren. Beispielsweise wird es innerhalb von Suchfeldern verwendet und sollte daher klar und anschaulich sein.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • type
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentterminaltype paymentterminaltype
  • description
    map
    Die Beschreibung des Objekts wird in verschiedene Sprachen übersetzt.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der Name des Objekts wird in verschiedene Sprachen übersetzt.
token token
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customerEmailAddress
    string
    Die Kunden-E-Mail-Adresse entspricht der Käufer-E-Mail-Adresse.
  • customerId
    string
    Die Kunden-ID identifiziert den Kunden im Händlersystem. Im Fall, dass eine Kunden-ID zur Verfügung gestellt wird, muss diese mit der Kunden-ID auf der Transaktion übereinstimmen. Die Kunden-ID wird nicht automatisch gesetzt oder verändert. Die Kunden-ID muss durch das Händlersystem gesetzt werden.
  • enabledForOneClickPayment
    boolean
    Wenn der Token für One-Click-Zahlungen aktiviert ist, kann der Käufer diesen Token verwenden, um auf der Payment Page mit diesem Token zu bezahlen. Die Verwendung des Tokens reduziert die Anzahl Schritte, die der Käufer durchlaufen muss. Der Käufer wird über die Kunden-ID auf der Transaktion und auf dem Token verknüpft. Damit One-Click-Zahlungen funktionieren, muss die Zahlweise auch so konfiguriert sein, dass sie One-Click-Zahlungen zulässt.
  • externalId
    string
    Eine vom Client generierte eindeutige ID, welche die Entity identifiziert, die erzeugt werden soll. Nachfolgende Anfragen mit derselben externen ID werden keine neue Entity erzeugen sondern stattdessen die ursprünglich erzeugte zurück geben.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • timeZone
    string
    Die Zeitzone definiert die Zeitzone des Kunden. Die Zeitzone beeinflusst die Formatierung der Daten in der Kommunikation mit dem Kunden.
  • tokenReference
    string
    Nutzen Sie eine deskriptive Beschreibung. Dies hilft Ihnen, den Token wiederzufinden (z.B. Benutzer-ID, E-Mail-Adresse).
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
transaction transaction
  • acceptHeader
    string
     
  • acceptLanguageHeader
    string
    Der Accepted Language Header beinhaltet die Sprachpräferenz des Benutzers.
  • allowedPaymentMethodBrands
    array
     
  • allowedPaymentMethodConfigurations
    array
     
  • authorizationAmount
    decimal
     
  • authorizationEnvironment
    string
    Die Umgebung, in der diese Transaktion erfolgreich autorisiert wurde.
  • authorizationSalesChannel
    bigint
    Der Verkaufskanal, über den die Transaktion platziert wurde.
  • authorizationTimeoutOn
    timestamp
    Dies ist das Timeout, welches angewendet wird, wenn die Transaktion autorisiert wird. Dieses Timeout kann sich über die Zeit verändern.
  • authorizedOn
    timestamp
     
  • autoConfirmationEnabled
    boolean
    Wenn die automatische Bestätigung aktiviert ist, wird die Transaktion automatisch bestätigt, wenn dies vom Ablauf her nötig ist. Wenn die automatische Bestätigung deaktiviert ist, muss dies manuell gemacht werden.
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • billingAddress.legalOrganizationForm
    bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • chargeRetryEnabled
    boolean
    Falls das Belasten des Kunden fehlschlägt, können wir es erneut versuchen. Dies impliziert, dass wir den Kunden zurück auf die Payment Page leiten. Der Kunde kann dann erneut versuchen, die Zahlung abzuschliessen. Der Wiederholungsversuch ist in den Standardeinstellungen eingepflegt.
  • completedAmount
    decimal
    Der verbuchte Betrag ist der Gesamtbetrag, der gebucht wurde.
  • completedOn
    timestamp
     
  • completionBehavior
    string
    Das Transaktionsabschlussverhalten steuert wie die Transaktion verbucht wird.
  • completionTimeoutOn
    timestamp
     
  • confirmedBy
    bigint
     
  • confirmedOn
    timestamp
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • currency
    string
     
  • customerEmailAddress
    string
    Die Kunden-E-Mail-Adresse wird verwendet, wenn keine Liefer- oder Rechnungs-E-Mail-Adresse zur Verfügung steht.
  • customerId
    string
     
  • customersPresence
    string
    Die Anwesenheit des Kunden gibt an, welche Art von Authentifizierungsmethode letztendlich bei der Autorisierung der Transaktion verwendet wurde. Wird kein Wert angegeben, wird standardmäßig 'Virtually Present' verwendet.
  • deliveryDecisionMadeOn
    timestamp
    Das Lieferentscheidungsdatum gibt an, wann die Entscheidung gemacht wurde, ob geliefert werden soll.
  • deviceSessionIdentifier
    string
    Der Geräte-Session-Identifier verlinkt die Transaktion mit dem Session Identifier, welcher in der URL des JavaScripts angegeben wurde. Dies ermöglich die Verlinkung der Gerätedaten mit der Transaktion.
  • emailsDisabled
    boolean
    Flag, welches das Absenden von E-Mails für diese Transaktion ausschaltet. In der Grundeinstellung werden E-Mails gesendet.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    Die Umgebungsauswahl-Strategy definiert, wie die Umgebung (Test oder Live) ausgewählt wird.
  • failedOn
    timestamp
     
  • failedUrl
    string
    Der Benutzer wird auf die Failed URL umgeleitet, falls die Transaktion nicht autorisiert oder fertiggestellt werden konnte. Falls keine Failed URL spezifiziert ist, wird eine Standard Failed URL angezeigt.
  • failureReason
    bigint
    Die Fehlerbegründung beschreibt, weshalb die Transaktion fehlgeschlagen ist. Diese Begründung wird nur gesetzt, wenn die Transaktion fehlgeschlagen ist.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    Die Internet-Protocol-(IP)-Adresse identifiziert das Gerät des Käufers.
  • internetProtocolAddressCountry
    string
     
  • invoiceMerchantReference
    string
     
  • javaEnabled
    boolean
     
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • metaData
    map
    Meta Daten erlauben es weitere Informationen mit dem Objekt zusammen abzulegen.
  • parent
    bigint
     
  • paymentConnectorConfiguration
    bigint
     
  • processingOn
    timestamp
     
  • refundedAmount
    decimal
    Der gutgeschriebene Betrag entspricht dem Total aller Gutschriften.
  • screenColorDepth
    string
     
  • screenHeight
    string
     
  • screenWidth
    string
     
  • shippingAddress
    struct
     
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • shippingAddress.legalOrganizationForm
    bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • shippingMethod
    string
     
  • spaceViewId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • successUrl
    string
    Der Benutzer wird auf die Success URL umgeleitet, sobald die Transaktion autorisiert oder fertiggestellt wurde. Falls keine Success URL spezifiert ist, wird eine Standard Success URL angezeigt.
  • terminal
    bigint
    Das Terminal, an dem die Zahlung verarbeitet wurde.
  • timeZone
    string
    Die Zeitzone definiert die Zeitzone des Kunden. Die Zeitzone beeinflusst die Formatierung der Daten in der Kommunikation mit dem Kunden.
  • token
    bigint
     
  • tokenizationMode
    string
    Der Tokenisierungsmodus steuert, ob und wie die Zahlungsinformationen tokenisiert werden.
  • totalAppliedFees
    decimal
    Die Summe der Gebühren ist der gesamte Betrag welcher bisher an Gebühren bezahlt wurde.
  • totalSettledAmount
    decimal
    Die Summe der bezahlten Beträge ist der gesamte Betrag welcher bisher bezahlt wurde.
  • userAgentHeader
    string
    Der User Agent Header gibt an, welcher Browser durch den Käufer verwendet wird.
  • userFailureMessage
    string
    Die Fehlermeldung beschreibt für den End-Benutzer, weshalb die Transaktion nicht erfolgreich war. Die Fehlermeldung wird nur gesetzt, wenn die Transaktion fehlgeschlagen ist.
  • userInterfaceType
    string
    Der Benutzerinterface-Typ definiert, wie die Transaktion erzeugt bzw. verarbeitet wurde.
  • windowHeight
    string
     
  • windowWidth
    string
     
  • yearsToKeep
    int
    Die Anzahl Jahre welche eine Transaktion gespeichert wird nachdem sie authorisiert wurde.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
transactioncompletion transactioncompletion
  • amount
    decimal
    Der Betrag, der erfasst wird. Der Betrag stellt die Summe der Belegpositionen mit Steuern dar.
  • baseLineItems
    array
    Die Basis-Belegposition, auf die der Abschluss angewendet wird.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • externalId
    string
    Die externe ID hilft die Entität zu identifizieren. Beim Erstellen einer weiteren Entität mit der selben ID wird die neue Entität nicht erzeugt, stattdessen wird die erste Entität zurückgegeben.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • invoiceMerchantReference
    string
     
  • labels
    array
     
  • language
    string
    The language that is linked to the object.
  • lastCompletion
    boolean
    Gibt an, das dies die letzte Abschluss ist. Nachdem der letzte Abschluss erstellt wurde, kann die Transaktion nicht mehr abgeschlossen werden.
  • lineItems
    array
    Die Einzelposten, die erfasst sind.
  • linkedTransaction
    bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • statementDescriptor
    string
    Die Auszugsbeschreibung erklärt Gebühren oder Zahlungen auf Kontoauszügen.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    Die Gesamtsumme aller Steuern von Belegpositionen.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
transactioninvoice transactioninvoice

Die Transaktions-Rechnung repräsentiert das Rechnungsdokument einer Transaktion.

Die Transaktions-Rechnung repräsentiert das Rechnungsdokument einer Transaktion.
  • amount
    decimal
     
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • billingAddress.legalOrganizationForm
    bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • completion
    bigint
     
  • createdOn
    timestamp
    Das Datum, an dem die Rechnung kreiert wird.
  • derecognizedBy
    bigint
    Die ID des Benutzers welcher die Rechnung ausgebucht hat.
  • derecognizedOn
    timestamp
    Das Datum, an dem die Rechnung als ausgebucht markiert wird.
  • dueOn
    timestamp
    Das Datum, an dem die Rechnung bezahlt werden soll.
  • environment
    string
     
  • externalId
    string
    Die externe ID identifiziert die Entität. Wenn die gleiche ID wiederholt verwendet wird, dann wird die Entität nicht ein weiteres mal angelegt.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • linkedTransaction
    bigint
     
  • merchantReference
    string
     
  • outstandingAmount
    decimal
    Der ausstehende Betrag gibt an, wie viel der Kunde dem Händler schuldet. Ein negativer Betrag bedeutet, dass der Kunde zu viel bezahlt hat.
  • paidOn
    timestamp
    Das Datum, an dem die Rechnung als bezahlt markiert wurde. Es kann sein, dass dieses Datum dem aktuellen Bezahldatum etwas hinterher hinkt.
  • spaceViewId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.