Udostępnij przez


UKG Pro HCM (wersja zapoznawcza)

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

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name KGS
adres URL https://www.ukg.com/support
Email support@ukg.com
Metadane łącznika
Publisher Dilip Chenani
Witryna internetowa https://www.ukg.com/
Zasady ochrony prywatności https://www.ukg.com/privacy
Kategorie Zasoby ludzkie

Łącznik UKG Pro HCM upraszcza transfer danych przy użyciu interfejsu API UKG Pro i umożliwia wykorzystanie danych UKG Pro na potrzeby rozwiązywania problemów z aplikacjami biznesowymi i potrzebami integracji.

Wymagania wstępne

  • Istniejący użytkownicy UKG Pro z kontem usługi internetowej i prawidłowymi uprawnieniami zasobów z odpowiednimi wartościami nazwy użytkownika i klucza interfejsu API użytkownika. Łącznik UKG Pro HCM używa uwierzytelniania podstawowego i wymaga unikatowego klucza nazwy użytkownika i interfejsu API użytkownika.
  • Podstawowy adres URL usługi UKG Pro, który będzie podobny do "https://servicet.ultipro.com/services/", ale będzie się różnić w zależności od centrum danych klienta i środowisk produkcyjnych/testowych.

Jak uzyskać poświadczenia

Łącznik UKG Pro HCM, używając uwierzytelniania podstawowego, jest dostępny tylko za pomocą konta usługi internetowej. Aby uzyskać informacje dotyczące ustanawiania i utrzymywania konta usługi UKG Pro, kliknij tutaj.

Wprowadzenie do łącznika

  • Uzyskiwanie rekordu szczegółów pojedynczej osoby
  • Uzyskiwanie rekordu szczegółów pojedynczej osoby dla jednej firmy
  • Pobieranie zestawienia wynagrodzenia pracownika
  • Pobieranie zestawienia ostatniego wynagrodzenia pracownika
  • Pobieranie szczegółów zatrudnienia pracowników
  • Pobieranie szczegółów demograficznych pracowników
  • Uzyskiwanie szczegółowych informacji dotyczących ogólnego przebiegu rejestru
  • Przesyłanie transakcji XML do narzędzia importu
  • Wyszukiwanie identyfikatora pracownika
  • Uzyskiwanie określonych planów pto pracowników
  • Pobieranie szczegółów nadzorcy pracownika
  • Uzyskiwanie wszystkich szczegółów dotyczących osoby przypisanej do pracownika jako osoby kontaktowej

Znane problemy i ograniczenia

Żaden

Typowe błędy i środki zaradcze

Skontaktuj się z nami za pośrednictwem https://www.ukg.com/support

Często zadawane pytania

Skontaktuj się z nami za pośrednictwem adresu w https://www.ukg.com/support przypadku błędów i pytań.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: Wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Nazwa użytkownika securestring Nazwa użytkownika dla tego interfejsu API Prawda
Klucz interfejsu API użytkownika securestring Klucz interfejsu API użytkownika dla tego interfejsu API Prawda
Adres URL usługi podstawowej UKG Pro ciąg Podstawowy adres URL usługi będzie podobny do servicet.ultipro.com, ale będzie się różnić w zależności od centrum danych klienta i środowisk produkcyjnych/testowych Prawda
US-Customer —Api-Key ciąg Wprowadź swójApi-Key us-customer Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Pobieranie szczegółów demograficznych pracowników

Pobieranie szczegółów demograficznych pracowników.

Pobieranie szczegółów nadzorcy pracownika

Pobieranie szczegółów przełożonego pracownika.

Pobieranie szczegółów zatrudnienia pracowników

Pobierz szczegóły zatrudnienia pracowników.

Pobieranie zestawienia ostatniego wynagrodzenia pracownika

Pobierz zestawienie ostatniego wynagrodzenia pracownika na podstawie przekazanego identyfikatora pracownika.

Pobieranie zestawienia wynagrodzenia pracownika

Pobierz zestawienie wynagrodzenia pracownika na podstawie przekazanego identyfikatora pracownika.

Przesyłanie transakcji XML do narzędzia importu

Przesyła zakodowaną transakcję XML do narzędzia importu.

Uzyskiwanie określonych planów pto pracowników

Uzyskiwanie określonych planów pto pracowników

Uzyskiwanie rekordu szczegółów pojedynczej osoby

Uzyskiwanie rekordu szczegółów pojedynczej osoby.

Uzyskiwanie rekordu szczegółów pojedynczej osoby dla jednej firmy

Uzyskaj rekord szczegółów pojedynczej osoby dla jednej firmy.

Uzyskiwanie szczegółowych informacji dotyczących ogólnego przebiegu rejestru

Zwraca listę szczegółów dla przebiegu rejestru ogólnego.

Uzyskiwanie wszystkich szczegółów dotyczących osoby przypisanej do pracownika jako osoby kontaktowej

Pobierz wszystkie szczegóły osoby przypisanej do pracownika jako osoby kontaktowej.

Wyszukiwanie identyfikatora pracownika

Wyszukiwanie identyfikatora pracownika.

Pobieranie szczegółów demograficznych pracowników

Pobieranie szczegółów demograficznych pracowników.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator pracownika
employeeId string

Identyfikator pracownika

companyId
companyId string

Identyfikator firmy

nazwisko
lastName string

Nazwisko pracownika

adres e-mail
emailAddress string

Adres e-mail pracownika

addressState
addressState string

Stan zamieszkania pracownika

addressCountry
addressCountry string

Kraj zamieszkania pracownika

page
page integer

Stronicowanie, która strona ma być widoczna

per_Page
per_Page integer

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Pobieranie szczegółów nadzorcy pracownika

Pobieranie szczegółów przełożonego pracownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator firmy
companyId string

Identyfikator firmy

Identyfikator pracownika
employeeId string

