Skip to main content

Contacts

Use formats of the type Contacts to export contact data, address data and company data.

1. Account

Table 1 lists the fields available for exporting company data.

Table 1. Fields for exporting company data
Field Explanation

companyName

Company name

dealerMinOrderValue

Minimum order value for the supplier

deliveryTime

Delivery time for the supplier

discountDays

Early payment discount (days) of the company

discountPercent

Percentage for early payment discount of the company

id

The ID of the company

number

Customer number. This number is not assigned automatically. The maximum length is 128 characters.

salesRepresentativeContactId

Contact ID of the sales representative

taxIdNumber

VAT identification number of the customer

TimeForPaymentAllowedDays

Payment due date of the contact

userId

ID of the owner (plentymarkets user ID)

valuta

Valuta of the company

2. BillingAddress

Table 2 lists the fields available for exporting invoice address data.

Table 2. Fields for exporting invoice address data
Field Explanation

address1

Address field 1 (default: Street)

address2

Address field 2 (default: House number)

address3

Address field 3 (default: Additional address information)

address4

Address field 4 (freely definable)

checkedAt

Time stamp of the last check of address (Unix timestamp)

countryId

Country ID

id

ID of the invoice address

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

postalCode

Postcode

stateId

ID of the federal state

title

Title of contact

town

Town

3. BillingAddressOption

Table 3 lists the fields available for exporting different types of invoice address options.

Table 3. Fields for exporting invoice address options
Field Explanation

bBFC

BBFC (age rating)

birthday

Date of birth

contactPerson

Contact person

email

Email address

entryCertificate

Entry certificate (Gelangensbestätigung)

externalAddressID

External ID of the invoice address

personalId

Personnel ID

postNumber

Post number

sessionID

Session ID

telephone

Telephone number

title

Title of the invoice recipient

vatNumber

VAT identification number of the customer

4. Contact

Table 4 lists the fields available for exporting contact data.

Table 4. Fields for exporting contact data
Field Explanation

birthdayAt

Birthday of the contact

blocked

Status “Blocked”. A contact can be locked for a specific client.
Possible values: 0 = not blocked, 1 = blocked.

bookAccount

Debtor account of the contact. An additional, separate number that usually corresponds to the contact number or the debtor number of the contact in your administrative accounting.

classId

Customer class ID

dhlPostIdent

DHL PostIdent of the contact

discountDays

Early payment discount (days) of the contact

discountPercent

Percentage for early payment discount of the contact

externalId

External contact ID

firstName

The contact’s first name

gender

Gender of the contact

id

ID of the contact

lang

Language of the contact

lastLoginAtTimestamp

Date of last login of the contact

lastName

The contact’s last name

lastOrderAt

Date of last order

newsletterAllowanceAt

Time stamp of the contact registering for the newsletter

number

Customer number. This number is not assigned automatically. The maximum length is 128 characters.

plentyId

Client that is assigned to the contact

rating

Rating of the contact. This is an internal rating only. 5 red stars are the worst possible rating and 5 yellow stars are the best possible rating. Possible values:
-5 = 5 red stars (worst possible rating)
-4 = 4 red stars
-3 = 3 red stars
-2 = 2 red stars
-1 = 1 red star
0 = 5 grey stars, no rating saved for the contact.
1 = 1 yellow star
2 = 2 yellow stars
3 = 3 yellow stars
4 = 4 yellow stars
5 = 5 yellow stars (best possible rating)

referrerId

Referrer ID of the contact

salesRepresentativeContactId

Contact ID of the sales representative

timeForPaymentAllowedDays

Payment due date of the contact

title

Title of contact

typeId

Contact type ID

userId

Owner ID of the contact

valuta

Valuta of the contact

5. contactAllowedMethodOfPayment

Table 5 lists the fields available for exporting allowed methods of payment saved in the contact data record.

Table 5. Fields for exporting allowed methods of payment of the contact
Field Explanation

allowDebit

Information that states whether the contact is allowed to pay via direct debit.
Possible values:
0 = do not allow
1 = allow

allowInvoice

Information that states whether the contact is allowed to pay via invoice.
Possible values:
0 = do not allow
1 = allow

6. ContactBank

