Colaboradores / Persons

Cadastro / Add

[PT] Este serviço permite o cadastro de um colaborador. Um JSON no formato abaixo relacionado deve ser enviado como payload. Os campos obrigatórios estão marcados com um () na aba "Model".[EN] Creates a new person. The payload to be sent is the bellow JSON. Required fields have a asterisk mark () in "Model" tab.

post/persons

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/persons
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Request body

idinteger

[PT]ID do colaborador [EN]Person ID

personSituationIdinteger required

[PT]ID da situação do colaborar. Valores: [ID - 1] - TRABALHANDO [ID - 2] - AUSENTE [ID - 3] - DEMITIDO [EN]Person situation ID. Values: [ID - 1] - WORKING [ID - 2] - ABSENT [ID - 3] - DISMISSED

personTypeIdinteger required

[PT]ID do tipo de colaborar. Valores: [ID - 1] - COLABORADOR [ID - 2] - TERCERIZADO [EN]Person type ID. Values: [ID - 1] - EMPLOYEE [ID - 2] - OUTSOURCED

businessUnitIdinteger

[PT]ID da unidade de negócio [EN]Person business unit ID

businessUnitNamestring

[PT]Nome da unidade de negócio [EN]Name business unit ID

careerIdinteger required

[PT]ID do cargo [EN]Person career ID

companyIdinteger

[PT]ID da empresa [EN]Person company ID

enrolmentstring

[PT]Matricula do colaborador [EN]Person enrolment

namestring required

[PT]Nome do colaborador [EN]Person name

emailstring

[PT]E-mail do colaborador [EN]Person E-mail

phonestring

[PT]Telefone do colaborador [EN]Person phone

phone2string

[PT]Telefone 2 do colaborador [EN]Person phone 2

externalIdstring

[PT]ID externo do colaborador [EN]External person ID

cpfstring

[PT]CPF do colaborador [EN]Person register number

pisstring

[PT]PIS do colaborador [EN]Person number social inegration

zipCodestring

[PT]Código postal [EN]Zip code

addressstring

[PT]Endereço [EN]Address

districtstring

[PT]Bairro [EN]District

citystring

[PT]Cidade [EN]City

statestring

[PT]Estado [EN]State

countrystring

[PT]País [EN]Country

houseNumberstring

[PT]Número da casa [EN]House number

complementstring

[PT]Complemento [EN]Complement

genderstring

[PT]Gênero [EN]Gender

birthDatestring

[PT]Data de aniversário [EN]Birth date

admissionDatestring required

[PT]Data de admissão [EN]Admission date

demissionDatestring

[PT]Data de demissão [EN]Demission date

issueDateRegisterNumberstring

[PT]Data de emissão [EN]Issuing date

adminDeviceboolean

[PT]Adminstrador do dispositivo [EN]Admin device

workplaceIdinteger

[PT]ID do posto [EN]Workplace ID

workplaceNamestring

[PT]Nome do posto [EN]Workplace Name

externalWorkplaceIdstring

[PT]ID externo do posto [EN]External workplace ID

tradeUnionIdinteger

[PT]ID do sindicato [EN]Trade Union ID

externalTradeUnionIdstring

[PT]ID externo do sindicato [EN]External trade union ID

scheduleIdinteger

[PT]ID da escala [EN]Schedule ID

nameSchedulestring

[PT]Nome da escala [EN]Schedule name

scheduleDailyWorkloadinteger

[PT]Carga horária diária em minutos [EN]Daily workload in minutes

scheduleMonthlyWorkloadinteger

[PT]Carga horária mensal em minutos [EN]Monthly workload in minutes

nameCareerstring

[PT]Nome do cargo [EN]Career Name

rotationIdinteger

[PT]ID da turma [EN]Rotation ID

ignoreValidationboolean

[PT]Ignorar validação [EN]Ignore validation

ignoreTimeTrackingboolean

[PT]Ignorar Apuração [EN]Ignore Time Tracking

compensateComptimeBankboolean

[PT]Compensar Banco de Horas [EN]Compensate Time Bank

allowDevicePasswordboolean

[PT]Permitir senha no dispositivo [EN]Allow device password

allowMobileClockingboolean

[PT]Permitir acesso mobile [EN]Allow mobile clocking

externalCompanyIdstring

[PT]ID externo da empresa [EN]External company ID

externalScheduleIdstring

[PT]ID externo da escala [EN]External schedule ID

externalBusinessUnitIdstring

[PT]ID externo da unidade de negócios [EN]External business unit ID

externalCareerIdstring required

[PT]ID externo do cargo [EN]External career ID

rotationCodeinteger

[PT]Código da turma [EN]Rotation code

mothersNamestring

[PT]Nome da mãe [EN]Mother's name

fathersNamestring

[PT]Nome da mãe [EN]Father's name

registerNumberstring

[PT]Registro Geral [EN]Register Number

initialsRegisterNumberstring

[PT]Estado emissor. Tamanho máximo 2 (dois) caracteres [EN]Issuing federative unit. Maximum length 2 (two) characters

maritalStatusIdinteger

[PT]ID do estado civil [EN]Marital status ID

maritalStatusExternalIdstring

[PT]ID externo do estado civil [EN]External marital status ID

maritalStatusNamestring

[PT]Nome do estado civil [EN]Marital status name

publicAreastring

[PT]Tipo de Logradouro [EN]Public Area

federatedUnitInitialsstring

[PT]UF do Estado [EN]Federated Unit Initials

shiftIdinteger

[PT]ID do horário [EN]Shift ID

externalShiftIdstring

[PT]ID externo do horário [EN]External shift ID

markingsinteger[]

[PT]Horários [EN]Markings

referenceDatestring

[PT]Data de referência [EN]Reference Date

userAccountIdinteger

[PT]ID do Usuário [EN]User Account ID

ignoreTimeTrackingDatestring

[PT]Data de corte [EN]Cutoff Date

generateNightBonusByExpectedWorkloadboolean

[PT]Gerar adicional noturno por jornada prevista [EN]Generate Night Bonus By Expected Workload

allowComptimeMobileboolean
allowMobileMonthComptimeboolean

Example request

{
  "gender": "'M', 'F'",
  "birthDate": "ddMMyyyyHHmmss",
  "admissionDate": "ddMMyyyyHHmmss",
  "demissionDate": "ddMMyyyyHHmmss",
  "issueDateRegisterNumber": "ddMMyyyyHHmmss",
  "initialsRegisterNumber": "RJ",
  "maritalStatusExternalId": "002",
  "maritalStatusName": "Solteiro",
  "publicArea": "Rua, avenida, Travessa",
  "federatedUnitInitials": "SC, SP",
  "markings": [
    480,
    720,
    760,
    880
  ],
  "referenceDate": "YYYY-MM-DD",
  "ignoreTimeTrackingDate": "ddMMyyyyHHmmss"
}

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

{
  "value": {
    "gender": "'M', 'F'",
    "birthDate": "ddMMyyyyHHmmss",
    "admissionDate": "ddMMyyyyHHmmss",
    "demissionDate": "ddMMyyyyHHmmss",
    "issueDateRegisterNumber": "ddMMyyyyHHmmss",
    "initialsRegisterNumber": "RJ",
    "maritalStatusExternalId": "002",
    "maritalStatusName": "Solteiro",
    "publicArea": "Rua, avenida, Travessa",
    "federatedUnitInitials": "SC, SP",
    "markings": [
      480,
      720,
      760,
      880
    ],
    "referenceDate": "YYYY-MM-DD",
    "ignoreTimeTrackingDate": "ddMMyyyyHHmmss"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.