Partager via


UKG Pro HCM (préversion)

UKG Pro HCM Connector for Pro HR, Payroll and Talent.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom KGS
URL https://www.ukg.com/support
Messagerie électronique support@ukg.com
Métadonnées du connecteur
Éditeur Dilip Chenani
Site web https://www.ukg.com/
Politique de confidentialité https://www.ukg.com/privacy
Catégories Ressources humaines

UkG Pro HCM Connector simplifie le transfert de données à l’aide de l’API UKG Pro et vous permet de tirer parti de vos données UKG Pro pour résoudre les besoins d’intégration et d’application métier.

Prerequisites

  • Utilisateurs UKG Pro existants avec un compte de service web et des autorisations de ressources valides avec les valeurs appropriées de nom d’utilisateur et de clé API utilisateur. UkG Pro HCM Connector utilise l’authentification de base et nécessite une clé API utilisateur et nom d’utilisateur unique.
  • URL du service de base UKG Pro qui sera similaire à «https://servicet.ultipro.com/services/" ; mais varie en fonction des environnements de centre de données et de production/test du client.

Comment obtenir des informations d’identification

UkG Pro HCM Connector, à l’aide de l’authentification de base, n’est accessible qu’avec un compte de service web. Pour plus d’informations sur l’établissement et la gestion d’un compte de service UKG Pro, cliquez ici.

Bien démarrer avec votre connecteur

  • Obtenir un enregistrement de détails d’une seule personne
  • Obtenir un enregistrement de détails d’une seule personne pour une seule entreprise
  • Obtenir le relevé de salaire des employés
  • Obtenir le dernier relevé de salaire de l’employé
  • Obtenir les détails de l’emploi des employés
  • Obtenir les détails démographiques des employés
  • Obtenir des détails pour une exécution de registre général
  • Envoyer une transaction XML à l’outil d’importation
  • Recherche d’ID d’employé
  • Obtenir un employé spécifique pto-plans
  • Obtenir les détails du superviseur des employés
  • Obtenir tous les détails d’une personne affectée à un employé en tant que contact

Problèmes connus et limitations

Aucun

Erreurs courantes et solutions

Contactez-nous via https://www.ukg.com/support

Questions fréquentes (FAQ)

Contactez-nous en https://www.ukg.com/support cas d’erreurs et de questions.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom Type Descriptif Obligatoire
Nom d'utilisateur securestring Nom d’utilisateur de cette API Vrai
Clé API utilisateur securestring Clé API utilisateur pour cette API Vrai
UKG Pro base service URL ficelle L’URL du service de base sera similaire à servicet.ultipro.com, mais varie en fonction des environnements de centre de données et de production/test du client. Vrai
Us-Customer-Api-Key ficelle Entrez votreApi-Key us-Customer Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Envoyer une transaction XML à l’outil d’importation

Envoie une transaction XML encodée à l’outil d’importation.

Obtenir des détails pour une exécution de registre général

Retourne la liste des détails d’une exécution de registre général.

Obtenir le dernier relevé de salaire de l’employé

Obtenez le dernier relevé de salaire de l’employé en fonction de l’identificateur d’employé transmis.

Obtenir le relevé de salaire des employés

Obtenez le relevé de salaire de l’employé en fonction de l’identificateur d’employé transmis.

Obtenir les détails de l’emploi des employés

Obtenir les détails de l’emploi des employés.

Obtenir les détails du superviseur des employés

Obtenez les détails du superviseur des employés.

Obtenir les détails démographiques des employés

Obtenez les détails démographiques des employés.

Obtenir tous les détails d’une personne affectée à un employé en tant que contact

Obtenez tous les détails d’une personne affectée à un employé en tant que contact.

Obtenir un employé spécifique pto-plans

Obtenir un employé spécifique pto-plans

Obtenir un enregistrement de détails d’une seule personne

Obtenir un enregistrement de détails d’une seule personne.

Obtenir un enregistrement de détails d’une seule personne pour une seule entreprise

Obtenez un enregistrement de détails d’une seule personne pour une seule entreprise.

Recherche d’ID d’employé

Recherche d’ID d’employé.

Envoyer une transaction XML à l’outil d’importation

Envoie une transaction XML encodée à l’outil d’importation.

Paramètres

Nom Clé Obligatoire Type Description
transaction
transaction True string

Entrez la transaction XML encodée.

uniqueFileName
uniqueFileName string

Entrez un nom de fichier unique se terminant par l’extension xml.

Retours

Obtenir des détails pour une exécution de registre général

Retourne la liste des détails d’une exécution de registre général.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant d'exécution
runId string

Identificateur de l’exécution du registre général

blockId
blockId string

Identificateur du bloc spécifique dans l’exécution du registre général

per_Page
per_Page integer

Filtrer pour récupérer les données les plus récentes

page
page integer

Pagination, page à afficher

mostRecent
mostRecent string

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir le dernier relevé de salaire de l’employé

Obtenez le dernier relevé de salaire de l’employé en fonction de l’identificateur d’employé transmis.

Paramètres

Nom Clé Obligatoire Type Description
eeid
eeid True string

Entrez votre ID d’employé.

coid
coid True string

Entrez votre ID d’entreprise.

date de début
startDate string

Entrez la date de début.

date de fin
endDate string

Entrez la date de fin.

page
page integer

Entrez le numéro de page.

per_Page
per_Page integer

