📚 SAP Business One SDK Help

EmployeesInfo Object Members
See Also  Overview 

Public Methods

Public Method AddAdds a record to the object table in SAP Business One company database.
Public Method CloseNot supported.
Public Method GetAsXMLReturns the object from XML data, which is stored as string in a buffer.
Public Method GetByKeyRetrieves and sets the values of the object's properties by the object's absolute key from the Company database.
Public Method RemoveDeletes a record from the object table.
Public Method SaveToFileSave the object to a file as XML data.
Public Method SaveXMLSaves the object data to XML formatted data.
Public Method UpdateUpdates the object data in the company database.

Public Properties

Public Property AbsenceInfoReturns the EmployeeAbsenceInfo object.
Public Property AccountantResponsibleproperty AccountantResponsible
Public Property Activeproperty Active
Public Property AdditionalAmountThe additional benefit amount of the employee.

Field: AddiAmnt.

Public Property AdditionalCurrencyThe currency of the additional benefit amount.

Field: AddiCurr.

Public Property AdditionalUnitThe time period unit of the additional benefit.

Field: AddiUnit.

Public Property ApplicationUserIDSets or returns the employee user code of SAP Business One application.

Field name: userId.

This is a foreign key to the Users object.

Public Property AttachmentEntrySets or returns the Attachment Entry.

Field name: AtcEntry.

Public Property AttachmentsReturns the Attachments object.
Public Property AuthorizationForRetrieveFromSEFAZAuthorization to Retrieve NFe from SEFAZ.

Field name: ARetSEFAZ.

Public Property BankAccountSets or returns the bank account number of the employee .

Field name: bankAcount.

Length: 100 characters.

Public Property BankBranchSets or returns the bank branch name of the employee .

Field name: branch

Length: 100 characters

Public Property BankBranchNumSets or returns the bank branch number of the employee .

Field name: bankBranNo.

Length: 30 characters.

Public Property BankCodeSets or returns the employee bank name.

Field name: bankCode.

Length: 30 characters.

Public Property BankCodeForDATEVThe bank code for DATEV.

Field name: BCodeDateV.

Length: 20 characters.

Public Property BirthPlaceThe birth place of the employee.

Field: BirthPlace.

Public Property BPLIDproperty BPLID
Public Property BranchSets or returns the branch office of the employee.

Field name: branch.

Public Property BrowserReturns the DataBrowser object.
Public Property CitizenshipCountryCodeSets or returns the citizenship country code.

Field name: citizenshp.

This is a foreign key to the Countries table (OCRY - not exposed through the DI API).

Length: 3 characters.

Public Property CompanyNumberIndicate the company number to which the employee belongs, in case there are various numbers available within the company.

Field name: CompanyNum.

Length: 20 characters.

Public Property CostCenterCodeSets or returns the cost center to which the employee belongs.

Field name: CostCenter.

Public Property CountryOfBirthSets or returns the country of birth of the employee.

Field name: brthCountr.

Length: 3 characters.

This is a foreign key to the Countries table (OCRY - not exposed through the DI API).

Public Property CPFproperty CPF
Public Property CRCNumberproperty CRCNumber
Public Property CRCStateproperty CRCState
Public Property CreateDateproperty CreateDate
Public Property CreateTimeproperty CreateTime
Public Property DateOfBirthSets or returns the birth date of the employee.

Field name: birthDate.

Public Property DepartmentSets or returns the employee department.

Field name: dept

This is a foreign key to the Departments table (OUDP), which is exposed via the DepartmentsService object.

Public Property DeviatingBankAccountOwnerIndicate whether the bank account owner is a person other than the employee, for example, the spouse of the employee.

Field: DevBAOwner.

Public Property DIRFResponsibleproperty DIRFResponsible
Public Property EducationInfoReturns the EmployeeEducationInfo object.
Public Property EducationStatusThe education level of the employee.

1 - Without Profession
2 - With Profession
3 - High school without profession
4 - High school with profession
5 - Professional skilled exam
6 - University
7 - Indication not possible

Field: StatusOfE.

Public Property eMailSets or returns the e-mail address.

Field name: email.

Length: 100 characters.

