Inhaltsverzeichnis Product Sales create Product Sales cancel Product Sales Ermittlung der OrderNumber Product Sales create Product Sales Legt Product Sales Aufträge an. Webservice zur Anlage eines Product Sales Auftrags in der ccb by dsb® Suite. Hierzu werden Geschäftspartnerdaten und die zahlungsrelevanten Details in untenstehender Struktur an das System übergeben. Bei erfolgreicher Anlage gibt es eine Rückmeldung, die die vergebene Auftragsnummer enthält. Die eingespielten Aufträge können innerhalb der ccb by dsb® Suite in der Optimierten Auftragsanlage (OAA) gesichtet werden. Dort erfolgt auch eine eventuell notwendige Nachbearbeitung, sollte z.B. ein Geschäftspartner auf Dublette gelaufen sein. URL POST: /rest/{client}/productSales?sp=xxx&so=xxx Parameter Typ/Länge Beschreibung client AN / 3 Mandantennummer sp AN / 3 Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so AN / 4 VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) mode AN direct oder buffered (default): direkte oder gepufferte Einspielung. Bei der gepufferten Einspielung muss auch der Backend Job eingerichtet werden. stackname AN nur bei direkter Einspielung: Name des Stapels, in den eingespielt werden soll. Dieser Stapel muss existieren. Wenn kein Name angegeben wird, wird ein neuer Stapel erstellt. Request Body Der body des POST Requests beinhaltet den Auftrag im ein JSON Format. JSON Product Sales Auftrag Beispiel { "externalOrderNumber" : "93-2", "bpRelations" : [ { "role" : "AG", "bp" : {...} }], "articleNumber" : "1234567980", "invoiceNumber": "4711", "orderDescription" : "Example Order", "paymentFormReference": "AB-34", "paymentMethod": "R", "dsbEPaymentGuid" : "ac5f2111-d2ff-402e-b760-5d4e67d19b6f", "payment" : { "amount" : 12.2, "currency" : "EUR" }, "externalInvoice": { "customerPurchaseOrderNumber": "ABCD", "netValue": 110.00, "grossValue": 107.0, "salesDocumentNumber" : "123", "documentCurrency": "EUR", "taxrate": 7.0, "taxValue": 7, "taxClassification" : "", "vatCode" : "", "actualAmountBilled" : 10.1, "invoiceEmail": "test@test.de", "discountType": "01", "discountValue": 10.00, "partDiscount": 0, "taxDestinationCountry": "", "orderDescription": "Beschreibung", "pricingDate" : "2022-04-21", "serviceDate" : "2022-05-03", "accountingArea" : "", "costCenter" : "", "eventType" : "", "eventCountry" : "", "customFieldsType" : "", "customFields" : [ "line1", "line2", "line3", "line4", "line5", "line6" ] }, "payMethodDetails": { "other": { "bankClearingAccount": "145054", "amount": 107, "currencyCode": "EUR" } }, "debitAccount" : { "debitAccountId" : "3241", "debitBankCode" : "ABCD1234", "debitCountryCode" : "DE", "debitAccountNumber" : "213456666", "debitAccountHolder" : "Max Mustermann", "debitContinuous" : true, "iban" : "DE12123412341234123400", "bic" : "BBFE123" }, "sepaMandate" : { "creationType" : "", "transactionType" : "", "sepaDetails" : { "b2bMandante" : false, "mandateRefPerCreditor" : "", "previousCreditorId" : "", "previousBic" : "", "lastDueDate" : "" }, "complaint": { "type": "delivery", "complaintReason": "G01", "numberOfIssues": 5, "text": "Test", } } Element Definitionen Parameter TypLängeBeschreibung externalOrderNumberC35In diesem Feld wird eine mandantenweit eindeutige externe Auftragsnummer erwartet. (mandatory) Diese dient gleichzeitig als Primärschlüssel in der Datenbank. articleNumberC18Artikelnummer invoiceNumberC50Rechnungsnummer orderDescriptionC ProductSales Auftragsbezeichnung (Leistungsbezeichnung) paymentFormReferenceC50Zahlscheinreferenznummer paymentMethodC1Zahlweg (mandatory) (Codes) dsbEPaymentGuid C36Authorisation-GUID in der dsb-Webservice Umgebung. Beinhaltet die ID von einem vormals getätigten notify Request (Bsp.: notifyCardTransactionWithWirecard) payment *currencyC3ProdSales Auftragsposition Währung *amountN ProdSales Auftragsposition Betrag externalInvoice * customerPurchaseOrderNumberC20Auftragsnummer des Kunden * netValueNNettobetrag * grossValueNBruttobetrag * documentCurrencyC3Währung * taxrateNSteuersatz (Prozentsatz) * taxValueNSteuerbetrag * invoiceEmailC50Email-Adresse für Rechnung * discountTypeC2Rabatttyp * discountValueNRabattbetrag * partDiscountN??? * taxDestinationCountryC2Steuerliches Empfangsland * orderDescriptionC120Beschreibung des Auftrags payMethodDetails * cheque * bankClearingAccountC10Bankverrechnungskonto - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * chequeNumber C13 Schecknummer - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * amount N Betrag in Transaktionswährung mit Vorzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * currencyCode C3 Währungskennzeichen ISO - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist Währung als ISO-Währungscode EUR Euro CHF Schweizer Franken GBP Britische Pfund usw. * bankCode C15Bankleitzahl - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * bankControlKey C2Bankenkontrolschlüssel - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * bankCountryCode C2Länderschlüssel der Bank - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * bankAccountNumber C18Bankkontonummer - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-cheque' angegeben ist * other * bankClearingAccountC10Bankverrechnungskonto - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist * amount N Betrag in Transaktionswährung mit Vorzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist * currencyCode C3Währungskennzeichen - Pflichtfeld, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist Währung als ISO-Währungscode EUR Euro CHF Schweizer Franken GBP Britische Pfund usw. * payeeNote C80Text zur verwendung der Zahlung - Kann, wenn unterhalb des Elements 'payment-method-details' Struktur 'payment-method-other' angegeben ist debitAccount * debitAccountId C4debit account id * debitBankCode C15Bankschlüssel - Muss, wenn entsprechender Zahlweg. * debitCountryCode C2ISO-Ländercode der Bank - ISO-Ländercode der Bankverbindung bei entsprechendem Zahlweg. * debitAccountNumber C18Bankkontonummer - Muss, wenn entsprechender Zahlweg. * debitAccountHolder C60Name des Kontoinhabers - Muss, wenn entsprechender Zahlweg. * debitContinuous B Liegt eine Einzugsermächtigung vor? true = ja false = nein * iban C34International bank account nummer (debitAccountNumber oder iban ist mandatory) Siehe auch Element „sepa-mandate“ * bic C11Bank identifier code (debitBankCode oder bic ist mandatory) bpRelations * roleC2business partner role * bp business partner (see below) sepaMandate * creationType C1„ “ = kein Mandat angelegt „N“ = Neues Mandat anlegen „T“ l= Mandatsumstellung (momentan nicht zu verwenden) „M“ = Mandatsmigration(momentan nicht zu verwenden) Muss angegeben werden, wenn eine IBAN vorhanden ist! * transactionType C1„1“ = 1x Mandat „N“ = Mehrfach Mandat (default) * sepaDetails * * b2bMandante B B2B-Mandat „true” oder „false” (Wird bisher nicht unterstützt) * * mandateRefPerCreditorC35Eindeutige Referenz auf das Mandat pro Kreditor / Bisherige Mandats-ID (Nur für Umstellungen relevant creation-type „T“ und „M“) * * previousCreditorId C35Kreditorkennung (landesübergreifend eindeutig) / Bisherige Gläubiger-ID (Nur für Umstellungen relevant creation-type „T“ und „M“)) * * previousBic C11Bisheriger BIC-Code (Nur für Umstellungen relevant „T“ und „M“) * * lastDueDate C Wenn Vorlagemandat verwendet wurde mit Datum der letzten Verwendung (Fälligkeit) füllen Initialwert für Übernahmen (Typ „M“) notwendig, falls noch nicht eingezogen wurde „YYYY-MM-DD“ complaint BETA 0 … 1 Gutscheinabwicklung über SHOP/REKLA * typeCdelivery / debit(Gutschrift) / credit(Belastung), mandatory * complaintReasonC4Reklamationsgrund ,mandatory) * numberOfIssuesN3Anzahl Heftfolgen (mandatory wenn type=delivery) * amountN8,2Betrag (mandatory wenn type = debit/credit) * textC35Freitext für Gutschrift/Belastung (optional) businessPartners 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 bei direkter Einspielung { "stackName": "07898TESRFC160322", "numberInStack": 5, "messages": [ { "msgId": "JG", "msgNo": "333", "msgType": "E", "msgText": "Die Postleitzahl 74821 hat ein ungültiges Format" } ] } Parameter Typ/Länge Beschreibung stackName AN Stapel, in den eingespielt wurde numberInStack N Position im Stapel messages Meldungen aus AVS bei gepufferter Einspielung { "resultCode": "NOK", "resultMessage": [ "Instance with ID already exists." ] } Parameter Typ/Länge Beschreibung resultCode AN OK/NOK Status resultMessage Statusmeldungen cancel Product Sales Storniert Product Sales Aufträge. Der Service befindet sich in Entwicklung. Diese Dokumentationsseite dient der Entwicklung. Der Service ist nur in der Testumgebung verfügbar. URL POST: /rest/{client}/productSales/cancellations?sp=xxx&so=xxx&orderNumber=4100000123&invoiceNumber=4711&customerPurchaseOrderNumber=AB1234&cancelReason=199 Parameter Typ/Länge Beschreibung client AN / 3 Mandantennummer sp AN / 3 Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so AN / 4 VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) orderNumber AN Auftragsnummer invoiceNumber AN Rechnungsnummer customerPurchaseOrderNumber AN Kundenauftragsnummer cancelReason AN Kündigungsgrund. Optional, falls keine Kündigungsgrund angegeben wird, muss im Customizing ein Defaultgrund hinterlegt sein. Von den Parametern orderNumber, invoiceNumber und customerPurchaseOrderNumber muss genau einer übergeben werden. Response [ { "msgId": "JG", "msgNo": "333", "msgType": "E", "msgText": "Die Postleitzahl 74821 hat ein ungültiges Format" } ] Ermittlung der OrderNumber Der Service ermittelt zu einer invoiceNumber oder einer costumerPurchaseOrderNumber die zugehörige AVS OrderNumber. URL GET: /rest/{client}/productSales?sp=xxx&so=xxx&queryOrderNumbers&customerPurchaseOrderNumber=AB1234 Parameter Typ/Länge Beschreibung client AN / 3 Mandantennummer sp AN / 3 Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.) so AN / 4 VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.) queryOrderNumbers AN Fix. Dies muss angegeben werden. invoiceNumber AN Rechnungsnummer customerPurchaseOrderNumber AN Kundenauftragsnummer externalOrderNumber AN externe Auftragsnummer invoiceNumber, customerPurchaseOrderNumber oder externalOrderNumber muss übergeben werden. Response { "orderNumbers" : [ "1239982323", "1323232323" ], "messages" : [ { "msgId": "/DSB/JGNA_DOI", "msgNo": "019", "msgType": "E", "msgV1": "1007719922", "msgText": "Etwas hat nicht funktioniert." } ] } Im Erfolgsfall ist orderNumbers gefüllt. Im Fehlerfall stehen in messages die Meldungen aus AVS. 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