Entrez la valeur par page.

pagesCount
pagesCount integer

Entrez le nombre de pages.

Retours

Obtenir le relevé de salaire des employés

Obtenez le relevé de salaire de l’employé en fonction de l’identificateur d’employé transmis.

Paramètres

Nom Clé Obligatoire Type Description
companyCode
companyCode string

Entrez votre code d’entreprise.

numéroEmployé
employeeNumber string

Entrez votre numéro d’employé.

eeid
eeid string

Entrez votre ID d’employé.

coid
coid string

Entrez votre ID d’entreprise.

date de début
startDate string

Entrez la date de début.

date de fin
endDate string

Entrez la date de fin.

page
page integer

Entrez le numéro de page.

per_Page
per_Page integer

Entrez la valeur par page.

pagesCount
pagesCount integer

Entrez le nombre de pages.

Retours

Obtenir les détails de l’emploi des employés

Obtenir les détails de l’emploi des employés.

Paramètres

Nom Clé Obligatoire Type Description
companyID
companyID string

Numéro d’identification de l’entreprise

employeeID
employeeID string

Numéro d’identification des employés

primaryJobCode
primaryJobCode string

Code représentant le travail principal de l’employé

Intitulé du poste
jobTitle string

Titre du travail de l’employé

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Code indiquant si l’employé est à temps plein ou à temps partiel

primaryWorkLocationCode
primaryWorkLocationCode string

Code représentant l’emplacement de travail principal de l’employé

primaryProjectCode
primaryProjectCode string

Code représentant le groupe de projets principal de l’employé

deductionGroupCode
deductionGroupCode string

Code représentant le groupe de déductions pour l’employé

earningGroupCode
earningGroupCode string

Code représentant le groupe de revenus de l’employé

employeeTypeCode
employeeTypeCode string

Code représentant le type d’employé

employeeStatusCode
employeeStatusCode string

Code représentant l’état de l’employé

numéroEmployé
employeeNumber string

Numéro attribué à l’employé

supervisorId
supervisorId string

Identificateur unique pour le superviseur de l’employé

originalHireDate
originalHireDate string

Date à laquelle l’employé a été embauché à l’origine

lastHireDate
lastHireDate string

Date de la dernière embauche de l’employé

dateOfTermination
dateOfTermination string

Date de l’arrêt de l’employé

dateOfRetirement
dateOfRetirement string

Date de la retraite de l’employé

dateTimeCreated
dateTimeCreated string

Horodatage indiquant quand l’enregistrement a été créé

dateTimeChanged
dateTimeChanged string

Horodatage indiquant quand l’enregistrement a été mis à jour pour la dernière fois

dateLastPayDatePaid
dateLastPayDatePaid string

Date de la dernière date de paiement de l’employé

payGroup
payGroup string

Groupe associé au salaire de l’employé.

isHomeCompany
isHomeCompany boolean

Indicateur si l’entreprise est la société à domicile de l’employé

page
page integer

Pagination, page à afficher

per_Page
per_Page integer

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir les détails du superviseur des employés

Obtenez les détails du superviseur des employés.

Paramètres

Nom Clé Obligatoire Type Description
ID de l’entreprise
companyId string

Identificateur de l’entreprise

ID de l’employé
employeeId string

Identificateur de l’entreprise de l’employé

supervisorCompanyId
supervisorCompanyId string

Chaîne qui représente l’identificateur d’entreprise du superviseur

superviseurEmployeeId
supervisorEmployeeId string

Chaîne qui représente l’identificateur de l’employé du superviseur

supervisorCompanyCode
supervisorCompanyCode string

Chaîne qui représente le code d’entreprise du superviseur

page
page integer

Pagination, page à afficher

per_Page
per_Page integer

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir les détails démographiques des employés

Obtenez les détails démographiques des employés.

Paramètres

Nom Clé Obligatoire Type Description
employeeId
employeeId string

Identificateur d’employé

companyId
companyId string

Identificateur de l’entreprise

lastName
lastName string

Nom de l’employé

adresse e-mail
emailAddress string

Adresse e-mail de l’employé

addressState
addressState string

État de résidence de l’employé

addressCountry
addressCountry string

Pays de résidence de l’employé

page
page integer

Pagination, page à afficher

per_Page
per_Page integer

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir tous les détails d’une personne affectée à un employé en tant que contact

Obtenez tous les détails d’une personne affectée à un employé en tant que contact.

Paramètres

Nom Clé Obligatoire Type Description
employeeId
employeeId string

Identificateur d’employé

isActive
isActive string

Indicateur d’état actif

relationshipCode
relationshipCode string

Code du type de relation employé au contact

contactId
contactId string

Identificateur de contact

countryCode
countryCode string

Code pays

cobraIsActive
cobraIsActive string

Champ booléen indiquant si la couverture COBRA est actuellement active.

cobraStatus
cobraStatus string

Il s’agit d’une chaîne indiquant l’état de la couverture COBRA

isBeneficiary
isBeneficiary string

Indicateur bénéficiaire

isDependent
isDependent string

Indicateur dépendant

dateOfCobraEvent
dateOfCobraEvent string

Utilisé pour rechercher la date de l’événement COBRA inférieur, supérieur, égal ou compris entre les dates passées.

statusAsOfDate
statusAsOfDate string

Permet de trouver l’état du contact à compter de la date inférieure, supérieure, égale ou comprise entre les dates passées.

