| Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | filiais |
|---|
| Filiais - api/rh/v1/DbHrBranches API responsável por trazer todas as filiais para serem utilizadas no filtro do Dashboard RH. Assim será possível ter uma visão macro da empresa ou apenas de uma filial em específico. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para consultar todas as filiais cadastradas para serem utilizadas no filtro do Dashboard RH. CadastroEsta API contempla apenas a consulta das filiais cadastradas. ProcessosO Dashboard RH realizará o consumo da API para buscar todas as filiais. Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método Get GET e do Serviço api/rh/v1/DbHrBranches;
Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI Por ser uma API que retorna todas as filiais, não existe qualquer parâmetro que precisa ser enviado.
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrBranches Response da API: Application/json
{
"branches": [
"D MG 01 ",
"D MG 02 ",
"D RJ 01 ",
"D RJ 02 ",
"M PR 01 ",
"M PR 02 ",
"M SP 01 ",
"M SP 02 ",
"M SP 03 "
]
}  Image Removed Image Added
|
Por ser uma API que retorna todos os gestores, não existe qualquer parâmetro que precisa ser enviado.
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrAttendanceControlDbHrManagers Response da API: Application/json
{
"managers": [
"GESTOR FINANCEIRO D MG (D MG 01 - 000001)",
"GESTOR RH M SP (M SP 01 - 000001)",
"GESTOR TI D MG (D MG 01 - 000002)"
]
}  Image Added
Observações:
1 - Para que o Dashboard RH consiga localizar corretamente os funcionários que percentem à um gestor é necessário informar a filial e matrícula (separados por espaço + "-" + espaço) dos gestores entre parênteses. Exemplo: Gestor A (M SP 01 - 000001), Gestor B (M SP 01 - 000002) e Gestor C (M SP 01 - 000003).
2 - Caso o ERP não possua uma hierarquia ou não foram encontrados os gestores, o retorno a API deverá ser um Array vazio. Enviado um Array vazio o Dashboard RH irá desativar o filtro por gestor e o botão de enviar e-mail para os gestores.
 Image Added | Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | ponto | gestores |
