Customer


customer.get

Requests the details of one or more customers. When no filter is set, 10 customers will be delivered. A LIMIT up to 100 customers is possible. The RESPONSE contains a "list of customers" and each of them with the following fields.


FILTER
TagsDescription
CUSTOMER_ID A specific customer ID
CUSTOMER_NUMBER Assigned customer number
COUNTRY_CODE A country (ISO 3166 ALPHA-2)
CITY City
TERM Search term in one of the given fields: ORGANIZATION, FIRST_NAME, LAST_NAME, ADDRESS, ADDRESS_2, ZIPCODE, EMAIL, TAGS.

RESPONSE
TagsDescription
CUSTOMER_ID A specific customer ID
CUSTOMER_NUMBER Assigned customer number
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
BANK_NAME Bank name
BANK_ACCOUNT_NUMBER Bank account number
BANK_CODE Bank code
BANK_ACCOUNT_OWNER Bank account owner
BANK_IBAN IBAN
BANK_BIC BIC
BANK_ACCOUNT_MANDATE_REFERENCE Mandate reference number
SHOW_PAYMENT_NOTICE Show payment notice
ACCOUNT_RECEIVABLE Accounts receivable number
CUSTOMER_TYPE Customer type: business | consumer
TOP
NEWSLETTER_OPTIN Deprecated Newsletter option: 0 = no | 1 = yes
ORGANIZATION Company name [REQUIRED] when CUSTOMER_TYPE = business
POSITION Position in the company
ACADEMIC_DEGREE Academic degree
SALUTATION Salutation: mr | mrs | family | "empty"
FIRST_NAME First name [REQUIRED] when CUSTOMER_TYPE = consumer
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_ADDRES
PHONE Phone
PHONE_2 Phone 2
FAX Fax number
MOBILE Mobile phone number
EMAIL e-mail address
WEBSITE Website
VAT_ID VAT identification number
CURRENCY_CODE Currency code
LASTUPDATE Date of latest update
TAGS Tags
DOCUMENT_HISTORY_URL URL to the document history of the customercenter

customer.create

Creates a new customer


DATA
TagsDescription
CUSTOMER_NUMBER Assigned customer number
CUSTOMER_TYPE Required Customer type: business | consumer
ORGANIZATION Required Company name [REQUIRED] when CUSTOMER_TYPE = business
POSITION Position in the company
ACADEMIC_DEGREE Academic degree
SALUTATION Salutation: mr | mrs | family | "empty"
FIRST_NAME First name [REQUIRED] when CUSTOMER_TYPE = consumer
LAST_NAME Required Last name [REQUIRED] when CUSTOMER_TYPE = consumer
ADDRESS Address
ADDRESS_2 Address 2
SECONDARY_ADDRESS Delivery address
ZIPCODE ZIP code
CITY City
STATE Federal state
COUNTRY_CODE A country (ISO 3166 ALPHA-2)
PHONE Phone
PHONE_2 Phone 2
FAX Fax number
MOBILE Mobile phone number
EMAIL e-mail address
WEBSITE Website
ACCOUNT_RECEIVABLE Accounts receivable number
CURRENCY_CODE Currency code
VAT_ID VAT identification number
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
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_MANDATE_REFERENCE Mandate reference number
TAGS Tags

RESPONSE
TagsDescription
STATUS Result of the action
CUSTOMER_ID A specific customer ID

customer.update

Updates the information of a customer.


DATA
TagsDescription
See action customer.create

RESPONSE
TagsDescription
STATUS Result of the action
CUSTOMER_ID A specific customer ID

customer.delete

Deletes a customer.


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID

RESPONSE
TagsDescription
STATUS Result of the action

contact.get

Requests the details of one or more contacts. When no filter is set, 10 contacts will be delivered.


FILTER
TagsDescription
CUSTOMER_ID A specific customer ID
CUSTOMER_NUMBER Assigned customer number
TERM Search term in one of the given fields: ORGANIZATION, FIRST_NAME, LAST_NAME, ADDRESS, ADDRESS_2, ZIPCODE, EMAIL, TAGS.
CONTACT_ID

RESPONSE
TagsDescription
CONTACT_ID
CUSTOMER_ID A specific customer ID
ORGANIZATION Company name [REQUIRED] when CUSTOMER_TYPE = business
POSITION Position in the company
SALUTATION Salutation: mr | mrs | family | "empty"
FIRST_NAME First name [REQUIRED] when CUSTOMER_TYPE = consumer
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
PHONE Phone
PHONE_2 Phone 2
FAX Fax number
MOBILE Mobile phone number
EMAIL e-mail address
VAT_ID VAT identification number
CURRENCY_CODE Currency code
CREATED Date of Creation
TAGS Tags

contact.create

Creates a new contact.


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID
ORGANIZATION Company name [REQUIRED] when CUSTOMER_TYPE = business
POSITION Position in the company
SALUTATION Salutation: mr | mrs | family | "empty"
FIRST_NAME First name [REQUIRED] when CUSTOMER_TYPE = consumer
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
PHONE Phone
PHONE_2 Phone 2
FAX Fax number
MOBILE Mobile phone number
EMAIL e-mail address
VAT_ID VAT identification number
CURRENCY_CODE Currency code
CREATED Date of Creation
TAGS Tags

RESPONSE
TagsDescription
STATUS Result of the action
CONTACT_ID

contact.update

Updates the information of a contact.


DATA
TagsDescription
See action customer.create

RESPONSE
TagsDescription
STATUS Result of the action
CONTACT_ID

contact.delete

Deletes a customer.


DATA
TagsDescription
CUSTOMER_ID Required A specific customer ID
CONTACT_ID Required

RESPONSE
TagsDescription
STATUS Result of the action
support@fastbill.com
© 2021 FastBill GmbH