conductor-node-mcp 14.21.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',
@@ -9056,7 +9056,7 @@ const EMBEDDED_METHODS = [
9056
9056
  'openingBalanceDate?: string;',
9057
9057
  'phone?: string;',
9058
9058
  'purchaseTaxAccountId?: string;',
9059
- "reportingPeriod?: 'annual' | 'monthly' | 'quarterly';",
9059
+ "reportingPeriod?: 'monthly' | 'quarterly';",
9060
9060
  'salesTaxAccountId?: string;',
9061
9061
  'salesTaxCodeId?: string;',
9062
9062
  "salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us';",
@@ -9068,8 +9068,8 @@ const EMBEDDED_METHODS = [
9068
9068
  'termsId?: string;',
9069
9069
  'vendorTypeId?: string;',
9070
9070
  ],
9071
- response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9072
- markdown: "## create\n\n`conductor.qbd.vendors.create(name: string, Conductor-End-User-Id: string, accountNumber?: string, additionalContacts?: { firstName: string; customContactFields?: { name: string; value: string; }[]; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[], additionalNotes?: { note: string; }[], alternateContact?: string, alternatePhone?: string, billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, billingRateId?: string, ccEmail?: string, classId?: string, companyName?: string, contact?: string, creditLimit?: string, currencyId?: string, customContactFields?: { name: string; value: string; }[], defaultExpenseAccountIds?: string[], email?: string, externalId?: string, fax?: string, firstName?: string, isActive?: boolean, isCompoundingTax?: boolean, isEligibleFor1099?: boolean, isSalesTaxAgency?: boolean, isTrackingPurchaseTax?: boolean, isTrackingSalesTax?: boolean, jobTitle?: string, lastName?: string, middleName?: string, nameOnCheck?: string, note?: string, openingBalance?: string, openingBalanceDate?: string, phone?: string, purchaseTaxAccountId?: string, reportingPeriod?: 'annual' | 'monthly' | 'quarterly', salesTaxAccountId?: string, salesTaxCodeId?: string, salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us', salesTaxReturnId?: string, salutation?: string, shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, taxIdentificationNumber?: string, taxRegistrationNumber?: string, termsId?: string, vendorTypeId?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**post** `/quickbooks-desktop/vendors`\n\nCreates a new vendor.\n\n### Parameters\n\n- `name: string`\n The case-insensitive unique name of this vendor, unique across all vendors.\n\n**NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 41 characters.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The vendor'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- `additionalContacts?: { firstName: string; customContactFields?: { name: string; value: string; }[]; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[]`\n Additional alternate contacts for this vendor.\n\n- `additionalNotes?: { note: string; }[]`\n Additional notes about this vendor.\n\n- `alternateContact?: string`\n The name of a alternate contact person for this vendor.\n\n- `alternatePhone?: string`\n The vendor's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's billing address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The vendor's billing rate, used to override service item rates in time tracking activities.\n\n- `ccEmail?: string`\n An email address to carbon copy (CC) on communications with this vendor.\n\n- `classId?: string`\n The vendor'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\n- `companyName?: string`\n The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.\n\nMaximum length: 41 characters.\n\n- `contact?: string`\n The name of the primary contact person for this vendor.\n\n- `creditLimit?: string`\n The vendor's credit limit, represented as a decimal string. This is the maximum amount of money that can be spent being before billed by this vendor. If `null`, there is no credit limit.\n\n- `currencyId?: string`\n The vendor's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this vendor, such as phone numbers or email addresses.\n\n- `defaultExpenseAccountIds?: string[]`\n The expense accounts to prefill when entering bills for this vendor.\n\n- `email?: string`\n The vendor's email address.\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 vendor's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The first name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `isActive?: boolean`\n Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `isCompoundingTax?: boolean`\n Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.\n\n- `isEligibleFor1099?: boolean`\n Indicates whether this vendor is eligible to receive a 1099 form for tax reporting purposes. When `true`, then the fields `taxId` and `billingAddress` are required.\n\n- `isSalesTaxAgency?: boolean`\n Indicates whether this vendor is a sales tax agency.\n\n- `isTrackingPurchaseTax?: boolean`\n Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.\n\n- `isTrackingSalesTax?: boolean`\n Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.\n\n- `jobTitle?: string`\n The job title of the contact person for this vendor.\n\n- `lastName?: string`\n The last name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The middle name of the contact person for this vendor.\n\nMaximum length: 5 characters.\n\n- `nameOnCheck?: string`\n The vendor's name as it should appear on checks issued to this vendor.\n\nMaximum length: 41 characters.\n\n- `note?: string`\n A note or comment about this vendor.\n\n- `openingBalance?: string`\n The opening balance of this vendor's account, indicating the amount owed to this vendor, represented as a decimal string.\n\n- `openingBalanceDate?: string`\n The date of the opening balance of this vendor, in ISO 8601 format (YYYY-MM-DD).\n\n- `phone?: string`\n The vendor's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `purchaseTaxAccountId?: string`\n The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.\n\n- `reportingPeriod?: 'annual' | 'monthly' | 'quarterly'`\n The vendor's tax reporting period, for use in Canada or the UK.\n\n- `salesTaxAccountId?: string`\n The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.\n\n- `salesTaxCodeId?: string`\n The default sales-tax code for transactions with this vendor, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.\n\nDefault codes include \"Non\" (non-taxable) and \"Tax\" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the \"Do You Charge Sales Tax?\" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.\n\n- `salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us'`\n The country for which sales tax is collected for this vendor.\n\n- `salesTaxReturnId?: string`\n The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.\n\n- `salutation?: string`\n The formal salutation title that precedes the name of the contact person for this vendor, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's shipping address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `taxIdentificationNumber?: string`\n The vendor's tax identification number (e.g., EIN or SSN).\n\n- `taxRegistrationNumber?: string`\n The vendor's tax registration number, for use in Canada or the UK.\n\n- `termsId?: string`\n The vendor's payment terms, defining when payment is due and any applicable discounts.\n\n- `vendorTypeId?: string`\n The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'annual' | 'monthly' | 'quarterly'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.create({ name: 'Acme Supplies Inc.', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9071
+ response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9072
+ markdown: "## create\n\n`conductor.qbd.vendors.create(name: string, Conductor-End-User-Id: string, accountNumber?: string, additionalContacts?: { firstName: string; customContactFields?: { name: string; value: string; }[]; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[], additionalNotes?: { note: string; }[], alternateContact?: string, alternatePhone?: string, billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, billingRateId?: string, ccEmail?: string, classId?: string, companyName?: string, contact?: string, creditLimit?: string, currencyId?: string, customContactFields?: { name: string; value: string; }[], defaultExpenseAccountIds?: string[], email?: string, externalId?: string, fax?: string, firstName?: string, isActive?: boolean, isCompoundingTax?: boolean, isEligibleFor1099?: boolean, isSalesTaxAgency?: boolean, isTrackingPurchaseTax?: boolean, isTrackingSalesTax?: boolean, jobTitle?: string, lastName?: string, middleName?: string, nameOnCheck?: string, note?: string, openingBalance?: string, openingBalanceDate?: string, phone?: string, purchaseTaxAccountId?: string, reportingPeriod?: 'monthly' | 'quarterly', salesTaxAccountId?: string, salesTaxCodeId?: string, salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us', salesTaxReturnId?: string, salutation?: string, shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, taxIdentificationNumber?: string, taxRegistrationNumber?: string, termsId?: string, vendorTypeId?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**post** `/quickbooks-desktop/vendors`\n\nCreates a new vendor.\n\n### Parameters\n\n- `name: string`\n The case-insensitive unique name of this vendor, unique across all vendors.\n\n**NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 41 characters.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountNumber?: string`\n The vendor'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- `additionalContacts?: { firstName: string; customContactFields?: { name: string; value: string; }[]; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[]`\n Additional alternate contacts for this vendor.\n\n- `additionalNotes?: { note: string; }[]`\n Additional notes about this vendor.\n\n- `alternateContact?: string`\n The name of a alternate contact person for this vendor.\n\n- `alternatePhone?: string`\n The vendor's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's billing address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The vendor's billing rate, used to override service item rates in time tracking activities.\n\n- `ccEmail?: string`\n An email address to carbon copy (CC) on communications with this vendor.\n\n- `classId?: string`\n The vendor'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\n- `companyName?: string`\n The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.\n\nMaximum length: 41 characters.\n\n- `contact?: string`\n The name of the primary contact person for this vendor.\n\n- `creditLimit?: string`\n The vendor's credit limit, represented as a decimal string. This is the maximum amount of money that can be spent being before billed by this vendor. If `null`, there is no credit limit.\n\n- `currencyId?: string`\n The vendor's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this vendor, such as phone numbers or email addresses.\n\n- `defaultExpenseAccountIds?: string[]`\n The expense accounts to prefill when entering bills for this vendor.\n\n- `email?: string`\n The vendor's email address.\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 vendor's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The first name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `isActive?: boolean`\n Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `isCompoundingTax?: boolean`\n Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.\n\n- `isEligibleFor1099?: boolean`\n Indicates whether this vendor is eligible to receive a 1099 form for tax reporting purposes. When `true`, then the fields `taxId` and `billingAddress` are required.\n\n- `isSalesTaxAgency?: boolean`\n Indicates whether this vendor is a sales tax agency.\n\n- `isTrackingPurchaseTax?: boolean`\n Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.\n\n- `isTrackingSalesTax?: boolean`\n Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.\n\n- `jobTitle?: string`\n The job title of the contact person for this vendor.\n\n- `lastName?: string`\n The last name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The middle name of the contact person for this vendor.\n\nMaximum length: 5 characters.\n\n- `nameOnCheck?: string`\n The vendor's name as it should appear on checks issued to this vendor.\n\nMaximum length: 41 characters.\n\n- `note?: string`\n A note or comment about this vendor.\n\n- `openingBalance?: string`\n The opening balance of this vendor's account, indicating the amount owed to this vendor, represented as a decimal string.\n\n- `openingBalanceDate?: string`\n The date of the opening balance of this vendor, in ISO 8601 format (YYYY-MM-DD).\n\n- `phone?: string`\n The vendor's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `purchaseTaxAccountId?: string`\n The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.\n\n- `reportingPeriod?: 'monthly' | 'quarterly'`\n The vendor's tax reporting period, for use in Canada or the UK.\n\n- `salesTaxAccountId?: string`\n The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.\n\n- `salesTaxCodeId?: string`\n The default sales-tax code for transactions with this vendor, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.\n\nDefault codes include \"Non\" (non-taxable) and \"Tax\" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the \"Do You Charge Sales Tax?\" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.\n\n- `salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us'`\n The country for which sales tax is collected for this vendor.\n\n- `salesTaxReturnId?: string`\n The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.\n\n- `salutation?: string`\n The formal salutation title that precedes the name of the contact person for this vendor, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's shipping address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `taxIdentificationNumber?: string`\n The vendor's tax identification number (e.g., EIN or SSN).\n\n- `taxRegistrationNumber?: string`\n The vendor's tax registration number, for use in Canada or the UK.\n\n- `termsId?: string`\n The vendor's payment terms, defining when payment is due and any applicable discounts.\n\n- `vendorTypeId?: string`\n The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.create({ name: 'Acme Supplies Inc.', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9073
9073
  perLanguage: {
9074
9074
  typescript: {
9075
9075
  method: 'client.qbd.vendors.create',
@@ -9114,8 +9114,8 @@ const EMBEDDED_METHODS = [
9114
9114
  'updatedAfter?: string;',
9115
9115
  'updatedBefore?: string;',
9116
9116
  ],
9117
- response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9118
- markdown: "## list\n\n`conductor.qbd.vendors.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors`\n\nReturns a list of vendors. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for vendors of these classes. A class is a way end-users can categorize vendors in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for vendors in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific vendors by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for vendors whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for vendors whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for vendors whose `name` is alphabetically greater than or equal to this value.\n\n- `names?: string[]`\n Filter for specific vendors by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a vendor.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for vendors whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for vendors whose `name` is alphabetically less than or equal to this value.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for vendors that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for vendors whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for vendors whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for vendors whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for vendors updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendors updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'annual' | 'monthly' | 'quarterly'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendor of conductor.qbd.vendors.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendor);\n}\n```",
9117
+ response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9118
+ markdown: "## list\n\n`conductor.qbd.vendors.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors`\n\nReturns a list of vendors. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for vendors of these classes. A class is a way end-users can categorize vendors in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for vendors in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific vendors by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for vendors whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for vendors whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for vendors whose `name` is alphabetically greater than or equal to this value.\n\n- `names?: string[]`\n Filter for specific vendors by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a vendor.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for vendors whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for vendors whose `name` is alphabetically less than or equal to this value.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for vendors that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for vendors whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for vendors whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for vendors whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for vendors updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendors updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendor of conductor.qbd.vendors.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendor);\n}\n```",
9119
9119
  perLanguage: {
9120
9120
  typescript: {
9121
9121
  method: 'client.qbd.vendors.list',
@@ -9139,8 +9139,8 @@ const EMBEDDED_METHODS = [
9139
9139
  stainlessPath: '(resource) qbd.vendors > (method) retrieve',
9140
9140
  qualified: 'client.qbd.vendors.retrieve',
9141
9141
  params: ['id: string;', 'Conductor-End-User-Id: string;'],
9142
- response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9143
- markdown: "## retrieve\n\n`conductor.qbd.vendors.retrieve(id: string, Conductor-End-User-Id: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors/{id}`\n\nRetrieves a vendor by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific vendors by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the vendor to retrieve.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'annual' | 'monthly' | 'quarterly'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.retrieve('80000001-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9142
+ response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9143
+ markdown: "## retrieve\n\n`conductor.qbd.vendors.retrieve(id: string, Conductor-End-User-Id: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors/{id}`\n\nRetrieves a vendor by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific vendors by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the vendor to retrieve.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.retrieve('80000001-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9144
9144
  perLanguage: {
9145
9145
  typescript: {
9146
9146
  method: 'client.qbd.vendors.retrieve',
@@ -9199,7 +9199,7 @@ const EMBEDDED_METHODS = [
9199
9199
  'note?: string;',
9200
9200
  'phone?: string;',
9201
9201
  'purchaseTaxAccountId?: string;',
9202
- "reportingPeriod?: 'annual' | 'monthly' | 'quarterly';",
9202
+ "reportingPeriod?: 'monthly' | 'quarterly';",
9203
9203
  'salesTaxAccountId?: string;',
9204
9204
  'salesTaxCodeId?: string;',
9205
9205
  "salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us';",
@@ -9211,8 +9211,8 @@ const EMBEDDED_METHODS = [
9211
9211
  'termsId?: string;',
9212
9212
  'vendorTypeId?: string;',
9213
9213
  ],
9214
- response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9215
- markdown: "## update\n\n`conductor.qbd.vendors.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, accountNumber?: string, additionalContacts?: { id: string; revisionNumber: string; customContactFields?: { name: string; value: string; }[]; firstName?: string; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[], additionalNotes?: { id: number; note: string; }[], alternateContact?: string, alternatePhone?: string, billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, billingRateId?: string, ccEmail?: string, classId?: string, companyName?: string, contact?: string, creditLimit?: string, currencyId?: string, customContactFields?: { name: string; value: string; }[], defaultExpenseAccountIds?: string[], email?: string, fax?: string, firstName?: string, isActive?: boolean, isCompoundingTax?: boolean, isEligibleFor1099?: boolean, isSalesTaxAgency?: boolean, isTrackingPurchaseTax?: boolean, isTrackingSalesTax?: boolean, jobTitle?: string, lastName?: string, middleName?: string, name?: string, nameOnCheck?: string, note?: string, phone?: string, purchaseTaxAccountId?: string, reportingPeriod?: 'annual' | 'monthly' | 'quarterly', salesTaxAccountId?: string, salesTaxCodeId?: string, salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us', salesTaxReturnId?: string, salutation?: string, shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, taxIdentificationNumber?: string, taxRegistrationNumber?: string, termsId?: string, vendorTypeId?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**post** `/quickbooks-desktop/vendors/{id}`\n\nUpdates an existing vendor.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the vendor to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the vendor 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 vendor'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- `additionalContacts?: { id: string; revisionNumber: string; customContactFields?: { name: string; value: string; }[]; firstName?: string; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[]`\n Additional alternate contacts for this vendor.\n\n- `additionalNotes?: { id: number; note: string; }[]`\n Additional notes about this vendor.\n\n- `alternateContact?: string`\n The name of a alternate contact person for this vendor.\n\n- `alternatePhone?: string`\n The vendor's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's billing address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The vendor's billing rate, used to override service item rates in time tracking activities.\n\n- `ccEmail?: string`\n An email address to carbon copy (CC) on communications with this vendor.\n\n- `classId?: string`\n The vendor'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\n- `companyName?: string`\n The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.\n\nMaximum length: 41 characters.\n\n- `contact?: string`\n The name of the primary contact person for this vendor.\n\n- `creditLimit?: string`\n The vendor's credit limit, represented as a decimal string. This is the maximum amount of money that can be spent being before billed by this vendor. If `null`, there is no credit limit.\n\n- `currencyId?: string`\n The vendor's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this vendor, such as phone numbers or email addresses.\n\n- `defaultExpenseAccountIds?: string[]`\n The expense accounts to prefill when entering bills for this vendor.\n\n- `email?: string`\n The vendor's email address.\n\n- `fax?: string`\n The vendor's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The first name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `isActive?: boolean`\n Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `isCompoundingTax?: boolean`\n Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.\n\n- `isEligibleFor1099?: boolean`\n Indicates whether this vendor is eligible to receive a 1099 form for tax reporting purposes. When `true`, then the fields `taxId` and `billingAddress` are required.\n\n- `isSalesTaxAgency?: boolean`\n Indicates whether this vendor is a sales tax agency.\n\n- `isTrackingPurchaseTax?: boolean`\n Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.\n\n- `isTrackingSalesTax?: boolean`\n Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.\n\n- `jobTitle?: string`\n The job title of the contact person for this vendor.\n\n- `lastName?: string`\n The last name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The middle name of the contact person for this vendor.\n\nMaximum length: 5 characters.\n\n- `name?: string`\n The case-insensitive unique name of this vendor, unique across all vendors.\n\n**NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 41 characters.\n\n- `nameOnCheck?: string`\n The vendor's name as it should appear on checks issued to this vendor.\n\nMaximum length: 41 characters.\n\n- `note?: string`\n A note or comment about this vendor.\n\n- `phone?: string`\n The vendor's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `purchaseTaxAccountId?: string`\n The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.\n\n- `reportingPeriod?: 'annual' | 'monthly' | 'quarterly'`\n The vendor's tax reporting period, for use in Canada or the UK.\n\n- `salesTaxAccountId?: string`\n The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.\n\n- `salesTaxCodeId?: string`\n The default sales-tax code for transactions with this vendor, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.\n\nDefault codes include \"Non\" (non-taxable) and \"Tax\" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the \"Do You Charge Sales Tax?\" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.\n\n- `salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us'`\n The country for which sales tax is collected for this vendor.\n\n- `salesTaxReturnId?: string`\n The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.\n\n- `salutation?: string`\n The formal salutation title that precedes the name of the contact person for this vendor, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's shipping address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `taxIdentificationNumber?: string`\n The vendor's tax identification number (e.g., EIN or SSN).\n\n- `taxRegistrationNumber?: string`\n The vendor's tax registration number, for use in Canada or the UK.\n\n- `termsId?: string`\n The vendor's payment terms, defining when payment is due and any applicable discounts.\n\n- `vendorTypeId?: string`\n The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'annual' | 'monthly' | 'quarterly'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'annual' | 'monthly' | 'quarterly'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.update('80000001-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9214
+ response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
9215
+ markdown: "## update\n\n`conductor.qbd.vendors.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, accountNumber?: string, additionalContacts?: { id: string; revisionNumber: string; customContactFields?: { name: string; value: string; }[]; firstName?: string; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[], additionalNotes?: { id: number; note: string; }[], alternateContact?: string, alternatePhone?: string, billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, billingRateId?: string, ccEmail?: string, classId?: string, companyName?: string, contact?: string, creditLimit?: string, currencyId?: string, customContactFields?: { name: string; value: string; }[], defaultExpenseAccountIds?: string[], email?: string, fax?: string, firstName?: string, isActive?: boolean, isCompoundingTax?: boolean, isEligibleFor1099?: boolean, isSalesTaxAgency?: boolean, isTrackingPurchaseTax?: boolean, isTrackingSalesTax?: boolean, jobTitle?: string, lastName?: string, middleName?: string, name?: string, nameOnCheck?: string, note?: string, phone?: string, purchaseTaxAccountId?: string, reportingPeriod?: 'monthly' | 'quarterly', salesTaxAccountId?: string, salesTaxCodeId?: string, salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us', salesTaxReturnId?: string, salutation?: string, shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, taxIdentificationNumber?: string, taxRegistrationNumber?: string, termsId?: string, vendorTypeId?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**post** `/quickbooks-desktop/vendors/{id}`\n\nUpdates an existing vendor.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the vendor to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the vendor 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 vendor'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- `additionalContacts?: { id: string; revisionNumber: string; customContactFields?: { name: string; value: string; }[]; firstName?: string; jobTitle?: string; lastName?: string; middleName?: string; salutation?: string; }[]`\n Additional alternate contacts for this vendor.\n\n- `additionalNotes?: { id: number; note: string; }[]`\n Additional notes about this vendor.\n\n- `alternateContact?: string`\n The name of a alternate contact person for this vendor.\n\n- `alternatePhone?: string`\n The vendor's alternate telephone number.\n\nMaximum length: 21 characters.\n\n- `billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's billing address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `billingRateId?: string`\n The vendor's billing rate, used to override service item rates in time tracking activities.\n\n- `ccEmail?: string`\n An email address to carbon copy (CC) on communications with this vendor.\n\n- `classId?: string`\n The vendor'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\n- `companyName?: string`\n The name of the company associated with this vendor. This name is used on invoices, checks, and other forms.\n\nMaximum length: 41 characters.\n\n- `contact?: string`\n The name of the primary contact person for this vendor.\n\n- `creditLimit?: string`\n The vendor's credit limit, represented as a decimal string. This is the maximum amount of money that can be spent being before billed by this vendor. If `null`, there is no credit limit.\n\n- `currencyId?: string`\n The vendor's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.\n\n- `customContactFields?: { name: string; value: string; }[]`\n Additional custom contact fields for this vendor, such as phone numbers or email addresses.\n\n- `defaultExpenseAccountIds?: string[]`\n The expense accounts to prefill when entering bills for this vendor.\n\n- `email?: string`\n The vendor's email address.\n\n- `fax?: string`\n The vendor's fax number.\n\nMaximum length: 21 characters.\n\n- `firstName?: string`\n The first name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `isActive?: boolean`\n Indicates whether this vendor is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `isCompoundingTax?: boolean`\n Indicates whether tax is charged on top of tax for this vendor, for use in Canada or the UK.\n\n- `isEligibleFor1099?: boolean`\n Indicates whether this vendor is eligible to receive a 1099 form for tax reporting purposes. When `true`, then the fields `taxId` and `billingAddress` are required.\n\n- `isSalesTaxAgency?: boolean`\n Indicates whether this vendor is a sales tax agency.\n\n- `isTrackingPurchaseTax?: boolean`\n Indicates whether tax is tracked on purchases for this vendor, for use in Canada or the UK.\n\n- `isTrackingSalesTax?: boolean`\n Indicates whether tax is tracked on sales for this vendor, for use in Canada or the UK.\n\n- `jobTitle?: string`\n The job title of the contact person for this vendor.\n\n- `lastName?: string`\n The last name of the contact person for this vendor.\n\nMaximum length: 25 characters.\n\n- `middleName?: string`\n The middle name of the contact person for this vendor.\n\nMaximum length: 5 characters.\n\n- `name?: string`\n The case-insensitive unique name of this vendor, unique across all vendors.\n\n**NOTE**: Vendors do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 41 characters.\n\n- `nameOnCheck?: string`\n The vendor's name as it should appear on checks issued to this vendor.\n\nMaximum length: 41 characters.\n\n- `note?: string`\n A note or comment about this vendor.\n\n- `phone?: string`\n The vendor's primary telephone number.\n\nMaximum length: 21 characters.\n\n- `purchaseTaxAccountId?: string`\n The account used for tracking taxes on purchases for this vendor, for use in Canada or the UK.\n\n- `reportingPeriod?: 'monthly' | 'quarterly'`\n The vendor's tax reporting period, for use in Canada or the UK.\n\n- `salesTaxAccountId?: string`\n The account used for tracking taxes on sales for this vendor, for use in Canada or the UK.\n\n- `salesTaxCodeId?: string`\n The default sales-tax code for transactions with this vendor, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.\n\nDefault codes include \"Non\" (non-taxable) and \"Tax\" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the \"Do You Charge Sales Tax?\" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.\n\n- `salesTaxCountry?: 'australia' | 'canada' | 'uk' | 'us'`\n The country for which sales tax is collected for this vendor.\n\n- `salesTaxReturnId?: string`\n The vendor's sales tax return information, used for tracking and reporting sales tax liabilities.\n\n- `salutation?: string`\n The formal salutation title that precedes the name of the contact person for this vendor, such as \"Mr.\", \"Ms.\", or \"Dr.\".\n\n- `shippingAddress?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The vendor's shipping address.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `taxIdentificationNumber?: string`\n The vendor's tax identification number (e.g., EIN or SSN).\n\n- `taxRegistrationNumber?: string`\n The vendor's tax registration number, for use in Canada or the UK.\n\n- `termsId?: string`\n The vendor's payment terms, defining when payment is due and any applicable discounts.\n\n- `vendorTypeId?: string`\n The vendor's type, used for categorizing vendors into meaningful segments, such as industry or region.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendor = await conductor.qbd.vendors.update('80000001-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendor);\n```",
9216
9216
  perLanguage: {
9217
9217
  typescript: {
9218
9218
  method: 'client.qbd.vendors.update',