Table of Contents Purchase Orders Get By Order Number Get By Order ID Get By Invoice Number Create Changes Purchase Orders This page describes the purchase order rest web services. Get By Order Number Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getPurchaseOrder-2.0.0 URL GET: /rest/{client}/purchase-orders/{po-number} ParameterDescription po-numberpurchase order number client client ID sp service provider. (mandatory if the user account can use different service provider values) Corresponing SOAP Service: getPurchaseOrder. Response The response is a JSON document containing a purchase orders. 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 ParameterDescription po-idpurchase order id client client ID sp service provider. (mandatory if the user account can use different service provider values) Corresponing SOAP Service: getPurchaseOrder. Response The response is a JSON document containing an array of purchase orders. 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 ParameterDescription invoice-numberinvoice number client client ID sp service provider. (mandatory if the user account can use different service provider values) Corresponing SOAP Service: getPurchaseOrder. Response The response is a JSON document containing an array of purchase orders. 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": "" }] } Create Creates a new purchase order. Path mapping(intern): /net/dsb/vhs3/NewPurchaseOrder/create-2.0.0 URL POST: /rest/{client}/purchase-orders ParameterDescription client client id sp service provider. (mandatory if the user account can use different service provider values) Request Body The Body of the Post Request contains a JSON document with a purchase order. JSON New Purchase Order Example { "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, "purchaseOrderInfo" : null, "positions" : [ ], "purchaseOrderAttributes" : [ ], "paymentType1" : "OB", "bpRelations" : [ { "role" : "AG", "bp" : { ... } } ] } Element Definitions Field name Type Description purchaseOrderSource AN purchase order source (mandatory) paymentType1 paymentType2 paymentType3AN Payment Type max. 3 external payment types at the same time. paymentType1 is mandatory. For example cash, check, CC, invoice (Coded field; content is declared by the department) paymentMethod AN Payment method shippingCostCode AN Shipping cost code (Coded field; content is declared by the department) shippingCost N Shipping costs usually no entry insuranceCode AN Insurance code (Coded field; content is declared by the department) insuranceAmount N Insurance amount debitAccountNumber AN Account number of debit. debitBankCode AN Bank code of debit debitCountryCode AN country code as ISO country code debitAccountHolder AN Account holder of debit debitContinuous AN Continuous Debit J = Yes Y = Yes (methods with version 2.0.0 or higher) N = No, only once iban AN IBAN bic AN BIC depositNumber AN Deposit number ccNumber AN CC Number ccChecksum AN CC check number ccCompany AN CC-company (Coded field; content is declared by the department) ccHolder AN CC holder ccExpiry N CC expiry YYYYMM ccStartdate N CC startdate YYYYMM ccIssuenumber AN CC issue number ccType AN CC type priceList AN Price List (Coded field; content is declared by the department) extraPayDiscountList AN Surcharge / Discount of item: Surcharge / Discount list (Coded field; content is declared by the department) extraPayDiscountRate N Surcharge / Discount rate (percentage) If discount, sign is minus Planned but not available yet! extraPayDiscountAmount N Surcharge / Discount amount If discount, sign is minus Planned but not available yet! extraPayDiscountOfPurchaseOrderAmount N Surcharge / Discount amount of purchase order If discount, sign is minus Use only after appropval of VHS/3 team. creditLimitCheck AN Credit limit check (Coded field; content is declared by the department) maximumPurchaseOrderValueCheck AN Check max. purchase order value J = test Y = test (methods with Version 2.0.0 or higher) N = no test ‘ ‘ = no declaration (Default value is applied) minimumPurchaseOrderValueCheck AN Check min. purchase order value J = test Y = test (methods with Version 2.0.0 or higher) N = no test ‘ ‘ = no declaration (Default value is applied).) giftParcel AN Gift parcel tag J = gift Y = gift (methods with Version 2.0.0 or higher) N = no gift ‘ ‘ = no declaration (no gift) partDeliveries AN Number of deliveries Values: 0 = unbounded 1 – 9 = according to customer wish ‘ ‘ = no entry (default value) purchaseOrderCategory AN Purchase order category classifies order (e.g. 24h delivery) (Coded field; content is declared by the department) seriesCode AN Code for Sequence and Series processing. externalOrderId AN Purchase order ID Reference to an external purchase order number correspondenceLanguageCode N Correspondence language code Determines in which language the order is processed (e. g. Print) (Coded field; content is declared by the department) (1 = English, 2 = German, more languages ) dateOfDelivery N Date of delivery (Format YYYY-MM-TT) cashHandInLater AN Cash hand in later (Coded field; content is declared by the department) chequeCode AN Cheque code chequeNumber AN Cheque number chequeAccountNumber AN Cheque account number chequeBankCode AN Cheque bank code chequeCountryCode AN Cheque country code. chequeBankName AN Cheque bank name chequeAccountHolder AN Cheque account holder chequeType AN Cheque type (Coded field; content is declared by the department) chequeCurrencyCode AN Cheque currency (Coded field; content is declared by the department) chequeAmount N Cheque amount cashCurrencyCode AN Cash currency code (Coded field; content is declared by the department) cashAmount N Cash amount cashInAdvanceCurrencyCode AN Cash in advance currency code (Coded field; content is declared by the department) cashInAdvanceAmount N Cash in advance amount purchaseOrderPriority AN Purchase order priority Controls the processing of the purchase order (Coded field; content is declared by the department) shippingMethod AN Shipping method (Coded field; content is declared by the department) 00 = determined automatically by Back Office shippingType AN Shipping type (Reference to shipping method) (Coded field; content is declared by the department) 00 = determined automatically by Back Office shippingTypeSuffix AN Shipping type suffix empty shippingForm AN Shipping form 00 = no declaration 01 = C. O. D. dateOfPurchaseOrder N Date-of-purchase-order ISO Format clientHasMoney N Client has the money, field for payment amount option AN Option processingType AN Processing Type (only if business-partner is used) 1 = only address 2 = purchase-order (default) 3 = only address but with automatic item assignment 4 = purchase-order with address modification variableCode1 AN Field for variable data variableCode2 AN Field for variable data purchaseOrderInfo AN Purchase Order Information dsbEPaymentGuid AN Transactions-ID of the authorisation. This is replied in the response of a Notify service. preliminaryCancellationCode AN Preliminary cancellation code of a external system. This is used to signal the VHS/3 that a purchase-order is already canceled and only transferred to the backend system in order to do statistical reporting. purchaseOrderAttributes bpRelations * bpRole C business partner role. Business Partner with role AG is mandatory. * bp business partner (see below) positions purchase order items. At least one item must be sent. 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 The response is a JSON document containing the result. ElementDescription resultCodeOK or NOTOK resultMessagelist of messages in case of an error Example error messages: 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 Corresponing SOAP Service: create. Changes This method returns a list of all orders, which have been added or change since the given timestamp. This method returns a limited count of purchase-order-numbers (~10000). You have to put the responded timestamp in the following request and make a recursive call with every returned timestamp, until the response is empty. Path mapping(intern): /net/dsb/vhs3/PurchaseOrder/getChangesEx-1.0.0 URL GET: /rest/{client}/purchase-orders/changes ParameterTyp/LängeBeschreibung client client id sp service provider. (mandatory if the user account can use different service provider values) timestamp All changes since this timestamp (inclusive) are returned. The response does also include a “timestamp” element. This element has to be used with the next request. (mandatory) ISO Format: 2017-01-01T12:00:00Z Response The response is a JSON document containing the result. Element Beschreibung timestamp Timestamp until this all changes are returned. This timestamp must be used in the next request to get all changes. purchaseOrders List of changed orders with this attributes: purchaseOrderId external order number purchaseOrderNumber internal order number Corresponing SOAP Service: getChangesEx (Version 1). This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.OKMore information