Inhaltsverzeichnis Purchase Orders Get By Order Number Get By Order ID Get By Invoice Number Create Changes Purchase Orders Diese Seite beschreibt die Purchase Order REST Webservices Get By Order Number Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getPurchaseOrder-2.0.0 URL GET: /rest/{client}/purchase-orders/{po-number} ParameterTyp/LängeBeschreibung po-numberN / 7 VHS/3 Auftragsnummer. Muss, wenn weder purchaseorder-id noch invoice-number angegeben sind. client AN / 4 Mandantennummer sp AN / 3 Einschränkung auf einen bestimmten Dienstleister. (mandatory) Korrespondierender SOAP Service: getPurchaseOrder. Für VHS-Clients liest dieser Service einen VHS Auftrag anhand der Auftragsnummer. Für AVS-Clients liest dieser Service den Product Sales Auftrag mit der Auftragsnummer. Für AVS Product Sales Aufträge existiert auch der Service Subscription.getByOrderNumber. Dieser liest den Product Sales Auftrag in einem anderen Format, liefert aber die gleichen Aufträge. Response Der Response ist ein JSON Dokument mit einer Purchase Order Struktur. JSON Purchase Order Example { "purchaseOrderNumber": 3021115, "purchaseOrderId": "18648", "serviceProvider": "132", "purchaseOrderCategory": "STD", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-29", "purchaseOrderState": "L9", "purchaseOrderSource": "0148-001", "purchaseOrderSourceGroup": "", "currencyCode": "EUR", "valueAllInclusiveBrutto": 0, "valueAllInclusiveNetto": 0, "valueBrutto": 0, "valueNetto": 0, "paymentTypePreliminary": "OB", "paymentTypePreliminary2": "", "paymentTypePreliminary3": "", "paymentTypeCorrected": "KL", "seriesCode": "", "freeOfChargeTag": true, "parcelQuantity": 4, "variableCode1": "", "variableCode2": "", "clientHasMoney": "", "scanStatus": "90", "timestampOfLastModification": "2014-09-06T00:33:00+02:00", "purchaseOrderInfo": "", "purchaseOrderRejection": "", "correspondenceLanguageCode": "2", "purchaseOrderAdditionList": [], "bpAddressList": [ { "addressType": "02", "bpNumber": "0000007658", "lastName1": "Muster", "lastName2": "", "firstName": "Christine", "titel": "", "company1": "Musterland Agrar GmbH", "company2": "", "company3": "", "salutationCode": "01", "countryCode": "D", "street": "Dorfweg", "streetSuffix": "", "streetNumber": "7", "streetNumberSuffix": "", "zipcode": "12345", "city": "Musterstadt", "district": "", "regionCode": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "communicationList": [ { "type": "TM", "communication": "01723111111" }, { "type": "TP", "communication": "01723111111" }, { "type": "WW", "communication": "muster@musterland-agrar.com" } ], "role": "AG" }], "itemList": [ { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 8, "quantityDelivered": 8, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070020", "packageNumber": 24095, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 4, "quantityDelivered": 4, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070037", "packageNumber": 24096, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 8, "quantityDelivered": 8, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070044", "packageNumber": 24097, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 1, "quantityDelivered": 1, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-05T16:30:00+02:00", "packageInfo": { "consignmentNumber": "93244166070051", "packageNumber": 24098, "receiptNumber": "0090211078", "receiptType": "R", "cut": 801, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-05" }, "itemAdditionList": [] } ], "articlesMap": {}, "reminderList": [], "returnList": [], "invoiceList": [ { "invoiceNumber": 90211078, "invoiceType": "K", "dateOfInvoice": "2014-09-01T00:00:00.000+0200", "invoiceMainPaymentType": "KL", "invoiceValueBrutto": 0, "invoicePaymentAmount": 0, "shippingCost": 0, "invoiceStatus": "2", "balance": 0, "invoiceProcessingStatus": "", "orderExtraPay": 0, "orderDiscount": 0, "paymentsReceivedTotal": 0, "numberOfPayments": 0, "dateOfLastPayment": "", "dateOfInvoiceCancellation": "", "numberOfDebits": 0, "debitAmountTotal": 0, "debitReturnReason": "" }] } Get By Order ID Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getPurchaseOrders-1.0.0 URL GET: /rest/{client}/purchase-orders ParameterTyp/LängeBeschreibung po-idAN / 10 Externe Auftragsnummer bzw. Bestell-ID Muss, wenn weder purchaseorder-number noch invoicenumber angegeben sind. client AN / 4 Mandantennummer sp AN / 3 Einschränkung auf einen bestimmten Dienstleister. (mandatory) Corresponing SOAP Service: getPurchaseOrder. Response Der Response ist ein JSON Dokument mit einer Purchase Order Struktur. JSON Purchase Order Example { "purchaseOrderNumber": 3021115, "purchaseOrderId": "18648", "serviceProvider": "132", "purchaseOrderCategory": "STD", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-29", "purchaseOrderState": "L9", "purchaseOrderSource": "0148-001", "purchaseOrderSourceGroup": "", "currencyCode": "EUR", "valueAllInclusiveBrutto": 0, "valueAllInclusiveNetto": 0, "valueBrutto": 0, "valueNetto": 0, "paymentTypePreliminary": "OB", "paymentTypePreliminary2": "", "paymentTypePreliminary3": "", "paymentTypeCorrected": "KL", "seriesCode": "", "freeOfChargeTag": true, "parcelQuantity": 4, "variableCode1": "", "variableCode2": "", "clientHasMoney": "", "scanStatus": "90", "timestampOfLastModification": "2014-09-06T00:33:00+02:00", "purchaseOrderInfo": "", "purchaseOrderRejection": "", "correspondenceLanguageCode": "2", "purchaseOrderAdditionList": [], "bpAddressList": [ { "addressType": "02", "bpNumber": "0000007658", "lastName1": "Muster", "lastName2": "", "firstName": "Christine", "titel": "", "company1": "Musterland Agrar GmbH", "company2": "", "company3": "", "salutationCode": "01", "countryCode": "D", "street": "Dorfweg", "streetSuffix": "", "streetNumber": "7", "streetNumberSuffix": "", "zipcode": "12345", "city": "Musterstadt", "district": "", "regionCode": "", "poBox": "", "poBoxZipcode": "", "poBoxCity": "", "communicationList": [ { "type": "TM", "communication": "01723111111" }, { "type": "TP", "communication": "01723111111" }, { "type": "WW", "communication": "muster@musterland-agrar.com" } ], "role": "AG" }], "itemList": [ { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 8, "quantityDelivered": 8, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070020", "packageNumber": 24095, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 4, "quantityDelivered": 4, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070037", "packageNumber": 24096, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 8, "quantityDelivered": 8, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-03T17:19:00+02:00", "packageInfo": { "consignmentNumber": "93244166070044", "packageNumber": 24097, "receiptNumber": "0090211078", "receiptType": "R", "cut": 399, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-03" }, "itemAdditionList": [] }, { "posNumber": 1, "posSubNumber": 0, "distributionArticleNumber": "BL0021", "distributionArticleNumberExternal": "", "distributionArticleDescription1": "SY 5x Gelbschale+Gitterabdeck", "distributionArticleDescription2": "", "distributionArticleEan": "", "articleType": "", "objectNumber": "", "width": "", "length": "", "purchaseOrderQuantity": 1, "quantityDelivered": 1, "salesPriceBrutto": 0, "salesPriceBruttoTotal": 0, "salesPriceNetto": 0, "salesPriceNettoTotal": 0, "extraPayDiscountRate": 0, "extraPayDiscountAmount": 0, "extraPayDiscountAmountTotal": 0, "deliveryCode": "F1", "setCode": "", "supplementTag": false, "specialPriceTag": false, "normalPriceTag": false, "freeOfChargeTag": true, "extraPayDiscountTag": false, "cancellationTag": false, "deliveryState": "L9", "invoiceNumber": 90211078, "invoiceType": "K", "dateOfPurchaseOrderClient": "2014-08-29", "dateOfPurchaseOrderSystem": "2014-08-30", "dateOfInvoice": "2014-09-01", "scanStatus": "90", "timestampOfLastModification": "2014-09-05T16:30:00+02:00", "packageInfo": { "consignmentNumber": "93244166070051", "packageNumber": 24098, "receiptNumber": "0090211078", "receiptType": "R", "cut": 801, "leadingCode": "665327ZV43", "trackStatus": "", "trackDepotNumber": "", "deliveryDate": "2014-09-01", "versWeg": "05", "scanStatus": "90", "scanStatusDate": "2014-09-05" }, "itemAdditionList": [] } ], "articlesMap": {}, "reminderList": [], "returnList": [], "invoiceList": [ { "invoiceNumber": 90211078, "invoiceType": "K", "dateOfInvoice": "2014-09-01T00:00:00.000+0200", "invoiceMainPaymentType": "KL", "invoiceValueBrutto": 0, "invoicePaymentAmount": 0, "shippingCost": 0, "invoiceStatus": "2", "balance": 0, "invoiceProcessingStatus": "", "orderExtraPay": 0, "orderDiscount": 0, "paymentsReceivedTotal": 0, "numberOfPayments": 0, "dateOfLastPayment": "", "dateOfInvoiceCancellation": "", "numberOfDebits": 0, "debitAmountTotal": 0, "debitReturnReason": "" }] } Get By Invoice Number Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getPurchaseOrders-1.0.0 URL GET: /rest/{client}/purchase-orders ParameterTyp/LängeBeschreibung invoice-numberN / 8 VHS/3 Rechnungs-Nr. Muss, wenn weder purchaseorder-number noch purchaseorder-id angegeben sind. client AN / 4 Mandantennummer sp AN / 3 Einschränkung auf einen bestimmten Dienstleister. (mandatory) Korrespondierender SOAP Service: getPurchaseOrder. Response Der Response ist ein JSON Dokument mit einer Purchase Order Struktur. Create Legt einen neuen Versandhandelsauftrag(NewPurchaseOrder) an. Path mapping(intern): /net/dsb/vhs3/NewPurchaseOrder/create-2.0.0 URL POST: /rest/{client}/purchase-orders ParameterTyp/LängeBeschreibung client AN / 4 Mandantennummer sp AN / 3 Einschränkung auf einen bestimmten Dienstleister. (mandatory) Request Body Der body des Post Requests beinhaltet ein JSON Dokument mit einer Purchase Order. JSON New Purchase Order Beispiel { "purchaseOrderSource" : "REPLACE", "paymentMethod" : null, "shippingCostCode" : "0", "shippingCost" : null, "insuranceCode" : null, "insuranceAmount" : null, "debitAccountNumber" : null, "debitBankCode" : null, "debitCountryCode" : null, "debitAccountHolder" : null, "debitContinuous" : "N", "ccNumber" : null, "ccCompany" : null, "ccChecksum" : null, "ccHolder" : null, "ccExpiry" : null, "ccStartdate" : null, "ccIssuenumber" : null, "ccType" : null, "priceList" : "UK", "creditLimitCheck" : null, "giftParcel" : null, "partDeliveries" : null, "purchaseOrderCategory" : null, "seriesCode" : null, "externalOrderId" : "0000007582", "correspondenceLanguageCode" : null, "dateOfDelivery" : null, "cashHandInLater" : null, "iban" : null, "bic" : null, "depositNumber" : null, "cashCurrencyCode" : null, "cashAmount" : 0.0, "cashInAdvanceCurrencyCode" : null, "cashInAdvanceAmount" : 0.0, "purchaseOrderPriority" : null, "shippingMethod" : null, "shippingType" : null, "shippingForm" : null, "shippingTypeSuffix" : null, "dateOfPurchaseOrder" : "2017-03-03", "clientHasMoney" : null, "option" : null, "processingType" : null, "variableCode1" : null, "variableCode2" : null, "dsbEPaymentGuid" : null, "preliminaryCancellationCode" : null, "purchaseOrderNumber" : null, "preliminarySpotId" : null, "preliminaryPurchaseOrderSource" : null, "skipDoiProcess" : true, "purchaseOrderInfo" : null, "positions" : [ ], "purchaseOrderAttributes" : [ ], "paymentType1" : "OB", "bpRelations" : [ { "role" : "AG", "bp" : { ... } } ] } Element Definition Element Typ/Länge Beschreibung purchaseOrderSource AN / 10 Bestellquelle Codetabelle, Inhalt legt Fachbereich fes (mandatory) paymentType1 paymentType2 paymentType3AN / 2Payment Type Zahlungsart max. 3 externe Eingaben Zahlungsarten parallel, z.B. Bargeld, Scheck, Kreditkarte, Lastschrift, offene Rechnung Codetabelle, Inhalt legt Fachbereich fest paymentMethod AN / 2Zahlungsweise Teilzahlung (TZ) Rate, Komplettbetrag oder Rate, fixer Betrag zu Termin …. shippingCostCode AN / 4Versandkostenkennung Codetabelle, Inhalt legt Fachbereich fest shippingCost N Versandkosten i.d.R. keine Eingabe insuranceCode AN / 4Versicherungskennung Codetabelle, Inhalt legt Fachbereich fest insuranceAmount N Versicherungsbetrag debitAccountNumber AN / 19Kontonummer Lastschrift debitBankCode AN /12 Bankleitzahl Lastschrift debitCountryCode AN / 3Länderkennung Bank/Lastschrift (Standard KFZ-Ländercode) Methoden ab der Version 2.0.0 unterstützen auch ISOLändercodes. Dann muss allerdings das Attribut code-type mit „iso“ gefüllt werden. debitAccountHolder AN / 50 Kontoinhaber debitContinuous AN / 1Kennung Dauerabbuchung Lastschrift J = Dauerabbuchung Y = Dauerabbuchung (Methoden ab der Version 2.0.0) N= Einmalabbuchung iban AN /34 IBAN bic AN / 11BIC depositNumber AN / 20Ablagenummer ccNumber AN / 19 Kreditkartennummer ccChecksum AN / 4Prüfsumme/Ziffer der Kreditkartennummer, diese befindet sich auf dem Unterschriftsfeld. ccCompany AN / 4 Kreditkarteninstitut (VHS/3) Codetabelle, Inhalt legt Fachbereich fest ccHolder AN / 50Kreditkarteninhaber ccExpiry N / 6Kreditkarte Gültigkeit bis JJJJMM ccStartdate N / 6Kreditkarte Gültigkeit ab JJJJMM ccIssuenumber AN / 2 Kreditkarte Ausgabenummer ccType AN / 3Kreditkarte Typ priceList AN / 4Preisliste Codetabelle, Inhalt legt Fachbereich fest, ‘ ‘ = keine Angabe (Defaultwertversorgung Back Office System) extraPayDiscountList AN / 4 Zu-/Abschlag Position: Zu-/Abschlagsliste Codetabelle, Inhalt legt Fachbereich fest extraPayDiscountRate N Zu-/Abschlag-Satz: Anteil (Prozentangabe) Bei Abschlag negatives Vorzeichen geplant, noch nicht verfügbar extraPayDiscountAmount N Zu-/Abschlag-Wert: Betrag (Betragsangabe) Bei Abschlag negatives Vorzeichen geplant, noch nicht verfügbar extraPayDiscountOfPurchaseOrderAmount N Zu-/Abschlag-Wert: Betrag (Betragsangabe) Purchase Order. Bei Abschlag negatives Vorzeichen Use only after appropval of VHS/3 team. creditLimitCheck AN / 1Kennung Kreditlimitprüfung Codetabelle, Inhalt legt Fachbereich fest minimumPurchaseOrderValueCheck AN Kennung Mindestbestellwert-Prüfung J = Prüfung Y = Prüfung (Methoden ab der Version 2.0.0) N = keine Prüfung ‘ ‘ = keine Angabe (Defaultwertvers.) giftParcel AN / 1 Kennung Geschenksendung J = Geschenksendung Y = Geschenksendung (Methoden ab der Version 2.0.0) N = keine Geschenksendung ‘ ‘ = keine Angabe (keine Geschenksendung) partDeliveries AN / 1 Anzahl Lieferungen ingabe Kundenwunsch, unbegrenzt, max. entspr. Mandantenvorgabe Werte: 0 = unbegrenzte Anz. Lieferungen 1 – 9 = Anz. Lieferung entspr. Angabe ‘ ‘ = keine Angabe (Defaultwertvers.) purchaseOrderCategory AN / 4Auftragsart klassifiziert die Bestellung z.B. Eilbestellung (24 Stunden Lieferung) Codetabelle, Inhalt legt Fachbereich fest seriesCode AN / 4Kennung für Serien- / Reihenlieferung externalOrderId AN / 10Bestellidentifikation Verweis auf evtl. Belege z.B. Übernahme Paginiernummer, sonstige Kennungen correspondenceLanguageCode N / 3Korrespondenzsprache in welcher Sprache soll Auftrag abgewickelt werden (z.B.Druck) Codetabelle, Inhalt legt Fachbereich fest (1 = Englisch, 2 = Deutsch, weitere Sprachen auf Anfrage) dateOfDelivery N / 8 Liefertermin bei Terminaufträgen Format JJJJMMTT oder Format JJJJ-MM-TT (Methoden ab der Version 2.0.0) cashHandInLater AN / 4Vorauskasse Nachreichen Codetabelle, Inhalt legt Fachbereich fest chequeCode AN / 7Scheckkennung chequeNumber AN / 15Schecknummer chequeAccountNumber AN / 19 Scheck Kontonummer chequeBankCode AN / 12Scheck Bankleitzahl chequeCountryCode AN / 3Scheck Länderkennung Bank Methoden ab der Version 2.0.0 unterstützen auch ISOLändercodes. Dann muss allerdings das Attribut code-type mit „iso“ gefüllt werden. chequeBankName AN / 44Scheck Name Bank chequeAccountHolder AN / 30Scheck Kontoinhaber chequeType AN / 2 Scheckart Codetabelle, Inhalt legt Fachbereich fest chequeCurrencyCode AN / 3Scheck-Währungskennung Codetabelle, Inhalt legt Fachbereich fest chequeAmount N Scheck-Betrag cashCurrencyCode AN / 3 Bargeld-Währungskennung Codetabelle, Inhalt legt Fachbereich fest ) cashAmount N Bargeld-Betrag cashInAdvanceCurrencyCode AN / 3Vorauskasse Bank-Währungskennung Codetabelle, Inhalt legt Fachbereich fest cashInAdvanceAmount N Vorauskasse Bank-Betrag purchaseOrderPriority AN / 2 Bestellpriorität Steuerung der Priorität bei der Auftragsabwicklung Codetabelle, Inhalt legt Fachbereich fest shippingMethod AN / 2Versandweg Codetabelle, Inhalt legt Fachbereich fest 00 = masch. Ermittlung Back Office shippingType AN / 2Versandart (Bezug zu Versandweg) Codetabelle, Inhalt legt Fachbereich fest 00 = masch. Ermittlung Back Office shippingTypeSuffix AN / 2Versandart-Zusatz leer shippingForm AN / 2Versandform 00 = keine Angabe 01 = Nachnahme dateOfPurchaseOrder N / 8 Auftragsdatum Format JJJJMMTT oder Format JJJJ-MM-TT (Methoden ab der Version 2.0.0) clientHasMoney N Geldeingang beim Mandant Geldeingang liegt beim Mandant vor option 6 AN Option option AN Option processingType AN / 1Bearbeitungsart (nur in Verbindung mit business-partner) 1 = nur Adresse 2 = Bestellung (Defaultwert) 3 = nur Adresse mit masch. Zusteuerung der Artikel 4 = Bestellung mit Adressänderung variableCode1 AN / 10Feld für variable Steuerung ext. Schlüssel variableCode2 AN / 20Feld für variable Steuerung ext. Schlüssel purchaseOrderInfo AN / 50Bestell-Info dsbEPaymentGuid AN / 36Transactions-ID von der Authorisierung. Diese wird im Response des Notify Service zurückgegeben. preliminaryCancellationCode AN / 4 Vorläufiger Storno-Grund eines externes Systems.Dient dazu dem VHS/3 anzuzeigen, dass ein Auftrag als stornierter Auftrag anzusehen ist und nur für statistische Zwecke ins Backend übertragen wird. skipDoiProcess B DOI Prozess beim GP nicht durchlaufen. purchaseOrderAttributes bpRelations * bpRole C GP Rolle. GP mit Rolle AG ist mandatory. * bp business partner (see below) positions purchase order items. Mindestens 1 Item muss vorhanden sein. bp JSON Business Partner Example { "salutationCode" : "01", "lastName1" : "Y", "firstName" : "X", "addressLine1" : "Blitz Media Ltd, Unit 1, Torfaen Bu", "zipcode" : "N1C 4AP", "countryCode" : "GB", "city" : "LONDON", "bpCommunicationsList" : [ { "communicationType" : "T", "communicationValue" : "123" } ], "bpAttributesList" : [], "avsAttributes" : { "salesOrganization" : "0100", "distributionChannel" : "01", "division" : "01" } } Element Definitions Field name TypeLengthDescription bpNumber C 10 Business partner no. lastName1 C 35 Lastname 1 lastName2 C 35 Lastname 2 firstName C 35 First-name nickName C 35 jobTitle C 35 Job title salutationCode C 2 Salutation-Code in AVS/3, For example 01 = Mr. 02 = Ms. prefix C 4 titleCodeAcademic C 4 Academic title code, e.g. 0027 = Dr titleAcademic C 15Academic Title, e.g. Dr. titleCodeRoyal C 4Royal title code titleRoyal C 15Royal title company1 C 401. line of company address. If this field is filled is the above name the contact person of the firm. company2 C 402. line of company address. Contains for example section or continuation of firm address. company3 C 40 3. line of company address department C 30 department zipcode C 10 zipcode street C 50Street with house no. and addition to house no. streetSuffix C 40 Addition to street streetNumber C 10 Street Number streetNumberSuffix C 10 Street Number Suffix addressLine1 C 35Address line 1 for UK addresses addressLine2 C 35Address line 2 for UK addresses addressLine3 C 35Address line 3 for UK addresses poBoxZipcode C 10Po-box-zipcode poBox C 10 Po-box poBoxCity C 40 Po-box-city poBoxCountryCode C 2 Po-box-country-code majorCustomerZipcodeC 10Major-cust-zip city C 40 City district C 40 Addition of city regionCode C 3 Region-Code (federal state, province, county) regionText C 25 Region as cleartext (e.g. County…) countryCode C 2 Two letter ISO 3166-1 alpha-2 country-code advertisement C 1 Advertisement permitted; Y / N block B General block-tag blockReason C 2 block reason euSalesTaxNumber C 14EU sales tax id addressSource C 10 source of the address dateOfBirth D Birthdate (YYYY-MM-DD) masterNumber C 10Partner-ID of master (for example company of contact person) sector C 10 branch bpCommunicationsList communicationType C 2Communication Types; Values communicationValue C 50 Communication value communicationDefault C 1Default value Y / N avsAttributes salesOrganizationC 4 (mandatory) distributionChannelC 2 (mandatory) divisionC 2 (mandatory) bpAttributesList JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value purchaseOrderAttributes JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value positions JSON Purchase Order Items Example { "purchaseOrderQuantity" : 1.0, "posNumber" : null, "distributionArticleNumber": "AB12345", "distArticleDescription1" : null, "price" : null, "priceUnit" : 0, "extraPayDiscountList" : null, "extraPayDiscountRate" : null, "extraPayDiscountAmount" : null, "shippingMethod" : null, "shippingType" : null, "shippingForm" : null, "shippingCostOfItem" : null, "wrappingPaperCode" : null, "itemAttributes" : [ ] } Element Definitions Field name Type Description distributionArticleNumber AN Distribution article number / Sales article number (mandatory) distributionArticleNumberExternal AN external distribution article number / Sales article number purchaseOrderQuantity N Purchase order quantity posNumber N External position number of this item, which should be used instead of the VHS/3 position number. This number must be unique over all positions of a purchase-order. price N Price (Single price or special price) priceUnit N Price unit freeOfCharge BOOL Free of charge tag extraPayDiscountList AN Surcharge / Discount Surcharge / Discount list (Coded field; content is declared by the department) extraPayDiscountRate N Surcharge / Discount rate (percentage) If discount, sign is minus extraPayDiscountAmount N Surcharge / Discount amount If discount, sign is minus shippingMethod shippingType shippingForm AN AN ANExtra shipping of article (Coded field; content is declared by the department) usually empty Shipping method Shipping type Shipping form shippingCostOfItem N Shipping costs of the item wrappingPaperCode AN Assignment of the gift wrap itemAttributes itemAttributes JSON Attributes Example { "type": "ABC", "value": "2876201a9b0b5173b5d436464b9c7a2b" } Element Definitions Field name Type Description type C type of attribute value C attribute value Response Der Response ist ein JSON Dokument mit dem Ergebnis. ElementBeschreibung resultCodeOK oder NOTOK resultMessageListe von optionalen Fehlermeldungen Beispiel Fehlermeldungen: Order without AG business partner isn't allowed. AG business partner is missing. INVALID_VALUE: Price List: The string is too long. Expected max length of: 4 the price list is longer than 4 characters INVALID_VALUE: Purchase order source: The object given should NOT be null the purchase order source must not be null Korrespondierender SOAP Service: create. Changes Diese Methode liefert eine Liste aller Auftrage zurück, die seit dem übergebenen Zeitpunkt verändert wurden. Diese Methode liefert einen Timestamp zurück, bis zu dem alle Änderungen geliefert wurden. Da max. ca. 10000 Aufträge geliefert werden, muss dieser Timestamp in einem Folgerequest mitgegeben werden, bis ein leeres Ergebnis zurückkommt, um alle Änderungen zu erhalten. Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getChangesEx-1.0.0 URL GET: /rest/{client}/purchase-orders/changes ParameterTyp/LängeBeschreibung client AN / 4 Mandantennummer sp AN / 3 VHS Dienstleister. Pflichtfeld, falls der Account mehrere Dienstleisterkennungen nutzen kann. timestamp Zeitpunkt, ab dem nach geänderten Aufträgen gesucht wird. (mandatory) ISO Format, Bsp.: 2017-01-01T12:00:00Z Response Der Response ist ein JSON Dokument mit dem Ergebnis. Element Beschreibung timestamp Zeitpunkt, bis zu dem alle Änderungen geliefert wurden. Mit diesem Zeitpunkt muss der nächste Aufruf gemacht werden. purchaseOrders Liste den geänderten Aufträgen mit folgenden Attributen: purchaseOrderId externe Auftragsnummer purchaseOrderNumber interne Auftragsnummer Korrespondierender SOAP Service: getChangesEx (Version 1). 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