Identyfikator firmy pracownika

supervisorCompanyId
supervisorCompanyId string

Ciąg reprezentujący identyfikator firmy nadzorcy

supervisorEmployeeId
supervisorEmployeeId string

Ciąg reprezentujący identyfikator pracownika nadzorcy

supervisorCompanyCode
supervisorCompanyCode string

Ciąg reprezentujący kod firmy nadzorcy

page
page integer

Stronicowanie, która strona ma być widoczna

per_Page
per_Page integer

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Pobieranie szczegółów zatrudnienia pracowników

Pobierz szczegóły zatrudnienia pracowników.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator firmy
companyID string

Numer identyfikacyjny firmy

identyfikator pracownika
employeeID string

Numer identyfikacyjny pracownika

primaryJobCode
primaryJobCode string

Kod reprezentujący podstawową pracę pracownika

tytuł stanowiska
jobTitle string

Tytuł pracy pracownika

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Kod wskazujący, czy pracownik jest w pełnym wymiarze godzin lub w niepełnym wymiarze godzin

primaryWorkLocationCode
primaryWorkLocationCode string

Kod reprezentujący podstawową lokalizację pracy pracownika

primaryProjectCode
primaryProjectCode string

Kod reprezentujący podstawową grupę projektów pracownika

deductionGroupCode
deductionGroupCode string

Kod reprezentujący grupę potrąceń dla pracownika

earningGroupCode
earningGroupCode string

Kod reprezentujący grupę zarobków dla pracownika

employeeTypeCode
employeeTypeCode string

Kod reprezentujący typ pracownika

employeeStatusCode
employeeStatusCode string

Kod reprezentujący stan pracownika

numerPracownika
employeeNumber string

Numer przypisany do pracownika

identyfikator nadzorcy
supervisorId string

Unikatowy identyfikator nadzorcy pracownika

originalHireDate
originalHireDate string

Data, kiedy pracownik został pierwotnie zatrudniony

lastHireDate
lastHireDate string

Data ostatniego zatrudnienia pracownika

dateOfTermination
dateOfTermination string

Data zakończenia pracy pracownika

dateOfRetirement
dateOfRetirement string

Data przejścia na emeryturę pracownika

dateTimeCreated
dateTimeCreated string

Sygnatura czasowa wskazująca, kiedy rekord został utworzony

dateTimeChanged
dateTimeChanged string

Sygnatura czasowa wskazująca, kiedy rekord został ostatnio zaktualizowany

dateLastPayDatePaid
dateLastPayDatePaid string

Data ostatniej daty wynagrodzenia pracownika

payGroup
payGroup string

Grupa skojarzona z wynagrodzeniem pracownika.

isHomeCompany
isHomeCompany boolean

Wskaźnik, czy firma jest firmą domową pracownika

page
page integer

Stronicowanie, która strona ma być widoczna

per_Page
per_Page integer

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Pobieranie zestawienia ostatniego wynagrodzenia pracownika

Pobierz zestawienie ostatniego wynagrodzenia pracownika na podstawie przekazanego identyfikatora pracownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
eeid
eeid True string

Wprowadź identyfikator pracownika.

coid
coid True string

Wprowadź identyfikator firmy.

startDate
startDate string

Wprowadź datę rozpoczęcia.

data zakończenia
endDate string

Wprowadź datę zakończenia.

page
page integer

Wprowadź numer strony.

per_Page
per_Page integer

Wprowadź wartość na stronę.

pagesCount
pagesCount integer

Wprowadź liczbę stron.

Zwraca

Pobieranie zestawienia wynagrodzenia pracownika

Pobierz zestawienie wynagrodzenia pracownika na podstawie przekazanego identyfikatora pracownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
kod firmy
companyCode string

Wprowadź kod firmy.

numerPracownika
employeeNumber string

Wprowadź numer pracownika.

eeid
eeid string

Wprowadź identyfikator pracownika.

coid
coid string

Wprowadź identyfikator firmy.

startDate
startDate string

Wprowadź datę rozpoczęcia.

data zakończenia
endDate string

Wprowadź datę zakończenia.

page
page integer

Wprowadź numer strony.

per_Page
per_Page integer

Wprowadź wartość na stronę.

pagesCount
pagesCount integer

Wprowadź liczbę stron.

Zwraca

Przesyłanie transakcji XML do narzędzia importu

Przesyła zakodowaną transakcję XML do narzędzia importu.

Parametry

Nazwa Klucz Wymagane Typ Opis
transakcja
transaction True string

Wprowadź zakodowaną transakcję XML.

uniqueFileName
uniqueFileName string

Wprowadź unikatową nazwę pliku kończącą się rozszerzeniem XML.

Zwraca

Uzyskiwanie określonych planów pto pracowników

Uzyskiwanie określonych planów pto pracowników

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pracownika
employeeID True string

Numer identyfikacyjny pracownika.

Identyfikator firmy
companyID True string

Numer identyfikacyjny firmy.

page
page integer

Stronicowanie, która strona ma być widoczna

per_page
per_page integer

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Uzyskiwanie rekordu szczegółów pojedynczej osoby

Uzyskiwanie rekordu szczegółów pojedynczej osoby.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pracownika
employeeID True string

Numer identyfikacyjny pracownika.

Zwraca

Uzyskiwanie rekordu szczegółów pojedynczej osoby dla jednej firmy

Uzyskaj rekord szczegółów pojedynczej osoby dla jednej firmy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pracownika
employeeID True string

Numer identyfikacyjny pracownika.

Identyfikator firmy
companyID True string

Numer identyfikacyjny firmy.

nazwisko
lastName string

Nazwisko pracownika

adres e-mail
emailAddress string

Adres e-mail pracownika

addressState
addressState string

Stan zamieszkania pracownika

addressCountry
addressCountry string

Kraj zamieszkania pracownika

