PDF Export

JSON New Subscription Order

Beispiel
{
    "promotionSource" : "WEBSHOP",
    "offerCode" : "BAR1",
    "publication" : "00000100",
    "edition" : "00000100",
    "mixType" : "01",
    "quantity" : "1",
    "customerPurchaseOrderType" : "I",
    "issueNumberFrom" : "000006880",
    "paymentMethod" : "K",
    "totalPaidCurrencyCode" : "GBP",
    "totalPaidAmount" : 795.00,
    "fixPrice" : 795,
    "walletPartPaymentAmount" : 0.00,
    "currencyCode" : "GBP",
    "priceListType" : "01",
    "fixedPriceListAndCurrencyCode" : true,
    "externalOrderNumber" : "93-2",
    "inputOffice" : "TST-INPUT",
    "inputDate" : "2017-04-19",
    "inputUser" : "SYS-RFC",
    "saveInSystem" : true,
    "matriculatedTo" : "2019-01-20",
    "saveInSystem" : true,
    "postAtOnce" : false,
    "skipDoiProcess" : false,
    "dsbEPaymentGuid" : "ac5f2111-d2ff-402e-b760-5d4e67d19b6f",
    "extraPayVoucher" : {
        "bankClearingAccount" : "voucher2",
        "amount" : 12.45,
        "currencyCode" : "EUR",
        "payeeNote" : "Test Voucher 2"
    },
    "subscriptionRenewal" : {
        "automaticRenewal" : false
    },
    "bpRelations" : [ {
          "role" : "AG",
          "bp" : {...}
    }],
    "premium": [{
      "materialNumber": "TestGIFT",
      "role": "VM",
      "referral": true
    }],
    "orderAttribute" : [],
    "additionalInformation" : [
      {
        "type" : "aType",
        "text" : "blabla"
      },
      {
        "type" : "utm_campaign",
        "text" : "Test"
      }
    ],
    "offerPhases" : [
        {
         "phase" : 1,
         "numberOfClaims" : 9999,
         "billingFrequency" : "M2",
         "priceKey" : "MIG1",
         "price" : 100.00,
         "currency" : "EUR",
         "numberFreeIssues" : 0.00,
         "priceBundleSlave1" : 0.00,
         "priceBundleSlave2" : 0.00,
         "priceBundleSlave3" : 0.00,
         "freeCycle" : false,
         "rightDefinition" : "TestRecht"
        }
    ],
    "complaint": {
            "type": "delivery",
	    "complaintReason": "G01",
            "numberOfIssues": 5, 
            "text": "Test"
        },
    "complaints": [{
            "type": "delivery",
	    "complaintReason": "G01",
            "numberOfIssues": 5, 
            "text": "Test"
        },
        {
            "type": "delivery",
	    "complaintReason": "G02",
            "numberOfIssues": 4, 
            "text": "Test"
        }]
}

More examples

Element Definitionen

