Dokumentation
Dokumentation
Analytics-Schema BETA
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
accountsubscription accountsubscription
  • accountSubscriber
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscription
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
boardingtrialsubscription boardingtrialsubscription
  • accountId
    bigint
     
  • couponCodes
    array
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • currency
    string
     
  • expireDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • lastNotifiedOn
    timestamp
     
  • productVersion
    bigint
     
  • selectedComponents
    array
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponentquantity subscriptionproductcomponentquantity
  • id
    bigint
    A unique identifier for the object.
  • quantity
    bigint
     
  • subscriptionProductComponent
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
account account
  • active
    boolean
    Ob dieses Konto und alle seine übergeordneten Konten aktiv sind.
  • activeOrRestrictedActive
    boolean
    Ob dieses Konto und alle seine übergeordneten Konten aktiv oder eingeschränkt aktiv sind.
  • createdBy
    bigint
    Die ID des Benutzers, von dem das Konto erstellt wurde.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Konto erstellt wurde.
  • deletedBy
    bigint
    Die ID eines Benutzers, von dem das Konto gelöscht wurde.
  • deletedOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Konto 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, der zur Identifizierung des Kontos verwendet wird.
  • parentAccount
    bigint
    Das übergeordnete Konto, das für die Verwaltung dieses Kontos zuständig ist.
  • restrictedActive
    boolean
    Ob dieses Konto und alle seine übergeordneten Konten aktiv oder eingeschränkt aktiv sind. Es gibt mindestens ein Konto, das eingeschränkt aktiv ist.
  • scope
    bigint
    Der Bereich, zu dem das Konto gehört.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subaccountLimit
    bigint
    Die Anzahl der Unterkonten, die innerhalb dieses Kontos erstellt werden können.
  • type
    string
    Der Typ des Kontos, der seine Rolle und Fähigkeiten definiert.
failurereason failurereason
  • category
    string
    Die Kategorie, zu der der Fehlergrund gehört.
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
labeldescriptor labeldescriptor
  • category
    string
    Die Kategorie des Etiketts.
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • group
    bigint
    Die Gruppe, zu der dieses Etikett gehört.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • weight
    int
    Bei der Auflistung von Etiketten können diese nach dieser Nummer sortiert werden.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • weight
    int
    Bei der Auflistung von Etikettengruppen können diese nach dieser Nummer sortiert werden.
space space
  • account
    bigint
    Das Konto, zu dem der Raum gehört.
  • active
    boolean
    Ob dieser Bereich und alle seine übergeordneten Konten aktiv sind.
  • activeOrRestrictedActive
    boolean
    Ob dieser Bereich und alle seine übergeordneten Konten aktiv oder eingeschränkt aktiv sind.
  • createdBy
    bigint
    Die ID des Benutzers, von dem der Bereich erstellt wurde.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der der Bereich erstellt wurde.
  • deletedBy
    bigint
    Die ID des Benutzers, von dem der Speicherplatz gelöscht wurde.
  • deletedOn
    timestamp
    Das Datum und die Uhrzeit, zu der der Speicherplatz 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, der zur Identifizierung des Raums verwendet wird.
  • postalAddress
    struct
    Die Adresse, die in der Kommunikation mit Kunden verwendet wird, zum Beispiel in E-Mails, Dokumenten usw.
  • 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
    Die Währung, die für die Anzeige der aggregierten Beträge im Raum verwendet wird.
  • requestLimit
    bigint
    Die maximale Anzahl von API-Anfragen, die innerhalb von zwei Minuten akzeptiert werden. Dieses Limit kann nur mit besonderen Rechten geändert werden.
  • restrictedActive
    boolean
    Ob dieser Bereich und alle seine übergeordneten Konten aktiv oder eingeschränkt aktiv sind. Es gibt mindestens ein übergeordnetes Konto, das eingeschränkt aktiv ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • technicalContactAddresses
    array
    Die E-Mail-Adresse, an die Nachrichten über technische Probleme und Fehler, die in dem Bereich auftreten, gesendet werden sollen.
  • timeZone
    string
    Die Zeitzone, die für die Planung und Ausführung von Hintergrundprozessen verwendet wird. Dies hat keinen Einfluss auf die Formatierung von Daten in der Benutzeroberfläche.
spacereference spacereference
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • spaceId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
legalorganizationform legalorganizationform
  • country
    string
    Der aus zwei Buchstaben bestehende Code des Landes, in dem die Rechtsform der Organisation verwendet wird (ISO 3166-1 Alpha-2-Format).
  • description
    array
    Die lokalisierten Beschreibungen der rechtlichen Organisationsform.
  • englishDescription
    string
    Der englische Name der rechtlichen Organisationsform.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    Die lokalisierten Abkürzungen der rechtlichen Organisationsform.
customer customer
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customerId
    string
    Die ID des Kunden im System des Händlers.
  • emailAddress
    string
    Die E-Mail Adresse des Kunden.
  • familyName
    string
    Der Familien- oder Nachname des Kunden.
  • givenName
    string
    Vorname oder Name des Kunden.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Ermöglicht die Speicherung zusätzlicher Informationen über das Objekt.
  • preferredCurrency
    string
    Die bevorzugte Währung des Kunden.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
