Documentation

UserEmploymentUpdate extends BaseComponent
in package

UserEmploymentUpdate Model

Tags
@property

?\Blackbaud\SKY\School\Components\EmployeeDepartmentsEditModel[] $employee_departments An array of employee department objects. If this property is included, the existing employee departments will be overwritten with the included list. This includes removing ones not included.

Table of Contents

Properties

$date_appointed  : string|null
$date_departed  : string|null
$disable_account  : bool|null
$employee_roles  : array<string|int, int>|null
$employee_sports  : array<string|int, int>|null
$employment_effective_date  : string|null
$grade_levels  : array<string|int, int>|null
$school_levels  : array<string|int, int>|null
$withdraw_effective_date  : string|null
$fields  : array<string|int, string>

Properties

$date_departed

public string|null $date_departed

The tenure end date. Note: this field will be overwritten by the withdrawal date if the effective withdrawal date is a future date.

$disable_account

public bool|null $disable_account

Set to true to disable the account upon withdrawal

$employee_roles

public array<string|int, int>|null $employee_roles

An array of faculty role IDs. If this property is included, the existing employee roles will be overwritten with the included list. This includes removing ones not included.

$employee_sports

public array<string|int, int>|null $employee_sports

An array of sport IDs. If this property is included, the existing employee sports will be overwritten with the included list. This includes removing ones not included.

$employment_effective_date

public string|null $employment_effective_date

The date and time these updates will take effect. If this field is blank or if prior to the current date and time, the changes will take effect immediately. If the date is in the future, all changes will be marked Pending until the effective date passes.

$grade_levels

public array<string|int, int>|null $grade_levels

An array of grade level IDs. If this property is included, the existing employee grade levels will be overwritten with the included list. This includes removing ones not included.

$school_levels

public array<string|int, int>|null $school_levels

An array of the school level IDs. If this property is included, the existing employee school levels will be overwritten with the included list. This includes removing ones not included.

$withdraw_effective_date

public string|null $withdraw_effective_date

The date and time the employee’s withdrawal will take effect. If this field is prior to the current date and time, the withdrawal will take effect immediately. If the date is in the future, the withdrawal will be marked Pending until the effective date passes.

$fields

protected static array<string|int, string> $fields = ["date_appointed" => "string", "date_departed" => "string", "employment_effective_date" => "string", "withdraw_effective_date" => "string", "disable_account" => "bool", "employee_roles" => "int[]", "school_levels" => "int[]", "employee_departments" => "\\Blackbaud\\SKY\\School\\Components\\EmployeeDepartmentsEditModel[]", "grade_levels" => "int[]", "employee_sports" => "int[]"]

        
On this page

Search results