pre employee moved event
Essa documentação se refere ao glossário do webhook de dados de admissão para sistema de folha do cliente.
Esse webhook é disparado toda vez que uma pessoa pré-colaboradora é movida entre etapas do Gupy Admissão.
A partir dele é possível desenvolver o fluxo de admissão para a folha de pagamento utilizada pela sua empresa, fazer envio dos dados para exame médico e também para provisionamento de equipamentos para a nova pessoa colaboradora. Para ver o contrato JSON desse webhook clique aqui.
Mapeamento de campos obrigatórios
Preste atenção aos campos obrigatórios exigidos pelo seu sistema ao desenvolver a integração, pois caso o documento não esteja como obrigatório dentro do template de admissão pode ocorrer da pessoa pré-colaboradora não realizar o preenchimento.
Caso você não tenha acesso aos templates e documentos solicitados à pessoa pré-colaboradora no Gupy Admissão, faça o alinhamento com o time de Departamento Pessoal da sua empresa, levantando quais campos são necessários para que a integração ocorra com sucesso.
| CAMPO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| companyName | Nome da empresa | ||
| id | Não visível | Id do evento | |
| event | Não visível | valor fixo = "pre-employee.moved" | |
| date | Não visível | Data em que foi realizada a movimentação de gatilho para disparo do webhook | |
| job.id | Número gerado automaticamente pela Gupy ao criar uma vaga (conhecido como jobId). Na tela de gestão de admissões, a coluna Código e nome da vaga | Retorno results.id ao criar uma vaga utilizando o endpoint creating a job | |
| job.name | Na tela de gestão de admissões, a coluna Código e nome da vaga | Nome da vaga da em que o candidato foi contratado | |
| job.type | vacancy_type_apprentice, vacancy_type_associate, vacancy_type_talent_pool, vacancy_type_effective, vacancy_type_internship, vacancy_type_summer, vacancy_type_temporary, vacancy_type_outsource, vacancy_type_trainee, vacancy_type_volunteer, vacancy_legal_entity, vacancy_type_lecturer, vacancy_type_freelancer, vacancy_type_autonomous | Tipo da vaga | |
| job.department. id | Não visível | Código do departamento/área gerado automaticamente na criação. | |
| job.department. code | Não visível | Quando uma área é criada através da plataforma esse campo fica "null", mas ao utilizar o endpoint creating a department é possível atribuir um valor para esse campo. É muito utilizado para realizar integrações com sistemas de folha onde é preciso enviar o código da área em que o candidato foi contratado. | |
| job.department. name | Nome da área da vaga em que o candidato foi contratado | ||
| job.department. similarity | financial_management, agronomy, architecture, audit_or_quality, attendance, sales, purchases, communication_or_design _or_marketing, accounting_or_controlling, engineering_or_maintenance _or_technical_services, legal, innovation_or_product, logistics, operations, project_or_processes, human_resources, security technology | Visível no setup de áreas | |
| job.role.id | Não visível | Código do cargo gerado automaticamente na criação. | |
| job.role.name | Ao acessar uma admissão a informação Cargo no lado esquerdo da tela | Nome do cargo da vaga em que o candidato foi contratado | |
| job.role.code | Não visível | Quando um cargo é criado através da plataforma esse campo fica "null", mas ao utilizar o endpoint creating a role é possível atribuir um valor para esse campo. É muito utilizado para realizar integrações com sistemas de folha onde é preciso enviar o código do cargo em que o candidato foi contratado. | |
| job.role. similarity | analyst, apprentice, auxiliary, consultant, coordinator, developer, director, intern, specialist, supervisor, manager, operator, technician, trainee | Visível no setup de cargos | |
| job.branch.id | Não visível | Código da filial/estrutura organizacional gerado automaticamente na criação. | |
| job.branch.code | Não visível | ||
| job.branch.name | Nome da filial/estrutura organizacional da vaga em que o candidato foi contratado | ||
| job.customfields. id | Não visível | Id gerado automaticamente ao criar um campo customizado na plataforma | |
| job.customfields. title | Nome do campo customizado criado no Gupy R&S | ||
| job.customfields. value | Valor que está atribuído ao campo no momento em que o evento foi disparado. (Caso a opção do campo customizada seja alterada e o evento seja disparado novamente ele carregará a nova opção que foi atribuída) | ||
| application.id | Número gerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga. Ao acessar uma candidatura o Id aparece na URL após /jobs/jobId/candidates | Retorno results.id ao criar uma candidatura utilizando o endpoint creating an application | |
| application.score | Na lista de candidatos em uma vaga é a porcentagem antes do nome do candidato e ao acessar uma candidatura, na tela principal é o valor definido para "Afinidade" | Aderência do candidato à vaga | |
| application.partnerName | 99hunters, catho, facebook_jobs, geekhunter, glassdoor, google_for_jobs, indeed, indeed_sponsored, jooble, linkedin, netvagas, riovagas, trampos, gupy_opportunities, gupy_opportunities_recommended, gupy_public_page, gupy_public_page_event | Nome do parceiro que gerou a candidatura. Em casos de inserção manual, essa informação só é preenchida após o candidato aceitar o convite. | |
| application.tags | Ao acessar uma candidatura, menu de Avaliação do Candidato no lado direito da tela | Tags relacionadas à candidatura, se houverem. | |
| currentStep.id | Ao editar uma etapa, o seu Id aparecerá na URL. Como nesse caso, a etapa que pessoa candidata está quando vai para o Admissão é sempre a padrão de Contratação o Id estará ao final da URL logo após /step/final | Id da etapa em que o candidato estava quando foi para o Gupy Admissão | |
| currentStep.name | Na lista de candidatos em uma vaga, o nome da etapa está logo abaixo do nome do candidato e ao abrir uma candidatura, tela principal do candidato, logo abaixo do nome. | Nome da etapa em que o candidato estava no Gupy R&S quando foi para o Gupy Admissão (Nesse caso sempre será "Contratação" | |
| currentStep.type | no caso desse webhook o type será "final" | Não visível | Esse campo pega as informações do Gupy R&S e lá esses campos possuem os seguintes valores: register: etapa de cadastro online: etapa customizada quando há alguma ação automática (teste, envio de vídeos, disparo de e-mail) offline: etapa customizada que há algum tipo de ação fora da plataforma (entrevista, agendamentos) |
| candidate.id | Não visível | Id do candidato, gerado na primeira vez em que ele se inscreve em alguma vaga na Gupy. | |
| candidate.name | Na gestão de admissões, a coluna Pré-colaborador | Nome do candidato | |
| candidate.lastName | Na gestão de admissões, a coluna Pré-colaborador | Sobrenome do candidato | |
| candidate.email | Ao acessar uma admissão, no lado esquerdo da tela abaixo do número de celular do pré-colaborador. | E-mail do candidato | |
| candidate. countryOfOrigin | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | País de origem do candidato | |
| candidate.birthdate | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Data de aniversário do candidato | |
| candidate. addressZipCode | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | CEP da residência do candidato | |
| candidate. addressStreet | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Logradouro da residência do candidato | |
| candidate. addressNumber | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Número da residência do candidato | |
| candidate. addressCity | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Cidade da residência do candidato | |
| candidate. addressState | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Estado onde o candidato reside | |
| candidate. addressStateShortName | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Abreviação do nome do Estado onde o candidato reside | |
| candidate. addressCountry | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | País de residência do candidato | |
| candidate. addressCountryShortName | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Abreviação do nome do país onde o candidato reside | |
| candidate. mobileNumber | Ao acessar uma admissão, no lado esquerdo da tela logo abaixo o nome do pré-colaborador | Telefone celular do candidato | |
| candidate. phoneNumber | Ao acessar uma candidatura no Gupy R&S, aba Cadastro | Telefone fixo do candidato | |
| candidate. schooling | elementary_school, high_school, technical_course, technological, graduation, post_graduate, master_degree, phd | Ao acessar uma candidatura no Gupy R&S na tela principal | Nível escolar do candidato |
| candidate. schoolingStatus | complete, in_progress, incomplete | Ao acessar uma candidatura no Gupy R&S na tela principal | Status de andamento do nível escolar informado |
| candidate.disabilities | true, false | Ao abrir uma candidatura no Gupy R&S, na tela principal do candidato em Diversidade | Caso o candidato tenha informado possuir alguma deficiência esse campo vem true, caso contrário, false. |
| candidate.gender | male, female, other, notInformed | Ao acessar uma candidatura, aba Cadastro | Gênero do candidato |
| admission.status | SEND_DOCUMENTS, SIGNING_CONTRACT, ADMISSION_CONCLUDED, OUT_PROCESS | Se a etapa for customizada o seu identificador será um id, para consultá-lo será necessário ir no setup -> admissão -> definição de etapas -> Editar etapa de interesse -> Na URL terá o id da etapa customizada | Nome da etapa em que foi disparado o evento |
| admission. admissionDeadline | Ao acessar uma admissão o campo Prazo de envio de documentos ao lado esquerdo da tela | ||
| admission. hiringDate | Na gestão de admissões, a coluna Data de admissão | Data da contratação que foi preenchida na tela de dados de contratação no Gupy R&S | |
| admission. documentsTemplate.id | Ao acessar o setup -> Admissão -> Templates de Admissão e selecione o template desejado, na URL aparecerá seu id após companies/setup /admission/templates/ | Id do template de admissão que foi escolhido no momento de iniciar a admissão do pré-colaborador | |
| admission. documentsTemplate.name | Ao acessar uma admissão iniciada, na aba Informações | Nome do template de admissão que foi escolhido no momento de iniciar a admissão do pré-colaborador | |
| admission.documents. preEmployee | Na Gestão de Admissões, etapa Envio da Documentação | Documentos do pré-colaborador | |
| admission.position | Estrutura que recebe os campos customizados do Gupy Admissão juntamente com centro de custo e turno | ||
| admission.position. customFields | Setup -> Admissão -> Campos customizados de pré-admissão e ao acessar uma admissão iniciada, na aba Detalhes da admissão | Array de campos customizados do Gupy Admissão, se houver. | |
| admission.position. branch | Objeto que traz as informações de id, code e nome da EO/Filial | ||
| admission.position. department | Objeto que traz as informações de id, code e nome da área | ||
| admission.position.role | Objeto que traz as informações de id, code e nome do cargo | ||
| admission.position. costCenter | Setup -> Admissão -> Centro de Custo e ao acessar uma admissão iniciada, na aba Detalhes da admissão | ||
| admission.position. workShift | Setup -> Admissão -> Turnos e ao acessar uma admissão iniciada, na aba Detalhes da admissão | Objeto que traz as informações de id, code e nome, descrição e carga horária do turno de trabalho informado na admissão |
As informações dos documentos que o pré-colaborador subiu na plataforma são entregues no array de documentos:
admission.documents.preEmployee
O array é composto pelos seguintes campos:
| CAMPO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| id | Id do documento que é gerado automaticamente pela Gupy | ||
| name | Nome do documento padrão da Gupy, exemplo: Carteira de Identidade (RG) | ||
| values | Campos que compõem o documento |
Os values são os valores que cada campo de cada documento recebe quando o pré-colaborador preenche a documentação. Abaixo iremos trazer todos os values de cada documento padrão da Gupy. Caso um campo de um documento não seja respondido ele não é enviado no webhook.
name: Carteira de Identidade (RG)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| nome | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Nome completo do pré-colaborador | |
| nome-social | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Nome social do pré-colaborador | |
| etnia | Branca, Preta/Negra, Amarela, Parda, Indígena | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | |
| genero | Feminino, Masculino | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | |
| uf-emissor | Consulte nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| nome-da-mae | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Nome completo da mãe do pré-colaborador | |
| nome-do-pai | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Nome completo do pai do pré-colaborador | |
| estado-civil | Solteiro(a) Casado(a) Separado(a) Divorciado(a) Viúvo(a) | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | |
| numero-do-rg | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Essa informação é enviada sem máscara (sem pontos ou traços) | |
| nacionalidade | Consulte Nome do País em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | A Gupy envia o nome do país por extenso, exemplo: Brasil |
| orgao-emissor | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | ||
| data-de-expedicao | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| cidade-onde-nasceu | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE | |
| data-de-nascimento | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| estado-onde-nasceu | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG) | Para esse campo a Gupy envia o nome do Estado por extenso, exemplo: "Alagoas" |
name: Comprovante de residência
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| tipo | Consulte nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | |
| bairro | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Bairro em que o pré-colaborador reside | |
| cidade | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE | |
| numero | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Número do logradouro | |
| cep | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia a informação de CEP no formato 00000-000 | |
| pais | Consulte Nome do País em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia o nome do país por extenso, exemplo: Brasil |
| estado | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia nesse campo a informação do nome do Estado por extenso, exemplo: Alagoas |
| logradouro | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Rua em que o pré-colaborador reside | |
| complemento | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Complemento do logradouro |
name: Carteira de Habilitação (CNH)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| categoria | A, B , C, D, E AB, AC, AD AE | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | |
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| validade | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| orgao-emissor | Denatran, Senatran ou Outro (essa opção abre um campo texto livre) | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | |
| data-de-emissao | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| numero-de-registro | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | ||
| data-da-primeira-habilitacao | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
name: Cartão Nacional de Saúde (CNS)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero | Etapa envio de documentos, ao acessar o documento Cartão Nacional de Saúde (CNS) |
name: CPF
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero-do-cpf | Etapa envio de documentos, ao acessar o documento CPF | A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx |
name: Comprovante de Escolaridade
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| grau_instrucao | Analfabeto, Ensino fundamental l incompleto, Ensino fundamental I completo, Ensino fundamental Il incompleto, Ensino fundamental IlI completo, Ensino médio incompleto, Ensino médio completo, Educação superior incompleta, Educação superior completa, Pós-graduação completa, Mestrado completo, Doutorado completo | Etapa envio de documentos, ao acessar o documento Comprovante de Escolaridade |
name: Contrato de estágio
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| nome | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| grau_instrucao | Analfabeto, Ensino fundamental l incompleto, Ensino fundamental I completo, Ensino fundamental Il incompleto, Ensino fundamental IlI completo, Ensino médio incompleto, Ensino médio completo, Educação superior incompleta, Educação superior completa, Pós-graduação completa, Mestrado completo, Doutorado completo | Etapa envio de documentos, ao acessar o documento Contrato de estágio | |
| tipo-estagio | Estágio remunerado, Estágio obrigatório ou curricular, Estágio supervisionado, Estágio não obrigatório ou voluntário. | Etapa envio de documentos, ao acessar o documento Contrato de estágio | |
| numero-apolice | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| nivel-estagio | Médio, Técnico, Superior | Etapa envio de documentos, ao acessar o documento Contrato de estágio | |
| area-estagio | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| cpf-coordenador | Etapa envio de documentos, ao acessar o documento Contrato de estágio | A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx | |
| nome-coordenador | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| cnpj-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| nome-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| cep-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | A Gupy envia a informação de CEP no formato 00000-000 | |
| tipo-logradouro-instituicao | Consulte nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Contrato de estágio | |
| logradouro-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| numero-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| complemento-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| bairro-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | ||
| uf-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas | |
| cidade-instituicao | Etapa envio de documentos, ao acessar o documento Contrato de estágio |
name: Comprovante de PIS/Pasep
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero | Etapa envio de documentos, ao acessar o documento Comprovante de PIS/Pasep | A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x Esse é um campo de preenchimento obrigatório mesmo que seja o primeiro emprego da pessoa pré-colaboradora, pois o número do PIS pode ser retirado na agência da Caixa ou enviado pela empresa. Caso a empresa tenha esse cenário de que ela faz a qualificação o documento de comprovante de PIS/PASEP não precisa ser adicionado no check-list de admissão. | |
| primeiro-emprego | true, false | Etapa envio de documentos, ao acessar o documento Comprovante de PIS/Pasep | Pergunta obrigatória |
name: Certificado de Reservista
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero-ra | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x | |
| regiao-militar | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | ||
| orgao-expeditor | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | ||
| uf-de-expedicao | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| situacao-militar | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | ||
| categoria-militar | Etapa envio de documentos, ao acessar o documento Certificado de Reservista |
name: Documento de Identificação Profissional (DIP)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x | |
| uf | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | ||
| data-de-emissao | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| uf-de-expedicao | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| data-de-registro | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| data-de-validade | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| associacao-profissional | Conselho Regional de Administração - CRA, Conselho Regional de Artquitetura e Urbanismo - CAU, Conselho Regional de Biblioteconomia - CRB, Conselho Regional de Biologia - CRBIO, Conselho Regional de Biomedicina - CRBM, Conselho Regional de Contabilidade - CRC, Conselho Regional de Corretores de Imóveis - CRECI, Conselho Regional de Economia - CORECON, Conselho Regional de Educação Física - CREF, Conselho Regional de Educadores e Pedagogos - CREP, Conselho Regional de Enfermagem - COREN, Conselho Regional de Engenharia e Agronomia - CREA, Conselho Regional de Farmácia - CRF, Conselho Regional de Fisioterapia e Terapia Ocupacional - CREFITO, Conselho Regional de Medicina - CRM, Conselho Regional de Medicina Veterinária - CRMV, Conselho Regional de Odontologia - CRO, Conselho Regional de Psicologia - CRP, Conselho Regional de Química - CRQ, Conselho Regional de Relações Públicas - CONRERP, Conselho Regional de Representantes Comerciais - CORE, Conselho Regional de Serviço Social - CRESS, Conselho Regional de Técnicos Agrícolas - CRTA, Conselho Regional de Técnicos Industriais - CRT, Conselho Regional e Fonoaudiologia - CREFONO, Ordem dos Advogados do Brasil - OAB, Ordem dos Músicos do Brasil - OMB Conselho Nacional de Técnicos em Radiologia - CONTER Conselho Regional de Técnicos em Radiologia - CRTR Conselho Nacional de Profissionais da Beleza - CNPB Superintendência Regional do Trabalho e Emprego - SRTE Ministério do Trabalho e Emprego - MTE | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) |
name: Título de Eleitor
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero | Etapa envio de documentos, ao acessar o documento Título de Eleitor | A Gupy envia a informação no seguinte formato: xxxx xxxx xxxx | |
| zona | Etapa envio de documentos, ao acessar o documento Título de Eleitor | ||
| secao | Etapa envio de documentos, ao acessar o documento Título de Eleitor | ||
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Título de Eleitor | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| data-de-emissao | Etapa envio de documentos, ao acessar o documento Título de Eleitor | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| cidade-votacao | Etapa envio de documentos, ao acessar o documento Título de Eleitor | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE |
name: Laudo Médico
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| tipo_deficiencia | Auditiva, Física, Intelectual, Mental, Visual, Reabilitado | Etapa envio de documentos, ao acessar o documento Laudo Médico |
name: Carteira de Trabalho (CTPS)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| numero-ctps | Etapa envio de documentos, ao acessar o documento Carteira de Trabalho (CTPS) | ||
| serie-ctps | Etapa envio de documentos, ao acessar o documento Carteira de Trabalho (CTPS) | ||
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Carteira de Trabalho (CTPS) | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| data-de-emissao | Etapa envio de documentos, ao acessar o documento Carteira de Trabalho (CTPS) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
name: Atestado de Saúde Ocupacional (ASO)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| data_exame | Etapa envio de documentos, ao acessar o documento Atestado de Saúde Ocupacional (ASO) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
name: Carteira de Registro Nacional Migratório (CRNM)
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| sexo | Feminino Masculino | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
| casado | Sim, Não | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | |
| filhos | Sim, Não | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | |
| numero-crnm | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| data-emissao | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| classificacao | Fronteiriço, Residente, Provisório, Visto Permanente, Visto Temporário, Asilado, Refugiado, Solicitante de Refugio, Residente fora do Brasil, Deficiente físico e com mais de 50 anos, Com residência provisória e anistiado, em situação irregular, Permanência no Brasil em razão de filhos ou cônjuges brasileiros, Beneficiado pelo acordo entre países do Mercosul, Dependente de agente diplomático e/ou consular, Benefic. pelo Tratado de Amizade, entre a Repúb. do Brasil e Repúb. Portuguesa | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | |
| data-validade | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| nacionalidade | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| nome-completo | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| orgao-emissor | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| data-nascimento | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| data-chegada-brasil | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| tipo-visto | Cortesia, Diplomático, Oficial, Permanente, Temporário, Trânsito, Turista | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | |
| nome-da-mae | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| nome-do-pai | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | ||
| naturalizado-brasileiro | Sim, Não | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | |
| numero-portaria-naturalizacao | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | Aparece apenas se naturalizado-brasileiro for Sim | |
| data-portaria-naturalizacao | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | (Aparece apenas se naturalizado-brasileiro for Sim). O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| data-naturalizacao | Etapa envio de documentos, ao acessar o documento Carteira de Registro Nacional Migratório (CRNM) | (Aparece apenas se naturalizado-brasileiro for Sim). O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
name: Passaporte
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| tipo | Etapa envio de documentos, ao acessar o documento Passaporte | Campo de texto livre (obrigatório) | |
| pais | Etapa envio de documentos, ao acessar o documento Passaporte | Campo de texto livre (obrigatório) | |
| numero | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório | |
| nome | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório | |
| data-de-nascimento | Etapa envio de documentos, ao acessar o documento Passaporte | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| sexo | Feminino, Masculino | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório |
| nacionalidade | Consulte Nome do País em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório - A Gupy envia o nome do país por extenso, exemplo: Brasil |
| estado | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório - A Gupy envia nesse campo a informação do nome do Estado por extenso, exemplo: Alagoas |
| naturalidade | Etapa envio de documentos, ao acessar o documento Passaporte | Campo obrigatório | |
| nome-da-mae | Etapa envio de documentos, ao acessar o documento Passaporte | Campo de texto livre (obrigatório) | |
| nome-do-pai | Etapa envio de documentos, ao acessar o documento Passaporte | Campo de texto livre | |
| data-de-emissao | Etapa envio de documentos, ao acessar o documento Passaporte | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| data-de-validade | Etapa envio de documentos, ao acessar o documento Passaporte | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| orgao-emissor | Etapa envio de documentos, ao acessar o documento Passaporte | Campo de texto livre |
name: Dados bancários
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| banco | Etapa envio de documentos, ao acessar o documento Dados bancários | ||
| conta | Etapa envio de documentos, ao acessar o documento Dados bancários | Esse campo não é passado com o dígito | |
| digito | Etapa envio de documentos, ao acessar o documento Dados bancários | ||
| agencia | Etapa envio de documentos, ao acessar o documento Dados bancários | Esse campo não é passado com o dígito. |
name: Dependentes v2
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|---|---|---|
| cpf | Etapa envio de documentos, ao acessar o documento Dependentes | A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx | |
| birthDate | Etapa envio de documentos, ao acessar o documento Dependentes | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z | |
| name | Etapa envio de documentos, ao acessar o documento Dependentes | Nome do dependente | |
| birthLocation | Etapa envio de documentos, ao acessar o documento Dependentes | Local de nascimento | |
| handicapped | true, false | Etapa envio de documentos, ao acessar o documento Dependentes | Campo que traz a informação se o dependente possui deficiencia |
| dependentTypeId | Consulte ID DO TIPO DE DEPENDENTE em nossas tabelas auxiliares para obter a lista de cada dependentTypeId, clicando aqui | Etapa envio de documentos, ao acessar o documento Dependentes | Cada dependentTypeId está vinculado à um tipo de relação que o colaborador tem com o seu dependente. Cada Id desse relacionamento é único. |
| gender | Feminino, Masculino | Etapa envio de documentos, ao acessar o documento Dependentes | |
| cityOfOrigin | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE | Etapa envio de documentos, ao acessar o documento Dependentes | Cidade de nascimento do dependente |
| stateOfOrigin | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Dependentes | Estado de nascimento do dependente |
| countryOfOrigin | Consulte Nome do País em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Dependentes | País de nascimento do dependente |
| includeIncomeTax | true, false | Etapa envio de documentos, ao acessar o documento Dependentes | Campo traz a resposta para a pergunta se o dependente é incluído no Imposto de Renda. A dedução ao Imposto de Renda está elegível para TODAS as relações de dependentes, com exceção de “Ex-Cônjuge” e “Agregado/Outros”. |
| includeSalarioFamilia | true, false | Etapa envio de documentos, ao acessar o documento Dependentes | Campo traz a resposta para a pergunta se o dependente é incluído no Salário Família. O direito ao Salário Família está condicionado apenas à relação de “Filho(a) ou enteado(a)” de até 14 anos de idade. Caso seja um filho com incapacidade, este direito passa a não ser condicionado por idade. |
| hasIdentificationDocument | true, false | Etapa envio de documentos, ao acessar o documento Dependentes | |
| tipo-deficiencia | Auditiva, Física, Intelectual Mental, Visual | Etapa envio de documentos, ao acessar o documento Dependentes | |
| payPension | True, False | Etapa envio de documentos, ao acessar o documento Dependentes | Campo traz a resposta para a pergunta: "Você paga pensão para esse dependente?" E só aparece se a relação for de filho e menor de idade. |
Documentos customizados
Eventualmente, pode ocorrer a necessidade da criação de um documento customizado para atender alguma regra do seu sistema de folha ou do seu processo admissional. Nesse caso cada campo do documento será composto por um Id gerado automaticamente pela Gupy no momento da criação desse documento.
Para saber quais são os Ids e mapear os campos da integração, aconselhamos que seja feita a simulação do preenchimento da documentação através da visão de um candidato teste e após o envio dos documentos, seja feita a movimentação de etapa. Assim o webhook será disparado com as informações, possibilitando mapear também os campos do documento customizado.
Updated 3 months ago