> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teceo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# referência de campos do cliente

o cadastro do cliente se divide em 6 seções: dados gerais, adicionais, endereços, contatos, representantes e regras. campos marcados como obrigatórios variam conforme o status do cliente, e a marca pode ampliar essa lista.

<Note>
  o cliente integrado por um sistema de gestão aceita alteração apenas em classificações e representantes cadastrados na teceo. os demais campos ficam travados, detalhe completo em [editar clientes](/docs/clientes/editar-um-cliente-v2).
</Note>

## dados gerais

classificações e fotos internas e externas ficam dentro desta seção, não em abas próprias.

| campo | tipo | obrigatório | comportamento |
| - | - | - | - |
| localização | seleção de país | sim, em todo status | define pessoa física/jurídica, máscara do documento e preenchimento automático de endereço. só é definida na criação do cliente, trava depois de salvo |
| tipo de pessoa | pessoa física ou pessoa jurídica | sim, quando localização é Brasil, a partir de pendente | aparece só para cliente no Brasil. só é definido na criação |
| tipo do documento | seleção de uma lista de tipos internacionais | sim, em todo status | aparece só para cliente fora do Brasil. trava depois de criado |
| CPF ou CNPJ | texto com máscara de CPF ou CNPJ (fora do Brasil, número do documento sem máscara) | sim, quando localização é Brasil, a partir de pendente | trava quando o cadastro deixa de ser rascunho |
| nome da loja | texto | sim, em todo status | |
| razão social | texto | sim, quando pessoa jurídica no Brasil, a partir de pendente | aparece só quando tipo de pessoa é pessoa jurídica |
| código ERP | texto | não, a menos que a marca exija | trava quando o cliente é sincronizado por integração |
| inscrição estadual | texto | não, a menos que a marca exija | |
| código SUFRAMA | texto | não, a menos que a marca exija | |
| e-mail | texto | sim, quando localização é Brasil, a partir de pendente | |
| telefone | texto com código do país | sim, a partir de pendente | |
| WhatsApp | texto com código do país | não, a menos que a marca exija | |
| status | rascunho, pendente, ativo, bloqueado ou inativo | — | sempre travado nesta tela. muda só pelo menu de mais ações, descrito em [o ciclo de vida dos clientes](/docs/clientes/controlar-o-status-de-um-cliente-v2) |
| motivo de bloqueio | seleção de um motivo pré-cadastrado pela marca (não é texto livre) | não, mesmo com o cliente bloqueado | liberado só quando o status atual já é bloqueado. a ação de bloquear pelo menu de mais ações não pede motivo, ele é preenchido depois, aqui |
| saldo disponível | numérico | não, a menos que a marca exija | trava para o perfil vendedor |
| limite de crédito | numérico | não, a menos que a marca exija | trava para o perfil vendedor |
| canal digital | seleção | não, a menos que a marca exija | |
| observação | texto | não | |
| classificações | tags de uma lista pré-cadastrada pela marca (não é texto livre) | não, a menos que a marca exija | classificação vinda de integração não pode ser removida |
| fotos internas e externas | upload de imagem (png, jpg, webp ou svg) | não, a menos que a marca exija | aceita reordenar e baixar cada foto |
| origem | somente leitura | — | mostra se o cadastro veio de integração ou foi criado na plataforma |
| criado em, atualizado em | somente leitura | — | |

<Note>
  o motivo de bloqueio não é limpo ao desbloquear o cliente. se o cliente for bloqueado outra vez por outro motivo, o campo continua mostrando o motivo anterior até alguém trocar manualmente.
</Note>

## adicionais

a aba só aparece quando a marca tem ao menos um campo personalizado configurado. rótulo e obrigatoriedade de cada campo são definidos para a marca, não vêm de uma lista fixa da plataforma.

| tipo do campo | como aparece |
| - | - |
| texto | campo de texto livre |
| número inteiro | campo numérico |
| número | campo numérico |
| data | seletor de data |
| lista | seleção única de uma lista pré-cadastrada, com opção "vazio" |

## endereços

lista de endereços: o cliente aceita mais de um, com um marcado como principal. a quantidade máxima de endereços varia por marca.

| campo | tipo | obrigatório (quando endereço é exigido) | comportamento |
| - | - | - | - |
| este é o endereço principal | opção única | — | só um endereço por vez pode ser o principal |
| tipo | entrega, cobrança ou comercial | sim | |
| CEP | texto com máscara | sim | a máscara varia por país |
| logradouro | texto | sim | |
| número | texto | sim, só no Brasil | não exigido em endereço fora do Brasil |
| complemento | texto | não | |
| bairro | texto | sim, só no Brasil | não exigido em endereço fora do Brasil |
| cidade | texto | sim | preenchida automaticamente pelo CEP no Brasil, e trava nesse caso |
| estado | texto | sim | mesmo comportamento automático no Brasil |
| país | texto | sim | mesmo comportamento automático no Brasil |
| código | texto | não | |

endereço é exigido só nos status pendente e ativo. o botão de adicionar endereço trava ao atingir o limite definido pela marca.

## contatos

lista de pessoas de contato do cliente.

| campo | tipo | obrigatório (quando contato é exigido) | comportamento |
| - | - | - | - |
| nome | texto | sim | |
| sobrenome | texto | não | |
| email | texto | não | |
| telefone | texto com código do país | não | |
| função | seleção pré-cadastrada (proprietário(a), diretor(a), gerente, supervisor(a), comprador(a)) | não | não é texto livre |

## representantes

| campo | tipo | obrigatório | comportamento |
| - | - | - | - |
| representantes | seleção múltipla de uma lista pré-cadastrada, com um marcado como principal | não, a menos que a marca exija | trava para o perfil vendedor e para quem não tem permissão de editar representantes. representante vindo de integração não pode ser removido |

## regras

| campo | tipo | obrigatório | comportamento |
| - | - | - | - |
| grupo de clientes | seleção única | sim, quando exigido | |
| utilizar a tabela de preço do grupo de clientes | opção | — | só aparece com um grupo selecionado |
| tabela de preço | seleção única | sim, quando exigido | trava quando "utilizar a tabela de preço do grupo de clientes" está marcado |
| formas de pagamento | seleção múltipla pré-cadastrada | não | substitui qualquer configuração de forma de pagamento vinda de outro lugar |

os 4 campos travam para o perfil vendedor.

## conteúdos relacionados

<div className="relacionados">
  <CardGroup cols={1}>
    <Card title="criar clientes" icon="file-lines" href="/docs/clientes/criar-um-cliente-v2" horizontal />

    <Card title="editar clientes" icon="file-lines" href="/docs/clientes/editar-um-cliente-v2" horizontal />

    <Card title="o ciclo de vida dos clientes" icon="file-lines" href="/docs/clientes/controlar-o-status-de-um-cliente-v2" horizontal />
  </CardGroup>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.