Protocolo Integração TopPonto

9 Cadastros

9.1 Empresa

9.1.1 Adicionar
Adicionar uma nova empresa no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/empresa

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idTipoDocumento	Number	1 (CNPJ) ou 2 (CPF)	Sim	Tipo do documento da empresa: 1 para CNPJ ou 2 para CPF.
razaoSocial	String	Máx. 150 caracteres	Sim	Razão social da empresa.
nomeFantasia	String	Máx. 50 caracteres	Não	Nome fantasia da empresa.
documento	String	Exatos 18 caracteres	Sim	Número do documento (CNPJ ou CPF).
idExportacao	String	Máx. 15 caracteres	Não	Utilizado para exportar uma referência da empresa.
endereco	String	Máx. 100 caracteres	Não	Endereço completo da empresa.
bairro	String	Máx. 100 caracteres	Não	Bairro da empresa.
cep	String	Máx. 10 caracteres	Não	Código postal (CEP) da empresa.
cidade	String	Máx. 60 caracteres	Não	Cidade onde a empresa está localizada.
uf	String	Exatos 2 caracteres	Não	Unidade Federativa (UF) da empresa.
diaApuracao	Number	Intervalo de dias entre 1 e 31	Sim	Dia de apuração.
fone	String	Máx. 20 caracteres	Não	Telefone de contato da empresa.
whatsApp	String	Máx. 20 caracteres	Não	WhatsApp de contato da empresa.
ativo	Boolean	true ou false	Sim	Indica se a empresa está ativa no sistema.
grupoEconomico	Boolean	true ou false	Sim	Indica se a empresa pertence a um grupo econômico.
observacao	String	Máx. 170 caracteres	Não	Campo para inserir observações adicionais sobre a empresa.

Requisição (JSON)

{
    "idEmpresa": null,
    "idTipoDocumento": 1,
    "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
    "nomeFantasia": "Topdata sistemas de automação ltda.",
    "documento": "72.041.049/0001-01",
    "idExportacao": null,
    "endereco": "R. Prof. Ana de Oliveira Viana, 40",
    "bairro": "Fanny",
    "cep": "81030-200",
    "cidade": "Curitiba",
    "uf": "PR",
    "diaApuracao": 1,
    "fone": "(41) 3213-7100",
    "whatsApp"; null,
    "ativo": true,
    "grupoEconomico": true,
    "observacao": null
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idEmpresa": 1,
        "idTipoDocumento": 1,
        "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
        "nomeFantasia": "Topdata sistemas de automação ltda.",
        "documento": "72.041.049/0001-01",
        "idExportacao": null,
        "endereco": "R. Prof. Ana de Oliveira Viana, 40",
        "bairro": "Fanny",
        "cep": "81030-200",
        "cidade": "Curitiba",
        "uf": "PR",
        "diaApuracao": 1,
        "fone": "(41) 3213-7100",
        "whatsApp": null,
        "ativo": true,
        "grupoEconomico": true,
        "observacao": null
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id da empresa só deve ser informado ao atualizar uma empresa existente.	400 – Bad Request
idTipoDocumento	O id tipo de documento inválido. Informe 1 para CNPJ ou 2 para CPF.	400 – Bad Request
razaoSocial	A razão social da empresa não pode ser vazia.	400 – Bad Request
razaoSocial	Razão social da empresa ultrapassou o limite definido.	400 – Bad Request
nomeFantasia	Nome fantasia da empresa ultrapassou o limite definido.	400 – Bad Request
documento	O documento da empresa não pode ser vazio.	400 – Bad Request
	Documento da empresa ultrapassou o limite definido.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CNPJ.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CPF.	400 – Bad Request
idExportacao	Id de exportação da empresa ultrapassou o limite definido.	400 – Bad Request
endereco	Endereço da empresa ultrapassou o limite definido.	400 – Bad Request
bairro	Bairro da empresa ultrapassou o limite definido.	400 – Bad Request
cep	Cep da empresa ultrapassou o limite definido.	400 – Bad Request
cidade	Cidade da empresa ultrapassou o limite definido.	400 – Bad Request
uf	Uf da empresa ultrapassou o limite definido.	400 – Bad Request
diaApuracao	Dia de apuração não pode ser nulo.	400 – Bad Request
diaApuracao	Dia de apuração deve estar entre os dias 1 e 31 do mês.	400 – Bad Request
whatsApp	WhatsApp da empresa ultrapassou o limite definido.	400 – Bad Request
ativo	O campo ativo da empresa não pode ser nulo.	400 – Bad Request
grupoEconomico	O campo grupo econômico da empresa não pode ser nulo.	400 – Bad Request
observacao	Observação da empresa ultrapassou o limite definido.	400 – Bad Request

9.1.2 Consultar (lista)
Retorna uma lista de empresas cadastradas.

Endpoint
https://integracao.topponto.com.br/cadastros/empresas

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo esperado

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Razao Social, Nome Fantasia ou Documento.	Não	Critério de busca da empresa (Razão Social, Nome Fantasia ou Documento).

Requisição (Query Parameters)

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/empresas

2. Exemplo com busca
https://integracao.topponto.com.br/cadastros/empresas?search=Topdata

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idEmpresa": 1,
            "idTipoDocumento": 1,
            "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
            "nomeFantasia": "Topdata sistemas de automação ltda.",
            "documento": "72.041.049/0001-01",
            "idExportacao": null,
            "endereco": "R. Prof. Ana de Oliveira Viana, 40",
            "bairro": "Fanny",
            "cep": "81030-200",
            "cidade": "Curitiba",
            "uf": "PR",
            "fone": "(41) 3213-7100",
            "whatsApp": null,
            "ativo": true,
            "grupoEconomico": true,
            "observacao": null
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.1.3 Consultar (id)
Retorna os dados de uma empresa específica com base no idEmpresa informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/empresa/idEmpresa

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/empresa/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idEmpresa": 1,
        "idTipoDocumento": 1,
        "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
        "nomeFantasia": "Topdata sistemas de automação ltda.",
        "documento": "72.041.049/0001-01",
        "idExportacao": null,
        "endereco": "R. Prof. Ana de Oliveira Viana, 40",
        "bairro": "Fanny",
        "cep": "81030-200",
        "cidade": "Curitiba",
        "uf": "PR",
        "fone": "(41) 3213-7100",
        "ativo": true,
        "grupoEconomico": true,
        "observacao": null
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id não pode ser nulo ou zero.	400 – Bad Request
idEmpresa	O id informado deve ser um número inteiro.	400 – Bad Request

9.1.4 Atualizar
Atualiza informações da empresa no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/empresa

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

9.1.5 Deletar
Remover uma empresa do sistema com base no idEmpresa.

Endpoint
https://integracao.topponto.com.br/cadastros/empresa/idEmpresa.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único do empresa.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/empresa/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found

9.1.6 Deletar
Remover um departamento do sistema com base no idDepartamento.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento/idDepartamento.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/departamento/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found
	Não foi possível excluir este departamento, pois ele possui vínculo com algum funcionário.	400 – Bad Request

9.2 CEI/CNO/CAEPF

9.2.1 Adicionar
Adicionar um novo cei a uma empresa no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/cei

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

9.2.2 Consultar (lista)
Retorna uma lista de ceis cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/ceis

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo esperado

9.2.3 Consultar (id)
Retorna os dados de um cei específico com base no idCei informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/cei/idCei

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idCei	Number	1 a N (Número Positivo)	Sim	Identificador único do cei.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/cei/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idCei": 1,
        "idEmpresa": 1,
        "descricao": "12345678912345"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCei	O id não pode ser nulo ou zero.	400 – Bad Request
idCei	O id informado deve ser um número inteiro.	400 – Bad Request

9.2.4 Consultar por empresa
Retorna a lista de ceis associados a uma empresa específica, identificada pelo parâmetro idEmpresa.

Endpoint
https://integracao.topponto.com.br/cadastros/ceis-por-empresa/idEmpresa

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/ceis-por-empresa/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idCei": 1,
            "idEmpresa": 1,
            "descricao": "12345678912345"
        },
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request

9.2.5 Atualizar
Atualiza informações do cargo no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/cei

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idCei	Number	1 a N (Número Positivo)	Sim	Identificador único do cei.
descricao	String	Exatos 14 caracteres	Sim	Esta opção é utilizada para o “CEI” – Cadastro Específico do INSS,”CNO” – Cadastro Nacional de Obras, “CAEPF” – Cadastro de Atividade Econômica de Pessoa Física, para contribuintes sem CNPJ ou matrícula CEI/CNO/CAEPF para empregador doméstico.

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idCei": 1,
        "idEmpresa": 1,
        "descricao": "54321987654321"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCei	O id do cei não pode ser nulo.	400 – Bad Request
	O id do cei deve ser maior que 0.	400 – Bad Request
	Cei não encontrado. Informe um id válido.	404 – Not Found
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found
descricao	A descrição do cei ultrapassou o limite definido.	400 – Bad Request
	A descrição do cei não pode ser vazia.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CEI.	400 – Bad Request
	O Cei informado já está cadastrado em outra empresa. Não é possível utilizá-lo.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.2.6 Deletar
Remover um departamento do sistema com base no idCei.

Endpoint
https://integracao.topponto.com.br/cadastros/cei/idCei.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do cei.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/cei/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCei	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Cei não encontrado. Informe um id válido.	404 – Not Found

Erros catalogados

Não há erros catalogados para este método.

9.3 Departamentos

9.3.1 Adicionar
Adicionar um novo departamento no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa a qual o departamento pertence.
descricao	String	Máx. 50 caracteres	Sim	Nome do departamento dentro da empresa.
ativo	String	true ou false	Sim	Indica se o departamento esta ativo ou inativo.

Requisição (JSON)

