# Cria um novo cliente

Cria umnovo cliente.

Endpoint: POST /api/v3/customers
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Request fields (application/json):

  - `name` (string, required)
    Nome do cliente pessoa física ou Razão social.
    Example: "Nome do Cliente"

  - `type` (string, required)
    Tipo do cliente.

- individual (Pessoa física)
- company (Pessoa jurídica)
    Enum: "individual", "company"

  - `birthday` (string)
    Data de nascimento do cliente pessoa física. Formato "YYYY-MM-DD"
    Example: "1990-12-25"

  - `company_name` (string)
    Razão Social
    Example: "MyCompany"

  - `notes` (string)
    Observações do cliente.
    Example: "Minhas obervações do cliente"

  - `contacts` (array)
    Lista de contatos do cliente.

  - `contacts.type` (string, required)
    Indica o tipo do contato.

- mobile: Número de telefone celular
- phone: Número de telefone (fixo ou celular)
- email: E-mail de contato
    Enum: "mobile", "phone", "email"

  - `contacts.value` (string, required)
    Dados do contato.
    Example: "joe@example.com"

  - `contacts.id` (number)
    Id do contato na CPlug.
    Example: 271

  - `addresses` (array)
    Lista de endereços do cliente.

  - `addresses.id` (number)
    id do endereço.
    Example: 220

  - `addresses.nickname` (string)
    Apelido do endereço.
    Example: "Casa"

  - `addresses.type` (string, required)
    Tipo do endereço.

- default endereço principal.
- shipping endereço de entrega.
- charge endereço de cobrança.
- other outro tipo de endereço.
    Enum: "default", "shipping", "charge", "other"

  - `addresses.street` (string, required)
    Nome do logradouro (Rua, Avenida, praça, etc).
    Example: "Avenida Paulista"

  - `addresses.number` (string)
    Número do logradouro.
    Example: "42 A"

  - `addresses.city_id` (number)
    ID da cidade.

Obrigatório quando o campo ibge_code não for passado.
    Example: 1234

  - `addresses.ibge_code` (string)
    Código do município segundo IBGE.

Exemplo: O código do município segundo IBGE é 3550308

Obrigatório quando o campo city_id não for passado.
    Example: "3550308"

  - `addresses.neighborhood` (string)
    Nome do Bairro.
    Example: "Bela Vista"

  - `addresses.complement` (string)
    Complemento do endereço.
    Example: "Apto 2550"

  - `addresses.zip_code` (string)
    CEP do endereço.
    Example: "01311000"

  - `documents` (array)
    Representa a lista de documentos

  - `documents.type` (string, required)
    Indica o tipo do documento.

- cpf: CPF Pessoa física
- rg: RG Pessoa física
- cnpj: CNPJ Pessoa jurídica
- ie: Inscrição Estadual Pessoa jurídica
- im: Inscrição Municipal Pessoa jurídica
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `documents.identify` (string, required)
    Identificação do documento.
    Example: "11144477735"

  - `companies` (array)
    Lista de empresas que permite visualizar.
    Example: [[1,2,3]]

  - `customer_category_id` (integer)
    Identificador único da categoria do cliente.

Você pode localizar os IDs das categorias de cliente no _endpoint_ de [listagem de categorias de clientes](#tag/CustomerCategory/operation/get-customer-categories).
    Example: 123

## Response 201 fields (application/json):

  - `id` (integer)
    Identificador único do Cliente.
    Example: 123

  - `name` (string)
    Nome do cliente pessoa física ou Razão social.
    Example: "Nome do Cliente"

  - `type` (string)
    Tipo do cliente.

- individual (Pessoa física)
- company (Pessoa jurídica)
    Enum: "individual", "company"

  - `birthday` (string)
    Data de nascimento do cliente Pessoa física. Formato "YYYY-MM-DD"
    Example: "1990-12-25"

  - `company_name` (string)
    Razão social da pessoa jurídica.
    Example: "MyCompany"

  - `notes` (string)
    Observações do cliente.
    Example: "Minhas obervações do cliente"

  - `created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `contacts` (array)
    Lista de contatos do cliente.

  - `contacts.type` (string, required)
    Indica o tipo do contato.

- mobile: Número de telefone celular
- phone: Número de telefone (fixo ou celular)
- email: E-mail de contato
    Enum: "mobile", "phone", "email"

  - `contacts.value` (string, required)
    Dados do contato.
    Example: "joe@example.com"

  - `contacts.id` (number)
    Id do contato na CPlug.
    Example: 271

  - `addresses` (array)
    Lista de endereços do cliente.

  - `addresses.id` (number)
    id do endereço.
    Example: 220

  - `addresses.nickname` (string)
    Apelido do endereço.
    Example: "Casa"

  - `addresses.type` (string, required)
    Tipo do endereço.

- default endereço principal.
- shipping endereço de entrega.
- charge endereço de cobrança.
- other outro tipo de endereço.
    Enum: "default", "shipping", "charge", "other"

  - `addresses.street` (string, required)
    Nome do logradouro (Rua, Avenida, praça, etc).
    Example: "Avenida Paulista"

  - `addresses.number` (string)
    Número do logradouro.
    Example: "42 A"

  - `addresses.city_id` (number)
    ID da cidade.

Obrigatório quando o campo ibge_code não for passado.
    Example: 1234

  - `addresses.ibge_code` (string)
    Código do município segundo IBGE.

Exemplo: O código do município segundo IBGE é 3550308

Obrigatório quando o campo city_id não for passado.
    Example: "3550308"

  - `addresses.state` (string)
    Sigla do estado do endereço.
    Example: "SP"

  - `addresses.city` (string)
    Nome da cidade.
    Example: "São Paulo"

  - `addresses.neighborhood` (string)
    Nome do Bairro.
    Example: "Bela Vista"

  - `addresses.complement` (string)
    Complemento do endereço.
    Example: "Apto 2550"

  - `addresses.zip_code` (string)
    CEP do endereço.
    Example: "01311000"

  - `documents` (array)
    Lista de documentos do cliente.

  - `documents.type` (string, required)
    Indica o tipo do documento.

- cpf: CPF Pessoa física
- rg: RG Pessoa física
- cnpj: CNPJ Pessoa jurídica
- ie: Inscrição Estadual Pessoa jurídica
- im: Inscrição Municipal Pessoa jurídica
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `documents.identify` (string, required)
    Identificação do documento.
    Example: "11144477735"

  - `companies` (array)
    Lista de empresas que permite visualizar.

  - `companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `category` (object)
    Representa uma categoria de Cliente.

  - `category.id` (integer)
    Identificador único da categoria de cliente.
    Example: 123

  - `category.name` (string)
    Nome da categoria.
    Example: "Ouro"

  - `category.is_wholesale` (boolean)
    Indica que todos os clientes vinculados à essa categoria irão pagar o valor de atacado dos produtos.

  - `category.discount_in_percent` (number)
    Desconto em percentual para a categoria.

Todos os clientes vinculados à essa categoria receberão o desconto informado automáticamente.
    Example: 2.5

  - `category.deleted` (boolean)
    Indica se está apagado ou não.

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields