Table of Contents

Description

The BasicCustomer object describes the customer.

Structure

Keyword JSON	Keyword XML	Occurs	Type	Format	Description
number	number	1	integer	int64	Customer number
client	client	1	string		Customer group
group	group	0 - 1	integer	int64	Number of customer group
name	name	1	string		Customer name, max. 255 characters,
type	type	1	enum	CustomerType	Type of customer
organization	organization	0 - 1	string		Company name
organization2	organization2	0 - 1	string		Company name
vatNumber	vat_number	0 - 1			VAT number
gender	gender	0 - 1	enum	Gender	Gender
title	title	0 - 1	string		Customer title
addressLines	address	0 - n	string		Customer address
city	city	1	string		Customer residence
state	state	0 - 1	string		State of residence
country	county	1	string		Country of residence
phone	phone	1	string	phone	Customer phone number, format +49-123-12345
fax	fax	0 - 1	string	phone	Customer phone number, format +49-123-12345
emails	email	1 - n	string	email	Customer email addrss
billingEmails	billing_email	0 - n	string	email	Customer billing email address
contacts	contact	0 - n	object	BasicCustomerContact	Additional contact data
payment	payment	1	enum	PaymentConstants	Describes the type of payment.
paymentMode	payment_mode	1	string		Describes the method of payment e.g. SEPA, Paypal.
paymentCurrency	payment_currency	1	string		Currency in which the customer pays
	payment_currency_exchange_fee	1	number	double	Fee incurred on currency conversion
discountValid	discount_valid	0 - 1	string	date-time	End of validity of a promotional offer
invoiceLanguage	invoice_language	0 - 1	string		Language in which the invoice is created.
	invoice_days	0 - 1	object	InvoiceDays	Days until the invoice is due.
	invoice_paperbill	1	boolean		Way of sending the invoice. false = digital true = paper Default value = false For XML, 0 (false) and 1 (true) can also be used.
pin	pin	1	string		Pin number for support requests
taxable	taxable	1	boolean		Is avlue added tax (VAT) charged for this customer? false = Do not charge VAT true = Charge VAT Default value = false For XML also 0 (false) and 1 (true) can be used.
card	card	1	object	Card	Credit card for billing
contracts	customer_contract	0 - n	object	CustomerContract	The contracts of the customer
autodelete		1	boolean		Is the customer an Autodelete customer? false = No autodelete customer true = Autodelete customer Default value = false For XML also 0 (false) and 1 (true) can be used.
pending	pending	1	boolean		Is the customer's data in still being checked? false = Check completed true = In check Default value = false For XML, 0 (false) and 1 (true) can also be used. If the data is still being checked, there is a persist object that returns the currently checked data.
verifications		0 - 1	object	BasicCustomerSpoolVerification	Displays the email verifications in progress.
account	account	1	object	Account	Billing account of the customer
locked	locked	1	boolean		Is the customer locked? false = Not locked true = Locked Default value = false For XML also 0 (false) and 1 (true) can be used.
persistent	persistent	1	object	BasicCustomer	Current data of the customer, if an update is pending and the data has not been checked yet. "Pending" is "true" in this case.
billingUsers	billing	1 - n	string		Billing contacts
comments	comment	0 - n	string		Kommentare zu diesem Kunden
fname	fname	1	string		Customer first name
lname	lname	1	string		Customer last name
pcode	pcode	1	string		Zip code of the customer address
sepa	sepa_mandate	0 - 1	object	SEPAMandate	SEPA mandate of the customer
lastConfirmed	last_confirmed	0 - 1	string	date-time	Date on which the customer data was last confirmed.
	pricelists	0 - 1	object	CustomerPriceLists	Price lists of the customer
	data_privacy_statement	0 - 1	boolean		Privacy policy read and accepted false = Not read true = Read and accepted Default value = false For XML, 0 (false) and 1 (true) can also be used.
newsletter	newsletter	0 - 1	boolean		Subscribed to the newsletter or not. false = Not subscribed true = Logged in Default value = true For XML, 0 (false) and 1 (true) can also be used.
	supplier_number	0 - 1	string		Supplier number
	url	0 - 1	string		Optional URL for the customer
owner	owner	1	object	BasicUser	User assigned to this customer
updater	updater	1	object	BasicUser	User who last updated this customer
created	created	1	string	date-time	Date when the customer was created
updated	updated	1	string	date-time	Date when the customer was last updated

Basic customer object

Description

Structure