Delen via


UKG Pro HCM (preview)

UKG Pro HCM Connector voor Pro HR, Payroll en Talent.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam KGS
URL https://www.ukg.com/support
E-mailen support@ukg.com
Connectormetagegevens
Uitgever Dilip Chenani
Webpagina https://www.ukg.com/
Privacybeleid https://www.ukg.com/privacy
Categorieën Personeel

UKG Pro HCM Connector vereenvoudigt de gegevensoverdracht met behulp van de UKG Pro-API en stelt u in staat uw UKG Pro-gegevens te gebruiken voor het oplossen van zakelijke toepassings- en integratiebehoeften.

Vereiste voorwaarden

  • Een bestaande UKG Pro-gebruikers met een webserviceaccount en geldige resourcemachtigingen met de juiste waarden van gebruikersnaam en gebruikers-API-sleutel. UKG Pro HCM Connector maakt gebruik van basisverificatie en vereist een unieke gebruikersnaam en gebruikers-API-sleutel.
  • UKG Pro-basisservice-URL die vergelijkbaar is met 'https://servicet.ultipro.com/services/", maar verschilt per datacenter van de klant en productie-/testomgevingen.

Referenties ophalen

UKG Pro HCM Connector, met behulp van basisverificatie, is alleen toegankelijk met een webserviceaccount. Klik hier voor informatie over het opzetten en onderhouden van een UKG Pro-serviceaccount.

Aan de slag met uw connector

  • Een detailrecord voor één persoon ophalen
  • Een detailrecord voor één persoon voor één bedrijf ophalen
  • Loonoverzicht van werknemers ophalen
  • Laatste betalingsoverzicht van werknemer ophalen
  • Werknemerswerkgegevens ophalen
  • Demografische gegevens van werknemers ophalen
  • Details ophalen voor een grootboekuitvoering
  • XML-transactie verzenden naar het importhulpprogramma
  • Opzoeken van werknemer-id
  • Een specifieke werknemers-pto-plannen krijgen
  • Details van werknemerssupervisor ophalen
  • Alle details voor een persoon ophalen die als contactpersoon aan een werknemer is toegewezen

Bekende problemen en beperkingen

Geen

Veelvoorkomende fouten en oplossingen

Neem contact met ons op via https://www.ukg.com/support

Veelgestelde vragen

Neem contact met ons op in https://www.ukg.com/support geval van fouten en vragen.

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typologie Description Verplicht
Gebruikersnaam beveiligde string De gebruikersnaam voor deze API Klopt
Api-sleutel van gebruiker beveiligde string De api-sleutel van de gebruiker voor deze API Klopt
URL voor UKG Pro-basisservice touw De basisservice-URL is vergelijkbaar met servicet.ultipro.com, maar verschilt per datacenter van de klant en productie-/testomgevingen Klopt
US-Customer-Api-Key touw Voer uw Amerikaanse klant-Api-Key in Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Alle details voor een persoon ophalen die als contactpersoon aan een werknemer is toegewezen

Haal alle details op voor een persoon die is toegewezen aan een werknemer als contactpersoon.

Demografische gegevens van werknemers ophalen

Demografische gegevens van werknemers ophalen.

Details ophalen voor een grootboekuitvoering

Retourneert een lijst met details voor een grootboekuitvoering.

Details van werknemerssupervisor ophalen

Details van werknemerssupervisor ophalen.

Een detailrecord voor één persoon ophalen

Een detailrecord voor één persoon ophalen.

Een detailrecord voor één persoon voor één bedrijf ophalen

Haal één persoonsdetailrecord op voor één bedrijf.

Een specifieke werknemers-pto-plannen krijgen

Een specifieke werknemers-pto-plannen krijgen

Laatste betalingsoverzicht van werknemer ophalen

Haal de laatste betalingsoverzicht van werknemers op op basis van de doorgegeven werknemer-id.

Loonoverzicht van werknemers ophalen

Betaaloverzicht van werknemers ophalen op basis van de doorgegeven werknemer-id.

Opzoeken van werknemer-id

Opzoeken van werknemers-id's.

Werknemerswerkgegevens ophalen

Vraag werknemerswerkgegevens op.

XML-transactie verzenden naar het importhulpprogramma

Hiermee verzendt u een gecodeerde XML-transactie naar het importhulpprogramma.

Alle details voor een persoon ophalen die als contactpersoon aan een werknemer is toegewezen

Haal alle details op voor een persoon die is toegewezen aan een werknemer als contactpersoon.

Parameters

Name Sleutel Vereist Type Description
medewerker-ID
employeeId string

Werknemer-id

isActive
isActive string

Indicator actieve status

relationshipCode
relationshipCode string

Relatiecode werknemer voor de contactpersoon

contactId
contactId string

Contactpersoon-id

landCode
countryCode string

Landcode

cobraIsActive
cobraIsActive string

Booleaanse waarde die aangeeft of de COBRA-dekking momenteel actief is.

cobraStatus
cobraStatus string

Dit is een tekenreeks die de status van de COBRA-dekking aangeeft

isBeneficiary
isBeneficiary string

Indicator van begunstigde

isDependent
isDependent string

Afhankelijke indicator

dateOfCobraEvent
dateOfCobraEvent string

Wordt gebruikt voor het vinden van datums van EEN COBRA-gebeurtenis kleiner, groter, gelijk aan of tussen doorgegeven datums.

statusAsOfDate
statusAsOfDate string

Wordt gebruikt om de contactstatus te vinden vanaf datum minder, groter, gelijk aan of tussen doorgegeven datums.

page
page integer

Paginering, welke pagina u wilt zien

