conductor-node-mcp 14.22.0 → 14.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3221,7 +3221,7 @@ const EMBEDDED_METHODS = [
3221
3221
  'workAuthorizationExpirationDate?: string;',
3222
3222
  ],
3223
3223
  response: 'object',
3224
- markdown: "## create\n\n`conductor.qbd.employees.create(Conductor-End-User-Id: string, accountNumber?: string, additionalNotes?: { note: string; }[], address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }, adjustedServiceDate?: string, alternatePhone?: string, billingRateId?: string, birthDate?: string, customContactFields?: { name: string; value: string; }[], department?: string, description?: string, disabilityDescription?: string, disabilityStatus?: 'disabled' | 'non_disabled', email?: string, emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }, employeePayroll?: { classId?: string; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }, employeeType?: 'officer' | 'owner' | 'regular' | 'statutory', employmentStatus?: 'full_time' | 'part_time', ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races', externalId?: string, fax?: string, firstName?: string, gender?: 'male' | 'female', hiredDate?: string, i9OnFileStatus?: 'on_file' | 'not_on_file', isActive?: boolean, jobTitle?: string, keyEmployeeStatus?: 'key_employee' | 'non_key_employee', lastName?: string, middleName?: string, militaryStatus?: 'active' | 'reserve', mobile?: string, note?: string, originalHireDate?: string, overtimeExemptStatus?: 'exempt' | 'non_exempt', pager?: string, pagerPin?: string, phone?: string, printAs?: string, salutation?: string, ssn?: string, supervisorId?: string, targetBonus?: string, terminationDate?: string, usCitizenshipStatus?: 'citizen' | 'non_citizen', usVeteranStatus?: 'veteran' | 'non_veteran', workAuthorizationExpirationDate?: string): { id: string; accountNumber: string; additionalNotes: object[]; address: object; adjustedServiceDate: string; alternatePhone: string; billingRate: object; birthDate: string; createdAt: string; customContactFields: object[]; customFields: object[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: object; employeePayroll: object; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: object; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n**post** `/quickbooks-desktop/employees`\n\nCreates an employee record that captures personal details, contact information, employment dates, and payroll settings in a single request so the employee is ready for scheduling, time tracking, and payroll processing.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The employee's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.\n\nNote that if the \"Use Account Numbers\" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.\n\n- `additionalNotes?: { note: string; }[]`\n Additional notes about this employee.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }`\n The employee's address.\n\nIf the company uses QuickBooks Payroll for this employee, this address must specify a complete address, including city, state, ZIP (or postal) code, and at least one line of the street address.\n - `city?: string`\n The city, district, suburb, town, or village name of the employee address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the employee address.\n - `line1?: string`\n The first line of the employee address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the employee address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `postalCode?: string`\n The postal code or ZIP code of the employee address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The U.S. state of the employee address. QuickBooks requires this field to be a U.S. state abbreviation (e.g., \"CA\" for California). See enum for all possible values.\n\n- `adjustedServiceDate?: string`\n The adjusted service date for this employee, in ISO 8601 format (YYYY-MM-DD). This date accounts for previous employment periods or leaves that affect seniority.\n\n- `alternatePhone?: string`\n The employee's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The employee's billing rate, used to override service item rates in time tracking activities.\n\n- `birthDate?: string`\n This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this employee, such as phone numbers or email addresses.\n\n- `department?: string`\n The employee's department. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `description?: string`\n A description of this employee. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `disabilityDescription?: string`\n A description of this employee's disability.\n\n- `disabilityStatus?: 'disabled' | 'non_disabled'`\n Indicates whether this employee is disabled.\n\n- `email?: string`\n The employee's email address.\n\n- `emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }`\n The employee's emergency contacts.\n - `primaryContact?: { name: string; value: string; relation?: string; }`\n The employee's primary emergency contact.\n - `secondaryContact?: { name: string; value: string; relation?: string; }`\n The employee's secondary emergency contact.\n\n- `employeePayroll?: { classId?: string; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }`\n The employee's payroll information.\n - `classId?: string`\n The employee's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.\n - `earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]`\n The employee's earnings.\n - `payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'`\n How frequently this employee is paid (e.g., weekly, biweekly, monthly). This determines the schedule for generating paychecks.\n - `sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's sick hours, including how sick time is accrued and the total hours accrued.\n - `useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'`\n Indicates whether this employee is using time-tracking data to create paychecks.\n - `vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's vacation hours, including how vacation time is accrued and the total hours accrued.\n\n- `employeeType?: 'officer' | 'owner' | 'regular' | 'statutory'`\n The employee type. This affects payroll taxes - a statutory employee is defined as an employee by statute. Note that owners/partners are typically on the \"Other Names\" list in QuickBooks, but if listed as an employee their type will be `owner`.\n\n- `employmentStatus?: 'full_time' | 'part_time'`\n Indicates whether this employee is a part-time or full-time employee.\n\n- `ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n This employee's ethnicity.\n\n- `externalId?: string`\n A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.\n\n- `fax?: string`\n The employee's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The employee's first name.\n\nMaximum length: 25 characters.\n\n- `gender?: 'male' | 'female'`\n This employee's gender.\n\n- `hiredDate?: string`\n The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).\n\n- `i9OnFileStatus?: 'on_file' | 'not_on_file'`\n Indicates whether this employee's I-9 is on file.\n\n- `isActive?: boolean`\n Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `jobTitle?: string`\n The employee's job title.\n\n- `keyEmployeeStatus?: 'key_employee' | 'non_key_employee'`\n Indicates whether this employee is a key employee.\n\n- `lastName?: string`\n The employee's last name.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The employee's middle name.\n\nMaximum length: 5 characters.\n\n- `militaryStatus?: 'active' | 'reserve'`\n This employee's military status if they are a U.S. veteran.\n\n- `mobile?: string`\n The employee's mobile phone number.\n\nMaximum length: 21 characters.\n\n- `note?: string`\n A note or comment about this employee.\n\n- `originalHireDate?: string`\n The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).\n\n- `overtimeExemptStatus?: 'exempt' | 'non_exempt'`\n Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).\n\n- `pager?: string`\n The employee's pager number.\n\nMaximum length: 21 characters.\n\n- `pagerPin?: string`\n The employee's pager PIN.\n\n- `phone?: string`\n The employee's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `printAs?: string`\n The name to use when printing this employee from QuickBooks. By default, this is the same as the `name` field.\n\n- `salutation?: string`\n The employee's formal salutation title that precedes their name, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `ssn?: string`\n The employee's Social Security Number. The value can be with or without dashes.\n\n**NOTE**: This field cannot be changed after the employee is created.\n\n- `supervisorId?: string`\n The employee's supervisor. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `targetBonus?: string`\n The target bonus for this employee, represented as a decimal string. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `terminationDate?: string`\n The date this employee's employment ended with the company, in ISO 8601 format (YYYY-MM-DD). This is also known as the released date or separation date.\n\n- `usCitizenshipStatus?: 'citizen' | 'non_citizen'`\n Indicates whether this employee is a U.S. citizen.\n\n- `usVeteranStatus?: 'veteran' | 'non_veteran'`\n Indicates whether this employee is a U.S. veteran.\n\n- `workAuthorizationExpirationDate?: string`\n The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalNotes: { id: number; date: string; note: string; }[]; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }; adjustedServiceDate: string; alternatePhone: string; billingRate: { id: string; fullName: string; }; birthDate: string; createdAt: string; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }; employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: object; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: { id: string; fullName: string; }; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }`\n - `adjustedServiceDate: string`\n - `alternatePhone: string`\n - `billingRate: { id: string; fullName: string; }`\n - `birthDate: string`\n - `createdAt: string`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `department: string`\n - `description: string`\n - `disabilityDescription: string`\n - `disabilityStatus: 'disabled' | 'non_disabled'`\n - `email: string`\n - `emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }`\n - `employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: { id: string; fullName: string; }; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }`\n - `employeeType: 'officer' | 'owner' | 'regular' | 'statutory'`\n - `employmentStatus: 'full_time' | 'part_time'`\n - `ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `gender: 'male' | 'female'`\n - `hiredDate: string`\n - `i9OnFileStatus: 'on_file' | 'not_on_file'`\n - `isActive: boolean`\n - `jobTitle: string`\n - `keyEmployeeStatus: 'key_employee' | 'non_key_employee'`\n - `lastName: string`\n - `middleName: string`\n - `militaryStatus: 'active' | 'reserve'`\n - `mobile: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_employee'`\n - `originalHireDate: string`\n - `overtimeExemptStatus: 'exempt' | 'non_exempt'`\n - `pager: string`\n - `pagerPin: string`\n - `phone: string`\n - `printAs: string`\n - `revisionNumber: string`\n - `salutation: string`\n - `ssn: string`\n - `supervisor: { id: string; fullName: string; }`\n - `targetBonus: string`\n - `terminationDate: string`\n - `updatedAt: string`\n - `usCitizenshipStatus: 'citizen' | 'non_citizen'`\n - `usVeteranStatus: 'veteran' | 'non_veteran'`\n - `workAuthorizationExpirationDate: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst employee = await conductor.qbd.employees.create({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(employee);\n```",
3224
+ markdown: "## create\n\n`conductor.qbd.employees.create(Conductor-End-User-Id: string, accountNumber?: string, additionalNotes?: { note: string; }[], address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }, adjustedServiceDate?: string, alternatePhone?: string, billingRateId?: string, birthDate?: string, customContactFields?: { name: string; value: string; }[], department?: string, description?: string, disabilityDescription?: string, disabilityStatus?: 'disabled' | 'non_disabled', email?: string, emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }, employeePayroll?: { classId?: string; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }, employeeType?: 'officer' | 'owner' | 'regular' | 'statutory', employmentStatus?: 'full_time' | 'part_time', ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races', externalId?: string, fax?: string, firstName?: string, gender?: 'male' | 'female', hiredDate?: string, i9OnFileStatus?: 'on_file' | 'not_on_file', isActive?: boolean, jobTitle?: string, keyEmployeeStatus?: 'key_employee' | 'non_key_employee', lastName?: string, middleName?: string, militaryStatus?: 'active' | 'reserve', mobile?: string, note?: string, originalHireDate?: string, overtimeExemptStatus?: 'exempt' | 'non_exempt', pager?: string, pagerPin?: string, phone?: string, printAs?: string, salutation?: string, ssn?: string, supervisorId?: string, targetBonus?: string, terminationDate?: string, usCitizenshipStatus?: 'citizen' | 'non_citizen', usVeteranStatus?: 'veteran' | 'non_veteran', workAuthorizationExpirationDate?: string): { id: string; accountNumber: string; additionalNotes: object[]; address: object; adjustedServiceDate: string; alternatePhone: string; billingRate: object; birthDate: string; createdAt: string; customContactFields: object[]; customFields: object[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: object; employeePayroll: object; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: object; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n**post** `/quickbooks-desktop/employees`\n\nCreates an employee record that captures personal details, contact information, employment dates, and payroll settings in a single request so the employee is ready for scheduling, time tracking, and payroll processing.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The employee's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.\n\nNote that if the \"Use Account Numbers\" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.\n\n- `additionalNotes?: { note: string; }[]`\n Additional notes about this employee.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }`\n The employee's address.\n\nIf the company uses QuickBooks Payroll for this employee, this address must specify a complete address, including city, state, ZIP (or postal) code, and at least one line of the street address.\n - `city?: string`\n The city, district, suburb, town, or village name of the employee address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the employee address.\n - `line1?: string`\n The first line of the employee address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the employee address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `postalCode?: string`\n The postal code or ZIP code of the employee address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The U.S. state or Canadian province of the employee address. QuickBooks requires this field to be a two-letter abbreviation (e.g., \"CA\" for California or \"ON\" for Ontario). See enum for all possible values. QuickBooks may reject values that the connected company file's edition does not support (e.g., a Canadian province on a U.S. company file).\n\n- `adjustedServiceDate?: string`\n The adjusted service date for this employee, in ISO 8601 format (YYYY-MM-DD). This date accounts for previous employment periods or leaves that affect seniority.\n\n- `alternatePhone?: string`\n The employee's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The employee's billing rate, used to override service item rates in time tracking activities.\n\n- `birthDate?: string`\n This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this employee, such as phone numbers or email addresses.\n\n- `department?: string`\n The employee's department. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `description?: string`\n A description of this employee. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `disabilityDescription?: string`\n A description of this employee's disability.\n\n- `disabilityStatus?: 'disabled' | 'non_disabled'`\n Indicates whether this employee is disabled.\n\n- `email?: string`\n The employee's email address.\n\n- `emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }`\n The employee's emergency contacts.\n - `primaryContact?: { name: string; value: string; relation?: string; }`\n The employee's primary emergency contact.\n - `secondaryContact?: { name: string; value: string; relation?: string; }`\n The employee's secondary emergency contact.\n\n- `employeePayroll?: { classId?: string; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }`\n The employee's payroll information.\n - `classId?: string`\n The employee's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.\n - `earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]`\n The employee's earnings.\n - `payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'`\n How frequently this employee is paid (e.g., weekly, biweekly, monthly). This determines the schedule for generating paychecks.\n - `sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's sick hours, including how sick time is accrued and the total hours accrued.\n - `useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'`\n Indicates whether this employee is using time-tracking data to create paychecks.\n - `vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's vacation hours, including how vacation time is accrued and the total hours accrued.\n\n- `employeeType?: 'officer' | 'owner' | 'regular' | 'statutory'`\n The employee type. This affects payroll taxes - a statutory employee is defined as an employee by statute. Note that owners/partners are typically on the \"Other Names\" list in QuickBooks, but if listed as an employee their type will be `owner`.\n\n- `employmentStatus?: 'full_time' | 'part_time'`\n Indicates whether this employee is a part-time or full-time employee.\n\n- `ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n This employee's ethnicity.\n\n- `externalId?: string`\n A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.\n\n- `fax?: string`\n The employee's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The employee's first name.\n\nMaximum length: 25 characters.\n\n- `gender?: 'male' | 'female'`\n This employee's gender.\n\n- `hiredDate?: string`\n The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).\n\n- `i9OnFileStatus?: 'on_file' | 'not_on_file'`\n Indicates whether this employee's I-9 is on file.\n\n- `isActive?: boolean`\n Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `jobTitle?: string`\n The employee's job title.\n\n- `keyEmployeeStatus?: 'key_employee' | 'non_key_employee'`\n Indicates whether this employee is a key employee.\n\n- `lastName?: string`\n The employee's last name.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The employee's middle name.\n\nMaximum length: 5 characters.\n\n- `militaryStatus?: 'active' | 'reserve'`\n This employee's military status if they are a U.S. veteran.\n\n- `mobile?: string`\n The employee's mobile phone number.\n\nMaximum length: 21 characters.\n\n- `note?: string`\n A note or comment about this employee.\n\n- `originalHireDate?: string`\n The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).\n\n- `overtimeExemptStatus?: 'exempt' | 'non_exempt'`\n Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).\n\n- `pager?: string`\n The employee's pager number.\n\nMaximum length: 21 characters.\n\n- `pagerPin?: string`\n The employee's pager PIN.\n\n- `phone?: string`\n The employee's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `printAs?: string`\n The name to use when printing this employee from QuickBooks. By default, this is the same as the `name` field.\n\n- `salutation?: string`\n The employee's formal salutation title that precedes their name, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `ssn?: string`\n The employee's Social Security Number. The value can be with or without dashes.\n\n**NOTE**: This field cannot be changed after the employee is created.\n\n- `supervisorId?: string`\n The employee's supervisor. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `targetBonus?: string`\n The target bonus for this employee, represented as a decimal string. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `terminationDate?: string`\n The date this employee's employment ended with the company, in ISO 8601 format (YYYY-MM-DD). This is also known as the released date or separation date.\n\n- `usCitizenshipStatus?: 'citizen' | 'non_citizen'`\n Indicates whether this employee is a U.S. citizen.\n\n- `usVeteranStatus?: 'veteran' | 'non_veteran'`\n Indicates whether this employee is a U.S. veteran.\n\n- `workAuthorizationExpirationDate?: string`\n The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalNotes: { id: number; date: string; note: string; }[]; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }; adjustedServiceDate: string; alternatePhone: string; billingRate: { id: string; fullName: string; }; birthDate: string; createdAt: string; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }; employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: object; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: { id: string; fullName: string; }; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }`\n - `adjustedServiceDate: string`\n - `alternatePhone: string`\n - `billingRate: { id: string; fullName: string; }`\n - `birthDate: string`\n - `createdAt: string`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `department: string`\n - `description: string`\n - `disabilityDescription: string`\n - `disabilityStatus: 'disabled' | 'non_disabled'`\n - `email: string`\n - `emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }`\n - `employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: { id: string; fullName: string; }; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }`\n - `employeeType: 'officer' | 'owner' | 'regular' | 'statutory'`\n - `employmentStatus: 'full_time' | 'part_time'`\n - `ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `gender: 'male' | 'female'`\n - `hiredDate: string`\n - `i9OnFileStatus: 'on_file' | 'not_on_file'`\n - `isActive: boolean`\n - `jobTitle: string`\n - `keyEmployeeStatus: 'key_employee' | 'non_key_employee'`\n - `lastName: string`\n - `middleName: string`\n - `militaryStatus: 'active' | 'reserve'`\n - `mobile: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_employee'`\n - `originalHireDate: string`\n - `overtimeExemptStatus: 'exempt' | 'non_exempt'`\n - `pager: string`\n - `pagerPin: string`\n - `phone: string`\n - `printAs: string`\n - `revisionNumber: string`\n - `salutation: string`\n - `ssn: string`\n - `supervisor: { id: string; fullName: string; }`\n - `targetBonus: string`\n - `terminationDate: string`\n - `updatedAt: string`\n - `usCitizenshipStatus: 'citizen' | 'non_citizen'`\n - `usVeteranStatus: 'veteran' | 'non_veteran'`\n - `workAuthorizationExpirationDate: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst employee = await conductor.qbd.employees.create({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(employee);\n```",
3225
3225
  perLanguage: {
3226
3226
  typescript: {
3227
3227
  method: 'client.qbd.employees.create',
@@ -3356,7 +3356,7 @@ const EMBEDDED_METHODS = [
3356
3356
  'workAuthorizationExpirationDate?: string;',
3357
3357
  ],
3358
3358
  response: 'object',
3359
- markdown: "## update\n\n`conductor.qbd.employees.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, accountNumber?: string, additionalNotes?: { id: number; note: string; }[], address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }, adjustedServiceDate?: string, alternatePhone?: string, billingRateId?: string, birthDate?: string, customContactFields?: { name: string; value: string; }[], department?: string, description?: string, disabilityDescription?: string, disabilityStatus?: 'disabled' | 'non_disabled', email?: string, emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }, employeePayroll?: { classId?: string; deleteAllEarnings?: boolean; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }, employeeType?: 'officer' | 'owner' | 'regular' | 'statutory', employmentStatus?: 'full_time' | 'part_time', ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races', fax?: string, firstName?: string, hiredDate?: string, i9OnFileStatus?: 'on_file' | 'not_on_file', isActive?: boolean, jobTitle?: string, keyEmployeeStatus?: 'key_employee' | 'non_key_employee', lastName?: string, middleName?: string, militaryStatus?: 'active' | 'reserve', mobile?: string, note?: string, originalHireDate?: string, overtimeExemptStatus?: 'exempt' | 'non_exempt', pager?: string, pagerPin?: string, phone?: string, printAs?: string, salutation?: string, supervisorId?: string, targetBonus?: string, terminationDate?: string, usCitizenshipStatus?: 'citizen' | 'non_citizen', usVeteranStatus?: 'veteran' | 'non_veteran', workAuthorizationExpirationDate?: string): { id: string; accountNumber: string; additionalNotes: object[]; address: object; adjustedServiceDate: string; alternatePhone: string; billingRate: object; birthDate: string; createdAt: string; customContactFields: object[]; customFields: object[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: object; employeePayroll: object; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: object; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n**post** `/quickbooks-desktop/employees/{id}`\n\nUpdates an employee record, allowing you to revise contact details, employment status dates, supervisory assignments, payroll configuration, and additional notes to keep workforce data current.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the employee to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the employee object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The employee's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.\n\nNote that if the \"Use Account Numbers\" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.\n\n- `additionalNotes?: { id: number; note: string; }[]`\n Additional notes about this employee.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }`\n The employee's address.\n\nIf the company uses QuickBooks Payroll for this employee, this address must specify a complete address, including city, state, ZIP (or postal) code, and at least one line of the street address.\n - `city?: string`\n The city, district, suburb, town, or village name of the employee address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the employee address.\n - `line1?: string`\n The first line of the employee address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the employee address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `postalCode?: string`\n The postal code or ZIP code of the employee address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The U.S. state of the employee address. QuickBooks requires this field to be a U.S. state abbreviation (e.g., \"CA\" for California). See enum for all possible values.\n\n- `adjustedServiceDate?: string`\n The adjusted service date for this employee, in ISO 8601 format (YYYY-MM-DD). This date accounts for previous employment periods or leaves that affect seniority.\n\n- `alternatePhone?: string`\n The employee's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The employee's billing rate, used to override service item rates in time tracking activities.\n\n- `birthDate?: string`\n This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this employee, such as phone numbers or email addresses.\n\n- `department?: string`\n The employee's department. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `description?: string`\n A description of this employee. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `disabilityDescription?: string`\n A description of this employee's disability.\n\n- `disabilityStatus?: 'disabled' | 'non_disabled'`\n Indicates whether this employee is disabled.\n\n- `email?: string`\n The employee's email address.\n\n- `emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }`\n The employee's emergency contacts.\n - `primaryContact?: { name: string; value: string; relation?: string; }`\n The employee's primary emergency contact.\n - `secondaryContact?: { name: string; value: string; relation?: string; }`\n The employee's secondary emergency contact.\n\n- `employeePayroll?: { classId?: string; deleteAllEarnings?: boolean; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }`\n The employee's payroll information.\n\n**IMPORTANT**: QuickBooks Desktop requires the connected app to have personal data access enabled to update this field. If updating this field fails with a personal data permission error, confirm this setting is enabled in QuickBooks Desktop: sign in as Admin in Single-User Mode and go to `Edit > Preferences > Integrated Applications > Company Preferences`, select the app, click `Properties`, then check \"Allow this application to access personal data such as Social Security Numbers and customer credit card information\".\n - `classId?: string`\n The employee's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.\n - `deleteAllEarnings?: boolean`\n When `true`, deletes all earnings records for this employee.\n - `earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]`\n The employee's earnings.\n\n**IMPORTANT**: When updating employees, if you include any earnings records in your update request, QuickBooks will delete all existing earnings records for this employee and replace them with the new records you provide. If you do not include any earnings records, the existing earnings records will remain unchanged. To delete all earnings records without adding new ones, set the `deleteAllEarnings` field to `true`.\n - `payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'`\n How frequently this employee is paid (e.g., weekly, biweekly, monthly). This determines the schedule for generating paychecks.\n - `sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's sick hours, including how sick time is accrued and the total hours accrued.\n - `useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'`\n Indicates whether this employee is using time-tracking data to create paychecks.\n - `vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's vacation hours, including how vacation time is accrued and the total hours accrued.\n\n- `employeeType?: 'officer' | 'owner' | 'regular' | 'statutory'`\n The employee type. This affects payroll taxes - a statutory employee is defined as an employee by statute. Note that owners/partners are typically on the \"Other Names\" list in QuickBooks, but if listed as an employee their type will be `owner`.\n\n- `employmentStatus?: 'full_time' | 'part_time'`\n Indicates whether this employee is a part-time or full-time employee.\n\n- `ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n This employee's ethnicity.\n\n- `fax?: string`\n The employee's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The employee's first name.\n\nMaximum length: 25 characters.\n\n- `hiredDate?: string`\n The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).\n\n- `i9OnFileStatus?: 'on_file' | 'not_on_file'`\n Indicates whether this employee's I-9 is on file.\n\n- `isActive?: boolean`\n Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `jobTitle?: string`\n The employee's job title.\n\n- `keyEmployeeStatus?: 'key_employee' | 'non_key_employee'`\n Indicates whether this employee is a key employee.\n\n- `lastName?: string`\n The employee's last name.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The employee's middle name.\n\nMaximum length: 5 characters.\n\n- `militaryStatus?: 'active' | 'reserve'`\n This employee's military status if they are a U.S. veteran.\n\n- `mobile?: string`\n The employee's mobile phone number.\n\nMaximum length: 21 characters.\n\n- `note?: string`\n A note or comment about this employee.\n\n- `originalHireDate?: string`\n The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).\n\n- `overtimeExemptStatus?: 'exempt' | 'non_exempt'`\n Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).\n\n- `pager?: string`\n The employee's pager number.\n\nMaximum length: 21 characters.\n\n- `pagerPin?: string`\n The employee's pager PIN.\n\n- `phone?: string`\n The employee's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `printAs?: string`\n The name to use when printing this employee from QuickBooks. By default, this is the same as the `name` field.\n\n- `salutation?: string`\n The employee's formal salutation title that precedes their name, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `supervisorId?: string`\n The employee's supervisor. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `targetBonus?: string`\n The target bonus for this employee, represented as a decimal string. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `terminationDate?: string`\n The date this employee's employment ended with the company, in ISO 8601 format (YYYY-MM-DD). This is also known as the released date or separation date.\n\n- `usCitizenshipStatus?: 'citizen' | 'non_citizen'`\n Indicates whether this employee is a U.S. citizen.\n\n- `usVeteranStatus?: 'veteran' | 'non_veteran'`\n Indicates whether this employee is a U.S. veteran.\n\n- `workAuthorizationExpirationDate?: string`\n The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalNotes: { id: number; date: string; note: string; }[]; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }; adjustedServiceDate: string; alternatePhone: string; billingRate: { id: string; fullName: string; }; birthDate: string; createdAt: string; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }; employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: object; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: { id: string; fullName: string; }; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }`\n - `adjustedServiceDate: string`\n - `alternatePhone: string`\n - `billingRate: { id: string; fullName: string; }`\n - `birthDate: string`\n - `createdAt: string`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `department: string`\n - `description: string`\n - `disabilityDescription: string`\n - `disabilityStatus: 'disabled' | 'non_disabled'`\n - `email: string`\n - `emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }`\n - `employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: { id: string; fullName: string; }; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }`\n - `employeeType: 'officer' | 'owner' | 'regular' | 'statutory'`\n - `employmentStatus: 'full_time' | 'part_time'`\n - `ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `gender: 'male' | 'female'`\n - `hiredDate: string`\n - `i9OnFileStatus: 'on_file' | 'not_on_file'`\n - `isActive: boolean`\n - `jobTitle: string`\n - `keyEmployeeStatus: 'key_employee' | 'non_key_employee'`\n - `lastName: string`\n - `middleName: string`\n - `militaryStatus: 'active' | 'reserve'`\n - `mobile: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_employee'`\n - `originalHireDate: string`\n - `overtimeExemptStatus: 'exempt' | 'non_exempt'`\n - `pager: string`\n - `pagerPin: string`\n - `phone: string`\n - `printAs: string`\n - `revisionNumber: string`\n - `salutation: string`\n - `ssn: string`\n - `supervisor: { id: string; fullName: string; }`\n - `targetBonus: string`\n - `terminationDate: string`\n - `updatedAt: string`\n - `usCitizenshipStatus: 'citizen' | 'non_citizen'`\n - `usVeteranStatus: 'veteran' | 'non_veteran'`\n - `workAuthorizationExpirationDate: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst employee = await conductor.qbd.employees.update('80000001-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(employee);\n```",
3359
+ markdown: "## update\n\n`conductor.qbd.employees.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, accountNumber?: string, additionalNotes?: { id: number; note: string; }[], address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }, adjustedServiceDate?: string, alternatePhone?: string, billingRateId?: string, birthDate?: string, customContactFields?: { name: string; value: string; }[], department?: string, description?: string, disabilityDescription?: string, disabilityStatus?: 'disabled' | 'non_disabled', email?: string, emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }, employeePayroll?: { classId?: string; deleteAllEarnings?: boolean; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }, employeeType?: 'officer' | 'owner' | 'regular' | 'statutory', employmentStatus?: 'full_time' | 'part_time', ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races', fax?: string, firstName?: string, hiredDate?: string, i9OnFileStatus?: 'on_file' | 'not_on_file', isActive?: boolean, jobTitle?: string, keyEmployeeStatus?: 'key_employee' | 'non_key_employee', lastName?: string, middleName?: string, militaryStatus?: 'active' | 'reserve', mobile?: string, note?: string, originalHireDate?: string, overtimeExemptStatus?: 'exempt' | 'non_exempt', pager?: string, pagerPin?: string, phone?: string, printAs?: string, salutation?: string, supervisorId?: string, targetBonus?: string, terminationDate?: string, usCitizenshipStatus?: 'citizen' | 'non_citizen', usVeteranStatus?: 'veteran' | 'non_veteran', workAuthorizationExpirationDate?: string): { id: string; accountNumber: string; additionalNotes: object[]; address: object; adjustedServiceDate: string; alternatePhone: string; billingRate: object; birthDate: string; createdAt: string; customContactFields: object[]; customFields: object[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: object; employeePayroll: object; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: object; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n**post** `/quickbooks-desktop/employees/{id}`\n\nUpdates an employee record, allowing you to revise contact details, employment status dates, supervisory assignments, payroll configuration, and additional notes to keep workforce data current.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the employee to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the employee object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The employee's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.\n\nNote that if the \"Use Account Numbers\" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.\n\n- `additionalNotes?: { id: number; note: string; }[]`\n Additional notes about this employee.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; postalCode?: string; state?: string; }`\n The employee's address.\n\nIf the company uses QuickBooks Payroll for this employee, this address must specify a complete address, including city, state, ZIP (or postal) code, and at least one line of the street address.\n - `city?: string`\n The city, district, suburb, town, or village name of the employee address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the employee address.\n - `line1?: string`\n The first line of the employee address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the employee address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the employee address, if needed.\n\nMaximum length: 41 characters.\n - `postalCode?: string`\n The postal code or ZIP code of the employee address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The U.S. state or Canadian province of the employee address. QuickBooks requires this field to be a two-letter abbreviation (e.g., \"CA\" for California or \"ON\" for Ontario). See enum for all possible values. QuickBooks may reject values that the connected company file's edition does not support (e.g., a Canadian province on a U.S. company file).\n\n- `adjustedServiceDate?: string`\n The adjusted service date for this employee, in ISO 8601 format (YYYY-MM-DD). This date accounts for previous employment periods or leaves that affect seniority.\n\n- `alternatePhone?: string`\n The employee's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The employee's billing rate, used to override service item rates in time tracking activities.\n\n- `birthDate?: string`\n This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this employee, such as phone numbers or email addresses.\n\n- `department?: string`\n The employee's department. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `description?: string`\n A description of this employee. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `disabilityDescription?: string`\n A description of this employee's disability.\n\n- `disabilityStatus?: 'disabled' | 'non_disabled'`\n Indicates whether this employee is disabled.\n\n- `email?: string`\n The employee's email address.\n\n- `emergencyContact?: { primaryContact?: { name: string; value: string; relation?: string; }; secondaryContact?: { name: string; value: string; relation?: string; }; }`\n The employee's emergency contacts.\n - `primaryContact?: { name: string; value: string; relation?: string; }`\n The employee's primary emergency contact.\n - `secondaryContact?: { name: string; value: string; relation?: string; }`\n The employee's secondary emergency contact.\n\n- `employeePayroll?: { classId?: string; deleteAllEarnings?: boolean; earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]; payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }; }`\n The employee's payroll information.\n\n**IMPORTANT**: QuickBooks Desktop requires the connected app to have personal data access enabled to update this field. If updating this field fails with a personal data permission error, confirm this setting is enabled in QuickBooks Desktop: sign in as Admin in Single-User Mode and go to `Edit > Preferences > Integrated Applications > Company Preferences`, select the app, click `Properties`, then check \"Allow this application to access personal data such as Social Security Numbers and customer credit card information\".\n - `classId?: string`\n The employee's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.\n - `deleteAllEarnings?: boolean`\n When `true`, deletes all earnings records for this employee.\n - `earnings?: { payrollWageItemId: string; rate?: string; ratePercent?: string; }[]`\n The employee's earnings.\n\n**IMPORTANT**: When updating employees, if you include any earnings records in your update request, QuickBooks will delete all existing earnings records for this employee and replace them with the new records you provide. If you do not include any earnings records, the existing earnings records will remain unchanged. To delete all earnings records without adding new ones, set the `deleteAllEarnings` field to `true`.\n - `payPeriod?: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'`\n How frequently this employee is paid (e.g., weekly, biweekly, monthly). This determines the schedule for generating paychecks.\n - `sickHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's sick hours, including how sick time is accrued and the total hours accrued.\n - `useTimeDataToCreatePaychecks?: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'`\n Indicates whether this employee is using time-tracking data to create paychecks.\n - `vacationHours?: { accrualPeriod?: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate?: string; hoursAccruedPerPeriod?: string; hoursAvailable?: string; hoursUsed?: string; maximumHours?: string; resetsHoursEachYear?: boolean; }`\n The employee's vacation hours, including how vacation time is accrued and the total hours accrued.\n\n- `employeeType?: 'officer' | 'owner' | 'regular' | 'statutory'`\n The employee type. This affects payroll taxes - a statutory employee is defined as an employee by statute. Note that owners/partners are typically on the \"Other Names\" list in QuickBooks, but if listed as an employee their type will be `owner`.\n\n- `employmentStatus?: 'full_time' | 'part_time'`\n Indicates whether this employee is a part-time or full-time employee.\n\n- `ethnicity?: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n This employee's ethnicity.\n\n- `fax?: string`\n The employee's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The employee's first name.\n\nMaximum length: 25 characters.\n\n- `hiredDate?: string`\n The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).\n\n- `i9OnFileStatus?: 'on_file' | 'not_on_file'`\n Indicates whether this employee's I-9 is on file.\n\n- `isActive?: boolean`\n Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `jobTitle?: string`\n The employee's job title.\n\n- `keyEmployeeStatus?: 'key_employee' | 'non_key_employee'`\n Indicates whether this employee is a key employee.\n\n- `lastName?: string`\n The employee's last name.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The employee's middle name.\n\nMaximum length: 5 characters.\n\n- `militaryStatus?: 'active' | 'reserve'`\n This employee's military status if they are a U.S. veteran.\n\n- `mobile?: string`\n The employee's mobile phone number.\n\nMaximum length: 21 characters.\n\n- `note?: string`\n A note or comment about this employee.\n\n- `originalHireDate?: string`\n The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).\n\n- `overtimeExemptStatus?: 'exempt' | 'non_exempt'`\n Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).\n\n- `pager?: string`\n The employee's pager number.\n\nMaximum length: 21 characters.\n\n- `pagerPin?: string`\n The employee's pager PIN.\n\n- `phone?: string`\n The employee's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `printAs?: string`\n The name to use when printing this employee from QuickBooks. By default, this is the same as the `name` field.\n\n- `salutation?: string`\n The employee's formal salutation title that precedes their name, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `supervisorId?: string`\n The employee's supervisor. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `targetBonus?: string`\n The target bonus for this employee, represented as a decimal string. Found in the \"employment job details\" section of the employee's record in QuickBooks.\n\n- `terminationDate?: string`\n The date this employee's employment ended with the company, in ISO 8601 format (YYYY-MM-DD). This is also known as the released date or separation date.\n\n- `usCitizenshipStatus?: 'citizen' | 'non_citizen'`\n Indicates whether this employee is a U.S. citizen.\n\n- `usVeteranStatus?: 'veteran' | 'non_veteran'`\n Indicates whether this employee is a U.S. veteran.\n\n- `workAuthorizationExpirationDate?: string`\n The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalNotes: { id: number; date: string; note: string; }[]; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }; adjustedServiceDate: string; alternatePhone: string; billingRate: { id: string; fullName: string; }; birthDate: string; createdAt: string; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }; employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: object; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: { id: string; fullName: string; }; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }`\n - `adjustedServiceDate: string`\n - `alternatePhone: string`\n - `billingRate: { id: string; fullName: string; }`\n - `birthDate: string`\n - `createdAt: string`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `department: string`\n - `description: string`\n - `disabilityDescription: string`\n - `disabilityStatus: 'disabled' | 'non_disabled'`\n - `email: string`\n - `emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }`\n - `employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: { id: string; fullName: string; }; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }`\n - `employeeType: 'officer' | 'owner' | 'regular' | 'statutory'`\n - `employmentStatus: 'full_time' | 'part_time'`\n - `ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `gender: 'male' | 'female'`\n - `hiredDate: string`\n - `i9OnFileStatus: 'on_file' | 'not_on_file'`\n - `isActive: boolean`\n - `jobTitle: string`\n - `keyEmployeeStatus: 'key_employee' | 'non_key_employee'`\n - `lastName: string`\n - `middleName: string`\n - `militaryStatus: 'active' | 'reserve'`\n - `mobile: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_employee'`\n - `originalHireDate: string`\n - `overtimeExemptStatus: 'exempt' | 'non_exempt'`\n - `pager: string`\n - `pagerPin: string`\n - `phone: string`\n - `printAs: string`\n - `revisionNumber: string`\n - `salutation: string`\n - `ssn: string`\n - `supervisor: { id: string; fullName: string; }`\n - `targetBonus: string`\n - `terminationDate: string`\n - `updatedAt: string`\n - `usCitizenshipStatus: 'citizen' | 'non_citizen'`\n - `usVeteranStatus: 'veteran' | 'non_veteran'`\n - `workAuthorizationExpirationDate: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst employee = await conductor.qbd.employees.update('80000001-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(employee);\n```",
3360
3360
  perLanguage: {
3361
3361
  typescript: {
3362
3362
  method: 'client.qbd.employees.update',