# Tipagens

Chamamos de tipo a definição das propriedades dentro de cada objeto presente nos retornos de nossa API.

Aqui você encontra um resumo das tipagens tanto para os Dados Empresariais como Portais Públicos.

# Empresa

Company

Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código da empresa
`name`	`string`	Razão social
`jurisdiction`	`string`	Ente federativo responsável
`equity`	`number`	Capital social
`nature`	Nature	Natureza jurídica
`size`	Size	Porte da empresa
`simples`	Simples	Regime do Simples Nacional
`simei`	Simples	Regime do SIMEI
`members`	Member[]	Quadro de sócios e administradores

# Porte

Size

Parentes: Company
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código do porte
`acronym`	`string`	`ME`, `EPP` ou `DEMAIS`
`text`	`string`	`Microempresa`, `Empresa de Pequeno Porte` ou `Demais`

# Natureza Jurídica

Nature

Parentes: Company
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código da natureza jurídica
`text`	`string`	Descrição conforme tabela fornecida pelo IBGE

# Simples Nacional

Simples

Parentes: Company
Fonte: Simples Nacional

Propriedade	Tipo	Descrição
`optant`	`boolean`	Indica se optante pelo Simples ou SIMEI
`since`	`string`	Data de início do período atual de opção
`history`	History[]	Histórico de períodos anteriores

# Histórico de Períodos

History

Parentes: Simples
Fonte: Simples Nacional

Propriedade	Tipo	Descrição
`from`	`string`	Data de início do período
`until`	`string`	Data de término do período
`text`	`string`	Detalhes de encerramento do período

# Estabelecimento

Office

Parentes: Company
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`taxId`	`string`	CNPJ do estabelecimento
`alias`	`string`	Nome fantasia
`founded`	`string`	Data de abertura
`head`	`boolean`	Indica se o estabelecimento é a matriz
`statusDate`	`string`	Data da situação cadastral
`status`	Status	Situação cadastral
`reason` Se status.id != 2	Reason	Motivo da situação cadastral
`specialDate`	`string`	Data da situação especial em formato ISO
`special` Se specialDate != null	Special	Situação cadastral especial
`address`	Address	Endereço de cadastro
`phones`	Phone[]	Telefones de cadastro
`emails`	Email[]	E-mails de cadastro
`mainActivity`	Activity	Atividade econômica principal
`sideActivities`	Activity[]	Atividades econômicas secundárias
`registrations`	Registration[]	Inscrições estaduais
`links`	Link[]	Links públicos para visualização de arquivos

# Situação Cadastral

Status

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código da situação cadastral
`text`	`string`	`Nula`, `Ativa`, `Suspensa`, `Inapta` ou `Baixada`

# Motivo da Situação

Reason

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`string`	Código do motivo da situação cadastral
`text`	`string`	Descrição conforme tabela fornecida pela Receita

# Situação Especial

Special

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código da situação cadastral especial
`text`	`string`	Descrição conforme tabela fornecida pela Receita

# Endereço

Address

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`municipality`	`number`	Código IBGE do município
`street`	`string`	Logradouro incluindo tipo
`number`	`string`	Número
`details`	`string`	Complemento
`district`	`string`	Bairro
`city`	`string`	Nome do município ou cidade no exterior
`state`	`string`	Unidade federativa
`zip`	`string`	Código postal
`country`	Country	País de origem

# País

Country

Parentes: Address , Person
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código M49 do país
`name`	`string`	Nome do país

# Telefone

Phone

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`area`	`string`	DDD com 2 dígitos
`number`	`string`	Número com 8 dígitos

# E-mail

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`address`	`string`	Endereço de e-mail
`domain`	`string`	Domínio de registro

# Atividade Econômica

Activity

Parentes: Office
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código IBGE da atividade econômica
`text`	`string`	Descrição conforme tabela fornecida pelo IBGE

# Inscrição Estadual

Registration

Parentes: Office
Fonte: Cadastro de Contribuintes

Propriedade	Tipo	Descrição
`number`	`string`	Número da inscrição estadual
`state`	`string`	Sigla da UF de registro
`enabled`	`boolean`	Indica se a IE está habilitada como contribuinte

# Link Assinado

Link

Parentes: Office

Propriedade	Tipo	Descrição
`type`	`string`	Tipo do link: • `RFB_CERTIFICATE`: Comprovante da Receita Federal • `SIMPLES_CERTIFICATE`: Comprovante do Simples Nacional • `OFFICE_MAP`: Mapa dos Arredores • `OFFICE_STREET`: Visão da Rua
`url`	`string`	Endereço público, assinado pelo seu usuário, para exibição do conteúdo do link

# Sócio ou Administrador

Member

Parentes: Company
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`since`	`string`	Data de entrada na sociedade em formato ISO
`person`	Person	Sócio ou administrador
`role`	Role	Qualificação no quadro societário
`agent` Se aplicável	Agent	Representante legal

# Representante Legal

Agent

Parentes: Member
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`person`	Person	Representante (pessoa física)
`role`	Role	Qualificação frente ao representado

# Qualificação

Role

Parentes: Member , Agent
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`number`	Código da qualificação societária
`text`	`string`	Descrição conforme tabela fornecida pela Receita

# Pessoa

Person

Parentes: Member , Agent
Fonte: Receita Federal

Propriedade	Tipo	Descrição
`id`	`string`	Código da pessoa
`type`	`string`	Tipo da pessoa: • `LEGAL` : Jurídica • `NATURAL` : Física • `FOREIGN` : Estrangeira • `UNKNOWN` : Desconhecida
`name`	`string`	Nome ou razão social
`taxId` Se type != 'FOREIGN'	`string`	CPF censurado ou CNPJ
`age` Se type == 'NATURAL'	`string`	Faixa etária
`country` Se type == 'FOREIGN'	Country	País de origem