nodes/generated

Interface BambooHrNodeParameters

Source
interface BambooHrNodeParameters {
    addasasress?: {
        value: {
            address1?: string;
            address2?: string;
            city?: string;
            country?: string;
            state?: string;
        };
    };
    additionalFields?: {
        address?: {
            value: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
            };
        };
        dateOfBirth?: string;
        department?: string;
        division?: string;
        employeeNumber?: string;
        exempt?: "exempt"
        | "non-exempt";
        gender?: "female" | "male";
        hireDate?: string;
        location?: string;
        maritalStatus?:
            | "single"
            | "married"
            | "domesticPartnership";
        mobilePhone?: string;
        paidPer?: | "hour"
        | "day"
        | "week"
        | "month"
        | "quater"
        | "year";
        payRate?: {
            value: { currency?: string; value?: string };
        };
        payType?: | "commission"
        | "contract"
        | "daily"
        | "exceptionHourly"
        | "hourly"
        | "monthly"
        | "pieceRate"
        | "proRata"
        | "salary"
        | "weekly";
        preferredName?: string;
        ssn?: string;
        workEmail?: string;
        workPhone?: string;
    };
    address?: {
        value: {
            address1?: string;
            address2?: string;
            city?: string;
            country?: string;
            state?: string;
        };
    };
    binaryPropertyName?: string;
    categoryId?: string;
    dateOfBirth?: string;
    department?: string;
    division?: string;
    employeeId?: string;
    employeeNumber?: string;
    exempt?: "exempt"
    | "non-exempt";
    fileId?: string;
    firstName?: string;
    format?: "CSV" | "JSON" | "PDF" | "XLS" | "XML";
    gender?: "female" | "male";
    hireDate?: string;
    lastName?: string;
    limit?: number;
    location?: string;
    maritalStatus?:
        | "single"
        | "married"
        | "domesticPartnership";
    mobilePhone?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upload"
    | "download";
    options?: | { fields?: unknown[] }
    | { share?: boolean }
    | { fd?: boolean; onlyCurrent?: boolean };
    output?: string;
    paidPer?:
        | "hour"
        | "day"
        | "week"
        | "month"
        | "quater"
        | "year";
    payRate?: {
        value: { currency?: string; value?: string };
    };
    payType?: | "commission"
    | "contract"
    | "daily"
    | "exceptionHourly"
    | "hourly"
    | "monthly"
    | "pieceRate"
    | "proRata"
    | "salary"
    | "weekly";
    preferredName?: string;
    reportId?: string;
    resource?: | "file"
    | "companyReport"
    | "employee"
    | "employeeDocument";
    returnAll?: boolean;
    simplifyOutput?: boolean;
    ssn?: string;
    synced?: boolean;
    updateFields?: | {
        addasasress?: {
            value: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
            };
        };
        dateOfBirth?: string;
        department?: string;
        division?: string;
        employeeNumber?: string;
        exempt?: "exempt"
        | "non-exempt";
        firstName?: string;
        gender?: "female" | "male";
        hireDate?: string;
        lastName?: string;
        location?: string;
        maritalStatus?:
            | "single"
            | "married"
            | "domesticPartnership";
        mobilePhone?: string;
        paidPer?: | "hour"
        | "day"
        | "week"
        | "month"
        | "quater"
        | "year";
        payRate?: {
            value: { currency?: string; value?: string };
        };
        payType?: | "commission"
        | "contract"
        | "daily"
        | "exceptionHourly"
        | "hourly"
        | "monthly"
        | "pieceRate"
        | "proRata"
        | "salary"
        | "weekly";
        preferredName?: string;
        ssn?: string;
        workEmail?: string;
        workPhone?: string;
    }
    | {
        categoryId?: string;
        name?: string;
        shareWithEmployee?: boolean;
    };
}

Properties§

§readonly addasasress?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly additionalFields?: { ... }

Default: {}

§readonly address?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly binaryPropertyName?: string

The name of the input field containing the binary file data to be uploaded. Supported file types: PNG, JPEG. Default: "data"

§readonly categoryId?: string
§readonly dateOfBirth?: string
§readonly department?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getDepartments"}

§readonly division?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getDivisions"}

§readonly employeeId?: string
§readonly employeeNumber?: string
§readonly exempt?: "exempt" | "non-exempt"
§readonly fileId?: string

ID of the employee file

§readonly firstName?: string
§readonly format?: "CSV" | "JSON" | "PDF" | "XLS" | "XML"

The output format for the report Default: "JSON"

§readonly gender?: "female" | "male"
§readonly hireDate?: string
§readonly lastName?: string
§readonly limit?: number

Max number of results to return Default: 5 Type options: {"minValue":1,"maxValue":1000}

§readonly location?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getEmployeeLocations"}

§readonly maritalStatus?: "single" | "married" | "domesticPartnership"
§readonly mobilePhone?: string
§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upload"
    | "download"

Default: "create"

§readonly options?:
    | { fields?: unknown[] }
    | { share?: boolean }
    | { fd?: boolean; onlyCurrent?: boolean }

Default: {}

§readonly output?: string

The name of the output field to put the binary file data in Default: "data"

§readonly paidPer?: "hour" | "day" | "week" | "month" | "quater" | "year"
§readonly payRate?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly payType?:
    | "commission"
    | "contract"
    | "daily"
    | "exceptionHourly"
    | "hourly"
    | "monthly"
    | "pieceRate"
    | "proRata"
    | "salary"
    | "weekly"
§readonly preferredName?: string
§readonly reportId?: string

ID of the report. You can get the report number by hovering over the report name on the reports page and grabbing the ID.

§readonly resource?: "file" | "companyReport" | "employee" | "employeeDocument"

Default: "employee"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly simplifyOutput?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

§readonly ssn?: string

A standard United States Social Security number, with dashes

§readonly synced?: boolean

Whether the employee to create was added to a pay schedule synced with Trax Payroll

§readonly updateFields?:
    | {
        addasasress?: {
            value: {
                address1?: string;
                address2?: string;
                city?: string;
                country?: string;
                state?: string;
            };
        };
        dateOfBirth?: string;
        department?: string;
        division?: string;
        employeeNumber?: string;
        exempt?: "exempt"
        | "non-exempt";
        firstName?: string;
        gender?: "female" | "male";
        hireDate?: string;
        lastName?: string;
        location?: string;
        maritalStatus?:
            | "single"
            | "married"
            | "domesticPartnership";
        mobilePhone?: string;
        paidPer?: | "hour"
        | "day"
        | "week"
        | "month"
        | "quater"
        | "year";
        payRate?: {
            value: { currency?: string; value?: string };
        };
        payType?: | "commission"
        | "contract"
        | "daily"
        | "exceptionHourly"
        | "hourly"
        | "monthly"
        | "pieceRate"
        | "proRata"
        | "salary"
        | "weekly";
        preferredName?: string;
        ssn?: string;
        workEmail?: string;
        workPhone?: string;
    }
    | {
        categoryId?: string;
        name?: string;
        shareWithEmployee?: boolean;
    }

Default: {}