Parameter TypLängeBeschreibung
promotionSource C10Bestellquelle (in AVS/3) (mandatory)
promotionSourceVariantC1Bestellquellen Variante
salesPromotion C8Werbeaktion (Falls mehrere Werbeaktionen für eine BQ angelegt wurden, so muss hier übergeben werden, welche benutzt werden soll)
advertisingLevel N2Werbestufe des akzeptierten Angebots(0-99 )
offerCode C5(Erneuerungs-)Angebot
publication C8Druckerzeugnis wenn blank, dann automatische Ermittlung aus dem BQ
edition C8Planvertriebsausgabe wenn blank, dann automatische Ermittlung aus Druckerzeugnis.
mixType C2Bezugstyp
Wert ist abhängig vom Mandant und können z. B. sein:
01 = Vollabo,
10 = mit CD,
11 = mit DVD
Dies aber bitte mit der Kundenbetreuung abklären. Wenn blank, dann automatische Ermittlung aus dem BQ.
purchaseFrequency C2Bezugsperiodizität - Muss nur angegeben werden wenn sie nicht eindeutig ist für den Mandanten. Mögliche Werte sind: VA = Vollabo Restliche Werte sind mandantenspezifisch
deliveryType C2Lieferart - Die Werte sind mandantenspezifisch. Bitte wenden Sie sich an Ihren Kundenberater.
quantity N Menge der Kundenauftrag-Verlag-Position-Einteilung. Default 1
salesOrganization C4Verkaufsorganisation - Muss nicht gefüllt werden, falls es über den BQ ermittelt werden kann oder in der PVA (Feld 'edition') eindeutig ist.
salesSuborganization C5Unterorganisation der vkorg
salesBureau C4annehmendes Verkaufsbüro - Ermittlung anhand des Feldes „inputuser“. Ansonsten: 0001 Restliche Werte sind mandantenspezifisch
distributionChannel C2Vertriebsweg - Muss nur angegeben werden, falls der Wert sich nicht eindeutig aus der PVA (Feld 'edition') ableiten lässt.
division C2Sparte Auftragskopf - Muss nur angegeben werden, falls der Wert sich nicht eindeutig aus dem Druckerzeugnis (Feld 'publication') ableiten lässt.
customerPurchaseOrderNumberC20Bestellnummer des Kunden
customerPurchaseOrderTypeC4Bestellart des Kunden - z.B. 'I' → Internet; 'T' → telefonisch
customerPurchaseOrderDateD Bestelldatum des Kunden Format (YYYY-MM-DD)
validFrom D EVT-Termin, ab welchem das nächste Heft geliefert werden soll. Falls das Datum kein Erstverkaufstag (EVT) ist, so wird auf den nächsten EVT-Termin hochgerechnet. Dieses Feld und „issue-number-from“ schließen sich gegenseitig aus.
validTo D EVT-Termin bis zu welchem die Lieferung der Hefte erfolgen soll Falls das Datum kein Erstverkaufstag (EVT) ist, so wird zum letzten EVTTermin heruntergerechnet. Dieses Feld und „issue-number-to“ schließen sich gegenseitig aus.
issueNumberFromC9Heftnummer der ersten zu liefernden Vertriebsausgabe. Standard Format: HHHH/YYYY oder mandantespezifisches Format/Freitext. Default: nächstes Heft im Versand. Dieses Feld und „valid-from“ schließen sich gegenseitig aus.
issueNumberToC9Heftnummer der letzten zu liefernden Vertriebsausgabe. Standard Format: HHHH/YYYY oder mandantespezifisches Format/ Freitext. Default: unbefristet bzw. die im BQ eingetragene Dauer. Dieses Feld und „valid-to“ schließen sich gegenseitig aus.
archiveReferenceC20Ablagenummer, Referenzbeleg
paymentMethodC1Zahlweg (mandatory) (Codes)
payMethodDetails
* cheque
* bankClearingAccountC10Bankverrechnungskonto - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* chequeNumber C13 Schecknummer - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* amount N Betrag in Transaktionswährung mit Vorzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* currencyCode C3 Währungskennzeichen ISO - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist Währung als ISO-Währungscode
EUR Euro
CHF Schweizer Franken
GBP Britische Pfund usw.
* bankCode C15Bankleitzahl - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* bankControlKey C2Bankenkontrolschlüssel - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* bankCountryCode C2Länderschlüssel der Bank - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* bankAccountNumber C18Bankkontonummer - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist
* other
* bankClearingAccountC10Bankverrechnungskonto - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist
* amount N Betrag in Transaktionswährung mit Vorzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist
* currencyCode C3Währungskennzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist Währung als ISO-Währungscode
EUR Euro
CHF Schweizer Franken
GBP Britische Pfund
usw.
* payeeNote C80Text zur verwendung der Zahlung - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist
totalPaidCurrencyCodeC3Währungskennzeichen - wird momentan für Renewal genutzt
totalPaidAmount N Der gezahlte Gesamtbetrag - wird momentan für Renewal genutzt
fixPrice N
walletPartPaymentAmount N Der mit Gutschein bezahlte Teilbetrag - wird momentan für Renewal genutzt
extraPayDiscount
* currencyCode C3Währungskennzeichen des Zu-/ Abschlags - wird momentan für Renewal genutzt
* discount N Rabatt
* extraPay N Zuschlag - wird zur Zeit über die Schnittstelle nicht genutzt
extraPayVoucher BETA
* bankClearingAccount C 10 BETA Bankverrechnungskonto, Pflichtfeld, wenn Struktur 'extraPayVoucher' angegeben ist
* amount N 9,2 BETA Betrag in Transaktionswährung mit Vorzeichen, Pflichtfeld, wenn Struktur 'extraPayVoucher' angegeben ist
* currencyCode C 3 BETA Währungskennzeichen, Pflichtfeld, wenn Struktur 'extraPayVoucher' angegeben ist Währung als ISO-Währungscode
EUR Euro
CHF Schweizer Franken
GBP Britische Pfund
usw.
* payeeNote C 80 BETA Text zur verwendung der Zahlung, Kann
printInvoice C Kennzeichen Rechnung drucken - Y = Rechnung drucken
N = keine Rechnung drucken
purchaseReason C3Bezugsgrund
deliveryEndReason C3 Lieferende Grund - Mandantenabhängig. Aufstellung nach Rücksprache mit ihrer AVS/3-Kundenbetreuung.
billingFrom D Berechnungsbeginn - Datum, ab welchem berechnet werden soll
issueBillingFrom C9Berechnungsbeginn - Heftnummer, ab welcher berechnet werden soll
currencyCode C3Währung - Währung als ISO-Währungscode
EUR Euro
CHF Schweizer Franken
GBP Britische Pfund
usw.
priceListType C2Preislistentyp - wenn blank, Ermittlungslogik aus: /DSB/JOT_PL_FIND
fixedPriceListAndCurrencyCode B don't change the submitted price and currency code (Default: false)
debitAccounts
* debitAccountId C4debit account id
* debitBankCode C15Bankschlüssel - Muss, wenn entsprechender Zahlweg.
* debitCountryCode C2ISO-Ländercode der Bank - ISO-Ländercode der Bankverbindung bei entsprechendem Zahlweg.
* debitAccountNumber C18Bankkontonummer - Muss, wenn entsprechender Zahlweg.
* debitAccountHolder C60Name des Kontoinhabers - Muss, wenn entsprechender Zahlweg.
* debitContinuous B Liegt eine Einzugsermächtigung vor? true = ja
false = nein
* debitDueDate C2Fälligkeitsdatum für Bankeinzug - Tag des Monats (1-31)
* iban C34International bank account nummer (debitAccountNumber oder iban ist mandatory) Siehe auch Element „sepa-mandate“
* bic C11Bank identifier code (debitBankCode oder bic ist mandatory)
sepaMandate
* creationType C1„ “ = kein Mandat angelegt
„N“ = Neues Mandat anlegen
„T“ l= Mandatsumstellung (momentan nicht zu verwenden)
„M“ = Mandatsmigration(momentan nicht zu verwenden)
Muss angegeben werden, wenn eine IBAN vorhanden ist!
* transactionType C1„1“ = 1x Mandat
„N“ = Mehrfach Mandat (default)
* sepaDetails
* * b2bMandante B B2B-Mandat „true” oder „false” (Wird bisher nicht unterstützt)
* * mandateRefPerCreditorC35Eindeutige Referenz auf das Mandat pro Kreditor / Bisherige Mandats-ID (Nur für Umstellungen relevant creation-type „T“ und „M“)
* * previousCreditorId C35Kreditorkennung (landesübergreifend eindeutig) / Bisherige Gläubiger-ID (Nur für Umstellungen relevant creation-type „T“ und „M“))
* * previousBic C11Bisheriger BIC-Code (Nur für Umstellungen relevant „T“ und „M“)
* * lastDueDate C Wenn Vorlagemandat verwendet wurde mit Datum der letzten Verwendung (Fälligkeit) füllen Initialwert für Übernahmen (Typ „M“) notwendig, falls noch nicht eingezogen wurde „YYYY-MM-DD“
priceKeyInTrialterm C4Preisschlüssel der Probeposition - gem. Aufstellung. Die Attribute sind mandantenabhängig. Eine Aufstellung erhalten Sie von Ihrer AVS/3- Kundenbetreuung.
billingFrequencyInTrialtermC2Fakturaperiodizität in der Probeposition Fakturaperioditität
priceGroupInTrialtermC2Preisgruppe Kunde in der Probeposition
durationInTrialtermC3Positionsdauer der Probeposition
unitInTrialterm C3Einheit der Dauer der Probeposition - z.B.:
MON Monate
WCH Wochen
TAG Tage
priceKeyInNormalterm1C4Preisschlüssel der Normalposition 1 - gem. Aufstellung. Die Attribute sind mandantenabhängig. Eine Aufstellung erhalten Sie von Ihrer AVS/3- Kundenbetreuung.
billingFrequencyInNormalterm1C2Fakturaperiodizität der Normalposition 1 Fakturaperioditität
priceGroupInNormalterm1C2Preisgruppe Kunde für die Normalposition 1
durationInNormalterm1C3Positionsdauer der Normalposition 1
unitInNormalterm1C3Einheit der Dauer der Normalposition 1 z.B.:
MON Monate
WCH Wochen
TAG Tage
priceKey C4Preisschlüssel der Normalposition - gem. Aufstellung. Die Attribute sind mandantenabhängig. Eine Aufstellung erhalten Sie von Ihrer AVS/3-Kundenbetreuung.
billingFrequency C2Fakturaperiodizität der Normalposition billing frequency in normalterm
priceGroup C2Preisgruppe Kunde für die Normalposition
duration C3Positionsdauer der Normalposition
unit C3Einheit der Dauer der Normalposition
postageKey C30Portoschlüssel (für Versandkostenermittlung) Wenn hier ein Portoschlüssel angegeben wird, dann wird dieser gefixed ans AVS übertragen. D.h. ein evtl. vorhandenes customizing /Optimierung des Portos im Backend wird deaktiviert. Sollte das mandantenspezifische customizing greifen, so muss der postage-key einfach leer übertragen werden.
dsbMedia1 C1Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
dsbMedia2 C2Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
dsbMedia3 C3Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
dsbMedia4 C4Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
dsbMedia2b C2Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
dsbMedia7 C7Feld zur freien Verfügung. Wird zum Auftrag gespeichert.
rule-idC3Eindeutige Identifikationsnummer einer Abgleichsregel für die Auftragsbewertung
Feld ist leer = es wird eine eventuell vorhandene Regel-ID aus der BQ gezogen
Feldwert ist 999 = keine Regel anwenden (eine eventuell vorhandene Regel-ID aus der BQ wird nicht verwendet)
externalOrderNumberC35In diesem Feld wird eine mandantenweit eindeutige externe Auftragsnummer erwartet (mandatory). Diese dient gleichzeitig als Primärschlüssel in der Webservice-Datenbank. Dieses Feld wird NICHT im SAP gespeichert und kann dort nicht als Referenz verwendet werden (Bitte verwenden Sie für diesen Zweck ein Auftragsmerkmal).
inputOffice C12Erfassungsbüro (mandatory). Freitext-Feld zur Identifikation des Einspiel-Büros. Erscheint in OAA-Stapel-Liste und im Auftragskopf
inputDate D Erfassungsdatum (mandatory)
inputUser C12Erfassungsuser (mandatory). Freitext-Feld zur Identifikation des Einspiel-Mitarbeiters. Erscheint in OAA-Stapel-Liste und im Auftragskopf
stackName C17Stapelname (nur bei createOrderDirect Requests)
saveInSystem B 'true' Die übergebenen Daten werden gespeichert. (Default)
'false' Es erfolgt nur eine Prüfung der Daten ohne Speichern. (mandatory)
postAtOnce B 'true' Die übergebenen Daten werden sofort verbucht. 'false' Die übergebenen Daten werden erst durch einen Sachbearbeiter verbucht. (mandatory)
skipDoiProcess B Soll der double opt in Prozess übersprungen werden? Normalerweise wird dieses Flag gesetzt, wenn der Shop bereits den DOI Prozess anstößt. Default ist false. Dies ist nur bei Mandanten relevant, die diesen Prozess nutzen.
adjustUpperAndLowerCase B 'true' Adressdaten werden von nur Großbuchstaben oder nur Kleinbuchstaben in Groß- und Kleinbuchstaben geändert. (Default) bzw. Namensanalyse ist eingeschalten
'false' Schreibweise der Adresse bleibt erhalten bzw. Namensalnalyse wird ausgeschalten
orderRating B 'true' = Auftragsbewertung ist an/aktiv (Default)
'true' = die Auftragsbewertung ist inaktiv / ausgeschaltet
stackLockCode C1Stapelsperre - W=Webservice
D=Datei
agentNumber C10Vertreternummer extern - Dies kann in Verbindung des Vertreters zur Provisionsabrechnung genutzt werden
agentOrganisationC5externe Vertreterorganisation
costCenter C10Kostenstelle - zu belastende Kostenstelle
matriculated B Kennzeichen Immatrikulationsbescheinigung vorhanden - 'true' → Immatrikulationsbescheinigung vorhanden 'true' → keine Immatrikulationsbescheinigung vorhanden Wenn hier true angegeben ist, muss auch das Datum gefüllt werden.
matriculatedTo D 10Immatrikulationsbescheinigung bis - Muss, wenn „matriculated“ auf Y gesetzt ist.
advanceBilling BVorausfaktur Flag (Default: false)
previouslyBilledTo D10 Datum „fakturiert bis“ im Vorsystem
issuePreviouslyBilledToC9Heftnummer „fakturiert bis“ im Vorsystem
deliveryStartStatisticalD10 Datum für den statistischen Lieferbeginn
issueDeliveryStartStatisticalC9Heftnummer für den statistischen Lieferbeginn
dispatchType C2Versandart. LP = Luftpost
dispatchText C5Versandtext - Weiteres Trennkriterium im Versand
ivwGroup C2Spezielle Gruppierung für IVWAuswertung
statisticGroup C2Kürzel der Statistikgruppe
conditionTermCommitmentPeriodN2Bindungsfrist - Vertragsbedingung:Dauer der Bindungsfrist (reguläreKündig. nach x Monaten möglich)
conditionTermCancellationPeriodN2Kündigungsfrist - Vertragsbedingungen: Kündigungsfrist
conditionTermRenewal N2Verlängerung - Vertragsbedingung: (autom.) Verlängerung der Bindungsfrist
dsbEPaymentGuid C36Authorisation-GUID in der dsb-Webservice Umgebung. Beinhaltet die ID von einem vormals getätigten notify Request (Bsp.: notifyCardTransactionWithWirecard)
dsbTrxIdForSolvencyCheckC36 Bonitätsprüfungs-GUID - Bonitätsprüfungs-GUID im dsb-WSI (z.Zt. ohne Funktion im AVS/3)
bpRelations
* roleC2business partner role
* bp business partner (see below)
subscriptionRenewal
* renewalOrderNumberC10Auftragsnummer des zu erneuernden Auftrags
* automaticRenewal B Kunde wünscht automatisch Erneuerung true / false
premium
* role C2Partner, der die Prämie erhalten soll - AG, RE, WE, VM
* materialNumber C18Materialnummer Sachprämie - wenn blank, aus BQ.
* referralBPrämie aufgrund einer Weiterempfehlung erhalten - true/false(default)
premiumPayment
* paymentMethodC1 siehe paymentMethod
* debitAccount siehe debitAccount
* ccAccount siehe ccAccount
orderAttribute
coreWbzCondition
* wbzWkzC1promotion charge benefit
* wbzWkzFixB WKZ-Key fixed
* wbzConditionC3WBZ-Condition
additionalInformation Zusatzinfo zum Abo
* typeC20Typ
* textC255Zusatzinfo
offerPhases Angebots Phasen
* phaseN1Angebotsphase
* numberOfClaimsN4Anzahl Fakturen, für die eine Renewal Phase gilt
* billingFrequencyC2Fakturaperiodizität
* priceKeyC2Preisschlüssel Abonnement
* priceN8,2Stepup Preis
* currencyC5Währung
* numberFreeIssuesN3Freifolgen am Beginn eines DD-Angebots
* priceBundleSlave1N13,2Bruttowert in Belegwährung
* priceBundleSlave2N13,2Bruttowert in Belegwährung
* priceBundleSlave3N13,2Bruttowert in Belegwährung
* freeCycleC1Kopplung Freifolgen an fkper
* rightDefinitionC255Rechte Definition
complaint Gutscheinabwicklung über SHOP/REKLA
* typeCdelivery / debit(Belastung) / credit(Gutschrift), mandatory
* complaintReasonC4Reklamationsgrund ,mandatory)
* numberOfIssuesN3Anzahl Heftfolgen (mandatory wenn type=delivery)
* amountN8,2Betrag (mandatory wenn type = debit/credit)
* textC35Freitext für Gutschrift/Belastung (optional)
complaints Gutscheinabwicklung über SHOP/REKLA Array von complaint Strukturen

businessPartners

orderAttributes


Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. Weitere Information