> ## 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 plano

o plano se divide em três seções: dados gerais, critérios e dimensões. o tipo do plano define quais seções existem e quais valores cada campo aceita, e o plano de compra da loja não tem a seção de critérios.

## dados gerais

| campo | tipo | obrigatório | comportamento |
| - | - | - | - |
| nome | texto | obrigatório em todo tipo de plano, com no máximo 120 caracteres | sugerido automaticamente como destinatário - período, e a sugestão deixa de ser aplicada quando o nome é digitado: apagar o conteúdo do campo faz a sugestão voltar. o espaço em volta é descartado antes de gravar. não precisa ser único, e aceita alteração em qualquer status |
| código | número inteiro | gerado pela plataforma | sequencial por tipo de plano e por origem, a partir de 1 |
| para quem | seleção de um cliente | obrigatório no plano de cliente, e inexistente no plano de compra da loja | a busca lista só clientes aprovados. cliente de outra marca é recusado |
| tipo do período | intervalo de datas ou coleção do pedido | obrigatório no plano de cliente | no plano de compra da loja, que usa sempre um intervalo de datas, não é exibido |
| período | duas datas, ou uma coleção da marca | obrigatório: as duas datas em intervalo de datas, a coleção em coleção do pedido | o seletor da data final não oferece data anterior à inicial. em coleção do pedido os campos de data deixam de ser exibidos, e a coleção precisa ser da própria marca |
| medida | valor bruto, valor líquido ou peças | obrigatório em todo tipo de plano | define a unidade do valor do plano, do valor de cada linha e do realizado. é definida na criação e não aceita alteração depois |
| valor do plano | numérico | opcional em todo tipo de plano | fica desabilitado enquanto a medida não é definida. em valor bruto e valor líquido aceita duas casas decimais e prefixo de moeda, e em peças não aceita casa decimal nem prefixo. quando preenchido, precisa ser maior que zero, ter no máximo 15 dígitos e ser inteiro na medida peças. mudar a medida descarta o valor digitado quando as casas decimais mudam. convive com as dimensões, e pode ser maior que a soma dos valores das linhas |

nome, para quem e valor do plano são editados diretamente na seção de dados gerais. o período é editado no formulário editar período, que reúne o tipo do período e as datas ou a coleção.

a data agendada não entra nesta seção: ela é coluna e filtro da listagem de cliente, editada na própria listagem, e está em [listagem de planos](/docs/planos/listagem-de-planos).

## critérios

o critério define o que entra no realizado, e não altera o valor planejado. definir critério é opcional, cada tipo entra uma vez só e o máximo por plano é 4. como os valores de um critério e de vários critérios se combinam está em [definir os critérios do plano](/docs/planos/definir-os-criterios-do-plano).

| critério | valores | em qual plano | comportamento |
| - | - | - | - |
| disponibilidade | pré-venda ou pronta-entrega | só de cliente | no realizado, pré-venda inclui também os itens de estoque futuro. estoque futuro e sem estoque não são valores aceitos |
| janela de entrega | as janelas de entrega da marca | só de cliente | exige pré-venda entre os valores de disponibilidade, e a regra vale nos dois sentidos. sem nenhum valor de disponibilidade escolhido é aceita, e nesse caso toda disponibilidade conta |
| classificação de produto | os valores do tipo de classificação de produto que a marca cadastrou | só de cliente | valor de outra marca é recusado |

o plano de compra da loja não aceita critério, e a seção de critérios não é exibida no formulário dele.

## dimensões

a dimensão quebra o plano em linhas. a quebra é opcional, e sem nenhum nível o plano não tem itens e o valor fica no próprio plano.

| dimensão | base de atributos | itens | comportamento |
| - | - | - | - |
| categoria teceo | teceo | um dos cinco atributos padronizados pela teceo: categoria, marca, cor, gênero e material | cada atributo entra como um nível próprio, e atributo teceo fora dessa lista é recusado |
| categoria da marca | da marca | as categorias do cadastro de produtos da marca | oferecida quando a marca tem categoria cadastrada |
| subcategoria da marca | da marca | as subcategorias do cadastro de produtos da marca | entra só no nível imediatamente abaixo de categoria da marca, e enquanto o nível acima não for esse aparece desabilitada. oferecida quando a marca tem subcategoria cadastrada |
| janela de entrega | da marca | as janelas de entrega da marca | oferecida quando a marca tem janela de entrega cadastrada |

as duas bases de atributos não se misturam: o primeiro nível define a base do plano inteiro, e a partir dele só dimensões da mesma base são oferecidas. no plano de compra da loja só a base teceo é oferecida. a dimensão já usada deixa de ser oferecida, e só o último nível da lista aceita remoção.

| limite | valor |
| - | - |
| níveis de dimensão por plano | 3 |
| itens por nível | 1.000 |
| linhas na árvore | 10.000, contando as linhas e os agrupamentos acima delas |
| bases de atributos por plano | 1 |
| caracteres na busca de itens | 100 |

## status

o plano de cliente é criado como sugerido, e o plano de compra da loja como rascunho. as mudanças de status estão em [o ciclo de vida dos planos](/docs/planos/o-ciclo-de-vida-dos-planos).

| status | em qual plano |
| - | - |
| sugerido | de cliente |
| rascunho | nos dois |
| aberto | nos dois |
| encerrado | de compra da loja |
| fechado e ganho | de cliente |
| fechado e perdido | de cliente |
| cancelado | nos dois |

## motivo de perda

o motivo de perda é obrigatório em fechado e perdido, e recusado em qualquer outro status. são 14:

* coleção sem atratividade
* condições comerciais sem atratividade
* preço sem atratividade
* estoque alto
* cliente bloqueado
* problemas de faturamento
* substituição por franquia ou loja
* substituição por outro varejista
* conflito com o site
* vai comprar na próxima coleção
* cliente de outra marca do grupo
* mudança de CNPJ
* loja fechada
* desastres naturais

## colunas da listagem

as colunas de cada listagem, com o que é ordenável e o que aceita ser ocultado, estão em [listagem de planos](/docs/planos/listagem-de-planos).

## conteúdos relacionados

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

    <Card title="preencher os valores dos itens" icon="file-lines" href="/docs/planos/preencher-os-valores-dos-itens" horizontal />
  </CardGroup>
</div>


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