createOrderDirect (Version 2) (for internal use only)

Object: /net/dsb/avs3/SubscriptionOrder
Method: createOrderDirect
Version: 2.0.0
Fuba: /DSB/ISM_E_KAPSELABOANLAGE

This method creates a subscription in the AVS/3 System. With this method you must implement the stack handling on client side. Therefore we recommend the use of createOrderBuffered.

At this point a vast number of parameters are possible which control the subscription which is created. Following items have to be observed:

A single order (Subscription) is going to be led with his elements within a subscription element.
The address data are put in a business-partner element. Per role (=function), that a business partner can have an address has to be created and a separate element of business-partner is created. For example for the orderer (Role ‚AG‘), for a drifting consignee (Role‚WE‘), for premium subscriptions for the procurer (Role ‚VM‘).
The role of the business partner can be transmitted over the structure subscription-to-business-partner-relationship as well as an attribute directly in the structure businesspartner. It is recommended to transmit the role over the structure business-partner.
For each premium a structure with the name premium has to be inserted.
It is important that all named elements which belong to a particular order are surrounded by the subscription element. Otherwise no definite allocation can take place.
A important field is BQ (source code) in the structure subscription. This value meets the promotion action number and different values can be left. So the deposited values are not transferred over the interface anymore but will be controlled at DSB.
Some fields are considered as constants (like for example field client in the Header). Allocation of these fields will be told to you.
The special sign ^ has in the subscription system a special meaning and should therefore not be used for the transferred data.

Parameter

Name	Type / max. length	mandatory?	Description
subscription	n.a.	m	XML-Fragment ‚subscription‘ see below

Response Element

XML-Fragment ‚subscription-response‘

Request Structure

Structure