per_Page
per_Page integer

Paginering, hoeveel records per pagina u wilt zien

Retouren

Demografische gegevens van werknemers ophalen

Demografische gegevens van werknemers ophalen.

Parameters

Name Sleutel Vereist Type Description
medewerker-ID
employeeId string

Werknemer-id

companyId
companyId string

Bedrijfs-id

achternaam
lastName string

Achternaam van werknemer

emailadres
emailAddress string

E-mailadres van werknemer

addressState
addressState string

Woonplaats van werknemer

addressCountry
addressCountry string

Land van woonplaats werknemer

page
page integer

Paginering, welke pagina u wilt zien

per_Page
per_Page integer

Paginering, hoeveel records per pagina u wilt zien

Retouren

Details ophalen voor een grootboekuitvoering

Retourneert een lijst met details voor een grootboekuitvoering.

Parameters

Name Sleutel Vereist Type Description
runId
runId string

Id voor de uitvoering van het grootboek

blockId
blockId string

Id voor het specifieke blok binnen de grootboekuitvoering

per_Page
per_Page integer

Filteren om de meest recente gegevens op te halen

page
page integer

Paginering, welke pagina u wilt zien

mostRecent
mostRecent string

Paginering, hoeveel records per pagina u wilt zien

Retouren

Details van werknemerssupervisor ophalen

Details van werknemerssupervisor ophalen.

Parameters

Name Sleutel Vereist Type Description
Bedrijfs-id
companyId string

Bedrijfs-id

Werknemer-id
employeeId string

Id voor het bedrijf van de werknemer

supervisorCompanyId
supervisorCompanyId string

Tekenreeks die de bedrijfs-id van de supervisor vertegenwoordigt

supervisorEmployeeId
supervisorEmployeeId string

Tekenreeks die de werknemer-id van de supervisor vertegenwoordigt

supervisorCompanyCode
supervisorCompanyCode string

Tekenreeks die de bedrijfscode van de supervisor vertegenwoordigt

page
page integer

Paginering, welke pagina u wilt zien

per_Page
per_Page integer

Paginering, hoeveel records per pagina u wilt zien

Retouren

Een detailrecord voor één persoon ophalen

Een detailrecord voor één persoon ophalen.

Parameters

Name Sleutel Vereist Type Description
Werknemer-id
employeeID True string

Identificatienummer werknemer.

Retouren

Een detailrecord voor één persoon voor één bedrijf ophalen

Haal één persoonsdetailrecord op voor één bedrijf.

Parameters

Name Sleutel Vereist Type Description
Werknemer-id
employeeID True string

Identificatienummer werknemer.

Bedrijfs-id
companyID True string

Bedrijfsidentificatienummer.

achternaam
lastName string

Achternaam van werknemer

emailadres
emailAddress string

E-mailadres van werknemer

addressState
addressState string

Woonplaats van werknemer

addressCountry
addressCountry string

Land van woonplaats werknemer

cobraIsActive
cobraIsActive string

Booleaanse waarde die aangeeft of de COBRA-dekking momenteel actief is.

cobraStatus
cobraStatus string

Dit is een tekenreeks die de status van de COBRA-dekking aangeeft.

dateOfCobraEvent
dateOfCobraEvent string

Wordt gebruikt voor het vinden van datums van EEN COBRA-gebeurtenis kleiner, groter, gelijk aan of tussen doorgegeven datums.

dateTimeCreated
dateTimeCreated string

Wordt gebruikt om de persoonsrecord te vinden die kleiner, groter, gelijk is aan of tussen doorgegeven datums.

dateTimeChanged
dateTimeChanged string

Wordt gebruikt om te zoeken of de persoonsrecord minder, groter, gelijk is aan of tussen doorgegeven datums is gewijzigd.

nationalId
nationalId string

Nationaal identificatienummer

nationalIdCountry
nationalIdCountry string

Landidentificatienummer

page
page integer

Paginanummer voor paginering

per_Page
per_Page integer

Aantal items per pagina

Retouren

Een specifieke werknemers-pto-plannen krijgen

Een specifieke werknemers-pto-plannen krijgen

Parameters

Name Sleutel Vereist Type Description
Werknemer-id
employeeID True string

Identificatienummer werknemer.

Bedrijfs-id
companyID True string

Bedrijfsidentificatienummer.

page
page integer

Paginering, welke pagina u wilt zien

per_page
per_page integer

Paginering, hoeveel records per pagina u wilt zien

Retouren

Laatste betalingsoverzicht van werknemer ophalen

Haal de laatste betalingsoverzicht van werknemers op op basis van de doorgegeven werknemer-id.

Parameters

Name Sleutel Vereist Type Description
eeid
eeid True string

Voer uw werknemers-id in.

coid
coid True string

Voer uw bedrijfs-id in.

startDate
startDate string

Voer de begindatum in.

einddatum
endDate string

Voer de einddatum in.

page
page integer

Voer het paginanummer in.

per_Page
per_Page integer

Voer per paginawaarde in.

pagesCount
pagesCount integer

Voer het aantal pagina's in.

Retouren

Loonoverzicht van werknemers ophalen

Betaaloverzicht van werknemers ophalen op basis van de doorgegeven werknemer-id.

Parameters

Name Sleutel Vereist Type Description
companyCode
companyCode string

Voer uw bedrijfscode in.

medewerkersnummer
employeeNumber string

Voer uw werknemersnummer in.

eeid
eeid string

Voer uw werknemers-id in.

coid
coid string

Voer uw bedrijfs-id in.

startDate
startDate string

Voer de begindatum in.

einddatum
endDate string

Voer de einddatum in.

page
page integer

