• qua, 09/21/2022 - 18:12
  • /jaime.cafure@se...

(GET) employeejourney/entities/costCenter

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

Um "CostCenter", para o HCM, é uma entidade que representa as informações de Centro de Custo cadastradas - mesmo sem colaboradores vinculados.. Algumas dessas informações são ID, nome, data de criação, código, descrição do código, data de expiração e empresa.

Esse endpoint é utilizado para obter as informações dos Centros de Custos cadastrados na base do HCM. Todos os endpoints do serviço da jornada do colaborador só podem ser acessados por usuários ou aplicações com o ( permissionamento correto), com 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 Centro de Custo consiste em:

{ "totalPages": "Número total de páginas", "totalElements": "Número total de centro de custos encontrados", "contents": [ { "id": "id centro de custo", "name": "nome", "codccu": "codigo do centro de custo", "creationDate": "data de criação", "company": { "id": "id Compania", "numemp": Número da compania, "tradingName": "Nome Comercial", "companyName": "Nome Compania", "cnpj": "CNPJ" },... }

**Os IDs retornados pelas APIs são os IDs utilizados pelos serviços acoplados ao Painel de Gestão, de modo que eles não são necessariamente consistentes em todos os serviços oferecidos pelo HCM.

Uso dos filtros:

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

Casos de uso:

  • Buscar todos os centros de custo cadastrados no sistema::

    .../entities/costCenter

  • Buscar todos os centros de custo que possuem uma empresa cadastrada:

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

  • Buscar os centros de custo que possuem empresa com um determinado nome comercial:

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

  • Buscar centros de custo pelo nome:

    .../costCenter?filter=name='Nome Centro de custo'

  • Buscar centros de custo pelo código:

    .../costCenter?codccu='codigo'

  • Buscar todos os centros de custo com determinado nome usando containing:

    .../costCenter?filter=containing(name, 'nome departamento')

  • Filtrando centros de custo por quantidade de retorno por página, usando ordenação:

    .../costCenter?size=6&offset=0&orderby=name

  • Filtrando centros de custo apenas utilizando os campos nome, com displayfields:

    .../costCenter?displayfields="name"