# CreateCustomerRequest

Request object for creating a new customer in the system

## Example Usage

```typescript
import { CreateCustomerRequest } from "@flexprice/sdk/sdk/models";

let value: CreateCustomerRequest = {
  externalId: "<id>",
  name: "<value>",
};
```

## Fields

| Field                                                                                                                                                                                                         | Type                                                                                                                                                                                                          | Required                                                                                                                                                                                                      | Description                                                                                                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `addressCity`                                                                                                                                                                                                 | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_city is the city name with maximum 100 characters                                                                                                                                                     |
| `addressCountry`                                                                                                                                                                                              | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_country is the two-letter ISO 3166-1 alpha-2 country code                                                                                                                                             |
| `addressLine1`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_line1 is the primary address line with maximum 255 characters                                                                                                                                         |
| `addressLine2`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_line2 is the secondary address line with maximum 255 characters                                                                                                                                       |
| `addressPostalCode`                                                                                                                                                                                           | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_postal_code is the ZIP code or postal code with maximum 20 characters                                                                                                                                 |
| `addressState`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_state is the state, province, or region name with maximum 100 characters                                                                                                                              |
| `contact`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | contact is an optional contact number for the customer (e.g. phone)                                                                                                                                           |
| `email`                                                                                                                                                                                                       | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | email is the customer's email address and must be a valid email format if provided                                                                                                                            |
| `externalId`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                            | external_id is the unique identifier from your system to reference this customer (required)                                                                                                                   |
| `integrationEntityMapping`                                                                                                                                                                                    | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[]                                                                                               | :heavy_minus_sign:                                                                                                                                                                                            | integration_entity_mapping contains provider integration mappings for this customer                                                                                                                           |
| `metadata`                                                                                                                                                                                                    | Record<string, *string*>                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | metadata contains additional key-value pairs for storing extra information                                                                                                                                    |
| `name`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                            | name is the full name or company name of the customer                                                                                                                                                         |
| `onboardingWorkflowName`                                                                                                                                                                                      | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | onboarding_workflow_name is given if a custom onboarding workflow is to be triggered for this customer                                                                                                        |
| `skipOnboardingWorkflow`                                                                                                                                                                                      | *boolean*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                            | skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered<br/>This is used internally when a customer is created via a workflow to prevent infinite loops<br/>Default: false |
| `taxRateOverrides`                                                                                                                                                                                            | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                            | tax_rate_overrides contains tax rate configurations to be linked to this customer                                                                                                                             |
| `timezone`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata", "America/New_York")<br/>Defaults to "UTC" if not provided                                                                                 |