Table of Contents getByOrderAttribute Field mapping to VIS Field mapping in VIS getByOrderAttribute BETA This method returns a list of max. 100 orders, which have been included the requested attribute / value combination. Object: /net/dsb/vhs3/PurchaseOrder Method: getByOrderAttribute Version: 2.0.0 Parameter Name Type / Lenght Opt. / Mandat Description purchase-orderaddition-text AN /50M Text of the order attribute purchase-orderaddition-purposeAN / 6 M Code of the order attribute service-provider AN / 3 K Select only the purchase-orders of a certain service-provider. Response Element XML fragment(s) 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-addition> <purchase-order-addition-text>Testbestellung</purchase-order-addition-text> <purchase-order-addition-purpose>AGXA</purchase-order-addition-purpose> </purchase-order-addition> </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> (Response) The following image shows the parts of a purchase-order and the relation between them. <purchase-order> <purchase-order-number>12345</purchase-order-number> <purchase-order-id></purchase-order-id> <correspondence-language-code></correspondence-language-code> <service-provider></service-provider> <purchase-order-category></purchase-order-category> <date-of-purchase-order-client></date-of-purchase-order-client> <date-of-purchase-order-system></date-of-purchase-order-system> <date-of-delivery></date-of-delivery> <purchase-order-state> </purchase-order-state> <purchase-order-source> </purchase-order-source> <purchase-order-source-group></purchase-order-source-group> <currency-code></currency-code> <value-all-inclusive-brutto></value-all-inclusive-brutto> <value-all-inclusive-netto></value-all-inclusive-netto> <value-brutto></value-brutto> <value-netto></value-netto> <payment-type-preliminary></payment-type-preliminary> <payment-type-preliminary-2></payment-type-preliminary-2> <payment-type-preliminary-3></payment-type-preliminary-3> <payment-type-corrected></payment-type-corrected> <series-code></series-code> <free-of-charge-tag></free-of-charge-tag> <parcel-quantity></parcel-quantity> <variable-code1></variable-code1> <variable-code2></variable-code2> <client-has-money></client-has-money> <scan-status></scan-status> <timestamp-of-last-modification></timestamp-of-last-modification> <purchase-order-info></purchase-order-info> <purchase-order-rejection></purchase-order-rejection> <!-- 0 .. n purchase-order additions --> <purchase-order-addition> <purchase-order-addition-text></purchase-order-addition-text> <purchase-order-addition-purpose></purchase-order-addition-purpose> </purchase-order-addition> <!—- 1 to 2 business-partner addresses --> <business-partner-address type="" role-type=""> </business-partner-address> <!—- 0 to n items --> <item> </item> <!—- 0 to n reminder --> <reminder> </reminder> <return-procedure></return-procedure> <!—- 0 to n returns --> <return> </return> <!—- 0 to n invoice --> <invoice> </invoice> </purchase-order> Element Definitions Field Key LengthTypeRemark, field supply or encoding purchase-order-number 7 N Order number (VHS/3) purchase-order-id 10 AN Order identification or external order number correspondence-language-code 3 AN Language code for correspondence service-provider 3 AN Id of the service-provider. purchase-order-category 4 AN Order type (Look at Code tables) date-of-purchase-order-client 8 N Order date (client) date-of-purchase-order-system 8 N Order date (system) date-of-delivery 8 N Delivery date purchase-order-state 2 AN Order status (Look at Code tables) purchase-order-source 10 AN Order source (Contents declared by the department) purchase-order-source-group 4 AN Order source group (Contents declared by the department) currency-code 3 AN Currency value-all-inclusive-brutto 9,2 N Order value (all inclusive) gross value-all-inclusive-netto 9,2 N Order value (all inclusive) net value-brutto 9,2 N Order value gross value-netto 9,2 N Order value net payment-type-preliminary 2 AN Preliminary payment type (customer payment type) payment-type-preliminary-2 2 AN Preliminary payment type 2 (customer payment type) payment-type-preliminary-3 2 AN Preliminary payment type 3 (customer payment type) payment-type-corrected 2 AN Corrected Payment Type series-code 4 AN Code for Sequence / Series deliveries (look at Code tables) free-of-charge-tag 1 AN Free of charge tag. parcel-quantity 3 N Number of packages in the order variable-code1 10 AN Field for variable Information variable-code2 20 AN Field for variable Information client-has-money 13 AN Amount collection(+999999999,99) scan-status 2 AN scanstatus timestamp-of-last-modification 19 D Timestamp of last order modification Format\\ YYYY-MM-DD HH:MM:SS purchase-order-info 50 AN Purchase Order Information purchase-order-rejection 4 AN The reason for the purchase order rejection purchase-order-addition purchase-order-addition-text 50 AN Text of purchase order addition purchase-order-addition-purpose 6 AN Code of purchase order addition business-partner-address n.a. n.a.see below items n.a. n.a.see below reminder n.a. n.a.see below return n.a. n.a.see below invoice n.a. n.a.see below Field mapping to VIS XML-Element Table and Field in VIS purchase-order-number V_AUF.A_AUF_NR purchase-order-id V_AUF.A_ID_INT service-provider V_AUF.A_QUELLE purchase-order-category V_AUF.A_ART date-of-purchase-order-client V_AUF.A_AUFDAT date-of-purchase-order-system V_AUF.A_NEU_DAT date-of-delivery V_AUF.A_LIEFDAT purchase-order-state V_AUF.A_STATUS purchase-order-source V_AUF.A_BQ purchase-order-source-group V_AUF.A_BQ_GRP currency-code V_AUF.A_WAEHR value-all-inclusive-brutto V_AUF.A_WERT_AIB value-all-inclusive-netto V_AUF.A_WERT_AIN value-brutto V_AUF.A_WERT_VKB value-netto V_AUF.A_WERT_VKN payment-type-preliminary V_AUF.A_ZAHLART_K payment-type-preliminary-2 V_AUF.A_ZAHLART_K2 payment-type-preliminary-3 V_AUF.A_ZAHLART_K3 payment-type-corrected V_AUF.A_V_ZAHLART series-tag V_AUF.A_RL_SL_K free-of-charge-tag V_AUF.A_KE_KOSTENL parcel-quantity V_OP.O_ANZ_PKT variable-code1 V_AUF.A_VARK_01 variable-code2 V_AUF.A_VARK_02 client-has-money V_AUF.A_GEIN_MAND scan-status V_AUF.A_SCAN_STATUS timestamp-of-last-modification V_AUF.A_MOD_DZ purchase-order-info V_AUF_TEXT.AT_TEXT purchase-order-rejection V_AUF.A_ABWEISUNG purchase-order-addition-text V_AUF_MERK.AM_WERT purchase-order-addition-purposeV_ AUF_MERK.AM_CODE Structure <business-partner-address> <business-partner-address> <bp-number></bp-number> <last-name1></last-name1> <last-name2></last-name2> <first-name></first-name> <titel></titel> <company1></company1> <company2></company2> <company3></company3> <salutation-code></salutation-code> <country-code></country-code> <street></street> <street-suffix></street-suffix> <street-number></street-number> <street-number-suffix></street-number-suffix> <zipcode></zipcode> <city></city> <district></district> <region-code></region-code> <po-box></po-box> <po-box-zipcode></po-box-zipcode> <po-box-city></po-box-city> <!-- 0 to n --> <communication type=""> </communication> </business-partner-address> Element Definitions The business-partner- address contains almost the same fields as a business-partner but without the customer details. Therefore, the fields are not explained in this section. Please look at the element definitions of business-partner for further details. Only the extended elements are described here. XML-Element Table and Field in VIS Attribute: type 02 = invoice address 06 = delivery address If no delivery address is given, the address of the type 02 is the invoice and delivery address. The address type is indicated only in the context of a purchase order, because it only has a meaning there. Attribute: role-typeDepends on attribute „type“. Possible values are either AG(customer) or WE(consignee) Structure <item> <item> <pos-number></pos-number> <pos-sub-number></pos-sub-number> <distribution-article-number></distribution-article-number> <distribution-article-number-external></distribution-article-number-external> <distribution-article-description1></distribution-article-description1> <distribution-article-description2></distribution-article-description2> <distribution-article-ean></distribution-article-ean> <article-type></article-type> <object-number></object-number> <date-of-release-invoice></date-of-release-invoice> <width></width> <length></length> <purchase-order-quantity></purchase-order-quantity> <quantity-delivered></quantity-delivered> <sales-price-brutto></sales-price-brutto> <sales-price-brutto-total></sales-price-brutto-total> <sales-price-netto></sales-price-netto> <sales-price-netto-total></sales-price-netto-total> <extra-pay-discount-rate></extra-pay-discount-rate> <extra-pay-discount-amount></extra-pay-discount-amount> <extra-pay-discount-amount-total></extra-pay-discount-amount-total> <delivery-code></delivery-code> <set-code></set-code> <supplement-tag></supplement-tag> <special-price-tag></special-price-tag> <normal-price-tag></normal-price-tag> <free-of-charge-tag></free-of-charge-tag> <extra-pay-discount-tag></extra-pay-discount-tag> <cancellation-tag></cancellation-tag> <substitute-tag></ substitute-tag> <delivery-state></delivery-state> <invoice-number></invoice-number> <invoice-type></invoice-type> <date-of-purchase-order-client></date-of-purchase-order-client> <date-of-purchase-order-system></date-of-purchase-order-system> <date-of-invoice></date-of-invoice> <date-of-backlog></date-of-backlog> <scan-status></scan-status> <timestamp-of-last-modification></timestamp-of-last-modification> <package-info> <consignment-number></consignment-number> <package-number></package-number> <receipt-number></receipt-number> <receipt-type></receipt-type> <cut></cut> <leading-code></leading-code> <track-status></track-status> <track-status-date></track-status-date> <track-depot-number></track-depot-number> <delivery-date></delivery-date> <vers-weg></vers-weg> <scan-status></scan-status> <scan-status-date></scan-status-date> </package-info> <!—- up to 30 item additions --> <item-addition> <item-addition-text></item-addition-text> <item-addition-purpose></item-addition-purpose> </item-addition> </item> Element Definitions Important note: The field length in brackets are valid for VHS/3 standalone. VHS/3 supports longer values in several fields. Field NameLengthTypeRemark, field supply or encoding pos-number 3 (19)N Position Number of the VHS/3 or external position number if it was supplied. pos-sub-number 2 N Sub number of the position. This number indicates the parts of a set with a unique number starting from 1 .. N. If this number is 0 it is a “normal” position. distribution-article-number 13 AN Article number (Distribution Article) distribution-article-number-external 20 AN External Article number (Distribution Article) distribution-article-description1 35 AN Article description 1 distribution-article-description2 35 AN Article description 2 distribution-article-ean 13 AN International Article Number (former European Article Number) article-type AN article type object-number AN object number date-of-release-invoice 8 N Release date of the article width 7 AN Width length 7 AN Length purchase-order-quantity 5,2 N Order quantity quantity-delivered 5,2 N Quantity delivery sales-price-brutto 9,2 N Single selling price gross sales-price-brutto-total 9,2 N Position value gross sales-price-netto 9,2 N Single selling price net sales-price-netto-total 9,2 N Position value net extra-pay-discount-rate 2,2 N Extra-pay / Discount rate extra-pay-discount-amount 7,2 N Extra-pay / Discount value extra-pay-discount-amount-total 7,2 N Total Extra-pay / Discount value delivery-code 2 AN Delivery code set-code 1 AN SET code supplement-tag 1 AN Supplement Tag X = Supplement special-price-tag 1 AN Special price tag X = special price normal-price-tag 1 AN Normal price tag X = Normal price free-of-charge 1 AN Free of charge tag X = free extra-pay-discount-tag Surcharge / Discount tag X = Surcharge / Discount cancellation-tag 1 AN Cancellation Tag X = Position was cancelled (invoice cancellation) substitute-tag 1 AN Substitute Tag X = Position is a substitute delivery-state 2 AN Delivery state (Look at Code tables) invoice-number 8 N Invoice number invoice-type 1 AN Invoice type date-of-purchase-order-client 8 N Order date (client) Format YYYYMMDD date-of-purchase-order-system 8 N Order date (system) Format YYYYMMDD date-of-invoice 8 N Invoice date Format YYYYMMDD date-of-backlog 8 N Backlog date Format YYYYMMDD scan-status 2 AN scanstatus timestamp-of-last-modification 19 DT Zeitstempel der letzten Positionsänderung im Format YYYY-MM-DD HH:MM:SS package-info * consignment-number 13 AN consignment number * package-number 8 N package number (internal) * receipt-number 10 AN receipt number * receipt-type 1 AN receipt type * cut 3 N cut * leading-code 14 AN Leading code * track-status 2 AN Tracking status * track-status-date 8 N Tracking status date (Format YYYYMMDD) * track-depot-number 3 AN Tracking depot number * delivery-date 8 N Delivery date (Format YYYYMMDD) * vers-weg 2 AN Delivery way * scan-status 2 AN Scan Status of delivery * scan-status-date 8 N Date of scan item-addition 0 … 30 * item-addition-text 72 AN Line with additional information to the item * 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 Field mapping in VIS XML-Element Table and Field in VIS pos-number V_POS.P_POS_NR pos-sub-number V_POS.P_POS_U_NR distribution-article-number V_POS.P_VART_NR distribution-article-number-description1M_VAR.VAR_ARTBEZ1 distribution-article-number-description2M_VAR.VAR_ARTBEZ2 distribution-article-ean M_VAR.VAR_VTR_EAN date-of-release-invoice M_VAR.VAR_VOE_DATUM width M_VAR.VAR_MASS_WEITE length M_VAR.VAR_MASS_LAENGE purchase-order-quantity V_POS.P_BEST_ME quantity-delivered V_POS.P_LIEF_ME sales-price-brutto V_POS.P_VKB sales-price-brutto-total V_POS.P_WERT_VKB sales-price-netto V_POS.P_VKN sales-price-netto-total V_POS.P_WERT_VKN extra-pay-discount-rate V_POS.P_ZUAB_PROZ extra-pay-discount-amount V_POS.P_ZUAB_WERT extra-pay-discount-amount-total V_POS.P_ZUAB_WERT_AE delivery-code V_POS.P_KE_LIEFER set-code V_POS.P_KE_SET supplement-tag V_POS.P_KE_BEILAGE special-price-tag V_POS.P_KE_P_SONDER normal-price-tag V_POS.P_KE_P_NORMAL free-of-charge-tag V_POS.P_KE_P_KOSTENL extra-pay-discount-tag V_POS.P_KE_P_ZUAB cancellation-tag V_POS.P_KE_STORNO delivery-state V_POS.P_STATUS invoice-number V_POS.P_REC_NR invoice-type V_OP.O_REC_ART date-of-purchase-order-client V_POS.P_AUFDAT date-of-purchase-order-system V_POS.P_NEU_DAT date-of-invoice V_POS.P_RECDAT date-of-backlog V_POS.P_RUEDAT scan-status V_POS.P_SCAN_STATUS timestamp-of-last-modification V_POS.P_MOD_DZ package-infoconsignment-number V_PKT_SEN.S_POST_ID resp. S_POST_ID_NEU (preferred) package-infopackage-number V_PKT_SEN.S_PKT_NR package-inforeceipt-number V_PKT_SEN.S_BEL_NR package-inforeceipt-type V_PKT_SEN.S_BEL_TYP package-infocut V_PKT_SEN.S_ZUSCHNITT package-infoleading-code V_PKT_SEN.S_POST_LC package-infotrack-status V_PKT_SEN.S_TRACK_STAT package-infotrack-status-date V_PKT_SEN.S_TRACK_STAT_DAT package-infotrack-depot-number V_PKT_SEN.S_TRACK_DEPT_NR package-infodelivery-date V_PKT_SEN.S_LIEFDAT package-infovers-weg V_PKT_SEN.S_VSWEG package-infoscan-status V_PKT_SEN.S_SCAN_STATUS package-infoscan-status-date V_PKT_SEN.S_SCAN_AUSL_DAT item-addition → item-additions-text V_POS_TEXT.PT_TEXT item-addition → item-additions-purpose V_POS_TEXT.PT_TEXT_KENNUNG Structure <reminder> <reminder> <invoice-number></invoice-number> <reminder-level></reminder-level> <date-of-reminder></date-of-reminder> <reminder-amount></reminder-amount> <reminder-charge></reminder-charge> </reminder> Element Definitions Field KeyLengthTypeRemark, field supply or encoding invoice-number 8 N Invoice number reminder-level 2 AN Reminder level (look at code tables) date-of-reminder 8 N Reminder date Format YYYYMMDD reminder-amount 9,2 AN Reminder amount reminder-charge 9,2 AN Reminder charges Field mapping to VIS XML-Element Table and Field in VIS invoice-number V_MAH.M_REC_NR reminder-level V_MAH.M_STUFE date-of-reminderV_MAH.M_DAT reminder-amount V_MAH.M_BETRAG reminder-charge V_MAH.M_GEB Structure <return> Version 1 <return-procedure></return-procedure> <return-processing-code></return-processing-code> <return-credit-amount-brutto></return-credit-amount-brutto> <return-credit-shipping-cost-brutto></return-credit-shipping-cost-brutto> <return> <pos-number></pos-number> <pos-sub-number></pos-sub-number> <distribution-article-number></distribution-article-number> <distribution-article-number-external></distribution-article-number-external> <distribution-article-description1></distribution-article-description1> <distribution-article-description2></distribution-article-description2> <date-of-return></date-of-return> <return-quantity></return-quantity> <return-reason-code></return-reason-code> </return> Structure <return> Version 2 <!-- return 0...n --> <return> <return-number></return-number> <return-procedure></return-procedure> <return-processing-code></return-processing-code> <return-credit-amount-brutto></return-credit-amount-brutto> <return-credit-shipping-cost-brutto></return-credit-shipping-cost-brutto> <return-reduction-amount>5.0</return-reduction-amount> <return-addition-amount>10.0</return-addition-amount> <return-status></return-status> <!-- return-pos 1...n --> <return-pos> <pos-number></pos-number> <pos-sub-number></pos-sub-number> <distribution-article-number></distribution-article-number> <distribution-article-number-external></distribution-article-number-external> <distribution-article-description1></distribution-article-description1> <distribution-article-description2></distribution-article-description2> <date-of-return></date-of-return> <return-quantity></return-quantity> <return-reason-code></return-reason-code> <price-per-unit></price-per-unit> <price-total-brutto></price-total-brutto> </return-pos> </return> Element Definitions Important note: The field length in brackets are valid for VHS/3 standalone. VHS/3 supports longer values in several fields. Field KeyLength TypeRemark, field supply or encoding return-number 10 N Number of the return return-procedure 1 AN Procedure part-/ full return return-processing-code 4 AN Bearbeitungs-Hinweis für Retouren return-credit-amount-brutto 9,2 N Credit for Returns (gross) return-credit-shipping-cost-brutto 7,2 N Credit for Returns p&p Costs (gross) return-reduction-amount 7,2 N Retouren Credit / Discount return-addition-amount 7,2 N Retouren Addition / Surcharge return-status 1 AN Returnstatus 2 = booked 3 = cancelled return-pos 1 … n * pos-number 3 (19)N Position Number of the VHS/3 or external position number if it was supplied. With this number you can identify the corresponding item-position. * pos-sub-number 2 N Sub number of the position. This number indicates the parts of a set with a unique number starting from 1 .. N. If this number is 0 it is a “normal” position. * distribution-article-number 13 AN Article number (distribution article) * distribution-article-number-external 20 AN External Article number (distribution article) * distribution-article-description1 35 AN Artikelbezeichnung 1 * distribution-article-description2 35 AN Artikelbezeichnung 2 * date-of-return 8 N Return date Format YYYYMMDD * return-quantity 5,2 N Return quantity * return-reason-code 2 AN Return reason (Content is declared by department) * price-per-unit 7,2 N Price per unit * price-total-brutto 7,2 N Price brutto Field mapping to VIS XML-Element Tables and Fields in VIS return-procedure V_RET_KOPF.RK_VORGANG return-processing-code V_RET_KOPF.RK_BEARB_VERT return-credit-amount-brutto V_RET_KOPF.RK_WERT_VKB return-credit-shipping-cost-brutto V_RET_KOPF.RK_KOR_VERSAK return-reduction-amount V_RET_KOPF.RK_KOR_AB return-addition-amount V_RET_KOPF.RK_KOR_ZU return-status V_RET_KOPF.RK_STATUS pos-number V_RET_POS.R_POS_NR pos-sub-number V_RET_POS.R_POS_U_NR distribution-article-number V_RET_POS.R_VART_NR distribution-article-number-description1M_VAR.VAR_ARTBEZ1 distribution-article-number-description2M_VAR.VAR_ARTBEZ2 date-of-return V_RET_POS.R_BDAT return-quantity V_RET_POS.R_RET_ME return-reason-code V_RET_POS.R_GRUND price-per-unit V_RET_POS.R_VKB price-total-brutto V_RET_POS.R_RETW_VKB Structure <invoice> <invoice> <invoice-number></invoice-number> <invoice-type></invoice-type> <date-of-invoice></date-of-invoice> <invoice-main-payment-type></invoice-main-payment-type> <invoice-value-brutto></invoice-value-brutto> <invoice-payment-amount></invoice-payment-amount> <shipping-cost></shipping-cost> <invoice-status></invoice-status> <balance></balance> <invoice-processing-status></invoice-processing-status> <order-extra-pay></order-extra-pay> <order-discount></order-discount> <payments-received-total></payments-received-total> <number-of-payments></number-of-payments> <date-of-last-payment></date-of-last-payment> <date-of-invoice-cancellation></date-of-invoice-cancellation> <number-of-debits></number-of-debits> <debit-amount-total></debit-amount-total> <debit-return-reason></debit-return-reason> </invoice> Element Definitions Field NameLengthTypeRemark, field supply or encoding invoice-number 8 N Invoice Number invoice-type 1 AN Invoice Type date-of-invoice 8 N Invoice Date invoice-main-payment-type 2 AN Main payment type of the invoice invoice-value-brutto 9,2 N Invoice Value gross invoice-payment-amount 9,2 N Payment Amount Invoice shipping-cost 7,2 N P&P (gross) invoice-status 1 AN Open Item Status balance 9,2 N Balance payments-received-total 9,2 N Payments received (total) number-ofpayments 2 N Number of Payments date-of-last-payment 8 N Last Payment Date invoice-processing-status 1 AN Open Item Processing Status date-of-invoice-cancellation 8 N Invoice Cancellation Date order-extra-pay 7,2 N Surcharge Order Header (gross) order-discount 7,2 N Discount Order Header (gross) number-of-debits 2 N Number of Debit Bookings (incl. Return Debit, CC Reclamation) debit-amount-total 9,2 AN Amount Debit Bookings Total debit-return-reason 4 AN Return Debit Reason invoice-number 8 N Invoice Number invoice-type 1 AN Invoice Date Field mapping to VIS XML-Element Table and Field in VIS invoice-number V_OP.O_REC_NR invoice-type V_OP.O_REC_ART date-of-invoice V_OP.O_RECDAT invoice-main-payment-type V_OP.O_H_ZAHLART invoice-value-brutto V_OP.O_WERT_VKB invoice-payment-amount V_OP.O_ZAHL_BETR shipping-cost V_OP.O_VERSAK_B invoice-status V_OP.O_STATUS balance V_OP.O_SALDO payments-received-total V_OP_FIBU_INFO.OPFI_ZE_BETR number-of-payments V_OP_FIBU_INFO.OPFI_ZE_ANZ date-of-last-payment V_OP_FIBU_INFO.OPFI_ZE_DAT_MAX invoice-processing-status V_OP.O_VERARB_STAT date-of-invoice-cancellationV_OP_FIBU_INFO.OPFI_DAT_STORNO order-extra-pay V_OP.O_ZU_B order-discount V_OP.O_AB_B number-of-debits V_OPFIBU_INFO.OPFI_LA_ANZ debit-amount-total V_OP_FIBU_INFO.OPFI_LA_BETRG debit-return-reason V_OP_FIBU_INFO.OPFI_RBLSZ_RBGRUND This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.OKMore information