Voer het paginanummer in.

per_Page
per_Page integer

Voer per paginawaarde in.

pagesCount
pagesCount integer

Voer het aantal pagina's in.

Retouren

Opzoeken van werknemer-id

Opzoeken van werknemers-id's.

Parameters

Name Sleutel Vereist Type Description
employeeIdentifierType
employeeIdentifierType True string

Voer het type werknemer-id in.

employeeIdentifierValue
employeeIdentifierValue True string

Waarde voor werknemer-id invoeren

companyIdentifierType
companyIdentifierType string

Voer het type bedrijfs-id in.

companyIdentiferValue
companyIdentifierValue string

Bedrijfs-id-waarde invoeren

Retouren

Werknemerswerkgegevens ophalen

Vraag werknemerswerkgegevens op.

Parameters

Name Sleutel Vereist Type Description
companyID
companyID string

Bedrijfsidentificatienummer

employeeID
employeeID string

Identificatienummer werknemer

primaryJobCode
primaryJobCode string

Code die de primaire taak van de werknemer vertegenwoordigt

functietitel
jobTitle string

Titel van de functie van de werknemer

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Code die aangeeft of de werknemer fulltime of parttime is

primaryWorkLocationCode
primaryWorkLocationCode string

Code die de primaire werklocatie van de werknemer vertegenwoordigt

primaryProjectCode
primaryProjectCode string

Code die de primaire projectgroep van de werknemer vertegenwoordigt

ductieGroupCode
deductionGroupCode string

Code voor de aftrekgroep voor de werknemer

earningGroupCode
earningGroupCode string

Code die de inkomstengroep voor de werknemer vertegenwoordigt

employeeTypeCode
employeeTypeCode string

Code die het type werknemer vertegenwoordigt

employeeStatusCode
employeeStatusCode string

Code die de status van de werknemer vertegenwoordigt

medewerkersnummer
employeeNumber string

Nummer toegewezen aan de werknemer

supervisorId
supervisorId string

Unieke id voor de supervisor van de werknemer

originalHireDate
originalHireDate string

Datum waarop de werknemer oorspronkelijk werd ingehuurd

lastHireDate
lastHireDate string

Datum van de laatste huur van de werknemer

dateOfTermination
dateOfTermination string

Datum van beëindiging van de werknemer

dateOfRetirement
dateOfRetirement string

Datum van pensioen van de werknemer

dateTimeCreated
dateTimeCreated string

Tijdstempel die aangeeft wanneer de record is gemaakt

dateTimeChanged
dateTimeChanged string

Tijdstempel die aangeeft wanneer de record voor het laatst is bijgewerkt

dateLastPayDatePaid
dateLastPayDatePaid string

Datum van de laatste betalingsdatum van de werknemer

payGroup
payGroup string

Groep die is gekoppeld aan de salarissen van de werknemer.

isHomeCompany
isHomeCompany boolean

Indicator of het bedrijf het thuisbedrijf van de werknemer is

page
page integer

Paginering, welke pagina u wilt zien

per_Page
per_Page integer

Paginering, hoeveel records per pagina u wilt zien

Retouren

XML-transactie verzenden naar het importhulpprogramma

Hiermee verzendt u een gecodeerde XML-transactie naar het importhulpprogramma.

Parameters

Name Sleutel Vereist Type Description
transactie
transaction True string

Voer gecodeerde XML-transactie in.

uniqueFileName
uniqueFileName string

Voer een unieke bestandsnaam in die eindigt op de XML-extensie.

Retouren

Definities

getASinglePersonDetailRecord

Name Pad Type Description
additionalName1
additionalName1 string

Extra naamveld 1

additionalName2
additionalName2 string

Extra naamveld 2

addressId
addressId string

Id voor het adres

addressIsOnTaxBoundary
addressIsOnTaxBoundary boolean

Geeft aan of het adres zich op een belastinggrens bevindt

addressLatitude
addressLatitude float

Breedtegraadcoördinaat van het adres

cobraExport
cobraExport string

INFORMATIE OVER DE EXPORT VAN COBRA

cobraIsActive
cobraIsActive boolean

Geeft aan of COBRA actief is voor de werknemer

cobraReason
cobraReason string

Reden voor DE STATUS VAN COBRA

cobraStatus
cobraStatus string

INFORMATIE OVER DE STATUS VAN COBRA

cobraStatusDate
cobraStatusDate string

Datum van DE STATUSupdate van COBRA

communityBroadcastSmsCode
communityBroadcastSmsCode string

Sms-code voor community-uitzending

consentElectronicW2
consentElectronicW2 boolean

Geeft toestemming voor elektronische W2-formulieren aan

consentElectronicw2pr
consentElectronicw2pr boolean

Geeft toestemming aan voor elektronische W2-formulieren (PR-specifiek)

dateDeceased
dateDeceased string

Datum van overleden

dateOfCobraEvent
dateOfCobraEvent string

Datum van COBRA-gebeurtenis

dateOfCobraExport
dateOfCobraExport string

Datum van DE EXPORT van COBRA

dateOfCobraLetter
dateOfCobraLetter string

Datum van COBRA-brief

dateOfI9Expiration
dateOfI9Expiration string

Vervaldatum van I-9-formulier

datetimeChanged
datetimeChanged string

Tijdstempel die aangeeft wanneer de gegevens voor het laatst zijn bijgewerkt

datetimeCreated
datetimeCreated string

Tijdstempel die aangeeft wanneer de gegevens zijn gemaakt

disabilityType
disabilityType string

Type beperking

ethnicDescription
ethnicDescription string

Beschrijving van etniciteit

formerName
formerName string