cobraIsActive
cobraIsActive string

Pole logiczne wskazujące, czy pokrycie COBRA jest obecnie aktywne.

cobraStatus
cobraStatus string

Jest to ciąg wskazujący stan pokrycia COBRA.

dateOfCobraEvent
dateOfCobraEvent string

Służy do znajdowania daty zdarzenia COBRA mniejszej, większej, równej lub między przekazanymi datami.

dateTimeCreated
dateTimeCreated string

Służy do znajdowania rekordu osoby utworzonego mniej, większego, równego lub między przekazanymi datami.

dateTimeChanged
dateTimeChanged string

Służy do znajdowania rekordu osoby zmieniono mniej,większe,równe lub między przekazanymi datami.

nationalId
nationalId string

Krajowy numer identyfikacyjny

nationalIdCountry
nationalIdCountry string

Numer identyfikacyjny kraju

page
page integer

Numer strony na potrzeby stronicowania

per_Page
per_Page integer

Liczba elementów na stronę

Zwraca

Uzyskiwanie szczegółowych informacji dotyczących ogólnego przebiegu rejestru

Zwraca listę szczegółów dla przebiegu rejestru ogólnego.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator uruchomienia
runId string

Identyfikator ogólnego przebiegu rejestru

blockId
blockId string

Identyfikator określonego bloku w ramach przebiegu rejestru ogólnego

per_Page
per_Page integer

Filtruj, aby pobrać najnowsze dane

page
page integer

Stronicowanie, która strona ma być widoczna

mostRecent
mostRecent string

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Uzyskiwanie wszystkich szczegółów dotyczących osoby przypisanej do pracownika jako osoby kontaktowej

Pobierz wszystkie szczegóły osoby przypisanej do pracownika jako osoby kontaktowej.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator pracownika
employeeId string

Identyfikator pracownika

isActive
isActive string

Aktywny wskaźnik stanu

relationshipCode
relationshipCode string

Kod typu relacji pracownika do kontaktu

contactId
contactId string

Identyfikator kontaktu

Kod kraju
countryCode string

Kod kraju

cobraIsActive
cobraIsActive string

Pole logiczne wskazujące, czy pokrycie COBRA jest obecnie aktywne.

cobraStatus
cobraStatus string

Jest to ciąg wskazujący stan pokrycia COBRA

isBeneficiary
isBeneficiary string

Wskaźnik beneficjenta

isDependent
isDependent string

Wskaźnik zależny

dateOfCobraEvent
dateOfCobraEvent string

Służy do znajdowania daty zdarzenia COBRA mniejszej, większej, równej lub między przekazanymi datami.

statusAsOfDate
statusAsOfDate string

Służy do znajdowania stanu kontaktu od daty mniejszej, większej, równej lub między przekazanymi datami.

page
page integer

Stronicowanie, która strona ma być widoczna

per_Page
per_Page integer

Stronicowanie, ile rekordów na stronę chcesz zobaczyć

Zwraca

Wyszukiwanie identyfikatora pracownika

Wyszukiwanie identyfikatora pracownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
employeeIdentifierType
employeeIdentifierType True string

Wprowadź typ identyfikatora pracownika.

employeeIdentifierValue
employeeIdentifierValue True string

Wprowadź wartość identyfikatora pracownika

companyIdentifierType
companyIdentifierType string

Wprowadź typ identyfikatora firmy.

companyIdentiferValue
companyIdentifierValue string

Wprowadź wartość identyfikatora firmy

Zwraca

Definicje

getASinglePersonDetailRecord

Nazwa Ścieżka Typ Opis
additionalName1
additionalName1 string

Dodatkowe pole nazwy 1

additionalName2
additionalName2 string

Dodatkowe pole nazwy 2

addressId
addressId string

Identyfikator adresu

addressIsOnTaxBoundary
addressIsOnTaxBoundary boolean

Wskazuje, czy adres znajduje się na granicy podatkowej

addressLatitude
addressLatitude float

Współrzędna szerokości geograficznej adresu

cobraExport
cobraExport string

Informacje o eksportowaniu COBRA

cobraIsActive
cobraIsActive boolean

Wskazuje, czy funkcja COBRA jest aktywna dla pracownika

cobraReason
cobraReason string

Przyczyna stanu COBRA

cobraStatus
cobraStatus string

Informacje o stanie COBRA

cobraStatusDate
cobraStatusDate string

Data aktualizacji stanu COBRA

communityBroadcastSmsCode
communityBroadcastSmsCode string

Kod WIADOMOŚCI SMS rozgłaszanych przez społeczność

consentElektronicW2
consentElectronicW2 boolean

Wskazuje zgodę na elektroniczne formularze W2

consentElektronicw2pr
consentElectronicw2pr boolean

Wskazuje zgodę na elektroniczne formularze W2 (specyficzne dla żądania ściągnięcia)

dateDeceased
dateDeceased string

Data zmarłego

dateOfCobraEvent
dateOfCobraEvent string

Data zdarzenia COBRA

dateOfCobraExport
dateOfCobraExport string

Data eksportu COBRA

dateOfCobraLetter
dateOfCobraLetter string

Data litery COBRA

dateOfI9Expiration
dateOfI9Expiration string

Data wygaśnięcia formularza I-9

datetimeChanged
datetimeChanged string

Sygnatura czasowa wskazująca, kiedy dane zostały ostatnio zaktualizowane

data/godzinaTworzenie
datetimeCreated string

Sygnatura czasowa wskazująca, kiedy dane zostały utworzone

niepełnosprawnośćTyp
disabilityType string

Rodzaj niepełnosprawności

ethnicDescription
ethnicDescription string

Opis pochodzenia etnicznego

formerName
formerName string

Była nazwa

healthBloodType
healthBloodType string

Informacje o typie krwi

healthEyes
healthEyes string