customeraddress customeraddress
  • address
    struct
    Die tatsächliche Postanschrift.
  • 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
    Ob die Adresse für die Rechnung, den Versand oder beides bestimmt ist.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customer
    bigint
    Der Kunde, zu dem das Objekt gehört.
  • defaultAddress
    boolean
    Ob dies die Standardadresse des Kunden ist.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
taxclass taxclass
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name, der zur Identifizierung der Steuerklasse verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
charge charge
  • createdOn
    timestamp
    Das Datum, an dem die Gebühren erfasst wurden.
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • spaceViewId
    bigint
    Die ID der Raumansicht, mit der dieses Objekt verknüpft ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • transaction
    bigint
     
  • type
    string
     
  • userFailureMessage
    string
    Die Fehlermeldung beschreibt für den End-Benutzer, weshalb die Belastung nicht erfolgreich war. Die Fehlermeldung wird nur gesetzt, wenn die Belastung fehlgeschlagen ist.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
chargeattempt chargeattempt
  • charge
    bigint
     
  • completionBehavior
    string
     
  • connectorConfiguration
    bigint
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customersPresence
    string
    Die Anwesenheit des Kunden zeigt an, welche Art der Kundeninteraktion während des Aufladeversuchs verwendet wurde.
  • environment
    string
     
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • initializingTokenVersion
    boolean
     
  • invocation
    bigint
     
  • language
    string
    The language that is linked to the object.
  • linkedTransaction
    bigint
     
  • nextUpdateOn
    timestamp
     
  • redirectionUrl
    string
     
  • salesChannel
    bigint
     
  • spaceViewId
    bigint
    Die ID der Raumansicht, mit der dieses Objekt verknüpft ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • succeededOn
    timestamp
     
  • terminal
    bigint
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • userFailureMessage
    string
    Geben Sie eine Nachricht im Falle einer fehlgeschlagenen Transaktion an, welche dem Kunden angezeigt wird. Die Lokalisierung erfolgt anhand der übergebenen Sprache.
  • wallet
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
saleschannel saleschannel
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • sortOrder
    int
    Bei der Auflistung der Vertriebskanäle können diese nach dieser Nummer sortiert werden.
connectorinvocation connectorinvocation
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • id
    bigint
    A unique identifier for the object.
  • stage
    string
     
  • timeTookInMilliseconds
    bigint
     
  • transaction
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentconnector paymentconnector
  • dataCollectionType
    string
    Die Art der Datenerfassung gibt an, wie die Zahlungsinformationen erfasst werden.
  • deprecated
    boolean
    Ob das Objekt veraltet ist.
  • deprecationReason
    map
    Der Verwerfungsgrund beschreibt, warum das Objekt veraltet ist.
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • paymentMethod
    bigint
    Die Zahlungsmethode, die der Konnektor unterstützt.
  • paymentMethodBrand
    bigint
    Die spezifische Marke, die dieser Zahlungsconnector unterstützt.
  • primaryRiskTaker
    string
    Die Stelle, die das Hauptrisiko trägt, wenn eine Vertragspartei ihren Verpflichtungen nicht nachkommt.
  • processor
    bigint
    Der Prozessor, zu dem der Anschluss gehört.
  • supportedCurrencies
    array
    Die Währungen, die von dem Konnektor unterstützt werden.
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Ob diese Konnektorkonfiguration für die Verarbeitung von Zahlungen aktiviert ist, wobei der Status der Prozessor- und Zahlwegkonfigurationen berücksichtigt wird.
  • connector
    bigint
    Der Anschluss, für den die Konfiguration gilt.
  • enabledSalesChannels
    array
    Die Vertriebskanäle, für die die Konfiguration des Connectors aktiviert ist. Wenn leer, ist er für alle Vertriebskanäle aktiviert.
  • enabledSpaceViews
    array
    Die Raumansichten, für die die Verbindungskonfiguration aktiviert ist. Ist sie leer, wird sie für alle Raumansichten aktiviert.
  • id
    bigint
    A unique identifier for the object.
  • imagePath
    string
    Die URL für das Bild des Verbinders.
  • name
    string
    Der Name, der zur Identifizierung der Anschlusskonfiguration verwendet wird.
  • paymentMethodConfiguration
    bigint
    Die Konfiguration der Zahlungsmethode, zu der die Konnektorkonfiguration gehört.
  • priority
    int
    Die Priorität, die die Reihenfolge bestimmt, in der die Anschlusskonfigurationen bei der Bearbeitung einer Zahlung berücksichtigt werden. Niedrige Werte werden zuerst berücksichtigt.
  • processorConfiguration
    bigint
    Die Prozessorkonfiguration, zu der die Anschlusskonfiguration gehört.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentcontract paymentcontract
  • account
    bigint
    Dieses Konto, zu dem der Vertrag gehört.
  • activatedOn
    timestamp
    Das Datum und die Uhrzeit, zu der der Vertrag aktiviert wurde.
  • contractIdentifier
    string
    Die Kennung des Vertrags.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • 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.
  • lastModifiedDate
    timestamp
    Das Datum und die Uhrzeit der letzten Änderung des Objekts.
  • rejectedOn
    timestamp
    Datum und Uhrzeit, zu der der Vertrag abgelehnt wurde.
  • rejectionReason
    bigint
    Der Grund für die Ablehnung des Vertrags.
  • startTerminatingOn
    timestamp
    Datum und Uhrzeit, zu der die Kündigung des Vertrags eingeleitet wurde.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • terminatedOn
    timestamp
    Das Datum und die Uhrzeit der Beendigung des Vertrags.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
    Die von der Zahlungsmethode unterstützten Datenerfassungsarten.
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Der lokalisierte Name des Objekts.
  • supportedCurrencies
    array
    Die Währungen, die von der Zahlungsmethode unterstützt werden.