<subscription>
  <promotion-source> </promotion-source>
  <promotion-source-variant> </promotion-source-variant>
  <sales-promotion> </sales-promotion>
  <advertising-level> </advertising-level>
  <offer-code> </offer-code>
  <publication> </publication>
  <edition> </edition>
  <mix-type> </mix-type>
  <purchase-frequency> </purchase-frequency>
  <delivery-type> </delivery-type>
  <quantity> </quantity>
  <sales-organization> </sales-organization>
  <sales-suborganization> </sales-suborganization>
  <sales-bureau> </sales-bureau>
  <distribution-channel> </distribution-channel>
  <division> </division>
  <customer-purchase-order-number> </customer-purchase-order-number>
  <customer-purchase-order-type> </customer-purchase-order-type>
  <customer-purchase-order-date> </customer-purchase-order-date>
  <valid-from> </valid-from>
  <valid-to> </valid-to>
  <issue-number-from> </issue-number-from>
  <issue-number-to> </issue-number-to>
  <archive-reference></archive-reference>
  <payment-method> </payment-method>
  <payment-method-details>
    <!-- entweder 'payment-method-cheque' -->
    <payment-method-cheque>
      <cheque-bank-clearing-account></cheque-bank-clearing-account>
      <cheque-number></cheque-number>
      <cheque-amount></cheque-amount>
      <cheque-currency-code></cheque-currency-code>
      <cheque-bank-code></cheque-bank-code>
      <cheque-bank-control-key></cheque-bank-control-key>
      <cheque-bank-country-code></cheque-bank-country-code>
      <cheque-bank-account-number></cheque-bank-account-number>
      <cheque-holder></cheque-holder>
    </payment-method-cheque>
    <!-- oder 'payment-method-other' -->
    <payment-method-other>
      <other-bank-clearing-account></other-bank-clearing-account>
      <other-amount></other-amount>
      <other-currency-code></other-currency-code>
      <other-payee-note></other-payee-note>
    </payment-method-other>
  </payment-method-details>
  <total-paid-currency-code></total-paid-currency-code>
  <total-paid-amount></total-paid-amount>
  <wallet-part-payment-amount></wallet-part-payment-amount>
  <extra-pay-discount>
    <currency-code></currency-code>
    <discount></discount>
  </extra-pay-discount>
  <extra-pay-voucher>     
    <bank-clearing-account></bank-clearing-account>
    <amount></amount>
    <currency-code></currency-code>
    <payee-note></payee-note>
  </extra-pay-voucher>
  <print-invoice> </print-invoice>
  <purchase-reason> </purchase-reason>
  <delivery-end-reason> </delivery-end-reason>
  <billing-from> </billing-from>
  <issue-billing-from> </issue-billing-from>
  <currency-code></currency-code>
  <price-list-type> </price-list-type>
  <fixed-price-list-and-currency-code>Y</fixed-price-list-and-currency-code>
  <debit-account>
    <debit-account-id></debit-account-id>
    <debit-bank-code> </debit-bank-code>
    <debit-country-code> </debit-country-code>
    <debit-account-number> </debit-account-number>
    <debit-account-holder> </debit-account-holder>
    <debit-continuous> </debit-continuous>
    <debit-due-date> </debit-due-date>
    <iban></iban>
    <bic></bic>
  </debit-account>
  <cc-account>
    <cc-account-id></cc-account-id>
    <cc-company-code> </cc-company-code>
    <cc-number> </cc-number>
    <cc-expiry> </cc-expiry>
  </cc-account>
  <sepa-mandate>
    <creation-type></creation-type>
    <transaction-type></transaction-type>
    <details>
      <b2b-mandate></b2b-mandate>
      <mandate-ref-pre-creditor></mandate-ref-pre-creditor>
      <previous-creditor-id></previous-creditor-id>
      <previous-bic></previous-bic>
      <last-due-date></last-due-date>
    </details>
  </sepa-mandate>
  <price-key-in-trialterm> </price-key-in-trialterm>
  <billing-frequency-in-trialterm> </billing-frequency-in-trialterm>
  <price-group-in-trialterm> </price-group-in-trialterm>
  <duration-in-trialterm></duration-in-trialterm>
  <unit-in-trialterm></unit-in-trialterm>
  <price-key-in-normalterm1> </price-key-in-normalterm1>
  <billing-frequency-in-normalterm1> </billing-frequency-in-normalterm1>
  <price-group-in-normalterm1> </price-group-in-normalterm1>
  <duration-in-normalterm1></duration-in-normalterm1>
  <unit-in-normalterm1></unit-in-normalterm1>
  <price-key> </price-key>
  <billing-frequency> </billing-frequency>
  <price-group> </price-group>
  <duration> </duration>
  <unit> </unit>
  <postage-key> </postage-key>
  <dsb-media1> </dsb-media1>
  <dsb-media2> </dsb-media2>
  <dsb-media3> </dsb-media3>
  <dsb-media4> </dsb-media4>
  <dsb-media2b> </dsb-media2b>
  <dsb-media7> </dsb-media7>
  <rule-id> </rule-id>
  <external-order-number></external-order-number>
  <input-office> </input-office>
  <input-date> </input-date>
  <input-user> </input-user>
  <stack-name></stack-name>
  <save-in-system> </save-in-system>
  <post-at-once> </post-at-once>
  <skip-doi-process>false</skip-doi-process>
  <adjust-upper-and-lower-case> </adjust-upper-and-lower-case>
  <order-rating></order-rating>
  <stack-lock-code></stack-lock-code>
  <agent-number> </agent-number>
  <agent-organisation> </agent-organisation>
  <cost-center> </cost-center>
  <matriculated> </matriculated>
  <matriculated-to> </matriculated-to>
  <advance-billing>false</advance-billing>
  <previously-billed-to> </previously-billed-to>
  <issue-previously-billed-to> </issue-previously-billed-to>
  <delivery-start-statistical> </delivery-start-statistical>
  <issue-delivery-start-statistical> </issue-delivery-start-statistical>
  <dispatch-type> </dispatch-type>
  <dispatch-text> </dispatch-text>
  <ivw-group> </ivw-group>
  <statistic-group> </statistic-group>
  <dsb-trx-id-for-ctp> </dsb-trx-id-for-ctp>
  <dsb-trx-id-for-epayment> </dsb-trx-id-for-epayment>
  <dsb-trx-id-for-solvency-check> </dsb-trx-id-for-solvency-check>
  <!—- one for each business partner -->
  <subscription-to-business-partner-relation>
    ...
  </subscription-to-business-partner-relation>
  <renewal>
    <renewal-order-number></renewal-order-number>
    <automatic-renewal></automatic-renewal>
  </renewal>
  <!—- one up to 3 -->
  <business-partner id=””>
    ...
  </business-partner>
  <!—- 0 to n possible -->
  <premium>
    ...
  </premium>
  <premium-payment>
    <premium-payment-method></premium-payment-method>
    <!-- either -->
    <debit-account>
      . . .
    </debit-account>
    <!-- or -->
    <cc-account>
      . . .
    </cc-account>
  </premium-payment>
  <!—- 0 to n possible -->
  <order-attribute>
    ...
  </order-attribute>
  <core-wbz-conditions>
    <wbz-wkz> </wbz-wkz>
    <wbz-wkz-fix> </wbz-wkz-fix>
    <wbz-condition> </wbz-condition>
  </core-wbz-conditions>