page
page integer

Pagination, page à afficher

per_Page
per_Page integer

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir un employé spécifique pto-plans

Obtenir un employé spécifique pto-plans

Paramètres

Nom Clé Obligatoire Type Description
ID d’employé
employeeID True string

Numéro d’identification des employés.

ID d’entreprise
companyID True string

Numéro d’identification de l’entreprise.

page
page integer

Pagination, page à afficher

per_page
per_page integer

Pagination, nombre d’enregistrements par page à afficher

Retours

Obtenir un enregistrement de détails d’une seule personne

Obtenir un enregistrement de détails d’une seule personne.

Paramètres

Nom Clé Obligatoire Type Description
ID d’employé
employeeID True string

Numéro d’identification des employés.

Retours

Obtenir un enregistrement de détails d’une seule personne pour une seule entreprise

Obtenez un enregistrement de détails d’une seule personne pour une seule entreprise.

Paramètres

Nom Clé Obligatoire Type Description
ID d’employé
employeeID True string

Numéro d’identification des employés.

ID d’entreprise
companyID True string

Numéro d’identification de l’entreprise.

lastName
lastName string

Nom de l’employé

adresse e-mail
emailAddress string

Adresse e-mail de l’employé

addressState
addressState string

État de résidence de l’employé

addressCountry
addressCountry string

Pays de résidence de l’employé

cobraIsActive
cobraIsActive string

Champ booléen indiquant si la couverture COBRA est actuellement active.

cobraStatus
cobraStatus string

Il s’agit d’une chaîne indiquant l’état de la couverture COBRA.

dateOfCobraEvent
dateOfCobraEvent string

Utilisé pour rechercher la date de l’événement COBRA inférieur, supérieur, égal ou compris entre les dates passées.

dateTimeCreated
dateTimeCreated string

Permet de trouver un enregistrement de personne créé moins, supérieur, égal ou compris entre les dates passées.

dateTimeChanged
dateTimeChanged string

Utilisé pour rechercher un enregistrement de personne modifié moins, supérieur, égal ou compris entre les dates passées.

nationalId
nationalId string

Numéro d’identification national

nationalIdCountry
nationalIdCountry string

Numéro d’identification du pays

page
page integer

Numéro de page pour la pagination

per_Page
per_Page integer

Nombre d’éléments par page

Retours

Recherche d’ID d’employé

Recherche d’ID d’employé.

Paramètres

Nom Clé Obligatoire Type Description
employeeIdentifierType
employeeIdentifierType True string

Entrez le type d’identificateur d’employé.

employeeIdentifierValue
employeeIdentifierValue True string

Entrer la valeur de l’identificateur de l’employé

companyIdentifierType
companyIdentifierType string

Entrez le type d’identificateur d’entreprise.

companyIdentiferValue
companyIdentifierValue string

Entrer la valeur de l’identificateur de l’entreprise

Retours

Définitions

getASinglePersonDetailRecord

Nom Chemin d’accès Type Description
additionalName1
additionalName1 string

Champ de nom supplémentaire 1

additionalName2
additionalName2 string

Champ de nom supplémentaire 2

addressId
addressId string

Identificateur de l’adresse

addressIsOnTaxBoundary
addressIsOnTaxBoundary boolean

Indique si l’adresse se trouve sur une limite fiscale

addressLatitude
addressLatitude float

Coordonnée de latitude de l’adresse

cobraExport
cobraExport string

Informations d’exportation COBRA

cobraIsActive
cobraIsActive boolean

Indique si COBRA est actif pour l’employé

cobraReason
cobraReason string

Motif de l’état COBRA

cobraStatus
cobraStatus string

Informations d’état COBRA

cobraStatusDate
cobraStatusDate string

Date de la mise à jour de l’état COBRA

communityBroadcastSmsCode
communityBroadcastSmsCode string

Code SMS de diffusion de la communauté

consentElectronicW2
consentElectronicW2 boolean

Indique le consentement pour les formulaires W2 électroniques

consentElectronicw2pr
consentElectronicw2pr boolean

Indique le consentement pour les formulaires W2 électroniques (spécifiques à la demande de tirage)

dateDeceased
dateDeceased string

Date du décès

dateOfCobraEvent
dateOfCobraEvent string

Date de l’événement COBRA

dateOfCobraExport
dateOfCobraExport string

Date de l’exportation COBRA

dateOfCobraLetter
dateOfCobraLetter string

Date de la lettre COBRA

dateOfI9Expiration
dateOfI9Expiration string

Date d’expiration du formulaire I-9

datetimeChanged
datetimeChanged string

Horodatage indiquant quand les données ont été mises à jour pour la dernière fois

datetimeCreated
datetimeCreated string

Horodatage indiquant quand les données ont été créées

disabilityType
disabilityType string

Type de handicap

ethnicDescription
ethnicDescription string

Description de l’origine ethnique

ancienName
formerName string

Ancien nom

healthBloodType
healthBloodType string

Informations sur le type de sang

healthEyes
healthEyes string

Informations sur la couleur des yeux

healthHair
healthHair string

Informations sur la couleur des cheveux

healthHeightFeet
healthHeightFeet string

Hauteur en pieds

healthHeightInches
healthHeightInches string

Hauteur en pouces

healthLastDonateDate
healthLastDonateDate string

Date du dernier don de sang

