Ir para o conteúdo

1.3. Dicionário de Dados

Nesta seção são documentadas as tabelas de definição (enums) utilizados nos endpoints de cadastro de cedente.

Serialização de enums em JSON: os enums são trafegados como string no padrão PascalCase, equivalente ao nome do membro do enum no backend (ex.: "PessoaFisica", "CNH", "Ltda"). Para algumas tabelas, o ID numérico também é aceito em entrada (legado). Em todas as respostas o valor é sempre string.


Tipo de Pessoa

Código Nome técnico (string) Descrição
1 PessoaFisica Pessoa Física (CPF)
2 PessoaJuridica Pessoa Jurídica (CNPJ)

Porte da Empresa

Código Nome técnico (string) Descrição
1 MEI Microempreendedor Individual (MEI)
2 Microempresa Microempresa (ME)
3 EmpresaPequenoPorte Empresa de Pequeno Porte (EPP)
4 MediaEmpresa Média empresa
5 GrandeEmpresa Grande empresa

Ramo de Atividade

Código Descrição
1 Indústria
2 Agrícola
3 Comércio
4 Importadora
5 Imobiliário
6 Serviços
7 Papelaria
8 Farmácia
9 Petrolífero
10 Financeiro
11 Fumo
12 Alimentos
13 Hospitalares
14 Metálicos
15 Transporte
16 Instalação
17 Primário
18 Terceiro Setor
19 Construção Civil

Tipo de Sociedade

Valores e nomes técnicos como retornados pela API quando enums são serializados em string (formato PascalCase).

Código Nome técnico (string) Descrição
1 Ltda LTDA
2 SA S.A.
3 LtdaME LTDA.ME
4 Outros Outros
5 InstituicaoFinanceira Instituição Financeira

Classificação de Risco

Código Rating
1 AA
2 A
3 B
4 C
5 D
6 E
7 F
8 G
9 H

Código de Coobrigação do Cedente

Código Descrição
1 Ambos (com e sem coobrigação)
2 Com coobrigação
3 Sem coobrigação

Estado Civil

Código Descrição
1 Solteiro(a)
2 Casado(a)
3 Separado(a) judicialmente
4 Divorciado(a)
5 Viúvo(a)
6 União Estável

Regime de Bens

Código Descrição
1 Comunhão total de bens
2 Comunhão parcial de bens
3 Separação total de bens
4 Participação final nos aquestos
5 Separação obrigatória de bens

Tipo de Parte Relacionada

Código Descrição
1 Presidente
2 Sócio
3 Administrador
4 Procurador
5 Diretor
6 Representante Legal
7 Conselheiro
8 Controlador

Papéis da Pessoa

Uma pessoa vinculada ao cedente pode acumular um ou mais papéis:

Campo Descrição
1 Sócio/Acionista — compõe o quadro societário
2 Representante legal — assina em nome da empresa
3 Avalista/Garantidor — garante operações

Tipo de Conta

Código Descrição
1 Conta Corrente
2 Conta Escrow / Vinculada
3 Conta Poupança

Tipo de Documento

Código Descrição
1 Contrato Social
2 CNH
3 RG — Frente
4 RG — Verso
5 Procuração
6 Balanço Patrimonial
7 DRE
8 Comprovante de Endereço
9 Estatuto Social
10 Ata de Eleição / Assembleia

Status do Documento

Código Descrição
1 Criado / Aguardando envio
2 Válido / Aceito
3 Inválido / Recusado
4 Cancelado
5 Aceito definitivamente

UF — Unidades Federativas

Código Nome
AC Acre
AL Alagoas
AP Amapá
AM Amazonas
BA Bahia
CE Ceará
DF Distrito Federal
ES Espírito Santo
GO Goiás
MA Maranhão
MT Mato Grosso
MS Mato Grosso do Sul
MG Minas Gerais
PA Pará
PB Paraíba
PR Paraná
PE Pernambuco
PI Piauí
RJ Rio de Janeiro
RN Rio Grande do Norte
RS Rio Grande do Sul
RO Rondônia
RR Roraima
SC Santa Catarina
SP São Paulo
SE Sergipe
TO Tocantins