Informacje o kolorze oczu

healthHair
healthHair string

Informacje o kolorze włosów

healthHeightFeet
healthHeightFeet string

Wysokość w stopach

healthHeight
healthHeightInches string

Wysokość w calach

healthLastDonateDateDate
healthLastDonateDate string

Data ostatniego dawstwa krwi

healthWeight
healthWeight double

Waga w funtach

i9AlienNumber
i9AlienNumber string

Numer obcy dla formularza I-9

i9DocA
i9DocA string

Dokument A dla I-9 formularza

i9DocB
i9DocB string

Dokument B dla formularza I-9

i9DocC
i9DocC string

Dokument C dla formularzy I-9

i9Verified
i9Verified boolean

Wskazuje, czy formularz I-9 został zweryfikowany

i9VisaType
i9VisaType string

Typ wizy dla formularza I-9

i9WorkAuth
i9WorkAuth string

Autoryzacja służbowa dla formularza I-9

isDisabled (Wyłączone)
isDisabled boolean

Wskazuje, czy osoba jest wyłączona

isMultiPayGroup
isMultiPayGroup boolean

Wskazuje, czy dana osoba jest częścią wielu grup płac

isSmoker
isSmoker boolean

Wskazuje, czy osoba jest palaczem

militaryService
militaryService boolean

Wskazuje stan służby wojskowej

militaryBranchServed
militaryBranchServed string

Oddział służby wojskowej służył

militaryEra
militaryEra string

Informacje o czasach wojskowych

militaryIsDisabledVet
militaryIsDisabledVet string

Wskazuje, czy osoba jest niepełnosprawnym weteranem

militaryIsOthEligVet
militaryIsOthEligVet string

Wskazuje, czy dana osoba jest innym uprawnionym weteranem

militaryIsOthEligVetBasis
militaryIsOthEligVetBasis string

Podstawa dla innego kwalifikującego się statusu weterana

militaryIsActiveWartimeVet
militaryIsActiveWartimeVet string

Wskazuje, czy dana osoba jest aktywnym weteranem wojennym

nameFormer
nameFormer string

Była nazwa

previousSSN
previousSSN string

Poprzedni numer ubezpieczenia społecznego

originCountry
originCountry string

Kraj pochodzenia

originLocation
originLocation string

Lokalizacja źródła

w2IsDeceased
w2IsDeceased boolean

Wskazuje, czy osoba nie żyje w formularzach W2

cobraNotes
cobraNotes string

Uwagi związane z COBRA

addressSms
addressSms string

Adres powiadomień SMS

militarySeparationDate
militarySeparationDate string

Data separacji wojskowej

homePhoneIsPrivate
homePhoneIsPrivate boolean

Wskazuje, czy numer telefonu domowego jest prywatny

smsApprovals
smsApprovals boolean

Wskazuje, czy włączono zatwierdzenia wiadomości SMS

smsPayNotification
smsPayNotification boolean

Wskazuje, czy powiadomienia SMS dotyczące płatności są włączone

i9VisaExpirationDate
i9VisaExpirationDate string

Data wygaśnięcia wizy I-9

militaryIsMedalVet
militaryIsMedalVet string

Wskazuje, czy osoba jest weteranem medalu

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Wskazuje, czy nazwisko różni się od karty ubezpieczenia społecznego

chkCashingInstCode
chkCashingInstCode string

Sprawdzanie kodu instytucji gotówkowej

narodowość1
nationality1 string

Informacje o narodowości 1

narodowość 2
nationality2 string

Informacje o narodowości 2

narodowość3
nationality3 string

Informacje o narodowości 3

personId
personId string

Identyfikator osoby

identyfikator pracownika
employeeId string

Identyfikator pracownika

companyId
companyId string

Identyfikator firmy

userName
userName string

Nazwa użytkownika

imię
firstName string

Imię

drugie imię
middleName string

Drugie imię

nazwisko
lastName string

Nazwisko

preferredName
preferredName string

Preferowana nazwa

namePrefixCode
namePrefixCode string

Kod prefiksu dla nazwy

nameSufixCode
nameSufixCode string

Kod sufiksu dla nazwy

adres e-mail
emailAddress string

Adres e-mail

emailAddressAlternate
emailAddressAlternate string

Alternatywny adres e-mail

telefonDomowy
homePhone string

Numer telefonu domowego

homePhoneCountry
homePhoneCountry string

Kod kraju dla numeru telefonu domowego

Wiersz adresu1
addressLine1 string

Wiersz adresu 1

Wiersz adresu2
addressLine2 string

Wiersz adresu 2

addressCity
addressCity string

Miejscowość

addressState
addressState string

State

addressZipCode
addressZipCode string

Kod pocztowy

addressCountry
addressCountry string

Country

addressCounty
addressCounty string

Country

nationalId
nationalId string

Identyfikator krajowy

nationalIdCountry
nationalIdCountry string

Kraj dla identyfikatora narodowego

dateOfBirth
dateOfBirth string

Data urodzenia

gender
gender string

Gender

ethnicIDCode
ethnicIDCode string

Kod identyfikatora etnicznego

maritalStatusCode
maritalStatusCode string

Kod stanu cywilnego

Ssn
ssn string

Numer ubezpieczenia społecznego

ssnIsSuppressed
ssnIsSuppressed boolean

Wskazuje, czy numer ubezpieczenia społecznego jest pomijany

getEmployeePayStatement

Nazwa Ścieżka Typ Opis
Naliczenia
accruals array of object

Lista szczegółów naliczania

amountcurrent
accruals.amountcurrent double

Bieżąca kwota naliczona

amounttype
accruals.amounttype string

Typ kwoty naliczania

saldo
accruals.balance double

Bieżące saldo naliczania

plancode
accruals.plancode string

Kod identyfikujący plan

plandescription
accruals.plandescription string

Opis planu

