changeBp

This method changes the details of a business-partner. In order to change the details you have to supply all data of the existing business-partner (changed and unchanged). This is necessary because all details which are not part of the change request are interpreted to be deleted. The field “bp-number” is mandatory in a change request.

Object: /net/dsb/vhs3/Bp
Method: changeBp
Version: 1.0.0

Parameter

Name	Type / Lenght	Opt. / Mandat	Descripton
business-partner	XML	m	XML fragment “business-partner” according to new purchaseorders.

Response Element

Transaction-Number of the change.

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>
    <business-partner>
      <salutation-code>01</salutation-code>
      <last-name1>Mustermann</last-name1>
      <first-name>Hans</first-name>
      <street>Musterstr. 15</street>
      <zipcode>12345</zipcode>
      <country-code code-type="iso">DE</country-code>
      <city>Musterhausen</city>
      <bp-number>1234567890</bp-number>
      <communication>
        <communication-type>WW</communication-type>
        <communication-value>hans.mustermann@aol.com</communication-value>
      </communication>
      </business-partner
  </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>
    <transaction-guid>F67B9A28-E640-72CD-4989-29BB44F6CFEC</transaction-guid>
  </body>
</message>

Request Structure

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 Name	Key	Length	Type	Remark, 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