Voormalige naam

healthBloodType
healthBloodType string

Informatie over bloedtype

healthEyes
healthEyes string

Informatie over oogkleur

healthHair
healthHair string

Informatie over haarkleur

healthHeightFeet
healthHeightFeet string

Hoogte in voeten

healthHeightInches
healthHeightInches string

Hoogte in inch

healthLastDonateDate
healthLastDonateDate string

Datum van laatste bloeddonatie

healthWeight
healthWeight double

Gewicht in ponden

i9AlienNumber
i9AlienNumber string

Buitenaards nummer voor I-9-formulier

i9DocA
i9DocA string

Document A voor I-9-formulier

i9DocB
i9DocB string

Document B voor I-9-formulier

i9DocC
i9DocC string

Document C voor I-9 formg

i9Verified
i9Verified boolean

Geeft aan of het I-9-formulier is geverifieerd

i9VisaType
i9VisaType string

Visumtype voor I-9-formulier

i9WorkAuth
i9WorkAuth string

Werkautorisatie voor I-9-formulier

isUitgeschakeld
isDisabled boolean

Geeft aan of de persoon is uitgeschakeld

isMultiPayGroup
isMultiPayGroup boolean

Geeft aan of de persoon deel uitmaakt van meerdere betaalgroepen

isSmoker
isSmoker boolean

Geeft aan of de persoon een roker is

militaryService
militaryService boolean

Geeft de status van de militaire dienst aan

militaryBranchServed
militaryBranchServed string

Tak van militaire dienst diende

militaryEra
militaryEra string

Informatie over het militaire tijdperk

militaryIsDisabledVet
militaryIsDisabledVet string

Geeft aan of de persoon een uitgeschakeld veteraan is

militaryIsOthEligVet
militaryIsOthEligVet string

Geeft aan of de persoon een andere in aanmerking komende veteraan is

militaryIsOthEligVetBasis
militaryIsOthEligVetBasis string

Basis voor andere in aanmerking komende veteranenstatus

militaryIsActiveWartimeVet
militaryIsActiveWartimeVet string

Geeft aan of de persoon een actieve oorlogsveteraan is

nameFormer
nameFormer string

Voormalige naam

previousSSN
previousSSN string

Vorig burgerservicenummer

originCountry
originCountry string

Land van herkomst

originLocation
originLocation string

Locatie van oorsprong

w2IsDeceased
w2IsDeceased boolean

Geeft aan of de persoon is overleden voor W2-formulieren

cobraNotes
cobraNotes string

Opmerkingen met betrekking tot COBRA

addressSms
addressSms string

Adres voor sms-meldingen

militarySeparationDate
militarySeparationDate string

Datum van militaire scheiding

homePhoneIsPrivate
homePhoneIsPrivate boolean

Geeft aan of het telefoonnummer voor thuisgebruik privé is

smsApprovals
smsApprovals boolean

Geeft aan of SMS-goedkeuringen zijn ingeschakeld

smsPayNotification
smsPayNotification boolean

Geeft aan of sms-meldingen voor betalen zijn ingeschakeld

i9VisaExpirationDate
i9VisaExpirationDate string

Vervaldatum voor I-9 visum

militaryIsMedalVet
militaryIsMedalVet string

Geeft aan of de persoon een medailleveteraan is

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Geeft aan of de achternaam verschilt van de burgerservicekaart

chkCacheingInstCode
chkCashingInstCode string

De code van de instelling controleren

nationaliteit1
nationality1 string

Nationaliteitsinformatie 1

nationaliteit2
nationality2 string

Nationaliteitsinformatie 2

nationaliteit3
nationality3 string

Nationaliteitsinformatie 3

personId
personId string

Id voor de persoon

medewerker-ID
employeeId string

Id voor de werknemer

companyId
companyId string

Id voor het bedrijf

gebruikersnaam
userName string

Gebruikersnaam

voornaam
firstName string

Voornaam

tweede naam
middleName string

Middelste naam

achternaam
lastName string

Achternaam

preferredName
preferredName string

Voorkeursnaam

namePrefixCode
namePrefixCode string

Voorvoegselcode voor naam

nameSufixCode
nameSufixCode string

Achtervoegselcode voor naam

emailadres
emailAddress string

E-mailadres

emailAddressAlternate
emailAddressAlternate string

Alternatief e-mailadres

huistelefoon
homePhone string

Telefoonnummer thuis

homePhoneCountry
homePhoneCountry string

Landcode voor telefoonnummer thuis

adresLijn1
addressLine1 string

Adresregel 1

adresLijn2
addressLine2 string

Adresregel 2

addressCity
addressCity string

City

addressState
addressState string

Staat

addressZipCode
addressZipCode string

Postcode

addressCountry
addressCountry string

Country

addressCounty
addressCounty string

Country

nationalId
nationalId string

Nationale id

nationalIdCountry
nationalIdCountry string

Land voor nationale id

dateOfBirth
dateOfBirth string

Geboortedatum

gender
gender string

Geslacht

ethnicIDCode
ethnicIDCode string

Etnische id-code

maritalStatusCode
maritalStatusCode string

Burgerlijke staatscode

Ssn
ssn string

Burgerservicenummer

ssnIsSuppressed
ssnIsSuppressed boolean

Geeft aan of het burgerservicenummer wordt onderdrukt

getEmployeePayStatement

Name Pad Type Description
toerekening
accruals array of object

Lijst met toerekeningsgegevens

amountcurrent
accruals.amountcurrent double

Huidig bedrag opgebouwd

amounttype
accruals.amounttype string

Type toerekeningsbedrag

evenwicht
accruals.balance double

