nodes/generated

Interface HarvestNodeParameters

Source
interface HarvestNodeParameters {
    accountId?: string;
    additionalFields?:
        | {
            address?: string;
            currency?: string;
            is_active?: string;
        }
        | {
            email?: string;
            fax?: string;
            last_name?: string;
            phone_mobile?: string;
            phone_office?: string;
            title?: string;
        }
        | {
            currency?: string;
            issue_date?: string;
            notes?: string;
            number?: string;
            over_budget_notification_percentage?: string;
            purchase_order?: string;
            subject?: string;
            tax?: string;
            tax2?: string;
        }
        | {
            billable?: boolean;
            notes?: string;
            total_cost?: string;
            units?: string;
            user_id?: boolean;
        }
        | {
            currency?: string;
            ends_on?: string;
            estimate_id?: string;
            issue_date?: string;
            notes?: string;
            number?: string;
            over_budget_notification_percentage?: string;
            payment_term?: string;
            purchase_order?: string;
            retainer_id?: boolean;
            subject?: string;
            tax?: string;
            tax2?: string;
        }
        | {
            budget?: number;
            budget_is_monthly?: boolean;
            cost_budget?: string;
            cost_budget_include_expenses?: boolean;
            ends_on?: string;
            fee?: string;
            hourly_rate?: string;
            is_active?: boolean;
            is_fixed_fee?: boolean;
            notes?: string;
            notify_when_over_budget?: boolean;
            over_budget_notification_percentage?: string;
            show_budget_to_all?: boolean;
            starts_on?: string;
        }
        | {
            billable_by_default?: boolean;
            default_hourly_rate?: number;
            is_active?: boolean;
            is_default?: boolean;
        }
        | { hours?: number; notes?: string; user_id?: string }
        | {
            ended_time?: string;
            notes?: string;
            started_time?: string;
            user_id?: string;
        }
        | {
            can_create_invoices?: boolean;
            can_create_projects?: boolean;
            can_see_rates?: boolean;
            cost_rate?: number;
            default_hourly_rate?: string;
            has_access_to_all_future_projects?: boolean;
            is_active?: boolean;
            is_admin?: boolean;
            is_contractor?: boolean;
            is_project_manager?: boolean;
            roles?: string;
            timezone?: string;
            weekly_capacity?: number;
        };
    authentication?: "oAuth2"
    | "accessToken";
    billBy?: "none" | "People" | "Project" | "Tasks";
    budgetBy?: string;
    clientId?: string;
    email?: string;
    expenseCategoryId?: string;
    filters?:
        | { is_active?: boolean; updated_since?: string }
        | {
            client_id?: string;
            from?: string;
            page?: number;
            state?: string;
            to?: string;
            updated_since?: string;
        }
        | {
            client_id?: string;
            from?: string;
            is_billed?: boolean;
            page?: number;
            project_id?: string;
            to?: string;
            updated_since?: string;
            user_id?: string;
        }
        | {
            client_id?: string;
            from?: string;
            page?: number;
            project_id?: string;
            state?: ("open" | "closed" | "draft" | "paid")[];
            to?: string;
            updated_since?: string;
        }
        | {
            client_id?: string;
            is_active?: boolean;
            page?: number;
            updated_since?: string;
        }
        | {
            is_active?: boolean;
            page?: number;
            updated_since?: string;
        }
        | {
            client_id?: string;
            from?: string;
            is_billed?: boolean;
            is_running?: boolean;
            page?: number;
            to?: string;
            updated_since?: string;
            user_id?: string;
        }
        | {
            is_active?: boolean;
            page?: number;
            updated_since?: string;
        };
    firstName?: string;
    id?: string;
    isBillable?: boolean;
    lastName?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "createByDuration"
    | "createByStartEnd"
    | "deleteExternal"
    | "restartTime"
    | "stopTime"
    | "me";
    projectId?: string;
    resource?: | "contact"
    | "company"
    | "user"
    | "project"
    | "task"
    | "invoice"
    | "timeEntry"
    | "client"
    | "estimate"
    | "expense";
    returnAll?: boolean;
    spentDate?: string;
    taskId?: string;
    updateFields?: | {
        address?: string;
        currency?: string;
        is_active?: boolean;
        name?: string;
    }
    | {
        client_id?: string;
        email?: string;
        fax?: string;
        first_name?: string;
        last_name?: string;
        phone_mobile?: string;
        phone_office?: string;
        title?: string;
    }
    | {
        client_id?: string;
        currency?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        purchase_order?: string;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        billable?: boolean;
        expense_category_id?: string;
        notes?: string;
        project_id?: string;
        spent_date?: string;
        total_cost?: string;
        units?: string;
        user_id?: boolean;
    }
    | {
        client_id?: string;
        currency?: string;
        ends_on?: string;
        estimate_id?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        payment_term?: string;
        purchase_order?: string;
        retainer_id?: boolean;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        bill_by?: "none"
        | "People"
        | "Project"
        | "Tasks";
        budget?: string;
        budget_by?: string;
        budget_is_monthly?: boolean;
        client_id?: string;
        cost_budget?: string;
        cost_budget_include_expenses?: boolean;
        ends_on?: string;
        fee?: string;
        hourly_rate?: string;
        is_active?: boolean;
        is_billable?: boolean;
        is_fixed_fee?: boolean;
        name?: string;
        notes?: string;
        notify_when_over_budget?: boolean;
        over_budget_notification_percentage?: string;
        show_budget_to_all?: boolean;
        starts_on?: string;
    }
    | {
        billable_by_default?: boolean;
        default_hourly_rate?: number;
        is_active?: boolean;
        is_default?: boolean;
        name?: string;
    }
    | {
        ended_time?: string;
        hours?: number;
        notes?: string;
        started_time?: string;
    }
    | {
        can_create_invoices?: boolean;
        can_create_projects?: boolean;
        can_see_rates?: boolean;
        cost_rate?: number;
        default_hourly_rate?: string;
        email?: string;
        first_name?: string;
        has_access_to_all_future_projects?: boolean;
        is_active?: boolean;
        is_admin?: boolean;
        is_contractor?: boolean;
        is_project_manager?: boolean;
        last_name?: string;
        roles?: string;
        timezone?: string;
        weekly_capacity?: number;
    };
}

