---
title: "Create Customer"
method: POST
path: "/v2/customers"
tags: ["customer"]
---

# Create Customer

`POST /v2/customers`

Create a new customer

## Query parameters

- `disableAutomaticWorkflows` boolean

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Request body

- JTLWawiRestContractsModelsV1CustomerCreateCustomer — Model Class: CreateCustomer
  - `number` string — The customer's number.
  - `customerGroupId` string, uuid
  - `billingAddress` JTLWawiRestContractsModelsV1CommonCreateAddress — Model Class: CreateAddress
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `shipmentaddress` JTLWawiRestContractsModelsV1CommonCreateAddress — Model Class: CreateAddress
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `customAddress` JTLWawiRestContractsModelsV1CommonCreateAddress — Model Class: CreateAddress
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `otherAddresses` JTLWawiRestContractsModelsV1CustomerCreateOtherAddresses — Model Class: CreateOtherAddresses
    - `otherBillingAddresses` JTLWawiRestContractsModelsV1CommonCreateAddress[] — All other non-default billing addresses of the customer.
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `otherShippingAddresses` JTLWawiRestContractsModelsV1CommonCreateAddress[] — All other non-default shipping addresses of the customer.
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `otherCustomerAddresses` JTLWawiRestContractsModelsV1CommonCreateAddress[] — All other non-billing and non-shipping addresses of the customer.
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
  - `paymentSettings` JTLWawiRestContractsModelsV1CustomerCreatePaymentSettings — Model Class: CreatePaymentSettings
    - `paymentMethodId` string, uuid
    - `discount` number — The indicated discount, if any.
    - `paymentTarget` integer — The payment target in days.
    - `creditLimit` integer — The customer's credit limit.
    - `stopPaymentRequest` boolean — Option to stop payment requests.
  - `customerSince` string, date-time — Date since they have been a customer.
  - `lastChange` string, date-time — Date of the last customer's data change.
  - `languageIso` string — The customer's language.
  - `internalCompanyId` string, uuid — Represents a key for identifying a firm within the application.
  - `customerCategoryId` string, uuid
  - `taxIdentificationNumber` string — The customer's tax identification number.
  - `accountsReceivableNumber` integer — The customer's accounts receivable number.
  - `commercialRegisterNumber` string — The customer's commercial register number.
  - `website` string — The customer's website.
  - `initialContact` string — The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
  - `ebayUsername` string — The customer's eBay username.
  - `birthday` string, date-time — The customer's date of birth.
  - `isLocked` boolean — The customer's locked status for online shop sales channels.
  - `isCashRegisterBased` boolean — States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.

## Response `201`

The created customer.

- JTLWawiRestContractsModelsV1CustomerCustomer — Model Class: Customer
  - `id` string, uuid — Represents a unique key for identifying a customer in the JTL system.
  - `number` string — The customer's number.
  - `customerGroupId` string, uuid
  - `billingAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
    - `id` string, uuid
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `shipmentaddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
    - `id` string, uuid
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `customAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
    - `id` string, uuid
    - `company` string — Description of the Company.
    - `company2` string — Additional company information
    - `formOfAddress` string — Customer form of address
    - `title` string — Official title
    - `firstName` string — Customer first name
    - `lastName` string — Customer last name
    - `street` string — Street name in the customer's address
    - `address2` string — Additional address information
    - `postalCode` string — Postal code of the customer's address
    - `city` string — Name of city in the customer's address
    - `state` string — Name of state in the customer's address
    - `countryIso` string — Country ISO code
    - `vatID` string — Supplier VAT ID number
    - `phoneNumber` string — Landline phone number
    - `mobilePhoneNumber` string — Mobile phone number
    - `emailAddress` string — Email address
    - `fax` string — Fax number
  - `otherAddresses` JTLWawiRestContractsModelsV1CustomerOtherAddresses — Model Class: OtherAddresses
    - `otherBillingAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-default billing addresses of the customer.
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `otherShippingAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-default shipping addresses of the customer.
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `otherCustomerAddresses` JTLWawiRestContractsModelsV1CommonAddress[] — All other non-billing and non-shipping addresses of the customer.
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
  - `paymentSettings` JTLWawiRestContractsModelsV1CustomerPaymentSettings — Model Class: PaymentSettings
    - `paymentMethodId` string, uuid
    - `discount` number — The indicated discount, if any.
    - `paymentTarget` integer — The payment target in days.
    - `creditLimit` integer — The customer's credit limit.
    - `stopPaymentRequest` boolean — Option to stop payment requests.
  - `customerSince` string, date-time — Date since they have been a customer.
  - `lastChange` string, date-time — Date of the last customer's data change.
  - `languageIso` string — The customer's language.
  - `internalCompanyId` string, uuid — Represents a key for identifying a firm within the application.
  - `customerCategoryId` string, uuid
  - `taxIdentificationNumber` string — The customer's tax identification number.
  - `accountsReceivableNumber` integer — The customer's accounts receivable number.
  - `commercialRegisterNumber` string — The customer's commercial register number.
  - `website` string — The customer's website.
  - `initialContact` string — The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.
  - `ebayUsername` string — The customer's eBay username.
  - `birthday` string, date-time — The customer's date of birth.
  - `isLocked` boolean — The customer's locked status for online shop sales channels.
  - `isCashRegisterBased` boolean — States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.

## Other responses

- `400` — The sent data is invalid.
- `401`
- `402` — No licence available or the app has not been authorised by JTL.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)