HR Core and Payroll API - Domain model and concepts

[#1]

• Employee
• Contract
• Payroll data
• Benefits
• Value lists and other entities
• Company Collective Labor Agreement
• Organizational Unit
• Establishment Unit
• Values lists

This API is intended for external HR solutions and other external consumers in order to create and update data in HR Core and Payroll.

This is an entity driven API, based on the following entities:

• Employee: Person that belongs to a company
• Contract: Employee in a specific position
• Payroll data: Benefits, fixed payments and one off payment of an employee
• Value lists

Employee

Element Number	Label	Description
22	EmployeeCode	Employee code
10519680	PersonCode	PersonCode
25	Initials	Initials
51	FirstNames	First names
165	KnownAs	Known As
24	LastName	Last name
26	LastNamePrefix	Prefixes
37	MaritalStatus	Marital status
27	NamePartner	Name partner
166	PrefixesPartner	Prefixes partner
94	TitlePrefix	Title before name
95	TitleSuffix	Title after name
36	Gender	Gender
35	BirthDate	Birth date
7363	Birthplace	Birthplace
10204761	Nationality	Nationality
10302568	DateOfDeath	Date Of Death
10523564	UserUID	UserUID
10	Language	Language
10000018	BsnSocSecNumber	BSN/soc sec number
7376	TelephoneNumberPrivate	Telephone number: private
7377	TelephoneNumberMobile	Telephone number: mobile
7212	EmailAddress	Email address
7213	EmailAddressPrivate	Email address: private
34	CountryOfResidence	Country of residence
391	StreetEmployee	Street (employee)
392	HouseNumberEmployee	House number (employee)
393	HouseNumberAdditionEmployee	House number addition (employee)
394	PostalCodeEmployee	Postal code (employee)
395	MunicipalityEmployee	Municipality (employee)
8099	LocationDescription	Location description
10205283	RegionaamBuitenland	Regionaam buitenland
7571	CountryMailingAddress	Country (mailing address)
7572	StreetMailingAddress	Street (mailing address)
7573	AddressNumberMailingAddress	Address number (mailing address)
7574	HouseNumberPostalAddress	House number (postal address)
7575	PostalCodeMailingAddress	Postal code (mailing address)
7576	MunicipalityMailingAddress	Municipality (mailing address)
8100	LocationDescriptionMailingAddress	Location description (mailing address)
8101	RegionNameAbroadMailingAddress	Region name abroad (mailing address)
7745	Bic1	BIC (1)
7755	Iban1	IBAN (1)
10000037	Description1	Description (1)
10000085	AccountType1	Account type (1)
10003044	AccountHolder1	Account holder (1)
10000038	Amount1	Amount (1)
7746	Bic2	BIC (2)
7756	Iban2	IBAN (2)
10000040	Description2	Description (2)
10000041	Amount2	Amount (2)
10000086	AccountType2	Account type (2)
10003045	AccountHolder2	Account holder (2)
7747	Bic3	BIC (3)
7757	Iban3	IBAN (3)
10000043	Description3	Description (3)
10000044	Amount3	Amount (3)
10000087	AccountType3	Account type (3)
10003046	AccountHolder3	Account holder (3)
7748	Bic4	BIC (4)
7758	Iban4	IBAN (4)
10000046	Description4	Description (4)
10000047	Amount4	Amount (4)
10000088	AccountType4	Account type (4)
10003047	AccountHolder4	Account holder (4)
7749	Bic5	BIC (5)
7759	Iban5	IBAN (5)
10000049	Description5	Description (5)
10000050	Amount5	Amount (5)
10000089	AccountType5	Account type (5)
10003048	AccountHolder5	Account holder (5)
7750	Bic6	BIC (6)
7760	Iban6	IBAN (6)
10000071	Description6	Description (6)
10000072	Amount6	Amount (6)
10000090	AccountType6	Account type (6)
10003049	AccountHolder6	Account holder (6)
7751	Bic7	BIC (7)
7761	Iban7	IBAN (7)
10000074	Description7	Description (7)
10000075	Amount7	Amount (7)
10000091	AccountType7	Account type (7)
10003050	AccountHolder7	Account holder (7)
7752	Bic8	BIC (8)
7762	Iban8	IBAN (8)
10000077	Description8	Description (8)
10000078	Amount8	Amount (8)
10000092	AccountType8	Account type (8)
10003051	AccountHolder8	Account holder (8)
7753	Bic9	BIC (9)
7763	Iban9	IBAN (9)
10000080	Description9	Description (9)
10000081	Amount9	Amount (9)
10000093	AccountType9	Account type (9)
10003052	AccountHolder9	Account holder (9)
7754	Bic10	BIC (10)
7764	Iban10	IBAN (10)
10000083	Description10	Description (10)
10000084	Amount10	Amount (10)
10000094	AccountType10	Account type (10)
10003053	AccountHolder10	Account holder (10)
17	CompanyCode	Company Code

 

Contract

Element Number	Label	Description
91	EmploymentCode	EmploymentCode
90	ContractDescription	ContractDescription
97	JobProfile	JobProfile
465	HoursPeriod	AmountOfWork
464	DaysPeriod	UnitOfWork
10204687	ContractType	ContractType
75	Location	Location
474	Classification	Classification
53	CostCenter	CostCenter
10300574	SalaryScale	SalaryScale
193	CollectiveLaborAgreement	CollectiveLaborAgreement
7226	ContractEndDate	EndDate
96	Department	Department
10301875	IncomeRelationshipNumber	IncomeRelationshipNumber
10524364	WrittenLaborAgreement	WrittenLaborAgreement
10524365	OnCallAgreement	OnCallAgreement
10524210	MainOrAncillaryContract	MainOrAncillaryContract
7145	ProbationaryPeriod	Employee code
39	HireDate	HireDate
308	FirstHireDate	FirstHireDate
10520479	LastWorkingDate	LastWorkingDate
7449	EstablishmentUnit	Establishment Unit
6000	OrganizationalUnit	OrganizationalUnit
7393	EmploymentType	EmploymentType
22	EmployeeCode	Employee code
10519680	PersonCode	PersonCode
25	Initials	Initials
24	LastName	Last name
18	CompanyCode	CompanyCode

Payroll data

Benefits

Salary Scale

Element Number	Label	Description
10200268	SalaryPeriodicity	Salary Periodicity
10300574	SalaryScale	Salary Scale
10300575	SalaryLevel	Salary Level
10308085	RSP	RSP
10300576	Category	Category
10513358	FactorToConvertAnnualSalary	Factor To Convert Annual Salary
10513356	AutoIncreaseLevelBasedOnAge	Auto Increase Level Based On Age
10524248	AutoLevelIncreaseBasedOnYearsInService	Auto Level Increase Based On Years In Service
10300582	BlockCollectiveSalaryIncrease	Block Collective Salary Increase
10515124	AssessmentScore	Assessment Score
10515125	BlockIncreaseOfSalaryBasedOnAssessment	Block Increase Of Salary Based On Assessment
10300579	SalaryAmount	Salary Amount
91	EmploymentCode	Employment Code
22	EmployeeCode	Employee code
10519680	PersonCode	Person Code
25	Initials	Initials
24	LastName	Last name
18	CompanyCode	Company Code

Gross Variable

Element Number	Label	Description (EN)
10001489	SalaryHourlyRate	Salary Hourly Rate
10001490	SalaryHoursWorked	Salary Hours Worked
10001491	SalaryDaysWorked	Salary Days Worked
10300574	SalaryScale	Salary Scale
10300575	SalaryLevel	Salary Level
10308085	RSP	RSP
10512096	AlternateSalaryHourlyWages	Alternate Salary Hourly Wages
10513356	AutoIncreaseLevelBasedOnAge	Auto Increase Level Based On Age
10524248	AutoLevelIncreaseBasedOnYearsInService	Auto Level Increase Based On Years In Service
91	EmploymentCode	Employment Code
22	EmployeeCode	Employee code
10519680	PersonCode	PersonCode
25	Initials	Initials
24	LastName	Last name
18	CompanyCode	CompanyCode

 

Value lists and other entities

Company Collective Labor Agreement

Element Number	Label	Description
47	Code	Code
65	WorkSchedule	Work Schedule
191	ClientCLA	Client CLA
194	NameCLAImplementationCompany	Name CLA Implementation Company
549	Name	Name
565	WorkHoursScheduleWeek1	Work Hours Schedule Week 1
587	FlexBundleIdentification	Flex Bundle Identification
893	EmployerCategory	Employer Category
10520175	SequenceNumberCompanyCLA	Sequence Number Company CLA
18	CompanyCode	Company Code

Organizational Unit

Element Number	Label	Description
548	Code	Code
549	Name	Name
7011	BackupManager	Backup Manager
7012	NumberOfFTEs	Number Of FTEs
7137	Manager	Manager
7271	NumberKvK	Number KvK
7475	OrganizationType	Organization Type
7476	NumberOfEmployees	Number Of Employees
7477	YearEstimation	Year Estimation
7478	EducationBudget	Education Budget

Establishment Unit

Element Number	Label	Description
147	StreetHouseNumber	Street House Number
548	Code	Code
7271	NumberKvK	Number KvK
7375	FaxNumber	Fax Number
7380	HouseNumberMailingAddress	House Number Mailing Address
7381	MunicipalityMailingAddress	Municipality Mailing Address
7382	PostalCodeMailingAddress	Postal Code Mailing Address
7383	StreetMailingAddress	Street Mailing Address
7384	HouseNumberSuffixMailingAddress	House Number Suffix Mailing Address
7415	TelephoneNumber	Telephone Number
7445	WorklocationName	Worklocation Name
7446	Location	Location
7447	EmailAddress	Email Address
7451	HouseNumber	House Number
7452	HouseNumberSuffix	House Number Suffix
7453	PostCode	PostCode
7454	Street	Street
7456	Website	Website
7571	CountryMailingAddress	Country Mailing Address
8099	LocationDescription	Location Description
8100	LocationDescriptionMailingAddress	Location Description Mailing Address
8101	RegionNameAbroadMailingAddress	Region Name Abroad Mailing Address
8110	Country	Country
10205283	NameRegionAbroad	Name Region Abroad

Values lists

Employee

• MaritalStatus - 37 
• Gender - 36
• Nationality - 10204761
• Communication Language - 10
• 34 Home Address - 7571 Postal Address - Country
• AccountType1-10 (10000085,10000086,10000087,10000088,10000089,10000090,10000091,10000092,10000093,10000094)

Contract

• JobProfile - 97
• ContractType - 10204687
• Location - 75
• Classification - 474
• CostCenter - 53
• Salary Scale  - 10300574
• Department - 96
• writtenLaborAgreement - 10524364
• onCallAgreement - 10524365
• mainOrAncillaryContract - 10524210
• probationaryPeriod - 7145
• EmploymentType - 7393

The value list endpoints return a list of codes and descriptions.