Properties§

Source§

readonly accountId?: string

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

Source§

readonly additionalFields?:
    | {
        address?: string;
        currency?: string;
        is_active?: string;
    }
    | {
        email?: string;
        fax?: string;
        last_name?: string;
        phone_mobile?: string;
        phone_office?: string;
        title?: string;
    }
    | {
        currency?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        purchase_order?: string;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        billable?: boolean;
        notes?: string;
        total_cost?: string;
        units?: string;
        user_id?: boolean;
    }
    | {
        currency?: string;
        ends_on?: string;
        estimate_id?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        payment_term?: string;
        purchase_order?: string;
        retainer_id?: boolean;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        budget?: number;
        budget_is_monthly?: boolean;
        cost_budget?: string;
        cost_budget_include_expenses?: boolean;
        ends_on?: string;
        fee?: string;
        hourly_rate?: string;
        is_active?: boolean;
        is_fixed_fee?: boolean;
        notes?: string;
        notify_when_over_budget?: boolean;
        over_budget_notification_percentage?: string;
        show_budget_to_all?: boolean;
        starts_on?: string;
    }
    | {
        billable_by_default?: boolean;
        default_hourly_rate?: number;
        is_active?: boolean;
        is_default?: boolean;
    }
    | { hours?: number; notes?: string; user_id?: string }
    | {
        ended_time?: string;
        notes?: string;
        started_time?: string;
        user_id?: string;
    }
    | {
        can_create_invoices?: boolean;
        can_create_projects?: boolean;
        can_see_rates?: boolean;
        cost_rate?: number;
        default_hourly_rate?: string;
        has_access_to_all_future_projects?: boolean;
        is_active?: boolean;
        is_admin?: boolean;
        is_contractor?: boolean;
        is_project_manager?: boolean;
        roles?: string;
        timezone?: string;
        weekly_capacity?: number;
    }

Default: {}

Source§

readonly authentication?: "oAuth2" | "accessToken"

Default: "accessToken"

Source§

readonly billBy?: "none" | "People" | "Project" | "Tasks"

The method by which the project is invoiced Default: "none"

Source§

readonly budgetBy?: string

The email of the user or "none" Default: "none"

Source§

readonly clientId?: string

The ID of the client associated with this contact

Source§

readonly email?: string

The email of the user

Source§

readonly expenseCategoryId?: string

The ID of the expense category this expense is being tracked against

Source§