healthWeight
healthWeight double

Poids en livres

i9AlienNumber
i9AlienNumber string

Numéro étranger pour le formulaire I-9

i9DocA
i9DocA string

Document A pour le formulaire I-9

i9DocB
i9DocB string

Document B pour le formulaire I-9

i9DocC
i9DocC string

Document C pour I-9 formg

i9Verified
i9Verified boolean

Indique si le formulaire I-9 est vérifié

i9VisaType
i9VisaType string

Type de visa pour le formulaire I-9

i9WorkAuth
i9WorkAuth string

Autorisation de travail pour le formulaire I-9

isDisabled
isDisabled boolean

Indique si la personne est désactivée

isMultiPayGroup
isMultiPayGroup boolean

Indique si la personne fait partie de plusieurs groupes de paiement

isSmoker
isSmoker boolean

Indique si la personne est fumeur

militaryService
militaryService boolean

Indique l’état du service militaire

militaryBranchServed
militaryBranchServed string

Branche du service militaire servi

militaryEra
militaryEra string

Informations sur l’ère militaire

militaryIsDisabledVet
militaryIsDisabledVet string

Indique si la personne est un vétéran handicapé

militaryIsOthEligVet
militaryIsOthEligVet string

Indique si la personne est un autre vétéran éligible

militaryIsOthEligVetBasis
militaryIsOthEligVetBasis string

Base pour d’autres anciens combattants admissibles

militaryIsActiveWartimeVet
militaryIsActiveWartimeVet string

Indique si la personne est un ancien combattant actif en temps de guerre

nameFormer
nameFormer string

Ancien nom

previousSSN
previousSSN string

Numéro de sécurité sociale précédent

originCountry
originCountry string

Pays d’origine

originLocation
originLocation string

Emplacement de l’origine

w2IsDeceased
w2IsDeceased boolean

Indique si la personne est décédée pour les formulaires W2

cobraNotes
cobraNotes string

Remarques relatives à COBRA

addressSms
addressSms string

Adresse pour les notifications SMS

militarySeparationDate
militarySeparationDate string

Date de séparation militaire

homePhoneIsPrivate
homePhoneIsPrivate boolean

Indique si le numéro de téléphone à domicile est privé

smsApprovals
smsApprovals boolean

Indique si les approbations SMS sont activées

smsPayNotification
smsPayNotification boolean

Indique si les notifications SMS pour paiement sont activées

i9VisaExpirationDate
i9VisaExpirationDate string

Date d’expiration du visa I-9

militaryIsMedalVet
militaryIsMedalVet string

Indique si la personne est un vétéran de la médaille

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Indique si le nom est différent de la carte de sécurité sociale

chk CashingInstCode
chkCashingInstCode string

Vérifier le code de l’établissement de caisse

nationalité1
nationality1 string

Informations sur la nationalité 1

nationalité2
nationality2 string

Informations sur la nationalité 2

nationalité3
nationality3 string

Informations sur la nationalité 3

personId
personId string

Identificateur de la personne

employeeId
employeeId string

Identificateur de l’employé

companyId
companyId string

Identificateur de l’entreprise

nom d’utilisateur
userName string

Nom d’utilisateur

firstName
firstName string

Prénom

prénom
middleName string

Deuxième prénom

lastName
lastName string

Nom

preferredName
preferredName string

Nom préféré

namePrefixCode
namePrefixCode string

Code de préfixe pour le nom

nameSufixCode
nameSufixCode string

Code de suffixe pour le nom

adresse e-mail
emailAddress string

Adresse de messagerie

emailAddressAlternate
emailAddressAlternate string

Autre adresse e-mail

HomePhone
homePhone string

Numéro de téléphone d’accueil

homePhoneCountry
homePhoneCountry string

Code de pays pour le numéro de téléphone de domicile

adresseLigne1
addressLine1 string

Ligne d’adresse 1

adresseLigne2
addressLine2 string

Ligne d’adresse 2

addressCity
addressCity string

Ville

addressState
addressState string

État

addressZipCode
addressZipCode string

Code postal

addressCountry
addressCountry string

Pays

addressCounty
addressCounty string

Pays

nationalId
nationalId string

National ID

nationalIdCountry
nationalIdCountry string

Pays pour l’ID national

dateOfBirth
dateOfBirth string

Date de naissance

gender
gender string

Gender

ethnicIDCode
ethnicIDCode string

Code d’ID ethnique

maritalStatusCode
maritalStatusCode string

Code d’état civil

Ssn
ssn string

Numéro de sécurité sociale

ssnIsSuppressed
ssnIsSuppressed boolean

Indique si le numéro de sécurité sociale est supprimé

getEmployeePayStatement

Nom Chemin d’accès Type Description
accumulations
accruals array of object

Liste des détails d’accumulation

amountcurrent
accruals.amountcurrent double

Montant actuel cumulé

amounttype
accruals.amounttype string

Type de montant cumulé

balance
accruals.balance double

Solde actuel de l’accumulation

plancode
accruals.plancode string

Code identifiant le plan

plandescription
accruals.plandescription string

Description du plan

addressline1
addressline1 string

Ligne d’adresse 1

addressline2
addressline2 string

Ligne d’adresse 2

city
city string

Ville de l’adresse

companyaddresscity
companyaddresscity string

Adresse de la ville de l’entreprise

companyaddresscountry
companyaddresscountry string

