Requests the details from one or more customers. When no filter is set, 10 customers will be delivered. A LIMIT up to 100 customers is possible.
FILTER
Tags
Description
CUSTOMER_ID
A specific customer ID
CUSTOMER_NUMBER
The own customer number
COUNTRY_CODE
A country (ISO 3166 ALPHA-2)
CITY
City
TERM
Searchs for the term in fields: ORGANIZATION, FIRST_NAME, LAST_NAME, ADDRESS, ADDRESS_2, ZIPCODE, EMAIL
HASH
Filter for hash
RESPONSE
Tags
Description
CUSTOMER_ID
A specific customer ID
CUSTOMER_NUMBER
The own customer number
CUSTOMER_EXT_UID
External ID of customer
CUSTOMER_TYPE
Customer type: business | consumer
ORGANIZATION
Company name [REQUIRED] when customer_type = business
TITLE_ACADEMIC
Academic title
SALUTATION
Salutation: mr | mrs | family | "empty"
FIRST_NAME
First name
LAST_NAME
Last name [REQUIRED] when customer_type = consumer
ADDRESS
Address
ADDRESS_2
Address 2
ZIPCODE
ZIP code
CITY
City
COUNTRY_CODE
A country (ISO 3166 ALPHA-2)
SECONDARY_ADDRESS
Delivery address
STATE
State
PHONE
Phone
FAX
Fax number
EMAIL
e-mail address
EMAIL_CC
CC for sending an e-mail to a customer
BIRTHDAY
Birthday
PAYMENT_MAIL_ADDRESS
Email-adress for payment reference
VAT_ID
The VAT ID of a customer
TAX_ID
Tax ID
CURRENCY_CODE
Currency code
COMMENT
Comment
DAYS_FOR_PAYMENT
Days until date of payment
CREATED
Date of Creation
PAYMENT_TYPE
Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card
ALLOWED_PAYMENT_TYPES
Set which payment types can be selected by customer - contact Support to activate this function. Payment type: 1 = transfer | 2 = direct debit | 4 = paypal |6 = credit card
PAYMENT_PROVIDER
Name of integrated Payment Gateway
PAYMENT_TOKEN
customer reference token provided by payment gateway
BANK_NAME
Bank name
BANK_ACCOUNT_OWNER
Bank account owner
BANK_IBAN
IBAN
BANK_BIC
BIC
BANK_ACCOUNT_MANDATE_REFERENCE
Mandate reference number
BANK_ACCOUNT_MANDATE_REFERENCE_DATE
Creation date of the sepa mandate
SHOW_PAYMENT_NOTICE
Show payment notice
NEWSLETTER_OPTIN
Newsletter option: 0 = no | 1 = yes
AFFILIATE
Affiliate
HASH
Filter for hash
LASTUPDATE
Date of latest update
TAGS
Tags
LANGUAGE_CODE
Language code e.g. de, fr etc.
CHANGEDATA_URL
URL for changing Master data and invoice data
DASHBOARD_URL
URL leading to Dashboard
CREDIT_BALANCE
Balance
WIRECARD_GATEWAYREFERENCENUMBER
ID for payments via Wirecard
ADYEN_ENCRYPTED_DATA
Client side payment token
PAYPAL_BILLINGAGREEMENTID
Reference Transaction ID
PAYPAL_PAYERID
INVOICE_DELIVERY_METHOD
Method of invoice delivery
customer.create
Creates a new customer
DATA
Tags
Description
CUSTOMER_NUMBER
The own customer number
CUSTOMER_EXT_UID
External ID of customer
CUSTOMER_TYPE Required
Customer type: business | consumer
ORGANIZATION
Company name [REQUIRED] when customer_type = business
POSITION
Position in the company
SALUTATION
Salutation: mr | mrs | family | "empty"
TITLE_ACADEMIC
Academic title
FIRST_NAME
First name
LAST_NAME
Last name [REQUIRED] when customer_type = consumer
ADDRESS
Address
ADDRESS_2
Address 2
ZIPCODE
ZIP code
CITY
City
STATE
State
COUNTRY_CODE
A country (ISO 3166 ALPHA-2)
LANGUAGE_CODE
Language code e.g. de, fr etc.
BIRTHDAY
Birthday
PHONE
Phone
PHONE_2
Phone 2
FAX
Fax number
MOBILE
Mobile phone number
EMAIL
e-mail address
ACCOUNT_RECEIVABLE
Accounts receivable number
CURRENCY_CODE
Currency code
VAT_ID
The VAT ID of a customer
TAX_ID
Tax ID
DAYS_FOR_PAYMENT
Days until date of payment
PAYMENT_TYPE
Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card
ALLOWED_PAYMENT_TYPES
Set which payment types can be selected by customer - contact Support to activate this function. Payment type: 1 = transfer | 2 = direct debit | 4 = paypal |6 = credit card
PAYMENT_PROVIDER
Name of integrated Payment Gateway
PAYMENT_TOKEN
customer reference token provided by payment gateway
SHOW_PAYMENT_NOTICE
Show payment notice
BANK_NAME
Bank name
BANK_CODE
Bank code
BANK_ACCOUNT_NUMBER
Bank account number
BANK_ACCOUNT_OWNER
Bank account owner
BANK_ACCOUNT_OWNER_ADDRESS
Address of account owner
BANK_ACCOUNT_OWNER_CITY
City of account owner
BANK_ACCOUNT_OWNER_ZIPCODE
ZIP code of account owner
BANK_ACCOUNT_OWNER_EMAIL
e-Mail address of account owner
BANK_BIC
BIC
BANK_IBAN
IBAN
PAYMILL_TOKEN
Token for payment by credit card via Paymill
COMMENT
Comment
NEWSLETTER_OPTIN
Newsletter option: 0 = no | 1 = yes
X_ATTRIBUTES
Using own fields (webhooks will include it)
PAYMILL_AMOUNT
Amount of next payment (for balance)
WIRECARD_GATEWAYREFERENCENUMBER
ID for payments via Wirecard
ADYEN_ENCRYPTED_DATA
Client side payment token
PAYPAL_BILLINGAGREEMENTID
Reference Transaction ID
PAYPAL_PAYERID
AFFILIATE
Affiliate
INVOICE_DELIVERY_METHOD
Method of invoice delivery
RESPONSE
Tags
Description
STATUS
Result of the action or status of an invoice
CUSTOMER_ID
A specific customer ID
HASH
Filter for hash
CHANGEDATA_URL
URL for changing Master data and invoice data
DASHBOARD_URL
URL leading to Dashboard
customer.checkvatid
Validates the VAT ID of a customer.
DATA
Tags
Description
VAT_ID Required
The VAT ID of a customer
RESPONSE
Tags
Description
STATUS
Result of the action or status of an invoice
EXTERNAL_CHECK
internal check of id syntax
customer.update
Updates the information of a customer.
DATA
Tags
Description
CUSTOMER_ID Required
A specific customer ID
SUPPRESS_MAIL
Suppress confirmation mail to customer (0 = no | 1 = yes)
CUSTOMER_NUMBER
The own customer number
CUSTOMER_EXT_UID
External ID of customer
CUSTOMER_TYPE
Customer type: business | consumer
ORGANIZATION
Company name [REQUIRED] when customer_type = business
POSITION
Position in the company
SALUTATION
Salutation: mr | mrs | family | "empty"
TITLE_ACADEMIC
Academic title
FIRST_NAME
First name
LAST_NAME
Last name [REQUIRED] when customer_type = consumer
ADDRESS
Address
ADDRESS_2
Address 2
ZIPCODE
ZIP code
CITY
City
STATE
State
COUNTRY_CODE
A country (ISO 3166 ALPHA-2)
LANGUAGE_CODE
Language code e.g. de, fr etc.
BIRTHDAY
Birthday
PHONE
Phone
PHONE_2
Phone 2
FAX
Fax number
MOBILE
Mobile phone number
EMAIL
e-mail address
ACCOUNT_RECEIVABLE
Accounts receivable number
CURRENCY_CODE
Currency code
VAT_ID
The VAT ID of a customer
TAX_ID
Tax ID
DAYS_FOR_PAYMENT
Days until date of payment
PAYMENT_TYPE
Payment type : 1 = transfer | 2 = direct debit | 3 = cash | 4 = paypal | 5 = advanced payment | 6 = credit card
ALLOWED_PAYMENT_TYPES
Set which payment types can be selected by customer - contact Support to activate this function. Payment type: 1 = transfer | 2 = direct debit | 4 = paypal |6 = credit card
PAYMENT_PROVIDER
Name of integrated Payment Gateway
PAYMENT_TOKEN
customer reference token provided by payment gateway
SHOW_PAYMENT_NOTICE
Show payment notice
BANK_NAME
Bank name
BANK_CODE
Bank code
BANK_ACCOUNT_NUMBER
Bank account number
BANK_ACCOUNT_OWNER
Bank account owner
BANK_ACCOUNT_OWNER_ADDRESS
Address of account owner
BANK_ACCOUNT_OWNER_CITY
City of account owner
BANK_ACCOUNT_OWNER_ZIPCODE
ZIP code of account owner
BANK_ACCOUNT_OWNER_EMAIL
e-Mail address of account owner
BANK_BIC
BIC
BANK_IBAN
IBAN
PAYMILL_TOKEN
Token for payment by credit card via Paymill
COMMENT
Comment
NEWSLETTER_OPTIN
Newsletter option: 0 = no | 1 = yes
X_ATTRIBUTES
Using own fields (webhooks will include it)
PAYMILL_AMOUNT
Amount of next payment (for balance)
WIRECARD_GATEWAYREFERENCENUMBER
ID for payments via Wirecard
ADYEN_ENCRYPTED_DATA
Client side payment token
PAYPAL_BILLINGAGREEMENTID
Reference Transaction ID
PAYPAL_PAYERID
AFFILIATE
Affiliate
INVOICE_DELIVERY_METHOD
Method of invoice delivery
RESPONSE
Tags
Description
STATUS
Result of the action or status of an invoice
CUSTOMER_ID
A specific customer ID
customer.delete
Deletes a customer.
DATA
Tags
Description
CUSTOMER_ID Required
A specific customer ID
RESPONSE
Tags
Description
STATUS
Result of the action or status of an invoice
customer.addcredits
Credit balance of a customer
DATA
Tags
Description
CUSTOMER_ID Required
A specific customer ID
AMOUNT Required
Amount
RESPONSE
Tags
Description
STATUS
Result of the action or status of an invoice
customer.createsecurelink
Creates a link to Account-Data and Dashboard of the Customer