nxus-qbd 0.3.0 → 0.3.2

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.
Files changed (64) hide show
  1. package/README.md +52 -1
  2. package/dist/client.d.ts +18 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +11 -3
  5. package/dist/client.js.map +1 -1
  6. package/dist/generated/index.d.ts +1 -1
  7. package/dist/generated/index.d.ts.map +1 -1
  8. package/dist/generated/index.js +1 -1
  9. package/dist/generated/index.js.map +1 -1
  10. package/dist/generated/types.gen.d.ts +919 -610
  11. package/dist/generated/types.gen.d.ts.map +1 -1
  12. package/dist/generated/types.gen.js.map +1 -1
  13. package/dist/models/index.d.ts +2 -2
  14. package/dist/models/index.d.ts.map +1 -1
  15. package/dist/models/index.js +2 -2
  16. package/dist/models/index.js.map +1 -1
  17. package/dist/models/qbd/bill_payment_or_credit.d.ts +2 -0
  18. package/dist/models/qbd/bill_payment_or_credit.d.ts.map +1 -0
  19. package/dist/models/qbd/bill_payment_or_credit.js +3 -0
  20. package/dist/models/qbd/bill_payment_or_credit.js.map +1 -0
  21. package/dist/models/qbd/check.d.ts +1 -1
  22. package/dist/models/qbd/check.d.ts.map +1 -1
  23. package/dist/models/qbd/check.js +0 -1
  24. package/dist/models/qbd/check.js.map +1 -1
  25. package/dist/models/qbd/check_bill.d.ts +1 -1
  26. package/dist/models/qbd/check_bill.d.ts.map +1 -1
  27. package/dist/models/qbd/check_bill.js +0 -1
  28. package/dist/models/qbd/check_bill.js.map +1 -1
  29. package/dist/models/qbd/credit_card_bill.d.ts +1 -1
  30. package/dist/models/qbd/credit_card_bill.d.ts.map +1 -1
  31. package/dist/models/qbd/credit_card_bill.js +0 -1
  32. package/dist/models/qbd/credit_card_bill.js.map +1 -1
  33. package/dist/models/qbd/index.d.ts +1 -1
  34. package/dist/models/qbd/index.d.ts.map +1 -1
  35. package/dist/models/qbd/index.js +1 -1
  36. package/dist/models/qbd/index.js.map +1 -1
  37. package/dist/models/qbd/inventory_adjustment.d.ts +1 -1
  38. package/dist/models/qbd/inventory_adjustment.d.ts.map +1 -1
  39. package/dist/models/qbd/inventory_adjustment.js +0 -1
  40. package/dist/models/qbd/inventory_adjustment.js.map +1 -1
  41. package/dist/models/qbd/item_service.d.ts +1 -1
  42. package/dist/models/qbd/item_service.d.ts.map +1 -1
  43. package/dist/models/qbd/item_service.js +0 -1
  44. package/dist/models/qbd/item_service.js.map +1 -1
  45. package/dist/models/qbd/receive_payment.d.ts +1 -1
  46. package/dist/models/qbd/receive_payment.d.ts.map +1 -1
  47. package/dist/models/qbd/sales_receipt.d.ts +1 -1
  48. package/dist/models/qbd/sales_receipt.d.ts.map +1 -1
  49. package/dist/models/qbd/sales_receipt.js +0 -1
  50. package/dist/models/qbd/sales_receipt.js.map +1 -1
  51. package/dist/resources/base.d.ts.map +1 -1
  52. package/dist/resources/base.js +15 -5
  53. package/dist/resources/base.js.map +1 -1
  54. package/dist/resources/connections.d.ts.map +1 -1
  55. package/dist/resources/connections.js +3 -1
  56. package/dist/resources/connections.js.map +1 -1
  57. package/dist/resources/reports.d.ts.map +1 -1
  58. package/dist/resources/reports.js +3 -1
  59. package/dist/resources/reports.js.map +1 -1
  60. package/dist/transport.d.ts +30 -0
  61. package/dist/transport.d.ts.map +1 -1
  62. package/dist/transport.js +131 -17
  63. package/dist/transport.js.map +1 -1
  64. package/package.json +7 -4