Adresse du pays de l’entreprise

companyaddresscounty
companyaddresscounty string

Adresse du comté de la société

companyaddressline1
companyaddressline1 string

Ligne d’adresse de l’entreprise 1

companyaddressline2
companyaddressline2 string

Ligne d’adresse de l’entreprise 2

companyaddresspostalcode
companyaddresspostalcode string

Code postal de l’adresse de l’entreprise

companyaddressstateorprovince
companyaddressstateorprovince string

État ou province de l’adresse de l’entreprise

companyname
companyname string

Nom de l’entreprise

companyphone
companyphone string

Numéro de téléphone principal de l’entreprise

companyphoneext
companyphoneext string

Extension pour le téléphone de l’entreprise

country
country string

Pays de l’adresse

Déductions
deductions array of object
basisamount
deductions.basisamount double

Montant de base des déductions

code de déduction
deductions.deductioncode string

Code identifiant la déduction

déductiondescription
deductions.deductiondescription string

Description de la déduction

employeeamount
deductions.employeeamount double

Montant de déduction de l’employé

employeeamountytd
deductions.employeeamountytd double

Montant de déduction de l’employé pour l’année

employeuramount
deductions.employeramount double

Montant de déduction versé par l’employeur

employeuramountytd
deductions.employeramountytd double

Montant de déduction de l’employeur pour l’année

prétaxe
deductions.pretax boolean

Indique si la déduction est antérieure à l’impôt

déductionscurrentes
deductionscurrent double

Total des déductions actuelles

déductionsytd
deductionsytd double

Déductions totales pour l’année

document
document string

Identificateur ou description du document

gain
earnings array of object

Liste des enregistrements de revenus

quantité
earnings.amount double

Montant des gains

amountytd
earnings.amountytd double

Montant des gains pour l’année

Heures
earnings.hours double

Heures travaillées

hoursytd
earnings.hoursytd double

Heures travaillées pour l’année

paycode
earnings.paycode string

Code identifiant le type de paiement

paydescription
earnings.paydescription string

Description du type de paiement

payrate
earnings.payrate double

Taux de rémunération

periodend
earnings.periodend date-time

Date de fin de la période de paiement

periodstart
earnings.periodstart date-time

Date de début de la période de paiement

nombre de morceaux
earnings.piececount double

Nombre de pièces terminées (pour les pièces)

piecepayrate
earnings.piecepayrate double

Taux de rémunération par pièce (pour les pièces)

type d’identification
employeeidentifier.identificationtype string

ficelle

companyidentifier
employeeidentifier.companyidentifier string

ficelle

employeeidentifier
employeeidentifier.employeeidentifier string

ficelle

employeenumber
employeenumber string

Numéro identifiant l’employé

federaladditionalamountWithheld
federaladditionalamountWithheld double

Taxes fédérales supplémentaires retenues

federalallowancesclaimed
federalallowancesclaimed double

Allocations fiscales fédérales revendiquées

federalfilingstatus
federalfilingstatus string

État du dépôt fiscal fédéral

federaltaxablewagescurrent
federaltaxablewagescurrent double

Salaires imposables fédéraux actuels

federaltaxablewagesytd
federaltaxablewagesytd double

Salaires imposables fédéraux pour l’année

fullname
fullname string

Nom complet de l’employé

grosswagescurrent
grosswagescurrent double

Salaires bruts actuels

grosswagesytd
grosswagesytd double

Salaires bruts pour l’année

travail
job string

Titre ou description du travail

location
location string

Emplacement professionnel de l’employé

netpay
netpay array of object

Liste des enregistrements de paiement net

accountnumber
netpay.accountnumber string

Numéro de compte bancaire

accounttype
netpay.accounttype string

Type de compte bancaire

quantité
netpay.amount double

Montant du paiement net

netpaycurrent
netpaycurrent double

Paiement net actuel

netpayytd
netpayytd double

Paiement net pour l’année

orglevel1
orglevel1 string

Premier niveau de hiérarchie organisationnelle

orglevel2
orglevel2 string

Deuxième niveau de hiérarchie organisationnelle

orglevel3
orglevel3 string

Troisième niveau de hiérarchie organisationnelle

orglevel4
orglevel4 string

Quatrième niveau de hiérarchie organisationnelle

paydate
paydate string

Date à laquelle le paiement a été émis

payperiodfrequency
payperiodfrequency string

Fréquence de la période de paiement

paygroup
paygroup string

Classification des groupes pour la paie

payidentifier
payidentifier string

Identificateur de l’instance de paiement

payrate
payrate double

Taux de rémunération

periodenddate
periodenddate string

Date de fin de la période de paiement

periodstartdate
periodstartdate string

Date de début de la période de paiement

code postal
postalcode string

Code postal pour l’adresse de l’employé

residentstateallowancesclaimed
residentstateallowancesclaimed double

Allocations fiscales d’État réclamées par le résident

residentstatefilingstatus
residentstatefilingstatus string

État de dépôt de l’état pour le résident

Ssn
ssn string

Numéro de sécurité sociale

stateorprovince
stateorprovince string

État ou province de l’employé

impôts
taxes array of object

Liste des enregistrements fiscaux

quantité
taxes.amount double

Montant de l’impôt

amountytd
taxes.amountytd double

Montant de l’impôt pour l’année

basisamount
taxes.basisamount double

Montant de base pour le calcul fiscal

