• sex, 10/22/2021 - 11:25
  • /vitor.goncalves...

(GET) employeejourney/entities/company

https://api.senior.com.br/hcm/employeejourney/entities/company

A "company", para o HCM, é a entidade que representa as empresas e filiais cadastradas na base de dados. Essa entidade contém informações como o CNPJ da empresa, o nome fantasia, se a empresa em questão é a matriz ou uma filial e quais são as suas filiais. Esses dados são obtidos nas telas de informações sobre empresas no HCM.

Esse endpoint é responsável por trazer dados das empresas que estão cadastradas na base do HCM. A diferença entre esse endpoint e o endpoint Empresa com Filiais é a apresentação dos dados: nesse endpoint, as empresas são apresentadas de forma individual, onde as matrizes e as filiais são apresentadas todas em uma lista,

Assim como os demais endpoints, só poderá ser acessado com usuário ou permissionamento correto e possuem um limite máximo de 100 itens por página de retorno. Campos não preenchidos não são retornados.

O payload de cada empresa consiste de:

{ "id": id da empresa, "numemp": número da empresa, "tradingName": nome fantasia da empresa, "companyName": nome da empresa, "cnpj": cnpj da empresa, "companyType": tipo da empresa, "cnae": CNAE da empresa, "address": endereço da empresa, "headquarter": { "id": id da matriz, "numemp": número da matriz, "tradingName": nome fantasia da matriz "companyName": nome da matriz, "cnpj": cnpj da matriz, "companyType": tipo da matriz, "cnae": CNAE da matriz, "address": endereço da matriz } }

Uso dos filtros:

É possível filtrar os resultados seguindo estas diretivas . Observe nos casos de uso que é possível utilizar filtros de atributos.

Casos de uso:

  • Buscar todas as empresas cadastradas no sistema:

    https://api.senior.com.br/hcm/employeejourney/entities/company

  • Buscar empresa cadastrada pelo id:

    .../company?filter=id='ID'

  • Buscar somente as empresas que contém filiais:

    .../company?filter=headquarter.id is not null

  • Buscar empresa pelo nome da matriz:

    .../company?filter=headquarter.tradingName='Nome Filial'

  • Buscar empresa pelo nome:

    .../company?filter=tradingName='Nome'

  • Buscar empresa por cidade:

    .../company?filter=address.city.name='Nome Cidade'