paymentmethodbrand paymentmethodbrand
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • paymentMethod
    bigint
    Die Zahlungsmethode, zu der die Marke gehört.
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
    Die Art der Datenerfassung gibt an, wie die Zahlungsinformationen erfasst werden.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name, der zur Identifizierung der Konfiguration der Zahlungsmethode verwendet wird.
  • oneClickPaymentMode
    string
    Der Ein-Klick-Zahlungsmodus bestimmt, ob der Kunde seine Zahlungsdaten für spätere Zahlungen speichern kann.
  • paymentMethod
    bigint
    Die Zahlungsmethode, für die die Konfiguration gilt.
  • resolvedDescription
    map
    Die Beschreibung für die Zahlungsmethode, die dem Kunden tatsächlich angezeigt wird. Dabei handelt es sich entweder um die benutzerdefinierte Beschreibung, falls definiert, oder um die Standardbeschreibung der Zahlungsmethode.
  • resolvedTitle
    map
    Der Titel für die Zahlungsmethode, der dem Kunden tatsächlich angezeigt wird. Dabei handelt es sich entweder um den benutzerdefinierten Titel, falls definiert, oder um den Standardtitel der Zahlungsmethode.
  • sortOrder
    int
    Bei der Auflistung der Zahlungsarten können diese nach dieser Nummer sortiert werden.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentprocessor paymentprocessor

Zahlungsabwickler stellen die Verbindung zu Drittunternehmen (Zahlungsdienstleistern) her, die den Zahlungsverkehr technisch abwickeln und somit die Zahlungen verarbeiten.

Zahlungsabwickler stellen die Verbindung zu Drittunternehmen (Zahlungsdienstleistern) her, die den Zahlungsverkehr technisch abwickeln und somit die Zahlungen verarbeiten.
  • companyName
    map
    Der Name des Unternehmens, zu dem der Verarbeiter gehört.
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • headquartersLocation
    map
    Wo sich der Hauptsitz des Verarbeiters befindet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
  • productName
    map
    Der Name des Produkts des Verarbeiters.
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    ob die Prozessorkonfiguration von der Anwendung verwaltet wird und daher nicht geändert werden kann.
  • contractId
    bigint
    Die ID des Zahlungsvertrags, mit dem die Prozessorkonfiguration verknüpft ist.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name, der zur Identifizierung der Konfiguration der Zahlungsmethode verwendet wird.
  • processor
    bigint
    Der Zahlungsabwickler, für den die Konfiguration gilt.
  • 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
    Die Etiketten liefern zusätzliche Informationen über das Objekt.
  • 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
    Die Standardwährung des Terminals.
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    Die eindeutige Kennung des Terminals, die auf dem Gerät angezeigt wird.
  • name
    string
    Der Name, der zur Identifizierung des Zahlungsterminals verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • type
    bigint
    Der Typ des Zahlungsterminals.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