taxdescription
taxes.taxdescription string

Description de la taxe

taxcode
taxes.taxcode string

Code identifiant la taxe

taxescurrent
taxescurrent double

Total des taxes actuelles

taxesytd
taxesytd double

Impôts totaux pour l’année

workstateallowancesclaimed
workstateallowancesclaimed double

Allocations fiscales d’État réclamées par l’employé

workstatefilingstatus
workstatefilingstatus string

État du statut de déclaration fiscale de l’employé

getEmployeeEmploymentDetails

Nom Chemin d’accès Type Description
companyID
companyID string

Identificateur de l’entreprise

employeeID
employeeID string

Identificateur de l’employé

primaryJobCode
primaryJobCode string

Code identifiant le travail principal

Intitulé du poste
jobTitle string

Titre du travail de l’employé

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Code indiquant si le travail est à temps plein ou à temps partiel

primaryWorkLocationCode
primaryWorkLocationCode string

Code pour l’emplacement de travail principal

primaryProjectCode
primaryProjectCode string

Code du projet principal associé à l’employé

deductionGroupCode
deductionGroupCode string

Code identifiant le groupe de déductions

earningGroupCode
earningGroupCode string

Code identifiant le groupe de revenus

employeeTypeCode
employeeTypeCode string

Code définissant le type d’emploi

employeeStatusCode
employeeStatusCode string

Code représentant l’état actuel de l’employé

numéroEmployé
employeeNumber string

Numéro unique attribué à l’employé

supervisorId
supervisorId string

Identificateur du superviseur de l’employé

originalHireDate
originalHireDate string

Date à laquelle l’employé a été embauché à l’origine

lastHireDate
lastHireDate string

Date à laquelle l’employé a été embauché le plus récemment

dateOfTermination
dateOfTermination string

Date à laquelle l’employé a été arrêté

dateOfRetirement
dateOfRetirement string

Date de mise hors service de l’employé

dateTimeCreated
dateTimeCreated string

Horodatage lors de la création de l’enregistrement de l’employé

dateTimeChanged
dateTimeChanged string

Horodatage de la dernière modification de l’enregistrement de l’employé

dateLastPayDatePaid
dateLastPayDatePaid string

Date à laquelle le dernier paiement a été effectué à l’employé

payGroup
payGroup string

Classification des groupes pour la paie

isHomeCompany
isHomeCompany boolean

Indique si l’entreprise est la société à domicile de l’employé

page
page integer

Numéro de page dans une réponse paginé

per_Page
per_Page integer

Nombre d’éléments par page dans une réponse paginé

getEmployeeDemographicDetails

Nom Chemin d’accès Type Description
ethnicDescription
ethnicDescription string

Origine ethnique

additionalName1
additionalName1 string

Champ de nom supplémentaire 1

additionalName2
additionalName2 string

Champ de nom supplémentaire 2

addressId
addressId string

Identificateur de l’adresse

addressIsOnTaxBoundary
addressIsOnTaxBoundary string

Adresse sur l’état de la limite fiscale

addressLatitude
addressLatitude double

Latitude géographique de l’adresse

disabilityType
disabilityType string

Type de handicap

ancienName
formerName string

Nom précédent

healthBloodType
healthBloodType string

Informations sur le type de sang

healthEyes
healthEyes string

Informations sur la couleur des yeux

healthHair
healthHair string

Informations sur la couleur des cheveux

healthHeightFeet
healthHeightFeet string

Hauteur en pieds

healthHeightInches
healthHeightInches string

Hauteur en pouces

healthLastDonateDate
healthLastDonateDate string

Date du dernier don de sang

healthWeight
healthWeight double

Poids en unités appropriées

previousSSN
previousSSN string

Numéro de sécurité sociale précédent

originCountry
originCountry string

Pays d’origine

originLocation
originLocation string

Emplacement de l’origine

addressSms
addressSms string

Adresse pour les notifications SMS

homePhoneIsPrivate
homePhoneIsPrivate boolean

Le numéro de téléphone personnel est privé

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Le nom diffère de la carte SS

nationalité1
nationality1 string

Informations sur la première nationalité

nationalité2
nationality2 string

Informations sur la deuxième nationalité

nationalité3
nationality3 string

Troisième information sur la nationalité

personId
personId string

Identificateur de la personne

employeeId
employeeId string

Identificateur de l’employé

companyId
companyId string

Identificateur de l’entreprise

firstName
firstName string

Prénom

prénom
middleName string

Deuxième prénom

lastName
lastName string

Nom

preferredName
preferredName string

Nom préféré

namePrefixCode
namePrefixCode string

Code de préfixe pour le nom

nameSuffixCode
nameSuffixCode string

Code de suffixe pour le nom

adresse e-mail
emailAddress string

Adresse de messagerie

emailAddressAlternate
emailAddressAlternate string

Autre adresse e-mail

homePhoneID
homePhoneID string

Identificateur du téléphone domestique

HomePhone
homePhone string

Numéro de téléphone d’accueil

homePhoneCountry
homePhoneCountry string

Code de pays pour téléphone domestique

adresseLigne1
addressLine1 string

Ligne d’adresse principale

adresseLigne2
addressLine2 string

Ligne d’adresse secondaire

adresseLigne3
addressLine3 string

Ligne d’adresse tertiaire

addressLine4
addressLine4 string

Ligne d’adresse Quaternary

