Listar Empresas cadastradas

Esse endpoint permite listar todas as Empresas cadastradas para o Originador. É possível realizar filtros para restringir os dados retornados ou trocar de página caso o Originador possua muitas Empresas cadastradas e associadas a ele.

Parâmetros da URL (opcionais)

• taxpayer_id (string) : Identificador do cadastro da Empresa a ser consultada.

• legal_name (string): Razão social da Empresa a ser consultada.

• page (int): Número da página a ser buscada em caso de retorno com paginação.

• size (int): Quantidade de registros a serem retornados na página.

Parâmetros da Requisição

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

Resposta

Se a requisição for processada com sucesso será retornado um status 200 e um JSON com o seguinte formato:

Campos da resposta:

• content: Um objeto contendo uma lista das Empresas cadastradas para o Originador. Dependendo da quantidade de registros esse objeto será retornado paginado.

• total_pages: O número total de páginas retornadas para a consulta executada.

• total_elements: O número total de registros retornados.

• has_next: Campo do tipo "boolean" para indicar se tem mais páginas a serem consultadas.

Objeto "content" (lista de Empresas)

• 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.

Exemplo de JSON:

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