paymentterminaltype paymentterminaltype
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
token token
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • customerEmailAddress
    string
    Die E-Mail Adresse des Kunden.
  • customerId
    string
    Die eindeutige Kennung des Kunden im externen System.
  • enabledForOneClickPayment
    boolean
    Ob das Token für One-Click-Zahlungen aktiviert ist, die den Zahlungsvorgang für den Kunden vereinfachen. One-Click-Tokens sind über die Kunden-ID mit Kunden verknüpft.
  • 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 des Kunden, die sich darauf auswirkt, wie Daten und Zeiten bei der Kommunikation mit dem Kunden formatiert werden.
  • tokenReference
    string
    Die Referenz, die zur Identifizierung des Zahlungs-Tokens verwendet wird (z. B. die ID oder E-Mail-Adresse des Kunden).
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
transaction transaction
  • acceptHeader
    string
    Der "Accept"-Kopf des Webbrowsers des Kunden.
  • acceptLanguageHeader
    string
    Die Kopfzeile "Sprache akzeptieren" des Webbrowsers des Kunden.
  • allowedPaymentMethodBrands
    array
    Die Zahlwegmarken, die zur Autorisierung der Transaktion verwendet werden können.
  • allowedPaymentMethodConfigurations
    array
    Die Zahlwegkonfigurationen, die zur Autorisierung der Transaktion verwendet werden können.
  • authorizationAmount
    decimal
    Die Summe aller Einzelpostenpreise einschließlich Steuern in der Währung der Transaktion.
  • authorizationEnvironment
    string
    Die Umgebung, in der die Transaktion genehmigt wurde.
  • authorizationSalesChannel
    bigint
    Der Verkaufskanal, über den die Transaktion platziert wurde.
  • authorizationTimeoutOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion genehmigt werden muss, andernfalls wird sie storniert.
  • authorizedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion genehmigt wurde.
  • autoConfirmationEnabled
    boolean
    Ob die Transaktion automatisch bestätigt werden kann oder ob dies explizit über die API erfolgen muss. Standard ist true.
  • billingAddress
    struct
    Die Adresse, die mit der Zahlungsmethode für die Rechnungsstellung und Transaktionsverarbeitung verbunden ist.
  • 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
    Ob der Kunde weitere Zahlungsversuche unternehmen kann, wenn der erste fehlgeschlagen ist. Standard ist true.
  • completedAmount
    decimal
    Der Gesamtbetrag, der abgeschlossen wurde, in der Währung der Transaktion.
  • completedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion abgeschlossen wurde.
  • completionBehavior
    string
    Das Verhalten, das steuert, wann die Transaktion abgeschlossen ist.
  • completionTimeoutOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion automatisch abgeschlossen wird.
  • confirmedBy
    bigint
    Die ID des Benutzers, von dem die Transaktion bestätigt wurde.
  • confirmedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion erstellt wurde.
  • createdBy
    bigint
    Die ID des Benutzers, von dem die Transaktion erstellt wurde.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • currency
    string
    Der aus drei Buchstaben bestehende Code (Format ISO 4217) für die Währung der Transaktion.
  • customerEmailAddress
    string
    Die E-Mail Adresse des Kunden.
  • customerId
    string
    Die eindeutige Kennung des Kunden im externen System.
  • customersPresence
    string
    Die Anwesenheit des Kunden gibt an, ob und in welcher Form der Kunde der Transaktion anwesend ist. Standardwert ist VIRTUAL_PRESENT.
  • deliveryDecisionMadeOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Entscheidung getroffen wurde, ob der Auftrag versandt werden soll.
  • deviceSessionIdentifier
    string
    Ermöglicht die Verknüpfung der Transaktion mit den vom Gerät des Kunden erfassten Daten.
  • emailsDisabled
    boolean
    Ob der E-Mail-Versand für die Transaktion deaktiviert ist. Standard ist false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    Die Strategie, mit der festgelegt wird, ob die Transaktion in der Test- oder Produktionsumgebung verarbeitet werden soll.
  • failedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Transaktion fehlgeschlagen ist.
  • failedUrl
    string
    Die URL, zu der der Kunde zurückgeleitet wird, nachdem er seine Zahlung storniert oder nicht authentifiziert hat.
  • failureReason
    bigint
    Der Grund für das Scheitern der Transaktion.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    Die IP-Adresse des Geräts des Kunden.
  • internetProtocolAddressCountry
    string
    Das Land, das anhand der IP-Adresse des Geräts des Kunden ermittelt wird.
  • invoiceMerchantReference
    string
    Die Referenz des Händlers, die zur Identifizierung der Rechnung verwendet wird.
  • javaEnabled
    boolean
    Ob Java auf dem Webbrowser des Kunden aktiviert ist.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
    Die vom Kunden gekauften Einzelposten.
  • merchantReference
    string
    Die Referenz des Händlers, die zur Identifizierung der Transaktion verwendet wird.
  • metaData
    map
    Ermöglicht die Speicherung zusätzlicher Informationen über das Objekt.
  • parent
    bigint
    Die übergeordnete Transaktion, die (teilweise) durch diese Transaktion ersetzt wurde.
  • paymentConnectorConfiguration
    bigint
    Die Konfiguration des Zahlungskonnektors, der zur Autorisierung der Transaktion verwendet wurde.
  • processingOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Verarbeitung der Transaktion begonnen wurde.
  • refundedAmount
    decimal
    Der Gesamtbetrag, der erstattet wurde, in der Währung der Transaktion.
  • screenColorDepth
    string
    Die Bildschirmfarbtiefe des Webbrowsers des Kunden.
  • screenHeight
    string
    Die Bildschirmhöhe des Webbrowsers des Kunden.
  • screenWidth
    string
    Die Bildschirmbreite des Webbrowsers des Kunden.
  • shippingAddress
    struct
    Die Adresse, an die die Bestellung versandt werden soll.
  • 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
    Der Name der Versandmethode, die für den Versand der Produkte verwendet wird.
  • spaceViewId
    bigint
    Die ID der Raumansicht, mit der dieses Objekt verknüpft ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • successUrl
    string
    Die URL, zu der der Kunde nach erfolgreicher Authentifizierung seiner Zahlung zurückgeleitet wird.
  • terminal
    bigint
    Das Zahlungsterminal, über das die Zahlung abgewickelt wurde.
  • timeZone
    string
    Die Zeitzone des Kunden, die sich darauf auswirkt, wie Daten und Zeiten bei der Kommunikation mit dem Kunden formatiert werden.
  • token
    bigint
    Das Zahlungs-Token, das für die Belastung des Kunden verwendet werden soll.
  • tokenizationMode
    string
    Der Tokenisierungsmodus gibt an, ob und wie die Tokenisierung von Zahlungsinformationen auf die Transaktion angewendet wird.
  • totalAppliedFees
    decimal
    Der Gesamtbetrag aller erhobenen Gebühren in der Währung der Transaktion.
  • totalSettledAmount
    decimal
    Der Gesamtbetrag, der abgerechnet wurde, in der Währung der Transaktion.
  • userAgentHeader
    string
    Der "User Agent"-Header des Webbrowsers des Kunden.
  • userFailureMessage
    string
    Die Nachricht, die dem Kunden angezeigt werden kann, um zu erklären, warum die Transaktion fehlgeschlagen ist, in der Sprache des Kunden.
  • userInterfaceType
    string
    Die Art der Benutzeroberfläche, die der Kunde zur Angabe der Zahlungsinformationen verwendet hat.
  • windowHeight
    string
    Die Fensterhöhe des Webbrowsers des Kunden.
  • windowWidth
    string
    Die Fensterbreite des Webbrowsers des Kunden.
  • yearsToKeep
    int
    Die Anzahl der Jahre, die die Transaktion nach ihrer Genehmigung aufbewahrt wird.
  • 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
    Die Etiketten liefern zusätzliche Informationen über das Objekt.
  • 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
    Die ID der Raumansicht, mit der dieses Objekt verknüpft ist.
  • 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
    Die ID der Raumansicht, mit der dieses Objekt verknüpft ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
