UKG Pro HCM (versão prévia)
UKG Pro HCM Connector for Pro HR, Payroll and Talent.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | KGS |
| URL | https://www.ukg.com/support |
| support@ukg.com |
| Metadados do conector | |
|---|---|
| Publicador | Dilip Chenani |
| Site | https://www.ukg.com/ |
| Política de privacidade | https://www.ukg.com/privacy |
| Categorias | Recursos Humanos |
O UkG Pro HCM Connector simplifica a transferência de dados usando a API do UKG Pro e permite que você aproveite seus dados do UKG Pro para resolver as necessidades de integração e aplicativos de negócios.
Pré-requisitos
- Usuários existentes do UKG Pro com conta de serviço Web e permissões de recurso válidas com valores apropriados de Nome de Usuário e Chave de API de Usuário. O Conector do UKG Pro HCM usa a Autenticação Básica e requer uma chave de API de usuário e nome de usuário exclusiva.
- URL de serviço base do UKG Pro, que será semelhante a "https://servicet.ultipro.com/services/", mas variará de acordo com o datacenter do cliente e os ambientes de produção/teste.
Como obter credenciais
O Conector do UKG Pro HCM, usando a Autenticação Básica, só pode ser acessado com uma conta de serviço Web. Para obter informações sobre como estabelecer e manter uma Conta de Serviço do UKG Pro, clique aqui.
Introdução ao conector
- Obter um registro de detalhes de uma única pessoa
- Obter um registro de detalhes de uma única pessoa para uma única empresa
- Obter a declaração de pagamento do funcionário
- Obter a última declaração de pagamento do funcionário
- Obter detalhes de emprego do funcionário
- Obter detalhes demográficos dos funcionários
- Obter detalhes para uma execução geral do razão
- Enviar transação XML para a Ferramenta de Importação
- Pesquisa de ID do Funcionário
- Obter planos de pto de funcionários específicos
- Obter detalhes do supervisor do funcionário
- Obter todos os detalhes de uma pessoa atribuída a um funcionário como um contato
Problemas e limitações conhecidos
None
Erros e soluções comuns
Entre em contato conosco por meio de https://www.ukg.com/support
perguntas frequentes
Entre em contato conosco em https://www.ukg.com/support caso de erros e perguntas.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome do usuário | secureString | O nome de usuário para esta api | Verdade |
| Chave de API do Usuário | secureString | A chave de API de Usuário para esta api | Verdade |
| URL do serviço base do UKG Pro | cadeia | A URL de serviço base será semelhante a servicet.ultipro.com, mas variará de acordo com o datacenter do cliente e os ambientes de produção/teste | Verdade |
| Us-Customer-Api-Key | cadeia | Insira oApi-Key US-Customer | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Enviar transação XML para a Ferramenta de Importação |
Envia uma transação XML codificada para a Ferramenta de Importação. |
| Obter a declaração de pagamento do funcionário |
Obtenha a declaração de pagamento do funcionário com base no identificador de funcionário aprovado. |
| Obter a última declaração de pagamento do funcionário |
Obtenha a última declaração de pagamento do funcionário com base no identificador de funcionário passado. |
| Obter detalhes de emprego do funcionário |
Obtenha detalhes sobre o emprego do funcionário. |
| Obter detalhes demográficos dos funcionários |
Obtenha detalhes demográficos dos funcionários. |
| Obter detalhes do supervisor do funcionário |
Obtenha detalhes do supervisor do funcionário. |
| Obter detalhes para uma execução geral do razão |
Retorna uma lista de detalhes para uma execução geral do razão. |
| Obter planos de pto de funcionários específicos |
Obter planos de pto de funcionários específicos |
| Obter todos os detalhes de uma pessoa atribuída a um funcionário como um contato |
Obtenha todos os detalhes de uma pessoa atribuída a um funcionário como um contato. |
| Obter um registro de detalhes de uma única pessoa |
Obtenha um registro de detalhes de uma única pessoa. |
| Obter um registro de detalhes de uma única pessoa para uma única empresa |
Obtenha um registro de detalhes de uma única pessoa para uma única empresa. |
| Pesquisa de ID do Funcionário |
Pesquisa de ID do funcionário. |
Enviar transação XML para a Ferramenta de Importação
Envia uma transação XML codificada para a Ferramenta de Importação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
transação
|
transaction | True | string |
Insira a transação XML codificada. |
|
uniqueFileName
|
uniqueFileName | string |
Insira o nome de arquivo exclusivo que termina com a extensão xml. |
Retornos
Obter a declaração de pagamento do funcionário
Obtenha a declaração de pagamento do funcionário com base no identificador de funcionário aprovado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
companyCode
|
companyCode | string |
Insira o código da empresa. |
|
|
númeroDoFuncionário
|
employeeNumber | string |
Insira o número do funcionário. |
|
|
eeid
|
eeid | string |
Insira sua ID do Funcionário. |
|
|
coid
|
coid | string |
Insira sua ID da Empresa. |
|
|
startDate
|
startDate | string |
Insira a Data de Início. |
|
|
data de término
|
endDate | string |
Insira a Data de Término. |
|
|
página
|
page | integer |
Insira o número da página. |
|
|
per_Page
|
per_Page | integer |
Insira o valor por página. |
|
|
pagesCount
|
pagesCount | integer |
Insira a contagem de páginas. |
Retornos
- response
- array of getEmployeePayStatement
Obter a última declaração de pagamento do funcionário
Obtenha a última declaração de pagamento do funcionário com base no identificador de funcionário passado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
eeid
|
eeid | True | string |
Insira sua ID do Funcionário. |
|
coid
|
coid | True | string |
Insira sua ID da Empresa. |
|
startDate
|
startDate | string |
Insira a Data de Início. |
|
|
data de término
|
endDate | string |
Insira a Data de Término. |
|
|
página
|
page | integer |
Insira o número da página. |
|
|
per_Page
|
per_Page | integer |
Insira o valor por página. |
|
|
pagesCount
|
pagesCount | integer |
Insira a contagem de páginas. |
Retornos
- Corpo
- getEmployeePayStatement
Obter detalhes de emprego do funcionário
Obtenha detalhes sobre o emprego do funcionário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
companyID
|
companyID | string |
Número de identificação da empresa |
|
|
employeeID
|
employeeID | string |
Número de identificação do funcionário |
|
|
primaryJobCode
|
primaryJobCode | string |
Código que representa o trabalho primário do funcionário |
|
|
título do cargo
|
jobTitle | string |
Título do trabalho do funcionário |
|
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica se o funcionário está em tempo integral ou meio período |
|
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código que representa o local de trabalho principal do funcionário |
|
|
primaryProjectCode
|
primaryProjectCode | string |
Código que representa o grupo de projetos primário do funcionário |
|
|
deductionGroupCode
|
deductionGroupCode | string |
Código que representa o grupo de dedução para o funcionário |
|
|
earningGroupCode
|
earningGroupCode | string |
Código que representa o grupo de ganhos para o funcionário |
|
|
employeeTypeCode
|
employeeTypeCode | string |
Código que representa o tipo de funcionário |
|
|
employeeStatusCode
|
employeeStatusCode | string |
Código que representa o status do funcionário |
|
|
númeroDoFuncionário
|
employeeNumber | string |
Número atribuído ao funcionário |
|
|
supervisorId
|
supervisorId | string |
Identificador exclusivo para o supervisor do funcionário |
|
|
originalHireDate
|
originalHireDate | string |
Data em que o funcionário foi originalmente contratado |
|
|
lastHireDate
|
lastHireDate | string |
Data da última contratação do funcionário |
|
|
dateOfTermination
|
dateOfTermination | string |
Data da rescisão do funcionário |
|
|
dateOfRetirement
|
dateOfRetirement | string |
Data da desativação do funcionário |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Carimbo de data/hora que indica quando o registro foi criado |
|
|
dateTimeChanged
|
dateTimeChanged | string |
Carimbo de data/hora indicando quando o registro foi atualizado pela última vez |
|
|
dateLastPayDatePaid
|
dateLastPayDatePaid | string |
Data da última data de pagamento do funcionário |
|
|
payGroup
|
payGroup | string |
Grupo associado ao salário do funcionário. |
|
|
isHomeCompany
|
isHomeCompany | boolean |
Indicador se a empresa é a empresa de origem do funcionário |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
per_Page
|
per_Page | integer |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter detalhes demográficos dos funcionários
Obtenha detalhes demográficos dos funcionários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
identificação do funcionário
|
employeeId | string |
Identificador de funcionário |
|
|
companyId
|
companyId | string |
Identificador da empresa |
|
|
sobrenome
|
lastName | string |
Sobrenome do funcionário |
|
|
endereço de email
|
emailAddress | string |
Endereço de email do funcionário |
|
|
addressState
|
addressState | string |
Estado de residência do funcionário |
|
|
addressCountry
|
addressCountry | string |
País de residência do funcionário |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
per_Page
|
per_Page | integer |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter detalhes do supervisor do funcionário
Obtenha detalhes do supervisor do funcionário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da empresa
|
companyId | string |
Identificador da empresa |
|
|
ID do funcionário
|
employeeId | string |
Identificador para a empresa do funcionário |
|
|
supervisorCompanyId
|
supervisorCompanyId | string |
Cadeia de caracteres que representa o identificador da empresa do supervisor |
|
|
supervisorEmployeeId
|
supervisorEmployeeId | string |
Cadeia de caracteres que representa o identificador de funcionário do supervisor |
|
|
supervisorCompanyCode
|
supervisorCompanyCode | string |
Cadeia de caracteres que representa o código da empresa do supervisor |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
per_Page
|
per_Page | integer |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter detalhes para uma execução geral do razão
Retorna uma lista de detalhes para uma execução geral do razão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
runId
|
runId | string |
Identificador para a execução geral do razão |
|
|
blockId
|
blockId | string |
Identificador do bloco específico dentro da execução geral do razão |
|
|
per_Page
|
per_Page | integer |
Filtrar para recuperar os dados mais recentes |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
mostRecent
|
mostRecent | string |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter planos de pto de funcionários específicos
Obter planos de pto de funcionários específicos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Funcionário
|
employeeID | True | string |
Número de identificação do funcionário. |
|
ID da Empresa
|
companyID | True | string |
Número de identificação da empresa. |
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
per_page
|
per_page | integer |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter todos os detalhes de uma pessoa atribuída a um funcionário como um contato
Obtenha todos os detalhes de uma pessoa atribuída a um funcionário como um contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
identificação do funcionário
|
employeeId | string |
Identificador de funcionário |
|
|
isActive
|
isActive | string |
Indicador de Status Ativo |
|
|
relationshipCode
|
relationshipCode | string |
Código de tipo de relação de funcionário para o contato |
|
|
contactId
|
contactId | string |
Identificador de Contato |
|
|
código do país
|
countryCode | string |
Código do país |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booliano que indica se a cobertura COBRA está ativa no momento. |
|
|
cobraStatus
|
cobraStatus | string |
Essa é uma cadeia de caracteres que indica o status da cobertura COBRA |
|
|
isBeneficiary
|
isBeneficiary | string |
Indicador de Beneficiário |
|
|
isDependent
|
isDependent | string |
Indicador Dependente |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Usado para localizar a data do evento COBRA menor, maior, igual ou entre as datas passadas. |
|
|
statusAsOfDate
|
statusAsOfDate | string |
Usado para localizar o status do contato a partir de datas menores, maiores, iguais ou entre datas passadas. |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
per_Page
|
per_Page | integer |
Paginação, quantos registros por página você deseja ver |
Retornos
Obter um registro de detalhes de uma única pessoa
Obtenha um registro de detalhes de uma única pessoa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Funcionário
|
employeeID | True | string |
Número de identificação do funcionário. |
Retornos
Obter um registro de detalhes de uma única pessoa para uma única empresa
Obtenha um registro de detalhes de uma única pessoa para uma única empresa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Funcionário
|
employeeID | True | string |
Número de identificação do funcionário. |
|
ID da Empresa
|
companyID | True | string |
Número de identificação da empresa. |
|
sobrenome
|
lastName | string |
Sobrenome do funcionário |
|
|
endereço de email
|
emailAddress | string |
Endereço de email do funcionário |
|
|
addressState
|
addressState | string |
Estado de residência do funcionário |
|
|
addressCountry
|
addressCountry | string |
País de residência do funcionário |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booliano que indica se a cobertura COBRA está ativa no momento. |
|
|
cobraStatus
|
cobraStatus | string |
Essa é uma cadeia de caracteres que indica o status da cobertura COBRA. |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Usado para localizar a data do evento COBRA menor, maior, igual ou entre as datas passadas. |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Usado para localizar o registro de pessoa criado menos, maior, igual ou entre datas passadas. |
|
|
dateTimeChanged
|
dateTimeChanged | string |
Usado para localizar o registro de pessoa alterado menos, maior, igual ou entre datas passadas. |
|
|
nationalId
|
nationalId | string |
Número de identificação nacional |
|
|
nationalIdCountry
|
nationalIdCountry | string |
Número de identificação do país |
|
|
página
|
page | integer |
Número da página para paginação |
|
|
per_Page
|
per_Page | integer |
Número de itens por página |
Retornos
Pesquisa de ID do Funcionário
Pesquisa de ID do funcionário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
employeeIdentifierType
|
employeeIdentifierType | True | string |
Insira o tipo de identificador de funcionário. |
|
employeeIdentifierValue
|
employeeIdentifierValue | True | string |
Insira o valor do identificador de funcionário |
|
companyIdentifierType
|
companyIdentifierType | string |
Insira o tipo de identificador da empresa. |
|
|
companyIdentiferValue
|
companyIdentifierValue | string |
Insira o valor do identificador da empresa |
Retornos
- Corpo
- employeeIdLookup
Definições
getASinglePersonDetailRecord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
additionalName1
|
additionalName1 | string |
Campo de nome adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nome adicional 2 |
|
addressId
|
addressId | string |
Identificador do endereço |
|
addressIsOnTaxBoundary
|
addressIsOnTaxBoundary | boolean |
Indica se o endereço está em um limite fiscal |
|
addressLatitude
|
addressLatitude | float |
Coordenada de latitude do endereço |
|
cobraExport
|
cobraExport | string |
Informações de exportação do COBRA |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica se o COBRA está ativo para o funcionário |
|
cobraReason
|
cobraReason | string |
Motivo do status do COBRA |
|
cobraStatus
|
cobraStatus | string |
Informações de status do COBRA |
|
cobraStatusDate
|
cobraStatusDate | string |
Data da atualização de status do COBRA |
|
communityBroadcastSmsCode
|
communityBroadcastSmsCode | string |
Código SMS de transmissão da comunidade |
|
consentElectronicW2
|
consentElectronicW2 | boolean |
Indica consentimento para formulários W2 eletrônicos |
|
consentElectronicw2pr
|
consentElectronicw2pr | boolean |
Indica consentimento para formulários W2 eletrônicos (específicos de PR) |
|
dateDeceased
|
dateDeceased | string |
Data do falecido |
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Data do evento COBRA |
|
dateOfCobraExport
|
dateOfCobraExport | string |
Data da exportação do COBRA |
|
dateOfCobraLetter
|
dateOfCobraLetter | string |
Data da letra COBRA |
|
dateOfI9Expiration
|
dateOfI9Expiration | string |
Data de expiração do formulário I-9 |
|
datetimeChanged
|
datetimeChanged | string |
Carimbo de data/hora indicando quando os dados foram atualizados pela última vez |
|
datetimeCreated
|
datetimeCreated | string |
Carimbo de data/hora que indica quando os dados foram criados |
|
disabilityType
|
disabilityType | string |
Tipo de deficiência |
|
ethnicDescription
|
ethnicDescription | string |
Descrição da etnia |
|
formerName
|
formerName | string |
Nome antigo |
|
healthBloodType
|
healthBloodType | string |
Informações sobre tipo sanguíneo |
|
healthEyes
|
healthEyes | string |
Informações sobre cor dos olhos |
|
healthHair
|
healthHair | string |
Informações sobre cor do cabelo |
|
healthHeightFeet
|
healthHeightFeet | string |
Altura nos pés |
|
healthHeightInches
|
healthHeightInches | string |
Altura em polegadas |
|
healthLastDonateDate
|
healthLastDonateDate | string |
Data da última doação de sangue |
|
healthWeight
|
healthWeight | double |
Peso em libras |
|
i9AlienNumber
|
i9AlienNumber | string |
Número alienígena para o formulário I-9 |
|
i9DocA
|
i9DocA | string |
Documento A para formulário I-9 |
|
i9DocB
|
i9DocB | string |
Documento B para formulário I-9 |
|
i9DocC
|
i9DocC | string |
Documento C para I-9 formg |
|
i9Verified
|
i9Verified | boolean |
Indica se o formulário I-9 é verificado |
|
i9VisaType
|
i9VisaType | string |
Tipo de visto para formulário I-9 |
|
i9WorkAuth
|
i9WorkAuth | string |
Autorização de trabalho para o formulário I-9 |
|
está desabilitado
|
isDisabled | boolean |
Indica se a pessoa está desabilitada |
|
isMultiPayGroup
|
isMultiPayGroup | boolean |
Indica se a pessoa faz parte de vários grupos de pagamento |
|
isSmoker
|
isSmoker | boolean |
Indica se a pessoa é fumante |
|
serviço militar
|
militaryService | boolean |
Indica o status do serviço militar |
|
militarBranchServed
|
militaryBranchServed | string |
Ramo do serviço militar servido |
|
militaryEra
|
militaryEra | string |
Informações da era militar |
|
militaryIsDisabledVet
|
militaryIsDisabledVet | string |
Indica se a pessoa é um veterano desabilitado |
|
militaryIsOthEligVet
|
militaryIsOthEligVet | string |
Indica se a pessoa é outra veterana qualificada |
|
militaryIsOthEligVetBasis
|
militaryIsOthEligVetBasis | string |
Base para outro status de veterano qualificado |
|
militaryIsActiveWartimeVet
|
militaryIsActiveWartimeVet | string |
Indica se a pessoa é uma veterana em tempo de guerra ativa |
|
nameFormer
|
nameFormer | string |
Nome antigo |
|
previousSSN
|
previousSSN | string |
Número anterior da Previdência Social |
|
originCountry
|
originCountry | string |
País de origem |
|
originLocation
|
originLocation | string |
Local de origem |
|
w2IsDeceased
|
w2IsDeceased | boolean |
Indica se a pessoa está morta para formulários W2 |
|
cobraNotes
|
cobraNotes | string |
Anotações relacionadas ao COBRA |
|
addressSms
|
addressSms | string |
Endereço para notificações por SMS |
|
militarySeparationDate
|
militarySeparationDate | string |
Data da separação militar |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
Indica se o número de telefone residencial é privado |
|
smsApprovals
|
smsApprovals | boolean |
Indica se as aprovações de SMS estão habilitadas |
|
smsPayNotification
|
smsPayNotification | boolean |
Indica se as notificações por SMS para pagamento estão habilitadas |
|
i9VisaExpirationDate
|
i9VisaExpirationDate | string |
Data de validade do visto I-9 |
|
militaryIsMedalVet
|
militaryIsMedalVet | string |
Indica se a pessoa é uma veterana de medalha |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
Indica se o sobrenome é diferente do Cartão de Segurança Social |
|
chkCashingInstCode
|
chkCashingInstCode | string |
Verificar o código da instituição de caixa |
|
nationality1
|
nationality1 | string |
Informações de nacionalidade 1 |
|
nationality2
|
nationality2 | string |
Informações de nacionalidade 2 |
|
nacionalidade3
|
nationality3 | string |
Informações de nacionalidade 3 |
|
personId
|
personId | string |
Identificador para a pessoa |
|
identificação do funcionário
|
employeeId | string |
Identificador para o funcionário |
|
companyId
|
companyId | string |
Identificador para a empresa |
|
userName
|
userName | string |
Nome de usuário |
|
primeiro nome
|
firstName | string |
Nome |
|
nome do meio
|
middleName | string |
Nome do meio |
|
sobrenome
|
lastName | string |
Sobrenome |
|
preferredName
|
preferredName | string |
Nome preferencial |
|
namePrefixCode
|
namePrefixCode | string |
Código de prefixo para nome |
|
nameSufixCode
|
nameSufixCode | string |
Código de sufixo para nome |
|
endereço de email
|
emailAddress | string |
Endereço de email |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Endereço de email alternativo |
|
homePhone
|
homePhone | string |
Número de telefone residencial |
|
homePhoneCountry
|
homePhoneCountry | string |
Código do país para o número de telefone residencial |
|
endereçoLinha1
|
addressLine1 | string |
Linha de endereço 1 |
|
endereçoLinha2
|
addressLine2 | string |
Linha de endereço 2 |
|
addressCity
|
addressCity | string |
City |
|
addressState
|
addressState | string |
Estado |
|
addressZipCode
|
addressZipCode | string |
Código Postal |
|
addressCountry
|
addressCountry | string |
País |
|
addressCounty
|
addressCounty | string |
País |
|
nationalId
|
nationalId | string |
ID nacional |
|
nationalIdCountry
|
nationalIdCountry | string |
País para ID nacional |
|
dateOfBirth
|
dateOfBirth | string |
Data de nascimento |
|
gender
|
gender | string |
Gênero |
|
ethnicIDCode
|
ethnicIDCode | string |
Código de ID étnica |
|
maritalStatusCode
|
maritalStatusCode | string |
Código de estado civil |
|
Ssn
|
ssn | string |
Número da Previdência Social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica se o Número da Previdência Social é suprimido |
getEmployeePayStatement
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Acréscimos
|
accruals | array of object |
Lista de detalhes de acréscimo |
|
amountcurrent
|
accruals.amountcurrent | double |
Valor atual acumulado |
|
amounttype
|
accruals.amounttype | string |
Tipo de valor acumulado |
|
saldo
|
accruals.balance | double |
Saldo atual do acréscimo |
|
plancode
|
accruals.plancode | string |
Código que identifica o plano |
|
plandescription
|
accruals.plandescription | string |
Descrição do plano |
|
addressline1
|
addressline1 | string |
Linha de endereço 1 |
|
addressline2
|
addressline2 | string |
Linha de endereço 2 |
|
city
|
city | string |
Cidade do endereço |
|
companyaddresscity
|
companyaddresscity | string |
Endereço da cidade da empresa |
|
companyaddresscountry
|
companyaddresscountry | string |
Endereço do país da empresa |
|
companyaddresscounty
|
companyaddresscounty | string |
Endereço do condado da empresa |
|
companyaddressline1
|
companyaddressline1 | string |
Linha de endereço 1 da empresa |
|
companyaddressline2
|
companyaddressline2 | string |
Linha de endereço 2 da empresa |
|
companyaddresspostalcode
|
companyaddresspostalcode | string |
Código postal do endereço da empresa |
|
companyaddressstateorprovince
|
companyaddressstateorprovince | string |
Estado ou província do endereço da empresa |
|
nome da empresa
|
companyname | string |
Nome da empresa |
|
companyphone
|
companyphone | string |
Número de telefone principal da empresa |
|
companyphoneext
|
companyphoneext | string |
Extensão para o telefone da empresa |
|
country
|
country | string |
País do endereço |
|
Deduções
|
deductions | array of object | |
|
baseamount
|
deductions.basisamount | double |
Valor base para deduções |
|
deduções
|
deductions.deductioncode | string |
Código que identifica a dedução |
|
deduçãodescription
|
deductions.deductiondescription | string |
Descrição da dedução |
|
employeeamount
|
deductions.employeeamount | double |
Valor de dedução do funcionário |
|
employeeamountytd
|
deductions.employeeamountytd | double |
Valor de dedução do funcionário para o ano |
|
employeramount
|
deductions.employeramount | double |
Valor da dedução contribuiu para o empregador |
|
employeramountytd
|
deductions.employeramountytd | double |
Valor da dedução do empregador para o ano |
|
pretax
|
deductions.pretax | boolean |
Indica se a dedução é pré-imposto |
|
deduçõescurrent
|
deductionscurrent | double |
Total de deduções atuais |
|
deduçõesytd
|
deductionsytd | double |
Total de deduções para o ano |
|
documento
|
document | string |
Identificador ou descrição do documento |
|
renda
|
earnings | array of object |
Lista de registros de ganhos |
|
quantidade
|
earnings.amount | double |
Valor do lucro |
|
amountytd
|
earnings.amountytd | double |
Valor do lucro do ano |
|
horas
|
earnings.hours | double |
Horas trabalhadas |
|
hoursytd
|
earnings.hoursytd | double |
Horas trabalhadas para o ano |
|
paycode
|
earnings.paycode | string |
Código que identifica o tipo de pagamento |
|
paydescription
|
earnings.paydescription | string |
Descrição do tipo de pagamento |
|
taxa de pagamento
|
earnings.payrate | double |
Taxa de pagamento |
|
periodend
|
earnings.periodend | date-time |
Data de término do período de pagamento |
|
início do período
|
earnings.periodstart | date-time |
Data de início do período de pagamento |
|
contagem de peças
|
earnings.piececount | double |
Contagem de peças concluídas (para trabalho em partes) |
|
taxa de pagamento de peças
|
earnings.piecepayrate | double |
Taxa de pagamento por peça (para trabalho em pedaços) |
|
tipo de identificação
|
employeeidentifier.identificationtype | string |
cadeia |
|
companyidentifier
|
employeeidentifier.companyidentifier | string |
cadeia |
|
employeeidentifier
|
employeeidentifier.employeeidentifier | string |
cadeia |
|
número de funcionários
|
employeenumber | string |
Número que identifica o funcionário |
|
federaladditionalamountWithheld
|
federaladditionalamountWithheld | double |
Imposto federal adicional retido |
|
federalallowancesclaimed
|
federalallowancesclaimed | double |
Subsídios fiscais federais reivindicados |
|
federalfilingstatus
|
federalfilingstatus | string |
Status do arquivamento de impostos federais |
|
federaltaxablewagescurrent
|
federaltaxablewagescurrent | double |
Salários tributáveis federais atuais |
|
federaltaxablewagesytd
|
federaltaxablewagesytd | double |
Salários tributáveis federais para o ano |
|
fullname
|
fullname | string |
Nome completo do funcionário |
|
grosswagescurrent
|
grosswagescurrent | double |
Salários brutos atuais |
|
grosswagesytd
|
grosswagesytd | double |
Salários brutos para o ano |
|
cargo
|
job | string |
Cargo ou descrição |
|
local
|
location | string |
Local de trabalho do funcionário |
|
netpay
|
netpay | array of object |
Lista de registros de pagamento líquidos |
|
accountnumber
|
netpay.accountnumber | string |
Número da conta bancária |
|
accounttype
|
netpay.accounttype | string |
Tipo de conta bancária |
|
quantidade
|
netpay.amount | double |
Valor do pagamento líquido |
|
netpaycurrent
|
netpaycurrent | double |
Pagamento líquido atual |
|
netpayytd
|
netpayytd | double |
Pagamento líquido do ano |
|
orglevel1
|
orglevel1 | string |
Primeiro nível da hierarquia organizacional |
|
orglevel2
|
orglevel2 | string |
Segundo nível da hierarquia organizacional |
|
orglevel3
|
orglevel3 | string |
Terceiro nível da hierarquia organizacional |
|
orglevel4
|
orglevel4 | string |
Quarto nível da hierarquia organizacional |
|
paydate
|
paydate | string |
Data em que o pagamento foi emitido |
|
payperiodfrequency
|
payperiodfrequency | string |
Frequência do período de pagamento |
|
paygroup
|
paygroup | string |
Classificação de grupo para folha de pagamento |
|
payidentifier
|
payidentifier | string |
Identificador para a instância de pagamento |
|
taxa de pagamento
|
payrate | double |
Taxa de pagamento |
|
periodenddate
|
periodenddate | string |
Data de término do período de pagamento |
|
periodstartdate
|
periodstartdate | string |
Data de início do período de pagamento |
|
código postal
|
postalcode | string |
Código postal para o endereço do funcionário |
|
residentstateallowancesclaimed
|
residentstateallowancesclaimed | double |
Subsídios fiscais estaduais reivindicados pelo residente |
|
residentstatefilingstatus
|
residentstatefilingstatus | string |
Status do arquivo de estado para o residente |
|
Ssn
|
ssn | string |
Número da Previdência Social |
|
stateorprovince
|
stateorprovince | string |
Estado ou província do funcionário |
|
impostos
|
taxes | array of object |
Lista de registros fiscais |
|
quantidade
|
taxes.amount | double |
Valor do imposto |
|
amountytd
|
taxes.amountytd | double |
Valor do imposto para o ano |
|
baseamount
|
taxes.basisamount | double |
Valor base para cálculo de impostos |
|
taxdescription
|
taxes.taxdescription | string |
Descrição do imposto |
|
taxcode
|
taxes.taxcode | string |
Código que identifica o imposto |
|
taxescurrent
|
taxescurrent | double |
Total de impostos atuais |
|
taxesytd
|
taxesytd | double |
Total de impostos para o ano |
|
workstateallowancesclaimed
|
workstateallowancesclaimed | double |
Subsídios fiscais estaduais reivindicados pelo funcionário |
|
workstatefilingstatus
|
workstatefilingstatus | string |
Status de registro de imposto estadual do funcionário |
getEmployeeEmploymentDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
companyID
|
companyID | string |
Identificador para a empresa |
|
employeeID
|
employeeID | string |
Identificador para o funcionário |
|
primaryJobCode
|
primaryJobCode | string |
Código que identifica o trabalho primário |
|
título do cargo
|
jobTitle | string |
Título do trabalho do funcionário |
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica se o trabalho é em tempo integral ou meio período |
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código para o local de trabalho primário |
|
primaryProjectCode
|
primaryProjectCode | string |
Código para o projeto primário associado ao funcionário |
|
deductionGroupCode
|
deductionGroupCode | string |
Código que identifica o grupo de dedução |
|
earningGroupCode
|
earningGroupCode | string |
Código que identifica o grupo de ganhos |
|
employeeTypeCode
|
employeeTypeCode | string |
Código que define o tipo de emprego |
|
employeeStatusCode
|
employeeStatusCode | string |
Código que representa o status atual do funcionário |
|
númeroDoFuncionário
|
employeeNumber | string |
Número exclusivo atribuído ao funcionário |
|
supervisorId
|
supervisorId | string |
Identificador do supervisor do funcionário |
|
originalHireDate
|
originalHireDate | string |
Data em que o funcionário foi originalmente contratado |
|
lastHireDate
|
lastHireDate | string |
Data em que o funcionário foi contratado mais recentemente |
|
dateOfTermination
|
dateOfTermination | string |
Data em que o funcionário foi encerrado |
|
dateOfRetirement
|
dateOfRetirement | string |
Data em que o funcionário se aposentou |
|
dateTimeCreated
|
dateTimeCreated | string |
Carimbo de data/hora quando o registro do funcionário foi criado |
|
dateTimeChanged
|
dateTimeChanged | string |
Carimbo de data/hora quando o registro do funcionário foi modificado pela última vez |
|
dateLastPayDatePaid
|
dateLastPayDatePaid | string |
Data em que o último pagamento foi feito ao funcionário |
|
payGroup
|
payGroup | string |
Classificação de grupo para folha de pagamento |
|
isHomeCompany
|
isHomeCompany | boolean |
Indica se a empresa é a empresa de origem do funcionário |
|
página
|
page | integer |
Número da página em uma resposta paginada |
|
per_Page
|
per_Page | integer |
Número de itens por página em uma resposta paginada |
getEmployeeDemographicDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ethnicDescription
|
ethnicDescription | string |
Origem étnica |
|
additionalName1
|
additionalName1 | string |
Campo de nome adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nome adicional 2 |
|
addressId
|
addressId | string |
Identificador do endereço |
|
addressIsOnTaxBoundary
|
addressIsOnTaxBoundary | string |
Endereço sobre o status do limite fiscal |
|
addressLatitude
|
addressLatitude | double |
Latitude geográfica do endereço |
|
disabilityType
|
disabilityType | string |
Tipo de deficiência |
|
formerName
|
formerName | string |
Nome anterior |
|
healthBloodType
|
healthBloodType | string |
Informações sobre tipo sanguíneo |
|
healthEyes
|
healthEyes | string |
Informações sobre cor dos olhos |
|
healthHair
|
healthHair | string |
Informações sobre cor do cabelo |
|
healthHeightFeet
|
healthHeightFeet | string |
Altura nos pés |
|
healthHeightInches
|
healthHeightInches | string |
Altura em polegadas |
|
healthLastDonateDate
|
healthLastDonateDate | string |
Data da última doação de sangue |
|
healthWeight
|
healthWeight | double |
Peso em unidades apropriadas |
|
previousSSN
|
previousSSN | string |
Número anterior da Previdência Social |
|
originCountry
|
originCountry | string |
País de origem |
|
originLocation
|
originLocation | string |
Local de origem |
|
addressSms
|
addressSms | string |
Endereço para notificações por SMS |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
O número de telefone residencial é privado |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
O sobrenome difere do cartão SS |
|
nationality1
|
nationality1 | string |
Primeiras informações de nacionalidade |
|
nationality2
|
nationality2 | string |
Informações de segunda nacionalidade |
|
nacionalidade3
|
nationality3 | string |
Terceiras informações de nacionalidade |
|
personId
|
personId | string |
Identificador para a pessoa |
|
identificação do funcionário
|
employeeId | string |
Identificador para o funcionário |
|
companyId
|
companyId | string |
Identificador para a empresa |
|
primeiro nome
|
firstName | string |
Nome |
|
nome do meio
|
middleName | string |
Nome do meio |
|
sobrenome
|
lastName | string |
Sobrenome |
|
preferredName
|
preferredName | string |
Nome preferencial |
|
namePrefixCode
|
namePrefixCode | string |
Código de prefixo para o nome |
|
nameSuffixCode
|
nameSuffixCode | string |
Código de sufixo para o nome |
|
endereço de email
|
emailAddress | string |
Endereço de email |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Endereço de email alternativo |
|
homePhoneID
|
homePhoneID | string |
Identificador do telefone residencial |
|
homePhone
|
homePhone | string |
Número de telefone residencial |
|
homePhoneCountry
|
homePhoneCountry | string |
Código do país para telefone doméstico |
|
endereçoLinha1
|
addressLine1 | string |
Linha de endereço principal |
|
endereçoLinha2
|
addressLine2 | string |
Linha de endereço secundária |
|
addressLine3
|
addressLine3 | string |
Linha de endereço terciária |
|
addressLine4
|
addressLine4 | string |
Linha de endereço quaternário |
|
addressCity
|
addressCity | string |
Cidade do endereço |
|
addressState
|
addressState | string |
Estado do endereço |
|
addressZipCode
|
addressZipCode | string |
CEP do endereço |
|
addressCountry
|
addressCountry | string |
País do endereço |
|
addressCounty
|
addressCounty | string |
Condado do endereço |
|
dateOfBirth
|
dateOfBirth | string |
Data de nascimento |
|
gender
|
gender | string |
Gênero do indivíduo |
|
ethnicIdCode
|
ethnicIdCode | string |
Código de ID étnica |
|
isSmoker
|
isSmoker | boolean |
Indica se a pessoa é fumante |
|
está desabilitado
|
isDisabled | string |
Status de deficiência |
|
maritalStatusCode
|
maritalStatusCode | string |
Código de estado civil |
|
Ssn
|
ssn | string |
Número da Previdência Social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica se o SSN é suprimido |
|
userID
|
userID | string |
ID do Usuário |
|
integrationRecordId
|
integrationRecordId | string |
Identificador de registro de integração |
|
cellPhoneNumber
|
cellPhoneNumber | string |
Número de telefone celular |
returnsAListOfDetailsForAGeneralLedgerRun
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
runId
|
runId | string |
Identificador exclusivo para a execução |
|
payPeriodEndDate
|
payPeriodEndDate | string |
Data de término do período de pagamento |
|
tipo de conta
|
accountType | string |
Tipo de conta |
|
baseSegment
|
baseSegment | string |
Identificador de segmento base |
|
companyCode
|
companyCode | string |
Código que identifica a empresa |
|
creditAmt
|
creditAmt | double |
Valor do crédito registrado |
|
debitAmt
|
debitAmt | double |
Valor do débito registrado |
|
descrição
|
description | string |
Descrição da transação |
|
generalLedgerAccount
|
generalLedgerAccount | string |
Número geral da conta do razão |
|
jobCode
|
jobCode | string |
Código para o trabalho |
|
jobDesc
|
jobDesc | string |
Descrição do trabalho |
|
local
|
location | string |
Local da transação |
|
orgLevel1
|
orgLevel1 | string |
Primeiro nível da hierarquia organizacional |
|
orgLevel2
|
orgLevel2 | string |
Segundo nível da hierarquia organizacional |
|
orgLevel3
|
orgLevel3 | string |
Terceiro nível da hierarquia organizacional |
|
orgLevel4
|
orgLevel4 | string |
Quarto nível da hierarquia organizacional |
|
payGroup
|
payGroup | string |
Identificador de grupo de folha de pagamento |
|
periodEndDate
|
periodEndDate | string |
Data de término do período contábil |
|
periodStartDate
|
periodStartDate | string |
Data de início do período contábil |
|
positionCode
|
positionCode | string |
Código para a posição |
|
positionDesc
|
positionDesc | string |
Descrição da posição |
|
projeto
|
project | string |
Identificador de projeto |
|
systemId
|
systemId | double |
Número de identificação do sistema |
|
blockId
|
blockId | double |
Identificador de bloco dentro do sistema |
|
coId
|
coId | string |
Identificador da empresa |
|
glRunDateTime
|
glRunDateTime | string |
Data e hora da execução do GL |
|
totalNrOfBlocks
|
totalNrOfBlocks | double |
Número total de blocos na execução |
|
userWhoRanThisGl
|
userWhoRanThisGl | string |
Usuário que executou a execução gl |
|
glJson
|
glJson | string |
Dados JSON da execução geral do razão |
takesAnXmlTransactionAndFeedsItIntoTheImportTool
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
stagingId
|
stagingId | string |
Identificador do registro de preparo |
|
dateTimeCreated
|
dateTimeCreated | string |
Carimbo de data/hora quando o registro foi criado |
|
fileName
|
fileName | string |
Nome do arquivo |
employeeIdLookup
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
Tipo de erro ou status |
|
title
|
title | string |
Título resumindo o erro ou o status |
|
detail
|
detail | string |
Descrição detalhada do erro ou status |
|
errorCount
|
errorCount | double |
Número de erros relatados |
|
multistatus
|
multistatus | array of object | |
|
sequenceId
|
multistatus.sequenceId | double |
Identificador para a sequência em vários pontos |
|
status
|
multistatus.status | string |
Status da operação no multistatus |
|
property-name
|
multistatus.modelstate.property-name | array of object |
Lista de mensagens de erro chaveadas pelo nome da propriedade |
|
mensagem
|
multistatus.modelstate.property-name.message | string |
Mensagem de erro para a propriedade específica |
|
tipo
|
multistatus.modelstate.property-name.type | string |
Tipo de erro para a propriedade específica |
|
eeid
|
multistatus.body.eeid | string |
Identificador de funcionário |
|
coid
|
multistatus.body.coid | array of string |
Lista de identificadores da empresa; home company é o primeiro |
getASpecificEmployeesPtoplans
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
identificação do funcionário
|
employeeId | string |
Identificador exclusivo para o funcionário |
|
companyId
|
companyId | string |
Identificador da empresa associada ao funcionário |
|
ptoPlan
|
ptoPlan | string |
Identificador do plano PTO aplicável ao funcionário |
|
auferido
|
earned | double |
Total de horas de PTO obtidas pelo funcionário |
|
tomado
|
taken | double |
Total de horas de PTO tomadas pelo funcionário |
|
pendingBalance
|
pendingBalance | double |
Saldo atual de horas de PTO pendentes |
|
earnedThroughDate
|
earnedThroughDate | string |
Última data pela qual o PTO foi acumulado |
|
redefinir
|
reset | string |
Data em que o saldo do PTO é redefinido |
|
pendingMoveDate
|
pendingMoveDate | string |
Data relevante para regras de PTO pendentes |
getEmployeeSupervisorDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
employeeID
|
employeeID | string |
Identificador para o funcionário |
|
companyID
|
companyID | string |
Identificador para a empresa do funcionário |
|
númeroDoFuncionário
|
employeeNumber | string |
Número exclusivo atribuído ao funcionário |
|
supervisorEmployeeID
|
supervisorEmployeeID | string |
Identificador para o supervisor |
|
supervisorFirstName
|
supervisorFirstName | string |
Nome do supervisor |
|
supervisorLastName
|
supervisorLastName | string |
Sobrenome do supervisor |
|
supervisorEmployeeNumber
|
supervisorEmployeeNumber | string |
Número do funcionário do supervisor |
|
supervisorCompanyID
|
supervisorCompanyID | string |
Identificador da empresa para o supervisor |
|
supervisorCompanyCode
|
supervisorCompanyCode | string |
Código da empresa associado ao supervisor |
|
supervisorStatusCode
|
supervisorStatusCode | string |
Código de status que representa o status de emprego do supervisor |
|
supervisorJobCode
|
supervisorJobCode | string |
Código de trabalho atribuído ao supervisor |
|
supervisorPositionCode
|
supervisorPositionCode | string |
Código de posição atribuído ao supervisor |
|
supervisorEmail
|
supervisorEmail | string |
Endereço de email do supervisor |
|
supervisorWorkPhone
|
supervisorWorkPhone | string |
Número de telefone de trabalho do supervisor |
|
supervisorPersonId
|
supervisorPersonId | string |
Identificador exclusivo para o supervisor como uma pessoa |
getAllDetailsForAPersonAssignedToAnEmployeeAsAContact
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
city
|
city | string |
Cidade do endereço |
|
código do país
|
countryCode | string |
Código do país do endereço |
|
condado
|
county | string |
Condado do endereço |
|
addressIsDifferentFromEmployee
|
addressIsDifferentFromEmployee | boolean |
Indica se o endereço é diferente do endereço do funcionário |
|
endereçoLinha1
|
addressLine1 | string |
Linha de endereço principal |
|
endereçoLinha2
|
addressLine2 | string |
Linha de endereço secundária |
|
estado
|
state | string |
Estado do endereço |
|
CEP
|
zipCode | string |
CEP do endereço |
|
cobraExport
|
cobraExport | boolean |
Indica se os dados COBRA são exportados |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica se o COBRA está ativo |
|
cobraReason
|
cobraReason | string |
Motivo do status do COBRA |
|
cobraStatus
|
cobraStatus | string |
Status atual do COBRA |
|
cobraStatusDate
|
cobraStatusDate | string |
Data do status atual do COBRA |
|
dateOfBirth
|
dateOfBirth | string |
Data de nascimento |
|
dateOfCOBRAEvent
|
dateOfCOBRAEvent | string |
Data do evento COBRA |
|
dateOfCOBRALetter
|
dateOfCOBRALetter | string |
Data em que a carta COBRA foi emitida |
|
identificação do funcionário
|
employeeId | string |
Identificador para o funcionário |
|
gender
|
gender | string |
Gênero do indivíduo |
|
importId
|
importId | string |
Identificador de importação |
|
isBeneficiary
|
isBeneficiary | boolean |
Indica se o indivíduo é um beneficiário |
|
isDependent
|
isDependent | boolean |
Indica se o indivíduo é dependente |
|
está desabilitado
|
isDisabled | boolean |
Indica se o indivíduo está desabilitado |
|
isEmergencyContact
|
isEmergencyContact | boolean |
Indica se o indivíduo é um contato de emergência |
|
isSmoker
|
isSmoker | boolean |
Indica se o indivíduo é um fumante |
|
isStudent
|
isStudent | boolean |
Indica se o indivíduo é um aluno |
|
marriageDate
|
marriageDate | string |
Data do casamento |
|
primeiro nome
|
firstName | string |
Nome do indivíduo |
|
formerName
|
formerName | string |
Nome antigo do indivíduo |
|
sobrenome
|
lastName | string |
Sobrenome do indivíduo |
|
nome do meio
|
middleName | string |
Nome do meio do indivíduo |
|
nameSuffix
|
nameSuffix | string |
Sufixo do nome do indivíduo |
|
ocupação
|
occupation | string |
Ocupação do indivíduo |
|
otherInsurance
|
otherInsurance | string |
Detalhes de outro seguro |
|
homePhoneCountry
|
homePhoneCountry | string |
Código do país para telefone doméstico |
|
homePhoneNumber
|
homePhoneNumber | string |
Número de telefone residencial |
|
otherPhoneNumber
|
otherPhoneNumber | string |
Outro número de telefone |
|
otherPhoneType
|
otherPhoneType | string |
Tipo de outro telefone |
|
preferredPhoneNumber
|
preferredPhoneNumber | string |
Número de telefone preferencial |
|
relationshipCode
|
relationshipCode | string |
Código que descreve a relação |
|
relationshipDescription
|
relationshipDescription | string |
Descrição da relação |
|
Ssn
|
ssn | string |
Número da Previdência Social |
|
contactId
|
contactId | string |
Identificador do contato |
|
userDefinedField01
|
userDefinedField01 | string |
Campo personalizado para informações adicionais |
|
workPhoneExtension
|
workPhoneExtension | string |
Extensão do número de telefone do trabalho |
|
workPhoneNumber
|
workPhoneNumber | string |
Número de telefone de trabalho |
|
cobraNotes
|
cobraNotes | string |
Anotações relacionadas ao COBRA |
|
notas
|
notes | string |
Notas gerais sobre o indivíduo |
|
isActive
|
isActive | boolean |
Indica se o registro está ativo |
|
statusAsOfDate
|
statusAsOfDate | string |
Data do status atual |
|
deathDate
|
deathDate | string |
Data da morte |
|
divorceDate
|
divorceDate | string |
Data do divórcio |
|
endereço de email
|
emailAddress | string |
Endereço de email |
|
otherPhoneCountryCode
|
otherPhoneCountryCode | string |
Código do país para outro telefone |
|
healthCareId
|
healthCareId | string |
Identificador de cuidados de saúde |
|
nationalId
|
nationalId | string |
Identificador nacional |
|
nationalIdExpirationDate
|
nationalIdExpirationDate | string |
Data de validade da ID nacional |
|
personID
|
personID | string |
Identificador exclusivo para a pessoa |
|
addressID
|
addressID | string |
Identificador para endereço |
|
workPhoneId
|
workPhoneId | string |
Identificador para telefone comercial |
|
homePhoneId
|
homePhoneId | string |
Identificador para telefone residencial |
|
otherPhoneId
|
otherPhoneId | string |
Identificador para outro telefone |