Huidig saldo van toerekening

plancode
accruals.plancode string

Code waarmee het plan wordt geïdentificeerd

plandescription
accruals.plandescription string

Beschrijving van het plan

adreslijn1
addressline1 string

Adresregel 1

adreslijn2
addressline2 string

Adresregel 2

city
city string

Plaats van het adres

companyaddresscity
companyaddresscity string

Plaatsadres van bedrijf

companyaddresscountry
companyaddresscountry string

Landadres van bedrijf

companyaddresscounty
companyaddresscounty string

Adres van het bedrijf

companyaddressline1
companyaddressline1 string

Adresregel 1 van het bedrijf

companyaddressline2
companyaddressline2 string

Adresregel 2 van het bedrijf

companyaddresspostalcode
companyaddresspostalcode string

Postcode van het bedrijfsadres

companyaddressstateorprovince
companyaddressstateorprovince string

Staat of provincie van het bedrijfsadres

bedrijfsnaam
companyname string

Naam van het bedrijf

bedrijfstelefoon
companyphone string

Hoofdtelefoonnummer van het bedrijf

companyphoneext
companyphoneext string

Extensie voor de bedrijfstelefoon

country
country string

Land van het adres

Aftrek
deductions array of object
basisamount
deductions.basisamount double

Basisbedrag voor aftrek

aftrekcode
deductions.deductioncode string

Code die de aftrek identificeert

aftrekdescriptie
deductions.deductiondescription string

Beschrijving van de aftrek

employeeamount
deductions.employeeamount double

Aftrekbedrag van de werknemer

employeeamountytd
deductions.employeeamountytd double

Aftrekbedrag van de werknemer voor het jaar

employeramount
deductions.employeramount double

Aftrekbedrag bijgedragen door de werkgever

werkgeveramountytd
deductions.employeramountytd double

Aftrekbedrag werkgever voor het jaar

voortax
deductions.pretax boolean

Geeft aan of de aftrek voorbelasting is

aftrekcurrent
deductionscurrent double

Totale huidige aftrek

aftreksytd
deductionsytd double

Totale aftrek voor het jaar

document
document string

Document-id of -beschrijving

winst
earnings array of object

Lijst met inkomstenrecords

aantal
earnings.amount double

Inkomstenbedrag

amountytd
earnings.amountytd double

Inkomstenbedrag voor het jaar

uren
earnings.hours double

Gewerkte uren

hoursytd
earnings.hoursytd double

Gewerkte uren voor het jaar

paycode
earnings.paycode string

Code waarmee het betalingstype wordt geïdentificeerd

paydescription
earnings.paydescription string

Beschrijving van het betalingstype

betalen
earnings.payrate double

Tarief van betaling

periodend
earnings.periodend date-time

Einddatum van de betaalperiode

periodstart
earnings.periodstart date-time

Begindatum van de betalingsperiode

stukaantal
earnings.piececount double

Aantal voltooide stukken (voor stukwerk)

stukbetalen
earnings.piecepayrate double

Tarief per stuk (voor stukwerk)

identificationtype
employeeidentifier.identificationtype string

touw

companyidentifier
employeeidentifier.companyidentifier string

touw

employeeidentifier
employeeidentifier.employeeidentifier string

touw

werknemernummer
employeenumber string

Nummer waarmee de werknemer wordt geïdentificeerd

federaladditionalamountWithheld
federaladditionalamountWithheld double

Extra federale belasting ingehouden

federalallowancesclaimed
federalallowancesclaimed double

Federale belastingvergoedingen geclaimd

federalfilingstatus
federalfilingstatus string

Status van federale belastingaangifte

federaltaxablewagescurrent
federaltaxablewagescurrent double

Huidige federale belastbare lonen

federaltaxablewagesytd
federaltaxablewagesytd double

Federale belastbare lonen voor het jaar

fullname
fullname string

Volledige naam van de werknemer

grosswagescurrent
grosswagescurrent double

Huidig brutoloon

grosswagesytd
grosswagesytd double

Brutoloon voor het jaar

job
job string

Functie of beschrijving

location
location string

Werklocatie van de werknemer

nettopay
netpay array of object

Lijst met netto-betalingsrecords

accountnummer
netpay.accountnumber string

Bankrekeningnummer

accounttype
netpay.accounttype string

Type bankrekening

aantal
netpay.amount double

Bedrag van nettobetaling

nettopaycurrent
netpaycurrent double

Huidige nettobetaling

nettopayytd
netpayytd double

Nettoloon voor het jaar

orglevel1
orglevel1 string

Eerste niveau van organisatiehiërarchie

orglevel2
orglevel2 string

Tweede niveau van organisatiehiërarchie

orglevel3
orglevel3 string

Derde niveau van organisatiehiërarchie

orglevel4
orglevel4 string

Vierde niveau van de organisatiehiërarchie

paydate
paydate string

Datum waarop de betaling is uitgegeven

payperiodfrequency
payperiodfrequency string

Frequentie van de betaalperiode

paygroup
paygroup string

Groepsclassificatie voor salarisadministratie

payidentifier
payidentifier string

Id voor het betaalexemplaren

betalen
payrate double

Tarief voor betalen

periodenddate
periodenddate string

Einddatum van de betaalperiode

periodstartdate
periodstartdate string

Begindatum van de betalingsperiode

postcode
postalcode string

Postcode voor het adres van de werknemer

residentstateallowancesclaimed
residentstateallowancesclaimed double

Belastingvergoedingen die door de ingezetene worden geclaimd

residentstatefilingstatus
residentstatefilingstatus string

Status van indieningsstatus voor de ingezetene

Ssn
ssn string

