Consultar empresa comercial - GET

Objetivo

Método de consulta que retorna informações de uma lista de empresas.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Empresa/empresa-comercial

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web> API Cadastros Estruturais > API Cadastros Estruturais

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
NroEmpresa	Número de empresa	integer($int64)	Não há.
CNPJ	CNPJ da empresa	string	Não há.
NroDivisao	Número de divisão	integer($int64)	Não há.
NomeReduzido	Nome reduzido de empresa	string	Não há.
Status	Status da empresa	string	Opções: A - Ativo, I - Inativo, T - Todos
CodigoPessoa	Código de pessoa da empresa	integer($int64)	Não há.
Page	Páginas	integer($int64)	Não há.
PageSize	Tamanho das páginas	integer($int64)	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
"hasNext": true,
"items": [
{
"nroEmpresa": 0,
"cnpj": "string",
"razaoSocial": "string",
"nomeFantasia": "string",
"nomeReduzido": "string",
"nroDivisao": 0,
"status": "string",
"nroSegmentoPrincipal": 0,
"codigoPessoa": 0,
"endereco": {
"cep": "string",
"logradouro": "string",
"numero": "string",
"complemento": "stirng",
"cidade": "string",
"uf": "string"
}
}
]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}

Árvore de páginas