</subscription>

Element Definitions

Field Name	Length	Type	Text	m = Must k = can (m) = conditional Must	Remark, field supply or encoding
promotion-source	10	C	Source code (in AVS/3)	m	.
promotion-source-variant	1	C	Promotion-source-variant	(m)
reference-doc	20	C	Referenzbeleg	-	Contains the order number of the legacy system. Otherwise it is identical with the field order-number. Caution! This field DOESN'T exist in the WSI Interface!! But there is an alternative solution: Setting the old subscription number as an order attrinute. DSB can set this by a program in the field “reference number”. Example: <order-attribute> <type>ABOALT</type> <value>4241407</value> </order-attribute>
sales-promotion	8	C	Sales-promotion	(m)	In case if several sales-promotions have been set up for a BQ so it must be told which one can be used
advertising-level	2	N	Advertising level	k	Advertising level of the accepted offer(0-99 )
offer-code	5	C	(renewal-)offer code	(m)
publication	8	C	publication	(m)	when blank, then automatic determination out of BQ
edition	8	NC	edition	(m)	when blank, then automatic determination out of publication
mix-type	2	C	mix-type	(m)	Value is dependent on client Values can be 01 = full sub, 10 = with CD, 11 = with DVD Please discuss this with customer service. If blank, then automatic investigation out of BQ.
purchase-frequency	2	C	Purchase-frequency	(m)	Must only be indicated if it is not clear for the client. Possible values are: VA = full sub Other values are client specific.
delivery-type	2	C	Delivery-type	k	Depending on client. Please contact your AVS/3-customer service for possible values.
quantity	6	N	Quantity of customer order-publisher-Position-division	(m)	If not stated, amount 1 is accepted
sales-organization	4	C	Sales-organization	(m)	Must not be filled, if it can be detected over the BQ or it is clear in PVA (Field ‚edition‘).
sales-suborganisation	5	C	Under-Organization of vkorg	k
sales-bureau	4	C	Sales-bureau	(m)	Investigation based on the field „input-user“. otherwise: 0001 Other values are client specific.
distribution-channel	2	C	Distribution-channel	(m)	Must only be stated, if the value can not be clearly derivated out of the publication (field ‚publication‘).
division	2	C	division	(m)	Must only be stated, if the value can not be clearly derivated out of the publication (field ‚publication‘).
customer-purchase-order-number	20	C	Customer-purchase-order no.	k
customer-purchase-order-type	4	C	Order type of customer	k	e.g. ‚I‘ → Internet; ‚T‘ → by telephone
customer-purchase-order-date	10	D	Customer purchase order date YYYY-MM-DD	k
valid-from	10	D	Date from next delivery of issue	k	In case that the date has no shipping date, it is projected for the next dispatch This field and “issue-number-from” are mutal exclusive.
valid-to	10	D	Date to delivery of issues should be executed	k	If the date is no shipping date it is counted downward to the latest dispatch This field and “issue-number-to are mutal exclusive.
issue-number-from	9	C	Issue-number of first delivered issue. Default Format: HHHH/YYYY or any other client specific format /free text.	k	Default: next copy in dispatch. This field and “valid-from” are mutal exclusive.
issue-number-to	9	C	Issue-number of last delivered issue. Default Format: HHHH/YYYY or any other client specific format /free text.	k	Default: unlimited respectively the registered period in BQ. This field and “valid-to” are mutal exclusive.
archive-reference	20	C	Reference Number	k
payment-method	1	C	Payment-method	m	E → Payment per bank collection(national) D → Payment per bank collection(SEPA DirectDebit)¹⁾ K → Payment per credit card R → payment per invoice. P → payment per Paypal For foreign customers are possibly further ways of payment provided.
payment-method-details
* payment-method-cheque
* cheque-bank-clearing-account	10	C	Bank clearing account	(m)	Must, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-number	13	C	Cheque number	(m)	Must, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-amount	9,2	N	Amount in transaction currency	(m)	Must, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-currency-code	3	C	ISO Currency code	(m)	Must, if structure 'payment-method-cheque' is under 'payment-method-details' denoted Currency as ISO-Code EUR Euro CHF Schweizer Franken GBP Great British Pound etc.
* cheque-bank-code	15	C	Bank code	(k)	Can, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-bank-control-key	2	C	Bank control key	(k)	Can, if structure 'payment-method-cheque' is under 'payment-method-details' denotedt
* cheque-bank-country-code	3	C	Bank country code	(k)	Can, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-bank-account-number	18	C	Bank account number	(k)	Can, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* cheque-holder	60	C	Holder name	(k)	Can, if structure 'payment-method-cheque' is under 'payment-method-details' denoted
* payment-method-other
* other-bank-clearing-account	10	C	Bank clearing account	(m)	Must, if structure 'payment-method-cother' is under 'payment-method-details' denoted
* other-amount	9,2	N	Amount in transaction currency	(m)	Must, if structure 'payment-method-cother' is under 'payment-method-details' denoted
* other-currency-code	3	C	Currency code	(m)	Must, if structure 'payment-method-cother' is under 'payment-method-details' denoted Currency as ISO-Code EUR Euro CHF Schweizer Franken GBP Great British Pound etc.
* other-payee-note	80	C	Payee note	(k)	Can, if structure 'payment-method-cother' is under 'payment-method-details' denoted
total-paid-currency-code	3	C	Currency code	k	only in use for renewal
total-paid-amount	9,2	N	D	k	only in use for renewal
wallet-part-payment-amount	9,2	N	amount paid by voucher	k	only in use for renewal
extra-pay-discount
* currency-code	3	C	Currency code for discount/extra-pay	(m)	only in use for renewal
* discount	9,2	N	discount	(m)
* extra-pay	9,2	N	extra pay	(m)	not yet implemented
extra-pay-voucher `BETA`
* bank-clearing-account	10	C	Bank clearing account	(m)	`BETA` Must, if structure 'extra-pay-voucher' denoted
* amount	9,2	N	Amount in transaction currency	(m)	`BETA` Must, if structure 'extra-pay-voucher' denoted
* currency-code	3	C	Currency code	(m)	`BETA` Must, if structure 'extra-pay-voucher' denoted Currency as ISO-Code EUR Euro CHF Schweizer Franken GBP Great British Pound etc.
* payee-note	80	C	Payee note	(k)	`BETA` Can, if structure 'extra-pay-voucher' denoted
print-invoice	1	C	Mark print invoice	k	Y = print invoices N = print no invoices
purchase-reason	3	C	Purchase reason	k
delivery-end-reason	3	C	Delivery end reason	k	Depending on client. Setting up after consultation with your AVS/3-customer service.
billing-from	10	D	Billing-from	k	Date, from when it should be billed
issue-billing-from	9	C	Issue-billing-from	k	Copy no., from which it should be billed
currency-code	3	C	Currency	k	Currency as ISO-Code EUR Euro CHF Schweizer Franken GBP Great British Pound etc.
price-list-type	2	C	Price-list-type	(m)	when blank, investigation logic out: /DSB/JOT_PL_FIND
fixed-price-list-and-currency-code	1	C	Y/N	k	don't change the submitted price and currency code (Default: N)
debit-account
* debit-account-id	4	C	debit account id	k
* debit-bank-code	15	C	Debit-bank-code	(m)	Must be, when corresponding way of payment
* debit-country-code	3	C	ISO-country code of bank	k	ISO-country codes of bank data when corresponding way of payment.
* debit-account-number	18	C	Debit account number	(m)	Must be, when corresponding way of payment.
* debit-account-holder	60	C	Name of account holder	(m)	Must be, when corresponding was of payment.
* debit-continuous	1	C	Is there a direct debit mandate?	(m)	Y = yes N = no
* debit-due-date	2	C	due day for direct-debit	(m)	Day of month (0-31)
* iban	34	C	International bank account nummer	(m)
* bic	11	C	Bank identifier code	k
cc-account	only if credit card payment is not done by payment provider
* cc-account-id	6	C	Reference to existing creditcard data in the system	k
* cc-company-code	4	C	cc-type	(m)	credit card company
* cc-number	25	C	cc-no.	(m)	credtir card number
* cc-expiry	6	D	cc-expiry	(m)	expiry month Format YYYYMM
sepa-mandate
* creation-type	1	C		(m)	„ “ = no mandate created „N“ = Create new mandate „T“ l= Mandate change(currently not to use) „M“ = Mandate migration(currently not to use)
* transaction-type	1	C		k	„1“ = 1x Mandate „N“ = Multiple Mandate (default)
* details
* b2b-mandate	1	C			B2B-Mandate “Y” oder “N” (currently not supported)
* mandate-ref-per-creditor	35	C			Unique reference to mandate per creditor / previous mandate id (only in conjunction with <creation-type> „T“ und „M“)
* previous-creditor-id	35	C			Creditor identifier(unique accross country) / previous creditor id (only in conjunction with <creation-type> „T“ und „M“)
* previous-bic	11	C			Previous BIC-Code ((only in conjunction with <creation-type> „T“ und „M“)
* last-due-date	10	C
price-key-in-trialterm	4	C	Price-key-in-trialterm	k	Nomination. The attributes depend on the client. A nomination you receive from your AVS/3-customer service.
billing-frequency-in-trialterm	2	C	Billing-frequency-in-trialterm	k	billing frequency
price-group-in-trialterm	2	C	Price-group-in-trialterm	k	Price-group of trialterm
duration-in-trialterm	3	C	Duration-in-trialterm	k	Duration of position
unit-in-trialterm	3	C	Unit-in-trialterm	k	For example.: MON months WCH weeks TAG days
price-key-in-normalterm1	4	C	Price-key-in-normalterm 1	k	Nomination. The attributes depend on the client. A nomination you receive from your AVS/3- customer service.
billing-frequency-in-normalterm1	2	C	Billing-frequency-in-normalterm 1	k	billing frequency
price-group-in-normalterm1	2	C	Price-group-in-normalterm1	k
duration-in-normalterm1	3	C	Duration-in-normalterm1	k	Duration of position
unit-in-normalterm1	3	C	Unit-in-normalterm 1	k	For example: MON months WCH weeks TAG days
price-key	4	C	Price-key of normalterm	k	Nomination. The attributes depend on the client. A nomination you receive from your AVS/3-customer service.
billing-frequency	2	C	Billing frequency of normalterm	k	billing frequency
price-group	2	C	Price-group of normalterm	k
duration	3	C	Duration of normalterm	k	Duration of position
unit	3	C	Unit of duration of normalterm	k	For example: MON months WCH weeks TAG days
postage-key	2	C	Postage-key (dispatch costs investigation)	k	If a postage-key is available, it is transferred “fix” into the backend system, without any customization changes configured in the AVS/3 system. If you want to use the optimization from the backend, the postage-key can be easily transferred empty.
dsb-media1	1	C		k	Field for free disposal. Is stored to the order.
dsb-media2	2	C		k	Field for free disposal. Is stored to the order.
dsb-media3	3	C		k	Field for free disposal. Is stored to the order.
dsb-media4	4	C		k	Field for free disposal. Is stored to the order.
dsb-media2b	2	C		k	Field for free disposal. Is stored to the order.
dsb-media7	7	C		k	Field for free disposal. Is stored to the order.
rule-id	3	C		k	Unique Identifikationnumber of a matching rule for order evaluation
external-order-number	35	C	External-order-number	(m)	This field is a required element in ‚createOrderBufferd‘ and prevents duplicate recordings in the OAA In this field a unique external order no. is expected. This value is NOT stored in AVS/3 and cannot be used as a external reference Please use a order-attribute for this purpose instead.
input-office	12	C	Input-office	m
input-date	10	D	Input-date	m	Format YYYY-MM-DD
input-user	12	C	Input-user	m
stack-name	17	C	Stack-name	k
save-in-system	1	C		m	‚Y‘ the committed data is stored. (Default) ‚N‘ It is just a test of data without saving.
post-at-once	1	C		m	‚Y‘ the committed data is registered immediately. ‚N‘ the committed data is first registered through a consultant.
skip-doi-process	B		Should the double opt in process be skipped? Default is false. Only relevant with client that use the doi process.
adjust-upper-and-lower-case	1	C		k	‚Y‘ Address data is changed from only capital letters or only small letters into capital and small letters. (Default) ‚N‘ Spelling of the address remains.
order-rating	1	C		k	‚Y‘ order rating is active (Default) ‚N‘ order rating is deactivated/inactive
stack-lock-code	1	C	Stack lock code	k	W= webservice F=file
agent-number	10	C	External agent-number	k
agent-organisation	5	C	external agent-organisation	k
cost-center	10	C	Cost-center	k	to debited cost-center
matriculated	1	C	Mark present matriculated bill	k	‚Y‘ → matriculation certification available ‚N‘ → no matriculation certification available If “Y”, the next field must be supplied too.
matriculated-to	10	D	Matriculated-to	k
advance-billing		B	Billing in advance flag (default: false)
previously-billed-to	10	D	Previously-billed-to	k	Date „billed to “ in pre-system
issue-previously-billed-to	9	C	Issue-previously-billed-to	k	Copy no. “billed to” in pre-system
delivery-start-statistical	10	D	Delivery-start-statistical	k	Date for statistical delivery start
issue-delivery-start-statistical	9	C	Issue-delivery-start-statistical	k	Copy no. for statistical delivery start
dispatch-type	2	C	Dispatch-type	k	LP = air-mail
dispatch-text	5	C	Dispatch-text	k	Further criteria in dispatch-text
ivw-group	2	C	Special group for ivw evaluation	k
statistic-group	2	C	Token of statistic-group	k
ct-commitment-period	2	N	Commitment-period	k	Terms of contract: Duration of commitment-period (regular cancellation after x Months possible)
ct-cancellation-period	2	N	Cancellation-period	k	Terms of contract: period of notice
ct-renewal	2	N	Ct-renewal	k	Terms of contract: (autom.) renewal of bounded time limit
dsb-trx-id-for-ctp	36	C	Creditcard authorization GUID	k	Creditcard-Authorisation-GUID in the dsb-Webservice environment. Contains the “cc-dsb-transaction-id” from a previous made Notify request (for example notifyCardTransactionWithWirecard)
dsb-trx-id-for-epayment	36	C	E-Payment GUID	k	E-Payment-GUID in the dsb-WSI Contains the “dsb-transaction-id” from a previous made EPayment Notify request(for example notifyTrxWirecard)
dsb-trx-id-for-solvency-check	36	C	Solvency check GUID	k	Solvency-Check-GUID in the dsb-WSI (at the moment without function in the AVS/3)
subscription-to-business-partner-relation see description chapter below
renewal
* renewal-order-number	10	C		k	renewal order-number
* automatic-renewal	1	C		k	automatic renewal 'Y' / 'N'
business-partner See description below
premium See description below
premium-payment See description below
order-attribute See description below
core-wbz-conditions
* wbz-wkz	1	C	promotion charge benefit	k
* wbz-wkz-fix	1	C	WKZ-Key fixation	k	‚Y‘ = WKZ-Key fixed(x), ‚N‘ not fixed
* wbz-condition	3	C	WBZ-Condition	k	Abotype in data exchange

Structure <business-partner>

<business-partner id="" role-type="">
  <salutation-code></salutation-code>
  <prefix> </prefix>
  <titel-code-academic></titel-code-academic>
  <titel-academic></titel-academic>
  <titel-code-royal></titel-code-royal>
  <titel-royal></titel-royal>
  <job-titel></job-titel>
  <last-name1></last-name1>
  <last-name2></last-name2>
  <first-name></first-name>
  <nick-name></nick-name>
  <street></street>
  <street-suffix></street-suffix>
  <street-number></street-number>
  <street-number-suffix></street-number-suffix>
  <address-line-1></address-line-1>
  <address-line-2></address-line-2>
  <address-line-3></address-line-3>
  <zipcode></zipcode>
  <country-code></country-code>
  <city></city>
  <district></district>
  <region-code></region-code>
  <region-text></region-text>
  <company1></company1>
  <company2></company2>
  <company3></company3>
  <company4></company4>
  <department></department>
  <po-box></po-box>
  <po-box-zipcode></po-box-zipcode>
  <po-box-city></po-box-city>
  <po-box-country-code></po-box-country-code>
  <major-customer-zipcode></major-customer-zipcode>
  <address-source></address-source>
  <language>DE</language>
  <advertisement></advertisement>
  <bp-number></bp-number>
  <bp-number-external></bp-number-external>
  <bp-group></bp-group>
  <eu-sales-tax-number></eu-sales-tax-number>
  <date-of-birth></date-of-birth>
  <postal-check></postal-check>
  <purge-check></purge-check>
  <dublicate-check></dublicate-check>
  <bic-master-number></bic-master-number>
  <sector></sector>
  <email-bp></email-bp>
  <!—- 0 to n possible -->
  <communication>
    <communication-type></communication-type>
    <communication-value></communication-value>
  </communication>
  <!—- 0 to n possible -->
  <attribute>
    <attribute-type></attribute-type>
    <attribute-value></attribute-value>
  </attribute>
</business-partner>

Element Definitions

Field Name	Length	Type	Text	m = Must k = can (m) = conditional Must	Remark, field supply or encoding
business-partner →Attribut: id	n.a	C	Correspond to ‚bp-reference‘ in the structure ‚purchase-order-to-business-partner-relationship‘	(m)	Please only use it in exceptional cases. If there is no need for the description of the relation use attribute “role-type”.
business-partner →Attribut: role-type	2	C	Role of the business partners	(m)	AG = orderer WE = consignee VM = procurer
salutation-code	2	C	Salutation	m	01 = Mr. 02 = Ms. 99 = unknown further codes are deposited in a code table if needed please request. If a firm address is committed is this the salutation of the contact person (if available)
prefix	4	C	Intention word to the name (prefix)	k	The corresponding prefix has to be requested from customer service.
title-code-academic	4	C	Title-academic	k	Academic title code, e.g. 0027 = Dr. The codes are deposited in a code table if needed please request from your customer support.
title-academic	15	C	Title-academic in clear text (for example Dr.)
title-code-royal	4	C	Title of nobility	k	The codes are deposited in a code table if needed please request from your customer support.
title-royal	15	C	Title of nobility in cleartext		Attention: this functionality is at the moment in the interface not disposable!
job-titel	35	C	job titel	k
last-name1	35	C	Last-name1	(m)	If a firm address is committed is this the contact person.
last-name2	35	C	Last-name2	k	If a firm address is committed is this the contact person.
first-name	35	C	First-name(s)	(m)	If a firm address is committed is this the contact person.
nick-name	35	C	nick-name(s)	k	If a firm address is committed is this the contact person.
street	50	C	Street	(m)	Must not be set if address-line-1, address-line-2 or address-line-3 is set.
street-suffix	40	C	Street addition	k	Must not be set if address-line-1, address-line-2 or address-line-3 is set.
street-number	10	C	House-number	(m)	Must not be set if address-line-1, address-line-2 or address-line-3 is set.
street-number-suffix	8	C	House-number - addition	k	Must not be set if address-line-1, address-line-2 or address-line-3 is set.
address-line-1	35	C	Adresse Line 1 for UK Addresses	k
address-line-2	35	C	Adresse Line 2 for UK Addresses	k
address-line-3	35	C	Adresse Line 3 for UK Addresses	k
zipcode	10	C	zipcode	(m)	Obligation if a street address must be committed.
country-code	3	C	Country-code	m
country-code→code-type	3	C	Type of country-code in field ‘country-code’	k	iso – country codes as ISO country identification(default) iso3 –country code as ISO3 country identification car – car country code
city	40	C	city	(m)	Obligation if a street address must be committed.
district	25	C	Additional to city (for example, districts, areas)	k
region-code	3	C	region-code Codetabelle, Inhalt legt Fachbereich fest	k
region-text	25	C	Region als Klartext (z.B. Bundesland, County…)	k
company1	35	C	Company line1	(m)
company2	35	C	Company line2	k
company3	40	C	Company line3	k
company4	40	C	Company line4	k
department	30	C	Department	k
po-box	10	C	Po-box	(m)	Obligation if a po-box address must be committed.
po-box-zipcode	10	C	Po-box-zipcode	(m)	Obligation if a po-box address must be committed.
po-box-city	40	C	Po-box-city	(m)	Obligation if a po-box address must be committed.
po-box-country-code	3	C	Po-box-country-code	(m)	Obligation if a po-box address must be committed.
po-box-country-code→code-type	3	C	Type of country-code in field ‘po-box-country-code’	k	iso – country codes as ISO country identification(default) iso3 –country code as ISO3 country identification car – country code KFZ country identification
major-customer-zipcode	10	C	Major-customer zipcode	(m)
address-source	10	C	Address-source Code table, contents determines faculty	k
language	2	C	Language of BP	k	ISO-Code
advertisement	1	C	Mark if advertisement should be sent	k	‚N‘ → send no commercial ‚Y‚ → send commercial
category	2	C	Category		Attention: this functionality is at the moment in the interface not disposable!
bp-number	10	C	Optional, permanent customer bp-number	k
bp-number-external	20	C	Business partner no. of external system	k
bp-group	4	C	Customer group Codetable, contents determines faculty	k	Attention: this functionality is at the moment in the interface not disposable!
eu-sales-tax-number	14	C	EG-UST identical number	k
date-of-birth	10	D	Date-of-birth foramte: YYYY-MM-DD	k
postal-check	1	C	Check customer’s address: postal	k	Y = test N = no test no specification (Default adjustment is used) Attention: this functionality is at the moment in the interface not disposable!
purge-check	1	C	Check customer’s address:: Purge	m	Y = test N = no test Attention: this functionality is at the moment in the interface not disposable.
dublicate-check	1	C	Check customer’s address: Dublicate	m	Y = test N = no test
bic-master-number	10	C	Partner-ID of Masters (for example company of contact person)	k
sector	10	C	sector	k
email-bp	1	C	Email BusinesspPartner	k	Y = Yes, N = No(Default) no entry = Default
communication 0 … n
* communication-type	2	C	Communication type	(m)	Values Attention : it is always just 1 telephone number, 1 email address, 1 fax number and 1 mobile phone number receivable!
* communcation-value	50	C	Value of communication type	(m)	Attention : it is always just 1 telephone number, 1 email address , 1 fax number and 1 mobile phone number receivable!
attribute 0 … n
* attribute-type	6	C	Function of business partner attribute For example: type of address	(m)
* attribute-value	50	C	Values of business partner attribute	(m)

Structure <premium>

Basically premium elements are not urgently required in the representation. But if premiums have to be created, a completely described premium element must be available.

<premium>
  <role> </role>
  <material-number> </material-number>
  <referral></referral>
</premium>

Element Definitions

Field Name	Length	Type	Text	m=Must\ k = can \ (m) = conditional Must	Remark, field supply or encoding**
role	2	C	role of partner who should receive the premium	m	AG, RE, WE
material-number	18	C	Material-number material premium	k	If blank out of order source
referral	1	C	Receives gift because of referral	k	Y / N (default)

Structure <premium-payment>

<premium-payment>
  <premium-payment-method></premium-payment-method>
  <!-- either -->
  <debit-account>
    <debit-account-id></debit-account-id>
    <debit-bank-code></debit-bank-code>
    <debit-country-code></debit-country-code>
    <debit-account-number></debit-account-number>
    <debit-account-holder></debit-account-holder>
    <debit-continuous></debit-continuous>
    <iban></iban>
    <bic></bic>
  </debit-account>
  <!-- or -->
  <cc-account>
    <cc-account-id></cc-account-id>
    <cc-company-code></cc-company-code>
    <cc-number></cc-number>
    <cc-expiry></cc-expiry>
  </cc-account>
</premium-payment>

Elementdefinitions

See'debit-account' and 'cc-account' under 'business-partner' Structure.

Basically attributes to the order are not urgently necessary. They can, however, be used to pass further order specific information.

Structure <order-attribute>

<order-attribute>
  <type> </type>
  <value> </value>
</order-attribute>

Element Definitions

Field Name	Length	Type	Text	m = Must \ k = can \ (m) = conditional \ Must	Remark, field supply or encoding**
type	6	C		m	Marks the type of attribute and must be clear.
value	50	C		m	The actaul attribute value

Response Structure

Structure <subscription-response>

<subscription-response>
   <stack-name></stack-name>
   <number-in-stack></number-in-stack>
   <input-date></input-date>
   <vbeln></vbeln>
   <vkont></vkont>
   <error-message-id></error-message-id>
   <error-message-number></error-message-number>
   <error-message-type></error-message-type>
   <error-message-1></error-message-1>
   <error-message-2></error-message-2>
   <error-message-3</error-message-3>
   <error-message-4></error-message-4>
   <error-text></error-text> 
</subscription-response>

Element Definitions

Field Name	Length	Type	Text	Remark, field supply or encoding
stack-name	17	C	Name of already created stack in AVS/3-System	The stack name should still be used in following appeals. Apart from that every subscription is to be set up in a new stack. Please discuss with the customer service how many subscriptions should be set up in a stack. Not more than 999 subscriptions can be set up in a stack.
number-in-stack	3	N	Number of order in current stack
input-date	10	C	Date of order creation
vbeln	10	C	Created distribution reference number respectively order number
vkont	12	C	Contract account number
error-message-id	20	C	Clear error-message -ID
error-message-number	3	N	Error-message-number
error-message-type	1	C	Error-message-type	Relevant are following cases: ‚A‘ and ‚X‘. In both cases the transfer must be stopped and the customer service must be informed. In any case the doubtful order must be checked again because at this error status it counts not as transferred.
error-message-1	50	C
error-message-2	50	C
error-message-3	50	C
error-message-4	50	C
error-text	140	C	Complete error-text	This text obtains also messages of the fields ‚error-message-1‘ until ‚error-message-4‘

¹⁾

SEPA Direct Debit requires a SEPA mandate in conjunction with a bank account and IBAN