Burgerservicenummer

stateorprovince
stateorprovince string

Staat of provincie van de werknemer

Belastingen
taxes array of object

Lijst met belastingrecords

aantal
taxes.amount double

Belastingbedrag

amountytd
taxes.amountytd double

Belastingbedrag voor het jaar

basisamount
taxes.basisamount double

Basisbedrag voor belastingberekening

taxdescription
taxes.taxdescription string

Beschrijving van de belasting

belastingcode
taxes.taxcode string

Code voor het identificeren van de belasting

belastingencurrent
taxescurrent double

Totale huidige belastingen

belastingenytd
taxesytd double

Totale belastingen voor het jaar

workstateallowancesclaimed
workstateallowancesclaimed double

Door de werknemer geclaimde belastingvergoedingen

workstatefilingstatus
workstatefilingstatus string

Status van belastingaangifte van de werknemer

getEmployeeEmploymentDetails

Name Pad Type Description
companyID
companyID string

Id voor het bedrijf

employeeID
employeeID string

Id voor de werknemer

primaryJobCode
primaryJobCode string

Code die de primaire taak identificeert

functietitel
jobTitle string

Titel van de functie van de werknemer

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Code die aangeeft of de taak fulltime of parttime is

primaryWorkLocationCode
primaryWorkLocationCode string

Code voor de primaire werklocatie

primaryProjectCode
primaryProjectCode string

Code voor het primaire project dat is gekoppeld aan de werknemer

ductieGroupCode
deductionGroupCode string

Code die de aftrekgroep identificeert

earningGroupCode
earningGroupCode string

Code waarmee de inkomstengroep wordt geïdentificeerd

employeeTypeCode
employeeTypeCode string

Code voor het definiëren van het type werkgelegenheid

employeeStatusCode
employeeStatusCode string

Code die de huidige status van de werknemer vertegenwoordigt

medewerkersnummer
employeeNumber string

Uniek nummer dat is toegewezen aan de werknemer

supervisorId
supervisorId string

Id voor de supervisor van de werknemer

originalHireDate
originalHireDate string

Datum waarop de werknemer oorspronkelijk is ingehuurd

lastHireDate
lastHireDate string

Datum waarop de werknemer het laatst is ingehuurd

dateOfTermination
dateOfTermination string

Datum waarop de werknemer is beëindigd

dateOfRetirement
dateOfRetirement string

Datum waarop de werknemer buiten gebruik is gesteld

dateTimeCreated
dateTimeCreated string

Tijdstempel toen de werknemersrecord werd gemaakt

dateTimeChanged
dateTimeChanged string

Tijdstempel toen de werknemersrecord voor het laatst is gewijzigd

dateLastPayDatePaid
dateLastPayDatePaid string

Datum waarop de laatste betaling aan de werknemer is gedaan

payGroup
payGroup string

Groepsclassificatie voor salarisadministratie

isHomeCompany
isHomeCompany boolean

Geeft aan of het bedrijf het thuisbedrijf van de werknemer is

page
page integer

Paginanummer in een gepagineerd antwoord

per_Page
per_Page integer

Aantal items per pagina in een gepagineerd antwoord

getEmployeeDemographicDetails

Name Pad Type Description
ethnicDescription
ethnicDescription string

Etnische achtergrond

additionalName1
additionalName1 string

Extra naamveld 1

additionalName2
additionalName2 string

Extra naamveld 2

addressId
addressId string

Id voor het adres

addressIsOnTaxBoundary
addressIsOnTaxBoundary string

Adres op belastinggrensstatus

addressLatitude
addressLatitude double

Geografische breedtegraad van adres

disabilityType
disabilityType string

Type beperking

formerName
formerName string

Vorige naam

healthBloodType
healthBloodType string

Informatie over bloedtype

healthEyes
healthEyes string

Informatie over oogkleur

healthHair
healthHair string

Informatie over haarkleur

healthHeightFeet
healthHeightFeet string

Hoogte in voeten

healthHeightInches
healthHeightInches string

Hoogte in inch

healthLastDonateDate
healthLastDonateDate string

Datum van laatste bloeddonatie

healthWeight
healthWeight double

Gewicht in de juiste eenheden

previousSSN
previousSSN string

Vorig burgerservicenummer

originCountry
originCountry string

Land van herkomst

originLocation
originLocation string

Locatie van oorsprong

addressSms
addressSms string

Adres voor sms-meldingen

homePhoneIsPrivate
homePhoneIsPrivate boolean

Telefoonnummer thuis is privé

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Achternaam verschilt van SS-kaart

nationaliteit1
nationality1 string

Eerste nationaliteitsinformatie

nationaliteit2
nationality2 string

Tweede nationaliteitsinformatie

nationaliteit3
nationality3 string

Informatie over derde nationaliteit

personId
personId string

Id voor de persoon

medewerker-ID
employeeId string

Id voor de werknemer

companyId
companyId string

Id voor het bedrijf

voornaam
firstName string

Voornaam

tweede naam
middleName string

Middelste naam

achternaam
lastName string

Achternaam

preferredName
preferredName string

Voorkeursnaam

namePrefixCode
namePrefixCode string

Voorvoegselcode voor de naam

nameSuffixCode
nameSuffixCode string

Achtervoegselcode voor de naam

emailadres
emailAddress string

E-mailadres

emailAddressAlternate
emailAddressAlternate string

Alternatief e-mailadres

homePhoneID
homePhoneID string

Id voor de telefoon thuis

huistelefoon
homePhone string

Telefoonnummer thuis

homePhoneCountry
homePhoneCountry string

Landcode voor telefoon thuis