@@ -18,13 +18,22 @@ export type Account = {
18
18
  * The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. Parent:Child:SubChild
19
19
  */
20
20
  fullName?: string | null;
21
- parent?: QbdRef;
21
+ /**
22
+ * The short name of the account as it appears in the QuickBooks UI.
23
+ */
24
+ parent?: QbdRef | null;
22
25
  /**
23
26
  * Depth level of the account in the hierarchy (0 for top level).
24
27
  */
25
28
  sublevel?: number;
26
- accountType?: NullableAccountType;
27
- specialAccountType?: NullableSpecialAccountType;
29
+ /**
30
+ * The specific type of the account.
31
+ */
32
+ accountType?: NullableAccountType | null;
33
+ /**
34
+ * Special sub-classification for the account.
35
+ */
36
+ specialAccountType?: NullableSpecialAccountType | null;
28
37
  /**
29
38
  * Whether the account is a tax account (optional, default: false)
30
39
  * Only set to true for accounts that track tax liabilities/expenses
@@ -44,10 +53,21 @@ export type Account = {
44
53
  description?: string | null;
45
54
  balance?: number | null;
46
55
  totalBalance?: number | null;
47
- salesTaxCode?: QbdRef;
48
- taxLineDetails?: TaxLineInfo;
49
- cashFlowClassification?: NullableCashFlowClassification;
50
- currency?: QbdRef;
56
+ /**
57
+ * Reference to the associated Sales Tax Code.
58
+ * Derived from SalesTaxCodeRef.
59
+ */
60
+ salesTaxCode?: QbdRef | null;
61
+ taxLineDetails?: TaxLineInfo | null;
62
+ /**
63
+ * Cash flow classification for the account.
64
+ */
65
+ cashFlowClassification?: NullableCashFlowClassification | null;
66
+ /**
67
+ * Reference to the currency associated with the account.
68
+ * Derived from CurrencyRef.
69
+ */
70
+ currency?: QbdRef | null;
51
71
  /**
52
72
  * Whether the account is active (default: true)
53
73
  */
@@ -194,7 +214,7 @@ export type AddressRequest = {
194
214
  export type ApiResponseReport = {
195
215
  success?: boolean;
196
216
  message?: string | null;
197
- data?: Report;
217
+ data?: Report | null;
198
218
  timestamp?: string;
199
219
  requestId?: string | null;
200
220
  };
@@ -208,17 +228,17 @@ export type ApplicableCredit = {
208
228
  updatedAt: string;
209
229
  revisionNumber: string;
210
230
  transactionDate?: string | null;
211
- currency?: QbdRef;
231
+ currency?: QbdRef | null;
212
232
  exchangeRate?: number | null;
213
233
  refNumber?: string | null;
214
234
  memo?: string | null;
215
235
  transactionType?: string | null;
216
- payablesAccount?: QbdRef;
236
+ payablesAccount?: QbdRef | null;
217
237
  creditRemaining?: number | null;
218
238
  creditRemainingInHomeCurrency?: number | null;
219
239
  amount?: number | null;
220
- entity?: QbdRef;
221
- account?: QbdRef;
240
+ entity?: QbdRef | null;
241
+ account?: QbdRef | null;
222
242
  hasValidLineItems?: boolean;
223
243
  externalId?: string | null;
224
244
  linkedTransactions?: Array<LinkedTransaction> | null;
@@ -293,8 +313,14 @@ export type AppliedToTxn = {
293
313
  * The discount amount given on the applied-to transaction.
294
314
  */
295
315
  discountAmount?: number | null;
296
- discountAccount?: QbdRef;
297
- discountClass?: QbdRef;
316
+ /**
317
+ * Reference to the discount account used.
318
+ */
319
+ discountAccount?: QbdRef | null;
320
+ /**
321
+ * Reference to the class used for the discount.
322
+ */
323
+ discountClass?: QbdRef | null;
298
324
  linkedTransactions?: Array<LinkedTransaction> | null;
299
325
  /**
300
326
  * Credits applied to this transaction.
@@ -364,7 +390,7 @@ export type ArRefundCreditCard = {
364
390
  updatedAt: string;
365
391
  revisionNumber: string;
366
392
  transactionDate?: string | null;
367
- currency?: QbdRef;
393
+ currency?: QbdRef | null;
368
394
  /**
369
395
  * (Optional) The exchange rate for the transaction.
370
396
  */
@@ -378,18 +404,21 @@ export type ArRefundCreditCard = {
378
404
  */
379
405
  memo?: string | null;
380
406
  transactionNumber?: number | null;
381
- receivablesAccount?: QbdRef;
382
- address?: Address;
383
- addressBlock?: AddressBlock;
384
- paymentMethod?: QbdRef;
385
- creditCardTransaction?: CreditCardTransactionInfo;
407
+ receivablesAccount?: QbdRef | null;
408
+ /**
409
+ * (Optional) Address details for the refund.
410
+ */
411
+ address?: Address | null;
412
+ addressBlock?: AddressBlock | null;
413
+ paymentMethod?: QbdRef | null;
414
+ creditCardTransaction?: CreditCardTransactionInfo | null;
386
415
  /**
387
416
  * (Required) List of credit transactions (e.g., Credit Memos) to apply this refund to.
388
417
  */
389
418
  refundAppliedToTxns?: Array<RefundAppliedToTransaction> | null;
390
419
  amount?: number | null;
391
- entity?: QbdRef;
392
- account?: QbdRef;
420
+ entity?: QbdRef | null;
421
+ account?: QbdRef | null;
393
422
  amountInHomeCurrency?: string | null;
394
423
  hasValidLineItems?: boolean;
395
424
  externalId?: string | null;
@@ -1783,9 +1812,16 @@ export type Bill = {
1783
1812
  updatedAt: string;
1784
1813
  revisionNumber: string;
1785
1814
  transactionNumber?: number | null;
1786
- vendor?: QbdRef;
1787
- vendorAddress?: Address;
1788
- payablesAccount?: QbdRef;
1815
+ /**
1816
+ * The vendor who issued the bill. When linking to a Purchase Order, this vendor
1817
+ * must match the vendor on the Purchase Order.
1818
+ */
1819
+ vendor?: QbdRef | null;
1820
+ /**
1821
+ * The billing address of the vendor.
1822
+ */
1823
+ vendorAddress?: Address | null;
1824
+ payablesAccount?: QbdRef | null;
1789
1825
  transactionDate?: string | null;
1790
1826
  /**
1791
1827
  * The date by which the bill must be paid.
@@ -1795,7 +1831,7 @@ export type Bill = {
1795
1831
  * The total monetary amount of the bill.
1796
1832
  */
1797
1833
  amountDue?: number;
1798
- currency?: QbdRef;
1834
+ currency?: QbdRef | null;
1799
1835
  /**
1800
1836
  * Exchange rate for multi-currency transactions (v8.0).
1801
1837
  */
@@ -1813,13 +1849,23 @@ export type Bill = {
1813
1849
  * Indicates whether the bill is currently marked as pending.
1814
1850
  */
1815
1851
  isPending?: boolean | null;
1816
- terms?: QbdRef;
1817
- class?: QbdRef;
1852
+ /**
1853
+ * The payment terms associated with the bill (e.g., Net 30), which calculate the DueDate.
1854
+ */
1855
+ terms?: QbdRef | null;
1856
+ /**
1857
+ * The class associated with the bill, used for categorizing expenses and reporting
1858
+ * (requires class tracking to be enabled in QuickBooks).
1859
+ */
1860
+ class?: QbdRef | null;
1818
1861
  /**
1819
1862
  * Memo/description for the bill.
1820
1863
  */
1821
1864
  memo?: string | null;
1822
- salesTaxCode?: QbdRef;
1865
+ /**
1866
+ * The sales tax code indicating the general taxability of the bill (e.g., Tax, Non).
1867
+ */
1868
+ salesTaxCode?: QbdRef | null;
1823
1869
  /**
1824
1870
  * Indicates whether the bill has been paid in full and closed.
1825
1871
  */
@@ -1829,7 +1875,7 @@ export type Bill = {
1829
1875
  * Indicates whether the amounts in the bill already include sales tax.
1830
1876
  */
1831
1877
  isTaxIncluded?: boolean | null;
1832
- account?: QbdRef;
1878
+ account?: QbdRef | null;
1833
1879
  hasValidLineItems?: boolean;
1834
1880
  externalId?: string | null;
1835
1881
  linkedTransactions?: Array<LinkedTransaction> | null;
@@ -1906,7 +1952,10 @@ export type BillingRateItemRequest = {
1906
1952
  * Represents a custom rate or percentage adjustment applied to a specific service item within a billing rate [2, 4].
1907
1953
  */
1908
1954
  export type BillingRatePerItem = {
1909
- item?: QbdRef;
1955
+ /**
1956
+ * A reference to the specific service item this custom rate applies to [4, 5].
1957
+ */
1958
+ item?: QbdRef | null;
1910
1959
  /**
1911
1960
  * A fixed hourly rate for this specific service item that overrides the item's standard rate [6].
1912
1961
  */
@@ -1926,8 +1975,8 @@ export type BillPaymentOrCredit = {
1926
1975
  createdAt: string;
1927
1976
  updatedAt: string;
1928
1977
  revisionNumber: string;
1929
- bill?: PayableBill;
1930
- credit?: ApplicableCredit;
1978
+ bill?: PayableBill | null;
1979
+ credit?: ApplicableCredit | null;
1931
1980
  customFields?: Array<QbdDataExt> | null;
1932
1981
  };
1933
1982
  /**
@@ -1940,7 +1989,7 @@ export type BuildAssembly = {
1940
1989
  updatedAt: string;
1941
1990
  revisionNumber: string;
1942
1991
  transactionDate?: string | null;
1943
- currency?: QbdRef;
1992
+ currency?: QbdRef | null;
1944
1993
  exchangeRate?: number | null;
1945
1994
  /**
1946
1995
  * (Optional) The reference number for the build.
@@ -1954,9 +2003,12 @@ export type BuildAssembly = {
1954
2003
  * The internal transaction number.
1955
2004
  */
1956
2005
  txnNumber?: number | null;
1957
- itemInventoryAssembly?: QbdRef;
1958
- inventorySite?: QbdRef;
1959
- inventorySiteLocation?: QbdRef;
2006
+ /**
2007
+ * Reference to the Inventory Assembly Item being built.
2008
+ */
2009
+ itemInventoryAssembly?: QbdRef | null;
2010
+ inventorySite?: QbdRef | null;
2011
+ inventorySiteLocation?: QbdRef | null;
1960
2012
  /**
1961
2013
  * (Optional) Serial number for the built assembly.
1962
2014
  */
@@ -1982,8 +2034,8 @@ export type BuildAssembly = {
1982
2034
  quantityOnSalesOrder?: number | null;
1983
2035
  lines?: Array<ComponentItemLine> | null;
1984
2036
  amount?: number | null;
1985
- entity?: QbdRef;
1986
- account?: QbdRef;
2037
+ entity?: QbdRef | null;
2038
+ account?: QbdRef | null;
1987
2039
  amountInHomeCurrency?: string | null;
1988
2040
  hasValidLineItems?: boolean;
1989
2041
  externalId?: string | null;
@@ -1999,7 +2051,7 @@ export type BuildAssembly = {
1999
2051
  */
2000
2052
  export type CashBackInfo = {
2001
2053
  transactionLineId?: string | null;
2002
- account?: QbdRef;
2054
+ account?: QbdRef | null;
2003
2055
  /**
2004
2056
  * (Optional) Memo about the cash back line. (Max 4095 characters)
2005
2057
  */
@@ -2039,7 +2091,7 @@ export type Charge = {
2039
2091
  updatedAt: string;
2040
2092
  revisionNumber: string;
2041
2093
  transactionDate?: string | null;
2042
- currency?: QbdRef;
2094
+ currency?: QbdRef | null;
2043
2095
  exchangeRate?: number | null;
2044
2096
  /**
2045
2097
  * (Optional) The reference number.
@@ -2047,10 +2099,10 @@ export type Charge = {
2047
2099
  refNumber?: string | null;
2048
2100
  memo?: string | null;
2049
2101
  txnNumber?: number | null;
2050
- customer?: QbdRef;
2051
- item?: QbdRef;
2052
- inventorySite?: QbdRef;
2053
- inventorySiteLocation?: QbdRef;
2102
+ customer?: QbdRef | null;
2103
+ item?: QbdRef | null;
2104
+ inventorySite?: QbdRef | null;
2105
+ inventorySiteLocation?: QbdRef | null;
2054
2106
  /**
2055
2107
  * (Optional) Quantity of the item.
2056
2108
  */
@@ -2059,8 +2111,8 @@ export type Charge = {
2059
2111
  * (Optional) Unit of measure.
2060
2112
  */
2061
2113
  unitOfMeasure?: string | null;
2062
- overrideUnitOfMeasureSet?: QbdRef;
2063
- overrideItemAccount?: QbdRef;
2114
+ overrideUnitOfMeasureSet?: QbdRef | null;
2115
+ overrideItemAccount?: QbdRef | null;
2064
2116
  /**
2065
2117
  * (Optional) The rate or price per unit.
2066
2118
  */
@@ -2070,8 +2122,8 @@ export type Charge = {
2070
2122
  * (Optional) Description of the charge.
2071
2123
  */
2072
2124
  description?: string | null;
2073
- receivablesAccount?: QbdRef;
2074
- class?: QbdRef;
2125
+ receivablesAccount?: QbdRef | null;
2126
+ class?: QbdRef | null;
2075
2127
  /**
2076
2128
  * (Optional) The date the charge was billed.
2077
2129
  */
@@ -2085,8 +2137,8 @@ export type Charge = {
2085
2137
  * (Optional) The total amount of the charge.
2086
2138
  */
2087
2139
  amount?: number | null;
2088
- entity?: QbdRef;
2089
- account?: QbdRef;
2140
+ entity?: QbdRef | null;
2141
+ account?: QbdRef | null;
2090
2142
  amountInHomeCurrency?: string | null;
2091
2143
  hasValidLineItems?: boolean;
2092
2144
  externalId?: string | null;
@@ -2107,7 +2159,7 @@ export type Check = {
2107
2159
  updatedAt: string;
2108
2160
  revisionNumber: string;
2109
2161
  transactionDate?: string | null;
2110
- currency?: QbdRef;
2162
+ currency?: QbdRef | null;
2111
2163
  /**
2112
2164
  * Exchange rate (for multi-currency)
2113
2165
  */
@@ -2120,19 +2172,22 @@ export type Check = {
2120
2172
  * Memo/description for the check
2121
2173
  */
2122
2174
  memo?: string | null;
2123
- address?: Address;
2175
+ /**
2176
+ * Payee address (optional)
2177
+ */
2178
+ address?: Address | null;
2124
2179
  isPending?: boolean | null;
2125
2180
  isQueuedForPrint?: boolean;
2126
2181
  /**
2127
2182
  * If true, the amount includes sales tax.
2128
2183
  */
2129
2184
  isTaxIncluded?: boolean | null;
2130
- salesTaxCode?: QbdRef;
2185
+ salesTaxCode?: QbdRef | null;
2131
2186
  isVoid?: boolean;
2132
2187
  transactionNumber?: number | null;
2133
2188
  amount?: number | null;
2134
- entity?: QbdRef;
2135
- account?: QbdRef;
2189
+ entity?: QbdRef | null;
2190
+ account?: QbdRef | null;
2136
2191
  amountInHomeCurrency?: string | null;
2137
2192
  hasValidLineItems?: boolean;
2138
2193
  externalId?: string | null;
@@ -2176,7 +2231,7 @@ export type CheckBill = {
2176
2231
  updatedAt: string;
2177
2232
  revisionNumber: string;
2178
2233
  transactionDate?: string | null;
2179
- currency?: QbdRef;
2234
+ currency?: QbdRef | null;
2180
2235
  /**
2181
2236
  * (Optional) The currency exchange rate.
2182
2237
  */
@@ -2193,9 +2248,15 @@ export type CheckBill = {
2193
2248
  */
2194
2249
  memo?: string | null;
2195
2250
  transactionNumber?: number | null;
2196
- payablesAccount?: QbdRef;
2197
- address?: Address;
2198
- addressBlock?: AddressBlock;
2251
+ payablesAccount?: QbdRef | null;
2252
+ /**
2253
+ * The payee's full address.
2254
+ */
2255
+ address?: Address | null;
2256
+ /**
2257
+ * The address block formatted for printing on the check.
2258
+ */
2259
+ addressBlock?: AddressBlock | null;
2199
2260
  isQueuedForPrint?: boolean | null;
2200
2261
  /**
2201
2262
  * (Required) List of transactions (bills) to apply this check to.
@@ -2206,8 +2267,8 @@ export type CheckBill = {
2206
2267
  * (Optional) The total amount of the check.
2207
2268
  */
2208
2269
  amount?: number | null;
2209
- entity?: QbdRef;
2210
- account?: QbdRef;
2270
+ entity?: QbdRef | null;
2271
+ account?: QbdRef | null;
2211
2272
  /**
2212
2273
  * (Optional) The amount in the home currency.
2213
2274
  */
@@ -2240,7 +2301,7 @@ export type Class = {
2240
2301
  * The FullName is the name prefixed by the names of each ancestor, for example Parent:Child:SubClass. FullName values are not case-sensitive.
2241
2302
  */
2242
2303
  fullName?: string | null;
2243
- parent?: QbdRef;
2304
+ parent?: QbdRef | null;
2244
2305
  /**
2245
2306
  * A number indicating the number of ancestors. For example, The customer job with Name = carpets and FullName = Jones:Building2:carpets would have a sublevel of 2.
2246
2307
  */
@@ -2257,9 +2318,12 @@ export type Class = {
2257
2318
  */
2258
2319
  export type ComponentItemLine = {
2259
2320
  objectType?: string;
2260
- item?: QbdRef;
2261
- inventorySite?: QbdRef;
2262
- inventorySiteLocation?: QbdRef;
2321
+ /**
2322
+ * The Inventory Assembly item being created.
2323
+ */
2324
+ item?: QbdRef | null;
2325
+ inventorySite?: QbdRef | null;
2326
+ inventorySiteLocation?: QbdRef | null;
2263
2327
  serialNumber?: string | null;
2264
2328
  lotNumber?: string | null;
2265
2329
  expirationDateForSerialLotNumber?: string | null;
@@ -2488,7 +2552,10 @@ export type CreateArRefundCreditCardRequest = {
2488
2552
  * (Optional) The reference number for the refund.
2489
2553
  */
2490
2554
  refNumber?: string | null;
2491
- address?: AddressRequest;
2555
+ /**
2556
+ * (Optional) Address details for the refund.
2557
+ */
2558
+ address?: AddressRequest | null;
2492
2559
  /**
2493
2560
  * (Optional) The ListID or FullName of the payment method.
2494
2561
  */
@@ -2497,7 +2564,7 @@ export type CreateArRefundCreditCardRequest = {
2497
2564
  * (Optional) A memo for the transaction.
2498
2565
  */
2499
2566
  memo?: string | null;
2500
- creditCardTransaction?: CreditCardTransactionInfo;
2567
+ creditCardTransaction?: CreditCardTransactionInfo | null;
2501
2568
  /**
2502
2569
  * (Optional) The exchange rate for the transaction.
2503
2570
  */
@@ -2562,7 +2629,10 @@ export type CreateBillRequest = {
2562
2629
  * Filter by Vendor ID.
2563
2630
  */
2564
2631
  vendorId: string;
2565
- vendorAddress?: AddressRequest;
2632
+ /**
2633
+ * Optional vendor address override.
2634
+ */
2635
+ vendorAddress?: AddressRequest | null;
2566
2636
  payablesAccountId?: string | null;
2567
2637
  transactionDate: string;
2568
2638
  /**
@@ -2823,7 +2893,10 @@ export type CreateCheckRequest = {
2823
2893
  * The ListID or FullName of the sales tax code.
2824
2894
  */
2825
2895
  salesTaxCodeId?: string | null;
2826
- address?: Address;
2896
+ /**
2897
+ * Payee address (optional)
2898
+ */
2899
+ address?: Address | null;
2827
2900
  /**
2828
2901
  * Exchange rate (for multi-currency)
2829
2902
  */
@@ -3068,8 +3141,8 @@ export type CreateCreditCardTransactionInputInfoRequest = {
3068
3141
  creditCardAddress?: string | null;
3069
3142
  creditCardPostalCode?: string | null;
3070
3143
  commercialCardCode?: string | null;
3071
- transactionMode?: NullableTransactionMode;
3072
- creditCardTxnType?: NullableCreditCardTransactionType;
3144
+ transactionMode?: NullableTransactionMode | null;
3145
+ creditCardTxnType?: NullableCreditCardTransactionType | null;
3073
3146
  };
3074
3147
  /**
3075
3148
  * Results from the payment gateway for a Credit Card transaction.
@@ -3082,9 +3155,9 @@ export type CreateCreditCardTransactionResultInfoRequest = {
3082
3155
  paymentStatus: PaymentStatus;
3083
3156
  txnAuthorizationTime: string;
3084
3157
  authorizationCode?: string | null;
3085
- avsStreet?: NullableAvsStreet;
3086
- avsZip?: NullableAvsZip;
3087
- cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
3158
+ avsStreet?: NullableAvsStreet | null;
3159
+ avsZip?: NullableAvsZip | null;
3160
+ cardSecurityCodeMatch?: NullableCardSecurityCodeMatch | null;
3088
3161
  reconBatchId?: string | null;
3089
3162
  paymentGroupingCode?: number | null;
3090
3163
  txnAuthorizationStamp?: number | null;
@@ -3188,7 +3261,7 @@ export type CreateCreditMemoLineRequest = {
3188
3261
  overrideItemAccountId?: string | null;
3189
3262
  otherCustomField1?: string | null;
3190
3263
  otherCustomField2?: string | null;
3191
- creditCardTransactionInfo?: CreateCreditCardTransactionInfoRequest;
3264
+ creditCardTransactionInfo?: CreateCreditCardTransactionInfoRequest | null;
3192
3265
  customFields?: Array<DataExtRequest> | null;
3193
3266
  };
3194
3267
  /**
@@ -3216,8 +3289,8 @@ export type CreateCreditMemoRequest = {
3216
3289
  * (Optional) The reference number (e.g., Credit Memo #).
3217
3290
  */
3218
3291
  refNumber?: string | null;
3219
- billingAddress?: AddressRequest;
3220
- shippingAddress?: AddressRequest;
3292
+ billingAddress?: AddressRequest | null;
3293
+ shippingAddress?: AddressRequest | null;
3221
3294
  /**
3222
3295
  * (Optional) Indicates if the credit memo is pending.
3223
3296
  */
@@ -3295,7 +3368,10 @@ export type CreateCurrencyRequest = {
3295
3368
  * (Required) The three-letter currency code (e.g., USD, EUR). Values are normalized to trimmed uppercase. (Max 3 characters)
3296
3369
  */
3297
3370
  currencyCode: string;
3298
- currencyFormat?: CurrencyFormatRequest;
3371
+ /**
3372
+ * (Optional) Specifies the formatting rules for the currency.
3373
+ */
3374
+ currencyFormat?: CurrencyFormatRequest | null;
3299
3375
  externalId?: string | null;
3300
3376
  };
3301
3377
  /**
@@ -3312,8 +3388,8 @@ export type CreateCustomerRequest = {
3312
3388
  middleName?: string | null;
3313
3389
  lastName?: string | null;
3314
3390
  jobTitle?: string | null;
3315
- billingAddress?: AddressRequest;
3316
- shippingAddress?: AddressRequest;
3391
+ billingAddress?: AddressRequest | null;
3392
+ shippingAddress?: AddressRequest | null;
3317
3393
  shippingAddresses?: Array<ShipToAddressRequest> | null;
3318
3394
  phone?: string | null;
3319
3395
  altPhone?: string | null;
@@ -3336,8 +3412,11 @@ export type CreateCustomerRequest = {
3336
3412
  accountNumber?: string | null;
3337
3413
  creditLimit?: number | null;
3338
3414
  preferredPaymentMethodId?: string | null;
3339
- creditCardInfo?: CreditCardInfo;
3340
- jobStatus?: NullableJobStatus;
3415
+ creditCardInfo?: CreditCardInfo | null;
3416
+ /**
3417
+ * JobStatus may have one of the following values: Awarded, Closed, InProgress, None [DEFAULT], NotAwarded, Pending
3418
+ */
3419
+ jobStatus?: NullableJobStatus | null;
3341
3420
  jobStartDate?: string | null;
3342
3421
  jobProjectedEndDate?: string | null;
3343
3422
  jobEndDate?: string | null;
@@ -3394,8 +3473,16 @@ export type CreateDateDrivenTermRequest = {
3394
3473
  * Defines a single Deposit Line item to be added to the Deposit (uses discriminator pattern).
3395
3474
  */
3396
3475
  export type CreateDepositLineRequest = {
3397
- paymentLine?: DepositPaymentLineRequest;
3398
- manualLine?: DepositManualLineRequest;
3476
+ /**
3477
+ * (Optional) Details for depositing a previously recorded payment (ReceivePayment, SalesReceipt).
3478
+ * Mutually exclusive with ManualLine.
3479
+ */
3480
+ paymentLine?: DepositPaymentLineRequest | null;
3481
+ /**
3482
+ * (Optional) Details for manually depositing a fund from another source.
3483
+ * Mutually exclusive with PaymentLine.
3484
+ */
3485
+ manualLine?: DepositManualLineRequest | null;
3399
3486
  };
3400
3487
  /**
3401
3488
  * After you receive payments from customers (see ReceivePayment), you can use
@@ -3415,7 +3502,10 @@ export type CreateDepositRequest = {
3415
3502
  * (Optional) General memo about the Deposit. (Max 4095 characters)
3416
3503
  */
3417
3504
  memo?: string | null;
3418
- cashBackInfo?: CashBackInfoRequest;
3505
+ /**
3506
+ * (Optional) Information about cash back requested from the deposit total.
3507
+ */
3508
+ cashBackInfo?: CashBackInfoRequest | null;
3419
3509
  /**
3420
3510
  * (Optional) The ListID or FullName of the currency for the transaction.
3421
3511
  * Follows the Flattened-ID Pattern for CurrencyRef.
@@ -3450,7 +3540,7 @@ export type CreateEmployeeRequest = {
3450
3540
  supervisorId?: string | null;
3451
3541
  department?: string | null;
3452
3542
  description?: string | null;
3453
- employeeAddress?: EmployeeAddress;
3543
+ employeeAddress?: EmployeeAddress | null;
3454
3544
  printAs?: string | null;
3455
3545
  phone?: string | null;
3456
3546
  mobile?: string | null;
@@ -3464,7 +3554,10 @@ export type CreateEmployeeRequest = {
3464
3554
  * Additional contact references (may repeat, v12.0+).
3465
3555
  */
3466
3556
  additionalContacts?: Array<AdditionalContact> | null;
3467
- emergencyContacts?: EmergencyContact;
3557
+ /**
3558
+ * Emergency contacts for the employee (QBD only, v13.0+).
3559
+ */
3560
+ emergencyContacts?: EmergencyContact | null;
3468
3561
  /**
3469
3562
  * Additional notes (may repeat, v12.0+). For Add, only Note is needed.
3470
3563
  */
@@ -3494,7 +3587,7 @@ export type CreateEmployeeRequest = {
3494
3587
  workAuthExpireDate?: string | null;
3495
3588
  usVeteran?: string | null;
3496
3589
  militaryStatus?: string | null;
3497
- employeePayrollInfo?: EmployeePayrollInfo;
3590
+ employeePayrollInfo?: EmployeePayrollInfo | null;
3498
3591
  externalId?: string | null;
3499
3592
  suffix?: string | null;
3500
3593
  };
@@ -3575,8 +3668,8 @@ export type CreateEstimateRequest = {
3575
3668
  * (Optional) The sequential reference number for the Estimate (e.g., Estimate Number). (STRTYPE)
3576
3669
  */
3577
3670
  refNumber?: string | null;
3578
- billingAddress?: AddressRequest;
3579
- shippingAddress?: AddressRequest;
3671
+ billingAddress?: AddressRequest | null;
3672
+ shippingAddress?: AddressRequest | null;
3580
3673
  /**
3581
3674
  * (Optional) Whether the Estimate is active. (BOOLTYPE)
3582
3675
  */
@@ -3685,10 +3778,10 @@ export type CreateExpenseLineRequest = {
3685
3778
  export type CreateInventoryAdjustmentLineRequest = {
3686
3779
  itemId: string;
3687
3780
  memo?: string | null;
3688
- quantityAdjustment?: QuantityAdjustmentRequest;
3689
- valueAdjustment?: ValueAdjustmentRequest;
3690
- serialNumberAdjustment?: SerialNumberAdjustmentRequest;
3691
- lotNumberAdjustment?: LotNumberAdjustmentRequest;
3781
+ quantityAdjustment?: QuantityAdjustmentRequest | null;
3782
+ valueAdjustment?: ValueAdjustmentRequest | null;
3783
+ serialNumberAdjustment?: SerialNumberAdjustmentRequest | null;
3784
+ lotNumberAdjustment?: LotNumberAdjustmentRequest | null;
3692
3785
  };
3693
3786
  /**
3694
3787
  * A request model for adding a new Inventory Adjustment transaction.
@@ -3736,7 +3829,7 @@ export type CreateInventoryAdjustmentRequest = {
3736
3829
  */
3737
3830
  export type CreateInventoryItemRequest = {
3738
3831
  name: string;
3739
- barcode?: BarCodeRequest;
3832
+ barcode?: BarCodeRequest | null;
3740
3833
  classId?: string | null;
3741
3834
  parentId?: string | null;
3742
3835
  sku?: string | null;
@@ -3769,7 +3862,7 @@ export type CreateInventorySiteRequest = {
3769
3862
  phone?: string | null;
3770
3863
  fax?: string | null;
3771
3864
  email?: string | null;
3772
- address?: AddressRequest;
3865
+ address?: AddressRequest | null;
3773
3866
  externalId?: string | null;
3774
3867
  };
3775
3868
  /**
@@ -3795,8 +3888,8 @@ export type CreateInvoiceRequest = {
3795
3888
  * Reference number for the invoice.
3796
3889
  */
3797
3890
  refNumber?: string | null;
3798
- billingAddress?: AddressRequest;
3799
- shippingAddress?: AddressRequest;
3891
+ billingAddress?: AddressRequest | null;
3892
+ shippingAddress?: AddressRequest | null;
3800
3893
  isPending?: boolean | null;
3801
3894
  isFinanceCharge?: boolean | null;
3802
3895
  purchaseOrderNumber?: string | null;
@@ -3912,7 +4005,7 @@ export type CreateItemGroupLineRequest = {
3912
4005
  */
3913
4006
  export type CreateItemGroupRequest = {
3914
4007
  name: string;
3915
- barCode?: BarCodeRequest;
4008
+ barCode?: BarCodeRequest | null;
3916
4009
  description?: string | null;
3917
4010
  isActive?: boolean | null;
3918
4011
  unitOfMeasureSetId?: string | null;
@@ -3932,7 +4025,7 @@ export type CreateItemInventoryAssemblyRequest = {
3932
4025
  incomeAccountId?: string | null;
3933
4026
  assetAccountId: string | null;
3934
4027
  cogsAccountId?: string | null;
3935
- barCode?: BarCodeRequest;
4028
+ barCode?: BarCodeRequest | null;
3936
4029
  isActive?: boolean | null;
3937
4030
  classId?: string | null;
3938
4031
  parentId?: string | null;
@@ -4027,7 +4120,7 @@ export type CreateItemLineRequest = {
4027
4120
  * (Optional) Overrides the default income/expense account associated with the item.
4028
4121
  */
4029
4122
  overrideItemAccountId?: string | null;
4030
- linkToTransaction?: LinkToTransactionLineRequest;
4123
+ linkToTransaction?: LinkToTransactionLineRequest | null;
4031
4124
  salesRepresentativeId?: string | null;
4032
4125
  customFields?: Array<DataExtRequest> | null;
4033
4126
  };
@@ -4036,7 +4129,7 @@ export type CreateItemLineRequest = {
4036
4129
  */
4037
4130
  export type CreateItemNonInventoryRequest = {
4038
4131
  name: string;
4039
- barcode?: BarCodeRequest;
4132
+ barcode?: BarCodeRequest | null;
4040
4133
  isActive?: boolean | null;
4041
4134
  classId?: string | null;
4042
4135
  parentId?: string | null;
@@ -4044,8 +4137,8 @@ export type CreateItemNonInventoryRequest = {
4044
4137
  unitOfMeasureSetId?: string | null;
4045
4138
  isTaxIncluded?: boolean | null;
4046
4139
  salesTaxCodeId?: string | null;
4047
- salesOrPurchaseDetails?: ItemNonInventorySalesOrPurchaseDetailsRequest;
4048
- salesAndPurchaseDetails?: ItemNonInventorySalesAndPurchaseDetailsRequest;
4140
+ salesOrPurchaseDetails?: ItemNonInventorySalesOrPurchaseDetailsRequest | null;
4141
+ salesAndPurchaseDetails?: ItemNonInventorySalesAndPurchaseDetailsRequest | null;
4049
4142
  externalId?: string | null;
4050
4143
  };
4051
4144
  /**
@@ -4053,7 +4146,7 @@ export type CreateItemNonInventoryRequest = {
4053
4146
  */
4054
4147
  export type CreateItemOtherChargeRequest = {
4055
4148
  name: string;
4056
- barcode?: BarCodeRequest;
4149
+ barcode?: BarCodeRequest | null;
4057
4150
  isActive?: boolean | null;
4058
4151
  classId?: string | null;
4059
4152
  className?: string | null;
@@ -4061,8 +4154,8 @@ export type CreateItemOtherChargeRequest = {
4061
4154
  parentName?: string | null;
4062
4155
  isTaxIncluded?: boolean | null;
4063
4156
  salesTaxCodeId?: string | null;
4064
- salesOrPurchaseDetails?: ItemOtherChargeSalesOrPurchaseDetailsRequest;
4065
- salesAndPurchaseDetails?: ItemOtherChargeSalesAndPurchaseDetailsRequest;
4157
+ salesOrPurchaseDetails?: ItemOtherChargeSalesOrPurchaseDetailsRequest | null;
4158
+ salesAndPurchaseDetails?: ItemOtherChargeSalesAndPurchaseDetailsRequest | null;
4066
4159
  externalId?: string | null;
4067
4160
  };
4068
4161
  /**
@@ -4137,7 +4230,7 @@ export type CreateItemReceiptRequest = {
4137
4230
  */
4138
4231
  export type CreateItemSalesTaxGroupRequest = {
4139
4232
  name: string;
4140
- barCode?: BarCodeRequest;
4233
+ barCode?: BarCodeRequest | null;
4141
4234
  isActive?: boolean | null;
4142
4235
  description?: string | null;
4143
4236
  externalId?: string | null;
@@ -4153,7 +4246,10 @@ export type CreateItemSalesTaxRequest = {
4153
4246
  * (Required) The name or identifier for the new sales tax item.
4154
4247
  */
4155
4248
  name: string;
4156
- barcode?: BarCodeRequest;
4249
+ /**
4250
+ * (Optional) BarCode information.
4251
+ */
4252
+ barcode?: BarCodeRequest | null;
4157
4253
  /**
4158
4254
  * (Optional) Indicates whether the sales tax item is active.
4159
4255
  */
@@ -4194,7 +4290,7 @@ export type CreateItemSubtotalRequest = {
4194
4290
  name: string;
4195
4291
  isActive?: boolean | null;
4196
4292
  barCodeValue?: string | null;
4197
- barCode?: BarCodeRequest;
4293
+ barCode?: BarCodeRequest | null;
4198
4294
  externalId?: string | null;
4199
4295
  };
4200
4296
  /**
@@ -4270,8 +4366,8 @@ export type CreateOtherNameRequest = {
4270
4366
  firstName?: string | null;
4271
4367
  middleName?: string | null;
4272
4368
  lastName?: string | null;
4273
- address?: Address;
4274
- addressBlock?: AddressBlock;
4369
+ address?: Address | null;
4370
+ addressBlock?: AddressBlock | null;
4275
4371
  phone?: string | null;
4276
4372
  alternatPhone?: string | null;
4277
4373
  fax?: string | null;
@@ -4472,8 +4568,14 @@ export type CreatePurchaseOrderRequest = {
4472
4568
  * (Optional) The document number. (Max 11 characters)
4473
4569
  */
4474
4570
  refNumber?: string | null;
4475
- vendorAddress?: AddressRequest;
4476
- shipAddress?: AddressRequest;
4571
+ /**
4572
+ * (Optional) The primary address for the Vendor on this Purchase Order.
4573
+ */
4574
+ vendorAddress?: AddressRequest | null;
4575
+ /**
4576
+ * (Optional) The shipping address for the Purchase Order.
4577
+ */
4578
+ shipAddress?: AddressRequest | null;
4477
4579
  /**
4478
4580
  * (Optional) The ListID or FullName of the payment terms.
4479
4581
  * Follows the Flattened-ID Pattern for TermsRef.
@@ -4556,7 +4658,7 @@ export type CreateReceivePaymentRequest = {
4556
4658
  * Account to deposit the payment into.
4557
4659
  */
4558
4660
  depositToAccountId?: string | null;
4559
- creditCardTransactionInfo?: CreditCardTxnInfoRequest;
4661
+ creditCardTransactionInfo?: CreditCardTxnInfoRequest | null;
4560
4662
  externalId?: string | null;
4561
4663
  /**
4562
4664
  * If true, QuickBooks will automatically apply the payment to outstanding invoices.
@@ -4670,7 +4772,7 @@ export type CreateSalesReceiptLineRequest = {
4670
4772
  salesTaxCodeId?: string | null;
4671
4773
  otherCustomField1?: string | null;
4672
4774
  otherCustomField2?: string | null;
4673
- creditCardTransaction?: CreateCreditCardTransactionInfoRequest;
4775
+ creditCardTransaction?: CreateCreditCardTransactionInfoRequest | null;
4674
4776
  };
4675
4777
  /**
4676
4778
  * A request model for adding a new Sales Receipt transaction.
@@ -4694,8 +4796,8 @@ export type CreateSalesReceiptRequest = {
4694
4796
  * (Optional) The document number (e.g., receipt number). (Max 11 characters)
4695
4797
  */
4696
4798
  refNumber?: string | null;
4697
- billingAddress?: AddressRequest;
4698
- shippingAddress?: AddressRequest;
4799
+ billingAddress?: AddressRequest | null;
4800
+ shippingAddress?: AddressRequest | null;
4699
4801
  /**
4700
4802
  * (Optional) Indicates if the transaction is pending.
4701
4803
  */
@@ -4741,7 +4843,7 @@ export type CreateSalesReceiptRequest = {
4741
4843
  * (Optional) The ListID or FullName of the account to deposit the payment to.
4742
4844
  */
4743
4845
  depositToAccountId?: string | null;
4744
- creditCardTransaction?: CreateCreditCardTransactionInfoRequest;
4846
+ creditCardTransaction?: CreateCreditCardTransactionInfoRequest | null;
4745
4847
  /**
4746
4848
  * (Optional) Exchange rate if this is a foreign currency Sales Receipt.
4747
4849
  */
@@ -4820,7 +4922,10 @@ export type CreateSalesTaxPaymentCheckRequest = {
4820
4922
  * (Optional) A memo for the transaction. Max 4095 chars.
4821
4923
  */
4822
4924
  memo?: string | null;
4823
- address?: AddressRequest;
4925
+ /**
4926
+ * (Optional) The address of the payee.
4927
+ */
4928
+ address?: AddressRequest | null;
4824
4929
  externalId?: string | null;
4825
4930
  /**
4826
4931
  * (Required) A list of sales tax items and the amounts being paid.
@@ -4829,7 +4934,7 @@ export type CreateSalesTaxPaymentCheckRequest = {
4829
4934
  };
4830
4935
  export type CreateServiceItemRequest = {
4831
4936
  name: string;
4832
- barCode?: BarCodeRequest;
4937
+ barCode?: BarCodeRequest | null;
4833
4938
  externalId?: string | null;
4834
4939
  isActive?: boolean | null;
4835
4940
  classId?: string | null;
@@ -4839,8 +4944,8 @@ export type CreateServiceItemRequest = {
4839
4944
  forceUOMChange?: boolean | null;
4840
4945
  isTaxIncluded?: boolean | null;
4841
4946
  dataExt?: Array<QbdDataExt> | null;
4842
- salesOrPurchase?: CreateSalesOrPurchaseRequest;
4843
- salesAndPurchase?: CreateSalesAndPurchaseRequest;
4947
+ salesOrPurchase?: CreateSalesOrPurchaseRequest | null;
4948
+ salesAndPurchase?: CreateSalesAndPurchaseRequest | null;
4844
4949
  };
4845
4950
  /**
4846
4951
  * Represents the SetCredit aggregate in QBXML.
@@ -4894,7 +4999,10 @@ export type CreateSpecialItemRequest = {
4894
4999
  * Valid values: "FinanceCharge", "ReimbursableExpenseGroup", "ReimbursableExpenseSubtotal"
4895
5000
  */
4896
5001
  specialItemType: string;
4897
- barCode?: BarCodeRequest;
5002
+ /**
5003
+ * (Optional) Bar Code details for the special item.
5004
+ */
5005
+ barCode?: BarCodeRequest | null;
4898
5006
  externalId?: string | null;
4899
5007
  };
4900
5008
  /**
@@ -5053,8 +5161,8 @@ export type CreateVendorRequest = {
5053
5161
  middleName?: string | null;
5054
5162
  lastName?: string | null;
5055
5163
  jobTitle?: string | null;
5056
- billingAddress?: AddressRequest;
5057
- shippingAddress?: AddressRequest;
5164
+ billingAddress?: AddressRequest | null;
5165
+ shippingAddress?: AddressRequest | null;
5058
5166
  phone?: string | null;
5059
5167
  alternatePhone?: string | null;
5060
5168
  fax?: string | null;
@@ -5154,7 +5262,7 @@ export type CreditCardBill = {
5154
5262
  updatedAt: string;
5155
5263
  revisionNumber: string;
5156
5264
  transactionDate?: string | null;
5157
- currency?: QbdRef;
5265
+ currency?: QbdRef | null;
5158
5266
  /**
5159
5267
  * Exchange rate (required if currency is specified)
5160
5268
  */
@@ -5167,15 +5275,20 @@ export type CreditCardBill = {
5167
5275
  * Memo/description for the payment
5168
5276
  */
5169
5277
  memo?: string | null;
5170
- creditCardAccount?: QbdRef;
5171
- payablesAccount?: QbdRef;
5278
+ /**
5279
+ * Credit card account being charged (required)
5280
+ * The credit card account to which this bill credit card payment is being charged.
5281
+ * This bill credit card payment will decrease the balance of this account.
5282
+ */
5283
+ creditCardAccount?: QbdRef | null;
5284
+ payablesAccount?: QbdRef | null;
5172
5285
  appliedToTransactions?: Array<AppliedToTxn> | null;
5173
5286
  /**
5174
5287
  * Total amount of the payment
5175
5288
  */
5176
5289
  amount?: number | null;
5177
- entity?: QbdRef;
5178
- account?: QbdRef;
5290
+ entity?: QbdRef | null;
5291
+ account?: QbdRef | null;
5179
5292
  amountInHomeCurrency?: string | null;
5180
5293
  hasValidLineItems?: boolean;
5181
5294
  externalId?: string | null;
@@ -5195,16 +5308,16 @@ export type CreditCardCharge = {
5195
5308
  updatedAt: string;
5196
5309
  revisionNumber: string;
5197
5310
  transactionDate?: string | null;
5198
- currency?: QbdRef;
5311
+ currency?: QbdRef | null;
5199
5312
  exchangeRate?: number | null;
5200
5313
  refNumber?: string | null;
5201
5314
  memo?: string | null;
5202
5315
  transactionNumber?: string | null;
5203
5316
  isTaxIncluded?: boolean | null;
5204
- salesTaxCode?: QbdRef;
5317
+ salesTaxCode?: QbdRef | null;
5205
5318
  amount?: number | null;
5206
- entity?: QbdRef;
5207
- account?: QbdRef;
5319
+ entity?: QbdRef | null;
5320
+ account?: QbdRef | null;
5208
5321
  amountInHomeCurrency?: string | null;
5209
5322
  hasValidLineItems?: boolean;
5210
5323
  externalId?: string | null;
@@ -5225,7 +5338,7 @@ export type CreditCardCredit = {
5225
5338
  updatedAt: string;
5226
5339
  revisionNumber: string;
5227
5340
  transactionDate?: string | null;
5228
- currency?: QbdRef;
5341
+ currency?: QbdRef | null;
5229
5342
  /**
5230
5343
  * Exchange rate for multi-currency transactions (Optional).
5231
5344
  */
@@ -5244,10 +5357,13 @@ export type CreditCardCredit = {
5244
5357
  * Indicates if tax is included in the line items.
5245
5358
  */
5246
5359
  isTaxIncluded?: boolean | null;
5247
- salesTaxCode?: QbdRef;
5360
+ /**
5361
+ * Reference to the sales tax code.
5362
+ */
5363
+ salesTaxCode?: QbdRef | null;
5248
5364
  amount?: number | null;
5249
- entity?: QbdRef;
5250
- account?: QbdRef;
5365
+ entity?: QbdRef | null;
5366
+ account?: QbdRef | null;
5251
5367
  amountInHomeCurrency?: string | null;
5252
5368
  hasValidLineItems?: boolean;
5253
5369
  externalId?: string | null;
@@ -5307,8 +5423,11 @@ export type CreditCardTransactionInputInfo = {
5307
5423
  * (Optional) New commercial card code. (Max 4 characters)
5308
5424
  */
5309
5425
  commercialCardCode?: string | null;
5310
- transactionMode?: NullableTransactionMode;
5311
- transactionType?: NullableCreditCardTransactionType;
5426
+ /**
5427
+ * (Optional) New transaction mode (0 for CardNotPresent [DEFAULT], 1 for CardPresent).
5428
+ */
5429
+ transactionMode?: NullableTransactionMode | null;
5430
+ transactionType?: NullableCreditCardTransactionType | null;
5312
5431
  };
5313
5432
  /**
5314
5433
  * DTO for credit card result details.
@@ -5319,9 +5438,9 @@ export type CreditCardTransactionResultInfo = {
5319
5438
  creditCardTransID: string;
5320
5439
  merchantAccountNumber: string;
5321
5440
  authorizationCode?: string | null;
5322
- avsStreet?: NullableAvsStreet;
5323
- avsZip?: NullableAvsZip;
5324
- cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
5441
+ avsStreet?: NullableAvsStreet | null;
5442
+ avsZip?: NullableAvsZip | null;
5443
+ cardSecurityCodeMatch?: NullableCardSecurityCodeMatch | null;
5325
5444
  reconBatchID?: string | null;
5326
5445
  paymentGroupingCode?: number | null;
5327
5446
  paymentStatus: PaymentStatus;
@@ -5353,7 +5472,7 @@ export type CreditMemo = {
5353
5472
  updatedAt: string;
5354
5473
  revisionNumber: string;
5355
5474
  transactionDate?: string | null;
5356
- currency?: QbdRef;
5475
+ currency?: QbdRef | null;
5357
5476
  /**
5358
5477
  * (Optional) The exchange rate for the transaction.
5359
5478
  */
@@ -5367,25 +5486,25 @@ export type CreditMemo = {
5367
5486
  */
5368
5487
  memo?: string | null;
5369
5488
  transactionNumber?: number | null;
5370
- customer?: QbdRef;
5371
- class?: QbdRef;
5372
- receivablesAccount?: QbdRef;
5373
- template?: QbdRef;
5374
- billingAddress?: Address;
5375
- billingAddressBlock?: AddressBlock;
5376
- shippingAddress?: Address;
5377
- shippingAddressBlock?: AddressBlock;
5489
+ customer?: QbdRef | null;
5490
+ class?: QbdRef | null;
5491
+ receivablesAccount?: QbdRef | null;
5492
+ template?: QbdRef | null;
5493
+ billingAddress?: Address | null;
5494
+ billingAddressBlock?: AddressBlock | null;
5495
+ shippingAddress?: Address | null;
5496
+ shippingAddressBlock?: AddressBlock | null;
5378
5497
  /**
5379
5498
  * (Optional) Indicates if the credit memo is pending.
5380
5499
  */
5381
5500
  isPending?: boolean | null;
5382
5501
  poNumber?: string | null;
5383
- terms?: QbdRef;
5502
+ terms?: QbdRef | null;
5384
5503
  /**
5385
5504
  * (Optional) The due date.
5386
5505
  */
5387
5506
  dueDate?: string | null;
5388
- salesRepresentative?: QbdRef;
5507
+ salesRepresentative?: QbdRef | null;
5389
5508
  /**
5390
5509
  * (Optional) Free On Board (FOB) terms. (Max 13 characters)
5391
5510
  */
@@ -5394,15 +5513,15 @@ export type CreditMemo = {
5394
5513
  * (Optional) The date of shipment.
5395
5514
  */
5396
5515
  shipDate?: string | null;
5397
- shipMethod?: QbdRef;
5516
+ shipMethod?: QbdRef | null;
5398
5517
  subtotal?: number | null;
5399
- itemSalesTax?: QbdRef;
5518
+ itemSalesTax?: QbdRef | null;
5400
5519
  salesTaxPercentage?: number | null;
5401
5520
  salesTaxTotal?: number | null;
5402
5521
  totalAmount?: number | null;
5403
5522
  creditRemaining?: number | null;
5404
5523
  creditRemainingInHomeCurrency?: number | null;
5405
- customerMsg?: QbdRef;
5524
+ customerMsg?: QbdRef | null;
5406
5525
  /**
5407
5526
  * (Optional) Indicates if the transaction is to be printed.
5408
5527
  */
@@ -5415,7 +5534,7 @@ export type CreditMemo = {
5415
5534
  * (Optional) Indicates if tax is included in the amounts.
5416
5535
  */
5417
5536
  isTaxIncluded?: boolean | null;
5418
- customerSalesTaxCode?: QbdRef;
5537
+ customerSalesTaxCode?: QbdRef | null;
5419
5538
  /**
5420
5539
  * (Optional) Other custom field. (Max 29 characters)
5421
5540
  */
@@ -5426,8 +5545,8 @@ export type CreditMemo = {
5426
5545
  lines?: Array<CreditMemoLine> | null;
5427
5546
  lineGroups?: Array<CreditMemoLineGroup> | null;
5428
5547
  amount?: number | null;
5429
- entity?: QbdRef;
5430
- account?: QbdRef;
5548
+ entity?: QbdRef | null;
5549
+ account?: QbdRef | null;
5431
5550
  hasValidLineItems?: boolean;
5432
5551
  externalId?: string | null;
5433
5552
  linkedTransactions?: Array<LinkedTransaction> | null;
@@ -5443,7 +5562,7 @@ export type CreditMemo = {
5443
5562
  export type CreditMemoLine = {
5444
5563
  objectType?: string;
5445
5564
  id: string;
5446
- item?: QbdRef;
5565
+ item?: QbdRef | null;
5447
5566
  /**
5448
5567
  * (Optional) Description of the line item.
5449
5568
  */
@@ -5456,7 +5575,7 @@ export type CreditMemoLine = {
5456
5575
  * (Optional) Unit of measure.
5457
5576
  */
5458
5577
  unitOfMeasure?: string | null;
5459
- overrideUnitOfMeasureSet?: QbdRef;
5578
+ overrideUnitOfMeasureSet?: QbdRef | null;
5460
5579
  /**
5461
5580
  * (Optional) Rate or price per unit.
5462
5581
  */
@@ -5465,13 +5584,13 @@ export type CreditMemoLine = {
5465
5584
  * (Optional) Rate expressed as a percentage.
5466
5585
  */
5467
5586
  ratePercent?: number | null;
5468
- class?: QbdRef;
5587
+ class?: QbdRef | null;
5469
5588
  /**
5470
5589
  * (Optional) Total amount for the line.
5471
5590
  */
5472
5591
  amount?: number | null;
5473
- inventorySite?: QbdRef;
5474
- inventorySiteLocation?: QbdRef;
5592
+ inventorySite?: QbdRef | null;
5593
+ inventorySiteLocation?: QbdRef | null;
5475
5594
  /**
5476
5595
  * (Optional) Serial number for the item.
5477
5596
  */
@@ -5485,10 +5604,10 @@ export type CreditMemoLine = {
5485
5604
  * (Optional) Service date for the item.
5486
5605
  */
5487
5606
  serviceDate?: string | null;
5488
- salesTaxCode?: QbdRef;
5607
+ salesTaxCode?: QbdRef | null;
5489
5608
  otherCustomField1?: string | null;
5490
5609
  otherCustomField2?: string | null;
5491
- creditCardTransaction?: CreditCardTransactionInfo;
5610
+ creditCardTransaction?: CreditCardTransactionInfo | null;
5492
5611
  customFields?: Array<QbdDataExt> | null;
5493
5612
  };
5494
5613
  /**
@@ -5498,7 +5617,7 @@ export type CreditMemoLine = {
5498
5617
  export type CreditMemoLineGroup = {
5499
5618
  id: string;
5500
5619
  objectType?: string;
5501
- itemGroup?: QbdRef;
5620
+ itemGroup?: QbdRef | null;
5502
5621
  description?: string | null;
5503
5622
  /**
5504
5623
  * (Optional) Quantity of the group.
@@ -5508,7 +5627,7 @@ export type CreditMemoLineGroup = {
5508
5627
  * (Optional) Unit of measure.
5509
5628
  */
5510
5629
  unitOfMeasure?: string | null;
5511
- overrideUnitOfMeasureSet?: QbdRef;
5630
+ overrideUnitOfMeasureSet?: QbdRef | null;
5512
5631
  shouldPrintItemsInGroup?: boolean | null;
5513
5632
  totalAmount?: number | null;
5514
5633
  /**
@@ -5535,7 +5654,10 @@ export type Currency = {
5535
5654
  * (Required) The three-letter currency code (e.g., USD, EUR). Values are normalized to trimmed uppercase. (Max 3 characters)
5536
5655
  */
5537
5656
  currencyCode?: string | null;
5538
- currencyFormat?: CurrencyFormat;
5657
+ /**
5658
+ * (Optional) Specifies the formatting rules for the currency.
5659
+ */
5660
+ currencyFormat?: CurrencyFormat | null;
5539
5661
  isUserDefinedCurrency?: boolean | null;
5540
5662
  exchangeRate?: number | null;
5541
5663
  asOfDate?: string | null;
@@ -5644,8 +5766,8 @@ export type Customer = {
5644
5766
  * Job title of the customer's primary contact.
5645
5767
  */
5646
5768
  jobTitle?: string | null;
5647
- billingAddress?: Address;
5648
- shippingAddress?: Address;
5769
+ billingAddress?: Address | null;
5770
+ shippingAddress?: Address | null;
5649
5771
  alternateShippingAddresses?: Array<ShipToAddress> | null;
5650
5772
  /**
5651
5773
  * Primary phone number for the customer.
@@ -5679,17 +5801,50 @@ export type Customer = {
5679
5801
  * Maps to Contacts in QbXML.
5680
5802
  */
5681
5803
  additionalContacts?: Array<Contact> | null;
5682
- class?: QbdRef;
5683
- parent?: QbdRef;
5684
- customerType?: QbdRef;
5685
- terms?: QbdRef;
5686
- salesRep?: QbdRef;
5687
- salesTaxCode?: QbdRef;
5688
- itemSalesTax?: QbdRef;
5689
- preferredPaymentMethod?: QbdRef;
5690
- jobType?: QbdRef;
5691
- priceLevel?: QbdRef;
5692
- currency?: QbdRef;
5804
+ /**
5805
+ * The class assigned to this customer for departmental tracking.
5806
+ */
5807
+ class?: QbdRef | null;
5808
+ /**
5809
+ * The parent customer or job this record belongs to (for sub-customers/jobs).
5810
+ */
5811
+ parent?: QbdRef | null;
5812
+ /**
5813
+ * The customer type category assigned to this customer.
5814
+ */
5815
+ customerType?: QbdRef | null;
5816
+ /**
5817
+ * The default payment terms for this customer (e.g., "Net 30").
5818
+ */
5819
+ terms?: QbdRef | null;
5820
+ /**
5821
+ * The sales representative assigned to this customer.
5822
+ */
5823
+ salesRep?: QbdRef | null;
5824
+ /**
5825
+ * The sales tax code that determines whether sales to this customer are taxable.
5826
+ */
5827
+ salesTaxCode?: QbdRef | null;
5828
+ /**
5829
+ * The default sales tax item applied to taxable sales for this customer.
5830
+ */
5831
+ itemSalesTax?: QbdRef | null;
5832
+ /**
5833
+ * The customer's preferred payment method.
5834
+ */
5835
+ preferredPaymentMethod?: QbdRef | null;
5836
+ /**
5837
+ * The type of job (used when this record represents a job under a customer).
5838
+ */
5839
+ jobType?: QbdRef | null;
5840
+ /**
5841
+ * The custom price level applied to sales for this customer.
5842
+ */
5843
+ priceLevel?: QbdRef | null;
5844
+ /**
5845
+ * The currency used for transactions with this customer (multi-currency files only).
5846
+ */
5847
+ currency?: QbdRef | null;
5693
5848
  /**
5694
5849
  * Current outstanding balance owed by this customer.
5695
5850
  */
@@ -5714,7 +5869,7 @@ export type Customer = {
5714
5869
  * Maximum credit limit extended to this customer.
5715
5870
  */
5716
5871
  creditLimit?: number | null;
5717
- creditCard?: CreditCardInfo;
5872
+ creditCard?: CreditCardInfo | null;
5718
5873
  /**
5719
5874
  * Current status of the job (e.g., "InProgress", "Awarded", "Closed"). Applies when this record is a job.
5720
5875
  */
@@ -5773,7 +5928,7 @@ export type CustomerType = {
5773
5928
  * The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
5774
5929
  */
5775
5930
  fullName?: string | null;
5776
- parent?: QbdRef;
5931
+ parent?: QbdRef | null;
5777
5932
  sublevel?: number | null;
5778
5933
  /**
5779
5934
  * (Optional) If false, this Customer Type is inactive. Default is true.
@@ -5875,7 +6030,7 @@ export type Deposit = {
5875
6030
  updatedAt: string;
5876
6031
  revisionNumber: string;
5877
6032
  transactionDate?: string | null;
5878
- currency?: QbdRef;
6033
+ currency?: QbdRef | null;
5879
6034
  /**
5880
6035
  * (Optional) Exchange rate if this is a foreign currency Deposit.
5881
6036
  */
@@ -5886,17 +6041,20 @@ export type Deposit = {
5886
6041
  */
5887
6042
  memo?: string | null;
5888
6043
  transactionNumber?: number | null;
5889
- depositToAccount?: QbdRef;
6044
+ depositToAccount?: QbdRef | null;
5890
6045
  depositTotal?: number | null;
5891
6046
  depositTotalInHomeCurrency?: number | null;
5892
- cashBackInfo?: CashBackInfo;
6047
+ /**
6048
+ * (Optional) Information about cash back requested from the deposit total.
6049
+ */
6050
+ cashBackInfo?: CashBackInfo | null;
5893
6051
  /**
5894
6052
  * (Optional) A list of payment and manual lines making up the total deposit amount.
5895
6053
  */
5896
6054
  depositLines?: Array<DepositLine> | null;
5897
6055
  amount?: number | null;
5898
- entity?: QbdRef;
5899
- account?: QbdRef;
6056
+ entity?: QbdRef | null;
6057
+ account?: QbdRef | null;
5900
6058
  amountInHomeCurrency?: string | null;
5901
6059
  hasValidLineItems?: boolean;
5902
6060
  externalId?: string | null;
@@ -5914,12 +6072,12 @@ export type DepositLine = {
5914
6072
  transactionId?: string | null;
5915
6073
  transactionLineId?: string | null;
5916
6074
  paymentTransactionLineId?: string | null;
5917
- entity?: QbdRef;
5918
- account?: QbdRef;
6075
+ entity?: QbdRef | null;
6076
+ account?: QbdRef | null;
5919
6077
  memo?: string | null;
5920
6078
  checkNumber?: string | null;
5921
- paymentMethod?: QbdRef;
5922
- class?: QbdRef;
6079
+ paymentMethod?: QbdRef | null;
6080
+ class?: QbdRef | null;
5923
6081
  amount?: number | null;
5924
6082
  };
5925
6083
  /**
@@ -5987,8 +6145,14 @@ export type DictionaryStringString = {
5987
6145
  [key: string]: string;
5988
6146
  };
5989
6147
  export type EmergencyContact = {
5990
- primaryContact?: AdditionalContact;
5991
- secondaryContact?: AdditionalContact;
6148
+ /**
6149
+ * The employee's primary emergency contact.
6150
+ */
6151
+ primaryContact?: AdditionalContact | null;
6152
+ /**
6153
+ * The employee's secondary emergency contact.
6154
+ */
6155
+ secondaryContact?: AdditionalContact | null;
5992
6156
  };
5993
6157
  /**
5994
6158
  * Data transfer object for an employee.
@@ -6006,11 +6170,11 @@ export type Employee = {
6006
6170
  middleName?: string | null;
6007
6171
  lastName?: string | null;
6008
6172
  jobTitle?: string | null;
6009
- supervisor?: QbdRef;
6173
+ supervisor?: QbdRef | null;
6010
6174
  department?: string | null;
6011
6175
  description?: string | null;
6012
6176
  targetBonus?: number | null;
6013
- employeeAddress?: EmployeeAddress;
6177
+ employeeAddress?: EmployeeAddress | null;
6014
6178
  printAs?: string | null;
6015
6179
  phone?: string | null;
6016
6180
  mobile?: string | null;
@@ -6020,7 +6184,10 @@ export type Employee = {
6020
6184
  fax?: string | null;
6021
6185
  ssn?: string | null;
6022
6186
  email?: string | null;
6023
- emergencyContacts?: EmergencyContact;
6187
+ /**
6188
+ * Emergency contacts for the employee (QBD only, v13.0+).
6189
+ */
6190
+ emergencyContacts?: EmergencyContact | null;
6024
6191
  /**
6025
6192
  * Additional contact references (may repeat, v12.0+).
6026
6193
  */
@@ -6049,8 +6216,8 @@ export type Employee = {
6049
6216
  militaryStatus?: string | null;
6050
6217
  accountNumber?: string | null;
6051
6218
  notes?: string | null;
6052
- billingRate?: QbdRef;
6053
- employeePayrollInfo?: EmployeePayrollInfo;
6219
+ billingRate?: QbdRef | null;
6220
+ employeePayrollInfo?: EmployeePayrollInfo | null;
6054
6221
  externalId?: string | null;
6055
6222
  /**
6056
6223
  * The employee's name (required). This is the display name in QuickBooks.
@@ -6078,13 +6245,13 @@ export type EmployeeAddress = {
6078
6245
  */
6079
6246
  export type EmployeePayrollInfo = {
6080
6247
  payPeriod?: string | null;
6081
- paySchedule?: QbdRef;
6082
- class?: QbdRef;
6248
+ paySchedule?: QbdRef | null;
6249
+ class?: QbdRef | null;
6083
6250
  clearEarnings?: boolean | null;
6084
6251
  clearNonEarnings?: boolean | null;
6085
6252
  useTimeDataToCreatePaychecks?: string | null;
6086
- sickHours?: SickHours;
6087
- vacationHours?: VacationHours;
6253
+ sickHours?: SickHours | null;
6254
+ vacationHours?: VacationHours | null;
6088
6255
  };
6089
6256
  /**
6090
6257
  * Detailed error information conforming to the standardized error schema.
@@ -6133,7 +6300,7 @@ export type Estimate = {
6133
6300
  * (Optional) The date of the transaction. Cannot be cleared. (DATETYPE)
6134
6301
  */
6135
6302
  transactionDate?: string | null;
6136
- currency?: QbdRef;
6303
+ currency?: QbdRef | null;
6137
6304
  /**
6138
6305
  * (Optional) The exchange rate for multi-currency transactions. (FLOATTYPE)
6139
6306
  */
@@ -6147,11 +6314,11 @@ export type Estimate = {
6147
6314
  */
6148
6315
  memo?: string | null;
6149
6316
  transactionNumber?: number | null;
6150
- customer?: QbdRef;
6151
- class?: QbdRef;
6152
- template?: QbdRef;
6153
- billingAddress?: Address;
6154
- shippingAddress?: Address;
6317
+ customer?: QbdRef | null;
6318
+ class?: QbdRef | null;
6319
+ template?: QbdRef | null;
6320
+ billingAddress?: Address | null;
6321
+ shippingAddress?: Address | null;
6155
6322
  /**
6156
6323
  * (Optional) Whether the Estimate is active. (BOOLTYPE)
6157
6324
  */
@@ -6160,22 +6327,22 @@ export type Estimate = {
6160
6327
  * (Optional) Customer's Purchase Order number. (STRTYPE)
6161
6328
  */
6162
6329
  poNumber?: string | null;
6163
- terms?: QbdRef;
6330
+ terms?: QbdRef | null;
6164
6331
  /**
6165
6332
  * (Optional) The due date calculated from the terms. (DATETYPE)
6166
6333
  */
6167
6334
  dueDate?: string | null;
6168
- salesRepresentative?: QbdRef;
6335
+ salesRepresentative?: QbdRef | null;
6169
6336
  /**
6170
6337
  * (Optional) Freight on Board term. (STRTYPE)
6171
6338
  */
6172
6339
  fob?: string | null;
6173
6340
  subtotal?: number | null;
6174
- itemSalesTax?: QbdRef;
6341
+ itemSalesTax?: QbdRef | null;
6175
6342
  salesTaxPercentage?: number | null;
6176
6343
  salesTaxTotal?: number | null;
6177
6344
  totalAmountInHomeCurrency?: number | null;
6178
- customerMsg?: QbdRef;
6345
+ customerMsg?: QbdRef | null;
6179
6346
  /**
6180
6347
  * (Optional) Whether the Estimate should be flagged to be emailed. (BOOLTYPE)
6181
6348
  */
@@ -6184,7 +6351,7 @@ export type Estimate = {
6184
6351
  * (Optional) Whether tax is included in the line item amounts. (BOOLTYPE)
6185
6352
  */
6186
6353
  isTaxIncluded?: boolean | null;
6187
- customerSalesTaxCode?: QbdRef;
6354
+ customerSalesTaxCode?: QbdRef | null;
6188
6355
  linkedTransactions?: Array<LinkedTransaction> | null;
6189
6356
  itemLines?: Array<EstimateItemLine> | null;
6190
6357
  itemGroupLines?: Array<EstimateItemGroupLine> | null;
@@ -6193,8 +6360,8 @@ export type Estimate = {
6193
6360
  */
6194
6361
  other?: string | null;
6195
6362
  amount?: number | null;
6196
- entity?: QbdRef;
6197
- account?: QbdRef;
6363
+ entity?: QbdRef | null;
6364
+ account?: QbdRef | null;
6198
6365
  hasValidLineItems?: boolean;
6199
6366
  externalId?: string | null;
6200
6367
  expenseLines?: Array<ExpenseLine> | null;
@@ -6206,11 +6373,11 @@ export type Estimate = {
6206
6373
  export type EstimateItemGroupLine = {
6207
6374
  id: string;
6208
6375
  objectType?: string;
6209
- itemGroup?: QbdRef;
6376
+ itemGroup?: QbdRef | null;
6210
6377
  description?: string | null;
6211
6378
  quantity?: number | null;
6212
6379
  unitOfMeasure?: string | null;
6213
- overrideUnitOfMeasureSet?: QbdRef;
6380
+ overrideUnitOfMeasureSet?: QbdRef | null;
6214
6381
  isPrintItemsInGroup?: boolean | null;
6215
6382
  totalAmount?: number | null;
6216
6383
  itemLines?: Array<EstimateItemLine> | null;
@@ -6222,18 +6389,18 @@ export type EstimateItemGroupLine = {
6222
6389
  export type EstimateItemLine = {
6223
6390
  id: string;
6224
6391
  objectType?: string;
6225
- item?: QbdRef;
6392
+ item?: QbdRef | null;
6226
6393
  description?: string | null;
6227
6394
  quantity?: number | null;
6228
6395
  unitOfMeasure?: string | null;
6229
- overrideUnitOfMeasureSet?: QbdRef;
6396
+ overrideUnitOfMeasureSet?: QbdRef | null;
6230
6397
  rate?: number | null;
6231
6398
  ratePercent?: number | null;
6232
- class?: QbdRef;
6399
+ class?: QbdRef | null;
6233
6400
  amount?: number | null;
6234
- inventorySite?: QbdRef;
6235
- inventorySiteLocation?: QbdRef;
6236
- salesTaxCode?: QbdRef;
6401
+ inventorySite?: QbdRef | null;
6402
+ inventorySiteLocation?: QbdRef | null;
6403
+ salesTaxCode?: QbdRef | null;
6237
6404
  markupRate?: number | null;
6238
6405
  markupRatePercent?: number | null;
6239
6406
  other?: string | null;
@@ -6246,7 +6413,10 @@ export type EstimateItemLine = {
6246
6413
  export type ExpenseLine = {
6247
6414
  id: string;
6248
6415
  objectType?: string;
6249
- account?: QbdRef;
6416
+ /**
6417
+ * Expense account (e.g., "Office Supplies")
6418
+ */
6419
+ account?: QbdRef | null;
6250
6420
  /**
6251
6421
  * (Optional) The amount of the expense line.
6252
6422
  */
@@ -6255,13 +6425,16 @@ export type ExpenseLine = {
6255
6425
  * (Optional) A memo specific to this line item.
6256
6426
  */
6257
6427
  memo?: string | null;
6258
- class?: QbdRef;
6259
- customer?: QbdRef;
6260
- salesRepresentative?: QbdRef;
6261
- salesTaxCode?: QbdRef;
6428
+ class?: QbdRef | null;
6429
+ customer?: QbdRef | null;
6430
+ salesRepresentative?: QbdRef | null;
6431
+ salesTaxCode?: QbdRef | null;
6262
6432
  taxAmount?: number | null;
6263
- vendor?: QbdRef;
6264
- billableStatus?: NullableBillableStatus;
6433
+ vendor?: QbdRef | null;
6434
+ /**
6435
+ * (Optional) Billable status (Billable, NotBillable, HasBeenBilled).
6436
+ */
6437
+ billableStatus?: NullableBillableStatus | null;
6265
6438
  customFields?: Array<QbdDataExt> | null;
6266
6439
  };
6267
6440
  /**
@@ -6297,7 +6470,7 @@ export type InventoryAdjustment = {
6297
6470
  updatedAt: string;
6298
6471
  revisionNumber: string;
6299
6472
  transactionDate?: string | null;
6300
- currency?: QbdRef;
6473
+ currency?: QbdRef | null;
6301
6474
  exchangeRate?: number | null;
6302
6475
  /**
6303
6476
  * (Optional) The document number. (Max 11 characters)
@@ -6308,13 +6481,13 @@ export type InventoryAdjustment = {
6308
6481
  */
6309
6482
  memo?: string | null;
6310
6483
  transactionNumber?: number | null;
6311
- account?: QbdRef;
6312
- inventorySite?: QbdRef;
6313
- customer?: QbdRef;
6314
- class?: QbdRef;
6484
+ account?: QbdRef | null;
6485
+ inventorySite?: QbdRef | null;
6486
+ customer?: QbdRef | null;
6487
+ class?: QbdRef | null;
6315
6488
  lines?: Array<InventoryAdjustmentLine> | null;
6316
6489
  amount?: number | null;
6317
- entity?: QbdRef;
6490
+ entity?: QbdRef | null;
6318
6491
  amountInHomeCurrency?: string | null;
6319
6492
  hasValidLineItems?: boolean;
6320
6493
  externalId?: string | null;
@@ -6330,12 +6503,12 @@ export type InventoryAdjustment = {
6330
6503
  */
6331
6504
  export type InventoryAdjustmentLine = {
6332
6505
  id: string;
6333
- item?: QbdRef;
6506
+ item?: QbdRef | null;
6334
6507
  serialNumber?: string | null;
6335
6508
  serialNumberAddedOrRemoved?: string | null;
6336
6509
  lotNumber?: string | null;
6337
6510
  expirationDate?: string | null;
6338
- inventorySiteLocation?: QbdRef;
6511
+ inventorySiteLocation?: QbdRef | null;
6339
6512
  quantityDifference?: number | null;
6340
6513
  valueDifference?: number | null;
6341
6514
  customFields?: Array<QbdDataExt> | null;
@@ -6358,13 +6531,13 @@ export type InventoryItem = {
6358
6531
  isTaxIncluded?: boolean | null;
6359
6532
  salesDesc?: string | null;
6360
6533
  salesPrice?: number | null;
6361
- incomeAccount?: QbdRef;
6534
+ incomeAccount?: QbdRef | null;
6362
6535
  purchaseDesc?: string | null;
6363
6536
  purchaseCost?: number | null;
6364
- purchaseTaxCode?: QbdRef;
6365
- cogsAccount?: QbdRef;
6366
- preferredVendor?: QbdRef;
6367
- assetAccount?: QbdRef;
6537
+ purchaseTaxCode?: QbdRef | null;
6538
+ cogsAccount?: QbdRef | null;
6539
+ preferredVendor?: QbdRef | null;
6540
+ assetAccount?: QbdRef | null;
6368
6541
  reorderPoint?: number | null;
6369
6542
  max?: number | null;
6370
6543
  quantityOnHand?: number | null;
@@ -6373,11 +6546,11 @@ export type InventoryItem = {
6373
6546
  quantityOnSalesOrder?: number | null;
6374
6547
  fullName?: string | null;
6375
6548
  barcode?: string | null;
6376
- class?: QbdRef;
6377
- parent?: QbdRef;
6549
+ class?: QbdRef | null;
6550
+ parent?: QbdRef | null;
6378
6551
  sublevel?: number | null;
6379
- unitOfMeasureSet?: QbdRef;
6380
- salesTaxCode?: QbdRef;
6552
+ unitOfMeasureSet?: QbdRef | null;
6553
+ salesTaxCode?: QbdRef | null;
6381
6554
  description?: string | null;
6382
6555
  externalId?: string | null;
6383
6556
  isActive?: boolean;
@@ -6394,15 +6567,15 @@ export type InventorySite = {
6394
6567
  createdAt: string;
6395
6568
  updatedAt: string;
6396
6569
  revisionNumber: string;
6397
- parentSite?: QbdRef;
6570
+ parentSite?: QbdRef | null;
6398
6571
  isDefaultSite?: boolean | null;
6399
6572
  siteDesc?: string | null;
6400
6573
  contact?: string | null;
6401
6574
  phone?: string | null;
6402
6575
  fax?: string | null;
6403
6576
  email?: string | null;
6404
- siteAddress?: Address;
6405
- siteAddressBlock?: AddressBlock;
6577
+ siteAddress?: Address | null;
6578
+ siteAddressBlock?: AddressBlock | null;
6406
6579
  isActive?: boolean;
6407
6580
  customFields?: Array<QbdDataExt> | null;
6408
6581
  };
@@ -6419,7 +6592,7 @@ export type Invoice = {
6419
6592
  updatedAt: string;
6420
6593
  revisionNumber: string;
6421
6594
  transactionDate?: string | null;
6422
- currency?: QbdRef;
6595
+ currency?: QbdRef | null;
6423
6596
  exchangeRate?: number | null;
6424
6597
  /**
6425
6598
  * Reference number for the invoice.
@@ -6429,30 +6602,42 @@ export type Invoice = {
6429
6602
  * Memo/description for the invoice.
6430
6603
  */
6431
6604
  memo?: string | null;
6432
- customer?: QbdRef;
6433
- class?: QbdRef;
6434
- receivablesAccount?: QbdRef;
6435
- template?: QbdRef;
6605
+ /**
6606
+ * The customer to whom the invoice is addressed.
6607
+ */
6608
+ customer?: QbdRef | null;
6609
+ /**
6610
+ * Class Reference.
6611
+ */
6612
+ class?: QbdRef | null;
6613
+ receivablesAccount?: QbdRef | null;
6614
+ /**
6615
+ * Reference to the visual template (e.g., "Custom Invoice") used in QuickBooks.
6616
+ */
6617
+ template?: QbdRef | null;
6436
6618
  /**
6437
6619
  * The date the invoice is due.
6438
6620
  */
6439
6621
  dueDate?: string | null;
6440
- billingAddress?: Address;
6441
- shippingAddress?: Address;
6622
+ billingAddress?: Address | null;
6623
+ shippingAddress?: Address | null;
6442
6624
  isPending?: boolean | null;
6443
6625
  isFinanceCharge?: boolean | null;
6444
6626
  purchaseOrderNumber?: string | null;
6445
- terms?: QbdRef;
6446
- salesRepresentative?: QbdRef;
6627
+ /**
6628
+ * Reference to the payment terms (e.g., "Net 30") applied to this invoice.
6629
+ */
6630
+ terms?: QbdRef | null;
6631
+ salesRepresentative?: QbdRef | null;
6447
6632
  shipmentOrigin?: string | null;
6448
6633
  shippingDate?: string | null;
6449
- shippingMethod?: QbdRef;
6450
- itemSalesTax?: QbdRef;
6451
- customerMsg?: QbdRef;
6634
+ shippingMethod?: QbdRef | null;
6635
+ itemSalesTax?: QbdRef | null;
6636
+ customerMsg?: QbdRef | null;
6452
6637
  isQueuedForPrint?: boolean | null;
6453
6638
  isQueuedForEmail?: boolean | null;
6454
6639
  isTaxIncluded?: boolean | null;
6455
- customerSalesTaxCode?: QbdRef;
6640
+ customerSalesTaxCode?: QbdRef | null;
6456
6641
  otherCustomField?: string | null;
6457
6642
  /**
6458
6643
  * The total of all line items, before sales tax.
@@ -6472,8 +6657,11 @@ export type Invoice = {
6472
6657
  */
6473
6658
  isPaid?: boolean | null;
6474
6659
  amount?: number | null;
6475
- entity?: QbdRef;
6476
- account?: QbdRef;
6660
+ entity?: QbdRef | null;
6661
+ /**
6662
+ * The Accounts Receivable (A/R) account associated with this invoice.
6663
+ */
6664
+ account?: QbdRef | null;
6477
6665
  amountInHomeCurrency?: string | null;
6478
6666
  hasValidLineItems?: boolean;
6479
6667
  externalId?: string | null;
@@ -6533,14 +6721,14 @@ export type ItemDiscount = {
6533
6721
  itemDesc?: string | null;
6534
6722
  discountRate?: number | null;
6535
6723
  discountRatePercent?: number | null;
6536
- account?: QbdRef;
6724
+ account?: QbdRef | null;
6537
6725
  fullName?: string | null;
6538
6726
  barcode?: string | null;
6539
- class?: QbdRef;
6540
- parent?: QbdRef;
6727
+ class?: QbdRef | null;
6728
+ parent?: QbdRef | null;
6541
6729
  sublevel?: number | null;
6542
- unitOfMeasureSet?: QbdRef;
6543
- salesTaxCode?: QbdRef;
6730
+ unitOfMeasureSet?: QbdRef | null;
6731
+ salesTaxCode?: QbdRef | null;
6544
6732
  description?: string | null;
6545
6733
  externalId?: string | null;
6546
6734
  isActive?: boolean;
@@ -6577,8 +6765,11 @@ export type ItemFixedAsset = {
6577
6765
  * The original purchase price or cost of acquiring the asset.
6578
6766
  */
6579
6767
  vendorOrPayeeName?: string | null;
6580
- assetAccount?: QbdRef;
6581
- salesInfo?: FixedAssetSalesInfo;
6768
+ /**
6769
+ * A reference to the specific Fixed Asset account in the Chart of Accounts used to track this asset's financial value.
6770
+ */
6771
+ assetAccount?: QbdRef | null;
6772
+ salesInfo?: FixedAssetSalesInfo | null;
6582
6773
  /**
6583
6774
  * A general description of the fixed asset.
6584
6775
  */
@@ -6621,11 +6812,11 @@ export type ItemFixedAsset = {
6621
6812
  yearEndBookValue?: number | null;
6622
6813
  fullName?: string | null;
6623
6814
  barcode?: string | null;
6624
- class?: QbdRef;
6625
- parent?: QbdRef;
6815
+ class?: QbdRef | null;
6816
+ parent?: QbdRef | null;
6626
6817
  sublevel?: number | null;
6627
- unitOfMeasureSet?: QbdRef;
6628
- salesTaxCode?: QbdRef;
6818
+ unitOfMeasureSet?: QbdRef | null;
6819
+ salesTaxCode?: QbdRef | null;
6629
6820
  description?: string | null;
6630
6821
  externalId?: string | null;
6631
6822
  isActive?: boolean;
@@ -6646,11 +6837,11 @@ export type ItemGroup = {
6646
6837
  lines?: Array<ItemGroupLineDetail> | null;
6647
6838
  fullName?: string | null;
6648
6839
  barcode?: string | null;
6649
- class?: QbdRef;
6650
- parent?: QbdRef;
6840
+ class?: QbdRef | null;
6841
+ parent?: QbdRef | null;
6651
6842
  sublevel?: number | null;
6652
- unitOfMeasureSet?: QbdRef;
6653
- salesTaxCode?: QbdRef;
6843
+ unitOfMeasureSet?: QbdRef | null;
6844
+ salesTaxCode?: QbdRef | null;
6654
6845
  description?: string | null;
6655
6846
  externalId?: string | null;
6656
6847
  isActive?: boolean;
@@ -6662,7 +6853,7 @@ export type ItemGroup = {
6662
6853
  export type ItemGroupLine = {
6663
6854
  id: string;
6664
6855
  objectType?: string;
6665
- itemGroup?: QbdRef;
6856
+ itemGroup?: QbdRef | null;
6666
6857
  description?: string | null;
6667
6858
  /**
6668
6859
  * (Optional) Quantity of the group. QuickBooks will multiply this by the group's internal quantities.
@@ -6681,7 +6872,7 @@ export type ItemGroupLine = {
6681
6872
  * Represents a line item detail request for ItemGroup operations.
6682
6873
  */
6683
6874
  export type ItemGroupLineDetail = {
6684
- item?: QbdRef;
6875
+ item?: QbdRef | null;
6685
6876
  quantity?: number | null;
6686
6877
  unitOfMeasure?: string | null;
6687
6878
  };
@@ -6708,13 +6899,13 @@ export type ItemInventoryAssembly = {
6708
6899
  isTaxIncluded?: boolean | null;
6709
6900
  salesDescription?: string | null;
6710
6901
  salesPrice?: number | null;
6711
- incomeAccount?: QbdRef;
6902
+ incomeAccount?: QbdRef | null;
6712
6903
  purchaseDescription?: string | null;
6713
6904
  purchaseCost?: number | null;
6714
- purchaseTaxCode?: QbdRef;
6715
- cogsAccount?: QbdRef;
6716
- preferredVendor?: QbdRef;
6717
- assetAccount?: QbdRef;
6905
+ purchaseTaxCode?: QbdRef | null;
6906
+ cogsAccount?: QbdRef | null;
6907
+ preferredVendor?: QbdRef | null;
6908
+ assetAccount?: QbdRef | null;
6718
6909
  buildPoint?: number | null;
6719
6910
  max?: number | null;
6720
6911
  quantityOnHand?: number | null;
@@ -6725,18 +6916,18 @@ export type ItemInventoryAssembly = {
6725
6916
  lines?: Array<ItemInventoryAssemblyLine> | null;
6726
6917
  fullName?: string | null;
6727
6918
  barcode?: string | null;
6728
- class?: QbdRef;
6729
- parent?: QbdRef;
6919
+ class?: QbdRef | null;
6920
+ parent?: QbdRef | null;
6730
6921
  sublevel?: number | null;
6731
- unitOfMeasureSet?: QbdRef;
6732
- salesTaxCode?: QbdRef;
6922
+ unitOfMeasureSet?: QbdRef | null;
6923
+ salesTaxCode?: QbdRef | null;
6733
6924
  description?: string | null;
6734
6925
  externalId?: string | null;
6735
6926
  isActive?: boolean;
6736
6927
  customFields?: Array<QbdDataExt> | null;
6737
6928
  };
6738
6929
  export type ItemInventoryAssemblyLine = {
6739
- inventoryItem?: QbdRef;
6930
+ inventoryItem?: QbdRef | null;
6740
6931
  quantity?: number | null;
6741
6932
  };
6742
6933
  /**
@@ -6758,13 +6949,13 @@ export type ItemInventoryItem = {
6758
6949
  isTaxIncluded?: boolean | null;
6759
6950
  salesDesc?: string | null;
6760
6951
  salesPrice?: number | null;
6761
- incomeAccount?: QbdRef;
6952
+ incomeAccount?: QbdRef | null;
6762
6953
  purchaseDesc?: string | null;
6763
6954
  purchaseCost?: number | null;
6764
- purchaseTaxCode?: QbdRef;
6765
- cogsAccount?: QbdRef;
6766
- preferredVendor?: QbdRef;
6767
- assetAccount?: QbdRef;
6955
+ purchaseTaxCode?: QbdRef | null;
6956
+ cogsAccount?: QbdRef | null;
6957
+ preferredVendor?: QbdRef | null;
6958
+ assetAccount?: QbdRef | null;
6768
6959
  reorderPoint?: number | null;
6769
6960
  max?: number | null;
6770
6961
  quantityOnHand?: number | null;
@@ -6773,11 +6964,11 @@ export type ItemInventoryItem = {
6773
6964
  quantityOnSalesOrder?: number | null;
6774
6965
  fullName?: string | null;
6775
6966
  barcode?: string | null;
6776
- class?: QbdRef;
6777
- parent?: QbdRef;
6967
+ class?: QbdRef | null;
6968
+ parent?: QbdRef | null;
6778
6969
  sublevel?: number | null;
6779
- unitOfMeasureSet?: QbdRef;
6780
- salesTaxCode?: QbdRef;
6970
+ unitOfMeasureSet?: QbdRef | null;
6971
+ salesTaxCode?: QbdRef | null;
6781
6972
  description?: string | null;
6782
6973
  externalId?: string | null;
6783
6974
  isActive?: boolean;
@@ -6804,14 +6995,14 @@ export type ItemItemDiscount = {
6804
6995
  itemDesc?: string | null;
6805
6996
  discountRate?: number | null;
6806
6997
  discountRatePercent?: number | null;
6807
- account?: QbdRef;
6998
+ account?: QbdRef | null;
6808
6999
  fullName?: string | null;
6809
7000
  barcode?: string | null;
6810
- class?: QbdRef;
6811
- parent?: QbdRef;
7001
+ class?: QbdRef | null;
7002
+ parent?: QbdRef | null;
6812
7003
  sublevel?: number | null;
6813
- unitOfMeasureSet?: QbdRef;
6814
- salesTaxCode?: QbdRef;
7004
+ unitOfMeasureSet?: QbdRef | null;
7005
+ salesTaxCode?: QbdRef | null;
6815
7006
  description?: string | null;
6816
7007
  externalId?: string | null;
6817
7008
  isActive?: boolean;
@@ -6841,8 +7032,8 @@ export type ItemItemFixedAsset = {
6841
7032
  purchaseDate?: string | null;
6842
7033
  purchaseCost?: number | null;
6843
7034
  vendorOrPayeeName?: string | null;
6844
- assetAccount?: QbdRef;
6845
- salesInfo?: FixedAssetSalesInfo;
7035
+ assetAccount?: QbdRef | null;
7036
+ salesInfo?: FixedAssetSalesInfo | null;
6846
7037
  assetDesc?: string | null;
6847
7038
  location?: string | null;
6848
7039
  poNumber?: string | null;
@@ -6855,11 +7046,11 @@ export type ItemItemFixedAsset = {
6855
7046
  yearEndBookValue?: number | null;
6856
7047
  fullName?: string | null;
6857
7048
  barcode?: string | null;
6858
- class?: QbdRef;
6859
- parent?: QbdRef;
7049
+ class?: QbdRef | null;
7050
+ parent?: QbdRef | null;
6860
7051
  sublevel?: number | null;
6861
- unitOfMeasureSet?: QbdRef;
6862
- salesTaxCode?: QbdRef;
7052
+ unitOfMeasureSet?: QbdRef | null;
7053
+ salesTaxCode?: QbdRef | null;
6863
7054
  description?: string | null;
6864
7055
  externalId?: string | null;
6865
7056
  isActive?: boolean;
@@ -6888,11 +7079,11 @@ export type ItemItemGroup = {
6888
7079
  lines?: Array<ItemGroupLineDetail> | null;
6889
7080
  fullName?: string | null;
6890
7081
  barcode?: string | null;
6891
- class?: QbdRef;
6892
- parent?: QbdRef;
7082
+ class?: QbdRef | null;
7083
+ parent?: QbdRef | null;
6893
7084
  sublevel?: number | null;
6894
- unitOfMeasureSet?: QbdRef;
6895
- salesTaxCode?: QbdRef;
7085
+ unitOfMeasureSet?: QbdRef | null;
7086
+ salesTaxCode?: QbdRef | null;
6896
7087
  description?: string | null;
6897
7088
  externalId?: string | null;
6898
7089
  isActive?: boolean;
@@ -6921,13 +7112,13 @@ export type ItemItemInventoryAssembly = {
6921
7112
  isTaxIncluded?: boolean | null;
6922
7113
  salesDescription?: string | null;
6923
7114
  salesPrice?: number | null;
6924
- incomeAccount?: QbdRef;
7115
+ incomeAccount?: QbdRef | null;
6925
7116
  purchaseDescription?: string | null;
6926
7117
  purchaseCost?: number | null;
6927
- purchaseTaxCode?: QbdRef;
6928
- cogsAccount?: QbdRef;
6929
- preferredVendor?: QbdRef;
6930
- assetAccount?: QbdRef;
7118
+ purchaseTaxCode?: QbdRef | null;
7119
+ cogsAccount?: QbdRef | null;
7120
+ preferredVendor?: QbdRef | null;
7121
+ assetAccount?: QbdRef | null;
6931
7122
  buildPoint?: number | null;
6932
7123
  max?: number | null;
6933
7124
  quantityOnHand?: number | null;
@@ -6938,11 +7129,11 @@ export type ItemItemInventoryAssembly = {
6938
7129
  lines?: Array<ItemInventoryAssemblyLine> | null;
6939
7130
  fullName?: string | null;
6940
7131
  barcode?: string | null;
6941
- class?: QbdRef;
6942
- parent?: QbdRef;
7132
+ class?: QbdRef | null;
7133
+ parent?: QbdRef | null;
6943
7134
  sublevel?: number | null;
6944
- unitOfMeasureSet?: QbdRef;
6945
- salesTaxCode?: QbdRef;
7135
+ unitOfMeasureSet?: QbdRef | null;
7136
+ salesTaxCode?: QbdRef | null;
6946
7137
  description?: string | null;
6947
7138
  externalId?: string | null;
6948
7139
  isActive?: boolean;
@@ -6971,22 +7162,22 @@ export type ItemItemNonInventory = {
6971
7162
  desc?: string | null;
6972
7163
  price?: number | null;
6973
7164
  pricePercent?: number | null;
6974
- account?: QbdRef;
7165
+ account?: QbdRef | null;
6975
7166
  salesDesc?: string | null;
6976
7167
  salesPrice?: number | null;
6977
- incomeAccount?: QbdRef;
7168
+ incomeAccount?: QbdRef | null;
6978
7169
  purchaseDesc?: string | null;
6979
7170
  purchaseCost?: number | null;
6980
- purchaseTaxCode?: QbdRef;
6981
- expenseAccount?: QbdRef;
6982
- preferredVendor?: QbdRef;
7171
+ purchaseTaxCode?: QbdRef | null;
7172
+ expenseAccount?: QbdRef | null;
7173
+ preferredVendor?: QbdRef | null;
6983
7174
  fullName?: string | null;
6984
7175
  barcode?: string | null;
6985
- class?: QbdRef;
6986
- parent?: QbdRef;
7176
+ class?: QbdRef | null;
7177
+ parent?: QbdRef | null;
6987
7178
  sublevel?: number | null;
6988
- unitOfMeasureSet?: QbdRef;
6989
- salesTaxCode?: QbdRef;
7179
+ unitOfMeasureSet?: QbdRef | null;
7180
+ salesTaxCode?: QbdRef | null;
6990
7181
  description?: string | null;
6991
7182
  externalId?: string | null;
6992
7183
  isActive?: boolean;
@@ -7016,22 +7207,22 @@ export type ItemItemOtherCharge = {
7016
7207
  itemOtherChargeDescription?: string | null;
7017
7208
  price?: number | null;
7018
7209
  pricePercent?: number | null;
7019
- account?: QbdRef;
7210
+ account?: QbdRef | null;
7020
7211
  salesDesc?: string | null;
7021
7212
  salesPrice?: number | null;
7022
- incomeAccount?: QbdRef;
7213
+ incomeAccount?: QbdRef | null;
7023
7214
  purchaseDesc?: string | null;
7024
7215
  purchaseCost?: number | null;
7025
- purchaseTaxCode?: QbdRef;
7026
- expenseAccount?: QbdRef;
7027
- preferredVendor?: QbdRef;
7216
+ purchaseTaxCode?: QbdRef | null;
7217
+ expenseAccount?: QbdRef | null;
7218
+ preferredVendor?: QbdRef | null;
7028
7219
  fullName?: string | null;
7029
7220
  barcode?: string | null;
7030
- class?: QbdRef;
7031
- parent?: QbdRef;
7221
+ class?: QbdRef | null;
7222
+ parent?: QbdRef | null;
7032
7223
  sublevel?: number | null;
7033
- unitOfMeasureSet?: QbdRef;
7034
- salesTaxCode?: QbdRef;
7224
+ unitOfMeasureSet?: QbdRef | null;
7225
+ salesTaxCode?: QbdRef | null;
7035
7226
  description?: string | null;
7036
7227
  externalId?: string | null;
7037
7228
  isActive?: boolean;
@@ -7056,15 +7247,15 @@ export type ItemItemPayment = {
7056
7247
  updatedAt: string;
7057
7248
  revisionNumber: string;
7058
7249
  itemDesc?: string | null;
7059
- depositToAccount?: QbdRef;
7060
- paymentMethod?: QbdRef;
7250
+ depositToAccount?: QbdRef | null;
7251
+ paymentMethod?: QbdRef | null;
7061
7252
  fullName?: string | null;
7062
7253
  barcode?: string | null;
7063
- class?: QbdRef;
7064
- parent?: QbdRef;
7254
+ class?: QbdRef | null;
7255
+ parent?: QbdRef | null;
7065
7256
  sublevel?: number | null;
7066
- unitOfMeasureSet?: QbdRef;
7067
- salesTaxCode?: QbdRef;
7257
+ unitOfMeasureSet?: QbdRef | null;
7258
+ salesTaxCode?: QbdRef | null;
7068
7259
  description?: string | null;
7069
7260
  externalId?: string | null;
7070
7261
  isActive?: boolean;
@@ -7090,15 +7281,15 @@ export type ItemItemSalesTax = {
7090
7281
  revisionNumber: string;
7091
7282
  itemDesc?: string | null;
7092
7283
  taxRate?: number | null;
7093
- taxVendor?: QbdRef;
7094
- salesTaxReturnLine?: QbdRef;
7284
+ taxVendor?: QbdRef | null;
7285
+ salesTaxReturnLine?: QbdRef | null;
7095
7286
  fullName?: string | null;
7096
7287
  barcode?: string | null;
7097
- class?: QbdRef;
7098
- parent?: QbdRef;
7288
+ class?: QbdRef | null;
7289
+ parent?: QbdRef | null;
7099
7290
  sublevel?: number | null;
7100
- unitOfMeasureSet?: QbdRef;
7101
- salesTaxCode?: QbdRef;
7291
+ unitOfMeasureSet?: QbdRef | null;
7292
+ salesTaxCode?: QbdRef | null;
7102
7293
  description?: string | null;
7103
7294
  externalId?: string | null;
7104
7295
  isActive?: boolean;
@@ -7129,11 +7320,11 @@ export type ItemItemSalesTaxGroup = {
7129
7320
  itemSalesTax?: Array<QbdRef> | null;
7130
7321
  fullName?: string | null;
7131
7322
  barcode?: string | null;
7132
- class?: QbdRef;
7133
- parent?: QbdRef;
7323
+ class?: QbdRef | null;
7324
+ parent?: QbdRef | null;
7134
7325
  sublevel?: number | null;
7135
- unitOfMeasureSet?: QbdRef;
7136
- salesTaxCode?: QbdRef;
7326
+ unitOfMeasureSet?: QbdRef | null;
7327
+ salesTaxCode?: QbdRef | null;
7137
7328
  description?: string | null;
7138
7329
  externalId?: string | null;
7139
7330
  isActive?: boolean;
@@ -7168,11 +7359,11 @@ export type ItemItemSubtotal = {
7168
7359
  specialItemType?: string | null;
7169
7360
  fullName?: string | null;
7170
7361
  barcode?: string | null;
7171
- class?: QbdRef;
7172
- parent?: QbdRef;
7362
+ class?: QbdRef | null;
7363
+ parent?: QbdRef | null;
7173
7364
  sublevel?: number | null;
7174
- unitOfMeasureSet?: QbdRef;
7175
- salesTaxCode?: QbdRef;
7365
+ unitOfMeasureSet?: QbdRef | null;
7366
+ salesTaxCode?: QbdRef | null;
7176
7367
  description?: string | null;
7177
7368
  externalId?: string | null;
7178
7369
  isActive?: boolean;
@@ -7193,7 +7384,7 @@ export type ItemLine = {
7193
7384
  objectType?: string;
7194
7385
  otherCustomField1?: string | null;
7195
7386
  otherCustomField2?: string | null;
7196
- item?: QbdRef;
7387
+ item?: QbdRef | null;
7197
7388
  /**
7198
7389
  * (Optional) Description for the line item.
7199
7390
  */
@@ -7210,11 +7401,14 @@ export type ItemLine = {
7210
7401
  * (Optional) Total amount for the line.
7211
7402
  */
7212
7403
  amount?: number | null;
7213
- customer?: QbdRef;
7214
- class?: QbdRef;
7215
- overrideItemAccount?: QbdRef;
7216
- billableStatus?: NullableBillableStatus;
7217
- itemGroup?: QbdRef;
7404
+ customer?: QbdRef | null;
7405
+ class?: QbdRef | null;
7406
+ overrideItemAccount?: QbdRef | null;
7407
+ /**
7408
+ * (Optional) Billable status (Billable, NotBillable, HasBeenBilled).
7409
+ */
7410
+ billableStatus?: NullableBillableStatus | null;
7411
+ itemGroup?: QbdRef | null;
7218
7412
  /**
7219
7413
  * (Optional) Unit of measure.
7220
7414
  */
@@ -7223,9 +7417,9 @@ export type ItemLine = {
7223
7417
  * (Optional) Price per item (used in sales).
7224
7418
  */
7225
7419
  rate?: number | null;
7226
- salesTaxCode?: QbdRef;
7227
- inventorySite?: QbdRef;
7228
- inventorySiteLocation?: QbdRef;
7420
+ salesTaxCode?: QbdRef | null;
7421
+ inventorySite?: QbdRef | null;
7422
+ inventorySiteLocation?: QbdRef | null;
7229
7423
  /**
7230
7424
  * (Optional) Serial number for the item.
7231
7425
  */
@@ -7255,22 +7449,22 @@ export type ItemNonInventory = {
7255
7449
  desc?: string | null;
7256
7450
  price?: number | null;
7257
7451
  pricePercent?: number | null;
7258
- account?: QbdRef;
7452
+ account?: QbdRef | null;
7259
7453
  salesDesc?: string | null;
7260
7454
  salesPrice?: number | null;
7261
- incomeAccount?: QbdRef;
7455
+ incomeAccount?: QbdRef | null;
7262
7456
  purchaseDesc?: string | null;
7263
7457
  purchaseCost?: number | null;
7264
- purchaseTaxCode?: QbdRef;
7265
- expenseAccount?: QbdRef;
7266
- preferredVendor?: QbdRef;
7458
+ purchaseTaxCode?: QbdRef | null;
7459
+ expenseAccount?: QbdRef | null;
7460
+ preferredVendor?: QbdRef | null;
7267
7461
  fullName?: string | null;
7268
7462
  barcode?: string | null;
7269
- class?: QbdRef;
7270
- parent?: QbdRef;
7463
+ class?: QbdRef | null;
7464
+ parent?: QbdRef | null;
7271
7465
  sublevel?: number | null;
7272
- unitOfMeasureSet?: QbdRef;
7273
- salesTaxCode?: QbdRef;
7466
+ unitOfMeasureSet?: QbdRef | null;
7467
+ salesTaxCode?: QbdRef | null;
7274
7468
  description?: string | null;
7275
7469
  externalId?: string | null;
7276
7470
  isActive?: boolean;
@@ -7312,22 +7506,22 @@ export type ItemOtherCharge = {
7312
7506
  itemOtherChargeDescription?: string | null;
7313
7507
  price?: number | null;
7314
7508
  pricePercent?: number | null;
7315
- account?: QbdRef;
7509
+ account?: QbdRef | null;
7316
7510
  salesDesc?: string | null;
7317
7511
  salesPrice?: number | null;
7318
- incomeAccount?: QbdRef;
7512
+ incomeAccount?: QbdRef | null;
7319
7513
  purchaseDesc?: string | null;
7320
7514
  purchaseCost?: number | null;
7321
- purchaseTaxCode?: QbdRef;
7322
- expenseAccount?: QbdRef;
7323
- preferredVendor?: QbdRef;
7515
+ purchaseTaxCode?: QbdRef | null;
7516
+ expenseAccount?: QbdRef | null;
7517
+ preferredVendor?: QbdRef | null;
7324
7518
  fullName?: string | null;
7325
7519
  barcode?: string | null;
7326
- class?: QbdRef;
7327
- parent?: QbdRef;
7520
+ class?: QbdRef | null;
7521
+ parent?: QbdRef | null;
7328
7522
  sublevel?: number | null;
7329
- unitOfMeasureSet?: QbdRef;
7330
- salesTaxCode?: QbdRef;
7523
+ unitOfMeasureSet?: QbdRef | null;
7524
+ salesTaxCode?: QbdRef | null;
7331
7525
  description?: string | null;
7332
7526
  externalId?: string | null;
7333
7527
  isActive?: boolean;
@@ -7360,15 +7554,15 @@ export type ItemPayment = {
7360
7554
  updatedAt: string;
7361
7555
  revisionNumber: string;
7362
7556
  itemDesc?: string | null;
7363
- depositToAccount?: QbdRef;
7364
- paymentMethod?: QbdRef;
7557
+ depositToAccount?: QbdRef | null;
7558
+ paymentMethod?: QbdRef | null;
7365
7559
  fullName?: string | null;
7366
7560
  barcode?: string | null;
7367
- class?: QbdRef;
7368
- parent?: QbdRef;
7561
+ class?: QbdRef | null;
7562
+ parent?: QbdRef | null;
7369
7563
  sublevel?: number | null;
7370
- unitOfMeasureSet?: QbdRef;
7371
- salesTaxCode?: QbdRef;
7564
+ unitOfMeasureSet?: QbdRef | null;
7565
+ salesTaxCode?: QbdRef | null;
7372
7566
  description?: string | null;
7373
7567
  externalId?: string | null;
7374
7568
  isActive?: boolean;
@@ -7392,7 +7586,7 @@ export type ItemReceipt = {
7392
7586
  updatedAt: string;
7393
7587
  revisionNumber: string;
7394
7588
  transactionDate?: string | null;
7395
- currency?: QbdRef;
7589
+ currency?: QbdRef | null;
7396
7590
  /**
7397
7591
  * Exchange rate for multi-currency transactions (Optional).
7398
7592
  */
@@ -7406,16 +7600,19 @@ export type ItemReceipt = {
7406
7600
  */
7407
7601
  memo?: string | null;
7408
7602
  transactionNumber?: number | null;
7409
- payablesAccount?: QbdRef;
7410
- liabilityAccount?: QbdRef;
7603
+ payablesAccount?: QbdRef | null;
7604
+ /**
7605
+ * The Liability account (e.g., for items received without a bill).
7606
+ */
7607
+ liabilityAccount?: QbdRef | null;
7411
7608
  /**
7412
7609
  * Indicates if tax is included in line items (Optional).
7413
7610
  */
7414
7611
  isTaxIncluded?: boolean | null;
7415
- salesTaxCode?: QbdRef;
7612
+ salesTaxCode?: QbdRef | null;
7416
7613
  amount?: number | null;
7417
- entity?: QbdRef;
7418
- account?: QbdRef;
7614
+ entity?: QbdRef | null;
7615
+ account?: QbdRef | null;
7419
7616
  amountInHomeCurrency?: string | null;
7420
7617
  hasValidLineItems?: boolean;
7421
7618
  externalId?: string | null;
@@ -7455,18 +7652,18 @@ export type ItemSalesTax = {
7455
7652
  * (Optional) The tax rate as a percentage (e.g., 7.5 for 7.5%).
7456
7653
  */
7457
7654
  taxRate?: number | null;
7458
- taxVendor?: QbdRef;
7459
- salesTaxReturnLine?: QbdRef;
7655
+ taxVendor?: QbdRef | null;
7656
+ salesTaxReturnLine?: QbdRef | null;
7460
7657
  fullName?: string | null;
7461
7658
  /**
7462
7659
  * (Optional) BarCode information.
7463
7660
  */
7464
7661
  barcode?: string | null;
7465
- class?: QbdRef;
7466
- parent?: QbdRef;
7662
+ class?: QbdRef | null;
7663
+ parent?: QbdRef | null;
7467
7664
  sublevel?: number | null;
7468
- unitOfMeasureSet?: QbdRef;
7469
- salesTaxCode?: QbdRef;
7665
+ unitOfMeasureSet?: QbdRef | null;
7666
+ salesTaxCode?: QbdRef | null;
7470
7667
  description?: string | null;
7471
7668
  externalId?: string | null;
7472
7669
  /**
@@ -7499,11 +7696,11 @@ export type ItemSalesTaxGroup = {
7499
7696
  itemSalesTax?: Array<QbdRef> | null;
7500
7697
  fullName?: string | null;
7501
7698
  barcode?: string | null;
7502
- class?: QbdRef;
7503
- parent?: QbdRef;
7699
+ class?: QbdRef | null;
7700
+ parent?: QbdRef | null;
7504
7701
  sublevel?: number | null;
7505
- unitOfMeasureSet?: QbdRef;
7506
- salesTaxCode?: QbdRef;
7702
+ unitOfMeasureSet?: QbdRef | null;
7703
+ salesTaxCode?: QbdRef | null;
7507
7704
  description?: string | null;
7508
7705
  externalId?: string | null;
7509
7706
  isActive?: boolean;
@@ -7523,22 +7720,22 @@ export type ItemServiceItem = {
7523
7720
  desc?: string | null;
7524
7721
  price?: number | null;
7525
7722
  pricePercent?: number | null;
7526
- account?: QbdRef;
7723
+ account?: QbdRef | null;
7527
7724
  salesDescription?: string | null;
7528
7725
  salesPrice?: number | null;
7529
- incomeAccount?: QbdRef;
7726
+ incomeAccount?: QbdRef | null;
7530
7727
  purchaseDesc?: string | null;
7531
7728
  purchaseCost?: number | null;
7532
- purchaseTaxCode?: QbdRef;
7533
- expenseAccount?: QbdRef;
7534
- preferredVendor?: QbdRef;
7729
+ purchaseTaxCode?: QbdRef | null;
7730
+ expenseAccount?: QbdRef | null;
7731
+ preferredVendor?: QbdRef | null;
7535
7732
  fullName?: string | null;
7536
7733
  barcode?: string | null;
7537
- class?: QbdRef;
7538
- parent?: QbdRef;
7734
+ class?: QbdRef | null;
7735
+ parent?: QbdRef | null;
7539
7736
  sublevel?: number | null;
7540
- unitOfMeasureSet?: QbdRef;
7541
- salesTaxCode?: QbdRef;
7737
+ unitOfMeasureSet?: QbdRef | null;
7738
+ salesTaxCode?: QbdRef | null;
7542
7739
  description?: string | null;
7543
7740
  externalId?: string | null;
7544
7741
  isActive?: boolean;
@@ -7573,11 +7770,11 @@ export type ItemSubtotal = {
7573
7770
  specialItemType?: string | null;
7574
7771
  fullName?: string | null;
7575
7772
  barcode?: string | null;
7576
- class?: QbdRef;
7577
- parent?: QbdRef;
7773
+ class?: QbdRef | null;
7774
+ parent?: QbdRef | null;
7578
7775
  sublevel?: number | null;
7579
- unitOfMeasureSet?: QbdRef;
7580
- salesTaxCode?: QbdRef;
7776
+ unitOfMeasureSet?: QbdRef | null;
7777
+ salesTaxCode?: QbdRef | null;
7581
7778
  description?: string | null;
7582
7779
  externalId?: string | null;
7583
7780
  isActive?: boolean;
@@ -7593,7 +7790,7 @@ export type JournalEntry = {
7593
7790
  updatedAt: string;
7594
7791
  revisionNumber: string;
7595
7792
  transactionDate?: string | null;
7596
- currency?: QbdRef;
7793
+ currency?: QbdRef | null;
7597
7794
  exchangeRate?: number | null;
7598
7795
  /**
7599
7796
  * Reference number for the journal entry. (Max 20 characters)
@@ -7616,8 +7813,8 @@ export type JournalEntry = {
7616
7813
  debitLines?: Array<JournalLine> | null;
7617
7814
  creditLines?: Array<JournalLine> | null;
7618
7815
  amount?: number | null;
7619
- entity?: QbdRef;
7620
- account?: QbdRef;
7816
+ entity?: QbdRef | null;
7817
+ account?: QbdRef | null;
7621
7818
  amountInHomeCurrency?: string | null;
7622
7819
  hasValidLineItems?: boolean;
7623
7820
  externalId?: string | null;
@@ -7633,7 +7830,7 @@ export type JournalEntry = {
7633
7830
  export type JournalLine = {
7634
7831
  objectType?: string;
7635
7832
  id: string;
7636
- account?: QbdRef;
7833
+ account?: QbdRef | null;
7637
7834
  /**
7638
7835
  * (Required) Amount for the line.
7639
7836
  */
@@ -7642,9 +7839,9 @@ export type JournalLine = {
7642
7839
  * Memo for the line. (Max 4095 characters)
7643
7840
  */
7644
7841
  memo?: string | null;
7645
- entity?: QbdRef;
7646
- class?: QbdRef;
7647
- itemSalesTax?: QbdRef;
7842
+ entity?: QbdRef | null;
7843
+ class?: QbdRef | null;
7844
+ itemSalesTax?: QbdRef | null;
7648
7845
  /**
7649
7846
  * Billable status of the line (Billable, NotBillable, HasBeenBilled).
7650
7847
  */
@@ -7790,8 +7987,14 @@ export type OtherName = {
7790
7987
  firstName?: string | null;
7791
7988
  middleName?: string | null;
7792
7989
  lastName?: string | null;
7793
- address?: Address;
7794
- addressBlock?: AddressBlock;
7990
+ /**
7991
+ * The primary address for the "Other Name".
7992
+ */
7993
+ address?: Address | null;
7994
+ /**
7995
+ * The address formatted as a 5-line block.
7996
+ */
7997
+ addressBlock?: AddressBlock | null;
7795
7998
  phone?: string | null;
7796
7999
  alternatePhone?: string | null;
7797
8000
  fax?: string | null;
@@ -7813,7 +8016,7 @@ export type PayableBill = {
7813
8016
  updatedAt: string;
7814
8017
  revisionNumber: string;
7815
8018
  transactionDate?: string | null;
7816
- currency?: QbdRef;
8019
+ currency?: QbdRef | null;
7817
8020
  amountDue?: number | null;
7818
8021
  exchangeRate?: number | null;
7819
8022
  /**
@@ -7823,10 +8026,10 @@ export type PayableBill = {
7823
8026
  refNumber?: string | null;
7824
8027
  memo?: string | null;
7825
8028
  transactionType?: string | null;
7826
- payablesAccount?: QbdRef;
8029
+ payablesAccount?: QbdRef | null;
7827
8030
  dueDate?: string | null;
7828
- entity?: QbdRef;
7829
- account?: QbdRef;
8031
+ entity?: QbdRef | null;
8032
+ account?: QbdRef | null;
7830
8033
  amountInHomeCurrency?: string | null;
7831
8034
  hasValidLineItems?: boolean;
7832
8035
  externalId?: string | null;
@@ -7883,8 +8086,14 @@ export type PayrollItemNonWage = {
7883
8086
  * Possible values: Addition, CompanyContribution, Deduction, DirectDeposit, Tax
7884
8087
  */
7885
8088
  nonWageType: string;
7886
- expenseAccount?: QbdRef;
7887
- liabilityAccount?: QbdRef;
8089
+ /**
8090
+ * The expense account associated with this payroll item.
8091
+ */
8092
+ expenseAccount?: QbdRef | null;
8093
+ /**
8094
+ * The liability account associated with this payroll item.
8095
+ */
8096
+ liabilityAccount?: QbdRef | null;
7888
8097
  /**
7889
8098
  * (Optional) Indicates whether the payroll item is active.
7890
8099
  */
@@ -7945,7 +8154,10 @@ export type PriceLevel = {
7945
8154
  * List of per-item price level rules (only for PerItem type).
7946
8155
  */
7947
8156
  perItemPriceLevels?: Array<PriceLevelPerItem> | null;
7948
- currency?: QbdRef;
8157
+ /**
8158
+ * The currency associated with this price level.
8159
+ */
8160
+ currency?: QbdRef | null;
7949
8161
  /**
7950
8162
  * (Optional) Whether the price level is active. Defaults to true.
7951
8163
  */
@@ -7957,7 +8169,10 @@ export type PriceLevel = {
7957
8169
  * Maps to PriceLevelPerItemRet in QBXML.
7958
8170
  */
7959
8171
  export type PriceLevelPerItem = {
7960
- item?: QbdRef;
8172
+ /**
8173
+ * The item this pricing rule applies to.
8174
+ */
8175
+ item?: QbdRef | null;
7961
8176
  /**
7962
8177
  * The custom price for this item (mutually exclusive with CustomPricePercent).
7963
8178
  */
@@ -8004,7 +8219,7 @@ export type PurchaseOrder = {
8004
8219
  updatedAt: string;
8005
8220
  revisionNumber: string;
8006
8221
  transactionDate?: string | null;
8007
- currency?: QbdRef;
8222
+ currency?: QbdRef | null;
8008
8223
  /**
8009
8224
  * (Optional) Exchange rate if this is a foreign currency Purchase Order.
8010
8225
  */
@@ -8018,16 +8233,22 @@ export type PurchaseOrder = {
8018
8233
  */
8019
8234
  memo?: string | null;
8020
8235
  transactionNumber?: number | null;
8021
- vendor?: QbdRef;
8022
- class?: QbdRef;
8023
- inventorySite?: QbdRef;
8024
- shipToEntity?: QbdRef;
8025
- template?: QbdRef;
8026
- vendorAddress?: Address;
8027
- vendorAddressBlock?: AddressBlock;
8028
- shipAddress?: Address;
8029
- shipAddressBlock?: AddressBlock;
8030
- terms?: QbdRef;
8236
+ vendor?: QbdRef | null;
8237
+ class?: QbdRef | null;
8238
+ inventorySite?: QbdRef | null;
8239
+ shipToEntity?: QbdRef | null;
8240
+ template?: QbdRef | null;
8241
+ /**
8242
+ * (Optional) The primary address for the Vendor on this Purchase Order.
8243
+ */
8244
+ vendorAddress?: Address | null;
8245
+ vendorAddressBlock?: AddressBlock | null;
8246
+ /**
8247
+ * (Optional) The shipping address for the Purchase Order.
8248
+ */
8249
+ shipAddress?: Address | null;
8250
+ shipAddressBlock?: AddressBlock | null;
8251
+ terms?: QbdRef | null;
8031
8252
  /**
8032
8253
  * (Optional) The date the payment is due based on terms.
8033
8254
  */
@@ -8036,7 +8257,7 @@ export type PurchaseOrder = {
8036
8257
  * (Optional) The date the vendor is expected to deliver the item.
8037
8258
  */
8038
8259
  expectedDate?: string | null;
8039
- shipmentMethod?: QbdRef;
8260
+ shipmentMethod?: QbdRef | null;
8040
8261
  shipmentOrigin?: string | null;
8041
8262
  totalAmount?: number | null;
8042
8263
  /**
@@ -8051,14 +8272,14 @@ export type PurchaseOrder = {
8051
8272
  * (Optional) If true, the line item rates/amounts are inclusive of sales tax.
8052
8273
  */
8053
8274
  isTaxIncluded?: boolean | null;
8054
- salesTaxCode?: QbdRef;
8275
+ salesTaxCode?: QbdRef | null;
8055
8276
  otherCustomField1?: string | null;
8056
8277
  otherCustomField2?: string | null;
8057
8278
  lines?: Array<PurchaseOrderLine> | null;
8058
8279
  lineGroups?: Array<PurchaseOrderLineGroup> | null;
8059
8280
  amount?: number | null;
8060
- entity?: QbdRef;
8061
- account?: QbdRef;
8281
+ entity?: QbdRef | null;
8282
+ account?: QbdRef | null;
8062
8283
  amountInHomeCurrency?: string | null;
8063
8284
  hasValidLineItems?: boolean;
8064
8285
  externalId?: string | null;
@@ -8073,7 +8294,7 @@ export type PurchaseOrder = {
8073
8294
  */
8074
8295
  export type PurchaseOrderLine = {
8075
8296
  id: string;
8076
- item?: QbdRef;
8297
+ item?: QbdRef | null;
8077
8298
  /**
8078
8299
  * (Optional) The manufacturer's part number for the item. (Max 31 characters)
8079
8300
  */
@@ -8087,23 +8308,23 @@ export type PurchaseOrderLine = {
8087
8308
  */
8088
8309
  quantity?: number | null;
8089
8310
  unitOfMeasure?: string | null;
8090
- overrideUnitOfMeasureSet?: QbdRef;
8311
+ overrideUnitOfMeasureSet?: QbdRef | null;
8091
8312
  /**
8092
8313
  * (Optional) Cost/Rate per item unit.
8093
8314
  */
8094
8315
  rate?: number | null;
8095
- class?: QbdRef;
8316
+ class?: QbdRef | null;
8096
8317
  /**
8097
8318
  * (Optional) Total amount for the line.
8098
8319
  */
8099
8320
  amount?: number | null;
8100
- inventorySiteLocation?: QbdRef;
8101
- customer?: QbdRef;
8321
+ inventorySiteLocation?: QbdRef | null;
8322
+ customer?: QbdRef | null;
8102
8323
  /**
8103
8324
  * (Optional) The date the service was performed (if this is a service item).
8104
8325
  */
8105
8326
  serviceDate?: string | null;
8106
- salesTaxCode?: QbdRef;
8327
+ salesTaxCode?: QbdRef | null;
8107
8328
  receivedQuantity?: number | null;
8108
8329
  unbilledQuantity?: number | null;
8109
8330
  isBilled?: boolean | null;
@@ -8121,14 +8342,14 @@ export type PurchaseOrderLine = {
8121
8342
  export type PurchaseOrderLineGroup = {
8122
8343
  id: string;
8123
8344
  objectType?: string;
8124
- itemGroup?: QbdRef;
8345
+ itemGroup?: QbdRef | null;
8125
8346
  description?: string | null;
8126
8347
  /**
8127
8348
  * (Optional) Quantity of the group to purchase.
8128
8349
  */
8129
8350
  quantity?: number | null;
8130
8351
  unitOfMeasure?: string | null;
8131
- overrideUnitOfMeasureSet?: QbdRef;
8352
+ overrideUnitOfMeasureSet?: QbdRef | null;
8132
8353
  isPrintItemsInGroup?: boolean | null;
8133
8354
  totalAmount?: number | null;
8134
8355
  lines?: Array<PurchaseOrderLine> | null;
@@ -8208,7 +8429,7 @@ export type ReceivePayment = {
8208
8429
  updatedAt: string;
8209
8430
  revisionNumber: string;
8210
8431
  transactionDate?: string | null;
8211
- currency?: QbdRef;
8432
+ currency?: QbdRef | null;
8212
8433
  /**
8213
8434
  * Exchange rate for multi-currency transactions (v8.0+).
8214
8435
  */
@@ -8222,11 +8443,11 @@ export type ReceivePayment = {
8222
8443
  */
8223
8444
  memo?: string | null;
8224
8445
  txnNumber?: number | null;
8225
- customer?: QbdRef;
8226
- receivablesAccount?: QbdRef;
8227
- paymentMethod?: QbdRef;
8228
- depositToAccount?: QbdRef;
8229
- creditCardTransaction?: CreditCardTransactionInfo;
8446
+ customer?: QbdRef | null;
8447
+ receivablesAccount?: QbdRef | null;
8448
+ paymentMethod?: QbdRef | null;
8449
+ depositToAccount?: QbdRef | null;
8450
+ creditCardTransaction?: CreditCardTransactionInfo | null;
8230
8451
  unusedPayment?: number | null;
8231
8452
  unusedCredits?: number | null;
8232
8453
  /**
@@ -8235,8 +8456,8 @@ export type ReceivePayment = {
8235
8456
  */
8236
8457
  appliedToTxns?: Array<AppliedToTxn> | null;
8237
8458
  amount?: number | null;
8238
- entity?: QbdRef;
8239
- account?: QbdRef;
8459
+ entity?: QbdRef | null;
8460
+ account?: QbdRef | null;
8240
8461
  amountInHomeCurrency?: string | null;
8241
8462
  hasValidLineItems?: boolean;
8242
8463
  externalId?: string | null;
@@ -8341,7 +8562,7 @@ export type Report = {
8341
8562
  columnCount?: number | null;
8342
8563
  headerRowCount?: number | null;
8343
8564
  columns?: Array<ReportColumnDescription> | null;
8344
- data?: ReportData;
8565
+ data?: ReportData | null;
8345
8566
  customFields?: Array<QbdDataExt> | null;
8346
8567
  };
8347
8568
  /**
@@ -8357,7 +8578,10 @@ export type ReportColData = {
8357
8578
  * The data type of the column.
8358
8579
  */
8359
8580
  dataType?: string | null;
8360
- attributes?: DictionaryStringString;
8581
+ /**
8582
+ * The attributes of the column.
8583
+ */
8584
+ attributes?: DictionaryStringString | null;
8361
8585
  };
8362
8586
  /**
8363
8587
  * Describes a column in the report (maps ColDesc QBXML element).
@@ -8417,7 +8641,7 @@ export type ReportRow = {
8417
8641
  * The value of the row.
8418
8642
  */
8419
8643
  value?: string | null;
8420
- info?: ReportRowData;
8644
+ info?: ReportRowData | null;
8421
8645
  values?: Array<ReportColData> | null;
8422
8646
  rows?: Array<ReportRow> | null;
8423
8647
  };
@@ -8457,7 +8681,7 @@ export type SalesReceipt = {
8457
8681
  updatedAt: string;
8458
8682
  revisionNumber: string;
8459
8683
  transactionDate?: string | null;
8460
- currency?: QbdRef;
8684
+ currency?: QbdRef | null;
8461
8685
  /**
8462
8686
  * (Optional) Exchange rate if this is a foreign currency Sales Receipt.
8463
8687
  */
@@ -8471,13 +8695,13 @@ export type SalesReceipt = {
8471
8695
  */
8472
8696
  memo?: string | null;
8473
8697
  txnNumber?: number | null;
8474
- customer?: QbdRef;
8475
- class?: QbdRef;
8476
- template?: QbdRef;
8477
- billingAddress?: Address;
8478
- billingAddressBlock?: AddressBlock;
8479
- shippingAddress?: Address;
8480
- shippingAddressBlock?: AddressBlock;
8698
+ customer?: QbdRef | null;
8699
+ class?: QbdRef | null;
8700
+ template?: QbdRef | null;
8701
+ billingAddress?: Address | null;
8702
+ billingAddressBlock?: AddressBlock | null;
8703
+ shippingAddress?: Address | null;
8704
+ shippingAddressBlock?: AddressBlock | null;
8481
8705
  /**
8482
8706
  * (Optional) Indicates if the transaction is pending.
8483
8707
  */
@@ -8486,37 +8710,37 @@ export type SalesReceipt = {
8486
8710
  * (Optional) Check number if payment method is check. (Max 25 characters)
8487
8711
  */
8488
8712
  checkNumber?: string | null;
8489
- paymentMethod?: QbdRef;
8713
+ paymentMethod?: QbdRef | null;
8490
8714
  /**
8491
8715
  * (Optional) The date the payment is due (if applicable).
8492
8716
  */
8493
8717
  dueDate?: string | null;
8494
- salesRepresentative?: QbdRef;
8718
+ salesRepresentative?: QbdRef | null;
8495
8719
  shipDate?: string | null;
8496
- shipMethod?: QbdRef;
8720
+ shipMethod?: QbdRef | null;
8497
8721
  shipmentOrigin?: string | null;
8498
8722
  subtotal?: number | null;
8499
- itemSalesTax?: QbdRef;
8723
+ itemSalesTax?: QbdRef | null;
8500
8724
  salesTaxPercentage?: number | null;
8501
8725
  salesTaxTotal?: number | null;
8502
8726
  totalAmount?: number | null;
8503
8727
  totalAmountInHomeCurrency?: number | null;
8504
- customerMessage?: QbdRef;
8728
+ customerMessage?: QbdRef | null;
8505
8729
  isQueuedForPrint?: boolean | null;
8506
8730
  isQueuedForEmail?: boolean | null;
8507
8731
  /**
8508
8732
  * (Optional) If true, tax is included in the item amounts (tax-inclusive pricing).
8509
8733
  */
8510
8734
  isTaxIncluded?: boolean | null;
8511
- customerSalesTaxCode?: QbdRef;
8512
- depositToAccount?: QbdRef;
8513
- creditCardTransaction?: CreditCardTransactionInfo;
8735
+ customerSalesTaxCode?: QbdRef | null;
8736
+ depositToAccount?: QbdRef | null;
8737
+ creditCardTransaction?: CreditCardTransactionInfo | null;
8514
8738
  otherCustomField?: string | null;
8515
8739
  lines?: Array<SalesReceiptLine> | null;
8516
8740
  lineGroups?: Array<SalesReceiptLineGroup> | null;
8517
8741
  amount?: number | null;
8518
- entity?: QbdRef;
8519
- account?: QbdRef;
8742
+ entity?: QbdRef | null;
8743
+ account?: QbdRef | null;
8520
8744
  amountInHomeCurrency?: string | null;
8521
8745
  hasValidLineItems?: boolean;
8522
8746
  externalId?: string | null;
@@ -8532,7 +8756,7 @@ export type SalesReceipt = {
8532
8756
  export type SalesReceiptLine = {
8533
8757
  id: string;
8534
8758
  objectType?: string | null;
8535
- item?: QbdRef;
8759
+ item?: QbdRef | null;
8536
8760
  /**
8537
8761
  * (Optional) Description for the line item. (Max 4095 characters)
8538
8762
  */
@@ -8545,7 +8769,7 @@ export type SalesReceiptLine = {
8545
8769
  * (Optional) Unit of measure override. (Max 31 characters)
8546
8770
  */
8547
8771
  unitOfMeasure?: string | null;
8548
- overrideUOMSet?: QbdRef;
8772
+ overrideUOMSet?: QbdRef | null;
8549
8773
  /**
8550
8774
  * (Optional) The direct rate per unit. Use either Rate, RatePercent, or PriceLevelId.
8551
8775
  */
@@ -8554,13 +8778,13 @@ export type SalesReceiptLine = {
8554
8778
  * (Optional) The percentage rate based on item price. Use either Rate, RatePercent, or PriceLevelId.
8555
8779
  */
8556
8780
  ratePercent?: number | null;
8557
- class?: QbdRef;
8781
+ class?: QbdRef | null;
8558
8782
  /**
8559
8783
  * (Optional) Total amount for the line. Overrides calculation if Rate/RatePercent not set.
8560
8784
  */
8561
8785
  amount?: number | null;
8562
- inventorySite?: QbdRef;
8563
- inventorySiteLocation?: QbdRef;
8786
+ inventorySite?: QbdRef | null;
8787
+ inventorySiteLocation?: QbdRef | null;
8564
8788
  /**
8565
8789
  * (Optional) Serial number for the item. Mutually exclusive with LotNumber. (Max 4095 characters)
8566
8790
  */
@@ -8574,10 +8798,10 @@ export type SalesReceiptLine = {
8574
8798
  * (Optional) The date the service was performed.
8575
8799
  */
8576
8800
  serviceDate?: string | null;
8577
- salesTaxCode?: QbdRef;
8801
+ salesTaxCode?: QbdRef | null;
8578
8802
  otherCustomField1?: string | null;
8579
8803
  otherCustomField2?: string | null;
8580
- creditCardTransaction?: CreditCardTransactionInfo;
8804
+ creditCardTransaction?: CreditCardTransactionInfo | null;
8581
8805
  customFields?: Array<QbdDataExt> | null;
8582
8806
  };
8583
8807
  /**
@@ -8586,7 +8810,7 @@ export type SalesReceiptLine = {
8586
8810
  export type SalesReceiptLineGroup = {
8587
8811
  id: string;
8588
8812
  objectType?: string | null;
8589
- itemGroup?: QbdRef;
8813
+ itemGroup?: QbdRef | null;
8590
8814
  description?: string | null;
8591
8815
  /**
8592
8816
  * (Optional) Quantity of the group.
@@ -8596,7 +8820,7 @@ export type SalesReceiptLineGroup = {
8596
8820
  * (Optional) Unit of measure override. (Max 31 characters)
8597
8821
  */
8598
8822
  unitOfMeasure?: string | null;
8599
- overrideUnitOfMeasureSet?: QbdRef;
8823
+ overrideUnitOfMeasureSet?: QbdRef | null;
8600
8824
  shouldPrintItemsInGroup?: boolean | null;
8601
8825
  totalAmount?: number | null;
8602
8826
  lines?: Array<SalesReceiptLine> | null;
@@ -8621,8 +8845,8 @@ export type SalesTaxCode = {
8621
8845
  */
8622
8846
  isTaxable?: boolean;
8623
8847
  desc?: string | null;
8624
- itemPurchaseTax?: QbdRef;
8625
- itemSalesTax?: QbdRef;
8848
+ itemPurchaseTax?: QbdRef | null;
8849
+ itemSalesTax?: QbdRef | null;
8626
8850
  /**
8627
8851
  * (Optional) If false, this Sales Tax Code is inactive. Default is true.
8628
8852
  */
@@ -8643,7 +8867,7 @@ export type SalesTaxPaymentCheck = {
8643
8867
  * (Required) The date of the transaction.
8644
8868
  */
8645
8869
  transactionDate?: string | null;
8646
- currency?: QbdRef;
8870
+ currency?: QbdRef | null;
8647
8871
  exchangeRate?: number | null;
8648
8872
  refNumber?: string | null;
8649
8873
  /**
@@ -8651,16 +8875,19 @@ export type SalesTaxPaymentCheck = {
8651
8875
  */
8652
8876
  memo?: string | null;
8653
8877
  transactionNumber?: number | null;
8654
- address?: Address;
8655
- addressBlock?: AddressBlock;
8878
+ /**
8879
+ * (Optional) The address of the payee.
8880
+ */
8881
+ address?: Address | null;
8882
+ addressBlock?: AddressBlock | null;
8656
8883
  isQueuedForPrint?: boolean | null;
8657
8884
  /**
8658
8885
  * (Required) A list of sales tax items and the amounts being paid.
8659
8886
  */
8660
8887
  lines?: Array<SalesTaxPaymentCheckLine> | null;
8661
8888
  amount?: number | null;
8662
- entity?: QbdRef;
8663
- account?: QbdRef;
8889
+ entity?: QbdRef | null;
8890
+ account?: QbdRef | null;
8664
8891
  amountInHomeCurrency?: string | null;
8665
8892
  hasValidLineItems?: boolean;
8666
8893
  externalId?: string | null;
@@ -8676,7 +8903,7 @@ export type SalesTaxPaymentCheck = {
8676
8903
  export type SalesTaxPaymentCheckLine = {
8677
8904
  objectType?: string;
8678
8905
  id: string;
8679
- itemSalesTax?: QbdRef;
8906
+ itemSalesTax?: QbdRef | null;
8680
8907
  /**
8681
8908
  * (Required) The amount of the payment for this line.
8682
8909
  */
@@ -8704,22 +8931,22 @@ export type ServiceItem = {
8704
8931
  desc?: string | null;
8705
8932
  price?: number | null;
8706
8933
  pricePercent?: number | null;
8707
- account?: QbdRef;
8934
+ account?: QbdRef | null;
8708
8935
  salesDescription?: string | null;
8709
8936
  salesPrice?: number | null;
8710
- incomeAccount?: QbdRef;
8937
+ incomeAccount?: QbdRef | null;
8711
8938
  purchaseDesc?: string | null;
8712
8939
  purchaseCost?: number | null;
8713
- purchaseTaxCode?: QbdRef;
8714
- expenseAccount?: QbdRef;
8715
- preferredVendor?: QbdRef;
8940
+ purchaseTaxCode?: QbdRef | null;
8941
+ expenseAccount?: QbdRef | null;
8942
+ preferredVendor?: QbdRef | null;
8716
8943
  fullName?: string | null;
8717
8944
  barcode?: string | null;
8718
- class?: QbdRef;
8719
- parent?: QbdRef;
8945
+ class?: QbdRef | null;
8946
+ parent?: QbdRef | null;
8720
8947
  sublevel?: number | null;
8721
- unitOfMeasureSet?: QbdRef;
8722
- salesTaxCode?: QbdRef;
8948
+ unitOfMeasureSet?: QbdRef | null;
8949
+ salesTaxCode?: QbdRef | null;
8723
8950
  description?: string | null;
8724
8951
  externalId?: string | null;
8725
8952
  isActive?: boolean;
@@ -8936,19 +9163,19 @@ export type TimeTracking = {
8936
9163
  updatedAt: string;
8937
9164
  revisionNumber: string;
8938
9165
  transactionDate?: string | null;
8939
- currency?: QbdRef;
9166
+ currency?: QbdRef | null;
8940
9167
  exchangeRate?: number | null;
8941
9168
  refNumber?: string | null;
8942
9169
  memo?: string | null;
8943
9170
  transactionNumber?: number | null;
8944
- customer?: QbdRef;
8945
- itemService?: QbdRef;
9171
+ customer?: QbdRef | null;
9172
+ itemService?: QbdRef | null;
8946
9173
  /**
8947
9174
  * (Required) The duration of the work performed, formatted as an XML TimeIntervalType string (e.g., "PT8H0M0S" for 8 hours).
8948
9175
  */
8949
9176
  duration?: string | null;
8950
- class?: QbdRef;
8951
- payrollItemWage?: QbdRef;
9177
+ class?: QbdRef | null;
9178
+ payrollItemWage?: QbdRef | null;
8952
9179
  /**
8953
9180
  * (Optional) General notes about the time entry. Max 4095 chars.
8954
9181
  */
@@ -8963,8 +9190,8 @@ export type TimeTracking = {
8963
9190
  isBillable?: boolean | null;
8964
9191
  isBilled?: boolean | null;
8965
9192
  amount?: number | null;
8966
- entity?: QbdRef;
8967
- account?: QbdRef;
9193
+ entity?: QbdRef | null;
9194
+ account?: QbdRef | null;
8968
9195
  amountInHomeCurrency?: string | null;
8969
9196
  hasValidLineItems?: boolean;
8970
9197
  externalId?: string | null;
@@ -8985,15 +9212,18 @@ export type Transaction = {
8985
9212
  updatedAt: string;
8986
9213
  revisionNumber: string;
8987
9214
  transactionDate?: string | null;
8988
- currency?: QbdRef;
9215
+ currency?: QbdRef | null;
8989
9216
  exchangeRate?: number | null;
8990
9217
  refNumber?: string | null;
8991
9218
  memo?: string | null;
8992
9219
  transactionType?: string | null;
8993
9220
  transactionLineId?: string | null;
8994
- entity?: QbdRef;
9221
+ /**
9222
+ * The entity associated with this transaction (Customer, Vendor, Employee, etc.)
9223
+ */
9224
+ entity?: QbdRef | null;
8995
9225
  amount?: number | null;
8996
- account?: QbdRef;
9226
+ account?: QbdRef | null;
8997
9227
  amountInHomeCurrency?: string | null;
8998
9228
  hasValidLineItems?: boolean;
8999
9229
  externalId?: string | null;
@@ -9021,7 +9251,10 @@ export type UnitOfMeasureSet = {
9021
9251
  * The type of measurement: "Area", "Count", "Length", "Other", "Time", "Volume", "Weight".
9022
9252
  */
9023
9253
  unitOfMeasureType?: string | null;
9024
- baseUnit?: BaseUnit;
9254
+ /**
9255
+ * The base unit definition for this set.
9256
+ */
9257
+ baseUnit?: BaseUnit | null;
9025
9258
  /**
9026
9259
  * List of related units with conversion ratios.
9027
9260
  */
@@ -9049,7 +9282,11 @@ export type UpdateAccountRequest = {
9049
9282
  * Whether the account is active
9050
9283
  */
9051
9284
  isActive?: boolean | null;
9052
- accountType?: NullableAccountType;
9285
+ /**
9286
+ * Account type (optional)
9287
+ * NOTE: Cannot create non_posting accounts via API - QuickBooks creates these internally
9288
+ */
9289
+ accountType?: NullableAccountType | null;
9053
9290
  /**
9054
9291
  * Whether the account is a tax account (optional)
9055
9292
  */
@@ -9135,7 +9372,10 @@ export type UpdateArRefundCreditCardRequest = {
9135
9372
  * (Optional) The reference number for the refund.
9136
9373
  */
9137
9374
  refNumber?: string | null;
9138
- address?: AddressRequest;
9375
+ /**
9376
+ * (Optional) Address details for the refund.
9377
+ */
9378
+ address?: AddressRequest | null;
9139
9379
  /**
9140
9380
  * (Optional) The ListID or FullName of the payment method.
9141
9381
  */
@@ -9144,7 +9384,7 @@ export type UpdateArRefundCreditCardRequest = {
9144
9384
  * (Optional) A memo for the transaction.
9145
9385
  */
9146
9386
  memo?: string | null;
9147
- creditCardTransaction?: CreditCardTransactionInfo;
9387
+ creditCardTransaction?: CreditCardTransactionInfo | null;
9148
9388
  /**
9149
9389
  * (Optional) The exchange rate for the transaction.
9150
9390
  */
@@ -9168,7 +9408,7 @@ export type UpdateBillRequest = {
9168
9408
  * Filter by Vendor ID.
9169
9409
  */
9170
9410
  vendorId?: string | null;
9171
- vendorAddress?: AddressRequest;
9411
+ vendorAddress?: AddressRequest | null;
9172
9412
  payablesAccountId?: string | null;
9173
9413
  transactionDate?: string | null;
9174
9414
  dueDate?: string | null;
@@ -9387,7 +9627,10 @@ export type UpdateCheckRequest = {
9387
9627
  */
9388
9628
  memo?: string | null;
9389
9629
  isQueuedForPrint?: boolean | null;
9390
- address?: Address;
9630
+ /**
9631
+ * Payee address
9632
+ */
9633
+ address?: Address | null;
9391
9634
  /**
9392
9635
  * If true, the amount includes sales tax.
9393
9636
  */
@@ -9615,8 +9858,8 @@ export type UpdateCreditCardRequest = {
9615
9858
  * Aggregate containing credit card input and result information for a payment (Mod).
9616
9859
  */
9617
9860
  export type UpdateCreditCardTransactionInfoRequest = {
9618
- creditCardTxnInputInfoMod?: UpdateCreditCardTransactionInputInfoRequest;
9619
- creditCardTxnResultInfoMod?: UpdateCreditCardTransactionResultInfoRequest;
9861
+ creditCardTxnInputInfoMod?: UpdateCreditCardTransactionInputInfoRequest | null;
9862
+ creditCardTxnResultInfoMod?: UpdateCreditCardTransactionResultInfoRequest | null;
9620
9863
  };
9621
9864
  /**
9622
9865
  * Contains modifiable data about the credit card itself for a payment request (Mod).
@@ -9651,8 +9894,15 @@ export type UpdateCreditCardTransactionInputInfoRequest = {
9651
9894
  * (Optional) New commercial card code. (Max 4 characters)
9652
9895
  */
9653
9896
  commercialCardCode?: string | null;
9654
- transactionMode?: NullableTransactionMode;
9655
- creditCardTxnType?: NullableCreditCardTransactionType;
9897
+ /**
9898
+ * (Optional) New transaction mode (0 for CardNotPresent [DEFAULT], 1 for CardPresent).
9899
+ */
9900
+ transactionMode?: NullableTransactionMode | null;
9901
+ /**
9902
+ * (Optional) New type of credit card transaction.
9903
+ * Used for actions like changing an Authorization to a Capture (1).
9904
+ */
9905
+ creditCardTxnType?: NullableCreditCardTransactionType | null;
9656
9906
  };
9657
9907
  export type UpdateCreditCardTransactionResultInfoRequest = {
9658
9908
  resultCode: number;
@@ -9662,9 +9912,9 @@ export type UpdateCreditCardTransactionResultInfoRequest = {
9662
9912
  paymentStatus: PaymentStatus;
9663
9913
  txnAuthorizationTime: string;
9664
9914
  authorizationCode?: string | null;
9665
- avsStreet?: NullableAvsStreet;
9666
- avsZip?: NullableAvsZip;
9667
- cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
9915
+ avsStreet?: NullableAvsStreet | null;
9916
+ avsZip?: NullableAvsZip | null;
9917
+ cardSecurityCodeMatch?: NullableCardSecurityCodeMatch | null;
9668
9918
  reconBatchId?: string | null;
9669
9919
  paymentGroupingCode?: number | null;
9670
9920
  txnAuthorizationStamp?: number | null;
@@ -9798,8 +10048,8 @@ export type UpdateCreditMemoRequest = {
9798
10048
  * (Optional) The reference number.
9799
10049
  */
9800
10050
  refNumber?: string | null;
9801
- billingAddress?: AddressRequest;
9802
- shippingAddress?: AddressRequest;
10051
+ billingAddress?: AddressRequest | null;
10052
+ shippingAddress?: AddressRequest | null;
9803
10053
  /**
9804
10054
  * (Optional) Indicates if the credit memo is pending.
9805
10055
  */
@@ -9874,7 +10124,10 @@ export type UpdateCurrencyRequest = {
9874
10124
  * (Optional) The three-letter currency code (e.g., USD, EUR). Values are normalized to trimmed uppercase. Cannot be changed for built-in QuickBooks currencies. (Max 3 characters)
9875
10125
  */
9876
10126
  currencyCode?: string | null;
9877
- currencyFormat?: CurrencyFormatRequest;
10127
+ /**
10128
+ * (Optional) Specifies the formatting rules for the currency.
10129
+ */
10130
+ currencyFormat?: CurrencyFormatRequest | null;
9878
10131
  };
9879
10132
  /**
9880
10133
  * Request model for updating an existing customer
@@ -9900,14 +10153,14 @@ export type UpdateCustomerRequest = {
9900
10153
  taxRegistrationNumber?: string | null;
9901
10154
  jobTypeId?: string | null;
9902
10155
  currencyId?: string | null;
9903
- creditCardInfo?: CreditCardInfo;
10156
+ creditCardInfo?: CreditCardInfo | null;
9904
10157
  salutation?: string | null;
9905
10158
  firstName?: string | null;
9906
10159
  middleName?: string | null;
9907
10160
  lastName?: string | null;
9908
10161
  jobTitle?: string | null;
9909
- billingAddress?: AddressRequest;
9910
- shippingAddress?: AddressRequest;
10162
+ billingAddress?: AddressRequest | null;
10163
+ shippingAddress?: AddressRequest | null;
9911
10164
  /**
9912
10165
  * Additional ship-to addresses (up to 50 allowed by QuickBooks).
9913
10166
  * Note: Updating ship-to addresses replaces the entire list.
@@ -9925,7 +10178,7 @@ export type UpdateCustomerRequest = {
9925
10178
  */
9926
10179
  customContactFields?: Array<CustomContactField> | null;
9927
10180
  creditLimit?: number | null;
9928
- jobStatus?: NullableJobStatus;
10181
+ jobStatus?: NullableJobStatus | null;
9929
10182
  jobStartDate?: string | null;
9930
10183
  jobProjectedEndDate?: string | null;
9931
10184
  jobEndDate?: string | null;
@@ -9959,8 +10212,16 @@ export type UpdateDateDrivenTermRequest = {
9959
10212
  */
9960
10213
  export type UpdateDepositLineRequest = {
9961
10214
  transactionLineId: string;
9962
- paymentLineMod?: DepositPaymentLineRequest;
9963
- manualLineMod?: DepositManualLineRequest;
10215
+ /**
10216
+ * (Optional) Modification details for a payment line (PaymentTxnID, OverrideMemo, etc.).
10217
+ * Mutually exclusive with ManualLineMod.
10218
+ */
10219
+ paymentLineMod?: DepositPaymentLineRequest | null;
10220
+ /**
10221
+ * (Optional) Modification details for a manual line (EntityId, AccountId, Amount, etc.).
10222
+ * Mutually exclusive with PaymentLineMod.
10223
+ */
10224
+ manualLineMod?: DepositManualLineRequest | null;
9964
10225
  };
9965
10226
  /**
9966
10227
  * A request model for modifying an existing Deposit transaction.
@@ -9978,7 +10239,7 @@ export type UpdateDepositRequest = {
9978
10239
  * (Optional) New general memo about the Deposit. (Max 4095 characters)
9979
10240
  */
9980
10241
  memo?: string | null;
9981
- cashBackInfo?: CashBackInfoRequest;
10242
+ cashBackInfo?: CashBackInfoRequest | null;
9982
10243
  /**
9983
10244
  * (Optional) The ListID or FullName of the currency for the transaction.
9984
10245
  * Follows the Flattened-ID Pattern for CurrencyRef.
@@ -10008,7 +10269,7 @@ export type UpdateEmployeeRequest = {
10008
10269
  supervisorId?: string | null;
10009
10270
  department?: string | null;
10010
10271
  description?: string | null;
10011
- employeeAddress?: EmployeeAddress;
10272
+ employeeAddress?: EmployeeAddress | null;
10012
10273
  printAs?: string | null;
10013
10274
  phone?: string | null;
10014
10275
  mobile?: string | null;
@@ -10022,7 +10283,10 @@ export type UpdateEmployeeRequest = {
10022
10283
  * Additional contact references (may repeat, v12.0+).
10023
10284
  */
10024
10285
  additionalContacts?: Array<AdditionalContact> | null;
10025
- emergencyContacts?: EmergencyContact;
10286
+ /**
10287
+ * Emergency contacts for the employee (QBD only, v13.0+).
10288
+ */
10289
+ emergencyContacts?: EmergencyContact | null;
10026
10290
  employeeType?: string | null;
10027
10291
  partOrFullTime?: string | null;
10028
10292
  gender?: string | null;
@@ -10053,7 +10317,7 @@ export type UpdateEmployeeRequest = {
10053
10317
  workAuthExpireDate?: string | null;
10054
10318
  usVeteran?: string | null;
10055
10319
  militaryStatus?: string | null;
10056
- employeePayrollInfo?: EmployeePayrollInfo;
10320
+ employeePayrollInfo?: EmployeePayrollInfo | null;
10057
10321
  externalId?: string | null;
10058
10322
  };
10059
10323
  /**
@@ -10145,8 +10409,8 @@ export type UpdateEstimateRequest = {
10145
10409
  * (Optional) The sequential reference number for the Estimate (e.g., Estimate Number). (STRTYPE)
10146
10410
  */
10147
10411
  refNumber?: string | null;
10148
- billingAddress?: AddressRequest;
10149
- shippingAddress?: AddressRequest;
10412
+ billingAddress?: AddressRequest | null;
10413
+ shippingAddress?: AddressRequest | null;
10150
10414
  /**
10151
10415
  * (Optional) Whether the Estimate is active. Cannot be cleared. (BOOLTYPE)
10152
10416
  */
@@ -10305,7 +10569,7 @@ export type UpdateInventoryAdjustmentRequest = {
10305
10569
  */
10306
10570
  export type UpdateInventoryItemRequest = {
10307
10571
  name: string;
10308
- barcode?: BarCodeRequest;
10572
+ barcode?: BarCodeRequest | null;
10309
10573
  classId?: string | null;
10310
10574
  parentId?: string | null;
10311
10575
  sku?: string | null;
@@ -10339,7 +10603,7 @@ export type UpdateInventorySiteRequest = {
10339
10603
  phone?: string | null;
10340
10604
  fax?: string | null;
10341
10605
  email?: string | null;
10342
- address?: AddressRequest;
10606
+ address?: AddressRequest | null;
10343
10607
  };
10344
10608
  /**
10345
10609
  * Request model for updating an existing invoice.
@@ -10365,8 +10629,8 @@ export type UpdateInvoiceRequest = {
10365
10629
  * Reference number for the invoice.
10366
10630
  */
10367
10631
  refNumber?: string | null;
10368
- billingAddress?: AddressRequest;
10369
- shippingAddress?: AddressRequest;
10632
+ billingAddress?: AddressRequest | null;
10633
+ shippingAddress?: AddressRequest | null;
10370
10634
  isPending?: boolean | null;
10371
10635
  purchaseOrderNumber?: string | null;
10372
10636
  /**
@@ -10471,7 +10735,7 @@ export type UpdateItemGroupLineRequest = {
10471
10735
  */
10472
10736
  export type UpdateItemGroupRequest = {
10473
10737
  name?: string | null;
10474
- barCode?: BarCodeRequest;
10738
+ barCode?: BarCodeRequest | null;
10475
10739
  isActive?: boolean | null;
10476
10740
  description?: string | null;
10477
10741
  unitOfMeasureSetId?: string | null;
@@ -10500,7 +10764,7 @@ export type UpdateItemInventoryAssemblyLineRequest = {
10500
10764
  export type UpdateItemInventoryAssemblyRequest = {
10501
10765
  revisionNumber: string;
10502
10766
  name?: string | null;
10503
- barCode?: BarCodeRequest;
10767
+ barCode?: BarCodeRequest | null;
10504
10768
  isActive?: boolean | null;
10505
10769
  classId?: string | null;
10506
10770
  parentId?: string | null;
@@ -10600,7 +10864,7 @@ export type UpdateItemLineRequest = {
10600
10864
  export type UpdateItemNonInventoryRequest = {
10601
10865
  revisionNumber: string;
10602
10866
  name?: string | null;
10603
- barcode?: BarCodeRequest;
10867
+ barcode?: BarCodeRequest | null;
10604
10868
  isActive?: boolean | null;
10605
10869
  classId?: string | null;
10606
10870
  parentId?: string | null;
@@ -10608,8 +10872,8 @@ export type UpdateItemNonInventoryRequest = {
10608
10872
  unitOfMeasureSetId?: string | null;
10609
10873
  isTaxIncluded?: boolean | null;
10610
10874
  salesTaxCodeId?: string | null;
10611
- salesOrPurchaseDetails?: ItemNonInventorySalesOrPurchaseDetailsRequest;
10612
- salesAndPurchaseDetails?: ItemNonInventorySalesAndPurchaseDetailsRequest;
10875
+ salesOrPurchaseDetails?: ItemNonInventorySalesOrPurchaseDetailsRequest | null;
10876
+ salesAndPurchaseDetails?: ItemNonInventorySalesAndPurchaseDetailsRequest | null;
10613
10877
  };
10614
10878
  /**
10615
10879
  * Request model for updating an ItemOtherCharge.
@@ -10617,14 +10881,14 @@ export type UpdateItemNonInventoryRequest = {
10617
10881
  export type UpdateItemOtherChargeRequest = {
10618
10882
  revisionNumber: string;
10619
10883
  name?: string | null;
10620
- barcode?: BarCodeRequest;
10884
+ barcode?: BarCodeRequest | null;
10621
10885
  isActive?: boolean | null;
10622
10886
  classId?: string | null;
10623
10887
  parentId?: string | null;
10624
10888
  isTaxIncluded?: boolean | null;
10625
10889
  salesTaxCodeId?: string | null;
10626
- salesOrPurchaseDetails?: ItemOtherChargeSalesOrPurchaseDetailsRequest;
10627
- salesAndPurchaseDetails?: ItemOtherChargeSalesAndPurchaseDetailsRequest;
10890
+ salesOrPurchaseDetails?: ItemOtherChargeSalesOrPurchaseDetailsRequest | null;
10891
+ salesAndPurchaseDetails?: ItemOtherChargeSalesAndPurchaseDetailsRequest | null;
10628
10892
  };
10629
10893
  /**
10630
10894
  * Request model for updating an ItemPayment.
@@ -10698,7 +10962,7 @@ export type UpdateItemReceiptRequest = {
10698
10962
  export type UpdateItemSalesTaxGroupRequest = {
10699
10963
  revisionNumber: string;
10700
10964
  name?: string | null;
10701
- barCode?: BarCodeRequest;
10965
+ barCode?: BarCodeRequest | null;
10702
10966
  isActive?: boolean | null;
10703
10967
  description?: string | null;
10704
10968
  itemSalesTaxIds?: Array<string> | null;
@@ -10713,7 +10977,10 @@ export type UpdateItemSalesTaxRequest = {
10713
10977
  * (Optional) The name or identifier for the sales tax item.
10714
10978
  */
10715
10979
  name?: string | null;
10716
- barcode?: BarCodeRequest;
10980
+ /**
10981
+ * (Optional) BarCode information.
10982
+ */
10983
+ barcode?: BarCodeRequest | null;
10717
10984
  /**
10718
10985
  * (Optional) Indicates whether the sales tax item is active.
10719
10986
  */
@@ -10754,7 +11021,7 @@ export type UpdateItemSubtotalRequest = {
10754
11021
  name: string;
10755
11022
  isActive?: boolean | null;
10756
11023
  barCodeValue?: string | null;
10757
- barCode?: BarCodeRequest;
11024
+ barCode?: BarCodeRequest | null;
10758
11025
  externalId?: string | null;
10759
11026
  };
10760
11027
  /**
@@ -10830,8 +11097,8 @@ export type UpdateOtherNameRequest = {
10830
11097
  firstName?: string | null;
10831
11098
  middleName?: string | null;
10832
11099
  lastName?: string | null;
10833
- address?: Address;
10834
- addressBlock?: AddressBlock;
11100
+ address?: Address | null;
11101
+ addressBlock?: AddressBlock | null;
10835
11102
  phone?: string | null;
10836
11103
  alternatePhone?: string | null;
10837
11104
  fax?: string | null;
@@ -11006,8 +11273,14 @@ export type UpdatePurchaseOrderRequest = {
11006
11273
  * (Optional) The document number. (Max 11 characters)
11007
11274
  */
11008
11275
  refNumber?: string | null;
11009
- vendorAddress?: AddressRequest;
11010
- shipAddress?: AddressRequest;
11276
+ /**
11277
+ * (Optional) The primary address for the Vendor on this Purchase Order.
11278
+ */
11279
+ vendorAddress?: AddressRequest | null;
11280
+ /**
11281
+ * (Optional) The shipping address for the Purchase Order.
11282
+ */
11283
+ shipAddress?: AddressRequest | null;
11011
11284
  /**
11012
11285
  * (Optional) The ListID or FullName of the payment terms.
11013
11286
  * Follows the Flattened-ID Pattern for TermsRef.
@@ -11104,7 +11377,10 @@ export type UpdateReceivePaymentRequest = {
11104
11377
  * Account to deposit the payment into.
11105
11378
  */
11106
11379
  depositToAccountId?: string | null;
11107
- creditCardTxnInfo?: CreditCardTxnInfoRequest;
11380
+ /**
11381
+ * Credit card transaction information (v7.0+ for mod).
11382
+ */
11383
+ creditCardTxnInfo?: CreditCardTxnInfoRequest | null;
11108
11384
  appliedToTransactions?: Array<AppliedToTransactionRequest> | null;
11109
11385
  };
11110
11386
  export type UpdateSalesAndPurchaseRequest = {
@@ -11238,8 +11514,8 @@ export type UpdateSalesReceiptRequest = {
11238
11514
  * (Optional) The new document number (e.g., receipt number). (Max 11 characters)
11239
11515
  */
11240
11516
  refNumber?: string | null;
11241
- billingAddress?: AddressRequest;
11242
- shippingAddress?: AddressRequest;
11517
+ billingAddress?: AddressRequest | null;
11518
+ shippingAddress?: AddressRequest | null;
11243
11519
  /**
11244
11520
  * (Optional) New check number if payment method is check. (Max 25 characters)
11245
11521
  */
@@ -11283,7 +11559,7 @@ export type UpdateSalesReceiptRequest = {
11283
11559
  */
11284
11560
  exchangeRate?: number | null;
11285
11561
  otherCustomField?: string | null;
11286
- creditCardTransaction?: UpdateCreditCardTransactionInfoRequest;
11562
+ creditCardTransaction?: UpdateCreditCardTransactionInfoRequest | null;
11287
11563
  lines?: Array<UpdateSalesReceiptLineRequest> | null;
11288
11564
  lineGroups?: Array<UpdateSalesReceiptLineGroupRequest> | null;
11289
11565
  };
@@ -11342,12 +11618,15 @@ export type UpdateSalesTaxPaymentCheckRequest = {
11342
11618
  * (Optional) A memo for the transaction. Max 4095 chars.
11343
11619
  */
11344
11620
  memo?: string | null;
11345
- address?: AddressRequest;
11621
+ /**
11622
+ * (Optional) The address of the payee.
11623
+ */
11624
+ address?: AddressRequest | null;
11346
11625
  };
11347
11626
  export type UpdateServiceItemRequest = {
11348
11627
  revisionNumber: string;
11349
11628
  name?: string | null;
11350
- barCode?: BarCodeRequest;
11629
+ barCode?: BarCodeRequest | null;
11351
11630
  isActive?: boolean | null;
11352
11631
  parentId?: string | null;
11353
11632
  salesTaxCodeId?: string | null;
@@ -11357,8 +11636,8 @@ export type UpdateServiceItemRequest = {
11357
11636
  applyAccountToExistingTransactions?: boolean | null;
11358
11637
  applyIncomeAccountToExistingTransactions?: boolean | null;
11359
11638
  applyExpenseAccountToExistingTransactions?: boolean | null;
11360
- salesOrPurchaseMod?: UpdateSalesOrPurchaseRequest;
11361
- salesAndPurchaseMod?: UpdateSalesAndPurchaseRequest;
11639
+ salesOrPurchaseMod?: UpdateSalesOrPurchaseRequest | null;
11640
+ salesAndPurchaseMod?: UpdateSalesAndPurchaseRequest | null;
11362
11641
  includeRetElement?: Array<string> | null;
11363
11642
  };
11364
11643
  /**
@@ -11503,8 +11782,8 @@ export type UpdateVendorRequest = {
11503
11782
  middleName?: string | null;
11504
11783
  lastName?: string | null;
11505
11784
  jobTitle?: string | null;
11506
- billingAddress?: AddressRequest;
11507
- shippingAddress?: AddressRequest;
11785
+ billingAddress?: AddressRequest | null;
11786
+ shippingAddress?: AddressRequest | null;
11508
11787
  phone?: string | null;
11509
11788
  alternatePhone?: string | null;
11510
11789
  fax?: string | null;
@@ -11667,18 +11946,39 @@ export type Vendor = {
11667
11946
  */
11668
11947
  accountNumber?: string | null;
11669
11948
  note?: string | null;
11670
- class?: QbdRef;
11671
- vendorType?: QbdRef;
11672
- terms?: QbdRef;
11673
- billingRate?: QbdRef;
11674
- salesTaxCode?: QbdRef;
11675
- salesTaxReturn?: QbdRef;
11676
- purchaseTaxAccount?: QbdRef;
11677
- salesTaxAccount?: QbdRef;
11678
- currency?: QbdRef;
11949
+ /**
11950
+ * The class assigned to this vendor for departmental tracking.
11951
+ */
11952
+ class?: QbdRef | null;
11953
+ /**
11954
+ * The vendor type category assigned to this vendor.
11955
+ */
11956
+ vendorType?: QbdRef | null;
11957
+ /**
11958
+ * The default payment terms for this vendor (e.g., "Net 30").
11959
+ */
11960
+ terms?: QbdRef | null;
11961
+ /**
11962
+ * The billing rate used when tracking time for this vendor.
11963
+ */
11964
+ billingRate?: QbdRef | null;
11965
+ /**
11966
+ * The sales tax code assigned to this vendor.
11967
+ */
11968
+ salesTaxCode?: QbdRef | null;
11969
+ /**
11970
+ * The sales tax return account for this tax-agency vendor.
11971
+ */
11972
+ salesTaxReturn?: QbdRef | null;
11973
+ purchaseTaxAccount?: QbdRef | null;
11974
+ salesTaxAccount?: QbdRef | null;
11975
+ /**
11976
+ * The currency used for transactions with this vendor (multi-currency files only).
11977
+ */
11978
+ currency?: QbdRef | null;
11679
11979
  defaultExpenseAccounts?: Array<QbdRef> | null;
11680
- billingAddress?: Address;
11681
- shippingAddress?: Address;
11980
+ billingAddress?: Address | null;
11981
+ shippingAddress?: Address | null;
11682
11982
  /**
11683
11983
  * Custom contact fields (name/value pairs) defined for this vendor.
11684
11984
  */
@@ -11741,7 +12041,7 @@ export type VendorCredit = {
11741
12041
  * (Optional) The date of the transaction. Defaults to the current date.
11742
12042
  */
11743
12043
  transactionDate?: string | null;
11744
- currency?: QbdRef;
12044
+ currency?: QbdRef | null;
11745
12045
  /**
11746
12046
  * (Optional) The exchange rate, if using multi-currency.
11747
12047
  */
@@ -11755,10 +12055,19 @@ export type VendorCredit = {
11755
12055
  */
11756
12056
  memo?: string | null;
11757
12057
  transactionNumber?: number | null;
11758
- entity?: QbdRef;
11759
- vendor?: QbdRef;
11760
- account?: QbdRef;
11761
- payablesAccount?: QbdRef;
12058
+ /**
12059
+ * Refers to the Vendor. Note: The base Entity is for PayeeEntityRef.
12060
+ */
12061
+ entity?: QbdRef | null;
12062
+ /**
12063
+ * Refers to the Vendor.
12064
+ */
12065
+ vendor?: QbdRef | null;
12066
+ /**
12067
+ * Refers to the Payables Account. Note: The base Account is for PayeeAccountRef.
12068
+ */
12069
+ account?: QbdRef | null;
12070
+ payablesAccount?: QbdRef | null;
11762
12071
  /**
11763
12072
  * The total amount of the credit.
11764
12073
  */
@@ -11771,7 +12080,7 @@ export type VendorCredit = {
11771
12080
  * (Optional) If true, the amount includes sales tax.
11772
12081
  */
11773
12082
  isTaxIncluded?: boolean | null;
11774
- salesTaxCode?: QbdRef;
12083
+ salesTaxCode?: QbdRef | null;
11775
12084
  /**
11776
12085
  * The amount of this credit that has not yet been applied.
11777
12086
  */
@@ -11814,7 +12123,7 @@ export type VendorType = {
11814
12123
  * The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
11815
12124
  */
11816
12125
  fullName?: string | null;
11817
- parent?: QbdRef;
12126
+ parent?: QbdRef | null;
11818
12127
  sublevel?: number | null;
11819
12128
  /**
11820
12129
  * (Optional) If false, this Vendor Type is inactive. Default is true.