Inhaltsverzeichnis Auftrag lesen Get By Order Number Get By Reference Doc Get By Order Attribute Get By Search Pattern Auftrag lesen Diese Seite beschreibt die REST Web Services zu Abonnements. Get By Order Number Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByOrderNumber-3.0.0 SAP Fuba: /DSB/_ISM_E_SEL_VBELN Korrespondierender SOAP Service: getByOrderNumber. URL GET: /rest/{client}/subscriptions/{orderNumber} ParameterBeschreibung orderNumber Abo Auftragsnummer Zusätzliche allgemeine Parameter Parameter Beschreibung client Mandantennummer sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) readProductsales Sollen Product Sales Aufträge gelesen werdem? PS Aufträge müssen separat abgefragt werden. publication Vertriebsausgabe (optional) returnAddressType Welcher Geschäftspartner soll geliefert werden? (AG, WE, VM, RE). Default: WE returnAddressTimepoint Welche Adresse soll geliefert werden? (mandatory) 'L' = Adresse zum letzten Versand 'A' = aktive Adresse 'Z' = Adresse zum nächsten Versand returnExtendedCommunicationData Liefere erweiterte Kommunikationsdaten true = Ja false = Nein (Default) returnRenewalPaymentData Rückgabe zusätzlicher Renewal Zahlungsdaten true = Ja false = Nein (Default) returnRenewalIssueRemaining true = Ja Liefere Ausgaben zur gesamten Abolaufzeit oder Liefere die verbleibenden Ausgaben zum aktuellen Zyklus (Default) returnCurrentSuspencionData Rückgabe zusätzlicher Daten für die aktuelle Unterbrechung. Falls es keine aktuelle Unterbrechung gibt, werden die Daten zur nächsten geliefert. true = Ja false = Nein (Default) returnExtendedPremiumData Rückgabe zusätzlicher Prämien Daten true = Ja false = Nein (Default) returnHolidayAddresses BETA BETA Rückgabe von Urlaubsadressen true = Yes false = No (Default) filter kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Filter werden als kommaseparierte Liste als Request Parameter übergeben. Parameter zum Filter werden in eckigen Klammern als Key-Value-Paar an den Filternamen angehängt. Bsp.: &filter=filter1,filter2[key1=value1;key2=value2],filter2 Liste der verfügbaren Filter Ergebnis Das Ergebnis ist ein JSON Dokument mit einem Abo. JSON Subscription Order Beispiel { "orderNumber": "4807309861", "dsbUrposLief": "000001", "publication": "00000310", "publicationName": "Publication", "edition": "00000310", "mixType": "01", "purchaseFrequency": "VA", "deliveryType": "DM", "orderStatus": "I", "isRenewal" : true, "isTimebased" : true, "orderCurrency": "GBP", "issueNrFrom": "000000265", "issueNrTo": "000000277", "issueNrFirstBill": "", "validFrom": "2014-03-08", "validTo": "2015-02-24", "endReason": "900", "promotionSource": "MP2123", "prSourceVar": "", "referenceDoc": "10995ABC123456789", "custOrderNumber": "", "custOrderDate": "2014-01-24", "subscrPhase": "IF1", "priceGroup": "", "priceKey": "CP02", "paymentMethod": "", "subOProcessedPMD": {"subPaymentMethod": "660"}, "billingFrequency": "Y1", "billingFrequencyShortDescription": "", "quantity": "1", "salesOrganization": "0100", "dsbMedia1": "", "dsbMedia2": "", "dsbMedia3": "", "dsbMedia4": "", "dsbMedia2b": "", "dsbMedia7": "", "agentNumber": "", "materialNumber": "", "premiumDescription": "", "premiumDispatchDate": null, "premiumRepetitions": "", "premiumProcessedDate": null, "billingPayedTo": "", "issueNumberNextBill": "", "issueNumberFromLastBill": "", "issueNumberToLastBill": "", "currentDunningLevel": "00", "conditionTermCommitmentPeriod": "1", "conditionTermCancelationPeriod": "1", "conditionTermRenewal": "1", "salesSource": "REN1", "advertisingMedium": "MP2ED02", "salesDocumentType": "REN", "validFromEvt": "2014-02-25", "validToEvt": "2015-01-28", "validFromOnSaleDate": "2014-03-15", "validToOnSaleDate": "2015-02-15", "validFromIssueNr" : "1001", "validToIssueNr" : "1005", "dispatchType": "", "dispatchText": "", "contractAccountBalance": "0.00", "postageKey": "DM", "productType": "ON", "isCombiSubscription": false, "bundle": { "bundleNumber": "5001445625", "priceId": "F_E_VA", "bundleable": true }, "renewal": { "expiryDate": "2015-02-15", "expiryIssueNr": "000000277", "expiryDesc": "Issue 1570", "currentCycleNumberOfIssues": 13, "currentCycleExpiryDate": "2015-02-15", "currentCycleExpiryIssueNr": "000000277", "currentCycleExpiryDesc": "Issue 1570", "currentCycleStartDate": "2014-03-15", "currentCycleStartIssueNr": "000000265", "currentCycleAcceptanceDate": "2014-02-04", "currentCycleOffer": "ED1C2", "currentCycleOfferType": "RN", "currentCycleOfferDescription": "", "currentCycleOfferMarketingText": "", "currentCyclePaidAmount": "20.00", "currentCycleBundlePaidAmount": "0.00", "offerClassification": "", "offerClassificationDefinition": "", "orderCurrency": "GBP", "renewalDueDate": "2014-02-04", "numberIssuesRemaining": 0, "renewalBundleComponent" : "M", "autoRenewal": false, "autoRenewalNextPaymentAmount": 0, "autoRenewalNextPaymentFrequencyCode": "", "autoRenewalNextPaymentFrequencyText": "", "autoRenewalNextPaymentDate": null, "autoRenewalLastPaymentAmount": 0, "autoRenewalLastPaymentFrequencyCode": "", "autoRenewalLastPaymentFrequencyText": "", "autoRenewalLastPaymentDate": null, "autoRenewalActualClaimCounter": 2, "autoRenewalIncreaseClaimCounter": 0 }, "currentSuspension": { "suspendedFromDate": null, "suspendedToDate": null, "suspendedFromIssueNr": "", "suspendedToIssueNr": "", "suspendedReasonCode": "" }, "currentChangeInfo": { "futureMixType": null, "futureMixTypeFromIssueNr": null, "futureMixTypeToIssueNr": null, "formerMixType": null, "formerMixTypeToIssueNr": null, "futureDeliveryQuantity": null, "futureDeliveryQuantityFromIssueNr": null, "formerDeliveryQuantity": null, "formerDeliveryQuantityToIssueNr": null, "futureDeliveryType": null, "futureDeliveryTypeFromIssueNr": null, "formerDeliveryType": null, "formerDeliveryTypeToIssueNr": null, "futureDispatchType": null, "futureDispatchTypeFromIssueNr": null, "formerDispatchType": null, "formerDispatchTypeToIssueNr": null, "futureDispatchText": null, "futureDispatchTextFromIssueNr": null, "formerDispatchText": null, "formerDispatchTextToIssueNr": null }, "bundles": [], "businessPartners": [], "orderAttributes": [], "productSalesOrder" : { "status" : "", "statusDescription" : "", "positions" : [ { "positionNumber" : 1, "articleNumber" : "ABC", "externalArticleNumber" : "AY-32", "status" : "", "statusDescription" : "", "textVariant" : "", "articleDescription" : "", "activity" : "", "articleGroup" : "" } ] } } Element Definitions Field name Type Description orderNumber C Auftragsnummer dsbUrposLief C ursprüngliche Lieferposition dieses Auftrags publication C Druckerzeugnis publication-name C Bezeichnung des Druckerzeugnisses edition C Planvertriebsausgabe mixType C Bezugstyp purchaseFrequency C Bezugsperiodizität deliveryType C Lieferart orderStatus C Auftragsstatus isRenewal B handelt es sich um ein Renewal-Abo ? isTimebased B handelt es sich um ein zeitbasiertes Renewal-Abo ?(true/false) orderCurrency C Währung des Auftrags issueNrFrom C Lieferbeginn Heftnummer issueNrTo C Lieferende Heftnummer issueNrFirstBill C Heftnummer der 1. Rechnung validFrom D Lieferbeginn Datum validTo D Lieferende Datum validFromEvt D Datum des ersten Versandtages validToEvt D Datum des letzten Versandtages validFromOnSaleDate D Erstverkaufstag(EVT) des ersten zu liefernden Hefts validToOnSaleDate D Erstverkaufstag(EVT) des letzten gelieferten Hefts validFromIssueNr validToIssueNr endReason C Grund der Liefereinstellung promotionSource C Bestellquelle prSourceVar C Bestellquellen-Variante referenceDoc C Referenzbeleg custOrderNr C Bestellnummer des Kunden custorderDate D Bestelldatum des Kunden subscrPhase C Phase, in der sich das Abo momentan befindet priceGroup C Preisgruppe des Kunden priceKey C Preisschlüssel des Kunden paymentMethod C Zahlweg: E → Zahlung per Bankeinzug K→ Zahlung per Kreditkarte R → Zahlung per Rechnung. Für ausländische Kunden sind evtl. noch weitere Zahlwege vorgesehen subOProcessedPMD * subPaymentMethod C Zahlweg Untergruppe billingFrequency C Fakturaperioditität billingFrequencyShortDescription C Fakturaperioditität Kurz-Beschreibung quantity C Bezugsmenge salesOrganization C Verkaufsorganisation dsbMedia1 C Feld zur freien Verfügung. dsbMedia2 C Feld zur freien Verfügung. dsbMedia3 C Feld zur freien Verfügung. dsbMedia4 C Feld zur freien Verfügung. dsbMedia2b C Feld zur freien Verfügung. dsbMedia7 C Feld zur freien Verfügung. agentNumber C Vertreternummer materialNumber C Prämien-Nr. premiumDescription C Prämien Beschreibung premiumDispatchDate C Meldedatum an VHS premiumRepetitions C wievielte Wiederholung des Prämien-Versands premiumProcessedDate C Meldedatum an VHS billingPayedTo C Faktura bezahlt bis Heftnummer issueNumberNextBill C Heftnummer der nächsten Rechnung issueNumberFromLastBill C Heftnummer Start der letzten Rechnung issueNumberToLastBill C Heftnummer Ende der letzten Rechnung currentDunningLevel C Mahnstufe conditionTermCommitmentPeriod C Bindungsfrist conditionTermCancelationPeriod C Kündigungsfrist conditionTermRenewal N Verlängerung Vertragsbedingung salesSource C Werbeart advertisingMedium C Werbeträger salesDocumentType C Verkaufsbelegart dispatchType C Versandart dispatchText C Versandtext contractAccountBalance C Saldo des Vertragskontos \\Note! Bitte beachten! Dieser Wert ist nur Tagesaktuell!\\Bei Sammelrechnungen kann es der Saldo aus mehreren Verträgen sein. . negativer Wert = Kundenguthaben positiver Wert = offene Vorderungen vorhanden postageKey C Portoschlüssel (für Versandkostenermittlung) productType CBETA Art des Medium (ON,….) Mapping kann mit derm Service MasterData.getMasterData abgerufen werden isCombiSubscriptionBBETA Ist es ein Kombi Abo true/false(default) bundle bundleNumber C priceId C promotionSource C bundleable B fixed B exceptionCode S renewal expiryDate C Datum, an dem das ganze Abo abläuft. expiryIssueNr C Letzte Heftnummer, die der Abonnent bekommt expiryDesc C Letztes Heft renewalDueDate C Fälligkeit für nächste Zahlung numberIssuesRemaining N Wenn Request Flag returnRenewalIssueRemaining gesetzt ist, die Anzahl noch zu liefernder Ausgaben über das ganze Abo. Sonst, Anzahl noch zu liefernder Ausgaben über den aktuellen Zyklus currentCycleNumberOfIssues N Anzahl der Hefte in aktuellen Zyklus currentCycleStartIssueNr C Heftnummer des Beginns des aktuellen Zyklus currentCycleStartDate C Startdatum des aktuellen Zyklus currentCycleExpiryIssueNr C Heftnummer am Ende des aktuellen Zyklus currentCycleExpiryDate C Endedatum des aktuellen Zyklus currentCycleExpiryDesc C leftes Heft des aktuellen Zyklus currentCycleAcceptanceDate C Datum, an dem der Abonnent das Renewal Abo aktzeptiert currentCycleOffer C Renewal Angebot des aktuellen Zyklus currentCycleOfferType C Typ des Renewal Angebots des aktuellen Zyklus(RN, DD oder BU) currentCycleOfferDescription C Beschreibung des Renewal Angebots des aktuellen Zyklus currentCycleOfferMarketingText C Marketingtext des Renewal Angebots des aktuellen Zyklus offerClassification C Klassifikation B = bundle N = normal M = membership offerClassificationDefinition C Offer classification definition currentCyclePaidAmount C Zahlbetrag des aktuellen Zyklus des Auftrages currentCycleBundlePaidAmount C Gesamt-Zahlbetrag Bundle orderCurrency C Auftragswährung renewalBundleComponent C M = Master, S = Slave autoRenewal B Kennzeichen, ob Subscription automatisch erneuert wird (true/false) autoRenewalNextPaymentAmount C Zahlbetrag des nächsten Einzugs in der entsprechenden Auftrags Währung autoRenewalNextPaymentFrequencyCode C autoRenewalNextPaymentFrequencyText C autoRenewalNextPaymentDate C Datum des nächsten Einzugs autoRenewalLastPaymentAmount C Zahlbetrag des letzten Einzugs in der entsprechenden Auftrags Währung autoRenewalLastPaymentFrequencyCode C autoRenewalLastPaymentFrequencyText C autoRenewalLastPaymentDate C Datum des letzten Einzugs autoRenewalActualClaimCounter N actual claim counter autoRenewalIncreaseClaimCounter N increase claim counter bundles bundleOrderNumber C Auftragsnummer des Unterauftrags publication C Druckerzeugnis edition C Planvertriebsausgabe quantity N Menge currentSuspension suspendedFromDate C Unterbrechung von Datum suspendedToDate C Unterbrechung bis Datum suspendedFromIssueNr C Unterbrechung von Heft Nr. suspendedToIssueNr C Unterbrechung bis Heft Nr. suspendedReasonCode C Grund der Unterbrechung currentChangeInfo (Um diese Daten zu erhalten, setzen Sie sich bitte mit ihrem Kundenberater in Verbindung. Im Mandantencustomizing muss das Flag x_change_info gesetzt werden.) futureMixType C zukünftiger Bezugstyp futureMixTypeFromIssueNr C ab Heftnummer futureMixTypeToIssueNr C bis Heftnummer formerMixType C ehemaliger Bezugstyp formerMixTypeToIssueNr C bis Heftnummer futureDeliveryQuantity N zukünftige Liefermenge futureDeliveryQuantityFromIssueNr C ab Heftnummer formerDeliveryQuantity N ehemalige Liefermenge formerDeliveryQuantityToIssueNr C bis Heftnummer futureDeliveryType C zukünftige Lieferart futureDeliveryTypeFromIssueNr C ab Heftnummer formerDeliveryType C ehemalige Lieferart formerDeliveryTypeToIssueNr C bis Heftnummer futureDispatchType C zukünftige Versandart futureDispatchTypeFromIssueNr C ab Heftnummer formerDispatchType C ehemalige Versandart formerDispatchTypeToIssueNr C bis Heftnummer futureDispatchText C zukünftiger Versand-Text futureDispatchTextFromIssueNr C ab Heftnummer formerDispatchText C ehemaliger Versand-Text formerDispatchTextToIssueNr C bis Heftnummer productSalesOrder Daten zum Productsales Auftrag, bei Aufträgen, die mit readProductSales gelesen wurden. status C statusDescription C positions Postitionen zum Productsales Auftrag. positionNumber N articleNumber C externalArticleNumber C status C statusDescription C textVariant C articleDescription C activity C articleGroup C businessPartners JSON Business Partner Example { "role": "WE", "bpNumber": "1006346741", "fullSalutation": "Dear Mrs Customer", "lastName1": "Customer", "lastName2": "", "firstName": "Anne", "dateOfBirth": "", "fullLastName": "Customer", "nameAddition": "", "jobTitle": "", "title": "", "salutationCode": "02", "salutation": "Mrs", "company1": "", "company2": "", "company3": "", "department": "", "zipcode": "NN4 7BF", "street": "", "streetSuffix": "", "streetNumber": "", "streetNumberSuffix": "", "addressLine1": "1 Main Road", "addressLine2": "", "addressLine3": "", "regionCode": "NH", "regionText": "Northamptonshire", "fullStreet": "", "poBoxZipcode": "", "poBox": "", "poBoxCity": "", "majorCustZip": "", "city": "NORTHAMPTON", "district": "", "countryCode": "GB", "country": "United Kingdom", "advertisement": "Y", "blockTag": "N", "addressResearchRunning": true, "euSalesTaxNumber": "", "bicMasterNumber": "", "sector": "", "mobilePhoneNumber": "", "phoneNumber": "", "faxNumber": "", "emailAddress": "customer@example.com", "bpExtCommunication": [], "bpAttributes": [], "bpHolidayAddress": [] } Element Definitions Field name Description role C Art des Geschäftspartners AG = Auftraggeber WE = Warenempfänger RE = Rechnungsempfänger bpNumber C Geschäftspartnernummer fullSalutation C Montierte persönliche Briefanrede lastName1 C Nachname 1 lastName2 C Nachname 2 firstName C Vorname fullLastName C Montierter Nachname nameAddition C Namenszusatz jobTitle C Berufs-Bezeichnung title C Akademischer Titel salutationCode C Anrede-Code im AVS/3, For example 01 = Herr 02 = Frau salutation C Anrede company1 C Firma 1. Zeile der Firmenadresse. Falls dieses Feld gefüllt ist, ist der obige Name der Ansprechpartner dieser Firma. company2 C Firma 2. Zeile der Firmenadresse. company3 C Firma 3. Zeile der Firmenadresse. department C Abteilung zipcode C Postleitzahl street C Straße mit Hausnummer und Zusatz zur Hausnummer streetSuffix C Zusatz zur Straße streetName C Straßenname streetNumber C Hausnummer streetNumberSuffix C Hausnummer Zusatz addressLine1 C Adresse Zeile 1 für UK Adressen addressLine2 C Adresse Zeile 2 für UK Adressen addressLine3 C Adresse Zeile 3 für UK Adressen poBoxZipcode C Postleitzahl zum Postfach poBox C Postfach poBoxCity C Ort zum Postfach majorCustZip C Großkundenpostleitzahl city C Ort district C Zusatz zum Ort regionCode C regionText C countryCode C 2-stelliges Länderkennzeichen country C Land advertisement C Werbung erlaubt; Y / N blockTag C Allgemeine Kundesperre ( X = put block-tag ) addressResearchRunning B Addresssuche läuft? true/false euSalesTaxNumber C EU-UST Identnummer dateOfBirth D Geburtsdatum (YYYY-MM-DD) bicMasterNumber C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector C Branche mobilePhoneNumber C Handy-Nr.: Vorwahl + Anschluss phoneNumber C Telefon-Nr.: Vorwahl + Anschluss faxNumber C Fax-Nr.: Vorwahl + Anschluss emailAddress C E-Mail-Adresse bpExtCommunication erweiterte Kommunikationsdaten (nur wenn Request Parameter returnExtendedCommunicationData=true ist) communicationType C Typ; Wertebereich communicationValue C Wert communicationDefault C Default value Y / N bpAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert bpHolidayAddress JSON Attributes Beispiel "bpHolidayAddress": [ { "validFrom": "2009-11-08", "validTo": "9999-12-31", "street": "", "streetNumber": "", "streetNumberSuffix": "", "zipcode": "", "zipcodeExtension": "", "city": "", "district": "", "poBox": "", "poBoxExtension": "", "poBoxZipcode": "", "poBoxCity": "", "majorCustZip": "", "majorCustZipExtension": "", "countryCode": "" }, ... ] Element Definition ParameterTypLängeBeschreibung validFrom C 10 Gültig von YYYY-MM-DD validTo C 10 Gültig bis YYYY-MM-DD street C 35 Straßenname streetNumber C 10 Hausnummer streetNumberSuffix C 8 Ergänzung zur Hausnummer zipcode C 10 Postleitzahl zipcodeExtension C 4 Erweiterung der Postleitzahl city C 35 Ortsname district C 35 Ortsteil poBox C 35 Postfach poBoxExtension C 4 Erweiterung zum Postfach poBoxZipcode C 10 Postleitzahl des Postfachs poBoxCity C 35 Ort zum Postfach majorCustZip C 10 Postleitzahl der Firma majorCustZipExtension C 4 Erweiterung zur Postleitzahl der Firma countryCode C 3 Länderschlüssel orderAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert Get By Reference Doc Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByReferenceDoc-3.0.0 SAP Fuba: /DSB/_ISM_E_SEL_REFDOC Korrespondierender SOAP Service: getByReferenceDoc. URL GET: /rest/{client}/subscriptions ParameterBeschreibung refdocAbo reference-doc Nummer Zusätzliche allgemeine Parameter Parameter Beschreibung client Mandantennummer sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) readProductsales Sollen Product Sales Aufträge gelesen werdem? PS Aufträge müssen separat abgefragt werden. publication Vertriebsausgabe (optional) returnAddressType Welcher Geschäftspartner soll geliefert werden? (AG, WE, VM, RE). Default: WE returnAddressTimepoint Welche Adresse soll geliefert werden? (mandatory) 'L' = Adresse zum letzten Versand 'A' = aktive Adresse 'Z' = Adresse zum nächsten Versand returnExtendedCommunicationData Liefere erweiterte Kommunikationsdaten true = Ja false = Nein (Default) returnRenewalPaymentData Rückgabe zusätzlicher Renewal Zahlungsdaten true = Ja false = Nein (Default) returnRenewalIssueRemaining true = Ja Liefere Ausgaben zur gesamten Abolaufzeit oder Liefere die verbleibenden Ausgaben zum aktuellen Zyklus (Default) returnCurrentSuspencionData Rückgabe zusätzlicher Daten für die aktuelle Unterbrechung. Falls es keine aktuelle Unterbrechung gibt, werden die Daten zur nächsten geliefert. true = Ja false = Nein (Default) returnExtendedPremiumData Rückgabe zusätzlicher Prämien Daten true = Ja false = Nein (Default) returnHolidayAddresses BETA BETA Rückgabe von Urlaubsadressen true = Yes false = No (Default) filter kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Filter werden als kommaseparierte Liste als Request Parameter übergeben. Parameter zum Filter werden in eckigen Klammern als Key-Value-Paar an den Filternamen angehängt. Bsp.: &filter=filter1,filter2[key1=value1;key2=value2],filter2 Liste der verfügbaren Filter Ergebnis Das Ergebnis ist ein JSON Dokument mit einem Array von Abos. JSON Subscription Order Beispiel { "orderNumber": "4807309861", "dsbUrposLief": "000001", "publication": "00000310", "publicationName": "Publication", "edition": "00000310", "mixType": "01", "purchaseFrequency": "VA", "deliveryType": "DM", "orderStatus": "I", "isRenewal" : true, "isTimebased" : true, "orderCurrency": "GBP", "issueNrFrom": "000000265", "issueNrTo": "000000277", "issueNrFirstBill": "", "validFrom": "2014-03-08", "validTo": "2015-02-24", "endReason": "900", "promotionSource": "MP2123", "prSourceVar": "", "referenceDoc": "10995ABC123456789", "custOrderNumber": "", "custOrderDate": "2014-01-24", "subscrPhase": "IF1", "priceGroup": "", "priceKey": "CP02", "paymentMethod": "", "subOProcessedPMD": {"subPaymentMethod": "660"}, "billingFrequency": "Y1", "billingFrequencyShortDescription": "", "quantity": "1", "salesOrganization": "0100", "dsbMedia1": "", "dsbMedia2": "", "dsbMedia3": "", "dsbMedia4": "", "dsbMedia2b": "", "dsbMedia7": "", "agentNumber": "", "materialNumber": "", "premiumDescription": "", "premiumDispatchDate": null, "premiumRepetitions": "", "premiumProcessedDate": null, "billingPayedTo": "", "issueNumberNextBill": "", "issueNumberFromLastBill": "", "issueNumberToLastBill": "", "currentDunningLevel": "00", "conditionTermCommitmentPeriod": "1", "conditionTermCancelationPeriod": "1", "conditionTermRenewal": "1", "salesSource": "REN1", "advertisingMedium": "MP2ED02", "salesDocumentType": "REN", "validFromEvt": "2014-02-25", "validToEvt": "2015-01-28", "validFromOnSaleDate": "2014-03-15", "validToOnSaleDate": "2015-02-15", "validFromIssueNr" : "1001", "validToIssueNr" : "1005", "dispatchType": "", "dispatchText": "", "contractAccountBalance": "0.00", "postageKey": "DM", "productType": "ON", "isCombiSubscription": false, "bundle": { "bundleNumber": "5001445625", "priceId": "F_E_VA", "bundleable": true }, "renewal": { "expiryDate": "2015-02-15", "expiryIssueNr": "000000277", "expiryDesc": "Issue 1570", "currentCycleNumberOfIssues": 13, "currentCycleExpiryDate": "2015-02-15", "currentCycleExpiryIssueNr": "000000277", "currentCycleExpiryDesc": "Issue 1570", "currentCycleStartDate": "2014-03-15", "currentCycleStartIssueNr": "000000265", "currentCycleAcceptanceDate": "2014-02-04", "currentCycleOffer": "ED1C2", "currentCycleOfferType": "RN", "currentCycleOfferDescription": "", "currentCycleOfferMarketingText": "", "currentCyclePaidAmount": "20.00", "currentCycleBundlePaidAmount": "0.00", "offerClassification": "", "offerClassificationDefinition": "", "orderCurrency": "GBP", "renewalDueDate": "2014-02-04", "numberIssuesRemaining": 0, "renewalBundleComponent" : "M", "autoRenewal": false, "autoRenewalNextPaymentAmount": 0, "autoRenewalNextPaymentFrequencyCode": "", "autoRenewalNextPaymentFrequencyText": "", "autoRenewalNextPaymentDate": null, "autoRenewalLastPaymentAmount": 0, "autoRenewalLastPaymentFrequencyCode": "", "autoRenewalLastPaymentFrequencyText": "", "autoRenewalLastPaymentDate": null, "autoRenewalActualClaimCounter": 2, "autoRenewalIncreaseClaimCounter": 0 }, "currentSuspension": { "suspendedFromDate": null, "suspendedToDate": null, "suspendedFromIssueNr": "", "suspendedToIssueNr": "", "suspendedReasonCode": "" }, "currentChangeInfo": { "futureMixType": null, "futureMixTypeFromIssueNr": null, "futureMixTypeToIssueNr": null, "formerMixType": null, "formerMixTypeToIssueNr": null, "futureDeliveryQuantity": null, "futureDeliveryQuantityFromIssueNr": null, "formerDeliveryQuantity": null, "formerDeliveryQuantityToIssueNr": null, "futureDeliveryType": null, "futureDeliveryTypeFromIssueNr": null, "formerDeliveryType": null, "formerDeliveryTypeToIssueNr": null, "futureDispatchType": null, "futureDispatchTypeFromIssueNr": null, "formerDispatchType": null, "formerDispatchTypeToIssueNr": null, "futureDispatchText": null, "futureDispatchTextFromIssueNr": null, "formerDispatchText": null, "formerDispatchTextToIssueNr": null }, "bundles": [], "businessPartners": [], "orderAttributes": [], "productSalesOrder" : { "status" : "", "statusDescription" : "", "positions" : [ { "positionNumber" : 1, "articleNumber" : "ABC", "externalArticleNumber" : "AY-32", "status" : "", "statusDescription" : "", "textVariant" : "", "articleDescription" : "", "activity" : "", "articleGroup" : "" } ] } } Element Definitions Field name Type Description orderNumber C Auftragsnummer dsbUrposLief C ursprüngliche Lieferposition dieses Auftrags publication C Druckerzeugnis publication-name C Bezeichnung des Druckerzeugnisses edition C Planvertriebsausgabe mixType C Bezugstyp purchaseFrequency C Bezugsperiodizität deliveryType C Lieferart orderStatus C Auftragsstatus isRenewal B handelt es sich um ein Renewal-Abo ? isTimebased B handelt es sich um ein zeitbasiertes Renewal-Abo ?(true/false) orderCurrency C Währung des Auftrags issueNrFrom C Lieferbeginn Heftnummer issueNrTo C Lieferende Heftnummer issueNrFirstBill C Heftnummer der 1. Rechnung validFrom D Lieferbeginn Datum validTo D Lieferende Datum validFromEvt D Datum des ersten Versandtages validToEvt D Datum des letzten Versandtages validFromOnSaleDate D Erstverkaufstag(EVT) des ersten zu liefernden Hefts validToOnSaleDate D Erstverkaufstag(EVT) des letzten gelieferten Hefts validFromIssueNr validToIssueNr endReason C Grund der Liefereinstellung promotionSource C Bestellquelle prSourceVar C Bestellquellen-Variante referenceDoc C Referenzbeleg custOrderNr C Bestellnummer des Kunden custorderDate D Bestelldatum des Kunden subscrPhase C Phase, in der sich das Abo momentan befindet priceGroup C Preisgruppe des Kunden priceKey C Preisschlüssel des Kunden paymentMethod C Zahlweg: E → Zahlung per Bankeinzug K→ Zahlung per Kreditkarte R → Zahlung per Rechnung. Für ausländische Kunden sind evtl. noch weitere Zahlwege vorgesehen subOProcessedPMD * subPaymentMethod C Zahlweg Untergruppe billingFrequency C Fakturaperioditität billingFrequencyShortDescription C Fakturaperioditität Kurz-Beschreibung quantity C Bezugsmenge salesOrganization C Verkaufsorganisation dsbMedia1 C Feld zur freien Verfügung. dsbMedia2 C Feld zur freien Verfügung. dsbMedia3 C Feld zur freien Verfügung. dsbMedia4 C Feld zur freien Verfügung. dsbMedia2b C Feld zur freien Verfügung. dsbMedia7 C Feld zur freien Verfügung. agentNumber C Vertreternummer materialNumber C Prämien-Nr. premiumDescription C Prämien Beschreibung premiumDispatchDate C Meldedatum an VHS premiumRepetitions C wievielte Wiederholung des Prämien-Versands premiumProcessedDate C Meldedatum an VHS billingPayedTo C Faktura bezahlt bis Heftnummer issueNumberNextBill C Heftnummer der nächsten Rechnung issueNumberFromLastBill C Heftnummer Start der letzten Rechnung issueNumberToLastBill C Heftnummer Ende der letzten Rechnung currentDunningLevel C Mahnstufe conditionTermCommitmentPeriod C Bindungsfrist conditionTermCancelationPeriod C Kündigungsfrist conditionTermRenewal N Verlängerung Vertragsbedingung salesSource C Werbeart advertisingMedium C Werbeträger salesDocumentType C Verkaufsbelegart dispatchType C Versandart dispatchText C Versandtext contractAccountBalance C Saldo des Vertragskontos \\Note! Bitte beachten! Dieser Wert ist nur Tagesaktuell!\\Bei Sammelrechnungen kann es der Saldo aus mehreren Verträgen sein. . negativer Wert = Kundenguthaben positiver Wert = offene Vorderungen vorhanden postageKey C Portoschlüssel (für Versandkostenermittlung) productType CBETA Art des Medium (ON,….) Mapping kann mit derm Service MasterData.getMasterData abgerufen werden isCombiSubscriptionBBETA Ist es ein Kombi Abo true/false(default) bundle bundleNumber C priceId C promotionSource C bundleable B fixed B exceptionCode S renewal expiryDate C Datum, an dem das ganze Abo abläuft. expiryIssueNr C Letzte Heftnummer, die der Abonnent bekommt expiryDesc C Letztes Heft renewalDueDate C Fälligkeit für nächste Zahlung numberIssuesRemaining N Wenn Request Flag returnRenewalIssueRemaining gesetzt ist, die Anzahl noch zu liefernder Ausgaben über das ganze Abo. Sonst, Anzahl noch zu liefernder Ausgaben über den aktuellen Zyklus currentCycleNumberOfIssues N Anzahl der Hefte in aktuellen Zyklus currentCycleStartIssueNr C Heftnummer des Beginns des aktuellen Zyklus currentCycleStartDate C Startdatum des aktuellen Zyklus currentCycleExpiryIssueNr C Heftnummer am Ende des aktuellen Zyklus currentCycleExpiryDate C Endedatum des aktuellen Zyklus currentCycleExpiryDesc C leftes Heft des aktuellen Zyklus currentCycleAcceptanceDate C Datum, an dem der Abonnent das Renewal Abo aktzeptiert currentCycleOffer C Renewal Angebot des aktuellen Zyklus currentCycleOfferType C Typ des Renewal Angebots des aktuellen Zyklus(RN, DD oder BU) currentCycleOfferDescription C Beschreibung des Renewal Angebots des aktuellen Zyklus currentCycleOfferMarketingText C Marketingtext des Renewal Angebots des aktuellen Zyklus offerClassification C Klassifikation B = bundle N = normal M = membership offerClassificationDefinition C Offer classification definition currentCyclePaidAmount C Zahlbetrag des aktuellen Zyklus des Auftrages currentCycleBundlePaidAmount C Gesamt-Zahlbetrag Bundle orderCurrency C Auftragswährung renewalBundleComponent C M = Master, S = Slave autoRenewal B Kennzeichen, ob Subscription automatisch erneuert wird (true/false) autoRenewalNextPaymentAmount C Zahlbetrag des nächsten Einzugs in der entsprechenden Auftrags Währung autoRenewalNextPaymentFrequencyCode C autoRenewalNextPaymentFrequencyText C autoRenewalNextPaymentDate C Datum des nächsten Einzugs autoRenewalLastPaymentAmount C Zahlbetrag des letzten Einzugs in der entsprechenden Auftrags Währung autoRenewalLastPaymentFrequencyCode C autoRenewalLastPaymentFrequencyText C autoRenewalLastPaymentDate C Datum des letzten Einzugs autoRenewalActualClaimCounter N actual claim counter autoRenewalIncreaseClaimCounter N increase claim counter bundles bundleOrderNumber C Auftragsnummer des Unterauftrags publication C Druckerzeugnis edition C Planvertriebsausgabe quantity N Menge currentSuspension suspendedFromDate C Unterbrechung von Datum suspendedToDate C Unterbrechung bis Datum suspendedFromIssueNr C Unterbrechung von Heft Nr. suspendedToIssueNr C Unterbrechung bis Heft Nr. suspendedReasonCode C Grund der Unterbrechung currentChangeInfo (Um diese Daten zu erhalten, setzen Sie sich bitte mit ihrem Kundenberater in Verbindung. Im Mandantencustomizing muss das Flag x_change_info gesetzt werden.) futureMixType C zukünftiger Bezugstyp futureMixTypeFromIssueNr C ab Heftnummer futureMixTypeToIssueNr C bis Heftnummer formerMixType C ehemaliger Bezugstyp formerMixTypeToIssueNr C bis Heftnummer futureDeliveryQuantity N zukünftige Liefermenge futureDeliveryQuantityFromIssueNr C ab Heftnummer formerDeliveryQuantity N ehemalige Liefermenge formerDeliveryQuantityToIssueNr C bis Heftnummer futureDeliveryType C zukünftige Lieferart futureDeliveryTypeFromIssueNr C ab Heftnummer formerDeliveryType C ehemalige Lieferart formerDeliveryTypeToIssueNr C bis Heftnummer futureDispatchType C zukünftige Versandart futureDispatchTypeFromIssueNr C ab Heftnummer formerDispatchType C ehemalige Versandart formerDispatchTypeToIssueNr C bis Heftnummer futureDispatchText C zukünftiger Versand-Text futureDispatchTextFromIssueNr C ab Heftnummer formerDispatchText C ehemaliger Versand-Text formerDispatchTextToIssueNr C bis Heftnummer productSalesOrder Daten zum Productsales Auftrag, bei Aufträgen, die mit readProductSales gelesen wurden. status C statusDescription C positions Postitionen zum Productsales Auftrag. positionNumber N articleNumber C externalArticleNumber C status C statusDescription C textVariant C articleDescription C activity C articleGroup C businessPartners JSON Business Partner Example { "role": "WE", "bpNumber": "1006346741", "fullSalutation": "Dear Mrs Customer", "lastName1": "Customer", "lastName2": "", "firstName": "Anne", "dateOfBirth": "", "fullLastName": "Customer", "nameAddition": "", "jobTitle": "", "title": "", "salutationCode": "02", "salutation": "Mrs", "company1": "", "company2": "", "company3": "", "department": "", "zipcode": "NN4 7BF", "street": "", "streetSuffix": "", "streetNumber": "", "streetNumberSuffix": "", "addressLine1": "1 Main Road", "addressLine2": "", "addressLine3": "", "regionCode": "NH", "regionText": "Northamptonshire", "fullStreet": "", "poBoxZipcode": "", "poBox": "", "poBoxCity": "", "majorCustZip": "", "city": "NORTHAMPTON", "district": "", "countryCode": "GB", "country": "United Kingdom", "advertisement": "Y", "blockTag": "N", "addressResearchRunning": true, "euSalesTaxNumber": "", "bicMasterNumber": "", "sector": "", "mobilePhoneNumber": "", "phoneNumber": "", "faxNumber": "", "emailAddress": "customer@example.com", "bpExtCommunication": [], "bpAttributes": [], "bpHolidayAddress": [] } Element Definitions Field name Description role C Art des Geschäftspartners AG = Auftraggeber WE = Warenempfänger RE = Rechnungsempfänger bpNumber C Geschäftspartnernummer fullSalutation C Montierte persönliche Briefanrede lastName1 C Nachname 1 lastName2 C Nachname 2 firstName C Vorname fullLastName C Montierter Nachname nameAddition C Namenszusatz jobTitle C Berufs-Bezeichnung title C Akademischer Titel salutationCode C Anrede-Code im AVS/3, For example 01 = Herr 02 = Frau salutation C Anrede company1 C Firma 1. Zeile der Firmenadresse. Falls dieses Feld gefüllt ist, ist der obige Name der Ansprechpartner dieser Firma. company2 C Firma 2. Zeile der Firmenadresse. company3 C Firma 3. Zeile der Firmenadresse. department C Abteilung zipcode C Postleitzahl street C Straße mit Hausnummer und Zusatz zur Hausnummer streetSuffix C Zusatz zur Straße streetName C Straßenname streetNumber C Hausnummer streetNumberSuffix C Hausnummer Zusatz addressLine1 C Adresse Zeile 1 für UK Adressen addressLine2 C Adresse Zeile 2 für UK Adressen addressLine3 C Adresse Zeile 3 für UK Adressen poBoxZipcode C Postleitzahl zum Postfach poBox C Postfach poBoxCity C Ort zum Postfach majorCustZip C Großkundenpostleitzahl city C Ort district C Zusatz zum Ort regionCode C regionText C countryCode C 2-stelliges Länderkennzeichen country C Land advertisement C Werbung erlaubt; Y / N blockTag C Allgemeine Kundesperre ( X = put block-tag ) addressResearchRunning B Addresssuche läuft? true/false euSalesTaxNumber C EU-UST Identnummer dateOfBirth D Geburtsdatum (YYYY-MM-DD) bicMasterNumber C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector C Branche mobilePhoneNumber C Handy-Nr.: Vorwahl + Anschluss phoneNumber C Telefon-Nr.: Vorwahl + Anschluss faxNumber C Fax-Nr.: Vorwahl + Anschluss emailAddress C E-Mail-Adresse bpExtCommunication erweiterte Kommunikationsdaten (nur wenn Request Parameter returnExtendedCommunicationData=true ist) communicationType C Typ; Wertebereich communicationValue C Wert communicationDefault C Default value Y / N bpAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert bpHolidayAddress JSON Attributes Beispiel "bpHolidayAddress": [ { "validFrom": "2009-11-08", "validTo": "9999-12-31", "street": "", "streetNumber": "", "streetNumberSuffix": "", "zipcode": "", "zipcodeExtension": "", "city": "", "district": "", "poBox": "", "poBoxExtension": "", "poBoxZipcode": "", "poBoxCity": "", "majorCustZip": "", "majorCustZipExtension": "", "countryCode": "" }, ... ] Element Definition ParameterTypLängeBeschreibung validFrom C 10 Gültig von YYYY-MM-DD validTo C 10 Gültig bis YYYY-MM-DD street C 35 Straßenname streetNumber C 10 Hausnummer streetNumberSuffix C 8 Ergänzung zur Hausnummer zipcode C 10 Postleitzahl zipcodeExtension C 4 Erweiterung der Postleitzahl city C 35 Ortsname district C 35 Ortsteil poBox C 35 Postfach poBoxExtension C 4 Erweiterung zum Postfach poBoxZipcode C 10 Postleitzahl des Postfachs poBoxCity C 35 Ort zum Postfach majorCustZip C 10 Postleitzahl der Firma majorCustZipExtension C 4 Erweiterung zur Postleitzahl der Firma countryCode C 3 Länderschlüssel orderAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert Get By Order Attribute Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByOrderAttribute-3.0.0 Fuba: /DSB/_ISM_E_SEL_MERKM Korrespondierender SOAP Service: getByOrderAttribute. URL GET: /rest/{client}/subscriptions/attributes ParameterBeschreibung typeTyp des Attributs valueWert des Attributs Beide Parameter (type und value) können als Pattern angegeben werden. Dabei gelten Folgende Maskierungszeichen: „*“ und „%“ → beliebige Zeichenkette „+“ und „_“ → beliebiges einzelnes Zeichen Zusätzliche allgemeine Parameter Parameter Beschreibung client Mandantennummer sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) readProductsales Sollen Product Sales Aufträge gelesen werdem? PS Aufträge müssen separat abgefragt werden. publication Vertriebsausgabe (optional) returnAddressType Welcher Geschäftspartner soll geliefert werden? (AG, WE, VM, RE). Default: WE returnAddressTimepoint Welche Adresse soll geliefert werden? (mandatory) 'L' = Adresse zum letzten Versand 'A' = aktive Adresse 'Z' = Adresse zum nächsten Versand returnExtendedCommunicationData Liefere erweiterte Kommunikationsdaten true = Ja false = Nein (Default) returnRenewalPaymentData Rückgabe zusätzlicher Renewal Zahlungsdaten true = Ja false = Nein (Default) returnRenewalIssueRemaining true = Ja Liefere Ausgaben zur gesamten Abolaufzeit oder Liefere die verbleibenden Ausgaben zum aktuellen Zyklus (Default) returnCurrentSuspencionData Rückgabe zusätzlicher Daten für die aktuelle Unterbrechung. Falls es keine aktuelle Unterbrechung gibt, werden die Daten zur nächsten geliefert. true = Ja false = Nein (Default) returnExtendedPremiumData Rückgabe zusätzlicher Prämien Daten true = Ja false = Nein (Default) returnHolidayAddresses BETA BETA Rückgabe von Urlaubsadressen true = Yes false = No (Default) filter kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Filter werden als kommaseparierte Liste als Request Parameter übergeben. Parameter zum Filter werden in eckigen Klammern als Key-Value-Paar an den Filternamen angehängt. Bsp.: &filter=filter1,filter2[key1=value1;key2=value2],filter2 Liste der verfügbaren Filter Ergebnis Das Ergebnis ist ein JSON Dokument mit einem Array von Abos. JSON Subscription Order Beispiel { "orderNumber": "4807309861", "dsbUrposLief": "000001", "publication": "00000310", "publicationName": "Publication", "edition": "00000310", "mixType": "01", "purchaseFrequency": "VA", "deliveryType": "DM", "orderStatus": "I", "isRenewal" : true, "isTimebased" : true, "orderCurrency": "GBP", "issueNrFrom": "000000265", "issueNrTo": "000000277", "issueNrFirstBill": "", "validFrom": "2014-03-08", "validTo": "2015-02-24", "endReason": "900", "promotionSource": "MP2123", "prSourceVar": "", "referenceDoc": "10995ABC123456789", "custOrderNumber": "", "custOrderDate": "2014-01-24", "subscrPhase": "IF1", "priceGroup": "", "priceKey": "CP02", "paymentMethod": "", "subOProcessedPMD": {"subPaymentMethod": "660"}, "billingFrequency": "Y1", "billingFrequencyShortDescription": "", "quantity": "1", "salesOrganization": "0100", "dsbMedia1": "", "dsbMedia2": "", "dsbMedia3": "", "dsbMedia4": "", "dsbMedia2b": "", "dsbMedia7": "", "agentNumber": "", "materialNumber": "", "premiumDescription": "", "premiumDispatchDate": null, "premiumRepetitions": "", "premiumProcessedDate": null, "billingPayedTo": "", "issueNumberNextBill": "", "issueNumberFromLastBill": "", "issueNumberToLastBill": "", "currentDunningLevel": "00", "conditionTermCommitmentPeriod": "1", "conditionTermCancelationPeriod": "1", "conditionTermRenewal": "1", "salesSource": "REN1", "advertisingMedium": "MP2ED02", "salesDocumentType": "REN", "validFromEvt": "2014-02-25", "validToEvt": "2015-01-28", "validFromOnSaleDate": "2014-03-15", "validToOnSaleDate": "2015-02-15", "validFromIssueNr" : "1001", "validToIssueNr" : "1005", "dispatchType": "", "dispatchText": "", "contractAccountBalance": "0.00", "postageKey": "DM", "productType": "ON", "isCombiSubscription": false, "bundle": { "bundleNumber": "5001445625", "priceId": "F_E_VA", "bundleable": true }, "renewal": { "expiryDate": "2015-02-15", "expiryIssueNr": "000000277", "expiryDesc": "Issue 1570", "currentCycleNumberOfIssues": 13, "currentCycleExpiryDate": "2015-02-15", "currentCycleExpiryIssueNr": "000000277", "currentCycleExpiryDesc": "Issue 1570", "currentCycleStartDate": "2014-03-15", "currentCycleStartIssueNr": "000000265", "currentCycleAcceptanceDate": "2014-02-04", "currentCycleOffer": "ED1C2", "currentCycleOfferType": "RN", "currentCycleOfferDescription": "", "currentCycleOfferMarketingText": "", "currentCyclePaidAmount": "20.00", "currentCycleBundlePaidAmount": "0.00", "offerClassification": "", "offerClassificationDefinition": "", "orderCurrency": "GBP", "renewalDueDate": "2014-02-04", "numberIssuesRemaining": 0, "renewalBundleComponent" : "M", "autoRenewal": false, "autoRenewalNextPaymentAmount": 0, "autoRenewalNextPaymentFrequencyCode": "", "autoRenewalNextPaymentFrequencyText": "", "autoRenewalNextPaymentDate": null, "autoRenewalLastPaymentAmount": 0, "autoRenewalLastPaymentFrequencyCode": "", "autoRenewalLastPaymentFrequencyText": "", "autoRenewalLastPaymentDate": null, "autoRenewalActualClaimCounter": 2, "autoRenewalIncreaseClaimCounter": 0 }, "currentSuspension": { "suspendedFromDate": null, "suspendedToDate": null, "suspendedFromIssueNr": "", "suspendedToIssueNr": "", "suspendedReasonCode": "" }, "currentChangeInfo": { "futureMixType": null, "futureMixTypeFromIssueNr": null, "futureMixTypeToIssueNr": null, "formerMixType": null, "formerMixTypeToIssueNr": null, "futureDeliveryQuantity": null, "futureDeliveryQuantityFromIssueNr": null, "formerDeliveryQuantity": null, "formerDeliveryQuantityToIssueNr": null, "futureDeliveryType": null, "futureDeliveryTypeFromIssueNr": null, "formerDeliveryType": null, "formerDeliveryTypeToIssueNr": null, "futureDispatchType": null, "futureDispatchTypeFromIssueNr": null, "formerDispatchType": null, "formerDispatchTypeToIssueNr": null, "futureDispatchText": null, "futureDispatchTextFromIssueNr": null, "formerDispatchText": null, "formerDispatchTextToIssueNr": null }, "bundles": [], "businessPartners": [], "orderAttributes": [], "productSalesOrder" : { "status" : "", "statusDescription" : "", "positions" : [ { "positionNumber" : 1, "articleNumber" : "ABC", "externalArticleNumber" : "AY-32", "status" : "", "statusDescription" : "", "textVariant" : "", "articleDescription" : "", "activity" : "", "articleGroup" : "" } ] } } Element Definitions Field name Type Description orderNumber C Auftragsnummer dsbUrposLief C ursprüngliche Lieferposition dieses Auftrags publication C Druckerzeugnis publication-name C Bezeichnung des Druckerzeugnisses edition C Planvertriebsausgabe mixType C Bezugstyp purchaseFrequency C Bezugsperiodizität deliveryType C Lieferart orderStatus C Auftragsstatus isRenewal B handelt es sich um ein Renewal-Abo ? isTimebased B handelt es sich um ein zeitbasiertes Renewal-Abo ?(true/false) orderCurrency C Währung des Auftrags issueNrFrom C Lieferbeginn Heftnummer issueNrTo C Lieferende Heftnummer issueNrFirstBill C Heftnummer der 1. Rechnung validFrom D Lieferbeginn Datum validTo D Lieferende Datum validFromEvt D Datum des ersten Versandtages validToEvt D Datum des letzten Versandtages validFromOnSaleDate D Erstverkaufstag(EVT) des ersten zu liefernden Hefts validToOnSaleDate D Erstverkaufstag(EVT) des letzten gelieferten Hefts validFromIssueNr validToIssueNr endReason C Grund der Liefereinstellung promotionSource C Bestellquelle prSourceVar C Bestellquellen-Variante referenceDoc C Referenzbeleg custOrderNr C Bestellnummer des Kunden custorderDate D Bestelldatum des Kunden subscrPhase C Phase, in der sich das Abo momentan befindet priceGroup C Preisgruppe des Kunden priceKey C Preisschlüssel des Kunden paymentMethod C Zahlweg: E → Zahlung per Bankeinzug K→ Zahlung per Kreditkarte R → Zahlung per Rechnung. Für ausländische Kunden sind evtl. noch weitere Zahlwege vorgesehen subOProcessedPMD * subPaymentMethod C Zahlweg Untergruppe billingFrequency C Fakturaperioditität billingFrequencyShortDescription C Fakturaperioditität Kurz-Beschreibung quantity C Bezugsmenge salesOrganization C Verkaufsorganisation dsbMedia1 C Feld zur freien Verfügung. dsbMedia2 C Feld zur freien Verfügung. dsbMedia3 C Feld zur freien Verfügung. dsbMedia4 C Feld zur freien Verfügung. dsbMedia2b C Feld zur freien Verfügung. dsbMedia7 C Feld zur freien Verfügung. agentNumber C Vertreternummer materialNumber C Prämien-Nr. premiumDescription C Prämien Beschreibung premiumDispatchDate C Meldedatum an VHS premiumRepetitions C wievielte Wiederholung des Prämien-Versands premiumProcessedDate C Meldedatum an VHS billingPayedTo C Faktura bezahlt bis Heftnummer issueNumberNextBill C Heftnummer der nächsten Rechnung issueNumberFromLastBill C Heftnummer Start der letzten Rechnung issueNumberToLastBill C Heftnummer Ende der letzten Rechnung currentDunningLevel C Mahnstufe conditionTermCommitmentPeriod C Bindungsfrist conditionTermCancelationPeriod C Kündigungsfrist conditionTermRenewal N Verlängerung Vertragsbedingung salesSource C Werbeart advertisingMedium C Werbeträger salesDocumentType C Verkaufsbelegart dispatchType C Versandart dispatchText C Versandtext contractAccountBalance C Saldo des Vertragskontos \\Note! Bitte beachten! Dieser Wert ist nur Tagesaktuell!\\Bei Sammelrechnungen kann es der Saldo aus mehreren Verträgen sein. . negativer Wert = Kundenguthaben positiver Wert = offene Vorderungen vorhanden postageKey C Portoschlüssel (für Versandkostenermittlung) productType CBETA Art des Medium (ON,….) Mapping kann mit derm Service MasterData.getMasterData abgerufen werden isCombiSubscriptionBBETA Ist es ein Kombi Abo true/false(default) bundle bundleNumber C priceId C promotionSource C bundleable B fixed B exceptionCode S renewal expiryDate C Datum, an dem das ganze Abo abläuft. expiryIssueNr C Letzte Heftnummer, die der Abonnent bekommt expiryDesc C Letztes Heft renewalDueDate C Fälligkeit für nächste Zahlung numberIssuesRemaining N Wenn Request Flag returnRenewalIssueRemaining gesetzt ist, die Anzahl noch zu liefernder Ausgaben über das ganze Abo. Sonst, Anzahl noch zu liefernder Ausgaben über den aktuellen Zyklus currentCycleNumberOfIssues N Anzahl der Hefte in aktuellen Zyklus currentCycleStartIssueNr C Heftnummer des Beginns des aktuellen Zyklus currentCycleStartDate C Startdatum des aktuellen Zyklus currentCycleExpiryIssueNr C Heftnummer am Ende des aktuellen Zyklus currentCycleExpiryDate C Endedatum des aktuellen Zyklus currentCycleExpiryDesc C leftes Heft des aktuellen Zyklus currentCycleAcceptanceDate C Datum, an dem der Abonnent das Renewal Abo aktzeptiert currentCycleOffer C Renewal Angebot des aktuellen Zyklus currentCycleOfferType C Typ des Renewal Angebots des aktuellen Zyklus(RN, DD oder BU) currentCycleOfferDescription C Beschreibung des Renewal Angebots des aktuellen Zyklus currentCycleOfferMarketingText C Marketingtext des Renewal Angebots des aktuellen Zyklus offerClassification C Klassifikation B = bundle N = normal M = membership offerClassificationDefinition C Offer classification definition currentCyclePaidAmount C Zahlbetrag des aktuellen Zyklus des Auftrages currentCycleBundlePaidAmount C Gesamt-Zahlbetrag Bundle orderCurrency C Auftragswährung renewalBundleComponent C M = Master, S = Slave autoRenewal B Kennzeichen, ob Subscription automatisch erneuert wird (true/false) autoRenewalNextPaymentAmount C Zahlbetrag des nächsten Einzugs in der entsprechenden Auftrags Währung autoRenewalNextPaymentFrequencyCode C autoRenewalNextPaymentFrequencyText C autoRenewalNextPaymentDate C Datum des nächsten Einzugs autoRenewalLastPaymentAmount C Zahlbetrag des letzten Einzugs in der entsprechenden Auftrags Währung autoRenewalLastPaymentFrequencyCode C autoRenewalLastPaymentFrequencyText C autoRenewalLastPaymentDate C Datum des letzten Einzugs autoRenewalActualClaimCounter N actual claim counter autoRenewalIncreaseClaimCounter N increase claim counter bundles bundleOrderNumber C Auftragsnummer des Unterauftrags publication C Druckerzeugnis edition C Planvertriebsausgabe quantity N Menge currentSuspension suspendedFromDate C Unterbrechung von Datum suspendedToDate C Unterbrechung bis Datum suspendedFromIssueNr C Unterbrechung von Heft Nr. suspendedToIssueNr C Unterbrechung bis Heft Nr. suspendedReasonCode C Grund der Unterbrechung currentChangeInfo (Um diese Daten zu erhalten, setzen Sie sich bitte mit ihrem Kundenberater in Verbindung. Im Mandantencustomizing muss das Flag x_change_info gesetzt werden.) futureMixType C zukünftiger Bezugstyp futureMixTypeFromIssueNr C ab Heftnummer futureMixTypeToIssueNr C bis Heftnummer formerMixType C ehemaliger Bezugstyp formerMixTypeToIssueNr C bis Heftnummer futureDeliveryQuantity N zukünftige Liefermenge futureDeliveryQuantityFromIssueNr C ab Heftnummer formerDeliveryQuantity N ehemalige Liefermenge formerDeliveryQuantityToIssueNr C bis Heftnummer futureDeliveryType C zukünftige Lieferart futureDeliveryTypeFromIssueNr C ab Heftnummer formerDeliveryType C ehemalige Lieferart formerDeliveryTypeToIssueNr C bis Heftnummer futureDispatchType C zukünftige Versandart futureDispatchTypeFromIssueNr C ab Heftnummer formerDispatchType C ehemalige Versandart formerDispatchTypeToIssueNr C bis Heftnummer futureDispatchText C zukünftiger Versand-Text futureDispatchTextFromIssueNr C ab Heftnummer formerDispatchText C ehemaliger Versand-Text formerDispatchTextToIssueNr C bis Heftnummer productSalesOrder Daten zum Productsales Auftrag, bei Aufträgen, die mit readProductSales gelesen wurden. status C statusDescription C positions Postitionen zum Productsales Auftrag. positionNumber N articleNumber C externalArticleNumber C status C statusDescription C textVariant C articleDescription C activity C articleGroup C businessPartners JSON Business Partner Example { "role": "WE", "bpNumber": "1006346741", "fullSalutation": "Dear Mrs Customer", "lastName1": "Customer", "lastName2": "", "firstName": "Anne", "dateOfBirth": "", "fullLastName": "Customer", "nameAddition": "", "jobTitle": "", "title": "", "salutationCode": "02", "salutation": "Mrs", "company1": "", "company2": "", "company3": "", "department": "", "zipcode": "NN4 7BF", "street": "", "streetSuffix": "", "streetNumber": "", "streetNumberSuffix": "", "addressLine1": "1 Main Road", "addressLine2": "", "addressLine3": "", "regionCode": "NH", "regionText": "Northamptonshire", "fullStreet": "", "poBoxZipcode": "", "poBox": "", "poBoxCity": "", "majorCustZip": "", "city": "NORTHAMPTON", "district": "", "countryCode": "GB", "country": "United Kingdom", "advertisement": "Y", "blockTag": "N", "addressResearchRunning": true, "euSalesTaxNumber": "", "bicMasterNumber": "", "sector": "", "mobilePhoneNumber": "", "phoneNumber": "", "faxNumber": "", "emailAddress": "customer@example.com", "bpExtCommunication": [], "bpAttributes": [], "bpHolidayAddress": [] } Element Definitions Field name Description role C Art des Geschäftspartners AG = Auftraggeber WE = Warenempfänger RE = Rechnungsempfänger bpNumber C Geschäftspartnernummer fullSalutation C Montierte persönliche Briefanrede lastName1 C Nachname 1 lastName2 C Nachname 2 firstName C Vorname fullLastName C Montierter Nachname nameAddition C Namenszusatz jobTitle C Berufs-Bezeichnung title C Akademischer Titel salutationCode C Anrede-Code im AVS/3, For example 01 = Herr 02 = Frau salutation C Anrede company1 C Firma 1. Zeile der Firmenadresse. Falls dieses Feld gefüllt ist, ist der obige Name der Ansprechpartner dieser Firma. company2 C Firma 2. Zeile der Firmenadresse. company3 C Firma 3. Zeile der Firmenadresse. department C Abteilung zipcode C Postleitzahl street C Straße mit Hausnummer und Zusatz zur Hausnummer streetSuffix C Zusatz zur Straße streetName C Straßenname streetNumber C Hausnummer streetNumberSuffix C Hausnummer Zusatz addressLine1 C Adresse Zeile 1 für UK Adressen addressLine2 C Adresse Zeile 2 für UK Adressen addressLine3 C Adresse Zeile 3 für UK Adressen poBoxZipcode C Postleitzahl zum Postfach poBox C Postfach poBoxCity C Ort zum Postfach majorCustZip C Großkundenpostleitzahl city C Ort district C Zusatz zum Ort regionCode C regionText C countryCode C 2-stelliges Länderkennzeichen country C Land advertisement C Werbung erlaubt; Y / N blockTag C Allgemeine Kundesperre ( X = put block-tag ) addressResearchRunning B Addresssuche läuft? true/false euSalesTaxNumber C EU-UST Identnummer dateOfBirth D Geburtsdatum (YYYY-MM-DD) bicMasterNumber C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector C Branche mobilePhoneNumber C Handy-Nr.: Vorwahl + Anschluss phoneNumber C Telefon-Nr.: Vorwahl + Anschluss faxNumber C Fax-Nr.: Vorwahl + Anschluss emailAddress C E-Mail-Adresse bpExtCommunication erweiterte Kommunikationsdaten (nur wenn Request Parameter returnExtendedCommunicationData=true ist) communicationType C Typ; Wertebereich communicationValue C Wert communicationDefault C Default value Y / N bpAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert bpHolidayAddress JSON Attributes Beispiel "bpHolidayAddress": [ { "validFrom": "2009-11-08", "validTo": "9999-12-31", "street": "", "streetNumber": "", "streetNumberSuffix": "", "zipcode": "", "zipcodeExtension": "", "city": "", "district": "", "poBox": "", "poBoxExtension": "", "poBoxZipcode": "", "poBoxCity": "", "majorCustZip": "", "majorCustZipExtension": "", "countryCode": "" }, ... ] Element Definition ParameterTypLängeBeschreibung validFrom C 10 Gültig von YYYY-MM-DD validTo C 10 Gültig bis YYYY-MM-DD street C 35 Straßenname streetNumber C 10 Hausnummer streetNumberSuffix C 8 Ergänzung zur Hausnummer zipcode C 10 Postleitzahl zipcodeExtension C 4 Erweiterung der Postleitzahl city C 35 Ortsname district C 35 Ortsteil poBox C 35 Postfach poBoxExtension C 4 Erweiterung zum Postfach poBoxZipcode C 10 Postleitzahl des Postfachs poBoxCity C 35 Ort zum Postfach majorCustZip C 10 Postleitzahl der Firma majorCustZipExtension C 4 Erweiterung zur Postleitzahl der Firma countryCode C 3 Länderschlüssel orderAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert Get By Search Pattern Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getBySearchPattern-1.0.0 SAP Fuba: /DSB/_ISM_E_SEL_VBELN URL GET: /rest/{client}/subscriptions?pattern={searchpattern} ParameterBeschreibung pattern ein search pattern Zusätzliche allgemeine Parameter Parameter Beschreibung client Mandantennummer sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) readProductsales Sollen Product Sales Aufträge gelesen werdem? PS Aufträge müssen separat abgefragt werden. publication Vertriebsausgabe (optional) returnAddressType Welcher Geschäftspartner soll geliefert werden? (AG, WE, VM, RE). Default: WE returnAddressTimepoint Welche Adresse soll geliefert werden? (mandatory) 'L' = Adresse zum letzten Versand 'A' = aktive Adresse 'Z' = Adresse zum nächsten Versand returnExtendedCommunicationData Liefere erweiterte Kommunikationsdaten true = Ja false = Nein (Default) returnRenewalPaymentData Rückgabe zusätzlicher Renewal Zahlungsdaten true = Ja false = Nein (Default) returnRenewalIssueRemaining true = Ja Liefere Ausgaben zur gesamten Abolaufzeit oder Liefere die verbleibenden Ausgaben zum aktuellen Zyklus (Default) returnCurrentSuspencionData Rückgabe zusätzlicher Daten für die aktuelle Unterbrechung. Falls es keine aktuelle Unterbrechung gibt, werden die Daten zur nächsten geliefert. true = Ja false = Nein (Default) returnExtendedPremiumData Rückgabe zusätzlicher Prämien Daten true = Ja false = Nein (Default) returnHolidayAddresses BETA BETA Rückgabe von Urlaubsadressen true = Yes false = No (Default) filter kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Filter werden als kommaseparierte Liste als Request Parameter übergeben. Parameter zum Filter werden in eckigen Klammern als Key-Value-Paar an den Filternamen angehängt. Bsp.: &filter=filter1,filter2[key1=value1;key2=value2],filter2 Liste der verfügbaren Filter Ergebnis Das Ergebnis ist ein JSON Dokument mit einer Liste von Abos. JSON Subscription Order Beispiel { "orderNumber": "4807309861", "dsbUrposLief": "000001", "publication": "00000310", "publicationName": "Publication", "edition": "00000310", "mixType": "01", "purchaseFrequency": "VA", "deliveryType": "DM", "orderStatus": "I", "isRenewal" : true, "isTimebased" : true, "orderCurrency": "GBP", "issueNrFrom": "000000265", "issueNrTo": "000000277", "issueNrFirstBill": "", "validFrom": "2014-03-08", "validTo": "2015-02-24", "endReason": "900", "promotionSource": "MP2123", "prSourceVar": "", "referenceDoc": "10995ABC123456789", "custOrderNumber": "", "custOrderDate": "2014-01-24", "subscrPhase": "IF1", "priceGroup": "", "priceKey": "CP02", "paymentMethod": "", "subOProcessedPMD": {"subPaymentMethod": "660"}, "billingFrequency": "Y1", "billingFrequencyShortDescription": "", "quantity": "1", "salesOrganization": "0100", "dsbMedia1": "", "dsbMedia2": "", "dsbMedia3": "", "dsbMedia4": "", "dsbMedia2b": "", "dsbMedia7": "", "agentNumber": "", "materialNumber": "", "premiumDescription": "", "premiumDispatchDate": null, "premiumRepetitions": "", "premiumProcessedDate": null, "billingPayedTo": "", "issueNumberNextBill": "", "issueNumberFromLastBill": "", "issueNumberToLastBill": "", "currentDunningLevel": "00", "conditionTermCommitmentPeriod": "1", "conditionTermCancelationPeriod": "1", "conditionTermRenewal": "1", "salesSource": "REN1", "advertisingMedium": "MP2ED02", "salesDocumentType": "REN", "validFromEvt": "2014-02-25", "validToEvt": "2015-01-28", "validFromOnSaleDate": "2014-03-15", "validToOnSaleDate": "2015-02-15", "validFromIssueNr" : "1001", "validToIssueNr" : "1005", "dispatchType": "", "dispatchText": "", "contractAccountBalance": "0.00", "postageKey": "DM", "productType": "ON", "isCombiSubscription": false, "bundle": { "bundleNumber": "5001445625", "priceId": "F_E_VA", "bundleable": true }, "renewal": { "expiryDate": "2015-02-15", "expiryIssueNr": "000000277", "expiryDesc": "Issue 1570", "currentCycleNumberOfIssues": 13, "currentCycleExpiryDate": "2015-02-15", "currentCycleExpiryIssueNr": "000000277", "currentCycleExpiryDesc": "Issue 1570", "currentCycleStartDate": "2014-03-15", "currentCycleStartIssueNr": "000000265", "currentCycleAcceptanceDate": "2014-02-04", "currentCycleOffer": "ED1C2", "currentCycleOfferType": "RN", "currentCycleOfferDescription": "", "currentCycleOfferMarketingText": "", "currentCyclePaidAmount": "20.00", "currentCycleBundlePaidAmount": "0.00", "offerClassification": "", "offerClassificationDefinition": "", "orderCurrency": "GBP", "renewalDueDate": "2014-02-04", "numberIssuesRemaining": 0, "renewalBundleComponent" : "M", "autoRenewal": false, "autoRenewalNextPaymentAmount": 0, "autoRenewalNextPaymentFrequencyCode": "", "autoRenewalNextPaymentFrequencyText": "", "autoRenewalNextPaymentDate": null, "autoRenewalLastPaymentAmount": 0, "autoRenewalLastPaymentFrequencyCode": "", "autoRenewalLastPaymentFrequencyText": "", "autoRenewalLastPaymentDate": null, "autoRenewalActualClaimCounter": 2, "autoRenewalIncreaseClaimCounter": 0 }, "currentSuspension": { "suspendedFromDate": null, "suspendedToDate": null, "suspendedFromIssueNr": "", "suspendedToIssueNr": "", "suspendedReasonCode": "" }, "currentChangeInfo": { "futureMixType": null, "futureMixTypeFromIssueNr": null, "futureMixTypeToIssueNr": null, "formerMixType": null, "formerMixTypeToIssueNr": null, "futureDeliveryQuantity": null, "futureDeliveryQuantityFromIssueNr": null, "formerDeliveryQuantity": null, "formerDeliveryQuantityToIssueNr": null, "futureDeliveryType": null, "futureDeliveryTypeFromIssueNr": null, "formerDeliveryType": null, "formerDeliveryTypeToIssueNr": null, "futureDispatchType": null, "futureDispatchTypeFromIssueNr": null, "formerDispatchType": null, "formerDispatchTypeToIssueNr": null, "futureDispatchText": null, "futureDispatchTextFromIssueNr": null, "formerDispatchText": null, "formerDispatchTextToIssueNr": null }, "bundles": [], "businessPartners": [], "orderAttributes": [], "productSalesOrder" : { "status" : "", "statusDescription" : "", "positions" : [ { "positionNumber" : 1, "articleNumber" : "ABC", "externalArticleNumber" : "AY-32", "status" : "", "statusDescription" : "", "textVariant" : "", "articleDescription" : "", "activity" : "", "articleGroup" : "" } ] } } Element Definitions Field name Type Description orderNumber C Auftragsnummer dsbUrposLief C ursprüngliche Lieferposition dieses Auftrags publication C Druckerzeugnis publication-name C Bezeichnung des Druckerzeugnisses edition C Planvertriebsausgabe mixType C Bezugstyp purchaseFrequency C Bezugsperiodizität deliveryType C Lieferart orderStatus C Auftragsstatus isRenewal B handelt es sich um ein Renewal-Abo ? isTimebased B handelt es sich um ein zeitbasiertes Renewal-Abo ?(true/false) orderCurrency C Währung des Auftrags issueNrFrom C Lieferbeginn Heftnummer issueNrTo C Lieferende Heftnummer issueNrFirstBill C Heftnummer der 1. Rechnung validFrom D Lieferbeginn Datum validTo D Lieferende Datum validFromEvt D Datum des ersten Versandtages validToEvt D Datum des letzten Versandtages validFromOnSaleDate D Erstverkaufstag(EVT) des ersten zu liefernden Hefts validToOnSaleDate D Erstverkaufstag(EVT) des letzten gelieferten Hefts validFromIssueNr validToIssueNr endReason C Grund der Liefereinstellung promotionSource C Bestellquelle prSourceVar C Bestellquellen-Variante referenceDoc C Referenzbeleg custOrderNr C Bestellnummer des Kunden custorderDate D Bestelldatum des Kunden subscrPhase C Phase, in der sich das Abo momentan befindet priceGroup C Preisgruppe des Kunden priceKey C Preisschlüssel des Kunden paymentMethod C Zahlweg: E → Zahlung per Bankeinzug K→ Zahlung per Kreditkarte R → Zahlung per Rechnung. Für ausländische Kunden sind evtl. noch weitere Zahlwege vorgesehen subOProcessedPMD * subPaymentMethod C Zahlweg Untergruppe billingFrequency C Fakturaperioditität billingFrequencyShortDescription C Fakturaperioditität Kurz-Beschreibung quantity C Bezugsmenge salesOrganization C Verkaufsorganisation dsbMedia1 C Feld zur freien Verfügung. dsbMedia2 C Feld zur freien Verfügung. dsbMedia3 C Feld zur freien Verfügung. dsbMedia4 C Feld zur freien Verfügung. dsbMedia2b C Feld zur freien Verfügung. dsbMedia7 C Feld zur freien Verfügung. agentNumber C Vertreternummer materialNumber C Prämien-Nr. premiumDescription C Prämien Beschreibung premiumDispatchDate C Meldedatum an VHS premiumRepetitions C wievielte Wiederholung des Prämien-Versands premiumProcessedDate C Meldedatum an VHS billingPayedTo C Faktura bezahlt bis Heftnummer issueNumberNextBill C Heftnummer der nächsten Rechnung issueNumberFromLastBill C Heftnummer Start der letzten Rechnung issueNumberToLastBill C Heftnummer Ende der letzten Rechnung currentDunningLevel C Mahnstufe conditionTermCommitmentPeriod C Bindungsfrist conditionTermCancelationPeriod C Kündigungsfrist conditionTermRenewal N Verlängerung Vertragsbedingung salesSource C Werbeart advertisingMedium C Werbeträger salesDocumentType C Verkaufsbelegart dispatchType C Versandart dispatchText C Versandtext contractAccountBalance C Saldo des Vertragskontos \\Note! Bitte beachten! Dieser Wert ist nur Tagesaktuell!\\Bei Sammelrechnungen kann es der Saldo aus mehreren Verträgen sein. . negativer Wert = Kundenguthaben positiver Wert = offene Vorderungen vorhanden postageKey C Portoschlüssel (für Versandkostenermittlung) productType CBETA Art des Medium (ON,….) Mapping kann mit derm Service MasterData.getMasterData abgerufen werden isCombiSubscriptionBBETA Ist es ein Kombi Abo true/false(default) bundle bundleNumber C priceId C promotionSource C bundleable B fixed B exceptionCode S renewal expiryDate C Datum, an dem das ganze Abo abläuft. expiryIssueNr C Letzte Heftnummer, die der Abonnent bekommt expiryDesc C Letztes Heft renewalDueDate C Fälligkeit für nächste Zahlung numberIssuesRemaining N Wenn Request Flag returnRenewalIssueRemaining gesetzt ist, die Anzahl noch zu liefernder Ausgaben über das ganze Abo. Sonst, Anzahl noch zu liefernder Ausgaben über den aktuellen Zyklus currentCycleNumberOfIssues N Anzahl der Hefte in aktuellen Zyklus currentCycleStartIssueNr C Heftnummer des Beginns des aktuellen Zyklus currentCycleStartDate C Startdatum des aktuellen Zyklus currentCycleExpiryIssueNr C Heftnummer am Ende des aktuellen Zyklus currentCycleExpiryDate C Endedatum des aktuellen Zyklus currentCycleExpiryDesc C leftes Heft des aktuellen Zyklus currentCycleAcceptanceDate C Datum, an dem der Abonnent das Renewal Abo aktzeptiert currentCycleOffer C Renewal Angebot des aktuellen Zyklus currentCycleOfferType C Typ des Renewal Angebots des aktuellen Zyklus(RN, DD oder BU) currentCycleOfferDescription C Beschreibung des Renewal Angebots des aktuellen Zyklus currentCycleOfferMarketingText C Marketingtext des Renewal Angebots des aktuellen Zyklus offerClassification C Klassifikation B = bundle N = normal M = membership offerClassificationDefinition C Offer classification definition currentCyclePaidAmount C Zahlbetrag des aktuellen Zyklus des Auftrages currentCycleBundlePaidAmount C Gesamt-Zahlbetrag Bundle orderCurrency C Auftragswährung renewalBundleComponent C M = Master, S = Slave autoRenewal B Kennzeichen, ob Subscription automatisch erneuert wird (true/false) autoRenewalNextPaymentAmount C Zahlbetrag des nächsten Einzugs in der entsprechenden Auftrags Währung autoRenewalNextPaymentFrequencyCode C autoRenewalNextPaymentFrequencyText C autoRenewalNextPaymentDate C Datum des nächsten Einzugs autoRenewalLastPaymentAmount C Zahlbetrag des letzten Einzugs in der entsprechenden Auftrags Währung autoRenewalLastPaymentFrequencyCode C autoRenewalLastPaymentFrequencyText C autoRenewalLastPaymentDate C Datum des letzten Einzugs autoRenewalActualClaimCounter N actual claim counter autoRenewalIncreaseClaimCounter N increase claim counter bundles bundleOrderNumber C Auftragsnummer des Unterauftrags publication C Druckerzeugnis edition C Planvertriebsausgabe quantity N Menge currentSuspension suspendedFromDate C Unterbrechung von Datum suspendedToDate C Unterbrechung bis Datum suspendedFromIssueNr C Unterbrechung von Heft Nr. suspendedToIssueNr C Unterbrechung bis Heft Nr. suspendedReasonCode C Grund der Unterbrechung currentChangeInfo (Um diese Daten zu erhalten, setzen Sie sich bitte mit ihrem Kundenberater in Verbindung. Im Mandantencustomizing muss das Flag x_change_info gesetzt werden.) futureMixType C zukünftiger Bezugstyp futureMixTypeFromIssueNr C ab Heftnummer futureMixTypeToIssueNr C bis Heftnummer formerMixType C ehemaliger Bezugstyp formerMixTypeToIssueNr C bis Heftnummer futureDeliveryQuantity N zukünftige Liefermenge futureDeliveryQuantityFromIssueNr C ab Heftnummer formerDeliveryQuantity N ehemalige Liefermenge formerDeliveryQuantityToIssueNr C bis Heftnummer futureDeliveryType C zukünftige Lieferart futureDeliveryTypeFromIssueNr C ab Heftnummer formerDeliveryType C ehemalige Lieferart formerDeliveryTypeToIssueNr C bis Heftnummer futureDispatchType C zukünftige Versandart futureDispatchTypeFromIssueNr C ab Heftnummer formerDispatchType C ehemalige Versandart formerDispatchTypeToIssueNr C bis Heftnummer futureDispatchText C zukünftiger Versand-Text futureDispatchTextFromIssueNr C ab Heftnummer formerDispatchText C ehemaliger Versand-Text formerDispatchTextToIssueNr C bis Heftnummer productSalesOrder Daten zum Productsales Auftrag, bei Aufträgen, die mit readProductSales gelesen wurden. status C statusDescription C positions Postitionen zum Productsales Auftrag. positionNumber N articleNumber C externalArticleNumber C status C statusDescription C textVariant C articleDescription C activity C articleGroup C businessPartners JSON Business Partner Example { "role": "WE", "bpNumber": "1006346741", "fullSalutation": "Dear Mrs Customer", "lastName1": "Customer", "lastName2": "", "firstName": "Anne", "dateOfBirth": "", "fullLastName": "Customer", "nameAddition": "", "jobTitle": "", "title": "", "salutationCode": "02", "salutation": "Mrs", "company1": "", "company2": "", "company3": "", "department": "", "zipcode": "NN4 7BF", "street": "", "streetSuffix": "", "streetNumber": "", "streetNumberSuffix": "", "addressLine1": "1 Main Road", "addressLine2": "", "addressLine3": "", "regionCode": "NH", "regionText": "Northamptonshire", "fullStreet": "", "poBoxZipcode": "", "poBox": "", "poBoxCity": "", "majorCustZip": "", "city": "NORTHAMPTON", "district": "", "countryCode": "GB", "country": "United Kingdom", "advertisement": "Y", "blockTag": "N", "addressResearchRunning": true, "euSalesTaxNumber": "", "bicMasterNumber": "", "sector": "", "mobilePhoneNumber": "", "phoneNumber": "", "faxNumber": "", "emailAddress": "customer@example.com", "bpExtCommunication": [], "bpAttributes": [], "bpHolidayAddress": [] } Element Definitions Field name Description role C Art des Geschäftspartners AG = Auftraggeber WE = Warenempfänger RE = Rechnungsempfänger bpNumber C Geschäftspartnernummer fullSalutation C Montierte persönliche Briefanrede lastName1 C Nachname 1 lastName2 C Nachname 2 firstName C Vorname fullLastName C Montierter Nachname nameAddition C Namenszusatz jobTitle C Berufs-Bezeichnung title C Akademischer Titel salutationCode C Anrede-Code im AVS/3, For example 01 = Herr 02 = Frau salutation C Anrede company1 C Firma 1. Zeile der Firmenadresse. Falls dieses Feld gefüllt ist, ist der obige Name der Ansprechpartner dieser Firma. company2 C Firma 2. Zeile der Firmenadresse. company3 C Firma 3. Zeile der Firmenadresse. department C Abteilung zipcode C Postleitzahl street C Straße mit Hausnummer und Zusatz zur Hausnummer streetSuffix C Zusatz zur Straße streetName C Straßenname streetNumber C Hausnummer streetNumberSuffix C Hausnummer Zusatz addressLine1 C Adresse Zeile 1 für UK Adressen addressLine2 C Adresse Zeile 2 für UK Adressen addressLine3 C Adresse Zeile 3 für UK Adressen poBoxZipcode C Postleitzahl zum Postfach poBox C Postfach poBoxCity C Ort zum Postfach majorCustZip C Großkundenpostleitzahl city C Ort district C Zusatz zum Ort regionCode C regionText C countryCode C 2-stelliges Länderkennzeichen country C Land advertisement C Werbung erlaubt; Y / N blockTag C Allgemeine Kundesperre ( X = put block-tag ) addressResearchRunning B Addresssuche läuft? true/false euSalesTaxNumber C EU-UST Identnummer dateOfBirth D Geburtsdatum (YYYY-MM-DD) bicMasterNumber C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector C Branche mobilePhoneNumber C Handy-Nr.: Vorwahl + Anschluss phoneNumber C Telefon-Nr.: Vorwahl + Anschluss faxNumber C Fax-Nr.: Vorwahl + Anschluss emailAddress C E-Mail-Adresse bpExtCommunication erweiterte Kommunikationsdaten (nur wenn Request Parameter returnExtendedCommunicationData=true ist) communicationType C Typ; Wertebereich communicationValue C Wert communicationDefault C Default value Y / N bpAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert bpHolidayAddress JSON Attributes Beispiel "bpHolidayAddress": [ { "validFrom": "2009-11-08", "validTo": "9999-12-31", "street": "", "streetNumber": "", "streetNumberSuffix": "", "zipcode": "", "zipcodeExtension": "", "city": "", "district": "", "poBox": "", "poBoxExtension": "", "poBoxZipcode": "", "poBoxCity": "", "majorCustZip": "", "majorCustZipExtension": "", "countryCode": "" }, ... ] Element Definition ParameterTypLängeBeschreibung validFrom C 10 Gültig von YYYY-MM-DD validTo C 10 Gültig bis YYYY-MM-DD street C 35 Straßenname streetNumber C 10 Hausnummer streetNumberSuffix C 8 Ergänzung zur Hausnummer zipcode C 10 Postleitzahl zipcodeExtension C 4 Erweiterung der Postleitzahl city C 35 Ortsname district C 35 Ortsteil poBox C 35 Postfach poBoxExtension C 4 Erweiterung zum Postfach poBoxZipcode C 10 Postleitzahl des Postfachs poBoxCity C 35 Ort zum Postfach majorCustZip C 10 Postleitzahl der Firma majorCustZipExtension C 4 Erweiterung zur Postleitzahl der Firma countryCode C 3 Länderschlüssel orderAttributes JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert 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. OK Weitere Information