Public Property EmployeeBranchAssignmentproperty EmployeeBranchAssignment
Public Property EmployeeCodeproperty EmployeeCode
Public Property EmployeeCostsSets or returns the employee costs.

Field name: empCostCur.

Public Property EmployeeCostsCurrencySets or returns the currency of the employee cost.

Field name: empCostCur.

Length: 3 characters.

Public Property EmployeeCostUnitSets or returns a valid value of BoSalaryCostUnits type that specifies the employee cost unit (for example: per hour, per day, per month, and so on).

Field name: empCostUnt.

Public Property EmployeeIDReturns the employee ID.

Field name: empID.

Public Property EmployeeRolesInfoReturns the EmployeeRolesInfo child object.
Public Property EmployeeTypeSets or returns the default role ID of the employee.

Field name: type.

This is a foreign key to the Employee Type table (OHTY - not exposed through the DI API).

Public Property ExemptionAmountThe amount of the exemption benefit of the employee.

Field: ExemptAmnt.

Public Property ExemptionCurrencyThe currency of the exemption benefit amount.

Field: ExemptCurr.

Public Property ExemptionUnitThe time period unit of the exemption benefit.

Field: ExemptUnit.

Public Property ExternalEmployeeNumberThe external employee number.

Field: ExtEmpNo.

Public Property FaxSets or returns the fax number.

Field name: fax.

Length: 50 characters.

Public Property FirstNameSets or returns the employee first name.

Field name: firstName.

Mandatory property.

Length: 50 characters.

Public Property GenderSets or returns a valid value of BoGenderTypes type that specifies the employee gender type.

Field name: sex.

Public Property GenderExSets or returns the gender type that you specified in addition to the system predefined employee gender type.

Field name: SexEx.

Length: 15 characters.

Public Property HealthInsuranceCodeThe health insurance code of the employee.

Field name: HeaInsCode.

Length: 50 characters.

Public Property HealthInsuranceNameThe health insurance name of the employee.

Field name: HeaInsName.

Length: 50 characters.

Public Property HealthInsuranceType Indicate the type of the employee's health insurance.
  • AOK - Allgemeine Ortskrankenkasse (AOK)
  • IKK - Innungskrankenkasse (IKK)
  • EKK - Ersatzkasse (EKK)
  • BKK - Betriebskrankenkasse (BKK)
  • BKS - Bundesknappschaft (BKS)
  • LKK - Landeskrankenkasse (LKK)

Field name: HeaInsType.

Length: 20 characters.

Public Property HomeBlockSets or returns the block of the home address.

Field name: homeBlock.

Length: 100 characters.

Public Property HomeBuildingFloorRoomSets or returns additional details of the home address, such as building number, floor number, and room number.

Field name: HomeBuild.

Length: 64,000 characters.

Public Property HomeCitySets or returns the city of the home address.

Field name: homeCity.

Length: 100 characters.

Public Property HomeCountrySets or returns the country of the home address.

Field name: homeCountr.

Length: 3 characters.

This is a foreign key to the Countries table (OCRY - not exposed through the DI API).

Public Property HomeCountySets or returns the county part of the home address.

Field name: homeCounty.

Length: 100 characters.

Public Property HomePhoneSets or returns the home phone number.

Field name: homeTel.

Length: 50 characters.

Public Property HomeStateSets or returns the state of the home address.

Field name: homeState.

Length: 3 characters.

This is a foreign key to the Countries table (OCST - not exposed through the DI API).

Public Property HomeStreetSets or returns the street of the home address.

Field name: homeStreet.

Length: 100 characters.

Public Property HomeStreetNumberproperty HomeStreetNumber
Public Property HomeZipCodeSets or returns the zip code of the home address.

Field name: homeZip.

Length: 20 characters.

Public Property IdNumberSets or returns the personal ID number of the employee (such as, government ID number or social security number).

Field name: govID.

Length: 20 characters.

Public Property IDTypeproperty IDType
Public Property IncomeTaxLiabilityIndicate the income tax liability code:
1 - Unlimited
2 - Restricted
3 - Flat-rate tax
4 - Not liable

Field: InTaxLiabi.

Public Property JobTitleSets or returns the employee job title.

Field name: jobTitle.

Length: 20 characters.