adresLijn1
addressLine1 string

Primaire adresregel

adresLijn2
addressLine2 string

Secundaire adresregel

adresLijn3
addressLine3 string

Tertiaire adresregel

addressLine4
addressLine4 string

Adresregel Van Denary

addressCity
addressCity string

Plaats van het adres

addressState
addressState string

Status van het adres

addressZipCode
addressZipCode string

Postcode van het adres

addressCountry
addressCountry string

Land van het adres

addressCounty
addressCounty string

Provincie van het adres

dateOfBirth
dateOfBirth string

Geboortedatum

gender
gender string

Geslacht van het individu

ethnicIdCode
ethnicIdCode string

Etnische id-code

isSmoker
isSmoker boolean

Geeft aan of de persoon een roker is

isUitgeschakeld
isDisabled string

Status van handicap

maritalStatusCode
maritalStatusCode string

Burgerlijke staatscode

Ssn
ssn string

Burgerservicenummer

ssnIsSuppressed
ssnIsSuppressed boolean

Geeft aan of SSN wordt onderdrukt

userID
userID string

Gebruikers-ID

integrationRecordId
integrationRecordId string

Integratierecord-id

cellPhoneNumber
cellPhoneNumber string

Mobiel telefoonnummer

retourneertAListOfDetailsForAGeneralLedgerRun

Name Pad Type Description
runId
runId string

Unieke id voor de uitvoering

payPeriodEndDate
payPeriodEndDate string

Einddatum van de betaalperiode

accountType
accountType string

Soort account

baseSegment
baseSegment string

Basissegment-id

companyCode
companyCode string

Code die het bedrijf identificeert

creditAmt
creditAmt double

Opgenomen tegoed

debitAmt
debitAmt double

Vastgelegd bedrag van debet

beschrijving
description string

Beschrijving van de transactie

generalLedgerAccount
generalLedgerAccount string

Grootboekaccountnummer

jobCode
jobCode string

Code voor de taak

jobDesc
jobDesc string

Beschrijving van de taak

location
location string

Locatie van de transactie

orgLevel1
orgLevel1 string

Eerste niveau van organisatiehiërarchie

orgLevel2
orgLevel2 string

Tweede niveau van organisatiehiërarchie

orgLevel3
orgLevel3 string

Derde niveau van organisatiehiërarchie

orgLevel4
orgLevel4 string

Vierde niveau van de organisatiehiërarchie

payGroup
payGroup string

Salarisgroep-id

periodEndDate
periodEndDate string

Einddatum van de boekhoudperiode

periodStartDate
periodStartDate string

Begindatum van de boekhoudperiode

positionCode
positionCode string

Code voor de positie

positionDesc
positionDesc string

Beschrijving van de positie

project
project string

Project-id

systemId
systemId double

Systeemidentificatienummer

blockId
blockId double

Id blokkeren binnen het systeem

coId
coId string

Bedrijfs-id

glRunDateTime
glRunDateTime string

Datum en tijd van GL-uitvoering

totalNrOfBlocks
totalNrOfBlocks double

Totaal aantal blokken in de uitvoering

gebruikerWhoRanThisGl
userWhoRanThisGl string

Gebruiker die de GL-uitvoering heeft uitgevoerd

glJson
glJson string

JSON-gegevens van de grootboekuitvoering

takesAnXmlTransactionAndFeedsItIntoTheImportTool

Name Pad Type Description
stagingId
stagingId string

Id voor de faseringsrecord

dateTimeCreated
dateTimeCreated string

Tijdstempel toen de record werd gemaakt

fileName
fileName string

Naam van het bestand

employeeIdLookup

Name Pad Type Description
type
type string

Type fout of status

title
title string

Titel met een samenvatting van de fout of status

detail
detail string

Gedetailleerde beschrijving van de fout of status

errorCount
errorCount double

Aantal gerapporteerde fouten

multistatus
multistatus array of object
sequenceId
multistatus.sequenceId double

Id voor de reeks in meerdere statussen

status
multistatus.status string

Status van de bewerking in multistatus

eigenschapsnaam
multistatus.modelstate.property-name array of object

Lijst met foutberichten met sleutel op eigenschapsnaam

message
multistatus.modelstate.property-name.message string

Foutbericht voor de specifieke eigenschap

type
multistatus.modelstate.property-name.type string

Type fout voor de specifieke eigenschap

eeid
multistatus.body.eeid string

Werknemer-id

coid
multistatus.body.coid array of string

Lijst met bedrijfs-id's; thuisbedrijf is eerst

getASpecificEmployeesPtoplans

Name Pad Type Description
medewerker-ID
employeeId string

Unieke id voor de werknemer

companyId
companyId string

Id voor het bedrijf dat is gekoppeld aan de werknemer

ptoPlan
ptoPlan string

Id voor het PTO-plan dat van toepassing is op de werknemer

Verdiend
earned double

Totaal aantal PTO-uren dat door de werknemer is verdiend

Genomen
taken double

Totaal aantal PTO-uren dat de werknemer heeft genomen

pendingBalance
pendingBalance double

Huidig saldo van in behandeling zijnde PTO-uren

earnedThroughDate
earnedThroughDate string

Laatste datum waarop PTO is opgebouwd

reset
reset string

Datum waarop het PTO-saldo opnieuw wordt ingesteld

pendingMoveDate
pendingMoveDate string

Datum die relevant is voor in behandeling zijnde PTO-regels

getEmployeeSupervisorDetails

Name Pad Type Description
employeeID
employeeID string

Id voor de werknemer

companyID
companyID string

Id voor het bedrijf van de werknemer

medewerkersnummer
employeeNumber string