addressline1
addressline1 string

Wiersz adresu 1

addressline2
addressline2 string

Wiersz adresu 2

city
city string

Miasto, w którym znajduje się adres

companyaddresscity
companyaddresscity string

Adres miasta firmy

companyaddresscountry
companyaddresscountry string

Adres kraju firmy

companyaddresscounty
companyaddresscounty string

Adres powiatu firmy

companyaddressline1
companyaddressline1 string

Wiersz adresu 1 firmy

companyaddressline2
companyaddressline2 string

Wiersz adresu 2 firmy

companyaddresspostalcode
companyaddresspostalcode string

Kod pocztowy adresu firmy

companyaddressstateorprovince
companyaddressstateorprovince string

Województwo lub województwo firmy

nazwa firmy
companyname string

Nazwa firmy

telefon firmowy
companyphone string

Główny numer telefonu firmy

companyphoneext
companyphoneext string

Rozszerzenie dla telefonu firmowego

country
country string

Kraj adresu

Potrącenia
deductions array of object
basisamount
deductions.basisamount double

Kwota podstawy dla potrąceń

kod odliczenia
deductions.deductioncode string

Kod identyfikujący odliczenie

dekrypcja potrąceń
deductions.deductiondescription string

Opis odliczenia

employeeamount
deductions.employeeamount double

Kwota potrącenia od pracownika

employeeamountytd
deductions.employeeamountytd double

Kwota potrącenia od pracownika na rok

pracodawcamount
deductions.employeramount double

Kwota potrącenia wniesiona przez pracodawcę

pracodawcamountytd
deductions.employeramountytd double

Kwota potrącenia pracodawcy za rok

pretax
deductions.pretax boolean

Wskazuje, czy odliczenie jest przed opodatkowaniem

odliczeniabieżne
deductionscurrent double

Łączne bieżące odliczenia

potrącenia
deductionsytd double

Łączne odliczenia dla roku

dokument
document string

Identyfikator lub opis dokumentu

zarobek
earnings array of object

Lista rekordów zarobków

kwota
earnings.amount double

Kwota zarobków

amountytd
earnings.amountytd double

Kwota zarobków za rok

Godzin
earnings.hours double

Godziny pracy

godz.
earnings.hoursytd double

Godziny pracy przez rok

paycode
earnings.paycode string

Kod identyfikujący typ płatności

paydescription
earnings.paydescription string

Opis typu płatności

payrate
earnings.payrate double

Stawka wynagrodzenia

periodend
earnings.periodend date-time

Data zakończenia okresu płatności

periodstart
earnings.periodstart date-time

Data rozpoczęcia okresu płatności

elementcount
earnings.piececount double

Liczba wykonanych elementów (w przypadku elementów)

piecepayrate
earnings.piecepayrate double

Stawka za sztukę (za sztukę)

typ identyfikacji
employeeidentifier.identificationtype string

ciąg

companyidentifier
employeeidentifier.companyidentifier string

ciąg

employeeidentifier
employeeidentifier.employeeidentifier string

ciąg

numer pracownika
employeenumber string

Numer identyfikujący pracownika

federaladditionalamountWithheld
federaladditionalamountWithheld double

Dodatkowy federalny podatek wstrzymany

federalallowancesclaimed
federalallowancesclaimed double

Federalne ulgi podatkowe twierdziły

federalfilingstatus
federalfilingstatus string

Federalny stan zgłoszenia podatkowego

federaltaxablewagescurrent
federaltaxablewagescurrent double

Obecne federalne płace podlegające opodatkowaniu

federaltaxablewagesytd
federaltaxablewagesytd double

Federalne płace podlegające opodatkowaniu za rok

pełna nazwa
fullname string

Imię i nazwisko pracownika

grosswagescurrent
grosswagescurrent double

Bieżące płace brutto

grosswagesytd
grosswagesytd double

Płace brutto za rok

zadanie
job string

Stanowisko lub opis

lokalizacja
location string

Lokalizacja pracy pracownika

netpay
netpay array of object

Lista rekordów płatności netto

accountnumber
netpay.accountnumber string

Numer konta bankowego

typ konta
netpay.accounttype string

Typ konta bankowego

kwota
netpay.amount double

Kwota płatności netto

netpaycurrent
netpaycurrent double

Bieżąca płatność netto

netpayytd
netpayytd double

Płaca netto za rok

orglevel1
orglevel1 string

Pierwszy poziom hierarchii organizacyjnej

orglevel2
orglevel2 string

Drugi poziom hierarchii organizacyjnej

orglevel3
orglevel3 string

Trzeci poziom hierarchii organizacyjnej

orglevel4
orglevel4 string

Czwarty poziom hierarchii organizacyjnej

paydate
paydate string

Data wystawienia płatności

payperiodfrequency
payperiodfrequency string

Częstotliwość okresu płatności

paygroup
paygroup string

Klasyfikacja grup dla listy płac

payidentifier
payidentifier string

Identyfikator wystąpienia płatności

payrate
payrate double

Stawka płatności

periodenddate
periodenddate string

Data zakończenia okresu płatności

periodstartdate
periodstartdate string

Data rozpoczęcia okresu płatności

kod pocztowy
postalcode string

Kod pocztowy adresu pracownika

residentstateallowancesclaimed
residentstateallowancesclaimed double

Państwowa ulga podatkowa żądana przez rezydenta

residentstatefilingstatus
residentstatefilingstatus string

Stan zgłoszenia stanu dla rezydenta

Ssn
ssn string

Numer ubezpieczenia społecznego

stateorprovince
stateorprovince string

Stan lub prowincja pracownika

Podatków
taxes array of object

Lista rejestrów podatkowych

kwota
taxes.amount double

Kwota podatku

amountytd
taxes.amountytd double

Kwota podatku dla roku

basisamount
taxes.basisamount double

