Inhaltsverzeichnis Geschäftspartner create Business Partner Attribut delete Business Partner Attribut create extended Business Partner Attribut Get Business Partner mit BP Nummer Get Business Partner mit BP Attribut Get Subscriptions Get Payment Details Get PurchaseOrders Create business partner Change Address GP Beziehung anlegen (Nutzung nur bei entspr. Backendintegration in der ccb Suite) GP Beziehung löschen (Nutzung nur bei entspr. Backendintegration in der ccb Suite) Bouncenachricht anlegen / push bounces Suche mit Adresse Lesen mit anderen Kriterien GP löschen Account Info Invoice Info Change Log Abos anhand der GP Nummer, wo der Geschäftspartner Lizenznehmer ist Addresssuche stoppen / Stopp address research Geschäftspartner Diese Seite beschreibt die Geschäftspartner relevanten rest web services. create Business Partner Attribut URL POST: /rest/{client}/bp/{bpNumber}/attributes?sp={sp}&type={type}&value={value} Parameter Beschreibung client Mandantennummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) bpNumber Geschäftspartner Nummer type Attributtyp value Attributwert Korrespondierender SOAP Service: https://doc.dsb-ccb.net/de/ccbconnect/avs3/obj/bp/createattribute Response Der Response ist ein Json Dokument mit dem result. ElementBeschreibung resultCodeOK oder NOT_OK resultMessageListe von result Messages delete Business Partner Attribut URL DELETE: /rest/{client}/bp/{bpNumber}/attributes?sp={sp}&type={type}&value={value} Parameter Beschreibung client Mandantennummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) bpNumber Geschäftspartner Nummer type Attributtyp value Attributwert Korrespondierender SOAP Service: https://doc.dsb-ccb.net/de/ccbconnect/avs3/obj/bp/deleteattribute Response Der Response ist ein Json Dokument mit dem result. ElementBeschreibung resultCodeOK oder NOT_OK resultMessageListe von result Messages create extended Business Partner Attribut URL POST: /rest/{client}/bp/{bpNumber}/extendedAttributes?sp={sp} Parameter Beschreibung client Mandantennummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) bpNumber Geschäftspartner Nummer writeSoi Write a single optin (default: false) Korrespondierender SOAP Service: https://doc.dsb-ccb.net/de/ccbconnect/avs3/obj/bp/createExtendedAttribute Request Der Request enthält im Body die Daten als Json Dokument. { "customerOrderId" : "ICO_525_43dfa8fbc9ee10eef6465a49d34fdf43_1", "attributeType" : "OIE", "attributeValue" : "J", "source" : "00016251", "doiSource" : "1", "status" : "AB", "techStatus" : "2", "shopid" : "123", "optInEmail" : { "optInRequest" : { "text" : "Ich bin damit einverstanden, dass mich die Zeitschriften GmbH per Telefon und E-Mail über interessante Angebote zu Zeitschriften, digitalen Medien und Gewinnspielen informieren.* Diese Einwilligung kann ich jederzeit ohne Angabe von Gründen, schriftlich oder telefonisch gegenüber der Zeitschriften GmbH, Neckarsulmer Straße 10, 12345 Musterstadt, oder per E-Mail unter widerruf-werbung@muster.de widerrufen. Als Dankeschön erhalten Sie ein Überraschungsgeschenk!", "timestamp" : "2022-06-27T15:15:41Z", "ip" : "127.0.0.1" }, "doiMail" : { "sent" : { "address" : "oliver@example.de", "text" : "some text", "link" : "a link", "timestamp" : "2022-06-27T15:15:41Z" }, "received" : { "address" : "oliver@example.de", "timestamp" : "2022-07-05T11:30:59Z", "status" : "B" } } } } ElementBeschreibung resultCodeOK oder NOT_OK resultMessageListe von result Messages Response Der Response ist ein Json Dokument mit dem result. ElementBeschreibung resultCodeOK oder NOT_OK resultMessageListe von result Messages Get Business Partner mit BP Nummer URL GET: /rest/{client}/bp/{bpNumber} Parameter Beschreibung bpNumber Geschäftspartnernummer client Mandantennummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) getAllAddresses liefere alle, auch die zukünftigen Adressen (default: false) filter kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Korrespondierender SOAP Service: getByBpNumber Response The response is a JSON document containing a business partner. Der Response ist ein JSON Dokument mit einer Geschäftspartnerstruktur. JSON Geschäftspartner Beispiel { "salutationCode": "", "titleCodeAcademic": "", "titleAcademic": "", "titleCodeRoyal": "", "jobTitle": "", "lastName1": "", "lastName2": "", "firstName": "", "nickName": "", "street": "", "streetSuffix": "", "streetNumberSuffix": "", "addressLine1": "", "addressLine2": "", "addressLine3": "", "zipcode": "", "countryCode": "", "city": "", "district": "", "regionCode": "", "regionText": "", "company1": "", "company2": "", "company3": "", "company4": "", "department": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "poBoxCountryCode": "", "majorCustomerZipcode": "", "addressSource": "", "advertisement": "", "category": "", "bpNumber": "", "bpNumberExternal": "", "bpGroup": "", "euSalesTaxNumber": "", "dateOfBirth ": "", "bicMasterNumber ": "", "block ": , "blockReason": "", "advertisementBlock": , "advertisementBlockReason": "", "sector": "", "listOfCommunication": [ { "communicationDefault": "", "communicationValue": "", "communicationType": "" } ], "listOfAttribute": [ { "value": "", "type": "" } ],"otherAddresses": [ { "salutationCode": "", "company1": "", "company2": "", "street": "", "streetNumber": "", "regionCode": "", "regionText": "", "zipcode": "", "city": "", "countryCode": "", "validFrom": "", "validTo": "", "advertisement": true }, ... ] } Element Definition Feld LängeTypBemerkung, Feldversorgung oder Umschlüsselung salutationCode 2 C Anrede titleCodeAcademic 4 C Akademischer Titel titleAcademic 15 C Akademischer Titel im Klartext (z. B. Dr.) titleCodeRoyal 4 C Adels-Titel titleRoyal 15 C Adels-Titel im Klartext jobTitle 35 C Berufsbezeichnung im Klartext lastName1 40 C Nachname1 lastName2 40 C Nachname2 firstName 40 C Vorname(n) nickName 40 C Nickame street 50 C Strasse streetSuffix 40 C Strassen Zusatz streetNumber 10 C Haus-Nummer streetNumberSuffix 10 C Haus-Nummer - Zusatz addressLine1 35 C Adresse Zeile 1 für UK Adressen addressLine2 35 C Adresse Zeile 2 für UK Adressen addressLine3 35 C Adresse Zeile 3 für UK Adressen zipcode 10 C Postleitzahl country-code 3 C Land (KFZ Nationalitätskennzeichen) city 40 C Ort district 25 C Zusatz zum Ort (z. B. Ortsteil, Bezirk, Gebiet, …) regionCode 3 C Regions-Code (Bundesstaat, Bundesland, Provinz, Grafschaft) regionText 25 C Region als Klartext (z.B. Bundesland, County…) company1 35 C Firma Zeile 1 company2 35 C Firma Zeile 2 company3 40 C Firma Zeile 3 company4 40 C Firma Zeile 4 department 30 C Abteilung poBox 10 C Postfach poBoxZipcode 10 C Postfach-PLZ poBoxCity 40 C Ort zum Postfach poBoxCountryCode 3 C Land zum Postfach majorCustomerZipcode10 C Großkunden-PLZ addressSource 10 C Adressquelle Codetabelle, Inhalt legt Fachbereich fest advertisement 1 C Kennzeichen, ob Werbung zugesendet werden soll. category 2 C Adressart bpNumber 10 C Optional, bei Bestandskunde Kundennummer bpNumberExternal 20 C Geschäftspartner-Nr. eines externen Systems bpGroup 4 C Kundengruppe Codetabelle, Inhalt legt Fachbereich fest block 4 B GP Sperre true/false blockReason C GP Sperrgrund advertisementblock 4 B GP Werbesperre true/false advertisementBlockReason 2 C GP Sperrgrund euSalesTaxNumber 14 C EG-UST Identnummer dateOfBirth 10 D Geburtstag Format: JJJJ-MM-TT masterNumber 10 C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector 10 C Branche listOfcommunication - communicationtype 2 C Kommunikationsart (Wertebereich) - communcationvalue 50 C Wert der Kommunikationsart listOfAttribute - type 6 C Funktion des Geschäftspartner Merkmals z. B. Adressart - value 50 C Wert des Geschäftspartner Merkmals otherAddresses - bpNumber 10 C Optional, bei Bestandskunde Kundennummer - lastName1 40 C Nachname1 - lastName2 40 C Nachname2 - firstName 40 C Vorname(n) - nickName 40 C Nickame - titleCodeAcademic 4 C Akademischer Titel - titleAcademic 15 C Akademischer Titel im Klartext (z. B. Dr.) - titleCodeRoyal 4 C Adels-Titel - titleRoyal 15 C Adels-Titel im Klartext - jobTitle 35 C Berufsbezeichnung im Klartext - salutationCode 2 C Anred - company1 35 C Firma Zeile 1 - company2 35 C Firma Zeile 2 - company3 40 C Firma Zeile 3 - company4 40 C Firma Zeile 4 - department 30 C Abteilung - street 50 C Strasse - streetSuffix 40 C Strassen Zusatz - streetNumber 10 C Haus-Nummer - streetNumberSuffix 10 C Haus-Nummer - Zusatz - addressLine1 35 C Adresse Zeile 1 für UK Adressen - addressLine2 35 C Adresse Zeile 2 für UK Adressen - addressLine3 35 C Adresse Zeile 3 für UK Adressen - zipcode 10 C Postleitzahl - country-code 3 C Land (KFZ Nationalitätskennzeichen) - city 40 C Ort - district 25 C Zusatz zum Ort (z. B. Ortsteil, Bezirk, Gebiet, …) - regionCode 3 C Regions-Code (Bundesstaat, Bundesland, Provinz, Grafschaft) - regionText 25 C Region als Klartext (z.B. Bundesland, County…) - poBox 10 C Postfach - poBoxZipcode 10 C Postfach-PLZ - poBoxCity 40 C Ort zum Postfach - poBoxCountryCode 3 C Land zum Postfach - majorCustomerZipcode10 C Großkunden-PLZ - countryCode 3 C Land (KFZ Nationalitätskennzeichen) - validFrom 10D gültig von - validTo 10D gültig bis - addressSource 10 C Adressquelle Codetabelle, Inhalt legt Fachbereich fest - advertisement B Kennzeichen, ob Werbung zugesendet werden soll. - category 2 C Adressart - bpNumberExternal 20 C Geschäftspartner-Nr. eines externen Systems - bpGroup 4 C Kundengruppe Codetabelle, Inhalt legt Fachbereich fest Get Business Partner mit BP Attribut URL GET: /rest/{client}/bp/attributes Parameter Beschreibung client Mandantennummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) type Attributtyp value Attributwert getAllAddresses liefere alle, auch die zukünftigen Adressen (default: false) 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 Korrespondierender SOAP Service: getByBpAttribute Response The response is a JSON document containing a business partner. Der Response ist ein JSON Dokument mit einer Geschäftspartnerstruktur. JSON Geschäftspartner Beispiel { "salutationCode": "", "titleCodeAcademic": "", "titleAcademic": "", "titleCodeRoyal": "", "jobTitle": "", "lastName1": "", "lastName2": "", "firstName": "", "nickName": "", "street": "", "streetSuffix": "", "streetNumberSuffix": "", "addressLine1": "", "addressLine2": "", "addressLine3": "", "zipcode": "", "countryCode": "", "city": "", "district": "", "regionCode": "", "regionText": "", "company1": "", "company2": "", "company3": "", "company4": "", "department": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "poBoxCountryCode": "", "majorCustomerZipcode": "", "addressSource": "", "advertisement": "", "category": "", "bpNumber": "", "bpNumberExternal": "", "bpGroup": "", "euSalesTaxNumber": "", "dateOfBirth ": "", "bicMasterNumber ": "", "block ": , "blockReason": "", "advertisementBlock": , "advertisementBlockReason": "", "sector": "", "listOfCommunication": [ { "communicationDefault": "", "communicationValue": "", "communicationType": "" } ], "listOfAttribute": [ { "value": "", "type": "" } ],"otherAddresses": [ { "salutationCode": "", "company1": "", "company2": "", "street": "", "streetNumber": "", "regionCode": "", "regionText": "", "zipcode": "", "city": "", "countryCode": "", "validFrom": "", "validTo": "", "advertisement": true }, ... ] } Element Definition Feld LängeTypBemerkung, Feldversorgung oder Umschlüsselung salutationCode 2 C Anrede titleCodeAcademic 4 C Akademischer Titel titleAcademic 15 C Akademischer Titel im Klartext (z. B. Dr.) titleCodeRoyal 4 C Adels-Titel titleRoyal 15 C Adels-Titel im Klartext jobTitle 35 C Berufsbezeichnung im Klartext lastName1 40 C Nachname1 lastName2 40 C Nachname2 firstName 40 C Vorname(n) nickName 40 C Nickame street 50 C Strasse streetSuffix 40 C Strassen Zusatz streetNumber 10 C Haus-Nummer streetNumberSuffix 10 C Haus-Nummer - Zusatz addressLine1 35 C Adresse Zeile 1 für UK Adressen addressLine2 35 C Adresse Zeile 2 für UK Adressen addressLine3 35 C Adresse Zeile 3 für UK Adressen zipcode 10 C Postleitzahl country-code 3 C Land (KFZ Nationalitätskennzeichen) city 40 C Ort district 25 C Zusatz zum Ort (z. B. Ortsteil, Bezirk, Gebiet, …) regionCode 3 C Regions-Code (Bundesstaat, Bundesland, Provinz, Grafschaft) regionText 25 C Region als Klartext (z.B. Bundesland, County…) company1 35 C Firma Zeile 1 company2 35 C Firma Zeile 2 company3 40 C Firma Zeile 3 company4 40 C Firma Zeile 4 department 30 C Abteilung poBox 10 C Postfach poBoxZipcode 10 C Postfach-PLZ poBoxCity 40 C Ort zum Postfach poBoxCountryCode 3 C Land zum Postfach majorCustomerZipcode10 C Großkunden-PLZ addressSource 10 C Adressquelle Codetabelle, Inhalt legt Fachbereich fest advertisement 1 C Kennzeichen, ob Werbung zugesendet werden soll. category 2 C Adressart bpNumber 10 C Optional, bei Bestandskunde Kundennummer bpNumberExternal 20 C Geschäftspartner-Nr. eines externen Systems bpGroup 4 C Kundengruppe Codetabelle, Inhalt legt Fachbereich fest block 4 B GP Sperre true/false blockReason C GP Sperrgrund advertisementblock 4 B GP Werbesperre true/false advertisementBlockReason 2 C GP Sperrgrund euSalesTaxNumber 14 C EG-UST Identnummer dateOfBirth 10 D Geburtstag Format: JJJJ-MM-TT masterNumber 10 C Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector 10 C Branche listOfcommunication - communicationtype 2 C Kommunikationsart (Wertebereich) - communcationvalue 50 C Wert der Kommunikationsart listOfAttribute - type 6 C Funktion des Geschäftspartner Merkmals z. B. Adressart - value 50 C Wert des Geschäftspartner Merkmals otherAddresses - bpNumber 10 C Optional, bei Bestandskunde Kundennummer - lastName1 40 C Nachname1 - lastName2 40 C Nachname2 - firstName 40 C Vorname(n) - nickName 40 C Nickame - titleCodeAcademic 4 C Akademischer Titel - titleAcademic 15 C Akademischer Titel im Klartext (z. B. Dr.) - titleCodeRoyal 4 C Adels-Titel - titleRoyal 15 C Adels-Titel im Klartext - jobTitle 35 C Berufsbezeichnung im Klartext - salutationCode 2 C Anred - company1 35 C Firma Zeile 1 - company2 35 C Firma Zeile 2 - company3 40 C Firma Zeile 3 - company4 40 C Firma Zeile 4 - department 30 C Abteilung - street 50 C Strasse - streetSuffix 40 C Strassen Zusatz - streetNumber 10 C Haus-Nummer - streetNumberSuffix 10 C Haus-Nummer - Zusatz - addressLine1 35 C Adresse Zeile 1 für UK Adressen - addressLine2 35 C Adresse Zeile 2 für UK Adressen - addressLine3 35 C Adresse Zeile 3 für UK Adressen - zipcode 10 C Postleitzahl - country-code 3 C Land (KFZ Nationalitätskennzeichen) - city 40 C Ort - district 25 C Zusatz zum Ort (z. B. Ortsteil, Bezirk, Gebiet, …) - regionCode 3 C Regions-Code (Bundesstaat, Bundesland, Provinz, Grafschaft) - regionText 25 C Region als Klartext (z.B. Bundesland, County…) - poBox 10 C Postfach - poBoxZipcode 10 C Postfach-PLZ - poBoxCity 40 C Ort zum Postfach - poBoxCountryCode 3 C Land zum Postfach - majorCustomerZipcode10 C Großkunden-PLZ - countryCode 3 C Land (KFZ Nationalitätskennzeichen) - validFrom 10D gültig von - validTo 10D gültig bis - addressSource 10 C Adressquelle Codetabelle, Inhalt legt Fachbereich fest - advertisement B Kennzeichen, ob Werbung zugesendet werden soll. - category 2 C Adressart - bpNumberExternal 20 C Geschäftspartner-Nr. eines externen Systems - bpGroup 4 C Kundengruppe Codetabelle, Inhalt legt Fachbereich fest Get Subscriptions Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getByBpNumber-3.0.0 Korrespondierender SOAP Service: SubscriptionOrder::getByBpNumber. URL GET: /rest/{client}/bp/{bpNumber}/subscriptions ParameterBeschreibung bpNumber Geschäftspartner Nummer returnOnlyActive Aktive Abos zurückliefern (default) oder alle fromHit Index des Abos, ab dem beim paketweisen Lesen gelesen werden soll. maxHitCount maximale Anzahl Abos, die gelesen werden sollen (default 200; max. 200) 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 Da ein Geschäftspartner sehr viele Abos haben kann (mehrere tausend), kann dieser Request sehr lange dauern. Daher wird empfohlen, die Anzahl der Abos im Response zu begrenzen und bei Bedarf paketweise nachzulesen. Bsp. Request: /rest/{client}/bp/{bpNumber}/subscriptions?maxHitCount=100 Wenn im Response 100 Abos enthalten sind, könnte es auch noch mehr geben, dann folgt ein weiterer Request /rest/{client}/bp/{bpNumber}/subscriptions?fromHit=101&maxHitCount=100 usw. bis ein Response keine 100 Abos enthält. Response Der Response beinhaltet ein JSON Dokument mit einem Array aus subscriptions 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 Payment Details Path mapping(intern): /net/dsb/avs3/PaymentDetails/getByBpNumber-1.0.0 Corresponing SOAP Service: PaymentDetails::getByBpNumber. URL GET: /rest/{client}/bp/{bpNumber}/payment-details Parameter Beschreibung bpNumber Geschäftspartner Nummer client Mandant sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) Response Der Reponse ist ein JSON Dokument mit payment Details { "account" : { "listOfDebitAccount" : [ { "debitAccountId" : "0001", "debitBankName" : "Pkundenbank", "debitBankCode" : "00010010", "debitCountryCode" : "DE", "debitAccountNumber" : "11111111", "debitAccountHolder" : "Testet", "debitContinuous" : true, "iban" : "DE00000000000000000000", "bic" : "xxxxxxxxXXX" } ] }, "bpNumber" : "0000520000" } Get PurchaseOrders Dieser Service liefert bei einem VHS-Mandanten die VHS Aufträge des Geschäftspartners. Bei einem AVS Mandanten werden die Product Sales Aufträge des Geschäftspartners geliefert. Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getPurchaseOrders-1.0.0 Korrespondierender SOAP Service: getPurchaseOrders. URL GET: /rest/{client}/bp/{bpNumber}/purchase-orders Parameter Beschreibung bpNumber Geschäftspartner Nummer client Mandant sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) only-delivery Liefert auch Aufträge zurück, wo der Geschäftspartner die Rolle WE „Warenempfänger“ hat. Default value ist “false”. date-from Schränkt das Ergebnis ein, dass nur Purchase Orders ab dem angegebenen Datum geliefert werden. Format YYYY-MM-DD date-to Schränkt das Ergebnis ein, dass nur Purchase Orders vor dem angegebenen Datum geliefert werden. Format YYYY-MM-DD 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 Response Der Response besteht aus einer JSON Struktur mit einem Array. In diesem sind nur die einige Schlüsselfelder zu den Aufträgen des Geschäftspartners enthalten. Mit der Auftragsnummer kann der Service get by order number aufgerufen werden, um Auftragsdetails zu erhalten. JSON Purchase Order Extract Example { "client": "5244", "serviceProvider": "032", "purchaseOrderNumber": "3000261", "purchaseOrderId": "0000000253", "dateOfPurchaseOrder": "2017-09-26", "dateOfPurchaseOrderSystem": "2017-10-04", "purchaseOrderState": "L1", "roleType": "AG" } Feldbeschreibung Feldname Typ Beschreibung client C VHS Mandant (Vertriebsschiene) serviceProvider C VHS Dienstleisterkennung purchaseOrderNumber N Auftragsnummer (VHS/3) purchaseOrderId AN Bestellidentifikation bzw. externe Auftragsnummer dateOfPurchaseOrder D Auftragsdatum (Mandant) dateOfPurchaseOrderSystem D Auftragsdatum (System) purchaseOrderState C Auftragsstatus roleType C Rolle, die der GP im Auftrag hat; AG(Auftraggeber) oder WE(Warenempfänger) Create business partner Erstellt einen Geschäftspartner. Dieser Service ist gepuffert, d.h. die Aufträge werden in einer Datenbank zwischengespeichert. Damit die Aufträge ins Backend(ccb-suite) gelangen, muss hierfür ein zusätzlicher Transferjob eingerichtet werden. Bitte bestellen Sie diesen Job bei dem zuständigen Kundenberater. GP Direkteinspielung mit internem Stapelhandling: Wird hier als Query-Parameter mode=direct und die zusätzlichen Pflichtfelder sp, so, inputOffice und inputUser angegeben, so wird eine GP Direktanlage getriggert, die ein internes Stapelhandling nutzt. Die Pflichtparameter dienen zum Erstellen eines Identifiers (Format: {inputOffice}-{inputUser}-{client}-{sp}-{so} Bsp.: 0001-TEST_WW-286-DSB-0200), der für das korrekte Stapelhandling zuständig ist und sich in der SAP GPA unter „Eigene Notizen“ wiederfindet. Hierbei wird bei erfolgreicher Verbuchung sofort eine GP-Nummer zurückgegeben. Im Falle eines Verbuchungsproblems kann anhand des zurückgelieferten Stapelnamens und der Nr. Im Stapel der zugrundeliegende Fehler in der GPA behoben werden. URL POST: /rest/{client}/bp für die gepufferte GP Anlage POST: /rest/{client}/bp?sp={sp}&so={so}&mode=direct&inputOffice={inputOffice}&inputUser={inputUser} direkte GP Anlage ohne Pufferung der Daten 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.)) duplicateCheck true/false. Soll Dublettenprüfung erfolgen? mode direct / buffered (default) inputOffice Erfassungsbüro (nur bei direkter Einspielung, dann mandatory) inputUser Erfassungsuser (nur bei direkter Einspielung, dann mandatory) stackname Stapelname (nur bei direkter Einspielung) Wenn kein Stapelname angegeben wird, dann wird der zuletzt verwendete Stapel genommen. stackDescription Stapelbeschreibung (nur bei direkter Einspielung) Request Body Der Body des Post Requests beinhaltet ein JSON Dokument mit einem Geschäftspartner. JSON Business Partner Beispiel { "salutationCode" : "01", "lastName1" : "Y", "firstName" : "X", "addressLine1" : "Blitz Media Ltd, Unit 1, Torfaen Bu", "zipcode" : "N1C 4AP", "countryCode" : "GB", "city" : "LONDON", "netInvoice" : "1", "bpCommunicationsList" : [ { "communicationType" : "T", "communicationValue" : "123" } ], "bpAttributesList" : [], "avsAttributes" : { "salesOrganization" : "0100", "distributionChannel" : "01", "division" : "01" } } Element Definition Parameter Name TypLängeBeschreibung bpNumber C 10 Optional, bei Bestandskunde Kundennummer lastName1 C 35 Nachname1 - Falls eine Firmenadresse übergeben wird, ist dies der Ansprechpartner lastName2 C 35 Nachname2 - Falls eine Firmenadresse übergeben wird, ist dies der Ansprechpartner firstName C 35 Vorname(n) - Falls eine Firmenadresse übergeben wird, ist dies der Ansprechpartner nickName C35 Rufname(n) Falls eine Firmenadresse übergeben wird, ist dies der Ansprechpartner jobTitle C 35 Berufs-Bezeichnung für Druck - Nur für UK relevant salutationCode C 2 Anrede - 01 = Herr 02 = Frau 99 = unbekannt weitere Codes sind in einer Codetabelle hinterlegt, bei Bedarf bitte anfragen. Falls eine Firmenadresse übergeben wird, so handelt es sich hierbei um die Anrede des Ansprechpartners (falls vorhanden). prefix C 4 Vorsatzwort zum Namen (Schlüssel) Die entsprechenden Schlüssel sind von der Kundenbetreuung zu erfragen. titleCodeAcademic C 4 Codewert für den akademischen Titel - z.B. 0027 = Dr. Die Codes sind in einer Codetabelle hinterlegt. Diese können Sie von Ihrem Kundenbetreuer erhalten. titleAcademic C 15Akademischer Titel im Klartext (z. B. Dr.) titleCodeRoyal C 4Codewert für den Adelstitel - Die Codes sind in einer Codetabelle hinterlegt. Diese können Sie von Ihrem Kundenbetreuer erhalten. titleRoyal C 15Adels-Titel im Klartext company1 C 40Firma Zeile 1 wenn gefüllt, dann ist obiger Eintrag die Kontaktperson der Firma company2 C 40Firma Zeile 2 company3 C 40 Firma Zeile 3 company4 C 40 Firma Zeile 4 department C 30 Abteilung zipcode C 10 Postleitzahl - Pflicht, falls eine Straßenadresse übergeben werden soll. street C 50Strasse - Pflicht, falls eine Straßenadresse übergeben werden soll. Feld darf nicht gesetzt sein, wenn eines der Felder address-line-1, address-line-2 oder address-line-3 gefüllt ist. streetSuffix C 40 Strassen Zusatz - Feld darf nicht gesetzt sein, wenn eines der Felder address-line-1, address-line-2 oder address-line-3 gefüllt ist. streetNumber C 10 Haus-Nummer - Pflicht, falls eine Straßenadresse übergeben werden soll. Feld darf nicht gesetzt sein, wenn eines der Felder address-line-1, address-line-2 oder address-line-3 gefüllt ist. streetNumberSuffix C 10 Haus-Nummer Zusatz - Feld darf nicht gesetzt sein, wenn eines der Felder address-line-1, address-line-2 oder address-line-3 gefüllt ist. addressLine1 C 35Adresse Zeile 1 für UK Adressen addressLine2 C 35Adresse Zeile 2 für UK Adressen addressLine3 C 35Adresse Zeile 3 für UK Adressen poBoxZipcode C 10Postfach-PLZ - Pflicht, falls eine Postfachadresse übergeben werden soll poBox C 10 Postfach - Pflicht, falls eine Postfachadresse übergeben werden soll poBoxCity C 40 Ort zum Postfach - Pflicht, falls eine Postfachadresse übergeben werden soll poBoxCountryCode C 2 Land zum Postfach Pflicht, falls eine Postfachadresse übergeben werden soll majorCustomerZipcodeC 10Großkunden-PLZ city C 40 Ort - Pflicht, falls eine Straßenadresse übergeben werden soll. district C 40 Zusatz zum Ort (z. B. Ortsteil, Bezirk, Gebiet, …) regionCode C 3 region-code Codetabelle, Inhalt legt Fachbereich fest regionText C 25 Region als Klartext (z.B. Bundesland, County…) countryCode C 2 Two letter ISO 3166-1 alpha-2 country-code advertisement C 1 Kennzeichen, ob Werbung zugesendet werden soll. 'N' → Keine Werbung zusenden 'Y' → Werbung zusenden block B General block-tag blockReason C 2 Sperrgrund euSalesTaxNumber C 14EG-UST Identnummer dateOfBirth D Geburtstag Format: JJJJ-MM-TT addressSource C 10 Herkunft der Adresse masterNumber C 10Partner-ID des Masters (z.B. Firma des Ansprechpartners) sector C 10 Branche netInvoiceC 1 Nettofaktur bpCommunicationsList communicationType C 2Kommunikations Typen Values communicationValue C 50 Kommunikations Wert communicationDefault C 1Default Wert Y / N avsAttributes salesOrganizationC 4 Verkaufsorganisation (mandatory) distributionChannelC 2 Vertriebsweg (mandatory) divisionC 2 Sparte (mandatory) bpAttributesList JSON Attributes Beispiel { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definition ParameterTypLängeBeschreibung typeC6Attributs Typ valueC50Attributs Wert Response Body Der Response liefert beim gepufferten Service die ID der Transaktion zurück: 0726B744-1262-F8EF-1B99-6632FECBE06F Der direkte Service liefert ein JSON: { "stackName": "02968IMMRFC230821", "numberInStack": 11, "bpNumber": "1007719922", "messages": [ { "msgType": "S", "msgNo": "217", "msgV2": "", "msgText": "", "msgId": "R1", "msgV1": "", "msgV4": "", "msgV3": "" } ], "error": "" } Feld Beschreibung stackName Stapelname in der GPA numberInStack Position im Stapel bpNumber Geschäftspartnernummer. Beim createBp Service ist dies bei einer erfolgreichen Anlage die Nummer des neuen Geschäftspartners. Beim changeBpAddress Service ist dieses Feld irrelavant. messages Meldungen aus AVS messages.msgType Typ der Meldung: S = Success, I = Info, W = Warning, E = Error, A = Abortion error Trat ein Fehler auf? Korrespondierender SOAP Service: createBpBuffered oder createBp. Change Address Anlage einer gepufferten Adressänderung. Damit die Adressänderung ins Backend eingespielt wird, muss ein separater Job eingerichtet werden. Beauftragen Sie diesen bei Ihrem Kundenberater. Direkte Adressänderung mit internem Stapelhandling Wird hier als Query-Parameter mode=direct und die zusätzlichen Pflichtfelder sp, so, inputOffice und inputUser angegeben, so wird die Adressänderung direkt ausgeführt. Dabei wird ein internes Stapelhandling nutzt. Die Pflichtparameter dienen zum Erstellen eines Identifiers (Format: {inputOffice}-{inputUser}-{client}-{sp}-{so} Bsp.: 0001-TEST_WW-286-DSB-0200), der für das korrekte Stapelhandling zuständig ist. Im Falle eines Verbuchungsproblems kann anhand des zurückgelieferten Stapelnamens und der Nr. Im Stapel der zugrundeliegende Fehler in der GPA behoben werden. Path mapping(intern): /net/dsb/avs3/Bp/changeBpAddressBuffered-2.0.0 Korrespondierender SOAP Service: changeBpAddressBuffered oder changeBpAddress. URL POST: /rest/{clientId}/bp/{bp-number}/address für die gepufferte GP Anlage POST: /rest/{clientId}/bp/{bp-number}/address?sp={sp}&so={so}&mode=direct&inputOffice={inputOffice}&inputUser={inputUser} direkte Adressänderung mit integriertem Stapelhandling Parameter Beschreibung bp-number Geschäftspartner Nummer clientId Mandant sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) validFrom Datum einer zukünftigen Adressänderung im ISO Datumsformat (YYYY-MM-DD). Ohne dieses Datum gilt die Änderung ab sofort. (Nur im Test) Request Body Der Body des POST Requests besteht aus einer JSON Struktur mit den geänderten Adressfeldern. Bei zukünftigen Adressänderungen müssen immer alle Adressfelder mitgegeben werden, also auch die, die sich nicht ändern. JSON Business Partner Change Example Neue oder geänderte Adressfelder: { "lastName1": "Customer", "firstName": "Anne", "salutationCode": "02", "zipcode": "NN4 7BF", "addressLine1": "1 Main Road", "regionCode": "NH", "regionText": "Northamptonshire", "city": "NORTHAMPTON", "countryCode": "GB" } Löschen eines Adressfeldes: { "poBox": {"action": "DELETE"} } Um eine Kommunikationsadresse zu ändern, muss der zu ändernde Wert angegeben werden, da mehrere Kommunikationsadressen des gleichen Typs existieren können. Ändere Telefonnummer: { "bpCommunicationsList": [ { "communicationType" : { "value" : "T", "action" : "UPDATE" }, "communicationValue" : { "value" : "123", "oldValue" : "456", // the old value you want to update "action" : "UPDATE" } } ] } Neue Telefonnummer ergänzen: { "bpCommunicationsList": [ { "communicationType" : "T", "communicationValue" : "123" } ] } Telefonnummer löschen: { "bpCommunicationsList": [ { "communicationType" : { "value" : "T", "action" : "DELETE" }, "communicationValue" : { "value" : "123", // the old value you want to delete "action" : "DELETE" } } ] } Response Body Der Response liefert beim gepufferten Service die ID der Transaktion zurück: 0726B744-1262-F8EF-1B99-6632FECBE06F Der direkte Service liefert ein JSON: { "stackName": "02968IMMRFC230821", "numberInStack": 11, "bpNumber": "1007719922", "messages": [ { "msgType": "S", "msgNo": "217", "msgV2": "", "msgText": "", "msgId": "R1", "msgV1": "", "msgV4": "", "msgV3": "" } ], "error": "" } Feld Beschreibung stackName Stapelname in der GPA numberInStack Position im Stapel bpNumber Geschäftspartnernummer. Beim createBp Service ist dies bei einer erfolgreichen Anlage die Nummer des neuen Geschäftspartners. Beim changeBpAddress Service ist dieses Feld irrelavant. messages Meldungen aus AVS messages.msgType Typ der Meldung: S = Success, I = Info, W = Warning, E = Error, A = Abortion error Trat ein Fehler auf? GP Beziehung anlegen (Nutzung nur bei entspr. Backendintegration in der ccb Suite) Der Service legt eine Beziehung zwischen zwei GPs über ccb connect in der ccb suite an. Path mapping(intern): /net/dsb/avs3/Bp/createRelation-1.0.0 Beziehungstyp Bezeichnung BUR006 Dublette (ungerichtete Beziehung) BUR013 auszutrocknende Dublette + wird ersetzt durch (gerichtete Beziehung) ZJ0001 Haushalt (ungerichtete Beziehung) ZJ0002 nicht identisch (ungerichtete Beziehung) URL POST/rest/{client}/bp/{bpNumber1}/relations/{bpNumber2}?sp={sp}&so={so}… ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer bpNumber1 C/10Geschäftspartner Nummer 1 mandatory bpNumber2 C/10Geschäftspartner Nummer 2 mandatory sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) bpRelationType C/10Geschäftspartner-Beziehungstyp (siehe oben) mandatory checkWbzClusterBDer Parameter prüft ob die beiden GPs der Relation den gleichen Adresscluster haben. Sind sie unterschiedlich gibt es folgende Fehlermeldung: „Unterschiedliche Adresscluster. Keine Anlage möglich.“ (true/false = default) optional Response Der Response ist eine JSON Struktur ElementBeschreibung messageZus. Meldung successtrue/false GP Beziehung löschen (Nutzung nur bei entspr. Backendintegration in der ccb Suite) Der Service löscht eine Beziehung zwischen zwei GPs über ccb connect in der ccb suite. Path mapping(intern): /net/dsb/avs3/Bp/deleteRelation-1.0.0 URL DELETE: /rest/{client}/bp/{bpNumber1}/relations/{bpNumber2}?sp={sp}&so={so}… ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer bpNumber1 C/10Geschäftspartner Nummer 1 mandatory bpNumber2 C/10Geschäftspartner Nummer 2 mandatory sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) bpRelationType C/10Geschäftspartner-Beziehungstyp (siehe oben) mandatory Response Der Response ist eine JSON Struktur ElementBeschreibung messageZus. Meldung successtrue/false Bouncenachricht anlegen / push bounces (Nutzung nur bei entspr. Backendintegration in der ccb Suite) Der Service legt eine Bouncenachricht über ccb connect in der ccb suite an. Path mapping(intern): /net/dsb/commons/Email/pushBounces-1.0.0 URL POST: /rest/{client}/bp/{bpNumber}/bounces?sp={sp}&so={so} ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer mandatory bpNumber C/10Geschäftspartner Nummer 1 mandatory sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so C/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) Request body ElementTyp/LängeBeschreibung bPoolObjNrAN/16Brief-Pool-Objekt-Nummer mandatory smtpRcN/3Returncode vom STMP Server (z.B. 550) mandatory smtpMsgAN/132Textmeldung (z.B. „550 Requested action not taken: mailbox unavailable“) mandatory smtpAddrAN/241Empfängeradresse mandatory smtpSubjectAN/255Titel der E-Mail mandatory { "bPoolObjNr“: "“, "smtpRc": "", "smtpMsg": "", "smtpAddr": "", "smtpSubsject": "", } Response Der Response ist eine JSON Struktur ElementBeschreibung messageZus. Meldung successtrue/false Suche mit Adresse Suche nach geschäftspartner mit Adressfelderm. Path mapping(intern): /net/dsb/avs3/BpSearch/searchByAddress-2.0.0 URL POST: /rest/{client}/bpsearch?sp={sp}&so={so} ParameterType/LengthDescription client C/3Client ID sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) maxHits N max. Anzahl der Suchergebnisse ( default: 20 ) fallbackSearch BWenn das Element nicht angegeben wird ist es gleichbedeutend mit Element leer oder bestückt mit N(beim REST Service mit false). Dies ist der Standard-Fall und es wird dadurch keine erweiterte(2-stufige) Suche ausgeführt. Wird explizit ein Y(beim REST Service mit true) angegeben hat es zur Folge, dass intern eine erweiterte Suche mit z.B. Wildcards gemacht wird und es daher zu einer erweiterten Ergebnismenge kommen kann. Diese Sucherweiterung wird nur ausgeführt, wenn über die 1. Suchstufe kein Ergebnis ermittelt werden konnte. Kommt durch die 2-stufige Suche ein „unsauberes“ Ergebnis zurück, sollte client-seitig in der Ergebnis Selection direkt auf das entsprechende Kriterium gefiltert werden. (default: false) searchContact BSollen auch Ansprechpartner gesucht werden. Default ist „false“. Achtung: Dieser Parameter wird derzeit im AVS/3 nicht unterstützt und ist für zukünftige Erweiterungen gedacht. filter C kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Request body { "company": "My Comp.", "firstName": "Andy", "lastName": "Smith", "zipcode": "22334", "city": "London", "street": "High Cross Lane", "countryCode": "GB", "bpCommunicationsList": [ { "communicationValue": "andy@hotmail.com", "communicationType": "WW" } ] } Response The response is a JSON structure. [ { "client": "651", "bpNumber": "1055346513", "salutationCode": "01", "firstName": "Andy", "lastName": "Smith", "zipcode": "22334", "city": "London", "street": "High Cross Lane", "streetSuffix": "High Cross Lane", "streetNumberSuffix": "B", "countryCode": "GB", "bpCommunicationsList": [ { "communicationValue": "andy@hotmail.com", "communicationType": "WW", "communicationDefault": true }, { "communicationValue": "+447917000000", "communicationType": "T" } ], "validFrom": "0001-01-01", "validTo": "2011-06-05" } ] Korrespondierender SOAP Service: searchByAddress Lesen mit anderen Kriterien Geschäftspartner können auch mit anderen Kriterien gelesen werden. Path mapping(intern): /net/dsb/avs3/Bp/search-1.0.0 SAP REST: /GET_GP_BY_EMAIL oder /SEARCH_RFZAS oder /GET_GP_BY_PHONENUMBER URL GET: /rest/{client}/bp?sp={sp}&so={so}&email={address} Parameter Type/Length Description allgemein client C/3 Client ID sp C/3 service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so N/4 sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann) filter C kommaseparierte Liste von Filtern, die im Backend berücksichtigt werden Kriterium: Es muss genau ein Kriterium angegeben werden. email C Email-Adresse phoneNumber C Telefonnummer invoiceNumber C Rechnungsnummer. Es wird zunächst im AVS Mandanten nach dieser Rechnungsnummer gesucht und falls dort nichts gefunden wird in den zugehörigen VHS Mandanten. Response The response is a JSON structure. { "listOfBps": [ "4012543721" ] } GP löschen Der Service bietet über ccb-connect dieselbe Möglichkeit der GP Löschung wie über die Dialogsteuerung in der ccb suite. Path mapping(intern): /net/dsb/avs3/Bp/deleteBp-1.0.0 URL POST: /rest/{client}/bp/{bpNumber}?sp={sp}&dryRun=true… ParameterTyp/LängeBeschreibung client C/3Mandanten Nummer bpNumber C/10Geschäftspartner Nummer (mandatory) sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) dryRun Btrue = Testlauf false oder nicht angegeben = Echtlauf (default) Response Beispiel Respons Body JSON: { "wasCurrentlyDeleted": false, "wasPreviouslyDeleted": false, "messages": [ "I: 1000501553 ...", "I: 1000501553 Alter Wert:Keine Dialoglöschung", "E: 0537774705 Regel dsb_allg_02: Vertragskonto hat mind. einen offenen OP Beleg. ...", "E: 1000501553 hat offene Aufträge" ] } ElementBeschreibung wasCurrentlyDeletedFlag, ob der GP nach dem Aufruf des Webservices gelöscht ist. wasPreviouslyDeletedFlag, ob der GP bereits vor dem Aufruf des Webservices gelöscht war. messagesBestehend aus Char-Kürzel („I„ oder „E“) ob Meldung „gut oder schlecht„ ist (im Screenshot grün oder rot). Meldungstext HTTP Response StateDescription 404 GP nicht vorhanden Account Info Der Service bietet liefert die Account Info zu einem Geschäftspartner Path mapping(intern): /net/dsb/avs3/Bp/getAccountInfo-1.0.0 URL GET: /rest/{clientId}/bp/{bpNumber}/accountinfo?sp={sp} ParameterTyp/LängeBeschreibung clientIdC/3Mandanten Nummer bpNumber C/10Geschäftspartner Nummer (mandatory) sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) Response Beispiel Respons Body JSON: [ { "documentNumber": "122000004493", "repetitionPosition": 0, "itemNumber": 1, "subItemForPartialClearing": 0, "companyCode": "0200", "businessPartner": "1022053388", "contractReferenceDetails": "00000000004610174569", "contractAccount": "100001111085", "mainTransaction": "0070", "subTransaction": "0010", "taxCode": "A0", "taxCodeDescription": "Geen belastingoperatie", "documentDate": "2023-11-02", "postingDate": "2023-11-06", "postingDescription": "*Bankspesen", "currencyCode": "EUR", "dueDate": "2023-11-02", "amountInLocalCurrency": 3.49, "amountInTransactionCurrency": 3.49, "clearingAmount": 0.00, "dunningLevel": 0, "highestDunningLevel": 0, "documentType": "RL", "taxAmountInLocalCurrency": 0.00, "taxAmountInTransactionCurrency": 0.00, "addressNumber": "0002969132", "invoiceRecipient": "1022053388", "orderNumber": "4610174569", "orderItemNumber": 3, "originalOrderItem": 0, "cycleNumber": 0, "externalItemNumber": 10, "printedDocument": "00003081", "exchangeRate": 0.00000 } ] ElementBeschreibung documentNumber Belegnummer repetitionPosition Wiederholungsposition itemNumber Positionsnummer subItemForPartialClearing Teilposition zu einem Teilausgleich im Beleg companyCode Buchungskreis businessPartner Geschäftspartner contractReferenceDetails Referenzangaben aus dem Vertrag contractAccount Vertragskonto mainTransaction Hauptvorgang subTransaction Teilvorgang taxCode Steuerkennzeichen taxCodeDescription Beschreibung Steuerkennzeichen documentDate Belegdatum postingDate Buchungsdatum postingDescription Text currencyCode Währungskennzeichen dueDate Fälligkeit amountInLocalCurrency Betrag in Hauswährung amountInTransactionCurrency Betrag in Transaktionswährung clearingAmount Ausgleichsbetrag dunningLevel Mahnstufe highestDunningLevel höchste Mahnstufe documentType Belegart taxAmountInLocalCurrency Steueranteil in Hauswährung taxAmountInTransactionCurrency Steueranteil in Transaktionswährung addressNumber Adressnummer invoiceRecipient Rechnungsempfänger orderNumber Auftragsnummer orderItemNumber Auftragspositionsnummer originalOrderItem Ur-Position im Auftrag cycleNumber Zyklusnummer externalItemNumber Externe Positionsnummer printedDocument Druckerzeugnis exchangeRate Umrechnungskurs HTTP Response StateDescription 404 GP nicht vorhanden Invoice Info Der Service bietet liefert die Invoice Info zu einem Geschäftspartner Path mapping(intern): /net/dsb/avs3/Bp/getInvoiceInfo-1.0.0 URL GET: /rest/{clientId}/bp/{bpNumber}/invoiceinfo?sp={sp} ParameterTyp/LängeBeschreibung clientIdC/3Mandanten Nummer bpNumber C/10Geschäftspartner Nummer (mandatory) sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) Response Beispiel Respons Body JSON: [ { "invoiceNumber": "5034660575", "invoiceType": "YR00", "invoiceTypeDescription": "Facturatie abonnement", "currencyCode": "EUR", "salesOrganization": "0200", "companyCode": "0200", "invoiceDate": "2021-10-28", "postingStatus": "C", "netAmount": 70.93, "grossAmount": 75.90, "printInvoiceIndicator": false, "customer": "1022053388", "contractAccount": "100001111085", "contractAccountDocumentNumber": "750005812142", "addressNumber": "0002969132", "invoiceRecipient": "1022053388", "paymentMethod": "D", "maskedIBAN": "DE65250500000151215910", "positions": [ { "itemNumber": 10, "publication": "00003081", "publicationDescription": "Für Sie", "edition": "00003081", "editionDescription": "Für Sie", "mixType": "01", "mixTypeDescription": "Für Sie", "subscriptionFrequency": "VA", "invoiceText": "*0023/2021 Rechnung", "billingPeriod": "02", "billedFrom": "2021-10-15", "billedTo": "2021-10-15", "countryOfDelivery": "DE", "debitCreditIndicator": false, "netAmountItem": 0.00, "grossAmountItem": 0.00, "orderNumber": "4610174569", "orderItemNumber": 1, "goodsRecipient": "1022053388" } ] } ] ElementBeschreibung invoiceNumber Fakturnummer invoiceType Fakturart invoiceTypeDescription Beschreibung Fakturart currencyCode Währungskennzeichen salesOrganization Verkaufsorganisation companyCode Buchungskreis invoiceDate Fakturadatum postingStatus Buchungsstatus netAmount Nettowert grossAmount Bruttowert printInvoiceIndicator Rechnung drucken? customer Auftraggeber contractAccount Vertragskonto contractAccountDocumentNumber Belegnummer Vertragskonto addressNumber Adressnummer invoiceRecipient Rechnungsempfänger paymentMethod Zahlweg maskedIBAN IBAN maskiert positions Rechnungspositionen itemNumber Positionsnummer publication Druckerzeugnis publicationDescription Beschreibung Druckerzeugnis edition PVA editionDescription Beschreibung PVA mixType Bezugstyp mixTypeDescription Beschreibung Bezugstyp subscriptionFrequency Bezugsperiodizität invoiceText Fakturtext billingPeriod Fakturperiode billedFrom Fakturiert von billedTo Fakturiert bis countryOfDelivery beliefertes Land debitCreditIndicator Soll-Haben-Kennzeichen netAmountItem Nettowert Position grossAmountItem Bruttowert Position orderNumber Auftragsnummer orderItemNumber Auftragspositionsnummer goodsRecipient Warenempfänger HTTP Response StateDescription 404 GP nicht vorhanden Change Log Der Service bietet liefert das Change Log zu einem Geschäftspartner Path mapping(intern): /net/dsb/avs3/Bp/getChangeLog-1.0.0 URL GET: /rest/{clientId}/bp/{bpNumber}/changeLog?sp={sp} ParameterTyp/LängeBeschreibung clientIdC/3Mandanten Nummer bpNumber C/10Geschäftspartner Nummer (mandatory) sp C/3service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) orderNumber C nur das Log zu diesem Abo lesen (default ist alle Abos des GP) includeCanceledSubscriptions C auch Log zu gekündigten Abos lesen (default: false) fromDate D Log nur ab diesem Datum lesen Response Beispiel Respons Body JSON: [ { "orderNumber": "4722954825", "createdBy": "DSB-MUSTER", "createdOn": "2024-07-22", "createdAt": "09:55:26", "category": "INFBX", "role": "", "msgNumber": "", "letterDesc": "", "processingDate": "0000-00-00", "repetitionFlag": "", "paymentMethod": "", "paymentAmount": 0, "currency": "", "text": "info von DSB per outlook: lu nun behoben", "contactClass": "", "contactActivity": "", "contactDirection": "", "contactType": "", "changedBy": "", "changedOn": "0000-00-00", "changedAt": "00:00:00" } ] ElementBeschreibung HTTP Response StateDescription 404 GP nicht vorhanden Abos anhand der GP Nummer, wo der Geschäftspartner Lizenznehmer ist Path mapping(intern): /net/dsb/avs3/SubscriptionOrder/getLicensedSubscriptionsByBpNumber-1.0.0 URL GET: /rest/{client}/bp/{bpNumber}/licensedSubscriptions ParameterBeschreibung bpNumber Geschäftspartner Nummer returnOnlyActive Aktive Abos zurückliefern (default) oder alle fromHit Index des Abos, ab dem beim paketweisen Lesen gelesen werden soll. maxHitCount maximale Anzahl Abos, die gelesen werden sollen 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 Da ein Geschäftspartner sehr viele Abos haben kann (mehrere tausend), kann dieser Request sehr lange dauern. Daher wird empfohlen, die Anzahl der Abos im Response zu begrenzen und bei Bedarf paketweise nachzulesen. Bsp. Request: /rest/{client}/bp/{bpNumber}/subscriptions?maxHitCount=100 Wenn im Response 100 Abos enthalten sind, könnte es auch noch mehr geben, dann folgt ein weiterer Request /rest/{client}/bp/{bpNumber}/subscriptions?fromHit=101&maxHitCount=100 usw. bis ein Response keine 100 Abos enthält. Response Der Response beinhaltet ein JSON Dokument mit einem Array aus subscriptions aufgeteilt nach activ/inactive lizenzierten Aufträgen. { active[ { "orderNumber": "4721338038", ... }, { "orderNumber": "4721338039", ... }, ... ], inactive[ { "orderNumber": "4721338034", ... }, { "orderNumber": "4721338035", ... } ] } 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 Addresssuche stoppen / Stopp address research Stoppt, wenn aktiv, eine Addressuche beim Geschäftspartner mit der übergebenen GP Nummer Path mapping(intern): /net/dsb/avs3/Bp/stoppAddressResearch-1.0.0 Fuba: /DSB/_ISM_E_END_ADDR_RESEARCH URL POST: /rest/{client}/bp/{bpNumber}/stoppAddressResearch Parameter Beschreibung client Mandant bpNumber Geschäftspartner Nummer sp Dienstleister. (Pflichtfeld, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann) so Verkaufsorganisation. (Pflichtfeld, wenn der Account unterschiedliche VkOrgs nutzen kann) Response Der Reponse ist ein JSON Dokument [ { "msgId": "", "msgNo": "", "msgType": "", "msgText": "" } ] 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