UKG Pro HCM (Pré-visualização)
UKG Pro HCM Connector para RH Pro, Folha de Pagamento e Talento.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | QUILOGRAMAS |
| URL | https://www.ukg.com/support |
| support@ukg.com |
| Metadados do conector | |
|---|---|
| Editora | Dilip Chenani |
| Sítio Web | 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 UKG Pro e permite que você aproveite seus dados UKG Pro para resolver as necessidades de aplicativos de negócios e integração.
Pré-requisitos
- Um usuário UKG Pro existente com conta de serviço Web e permissões de recursos válidas com valores apropriados de Nome de Usuário e Chave de API de Usuário. O UKG Pro HCM Connector usa autenticação básica e requer um nome de usuário exclusivo e uma chave de API de usuário.
- URL do serviço base 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 UKG Pro HCM Connector, usando a Autenticação Básica, só é acessível com uma conta de serviço Web. Para obter informações sobre como estabelecer e manter uma conta de serviço UKG Pro, clique aqui.
Introdução ao conector
- Obter um registo de detalhes de uma única pessoa
- Obter um registro de detalhes de uma única pessoa para uma única empresa
- Obter declaração de pagamento de funcionários
- Obter o último extrato 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 contábil
- Enviar transação XML para a Ferramenta de Importação
- Pesquisa de ID de Funcionário
- Obtenha um pto-planos de funcionários específicos
- Obter detalhes do supervisor de funcionários
- Obter todos os detalhes de uma pessoa atribuída a um funcionário como contato
Problemas conhecidos e limitações
Nenhum
Erros e soluções comuns
Contacte-nos via https://www.ukg.com/support
FAQ
Contacte-nos via https://www.ukg.com/support em caso de erros e dúvidas.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome de Utilizador | securestring | O nome de usuário para esta api | Verdade |
| Chave da API do usuário | securestring | A chave de API do usuário para esta api | Verdade |
| URL do serviço base UKG Pro | cadeia (de caracteres) | A URL do serviço base será semelhante à 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 (de caracteres) | Introduza o seuApi-Key de Cliente dos EUA | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de 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. |
| Obtenha um pto-planos de funcionários específicos |
Obtenha um pto-planos de funcionários específicos |
| Obter declaração de pagamento de funcionários |
Obtenha a declaração de pagamento do funcionário com base no identificador de funcionário passado. |
| Obter detalhes de emprego do funcionário |
Obtenha detalhes de emprego do funcionário. |
| Obter detalhes demográficos dos funcionários |
Obtenha detalhes demográficos dos funcionários. |
| Obter detalhes do supervisor de funcionários |
Obtenha detalhes do supervisor de funcionários. |
| Obter detalhes para uma execução contábil |
Retorna uma lista de detalhes para uma execução contábil. |
| Obter o último extrato de pagamento do funcionário |
Obtenha o último extrato de pagamento do funcionário com base no identificador de funcionário passado. |
| Obter todos os detalhes de uma pessoa atribuída a um funcionário como contato |
Obtenha todos os detalhes de uma pessoa atribuída a um funcionário como contato. |
| Obter um registo 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 de Funcionário |
Pesquisa de ID de 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
transação
|
transaction | True | string |
Insira a transação XML codificada. |
|
uniqueFileName
|
uniqueFileName | string |
Digite Nome de arquivo exclusivo que termina com a extensão xml. |
Devoluções
Obtenha um pto-planos de funcionários específicos
Obtenha um pto-planos de funcionários específicos
Parâmetros
| Name | Chave | Necessá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 |
Devoluções
Obter declaração de pagamento de funcionários
Obtenha a declaração de pagamento do funcionário com base no identificador de funcionário passado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
companyCode
|
companyCode | string |
Introduza o Código da sua Empresa. |
|
|
Número do empregado
|
employeeNumber | string |
Introduza o seu Número de Funcionário. |
|
|
EEID
|
eeid | string |
Introduza o seu ID de funcionário. |
|
|
Cóide
|
coid | string |
Introduza o ID da sua 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. |
|
|
páginasContagem
|
pagesCount | integer |
Insira a contagem de páginas. |
Devoluções
- response
- array of getEmployeePayStatement
Obter detalhes de emprego do funcionário
Obtenha detalhes de emprego do funcionário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da empresa
|
companyID | string |
Número de identificação da empresa |
|
|
ID do empregado
|
employeeID | string |
Número de identificação do empregado |
|
|
primaryJobCode
|
primaryJobCode | string |
Código que representa o trabalho principal do empregado |
|
|
título do trabalho
|
jobTitle | string |
Designação do emprego do trabalhador |
|
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica se o trabalhador trabalha a tempo inteiro ou a tempo parcial |
|
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código que representa o local de trabalho principal do empregado |
|
|
primaryProjectCode
|
primaryProjectCode | string |
Código que representa o grupo de projeto principal do funcionário |
|
|
deduçãoGroupCode
|
deductionGroupCode | string |
Código que representa o grupo de dedução do trabalhador |
|
|
earningGroupCode
|
earningGroupCode | string |
Código que representa o grupo de ganhos para o empregado |
|
|
employeeTypeCode
|
employeeTypeCode | string |
Código que representa o tipo de trabalhador |
|
|
employeeStatusCode
|
employeeStatusCode | string |
Código que representa o estatuto do trabalhador |
|
|
Número do empregado
|
employeeNumber | string |
Número atribuído ao trabalhador |
|
|
identificação do supervisor
|
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 empregado |
|
|
dataDeRescisão
|
dateOfTermination | string |
Data da rescisão do empregado |
|
|
dataDeAposentadoria
|
dateOfRetirement | string |
Data da reforma do trabalhador |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Carimbo de data/hora indicando 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 empregado |
|
|
payGroup
|
payGroup | string |
Grupo associado à remuneração 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 |
Devoluções
Obter detalhes demográficos dos funcionários
Obtenha detalhes demográficos dos funcionários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de funcionário
|
employeeId | string |
Identificador do funcionário |
|
|
companyId
|
companyId | string |
Identificador da empresa |
|
|
sobrenome
|
lastName | string |
Sobrenome do funcionário |
|
|
endereço de e-mail
|
emailAddress | string |
Endereço de e-mail do funcionário |
|
|
endereçoEstado
|
addressState | string |
Estado de residência do trabalhador |
|
|
endereçoPaís
|
addressCountry | string |
País de residência do trabalhador |
|
|
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 |
Devoluções
Obter detalhes do supervisor de funcionários
Obtenha detalhes do supervisor de funcionários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Empresa
|
companyId | string |
Identificador da empresa |
|
|
ID do funcionário
|
employeeId | string |
Identificador da empresa do empregado |
|
|
supervisorCompanyId
|
supervisorCompanyId | string |
String que representa o identificador da empresa do supervisor |
|
|
supervisorEmployeeId
|
supervisorEmployeeId | string |
String que representa o identificador de funcionário do supervisor |
|
|
supervisorCompanyCode
|
supervisorCompanyCode | string |
String 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 |
Devoluções
Obter detalhes para uma execução contábil
Retorna uma lista de detalhes para uma execução contábil.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
runId
|
runId | string |
Identificador da execução da contabilidade |
|
|
blockId
|
blockId | string |
Identificador do bloco específico dentro da execução da contabilidade |
|
|
per_Page
|
per_Page | integer |
Filtrar para recuperar os dados mais recentes |
|
|
página
|
page | integer |
Paginação, qual página você deseja ver |
|
|
mais recentes
|
mostRecent | string |
Paginação, quantos registros por página você deseja ver |
Devoluções
Obter o último extrato de pagamento do funcionário
Obtenha o último extrato de pagamento do funcionário com base no identificador de funcionário passado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
EEID
|
eeid | True | string |
Introduza o seu ID de funcionário. |
|
Cóide
|
coid | True | string |
Introduza o ID da sua 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. |
|
|
páginasContagem
|
pagesCount | integer |
Insira a contagem de páginas. |
Devoluções
Obter todos os detalhes de uma pessoa atribuída a um funcionário como contato
Obtenha todos os detalhes de uma pessoa atribuída a um funcionário como contato.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de funcionário
|
employeeId | string |
Identificador do funcionário |
|
|
isActive
|
isActive | string |
Indicador de Estado Ativo |
|
|
relationshipCode
|
relationshipCode | string |
Código do tipo de relação de funcionário com o contato |
|
|
contactId
|
contactId | string |
Identificador de contato |
|
|
Código do país
|
countryCode | string |
Código do país |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booleano indicando se a cobertura COBRA está ativa no momento. |
|
|
cobraStatus
|
cobraStatus | string |
Esta é uma cadeia de caracteres que indica o status da cobertura COBRA |
|
|
isBeneficiário
|
isBeneficiary | string |
Indicador do beneficiário |
|
|
isDependente
|
isDependent | string |
Indicador dependente |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Usado para encontrar a data do evento COBRA menos, maior, igual ou entre datas passadas. |
|
|
statusAsOfDate
|
statusAsOfDate | string |
Usado para encontrar o status de contato como de data menor, maior, igual 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 |
Devoluções
Obter um registo de detalhes de uma única pessoa
Obtenha um registro de detalhes de uma única pessoa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do funcionário
|
employeeID | True | string |
Número de identificação do funcionário. |
Devoluções
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
| Name | Chave | Necessá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 e-mail
|
emailAddress | string |
Endereço de e-mail do funcionário |
|
|
endereçoEstado
|
addressState | string |
Estado de residência do trabalhador |
|
|
endereçoPaís
|
addressCountry | string |
País de residência do trabalhador |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booleano indicando se a cobertura COBRA está ativa no momento. |
|
|
cobraStatus
|
cobraStatus | string |
Esta é uma string que indica o status da cobertura COBRA. |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Usado para encontrar a data do evento COBRA menos, maior, igual ou entre datas passadas. |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Usado para encontrar registro de pessoa criado menos, maior, igual ou entre datas passadas. |
|
|
dateTimeChanged
|
dateTimeChanged | string |
Usado para encontrar registro de pessoa mudou 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 de página para paginação |
|
|
per_Page
|
per_Page | integer |
Número de itens por página |
Devoluções
Pesquisa de ID de Funcionário
Pesquisa de ID de Funcionário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
employeeIdentifierType
|
employeeIdentifierType | True | string |
Insira o tipo de identificador de funcionário. |
|
employeeIdentifierValue
|
employeeIdentifierValue | True | string |
Insira o valor do identificador do funcionário |
|
companyIdentifierType
|
companyIdentifierType | string |
Insira o tipo de identificador da empresa. |
|
|
empresaIdentiferValue
|
companyIdentifierValue | string |
Insira o valor do identificador da empresa |
Devoluções
- Body
- employeeIdLookup
Definições
getASinglePersonDetailRecord
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
additionalName1
|
additionalName1 | string |
Campo de nome adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nome adicional 2 |
|
endereçoId
|
addressId | string |
Identificador do endereço |
|
endereçoIsOnTaxBoundary
|
addressIsOnTaxBoundary | boolean |
Indica se o endereço está em um limite fiscal |
|
endereçoLatitude
|
addressLatitude | float |
Coordenada Latitude do endereço |
|
cobraExportação
|
cobraExport | string |
Informações de exportação COBRA |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica se o COBRA está ativo para o funcionário |
|
cobraRazão
|
cobraReason | string |
Razão para o status COBRA |
|
cobraStatus
|
cobraStatus | string |
Informações de status do COBRA |
|
cobraStatusDate
|
cobraStatusDate | string |
Data da atualização de status do COBRA |
|
comunidadeBroadcastSmsCode
|
communityBroadcastSmsCode | string |
Código SMS de transmissão comunitária |
|
consentimentoElectronicW2
|
consentElectronicW2 | boolean |
Indica consentimento para formulários W2 eletrônicos |
|
consentimentoElectronicw2pr
|
consentElectronicw2pr | boolean |
Indica consentimento para formulários W2 eletrónicos (específicos para RP) |
|
dataFalecido
|
dateDeceased | string |
Data do falecimento |
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Data do evento COBRA |
|
dateOfCobraExport
|
dateOfCobraExport | string |
Data de exportação do COBRA |
|
dateOfCobraLetter
|
dateOfCobraLetter | string |
Data da carta COBRA |
|
dateOfI9Expiração
|
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 |
|
datetimeCriado
|
datetimeCreated | string |
Carimbo de data/hora indicando quando os dados foram criados |
|
Tipo de deficiência
|
disabilityType | string |
Tipo de deficiência |
|
étnicoDescrição
|
ethnicDescription | string |
Descrição da etnia |
|
nome anterior
|
formerName | string |
Antigo nome |
|
saúdeTipo sanguíneo
|
healthBloodType | string |
Informação sobre o tipo sanguíneo |
|
saúdeOlhos
|
healthEyes | string |
Informações sobre a cor dos olhos |
|
saúdeCabelo
|
healthHair | string |
Informações sobre a cor do cabelo |
|
saúdeAlturaPés
|
healthHeightFeet | string |
Altura nos pés |
|
saúdeAlturaPolegadas
|
healthHeightInches | string |
Altura em polegadas |
|
saúdeLastDonateDate
|
healthLastDonateDate | string |
Data da última dádiva de sangue |
|
saúdePeso
|
healthWeight | double |
Peso em libras |
|
i9AlienNumber
|
i9AlienNumber | string |
Número de estrangeiro para o formulário I-9 |
|
i9DocA
|
i9DocA | string |
Documento A para o formulário I-9 |
|
i9DocB
|
i9DocB | string |
Documento B para o formulário I-9 |
|
i9DocC
|
i9DocC | string |
Documento C para o formulário I-9 |
|
i9Verificado
|
i9Verified | boolean |
Indica se o formulário I-9 está verificado |
|
i9VisaType
|
i9VisaType | string |
Tipo de visto para o formulário I-9 |
|
i9WorkAuth
|
i9WorkAuth | string |
Autorização de trabalho para o formulário I-9 |
|
isDisabled
|
isDisabled | boolean |
Indica se a pessoa é deficiente |
|
isMultiPayGroup
|
isMultiPayGroup | boolean |
Indica se a pessoa faz parte de vários grupos de remuneração |
|
isSmoker
|
isSmoker | boolean |
Indica se a pessoa é fumante |
|
Serviço militar
|
militaryService | boolean |
Indica o status do serviço militar |
|
militarBranchServiu
|
militaryBranchServed | string |
Ramo do serviço militar servido |
|
era militar
|
militaryEra | string |
Informação sobre a era militar |
|
militarIsDisabledVet
|
militaryIsDisabledVet | string |
Indica se a pessoa é um veterano com deficiência |
|
militarIsOthEligVet
|
militaryIsOthEligVet | string |
Indica se a pessoa é outro veterano elegível |
|
militarIsOthEligVetBasis
|
militaryIsOthEligVetBasis | string |
Base para outro estatuto de veterano elegível |
|
militarIsActiveWartimeVet
|
militaryIsActiveWartimeVet | string |
Indica se a pessoa é um veterano de guerra ativo |
|
nomeFormer
|
nameFormer | string |
Antigo nome |
|
anteriorSSN
|
previousSSN | string |
Número de Segurança Social Anterior |
|
origemPaís de origem
|
originCountry | string |
País de origem |
|
origemLocalização
|
originLocation | string |
Local de origem |
|
w2IsFalecido
|
w2IsDeceased | boolean |
Indica se a pessoa faleceu para os formulários W2 |
|
cobraNotas
|
cobraNotes | string |
Notas relacionadas com o COBRA |
|
endereçoSms
|
addressSms | string |
Endereço para notificações por SMS |
|
militarSeparationDate
|
militarySeparationDate | string |
Data da separação militar |
|
homeTelefoneÉPrivado
|
homePhoneIsPrivate | boolean |
Indica se o número de telefone residencial é privado |
|
smsAprovações
|
smsApprovals | boolean |
Indica se as aprovações por SMS estão habilitadas |
|
smsPayNotificação
|
smsPayNotification | boolean |
Indica se as notificações por SMS para pagamento estão ativadas |
|
i9VisaData de Expiração
|
i9VisaExpirationDate | string |
Data de validade do visto I-9 |
|
militarIsMedalVet
|
militaryIsMedalVet | string |
Indica se a pessoa é um veterano medalhista |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
Indica se o sobrenome é diferente do Cartão da Previdência Social |
|
chkCashingInstCode
|
chkCashingInstCode | string |
Verifique o código da instituição de pagamento |
|
nacionalidade1
|
nationality1 | string |
Informação sobre a nacionalidade 1 |
|
nacionalidade2
|
nationality2 | string |
Informação sobre a nacionalidade 2 |
|
nacionalidade3
|
nationality3 | string |
Informações sobre a nacionalidade 3 |
|
personId
|
personId | string |
Identificador da pessoa |
|
ID de funcionário
|
employeeId | string |
Identificador do empregado |
|
companyId
|
companyId | string |
Identificador da empresa |
|
nome de utilizador
|
userName | string |
Nome de utilizador |
|
primeiroNome
|
firstName | string |
Nome próprio |
|
Nome do meio
|
middleName | string |
Nome do meio |
|
sobrenome
|
lastName | string |
Apelido |
|
preferredName
|
preferredName | string |
Nome preferido |
|
nomePrefixCode
|
namePrefixCode | string |
Código de prefixo para o nome |
|
nomeSufixCode
|
nameSufixCode | string |
Código do sufixo para o nome |
|
endereço de e-mail
|
emailAddress | string |
Endereço de e-mail |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Endereço de e-mail alternativo |
|
homeTelefone
|
homePhone | string |
Número de telefone residencial |
|
homeTelefonePaís
|
homePhoneCountry | string |
Código do país para o número de telefone residencial |
|
endereçoLine1
|
addressLine1 | string |
Linha 1 do endereço |
|
endereçoLine2
|
addressLine2 | string |
Linha de endereço 2 |
|
endereçoCidade
|
addressCity | string |
City |
|
endereçoEstado
|
addressState | string |
Estado |
|
endereçoCEP
|
addressZipCode | string |
Código Postal |
|
endereçoPaís
|
addressCountry | string |
Country |
|
endereçoCondado
|
addressCounty | string |
Country |
|
nationalId
|
nationalId | string |
Documento de identificação nacional |
|
nationalIdCountry
|
nationalIdCountry | string |
País de identificação nacional |
|
dateOfBirth
|
dateOfBirth | string |
Data de nascimento |
|
Género
|
gender | string |
Sexo |
|
étnicoIDCode
|
ethnicIDCode | string |
Código de identificação étnica |
|
maritalStatusCode
|
maritalStatusCode | string |
Código do estado civil |
|
SSN
|
ssn | string |
Número de Segurança Social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica se o Número de Segurança Social está suprimido |
getEmployeePayStatement
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
acréscimos
|
accruals | array of object |
Lista de dados de especialização económica |
|
montantecorrente
|
accruals.amountcurrent | double |
Montante corrente acumulado |
|
tipo de montante
|
accruals.amounttype | string |
Tipo de acréscimo |
|
saldo
|
accruals.balance | double |
Saldo corrente de especialização económica |
|
código de plano
|
accruals.plancode | string |
Código que identifica o plano |
|
Descrição do plano
|
accruals.plandescription | string |
Descrição do plano |
|
endereço1
|
addressline1 | string |
Linha 1 do endereço |
|
endereço2
|
addressline2 | string |
Linha de endereço 2 |
|
city
|
city | string |
Cidade do endereço |
|
empresaendereçocidade
|
companyaddresscity | string |
Endereço da cidade da empresa |
|
empresaendereçopaís
|
companyaddresscountry | string |
Endereço do país da empresa |
|
EmpresaEndereçoCondado
|
companyaddresscounty | string |
Endereço do município da empresa |
|
empresaendereçolinha1
|
companyaddressline1 | string |
Endereço da empresa linha 1 |
|
empresaendereçolinha2
|
companyaddressline2 | string |
Endereço da empresa linha 2 |
|
Endereço da empresaPostalcode
|
companyaddresspostalcode | string |
Código postal do endereço da empresa |
|
EmpresaEndereçoEstadoProvíncia
|
companyaddressstateorprovince | string |
Estado ou província do endereço da empresa |
|
nome da empresa
|
companyname | string |
Nome da empresa |
|
telefone da empresa
|
companyphone | string |
Número de telefone principal da empresa |
|
CompanhiaPhoneExt
|
companyphoneext | string |
Extensão para o telefone da empresa |
|
country
|
country | string |
País do endereço |
|
deduções
|
deductions | array of object | |
|
montante base
|
deductions.basisamount | double |
Montante base para as deduções |
|
código de dedução
|
deductions.deductioncode | string |
Código que identifica a dedução |
|
deduçãoDescrição
|
deductions.deductiondescription | string |
Descrição da dedução |
|
montante dos trabalhadores
|
deductions.employeeamount | double |
Valor da dedução do empregado |
|
empregadoAmountytd
|
deductions.employeeamountytd | double |
Valor da dedução do empregado para o ano |
|
montante do empregador
|
deductions.employeramount | double |
Valor da dedução contribuído pelo empregador |
|
empregadoramountytd
|
deductions.employeramountytd | double |
Valor da dedução do empregador para o ano |
|
antes de impostos
|
deductions.pretax | boolean |
Indica se a dedução é antes de impostos |
|
deduçõescorrentes
|
deductionscurrent | double |
Total das deduções correntes |
|
deduçõesytd
|
deductionsytd | double |
Total das deduções do exercício |
|
documento
|
document | string |
Identificador ou descrição do documento |
|
ganhos
|
earnings | array of object |
Lista de registos de ganhos |
|
Montante
|
earnings.amount | double |
Valor dos ganhos |
|
AMOUNTYTD
|
earnings.amountytd | double |
Valor dos ganhos do ano |
|
Horas
|
earnings.hours | double |
Horas trabalhadas |
|
horasytd
|
earnings.hoursytd | double |
Horas trabalhadas no ano |
|
código de pagamento
|
earnings.paycode | string |
Código que identifica o tipo de pagamento |
|
Descrição do Pagamento
|
earnings.paydescription | string |
Descrição do tipo de pagamento |
|
taxa de pagamento
|
earnings.payrate | double |
Taxa de remuneração |
|
fim de período
|
earnings.periodend | date-time |
Data de fim do período de pagamento |
|
periodstart
|
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 (por peça) |
|
taxa de pagamento por peça
|
earnings.piecepayrate | double |
Taxa de pagamento por peça (por tarefa) |
|
tipo de identificação
|
employeeidentifier.identificationtype | string |
cadeia (de caracteres) |
|
identificador da empresa
|
employeeidentifier.companyidentifier | string |
cadeia (de caracteres) |
|
employeeidentifier
|
employeeidentifier.employeeidentifier | string |
cadeia (de caracteres) |
|
número de empregado
|
employeenumber | string |
Número de identificação do trabalhador |
|
federalmontante adicionalRetido
|
federaladditionalamountWithheld | double |
Imposto federal adicional retido na fonte |
|
subsídios federaisrequeridos
|
federalallowancesclaimed | double |
Deduções fiscais federais solicitadas |
|
federalfilingstatus
|
federalfilingstatus | string |
Status da declaração de impostos federais |
|
Salários Tributáveis FederaisCorrente
|
federaltaxablewagescurrent | double |
Salários tributáveis federais atuais |
|
Impostos FederaisSaláriosYTD
|
federaltaxablewagesytd | double |
Salários tributáveis federais do ano |
|
nome completo
|
fullname | string |
Nome completo do empregado |
|
Salários brutosCorrente
|
grosswagescurrent | double |
Salários brutos correntes |
|
Salário bruto
|
grosswagesytd | double |
Salários brutos do ano |
|
tarefa
|
job | string |
Cargo ou descrição |
|
localização
|
location | string |
Local de trabalho do empregado |
|
netpay
|
netpay | array of object |
Lista de registos de remuneração líquida |
|
número da conta
|
netpay.accountnumber | string |
Número da conta bancária |
|
tipo de conta
|
netpay.accounttype | string |
Tipo de conta bancária |
|
Montante
|
netpay.amount | double |
Montante da remuneração líquida |
|
netpaycurrent
|
netpaycurrent | double |
Remuneração líquida atual |
|
NetPayyTD
|
netpayytd | double |
Remuneração líquida do exercício |
|
nível de organização1
|
orglevel1 | string |
Primeiro nível de hierarquia organizacional |
|
nível de organização2
|
orglevel2 | string |
Segundo nível de hierarquia organizacional |
|
nível de organização3
|
orglevel3 | string |
Terceiro nível de hierarquia organizacional |
|
nível de organização4
|
orglevel4 | string |
Quarto nível de hierarquia organizacional |
|
data de pagamento
|
paydate | string |
Data de emissão do pagamento |
|
PayPeriodFrequency
|
payperiodfrequency | string |
Periodicidade do período de pagamento |
|
Grupo Remuneratório
|
paygroup | string |
Classificação de grupo para folha de pagamento |
|
payidentifier
|
payidentifier | string |
Identificador da instância de pagamento |
|
taxa de pagamento
|
payrate | double |
Taxa de pagamento |
|
perioddata-limite
|
periodenddate | string |
Data de fim do período de pagamento |
|
períododata de início
|
periodstartdate | string |
Data de início do período de pagamento |
|
pós-alcoda
|
postalcode | string |
Código postal do endereço do trabalhador |
|
Subsídios do Estado de Residenterequeridos
|
residentstateallowancesclaimed | double |
Deduções fiscais estatais solicitadas pelo residente |
|
residentstatefilingstatus
|
residentstatefilingstatus | string |
Estado de depósito do residente |
|
SSN
|
ssn | string |
Número de Segurança Social |
|
StateorProvince
|
stateorprovince | string |
Estado ou província do trabalhador |
|
impostos
|
taxes | array of object |
Lista de registos fiscais |
|
Montante
|
taxes.amount | double |
Montante do imposto |
|
AMOUNTYTD
|
taxes.amountytd | double |
Valor do imposto do ano |
|
montante base
|
taxes.basisamount | double |
Valor de base para o cálculo do imposto |
|
descrição fiscal
|
taxes.taxdescription | string |
Descrição do imposto |
|
Código Tributário
|
taxes.taxcode | string |
Código de identificação do imposto |
|
ImpostosCorrente
|
taxescurrent | double |
Total dos impostos correntes |
|
Taxesytd
|
taxesytd | double |
Total dos impostos do exercício |
|
Subsídios do Estado de trabalhoreivindicados
|
workstateallowancesclaimed | double |
Deduções fiscais estatais solicitadas pelo trabalhador |
|
workstatefilingstatus
|
workstatefilingstatus | string |
Situação fiscal estadual do empregado |
getEmployeeEmploymentDetalhes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da empresa
|
companyID | string |
Identificador da empresa |
|
ID do empregado
|
employeeID | string |
Identificador do empregado |
|
primaryJobCode
|
primaryJobCode | string |
Código que identifica o trabalho principal |
|
título do trabalho
|
jobTitle | string |
Designação do emprego do trabalhador |
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica se o emprego é a tempo inteiro ou a tempo parcial |
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código para o local de trabalho principal |
|
primaryProjectCode
|
primaryProjectCode | string |
Código para o projeto principal associado ao funcionário |
|
deduçãoGroupCode
|
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 a situação atual do trabalhador |
|
Número do empregado
|
employeeNumber | string |
Número único atribuído ao funcionário |
|
identificação do supervisor
|
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 |
|
dataDeRescisão
|
dateOfTermination | string |
Data de despedimento do trabalhador |
|
dataDeAposentadoria
|
dateOfRetirement | string |
Data em que o funcionário se aposentou |
|
dateTimeCreated
|
dateTimeCreated | string |
Carimbo de data/hora quando o registro de 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 foi efetuado o último pagamento ao trabalhador |
|
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 de página em uma resposta paginada |
|
per_Page
|
per_Page | integer |
Número de itens por página em uma resposta paginada |
getEmployeeDemographicDetails
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
étnicoDescrição
|
ethnicDescription | string |
Origem étnica |
|
additionalName1
|
additionalName1 | string |
Campo de nome adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nome adicional 2 |
|
endereçoId
|
addressId | string |
Identificador do endereço |
|
endereçoIsOnTaxBoundary
|
addressIsOnTaxBoundary | string |
Endereço sobre o estatuto de fronteira fiscal |
|
endereçoLatitude
|
addressLatitude | double |
Latitude geográfica do endereço |
|
Tipo de deficiência
|
disabilityType | string |
Tipo de deficiência |
|
nome anterior
|
formerName | string |
Nome anterior |
|
saúdeTipo sanguíneo
|
healthBloodType | string |
Informação sobre o tipo sanguíneo |
|
saúdeOlhos
|
healthEyes | string |
Informações sobre a cor dos olhos |
|
saúdeCabelo
|
healthHair | string |
Informações sobre a cor do cabelo |
|
saúdeAlturaPés
|
healthHeightFeet | string |
Altura nos pés |
|
saúdeAlturaPolegadas
|
healthHeightInches | string |
Altura em polegadas |
|
saúdeLastDonateDate
|
healthLastDonateDate | string |
Data da última dádiva de sangue |
|
saúdePeso
|
healthWeight | double |
Peso em unidades adequadas |
|
anteriorSSN
|
previousSSN | string |
Número de Segurança Social Anterior |
|
origemPaís de origem
|
originCountry | string |
País de origem |
|
origemLocalização
|
originLocation | string |
Local de origem |
|
endereçoSms
|
addressSms | string |
Endereço para notificações por SMS |
|
homeTelefoneÉPrivado
|
homePhoneIsPrivate | boolean |
O número de telefone residencial é privado |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
O sobrenome difere do cartão SS |
|
nacionalidade1
|
nationality1 | string |
Informação sobre a primeira nacionalidade |
|
nacionalidade2
|
nationality2 | string |
Informação sobre a segunda nacionalidade |
|
nacionalidade3
|
nationality3 | string |
Informação sobre a terceira nacionalidade |
|
personId
|
personId | string |
Identificador da pessoa |
|
ID de funcionário
|
employeeId | string |
Identificador do empregado |
|
companyId
|
companyId | string |
Identificador da empresa |
|
primeiroNome
|
firstName | string |
Nome próprio |
|
Nome do meio
|
middleName | string |
Nome do meio |
|
sobrenome
|
lastName | string |
Apelido |
|
preferredName
|
preferredName | string |
Nome preferido |
|
nomePrefixCode
|
namePrefixCode | string |
Código de prefixo para o nome |
|
nomeSuffixCode
|
nameSuffixCode | string |
Código de sufixo para o nome |
|
endereço de e-mail
|
emailAddress | string |
Endereço de e-mail |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Endereço de e-mail alternativo |
|
homeTelefoneID
|
homePhoneID | string |
Identificador do telefone doméstico |
|
homeTelefone
|
homePhone | string |
Número de telefone residencial |
|
homeTelefonePaís
|
homePhoneCountry | string |
Código do país para o telefone doméstico |
|
endereçoLine1
|
addressLine1 | string |
Linha de endereço principal |
|
endereçoLine2
|
addressLine2 | string |
Linha de endereço secundária |
|
endereçoLine3
|
addressLine3 | string |
Linha de endereço terciário |
|
endereçoLine4
|
addressLine4 | string |
Linha de endereço quaternário |
|
endereçoCidade
|
addressCity | string |
Cidade do endereço |
|
endereçoEstado
|
addressState | string |
Estado do endereço |
|
endereçoCEP
|
addressZipCode | string |
CEP do endereço |
|
endereçoPaís
|
addressCountry | string |
País do endereço |
|
endereçoCondado
|
addressCounty | string |
Localidade do endereço |
|
dateOfBirth
|
dateOfBirth | string |
Data de nascimento |
|
Género
|
gender | string |
Sexo do indivíduo |
|
ethnicIdCode
|
ethnicIdCode | string |
Código de identificação étnica |
|
isSmoker
|
isSmoker | boolean |
Indica se a pessoa é fumante |
|
isDisabled
|
isDisabled | string |
Estatuto de deficiência |
|
maritalStatusCode
|
maritalStatusCode | string |
Código do estado civil |
|
SSN
|
ssn | string |
Número de Segurança Social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica se o SSN foi suprimido |
|
ID de utilizador
|
userID | string |
ID de utilizador |
|
integrationRecordId
|
integrationRecordId | string |
Identificador de registo de integração |
|
número de telemóvel
|
cellPhoneNumber | string |
Número de telemóvel |
returnsAListOfDetailsForAGeneralLedgerRun
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
runId
|
runId | string |
Identificador exclusivo para a execução |
|
payPeriodEndDate
|
payPeriodEndDate | string |
Data de fim do período de pagamento |
|
Tipo de conta
|
accountType | string |
Tipo de conta |
|
baseSegment
|
baseSegment | string |
Identificador de segmento de base |
|
companyCode
|
companyCode | string |
Código de identificação da empresa |
|
créditoAmt
|
creditAmt | double |
Montante de crédito registado |
|
débitoAmt
|
debitAmt | double |
Valor do débito registado |
|
descrição
|
description | string |
Descrição da transação |
|
generalLedgerAccount
|
generalLedgerAccount | string |
Número da conta contábil |
|
jobCode
|
jobCode | string |
Código para o trabalho |
|
jobDesc
|
jobDesc | string |
Descrição do trabalho |
|
localização
|
location | string |
Localização da transação |
|
orgLevel1
|
orgLevel1 | string |
Primeiro nível de hierarquia organizacional |
|
orgLevel2
|
orgLevel2 | string |
Segundo nível de hierarquia organizacional |
|
orgLevel3
|
orgLevel3 | string |
Terceiro nível de hierarquia organizacional |
|
orgLevel4
|
orgLevel4 | string |
Quarto nível de hierarquia organizacional |
|
payGroup
|
payGroup | string |
Identificador do grupo da folha de pagamento |
|
periodData-limite
|
periodEndDate | string |
Data de fim do período contabilístico |
|
períodoDataInícioInício
|
periodStartDate | string |
Data de início do período contabilístico |
|
positionCode
|
positionCode | string |
Código do cargo |
|
posiçãoDesc
|
positionDesc | string |
Descrição do cargo |
|
projecto
|
project | string |
Identificador do 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 das GL |
|
totalNrOfBlocks
|
totalNrOfBlocks | double |
Número total de blocos em execução |
|
usuárioWhoRanThisGl
|
userWhoRanThisGl | string |
Usuário que executou a execução GL |
|
glJson
|
glJson | string |
Dados JSON da execução da contabilidade |
takesAnXmlTransactionAndFeedsItIntoTheImportTool
| Name | 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 ficheiro |
employeeIdLookup
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
Tipo de erro ou estado |
|
title
|
title | string |
Título resumindo o erro ou status |
|
detail
|
detail | string |
Descrição detalhada do erro ou status |
|
errorCount
|
errorCount | double |
Número de erros comunicados |
|
multistatus
|
multistatus | array of object | |
|
sequenceId
|
multistatus.sequenceId | double |
Identificador da sequência em multistatus |
|
estado
|
multistatus.status | string |
Status da operação em multistatus |
|
nome da propriedade
|
multistatus.modelstate.property-name | array of object |
Lista de mensagens de erro digitadas 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 |
|
Cóide
|
multistatus.body.coid | array of string |
Lista de identificadores de empresas; home company é a primeira |
getASpecificEmployeesPtoplans
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de funcionário
|
employeeId | string |
Identificador exclusivo do funcionário |
|
companyId
|
companyId | string |
Identificador da empresa associada ao colaborador |
|
ptoPlan
|
ptoPlan | string |
Identificador do plano do INPI aplicável ao empregado |
|
ganhou
|
earned | double |
Total de horas de PTO auferidas pelo empregado |
|
tomadas
|
taken | double |
Total de horas de PTO realizadas pelo empregado |
|
pendenteSaldo
|
pendingBalance | double |
Saldo atual de horas pendentes do INPI |
|
earnedThroughDate
|
earnedThroughDate | string |
Última data de constituição do INPI |
|
redefinir
|
reset | string |
Data de reposição do saldo do INPI |
|
pendenteMoveDate
|
pendingMoveDate | string |
Data relevante para as regras pendentes do INPI |
getEmployeeSupervisorDetalhes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do empregado
|
employeeID | string |
Identificador do empregado |
|
ID da empresa
|
companyID | string |
Identificador da empresa do empregado |
|
Número do empregado
|
employeeNumber | string |
Número único atribuído ao funcionário |
|
supervisorEmployeeID
|
supervisorEmployeeID | string |
Identificador do supervisor |
|
supervisorFirstName
|
supervisorFirstName | string |
Nome próprio do supervisor |
|
supervisorSobrenome
|
supervisorLastName | string |
Apelido do supervisor |
|
supervisorEmployeeNumber
|
supervisorEmployeeNumber | string |
Número de 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 do cargo atribuído ao supervisor |
|
supervisorE-mail
|
supervisorEmail | string |
Endereço de correio eletrónico do supervisor |
|
supervisorWorkPhone
|
supervisorWorkPhone | string |
Número de telefone de trabalho do supervisor |
|
supervisorPersonId
|
supervisorPersonId | string |
Identificador único para o supervisor enquanto pessoa |
getAllDetailsForAPersonAssignedToAnEmployeeAsAContact
| Name | 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 |
|
concelho
|
county | string |
Localidade do endereço |
|
endereçoIsDifferentFromEmployee
|
addressIsDifferentFromEmployee | boolean |
Indica se o endereço difere do endereço do funcionário |
|
endereçoLine1
|
addressLine1 | string |
Linha de endereço principal |
|
endereçoLine2
|
addressLine2 | string |
Linha de endereço secundária |
|
state
|
state | string |
Estado do endereço |
|
CEP
|
zipCode | string |
CEP do endereço |
|
cobraExportação
|
cobraExport | boolean |
Indica se os dados COBRA são exportados |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica se o COBRA está ativo |
|
cobraRazão
|
cobraReason | string |
Razão para o status 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 de emissão da carta COBRA |
|
ID de funcionário
|
employeeId | string |
Identificador do empregado |
|
Género
|
gender | string |
Sexo do indivíduo |
|
importId
|
importId | string |
Identificador de importação |
|
isBeneficiário
|
isBeneficiary | boolean |
Indica se a pessoa é beneficiária |
|
isDependente
|
isDependent | boolean |
Indica se o indivíduo é um dependente |
|
isDisabled
|
isDisabled | boolean |
Indica se a pessoa está incapacitada |
|
isEmergencyContact
|
isEmergencyContact | boolean |
Indica se a pessoa é um contacto de emergência |
|
isSmoker
|
isSmoker | boolean |
Indica se o indivíduo é fumante |
|
isEstudante
|
isStudent | boolean |
Indica se o indivíduo é um estudante |
|
CasamentoData
|
marriageDate | string |
Data do casamento |
|
primeiroNome
|
firstName | string |
Nome próprio da pessoa |
|
nome anterior
|
formerName | string |
Antigo nome da pessoa singular |
|
sobrenome
|
lastName | string |
Apelido da pessoa |
|
Nome do meio
|
middleName | string |
Nome do meio do indivíduo |
|
nomeSufixo
|
nameSuffix | string |
Sufixo do nome da pessoa |
|
Ocupação
|
occupation | string |
Ocupação do indivíduo |
|
outrosSeguros
|
otherInsurance | string |
Informações sobre outros seguros |
|
homeTelefonePaís
|
homePhoneCountry | string |
Código do país para o telefone doméstico |
|
homeNúmero de telefone
|
homePhoneNumber | string |
Número de telefone residencial |
|
outroNúmero de Telefone
|
otherPhoneNumber | string |
Outro número de telefone |
|
outroTipo de Telefone
|
otherPhoneType | string |
Tipo de outro telefone |
|
Número de telefone preferido
|
preferredPhoneNumber | string |
Número de telefone preferido |
|
relationshipCode
|
relationshipCode | string |
Código que descreve a relação |
|
relacionamentoDescrição
|
relationshipDescription | string |
Descrição da relação |
|
SSN
|
ssn | string |
Número de Segurança Social |
|
contactId
|
contactId | string |
Identificador do contacto |
|
userDefinedField01
|
userDefinedField01 | string |
Campo personalizado para informações adicionais |
|
workPhoneExtension
|
workPhoneExtension | string |
Extensão para o número de telefone de trabalho |
|
workPhoneNumber
|
workPhoneNumber | string |
Número de telefone do trabalho |
|
cobraNotas
|
cobraNotes | string |
Notas relacionadas com o COBRA |
|
Observações
|
notes | string |
Notas gerais sobre o indivíduo |
|
isActive
|
isActive | boolean |
Indica se o registro está ativo |
|
statusAsOfDate
|
statusAsOfDate | string |
Data da situação atual |
|
Data de falecimento
|
deathDate | string |
Data do óbito |
|
divórcioData do divórcio
|
divorceDate | string |
Data do divórcio |
|
endereço de e-mail
|
emailAddress | string |
Endereço de e-mail |
|
outroPhoneCountryCode
|
otherPhoneCountryCode | string |
Código do país para outro telefone |
|
saúdeCareId
|
healthCareId | string |
Identificador de cuidados de saúde |
|
nationalId
|
nationalId | string |
Identificador nacional |
|
nationalIdExpirationDate
|
nationalIdExpirationDate | string |
Data de validade do documento de identificação nacional |
|
identificação pessoal
|
personID | string |
Identificador único da pessoa |
|
endereçoID
|
addressID | string |
Identificador do endereço |
|
workPhoneId
|
workPhoneId | string |
Identificador do telefone de trabalho |
|
homeTelefoneId
|
homePhoneId | string |
Identificador do telefone doméstico |
|
outroPhoneId
|
otherPhoneId | string |
Identificador de outro telefone |