Consultar Empresa por ID

Esse endpoint permite a consulta de informações de uma Empresa previamente cadastrada, recebendo um "business_id" como parâmetro na URL.

Parâmetros da URL

• business_id (string, uuid v4) : Identificador do cadastro da Empresa a ser consulta.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

A resposta para a requisição é um JSON no seguinte formato:

• id (string uuid): Identificador único do cadastro da Empresa.

• taxpayer_id (string): O nº do CNPJ da empresa.

• legal_name (string): A razão social da empresa.

• name (string): O nome fantasia da empresa.

• email_address(string): Campo do e-mail para contato com a Empresa.

• foundation_date(string): Data de abertura/registro da Empresa na Receita Federal.

• phone(objeto): Objeto contendo o número do telefone para contato com a empresa.

  • area_code(string): Campo do código da área (DDD).

  • country_code(string): Código Internacional para identificação do país (DDI).

  • number(string): Número do telefone, somente os números.

  • formatted_number(string): Número do telefone formatado.

• incorporation_type(string): Regime legal da Empresa cadastrado na Receita Federal.

• tax_regime(string): Regime tributário da Empresa.

• industry_classification(string): Classificação para a área de atuação da Empresa (CNAE).

• address(objeto): Objeto contendo os dados do endereço da Empresa.

  • street_name(string): Nome do logradouro do endereço.

  • street_number(integer): Númeração do endereço.

  • extra_info(string): Campo de dados adicionais, complemento, do Endereço.

  • district(string): Bairro do endereço.

  • city(string): Cidade do endereço.

  • postal_code (string): Código de CEP para o endereço.

  • state_code(string): Sigla para identificação do estado/uf.

  • country_code(string): Código do país.

• pix (object): Objeto contendo os dados de uma chave PIX.

  • key (string): Chave PIX.

  • key_type (string): Tipo da chave PIX.

• external_bank_account (object): Objeto contendo os dados bancários.

  • bank_code (string): Código do banco.

  • bank_account (string): Número da conta

  • bank_account_digit (string): Dígito do número da conta.

  • bank_branch (string): Número da agência.

  • bank_account_type (string): Tipo da conta bancária.

  • ispb_code (string): Código da Instituição recebedora no Sistema de Pagamentos Instantâneo.

• billing_address(objeto): Objeto contendo os dados do endereço da Empresa para cobrança.

  • street_name(string): Nome do logradouro do endereço.

  • street_number(integer): Númeração do endereço.

  • extra_info(string): Campo para dados adicionais, complemento, do Endereço.

  • district(string): Bairro do endereço.

  • city(string): Cidade do endereço.

  • postal_code (string): Código de CEP para o endereço.

  • state_code(string): Sigla para identificação do estado/uf.

  • country_code(string): Código do país.

• share_capital(float): Capital social da eEmpresa.

• monthly_revenue(float): Faturamento mensal estimado para a Empresa.

• employer(boolean): Campo booleano que indica se essa empresa deve suportar ou não o cadastro de colaboradores vinculados a ela.

• custom_variables(objeto): Objeto contendo valores de variáveis personalizadas, no formato de "chave e valor".

• created_at : Data e hora que o registro da Empresa foi criado.

• version : Identificador da versão do cadastro da Empresa.

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "legal_name": {"type": "string"},
    "taxpayer_id": {"type": "string"},
    "phone": {
      "type": "object",
      "properties": {
        "country_code": {"type": "string"},
        "area_code": {"type": "string"},
        "number": {"type": "string"},
        "formatted_number": {"type": "string"}
      }
    },
    "incorporation_type": {"type": "string"},
    "tax_regime": {"type": "string"},
    "industry_classification": {"type": "string"},
    "name": {"type": ["string", "null"]},
    "email_address": {"type": "string"},
    "foundation_date": {"type": ["string", "null"]},
    "address": {
      "type": "object",
      "properties": {
        "street_name": {"type": "string"},
        "street_number": {"type": "number"},
        "postal_code": {"type": "string"},
        "district": {"type": "string"},
        "city": {"type": "string"},
        "state_code": {"type": "string"},
        "country_code": {"type": "string"},
        "extra_info": {"type": ["string", "null"]}
      }
    },
    "pix": {
      "type": "object",
      "properties": {
        "key": {"type": "string"},
        "key_type": {"type": "string"}
      }
    },
    "external_bank_account": {
      "type": "object",
      "properties": {
        "bank_code": {"type": "string"},
        "bank_account": {"type": "string"},
        "bank_account_digit": {"type": "string"},
        "bank_branch": {"type": "string"},
        "bank_account_type": {"type": ["string", "null"]},
        "ispb_code": {"type": ["string", "null"]}
      }
    },
    "custom_variables": {"type": "object"},
    "created_at": {"type": "string"},
    "version": {"type": "number"},
    "billing_address": {"type": ["object", "null"]},
    "share_capital": {"type": ["object", "null"]},
    "monthly_revenue": {"type": ["object", "null"]},
    "employer": {"type": "boolean"}
  }
}