addressCity
addressCity string

Ville de l’adresse

addressState
addressState string

État de l’adresse

addressZipCode
addressZipCode string

Code postal de l’adresse

addressCountry
addressCountry string

Pays de l’adresse

addressCounty
addressCounty string

Comté de l’adresse

dateOfBirth
dateOfBirth string

Date de naissance

gender
gender string

Sexe de l’individu

ethnicIdCode
ethnicIdCode string

Code d’ID ethnique

isSmoker
isSmoker boolean

Indique si la personne est fumeur

isDisabled
isDisabled string

Statut de handicap

maritalStatusCode
maritalStatusCode string

Code d’état civil

Ssn
ssn string

Numéro de sécurité sociale

ssnIsSuppressed
ssnIsSuppressed boolean

Indique si SSN est supprimé

userID
userID string

ID d’utilisateur

integrationRecordId
integrationRecordId string

Identificateur d’enregistrement d’intégration

cellPhoneNumber
cellPhoneNumber string

Numéro de téléphone cellulaire

returnsAListOfDetailsForAGeneralLedgerRun

Nom Chemin d’accès Type Description
Identifiant d'exécution
runId string

Identificateur unique de l’exécution

payPeriodEndDate
payPeriodEndDate string

Date de fin de la période de paiement

type de compte
accountType string

Type de compte

baseSegment
baseSegment string

Identificateur de segment de base

companyCode
companyCode string

Code identifiant l’entreprise

creditAmt
creditAmt double

Montant du crédit enregistré

debitAmt
debitAmt double

Débit enregistré

descriptif
description string

Description de la transaction

generalLedgerAccount
generalLedgerAccount string

Numéro de compte de registre général

jobCode
jobCode string

Code du travail

jobDesc
jobDesc string

Description du travail

location
location string

Emplacement de la transaction

orgLevel1
orgLevel1 string

Premier niveau de hiérarchie organisationnelle

orgLevel2
orgLevel2 string

Deuxième niveau de hiérarchie organisationnelle

orgLevel3
orgLevel3 string

Troisième niveau de hiérarchie organisationnelle

orgLevel4
orgLevel4 string

Quatrième niveau de hiérarchie organisationnelle

payGroup
payGroup string

Identificateur du groupe de paie

periodEndDate
periodEndDate string

Date de fin de la période comptable

periodStartDate
periodStartDate string

Date de début de la période comptable

positionCode
positionCode string

Code de la position

positionDesc
positionDesc string

Description de la position

project
project string

Identificateur de projet

systemId
systemId double

Numéro d’identification du système

blockId
blockId double

Identificateur de bloc dans le système

coId
coId string

Identificateur de l’entreprise

glRunDateTime
glRunDateTime string

Date et heure de l’exécution gl

totalNrOfBlocks
totalNrOfBlocks double

Nombre total de blocs dans l’exécution

userWhoRanThisGl
userWhoRanThisGl string

Utilisateur qui a exécuté l’exécution gl

glJson
glJson string

Données JSON de l’exécution du registre général

takesAnXmlTransactionAndFeedsItIntoTheImportTool

Nom Chemin d’accès Type Description
stagingId
stagingId string

Identificateur de l’enregistrement intermédiaire

dateTimeCreated
dateTimeCreated string

Horodatage lors de la création de l’enregistrement

fileName
fileName string

Nom du fichier

employeeIdLookup

Nom Chemin d’accès Type Description
type
type string

Type d’erreur ou d’état

title
title string

Titre récapitunant l’erreur ou l’état

detail
detail string

Description détaillée de l’erreur ou de l’état

errorCount
errorCount double

Nombre d’erreurs signalées

multistatus
multistatus array of object
sequenceId
multistatus.sequenceId double

Identificateur de la séquence dans multistatus

status
multistatus.status string

État de l’opération dans multistatus

property-name
multistatus.modelstate.property-name array of object

Liste des messages d’erreur clés par nom de propriété

Message
multistatus.modelstate.property-name.message string

Message d’erreur pour la propriété spécifique

type
multistatus.modelstate.property-name.type string

Type d’erreur pour la propriété spécifique

eeid
multistatus.body.eeid string

Identificateur de l’employé

coid
multistatus.body.coid array of string

Liste des identificateurs d’entreprise ; la société d’accueil est d’abord

getASpecificEmployeesPtoplans

Nom Chemin d’accès Type Description
employeeId
employeeId string

Identificateur unique de l’employé

companyId
companyId string

Identificateur de l’entreprise associée à l’employé

ptoPlan
ptoPlan string

Identificateur du plan PTO applicable à l’employé

gagné
earned double

Nombre total d’heures de prise en compte acquise par l’employé

pris
taken double

Nombre total d’heures de prise en charge par l’employé

pendingBalance
pendingBalance double

Solde actuel des heures PTO en attente

earnedThroughDate
earnedThroughDate string

Date de la dernière date à laquelle l’PTO a été accumulé

reset
reset string

Date à laquelle le solde PTO est réinitialisé

pendingMoveDate
pendingMoveDate string

Date pertinente pour les règles PTO en attente

getEmployeeSupervisorDetails

Nom Chemin d’accès Type Description
employeeID
employeeID string

Identificateur de l’employé

companyID
companyID string

Identificateur de l’entreprise de l’employé

numéroEmployé
employeeNumber string

Numéro unique attribué à l’employé

