Brasilapi.Cnpj.Company (BrasilAPI v0.1.5)

View Source

Represents a company data structure from the CNPJ API.

Summary

Types

cnae_secundario()
qsa()
regime_tributario()
t()

Functions

from_map(data)

Converts a map from the API response to a Company struct.

Types

cnae_secundario()

@type cnae_secundario() :: %{codigo: integer() | nil, descricao: String.t() | nil}

qsa()

@type qsa() :: %{
  pais: String.t() | nil,
  nome_socio: String.t() | nil,
  codigo_pais: String.t() | nil,
  faixa_etaria: String.t() | nil,
  cnpj_cpf_do_socio: String.t() | nil,
  qualificacao_socio: String.t() | nil,
  codigo_faixa_etaria: integer() | nil,
  data_entrada_sociedade: String.t() | nil,
  identificador_de_socio: integer() | nil,
  cpf_representante_legal: String.t() | nil,
  nome_representante_legal: String.t() | nil,
  codigo_qualificacao_socio: integer() | nil,
  qualificacao_representante_legal: String.t() | nil,
  codigo_qualificacao_representante_legal: integer() | nil
}

regime_tributario()

@type regime_tributario() :: %{
  optional(:dt_fim_op_simples) => String.t() | nil,
  optional(:dt_ini_op_simples) => String.t() | nil,
  optional(:dt_opcao_mei) => String.t() | nil,
  optional(:dt_exclusao_mei) => String.t() | nil
}

t()

@type t() :: %Brasilapi.Cnpj.Company{
  bairro: String.t() | nil,
  capital_social: number() | nil,
  cep: String.t() | nil,
  cnae_fiscal: integer() | nil,
  cnae_fiscal_descricao: String.t() | nil,
  cnaes_secundarios: [cnae_secundario()],
  cnpj: String.t() | nil,
  codigo_municipio: integer() | nil,
  codigo_municipio_ibge: integer() | nil,
  codigo_natureza_juridica: integer() | nil,
  codigo_pais: String.t() | nil,
  codigo_porte: integer() | nil,
  complemento: String.t() | nil,
  data_exclusao_do_mei: String.t() | nil,
  data_exclusao_do_simples: String.t() | nil,
  data_inicio_atividade: String.t() | nil,
  data_opcao_pelo_mei: String.t() | nil,
  data_opcao_pelo_simples: String.t() | nil,
  data_situacao_cadastral: String.t() | nil,
  data_situacao_especial: String.t() | nil,
  ddd_fax: String.t() | nil,
  ddd_telefone_1: String.t() | nil,
  ddd_telefone_2: String.t() | nil,
  descricao_identificador_matriz_filial: String.t() | nil,
  descricao_motivo_situacao_cadastral: String.t() | nil,
  descricao_porte: String.t() | nil,
  descricao_situacao_cadastral: String.t() | nil,
  descricao_tipo_de_logradouro: String.t() | nil,
  email: String.t() | nil,
  ente_federativo_responsavel: String.t() | nil,
  identificador_matriz_filial: integer() | nil,
  logradouro: String.t() | nil,
  motivo_situacao_cadastral: integer() | nil,
  municipio: String.t() | nil,
  natureza_juridica: String.t() | nil,
  nome_cidade_no_exterior: String.t() | nil,
  nome_fantasia: String.t() | nil,
  numero: String.t() | nil,
  opcao_pelo_mei: String.t() | nil,
  opcao_pelo_simples: String.t() | nil,
  pais: String.t() | nil,
  porte: String.t() | nil,
  qsa: [qsa()],
  qualificacao_do_responsavel: integer() | nil,
  razao_social: String.t() | nil,
  regime_tributario: [regime_tributario()],
  situacao_cadastral: integer() | nil,
  situacao_especial: String.t() | nil,
  uf: String.t() | nil
}

Functions

from_map(data)

@spec from_map(map()) :: t()

Converts a map from the API response to a Company struct.

Examples

iex> data = %{"cnpj" => "11000000000197", "razao_social" => "ACME INC"}
iex> Brasilapi.Cnpj.Company.from_map(data)
%Brasilapi.Cnpj.Company{cnpj: "11000000000197", razao_social: "ACME INC"}