Kwota podstawy do obliczenia podatku

taxdescription (opis podatkowy)
taxes.taxdescription string

Opis podatku

kod podatkowy
taxes.taxcode string

Kod identyfikujący podatek

podatkicurrent
taxescurrent double

Łączna bieżąca liczba podatków

taxesytd
taxesytd double

Łączne podatki dla roku

workstateallowancesclaimed
workstateallowancesclaimed double

Państwowa ulga podatkowa żądana przez pracownika

workstatefilingstatus
workstatefilingstatus string

Stan zgłoszenia podatkowego pracownika

getEmployeeEmploymentDetails

Nazwa Ścieżka Typ Opis
identyfikator firmy
companyID string

Identyfikator firmy

identyfikator pracownika
employeeID string

Identyfikator pracownika

primaryJobCode
primaryJobCode string

Kod identyfikujący zadanie podstawowe

tytuł stanowiska
jobTitle string

Tytuł pracy pracownika

fullTimeOrPartTimeCode
fullTimeOrPartTimeCode string

Kod wskazujący, czy zadanie jest w pełnym wymiarze godzin lub w niepełnym wymiarze godzin

primaryWorkLocationCode
primaryWorkLocationCode string

Kod podstawowej lokalizacji pracy

primaryProjectCode
primaryProjectCode string

Kod projektu podstawowego skojarzonego z pracownikiem

deductionGroupCode
deductionGroupCode string

Kod identyfikujący grupę potrąceń

earningGroupCode
earningGroupCode string

Kod identyfikujący grupę zarobków

employeeTypeCode
employeeTypeCode string

Kod definiujący typ zatrudnienia

employeeStatusCode
employeeStatusCode string

Kod reprezentujący bieżący stan pracownika

numerPracownika
employeeNumber string

Unikatowy numer przypisany do pracownika

identyfikator nadzorcy
supervisorId string

Identyfikator nadzorcy pracownika

originalHireDate
originalHireDate string

Data, w których pracownik został pierwotnie zatrudniony

lastHireDate
lastHireDate string

Data ostatniego zatrudnienia pracownika

dateOfTermination
dateOfTermination string

Data zakończenia pracy pracownika

dateOfRetirement
dateOfRetirement string

Data wycofania pracownika

dateTimeCreated
dateTimeCreated string

Sygnatura czasowa utworzenia rekordu pracownika

dateTimeChanged
dateTimeChanged string

Sygnatura czasowa ostatniej modyfikacji rekordu pracownika

dateLastPayDatePaid
dateLastPayDatePaid string

Data dokonania ostatniej płatności dla pracownika

payGroup
payGroup string

Klasyfikacja grup dla listy płac

isHomeCompany
isHomeCompany boolean

Wskazuje, czy firma jest firmą domową pracownika

page
page integer

Numer strony w odpowiedzi podzielonej na strony

per_Page
per_Page integer

Liczba elementów na stronę w odpowiedzi podzielonej na strony

getEmployeeDemographicDetails

Nazwa Ścieżka Typ Opis
ethnicDescription
ethnicDescription string

Pochodzenie etniczne

additionalName1
additionalName1 string

Dodatkowe pole nazwy 1

additionalName2
additionalName2 string

Dodatkowe pole nazwy 2

addressId
addressId string

Identyfikator adresu

addressIsOnTaxBoundary
addressIsOnTaxBoundary string

Adres dotyczący stanu granicy podatkowej

addressLatitude
addressLatitude double

Geograficzna szerokość geograficzna adresu

niepełnosprawnośćTyp
disabilityType string

Rodzaj niepełnosprawności

formerName
formerName string

Poprzednia nazwa

healthBloodType
healthBloodType string

Informacje o typie krwi

healthEyes
healthEyes string

Informacje o kolorze oczu

healthHair
healthHair string

Informacje o kolorze włosów

healthHeightFeet
healthHeightFeet string

Wysokość w stopach

healthHeight
healthHeightInches string

Wysokość w calach

healthLastDonateDateDate
healthLastDonateDate string

Data ostatniego oddawania krwi

healthWeight
healthWeight double

Waga w odpowiednich jednostkach

previousSSN
previousSSN string

Poprzedni numer ubezpieczenia społecznego

originCountry
originCountry string

Kraj pochodzenia

originLocation
originLocation string

Lokalizacja źródła

addressSms
addressSms string

Adres powiadomień SMS

homePhoneIsPrivate
homePhoneIsPrivate boolean

Numer telefonu domowego jest prywatny

lastNameNotSameAsSSCard
lastNameNotSameAsSSCard string

Nazwisko różni się od karty SS

narodowość1
nationality1 string

Informacje o pierwszym obywatelstwie

narodowość 2
nationality2 string

Informacje o drugim obywatelstwie

narodowość3
nationality3 string

Informacje o trzecim obywatelstwie

personId
personId string

Identyfikator osoby

identyfikator pracownika
employeeId string

Identyfikator pracownika

companyId
companyId string

Identyfikator firmy

imię
firstName string

Imię

drugie imię
middleName string

Drugie imię

nazwisko
lastName string

Nazwisko

preferredName
preferredName string

Preferowana nazwa

namePrefixCode
namePrefixCode string

Kod prefiksu nazwy

nameSuffixCode
nameSuffixCode string

Kod sufiksu dla nazwy

adres e-mail
emailAddress string

Adres e-mail

emailAddressAlternate
emailAddressAlternate string

Alternatywny adres e-mail

homePhoneID
homePhoneID string

Identyfikator telefonu domowego

telefonDomowy
homePhone string

Numer telefonu domowego

homePhoneCountry
homePhoneCountry string

Kod kraju dla telefonu domowego

Wiersz adresu1
addressLine1 string

Wiersz adresu podstawowego

Wiersz adresu2
addressLine2 string

Linia adresu pomocniczego

