Dokumentation
Dokumentation
    • Deutsch (Deutschland)
Doku
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    Der aktuelle Zustand des Objekts.
  • 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 Steuerklasse wird intern zur Identifizierung der Steuerklasse in administrativen Interfaces genutzt. Er wird beispielsweise in Suchfeldern genutzt und sollte daher klar und deskriptiv sein.
  • spaceId
    bigint
     
  • 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
     
  • 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
     
  • 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
     
  • reference
    string
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscription subscription
  • activatedOn
    timestamp
     
  • affiliate
    bigint
     
  • createdOn
    timestamp
     
  • currentProductVersion
    bigint
     
  • description
    string
     
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
     
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
     
  • reference
    string
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriber
    bigint
     
  • terminatedBy
    bigint
     
  • terminatedOn
    timestamp
     
  • terminatingOn
    timestamp
     
  • terminationScheduledOn
    timestamp
     
  • token
    bigint
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • component
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
     
  • effectivePeriodEndDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
     
  • plannedPeriodEndDate
    timestamp
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriptionVersion
    bigint
     
  • 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
     
  • billingCurrency
    string
    Der Aboent wird in der Abrechnungswährung belastet. Diese Währung muss zu den aktivierten Währungen auf dem Produkt gehören.
  • createdOn
    timestamp
     
  • expectedLastPeriodEnd
    timestamp
    Das erwartete Ende der letzten Periode ist das Datum an dem voraussichtlich die letzte Periode endet. Dies ist nur eine Vorhersage und kann vom effektiven Datum abweichen.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
     
  • productVersion
    bigint
     
  • selectedComponents
    array
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscription
    bigint
     
  • terminatedOn
    timestamp
     
  • terminatingOn
    timestamp
     
  • terminationIssuedOn
    timestamp
     
  • 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
     
  • discardedBy
    bigint
     
  • discardedOn
    timestamp
     
  • 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
     
  • 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.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
     
  • plannedExecutionDate
    timestamp
     
  • processingType
    string
     
  • reference
    string
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscription
    bigint
    Das Feld Abo zeigt an, zu welchem Abo die Belastung gehört.
  • succeedOn
    timestamp
     
  • 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.
  • transaction
    bigint
     
  • type
    string
     
  • 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
     
  • amountExcludingTax
    decimal
     
  • amountIncludingTax
    decimal
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    Das Datum und die Uhrzeit, zu der das Objekt erstellt wurde.
  • discountIncludingTax
    decimal
     
  • 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.
  • quantity
    decimal
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • subscriptionVersion
    bigint
     
  • taxAmount
    decimal
     
  • taxes
    array
     
  • title
    string
     
  • 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
     
  • description
    struct
    Die Beschreibung einer Komponentengebühr beschreibt die Gebühr für den Abonnenten. Die Beschreibung wird dem Abonnenten in gewissen Ansichten angezeigt.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der Name der Gebühr sollte für den Abonnenten beschreiben, wozu die Gebühr erhoben wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productmeteredfee productmeteredfee
  • component
    bigint
     
  • description
    struct
    Die Beschreibung einer Komponentengebühr beschreibt die Gebühr für den Abonnenten. Die Beschreibung wird dem Abonnenten in gewissen Ansichten angezeigt.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • metric
    bigint
     
  • name
    struct
    Der Name der Gebühr sollte für den Abonnenten beschreiben, wozu die Gebühr erhoben wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    Die Mengenstaffelung definiert die Berechnungsart der Preisstaffelung. Es gibt verschiedene Möglichkeiten der Berpreisung. Die Mengenstaffelung kontrolliert die Berechnung.
  • type
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productperiodfee productperiodfee
  • component
    bigint
     
  • description
    struct
    Die Beschreibung einer Komponentengebühr beschreibt die Gebühr für den Abonnenten. Die Beschreibung wird dem Abonnenten in gewissen Ansichten angezeigt.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    Der Titel des Buchungseintrags wird im Buchungseintrag des Abos angezeigt und in der Rechnung.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    Der Name der Gebühr sollte für den Abonnenten beschreiben, wozu die Gebühr erhoben wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    Die Anzahl von Gratisperioden spezifizieren wie viele Periode das Produkt kostenfrei getestet werden kann.
  • periodFee
    array
    Die wiederkehrende Gebühr wird für jede Periode belastet, ausser der Testperioden.
  • type
    string
     
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
productsetupfee productsetupfee
  • component
    bigint
     
  • description
    struct
    Die Beschreibung einer Komponentengebühr beschreibt die Gebühr für den Abonnenten. Die Beschreibung wird dem Abonnenten in gewissen Ansichten angezeigt.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Der Name der Gebühr sollte für den Abonnenten beschreiben, wozu die Gebühr erhoben wird.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    Sobald das Abo gewechselt wird und der Wechsel einem Downgrade entspricht, wird der definierte Betrag dem Kunden gutgeschrieben.
  • onUpgradeCreditedAmount
    array
    Sobald das Abo gewechselt wird und der Wechsel einem Upgrade entspricht, wird der definierte Betrag dem Kunden gutgeschrieben.
  • setupFee
    array
    Die Einrichtungsgebühr wird verbucht, sobald der Abonnent die Komponente abonniert.Die Gebühr wird direkt mit der initialen Belastung verbucht.
  • type
    string
     
  • 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
     
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
     
  • 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 zugelassene Zahlungsmethodenkonfiguration kontrolliert welche Zahlungsmethoden für dieses Produkt genutzt werden können. Sofern nichts selektiert ist, werden alle Zahlungsmethoden zugelassen.
  • failedPaymentSuspensionPeriod
    string
    Sobald eine Zahlung fehlschlägt, wir das Abo unterbrochen. Wenn diese Unterbrechung nicht aufgehoben wird innerhalb der definierten Periode, wird das Abo automatisch gekündigt. Eine Zahlug gilt als fehlgeschlagen, sofern die Belastung fehlschlägt oder der Kunde eine Gutschrift (Chargeback) einfordert.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Produktname wird intern in Konfiguration verwendet. Beipsielsweise in Suchfelder. Der Name sollte daher beschreibend und aussagekräftig sein.
  • productLocked
    boolean
    Markiert das Produkt als gesperrt. Das bedeutet, dass der Kunde nicht von diesem Produkt weg oder später zu diesem Produkt wechseln kann.
  • reference
    string
    Die Produktreferenz identifiziert ein Produkt für externe Systeme. Dieses Feld kann die SKU des Produkts enthalten.
  • sortOrder
    int
    Die Sortierreihenfolge kontrolliert die Reihenfolge der Produktauflistung. Die Sortierreihenfolge wird verwendet, um die Produkte in aufsteigeneder Reihenfogle zu sortieren.
  • spaceId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    Wenn eine Produktkomponente von einer niedrigeren Produktkomponentenstufe (z. B. 1) zu einer höheren Produktkomponentenstufe (z. B. 3) wechselt, wird dies als Upgrade betrachtet und es könnte eine einmalige Gebühr erhoben werden.
  • componentGroup
    bigint
     
  • defaultComponent
    boolean
    Sobald eine Komponente als 'Standard' Komponente markiert ist, wird sie als Standardkomponente in ihrer Gruppe verwendet und in der Produktkonfiguration vorausgewählt.
  • description
    struct
    Die Beschreibugn der Komponenten dürfen eine längere Beschreibung enthalten. Dies gibt dem Abonnenten ein besseres Verständnis vom Inhalt der Komponente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    Die maximale Quantität definiert den maximalen Wert, der für die Quantität eingegeben werden kann.
  • minimalQuantity
    decimal
    Die minimale Quantität definiert den minimalen Wert, der für die Quantität eingegeben werden kann.
  • name
    struct
    Der Name der Komponenten wird dem Abonnenten angezeigt. Er sollte in wenigen Worten die Komponentenfunktionen erklären.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    Der Quantitätsschritt definiert in welchem Interval die Quantität erhöht werden kann.
  • reference
    bigint
    Die Komponentenreferenz wird genutzt um die Komponenten in externen Systemen zu identifizieren. Im Weiteren markiert die Referenz Komponenten, die innerhalb der unterschiedlichen Produktversionen verwendet werden.
  • sortOrder
    int
    Die Sortierreihenfolge kontrolliert die Reihenfolge der Komponenten. Sie wird verwendet um die Komponenten in absteigender Reihenfolge zu sortieren.
  • taxClass
    bigint
    Die Steuerklasse der Komponente definiert die Steuern, welche auf allen Gebühren der Komponente angewendet werden.
  • 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 Name der Komponentengruppe wird angezeigt, wenn die Komponenten ausgewhält werden. Es kann sein, dass der Abonnent dies sieht.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Die Komponentengruppe kann optional sein. Es muss also keine Komponente vom Abonnenten selektiert werden.
  • productVersion
    bigint
     
  • sortOrder
    int
    Die Sortierreihenfolge kontrolliert die Reihenfolge der Komponentengruppe. Sie wird verwendet um die Komponentengruppe in absteigender Reihenfolge zu sortieren.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductcomponentreference subscriptionproductcomponentreference

