document-types

Catálogo de códigos de tipo de documento de pessoa (por exemplo, CPF, CNPJ, passaporte) com associação de país e regras de unicidade, usado para classificar entradas de documento nos registros de pessoa.

Caminho de origem: libraries/crm/src/document-type

Arquivo do módulo: document-type.module.ts

Introdução

O submódulo Document Types gerencia o catálogo de referência para documentos de identidade e registro anexados a pessoas (document_type_id em cada entrada de documento de pessoa). Cada entrada carrega um código estável, um country_code indicando a qual jurisdição o documento se aplica (por exemplo, "BR" para CPF/CNPJ, "US" para SSN/EIN), uma flag is_unique que controla se o valor do documento deve ser único entre todas as pessoas, e nomes de exibição traduzidos por locale.

A associação de country_code permite que uma única implantação atenda às convenções de documentos de múltiplos países lado a lado — uma instância de CRM brasileira pode registrar tanto o tipo de documento CPF (indivíduo) quanto CNPJ (empresa), cada um com sua própria regra de unicidade, sem codificar de forma fixa a lógica de validação específica de país no próprio submódulo Persons. Assim como Contact Types, este catálogo é totalmente mutável através de endpoints CRUD padrão.

Endpoints HTTP

5 endpoints

Lista paginada de tipos de documento de pessoa.

Query: page, pageSize, search

Obtém um único tipo de documento por ID.

Params: id (int)

Cria um novo tipo de documento.

Body

Field	Type	Required	Notes
code	string	yes	—
country_code	string	yes	ISO country code, e.g. "BR"
is_unique	boolean	yes	Whether this document must be unique per person
locale	Record<string, { name: string }>	yes	e.g. { "en": { "name": "..." } }

Atualiza um tipo de documento (mesmos campos da criação, todos opcionais).

Params: id (int)

Exclui um ou mais tipos de documento.

Body

Field	Type	Required	Notes
ids	number[]	yes	IDs to delete

Ferramentas MCP

Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).

crm.document-types.list
Lista tipos de documento de pessoa (por exemplo, CPF, CNPJ, Passaporte) com paginação
crm.document-types.get
Retorna um único tipo de documento por ID
crm.document-types.create
Cria um novo tipo de documento com nome multi-locale
crm.document-types.update
Atualiza um tipo de documento existente por ID
crm.document-types.delete
Exclui um ou mais tipos de documento pelos seus IDs