WebService::BambooHR::Employee - data class for holding details of one employee
$employee = WebService::BambooHR::Employee->new( firstName => 'Ford', lastName => 'Prefect', workEmail => 'ford@betelgeuse.org', );
WebService::BambooHR::Employee is a class for data objects that are used by WebService::BambooHR.
It supports attributes for all of the employee fields supported by BambooHR. You can get a list of these from the BambooHR documentation. The attributes are named exactly the same as the fields. The named fields are:
address1 address2 age bestEmail birthday bonusAmount bonusComment bonusDate bonusReason city commisionDate commissionAmount commissionComment commissionDate country dateOfBirth department displayName division eeo employeeNumber employmentHistoryStatus employmentStatus ethnicity exempt firstName flsaCode fullName1 fullName2 fullName3 fullName4 fullName5 gender hireDate homeEmail homePhone id jobTitle lastChanged lastName location maritalStatus middleName mobilePhone nickname payChangeReason payGroup payGroupId payRate payRateEffectiveDate payType photoUploaded rehireDate sin ssn standardHoursPerWeek state stateCode status supervisor supervisorEId supervisorId terminationDate workEmail workPhone workPhoneExtension workPhonePlusExtension zipcode
In addition, the following fields are supported, which aren't listed in the BambooHR documentation:
Returns 'Yes' or 'No' to signify whether the employee is able to login to the BambooHR service.
Returns one of 'Death', 'Voluntary', or 'Involuntary'. When someone is marked as terminated via the user interface, it is optional to specify the termination type. If not specified this will return undef.
undef
This might be one of the standard reasons ('Attendance', 'Other employment', 'Performance', or 'Relocation'), but it may also be a custom string that was entered by the person who recorded the termination.
WebService::BambooHR
Employee documentation on BambooHR's website.
Neil Bowers <neilb@cpan.org>
This software is copyright (c) 2014 by Neil Bowers <neilb@cpan.org>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install WebService::BambooHR, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::BambooHR
CPAN shell
perl -MCPAN -e shell install WebService::BambooHR
For more information on module installation, please visit the detailed CPAN module installation guide.