---
title: "Basic customer object"
url: "https://help.internetx.com/en/api/core-basic-customer-object/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Objects"
updated: "2023-09-25"
---

# Basic customer object

## 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](/de/api/core-customertype-enum/) | 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](/de/api/core-gender-enum/) | 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](/de/api/core-objekt-basic-customercontact/) | Additional contact data |
| payment | payment | 1 | enum | [PaymentConstants](/de/api/core-payment-constants/) | 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](/en/api/core-invoice-days-object/) | Days until the invoice is due. |
|  | invoice\_paperbill | 1 | boolean |  | Way of sending the invoice.<br>• false = digital<br>• true = paper<br>Default value = false<br>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?<br>• false = Do not charge VAT<br>• true = Charge VAT<br>Default value = false<br>For XML also 0 (false) and 1 (true) can be used. |
| card | card | 1 | object | [Card](/de/api/core-objekt-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?<br>• false = No autodelete customer<br>• true = Autodelete customer<br>Default value = false<br>For XML also 0 (false) and 1 (true) can be used. |
| pending | pending | 1 | boolean |  | Is the customer's data in still being checked?<br>• false = Check completed<br>• true = In check<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>If the data is still being checked, there is a persist object that returns the currently checked data. |
| verifications |  | 0 - 1 | object | [BasicCustomerSpoolVerification](/de/api/core-objekt-basic-customer-spool-verification/) | Displays the email verifications in progress. |
| account | account | 1 | object | [Account](/de/api/core-objekt-account/) | Billing account of the customer |
| locked | locked | 1 | boolean |  | Is the customer locked?<br>• false = Not locked<br>• true = Locked<br>Default value = false<br>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.<br>"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](/de/api/core-objekt-sepa-mandate/) | 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<br>• false = Not read<br>• true = Read and accepted<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| newsletter | newsletter | 0 - 1 | boolean |  | Subscribed to the newsletter or not.<br>• false = Not subscribed<br>• true = Logged in<br>Default value = true<br>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](/en/api/core-basic-user-object/) | User assigned to this customer |
| updater | updater | 1 | object | [BasicUser](/en/api/core-basic-user-object/) | 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 |