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

Xero NodeJS OAuth 2.0 client for xero-node

import { Address } from '././address';
import { Contracts } from '././contracts';
import { NICategory } from '././nICategory';
import { NICategoryLetter } from '././nICategoryLetter';
export declare class Employee {
    /**
    * Xero unique identifier for the employee
    */
    'employeeID'?: string;
    /**
    * Title of the employee
    */
    'title': string;
    /**
    * First name of employee
    */
    'firstName': string;
    /**
    * Last name of employee
    */
    'lastName': string;
    /**
    * Date of birth of the employee (YYYY-MM-DD)
    */
    'dateOfBirth': string;
    'address': Address;
    /**
    * The email address for the employee
    */
    'email'?: string;
    /**
    * The employee’s gender
    */
    'gender': Employee.GenderEnum;
    /**
    * Employee phone number
    */
    'phoneNumber'?: string;
    /**
    * Employment start date of the employee at the time it was requested
    */
    'startDate'?: string;
    /**
    * Employment end date of the employee at the time it was requested
    */
    'endDate'?: string;
    /**
    * Xero unique identifier for the payroll calendar of the employee
    */
    'payrollCalendarID'?: string;
    /**
    * UTC timestamp of last update to the employee
    */
    'updatedDateUTC'?: Date;
    /**
    * UTC timestamp when the employee was created in Xero
    */
    'createdDateUTC'?: Date;
    'niCategory'?: NICategoryLetter;
    /**
    * The employee\'s NI categories
    */
    'niCategories'?: Array<NICategory>;
    /**
    * National insurance number of the employee
    */
    'nationalInsuranceNumber'?: string;
    /**
    * Whether the employee is an off payroll worker
    */
    'isOffPayrollWorker'?: boolean;
    /**
    * The employee\'s contracts
    */
    'contracts'?: Array<Contracts>;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace Employee {
    enum GenderEnum {
        M,
        F
    }
}