superviseurEmployeeID
supervisorEmployeeID string

Identificateur du superviseur

supervisorFirstName
supervisorFirstName string

Prénom du superviseur

supervisorLastName
supervisorLastName string

Nom du superviseur

supervisorEmployeeNumber
supervisorEmployeeNumber string

Numéro d’employé du superviseur

supervisorCompanyID
supervisorCompanyID string

Identificateur de l’entreprise pour le superviseur

supervisorCompanyCode
supervisorCompanyCode string

Code d’entreprise associé au superviseur

supervisorStatusCode
supervisorStatusCode string

Code d’état représentant l’état d’emploi du superviseur

supervisorJobCode
supervisorJobCode string

Code de travail affecté au superviseur

supervisorPositionCode
supervisorPositionCode string

Code de position attribué au superviseur

supervisorEmail
supervisorEmail string

Adresse e-mail du superviseur

supervisorWorkPhone
supervisorWorkPhone string

Numéro de téléphone professionnel du superviseur

supervisorPersonId
supervisorPersonId string

Identificateur unique pour le superviseur en tant que personne

getAllDetailsForAPersonAssignedToAnEmployeeAsAContact

Nom Chemin d’accès Type Description
city
city string

Ville de l’adresse

countryCode
countryCode string

Code de pays de l’adresse

comté
county string

Comté de l’adresse

addressIsDifferentFromEmployee
addressIsDifferentFromEmployee boolean

Indique si l’adresse diffère de l’adresse de l’employé

adresseLigne1
addressLine1 string

Ligne d’adresse principale

adresseLigne2
addressLine2 string

Ligne d’adresse secondaire

état
state string

État de l’adresse

zipCode
zipCode string

Code postal de l’adresse

cobraExport
cobraExport boolean

Indique si les données COBRA sont exportées

cobraIsActive
cobraIsActive boolean

Indique si COBRA est actif

cobraReason
cobraReason string

Motif de l’état COBRA

cobraStatus
cobraStatus string

État actuel de COBRA

cobraStatusDate
cobraStatusDate string

Date de l’état COBRA actuel

dateOfBirth
dateOfBirth string

Date de naissance

dateOfCOBRAEvent
dateOfCOBRAEvent string

Date de l’événement COBRA

dateOfCOBRALetter
dateOfCOBRALetter string

Date à laquelle la lettre COBRA a été émise

employeeId
employeeId string

Identificateur de l’employé

gender
gender string

Sexe de l’individu

importId
importId string

Identificateur d’importation

isBeneficiary
isBeneficiary boolean

Indique si la personne est bénéficiaire

isDependent
isDependent boolean

Indique si l’individu est dépendant

isDisabled
isDisabled boolean

Indique si l’individu est désactivé

isEmergencyContact
isEmergencyContact boolean

Indique si l’individu est un contact d’urgence

isSmoker
isSmoker boolean

Indique si l’individu est fumeur

isStudent
isStudent boolean

Indique si l’individu est un étudiant

marriageDate
marriageDate string

Date du mariage

firstName
firstName string

Prénom de l’individu

ancienName
formerName string

Ancien nom de l’individu

lastName
lastName string

Nom de la personne

prénom
middleName string

Prénom de l’individu

nameSuffix
nameSuffix string

Suffixe du nom de l’individu

occupation
occupation string

Occupation de l’individu

otherInsurance
otherInsurance string

Détails d’autres assurances

homePhoneCountry
homePhoneCountry string

Code de pays pour téléphone domestique

homePhoneNumber
homePhoneNumber string

Numéro de téléphone d’accueil

otherPhoneNumber
otherPhoneNumber string

Autre numéro de téléphone

otherPhoneType
otherPhoneType string

Type d’autre téléphone

preferredPhoneNumber
preferredPhoneNumber string

Numéro de téléphone préféré

relationshipCode
relationshipCode string

Code décrivant la relation

relationshipDescription
relationshipDescription string

Description de la relation

Ssn
ssn string

Numéro de sécurité sociale

contactId
contactId string

Identificateur du contact

userDefinedField01
userDefinedField01 string

Champ personnalisé pour obtenir des informations supplémentaires

workPhoneExtension
workPhoneExtension string

Extension du numéro de téléphone professionnel

workPhoneNumber
workPhoneNumber string

Numéro de téléphone professionnel

cobraNotes
cobraNotes string

Remarques relatives à COBRA

Remarques
notes string

Notes générales sur l’individu

isActive
isActive boolean

Indique si l’enregistrement est actif

statusAsOfDate
statusAsOfDate string

Date de l’état actuel

deathDate
deathDate string

Date de décès

divorceDate
divorceDate string

Date du divorce

adresse e-mail
emailAddress string

Adresse de messagerie

otherPhoneCountryCode
otherPhoneCountryCode string

Code de pays pour un autre téléphone

healthCareId
healthCareId string

Identificateur des soins de santé

nationalId
nationalId string

Identificateur national

nationalIdExpirationDate
nationalIdExpirationDate string

Date d’expiration de l’ID national

personID
personID string

Identificateur unique de la personne

addressID
addressID string

Identificateur de l’adresse

workPhoneId
workPhoneId string

Identificateur du téléphone professionnel

homePhoneId
homePhoneId string

Identificateur du téléphone domestique

otherPhoneId
otherPhoneId string

Identificateur d’un autre téléphone