wallettype wallettype
  • description
    map
    Die lokalisierte Beschreibung des Objekts.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Der lokalisierte Name des Objekts.
subscriptionaffiliate subscriptionaffiliate
  • 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.
  • metaData
    map
    Ermöglicht die Speicherung zusätzlicher Informationen über das Objekt.
  • name
    string
    Der Name, der zur Identifizierung des Partners verwendet wird.
  • reference
    string
    Die Referenz, die zur Identifizierung des Partners verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscription subscription
  • activatedOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Abonnement aktiviert wurde.
  • affiliate
    bigint
    Die Tochtergesellschaft, die zur Schaffung des Abonnements führte.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Abonnement erstellt wurde.
  • currentProductVersion
    bigint
    Die Version des Produkts, mit dem das Abonnement derzeit verknüpft ist.
  • description
    string
    Eine Beschreibung, die zur Identifizierung des Abonnements dient.
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Abonnement initialisiert wurde.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    Das Datum und die Uhrzeit, zu der das Abonnement beendet werden soll.
  • reference
    string
    Die Referenz des Händlers, die zur Identifizierung des Abonnements verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriber
    bigint
    Der Abonnent, dem das Abonnement gehört.
  • terminatedBy
    bigint
    Die ID des Benutzers, von dem das Abonnement gekündigt wurde.
  • terminatedOn
    timestamp
    Das Datum und die Uhrzeit der Beendigung des Abonnements.
  • terminatingOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Beendigung des Abonnements begann.
  • terminationScheduledOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Abonnement beendet werden sollte.
  • token
    bigint
    Das Zahlungs-Token, das zur Belastung des Kunden verwendet wird.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • component
    bigint
    Die Komponente, die konfiguriert wird.
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
    Die Menge, die auf die Komponente angewendet werden soll.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Periodenrechnung erstellt wurde.
  • effectivePeriodEndDate
    timestamp
    Das Datum und die Uhrzeit, zu der der Zeitraum tatsächlich endete.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
    Das Datum und die Uhrzeit des Beginns des Zeitraums.
  • plannedPeriodEndDate
    timestamp
    Das Datum und die Uhrzeit, zu der der Zeitraum voraussichtlich enden wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriptionVersion
    bigint
    Die Abonnementversion, zu der die Periodenrechnung gehört.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionperiodbillitem subscriptionperiodbillitem
  • bill
    bigint
     
  • fee
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntry
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionversion subscriptionversion
  • activatedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Abonnementversion aktiviert wurde.
  • billingCurrency
    string
    Der aus drei Buchstaben bestehende Code (Format ISO 4217) der Währung, die für die Rechnungsstellung an den Kunden verwendet wird. Muss eine der vom Produkt unterstützten Währungen sein.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Abonnementversion erstellt wurde.
  • expectedLastPeriodEnd
    timestamp
    Das Datum und die Uhrzeit, zu der die letzte Periode voraussichtlich enden wird.
  • failedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Abonnementversion fehlgeschlagen ist.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    Das Datum und die Uhrzeit, zu der die Beendigung der Abonnementversion geplant ist.
  • productVersion
    bigint
    Die Produktversion, die abonniert ist.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscription
    bigint
    Das Abonnement, zu dem diese Version gehört.
  • terminatedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Abonnementversion beendet wurde.
  • terminatingOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Beendigung der Abonnementversion begann.
  • terminationIssuedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Kündigung der Abonnementversion ausgesprochen wurde.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptioncharge subscriptioncharge