Wiersz adresu3
addressLine3 string

Wiersz adresu tertiary

addressLine4
addressLine4 string

Linia adresu czwartoargumentowego

addressCity
addressCity string

Miasto, w którym znajduje się adres

addressState
addressState string

Stan adresu

addressZipCode
addressZipCode string

Kod pocztowy adresu

addressCountry
addressCountry string

Kraj adresu

addressCounty
addressCounty string

Hrabstwo adresu

dateOfBirth
dateOfBirth string

Data urodzenia

gender
gender string

Płeć osoby

ethnicIdCode
ethnicIdCode string

Kod identyfikatora etnicznego

isSmoker
isSmoker boolean

Wskazuje, czy osoba jest palaczem

isDisabled (Wyłączone)
isDisabled string

Stan niepełnosprawności

maritalStatusCode
maritalStatusCode string

Kod stanu cywilnego

Ssn
ssn string

Numer ubezpieczenia społecznego

ssnIsSuppressed
ssnIsSuppressed boolean

Wskazuje, czy SSN jest pomijany

identyfikator użytkownika
userID string

Identyfikator użytkownika

integrationRecordId
integrationRecordId string

Identyfikator rekordu integracji

cellPhoneNumber
cellPhoneNumber string

Numer telefonu komórkowego

returnsAListOfDetailsForAGeneralLedgerRun

Nazwa Ścieżka Typ Opis
identyfikator uruchomienia
runId string

Unikatowy identyfikator przebiegu

payPeriodEndDate
payPeriodEndDate string

Data zakończenia okresu płatności

Typ konta
accountType string

Rodzaj konta

baseSegment
baseSegment string

Identyfikator segmentu podstawowego

kod firmy
companyCode string

Kod identyfikujący firmę

creditAmt
creditAmt double

Zarejestrowana kwota środków

debitAmt
debitAmt double

Zarejestrowana kwota debetowa

opis
description string

Opis transakcji

generalLedgerAccount
generalLedgerAccount string

Ogólny numer konta rejestru

jobCode
jobCode string

Kod zadania

jobDesc
jobDesc string

Opis zadania

lokalizacja
location string

Lokalizacja transakcji

orgLevel1
orgLevel1 string

Pierwszy poziom hierarchii organizacyjnej

orgLevel2
orgLevel2 string

Drugi poziom hierarchii organizacyjnej

orgLevel3
orgLevel3 string

Trzeci poziom hierarchii organizacyjnej

orgLevel4
orgLevel4 string

Czwarty poziom hierarchii organizacyjnej

payGroup
payGroup string

Identyfikator grupy płac

periodEndDate
periodEndDate string

Data zakończenia okresu rozliczeniowego

periodStartDate
periodStartDate string

Data rozpoczęcia okresu rozliczeniowego

positionCode
positionCode string

Kod pozycji

positionDesc
positionDesc string

Opis położenia

projekt
project string

Identyfikator projektu

systemId
systemId double

Numer identyfikacyjny systemu

blockId
blockId double

Blokuj identyfikator w systemie

identyfikator coId
coId string

Identyfikator firmy

glRunDateTime
glRunDateTime string

Data i godzina uruchomienia GL

totalNrOfBlocks
totalNrOfBlocks double

Łączna liczba bloków w przebiegu

userWhoRanThisGl
userWhoRanThisGl string

Użytkownik, który wykonał przebieg GL

glJson
glJson string

Dane JSON przebiegu ogólnego rejestru

takesAnXmlTransactionAndFeedsItIntoTheImportTool

Nazwa Ścieżka Typ Opis
identyfikator przejściowy
stagingId string

Identyfikator rekordu przejściowego

dateTimeCreated
dateTimeCreated string

Sygnatura czasowa utworzenia rekordu

fileName
fileName string

Nazwa pliku

employeeIdLookup

Nazwa Ścieżka Typ Opis
typ
type string

Typ błędu lub stanu

title
title string

Tytuł podsumowujący błąd lub stan

detail
detail string

Szczegółowy opis błędu lub stanu

errorCount
errorCount double

Liczba zgłoszonych błędów

multistatus
multistatus array of object
sequenceId
multistatus.sequenceId double

Identyfikator sekwencji w wielostatucie

stan
multistatus.status string

Stan operacji w stanie wielostanowym

nazwa-właściwości
multistatus.modelstate.property-name array of object

Lista komunikatów o błędach kluczowanych według nazwy właściwości

komunikat
multistatus.modelstate.property-name.message string

Komunikat o błędzie dla określonej właściwości

typ
multistatus.modelstate.property-name.type string

Typ błędu dla określonej właściwości

eeid
multistatus.body.eeid string

Identyfikator pracownika

coid
multistatus.body.coid array of string

Lista identyfikatorów firmy; firma domowa jest pierwsza

getASpecificEmployeesPtoplans

Nazwa Ścieżka Typ Opis
identyfikator pracownika
employeeId string

Unikatowy identyfikator pracownika

companyId
companyId string

Identyfikator firmy skojarzonej z pracownikiem

ptoPlan
ptoPlan string

Identyfikator planu PTO mającego zastosowanie do pracownika

Zarobił
earned double

Łączna liczba godzin pracy uzyskanych przez pracownika

Podjęte
taken double

Łączna liczba godzin operacji PTO podejmowanych przez pracownika

pendingBalance
pendingBalance double

Bieżące saldo oczekujących godzin PTO

EarnedThroughDate
earnedThroughDate string

Data ostatniego naliczania operacji PTO

resetować
reset string

Data zresetowania salda PTO

pendingMoveDate
pendingMoveDate string

Data istotna dla oczekujących reguł PTO

getEmployeeSupervisorDetails

Nazwa Ścieżka Typ Opis
identyfikator pracownika
employeeID string

Identyfikator pracownika

identyfikator firmy
companyID string

