Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Um Segmento classifica Contas por características comuns ou regras de negócio.

​
Antes de começar

Você precisa de uma Organização e um Ledger existentes. Crie Segmentos quando as Contas precisarem de uma classificação compartilhada para relatórios, roteamento, regras de tarifas ou controles operacionais.

​
Crie o Segmento

Para criar um Segmento, siga estes passos:
1
Na página Segmentos, clique no botão Novo Segmento.
2
O formulário Novo Segmento será aberto no lado direito da tela.
3
Informe o Nome do Segmento na aba Detalhes do Segmento.
4
(Opcional) Selecione a aba Metadata para adicionar qualquer metadado que queira usar.
5
Após preencher as informações, clique no botão Salvar.
6
O Segmento aparecerá na lista de Segmentos disponíveis para o seu Ledger.

​
Guia de campos

CampoO que informarExemplo
Nome do SegmentoNome obrigatório para um grupo de Contas com características ou regras compartilhadas.Retail Customers
Metadata KeyNome opcional do campo de classificação ou integração.region
Metadata ValueValor da chave de metadado.BR-SP
Os campos da aba Metadata são abertos. Não há chaves ou valores predefinidos. Use nomes de chave consistentes em toda a sua Organização, como region, businessLine ou channel, para que os Segmentos permaneçam úteis para filtragem e relatórios.

​
Próximos passos

Após criar o Segmento, vincule-o às Contas em Adicionando um Segmento a uma Conta, ou crie as Contas que devem pertencer a ele em Criando uma Conta.

Equivalente na API

Endpoint Criar um Segmento