Table 6 lists the fields available for exporting bank details.

Table 6. Fields for exporting bank details
Field Explanation

accountNumber

Account number

accountOwner

The account holder’s name

bankAddress

The address of the bank

bankCountry

Country of the bank

bankName

The name of the bank

bankPostalCodeTown

Postcode and town of the bank

bic

BIC of the bank account

contactId

ID of the contact

directDebitMandateAt

Date the SEPA direct debit mandate was granted

directDebiteMandateAvailable

Flag that indicates if a SEPA direct debit mandate was granted

directDebitMethod

Type of SEPA direct debit mandate. Possible values:
sepaDirectDebit
sepaB2bDirectDebit

directDebitType

Indicates if this is a first debit or recurring debit. Possible values:
first
next

iban

IBAN of bank account

id

ID of the bank account

lastUpdateBy

Date of last update. Possible values:
customer
back end
import

paymentMethod

Payment frequency of SEPA direct debit mandate. Possible values:
recurrent
onOff

sortCode

Bank code

7. ContactOption

Table 7 lists the fields available for exporting contact options.

Table 7. Fields for exporting contact options
Field Explanation

accessGuest

Account type. Indicates if the account is a regular account or a guest account.

accessMarketplacePartner

Access to the plentyMarketplace.

additionalContactPerson

Additional contact person

emailPayPal

PayPal email address

emailPrivate

Private email address

emailWork

Office email address

groupForum

Email address used in a forum

identificationNumberDHL

Identification number at DHL

identificationNumberKlarna

Identification number at Klarna

marketplaceAmazon

Email address at Amazon

marketplaceEbay

eBay name

paymentKlarna

Identification number at Klarna

paymentPayPal

Email address at PayPal

paymentStandard

Default payment method

salutationPrivate

Private form of address

salutationWork

Office form of address

telefaxPrivate

Private fax number

telefaxWork

Office fax number

telephoneMobilePrivate

Private mobile phone number

telephoneMobileWork

Office mobile phone number

telephonePrivate

Private telephone number

telephoneWork

Office telephone number

userNameForum

User name used in a forum

userNamePrivate

Private user name

userNameWork

Office user name

webPagePrivate

Private website

webPageWork

Office website

8. ContactProperty

Table 8 lists the fields available for exporting contact property data.

Table 8. Fields for exporting contact property data
Field Explanation

all

All data that is saved for the contact property

type

Type of the property, e.g. decimal number, multi-selection, short text or date.

id

ID of the property

linked

Contact ID that is linked to the property

value

Value of the property

9. DeliveryAddress

Table 9 lists the fields available for exporting delivery address data.

Table 9. Fields for exporting delivery address data
Field Explanation

address1

Address field 1 (default: Street)

address2

Address field 2 (default: House number)

address3

Address field 3 (default: Additional address information)

address4

Address field 4 (freely definable)

checkedAt

Time stamp of the last check of address

countryId

Country ID

id

ID of the invoice address

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

postalCode

Postcode

stateID

ID of the federal state

title

Title of contact

town

Town

10. DeliveryAddressOption

Table 10 lists the fields available for exporting different types of delivery address options.

Table 10. Fields for exporting delivery address options
Field Explanation

bBFC

BBFC (age rating)

birthday

Date of birth

contactPerson

Contact person

email

Email address

entryCertificate

Entry certificate (Gelangensbestätigung)

externalAddressID

External ID of the delivery address

personalId

Personnel ID

postNumber

Post number

sessionID

Session ID

telephone

Telephone number

title

Title of recipient

vatNumber

VAT identification number of the customer

11. SalesRepresentativeRegion

Table 11 lists the fields available for exporting data about the region of the sales representative.

Table 11. Fields for exporting data about the sales representative’s region
Field Explanation

countryId

Country ID

id

ID of the sales representative

postalCodeArea

Postcode area within which the sales representative is working

12. Custom value

Table 12 lists the fields available for exporting custom values.

Table 12. Fields for exporting custom values
Field Explanation

custom_value

Own value

13. Date

Table 13 lists the field available for exporting the current date. For further information, refer to this page.

Table 13. Field for exporting the current date
Field Explanation

date

Current date

To top