conductor-node 0.0.8 → 0.0.11

package/src/qb/qbXMLTypes/Customer.ts

@@ -0,0 +1,193 @@
+import type {
+  ActiveStatus,
+  AdditionalContactRef,
+  AdditionalNotesRet,
+  ClassFilter,
+  ClassRef,
+  ContactsRet,
+  CurrencyFilter,
+  CurrencyRef,
+  DataExtRet,
+  NameFilter,
+  NameRangeFilter,
+  ParentRef,
+  SalesTaxCodeRef,
+  SalesTaxCountry,
+  ShipAddress,
+  TermsRef,
+  TotalBalanceFilter,
+} from "@conductor/client/qb/qbXMLTypes/shared";
+
+export interface CustomerQueryRq {
+  ListID?: string;
+  FullName?: string;
+  MaxReturned?: number;
+  ActiveStatus?: ActiveStatus;
+  FromModifiedDate?: Date;
+  ToModifiedDate?: Date;
+  NameFilter?: NameFilter;
+  NameRangeFilter?: NameRangeFilter;
+  TotalBalanceFilter?: TotalBalanceFilter;
+  CurrencyFilter?: CurrencyFilter;
+  ClassFilter?: ClassFilter;
+  IncludeRetElement?: string;
+  OwnerID?: string;
+}
+
+export interface CustomerQueryRs {
+  CustomerRet?: CustomerRet;
+}
+
+export interface CustomerRet {
+  ListID: string;
+  TimeCreated: Date;
+  TimeModified: Date;
+  EditSequence: string;
+  Name: string;
+  FullName: string;
+  IsActive?: boolean;
+  ClassRef?: ClassRef;
+  ParentRef?: ParentRef;
+  Sublevel: number;
+  CompanyName?: string;
+  Salutation?: string;
+  FirstName?: string;
+  MiddleName?: string;
+  LastName?: string;
+  JobTitle?: string;
+  BillAddress?: BillAddress;
+  BillAddressBlock?: BillAddressBlock;
+  ShipAddress?: ShipAddress;
+  ShipAddressBlock?: ShipAddressBlock;
+  ShipToAddress?: ShipToAddress;
+  Phone?: string;
+  AltPhone?: string;
+  Fax?: string;
+  Email?: string;
+  Cc?: string;
+  Contact?: string;
+  AltContact?: string;
+  AdditionalContactRef?: AdditionalContactRef;
+  ContactsRet?: ContactsRet;
+  CustomerTypeRef?: CustomerTypeRef;
+  TermsRef?: TermsRef;
+  SalesRepRef?: SalesRepRef;
+  Balance?: string;
+  TotalBalance?: string;
+  SalesTaxCodeRef?: SalesTaxCodeRef;
+  ItemSalesTaxRef?: ItemSalesTaxRef;
+  SalesTaxCountry?: SalesTaxCountry;
+  ResaleNumber?: string;
+  AccountNumber?: string;
+  CreditLimit?: string;
+  PreferredPaymentMethodRef?: PreferredPaymentMethodRef;
+  CreditCardInfo?: CreditCardInfo;
+  JobStatus?: JobStatus;
+  JobStartDate?: Date;
+  JobProjectedEndDate?: Date;
+  JobEndDate?: Date;
+  JobDesc?: string;
+  JobTypeRef?: JobTypeRef;
+  Notes?: string;
+  AdditionalNotesRet?: AdditionalNotesRet;
+  PreferredDeliveryMethod?: PreferredDeliveryMethod;
+  PriceLevelRef?: PriceLevelRef;
+  ExternalGUID?: string;
+  TaxRegistrationNumber?: string;
+  CurrencyRef?: CurrencyRef;
+  DataExtRet?: DataExtRet;
+}
+
+interface BillAddress {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+  City?: string;
+  State?: string;
+  PostalCode?: string;
+  Country?: string;
+  Note?: string;
+}
+
+interface BillAddressBlock {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+}
+
+interface ShipAddressBlock {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+}
+
+interface ShipToAddress {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+  City?: string;
+  State?: string;
+  PostalCode?: string;
+  Country?: string;
+  Note?: string;
+  DefaultShipTo?: boolean;
+}
+
+interface CustomerTypeRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface SalesRepRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface ItemSalesTaxRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface PreferredPaymentMethodRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface CreditCardInfo {
+  CreditCardNumber?: string;
+  ExpirationMonth?: number;
+  ExpirationYear?: number;
+  NameOnCard?: string;
+  CreditCardAddress?: string;
+  CreditCardPostalCode?: string;
+}
+
+// Default is "None"
+type JobStatus =
+  | "Awarded"
+  | "Closed"
+  | "InProgress"
+  | "None"
+  | "NotAwarded"
+  | "Pending";
+
+interface JobTypeRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+// Default is "None"
+type PreferredDeliveryMethod = "Email" | "Fax" | "None";
+
+interface PriceLevelRef {
+  ListID?: string;
+  FullName?: string;
+}