Die Belastung eines Abo entspricht einer einzelnen Belastung, welche für das Abo ausgelöst wurde.

Die Belastung eines Abo entspricht einer einzelnen Belastung, welche für das Abo ausgelöst wurde.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Gebühr erstellt wurde.
  • discardedBy
    bigint
    Die ID des Benutzers, von dem die Gebühr verworfen wurde.
  • discardedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Ladung verworfen wurde.
  • 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.
  • failedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Ladung fehlgeschlagen ist.
  • failedUrl
    string
    Die URL, zu der der Kunde zurückgeleitet wird, nachdem er seine Zahlung storniert oder nicht authentifiziert hat.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
    Die zu der Belastung gehörenden Buchungseinträge.
  • plannedExecutionDate
    timestamp
    Das Datum und die Uhrzeit, zu der die Ausführung der Ladung geplant ist.
  • processingType
    string
    Die Verarbeitungsart gibt an, wie die Gebühr verarbeitet werden soll.
  • reference
    string
    Die Referenz des Händlers, die zur Identifizierung der Gebühr verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscription
    bigint
    Das Abonnement, zu dem die Gebühr gehört.
  • succeedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Ladung erfolgreich war.
  • successUrl
    string
    Die URL, zu der der Kunde nach erfolgreicher Authentifizierung seiner Zahlung zurückgeleitet wird.
  • transaction
    bigint
    Die Transaktion, mit der die Gebühr bearbeitet wurde.
  • type
    string
    Der Typ gibt an, wie die Ladung eingeleitet wurde.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionledgerentry subscriptionledgerentry

Die Einträge im Abo-Konto entsprechen Veränderungen auf der Abrechnung des Abonnenten.

Die Einträge im Abo-Konto entsprechen Veränderungen auf der Abrechnung des Abonnenten.
  • aggregatedTaxRate
    decimal
    Der Gesamtsteuersatz, der auf die Ledgerbuchung angewendet wird, berechnet aus den Sätzen aller Steuerzeilen.
  • amountExcludingTax
    decimal
    Der Betrag des Leger-Eintrags mit angewandten Rabatten, ohne Steuern.
  • amountIncludingTax
    decimal
    Der Betrag des Leger-Eintrags mit angewandten Rabatten, einschließlich Steuern.
  • createdBy
    bigint
    Die ID des Benutzers, von dem der Ledger-Eintrag erstellt wurde.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • discountIncludingTax
    decimal
    Der dem Bucheintrag zugewiesene Rabatt, einschließlich Steuern.
  • 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.
  • proRataCalculated
    boolean
     
  • quantity
    decimal
    Die Anzahl der konsumierten Artikel.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriptionVersion
    bigint
    Die Abonnementversion, zu der der Ledgereintrag gehört.
  • taxAmount
    decimal
    Die Summe aller Steuern, die auf die Ledgerbuchung angewendet werden.
  • taxes
    array
    Eine Reihe von Steuerzeilen, von denen jede eine Steuer angibt, die auf die Ledgerbuchung angewendet wird.
  • title
    string
    Der Titel, der angibt, worum es in der Buchung geht.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
coupon coupon

Gutscheine sind eine Möglichkeit, Rabatte auf Abos zu gewähren. Erstellen Sie einen neuen Gutschein, konfigurieren Sie ihn mit Rabatten und Regeln und geben Sie ihn dann an Ihre Kunden weiter.

Gutscheine sind eine Möglichkeit, Rabatte auf Abos zu gewähren. Erstellen Sie einen neuen Gutschein, konfigurieren Sie ihn mit Rabatten und Regeln und geben Sie ihn dann an Ihre Kunden weiter.
  • createdBy
    bigint
    Das Feld ""Erstellt von"" gibt den Benutzer an, der den Gutschein erstellt hat.
  • createdOn
    timestamp
     
  • deletedBy
    bigint
    Das Feld ""Gelöscht von"" gibt den Benutzer an, der den Gutschein gelöscht hat.
  • deletedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Gutscheinname wird nur für die Verwaltung der Gutscheins verwendet und wird dem Abonnenten niemals angezeigt. Sie können diesem Gutschein später bei der Konfiguration des Gutscheins eine genauere Bezeichnung oder einen Namen geben.
  • spaceId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
couponversion couponversion

Die Gutscheinversion enthält eine Teilmenge der Gutscheineigenschaften, die sich im Laufe der Zeit ändern können, wobei nur eine Version gleichzeitig aktiv sein kann.

