---
title: "View customer"
method: GET
path: "/api/v2/customers/{id}"
tags: ["Customer"]
---

# View customer

`GET /api/v2/customers/{id}`

Returns details of a single customer

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

Customer response object

- object
  - `data` object, required — Customer object
    - `id` string, required — Resource identifier.
    - `uuid` string, nullable — Nullable UUID identifier of the resource.
    - `createdAt` string, date-time, required — Timestamp when the customer was created
    - `updatedAt` string, date-time, required — Timestamp when the customer was last updated
    - `number` string, required — Customer number. if this is not provided default number ranges will be applied automatically
    - `deviatingCustomerNumber` string, required — Deviating Customer number.
    - `customerType` 'company' | 'person', nullable, required — Type of customer
    - `name` string, required — Full name of the customer
    - `firstname` string, required — First name of the customer
    - `lastname` string, required — Last name of the customer
    - `title` string, nullable — Additional information used for salutations
    - `salutation` 'company' | 'mr' | 'mrs' | 'other', nullable, required — Salutation of the customer
    - `salutationPhrase` string, nullable, required — You can specify a salutation how a customer/company should be addressed and override automatic rules.
    - `birthdate` string, date, nullable — Birthdate of customer
    - `department` string, nullable, required — Department of customer if necessary and available
    - `subDepartment` string, nullable, required — Sub-Department of customer if necessary and available
    - `mainProject` object, required — Main Project id
      - `id` string, required — Resource identifier.
    - `projects` object[], required — List of customer projects
      - `id` string, required — Resource identifier.
    - `groups` object[], required — List of groups the customer belongs to
      - `id` string, required — Resource identifier.
    - `contactDetails` object, required — Contact information of a customer
      - `phone` string, nullable — Phone number of a customer
      - `mobile` string, nullable — Mobile number of a customer
      - `fax` string, nullable — Fax number of a customer
      - `email` string, nullable — Email address of a customer
      - `website` string, nullable — URL of customers website
      - `additionalData` object[] — List of additional not default contact data
        - `label` string, required — Specific key for customer contact data
        - `value` string, nullable, required — Value for specified customers contact data key
    - `accountManager` object, nullable, required — Account manager of this customer
      - `id` string, required — Resource identifier.
    - `salesManager` object, nullable, required — Sales manager of this customer
      - `id` string, required — Resource identifier.
    - `isLead` boolean, required — Tells if customer is a lead
    - `contactPerson` string, nullable, required — Name of contact person
    - `language` string, nullable — Language ISO code for customer communication
    - `commission` number, float — Commission percentage for this customer
    - `identifier` string, nullable — Custom identifier for the customer
    - `logfile` string — Log entries of customer activities
    - `lat` number, float, nullable — Latitude coordinate
    - `lng` number, float, nullable — Longitude coordinate
    - `fromShop` object — Shop where customer originated from
      - `id` string, required — Resource identifier.
    - `marketing` object — Marketing preferences and settings
      - `marketingBan` boolean — Whether marketing is banned for this customer
      - `showBirthdayInCalendar` boolean — Show customer birthday in calendar
      - `birthdayCard` boolean — Send birthday card to customer
      - `ageApproval` boolean — Customer has approved age verification
    - `documentDelivery` object, required — Additional E-Mail addresses used for deliver business letters
      - `offer` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `salesOrder` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `invoice` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `creditNote` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `deliveryNote` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `purchaseOrder` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `dunning` object, required
        - `email` string, nullable — E-mail address used for sending document
        - `cc` string, nullable — E-mail address used for sending copy of document
      - `autoCreateDocuments` 'both' | 'delivery_note' | 'invoice' — Create receipts in auto-shipping
      - `invoiceAlwaysPaper` boolean — Even with automatic dispatch, a paper invoice is always created
      - `amountInvoicePrints` integer, nullable — Number of printouts during shipping
      - `preferFax` boolean — Prefer sending by FAX
    - `customFields` object[]
      - `id` string — Identifier of custom field (between 1 and 20)
      - `name` string — Configured name of custom field
      - `value` string — Value of configured custom field for this specific customer
    - `financials` object — Financial information
      - `tax` object — Tax information
        - `taxation` 'domestic' | 'eu-delivery' | 'export' | 'free' — Taxation
        - `taxDisplay` 'automatically' | 'always-net' | 'always-gross' — Display of receipts with gross / net values.
        - `useDeliveryThreshold` boolean — Use delivery threshold
        - `taxNumber` string, nullable — Tax number
        - `vatId` string — VAT ID of customer
      - `paymentTerms` object — Payment terms
        - `fixedPaymentTerms` boolean — Fixed payment terms
        - `paymentTargetDays` integer, nullable — Payment terms target in days
        - `paymentTargetDiscount` number — Payment terms target discount
        - `paymentTargetDiscountDays` integer, nullable — Payment terms discount days
      - `paymentMethod` object, nullable
        - `id` string, nullable, required — Nullable resource identifier
      - `subscriptionPaymentMethod` 'invoice' | 'direct-debit', nullable — Payment method for subscriptions
      - `customsInformation` string, nullable — Customs information
      - `creditLimit` number, float — Credit limit
      - `defaultCurrency` string — Default currency for this customer
    - `primaryBankAccount` object — Primary bank account information
      - `bankName` string, nullable — Name of bank institute
      - `owner` string, nullable — Name of bank account owner
      - `iban` string, nullable — International bank account number
      - `bic` string, nullable — Business Identifier Code
      - `sepa` object — SEPA information
        - `companySepa` boolean — Another SEPA mandate is created especially for companies.
        - `mandateReference` string, nullable — SEPA mandate reference
        - `mandateReferenceChange` boolean — If true it creates a different XML for changed mandate reference in the SEPA format
        - `mandateReferenceDate` string, date, nullable — Date of mandate reference change
        - `usage` 'single' | 'recurring' — One time mandata reference or valid for recurring payments
        - `initial` boolean — If true it is first usage of this reference
        - `remark` string, nullable — Additional comment
    - `shipping` object, required — Customer shipping information
      - `freeShipping` boolean, nullable, required — Indicates if free shipping is enabled for this customer
      - `freeShippingFrom` number, float, required — Minimum order amount for free shipping
      - `trackingMailBan` boolean, required — Indicates if tracking mail is banned for this customer
      - `deliveryBan` boolean, nullable, required — Indicates if delivery is banned for this customer
      - `deliveryBanDate` string, date, nullable, required — Date when delivery ban was set
      - `deliveryBanReason` string, nullable, required — Reason for delivery ban
      - `shippingMethod` object, nullable — Nullable reference to another resource
        - `id` string, required — Resource identifier.
  - `links` object — A collection of related links for the customer resource.
    - `self` string — Self-reference link to the customer resource
    - `contactPersons` string — Link to the contact person of the customer
    - `addresses` string — Link to the addresses of the customer

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/versions/8a27ba392442/schema)