package/src/qb/qbXMLTypes/Employee.ts

@@ -1,5 +1,9 @@
 import type {
   ActiveStatus,
+  AdditionalContactRef,
+  AdditionalNotesRet,
+  BillingRateRef,
+  ClassRef,
   DataExtRet,
   NameFilter,
   NameRangeFilter,
@@ -313,11 +317,6 @@ interface EmployeeAddress {
   PostalCode?: string;
 }
 
-interface AdditionalContactRef {
-  ContactName: string;
-  ContactValue: string;
-}
-
 interface EmergencyContacts {
   PrimaryContact?: {
     ContactName: string;
@@ -377,29 +376,30 @@ interface AdditionalNotes {
   Note: string;
 }
 
-interface AdditionalNotesRet {
-  NoteID: number;
-  Date: Date;
-  Note: string;
-}
-
 interface AdditionalNotesMod {
   NoteID: number;
   Note: string;
 }
 
-interface BillingRateRef {
-  ListID?: string;
-  FullName?: string;
-}
-
 interface EmployeePayrollInfo {
   PayPeriod?: PayPeriod;
   ClassRef?: ClassRef;
   ClearEarnings?: boolean;
   Earnings?: Earnings;
+  /**
+   * Indicates whether or not paychecks are generated from time-tracking data.
+   * If you include a blank `IsUsingTimeDataToCreatePaychecks` element in an
+   * `EmployeeMod` message, you’ll receive an error.
+   */
   IsUsingTimeDataToCreatePaychecks?: boolean;
+  /**
+   * Indicates whether time data is used to create paychecks for this employee.
+   */
   UseTimeDataToCreatePaychecks?: UseTimeDataToCreatePaychecks;
+  /**
+   * Describes how “sick time” is accrued for this employee, along with how many
+   * sick hours the employee has accrued.
+   */
   SickHours?: SickHours;
   VacationHours?: VacationHours;
 }
@@ -424,11 +424,6 @@ type PayPeriod =
   | "Weekly"
   | "Yearly";
 
-interface ClassRef {
-  ListID?: string;
-  FullName?: string;
-}
-
 interface Earnings {
   PayrollItemWageRef?: PayrollItemWageRef;
   Rate?: string;
@@ -446,12 +441,47 @@ type UseTimeDataToCreatePaychecks =
   | "UseTimeData";
 
 interface SickHours {
+  /**
+   * The total number of hours currently available for the employee to use. If
+   * this value is empty, it will default to 0.
+   */
   HoursAvailable?: string;
+  /**
+   * Indicates how an employee accrues time off. If you include a blank
+   * `AccrualPeriod` element in an `EmployeeMod` message, you’ll receive an
+   * error. The default value is whatever the QuickBooks user has set in the
+   * QuickBooks Employee Preferences.
+   */
   AccrualPeriod?: AccrualPeriod;
+  /**
+   * The number of hours that the employee will accrue per accrual period. The
+   * default value is whatever the QuickBooks user has set in the QuickBooks
+   * Employee Preferences.
+   */
   HoursAccrued?: string;
+  /**
+   * The maximum number of hours that the employee can accrue. (QuickBooks
+   * itself does not enforce this limit, however. HoursAvailable can be greater
+   * than MaximumHours.) The default value is whatever the QuickBooks user has
+   * set in the QuickBooks Employee Preferences.
+   */
   MaximumHours?: string;
+  /**
+   * Indicates whether or not the hours accrued resets to zero at the beginning
+   * of the new year. If you include a blank `IsResettingHoursEachNewYear`
+   * element in an `EmployeeMod` message, you’ll receive an error.
+   */
   IsResettingHoursEachNewYear?: boolean;
+  /**
+   * When used in the `SickHours` or `VacationHours` aggregates, refers to the
+   * number of sick leave or vacation hours used in the current year.
+   */
   HoursUsed?: string;
+  /**
+   * When used in the `SickHours` or `VacationHours` aggregates, refers to the
+   * date on which sick leave or vacation hours in the current year began to
+   * accrue.
+   */
   AccrualStartDate?: Date;
 }
 

package/src/qb/qbXMLTypes/Vendor.ts

@@ -0,0 +1,192 @@
+import type {
+  ActiveStatus,
+  AdditionalContactRef,
+  AdditionalNotesRet,
+  BillingRateRef,
+  ClassFilter,
+  ClassRef,
+  ContactsRet,
+  CurrencyFilter,
+  CurrencyRef,
+  DataExtRet,
+  NameFilter,
+  NameRangeFilter,
+  SalesTaxCodeRef,
+  SalesTaxCountry,
+  ShipAddress,
+  TermsRef,
+  TotalBalanceFilter,
+} from "@conductor/client/qb/qbXMLTypes/shared";
+
+export interface VendorQueryRq {
+  ListID?: string;
+  FullName?: string;
+  MaxReturned?: number;
+  ActiveStatus?: ActiveStatus;
+  FromModifiedDate?: Date;
+  ToModifiedDate?: Date;
+  NameFilter?: NameFilter;
+  NameRangeFilter?: NameRangeFilter;
+  TotalBalanceFilter?: TotalBalanceFilter;
+  CurrencyFilter?: CurrencyFilter;
+  ClassFilter?: ClassFilter;
+  IncludeRetElement?: string;
+  OwnerID?: string;
+}
+
+export interface VendorQueryRs {
+  VendorRet?: VendorRet;
+}
+
+export interface VendorRet {
+  ListID: string;
+  TimeCreated: Date;
+  TimeModified: Date;
+  EditSequence: string;
+  Name: string;
+  /**
+   * If `IsActive` is `true`, this object is currently enabled for use by
+   * QuickBooks. The default value is `true`.
+   */
+  IsActive?: boolean;
+  /**
+   * Classes can be used to separate transactions into meaningful categories.
+   * (For example, transactions could be classified according to department,
+   * business location, or type of work.) In QuickBooks, class tracking is off
+   * by default. A `ClassRef` aggregate refers to one of these named classes.
+   * For example, in a `TimeTracking` message, `ClassRef` refers to the
+   * QuickBooks class into which the timed activity falls. If a `ClassRef`
+   * aggregate includes both `FullName` and `ListID`, `FullName` will be
+   * ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the
+   * whole invoice, that same `ClassRef` is automatically used in the line
+   * items. If you want to clear that (that is, have NO `ClassRef` for the line
+   * item, you can clear it in the line item by simply not specifying it in the
+   * line item.
+   */
+  ClassRef?: ClassRef;
+  /**
+   * Is the current entity a tax agency.
+   */
+  IsTaxAgency?: boolean;
+  /**
+   * The name of the QuickBooks user’s business, as specified in QuickBooks.
+   * `CompanyName` and `Address` are used on invoices, checks, and other forms.
+   * (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a
+   * company’s tax forms and pay stubs.)
+   */
+  CompanyName?: string;
+  /**
+   * A formal reference, such as Mr. or Dr., that precedes a name.
+   */
+  Salutation?: string;
+  /**
+   * The first name of a customer, vendor, employee, or person on the “other
+   * names” list.
+   */
+  FirstName?: string;
+  /**
+   * The middle name of a customer, vendor, employee, or person on the “other
+   * names” list.
+   */
+  MiddleName?: string;
+  /**
+   * The last name of a customer, vendor, employee, or person on the “other
+   * names” list.
+   */
+  LastName?: string;
+  /**
+   * The job title of a customer, vendor, employee, or person on the “other
+   * names” list.
+   */
+  JobTitle?: string;
+  /**
+   * If an address request fails, some combination of address fields might be
+   * too long.
+   */
+  VendorAddress?: VendorAddress;
+  VendorAddressBlock?: VendorAddressBlock;
+  ShipAddress?: ShipAddress;
+  Phone?: string;
+  AltPhone?: string;
+  Fax?: string;
+  Email?: string;
+  Cc?: string;
+  Contact?: string;
+  AltContact?: string;
+  AdditionalContactRef?: AdditionalContactRef;
+  ContactsRet?: ContactsRet;
+  NameOnCheck?: string;
+  AccountNumber?: string;
+  Notes?: string;
+  AdditionalNotesRet?: AdditionalNotesRet;
+  VendorTypeRef?: VendorTypeRef;
+  TermsRef?: TermsRef;
+  CreditLimit?: string;
+  VendorTaxIdent?: string;
+  IsVendorEligibleFor1099?: boolean;
+  Balance?: string;
+  BillingRateRef?: BillingRateRef;
+  ExternalGUID?: string;
+  SalesTaxCodeRef?: SalesTaxCodeRef;
+  SalesTaxCountry?: SalesTaxCountry;
+  IsSalesTaxAgency?: boolean;
+  SalesTaxReturnRef?: SalesTaxReturnRef;
+  TaxRegistrationNumber?: string;
+  ResaleNumber?: ReportingPeriod;
+  IsTaxTrackedOnPurchases?: boolean;
+  TaxOnPurchasesAccountRef?: TaxOnPurchasesAccountRef;
+  IsTaxTrackedOnSales?: boolean;
+  TaxOnSalesAccountRef?: TaxOnSalesAccountRef;
+  IsTaxOnTax?: boolean;
+  PrefillAccountRef?: PrefillAccountRef;
+  CurrencyRef?: CurrencyRef;
+  DataExtRet?: DataExtRet;
+}
+
+interface VendorAddress {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+  City?: string;
+  State?: string;
+  PostalCode?: string;
+  Country?: string;
+  Note?: string;
+}
+
+interface VendorAddressBlock {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+}
+
+interface VendorTypeRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface SalesTaxReturnRef {
+  ListID?: string;
+  FullNam?: string;
+}
+
+// Default is Quarterly
+type ReportingPeriod = "Monthly" | "Quarterly";
+
+interface TaxOnPurchasesAccountRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+interface TaxOnSalesAccountRef {
+  ListID?: string;
+}
+
+interface PrefillAccountRef {
+  ListID?: string;
+  FullName?: string;
+}

package/src/qb/qbXMLTypes/shared.ts

@@ -46,3 +46,98 @@ type DataExtType =
   | "QUANTYPE"
   | "STR255TYPE"
   | "STR1024TYPE";
+
+export interface CurrencyFilter {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface ClassRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface AdditionalContactRef {
+  ContactName: string;
+  ContactValue: string;
+}
+
+export interface AdditionalNotesRet {
+  NoteID: number;
+  Date: Date;
+  Note: string;
+}
+
+export interface BillingRateRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface SalesTaxCodeRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface CurrencyRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface TotalBalanceFilter {
+  Operator: Operator;
+  Amount: string;
+}
+
+type Operator =
+  | "Equal"
+  | "GreaterThan"
+  | "GreaterThanEqual"
+  | "LessThan"
+  | "LessThanEqual";
+
+export interface ClassFilter {
+  ListID?: string;
+  FullName?: string;
+  ListIDWithChildren?: string;
+  FullNameWithChildren?: string;
+}
+
+export interface ParentRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+export interface ShipAddress {
+  Addr1?: string;
+  Addr2?: string;
+  Addr3?: string;
+  Addr4?: string;
+  Addr5?: string;
+  City?: string;
+  State?: string;
+  PostalCode?: string;
+  Country?: string;
+  Note?: string;
+}
+
+export interface ContactsRet {
+  ListID: string;
+  TimeCreated: Date;
+  TimeModified: Date;
+  EditSequence: string;
+  Contact?: string;
+  Salutation?: string;
+  FirstName?: string;
+  MiddleName?: string;
+  LastName?: string;
+  JobTitle?: string;
+  AdditionalContactRef?: AdditionalContactRef;
+}
+
+export interface TermsRef {
+  ListID?: string;
+  FullName?: string;
+}
+
+// Default is Canada
+export type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";