{
    "idEmpresa": 1,
    "descricao": "Assistente Financeiro",
    "ativo": true
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idDepartamento": 1,
        "idEmpresa": 1,
        "descricao": "Assistente Financeiro",
        "ativo": true
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id do departamento só deve ser informado ao atualizar um departamento existente.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	400 – Bad Request
descricao	A descrição do departamento não pode ser vazia.	400 – Bad Request
ativo	O campo ativo do departamento não pode ser nulo.	400 – Bad Request

9.3.2 Consultar (lista)
Retorna uma lista de departamento cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/departamentos

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo esperado

Parâmetros (Não se enquadra)

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Descricao	Não	Critério de busca do departamento(Descrição).

Requisição (Query Parameters)

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/departamentos

2. Exemplo com busca
https://integracao.topponto.com.br/cadastros/departamentos?search=Financeiro

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "descricao": "Assistente Financeiro",
            "ativo": true
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.3.3 Consultar (id)
Retorna os dados de um departamento específico com base no idDepartamento informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento/idDepartamento

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/departamento/1

Resposta

https://integracao.topponto.com.br/cadastros/departamento/1
Resposta
{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idDepartamento": 1,
        "idEmpresa": 1,
        "descricao": "Assistente Financeiro",
        "ativo": true
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id não pode ser nulo ou zero.	400 – Bad Request
idDepartamento	O id informado deve ser um número inteiro.	400 – Bad Request

9.3.4 Consultar por empresa
Retorna a lista de departamentos associados a uma empresa específica, identificada pelo parâmetro idEmpresa.

Endpoint
https://integracao.topponto.com.br/cadastros/departamentos-por-empresa/idEmpresa

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/departamentos-por-empresa/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "descricao": "Assistente Financeiro",
            "ativo": true
        },
        ...
     ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id não pode ser nulo ou zero.	400 – Bad Request
idEmpresa	O id informado deve ser um número inteiro.	400 – Bad Request

9.3.5 Atualizar
Atualiza informações do departamento no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador do único departamento.
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa a qual o departamento pertence.
descricao	String	Máx. 50 caracteres	Sim	Nome do departamento dentro da empresa.
ativo	Boolean	true ou false	Sim	Indica se a empresa está ativa no sistema.

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idDepartamento": 1,
        "idEmpresa": 1,
        "descricao": "Analista Financeiro",
        "ativo": true
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id do departamento não pode ser nulo.	400 – Bad Request
	O id do departamento deve ser maior que 0.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	400 – Bad Request
	Não é possível alterar a empresa do departamento.	400 – Bad Request
descricao	A descrição do departamento não pode ser vazia.	400 – Bad Request
ativo	O campo ativo do departamento não pode ser nulo.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.3.6 Deletar
Remover um departamento do sistema com base no idDepartamento.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento/idDepartamento.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/departamento/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found
	Não foi possível excluir este departamento, pois ele possui vínculo com algum funcionário.	400 – Bad Request

9.4 Equipe

9.4.1 Adicionar
Adicionar uma nova equipe no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/equipe

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros (Equipe)

Campo	Tipo	Restrição	Obrigatório	Descrição
descricao	String	Máx. 50 caracteres	Sim	Nome da equipe.
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador do departamento a qual a equipe pertence.
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa a qual a equipe pertence.
idsResponsaveis	Array<Integer>	IDs de funcionários responsáveis pela equipe	Não	Lista de identificadores dos funcionários responsáveis. Se não informado, a equipe não terá responsáveis atribuídos.

Requisição (JSON)

{
    "descricao": "Equipe 1",
    "idDepartamento": 1,
    "idEmpresa": 1,
    "idsResponsaveis": [10,18]
}

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idEquipe": 5,
        "descricao": "Descrição",
        "idDepartamento": 3,
        "idEmpresa": 1,
        "responsaveis": [
           {
                "idEquipe": 1,
                "idFuncionario": 10,
                "nomeFuncionario": "ANDERSON NASCIMENTO"
            },
            {
                "idEquipe": 1,
                "idFuncionario": 18,
                "nomeFuncionario": "MARIANA PEREIRA"
            }
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
descricao	Descrição da equipe não pode ser vazia.	400 – Bad Request
idDepartamento	Id do departamento não pode ser nulo.	400 – Bad Request
	Id do departamento deve ser maior que 0.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found
	O departamento pertence a outra empresa, ele deve ser da mesma empresa informada.	400 – Bad Request
idEmpresa	Id da empresa não pode ser nulo.	400 – Bad Request
	Id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found

9.4.2 Consultar (lista)
Retorna uma lista de equipes cadastradas.

Endpoint
https://integracao.topponto.com.br/cadastros/equipes

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo esperado

Parâmetros (Não se enquadra)

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Descricao	Não	Critério de busca do departamento (Descrição Equipe, Descrição Departamento ou Nome Fantasia Empresa).
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador do departamento a qual a equipe pertence.

Requisição (Query Parameters)

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/equipes

2. Exemplo com busca
https://integracao.topponto.com.br/cadastros/departamentos?search=Equipe 1

3. Exemplo com busca pelo departamento
https://integracao.topponto.com.br/cadastros/departamentos?idDepartamento=1

4. Exemplo com Todos os Parâmetros
https://integracao.topponto.com.br/cadastros/departamentos?search=Equipe 1&idDepartamento=1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idEquipe": 1,
            "descricao": "Equipe 1",
            "idDepartamento": 1,
            "idEmpresa": 1,
            "responsaveis": []
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.4.3 Consultar (id)
Retorna os dados de uma queipe específica com base no idEquipe informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/equipe/idEquipe

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEquipe	Number	1 a N (Número Positivo)	Sim	Identificador único da equipe.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/equipe/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idEquipe": 1,
        "descricao": "Equipe 1",
        "idDepartamento": 1,
        "idEmpresa": 1,
        "responsaveis": [
           {
                "idEquipe": 1,
                "idFuncionario": 10,
                "nomeFuncionario": "ANDERSON NASCIMENTO"
            },
            {
                "idEquipe": 1,
                "idFuncionario": 18,
                "nomeFuncionario": "MARIANA PEREIRA"
            }
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEquipe	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Equipe não encontrada. Informe um id válido.	404 – Not Found

9.4.4 Consultar por departamento
Retorna a lista de equipes associados a um departamento específico, identificado pelo parâmetro idDepartamento.

Endpoint
https://integracao.topponto.com.br/cadastros/equipes-por-departamento/idDepartamento

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/equipes-por-departamento/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idEquipe": 1,
            "descricao": "Equipe 1",
            "idDepartamento": 1,
            "idEmpresa": 1,
            "responsaveis": [
                 {
                      "idEquipe": 1,
                      "idFuncionario": 10,
                      "nomeFuncionario": "ANDERSON NASCIMENTO"
                  },
                  {
                      "idEquipe": 1,
                      "idFuncionario": 18,
                      "nomeFuncionario": "MARIANA PEREIRA"
                  }
              ]
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found

9.4.5 Atualizar
Atualiza informações da equipe no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/equipe

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEquipe	Number	1 a N (Número Positivo)	Sim	Identificador único da equipe.
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa a qual o departamento pertence.
descricao	String	Máx. 50 caracteres	Sim	Nome do departamento dentro da empresa.
idsResponsaveis	Array<Integer>	IDs de funcionários responsáveis pela equipe, null, ou vazio.	Condicional	Lista de identificadores dos funcionários responsáveis. Se não informado, a equipe não terá responsáveis atribuídos. Para adicionar um funcionário como responsável basta adicionar no Array<Integer> o id do funcionário, mesmo vale para remover, basta remover do Array<Integer> já existente e realizar o PUT.

Requisição (JSON)

{
    "idEquipe": 1,
    "descricao": "Equipe 1",
    "idDepartamento": 1,
    "idEmpresa": 1,
    "incluirResponsaveis" : true,
    "idsResponsaveis": [55]
}

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idEquipe": 1,
        "descricao": "Equipe 1",
        "idDepartamento": 1,
        "idEmpresa": 1,
        "responsaveis": [
            {
                "idEquipe": 1,
                "idFuncionario": 10,
                "nomeFuncionario": "ANDERSON NASCIMENTO"
            },
            {
                "idEquipe": 1,
                "idFuncionario": 18,
                "nomeFuncionario": "MARIANA PEREIRA"
            },
            {
                "idEquipe": 1,
                "idFuncionario": 55,
                "nomeFuncionario": "RODRIGO DA SILVA"
            }
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEquipe	Id da equipe não pode ser nulo.	400 – Bad Request
	Id da equipe deve ser maior que 0.	400 – Bad Request
	Equipe não encontrada. Informe um id válido.	404 – Not Found
descricao	Descrição da equipe não pode ser vazia.	400 – Bad Request
descricao	Descrição da equipe ultrapassou o limite definido.	400 – Bad Request
idDepartamento	O id do departamento não pode ser nulo.	400 – Bad Request
	O id do departamento deve ser maior que 0.	400 – Bad Request
	O departamento da equipe não pode ser alterado.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	A empresa da equipe não pode ser alterada.	400 – Bad Request
idsResponsaveis	idsResponsaveis não pode ser vazio quando incluirResponsaveis for informado.	400 – Bad Request
idsResponsaveis	Responsáveis informados não foram encontrados.	404 – Not Found
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.4.6 Deletar
Remover uma equipe do sistema com base no idEquipe.

Endpoint
https://integracao.topponto.com.br/cadastros/equipe/idEquipe.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEquipe	Number	1 a N (Número Positivo)	Sim	Identificador único da equipe.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/equipe/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEquipe	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Equipe não encontrada. Informe um id válido.	404 – Not Found
	Não foi possível excluir esta equipe, pois ela possui vínculo com algum funcionário.	400 – Bad Request

9.5 Cargo

9.5.1 Adicionar
Adicionar um novo cargo no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/cargo

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
descricao	String	Máx. 50 caracteres	Sim	Nome do cargo dentro da empresa.

Requisição (JSON)

{
    "descricao": "Analista Financeiro"
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idCargo": 1,
        "descricao": "Analista Financeiro"
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
descricao	O campo descrição é obrigatório.	400 – Bad Request

9.5.2 Consultar (lista)
Retorna uma lista de cargos cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/cargos

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo esperado

Parâmetros (Query Parameters)

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Descricao	Não	Critério de busca do Cargo(Descrição).

Requisição

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/cargos

2. Exemplo com busca
https://integracao.topponto.com.br/cadastros/cargos?search=Analista

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idCargo": 1,
            "descricao": "Analista Financeiro"
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.5.3 Consulta (id)
Retorna os dados de um cargo específico com base no idCargo informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/departamento/idCargo

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idCargo	Number	1 a N (Número Positivo)	Sim	Identificador único do cargo.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/cargo/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idCargo": 1,
        "descricao": "Analista Financeiro"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCargo	O id não pode ser nulo ou zero.	400 – Bad Request
idCargo	O id informado deve ser um número inteiro.	400 – Bad Request

9.5.4 Atualizar
Atualiza informações do cargo no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/cargo

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idCargo	Number	1 a N (Número Positivo)	Sim	Identificador do cargo.
descricao	String	Máx. 50 caracteres	Sim	Nome do cargo dentro da empresa.

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idCargo": 1,
        "descricao": "Gerente Financeiro"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCargo	O id do cargo não pode ser nulo.	400 – Bad Request
	O id do cargo deve ser maior que 0.	400 – Bad Request
	Cargo não encontrado. Informe um id válido.	404 – Not Found
descricao	A descrição do cargo não pode ser vazia.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.5.5 Deletar
Remover um departamento do sistema com base no idCargo.

Endpoint
https://integracao.topponto.com.br/cadastros/cargo/idCargo.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do cargo.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/cargo/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idCargo	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Cargo não encontrado. Informe um id válido.	404 – Not Found

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.
descricao	String	Exatos 14 caracteres	Sim	Esta opção é utilizada para o “CEI” – Cadastro Específico do INSS,”CNO” – Cadastro Nacional de Obras, “CAEPF” – Cadastro de Atividade Econômica de Pessoa Física, para contribuintes sem CNPJ ou matrícula CEI/CNO/CAEPF para empregador doméstico.

Requisição (JSON)

{
    "idEmpresa": 1,
    "descricao" : "12345678912345"
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idCei": 1,
        "idEmpresa": 1,
        "descricao": "12345678912345"
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idCei	O id do cei só deve ser informado ao atualizar um existe.	400 – Bad Request
	O id do cei não pode ser nulo.	400 – Bad Request
	O id do cei deve ser maior que 0.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found
descricao	A descrição do cei ultrapassou o limite definido.	400 – Bad Request
	A descrição do cei não pode ser vazia.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CEI.	400 – Bad Request
	O Cei informado já está cadastrado em outra empresa. Não é possível utilizá-lo.	400 – Bad Request

Parâmetros (Query Parameters)

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Descricao	Não	Critério de busca do Cei(Descrição).

Requisição

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/ceis

2. Exemplo com busca
https://integracao.topponto.com.br/cadastros/ceis?search=12345

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idCei": 1,
            "idEmpresa": 1,
            "descricao": "12345678912345"
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.6 Funcionário

9.6.2 Adicionar
Criar um novo registro de funcionário no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa do funcionário.
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador do departamento ao qual o funcionário pertence.
idEquipe	Number	1 a N (Número Positivo)	Não	Identificador da equipe ao qual o funcionário pertence.
idCargo	Number	1 a N (Número Positivo)	Não	Identificador do cargo do funcionário.
idCei	Number	1 a N (Número Positivo)	Não	Identificador do CEI do funcionário.
identificacaoExportacao	String	Max. 15 caracteres.	Não	Identificador usado para referenciar o funcionário na folha de pagamento.
nome	String	Max. 52 caracteres.	Sim	Nome completo do funcionário.
pis	String	Max. 12 caracteres.	Não	Número do PIS/PASEP do funcionário. Caso não informado o pis será iniciado sempre em 9 seguido do cpf
cpf	String	Exatos 11 caracteres.	Sim	CPF do funcionário.
matricula	String	Max. 30 caracteres.	Não	Matrícula do funcionário.
ctps	String	Max. 20 caracteres.	Não	Número da CTPS (Carteira de Trabalho e Previdência Social).
dataAdmissao	String	Exatos 10 caracteres.	Sim	Data de admissão do funcionário (formato DD/MM/AAAA).
dataDemissao	String	Exatos 10 caracteres.	Não	Data de demissão do funcionário (formato DD/MM/AAAA).
observacao	String	Max. 52 caracteres.	Não	Observações gerais sobre o funcionário.
ativo	Boolean	true ou false	Sim	Indica se o funcionário está ativo ou não. (Quando inativo obrigatório informar a data de demissão)

Requisição (JSON)

{ 
   "idCargo" : 1,
   "idDepartamento": 1,
   "idEquipe": 1,
   "idEmpresa": 1,
   "idCei": 1,
   "nome": "NATALIA OLIVEIRA DA SILVA", 
   "pis": "12345678901", 
   "cpf": "12345678901", 
   "ctps": "123456789", 
   "matricula": "MATRICULA12345", 
   "identificacaoExportacao" : "123",
   "observacao": "Funcionário novo", 
   "dataAdmissao": "01/01/2022", 
   "dataDemissao": null, 
   "ativo": true,
   "grupoEconomico": true
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "dadosPessoais": null,
        "cargo": {
            "idCargo": 1,
            "descricao": "Analista Financeiro"
        },
        "departamento": {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "descricao": "Financeiro",
            "ativo": true
        },
        "equipe": {
            "idEquipe": 1,
            "descricao": "Equipe 1",
            "idDepartamento": 1,
            "idEmpresa": 1,
            "responsaveis": [
                {
                    "idEquipe": 1,
                    "idFuncionario": 10,
                    "nomeFuncionario": "ANDERSON NASCIMENTO"
                },
                {
                    "idEquipe": 1,
                    "idFuncionario": 18,
                    "nomeFuncionario": "MARIANA PEREIRA"
                }
            ]
        },
        "empresa": {
            "idEmpresa": 1,
            "idTipoDocumento": 1,
            "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
            "nomeFantasia": "Topdata sistemas de automação ltda.",
            "documento": "72.041.049/0001-01",
            "grupoEconomico": true,
            "endereco": "Rod. Br-277, 2160",
            "bairro": "Mossunguê",
            "cep": "81200-300",
            "cidade": "Curitiba",
            "uf": "PR",
            "fone": "(41)3213-7100",
            "ativo": true
        },
        "cei": {
            "idCei": 4,
            "idEmpresa": 1,
            "descricao": "134513863646"
        },
        "idFuncionario": 270,
        "nome": "NATALIA OLIVEIRA DA SILVA",
        "pis": "12345678901",
        "cpf": "12345678901",
        "ctps": "123456789",
        "matricula": "MATRICULA12345",
        "identificacaoExportacao": "123",
        "observacao": "Funcionário novo",
        "dataAdmissao": "01/01/2022",
        "dataDemissao": null,
        "ativo": true
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário só deve ser informado ao atualizar um existe.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
idEmpresa	O id da empresa deve ser maior que 0.	400 – Bad Request
idDepartamento	O id do departamento não pode ser nulo.	400 – Bad Request
idDepartamento	O id do departamento deve ser maior que 0.	400 – Bad Request
idEquipe	Equipe não encontrada. Informe um id válido.	400 – Bad Request
idCei	Cei não encontrado. Informe um id válido.	404 – Not Found
idCei	O cei informado pertence a uma empresa diferente. Ele deve corresponder à empresa especificada.	400 – Bad Request
nome	O nome do funcionário não pode ser vazio.	400 – Bad Request
nome	Nome do funcionário ultrapassou o limite definido.	400 – Bad Request
pis	O número do PIS informado é inválido. Verifique se os dados estão corretos.	400 – Bad Request
	Já existe um funcionário cadastrado com este PIS.	400 – Bad Request
	Pis do funcionário ultrapassou o limite definido.	400 – Bad Request
cpf	O número do CPF informado é inválido. Verifique se os dados estão corretos.	400 – Bad Request
	Este CPF já está cadastrado para outro PIS.	400 – Bad Request
	O cpf do funcionário não pode ser vazio.	400 – Bad Request
	Cpf do funcionário deve conter exatos 11 caracteres.	400 – Bad Request
ctps	Ctps do funcionário ultrapassou o limite definido.	400 – Bad Request
matricula	Matrícula do funcionário ultrapassou o limite definido.	400 – Bad Request
matricula	Já existe um funcionário cadastrado com essa matrícula.	409 – Conflict
identificacaoExportação	Identificação de exportação do funcionário ultrapassou o limite definido.	400 – Bad Request
observacao	Observação do funcionário ultrapassou o limite definido.	400 – Bad Request
dataAdmissao	A data de admissão deve estar no formato dd/MM/yyyy	400 – Bad Request
	Data de admissão do funcionário não pode estar vazia.	400 – Bad Request
	Data de admissão do funcionário deve conter exatos 10 caracteres.	400 – Bad Request
dataDemissao	A data de demissão deve estar no formato dd/MM/yyyy	400 – Bad Request
	Data de demissão do funcionário deve conter exatos 10 caracteres.	400 – Bad Request
	A data de demissão só deve ser informada para funcionários inativos.	400 – Bad Request
	A data de demissão é obrigatória para funcionários com status inativo.	400 – Bad Request
	A data de demissão não pode ser inferior ou igual a data de admissão.	400 – Bad Request
ativo	O campo ativo do funcionário não pode ser nulo.	400 – Bad Request

9.6.3 Consultar (lista)
Retorna uma lista de funcionários cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios

Requisição

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo Esperado

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
offset	Number	>= 0 (Número Não-Negativo)	Sim	Posição inicial dos registros para retorno.
qty	Number	1 a 100 (Número Não-Negativo)	Sim	Quantidade de registros a retornar.
search	String	Nome, CPF ou PIS	Não	Critério de busca dos funcionários (por Nome, CPF ou PIS).
idEmpresa	Number	1 a N (Número Positivo)	Não	Identificador da empresa.
idDepartamento	Number	1 a N (Número Positivo)	Não	Identificador do departamento.
idEquipe	Number	1 a N (Número Positivo)	Não	Identificador da equipe.
idResponsavel	Number	1 a N (Número Positivo)	Não	Identificador do responsável pela equipe a qual o funcionário pertence.
idCei	Number	1 a N (Número Positivo)	Não	Identificador do CEI (Cadastro Específico do INSS).

Requisição (Query Parameters)

1. Exemplo Básico: Paginação Simples
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10

2. Exemplo com Busca por Nome
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=20&search=João

3. Exemplo com Busca por CPF
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&search=12345678900

4. Exemplo com Busca por PIS
https://integracao.topponto.com.br/cadastros/funcionarios?offset=10&qty=10&search=12345678901

5. Exemplo com Filtro por idEmpresa
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=50&idEmpresa=5

6. Exemplo com Filtro por idDepartamento
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&idDepartamento=3

7. Exemplo com Filtro por idEquipe
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&idEquipe=1

8. Exemplo com Filtro por idReponsavel
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&idReponsavel=455

9. Exemplo com Filtro por idCei
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&idCei=7

10. Exemplo Combinando Filtros
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=20&idEmpresa=2&idDepartamento=5&idCei=10

11. Exemplo com Todos os Parâmetros
https://integracao.topponto.com.br/cadastros/funcionarios?offset=0&qty=10&search=Maria&idEmpresa=1&idDepartamento=4&idEquipe=1&idReponsavel=455&idCei=9

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "total": 264,
        "offset": 0,
        "qty": 2,
        "funcionarios": [
            {
                "dadosPessoais": null,
                "cargo": {
                    "idCargo": 1,
                    "descricao": "Assistente Financeiro"
                },
                "departamento": {
                    "idDepartamento": 1,
                    "idEmpresa": 1,
                    "descricao": "Financeiro",
                    "ativo": true
                },
                "equipe": {
                    "idEquipe": 1,
                    "descricao": "Equipe 1",
                    "idDepartamento": 1,
                    "idEmpresa": 1,
                    "responsaveis": [
                        {
                            "idEquipe": 1,
                            "idFuncionario": 10,
                            "nomeFuncionario": "ANDERSON NASCIMENTO"
                        },
                        {
                            "idEquipe": 1,
                            "idFuncionario": 18,
                            "nomeFuncionario": "MARIANA PEREIRA"
                        }
                    ]
                },
                "empresa": {
                    "idEmpresa": 1,
                    "idTipoDocumento": 1,
                    "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
                    "nomeFantasia": "Topdata sistemas de automação ltda.",
                    "documento": "72.041.049/0001-01",
                    "idExportacao": null,
                    "endereco": "Rod. Br-277, 2160",
                    "bairro": "Mossunguê",
                    "cep": "81200-300",
                    "cidade": "Curitiba",
                    "uf": "PR",
                    "fone": "(41) 3213-7100",
                    "whatsApp": null,
                    "ativo": true,
                    "grupoEconomico": true,
                    "observacao": null
                },
                "cei": null,
                "idFuncionario": 1,
                "nome": "NATALIA OLIVEIRA DA SILVA",
                "pis": "12345678901",
                "cpf": "12345678901",
                "ctps": null,
                "matricula": "",
                "identificacaoExportacao": "123",
                "observacao": null,
                "dataAdmissao": "",
                "dataDemissao": null,
                "ativo": true
            },
            ...
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
offset	O campo offset deve ser maior ou igual a 0.	400 – Bad Request
qty	O campo qty deve ser maior ou igual a 1.	400 – Bad Request
qty	O campo qty deve ser menor ou igual a 100.	400 – Bad Request
idEmpresa	O id da empresa deve ser maior que 0.	400 – Bad Request
idDepartamento	O id do departamento deve ser maior que 0.	400 – Bad Request
idEquipe	O id da equipe deve ser maior que 0.	400 – Bad Request
idResponsavel	O id do responsável deve ser maior que 0.	400 – Bad Request
idCei	O id do cei deve ser maior que 0.	400 – Bad Request

9.6.4 Consultar (id)
Retorna os dados completos de um funcionário específico com base no idFuncionario informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "dadosPessoais": null,
        "cargo": {
            "idCargo": 1,
            "descricao": "Assistente Financeiro"
        },
        "departamento": {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "descricao": "Financeiro",
            "ativo": true
        },
        "equipe": {
            "idEquipe": 1,
            "descricao": "Equipe 1",
            "idDepartamento": 1,
            "idEmpresa": 1,
            "responsaveis": [
               {
                    "idEquipe": 1,
                    "idFuncionario": 10,
                    "nomeFuncionario": "ANDERSON NASCIMENTO"
               },
               {
                    "idEquipe": 1,
                    "idFuncionario": 18,
                    "nomeFuncionario": "MARIANA PEREIRA"
               }
            ]
        },
        "empresa": {
            "idEmpresa": 1,
            "idTipoDocumento": 1,
            "razaoSocial": "TOP DATA SISTEMA E ",
            "nomeFantasia": "TOP DATA SISTEMA E ",
            "documento": "57573412000138",
            "idExportacao": null,
            "endereco": "XXX",
            "bairro": "XXXX",
            "cep": "17230000",
            "cidade": "Curitiba",
            "uf": "PR",
            "fone": "(41) 3213-7100",
            "whatsApp": null,
            "ativo": true,
            "grupoEconomico": true,
            "observacao": null
        },
        "cei": {
            "idCei": 1,
            "idEmpresa": 1,
            "descricao": "134513863646"
        },
        "idFuncionario": 270,
        "nome": "NATALIA OLIVEIRA DA SILVA",
        "pis": "12345678901",
        "cpf": "12345678901",
        "ctps": "123456789",
        "matricula": "MATRICULA12345",
        "identificacaoExportacao": "123",
        "observacao": "Funcionário novo",
        "dataAdmissao": "01/01/2022",
        "dataDemissao": null,
        "ativo": true
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id não pode ser nulo ou zero.	400 – Bad Request
idFuncionario	O id informado deve ser um número inteiro.	400 – Bad Request

9.6.5 Consultar por empresa
Retorna a lista de funcionários associados a uma empresa específica, identificada pelo parâmetro idEmpresa.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-por-empresa/idEmpresa

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionarios-por-empresa/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idFuncionario": 1,
            "idEmpresa": 1,
            "nome": "NATALIA OLIVEIRA DA SILVA",
            "cpf": "12345678901",
            "pis": "12345678901",
            "ativo": true
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id não pode ser nulo ou zero.	400 – Bad Request
idEmpresa	O id informado deve ser um número inteiro.	400 – Bad Request

9.6.6 Consultar por departamento
Retorna a lista de funcionários associados a um departamento específico, identificado pelo parâmetro idDepartamento.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-por-departamento/idDepartamento

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador único do departamento.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionarios-por-departamento/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idFuncionario": 1,
            "idDepartamento": 1,
            "nome": "NATALIA OLIVEIRA DA SILVA",
            "cpf": "12345678901",
            "pis": "12345678901",
            "ativo": true
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idDepartamento	O id não pode ser nulo ou zero.	400 – Bad Request
idDepartamento	O id informado deve ser um número inteiro.	400 – Bad Request

9.6.7 Consultar por equipe
Retorna a lista de funcionários associados a uma equipe específica, identificada pelo parâmetro idEquipe.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-por-equipe/idEquipe

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEquipe	Number	1 a N (Número Positivo)	Sim	Identificador único da equipe.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionarios-por-equipe/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
            "idEquipe": 1,
            "descricao": "Equipe 1",
            "idDepartamento": 1,
            "idEmpresa": 1,
            "responsaveis": []
     },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEquipe	O id não pode ser nulo ou zero.	400 – Bad Request

9.6.8 Consultar responsáveis (lista)

9.6.9 Consultar por responsáveis
Retorna a lista de funcionários associados a um responsável específico, identificada pelo parâmetro idResponsavel.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-por-responsavel/idResponsavel.

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idResponsavel	Number	1 a N (Número Positivo)	Sim	Identificador único do resposável.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionarios-por-responsavel/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
            "idFuncionario": 1,
            "idEmpresa": 1,
            "idDepartamento": 1,
            "idEquipe": 1,
            "nome": "NATALIA OLIVEIRA DA SILVA",
            "cpf": "12345678910",
            "pis": "12345678910",
            "ativo": true
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idResponsavel	O id não pode ser nulo ou zero.	400 – Bad Request

9.6.10 Atualizar
Atualizar os dados de um funcionário existente.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador do funcionário.
idCargo	Number	1 a N (Número Positivo)	Sim	Identificador do cargo do funcionário.
idDepartamento	Number	1 a N (Número Positivo)	Sim	Identificador do departamento ao qual o funcionário pertence.
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador da empresa do funcionário.
idCei	Number	1 a N (Número Positivo)	Não	Identificador do CEI do funcionário.
identificacaoExportacao	Number	1 a N (Número Positivo)	Não	Identificador usado para referenciar o funcionário na folha de pagamento.
nome	String	Max. 52 caracteres.	Sim	Nome completo do funcionário.
pis	String	Max. 12 caracteres.	Não	Número do PIS/PASEP do funcionário. Caso não informado o pis será iniciado sempre em 9 seguido do cpf
cpf	String	Exatos 11 caracteres.	Sim	CPF do funcionário.
matricula	String	Max. 30 caracteres.	Sim	Matrícula do funcionário.
ctps	String	Max. 20 caracteres.	Não	Número da CTPS (Carteira de Trabalho e Previdência Social).
dataAdmissao	String	Exatos 10 caracteres.	Sim	Data de admissão do funcionário (formato DD/MM/AAAA).
dataDemissao	String	Exatos 10 caracteres.	Não	Data de demissão do funcionário (formato DD/MM/AAAA).
observacao	String	Max. 52 caracteres.	Não	Observações gerais sobre o funcionário.
ativo	Boolean	true ou false	Sim	Indica se o funcionário está ativo ou não. (Quando inativo obrigatório informar a data de demissão)

Requisição (JSON)

{
    "idFuncionario": 1,
    "idCargo": 1,
    "idDepartamento": 1,
    "idEmpresa": 1,
    "idCei": 1,
    "nome": "Natalia Oliveira da Silva",
    "pis": "10987654321",
    "cpf": "10987654321",
    "ctps": "",
    "matricula": "0616",
    "observacao": "Funcionário Novo",
    "dataAdmissao": "01/01/2024",
    "dataDemissao": null,
    "ativo": true
}

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idFuncionario": 1,
        "idCargo": 1,
        "idDepartamento": 1,
        "idEmpresa": 1,
        "idCei": 1,
        "nome": "Natalia Oliveira da Silva",
        "pis": "10987654321",
        "cpf": "10987654321",
        "ctps": "",
        "matricula": "0616",
        "observacao": "Funcionário Novo",
        "dataAdmissao": "01/01/2024",
        "dataDemissao": null,
        "ativo": true
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário deve ser maior que 0.	404 – Not Found
idFuncionario	Funcionário não encontrado. Informe um id válido.	404 – Not Found
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found
idDepartamento	O id do departamento não pode ser nulo.	400 – Bad Request
	O id do departamento deve ser maior que 0.	400 – Bad Request
	Departamento não encontrado. Informe um id válido.	404 – Not Found
	O departamento pertence a outra empresa, ele deve ser da mesma empresa informada.	409 – Conflict
idCargo	Cargo não encontrado. Informe um id válido.	404 – Not Found
idCei	Cei não encontrado. Informe um id válido.	404 – Not Found
idCei	O cei informado pertence a uma empresa diferente. Ele deve corresponder à empresa especificada.	400 – Bad Request
nome	O nome do funcionário não pode ser vazio.	400 – Bad Request
nome	Nome do funcionário ultrapassou o limite definido.	400 – Bad Request
pis	O número do PIS informado é inválido. Verifique se os dados estão corretos.	400 – Bad Request
pis	Pis do funcionário ultrapassou o limite definido.	400 – Bad Request
cpf	O cpf do funcionário não pode ser vazio.	400 – Bad Request
	Cpf do funcionário deve conter exatos 11 caracteres.	400 – Bad Request
	Este CPF já está cadastrado para outro PIS.	400 – Bad Request
ctps	Ctps do funcionário ultrapassou o limite definido.	400 – Bad Request
matricula	Matrícula do funcionário ultrapassou o limite definido.	400 – Bad Request
matricula	Já existe um funcionário cadastrado com essa matrícula.	409 – Conflict
identificacaoExportação	Identificação de exportação do funcionário ultrapassou o limite definido.	400 – Bad Request
observacao	Observação do funcionário ultrapassou o limite definido.	400 – Bad Request
dataAdmissao	A data de admissão deve estar no formato dd/MM/yyyy	400 – Bad Request
	A data de admissão do funcionário não pode estar vazia.	400 – Bad Request
	A data de admissão do funcionário deve conter exatos 10 caracteres.	400 – Bad Request
dataDemissao	A data de demissão deve estar no formato dd/MM/yyyy	400 – Bad Request
	A data de demissão do funcionário deve conter exatos 10 caracteres.	400 – Bad Request
	A data de demissão só deve ser informada para funcionários inativos.	400 – Bad Request
	A data de demissão é obrigatória para funcionários com status inativo.	400 – Bad Request
	A data de demissão não pode ser inferior ou igual a data de admissão.	400 – Bad Request
ativo	O campo ativo do funcionário não pode ser nulo.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.6.11 Deletar
Remover um funcionário específico do sistema com base no idFuncionario.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Usuário não encontrado. Informe um id válido.	404 – Not Found

9.7 Funcionário foto

9.7.1 Adicionar
Adicionar uma foto ao funcionário no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/foto

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: multipart/form-dataX-Auth-Token: “token”X-Api-Version: 1	multipart/form-data

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário .
descricao	MultipartFile	Arquivo (Imagem)	Sim	Arquivo de imagem a ser enviado, representando a foto do funcionário.

Requisição (MultiPart Form-Data)

Body form-data
idFuncionario 1
file imagem.jpg

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idFuncionario": 1,
        "urlFoto": "https://armazenamentoproducao.blob.core.windows.net/topponto/fotos/DOMINIO/UUID.png"
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	Este funcionário já possui uma foto cadastrada. Use a opção de atualização.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
file	O arquivo é obrigatório.	400 – Bad Request
	O arquivo deve ter no máximo 2MB.	400 – Bad Request

9.7.2 Consultar (Lista)
Retorna uma lista contendo a url das fotos cadastradas.

Endpoint
https://integracao.topponto.com.br/cadastros/foto

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Não se enquadra

Parâmetros (Não se enquadra)
Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)
Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idFuncionario": 1,
            "urlFoto": "https://armazenamentoproducao.blob.core.windows.net/topponto/fotos/DOMINIO/UUID.png"
        },
        ...
       ],
    "status": 200
}

Erros catalogados
Não há erros catalogados para este método.
Retorna a url da foto do idFuncionario informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/foto/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/foto/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idFuncionario": 1,
        "urlFoto": "https://armazenamentoproducao.blob.core.windows.net/topponto/fotos/DOMINIO/UUID.png"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	Funcionário não encontrado. Informe um id válido.	404 – Bad Request

9.7.4 Atualizar
Atualizar foto do funcionário no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/foto

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: multipart/form-dataX-Auth-Token: “token”X-Api-Version: 1	multipart/form-data

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário .
descricao	MultipartFile	Arquivo (Imagem)	Sim	Arquivo de imagem a ser enviado, representando a foto do funcionário.

Requisição (MultiPart Form-Data)

Body form-data
idFuncionario 1
file imagem.jpg

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idFuncionario": 1,
        "urlFoto": "https://armazenamentoproducao.blob.core.windows.net/topponto-local/fotos/DOMINIO/UUID.png"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	Funcionário não encontrado. Informe um id válido.	404 – Not Found
file	O arquivo é obrigatório.	400 – Bad Request
file	O arquivo deve ter no máximo 2MB.	400 – Bad Request

9.7.5 Deletar
Deleta a foto do funcionário com base no idFuncionario.

Endpoint
https://integracao.topponto.com.br/cadastros/foto/idFuncionario.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/foto/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	Funcionário não possui uma foto salva.	404 – Not Found
idFuncionario	Funcionário não encontrado. Informe um id válido.	404 – Not Found

9.8 Funcionário dados Pessoais

9.8.1 Adicionar
Criar um novo registro de funcionário dados pessoais no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador do funcionário.
dataNascimento	String	Exatos 10 caracteres	Não	Data de nascimento do funcionário (formato DD/MM/AAAA).
documento	String	Máx. 20 caracteres	Condicional	Documento do funcionário. Obrigatório se dataEmissao for preenchidos.
dataEmissao	String	Exatos 10 caracteres	Condicional	Data de emissão do documento (formato DD/MM/AAAA). Obrigatório se documento for preenchidos.
ufDocumento	String	Exatos 2 caracteres	Não	UF de emissão do documento.
naturalidade	String	Máx. 100 caracteres	Não	Cidade natal do funcionário.
sexo	String	‘M’ ou ‘F’	Não	Sexo do funcionário (Masculino ou Feminino).
celular	String	Máx. 20 caracteres	Não	Número de celular do funcionário com DDD.
telefone	String	Máx. 20 caracteres	Não	Número de telefone fixo do funcionário com DDD.
nomeMae	String	Máx. 52 caracteres	Não	Nome completo da mãe do funcionário.
nomePai	String	Máx. 52 caracteres	Não	Nome completo do pai do funcionário.
endereco	String	Máx. 100 caracteres	Não	Logradouro do endereço do funcionário.
bairro	String	Máx. 100 caracteres	Não	Bairro do endereço do funcionário.
cep	String	Máx. 10 caracteres	Não	CEP do endereço do funcionário.
cidade	String	Máx. 60 caracteres	Não	Cidade do endereço do funcionário.
uf	String	Exatos 2 caracteres	Não	Unidade Federativa (UF) do endereço do funcionário.

Requisição (JSON)

{
    "idFuncionarioDadosPessoais": 1,
    "idFuncionario": 1,
    "telefone": null,
    "celular": "(041) 99999-9999",
    "dataNascimento": "05/05/2003",
    "sexo": "F",
    "documento": "12345678901",
    "dataEmissao": "01/05/2020",
    "ufDocumento": "PR",
    "naturalidade": "Brasileira",
    "nomePai": "Antonio Alves da Silva Neto",
    "nomeMae": "Selma Oliveira da Silva",
    "endereco": "Rua XV de novembro",
    "bairro": "Centro",
    "cep": "80060-000",
    "cidade": "Curitiba",
    "uf": "PR"
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idFuncionarioDadosPessoais": 1,
        "idFuncionario": 1,
        "telefone": null,
        "celular": "(041) 99999-9999",
        "dataNascimento": "05/05/2003",
        "sexo": "F",
        "documento": "12345678901",
        "dataEmissao": "01/05/2020",
        "ufDocumento": "PR",
        "naturalidade": "Brasileira",
        "nomePai": "Antonio Alves da Silva Neto",
        "nomeMae": "Selma Oliveira da Silva",
        "endereco": "Rua XV de novembro",
        "bairro": "Centro",
        "cep": "80060-000",
        "cidade": "Curitiba",
        "uf": "PR"
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionarioDadosPessoais	O id dos dados pessoais só deve ser informado ao atualizar um existe.	400 – Bad Request
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Request
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados pessoais já cadastrados para o funcionário informado.	409 – Conflict
dataNascimento	A data de nascimento do funcionário deve ter exatamente 10 caracteres.	400 – Bad Request
dataNascimento	A data de nascimento deve estar no formato dd/MM/yyyy	400 – Bad Request
documento	É necessário informar o número do documento	400 – Bad Request
documento	Documento deve ser informado ao preencher data de emissão.	400 – Bad Request
ufDocumento	Uf do documento do funcionário ultrapassou o limite definido.	400 – Bad Request
ufDocumento	A data de emissão deve estar no formato dd/MM/yyyy	400 – Bad Request
dataEmissao	A data de emissão do documento do funcionário deve ter exatamente 10 caracteres.	400 – Bad Request
dataEmissao	Data de emissão deve ser informada ao preencher documento.	400 – Bad Request
naturalidade	Naturalidade do funcionário ultrapassou o limite definido.	400 – Bad Request
sexo	Sexo do funcionário ultrapassou o limite definido.	400 – Bad Request
celular	Celular do funcionário ultrapassou o limite definido.	400 – Bad Request
telefone	Telefone do funcionário ultrapassou o limite definido.	400 – Bad Request
nomeMae	Nome da mãe do funcionário ultrapassou o limite definido.	400 – Bad Request
nomePai	Nome do pai do funcionário ultrapassou o limite definido.	400 – Bad Request
endereco	Endereço do funcionário ultrapassou o limite definido.	400 – Bad Request
bairro	Bairro do funcionário ultrapassou o limite definido.	400 – Bad Request
cep	Cep do funcionário ultrapassou o limite definido.	400 – Bad Request
cidade	Cidade do funcionário ultrapassou o limite definido.	400 – Bad Request
uf	Uf do funcionário ultrapassou o limite definido.	400 – Bad Request

9.8.2 Consultar (lista)
Retorna uma lista de dados pessoais dos funcionários cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-dados-pessoais

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo Esperado

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
offset	Number	>= 0 (Número Não-Negativo)	Sim	Posição inicial dos registros para retorno.
qty	Number	1 a 100	Sim	Quantidade de registros a retornar.
search	String	Funcionário (Nome, CPF ou PIS)Funcionário dados pessoais(Documento)	Não	Critério de busca dos dados pessoais (Nome, CPF, PIS ou Documento).

Requisição (Query Parameters)
https://integracao.topponto.com.br/cadastros/funcionarios-dados-pessoais?offset=0&qty=100

1. Exemplo Básico: Paginação Simples
https://integracao.topponto.com.br/cadastros/funcionarios-dados-pessoais?offset=0&qty=100

2. Exemplo com Busca por Nome
https://integracao.topponto.com.br/cadastros/funcionarios-dados-pessoais?offset=0&qty=100&search=João

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "total": 15,
        "offset": 0,
        "funcionarioDadosPessoais": [
            {
                "idFuncionarioDadosPessoais": 1,
                "idFuncionario": 1,
                "telefone": null,
                "celular": "(041) 99999-9999",
                "dataNascimento": "05/05/2003",
                "sexo": "F",
                "documento": "12345678901",
                "dataEmissao": "01/05/2020",
                "ufDocumento": "PR",
                "naturalidade": "Brasileira",
                "nomePai": "Antonio Alves da Silva Neto",
                "nomeMae": "Selma Oliveira da Silva",
                "endereco": "Rua XV de novembro",
                "bairro": "Centro",
                "cep": "80060-000",
                "cidade": "Curitiba",
                "uf": "PR"
            }
            ...
        ],
        "qty": 100
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
offset	O campo offset deve ser maior ou igual a 0.	400 – Bad Request
qty	O campo qty deve ser maior ou igual a 1.	400 – Bad Request
qty	O campo qty deve ser menor ou igual a 100.	400 – Bad Request

9.8.3 Consultar (id)
Retorna os dados completos dos dados pessoais de um funcionário com base no idFuncionarioDadosPessoais informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais/idFuncionarioDadosPessoais

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/jsonX-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionarioDadosPessoais	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário dados pessoais.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idFuncionarioDadosPessoais": 1,
        "idFuncionario": 1,
        "telefone": null,
        "celular": "(041) 99999-9999",
        "dataNascimento": "05/05/2003",
        "sexo": "F",
        "documento": "12345678901",
        "dataEmissao": "01/05/2020",
        "ufDocumento": "PR",
        "naturalidade": "Brasileira",
        "nomePai": "Antonio Alves da Silva Neto",
        "nomeMae": "Selma Oliveira da Silva",
        "endereco": "Rua XV de novembro",
        "bairro": "Centro",
        "cep": "80060-000",
        "cidade": "Curitiba",
        "uf": "PR"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionarioDadosPessoais	O id não pode ser nulo ou zero.	400 – Bad Request
idFuncionarioDadosPessoais	O id informado deve ser um número inteiro.	400 – Bad Request

9.8.4 Consultar por funcionário
Retorna os dados completos dos dados pessoais de um funcionário com base no idFuncionario informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais-por-funcionario/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/jsonX-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais-por-funcionario/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idFuncionarioDadosPessoais": 1,
        "idFuncionario": 1,
        "telefone": null,
        "celular": "(041) 99999-9999",
        "dataNascimento": "05/05/2003",
        "sexo": "F",
        "documento": "12345678901",
        "dataEmissao": "01/05/2020",
        "ufDocumento": "PR",
        "naturalidade": "Brasileira",
        "nomePai": "Antonio Alves da Silva Neto",
        "nomeMae": "Selma Oliveira da Silva",
        "endereco": "Rua XV de novembro",
        "bairro": "Centro",
        "cep": "80060-000",
        "cidade": "Curitiba",
        "uf": "PR"
    },
    "status": 200
}

9.8.5 Atualizar
Atualiza informações pessoais de um funcionário específico no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais

Estrutura

Método	Cabeçalho	Body
PUT	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionarioDadosPessoais	Number	1 a N (Número Positivo)	Sim	Identificador dos dados do funcionário.
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador do funcionário.
dataNascimento	String	Exatos 10 caracteres	Sim	Data de nascimento do funcionário (formato DD/MM/AAAA).
documento	String	Máx. 20 caracteres	Condicional	Documento do funcionário. Obrigatório se dataEmissao for preenchidos.
dataEmissao	String	Exatos 10 caracteres	Condicional	Data de emissão do documento (formato DD/MM/AAAA). Obrigatório se documento for preenchidos.
ufDocumento	String	Exatos 2 caracteres	Não	UF de emissão do documento.
naturalidade	String	Máx. 100 caracteres	Não	Cidade natal do funcionário.
sexo	String	‘M’ ou ‘F’	Não	Sexo do funcionário (Masculino ou Feminino).
celular	String	Máx. 20 caracteres	Não	Número de celular do funcionário com DDD.
telefone	String	Máx. 20 caracteres	Não	Número de telefone fixo do funcionário com DDD.
nomeMae	String	Máx. 52 caracteres	Não	Nome completo da mãe do funcionário.
nomePai	String	Máx. 52 caracteres	Não	Nome completo do pai do funcionário.
cep	String	Máx. 10 caracteres	Não	CEP do endereço do funcionário.
endereco	String	Máx. 100 caracteres	Não	Logradouro do endereço do funcionário.
bairro	String	Máx. 100 caracteres	Não	Bairro do endereço do funcionário.
cidade	String	Máx. 60 caracteres	Não	Cidade do endereço do funcionário.
uf	String	Exatos 2 caracteres	Não	Unidade Federativa (UF) do endereço do funcionário.

Requisição (JSON)

{
     "idFuncionarioDadosPessoais": 1,
     "idFuncionario": 1,
     "telefone": null,
     "celular": "(041) 99999-9999",
     "dataNascimento": "05/05/2003",
     "sexo": "F",
     "documento": "12345678901",
     "dataEmissao": "01/05/2020",
     "ufDocumento": "PR",
     "naturalidade": "Brasileira",
     "nomePai": "Antonio Alves da Silva Neto",
     "nomeMae": "Selma Oliveira da Silva",
     "endereco": "Avenida Batel",
     "bairro": "Batel",
     "cep": "80420-000",
     "cidade": "Curitiba",
     "uf": "PR"
 }

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idFuncionarioDadosPessoais": 1,
        "idFuncionario": 1,
        "telefone": null,
        "celular": "(041) 99999-9999",
        "dataNascimento": "05/05/2003",
        "sexo": "F",
        "documento": "12345678901",
        "dataEmissao": "01/05/2020",
        "ufDocumento": "PR",
        "naturalidade": "Brasileira",
        "nomePai": "Antonio Alves da Silva Neto",
        "nomeMae": "Selma Oliveira da Silva",
        "endereco": "Avenida Batel",
        "bairro": "Batel",
        "cep": "80420-000",
        "cidade": "Curitiba",
        "uf": "PR"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionarioDadosPessoais	O id dos dados pessoais não pode ser nulo.	400 – Bad Request
	O id dos dados pessoais deve ser maior que 0.	400 – Bad Request
	Dados pessoais não encontrado. Informe um id válido.	400 – Bad Request
	Dados pessoais não pertencem ao funcionário informado.	400 – Bad Request
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Request
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados pessoais já cadastrados para o funcionário informado.	409 – Conflict
dataNascimento	A data de nascimento do funcionário deve ter exatamente 10 caracteres.	400 – Bad Request
dataNascimento	A data de nascimento deve estar no formato dd/MM/yyyy	400 – Bad Request
documento	É necessário informar o número do documento	400 – Bad Request
documento	Documento deve ser informado ao preencher data de emissão.	400 – Bad Request
ufDocumento	Uf do documento do funcionário ultrapassou o limite definido.	400 – Bad Request
ufDocumento	A data de emissão deve estar no formato dd/MM/yyyy	400 – Bad Request
dataEmissao	A data de emissão do documento do funcionário deve ter exatamente 10 caracteres.	400 – Bad Request
dataEmissao	Data de emissão deve ser informada ao preencher documento.	400 – Bad Request
naturalidade	Naturalidade do funcionário ultrapassou o limite definido.	400 – Bad Request
sexo	Sexo do funcionário ultrapassou o limite definido.	400 – Bad Request
celular	Celular do funcionário ultrapassou o limite definido.	400 – Bad Request
telefone	Telefone do funcionário ultrapassou o limite definido.	400 – Bad Request
nomeMae	Nome da mãe do funcionário ultrapassou o limite definido.	400 – Bad Request
nomePai	Nome do pai do funcionário ultrapassou o limite definido.	400 – Bad Request
endereco	Endereço do funcionário ultrapassou o limite definido.	400 – Bad Request
bairro	Bairro do funcionário ultrapassou o limite definido.	400 – Bad Request
cep	Cep do funcionário ultrapassou o limite definido.	400 – Bad Request
cidade	Cidade do funcionário ultrapassou o limite definido.	400 – Bad Request
uf	Uf do funcionário ultrapassou o limite definido.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.8.6 Deletar
Remover os dados pessoais de um funcionário específico do sistema com base no idFuncionarioDadosPessoais.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais/idFuncionarioDadosPessoais.

Estrutura

Método	Cabeçalho	Path Variable
DELETE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionarioDadosPessoais	Number	1 a N (Número Positivo)	Sim	Identificador único dos dados funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario-dados-pessoais/1

Resposta

{
    "message": "Deletado com sucesso",
    "body": null,
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionarioDadosPessoais	O id não pode ser nulo ou zero.	400 – Bad Request
	O id informado deve ser um número inteiro.	400 – Bad Request
	Dados pessoais não encontrado. Informe um id válido.	404 – Not Found

9.9 Funcionário dados coletor

9.9.1 Adicionar
Criar um novo registro de funcionário dados coletor no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-coletor

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.
idTipoVerificacao	Number	1 a N (Número Positivo)	Sim	Identificador único do tipo de verificação.
nomeExibicao	String	Máx. 16 caracteres	Sim	Nome que será exibido no display dos coletores.
cartaoBarras	String	Máx. 20 caracteres	Sim	Número do cartão barras utilizado pelo funcionário.
cartaoProximidade	String	Máx. 20 caracteres	Sim	Número do cartão proximidade utilizado pelo funcionário.
numeroTeclado	String	Máx. 20 caracteres	Sim	Número que o funcionário utilizará para registrar o ponto através do teclado.
senha	String	Máx. 4 caracteres	Condicional	Senha cadastrada para registro de ponto via teclado. Obrigatório somente quando tipo de verificação for senha.
sinconismoAutomativo	Boolean	True ou False	Sim	Sincronismo automático define se os dados do coletor e funcionário serão enviados para os equipamentos.

Requisição (JSON)

{
    "idFuncionario": 1,
    "idTipoVerificacao": 4,
    "nomeExibicao": "Natalia Silva",
    "cartaoBarras": "20180616",
    "cartaoProximidade": "20180616",
    "numeroTeclado": "20180616",
    "senha": "0508",
    "sincronismoAutomatico": true
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoBarras": "20180616",
        "cartaoProximidade": "20180616",
        "numeroTeclado": "20180616",
        "senha": "0508",
        "identificador": "020046628589",
        "sincronismoAutomatico": true,
        "tipoVerificacao": {
            "idTipoVerificacao": 4,
            "descricao": "Senha"
        }
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Reques
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados coletores já cadastrados para o funcionário informado.	409 – Conflict
idTipoVerificacao	Tipo verificação não encontrado. Informe um id válido.	404 – Not Found
nomeExibicao	Nome de exibição não pode ser nulo.	400 – Bad Request
nomeExibicao	Nome de exibição ultrapassou o limite definido.	400 – Bad Request
cartaoBarras	Cartão QR Code/Barras não pode ser nulo.	400 – Bad Request
	Cartão QR Code/Barras não pode iniciar em 0.	400 – Bad Request
	Cartão QR Code/Barras ultrapassou o limite definido.	400 – Bad Request
	Já existe um funcionário com o mesmo cartão barras na empresa.	400 – Bad Request
cartaoProximidade	Cartão proximidade não pode ser nulo.	400 – Bad Request
	Cartão proximidade ultrapassou o limite definido.	400 – Bad Request
	Cartão proximidade não pode iniciar em 0.	400 – Bad Request
	Já existe um funcionário com o mesmo cartão proximidade na empresa.	400 – Bad Request
numeroTeclado	Número teclado não pode ser nulo.	400 – Bad Request
	Número teclado ultrapassou o limite definido.	400 – Bad Request
	Numero teclado não pode iniciar em 0.	400 – Bad Request
	Já existe um funcionário com o mesmo número teclado na empresa.	400 – Bad Request
senha	A senha só deve ser informada quando o tipo de verificação for ‘senha’.	400 – Bad Request
	Senha obrigatória quando o tipo de verificação for ‘senha’.	400 – Bad Request
	Senha ultrapassou o limite definido.	400 – Bad Request
	Senha deve conter apenas números.	400 – Bad Request
sincronismoAutomatico	Sincronismo automático não pode ser nulo.	400 – Bad Request

9.9.2 Consultar (lista)
Retorna uma lista de dados coletor dos funcionários cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-dados-coletor

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo Esperado

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Nome exibicao, Cartão barras, Cartão proximidade ou Número teclado	Não	Critério de busca dos dados pessoais (Nome exibicao, Cartão barras, Cartão proximidade ou Número teclado).

Requisição (Query Parameters)
https://integracao.topponto.com.br/cadastros/funcionarios-dados-coletor

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/funcionarios-dados-coletor

2. Exemplo com Busca por Nome
https://integracao.topponto.com.br/cadastros/funcionarios-dados-coletor?search=consulta

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idFuncionario": 1,
            "nomeExibicao": "Natalia Silva",
            "cartaoBarras": "20180616",
            "cartaoProximidade": "20180616",
            "numeroTeclado": "20180616",
            "senha": "0508",
            "identificador": "020046628589",
            "sincronismoAutomatico": true,
            "tipoVerificacao": {
                "idTipoVerificacao": 4,
                "descricao": "Senha"
            },
            "coletores": [
                {
                    "idFuncionario": 1,
                    "idColetor": 1,
                    "local": "ENTRADA 1",
                    "numeroSerie": "0062446",
                    "numeroModelo": "00365",
                    "descricaoSincronismo": "SINCRONIZADO",
                    "biometria": true
                },
                ...
            ]
        }
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.9.3 Consultar (id)
Retorna os dados coletor de um funcionário com base no idFuncionario informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-coletor/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/jsonX-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Requisição (URL)
https://integracao.topponto.com.br/cadastros/funcionario-dados-coletor/1

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoBarras": "20180616",
        "cartaoProximidade": "20180616",
        "numeroTeclado": "20180616",
        "senha": "0508",
        "identificador": "020046628589",
        "sincronismoAutomatico": true,
        "tipoVerificacao": {
            "idTipoVerificacao": 4,
            "descricao": "Senha"
        },
        "coletores": [
            {
                "idFuncionario": 1,
                "idColetor": 1,
                "local": "ENTRADA 1",
                "numeroSerie": "0062446",
                "numeroModelo": "00365",
                "descricaoSincronismo": "SINCRONIZADO",
                "biometria": true
            },
            ...
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id não pode ser nulo ou zero.	400 – Bad Request

9.9.4 Atualizar
Atualiza um registro de funcionário dados coletor no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-coletor

Estrutura

Método	Cabeçalho	Body
UPDATE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.
idTipoVerificacao	Number	1 a N (Número Positivo)	Sim	Identificador único do tipo de verificação
nomeExibicao	String	Máx. 16 caracteres	Sim	Nome que será exibido no display dos coletores
cartaoBarras	String	Máx. 20 caracteres.Não iniciar em 0.	Sim	Número do cartão barras utilizado pelo funcionário.
cartaoProximidade	String	Máx. 20 caracteres. Não iniciar em 0.	Sim	Número do cartão proximidade utilizado pelo funcionário.
numeroTeclado	String	Máx. 20 caracteres. Não iniciar em 0.	Sim	Número que o funcionário utilizará para registrar o ponto através do teclado.
senha	String	Máx. 4 caracteres	Condicional	Senha cadastrada para registro de ponto via teclado. Obrigatório somente quando tipo de verificação for senha.
sinconismoAutomativo	Boolean	True ou False	Sim	Sincronismo automático define se os dados do coletor e funcionário serão enviados para os equipamentos.

Requisição (JSON)

{
    "idFuncionario": 1,
    "idTipoVerificacao": 4,
    "nomeExibicao": "Natalia Silva",
    "cartaoBarras": "20180616",
    "cartaoProximidade": "20180616",
    "numeroTeclado": "20180616",
    "senha": "0616",
    "sincronismoAutomatico": true
}

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoBarras": "20180616",
        "cartaoProximidade": "20180616",
        "numeroTeclado": "20180616",
        "senha": "0616",
        "identificador": "020046628589",
        "sincronismoAutomatico": true,
        "tipoVerificacao": {
            "idTipoVerificacao": 4,
            "descricao": "Senha"
        }
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Reques
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados coletores já cadastrados para o funcionário informado.	409 – Conflict
idTipoVerificacao	Tipo verificação não encontrado. Informe um id válido.	404 – Not Found
nomeExibicao	Nome de exibição não pode ser nulo.	400 – Bad Request
nomeExibicao	Nome de exibição ultrapassou o limite definido.	400 – Bad Request
cartaoBarras	Cartão QR Code/Barras não pode ser nulo.	400 – Bad Request
	Cartão QR Code/Barras não pode iniciar em 0.	400 – Bad Request
	Cartão QR Code/Barras ultrapassou o limite definido.	400 – Bad Request
	Já existe um funcionário com o mesmo cartão barras na empresa.	400 – Bad Request
cartaoProximidade	Cartão proximidade não pode ser nulo.	400 – Bad Request
	Cartão proximidade ultrapassou o limite definido.	400 – Bad Request
	Cartão proximidade não pode iniciar em 0.	400 – Bad Request
	Já existe um funcionário com o mesmo cartão proximidade na empresa.	400 – Bad Request
numeroTeclado	Número teclado não pode ser nulo.	400 – Bad Request
	Número teclado ultrapassou o limite definido.	400 – Bad Request
	Numero teclado não pode iniciar em 0.	400 – Bad Request
	Já existe um funcionário com o mesmo número teclado na empresa.	400 – Bad Request
senha	A senha só deve ser informada quando o tipo de verificação for ‘senha’.	400 – Bad Request
	Senha obrigatória quando o tipo de verificação for ‘senha’.	400 – Bad Request
	Senha ultrapassou o limite definido.	400 – Bad Request
	Senha deve conter apenas números.	400 – Bad Request
sincronismoAutomatico	Sincronismo automático não pode ser nulo.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.9.5 Deletar
Não se enquadra.

9.10 Funcionário dados facial

9.10.1 Adicionar
Criar um novo registro de funcionário dados facial no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-facial

Estrutura

Método	Cabeçalho	Body
POST	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.
nomeExibicao	String	Máx. 16 caracteres	Sim	Nome que será exibido no display dos leitores faciais.
senha	String	Máx. 4 caracteres	Não	Senha cadastrada para registro de ponto via teclado. Obrigatório somente quando tipo de verificação for senha.

Requisição (JSON)

{
    "idFuncionario": 1,
    "nomeExibicao": "Natalia Silva",
    "cartaoProximidade": "20180616",
    "senha": "0508"
}

Resposta

{
    "message": "Salvo com sucesso",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoProximidade": "20180616",
        "senha": "0508"
    },
    "status": 201
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Request
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados facial já cadastrados para o funcionário informado.	409 – Conflict
nomeExibicao	Nome de exibição não pode ser nulo.	400 – Bad Request
	Nome de exibição não pode ser vazio.	400 – Bad Request
	Nome de exibição ultrapassou o limite definido.	400 – Bad Request
senha	Senha deve conter apenas números.	400 – Bad Request
senha	Senha ultrapassou o limite definido.	400 – Bad Request

9.10.2 Consultar (lista)
Retorna uma lista de dados faciais dos funcionários cadastrados.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionarios-dados-faciais

Estrutura

Método	Cabeçalho	Query Parameters
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Tipo Esperado

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
search	String	Nome exibicao ou Cartão proximidade.	Não	Critério de busca dos dados pessoais (Nome exibicao ou Cartão proximidade).

Requisição (Query Parameters)
https://integracao.topponto.com.br/cadastros/funcionarios-dados-faciais

1. Exemplo Básico
https://integracao.topponto.com.br/cadastros/funcionarios-dados-faciais

2. Exemplo com Busca por Nome
https://integracao.topponto.com.br/cadastros/funcionarios-dados-faciais?search=consulta

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idFuncionario": 1,
            "nomeExibicao": "Natalia Silva",
            "cartaoProximidade": "20180616",
            "senha": "0508",
            "faciais": [
                {
                    "idFuncionario": 1,
                    "nomeExibicao": "Natalia Silva",
                    "cartaoProximidade": "20180616",
                    "senha": "0508"
                }
            ]
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

9.10.3 Consultar (id)
Retorna os dados facial de um funcionário com base no idFuncionario informado no endpoint.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-facial/idFuncionario

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/jsonX-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoProximidade": "20180616",
        "senha": "0508",
        "faciais": [
            {
                "idFuncionario": 1,
                "nomeExibicao": "Natalia Silva",
                "cartaoProximidade": "20180616",
                "senha": "0508"
            }
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id não pode ser nulo ou zero.	400 – Bad Request

9.10.4 Atualizar
Atualiza um registro de funcionário dados facial no sistema.

Endpoint
https://integracao.topponto.com.br/cadastros/funcionario-dados-facial

Estrutura

Método	Cabeçalho	Body
UPDATE	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idFuncionario	Number	1 a N (Número Positivo)	Sim	Identificador único do funcionário.
nomeExibicao	String	Máx. 16 caracteres	Sim	Nome que será exibido no display dos leitores faciais.
senha	String	Máx. 9 caracteres	Não	Senha cadastrada para registro de ponto via teclado. Obrigatório somente quando tipo de verificação for senha.

Requisição (JSON)

{
    "idFuncionario": 1,
    "nomeExibicao": "Natalia Silva",
    "cartaoProximidade": "20180616",
    "senha": "0616"
}

Resposta

{
    "message": "Atualizado com sucesso",
    "body": {
        "idFuncionario": 1,
        "nomeExibicao": "Natalia Silva",
        "cartaoProximidade": "20180616",
        "senha": "0616"
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idFuncionario	O id do funcionário não pode ser nulo.	400 – Bad Request
	O id do funcionário deve ser maior que 0.	400 – Bad Request
	Funcionário não encontrado. Informe um id válido.	404 – Not Found
	Dados facial já cadastrados para o funcionário informado.	409 – Conflict
nomeExibicao	Nome de exibição não pode ser nulo.	400 – Bad Request
	Nome de exibição não pode ser vazio.	400 – Bad Request
	Nome de exibição ultrapassou o limite definido.	400 – Bad Request
senha	Senha deve conter apenas números.	400 – Bad Request
senha	Senha ultrapassou o limite definido.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

9.10.5 Deletar
Não se enquadra.

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.
idTipoDocumento	Number	1 (CNPJ) ou 2 (CPF)	Sim	Tipo do documento da empresa: 1 para CNPJ ou 2 para CPF.
razaoSocial	String	Máx. 150 caracteres	Sim	Razão social da empresa.
nomeFantasia	String	Máx. 50 caracteres	Sim	Nome fantasia da empresa.
documento	String	Exatos 18 caracteres	Sim	Número do documento (CNPJ ou CPF).
idExportacao	String	Máx. 15 caracteres	Não	Utilizado para exportar uma referência da empresa.
endereco	String	Máx. 100 caracteres	Não	Endereço completo da empresa.
bairro	String	Máx. 100 caracteres	Não	Bairro da empresa.
cep	String	Máx. 10 caracteres	Não	Código postal (CEP) da empresa.
cidade	String	Máx. 60 caracteres	Não	Cidade onde a empresa está localizada.
uf	String	Exatos 2 caracteres	Não	Unidade Federativa (UF) da empresa.
diaApuracao	Number	Intervalo de dias entre 1 e 31	Sim	Dia de apuração.
fone	String	Máx. 20 caracteres	Não	Telefone de contato da empresa.
ativo	Boolean	true ou false	Sim	Indica se a empresa está ativa no sistema.
grupoEconomico	Boolean	true ou false	Sim	Indica se a empresa pertence a um grupo econômico.
observacao	String	Máx. 170 caracteres	Não	Observações sobre a empresa.

Requisição (JSON)

{
    "idEmpresa": 1,
    "idTipoDocumento": 1,
    "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
    "nomeFantasia": "Topdata sistemas de automação ltda.",
    "documento": "72.041.049/0001-01",
    "idExportacao": null,
    "endereco": "Rod. Br-277, 2160",
    "bairro": "Mossunguê",
    "cep": "81200-300",
    "cidade": "Curitiba",
    "uf": "PR",
    "diaApuracao": 1,
    "fone": "(41)3213-7100",
    "whatsApp": null,
    "ativo": true,
    "grupoEconomico": true,
    "observacao": null
}

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idEmpresa": 1,
        "idTipoDocumento": 1,
        "razaoSocial": "Topdata – Fabricante de Catracas e Relógios de Ponto",
        "nomeFantasia": "Topdata sistemas de automação ltda.",
        "documento": "72.041.049/0001-01",
        "idExportacao": null,
        "endereco": "Rod. Br-277, 2160",
        "bairro": "Mossunguê",
        "cep": "81200-300",
        "cidade": "Curitiba",
        "uf": "PR",
        "diaApuracao": 1,
        "fone": "(41)3213-7100",
        "whatsApp": null,
        "ativo": true,
        "grupoEconomico": true,
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	O id da empresa não pode ser nulo.	400 – Bad Request
	O id da empresa deve ser maior que 0.	400 – Bad Request
	Empresa não encontrada. Informe um id válido.	404 – Not Found
idTipoDocumento	O id tipo de documento inválido. Informe 1 para CNPJ ou 2 para CPF.	400 – Bad Request
razaoSocial	A razão social da empresa não pode ser vazia.	400 – Bad Request
razaoSocial	Razão social da empresa ultrapassou o limite definido.	400 – Bad Request
nomeFantasia	Nome fantasia da empresa ultrapassou o limite definido.	400 – Bad Request
documento	O documento da empresa não pode ser vazio.	400 – Bad Request
	Documento da empresa ultrapassou o limite definido.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CNPJ.	400 – Bad Request
	Já existe uma empresa cadastrada com esse CPF.	400 – Bad Request
idExportacao	Id de exportação da empresa ultrapassou o limite definido.	400 – Bad Request
endereco	Endereço da empresa ultrapassou o limite definido.	400 – Bad Request
bairro	Bairro da empresa ultrapassou o limite definido.	400 – Bad Request
cep	Cep da empresa ultrapassou o limite definido.	400 – Bad Request
cidade	Cidade da empresa ultrapassou o limite definido.	400 – Bad Request
uf	Uf da empresa ultrapassou o limite definido.	400 – Bad Request
fone	Fone da empresa ultrapassou o limite definido.	400 – Bad Request
diaApuracao	Dia de apuração não pode ser nulo.	400 – Bad Request
diaApuracao	Dia de apuração deve estar entre os dias 1 e 31 do mês.	400 – Bad Request
ativo	O campo ativo da empresa não pode ser nulo.	400 – Bad Request
grupoEconomico	O campo grupo econômico da empresa não pode ser nulo.	400 – Bad Request
observacao	Observação da empresa ultrapassou o limite definido.	400 – Bad Request
Geral	Nenhuma alteração detectada. Os dados enviados são idênticos aos já salvos.	400 – Bad Request
Geral	Atualizado com sucesso, mas não foi possível retornar os dados.	400 – Bad Request

Mais páginas

Mais Páginas

Introdução
Eventos
Painel
Erros Catalogados

Páginas: 1 2 3 4 5

« Anterior 1 2 3 4 5 Próxima »

Esse artigo foi útil?

Sim Não