read Read a purchase order from the import buffer und returns the data. Object: /net/dsb/vhs3/NewPurchaseOrder Method: read Version: 2.0.0 Parameter Name Type / LengthOpt. / Mandat.Description purchase-order-id AN / 10 O External purchase-order-id. This is the preferred way. variable-code1 AN / 10 O variable code 1 variable-code2 AN / 20 O variable code 2 purchase-order-uuidAN / 36 O purchase-order-uuid Response Element XML fragment purchase-order . Example Request <?xml version="1.0" encoding="UTF-8"?> <message version="1.0" system="vhs/3" > <header> <client>4711</client> <service-provider>999</service-provider> </header> <body> <purchase-order-id>28</purchase-order-id> </body> </message> Example Response <?xml version="1.0" encoding="UTF-8"?> <message version="1.0" system="vhs/3"> <header> <client>4711</client> <service-provider>999</service-provider> </header> <body> <purchase-order> ... </purchase-order> </body> </message> Response Structure Structure <purchase-order> <purchase-order> <purchase-order-number></purchase-order-number> <purchase-order-source></purchase-order-source> <payment-type1></payment-type1> <payment-type2></payment-type2> <payment-type3></payment-type3> <payment-method></payment-method> <shipping-cost-code></shipping-cost-code> <shipping-cost></shipping-cost> <insurance-code></insurance-code> <insurance-amount></insurance-amount> <debit-account-number></debit-account-number> <debit-bank-code></debit-bank-code> <debit-country-code></debit-country-code> <debit-account-holder></debit-account-holder> <debit-continuous></debit-continuous> <iban></iban> <bic></bic> <deposit-number></deposit-number> <cc-number></cc-number> <cc-checksum></cc-checksum> <cc-company></cc-company> <cc-holder></cc-holder> <cc-expiry></cc-expiry> <cc-startdate></cc-startdate> <cc-issuenumber></cc-issuenumber> <cc-type></cc-type> <price-list></price-list> <extra-pay-discount-of-item> <extra-pay-discount-list></extra-pay-discount-list> <extra-pay-discount-rate></extra-pay-discount-rate> <extra-pay-discount-amount></extra-pay-discount-amount> </extra-pay-discount-of-item> <!-- up to 5 --> <extra-pay-discount-of-purchase-order> <extra-pay-discount-list></extra-pay-discount-list> </extra-pay-discount-of-purchase-order> <extra-pay-discount-of-purchase-order> <extra-pay-discount-list></extra-pay-discount-list> </extra-pay-discount-of-purchase-order> <!-- planned, but not available yet --> <extra-pay-discount-of-purchase-order-rate> </extra-pay-discount-of-purchase-order-rate> <extra-pay-discount-of-purchase-order-amount> </extra-pay-discount-of-purchase-order-amount> <credit-limit-check></credit-limit-check> <maximum-purchase-order-value-check></maximum-purchase-order-value-check> <minimum-purchase-order-value-check></minimum-purchase-order-value-check> <gift-parcel></gift-parcel> <part-deliveries></part-deliveries> <purchase-order-category></purchase-order-category> <series-code></series-code> <purchase-order-id></purchase-order-id> <correspondence-language-code></correspondence-language-code> <date-of-delivery></date-of-delivery> <cash-hand-in-later></cash-hand-in-later> <cheque-code></cheque-code> <cheque-number></cheque-number> <cheque-account-number></cheque-account-number> <cheque-bank-code></cheque-bank-code> <cheque-country-code></cheque-country-code> <cheque-bank-name></cheque-bank-name> <cheque-account-holder></cheque-account-holder> <cheque-type></cheque-type> <cheque-currency-code></cheque-currency-code> <cheque-amount></cheque-amount> <cash-currency-code></cash-currency-code> <cash-amount></cash-amount> <cash-in-advance-currency-code></cash-in-advance-currency-code> <cash-in-advance-amount></cash-in-advance-amount> <purchase-order-priority></purchase-order-priority> <shipping-method></shipping-method> <shipping-type></shipping-type> <shipping-type-suffix></shipping-type-suffix> <shipping-form></shipping-form> <edp-franking></edp-franking> <date-of-purchase-order></date-of-purchase-order> <client-has-money></client-has-money> <option></option> <variable-code1></variable-code1> <variable-code2></variable-code2> <purchase-order-info></purchase-order-info> <purchase-order-uuid></purchase-order-uuid> <solvency-check-transaction-guid></solvency-check-transaction-guid> <authorisation-transaction-guid></authorisation-transaction-guid> <epayment-transaction-guid></epayment-transaction-guid> <preliminary-cancellation-code></preliminary-cancellation-code> <preliminary-spot-id></preliminary-spot-id> <preliminary-purchase-order-source></preliminary-purchase-order-source> <sales-organization></sales-organization> <!-- up to 0 .. n purchase-order addtions --> <purchase-order-addition> <purchase-order-addition-text></purchase-order-addition-text> <purchase-order-addition-purpose></purchase-order-addition-purpose> </purchase-order-addition> <!-- 1. Possiblity (see Notes) --> <!-- at least 1, up to 2 --> <purchase-order-to-business-partner-relation> <bp-reference></bp-reference> <role> <role-type></role-type> </role> </purchase-order-to-business-partner-relation> <business-partner id=""> ... </business-partner> <!-- 2. Possiblity (see Notes) --> <!-- at least 1, up to 2 --> <business-partner role-type=""> ... </business-partner> <!-- at least 1, up to 99 --> <item> </item> </purchase-order> Element Definitions Field KeyLengthTypeRemark, field supply or encoding purchase-order-number 7 N VHS/3 order number (optional) purchase-order-source P 10 AN Purchase-order-source (Coded field; content is declared by the department) payment-type1 payment-type2 payment-type3P 2 2 2AN Payment type max. 3 external payment types at the same time. For example cash, check, CC, invoice (Coded field; content is declared by the department) payment-method 3 AN Payment method shipping-cost-code 4 AN Shipping cost code (Coded field; content is declared by the department) shipping-cost 7,2 N Shipping costs usually no entry insurance-code 4 AN Insurance code (Coded field; content is declared by the department) insurance-amount 7,2 N Insurance amount debit-account-number 19 AN Account number of debit. debit-bank-code 12 AN Bank code of debit debit-country-code 3 AN Country code of debit (Default: CarCode) Methods with version 2.0.0 or higher support also ISO country codes. In that case the attribute “code-type” is mandatory and have to be filled with “iso”. debit-country-code → attribute cody-type 3 AN iso - country code as ISO country code car - country code as international car code (default) debit-account-holder 50 AN Account holder of debit debit-continuous 1 AN Continuous Debit J = Yes Y = Yes (methods with version 2.0.0 or higher) N = No, only once iban 34 AN IBAN bic 11 AN BIC deposit-number 20 AN Deposit number cc-number 19 AN CC Number cc-checksum 4 AN CC check number This number is found on the field for the signature cc-company 4 AN CC-company (Coded field; content is declared by the department) cc-holder 50 AN CC holder cc-expiry 6 N CC expiry YYYYMM cc-startdate 6 N CC startdate YYYYMM cc-issuenumber 2 AN CC issue number cc-type 3 AN CC type price-list 4 AN Price List (Coded field; content is declared by the department) extra-pay-discount-of-item * extra-pay-discount-list 4 AN Surcharge / Discount of item: Surcharge / Discount list (Coded field; content is declared by the department) * extra-pay-discount-rate 2,2 N Surcharge / Discount rate (percentage) If discount, sign is minus Planned but not available yet! * extra-pay-discount-amount 7,2 N Surcharge / Discount amount If discount, sign is minus Planned but not available yet! extra-pay-discount-of-purchase-order 0 … 5 * extra-pay-discount-list 4 AN Surcharge / Discount of purchase order: Surcharge / Discount list (max. 5) (Coded field; content is declared by the department) extra-pay-discount-of-purchase-order-rate 2,2 N Surcharge / Discount rate of purchase order (percentage) If discount, sign is minus Use only after appropval of VHS/3 team. extra-pay-discount-of-purchase-order-amount 7,2 N Surcharge / Discount amount of purchase order If discount, sign is minus Use only after appropval of VHS/3 team. credit-limit-check 1 AN Credit limit check (Coded field; content is declared by the department) maximum-purchase-order-value-check 1 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) minimum-purchase-order-value-check 1 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).) gift-parcel 1 AN Gift parcel tag J = gift Y = gift (methods with Version 2.0.0 or higher) N = no gift ‘ ‘ = no declaration (no gift) part-deliveries 1 AN Number of deliveries Values: 0 = unbounded 1 – 9 = according to customer wish ‘ ‘ = no entry (default value) purchase-order-category 4 AN Purchase order category classifies order (e.g. 24h delivery) (Coded field; content is declared by the department) series-code 4 AN Code for Sequence and Series processing. purchase-order-id 10 AN Purchase order ID Reference to an external purchase order number correspondence-language-code 3 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 ) date-of-delivery 8 N Date of delivery Format YYYYMMTT or Format YYYY-MM-TT (methods with version 2.0.0 or higher) cash-hand-in-later 4 AN Cash hand in later (Coded field; content is declared by the department) cheque-code 7 AN Cheque code cheque-number 15 AN Cheque number cheque-account-number 19 AN Cheque account number cheque-bank-code 12 AN Cheque bank code cheque-country-code 3 AN Cheque country code Methods with version 2.0.0 or higher support also ISO country codes. In that case the attribute “code-type” is mandatory and have to be filled with “iso”. cheque-country-code→ attribute cody-type 3 AN iso - country code as ISO country code car - country code as international car code (default) cheque-bank-name 44 AN Cheque bank name cheque-account-holder 30 AN Cheque account holder cheque-type 2 AN Cheque type (Coded field; content is declared by the department) cheque-currency-code 3 AN Cheque currency (Coded field; content is declared by the department) cheque-amount 9,2 N Cheque amount cash-currency-code 3 AN Cash currency code (Coded field; content is declared by the department) cash-amount 9,2 N Cash amount cash-in-advance-currency-code 3 AN Cash in advance currency code (Coded field; content is declared by the department) cash-in-advance-amount 9,2 N Cash in advance amount purchase-order-priority 2 AN Purchase order priority Controls the processing of the purchase order (Coded field; content is declared by the department) shipping-method 2 AN Shipping method (Coded field; content is declared by the department) 00 = determined automatically by Back Office shipping-type 2 AN Shipping type (Reference to shipping method) (Coded field; content is declared by the department) 00 = determined automatically by Back Office shipping-type-suffix 2 AN Shipping type suffix empty shipping-form 2 AN Shipping form 00 = no declaration 01 = C. O. D. edp-franking 1 AN Edp-franking J = edp-franking Y = edp-franking(methods with Version 2.0.0 or higher) N = no edp-franking ‘ ‘ = no entry (default value) date-of-purchase-order 8 N Date-of-purchase-order Format YYYYMMTT or Format YYYY-MM-TT (methods with version 2.0.0 or higher) client-has-money 9,2 N Client has the money option 6 AN Option processing-type 1 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 variable-code1 10 AN Field for variable data variable-code2 20 AN Field for variable data purchase-order-info 50 AN Purchase Order Information purchase-order-uuid 36 AN An alternative ID for the purchase-order. This ID is only applicable in the input buffer. solvency-check-transaction-guid 36 AN Transactions-ID of the solvency check. This is replied when the online solvency-check is called and must be given again as a parameter when a new purchase-order is transmitted which has already been checked. authorisation-transaction-guid 36 AN Transactions-ID of the authorisation. This is replied in the response element “cc-dsb-transaction-id” when the online authorisation or a nother CardTransactionProcessing request is called and must be given again as a parameter when a new purchase-order is transmitted which has already been authorised. epayment-transaction-guid 36 AN Transaction-ID of a E-Payment transaction as a GUID, which is returned after call of the notify-service within the response element “dsb-transaction-id”(see: “WSI Commons - E-Payment documentation). This ID has to set to this field in the puchase-order. preliminary-cancellation-code 4 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. preliminary-spot-id 12 N do not use / only for internal use preliminary-purchase-order-source 10 N do not use / only for internal use sales-organization 4 AN sales organization (only internal use by SingleSales / AvsToVhs integration) purchase-order-addition 0 … n * purchase-order-addition-text 50 AN Text of the purchase-order addition * purchase-order-addition-purpose 6 AN Code of the purpose of the purchase-order addition. purchase-order-to-business-partner-relation * bp-reference n. a. AN Reference to a business-partner. This matches the ID-Attribute of a business-partner element. Please to not mix up this with the role-type attribute, which describes the role of a business-partner but does not identify it. * role → role-type 2 AN Role which has the business-partner according to the purchase-order. AG = Invoice Address (and deliver address, if the same) WE = differing delivery address business-partner n. a. xml Business Partner see s-ection 3.22. item n. a. xml purchase order item see section Bestellpositionen siehe Abschnitt 3.23. Important note: There are 2 possibilities to create a new purchase-order: As business-partner with relation-attributes This possibility has to be used if the client is customized for the integrated use of VHS/3 and AVS/3 and supports extended description of the relationship of a business-partner and a purchase order. As business-partner without relation-attributes This possibility has to be used if the client is customized for the integrated use of VHS/3 and AVS/3 and does not support the extended description of the relationship of a business-partner and a purchase order. Structure <business-partner> <business-partner id="" role-type=""> <salutation-code/> <prefix/> <titel-code-academic/> <titel-academic/> <titel-code-royal/> <titel-royal/> <job-titel/> <last-name1/> <last-name2/> <first-name/> <street/> <street-suffix/> <street-number/> <street-number-suffix/> <address-line-1/> <address-line-2/> <address-line-3/> <zipcode/> <country-code code-type=""/> <city/> <district/> <region-code/> <region-text/> <company1/> <company2/> <company3/> <department/> <po-box/> <po-box-zipcode/> <po-box-city/> <po-box-country-code code-type=""/> <major-customer-zipcode/> <address-source/> <advertisement/> <category/> <bp-number/> <bp-number-external/> <bp-group/> <eu-sales-tax-number/> <date-of-birth/> <postal-check/> <purge-check/> <dublicate-check/> <block/> <block-reason/> <intercompany /> <bic-master-number/> <sector/> <communication> <communication-type/> <communication-value/> </communication> <attribute> <attribute-type/> <attribute-value/> </attribute> <debit-account> <debit-account-number/> <debit-bank-code/> <debit-country-code code-type=""/> <debit-account-holder/> <debit-continuous/> <iban/> <bic/> </debit-account> <cc-account> <cc-number/> <cc-checksum/> <cc-company-code/> <cc-holder/> <cc-expiry/> <cc-startdate/> <cc-issuenumber/> <cc-type/> </cc-account> <avs-attributes> <sales-organization/> <distribution-channel/> <division/> </avs-attributes> <vhs-attributes> <client/> <service-provider/> </vhs-attributes> </business-partner> Element Definitions The field length in brackets are valid for VHS/3 standalone. VHS/3 supports longer values in several fields. Field NameKeyLengthTypeRemark, field supply or encoding Attribute: id n. a. AN Unambiguous ID (e. g. GUID) of this business-partner within the XML document. This ID is necessary to build a relation between the purchase order and the business-partner. Please do not mix up this attribute with the role-type attribute which describes the role of a business-partner merely. See also element “bp-reference” in the XML structure “purchase-order” in section 3.22. Attribute: role-type 2 AN Role of the business-partner in relation to the purchase-order AG = Invoice address WE = Delivery address (if different from invoice address) This attribute is the simplified possibility to describe the relation. It can be used if there is no need for the extended possibilities of “purchase-order-to-business-partner-relation”. salutation-code 2 AN Salutation 01 = Mr 02 = Ms 04 = Comapny 99 = unknown (Coded field; content is declared by the department) titel-code-academic 4 AN Academic title (Coded field; content is declared by the department) titel-academic 15 (30)AN Academic title in plain text titel-code-royal 4 AN nobility title titel-royal 15 (30) AN Nobility title in plain text VHS/3-Standalone supports length of 30 job-titel 35 AN job title last-name1 40 (50)AN last name 1 last-name2 40 (50)AN last name 2 first-name 40 (30)AN first name street 50 AN street street-suffix 40 AN street-suffix street-number 10 AN street or house number street-number-suffix 10 AN street or house number suffix address-line-1 35 AN address line 1 for UK addresses address-line-2 35 AN address line 2 for UK addresses address-line-3 35 AN address line 3 for UK addresses zipcode 10 AN zipcode or postcode country-code 2 AN country code (ISO country code) country-code → Attribute code-type 3 AN iso - country code as ISO country code (default) car - country code as international car code city 40 AN city district 40 (50)AN district region-code 3 AN region-code (Coded field; content is declared by the department) region-text 25 AN region as plain text (e. g. county, federal state, …) company1 40 AN company line 1 company2 40 AN company line 2 company3 40 AN company line 3 department 30 AN department po-box 10 AN postoffce-box po-box-zipcode 10 AN zipcode or postcode of the postoffce-box po-box-city 40 AN city of the postoffce-box (not supported by VHS/3) po-box-country-code 2 AN country code of postoffce-box (ISO country code) (not supported by VHS/3) major-customer-zipcode 10 AN zipcode of a customer with an own zipcode address-source 10 AN address-source (Coded field; content is declared by the department) The customizing has to be done in AVS/3. advertisement 1 AN Advertisement allowed (only available in integrated mode) Y = Yes N = No category 2 AN address category (only for VHS/3) bp-number 10 AN Optional, the business-partner number of a known customer. bp-number-external 20 AN Business-partner number of an external system. bp-group 4 AN Business-partner group (Coded field; content is declared by the department) The customizing has to be done in AVS/3. eu-sales-tax-number 14 AN Tax Identity number of the EU date-of-birth 10 N date of birth Format: YYYY-MM-DD postal-check 1 AN Postal check of the business-partner Y = Yes N = No <no value> = (Customized default value) purge-check 1 AN Purge check of the business-partner dublicate-check 1 AN dublicate check of the business-partner block 1 AN Block flag of the business partner Y = Yes N = No block-reason 2 AN Reason of the block. intercompany 1 AN Y/N section 10 AN Branch This element is only in case of single sales integration available communication * communication-type P 2 AN Communication Types * communcation-value P 50 AN Value of the communication type attribute * attribute-type P 6 > AN> Business-Partner attribute type The customizing has to be done in AVS/3. * attribute-value P 50 AN Value of the business-partner attribute. debit-account * debit-account-number P 18 AN Debit account number. * debit-bank-code P 12 AN Bank code * debit-country-code P 2 AN country code of the bank (international ISO Code) * debit-account-holder P 50 AN Name of the account holder * debit-continous 1 AN One time debit or direct debit authorization. Y = direct debit authorization N = One time debit cc-account * cc-number P 19 AN CC number * cc-checksum 4 AN CC checknumber Only for the purpose of solvency checks but not stored. * cc-company-code P 4 AN CC company * cc-holder P 40 AN CC holder * cc-expiry P 6 N CC expiry (Format YYYYMM) * cc-startdate 6 N CC startdate (Format YYYYMM) * cc-issuenumber 3 AN CC Issue number * cc-type 2 AN CC Type avs-attributes * sales-organization 4 AN> Sales-organization in AVS/3 * distribution-channel 2 AN> Distribution-channel in AVS/3 * division 2 AN Divisionin AVS/3 vhs-attributes * client 4 AN Client number in VHS/3 * service-provider 3 AN Service-provider in VHS/3 Structure <item> (request) <item> <distribution-article-number></distribution-article-number> <distribution-article-number-external></distribution-article-number-external> <purchase-order-quantity></purchase-order-quantity> <pos-number></pos-number> <price></price> <price-unit></price-unit> <free-of-charge></free-of-charge> <extra-pay-discount-list></extra-pay-discount-list> <extra-pay-discount-rate></extra-pay-discount-rate> <extra-pay-discount-amount></extra-pay-discount-amount> <shipping-method></shipping-method> <shipping-type></shipping-type> <shipping-form></shipping-form> <shipping-cost-of-item></shipping-cost-of-item> <wrapping-paper-code></wrapping-paper-code> <!—-up to 30 item additions --> <item-addition> <item-addition-text></item-addition-text> <item-addition-purpose></item-addition-purpose> </item-addition> </item> Element Definitions Field NameKeyLengthTypeRemark, field supply or encoding distribution-article-number P 13 AN Distribution article number / Sales article number distribution-article-number-external 20 AN external distribution article number / Sales article number purchase-order-quantity P 5,2 N Purchase order quantity pos-number 19 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 7,2 N Price (Single price or special price) price-unit P 2 N Price unit free-of-charge P 1 AN Free of charge tag N, ‘ ‘ = not free of charge J = free of charge extra-pay-discount-list 4 AN Surcharge / Discount Surcharge / Discount list (Coded field; content is declared by the department) extra-pay-discount-rate 2,2 N Surcharge / Discount rate (percentage) If discount, sign is minus extra-pay-discount-amount 7,2 N Surcharge / Discount amount If discount, sign is minus shipping-method shipping-type shipping-form 2 2 2AN AN ANExtra shipping of article (Coded field; content is declared by the department) usually empty Shipping method Shipping type Shipping form shipping-cost-of-item 7,2 N Shipping costs of the item wrapping-paper-code 2 AN Assignment of the gift wrap item-addition 0…30 * item-addition → item-addition-text 72 AN Line with additional information to the item * item-addition → item-addition-purpose 1 AN Purpose of the additional information G = greeting text P = points (max. 1 entity) S = shipment-id (max. 1 entity) B = bundle identifier This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.OKMore information