• qua, 03/06/2024 - 17:12
  • /gabriel.kresin@...

(GET) employeejourney/queries/getCompanyWithBranches

https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/employeejourney/queries/getCompanyWithBranches

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 matrizes que estão cadastradas na base do HCM. A diferença entre este endpoint e o endpoint Empresa é a apresentação dos dados: enquanto no endpoint 'Empresa' as empresas são retornadas de forma não estruturada, no endpoint 'Empresa com Filiais' as filiais são retornadas "dentro" do payload das empresas matrizes, por meio do campo "companyBranches".

Assim como os demais endpoints, só poderá ser acessado com o 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 consiste de:

{ "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, "companyBranches": [ { "id": id da filial, "numemp": número da filial, "tradingName": nome fantasia da filial "companyName": nome da filial, "cnpj": cnpj da filial, "companyType": tipo da filial, "cnae": CNAE da filial, "address": endereço da filial } ] }

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:

  • Listar todas as empresas com as suas filiais:

    https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/employeejourney/queries/getCompanyWithBranches

  • Buscar filial por id:

    .../getCompanyWithBranches?filter=companyBranches.id eq 'ID'