Identyfikator firmy pracownika

numerPracownika
employeeNumber string

Unikatowy numer przypisany do pracownika

supervisorEmployeeID
supervisorEmployeeID string

Identyfikator nadzorcy

supervisorFirstName
supervisorFirstName string

Imię nadzorcy

supervisorLastName
supervisorLastName string

Nazwisko nadzorcy

supervisorEmployeeNumber
supervisorEmployeeNumber string

Numer pracownika nadzorcy

supervisorCompanyID
supervisorCompanyID string

Identyfikator firmy dla nadzorcy

supervisorCompanyCode
supervisorCompanyCode string

Kod firmy skojarzony z nadzorcą

supervisorStatusCode
supervisorStatusCode string

Kod stanu reprezentujący status zatrudnienia nadzorcy

supervisorJobCode
supervisorJobCode string

Kod zadania przypisany do nadzorcy

supervisorPositionCode
supervisorPositionCode string

Kod położenia przypisany do nadzorcy

supervisorEmail
supervisorEmail string

Adres e-mail nadzorcy

supervisorWorkPhone
supervisorWorkPhone string

Numer telefonu służbowego nadzorcy

supervisorPersonId
supervisorPersonId string

Unikatowy identyfikator nadzorcy jako osoba

getAllDetailsForAPersonAssignedToAnEmployeeAsAsAContact

Nazwa Ścieżka Typ Opis
city
city string

Miasto, w którym znajduje się adres

Kod kraju
countryCode string

Kod kraju adresu

hrabstwo
county string

Hrabstwo adresu

addressIsDifferentFromEmployee
addressIsDifferentFromEmployee boolean

Wskazuje, czy adres różni się od adresu pracownika

Wiersz adresu1
addressLine1 string

Wiersz adresu podstawowego

Wiersz adresu2
addressLine2 string

Linia adresu pomocniczego

stan
state string

Stan adresu

Kod pocztowy
zipCode string

Kod pocztowy adresu

cobraExport
cobraExport boolean

Wskazuje, czy dane COBRA są eksportowane

cobraIsActive
cobraIsActive boolean

Wskazuje, czy FUNKCJA COBRA jest aktywna

cobraReason
cobraReason string

Przyczyna stanu COBRA

cobraStatus
cobraStatus string

Bieżący stan COBRA

cobraStatusDate
cobraStatusDate string

Data bieżącego stanu COBRA

dateOfBirth
dateOfBirth string

Data urodzenia

dateOfCOBRAEvent
dateOfCOBRAEvent string

Data zdarzenia COBRA

dateOfCOBRALetter
dateOfCOBRALetter string

Data wydania listu COBRA

identyfikator pracownika
employeeId string

Identyfikator pracownika

gender
gender string

Płeć osoby

importId
importId string

Identyfikator importu

isBeneficiary
isBeneficiary boolean

Wskazuje, czy osoba jest beneficjentem

isDependent
isDependent boolean

Wskazuje, czy dana osoba jest zależna

isDisabled (Wyłączone)
isDisabled boolean

Wskazuje, czy dana osoba jest wyłączona

isEmergencyContact
isEmergencyContact boolean

Wskazuje, czy dana osoba jest kontaktem awaryjnym

isSmoker
isSmoker boolean

Wskazuje, czy dana osoba jest palaczem

isStudent
isStudent boolean

Wskazuje, czy dana osoba jest uczniem

marriageDate
marriageDate string

Data małżeństwa

imię
firstName string

Imię osoby

formerName
formerName string

Była nazwa osoby

nazwisko
lastName string

Nazwisko osoby

drugie imię
middleName string

Drugie imię osoby

nameSuffix
nameSuffix string

Sufiks nazwy osoby

zawód
occupation string

Zawód osoby

other Asekursja
otherInsurance string

Szczegóły innych ubezpieczeń

homePhoneCountry
homePhoneCountry string

Kod kraju dla telefonu domowego

homePhoneNumber
homePhoneNumber string

Numer telefonu domowego

otherPhoneNumber
otherPhoneNumber string

Inny numer telefonu

otherPhoneType
otherPhoneType string

Typ innego telefonu

preferredPhoneNumber
preferredPhoneNumber string

Preferowany numer telefonu

relationshipCode
relationshipCode string

Kod opisujący relację

relationshipDescription
relationshipDescription string

Opis relacji

Ssn
ssn string

Numer ubezpieczenia społecznego

contactId
contactId string

Identyfikator kontaktu

userDefinedField01
userDefinedField01 string

Pole niestandardowe dla dodatkowych informacji

workPhoneExtension
workPhoneExtension string

Rozszerzenie numeru telefonu służbowego

numer telefonu służbowego
workPhoneNumber string

Służbowy numer telefonu

cobraNotes
cobraNotes string

Uwagi związane z COBRA

Notatki
notes string

Ogólne uwagi dotyczące osoby fizycznej

isActive
isActive boolean

Wskazuje, czy rekord jest aktywny

statusAsOfDate
statusAsOfDate string

Data bieżącego stanu

deathDate
deathDate string

Data śmierci

rozwódDate
divorceDate string

Data rozwodu

adres e-mail
emailAddress string

Adres e-mail

otherPhoneCountryCode
otherPhoneCountryCode string

Kod kraju dla innego telefonu

healthCareId
healthCareId string

Identyfikator opieki zdrowotnej

nationalId
nationalId string

Identyfikator krajowy

nationalIdExpirationDate
nationalIdExpirationDate string

Data wygaśnięcia krajowego identyfikatora

personID
personID string

Unikatowy identyfikator osoby

addressID
addressID string

Identyfikator adresu

workPhoneId
workPhoneId string

Identyfikator telefonu służbowego

homePhoneId
homePhoneId string

Identyfikator telefonu domowego

otherPhoneId
otherPhoneId string

Identyfikator innego telefonu