xero-node/dist/gen/model/payroll-uk/employeeStatutorySickLeave.d.ts

Xero NodeJS OAuth 2.0 client for xero-node

export declare class EmployeeStatutorySickLeave {
    /**
    * The unique identifier (guid) of a statutory leave
    */
    'statutoryLeaveID'?: string;
    /**
    * The unique identifier (guid) of the employee
    */
    'employeeID': string;
    /**
    * The unique identifier (guid) of the \"Statutory Sick Leave (non-pensionable)\" pay item
    */
    'leaveTypeID': string;
    /**
    * The date when the leave starts
    */
    'startDate': string;
    /**
    * The date when the leave ends
    */
    'endDate': string;
    /**
    * the type of statutory leave
    */
    'type'?: string;
    /**
    * the type of statutory leave
    */
    'status'?: string;
    /**
    * The days of the work week the employee is scheduled to work at the time the leave is taken
    */
    'workPattern': Array<string>;
    /**
    * Whether the sick leave was pregnancy related
    */
    'isPregnancyRelated': boolean;
    /**
    * Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request
    */
    'sufficientNotice': boolean;
    /**
    * Whether the leave was entitled to receive payment
    */
    'isEntitled'?: boolean;
    /**
    * The amount of requested time (in weeks)
    */
    'entitlementWeeksRequested'?: number;
    /**
    * The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested
    */
    'entitlementWeeksQualified'?: number;
    /**
    * A calculated amount of time (in weeks) that remains for the statutory sick leave period
    */
    'entitlementWeeksRemaining'?: number;
    /**
    * Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave\'s period. While this is allowed it could affect payment amounts
    */
    'overlapsWithOtherLeave'?: boolean;
    /**
    * If the leave requested was considered \"not entitled\", the reasons why are listed here.
    */
    'entitlementFailureReasons'?: Array<EmployeeStatutorySickLeave.EntitlementFailureReasonsEnum>;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace EmployeeStatutorySickLeave {
    enum EntitlementFailureReasonsEnum {
        UnableToCalculateAwe,
        AweLowerThanLel,
        NotQualifiedInPreviousPiw,
        ExceededMaximumEntitlementWeeksOfSsp,
        ExceededMaximumDurationOfPiw,
        SufficientNoticeNotGiven
    }
}