Die Gutscheinversion enthält eine Teilmenge der Gutscheineigenschaften, die sich im Laufe der Zeit ändern können, wobei nur eine Version gleichzeitig aktiv sein kann.
  • activatedBy
    bigint
    Das Feld ""Aktiviert von"" gibt den Benutzer an, der die Gutscheinversion aktiviert hat.
  • activatedOn
    timestamp
     
  • coupon
    bigint
    Der Gutschein, mit dem die Gutscheinversion verknüpft ist.
  • createdBy
    bigint
    Das Feld ""Erstellt von"" gibt den Benutzer an, der die Gutscheinversion erstellt hat.
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Ein aussagekräftiger Name oder eine kurze Beschreibung, um die Absicht des Gutscheins zu kommunizieren. Dies wird dem Abonnenten auf seiner Rechnung angezeigt oder wenn er den Gutscheincode einlöst.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • obsoletedBy
    bigint
    Das Feld ""Ausgelaufen von"" gibt den Benutzer an, der die Gutscheinversion auslaufen lassen hat.
  • obsoletedOn
    timestamp
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
abstractproductfee abstractproductfee
  • component
    bigint
    Die Produktkomponente, zu der die Gebühr gehört.
  • description
    struct
    Die lokalisierte Beschreibung der Gebühr, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der lokalisierte Name der Gebühr, die dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
    Die Art der Gebühr.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productmeteredfee productmeteredfee
  • component
    bigint
    Die Produktkomponente, zu der die Gebühr gehört.
  • description
    struct
    Die lokalisierte Beschreibung der Gebühr, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • metric
    bigint
    Die Metrik, die zur Bestimmung des dem Kunden in Rechnung gestellten Ressourcenverbrauchs verwendet wird.
  • name
    struct
    Der lokalisierte Name der Gebühr, die dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    Die zur Berechnung des Staffelpreises verwendete Methode.
  • type
    string
    Die Art der Gebühr.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productperiodfee productperiodfee
  • component
    bigint
    Die Produktkomponente, zu der die Gebühr gehört.
  • description
    struct
    Die lokalisierte Beschreibung der Gebühr, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    Der lokalisierte Titel, der auf Buchungen und Rechnungen verwendet wird.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    Der lokalisierte Name der Gebühr, die dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    Die Anzahl der Abonnement-Abrechnungszyklen, die als Testphase gelten und während derer keine Gebühren erhoben werden.
  • periodFee
    array
    Der Betrag, der dem Kunden für jeden Abrechnungszyklus während der Laufzeit eines Abonnements in Rechnung gestellt wird.
  • type
    string
    Die Art der Gebühr.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productsetupfee productsetupfee
  • component
    bigint
    Die Produktkomponente, zu der die Gebühr gehört.
  • description
    struct
    Die lokalisierte Beschreibung der Gebühr, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der lokalisierte Name der Gebühr, die dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    Der Betrag, der dem Kunden berechnet wird, wenn ein Abonnement herabgestuft wird.
  • onUpgradeCreditedAmount
    array
    Der Betrag, der dem Kunden berechnet wird, wenn ein Abonnement aufgerüstet wird.
  • setupFee
    array
    Der Betrag, der dem Kunden einmalig berechnet wird, wenn er ein Abonnement abschließt.
  • type
    string
    Die Art der Gebühr.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionmetric subscriptionmetric

Die Metrik entspricht dem Verbrauch einer messbaren Ressource

Die Metrik entspricht dem Verbrauch einer messbaren Ressource
  • description
    struct
    Die lokalisierte Beschreibung der Metrik, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der lokalisierte Name der Metrik, der dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproduct subscriptionproduct

Ein Aboprodukt entspricht einem Produkt, welches ein Abonnent abonnieren kann. Ein Produkt definiert, welche Kosten in welchen Zeiträumen belastet werden.

Ein Aboprodukt entspricht einem Produkt, welches ein Abonnent abonnieren kann. Ein Produkt definiert, welche Kosten in welchen Zeiträumen belastet werden.
  • allowedPaymentMethodConfigurations
    array
    Die Zahlungsarten, die für das Abonnement dieses Produkts verwendet werden können. Wenn keine ausgewählt sind, gelten keine Einschränkungen.
  • failedPaymentSuspensionPeriod
    string
    Der Zeitraum, nach dem ein Abonnement, das aufgrund einer fehlgeschlagenen Zahlung ausgesetzt wurde, beendet wird.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name, der zur Identifizierung des Produkts verwendet wird.
  • productLocked
    boolean
    Ob Abonnements zu oder von diesem Produkt gewechselt werden können oder ob sie gebunden sind.
  • reference
    string
    Die Referenz des Händlers, die zur Identifizierung des Produkts verwendet wird, z. B. die SKU.
  • sortOrder
    int
    Bei der Auflistung der Produkte können diese nach dieser Nummer sortiert werden.
  • spaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    Wenn Sie von einer Komponente mit einer niedrigeren Stufe zu einer Komponente mit einer höheren Stufe wechseln, gilt dies als Upgrade und es kann eine Gebühr anfallen.
  • componentGroup
    bigint
    Die Gruppe, zu der die Komponente gehört.
  • defaultComponent
    boolean
    Ob es sich um die Standardkomponente in ihrer Gruppe handelt und ob sie vorausgewählt ist.
  • description
    struct
    Die lokalisierte Beschreibung der Komponente, die dem Kunden angezeigt wird.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    Für diese Komponente kann maximal die definierte Menge gewählt werden.
  • minimalQuantity
    decimal
    Für diese Komponente muss mindestens die definierte Menge gewählt werden.
  • name
    struct
    Der lokalisierte Name der Komponente, der dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    Der Mengenschritt bestimmt das Intervall, in dem die Menge erhöht werden kann.
  • reference
    bigint
    Die Referenz wird verwendet, um Komponenten zwischen verschiedenen Produktversionen zu verknüpfen.
  • sortOrder
    int
    Bei der Auflistung der Komponenten können diese nach dieser Nummer sortiert werden.
  • taxClass
    bigint
    Die Steuerklasse, die auf Gebühren anzuwenden ist.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponentgroup subscriptionproductcomponentgroup
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der lokalisierte Name der Komponentengruppe, der dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Ob die Komponentengruppe optional ist, d.h. der Kunde muss keine Komponente auswählen.
  • productVersion
    bigint
    Die Produktversion, zu der die Komponentengruppe gehört.
  • sortOrder
    int
    Bei der Auflistung von Komponentengruppen können diese nach dieser Nummer sortiert werden.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponentreference subscriptionproductcomponentreference