Die Produktkomponenten Referenz verbindet die Komponenten verschiedender Produkte. Dies ermöglicht die Migration von Produktversionen.

Die Produktkomponenten Referenz verbindet die Komponenten verschiedender Produkte. Dies ermöglicht die Migration von Produktversionen.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Der Name der Komponentenreferenz wird intern zur Identifikation der Referenz benutzt. Der Name wird in Suchfeldern angezeigt und sollte daher beschreibend und aussagekräftig sein.
  • spaceId
    bigint
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • linkedSpaceId
    bigint
    Die ID des Raums, zu dem dieses Objekt gehört.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
     
  • billingCycle
    string
    Der Abrechnungszyklus definiert den Verbuchungsrhytmus beim Abonnenten. Die Belastung kann, abhängig von den Einstellungen, einen abweichenden Rhytmus haben.
  • comment
    string
    Das Kommentarfeld kann für einen internen Kommentar zur Produktversion verwendet werden. Es hilft zu dokumentieren was im Produkt gewechselt wurde. Der Kommentar ist für den Abonnenten nicht ersichtlich.
  • createdOn
    timestamp
     
  • defaultCurrency
    string
    Die Standardwährung muss für alle Gebühren verwendet werden.
  • enabledCurrencies
    array
    Die aktivierten Währungen können für die Komponentengebühren verwendet werden. Nicht aktivierte Währungen können nicht für Gebühren verwendet werden.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Die hochgezählte Nummer entspricht der Versionnummer, welche erhöht wird, sobald eine neue Abo Version aktiviert wird.
  • minimalNumberOfPeriods
    int
    Die minimale Anzahl an Perioden entspricht der minimalen Kündigungsfrist eines Abos.
  • name
    struct
    Der Name der Produktversion entspricht dem Namen des Produkts, welcher dem Benutzer angezeigt wird. Bei einem Wechsel des Produktnamens wird eine neue Produktversion mit dem neuen Namen erzeugt.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    Die Kündigungsfrist definiert, wie viele Perioden bezahlt werden müssen, bis das Abo gekündigt wird.
  • obsoletedOn
    timestamp
     
  • product
    bigint
    Jede Produktversion ist mit einem Produkt verlinkt.
  • reference
    string
    Die Produktversionreferenz hilft die Version zu identifizieren. Die Referenz wird aus der Produktreferenz generiert.
  • retiringFinishedOn
    timestamp
     
  • retiringStartedOn
    timestamp
     
  • state
    string
    Der aktuelle Zustand des Objekts.
  • taxCalculation
    string
    Strategie, die für die Steuerberechnung in Gebühren verwendet wird.
  • 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
    Diese Zahlungsmethode sind zur Auswahl verfügbar, auch wenn diese auf dem Produkt nicht zugelassen sind.
  • 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
     
  • description
    string
    Die Beschreibung des Abonnenten kann genutzt werden um den Abonnenten zu identifizieren.
  • disallowedPaymentMethodConfigurations
    array
    Diese Zahlungsmethoden stehen nicht zur Verfügung, auch wenn diese auf dem Produkt zugelassen wären.
  • emailAddress
    string
    Die E-Mail-Adresse wird zur Kommunikation mit dem Abonnenten genutzt. Die E-Mail-Adresse muss pro Space eindeutig sein.
  • 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 des Abonnenten definiert die Sprache, welche für die 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 Abonnentenreferenz identifiziert den Abonnenten in den Administrativoberflächen. Wir empfehlen beispielsweise die Kundennummer zu verwenden.
  • 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
     
  • 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.