Entidade: Customfield

Visão Geral

A entidade Customfield representa campos personalizados que podem ser criados por empresas para capturar informações específicas do seu negócio. Esses campos customizados oferecem flexibilidade para adaptar o sistema às necessidades particulares de cada organização, permitindo diferentes tipos de entrada de dados como texto, seleção de opções, estados e cidades.

Estrutura da Entidade

Campos Principais

Campo	Tipo	Descrição	Obrigatório
`id`	number	Identificador único do campo customizado	✅ (auto)
`name`	string	Nome do campo customizado	✅
`type`	string	Tipo do campo (`text`, `selectbox`, `state`, `city`)	✅
`status`	string	Status do campo (`active`, `inactive`)	✅ (auto)
`companyId`	number	ID da empresa proprietária	✅ (auto)
`createdAt`	DateTime	Data/hora de criação	✅ (auto)
`updatedAt`	DateTime	Data/hora da última atualização	✅ (auto)

Relacionamentos

Company: Empresa proprietária do campo

CustomfieldOptions: Opções disponíveis para campos do tipo selectbox

Tipos Disponíveis

Tipo	Descrição
`text`	Campo de texto livre
`selectbox`	Campo de seleção com opções predefinidas
`state`	Campo específico para estados/províncias
`city`	Campo específico para cidades

Casos de Uso Detalhados

1. Criação de Campo de Segmento de Mercado

Cenário: Uma empresa deseja categorizar seus clientes por segmento de mercado.

Fluxo:

O administrador acessa a seção de campos customizados

Cria um campo do tipo selectbox chamado "Segmento de Mercado"

Define opções como "Varejo", "Atacado", "E-commerce"

O campo fica disponível para uso em formulários de clientes

Benefícios:

Padronização das categorias

Facilita relatórios e análises segmentadas

2. Campo Único por Tipo (State/City)

Cenário: Uma empresa tenta criar um segundo campo do tipo state.

Fluxo:

O usuário tenta criar um novo campo do tipo state

O sistema verifica se já existe um campo deste tipo na empresa

Retorna erro informando que já existe um campo do tipo state

Benefícios:

Evita duplicação desnecessária

Mantém consistência na estrutura de dados

Regras de Negócio

Criação de Campos

Todos os campos são associados automaticamente à empresa do usuário autenticado

Status padrão é active na criação

Para tipos state e city: apenas um campo por tipo é permitido por empresa

Para tipo selectbox: opções podem ser definidas durante a criação

Edição de Campos

Campos podem ter suas informações básicas alteradas

Para campos selectbox: opções são recriadas completamente durante atualização

Apenas campos da própria empresa podem ser editados

Exclusão de Campos

Somente campos da própria empresa podem ser excluídos

Exclusão é permanente (hard delete)

Validações

Nome do campo é obrigatório

Tipo deve ser um dos valores permitidos

Para campos selectbox com opções, as opções são obrigatórias

Operações Disponíveis

Operação	Descrição	Método HTTP
Listar	Lista campos customizados com paginação	GET
Criar	Cria um novo campo customizado	POST
Visualizar	Recupera um campo específico	GET
Atualizar	Altera informações do campo	PUT/PATCH
Excluir	Remove um campo customizado	DELETE

Custom Field

Entidade: Customfield

Visão Geral

Estrutura da Entidade

Campos Principais

Relacionamentos

Tipos Disponíveis

Casos de Uso Detalhados

1. Criação de Campo de Segmento de Mercado

2. Campo Único por Tipo (State/City)

Regras de Negócio

Criação de Campos

Edição de Campos

Exclusão de Campos

Validações

Operações Disponíveis

Fluxo de Uso

Custom Field

Entidade: Customfield#

Visão Geral#

Estrutura da Entidade#

Campos Principais#

Relacionamentos#

Tipos Disponíveis#

Casos de Uso Detalhados#

1. Criação de Campo de Segmento de Mercado#

2. Campo Único por Tipo (State/City)#

Regras de Negócio#

Criação de Campos#

Edição de Campos#

Exclusão de Campos#

Validações#

Operações Disponíveis#

Fluxo de Uso#

Entidade: Customfield

Visão Geral

Estrutura da Entidade

Campos Principais

Relacionamentos

Tipos Disponíveis

Casos de Uso Detalhados

1. Criação de Campo de Segmento de Mercado

2. Campo Único por Tipo (State/City)

Regras de Negócio

Criação de Campos

Edição de Campos

Exclusão de Campos

Validações

Operações Disponíveis

Fluxo de Uso