Public Property JobTitleCodeThe job title of the employee.

Field name: JTCode.

Length: 5 characters.

Public Property LastNameSets or returns the employee last name.

Field name: lastName.

Mandatory property.

Length: 50 characters.

Public Property LegalRepresentativeproperty LegalRepresentative
Public Property LinkedVendorproperty LinkedVendor
Public Property ManagerSets or returns the manager's employee-ID of the employee.

Field name: manager.

This is a key to the OHEM object.

Public Property MartialStatusSets or returns a valid value of BoMeritalStatuses type that specifies the merital status.

Field name: martStatus.

Public Property MiddleNameSets or returns the employee middle name.

Field name: middleName.

Length: 50 characters.

Public Property MobilePhoneSets or returns the mobile phone number.

Field name: mobile.

Length: 50 characters.

Public Property MunicipalityKeyThe key of the municipality to which the employee belongs.

Field name: MunKey.

Length: 20 characters.

Public Property NaturalPerThis shows whether the business partner is natural person or not.

Field name: NaturalPer.

Public Property NumOfChildrenSets or returns the number of children.

Field name: nChildren.

Public Property OfficeExtensionSets or returns the extension of the office phone number.

Field name: officeExt.

Length: 50 characters.

Public Property OfficePhoneSets or returns the office phone number.

Field name: officeTel.

Length: 50 characters.

Public Property PagerSets or returns the pager number.

Field name: pager.

Length: 50 characters.

Public Property PartnerReligionIndicates the religion of the employee's spouse.

--  - No church tax liability
AK - Old catholic
EV - Protestant
FA - Non-denomination Alzey
FB - Non-denominational regional congregation Baden
FG - Non-denominational regional congregation Palatinate
FM - Non-denominational congregation Mainz
FR - French-reformed
FS - Non-denominational congregation Offenbach/Mainz
IB - Israelite Religious Community Baden
IL - Israelite Rural
IS - Israelite
IW - Israelite religious community Wuerttemberg
JD - Jewish religion tax
JH - Jewish religion tax
JS - Jewish religion tax
LT - Lutheran
RF - Reformed
RK - Roman catholic

Field: RelPartner.

Public Property PassportExpirationDateSets or returns the expiration date of the passport.

Field name: passportEx.

Public Property PassportIssueDateproperty PassportIssueDate
Public Property PassportIssuerproperty PassportIssuer
Public Property PassportNumberSets or returns the employee passport number.

Field name: passportNo.

Length: 20 characters.

Public Property PaymentMethodThe payment method of the employee.

Field name: PymMeth.

Public Property PersonGroupThe person group of the employee.

101 - Social insurance obliged without characteristic
102 - Apprentice
104 - Home worker
105 - Trainee
106 - Student
108 - Early retirement
109 - Part time occupied employee
110 - Short time occupied
112 - Family related person agriculture
113 - Additio. income agriculture
114 - Additio. income agriculture seasonal
116 - Receiver of clearing cash
118 - Unregular occupied
119 - Pensioner
997 - Not specified

Field: PersGroup.

Public Property PictureSets or returns the picture file name (without the path).

Field name: picture.

Length: 200 characters.

Public Property PositionSets or returns a value that specifies the employee position. This property This is a foreign key to OHPS table, which is not exposed through the DI API.

Field name: Position.

Public Property PreviousEmpoymentInfoReturns the EmployeePrevEmpoymentInfo object.
Public Property PreviousPRWebAccessproperty PreviousPRWebAccess
Public Property ProfessionStatusThe profession of the employee.

0 - Trainee
1 - Worker
2 - Skilled Worker
3 - Supervisor/Foreman
4 - Clerk
5 - Youthhelp/Sheltered Workshop
6 - Participation for profession focused measures
7 - Homeworker
8 - Part time < 18 hrs
9 - Part time > 18 hrs

Field: StatusOfP.

Public Property PRWebAccessproperty PRWebAccess
Public Property QualificationCodeproperty QualificationCode
Public Property ReligionIndicates the religion of the employee.