readonly filters?:
    | { is_active?: boolean; updated_since?: string }
    | {
        client_id?: string;
        from?: string;
        page?: number;
        state?: string;
        to?: string;
        updated_since?: string;
    }
    | {
        client_id?: string;
        from?: string;
        is_billed?: boolean;
        page?: number;
        project_id?: string;
        to?: string;
        updated_since?: string;
        user_id?: string;
    }
    | {
        client_id?: string;
        from?: string;
        page?: number;
        project_id?: string;
        state?: ("open" | "closed" | "draft" | "paid")[];
        to?: string;
        updated_since?: string;
    }
    | {
        client_id?: string;
        is_active?: boolean;
        page?: number;
        updated_since?: string;
    }
    | {
        is_active?: boolean;
        page?: number;
        updated_since?: string;
    }
    | {
        client_id?: string;
        from?: string;
        is_billed?: boolean;
        is_running?: boolean;
        page?: number;
        to?: string;
        updated_since?: string;
        user_id?: string;
    }
    | {
        is_active?: boolean;
        page?: number;
        updated_since?: string;
    }

Default: {}

Source§

readonly firstName?: string

The first name of the contact

Source§

readonly id?: string

The ID of the client you are retrieving

Source§

readonly isBillable?: boolean

Whether the project is billable or not Default: true

Source§

readonly lastName?: string

The last name of the user

Source§

readonly limit?: number

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

Source§

readonly name?: string

The name of the client

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "createByDuration"
    | "createByStartEnd"
    | "deleteExternal"
    | "restartTime"
    | "stopTime"
    | "me"

Default: "getAll"

Source§

readonly projectId?: string

The ID of the project associated with this expense

Source§

readonly resource?:
    | "contact"
    | "company"
    | "user"
    | "project"
    | "task"
    | "invoice"
    | "timeEntry"
    | "client"
    | "estimate"
    | "expense"

Default: "task"

Source§

readonly returnAll?: boolean

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

Source§

readonly spentDate?: string

Date the expense occurred

Source§

readonly taskId?: string

The ID of the task to associate with the time entry

Source§

readonly updateFields?:
    | {
        address?: string;
        currency?: string;
        is_active?: boolean;
        name?: string;
    }
    | {
        client_id?: string;
        email?: string;
        fax?: string;
        first_name?: string;
        last_name?: string;
        phone_mobile?: string;
        phone_office?: string;
        title?: string;
    }
    | {
        client_id?: string;
        currency?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        purchase_order?: string;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        billable?: boolean;
        expense_category_id?: string;
        notes?: string;
        project_id?: string;
        spent_date?: string;
        total_cost?: string;
        units?: string;
        user_id?: boolean;
    }
    | {
        client_id?: string;
        currency?: string;
        ends_on?: string;
        estimate_id?: string;
        issue_date?: string;
        notes?: string;
        number?: string;
        over_budget_notification_percentage?: string;
        payment_term?: string;
        purchase_order?: string;
        retainer_id?: boolean;
        subject?: string;
        tax?: string;
        tax2?: string;
    }
    | {
        bill_by?: "none"
        | "People"
        | "Project"
        | "Tasks";
        budget?: string;
        budget_by?: string;
        budget_is_monthly?: boolean;
        client_id?: string;
        cost_budget?: string;
        cost_budget_include_expenses?: boolean;
        ends_on?: string;
        fee?: string;
        hourly_rate?: string;
        is_active?: boolean;
        is_billable?: boolean;
        is_fixed_fee?: boolean;
        name?: string;
        notes?: string;
        notify_when_over_budget?: boolean;
        over_budget_notification_percentage?: string;
        show_budget_to_all?: boolean;
        starts_on?: string;
    }
    | {
        billable_by_default?: boolean;
        default_hourly_rate?: number;
        is_active?: boolean;
        is_default?: boolean;
        name?: string;
    }
    | {
        ended_time?: string;
        hours?: number;
        notes?: string;
        started_time?: string;
    }
    | {
        can_create_invoices?: boolean;
        can_create_projects?: boolean;
        can_see_rates?: boolean;
        cost_rate?: number;
        default_hourly_rate?: string;
        email?: string;
        first_name?: string;
        has_access_to_all_future_projects?: boolean;
        is_active?: boolean;
        is_admin?: boolean;
        is_contractor?: boolean;
        is_project_manager?: boolean;
        last_name?: string;
        roles?: string;
        timezone?: string;
        weekly_capacity?: number;
    }

Default: {}