UKG Pro HCM (versión preliminar)
UKG Pro HCM Connector for Pro HR, Payroll and Talent.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | KGS |
| URL | https://www.ukg.com/support |
| Correo Electrónico | support@ukg.com |
| Metadatos del conector | |
|---|---|
| Publicador | Dilip Chenani |
| Sitio web | https://www.ukg.com/ |
| Directiva de privacidad | https://www.ukg.com/privacy |
| Categorías | Recursos humanos |
UkG Pro HCM Connector simplifica la transferencia de datos mediante UKG Pro API y le permite aprovechar los datos de UKG Pro para resolver las necesidades de integración y aplicación empresarial.
Prerrequisitos
- Usuarios de UKG Pro existentes con cuenta de servicio web y permisos de recursos válidos con los valores adecuados de Nombre de usuario y Clave de API de usuario. UkG Pro HCM Connector usa la autenticación básica y requiere un nombre de usuario único y una clave de API de usuario.
- Dirección URL del servicio base UKG Pro que será similar a "https://servicet.ultipro.com/services/", pero variará según los entornos de producción y producción y pruebas del cliente.
Obtención de credenciales
UkG Pro HCM Connector, mediante la autenticación básica, solo es accesible con una cuenta de servicio web. Para obtener información sobre cómo establecer y mantener una cuenta de servicio UKG Pro, haga clic aquí.
Introducción al conector
- Obtener un registro de detalles de una sola persona
- Obtener un registro de detalles de una sola persona para una sola empresa
- Obtener declaración de pago de empleado
- Obtener la última declaración de pago del empleado
- Obtener detalles de empleo de empleado
- Obtener detalles demográficos de los empleados
- Obtención de detalles de una ejecución de libro de contabilidad general
- Enviar transacción XML a la herramienta de importación
- Búsqueda de id. de empleado
- Obtener un empleado específico pto-plans
- Obtener detalles del supervisor de empleados
- Obtener todos los detalles de una persona asignada a un empleado como contacto
Problemas y limitaciones conocidos
Ninguno
Errores y soluciones comunes
Póngase en contacto con nosotros a través de https://www.ukg.com/support
Preguntas más frecuentes
Póngase en contacto con nosotros en https://www.ukg.com/support caso de errores y preguntas.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Nombre de usuario | securestring | El nombre de usuario de esta API | Cierto |
| Clave de API de usuario | securestring | La clave de API de usuario para esta API | Cierto |
| DIRECCIÓN URL del servicio base UKG Pro | cuerda / cadena | La dirección URL del servicio base será similar a servicet.ultipro.com, pero variará según los entornos de producción y producción y pruebas del cliente. | Cierto |
| Us-Customer-Api-Key | cuerda / cadena | Escriba suApi-Key de cliente de EE. UU. | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Búsqueda de id. de empleado |
Búsqueda de id. de empleado. |
| Enviar transacción XML a la herramienta de importación |
Envía una transacción XML codificada a la herramienta de importación. |
| Obtención de detalles de una ejecución de libro de contabilidad general |
Devuelve una lista de detalles de una ejecución de libro de contabilidad general. |
| Obtener declaración de pago de empleado |
Obtenga la declaración de pago de empleado en función del identificador de empleado pasado. |
| Obtener detalles de empleo de empleado |
Obtener los detalles de empleo de los empleados. |
| Obtener detalles del supervisor de empleados |
Obtenga los detalles del supervisor de empleados. |
| Obtener detalles demográficos de los empleados |
Obtenga los detalles demográficos de los empleados. |
| Obtener la última declaración de pago del empleado |
Obtenga la última declaración de pago del empleado en función del identificador de empleado pasado. |
| Obtener todos los detalles de una persona asignada a un empleado como contacto |
Obtenga todos los detalles de una persona asignada a un empleado como contacto. |
| Obtener un empleado específico pto-plans |
Obtener un empleado específico pto-plans |
| Obtener un registro de detalles de una sola persona |
Obtener un registro de detalle de una sola persona. |
| Obtener un registro de detalles de una sola persona para una sola empresa |
Obtener un registro de detalle de una sola persona para una sola empresa. |
Búsqueda de id. de empleado
Búsqueda de id. de empleado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
employeeIdentifierType
|
employeeIdentifierType | True | string |
Escriba el tipo de identificador de empleado. |
|
employeeIdentifierValue
|
employeeIdentifierValue | True | string |
Escriba el valor del identificador de empleado. |
|
companyIdentifierType
|
companyIdentifierType | string |
Escriba el tipo de identificador de empresa. |
|
|
companyIdentiferValue
|
companyIdentifierValue | string |
Escriba el valor del identificador de la empresa. |
Devoluciones
- Body
- employeeIdLookup
Enviar transacción XML a la herramienta de importación
Envía una transacción XML codificada a la herramienta de importación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
transaction
|
transaction | True | string |
Escriba la transacción XML codificada. |
|
uniqueFileName
|
uniqueFileName | string |
Escriba Nombre de archivo único que termina con la extensión xml. |
Devoluciones
Obtención de detalles de una ejecución de libro de contabilidad general
Devuelve una lista de detalles de una ejecución de libro de contabilidad general.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
runId
|
runId | string |
Identificador de la ejecución del libro de contabilidad general |
|
|
blockId
|
blockId | string |
Identificador del bloque específico dentro de la ejecución del libro de contabilidad general |
|
|
per_Page
|
per_Page | integer |
Filtrar para recuperar los datos más recientes |
|
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
mostRecent
|
mostRecent | string |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener declaración de pago de empleado
Obtenga la declaración de pago de empleado en función del identificador de empleado pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
companyCode
|
companyCode | string |
Escriba el Código de la empresa. |
|
|
número de empleado
|
employeeNumber | string |
Escriba el número de empleado. |
|
|
eeid
|
eeid | string |
Escriba el id. de empleado. |
|
|
coid
|
coid | string |
Escriba el identificador de la empresa. |
|
|
startDate
|
startDate | string |
Escriba Fecha de inicio. |
|
|
fecha de finalización
|
endDate | string |
Escriba Fecha de finalización. |
|
|
página
|
page | integer |
Escriba el número de página. |
|
|
per_Page
|
per_Page | integer |
Escriba por valor de página. |
|
|
pagesCount
|
pagesCount | integer |
Escriba recuento de páginas. |
Devoluciones
- response
- array of getEmployeePayStatement
Obtener detalles de empleo de empleado
Obtener los detalles de empleo de los empleados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
companyID
|
companyID | string |
Número de identificación de la empresa |
|
|
employeeID
|
employeeID | string |
Número de identificación de empleado |
|
|
primaryJobCode
|
primaryJobCode | string |
Código que representa el trabajo principal del empleado |
|
|
título del trabajo
|
jobTitle | string |
Título del trabajo del empleado |
|
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica si el empleado es a tiempo completo o a tiempo parcial |
|
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código que representa la ubicación de trabajo principal del empleado |
|
|
primaryProjectCode
|
primaryProjectCode | string |
Código que representa el grupo de proyectos principal del empleado |
|
|
deductionGroupCode
|
deductionGroupCode | string |
Código que representa el grupo de deducción para el empleado |
|
|
earningGroupCode
|
earningGroupCode | string |
Código que representa el grupo de ganancias para el empleado |
|
|
employeeTypeCode
|
employeeTypeCode | string |
Código que representa el tipo de empleado |
|
|
employeeStatusCode
|
employeeStatusCode | string |
Código que representa el estado del empleado |
|
|
número de empleado
|
employeeNumber | string |
Número asignado al empleado |
|
|
supervisorId
|
supervisorId | string |
Identificador único del supervisor del empleado |
|
|
originalHireDate
|
originalHireDate | string |
Fecha en que el empleado fue contratado originalmente |
|
|
lastHireDate
|
lastHireDate | string |
Fecha de la última contratación del empleado |
|
|
dateOfTermination
|
dateOfTermination | string |
Fecha de finalización del empleado |
|
|
dateOfRetirement
|
dateOfRetirement | string |
Fecha de retirada del empleado |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Marca de tiempo que indica cuándo se creó el registro |
|
|
dateTimeChanged
|
dateTimeChanged | string |
Marca de tiempo que indica cuándo se actualizó por última vez el registro |
|
|
dateLastPayDatePaid
|
dateLastPayDatePaid | string |
Fecha de la última fecha de pago del empleado |
|
|
payGroup
|
payGroup | string |
Grupo asociado al pago del empleado. |
|
|
isHomeCompany
|
isHomeCompany | boolean |
Indicador si la empresa es la empresa principal del empleado |
|
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
per_Page
|
per_Page | integer |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener detalles del supervisor de empleados
Obtenga los detalles del supervisor de empleados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de empresa
|
companyId | string |
Identificador de empresa |
|
|
Id. de empleado
|
employeeId | string |
Identificador de la empresa del empleado |
|
|
supervisorCompanyId
|
supervisorCompanyId | string |
Cadena que representa el identificador de la compañía del supervisor |
|
|
supervisorEmployeeId
|
supervisorEmployeeId | string |
Cadena que representa el identificador de empleado del supervisor |
|
|
supervisorCompanyCode
|
supervisorCompanyCode | string |
Cadena que representa el código de la compañía del supervisor |
|
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
per_Page
|
per_Page | integer |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener detalles demográficos de los empleados
Obtenga los detalles demográficos de los empleados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de empleado
|
employeeId | string |
Identificador de empleado |
|
|
companyId
|
companyId | string |
Identificador de empresa |
|
|
lastName
|
lastName | string |
Apellidos del empleado |
|
|
dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico del empleado |
|
|
addressState
|
addressState | string |
Estado de residencia del empleado |
|
|
addressCountry
|
addressCountry | string |
País de residencia del empleado |
|
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
per_Page
|
per_Page | integer |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener la última declaración de pago del empleado
Obtenga la última declaración de pago del empleado en función del identificador de empleado pasado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
eeid
|
eeid | True | string |
Escriba el id. de empleado. |
|
coid
|
coid | True | string |
Escriba el identificador de la empresa. |
|
startDate
|
startDate | string |
Escriba Fecha de inicio. |
|
|
fecha de finalización
|
endDate | string |
Escriba Fecha de finalización. |
|
|
página
|
page | integer |
Escriba el número de página. |
|
|
per_Page
|
per_Page | integer |
Escriba por valor de página. |
|
|
pagesCount
|
pagesCount | integer |
Escriba recuento de páginas. |
Devoluciones
Obtener todos los detalles de una persona asignada a un empleado como contacto
Obtenga todos los detalles de una persona asignada a un empleado como contacto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de empleado
|
employeeId | string |
Identificador de empleado |
|
|
isActive
|
isActive | string |
Indicador de estado activo |
|
|
relationshipCode
|
relationshipCode | string |
Código de tipo de relación de empleado al contacto |
|
|
contactId
|
contactId | string |
Identificador de contacto |
|
|
countryCode
|
countryCode | string |
Código de país |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booleano que indica si la cobertura cobra está activa actualmente. |
|
|
cobraStatus
|
cobraStatus | string |
Se trata de una cadena que indica el estado de la cobertura COBRA. |
|
|
isBeneficiary
|
isBeneficiary | string |
Indicador beneficiario |
|
|
isDependent
|
isDependent | string |
Indicador dependiente |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Se usa para buscar la fecha del evento COBRA menor, mayor, igual o entre fechas superada. |
|
|
statusAsOfDate
|
statusAsOfDate | string |
Se usa para buscar el estado de contacto a partir de la fecha menor, mayor, igual o entre fechas superada. |
|
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
per_Page
|
per_Page | integer |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener un empleado específico pto-plans
Obtener un empleado específico pto-plans
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de empleado
|
employeeID | True | string |
Número de identificación del empleado. |
|
Id. de empresa
|
companyID | True | string |
Número de identificación de la empresa. |
|
página
|
page | integer |
Paginación, qué página quiere ver |
|
|
per_page
|
per_page | integer |
Paginación, cuántos registros por página desea ver |
Devoluciones
Obtener un registro de detalles de una sola persona
Obtener un registro de detalle de una sola persona.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de empleado
|
employeeID | True | string |
Número de identificación del empleado. |
Devoluciones
Obtener un registro de detalles de una sola persona para una sola empresa
Obtener un registro de detalle de una sola persona para una sola empresa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de empleado
|
employeeID | True | string |
Número de identificación del empleado. |
|
Id. de empresa
|
companyID | True | string |
Número de identificación de la empresa. |
|
lastName
|
lastName | string |
Apellidos del empleado |
|
|
dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico del empleado |
|
|
addressState
|
addressState | string |
Estado de residencia del empleado |
|
|
addressCountry
|
addressCountry | string |
País de residencia del empleado |
|
|
cobraIsActive
|
cobraIsActive | string |
Campo booleano que indica si la cobertura cobra está activa actualmente. |
|
|
cobraStatus
|
cobraStatus | string |
Se trata de una cadena que indica el estado de la cobertura COBRA. |
|
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Se usa para buscar la fecha del evento COBRA menor, mayor, igual o entre fechas superada. |
|
|
dateTimeCreated
|
dateTimeCreated | string |
Se usa para buscar el registro de persona creado menos, mayor, igual o entre fechas superada. |
|
|
dateTimeChanged
|
dateTimeChanged | string |
Se usa para encontrar que el registro de persona ha cambiado menos, mayor, igual o entre fechas pasadas. |
|
|
nationalId
|
nationalId | string |
Número de identificación nacional |
|
|
nationalIdCountry
|
nationalIdCountry | string |
Número de identificación del país |
|
|
página
|
page | integer |
Número de página para la paginación |
|
|
per_Page
|
per_Page | integer |
Número de elementos por página |
Devoluciones
Definiciones
getASinglePersonDetailRecord
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
additionalName1
|
additionalName1 | string |
Campo de nombre adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nombre adicional 2 |
|
addressId
|
addressId | string |
Identificador de la dirección |
|
addressIsOnTaxBoundary
|
addressIsOnTaxBoundary | boolean |
Indica si la dirección está en un límite fiscal. |
|
addressLatitude
|
addressLatitude | float |
Coordenada de latitud de la dirección |
|
cobraExport
|
cobraExport | string |
Información de exportación de COBRA |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica si COBRA está activo para el empleado |
|
cobraReason
|
cobraReason | string |
Motivo del estado de COBRA |
|
cobraStatus
|
cobraStatus | string |
Información de estado de COBRA |
|
cobraStatusDate
|
cobraStatusDate | string |
Fecha de actualización de estado de COBRA |
|
communityBroadcastSmsCode
|
communityBroadcastSmsCode | string |
Código SMS de difusión de la comunidad |
|
consentElectronicW2
|
consentElectronicW2 | boolean |
Indica el consentimiento de formularios W2 electrónicos. |
|
consentElectronicw2pr
|
consentElectronicw2pr | boolean |
Indica el consentimiento de formularios W2 electrónicos (específicos de la solicitud de incorporación de cambios) |
|
dateDeceased
|
dateDeceased | string |
Fecha de muerte |
|
dateOfCobraEvent
|
dateOfCobraEvent | string |
Fecha del evento COBRA |
|
dateOfCobraExport
|
dateOfCobraExport | string |
Fecha de exportación de COBRA |
|
dateOfCobraLetter
|
dateOfCobraLetter | string |
Fecha de la carta COBRA |
|
dateOfI9Expiration
|
dateOfI9Expiration | string |
Fecha de expiración del formulario I-9 |
|
datetimeChanged
|
datetimeChanged | string |
Marca de tiempo que indica cuándo se actualizaron por última vez los datos |
|
datetimeCreated
|
datetimeCreated | string |
Marca de tiempo que indica cuándo se crearon los datos |
|
disabilitType
|
disabilityType | string |
Tipo de discapacidad |
|
ethnicDescription
|
ethnicDescription | string |
Descripción de la etnia |
|
formerName
|
formerName | string |
Nombre anterior |
|
healthBloodType
|
healthBloodType | string |
Información del tipo de sangre |
|
healthEyes
|
healthEyes | string |
Información del color del ojo |
|
healthHair
|
healthHair | string |
Información del color del cabello |
|
healthHeightFeet
|
healthHeightFeet | string |
Altura en pies |
|
healthHeightInches
|
healthHeightInches | string |
Alto en pulgadas |
|
healthLastDonateDate
|
healthLastDonateDate | string |
Fecha de la última donación de sangre |
|
healthWeight
|
healthWeight | double |
Peso en libras |
|
i9AlienNumber
|
i9AlienNumber | string |
Número alienígena para el formulario I-9 |
|
i9DocA
|
i9DocA | string |
Documento A para formulario I-9 |
|
i9DocB
|
i9DocB | string |
Documento B para formulario I-9 |
|
i9DocC
|
i9DocC | string |
Documento C para I-9 formg |
|
i9Verified
|
i9Verified | boolean |
Indica si se comprueba el formulario I-9. |
|
i9VisaType
|
i9VisaType | string |
Tipo de visa para formulario I-9 |
|
i9WorkAuth
|
i9WorkAuth | string |
Autorización de trabajo para formulario I-9 |
|
isDisabled
|
isDisabled | boolean |
Indica si la persona está deshabilitada |
|
isMultiPayGroup
|
isMultiPayGroup | boolean |
Indica si la persona forma parte de varios grupos de pago |
|
isSmoker
|
isSmoker | boolean |
Indica si la persona es fumadora |
|
militaryService
|
militaryService | boolean |
Indica el estado del servicio militar. |
|
militaryBranchServed
|
militaryBranchServed | string |
Rama del servicio militar servido |
|
militaryEra
|
militaryEra | string |
Información de la era militar |
|
militaryIsDisabledVet
|
militaryIsDisabledVet | string |
Indica si la persona es un veterano deshabilitado |
|
militaryIsOthEligVet
|
militaryIsOthEligVet | string |
Indica si la persona es otra veterano elegible |
|
militaryIsOthEligVetBasis
|
militaryIsOthEligVetBasis | string |
Base para otros estados veteranos elegibles |
|
militaryIsActiveWartimeVet
|
militaryIsActiveWartimeVet | string |
Indica si la persona es un veterano activo en tiempo de guerra |
|
nameFormer
|
nameFormer | string |
Nombre anterior |
|
previousSSN
|
previousSSN | string |
Número anterior de la Seguridad Social |
|
originCountry
|
originCountry | string |
País de origen |
|
originLocation
|
originLocation | string |
Ubicación de origen |
|
w2IsDeceased
|
w2IsDeceased | boolean |
Indica si la persona ha muerto para formularios W2 |
|
cobraNotes
|
cobraNotes | string |
Notas relacionadas con COBRA |
|
addressSms
|
addressSms | string |
Dirección de las notificaciones por SMS |
|
militarySeparationDate
|
militarySeparationDate | string |
Fecha de separación militar |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
Indica si el número de teléfono principal es privado. |
|
smsApprovals
|
smsApprovals | boolean |
Indica si las aprobaciones de SMS están habilitadas. |
|
smsPayNotification
|
smsPayNotification | boolean |
Indica si las notificaciones por SMS para pago están habilitadas. |
|
i9VisaExpirationDate
|
i9VisaExpirationDate | string |
Fecha de expiración del visado I-9 |
|
militaryIsMedalVet
|
militaryIsMedalVet | string |
Indica si la persona es un veterano de medalla |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
Indica si el apellido es diferente de la tarjeta de seguridad social. |
|
chkCashingInstCode
|
chkCashingInstCode | string |
Comprobar el código de la institución de efectivo |
|
nacionalidad1
|
nationality1 | string |
Información de nacionalidad 1 |
|
nacionalidad2
|
nationality2 | string |
Información de nacionalidad 2 |
|
nacionalidad3
|
nationality3 | string |
Información de nacionalidad 3 |
|
personId
|
personId | string |
Identificador de la persona |
|
ID de empleado
|
employeeId | string |
Identificador del empleado |
|
companyId
|
companyId | string |
Identificador de la empresa |
|
nombre de usuario
|
userName | string |
Nombre de usuario |
|
firstName
|
firstName | string |
Nombre |
|
Nombre del medio
|
middleName | string |
Segundo nombre |
|
lastName
|
lastName | string |
Apellido |
|
preferredName
|
preferredName | string |
Nombre preferido |
|
namePrefixCode
|
namePrefixCode | string |
Código de prefijo para el nombre |
|
nameSufixCode
|
nameSufixCode | string |
Código de sufijo para name |
|
dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Dirección de correo electrónico alternativa |
|
homePhone
|
homePhone | string |
Número de teléfono principal |
|
homePhoneCountry
|
homePhoneCountry | string |
Código de país para el número de teléfono principal |
|
addressLine1
|
addressLine1 | string |
Línea de dirección 1 |
|
addressLine2
|
addressLine2 | string |
Línea de dirección 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 el identificador nacional |
|
dateOfBirth
|
dateOfBirth | string |
Fecha de nacimiento |
|
gender
|
gender | string |
Gender |
|
ethnicIDCode
|
ethnicIDCode | string |
Código de id. étnico |
|
mariStatusCode
|
maritalStatusCode | string |
Código de estado civil |
|
Ssn
|
ssn | string |
Número de seguro social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica si se suprime el número de seguro social. |
getEmployeePayStatement
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Acumulaciones
|
accruals | array of object |
Lista de detalles de acumulación |
|
amountcurrent
|
accruals.amountcurrent | double |
Importe actual acumulado |
|
amounttype
|
accruals.amounttype | string |
Tipo de importe acumulado |
|
equilibrar
|
accruals.balance | double |
Saldo actual de acumulación |
|
plancode
|
accruals.plancode | string |
Código que identifica el plan |
|
plandescription
|
accruals.plandescription | string |
Descripción del plan |
|
addressline1
|
addressline1 | string |
Línea de dirección 1 |
|
addressline2
|
addressline2 | string |
Línea de dirección 2 |
|
city
|
city | string |
Ciudad de la dirección |
|
companyaddresscity
|
companyaddresscity | string |
Dirección de la ciudad de la compañía |
|
companyaddresscountry
|
companyaddresscountry | string |
Dirección del país de la compañía |
|
companyaddresscounty
|
companyaddresscounty | string |
Dirección del condado de la compañía |
|
companyaddressline1
|
companyaddressline1 | string |
Línea 1 de dirección de la compañía |
|
companyaddressline2
|
companyaddressline2 | string |
Línea 2 de dirección de la empresa |
|
companyaddresspostalcode
|
companyaddresspostalcode | string |
Código postal de la dirección de la empresa |
|
companyaddressstateorprovince
|
companyaddressstateorprovince | string |
Estado o provincia de la dirección de la empresa |
|
companyname
|
companyname | string |
Nombre de la empresa |
|
companyphone
|
companyphone | string |
Número de teléfono principal de la empresa |
|
companyphoneext
|
companyphoneext | string |
Extensión para el teléfono de la empresa |
|
country
|
country | string |
País de la dirección |
|
Deducciones
|
deductions | array of object | |
|
basisamount
|
deductions.basisamount | double |
Cantidad base para deducciones |
|
deduccióncode
|
deductions.deductioncode | string |
Código que identifica la deducción |
|
deductiondescription
|
deductions.deductiondescription | string |
Descripción de la deducción |
|
employeeamount
|
deductions.employeeamount | double |
Importe de deducción del empleado |
|
employeeamountytd
|
deductions.employeeamountytd | double |
Importe de deducción del empleado durante el año |
|
employeramount
|
deductions.employeramount | double |
Importe de deducción aportado por el empleador |
|
employeramountytd
|
deductions.employeramountytd | double |
Importe de deducción del empleador para el año |
|
pretax
|
deductions.pretax | boolean |
Indica si la deducción es pre-tax |
|
deductionscurrent
|
deductionscurrent | double |
Deducciones actuales totales |
|
deductionsytd
|
deductionsytd | double |
Deducciones totales para el año |
|
documento
|
document | string |
Identificador o descripción del documento |
|
ganancias
|
earnings | array of object |
Lista de registros de ganancias |
|
importe
|
earnings.amount | double |
Importe de ganancias |
|
amountytd
|
earnings.amountytd | double |
Importe de ganancias para el año |
|
horas
|
earnings.hours | double |
Horas trabajadas |
|
hoursytd
|
earnings.hoursytd | double |
Horas trabajadas durante el año |
|
código de pago
|
earnings.paycode | string |
Código que identifica el tipo de pago |
|
paydescription
|
earnings.paydescription | string |
Descripción del tipo de pago |
|
payrate
|
earnings.payrate | double |
Tasa de pago |
|
periodend
|
earnings.periodend | date-time |
Fecha de finalización del período de pago |
|
periodstart
|
earnings.periodstart | date-time |
Fecha de inicio del período de pago |
|
piececount
|
earnings.piececount | double |
Recuento de piezas completadas (para piezas) |
|
piecepayrate
|
earnings.piecepayrate | double |
Tasa de pago por pieza (por pieza) |
|
identificationtype
|
employeeidentifier.identificationtype | string |
cuerda / cadena |
|
companyidentifier
|
employeeidentifier.companyidentifier | string |
cuerda / cadena |
|
employeeidentifier
|
employeeidentifier.employeeidentifier | string |
cuerda / cadena |
|
employeenumber
|
employeenumber | string |
Número que identifica al empleado |
|
federaladditionalamountWithheld
|
federaladditionalamountWithheld | double |
Impuestos federales adicionales retenidos |
|
federalallowancesclaimed
|
federalallowancesclaimed | double |
Asignaciones fiscales federales reclamadas |
|
federalfilingstatus
|
federalfilingstatus | string |
Estado de presentación fiscal federal |
|
federaltaxablewagescurrent
|
federaltaxablewagescurrent | double |
Salarios fiscales federales actuales |
|
federaltaxablewagesytd
|
federaltaxablewagesytd | double |
Salarios fiscales federales para el año |
|
fullname
|
fullname | string |
Nombre completo del empleado |
|
grosswagescurrent
|
grosswagescurrent | double |
Salarios brutos actuales |
|
grosswagesytd
|
grosswagesytd | double |
Salarios brutos para el año |
|
job
|
job | string |
Título o descripción del trabajo |
|
location
|
location | string |
Ubicación laboral del empleado |
|
netpay
|
netpay | array of object |
Lista de registros netos de pago |
|
accountnumber
|
netpay.accountnumber | string |
Número de cuenta bancaria |
|
accounttype
|
netpay.accounttype | string |
Tipo de cuenta bancaria |
|
importe
|
netpay.amount | double |
Importe de pago neto |
|
netpaycurrent
|
netpaycurrent | double |
Pago neto actual |
|
netpayytd
|
netpayytd | double |
Pago neto por el año |
|
orglevel1
|
orglevel1 | string |
Primer nivel de jerarquía organizativa |
|
orglevel2
|
orglevel2 | string |
Segundo nivel de jerarquía organizativa |
|
orglevel3
|
orglevel3 | string |
Tercer nivel de jerarquía organizativa |
|
orglevel4
|
orglevel4 | string |
Cuarto nivel de jerarquía organizativa |
|
paydate
|
paydate | string |
Fecha en la que se emitió el pago |
|
payperiodfrequency
|
payperiodfrequency | string |
Frecuencia del período de pago |
|
paygroup
|
paygroup | string |
Clasificación de grupos para nóminas |
|
payidentifier
|
payidentifier | string |
Identificador de la instancia de pago |
|
payrate
|
payrate | double |
Tasa de pago |
|
periodenddate
|
periodenddate | string |
Fecha de finalización del período de pago |
|
periodstartdate
|
periodstartdate | string |
Fecha de inicio del período de pago |
|
postalcode
|
postalcode | string |
Código postal de la dirección del empleado |
|
residentstateallowancesclaimed
|
residentstateallowancesclaimed | double |
Asignaciones fiscales estatales reclamadas por el residente |
|
residentstatefilingstatus
|
residentstatefilingstatus | string |
Estado de presentación del residente |
|
Ssn
|
ssn | string |
Número de seguro social |
|
stateorprovince
|
stateorprovince | string |
Estado o provincia del empleado |
|
impuestos
|
taxes | array of object |
Lista de registros fiscales |
|
importe
|
taxes.amount | double |
Importe del impuesto |
|
amountytd
|
taxes.amountytd | double |
Importe fiscal del año |
|
basisamount
|
taxes.basisamount | double |
Importe base para el cálculo fiscal |
|
taxdescription
|
taxes.taxdescription | string |
Descripción del impuesto |
|
taxcode
|
taxes.taxcode | string |
Código que identifica el impuesto |
|
taxescurrent
|
taxescurrent | double |
Total de impuestos actuales |
|
taxesytd
|
taxesytd | double |
Total de impuestos para el año |
|
workstateallowancesclaimed
|
workstateallowancesclaimed | double |
Asignaciones fiscales estatales reclamadas por el empleado |
|
workstatefilingstatus
|
workstatefilingstatus | string |
Estado de presentación fiscal del empleado |
getEmployeeEmploymentDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
companyID
|
companyID | string |
Identificador de la empresa |
|
employeeID
|
employeeID | string |
Identificador del empleado |
|
primaryJobCode
|
primaryJobCode | string |
Código que identifica el trabajo principal |
|
título del trabajo
|
jobTitle | string |
Título del trabajo del empleado |
|
fullTimeOrPartTimeCode
|
fullTimeOrPartTimeCode | string |
Código que indica si el trabajo es a tiempo completo o a tiempo parcial |
|
primaryWorkLocationCode
|
primaryWorkLocationCode | string |
Código para la ubicación de trabajo principal |
|
primaryProjectCode
|
primaryProjectCode | string |
Código del proyecto principal asociado al empleado |
|
deductionGroupCode
|
deductionGroupCode | string |
Código que identifica el grupo de deducción |
|
earningGroupCode
|
earningGroupCode | string |
Código que identifica el grupo de ganancias |
|
employeeTypeCode
|
employeeTypeCode | string |
Código que define el tipo de empleo |
|
employeeStatusCode
|
employeeStatusCode | string |
Código que representa el estado actual del empleado |
|
número de empleado
|
employeeNumber | string |
Número único asignado al empleado |
|
supervisorId
|
supervisorId | string |
Identificador del supervisor del empleado |
|
originalHireDate
|
originalHireDate | string |
Fecha en que el empleado fue contratado originalmente |
|
lastHireDate
|
lastHireDate | string |
Fecha en que el empleado fue contratado más recientemente |
|
dateOfTermination
|
dateOfTermination | string |
Fecha de finalización del empleado |
|
dateOfRetirement
|
dateOfRetirement | string |
Fecha en que se retiró el empleado |
|
dateTimeCreated
|
dateTimeCreated | string |
Marca de tiempo en la que se creó el registro de empleado |
|
dateTimeChanged
|
dateTimeChanged | string |
Marca de tiempo en la que se modificó por última vez el registro de empleado |
|
dateLastPayDatePaid
|
dateLastPayDatePaid | string |
Fecha en que se realizó el último pago al empleado |
|
payGroup
|
payGroup | string |
Clasificación de grupos para nóminas |
|
isHomeCompany
|
isHomeCompany | boolean |
Indica si la empresa es la empresa principal del empleado. |
|
página
|
page | integer |
Número de página en una respuesta paginada |
|
per_Page
|
per_Page | integer |
Número de elementos por página en una respuesta paginada |
getEmployeeDemographicDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ethnicDescription
|
ethnicDescription | string |
Antecedentes étnicos |
|
additionalName1
|
additionalName1 | string |
Campo de nombre adicional 1 |
|
additionalName2
|
additionalName2 | string |
Campo de nombre adicional 2 |
|
addressId
|
addressId | string |
Identificador de la dirección |
|
addressIsOnTaxBoundary
|
addressIsOnTaxBoundary | string |
Dirección en el estado de límite fiscal |
|
addressLatitude
|
addressLatitude | double |
Latitud geográfica de la dirección |
|
disabilitType
|
disabilityType | string |
Tipo de discapacidad |
|
formerName
|
formerName | string |
Nombre anterior |
|
healthBloodType
|
healthBloodType | string |
Información del tipo de sangre |
|
healthEyes
|
healthEyes | string |
Información del color del ojo |
|
healthHair
|
healthHair | string |
Información del color del cabello |
|
healthHeightFeet
|
healthHeightFeet | string |
Altura en pies |
|
healthHeightInches
|
healthHeightInches | string |
Alto en pulgadas |
|
healthLastDonateDate
|
healthLastDonateDate | string |
Fecha de la última donación de sangre |
|
healthWeight
|
healthWeight | double |
Peso en unidades adecuadas |
|
previousSSN
|
previousSSN | string |
Número anterior de la Seguridad Social |
|
originCountry
|
originCountry | string |
País de origen |
|
originLocation
|
originLocation | string |
Ubicación de origen |
|
addressSms
|
addressSms | string |
Dirección de las notificaciones por SMS |
|
homePhoneIsPrivate
|
homePhoneIsPrivate | boolean |
El número de teléfono principal es privado |
|
lastNameNotSameAsSSCard
|
lastNameNotSameAsSSCard | string |
El apellido difiere de la tarjeta SS |
|
nacionalidad1
|
nationality1 | string |
Primera información de nacionalidad |
|
nacionalidad2
|
nationality2 | string |
Segunda información de nacionalidad |
|
nacionalidad3
|
nationality3 | string |
Tercera información de nacionalidad |
|
personId
|
personId | string |
Identificador de la persona |
|
ID de empleado
|
employeeId | string |
Identificador del empleado |
|
companyId
|
companyId | string |
Identificador de la empresa |
|
firstName
|
firstName | string |
Nombre |
|
Nombre del medio
|
middleName | string |
Segundo nombre |
|
lastName
|
lastName | string |
Apellido |
|
preferredName
|
preferredName | string |
Nombre preferido |
|
namePrefixCode
|
namePrefixCode | string |
Código de prefijo para el nombre |
|
nameSuffixCode
|
nameSuffixCode | string |
Código de sufijo para el nombre |
|
dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
emailAddressAlternate
|
emailAddressAlternate | string |
Dirección de correo electrónico alternativa |
|
homePhoneID
|
homePhoneID | string |
Identificador del teléfono doméstico |
|
homePhone
|
homePhone | string |
Número de teléfono principal |
|
homePhoneCountry
|
homePhoneCountry | string |
Código de país para teléfono doméstico |
|
addressLine1
|
addressLine1 | string |
Línea de direcciones principal |
|
addressLine2
|
addressLine2 | string |
Línea de direcciones secundarias |
|
addressLine3
|
addressLine3 | string |
Línea de direcciones terciarias |
|
addressLine4
|
addressLine4 | string |
Línea de direcciones cuaternarias |
|
addressCity
|
addressCity | string |
Ciudad de la dirección |
|
addressState
|
addressState | string |
Estado de la dirección |
|
addressZipCode
|
addressZipCode | string |
Código postal de la dirección |
|
addressCountry
|
addressCountry | string |
País de la dirección |
|
addressCounty
|
addressCounty | string |
Condado de la dirección |
|
dateOfBirth
|
dateOfBirth | string |
Fecha de nacimiento |
|
gender
|
gender | string |
Género del individuo |
|
ethnicIdCode
|
ethnicIdCode | string |
Código de id. étnico |
|
isSmoker
|
isSmoker | boolean |
Indica si la persona es fumadora |
|
isDisabled
|
isDisabled | string |
Estado de discapacidad |
|
mariStatusCode
|
maritalStatusCode | string |
Código de estado civil |
|
Ssn
|
ssn | string |
Número de seguro social |
|
ssnIsSuppressed
|
ssnIsSuppressed | boolean |
Indica si se suprime SSN. |
|
userID
|
userID | string |
Id. de usuario |
|
integrationRecordId
|
integrationRecordId | string |
Identificador de registro de integración |
|
cellPhoneNumber
|
cellPhoneNumber | string |
Número de teléfono celular |
returnsAListOfDetailsForAGeneralLedgerRun
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
runId
|
runId | string |
Identificador único de la ejecución |
|
payPeriodEndDate
|
payPeriodEndDate | string |
Fecha de finalización del período de pago |
|
AccountType
|
accountType | string |
Tipo de cuenta |
|
baseSegment
|
baseSegment | string |
Identificador de segmento base |
|
companyCode
|
companyCode | string |
Código que identifica la empresa |
|
creditAmt
|
creditAmt | double |
Importe de crédito registrado |
|
debitAmt
|
debitAmt | double |
Importe de débito registrado |
|
descripción
|
description | string |
Descripción de la transacción |
|
generalLedgerAccount
|
generalLedgerAccount | string |
Número de cuenta del libro de contabilidad general |
|
jobCode
|
jobCode | string |
Código para el trabajo |
|
jobDesc
|
jobDesc | string |
Descripción del trabajo |
|
location
|
location | string |
Ubicación de la transacción |
|
orgLevel1
|
orgLevel1 | string |
Primer nivel de jerarquía organizativa |
|
orgLevel2
|
orgLevel2 | string |
Segundo nivel de jerarquía organizativa |
|
orgLevel3
|
orgLevel3 | string |
Tercer nivel de jerarquía organizativa |
|
orgLevel4
|
orgLevel4 | string |
Cuarto nivel de jerarquía organizativa |
|
payGroup
|
payGroup | string |
Identificador del grupo de nóminas |
|
periodEndDate
|
periodEndDate | string |
Fecha de finalización del período contable |
|
periodStartDate
|
periodStartDate | string |
Fecha de inicio del período contable |
|
positionCode
|
positionCode | string |
Código para la posición |
|
positionDesc
|
positionDesc | string |
Descripción de la posición |
|
project
|
project | string |
Identificador del proyecto |
|
systemId
|
systemId | double |
Número de identificación del sistema |
|
blockId
|
blockId | double |
Identificador de bloque dentro del sistema |
|
coId
|
coId | string |
Identificador de la empresa |
|
glRunDateTime
|
glRunDateTime | string |
Fecha y hora de ejecución de GL |
|
totalNrOfBlocks
|
totalNrOfBlocks | double |
Número total de bloques de la ejecución |
|
userWhoRanThisGl
|
userWhoRanThisGl | string |
Usuario que ejecutó la ejecución de GL |
|
glJson
|
glJson | string |
Datos JSON de la ejecución del libro de contabilidad general |
takesAnXmlTransactionAndFeedsItIntoTheImportTool
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
stagingId
|
stagingId | string |
Identificador del registro de almacenamiento provisional |
|
dateTimeCreated
|
dateTimeCreated | string |
Marca de tiempo cuando se creó el registro |
|
fileName
|
fileName | string |
Nombre del archivo |
employeeIdLookup
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string |
Tipo de error o estado |
|
title
|
title | string |
Título que resume el error o el estado |
|
detail
|
detail | string |
Descripción detallada del error o estado |
|
errorCount
|
errorCount | double |
Número de errores notificados |
|
multistatus
|
multistatus | array of object | |
|
sequenceId
|
multistatus.sequenceId | double |
Identificador de la secuencia en varias estadísticas |
|
estado
|
multistatus.status | string |
Estado de la operación en varias estadísticas |
|
property-name
|
multistatus.modelstate.property-name | array of object |
Lista de mensajes de error con clave por nombre de propiedad |
|
Mensaje
|
multistatus.modelstate.property-name.message | string |
Mensaje de error para la propiedad específica |
|
type
|
multistatus.modelstate.property-name.type | string |
Tipo de error para la propiedad específica |
|
eeid
|
multistatus.body.eeid | string |
Identificador de empleado |
|
coid
|
multistatus.body.coid | array of string |
Lista de identificadores de empresa; la empresa principal es la primera |
getASpecificEmployeesPtoplans
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de empleado
|
employeeId | string |
Identificador único para el empleado |
|
companyId
|
companyId | string |
Identificador de la empresa asociada al empleado |
|
ptoPlan
|
ptoPlan | string |
Identificador del plan de PTO aplicable al empleado |
|
ganado
|
earned | double |
Total de horas de PTO obtenidas por el empleado |
|
Tomado
|
taken | double |
Total de horas de PTO tomadas por el empleado |
|
pendingBalance
|
pendingBalance | double |
Saldo actual de horas de PTO pendientes |
|
earnedThroughDate
|
earnedThroughDate | string |
Última fecha a la que se ha acumulado la PTO |
|
reset
|
reset | string |
Fecha en la que se restablece el saldo de PTO |
|
pendingMoveDate
|
pendingMoveDate | string |
Fecha pertinente para las reglas de PTO pendientes |
getEmployeeSupervisorDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
employeeID
|
employeeID | string |
Identificador del empleado |
|
companyID
|
companyID | string |
Identificador de la empresa del empleado |
|
número de empleado
|
employeeNumber | string |
Número único asignado al empleado |
|
supervisorEmployeeID
|
supervisorEmployeeID | string |
Identificador del supervisor |
|
supervisorFirstName
|
supervisorFirstName | string |
Nombre del supervisor |
|
supervisorLastName
|
supervisorLastName | string |
Apellidos del supervisor |
|
supervisorEmployeeNumber
|
supervisorEmployeeNumber | string |
Número de empleado del supervisor |
|
supervisorCompanyID
|
supervisorCompanyID | string |
Identificador de empresa para el supervisor |
|
supervisorCompanyCode
|
supervisorCompanyCode | string |
Código de empresa asociado al supervisor |
|
supervisorStatusCode
|
supervisorStatusCode | string |
Código de estado que representa el estado de empleo del supervisor |
|
supervisorJobCode
|
supervisorJobCode | string |
Código de trabajo asignado al supervisor |
|
supervisorPositionCode
|
supervisorPositionCode | string |
Posición del código asignado al supervisor |
|
supervisorEmail
|
supervisorEmail | string |
Dirección de correo electrónico del supervisor |
|
supervisorWorkPhone
|
supervisorWorkPhone | string |
Número de teléfono laboral del supervisor |
|
supervisorPersonId
|
supervisorPersonId | string |
Identificador único del supervisor como persona |
getAllDetailsForAPersonAssignedToAnEmployeeAsAContact
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
city
|
city | string |
Ciudad de la dirección |
|
countryCode
|
countryCode | string |
Código de país de la dirección |
|
condado
|
county | string |
Condado de la dirección |
|
addressIsDifferentFromEmployee
|
addressIsDifferentFromEmployee | boolean |
Indica si la dirección difiere de la dirección del empleado. |
|
addressLine1
|
addressLine1 | string |
Línea de direcciones principal |
|
addressLine2
|
addressLine2 | string |
Línea de direcciones secundarias |
|
estado
|
state | string |
Estado de la dirección |
|
código postal
|
zipCode | string |
Código postal de la dirección |
|
cobraExport
|
cobraExport | boolean |
Indica si se exportan los datos de COBRA. |
|
cobraIsActive
|
cobraIsActive | boolean |
Indica si COBRA está activo. |
|
cobraReason
|
cobraReason | string |
Motivo del estado de COBRA |
|
cobraStatus
|
cobraStatus | string |
Estado actual de COBRA |
|
cobraStatusDate
|
cobraStatusDate | string |
Fecha del estado actual de COBRA |
|
dateOfBirth
|
dateOfBirth | string |
Fecha de nacimiento |
|
dateOfCOBRAEvent
|
dateOfCOBRAEvent | string |
Fecha del evento COBRA |
|
dateOfCOBRALetter
|
dateOfCOBRALetter | string |
Fecha en que se emitió la carta COBRA |
|
ID de empleado
|
employeeId | string |
Identificador del empleado |
|
gender
|
gender | string |
Género del individuo |
|
importId
|
importId | string |
Identificador de importación |
|
isBeneficiary
|
isBeneficiary | boolean |
Indica si el individuo es beneficiario |
|
isDependent
|
isDependent | boolean |
Indica si el individuo es dependiente |
|
isDisabled
|
isDisabled | boolean |
Indica si el individuo está deshabilitado |
|
isEmergencyContact
|
isEmergencyContact | boolean |
Indica si el individuo es un contacto de emergencia |
|
isSmoker
|
isSmoker | boolean |
Indica si el individuo es fumador |
|
isStudent
|
isStudent | boolean |
Indica si el individuo es un alumno. |
|
marriageDate
|
marriageDate | string |
Fecha de matrimonio |
|
firstName
|
firstName | string |
Nombre del individuo |
|
formerName
|
formerName | string |
Nombre anterior del individuo |
|
lastName
|
lastName | string |
Apellidos del individuo |
|
Nombre del medio
|
middleName | string |
Nombre intermedio de la persona |
|
nameSuffix
|
nameSuffix | string |
Sufijo del nombre del individuo |
|
ocupación
|
occupation | string |
Ocupación del individuo |
|
otherInsurance
|
otherInsurance | string |
Detalles de otros seguros |
|
homePhoneCountry
|
homePhoneCountry | string |
Código de país para teléfono doméstico |
|
homePhoneNumber
|
homePhoneNumber | string |
Número de teléfono principal |
|
otherPhoneNumber
|
otherPhoneNumber | string |
Otro número de teléfono |
|
otherPhoneType
|
otherPhoneType | string |
Tipo de otro teléfono |
|
preferredPhoneNumber
|
preferredPhoneNumber | string |
Número de teléfono preferido |
|
relationshipCode
|
relationshipCode | string |
Código que describe la relación |
|
relationshipDescription
|
relationshipDescription | string |
Descripción de la relación |
|
Ssn
|
ssn | string |
Número de seguro social |
|
contactId
|
contactId | string |
Identificador del contacto |
|
userDefinedField01
|
userDefinedField01 | string |
Campo personalizado para obtener información adicional |
|
workPhoneExtension
|
workPhoneExtension | string |
Extensión para el número de teléfono profesional |
|
workPhoneNumber
|
workPhoneNumber | string |
Número de teléfono profesional |
|
cobraNotes
|
cobraNotes | string |
Notas relacionadas con COBRA |
|
notas
|
notes | string |
Notas generales sobre el individuo |
|
isActive
|
isActive | boolean |
Indica si el registro está activo. |
|
statusAsOfDate
|
statusAsOfDate | string |
Fecha del estado actual |
|
deathDate
|
deathDate | string |
Fecha de muerte |
|
divorceDate
|
divorceDate | string |
Fecha de divorcio |
|
dirección de correo electrónico
|
emailAddress | string |
Dirección de correo electrónico |
|
otherPhoneCountryCode
|
otherPhoneCountryCode | string |
Código de país para otro teléfono |
|
healthCareId
|
healthCareId | string |
Identificador de atención médica |
|
nationalId
|
nationalId | string |
Identificador nacional |
|
nationalIdExpirationDate
|
nationalIdExpirationDate | string |
Fecha de expiración del identificador nacional |
|
personID
|
personID | string |
Identificador único de la persona |
|
addressID
|
addressID | string |
Identificador de dirección |
|
workPhoneId
|
workPhoneId | string |
Identificador del teléfono de trabajo |
|
homePhoneId
|
homePhoneId | string |
Identificador del teléfono doméstico |
|
otherPhoneId
|
otherPhoneId | string |
Identificador de otro teléfono |