--  - No church tax liability
AK - Old catholic
EV - Protestant
FA - Non-denomination Alzey
FB - Non-denominational regional congregation Baden
FG - Non-denominational regional congregation Palatinate
FM - Non-denominational congregation Mainz
FR - French-reformed
FS - Non-denominational congregation Offenbach/Mainz
IB - Israelite Religious Community Baden
IL - Israelite Rural
IS - Israelite
IW - Israelite religious community Wuerttemberg
JD - Jewish religion tax
JH - Jewish religion tax
JS - Jewish religion tax
LT - Lutheran
RF - Reformed
RK - Roman catholic

Field: EmTaxCCode.

Public Property RemarksSets or returns a memo type string that specifies remarks on the employee.

Field name: remark.

Length: 64,000 characters.

Public Property ReviewsInfoReturns the EmployeeReviewsInfo object.
Public Property SalarySets or returns the employee salary.

Field name: salary.

Public Property SalaryCurrencySets or returns the currency of the salary.

Field name: salaryCurr.

Length: 3 characters.

Public Property SalaryUnitSets or returns a valid value of BoSalaryCostUnits type that specifies the salary unit (for example: per hour, per day, per month, and so on).

Field name: salaryUnit.

Public Property SalesPersonCodeSets or returns the sales person code.

Field name: salesPrson.

This is a foreign key to the SalesPersons Object.

Public Property SavingsPaymentInfoReturns the EmployeeSavingsPaymentInfo child object.
Public Property SocialInsuranceNumberThe social insurance number of the employee.

Field name: SInsurNum.

Length: 20 characters.

Public Property SpouseFirstNameThe first name of the employee's spouse.

Field name: FNameSP.

Length: 50 characters.

Public Property SpouseSurnameThe surname of the employee's spouse.

Field name: SurnameSP.

Length: 50 characters.

Public Property StartDateSets or returns the date when the employee started the work in the company.

Field name: startDate.

Public Property StatusCodeSets or returns the employee status code.

Field name: status.

Public Property STDCodeproperty STDCode
Public Property TaxClassIndicates the tax class of the employee:

1 - Tax Class I
2 - Tax Class II
3 - Tax Class III
4 - Tax Class IV
5 - Tax Class V
6 - Tax Class VI

Field name: TaxClass.

Public Property TaxOfficeNameThe tax office name of the employee.

Field name: TaxOName.

Length: 50 characters.

Public Property TaxOfficeNumberThe tax office number of the employee.

Field name: TaxONum.

Length: 20 characters.

Public Property TerminationDateSets or returns the date when the employee terminated the work in the company.

Field name: termDate.

Public Property TreminationReasonSets or returns the termination reason.

Field name: termReason.

This is a foreign key to the Termination Reason table (OHTR - not exposed through the DI API).

Public Property UpdateDateproperty UpdateDate
Public Property UpdateTimeproperty UpdateTime
Public Property UserFieldsReturns the UserFields object.
Public Property VacationCurrentYearThe employee's vacation information of the current year.

Field name: VacCurYear.

Length: 3 characters.

Public Property VacationPreviousYearThe employee's vacation information of the previous year.

Field name: VacPreYear.

Length: 3 characters.

Public Property WorkBlockSets or returns the block of the workplace address.

Field name: workBlock.

Length: 100 characters.

Public Property WorkBuildingFloorRoomSets or returns additional details of the workplace address, such as building number, floor number, and room number.

Field name: WorkBuild.

Length: 64,000 characters.

Public Property WorkCitySets or returns the city of the workplace address.

Field name: workCity.

Length: 100 characters.

Public Property WorkCountryCodeSets or returns the country of the workplace address.

Field name: workCountr.

Length: 3 characters.

This is a foreign key to the Countries table (OCRY - not exposed through the DI API).

Public Property WorkCountySets or returns the county of the workplace address.

Field name: workCounty.

Length: 100 characters.

Public Property WorkStateCodeSets or returns the state of the workplace address.

Field name: workState.

Length: 3 characters.

This is a foreign key to the States table (OCST - not exposed through the DI API).

Public Property WorkStreetSets or returns the street of the workplace address.

Field name: workStreet.

Length: 100 characters.

Public Property WorkStreetNumberproperty WorkStreetNumber
Public Property WorkZipCodeSets or returns the zip code of the workplace address.

Field name: workZip.

Length: 20 characters.

See Also