Uniek nummer dat is toegewezen aan de werknemer

supervisorEmployeeID
supervisorEmployeeID string

Id voor de supervisor

supervisorFirstName
supervisorFirstName string

Voornaam van de supervisor

supervisorLastName
supervisorLastName string

Achternaam van de supervisor

supervisorEmployeeNumber
supervisorEmployeeNumber string

Werknemernummer van de supervisor

supervisorCompanyID
supervisorCompanyID string

Bedrijfs-id voor de supervisor

supervisorCompanyCode
supervisorCompanyCode string

Bedrijfscode die is gekoppeld aan de supervisor

supervisorStatusCode
supervisorStatusCode string

Statuscode die de arbeidsstatus van de supervisor vertegenwoordigt

supervisorJobCode
supervisorJobCode string

Taakcode die is toegewezen aan de supervisor

supervisorPositionCode
supervisorPositionCode string

Positiecode die is toegewezen aan de supervisor

supervisorEmail
supervisorEmail string

E-mailadres van de supervisor

supervisorWorkPhone
supervisorWorkPhone string

Telefoonnummer van het werk van de supervisor

supervisorPersonId
supervisorPersonId string

Unieke id voor de supervisor als persoon

getAllDetailsForAPersonAssignedToAnEmployeeAsAContact

Name Pad Type Description
city
city string

Plaats van het adres

landCode
countryCode string

Landcode van het adres

graafschap
county string

Provincie van het adres

addressIsDifferentFromEmployee
addressIsDifferentFromEmployee boolean

Geeft aan of het adres van de werknemer verschilt van het adres van de werknemer

adresLijn1
addressLine1 string

Primaire adresregel

adresLijn2
addressLine2 string

Secundaire adresregel

state
state string

Status van het adres

postcode
zipCode string

Postcode van het adres

cobraExport
cobraExport boolean

Geeft aan of DE GEGEVENS van COBRA worden geëxporteerd

cobraIsActive
cobraIsActive boolean

Geeft aan of COBRA actief is

cobraReason
cobraReason string

Reden voor DE STATUS VAN COBRA

cobraStatus
cobraStatus string

Huidige STATUS VAN COBRA

cobraStatusDate
cobraStatusDate string

Datum van de huidige STATUS VAN HET AANTAL

dateOfBirth
dateOfBirth string

Geboortedatum

dateOfCOBRAEvent
dateOfCOBRAEvent string

Datum van de COBRA-gebeurtenis

dateOfCOBRALetter
dateOfCOBRALetter string

Datum waarop de COBRA-brief is uitgegeven

medewerker-ID
employeeId string

Id voor de werknemer

gender
gender string

Geslacht van het individu

importId
importId string

Id importeren

isBeneficiary
isBeneficiary boolean

Geeft aan of de persoon een begunstigde is

isDependent
isDependent boolean

Geeft aan of de persoon afhankelijk is

isUitgeschakeld
isDisabled boolean

Geeft aan of de persoon is uitgeschakeld

isEmergencyContact
isEmergencyContact boolean

Geeft aan of de persoon een contactpersoon voor noodgevallen is

isSmoker
isSmoker boolean

Geeft aan of het individu een roker is

isStudent
isStudent boolean

Geeft aan of het individu een student is

marriageDate
marriageDate string

Datum van huwelijk

voornaam
firstName string

Voornaam van de persoon

formerName
formerName string

Voormalige naam van de persoon

achternaam
lastName string

Achternaam van de persoon

tweede naam
middleName string

Middelste naam van de persoon

nameSuffix
nameSuffix string

Achtervoegsel van de naam van het individu

beroep
occupation string

Beroep van de persoon

otherInsurance
otherInsurance string

Details van andere verzekeringen

homePhoneCountry
homePhoneCountry string

Landcode voor telefoon thuis

homePhoneNumber
homePhoneNumber string

Telefoonnummer thuis

otherPhoneNumber
otherPhoneNumber string

Ander telefoonnummer

otherPhoneType
otherPhoneType string

Type andere telefoon

preferredPhoneNumber
preferredPhoneNumber string

Voorkeurstelefoonnummer

relationshipCode
relationshipCode string

Code die de relatie beschrijft

relationshipDescription
relationshipDescription string

Beschrijving van de relatie

Ssn
ssn string

Burgerservicenummer

contactId
contactId string

Id voor de contactpersoon

userDefinedField01
userDefinedField01 string

Aangepast veld voor aanvullende informatie

workPhoneExtension
workPhoneExtension string

Verlenging voor het werktelefoonnummer

workPhoneNumber
workPhoneNumber string

Telefoonnummer werk

cobraNotes
cobraNotes string

Opmerkingen met betrekking tot COBRA

Notities
notes string

Algemene opmerkingen over de persoon

isActive
isActive boolean

Geeft aan of de record actief is

statusAsOfDate
statusAsOfDate string

Datum van de huidige status

deathDate
deathDate string

Datum van overlijden

divorceDate
divorceDate string

Datum van scheiding

emailadres
emailAddress string

E-mailadres

anderePhoneCountryCode
otherPhoneCountryCode string

Landcode voor andere telefoon

healthCareId
healthCareId string

Gezondheidszorg-id

nationalId
nationalId string

Nationale id

nationalIdExpirationDate
nationalIdExpirationDate string

Vervaldatum van nationale id

personID
personID string

Unieke id voor de persoon

addressID
addressID string

Id voor adres

workPhoneId
workPhoneId string

Id voor werktelefoon

homePhoneId
homePhoneId string

Id voor telefoon thuis

anderePhoneId
otherPhoneId string

Id voor een andere telefoon