Die Produktkomponentenreferenz verknüpft Komponenten aus verschiedenen Produktversionen, was die Durchführung von Migrationen ermöglicht.

Die Produktkomponentenreferenz verknüpft Komponenten aus verschiedenen Produktversionen, was die Durchführung von Migrationen ermöglicht.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name, der zur Identifizierung der Komponentenreferenz verwendet wird.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Produktversion aktiviert wurde.
  • billingCycle
    string
    Der wiederkehrende Zeitraum, in der Regel monatlich oder jährlich, für den einem Abonnenten Gebühren berechnet werden.
  • comment
    string
    Ein Kommentar, der die Produktversion beschreibt und erklärt, warum sie erstellt wurde. Er wird dem Abonnenten nicht bekannt gegeben.
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Produktversion erstellt wurde.
  • defaultCurrency
    string
    Der aus drei Buchstaben bestehende Code (Format ISO 4217) für die Standardwährung der Produktversion.
  • enabledCurrencies
    array
    Die aus drei Buchstaben bestehenden Codes (ISO 4217-Format) der Währungen, die die Produktversion unterstützt.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Jedes Mal, wenn eine neue Version eines Produkts erstellt wird, wird die Nummer erhöht und vergeben.
  • minimalNumberOfPeriods
    int
    Die Mindestanzahl der Perioden, die das Abonnement läuft, bevor es beendet werden kann.
  • name
    struct
    Der lokalisierte Name des Produkts, der dem Kunden angezeigt wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    Die Anzahl der Zeiträume, die das Abonnement nach seiner Beendigung weiterläuft.
  • obsoletedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Produktversion für veraltet erklärt wurde.
  • product
    bigint
    Das Produkt, zu dem die Version gehört.
  • reference
    string
    Die Referenz, die zur Identifizierung der Produktversion verwendet wird.
  • retiringFinishedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Produktversion aus dem Verkehr gezogen wurde.
  • retiringStartedOn
    timestamp
    Das Datum und die Uhrzeit, zu der die Ausmusterung der Produktversion begonnen hat.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • taxCalculation
    string
    Die Art und Weise, wie die Steuern für Gebühren berechnet werden.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriber subscriber

Ein Abonnent entspricht allen, welche ein Produkt abonniert haben.

Ein Abonnent entspricht allen, welche ein Produkt abonniert haben.
  • additionalAllowedPaymentMethodConfigurations
    array
    Erlauben Sie dem Abonnenten, diese Zahlungsmethoden zu verwenden, auch wenn die Abonnementprodukte sie nicht akzeptieren.
  • billingAddress
    struct
    Die Adresse, die dem Abonnenten zu Zwecken der Rechnungsstellung und Transaktionsverarbeitung zugeordnet ist.
  • 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
     
  • description
    string
    Die zur Identifizierung des Teilnehmers verwendete Beschreibung.
  • disallowedPaymentMethodConfigurations
    array
    Verhindern Sie, dass der Abonnent diese Zahlungsmethoden verwendet, auch wenn die Abonnementprodukte sie akzeptieren.
  • emailAddress
    string
    Die E-Mail-Adresse, die für die Kommunikation mit dem Abonnenten verwendet wird. Pro Bereich kann es nur einen Abonnenten mit der gleichen E-Mail-Adresse geben.
  • 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
    Die Sprache, die bei der Kommunikation mit dem Abonnenten in E-Mails und Dokumenten verwendet wird.
  • metaData
    map
    Ermöglicht die Speicherung zusätzlicher Informationen über das Objekt.
  • reference
    string
    Die Referenz des Händlers, die zur Identifizierung des Teilnehmers verwendet wird.
  • shippingAddress
    struct
    Die Adresse, an die die Bestellungen versandt werden sollen.
  • 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
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscribercustomer subscribercustomer
  • customer
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.