|---|
| Filiais Ponto Completo e Incompleto - api/rh/v1/DbHrAttendanceControlDbHrManagers API responsável por retornar o total de funcionários, funcionários com o ponto completo, incompleto e sem marcações, que não foram demitidos antes do período selecionado ou os funcionários demitidos dentro do período selecionado. Basicamente esta API irá verificar a quantidade de marcações realizadas no período pelo funcionário e irá validar com a quantidade em que o funcionário deveria realizar de acordo com o seu turno. Por exemplo um funcionário precisa realizar a marcação do ponto 4 vezes ao dia (entrada jornada, saída para o almoço, volta do almoço e saída da jornada). Na semana o funcionário trabalha de segunda à sexta, então teremos 5 dias trabalhados, onde cada dia o funcionário precisa bater o ponto 4 vezes, totalizando 20 marcações na semana. Se o funcionário possuir 20 ou mais marcações o sistema irá contabilizar como ponto completo, caso o funcionário tenha menos de 20 marcações na semana, será considerado como ponto incompleto.
Observação: O dia da demissão do funcionário contará como dia trabalhado, caso o funcionário seja demitido no dia 19/08/2022 e o filtro do período é de 01/08/2022 à 19/08/2022, a quantidade de marcações do dia 19/08/2022 será contabilizado normalmente. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações CadastroEsta API contempla as consultas do cadastro de funcionários, turnos, tabela de horário padrão e marcações realizadas pelo funcionários. ProcessosO Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações Como realizar a chamada da API RESTtrazer todos os gestores para serem utilizados no filtro do Dashboard RH. Assim será possível realizar filtros dos funcionários separados por gestor ou gestores. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para consultar todos os gestores cadastrados para serem utilizadas no filtro do Dashboard RH. CadastroEsta API contempla apenas a consulta dos gestores cadastrados. ProcessosO Dashboard RH realizará o consumo da API para buscar todos os gestores. Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método GET e do Serviço api/rh/v1/DbHrManagers
- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método Post e do Serviço api/rh/v1/DbHrAttendanceControl;
- Preenchimento dos parâmetros obrigatórios da API;
Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD
Parâmetros de Entrada: | | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
| startDate | 2022-11-01 | Sim | Date | Body | Data inicial do período. | | endDate | 2022-11-11 | Sim | Date | Body | Data final do período. | | branches | ["D MG 01"]
["D MG 01","M SP 01"]
["todas"] | Sim | Array | Body | Filtro da filial. | accept | application/json | Sim | String | Header | content-type | application/json | Sim | String | Header |
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrClockin Response da API: Application/json | Totvs custom tabs box items |
|---|
| Ponto Completo e Incompleto - api/rh/v1/DbHrAttendanceControl API responsável por retornar o total de funcionários, funcionários com o ponto completo, incompleto e sem marcações, que não foram demitidos antes do período selecionado ou os funcionários demitidos dentro do período selecionado. Basicamente esta API irá verificar a quantidade de marcações realizadas no período pelo funcionário e irá validar com a quantidade em que o funcionário deveria realizar de acordo com o seu turno. Por exemplo um funcionário precisa realizar a marcação do ponto 4 vezes ao dia (entrada jornada, saída para o almoço, volta do almoço e saída da jornada). Se o funcionário possuir 4 ou mais marcações o sistema irá contabilizar como ponto completo, caso o funcionário tenha menos de 4 marcações, será considerado como ponto incompleto e se o funcionário não possuir marcações no dia, será contabilizado com funcionário sem marcação, com exceção dos finais de semandas, feriados ou em dias em que o funcionário não trabalha. Quando for selecionado um período de 30 dias, por exemplo, a validação do ponto completo será realizada diariamente, ou seja, se o funcionário tiver 4 marcações todos os dias do período selecionado ele será considerado como ponto completo. Se no período existir pelo menos 1 dia com marcações faltantes, ele será considerado ponto incompleto e se o funcionário não possuir marcações no período selecionado, será considerado como funcionário sem marcações.
Observação: O dia da demissão do funcionário contará como dia trabalhado, caso o funcionário seja demitido no dia 19/08/2022 e o filtro do período é de 01/08/2022 à 19/08/2022, a quantidade de marcações do dia 19/08/2022 será contabilizado normalmente. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações CadastroEsta API contempla as consultas do cadastro de funcionários, turnos, tabela de horário padrão e marcações realizadas pelo funcionários. ProcessosO Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de funcionários, funcionários que estão com o ponto completo, incompleto e sem marcações Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método POST e do Serviço api/rh/v1/DbHrAttendanceControl;
- Preenchimento dos parâmetros obrigatórios da API;
Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD Parâmetros de Entrada: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
| startDate | 2024-01-01 | Sim | Date | Body | Data inicial do período. | | endDate | 2024-01-08 | Sim | Date | Body | Data final do período. | | branches | ["D MG 01"]
["D MG 01","M SP 01"]
["todas"] | Sim | Array | Body | Filtro da filial. | managers | ["GESTOR FINANCEIRO D MG (D MG 01 - 000001)"]
["GESTOR FINANCEIRO D MG (D MG 01 - 000001)","GESTOR RH M SP (M SP 01 - 000001)"]
["todos"]
| Sim | Array | Body | Gestores selecionados no filtro. | accept | application/json | Sim | String | Header |
| content-type | application/json | Sim | String | Header |
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/DbHrAttendanceControl Response da API: Application/json | Bloco de código |
|---|
| {
"1": {
"branch": "Todas as Filiais | | Bloco de código |
|---|
| {
"1": {
"branch": "Todas as Filiais",
"totalEmployees": 6,
"totalDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "D MG 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "M SP 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"department": "GPE001- OPERACIONAL - SP"
},
{
"branch": "M SP 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "GPE001- OPERACIONAL - SP"
},
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "GPE001- OPERACIONAL - SP"
}
],
"clockMarkingsComplete": 2,
"completeDetails": [
{
"branch": "D MG 01 ",
"registration": "003921",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "M SP 01 ",
"registration": "003923",
"name": "DRHJORNPRT-3921 PT COMPLETO",
"department": "GPE001- OPERACIONAL - SP"
}
],
"clockMarkingsIncomplete": 2,
"incompleteDetails": [
{
"branch": "D MG 01 ",
"registration": "003922",
"name": "DRHJORNPRT-3921 PT INCOMPLETO",
"totalEmployees": 9,
"departmenttotalDetails": [
"DEPARTAMENTO 1 RH",
{
"dateTime": "01/03/2023 "branch": "D MG 01 ",
"reasonregistration": "2 Marcaões faltantes000003",
"estimatedname": "09:00DASH -PNT 12:00 - 13:00 - 18:00COMPLETO FINANCEIRO",
"performeddepartment": "09:00FINANCEIRO - 12:00"
},
{",
"branchmanager": "GESTOR FINANCEIRO D MG 01 ",
"registrationmanagerId": "003922",
D MG 01 - 000001"
},
"name": "DRHJORNPRT-3921 PT INCOMPLETO", {
"departmentbranch": "DEPARTAMENTOD MG 101 RH",
"dateTimeregistration": "02/03/2023000004",
"reasonname": "DiaDASH PNT semINCOMPLET marcaçãoFINANCEIRO",
"estimateddepartment": "09:00FINANCEIRO - 12:00 - 13:00 - 18:00 ",
"performedmanager": "GESTOR FINANCEIRO D MG ",
},
"managerId": "D MG 01 - 000001"
{
},
"branch": "M SP 01 ",{
"registrationbranch": "003921D MG 01 ",
"nameregistration": "DRHJORNPRT-3921 PT INCOMPLETO000005",
"departmentname": "GPE001- OPERACIONAL - SPDASH PNT SEM MARC FINANCEIRO",
"dateTimedepartment": "01/03/2023",
FINANCEIRO "reason": "Dia sem marcação",
"estimatedmanager": "09:00 - 12:00 - 13:00 - 18:00GESTOR FINANCEIRO D MG ",
"performedmanagerId": "D MG 01 - 000001"
},
{
"branch": "MD SPMG 01 ",
"registration": "003921000006",
"name": "DRHJORNPRT-3921 PT INCOMPLETODASH PNT COMPLETO TI",
"department": "GPE001- OPERACIONAL - SP",
TI "dateTime": "02/03/2023",
"reasonmanager": "1GESTOR Marcação faltante",
TI D MG "estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performedmanagerId": "12:00 - 13:00D MG 01 - 18:00000002"
}
],
"withoutClockMarkings": 2,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "003923000007",
"name": "DRHJORNPRT-3921 SEM MARCACOESDASH PNT INCOMPLETO TI",
"department": "DEPARTAMENTOTI 1 RH"
},
{",
"branchmanager": "MGESTOR SPTI 01D ",
MG "registration": "003922",
"namemanagerId": "DRHJORNPRT-3921 SEM MARCACOES",D MG 01 - 000002"
},
"department": "GPE001- OPERACIONAL - SP"
{
}
]
}"branch": "D MG 01 ",
"2": {
"branchregistration": "D MG 01000008",
"totalEmployeesname": 3"DASH PNT SEM MARC TI",
"totalDetails": [
"department": "TI {
"branch": "D MG 01 ",
"registrationmanager": "003921",
GESTOR TI D MG "name": "DRHJORNPRT-3921 PT COMPLETO",
"departmentmanagerId": "DEPARTAMENTO 1 RHD MG 01 - 000002"
},
{
"branch": "DM MGSP 01 ",
"registration": "003922000002",
"name": "DRHJORNPRT-3921 PT INCOMPLETODASH PNT COMPLETO RH",
"department": "DEPARTAMENTO 1 RH"
},
{
"branch": "D MG 01 ",
"registrationmanager": "003923",
GESTOR RH M SP "name": "DRHJORNPRT-3921 SEM MARCACOES",
"departmentmanagerId": "DEPARTAMENTOM 1SP RH"
01 }- 000001"
],
"clockMarkingsComplete": 1,
"completeDetails": [},
{
"branch": "DM MGSP 01 ",
"registration": "003921000003",
"name": "DRHJORNPRT-3921 PT COMPLETODASH PNT INCOMPLETO RH",
"department": "DEPARTAMENTO 1 RH"
}
],
"clockMarkingsIncomplete": 1,
"incompleteDetails": [
"manager": "GESTOR RH M SP {
"branch": "D MG 01 ",",
"registrationmanagerId": "003922",
M SP 01 - 000001"
"name": "DRHJORNPRT-3921 PT INCOMPLETO" },
"department": "DEPARTAMENTO 1 RH",{
"dateTimebranch": "01/03/2023M SP 01 ",
"reasonregistration": "2 Marcaões faltantes000004",
"estimatedname": "09:00DASH -PNT 12:00SEM - 13:00 - 18:00MARC RH",
"performeddepartment": "09:00 - 12:00"
RH },
{",
"branchmanager": "DGESTOR MGRH 01M ",
SP "registration": "003922",
"namemanagerId": "DRHJORNPRT-3921 PT INCOMPLETO",M SP 01 - 000001"
}
"department": "DEPARTAMENTO 1 RH", ],
"clockMarkingsComplete": 3,
"completeDetails": [
{
"dateTime "branch": "02/03/2023D MG 01 ",
"reasonregistration": "Dia sem marcação000003",
"estimatedname": "09:00DASH -PNT 12:00 - 13:00 - 18:00COMPLETO FINANCEIRO ",
"performeddepartment": ""
FINANCEIRO }
]",
"withoutClockMarkings": 1,
"withoutDetailsmanager": [
"GESTOR FINANCEIRO D MG {",
"branchmanagerId": "D MG 01 - 000001",
},
"registration": "003923", {
"namebranch": "DRHJORNPRT-3921 SEM MARCACOESD MG 01 ",
"departmentregistration": "DEPARTAMENTO 1 RH000006",
}
]
},
"3": {
"name": "DASH PNT COMPLETO TI "branch": "M SP 01",
"totalEmployees": 3,
"totalDetailsdepartment": [
"TI {
"branch": "M SP 01 ",
"registrationmanager": "003923",
GESTOR TI D MG "name": "DRHJORNPRT-3921 PT COMPLETO",
"departmentmanagerId": "GPE001- OPERACIONALD MG 01 - SP000002"
},
{
"branch": "M SP 01 ",
"registration": "003921000002",
"name": "DRHJORNPRT-3921 PT INCOMPLETODASH PNT COMPLETO RH ",
"department": "GPE001-RH OPERACIONAL - SP"
},
{",
"branchmanager": "GESTOR RH M SP 01 ",
"registration": "003922",
"namemanagerId": "DRHJORNPRT-3921 SEM MARCACOES",
"department": "GPE001- OPERACIONAL - SPM SP 01 - 000001"
}
],
"clockMarkingsCompleteclockMarkingsIncomplete": 13,
"completeDetailsincompleteDetails": [
{
"branch": "MD SPMG 01 ",
"registration": "003923000004",
"name": "DRHJORNPRT-3921 PT COMPLETODASH PNT INCOMPLET FINANCEIRO ",
"department": "GPE001-FINANCEIRO OPERACIONAL - SP"
}
]",
"clockMarkingsIncomplete": 1,
"incompleteDetailsmanager": [
"GESTOR FINANCEIRO D MG {",
"branchdateTime": "M SP 01 05/01/2024",
"registrationreason": "003921Dia sem marcação",
"nameestimated": "DRHJORNPRT-3921 PT INCOMPLETO 09:00 - 12:00 - 13:00 - 18:00",
"departmentperformed": "GPE001- OPERACIONAL - SP",
"dateTimemanagerId": "01/03/2023",D MG 01 - 000001"
},
"reason": "Dia sem marcação", {
"estimatedbranch": "09:00D - 12:00 - 13:00 - 18:00MG 01 ",
"performedregistration": "000007",
},
"name": "DASH PNT INCOMPLETO TI {",
"branchdepartment": "M SP 01 ",
TI "registration": "003921",
"namemanager": "DRHJORNPRT-3921GESTOR PT INCOMPLETO",
TI D MG "department": "GPE001- OPERACIONAL - SP",
"dateTime": "0203/0301/20232024",
"reason": "1 Marcação faltante",
"estimated": "09:00 - 12:00 - 13:00 - 18:00",
"performed": "12 09:00 - 1312:00 - 1813:00"
}
],
"withoutClockMarkings": 1,
"withoutDetails": [
{
"branch": "M SP 01 ",
"registrationmanagerId": "003922",
D MG 01 - 000002"
"name": "DRHJORNPRT-3921 SEM MARCACOES" },
{
"department": "GPE001- OPERACIONAL - SP"
"branch": "M SP 01 }",
]
}
} |
ObservaçãoCaso seja selecionada 2 ou mais filiais, a primeira posição da resposta obrigatoriamente será o totalizador, para a demais posições serão as filiais e suas informações.
Se for selecionado apenas 1 filial no filtro só haverá 1 posição na resposta da API. Chamada API: Image Removed
Possíveis situações no envio dos filtros| Bloco de código |
|---|
| {
"startDateregistration": "2023-03-01000003",
"endDate":"2023-03-31",
"branchesname":[
"DASH PNT INCOMPLETO RH "todas"
]
} | | Bloco de código |
|---|
| {
",
"startDatedepartment":"2023-03-01",
"RH "endDate":"2023-03-31",
"branches":[
"D MG 01"
]
} | | Bloco de código |
|---|
| title | Duas ou mais filiais |
|---|
| {
"startDate":"2023-03-01",
"endDate "manager":"2023-03-31 "GESTOR RH M SP ",
"branches":[
"D MG 01dateTime": "04/01/2024",
"M SP 01"
]
} |
Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução. Mensagens de Pré-Validação | | Código | Erro | Detalhe |
|---|
400 | "Parâmetros inválidos: Verifique se os parâmetros startDate, endDate e filial foram enviados." | | Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | clockin |
|---|
| Integrações Clock In - api/rh/v1/DbHrClockin API responsável por retornar o total de marcações no Clock In, total de marcações integradas, total de marcações a serem integradas e o total de marcações sem NSR gerada. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários que estão com o ponto completo e o total de funcionários com o ponto incompleto. CadastroEsta API contempla as consultas de marcações do Clock In e marcações integradas com o ERP. ProcessosO Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de marcações no Clock In, total de marcações integradas, total de marcações a serem integradas e o total de marcações sem NSR gerada. Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método Post e do Serviço api/rh/v1/DbHrClockin;
- Preenchimento dos parâmetros obrigatórios da API;
Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo:
https://tdn.totvs.com/x/jIUoI As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD
Parâmetros de Entrada: | | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
|---|
| startDate | 2022-05-01 | Sim | Date | Body | Data inicial do período. | | endDate | 2022-05-31 | Sim | Date | Body | Data final do período. | | branches | ["D MG 01"]
["D MG 01","M SP 01"]
["todas"] | Sim | Array | Body | Filtro da filial. | accept | application/json | Sim | String | Header | content-type | application/json | Sim | String | Header |
| Bloco de código |
|---|
| {
"1": {
"branch": "Todas"reason": "Dia sem marcação",
"estimated": "08:00 - 13:00 - 14:00 - 17:00",
"performed": "",
"managerId": "M SP 01 - 000001"
}
],
"withoutClockMarkings": 3,
"withoutDetails": [
{
"branch": "D MG 01 ",
"registration": "000005",
"name": "DASH PNT SEM MARC FINANCEIRO ",
"department": "FINANCEIRO ",
"manager": "GESTOR FINANCEIRO D MG ",
"managerId": "D MG 01 - 000001"
},
{
"branch": "D MG 01 ",
"registration": "000008",
"totalClockMarkings": 7,
"totalDetailsname": [
"DASH PNT SEM MARC TI {",
"CNPJdepartment": "99999999999999",
TI "CPF": "44379500039",
"PIS": "61743152540",
"branchmanager": "Filial A",
GESTOR TI D MG "name": "Func A",
"devicemanagerId": "dispositivo A",
D MG 01 - 000002"
"NSR": 1},
"dateTime": "01/03/2023 09:00"{
},
"branch": "M SP {01 ",
"CNPJregistration": "99999999999999000004",
"CPFname": "44379500039",
DASH PNT SEM MARC RH "PIS": "61743152540",
"branchdepartment": "Filial A",
RH "name": "Func A",
"devicemanager": "dispositivo A",
GESTOR RH M SP "NSR": 2,
,
"dateTimemanagerId": "01/03/2023 12:00M SP 01 - 000001"
},
]
{},
"2": {
"CNPJbranch": "99999999999999D MG 01",
"totalEmployees": 6,
"CPFtotalDetails": "44379500039",[
"PIS": "61743152540",{
"branch": "FilialD MG 01 A",
"nameregistration": "Func A000003",
"devicename": "dispositivo ADASH PNT COMPLETO FINANCEIRO ",
"NSRdepartment": 3,
"FINANCEIRO "dateTime": "01/03/2023 13:00",
},
"manager": "GESTOR FINANCEIRO D MG { ",
"CNPJmanagerId": "99999999999999",
D MG 01 - 000001"
"CPF": "44379500039" },
{
"PIS": "61743152540",
"branch": "FilialD MG 01 A",
"nameregistration": "Func A000006",
"devicename": "dispositivo A",
DASH PNT COMPLETO TI "NSR": 0,
"dateTimedepartment": "01/03/2023 18:00"
TI },
{",
"CNPJmanager": "99999999999999",
GESTOR TI D MG "CPF": "88888888888",
"PISmanagerId": "77777777777",
D MG 01 - 000002"
},
"branch": "Filial B",{
"namebranch": "FuncD MG 01 B",
"deviceregistration": "dispositivo B000004",
"NSRname": 1 "DASH PNT INCOMPLET FINANCEIRO ",
"dateTimedepartment": "01/03/2023 09:00"
FINANCEIRO },
{",
"CNPJmanager": "99999999999999",
GESTOR FINANCEIRO D MG "CPF": "88888888888",
"PISmanagerId": "77777777777",
D MG 01 - 000001"
"branch": "Filial B" },
"name": "Func B",{
"devicebranch": "dispositivoD MG 01 B",
"NSRregistration": 2"000007",
"dateTimename": "01/03/2023 12:00"
DASH PNT INCOMPLETO TI }",
{
"department": "TI "CNPJ": "99999999999999",
"CPF": "88888888888",
"PISmanager": "77777777777",
GESTOR TI D MG "branch": "Filial B ",
"namemanagerId": "Func B",D MG 01 - 000002"
},
"device": "dispositivo B", {
"NSRbranch": 0 "D MG 01 ",
"dateTimeregistration": "01/03/2023 13:00"000005",
}
"name": "DASH PNT SEM MARC ]FINANCEIRO ",
"totalIntegrated "department": 3,
"FINANCEIRO "integratedDetails": [
{",
"CNPJmanager": "99999999999999GESTOR FINANCEIRO D MG ",
"CPFmanagerId": "44379500039",D MG 01 - 000001"
},
"PIS": "61743152540", {
"branch": "FilialD MG 01 A",
"nameregistration": "Func A000008",
"devicename": "dispositivo A",
DASH PNT SEM MARC TI "NSR": 1,
"dateTimedepartment": "01/03/2023 09:00"
TI },
{",
"CNPJmanager": "99999999999999",
GESTOR TI D MG "CPF": "44379500039",
"PISmanagerId": "61743152540",D MG 01 - 000002"
}
"branch": "Filial A" ],
"clockMarkingsComplete": 2,
"namecompleteDetails": "Func A", [
{
"devicebranch": "dispositivoD MG 01 A",
"NSRregistration": 2"000003",
"dateTimename": "01/03/2023 12:00"
DASH PNT COMPLETO FINANCEIRO ",
},
"department": "FINANCEIRO {
"CNPJ": "99999999999999",
"CPFmanager": "88888888888",
GESTOR FINANCEIRO D MG "PIS": "77777777777",
"branchmanagerId": "Filial B",
D MG 01 - 000001"
},
"name": "Func B",{
"devicebranch": "dispositivoD MG 01 B",
"NSRregistration": 1"000006",
"dateTimename": "01/03/2023 09:00"
DASH PNT COMPLETO TI }",
],
"totalToBeIntegrateddepartment": 2,
"TI "toBeIntegratedDetails": [
{",
"CNPJmanager": "99999999999999",
GESTOR TI D MG "CPF": "44379500039",
"PISmanagerId": "61743152540",
D MG 01 - 000002"
"branch": "Filial A", }
],
"nameclockMarkingsIncomplete": "Func A"2,
"incompleteDetails": [
"device": "dispositivo A", {
"NSRbranch": 3"D MG 01 ",
"dateTimeregistration": "01/03/2023 13:00"000004",
},
"name": "DASH PNT INCOMPLET {FINANCEIRO ",
"CNPJdepartment": "99999999999999",
FINANCEIRO "CPF": "88888888888",
"PISmanager": "77777777777GESTOR FINANCEIRO D MG ",
"branchdateTime": "Filial B05/01/2024",
"namereason": "FuncDia sem Bmarcação",
"deviceestimated": "dispositivo B09:00 - 12:00 - 13:00 - 18:00",
"NSRperformed": 2"",
"dateTimemanagerId": "01/03/2023 12:00D MG 01 - 000001"
},
],{
"totalWhitoutNSR": 2,
"whitoutNsrDetailsbranch": [
"D MG 01 ",
{
"CNPJ"registration": "99999999999999000007",
"CPFname": "44379500039",
DASH PNT INCOMPLETO TI "PIS": "61743152540",
"branchdepartment": "Filial A",
TI "name": "Func A",
"devicemanager": "dispositivo A",
GESTOR TI D MG "NSR": 0,
"dateTime": "03/01/03/2023 18:00"2024",
},
"reason": "1 Marcação faltante",
{
"estimated": "09:00 - 12:00 - "CNPJ"13: "9999999999999900 - 18:00",
"CPFperformed": "88888888888",
09:00 - 12:00 - 13:00 "PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 0,
"dateTimemanagerId": "01/03/2023 18:00D MG 01 - 000002"
}
],
},
"2withoutClockMarkings": {2,
"branchwithoutDetails": "Filial A",
[
"totalClockMarkings": 4, {
"totalDetails": [
"branch": "D MG 01 {",
"CNPJregistration": "99999999999999000005",
"CPFname": "44379500039DASH PNT SEM MARC FINANCEIRO ",
"PISdepartment": "61743152540",
FINANCEIRO "branch": "Filial A",
"namemanager": "Func AGESTOR FINANCEIRO D MG ",
"devicemanagerId": "dispositivo A",
D MG 01 - 000001"
"NSR": 1},
"dateTime": "01/03/2023 09:00"{
},
"branch": "D MG {01 ",
"CNPJregistration": "99999999999999000008",
"CPFname": "44379500039",
DASH PNT SEM MARC TI "PIS": "61743152540",
"branchdepartment": "Filial A",
TI "name": "Func A",
"devicemanager": "dispositivo A",
GESTOR TI D MG "NSR": 2,
"dateTimemanagerId": "01/03/2023 12:00D MG 01 - 000002"
},
]
{},
"3": {
"CNPJbranch": "99999999999999M SP 01",
"totalEmployees": 3,
"CPFtotalDetails": "44379500039",[
{
"PIS": "61743152540",
"branch": "FilialM SP 01 A",
"nameregistration": "Func A000002",
"devicename": "dispositivo A",
DASH PNT COMPLETO RH "NSR": 3,
"dateTimedepartment": "01/03/2023 13:00"
RH },
{",
"CNPJmanager": "99999999999999",
GESTOR RH M SP "CPF": "44379500039",
"PISmanagerId": "61743152540",
M SP 01 - 000001"
},
"branch": "Filial A",{
"namebranch": "FuncM SP 01 A",
"deviceregistration": "dispositivo A000003",
"NSRname": 0"DASH PNT INCOMPLETO RH ",
"dateTimedepartment": "01/03/2023 18:00"
RH }
],
"totalIntegrated": 2,
"integratedDetails": [
"manager": "GESTOR RH M SP {
"CNPJ": "99999999999999",
"CPFmanagerId": "44379500039",
M SP 01 - 000001"
"PIS": "61743152540" },
"branch": "Filial A",{
"namebranch": "FuncM SP 01 A",
"deviceregistration": "dispositivo A000004",
"NSRname": 1,
"DASH PNT SEM MARC RH ",
"dateTime": "01/03/2023 09:00"
},
"department": "RH {
"CNPJ": "99999999999999",
"CPFmanager": "44379500039",
GESTOR RH M SP "PIS": "61743152540",
"branchmanagerId": "Filial A",M SP 01 - 000001"
}
"name": "Func A" ],
"clockMarkingsComplete": 1,
"devicecompleteDetails": "dispositivo A",[
"NSR": 2,{
"dateTimebranch": "01/03/2023 12:00"M SP 01 ",
}
]"registration": "000002",
"totalToBeIntegrated": 1,
"clockMarkingsname": "DASH [
PNT COMPLETO RH {",
"CNPJdepartment": "99999999999999",
RH "CPF": "44379500039",
"PIS": "61743152540",
"branchmanager": "Filial A",
GESTOR RH M SP "name": "Func A",
"devicemanagerId": "dispositivo A",
M SP 01 - 000001"
"NSR": 3,}
],
"dateTimeclockMarkingsIncomplete": "01/03/2023 13:00"
1,
"incompleteDetails": [
}
],{
"totalWhitoutNSR": 1,
"whitoutNsrDetailsbranch": [
"M SP {01 ",
"CNPJregistration": "99999999999999000003",
"CPFname": "44379500039",
DASH PNT INCOMPLETO RH "PIS": "61743152540",
"branchdepartment": "Filial A",
RH "name": "Func A",
"devicemanager": "dispositivo A",
GESTOR RH M SP "NSR": 0,
"dateTime": "04/01/03/2023 18:00"2024",
}
"reason": "Dia sem ]marcação",
},
"3": {
"branchestimated": "Filial B",
"totalClockMarkings": 3,
08:00 - 13:00 - 14:00 - 17:00",
"totalDetails": [
{"performed": "",
"CNPJmanagerId": "99999999999999",
M SP 01 - 000001"
"CPF": "88888888888", }
],
"PISwithoutClockMarkings": "77777777777"1,
"withoutDetails": [
"branch": "Filial B",{
"namebranch": "FuncM SP 01 B",
"deviceregistration": "dispositivo B000004",
"NSRname": 1,
"DASH PNT SEM MARC RH ",
"dateTime": "01/03/2023 09:00"
},
"department": "RH {
"CNPJ": "99999999999999",
"CPFmanager": "88888888888",
GESTOR RH M SP "PIS": "77777777777",
"branchmanagerId": "Filial B",M SP 01 - 000001"
}
"name": "Func B", ]
}
}
|
ObservaçãoCaso os indicadores não possuam dados a serem exibido, será necessário enviar no retorno da API as propriedades da resposta com 0 e o detalhamento com um array vazio. Exemplo: | Bloco de código |
|---|
{
"1": {
"devicebranch": "dispositivoTodas as BFiliais",
"totalEmployees": 0,
"NSRtotalDetails": 2[],
"clockMarkingsComplete": 0,
"dateTimecompleteDetails": "01/03/2023 12:00"[],
}"clockMarkingsIncomplete": 0,
"incompleteDetails": [],
{
"withoutClockMarkings": 0,
"CNPJwithoutDetails": "99999999999999",[]
},
"2": {
"CPFbranch": "88888888888Filial A",
"totalEmployees": 0,
"PIStotalDetails": "77777777777"[],
"clockMarkingsComplete": 0,
"branchcompleteDetails": "Filial B"[],
"clockMarkingsIncomplete": 0,
"nameincompleteDetails": "Func B"[],
"devicewithoutClockMarkings": "dispositivo B"0,
"withoutDetails": []
},
"NSR3": 0,{
"dateTime"branch": "01/03/2023 13:00"Filial B",
"totalEmployees": 0,
}
"totalDetails": [],
"totalIntegratedclockMarkingsComplete": 10,
"integratedDetailscompleteDetails": [],
"clockMarkingsIncomplete": 0,
{
"incompleteDetails": [],
"CNPJwithoutClockMarkings": "99999999999999"0,
"withoutDetails": []
}
}
|
ObservaçãoCaso seja selecionada 2 ou mais filiais, a primeira posição da resposta obrigatoriamente será o totalizador, para a demais posições serão as filiais e suas informações.
Se for selecionado apenas 1 filial no filtro só haverá 1 posição na resposta da API. Chamada API: Image Added
Possíveis situações no envio dos filtros de filiais| Bloco de código |
|---|
| {
"CPFstartDate": "888888888882024-01-01",
"endDate":"2024-01-05",
"PISbranches": "77777777777",[
"todas"
],
"branchmanagers": "Filial B",[
"todos"
]
} |
| Bloco de código |
|---|
| {
"namestartDate": "Func B"2024-01-01",
"device": "dispositivo B"endDate":"2024-01-05",
"branches":[
"D MG "NSR": 1,01"
],
"dateTime": "01/03/2023 09:00""managers":[
"todos"
]
} |
| Bloco de código |
|---|
| {
],
"startDate":"2024-01-01",
"totalToBeIntegratedendDate": 1"2024-01-05",
"toBeIntegratedDetailsbranches": [
"D MG 01",
"M SP {01"
],
"CNPJ": "99999999999999","managers":[
"todos"
"CPF": "88888888888",
"PIS": "77777777777]
} |
Observação1 - Para o filtro de gestor caso selecionado todos os gestores deverá ser retornado todos os funcionários, independemente se o funcionário possui ou não um gestor direto.
2 - Quando selecionado 1 ou mais gestores apenas os funcionários que respondem diretamente aos gestores selecionados deverão ser listados.
3 - Não há quebra dos indicadores separados por gestor, como existe na quebra por filial. Possíveis situações no envio dos filtros de filiais | Bloco de código |
|---|
| {
"startDate":"2024-01-01",
"endDate":"2024-01-05",
"branches":[
"branch": "Filial B","todas"
],
"managers":[
"name": "Func B",todos"
]
} |
| Bloco de código |
|---|
| {
"startDate":"2024-01-01",
"endDate":"2024-01-05",
"devicebranches": "dispositivo B",[
"todas"
],
"NSRmanagers": 2,
[
"GESTOR FINANCEIRO D MG (D MG 01 - 000001)"
]
} |
| Bloco de código |
|---|
| {
"startDate":"2024-01-01",
"dateTimeendDate": "01/03/2023 12:00"2024-01-05",
"branches":[
}"todas"
],
"totalWhitoutNSRmanagers": 1,
"whitoutNsrDetails": [
{
"CNPJ": "99999999999999",
"CPF": "88888888888",
"PIS": "77777777777",
"branch": "Filial B",
"name": "Func B",
"device": "dispositivo B",
"NSR": 0,
"dateTime": "01/03/2023 13:00"
}
]
}
} |
ObservaçãoCaso seja selecionada 2 ou mais filiais, a primeira posição da resposta obrigatoriamente será o totalizador, para a demais posições serão as filiais e suas informações.
Se for selecionado apenas 1 filial no filtro só haverá 1 posição na resposta da API. Chamada API:
 Image Removed
Possíveis situações no envio dos filtros| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"todas"
]
} |
| Bloco de código |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01"
]
} |
| Bloco de código |
|---|
| title | Duas ou mais filiais |
|---|
| {
"startDate":"2023-03-01",
"endDate":"2023-03-31",
"branches":[
"D MG 01",
"M SP 01"
]
} |
Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução. Mensagens de Pré-Validação |
