conductor-node 12.43.0 → 13.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1002) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +111 -41
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/bin/cli +46 -0
  12. package/bin/migration-config.json +44 -0
  13. package/client.d.mts +189 -0
  14. package/client.d.mts.map +1 -0
  15. package/client.d.ts +189 -0
  16. package/client.d.ts.map +1 -0
  17. package/client.js +462 -0
  18. package/client.js.map +1 -0
  19. package/client.mjs +458 -0
  20. package/client.mjs.map +1 -0
  21. package/core/api-promise.d.mts +46 -0
  22. package/core/api-promise.d.mts.map +1 -0
  23. package/core/api-promise.d.ts +46 -0
  24. package/core/api-promise.d.ts.map +1 -0
  25. package/core/api-promise.js +74 -0
  26. package/core/api-promise.js.map +1 -0
  27. package/core/api-promise.mjs +70 -0
  28. package/core/api-promise.mjs.map +1 -0
  29. package/core/error.d.mts +46 -0
  30. package/core/error.d.mts.map +1 -0
  31. package/core/error.d.ts +46 -0
  32. package/core/error.d.ts.map +1 -0
  33. package/core/error.js +113 -0
  34. package/core/error.js.map +1 -0
  35. package/core/error.mjs +97 -0
  36. package/core/error.mjs.map +1 -0
  37. package/core/pagination.d.mts +54 -0
  38. package/core/pagination.d.mts.map +1 -0
  39. package/core/pagination.d.ts +54 -0
  40. package/core/pagination.d.ts.map +1 -0
  41. package/core/pagination.js +101 -0
  42. package/core/pagination.js.map +1 -0
  43. package/core/pagination.mjs +95 -0
  44. package/core/pagination.mjs.map +1 -0
  45. package/core/resource.d.mts +6 -0
  46. package/core/resource.d.mts.map +1 -0
  47. package/core/resource.d.ts +6 -0
  48. package/core/resource.d.ts.map +1 -0
  49. package/core/resource.js +11 -0
  50. package/core/resource.js.map +1 -0
  51. package/core/resource.mjs +7 -0
  52. package/core/resource.mjs.map +1 -0
  53. package/core/uploads.d.mts +3 -0
  54. package/core/uploads.d.mts.map +1 -0
  55. package/core/uploads.d.ts +3 -0
  56. package/core/uploads.d.ts.map +1 -0
  57. package/core/uploads.js +6 -0
  58. package/core/uploads.js.map +1 -0
  59. package/core/uploads.mjs +2 -0
  60. package/core/uploads.mjs.map +1 -0
  61. package/error.d.mts +2 -0
  62. package/error.d.mts.map +1 -0
  63. package/error.d.ts +1 -46
  64. package/error.d.ts.map +1 -1
  65. package/error.js +3 -110
  66. package/error.js.map +1 -1
  67. package/error.mjs +1 -96
  68. package/error.mjs.map +1 -1
  69. package/index.d.mts +7 -124
  70. package/index.d.mts.map +1 -0
  71. package/index.d.ts +6 -123
  72. package/index.d.ts.map +1 -1
  73. package/index.js +14 -119
  74. package/index.js.map +1 -1
  75. package/index.mjs +6 -92
  76. package/index.mjs.map +1 -1
  77. package/internal/builtin-types.d.mts +73 -0
  78. package/internal/builtin-types.d.mts.map +1 -0
  79. package/internal/builtin-types.d.ts +73 -0
  80. package/internal/builtin-types.d.ts.map +1 -0
  81. package/internal/builtin-types.js +4 -0
  82. package/internal/builtin-types.js.map +1 -0
  83. package/internal/builtin-types.mjs +3 -0
  84. package/internal/builtin-types.mjs.map +1 -0
  85. package/internal/detect-platform.d.mts +15 -0
  86. package/internal/detect-platform.d.mts.map +1 -0
  87. package/internal/detect-platform.d.ts +15 -0
  88. package/internal/detect-platform.d.ts.map +1 -0
  89. package/internal/detect-platform.js +162 -0
  90. package/internal/detect-platform.js.map +1 -0
  91. package/internal/detect-platform.mjs +157 -0
  92. package/internal/detect-platform.mjs.map +1 -0
  93. package/internal/errors.d.mts +3 -0
  94. package/internal/errors.d.mts.map +1 -0
  95. package/internal/errors.d.ts +3 -0
  96. package/internal/errors.d.ts.map +1 -0
  97. package/internal/errors.js +41 -0
  98. package/internal/errors.js.map +1 -0
  99. package/internal/errors.mjs +36 -0
  100. package/internal/errors.mjs.map +1 -0
  101. package/internal/headers.d.mts +20 -0
  102. package/internal/headers.d.mts.map +1 -0
  103. package/internal/headers.d.ts +20 -0
  104. package/internal/headers.d.ts.map +1 -0
  105. package/internal/headers.js +79 -0
  106. package/internal/headers.js.map +1 -0
  107. package/internal/headers.mjs +74 -0
  108. package/internal/headers.mjs.map +1 -0
  109. package/internal/parse.d.mts +12 -0
  110. package/internal/parse.d.mts.map +1 -0
  111. package/internal/parse.d.ts +12 -0
  112. package/internal/parse.d.ts.map +1 -0
  113. package/internal/parse.js +35 -0
  114. package/internal/parse.js.map +1 -0
  115. package/internal/parse.mjs +32 -0
  116. package/internal/parse.mjs.map +1 -0
  117. package/internal/qs/formats.d.mts +7 -0
  118. package/internal/qs/formats.d.mts.map +1 -0
  119. package/internal/qs/formats.d.ts +1 -0
  120. package/internal/qs/formats.d.ts.map +1 -1
  121. package/internal/qs/formats.js +4 -2
  122. package/internal/qs/formats.js.map +1 -1
  123. package/internal/qs/formats.mjs +2 -1
  124. package/internal/qs/formats.mjs.map +1 -1
  125. package/internal/qs/index.d.mts +10 -0
  126. package/internal/qs/index.d.mts.map +1 -0
  127. package/internal/qs/index.d.ts.map +1 -1
  128. package/internal/qs/stringify.d.mts +3 -0
  129. package/internal/qs/stringify.d.mts.map +1 -0
  130. package/internal/qs/stringify.d.ts.map +1 -1
  131. package/internal/qs/stringify.js +16 -19
  132. package/internal/qs/stringify.js.map +1 -1
  133. package/internal/qs/stringify.mjs +17 -19
  134. package/internal/qs/stringify.mjs.map +1 -1
  135. package/internal/qs/types.d.mts +57 -0
  136. package/internal/qs/types.d.mts.map +1 -0
  137. package/internal/qs/utils.d.mts +15 -0
  138. package/internal/qs/utils.d.mts.map +1 -0
  139. package/internal/qs/utils.d.ts +1 -0
  140. package/internal/qs/utils.d.ts.map +1 -1
  141. package/internal/qs/utils.js +22 -21
  142. package/internal/qs/utils.js.map +1 -1
  143. package/internal/qs/utils.mjs +12 -12
  144. package/internal/qs/utils.mjs.map +1 -1
  145. package/internal/request-options.d.mts +75 -0
  146. package/internal/request-options.d.mts.map +1 -0
  147. package/internal/request-options.d.ts +75 -0
  148. package/internal/request-options.d.ts.map +1 -0
  149. package/internal/request-options.js +14 -0
  150. package/internal/request-options.js.map +1 -0
  151. package/internal/request-options.mjs +10 -0
  152. package/internal/request-options.mjs.map +1 -0
  153. package/internal/shim-types.d.mts +17 -0
  154. package/internal/shim-types.d.mts.map +1 -0
  155. package/internal/shim-types.d.ts +17 -0
  156. package/internal/shim-types.d.ts.map +1 -0
  157. package/internal/shim-types.js +4 -0
  158. package/internal/shim-types.js.map +1 -0
  159. package/internal/shim-types.mjs +3 -0
  160. package/internal/shim-types.mjs.map +1 -0
  161. package/internal/shims.d.mts +20 -0
  162. package/internal/shims.d.mts.map +1 -0
  163. package/internal/shims.d.ts +20 -0
  164. package/internal/shims.d.ts.map +1 -0
  165. package/internal/shims.js +92 -0
  166. package/internal/shims.js.map +1 -0
  167. package/internal/shims.mjs +85 -0
  168. package/internal/shims.mjs.map +1 -0
  169. package/internal/to-file.d.mts +45 -0
  170. package/internal/to-file.d.mts.map +1 -0
  171. package/internal/to-file.d.ts +45 -0
  172. package/internal/to-file.d.ts.map +1 -0
  173. package/internal/to-file.js +91 -0
  174. package/internal/to-file.js.map +1 -0
  175. package/internal/to-file.mjs +88 -0
  176. package/internal/to-file.mjs.map +1 -0
  177. package/internal/tslib.js +81 -0
  178. package/internal/tslib.mjs +17 -0
  179. package/internal/types.d.mts +69 -0
  180. package/internal/types.d.mts.map +1 -0
  181. package/internal/types.d.ts +69 -0
  182. package/internal/types.d.ts.map +1 -0
  183. package/internal/types.js +4 -0
  184. package/internal/types.js.map +1 -0
  185. package/internal/types.mjs +3 -0
  186. package/internal/types.mjs.map +1 -0
  187. package/internal/uploads.d.mts +42 -0
  188. package/internal/uploads.d.mts.map +1 -0
  189. package/internal/uploads.d.ts +42 -0
  190. package/internal/uploads.d.ts.map +1 -0
  191. package/internal/uploads.js +141 -0
  192. package/internal/uploads.js.map +1 -0
  193. package/internal/uploads.mjs +131 -0
  194. package/internal/uploads.mjs.map +1 -0
  195. package/internal/utils/base64.d.mts +3 -0
  196. package/internal/utils/base64.d.mts.map +1 -0
  197. package/internal/utils/base64.d.ts +3 -0
  198. package/internal/utils/base64.d.ts.map +1 -0
  199. package/internal/utils/base64.js +38 -0
  200. package/internal/utils/base64.js.map +1 -0
  201. package/internal/utils/base64.mjs +33 -0
  202. package/internal/utils/base64.mjs.map +1 -0
  203. package/internal/utils/bytes.d.mts +4 -0
  204. package/internal/utils/bytes.d.mts.map +1 -0
  205. package/internal/utils/bytes.d.ts +4 -0
  206. package/internal/utils/bytes.d.ts.map +1 -0
  207. package/internal/utils/bytes.js +31 -0
  208. package/internal/utils/bytes.js.map +1 -0
  209. package/internal/utils/bytes.mjs +26 -0
  210. package/internal/utils/bytes.mjs.map +1 -0
  211. package/internal/utils/env.d.mts +9 -0
  212. package/internal/utils/env.d.mts.map +1 -0
  213. package/internal/utils/env.d.ts +9 -0
  214. package/internal/utils/env.d.ts.map +1 -0
  215. package/internal/utils/env.js +22 -0
  216. package/internal/utils/env.js.map +1 -0
  217. package/internal/utils/env.mjs +18 -0
  218. package/internal/utils/env.mjs.map +1 -0
  219. package/internal/utils/log.d.mts +37 -0
  220. package/internal/utils/log.d.mts.map +1 -0
  221. package/internal/utils/log.d.ts +37 -0
  222. package/internal/utils/log.d.ts.map +1 -0
  223. package/internal/utils/log.js +85 -0
  224. package/internal/utils/log.js.map +1 -0
  225. package/internal/utils/log.mjs +79 -0
  226. package/internal/utils/log.mjs.map +1 -0
  227. package/internal/utils/path.d.mts +15 -0
  228. package/internal/utils/path.d.mts.map +1 -0
  229. package/internal/utils/path.d.ts +15 -0
  230. package/internal/utils/path.d.ts.map +1 -0
  231. package/internal/utils/path.js +79 -0
  232. package/internal/utils/path.js.map +1 -0
  233. package/internal/utils/path.mjs +74 -0
  234. package/internal/utils/path.mjs.map +1 -0
  235. package/internal/utils/sleep.d.mts +2 -0
  236. package/internal/utils/sleep.d.mts.map +1 -0
  237. package/internal/utils/sleep.d.ts +2 -0
  238. package/internal/utils/sleep.d.ts.map +1 -0
  239. package/internal/utils/sleep.js +7 -0
  240. package/internal/utils/sleep.js.map +1 -0
  241. package/internal/utils/sleep.mjs +3 -0
  242. package/internal/utils/sleep.mjs.map +1 -0
  243. package/internal/utils/uuid.d.mts +5 -0
  244. package/internal/utils/uuid.d.mts.map +1 -0
  245. package/internal/utils/uuid.d.ts +5 -0
  246. package/internal/utils/uuid.d.ts.map +1 -0
  247. package/internal/utils/uuid.js +19 -0
  248. package/internal/utils/uuid.js.map +1 -0
  249. package/internal/utils/uuid.mjs +15 -0
  250. package/internal/utils/uuid.mjs.map +1 -0
  251. package/internal/utils/values.d.mts +18 -0
  252. package/internal/utils/values.d.mts.map +1 -0
  253. package/internal/utils/values.d.ts +18 -0
  254. package/internal/utils/values.d.ts.map +1 -0
  255. package/internal/utils/values.js +112 -0
  256. package/internal/utils/values.js.map +1 -0
  257. package/internal/utils/values.mjs +94 -0
  258. package/internal/utils/values.mjs.map +1 -0
  259. package/internal/utils.d.mts +7 -0
  260. package/internal/utils.d.mts.map +1 -0
  261. package/internal/utils.d.ts +7 -0
  262. package/internal/utils.d.ts.map +1 -0
  263. package/internal/utils.js +11 -0
  264. package/internal/utils.js.map +1 -0
  265. package/internal/utils.mjs +8 -0
  266. package/internal/utils.mjs.map +1 -0
  267. package/package.json +113 -64
  268. package/pagination.d.mts +2 -0
  269. package/pagination.d.mts.map +1 -0
  270. package/pagination.d.ts +1 -17
  271. package/pagination.d.ts.map +1 -1
  272. package/pagination.js +3 -37
  273. package/pagination.js.map +1 -1
  274. package/pagination.mjs +1 -35
  275. package/pagination.mjs.map +1 -1
  276. package/resource.d.mts +2 -0
  277. package/resource.d.mts.map +1 -0
  278. package/resource.d.ts +1 -5
  279. package/resource.d.ts.map +1 -1
  280. package/resource.js +3 -8
  281. package/resource.js.map +1 -1
  282. package/resource.mjs +1 -6
  283. package/resource.mjs.map +1 -1
  284. package/resources/auth-sessions.d.mts +84 -0
  285. package/resources/auth-sessions.d.mts.map +1 -0
  286. package/resources/auth-sessions.d.ts +4 -3
  287. package/resources/auth-sessions.d.ts.map +1 -1
  288. package/resources/auth-sessions.js +1 -1
  289. package/resources/auth-sessions.js.map +1 -1
  290. package/resources/auth-sessions.mjs +1 -1
  291. package/resources/auth-sessions.mjs.map +1 -1
  292. package/resources/end-users.d.mts +195 -0
  293. package/resources/end-users.d.mts.map +1 -0
  294. package/resources/end-users.d.ts +24 -12
  295. package/resources/end-users.d.ts.map +1 -1
  296. package/resources/end-users.js +14 -7
  297. package/resources/end-users.js.map +1 -1
  298. package/resources/end-users.mjs +14 -7
  299. package/resources/end-users.mjs.map +1 -1
  300. package/resources/index.d.mts +4 -0
  301. package/resources/index.d.mts.map +1 -0
  302. package/resources/index.d.ts.map +1 -1
  303. package/resources/qbd/account-tax-lines.d.mts +56 -0
  304. package/resources/qbd/account-tax-lines.d.mts.map +1 -0
  305. package/resources/qbd/account-tax-lines.d.ts +5 -5
  306. package/resources/qbd/account-tax-lines.d.ts.map +1 -1
  307. package/resources/qbd/account-tax-lines.js +3 -2
  308. package/resources/qbd/account-tax-lines.js.map +1 -1
  309. package/resources/qbd/account-tax-lines.mjs +3 -2
  310. package/resources/qbd/account-tax-lines.mjs.map +1 -1
  311. package/resources/qbd/accounts.d.mts +645 -0
  312. package/resources/qbd/accounts.d.mts.map +1 -0
  313. package/resources/qbd/accounts.d.ts +11 -14
  314. package/resources/qbd/accounts.d.ts.map +1 -1
  315. package/resources/qbd/accounts.js +9 -7
  316. package/resources/qbd/accounts.js.map +1 -1
  317. package/resources/qbd/accounts.mjs +9 -7
  318. package/resources/qbd/accounts.mjs.map +1 -1
  319. package/resources/qbd/bill-check-payments.d.mts +918 -0
  320. package/resources/qbd/bill-check-payments.d.mts.map +1 -0
  321. package/resources/qbd/bill-check-payments.d.ts +16 -21
  322. package/resources/qbd/bill-check-payments.d.ts.map +1 -1
  323. package/resources/qbd/bill-check-payments.js +14 -16
  324. package/resources/qbd/bill-check-payments.js.map +1 -1
  325. package/resources/qbd/bill-check-payments.mjs +13 -14
  326. package/resources/qbd/bill-check-payments.mjs.map +1 -1
  327. package/resources/qbd/bill-credit-card-payments.d.mts +714 -0
  328. package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -0
  329. package/resources/qbd/bill-credit-card-payments.d.ts +14 -18
  330. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
  331. package/resources/qbd/bill-credit-card-payments.js +15 -13
  332. package/resources/qbd/bill-credit-card-payments.js.map +1 -1
  333. package/resources/qbd/bill-credit-card-payments.mjs +14 -11
  334. package/resources/qbd/bill-credit-card-payments.mjs.map +1 -1
  335. package/resources/qbd/bills.d.mts +2644 -0
  336. package/resources/qbd/bills.d.mts.map +1 -0
  337. package/resources/qbd/bills.d.ts +16 -21
  338. package/resources/qbd/bills.d.ts.map +1 -1
  339. package/resources/qbd/bills.js +14 -16
  340. package/resources/qbd/bills.js.map +1 -1
  341. package/resources/qbd/bills.mjs +13 -14
  342. package/resources/qbd/bills.mjs.map +1 -1
  343. package/resources/qbd/build-assemblies.d.mts +698 -0
  344. package/resources/qbd/build-assemblies.d.mts.map +1 -0
  345. package/resources/qbd/build-assemblies.d.ts +16 -21
  346. package/resources/qbd/build-assemblies.d.ts.map +1 -1
  347. package/resources/qbd/build-assemblies.js +14 -16
  348. package/resources/qbd/build-assemblies.js.map +1 -1
  349. package/resources/qbd/build-assemblies.mjs +13 -14
  350. package/resources/qbd/build-assemblies.mjs.map +1 -1
  351. package/resources/qbd/checks.d.mts +2607 -0
  352. package/resources/qbd/checks.d.mts.map +1 -0
  353. package/resources/qbd/checks.d.ts +16 -21
  354. package/resources/qbd/checks.d.ts.map +1 -1
  355. package/resources/qbd/checks.js +14 -16
  356. package/resources/qbd/checks.js.map +1 -1
  357. package/resources/qbd/checks.mjs +13 -14
  358. package/resources/qbd/checks.mjs.map +1 -1
  359. package/resources/qbd/classes.d.mts +344 -0
  360. package/resources/qbd/classes.d.mts.map +1 -0
  361. package/resources/qbd/classes.d.ts +11 -14
  362. package/resources/qbd/classes.d.ts.map +1 -1
  363. package/resources/qbd/classes.js +9 -7
  364. package/resources/qbd/classes.js.map +1 -1
  365. package/resources/qbd/classes.mjs +9 -7
  366. package/resources/qbd/classes.mjs.map +1 -1
  367. package/resources/qbd/company.d.mts +361 -0
  368. package/resources/qbd/company.d.mts.map +1 -0
  369. package/resources/qbd/company.d.ts +5 -5
  370. package/resources/qbd/company.d.ts.map +1 -1
  371. package/resources/qbd/company.js +3 -2
  372. package/resources/qbd/company.js.map +1 -1
  373. package/resources/qbd/company.mjs +3 -2
  374. package/resources/qbd/company.mjs.map +1 -1
  375. package/resources/qbd/credit-card-charges.d.mts +2316 -0
  376. package/resources/qbd/credit-card-charges.d.mts.map +1 -0
  377. package/resources/qbd/credit-card-charges.d.ts +16 -21
  378. package/resources/qbd/credit-card-charges.d.ts.map +1 -1
  379. package/resources/qbd/credit-card-charges.js +14 -16
  380. package/resources/qbd/credit-card-charges.js.map +1 -1
  381. package/resources/qbd/credit-card-charges.mjs +13 -14
  382. package/resources/qbd/credit-card-charges.mjs.map +1 -1
  383. package/resources/qbd/credit-card-credits.d.mts +2311 -0
  384. package/resources/qbd/credit-card-credits.d.mts.map +1 -0
  385. package/resources/qbd/credit-card-credits.d.ts +16 -21
  386. package/resources/qbd/credit-card-credits.d.ts.map +1 -1
  387. package/resources/qbd/credit-card-credits.js +14 -16
  388. package/resources/qbd/credit-card-credits.js.map +1 -1
  389. package/resources/qbd/credit-card-credits.mjs +13 -14
  390. package/resources/qbd/credit-card-credits.mjs.map +1 -1
  391. package/resources/qbd/credit-card-refunds.d.mts +1012 -0
  392. package/resources/qbd/credit-card-refunds.d.mts.map +1 -0
  393. package/resources/qbd/credit-card-refunds.d.ts +14 -18
  394. package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
  395. package/resources/qbd/credit-card-refunds.js +12 -14
  396. package/resources/qbd/credit-card-refunds.js.map +1 -1
  397. package/resources/qbd/credit-card-refunds.mjs +11 -12
  398. package/resources/qbd/credit-card-refunds.mjs.map +1 -1
  399. package/resources/qbd/credit-memos.d.mts +2718 -0
  400. package/resources/qbd/credit-memos.d.mts.map +1 -0
  401. package/resources/qbd/credit-memos.d.ts +16 -21
  402. package/resources/qbd/credit-memos.d.ts.map +1 -1
  403. package/resources/qbd/credit-memos.js +14 -16
  404. package/resources/qbd/credit-memos.js.map +1 -1
  405. package/resources/qbd/credit-memos.mjs +13 -14
  406. package/resources/qbd/credit-memos.mjs.map +1 -1
  407. package/resources/qbd/currencies.d.mts +439 -0
  408. package/resources/qbd/currencies.d.mts.map +1 -0
  409. package/resources/qbd/currencies.d.ts +11 -14
  410. package/resources/qbd/currencies.d.ts.map +1 -1
  411. package/resources/qbd/currencies.js +9 -7
  412. package/resources/qbd/currencies.js.map +1 -1
  413. package/resources/qbd/currencies.mjs +9 -7
  414. package/resources/qbd/currencies.mjs.map +1 -1
  415. package/resources/qbd/customer-types.d.mts +300 -0
  416. package/resources/qbd/customer-types.d.mts.map +1 -0
  417. package/resources/qbd/customer-types.d.ts +9 -11
  418. package/resources/qbd/customer-types.d.ts.map +1 -1
  419. package/resources/qbd/customer-types.js +7 -5
  420. package/resources/qbd/customer-types.js.map +1 -1
  421. package/resources/qbd/customer-types.mjs +7 -5
  422. package/resources/qbd/customer-types.mjs.map +1 -1
  423. package/resources/qbd/customers.d.mts +2163 -0
  424. package/resources/qbd/customers.d.mts.map +1 -0
  425. package/resources/qbd/customers.d.ts +14 -18
  426. package/resources/qbd/customers.d.ts.map +1 -1
  427. package/resources/qbd/customers.js +12 -14
  428. package/resources/qbd/customers.js.map +1 -1
  429. package/resources/qbd/customers.mjs +11 -12
  430. package/resources/qbd/customers.mjs.map +1 -1
  431. package/resources/qbd/date-driven-terms.d.mts +295 -0
  432. package/resources/qbd/date-driven-terms.d.mts.map +1 -0
  433. package/resources/qbd/date-driven-terms.d.ts +9 -11
  434. package/resources/qbd/date-driven-terms.d.ts.map +1 -1
  435. package/resources/qbd/date-driven-terms.js +7 -5
  436. package/resources/qbd/date-driven-terms.js.map +1 -1
  437. package/resources/qbd/date-driven-terms.mjs +7 -5
  438. package/resources/qbd/date-driven-terms.mjs.map +1 -1
  439. package/resources/qbd/deleted-list-objects.d.mts +105 -0
  440. package/resources/qbd/deleted-list-objects.d.mts.map +1 -0
  441. package/resources/qbd/deleted-list-objects.d.ts +5 -5
  442. package/resources/qbd/deleted-list-objects.d.ts.map +1 -1
  443. package/resources/qbd/deleted-list-objects.js +3 -2
  444. package/resources/qbd/deleted-list-objects.js.map +1 -1
  445. package/resources/qbd/deleted-list-objects.mjs +3 -2
  446. package/resources/qbd/deleted-list-objects.mjs.map +1 -1
  447. package/resources/qbd/deleted-transactions.d.mts +111 -0
  448. package/resources/qbd/deleted-transactions.d.mts.map +1 -0
  449. package/resources/qbd/deleted-transactions.d.ts +5 -5
  450. package/resources/qbd/deleted-transactions.d.ts.map +1 -1
  451. package/resources/qbd/deleted-transactions.js +3 -2
  452. package/resources/qbd/deleted-transactions.js.map +1 -1
  453. package/resources/qbd/deleted-transactions.mjs +3 -2
  454. package/resources/qbd/deleted-transactions.mjs.map +1 -1
  455. package/resources/qbd/discount-items.d.mts +642 -0
  456. package/resources/qbd/discount-items.d.mts.map +1 -0
  457. package/resources/qbd/discount-items.d.ts +14 -18
  458. package/resources/qbd/discount-items.d.ts.map +1 -1
  459. package/resources/qbd/discount-items.js +12 -14
  460. package/resources/qbd/discount-items.js.map +1 -1
  461. package/resources/qbd/discount-items.mjs +11 -12
  462. package/resources/qbd/discount-items.mjs.map +1 -1
  463. package/resources/qbd/employees.d.mts +1811 -0
  464. package/resources/qbd/employees.d.mts.map +1 -0
  465. package/resources/qbd/employees.d.ts +11 -14
  466. package/resources/qbd/employees.d.ts.map +1 -1
  467. package/resources/qbd/employees.js +9 -7
  468. package/resources/qbd/employees.js.map +1 -1
  469. package/resources/qbd/employees.mjs +9 -7
  470. package/resources/qbd/employees.mjs.map +1 -1
  471. package/resources/qbd/estimates.d.mts +2584 -0
  472. package/resources/qbd/estimates.d.mts.map +1 -0
  473. package/resources/qbd/estimates.d.ts +16 -21
  474. package/resources/qbd/estimates.d.ts.map +1 -1
  475. package/resources/qbd/estimates.js +14 -16
  476. package/resources/qbd/estimates.js.map +1 -1
  477. package/resources/qbd/estimates.mjs +13 -14
  478. package/resources/qbd/estimates.mjs.map +1 -1
  479. package/resources/qbd/index.d.mts +57 -0
  480. package/resources/qbd/index.d.mts.map +1 -0
  481. package/resources/qbd/index.d.ts +34 -34
  482. package/resources/qbd/index.d.ts.map +1 -1
  483. package/resources/qbd/index.js +2 -36
  484. package/resources/qbd/index.js.map +1 -1
  485. package/resources/qbd/index.mjs +34 -34
  486. package/resources/qbd/index.mjs.map +1 -1
  487. package/resources/qbd/inventory-adjustments.d.mts +893 -0
  488. package/resources/qbd/inventory-adjustments.d.mts.map +1 -0
  489. package/resources/qbd/inventory-adjustments.d.ts +13 -17
  490. package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
  491. package/resources/qbd/inventory-adjustments.js +11 -9
  492. package/resources/qbd/inventory-adjustments.js.map +1 -1
  493. package/resources/qbd/inventory-adjustments.mjs +11 -9
  494. package/resources/qbd/inventory-adjustments.mjs.map +1 -1
  495. package/resources/qbd/inventory-assembly-items.d.mts +988 -0
  496. package/resources/qbd/inventory-assembly-items.d.mts.map +1 -0
  497. package/resources/qbd/inventory-assembly-items.d.ts +14 -18
  498. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  499. package/resources/qbd/inventory-assembly-items.js +15 -13
  500. package/resources/qbd/inventory-assembly-items.js.map +1 -1
  501. package/resources/qbd/inventory-assembly-items.mjs +14 -11
  502. package/resources/qbd/inventory-assembly-items.mjs.map +1 -1
  503. package/resources/qbd/inventory-items.d.mts +898 -0
  504. package/resources/qbd/inventory-items.d.mts.map +1 -0
  505. package/resources/qbd/inventory-items.d.ts +14 -18
  506. package/resources/qbd/inventory-items.d.ts.map +1 -1
  507. package/resources/qbd/inventory-items.js +12 -14
  508. package/resources/qbd/inventory-items.js.map +1 -1
  509. package/resources/qbd/inventory-items.mjs +11 -12
  510. package/resources/qbd/inventory-items.mjs.map +1 -1
  511. package/resources/qbd/inventory-sites.d.mts +537 -0
  512. package/resources/qbd/inventory-sites.d.mts.map +1 -0
  513. package/resources/qbd/inventory-sites.d.ts +11 -14
  514. package/resources/qbd/inventory-sites.d.ts.map +1 -1
  515. package/resources/qbd/inventory-sites.js +9 -7
  516. package/resources/qbd/inventory-sites.js.map +1 -1
  517. package/resources/qbd/inventory-sites.mjs +9 -7
  518. package/resources/qbd/inventory-sites.mjs.map +1 -1
  519. package/resources/qbd/invoices.d.mts +2942 -0
  520. package/resources/qbd/invoices.d.mts.map +1 -0
  521. package/resources/qbd/invoices.d.ts +16 -21
  522. package/resources/qbd/invoices.d.ts.map +1 -1
  523. package/resources/qbd/invoices.js +14 -16
  524. package/resources/qbd/invoices.js.map +1 -1
  525. package/resources/qbd/invoices.mjs +13 -14
  526. package/resources/qbd/invoices.mjs.map +1 -1
  527. package/resources/qbd/item-groups.d.mts +548 -0
  528. package/resources/qbd/item-groups.d.mts.map +1 -0
  529. package/resources/qbd/item-groups.d.ts +14 -18
  530. package/resources/qbd/item-groups.d.ts.map +1 -1
  531. package/resources/qbd/item-groups.js +12 -14
  532. package/resources/qbd/item-groups.js.map +1 -1
  533. package/resources/qbd/item-groups.mjs +11 -12
  534. package/resources/qbd/item-groups.mjs.map +1 -1
  535. package/resources/qbd/item-receipts.d.mts +2416 -0
  536. package/resources/qbd/item-receipts.d.mts.map +1 -0
  537. package/resources/qbd/item-receipts.d.ts +16 -21
  538. package/resources/qbd/item-receipts.d.ts.map +1 -1
  539. package/resources/qbd/item-receipts.js +14 -16
  540. package/resources/qbd/item-receipts.js.map +1 -1
  541. package/resources/qbd/item-receipts.mjs +13 -14
  542. package/resources/qbd/item-receipts.mjs.map +1 -1
  543. package/resources/qbd/item-sites.d.mts +244 -0
  544. package/resources/qbd/item-sites.d.mts.map +1 -0
  545. package/resources/qbd/item-sites.d.ts +10 -12
  546. package/resources/qbd/item-sites.d.ts.map +1 -1
  547. package/resources/qbd/item-sites.js +9 -11
  548. package/resources/qbd/item-sites.js.map +1 -1
  549. package/resources/qbd/item-sites.mjs +8 -9
  550. package/resources/qbd/item-sites.mjs.map +1 -1
  551. package/resources/qbd/journal-entries.d.mts +937 -0
  552. package/resources/qbd/journal-entries.d.mts.map +1 -0
  553. package/resources/qbd/journal-entries.d.ts +16 -21
  554. package/resources/qbd/journal-entries.d.ts.map +1 -1
  555. package/resources/qbd/journal-entries.js +14 -16
  556. package/resources/qbd/journal-entries.js.map +1 -1
  557. package/resources/qbd/journal-entries.mjs +13 -14
  558. package/resources/qbd/journal-entries.mjs.map +1 -1
  559. package/resources/qbd/non-inventory-items.d.mts +1016 -0
  560. package/resources/qbd/non-inventory-items.d.mts.map +1 -0
  561. package/resources/qbd/non-inventory-items.d.ts +14 -18
  562. package/resources/qbd/non-inventory-items.d.ts.map +1 -1
  563. package/resources/qbd/non-inventory-items.js +12 -14
  564. package/resources/qbd/non-inventory-items.js.map +1 -1
  565. package/resources/qbd/non-inventory-items.mjs +11 -12
  566. package/resources/qbd/non-inventory-items.mjs.map +1 -1
  567. package/resources/qbd/other-charge-items.d.mts +948 -0
  568. package/resources/qbd/other-charge-items.d.mts.map +1 -0
  569. package/resources/qbd/other-charge-items.d.ts +14 -18
  570. package/resources/qbd/other-charge-items.d.ts.map +1 -1
  571. package/resources/qbd/other-charge-items.js +12 -14
  572. package/resources/qbd/other-charge-items.js.map +1 -1
  573. package/resources/qbd/other-charge-items.mjs +11 -12
  574. package/resources/qbd/other-charge-items.mjs.map +1 -1
  575. package/resources/qbd/other-names.d.mts +711 -0
  576. package/resources/qbd/other-names.d.mts.map +1 -0
  577. package/resources/qbd/other-names.d.ts +11 -14
  578. package/resources/qbd/other-names.d.ts.map +1 -1
  579. package/resources/qbd/other-names.js +9 -7
  580. package/resources/qbd/other-names.js.map +1 -1
  581. package/resources/qbd/other-names.mjs +9 -7
  582. package/resources/qbd/other-names.mjs.map +1 -1
  583. package/resources/qbd/payment-methods.d.mts +258 -0
  584. package/resources/qbd/payment-methods.d.mts.map +1 -0
  585. package/resources/qbd/payment-methods.d.ts +9 -11
  586. package/resources/qbd/payment-methods.d.ts.map +1 -1
  587. package/resources/qbd/payment-methods.js +7 -5
  588. package/resources/qbd/payment-methods.js.map +1 -1
  589. package/resources/qbd/payment-methods.mjs +7 -5
  590. package/resources/qbd/payment-methods.mjs.map +1 -1
  591. package/resources/qbd/payroll-wage-items.d.mts +267 -0
  592. package/resources/qbd/payroll-wage-items.d.mts.map +1 -0
  593. package/resources/qbd/payroll-wage-items.d.ts +12 -15
  594. package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
  595. package/resources/qbd/payroll-wage-items.js +10 -12
  596. package/resources/qbd/payroll-wage-items.js.map +1 -1
  597. package/resources/qbd/payroll-wage-items.mjs +9 -10
  598. package/resources/qbd/payroll-wage-items.mjs.map +1 -1
  599. package/resources/qbd/preferences.d.mts +599 -0
  600. package/resources/qbd/preferences.d.mts.map +1 -0
  601. package/resources/qbd/preferences.d.ts +5 -5
  602. package/resources/qbd/preferences.d.ts.map +1 -1
  603. package/resources/qbd/preferences.js +3 -2
  604. package/resources/qbd/preferences.js.map +1 -1
  605. package/resources/qbd/preferences.mjs +3 -2
  606. package/resources/qbd/preferences.mjs.map +1 -1
  607. package/resources/qbd/price-levels.d.mts +509 -0
  608. package/resources/qbd/price-levels.d.mts.map +1 -0
  609. package/resources/qbd/price-levels.d.ts +11 -14
  610. package/resources/qbd/price-levels.d.ts.map +1 -1
  611. package/resources/qbd/price-levels.js +9 -7
  612. package/resources/qbd/price-levels.js.map +1 -1
  613. package/resources/qbd/price-levels.mjs +9 -7
  614. package/resources/qbd/price-levels.mjs.map +1 -1
  615. package/resources/qbd/purchase-orders.d.mts +2632 -0
  616. package/resources/qbd/purchase-orders.d.mts.map +1 -0
  617. package/resources/qbd/purchase-orders.d.ts +16 -21
  618. package/resources/qbd/purchase-orders.d.ts.map +1 -1
  619. package/resources/qbd/purchase-orders.js +14 -16
  620. package/resources/qbd/purchase-orders.js.map +1 -1
  621. package/resources/qbd/purchase-orders.mjs +13 -14
  622. package/resources/qbd/purchase-orders.mjs.map +1 -1
  623. package/resources/qbd/qbd.d.mts +261 -0
  624. package/resources/qbd/qbd.d.mts.map +1 -0
  625. package/resources/qbd/qbd.d.ts +39 -39
  626. package/resources/qbd/qbd.d.ts.map +1 -1
  627. package/resources/qbd/qbd.js +59 -114
  628. package/resources/qbd/qbd.js.map +1 -1
  629. package/resources/qbd/qbd.mjs +37 -70
  630. package/resources/qbd/qbd.mjs.map +1 -1
  631. package/resources/qbd/receive-payments.d.mts +1358 -0
  632. package/resources/qbd/receive-payments.d.mts.map +1 -0
  633. package/resources/qbd/receive-payments.d.ts +16 -21
  634. package/resources/qbd/receive-payments.d.ts.map +1 -1
  635. package/resources/qbd/receive-payments.js +14 -16
  636. package/resources/qbd/receive-payments.js.map +1 -1
  637. package/resources/qbd/receive-payments.mjs +13 -14
  638. package/resources/qbd/receive-payments.mjs.map +1 -1
  639. package/resources/qbd/sales-orders.d.mts +2705 -0
  640. package/resources/qbd/sales-orders.d.mts.map +1 -0
  641. package/resources/qbd/sales-orders.d.ts +16 -21
  642. package/resources/qbd/sales-orders.d.ts.map +1 -1
  643. package/resources/qbd/sales-orders.js +14 -16
  644. package/resources/qbd/sales-orders.js.map +1 -1
  645. package/resources/qbd/sales-orders.mjs +13 -14
  646. package/resources/qbd/sales-orders.mjs.map +1 -1
  647. package/resources/qbd/sales-receipts.d.mts +3454 -0
  648. package/resources/qbd/sales-receipts.d.mts.map +1 -0
  649. package/resources/qbd/sales-receipts.d.ts +16 -21
  650. package/resources/qbd/sales-receipts.d.ts.map +1 -1
  651. package/resources/qbd/sales-receipts.js +14 -16
  652. package/resources/qbd/sales-receipts.js.map +1 -1
  653. package/resources/qbd/sales-receipts.mjs +13 -14
  654. package/resources/qbd/sales-receipts.mjs.map +1 -1
  655. package/resources/qbd/sales-representatives.d.mts +317 -0
  656. package/resources/qbd/sales-representatives.d.mts.map +1 -0
  657. package/resources/qbd/sales-representatives.d.ts +11 -14
  658. package/resources/qbd/sales-representatives.d.ts.map +1 -1
  659. package/resources/qbd/sales-representatives.js +9 -7
  660. package/resources/qbd/sales-representatives.js.map +1 -1
  661. package/resources/qbd/sales-representatives.mjs +9 -7
  662. package/resources/qbd/sales-representatives.mjs.map +1 -1
  663. package/resources/qbd/sales-tax-codes.d.mts +369 -0
  664. package/resources/qbd/sales-tax-codes.d.mts.map +1 -0
  665. package/resources/qbd/sales-tax-codes.d.ts +11 -14
  666. package/resources/qbd/sales-tax-codes.d.ts.map +1 -1
  667. package/resources/qbd/sales-tax-codes.js +9 -7
  668. package/resources/qbd/sales-tax-codes.js.map +1 -1
  669. package/resources/qbd/sales-tax-codes.mjs +9 -7
  670. package/resources/qbd/sales-tax-codes.mjs.map +1 -1
  671. package/resources/qbd/sales-tax-items.d.mts +518 -0
  672. package/resources/qbd/sales-tax-items.d.mts.map +1 -0
  673. package/resources/qbd/sales-tax-items.d.ts +14 -18
  674. package/resources/qbd/sales-tax-items.d.ts.map +1 -1
  675. package/resources/qbd/sales-tax-items.js +12 -14
  676. package/resources/qbd/sales-tax-items.js.map +1 -1
  677. package/resources/qbd/sales-tax-items.mjs +11 -12
  678. package/resources/qbd/sales-tax-items.mjs.map +1 -1
  679. package/resources/qbd/service-items.d.mts +987 -0
  680. package/resources/qbd/service-items.d.mts.map +1 -0
  681. package/resources/qbd/service-items.d.ts +14 -18
  682. package/resources/qbd/service-items.d.ts.map +1 -1
  683. package/resources/qbd/service-items.js +12 -14
  684. package/resources/qbd/service-items.js.map +1 -1
  685. package/resources/qbd/service-items.mjs +11 -12
  686. package/resources/qbd/service-items.mjs.map +1 -1
  687. package/resources/qbd/standard-terms.d.mts +273 -0
  688. package/resources/qbd/standard-terms.d.mts.map +1 -0
  689. package/resources/qbd/standard-terms.d.ts +9 -11
  690. package/resources/qbd/standard-terms.d.ts.map +1 -1
  691. package/resources/qbd/standard-terms.js +7 -5
  692. package/resources/qbd/standard-terms.js.map +1 -1
  693. package/resources/qbd/standard-terms.mjs +7 -5
  694. package/resources/qbd/standard-terms.mjs.map +1 -1
  695. package/resources/qbd/subtotal-items.d.mts +383 -0
  696. package/resources/qbd/subtotal-items.d.mts.map +1 -0
  697. package/resources/qbd/subtotal-items.d.ts +14 -18
  698. package/resources/qbd/subtotal-items.d.ts.map +1 -1
  699. package/resources/qbd/subtotal-items.js +12 -14
  700. package/resources/qbd/subtotal-items.js.map +1 -1
  701. package/resources/qbd/subtotal-items.mjs +11 -12
  702. package/resources/qbd/subtotal-items.mjs.map +1 -1
  703. package/resources/qbd/templates.d.mts +107 -0
  704. package/resources/qbd/templates.d.mts.map +1 -0
  705. package/resources/qbd/templates.d.ts +5 -5
  706. package/resources/qbd/templates.d.ts.map +1 -1
  707. package/resources/qbd/templates.js +3 -2
  708. package/resources/qbd/templates.js.map +1 -1
  709. package/resources/qbd/templates.mjs +3 -2
  710. package/resources/qbd/templates.mjs.map +1 -1
  711. package/resources/qbd/time-tracking-activities.d.mts +560 -0
  712. package/resources/qbd/time-tracking-activities.d.mts.map +1 -0
  713. package/resources/qbd/time-tracking-activities.d.ts +16 -21
  714. package/resources/qbd/time-tracking-activities.d.ts.map +1 -1
  715. package/resources/qbd/time-tracking-activities.js +17 -15
  716. package/resources/qbd/time-tracking-activities.js.map +1 -1
  717. package/resources/qbd/time-tracking-activities.mjs +16 -13
  718. package/resources/qbd/time-tracking-activities.mjs.map +1 -1
  719. package/resources/qbd/transactions.d.mts +356 -0
  720. package/resources/qbd/transactions.d.mts.map +1 -0
  721. package/resources/qbd/transactions.d.ts +10 -12
  722. package/resources/qbd/transactions.d.ts.map +1 -1
  723. package/resources/qbd/transactions.js +9 -11
  724. package/resources/qbd/transactions.js.map +1 -1
  725. package/resources/qbd/transactions.mjs +8 -9
  726. package/resources/qbd/transactions.mjs.map +1 -1
  727. package/resources/qbd/transfers.d.mts +331 -0
  728. package/resources/qbd/transfers.d.mts.map +1 -0
  729. package/resources/qbd/transfers.d.ts +14 -18
  730. package/resources/qbd/transfers.d.ts.map +1 -1
  731. package/resources/qbd/transfers.js +12 -14
  732. package/resources/qbd/transfers.js.map +1 -1
  733. package/resources/qbd/transfers.mjs +11 -12
  734. package/resources/qbd/transfers.mjs.map +1 -1
  735. package/resources/qbd/unit-of-measure-sets.d.mts +443 -0
  736. package/resources/qbd/unit-of-measure-sets.d.mts.map +1 -0
  737. package/resources/qbd/unit-of-measure-sets.d.ts +9 -11
  738. package/resources/qbd/unit-of-measure-sets.d.ts.map +1 -1
  739. package/resources/qbd/unit-of-measure-sets.js +7 -5
  740. package/resources/qbd/unit-of-measure-sets.js.map +1 -1
  741. package/resources/qbd/unit-of-measure-sets.mjs +7 -5
  742. package/resources/qbd/unit-of-measure-sets.mjs.map +1 -1
  743. package/resources/qbd/vendor-credits.d.mts +2387 -0
  744. package/resources/qbd/vendor-credits.d.mts.map +1 -0
  745. package/resources/qbd/vendor-credits.d.ts +16 -21
  746. package/resources/qbd/vendor-credits.d.ts.map +1 -1
  747. package/resources/qbd/vendor-credits.js +14 -16
  748. package/resources/qbd/vendor-credits.js.map +1 -1
  749. package/resources/qbd/vendor-credits.mjs +13 -14
  750. package/resources/qbd/vendor-credits.mjs.map +1 -1
  751. package/resources/qbd/vendors.d.mts +1734 -0
  752. package/resources/qbd/vendors.d.mts.map +1 -0
  753. package/resources/qbd/vendors.d.ts +14 -18
  754. package/resources/qbd/vendors.d.ts.map +1 -1
  755. package/resources/qbd/vendors.js +12 -14
  756. package/resources/qbd/vendors.js.map +1 -1
  757. package/resources/qbd/vendors.mjs +11 -12
  758. package/resources/qbd/vendors.mjs.map +1 -1
  759. package/resources/qbd.d.mts +2 -0
  760. package/resources/qbd.d.mts.map +1 -0
  761. package/resources/qbd.d.ts.map +1 -1
  762. package/resources/qbd.js +2 -15
  763. package/resources/qbd.js.map +1 -1
  764. package/resources.d.mts +2 -0
  765. package/resources.d.mts.map +1 -0
  766. package/resources.d.ts.map +1 -1
  767. package/resources.js +2 -15
  768. package/resources.js.map +1 -1
  769. package/src/api-promise.ts +2 -0
  770. package/src/client.ts +769 -0
  771. package/src/core/README.md +3 -0
  772. package/src/core/api-promise.ts +92 -0
  773. package/src/core/error.ts +130 -0
  774. package/src/core/pagination.ts +157 -0
  775. package/src/core/resource.ts +11 -0
  776. package/src/core/uploads.ts +2 -0
  777. package/src/error.ts +2 -130
  778. package/src/index.ts +6 -223
  779. package/src/internal/README.md +3 -0
  780. package/src/internal/builtin-types.ts +93 -0
  781. package/src/internal/detect-platform.ts +196 -0
  782. package/src/internal/errors.ts +33 -0
  783. package/src/internal/headers.ts +97 -0
  784. package/src/internal/parse.ts +50 -0
  785. package/src/internal/qs/formats.ts +3 -2
  786. package/src/internal/qs/index.ts +3 -3
  787. package/src/internal/qs/stringify.ts +18 -21
  788. package/src/internal/qs/utils.ts +16 -16
  789. package/src/internal/request-options.ts +91 -0
  790. package/src/internal/shim-types.ts +26 -0
  791. package/src/internal/shims.ts +107 -0
  792. package/src/internal/to-file.ts +154 -0
  793. package/src/internal/types.ts +95 -0
  794. package/src/internal/uploads.ts +187 -0
  795. package/src/internal/utils/base64.ts +40 -0
  796. package/src/internal/utils/bytes.ts +32 -0
  797. package/src/internal/utils/env.ts +18 -0
  798. package/src/internal/utils/log.ts +126 -0
  799. package/src/internal/utils/path.ts +88 -0
  800. package/src/internal/utils/sleep.ts +3 -0
  801. package/src/internal/utils/uuid.ts +17 -0
  802. package/src/internal/utils/values.ts +105 -0
  803. package/src/internal/utils.ts +8 -0
  804. package/src/pagination.ts +2 -60
  805. package/src/resource.ts +2 -11
  806. package/src/resources/auth-sessions.ts +4 -3
  807. package/src/resources/end-users.ts +33 -16
  808. package/src/resources/index.ts +3 -3
  809. package/src/resources/qbd/account-tax-lines.ts +7 -9
  810. package/src/resources/qbd/accounts.ts +19 -24
  811. package/src/resources/qbd/bill-check-payments.ts +31 -38
  812. package/src/resources/qbd/bill-credit-card-payments.ts +31 -30
  813. package/src/resources/qbd/bills.ts +27 -35
  814. package/src/resources/qbd/build-assemblies.ts +30 -38
  815. package/src/resources/qbd/checks.ts +27 -35
  816. package/src/resources/qbd/classes.ts +19 -20
  817. package/src/resources/qbd/company.ts +7 -6
  818. package/src/resources/qbd/credit-card-charges.ts +31 -38
  819. package/src/resources/qbd/credit-card-credits.ts +31 -38
  820. package/src/resources/qbd/credit-card-refunds.ts +26 -32
  821. package/src/resources/qbd/credit-memos.ts +29 -41
  822. package/src/resources/qbd/currencies.ts +19 -24
  823. package/src/resources/qbd/customer-types.ts +16 -19
  824. package/src/resources/qbd/customers.ts +23 -33
  825. package/src/resources/qbd/date-driven-terms.ts +16 -19
  826. package/src/resources/qbd/deleted-list-objects.ts +8 -7
  827. package/src/resources/qbd/deleted-transactions.ts +8 -7
  828. package/src/resources/qbd/discount-items.ts +25 -32
  829. package/src/resources/qbd/employees.ts +19 -24
  830. package/src/resources/qbd/estimates.ts +28 -39
  831. package/src/resources/qbd/index.ts +90 -90
  832. package/src/resources/qbd/inventory-adjustments.ts +27 -32
  833. package/src/resources/qbd/inventory-assembly-items.ts +31 -30
  834. package/src/resources/qbd/inventory-items.ts +25 -32
  835. package/src/resources/qbd/inventory-sites.ts +20 -28
  836. package/src/resources/qbd/invoices.ts +28 -39
  837. package/src/resources/qbd/item-groups.ts +23 -37
  838. package/src/resources/qbd/item-receipts.ts +29 -41
  839. package/src/resources/qbd/item-sites.ts +16 -24
  840. package/src/resources/qbd/journal-entries.ts +30 -38
  841. package/src/resources/qbd/non-inventory-items.ts +26 -32
  842. package/src/resources/qbd/other-charge-items.ts +26 -32
  843. package/src/resources/qbd/other-names.ts +19 -28
  844. package/src/resources/qbd/payment-methods.ts +16 -19
  845. package/src/resources/qbd/payroll-wage-items.ts +21 -26
  846. package/src/resources/qbd/preferences.ts +7 -6
  847. package/src/resources/qbd/price-levels.ts +19 -28
  848. package/src/resources/qbd/purchase-orders.ts +30 -38
  849. package/src/resources/qbd/qbd.ts +151 -187
  850. package/src/resources/qbd/receive-payments.ts +31 -35
  851. package/src/resources/qbd/sales-orders.ts +29 -41
  852. package/src/resources/qbd/sales-receipts.ts +30 -38
  853. package/src/resources/qbd/sales-representatives.ts +22 -26
  854. package/src/resources/qbd/sales-tax-codes.ts +20 -28
  855. package/src/resources/qbd/sales-tax-items.ts +25 -32
  856. package/src/resources/qbd/service-items.ts +24 -35
  857. package/src/resources/qbd/standard-terms.ts +16 -19
  858. package/src/resources/qbd/subtotal-items.ts +25 -32
  859. package/src/resources/qbd/templates.ts +7 -6
  860. package/src/resources/qbd/time-tracking-activities.ts +36 -36
  861. package/src/resources/qbd/transactions.ts +17 -22
  862. package/src/resources/qbd/transfers.ts +23 -33
  863. package/src/resources/qbd/unit-of-measure-sets.ts +17 -20
  864. package/src/resources/qbd/vendor-credits.ts +30 -38
  865. package/src/resources/qbd/vendors.ts +23 -26
  866. package/src/resources/qbd.ts +1 -1
  867. package/src/resources.ts +1 -1
  868. package/src/tsconfig.json +2 -2
  869. package/src/uploads.ts +2 -255
  870. package/src/version.ts +1 -1
  871. package/uploads.d.mts +2 -0
  872. package/uploads.d.mts.map +1 -0
  873. package/uploads.d.ts +1 -74
  874. package/uploads.d.ts.map +1 -1
  875. package/uploads.js +3 -168
  876. package/uploads.js.map +1 -1
  877. package/uploads.mjs +1 -157
  878. package/uploads.mjs.map +1 -1
  879. package/version.d.mts +2 -0
  880. package/version.d.mts.map +1 -0
  881. package/version.d.ts +1 -1
  882. package/version.d.ts.map +1 -1
  883. package/version.js +1 -1
  884. package/version.js.map +1 -1
  885. package/version.mjs +1 -1
  886. package/version.mjs.map +1 -1
  887. package/_shims/MultipartBody.d.ts +0 -9
  888. package/_shims/MultipartBody.d.ts.map +0 -1
  889. package/_shims/MultipartBody.js +0 -16
  890. package/_shims/MultipartBody.js.map +0 -1
  891. package/_shims/MultipartBody.mjs +0 -12
  892. package/_shims/MultipartBody.mjs.map +0 -1
  893. package/_shims/README.md +0 -46
  894. package/_shims/auto/runtime-bun.d.ts +0 -5
  895. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  896. package/_shims/auto/runtime-bun.js +0 -21
  897. package/_shims/auto/runtime-bun.js.map +0 -1
  898. package/_shims/auto/runtime-bun.mjs +0 -2
  899. package/_shims/auto/runtime-bun.mjs.map +0 -1
  900. package/_shims/auto/runtime-node.d.ts +0 -5
  901. package/_shims/auto/runtime-node.d.ts.map +0 -1
  902. package/_shims/auto/runtime-node.js +0 -21
  903. package/_shims/auto/runtime-node.js.map +0 -1
  904. package/_shims/auto/runtime-node.mjs +0 -2
  905. package/_shims/auto/runtime-node.mjs.map +0 -1
  906. package/_shims/auto/runtime.d.ts +0 -5
  907. package/_shims/auto/runtime.d.ts.map +0 -1
  908. package/_shims/auto/runtime.js +0 -21
  909. package/_shims/auto/runtime.js.map +0 -1
  910. package/_shims/auto/runtime.mjs +0 -2
  911. package/_shims/auto/runtime.mjs.map +0 -1
  912. package/_shims/auto/types-node.d.ts +0 -5
  913. package/_shims/auto/types-node.d.ts.map +0 -1
  914. package/_shims/auto/types-node.js +0 -21
  915. package/_shims/auto/types-node.js.map +0 -1
  916. package/_shims/auto/types-node.mjs +0 -2
  917. package/_shims/auto/types-node.mjs.map +0 -1
  918. package/_shims/auto/types.d.ts +0 -101
  919. package/_shims/auto/types.js +0 -3
  920. package/_shims/auto/types.mjs +0 -3
  921. package/_shims/bun-runtime.d.ts +0 -6
  922. package/_shims/bun-runtime.d.ts.map +0 -1
  923. package/_shims/bun-runtime.js +0 -14
  924. package/_shims/bun-runtime.js.map +0 -1
  925. package/_shims/bun-runtime.mjs +0 -10
  926. package/_shims/bun-runtime.mjs.map +0 -1
  927. package/_shims/index.d.ts +0 -83
  928. package/_shims/index.js +0 -17
  929. package/_shims/index.mjs +0 -11
  930. package/_shims/manual-types.d.ts +0 -12
  931. package/_shims/manual-types.js +0 -3
  932. package/_shims/manual-types.mjs +0 -3
  933. package/_shims/node-runtime.d.ts +0 -3
  934. package/_shims/node-runtime.d.ts.map +0 -1
  935. package/_shims/node-runtime.js +0 -89
  936. package/_shims/node-runtime.js.map +0 -1
  937. package/_shims/node-runtime.mjs +0 -56
  938. package/_shims/node-runtime.mjs.map +0 -1
  939. package/_shims/node-types.d.ts +0 -42
  940. package/_shims/node-types.js +0 -3
  941. package/_shims/node-types.mjs +0 -3
  942. package/_shims/registry.d.ts +0 -37
  943. package/_shims/registry.d.ts.map +0 -1
  944. package/_shims/registry.js +0 -41
  945. package/_shims/registry.js.map +0 -1
  946. package/_shims/registry.mjs +0 -37
  947. package/_shims/registry.mjs.map +0 -1
  948. package/_shims/web-runtime.d.ts +0 -5
  949. package/_shims/web-runtime.d.ts.map +0 -1
  950. package/_shims/web-runtime.js +0 -78
  951. package/_shims/web-runtime.js.map +0 -1
  952. package/_shims/web-runtime.mjs +0 -71
  953. package/_shims/web-runtime.mjs.map +0 -1
  954. package/_shims/web-types.d.ts +0 -83
  955. package/_shims/web-types.js +0 -3
  956. package/_shims/web-types.mjs +0 -3
  957. package/core.d.ts +0 -255
  958. package/core.d.ts.map +0 -1
  959. package/core.js +0 -924
  960. package/core.js.map +0 -1
  961. package/core.mjs +0 -892
  962. package/core.mjs.map +0 -1
  963. package/shims/node.d.ts +0 -30
  964. package/shims/node.d.ts.map +0 -1
  965. package/shims/node.js +0 -31
  966. package/shims/node.js.map +0 -1
  967. package/shims/node.mjs +0 -5
  968. package/shims/node.mjs.map +0 -1
  969. package/shims/web.d.ts +0 -26
  970. package/shims/web.d.ts.map +0 -1
  971. package/shims/web.js +0 -31
  972. package/shims/web.js.map +0 -1
  973. package/shims/web.mjs +0 -5
  974. package/shims/web.mjs.map +0 -1
  975. package/src/_shims/MultipartBody.ts +0 -9
  976. package/src/_shims/README.md +0 -46
  977. package/src/_shims/auto/runtime-bun.ts +0 -4
  978. package/src/_shims/auto/runtime-node.ts +0 -4
  979. package/src/_shims/auto/runtime.ts +0 -4
  980. package/src/_shims/auto/types-node.ts +0 -4
  981. package/src/_shims/auto/types.d.ts +0 -101
  982. package/src/_shims/auto/types.js +0 -3
  983. package/src/_shims/auto/types.mjs +0 -3
  984. package/src/_shims/bun-runtime.ts +0 -14
  985. package/src/_shims/index.d.ts +0 -83
  986. package/src/_shims/index.js +0 -17
  987. package/src/_shims/index.mjs +0 -11
  988. package/src/_shims/manual-types.d.ts +0 -12
  989. package/src/_shims/manual-types.js +0 -3
  990. package/src/_shims/manual-types.mjs +0 -3
  991. package/src/_shims/node-runtime.ts +0 -81
  992. package/src/_shims/node-types.d.ts +0 -42
  993. package/src/_shims/node-types.js +0 -3
  994. package/src/_shims/node-types.mjs +0 -3
  995. package/src/_shims/registry.ts +0 -67
  996. package/src/_shims/web-runtime.ts +0 -103
  997. package/src/_shims/web-types.d.ts +0 -83
  998. package/src/_shims/web-types.js +0 -3
  999. package/src/_shims/web-types.mjs +0 -3
  1000. package/src/core.ts +0 -1236
  1001. package/src/shims/node.ts +0 -50
  1002. package/src/shims/web.ts +0 -50
@@ -0,0 +1,2584 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
4
+ import { RequestOptions } from "../../internal/request-options.mjs";
5
+ export declare class Estimates extends APIResource {
6
+ /**
7
+ * Creates a new estimate.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const estimate = await conductor.qbd.estimates.create({
12
+ * customerId: '80000001-1234567890',
13
+ * transactionDate: '2024-10-01',
14
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
15
+ * });
16
+ * ```
17
+ */
18
+ create(params: EstimateCreateParams, options?: RequestOptions): APIPromise<Estimate>;
19
+ /**
20
+ * Retrieves an estimate by ID.
21
+ *
22
+ * **IMPORTANT:** If you need to fetch multiple specific estimates by ID, use the
23
+ * list endpoint instead with the `ids` parameter. It accepts an array of IDs so
24
+ * you can batch the request into a single call, which is significantly faster.
25
+ *
26
+ * NOTE: The response automatically includes any linked transactions.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const estimate = await conductor.qbd.estimates.retrieve(
31
+ * '123ABC-1234567890',
32
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
33
+ * );
34
+ * ```
35
+ */
36
+ retrieve(id: string, params: EstimateRetrieveParams, options?: RequestOptions): APIPromise<Estimate>;
37
+ /**
38
+ * Updates an existing estimate.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const estimate = await conductor.qbd.estimates.update(
43
+ * '123ABC-1234567890',
44
+ * {
45
+ * revisionNumber: '1721172183',
46
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
47
+ * },
48
+ * );
49
+ * ```
50
+ */
51
+ update(id: string, params: EstimateUpdateParams, options?: RequestOptions): APIPromise<Estimate>;
52
+ /**
53
+ * Returns a list of estimates. Use the `cursor` parameter to paginate through the
54
+ * results.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * // Automatically fetches more pages as needed.
59
+ * for await (const estimate of conductor.qbd.estimates.list({
60
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
61
+ * })) {
62
+ * // ...
63
+ * }
64
+ * ```
65
+ */
66
+ list(params: EstimateListParams, options?: RequestOptions): PagePromise<EstimatesCursorPage, Estimate>;
67
+ /**
68
+ * Permanently deletes a an estimate. The deletion will fail if the estimate is
69
+ * currently in use or has any linked transactions that are in use.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const estimate = await conductor.qbd.estimates.delete(
74
+ * '123ABC-1234567890',
75
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
76
+ * );
77
+ * ```
78
+ */
79
+ delete(id: string, params: EstimateDeleteParams, options?: RequestOptions): APIPromise<EstimateDeleteResponse>;
80
+ }
81
+ export type EstimatesCursorPage = CursorPage<Estimate>;
82
+ export interface Estimate {
83
+ /**
84
+ * The unique identifier assigned by QuickBooks to this estimate. This ID is unique
85
+ * across all transaction types.
86
+ */
87
+ id: string;
88
+ /**
89
+ * The estimate's billing address.
90
+ */
91
+ billingAddress: Estimate.BillingAddress | null;
92
+ /**
93
+ * The estimate's class. Classes can be used to categorize objects into meaningful
94
+ * segments, such as department, location, or type of work. In QuickBooks, class
95
+ * tracking is off by default. A class defined here is automatically used in this
96
+ * estimate's line items unless overridden at the line item level.
97
+ */
98
+ class: Estimate.Class | null;
99
+ /**
100
+ * The date and time when this estimate was created, in ISO 8601 format
101
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
102
+ * timezone of the end-user's computer.
103
+ */
104
+ createdAt: string;
105
+ /**
106
+ * The estimate's currency. For built-in currencies, the name and code are standard
107
+ * international values. For user-defined currencies, all values are editable.
108
+ */
109
+ currency: Estimate.Currency | null;
110
+ /**
111
+ * The customer or customer-job associated with this estimate.
112
+ */
113
+ customer: Estimate.Customer;
114
+ /**
115
+ * The message to display to the customer on the estimate.
116
+ */
117
+ customerMessage: Estimate.CustomerMessage | null;
118
+ /**
119
+ * The custom fields for the estimate object, added as user-defined data
120
+ * extensions, not included in the standard QuickBooks object.
121
+ */
122
+ customFields: Array<Estimate.CustomField>;
123
+ /**
124
+ * The predefined template in QuickBooks that determines the layout and formatting
125
+ * for this estimate when printed or displayed.
126
+ */
127
+ documentTemplate: Estimate.DocumentTemplate | null;
128
+ /**
129
+ * The date by which this estimate must be paid, in ISO 8601 format (YYYY-MM-DD).
130
+ */
131
+ dueDate: string | null;
132
+ /**
133
+ * The market exchange rate between this estimate's currency and the home currency
134
+ * in QuickBooks at the time of this transaction. Represented as a decimal value
135
+ * (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
136
+ */
137
+ exchangeRate: number | null;
138
+ /**
139
+ * A globally unique identifier (GUID) you, the developer, can provide for tracking
140
+ * this object in your external system. This field is immutable and can only be set
141
+ * during object creation.
142
+ */
143
+ externalId: string | null;
144
+ /**
145
+ * Indicates whether this estimate is active. Inactive objects are typically hidden
146
+ * from views and reports in QuickBooks. Defaults to `true`.
147
+ */
148
+ isActive: boolean;
149
+ /**
150
+ * Indicates whether this estimate is included in the queue of documents for
151
+ * QuickBooks to email to the customer.
152
+ */
153
+ isQueuedForEmail: boolean | null;
154
+ /**
155
+ * The estimate's line item groups, each representing a predefined set of related
156
+ * items.
157
+ */
158
+ lineGroups: Array<Estimate.LineGroup>;
159
+ /**
160
+ * The estimate's line items, each representing a single product or service quoted.
161
+ */
162
+ lines: Array<Estimate.Line>;
163
+ /**
164
+ * The estimate's linked transactions, such as payments applied, credits used, or
165
+ * associated purchase orders.
166
+ *
167
+ * **IMPORTANT**: You must specify the parameter `includeLinkedTransactions` when
168
+ * fetching a list of estimates to receive this field because it is not returned by
169
+ * default.
170
+ */
171
+ linkedTransactions: Array<Estimate.LinkedTransaction>;
172
+ /**
173
+ * A memo or note for this estimate that appears in reports, but not on the
174
+ * estimate. Use `customerMessage` to add a note to this estimate.
175
+ */
176
+ memo: string | null;
177
+ /**
178
+ * The type of object. This value is always `"qbd_estimate"`.
179
+ */
180
+ objectType: 'qbd_estimate';
181
+ /**
182
+ * A built-in custom field for additional information specific to this estimate.
183
+ * Unlike the user-defined fields in the `customFields` array, this is a standard
184
+ * QuickBooks field that exists for all estimates for convenience. Developers often
185
+ * use this field for tracking information that doesn't fit into other standard
186
+ * QuickBooks fields. Unlike `otherCustomField1` and `otherCustomField2`, which are
187
+ * line item fields, this exists at the transaction level. Hidden by default in the
188
+ * QuickBooks UI.
189
+ */
190
+ otherCustomField: string | null;
191
+ /**
192
+ * The customer's Purchase Order (PO) number associated with this estimate. This
193
+ * field is often used to cross-reference the estimate with the customer's
194
+ * purchasing system.
195
+ */
196
+ purchaseOrderNumber: string | null;
197
+ /**
198
+ * The case-sensitive user-defined reference number for this estimate, which can be
199
+ * used to identify the transaction in QuickBooks. This value is not required to be
200
+ * unique and can be arbitrarily changed by the QuickBooks user.
201
+ */
202
+ refNumber: string | null;
203
+ /**
204
+ * The current QuickBooks-assigned revision number of this estimate object, which
205
+ * changes each time the object is modified. When updating this object, you must
206
+ * provide the most recent `revisionNumber` to ensure you're working with the
207
+ * latest data; otherwise, the update will return an error.
208
+ */
209
+ revisionNumber: string;
210
+ /**
211
+ * The estimate's sales representative. Sales representatives can be employees,
212
+ * vendors, or other names in QuickBooks.
213
+ */
214
+ salesRepresentative: Estimate.SalesRepresentative | null;
215
+ /**
216
+ * The sales-tax code for this estimate, determining whether it is taxable or
217
+ * non-taxable. This can be overridden at the transaction-line level.
218
+ *
219
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
220
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
221
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
222
+ * non-taxable code to all sales.
223
+ */
224
+ salesTaxCode: Estimate.SalesTaxCode | null;
225
+ /**
226
+ * The sales-tax item used to calculate the actual tax amount for this estimate's
227
+ * transactions by applying a specific tax rate collected for a single tax agency.
228
+ * Unlike `salesTaxCode`, which only indicates general taxability, this field
229
+ * drives the actual tax calculation and reporting.
230
+ */
231
+ salesTaxItem: Estimate.SalesTaxItem | null;
232
+ /**
233
+ * The sales tax percentage applied to this estimate, represented as a decimal
234
+ * string.
235
+ */
236
+ salesTaxPercentage: string | null;
237
+ /**
238
+ * The total amount of sales tax charged for this estimate, represented as a
239
+ * decimal string.
240
+ */
241
+ salesTaxTotal: string | null;
242
+ /**
243
+ * The origin location from where the product associated with this estimate is
244
+ * shipped. This is the point at which ownership and liability for goods transfer
245
+ * from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field,
246
+ * which stands for "freight on board". This field is informational and has no
247
+ * accounting implications.
248
+ */
249
+ shipmentOrigin: string | null;
250
+ /**
251
+ * The estimate's shipping address.
252
+ */
253
+ shippingAddress: Estimate.ShippingAddress | null;
254
+ /**
255
+ * The subtotal of this estimate, which is the sum of all estimate lines before
256
+ * taxes and payments are applied, represented as a decimal string.
257
+ */
258
+ subtotal: string;
259
+ /**
260
+ * The estimate's payment terms, defining when payment is due and any applicable
261
+ * discounts.
262
+ */
263
+ terms: Estimate.Terms | null;
264
+ /**
265
+ * The total monetary amount of this estimate, equivalent to the sum of the amounts
266
+ * in `lines` and `lineGroups`, represented as a decimal string.
267
+ */
268
+ totalAmount: string;
269
+ /**
270
+ * The total monetary amount of this estimate converted to the home currency of the
271
+ * QuickBooks company file. Represented as a decimal string.
272
+ */
273
+ totalAmountInHomeCurrency: string | null;
274
+ /**
275
+ * The date of this estimate, in ISO 8601 format (YYYY-MM-DD).
276
+ */
277
+ transactionDate: string;
278
+ /**
279
+ * The date and time when this estimate was last updated, in ISO 8601 format
280
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
281
+ * timezone of the end-user's computer.
282
+ */
283
+ updatedAt: string;
284
+ }
285
+ export declare namespace Estimate {
286
+ /**
287
+ * The estimate's billing address.
288
+ */
289
+ interface BillingAddress {
290
+ /**
291
+ * The city, district, suburb, town, or village name of the address.
292
+ */
293
+ city: string | null;
294
+ /**
295
+ * The country name of the address.
296
+ */
297
+ country: string | null;
298
+ /**
299
+ * The first line of the address (e.g., street, PO Box, or company name).
300
+ */
301
+ line1: string | null;
302
+ /**
303
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
304
+ * building).
305
+ */
306
+ line2: string | null;
307
+ /**
308
+ * The third line of the address, if needed.
309
+ */
310
+ line3: string | null;
311
+ /**
312
+ * The fourth line of the address, if needed.
313
+ */
314
+ line4: string | null;
315
+ /**
316
+ * The fifth line of the address, if needed.
317
+ */
318
+ line5: string | null;
319
+ /**
320
+ * A note written at the bottom of the address in the form in which it appears,
321
+ * such as the invoice form.
322
+ */
323
+ note: string | null;
324
+ /**
325
+ * The postal code or ZIP code of the address.
326
+ */
327
+ postalCode: string | null;
328
+ /**
329
+ * The state, county, province, or region name of the address.
330
+ */
331
+ state: string | null;
332
+ }
333
+ /**
334
+ * The estimate's class. Classes can be used to categorize objects into meaningful
335
+ * segments, such as department, location, or type of work. In QuickBooks, class
336
+ * tracking is off by default. A class defined here is automatically used in this
337
+ * estimate's line items unless overridden at the line item level.
338
+ */
339
+ interface Class {
340
+ /**
341
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
342
+ * across all objects of the same type, but not across different QuickBooks object
343
+ * types.
344
+ */
345
+ id: string | null;
346
+ /**
347
+ * The fully-qualified unique name for this object, formed by combining the names
348
+ * of its parent objects with its own `name`, separated by colons. Not
349
+ * case-sensitive.
350
+ */
351
+ fullName: string | null;
352
+ }
353
+ /**
354
+ * The estimate's currency. For built-in currencies, the name and code are standard
355
+ * international values. For user-defined currencies, all values are editable.
356
+ */
357
+ interface Currency {
358
+ /**
359
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
360
+ * across all objects of the same type, but not across different QuickBooks object
361
+ * types.
362
+ */
363
+ id: string | null;
364
+ /**
365
+ * The fully-qualified unique name for this object, formed by combining the names
366
+ * of its parent objects with its own `name`, separated by colons. Not
367
+ * case-sensitive.
368
+ */
369
+ fullName: string | null;
370
+ }
371
+ /**
372
+ * The customer or customer-job associated with this estimate.
373
+ */
374
+ interface Customer {
375
+ /**
376
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
377
+ * across all objects of the same type, but not across different QuickBooks object
378
+ * types.
379
+ */
380
+ id: string | null;
381
+ /**
382
+ * The fully-qualified unique name for this object, formed by combining the names
383
+ * of its parent objects with its own `name`, separated by colons. Not
384
+ * case-sensitive.
385
+ */
386
+ fullName: string | null;
387
+ }
388
+ /**
389
+ * The message to display to the customer on the estimate.
390
+ */
391
+ interface CustomerMessage {
392
+ /**
393
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
394
+ * across all objects of the same type, but not across different QuickBooks object
395
+ * types.
396
+ */
397
+ id: string | null;
398
+ /**
399
+ * The fully-qualified unique name for this object, formed by combining the names
400
+ * of its parent objects with its own `name`, separated by colons. Not
401
+ * case-sensitive.
402
+ */
403
+ fullName: string | null;
404
+ }
405
+ interface CustomField {
406
+ /**
407
+ * The name of the custom field, unique for the specified `ownerId`. For public
408
+ * custom fields, this name is visible as a label in the QuickBooks UI.
409
+ */
410
+ name: string;
411
+ /**
412
+ * The identifier of the owner of the custom field, which QuickBooks internally
413
+ * calls a "data extension". For public custom fields visible in the UI, such as
414
+ * those added by the QuickBooks user, this is always "0". For private custom
415
+ * fields that are only visible to the application that created them, this is a
416
+ * valid GUID identifying the owning application. Internally, Conductor always
417
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
418
+ * objects.
419
+ */
420
+ ownerId: string;
421
+ /**
422
+ * The data type of this custom field.
423
+ */
424
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
425
+ /**
426
+ * The value of this custom field. The maximum length depends on the field's data
427
+ * type.
428
+ */
429
+ value: string;
430
+ }
431
+ /**
432
+ * The predefined template in QuickBooks that determines the layout and formatting
433
+ * for this estimate when printed or displayed.
434
+ */
435
+ interface DocumentTemplate {
436
+ /**
437
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
438
+ * across all objects of the same type, but not across different QuickBooks object
439
+ * types.
440
+ */
441
+ id: string | null;
442
+ /**
443
+ * The fully-qualified unique name for this object, formed by combining the names
444
+ * of its parent objects with its own `name`, separated by colons. Not
445
+ * case-sensitive.
446
+ */
447
+ fullName: string | null;
448
+ }
449
+ interface LineGroup {
450
+ /**
451
+ * The unique identifier assigned by QuickBooks to this estimate line group. This
452
+ * ID is unique across all transaction line types.
453
+ */
454
+ id: string;
455
+ /**
456
+ * The custom fields for the estimate line group object, added as user-defined data
457
+ * extensions, not included in the standard QuickBooks object.
458
+ */
459
+ customFields: Array<LineGroup.CustomField>;
460
+ /**
461
+ * A description of this estimate line group.
462
+ */
463
+ description: string | null;
464
+ /**
465
+ * The estimate line group's item group, representing a predefined set of items
466
+ * bundled because they are commonly purchased together or grouped for faster
467
+ * entry.
468
+ */
469
+ itemGroup: LineGroup.ItemGroup;
470
+ /**
471
+ * The estimate line group's line items, each representing a single product or
472
+ * service quoted.
473
+ */
474
+ lines: Array<LineGroup.Line>;
475
+ /**
476
+ * The type of object. This value is always `"qbd_estimate_line_group"`.
477
+ */
478
+ objectType: 'qbd_estimate_line_group';
479
+ /**
480
+ * Specifies an alternative unit-of-measure set when updating this estimate line
481
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
482
+ * select units from a different set than the item's default unit-of-measure set,
483
+ * which remains unchanged on the item itself. The override applies only to this
484
+ * specific line. For example, you can sell an item typically measured in volume
485
+ * units using weight units in a specific transaction by specifying a different
486
+ * unit-of-measure set with this field.
487
+ */
488
+ overrideUnitOfMeasureSet: LineGroup.OverrideUnitOfMeasureSet | null;
489
+ /**
490
+ * The quantity of the item group associated with this estimate line group. This
491
+ * field cannot be cleared.
492
+ *
493
+ * **NOTE**: Do not use this field if the associated item group is a discount item
494
+ * group.
495
+ */
496
+ quantity: number | null;
497
+ /**
498
+ * Indicates whether the individual items in this estimate line group and their
499
+ * separate amounts appear on printed forms.
500
+ */
501
+ shouldPrintItemsInGroup: boolean;
502
+ /**
503
+ * The total monetary amount of this estimate line group, equivalent to the sum of
504
+ * the amounts in `lines`, represented as a decimal string.
505
+ */
506
+ totalAmount: string;
507
+ /**
508
+ * The unit-of-measure used for the `quantity` in this estimate line group. Must be
509
+ * a valid unit within the item's available units of measure.
510
+ */
511
+ unitOfMeasure: string | null;
512
+ }
513
+ namespace LineGroup {
514
+ interface CustomField {
515
+ /**
516
+ * The name of the custom field, unique for the specified `ownerId`. For public
517
+ * custom fields, this name is visible as a label in the QuickBooks UI.
518
+ */
519
+ name: string;
520
+ /**
521
+ * The identifier of the owner of the custom field, which QuickBooks internally
522
+ * calls a "data extension". For public custom fields visible in the UI, such as
523
+ * those added by the QuickBooks user, this is always "0". For private custom
524
+ * fields that are only visible to the application that created them, this is a
525
+ * valid GUID identifying the owning application. Internally, Conductor always
526
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
527
+ * objects.
528
+ */
529
+ ownerId: string;
530
+ /**
531
+ * The data type of this custom field.
532
+ */
533
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
534
+ /**
535
+ * The value of this custom field. The maximum length depends on the field's data
536
+ * type.
537
+ */
538
+ value: string;
539
+ }
540
+ /**
541
+ * The estimate line group's item group, representing a predefined set of items
542
+ * bundled because they are commonly purchased together or grouped for faster
543
+ * entry.
544
+ */
545
+ interface ItemGroup {
546
+ /**
547
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
548
+ * across all objects of the same type, but not across different QuickBooks object
549
+ * types.
550
+ */
551
+ id: string | null;
552
+ /**
553
+ * The fully-qualified unique name for this object, formed by combining the names
554
+ * of its parent objects with its own `name`, separated by colons. Not
555
+ * case-sensitive.
556
+ */
557
+ fullName: string | null;
558
+ }
559
+ interface Line {
560
+ /**
561
+ * The unique identifier assigned by QuickBooks to this estimate line. This ID is
562
+ * unique across all transaction line types.
563
+ */
564
+ id: string;
565
+ /**
566
+ * The monetary amount of this estimate line, represented as a decimal string. If
567
+ * both `quantity` and `rate` are specified but not `amount`, QuickBooks will
568
+ * calculate `amount` using the rate and any markup you supply. The calculation is
569
+ * `amount = (quantity * rate) * (1 + markupRate)` when `markupRate` is provided,
570
+ * or `amount = (quantity * rate) * (1 + markupRatePercent/100)` when
571
+ * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
572
+ * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
573
+ * the suggested `rate`. This field cannot be cleared.
574
+ */
575
+ amount: string | null;
576
+ /**
577
+ * The estimate line's class. Classes can be used to categorize objects into
578
+ * meaningful segments, such as department, location, or type of work. In
579
+ * QuickBooks, class tracking is off by default. If a class is specified for the
580
+ * entire parent transaction, it is automatically applied to all estimate lines
581
+ * unless overridden here, at the transaction line level.
582
+ */
583
+ class: Line.Class | null;
584
+ /**
585
+ * The custom fields for the estimate line object, added as user-defined data
586
+ * extensions, not included in the standard QuickBooks object.
587
+ */
588
+ customFields: Array<Line.CustomField>;
589
+ /**
590
+ * A description of this estimate line.
591
+ */
592
+ description: string | null;
593
+ /**
594
+ * The site location where inventory for the item associated with this estimate
595
+ * line is stored.
596
+ */
597
+ inventorySite: Line.InventorySite | null;
598
+ /**
599
+ * The specific location (e.g., bin or shelf) within the inventory site where the
600
+ * item associated with this estimate line is stored.
601
+ */
602
+ inventorySiteLocation: Line.InventorySiteLocation | null;
603
+ /**
604
+ * The item associated with this estimate line. This can refer to any good or
605
+ * service that the business buys or sells, including item types such as a service
606
+ * item, inventory item, or special calculation item like a discount item or
607
+ * sales-tax item.
608
+ */
609
+ item: Line.Item | null;
610
+ /**
611
+ * The markup that will be passed on to the customer for this item on this estimate
612
+ * line. `amount = (quantity * rate) * (1 + markupRate)`
613
+ */
614
+ markupRate: string | null;
615
+ /**
616
+ * The markup, expressed as a percentage, that will be passed on to the customer
617
+ * for this item on this estimate line.
618
+ * `amount = (quantity * rate) * (1 + markupRatePercent/100)`
619
+ */
620
+ markupRatePercent: string | null;
621
+ /**
622
+ * The type of object. This value is always `"qbd_estimate_line"`.
623
+ */
624
+ objectType: 'qbd_estimate_line';
625
+ /**
626
+ * A built-in custom field for additional information specific to this estimate
627
+ * line. Unlike the user-defined fields in the `customFields` array, this is a
628
+ * standard QuickBooks field that exists for all estimate lines for convenience.
629
+ * Developers often use this field for tracking information that doesn't fit into
630
+ * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
631
+ */
632
+ otherCustomField1: string | null;
633
+ /**
634
+ * A second built-in custom field for additional information specific to this
635
+ * estimate line. Unlike the user-defined fields in the `customFields` array, this
636
+ * is a standard QuickBooks field that exists for all estimate lines for
637
+ * convenience. Like `otherCustomField1`, developers often use this field for
638
+ * tracking information that doesn't fit into other standard QuickBooks fields.
639
+ * Hidden by default in the QuickBooks UI.
640
+ */
641
+ otherCustomField2: string | null;
642
+ /**
643
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
644
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
645
+ * units from a different set than the item's default unit-of-measure set, which
646
+ * remains unchanged on the item itself. The override applies only to this specific
647
+ * line. For example, you can sell an item typically measured in volume units using
648
+ * weight units in a specific transaction by specifying a different unit-of-measure
649
+ * set with this field.
650
+ */
651
+ overrideUnitOfMeasureSet: Line.OverrideUnitOfMeasureSet | null;
652
+ /**
653
+ * The quantity of the item associated with this estimate line. This field cannot
654
+ * be cleared.
655
+ *
656
+ * **NOTE**: Do not use this field if the associated item is a discount item.
657
+ */
658
+ quantity: number | null;
659
+ /**
660
+ * The price per unit for this estimate line. If both `rate` and `amount` are
661
+ * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
662
+ * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
663
+ * decimal string. This field cannot be cleared.
664
+ */
665
+ rate: string | null;
666
+ /**
667
+ * The price of this estimate line expressed as a percentage. Typically used for
668
+ * discount or markup items.
669
+ */
670
+ ratePercent: string | null;
671
+ /**
672
+ * The sales-tax code for this estimate line, determining whether it is taxable or
673
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
674
+ * transaction or the associated item.
675
+ *
676
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
677
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
678
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
679
+ * non-taxable code to all sales.
680
+ */
681
+ salesTaxCode: Line.SalesTaxCode | null;
682
+ /**
683
+ * The unit-of-measure used for the `quantity` in this estimate line. Must be a
684
+ * valid unit within the item's available units of measure.
685
+ */
686
+ unitOfMeasure: string | null;
687
+ }
688
+ namespace Line {
689
+ /**
690
+ * The estimate line's class. Classes can be used to categorize objects into
691
+ * meaningful segments, such as department, location, or type of work. In
692
+ * QuickBooks, class tracking is off by default. If a class is specified for the
693
+ * entire parent transaction, it is automatically applied to all estimate lines
694
+ * unless overridden here, at the transaction line level.
695
+ */
696
+ interface Class {
697
+ /**
698
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
699
+ * across all objects of the same type, but not across different QuickBooks object
700
+ * types.
701
+ */
702
+ id: string | null;
703
+ /**
704
+ * The fully-qualified unique name for this object, formed by combining the names
705
+ * of its parent objects with its own `name`, separated by colons. Not
706
+ * case-sensitive.
707
+ */
708
+ fullName: string | null;
709
+ }
710
+ interface CustomField {
711
+ /**
712
+ * The name of the custom field, unique for the specified `ownerId`. For public
713
+ * custom fields, this name is visible as a label in the QuickBooks UI.
714
+ */
715
+ name: string;
716
+ /**
717
+ * The identifier of the owner of the custom field, which QuickBooks internally
718
+ * calls a "data extension". For public custom fields visible in the UI, such as
719
+ * those added by the QuickBooks user, this is always "0". For private custom
720
+ * fields that are only visible to the application that created them, this is a
721
+ * valid GUID identifying the owning application. Internally, Conductor always
722
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
723
+ * objects.
724
+ */
725
+ ownerId: string;
726
+ /**
727
+ * The data type of this custom field.
728
+ */
729
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
730
+ /**
731
+ * The value of this custom field. The maximum length depends on the field's data
732
+ * type.
733
+ */
734
+ value: string;
735
+ }
736
+ /**
737
+ * The site location where inventory for the item associated with this estimate
738
+ * line is stored.
739
+ */
740
+ interface InventorySite {
741
+ /**
742
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
743
+ * across all objects of the same type, but not across different QuickBooks object
744
+ * types.
745
+ */
746
+ id: string | null;
747
+ /**
748
+ * The fully-qualified unique name for this object, formed by combining the names
749
+ * of its parent objects with its own `name`, separated by colons. Not
750
+ * case-sensitive.
751
+ */
752
+ fullName: string | null;
753
+ }
754
+ /**
755
+ * The specific location (e.g., bin or shelf) within the inventory site where the
756
+ * item associated with this estimate line is stored.
757
+ */
758
+ interface InventorySiteLocation {
759
+ /**
760
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
761
+ * across all objects of the same type, but not across different QuickBooks object
762
+ * types.
763
+ */
764
+ id: string | null;
765
+ /**
766
+ * The fully-qualified unique name for this object, formed by combining the names
767
+ * of its parent objects with its own `name`, separated by colons. Not
768
+ * case-sensitive.
769
+ */
770
+ fullName: string | null;
771
+ }
772
+ /**
773
+ * The item associated with this estimate line. This can refer to any good or
774
+ * service that the business buys or sells, including item types such as a service
775
+ * item, inventory item, or special calculation item like a discount item or
776
+ * sales-tax item.
777
+ */
778
+ interface Item {
779
+ /**
780
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
781
+ * across all objects of the same type, but not across different QuickBooks object
782
+ * types.
783
+ */
784
+ id: string | null;
785
+ /**
786
+ * The fully-qualified unique name for this object, formed by combining the names
787
+ * of its parent objects with its own `name`, separated by colons. Not
788
+ * case-sensitive.
789
+ */
790
+ fullName: string | null;
791
+ }
792
+ /**
793
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
794
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
795
+ * units from a different set than the item's default unit-of-measure set, which
796
+ * remains unchanged on the item itself. The override applies only to this specific
797
+ * line. For example, you can sell an item typically measured in volume units using
798
+ * weight units in a specific transaction by specifying a different unit-of-measure
799
+ * set with this field.
800
+ */
801
+ interface OverrideUnitOfMeasureSet {
802
+ /**
803
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
804
+ * across all objects of the same type, but not across different QuickBooks object
805
+ * types.
806
+ */
807
+ id: string | null;
808
+ /**
809
+ * The fully-qualified unique name for this object, formed by combining the names
810
+ * of its parent objects with its own `name`, separated by colons. Not
811
+ * case-sensitive.
812
+ */
813
+ fullName: string | null;
814
+ }
815
+ /**
816
+ * The sales-tax code for this estimate line, determining whether it is taxable or
817
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
818
+ * transaction or the associated item.
819
+ *
820
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
821
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
822
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
823
+ * non-taxable code to all sales.
824
+ */
825
+ interface SalesTaxCode {
826
+ /**
827
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
828
+ * across all objects of the same type, but not across different QuickBooks object
829
+ * types.
830
+ */
831
+ id: string | null;
832
+ /**
833
+ * The fully-qualified unique name for this object, formed by combining the names
834
+ * of its parent objects with its own `name`, separated by colons. Not
835
+ * case-sensitive.
836
+ */
837
+ fullName: string | null;
838
+ }
839
+ }
840
+ /**
841
+ * Specifies an alternative unit-of-measure set when updating this estimate line
842
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
843
+ * select units from a different set than the item's default unit-of-measure set,
844
+ * which remains unchanged on the item itself. The override applies only to this
845
+ * specific line. For example, you can sell an item typically measured in volume
846
+ * units using weight units in a specific transaction by specifying a different
847
+ * unit-of-measure set with this field.
848
+ */
849
+ interface OverrideUnitOfMeasureSet {
850
+ /**
851
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
852
+ * across all objects of the same type, but not across different QuickBooks object
853
+ * types.
854
+ */
855
+ id: string | null;
856
+ /**
857
+ * The fully-qualified unique name for this object, formed by combining the names
858
+ * of its parent objects with its own `name`, separated by colons. Not
859
+ * case-sensitive.
860
+ */
861
+ fullName: string | null;
862
+ }
863
+ }
864
+ interface Line {
865
+ /**
866
+ * The unique identifier assigned by QuickBooks to this estimate line. This ID is
867
+ * unique across all transaction line types.
868
+ */
869
+ id: string;
870
+ /**
871
+ * The monetary amount of this estimate line, represented as a decimal string. If
872
+ * both `quantity` and `rate` are specified but not `amount`, QuickBooks will
873
+ * calculate `amount` using the rate and any markup you supply. The calculation is
874
+ * `amount = (quantity * rate) * (1 + markupRate)` when `markupRate` is provided,
875
+ * or `amount = (quantity * rate) * (1 + markupRatePercent/100)` when
876
+ * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
877
+ * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
878
+ * the suggested `rate`. This field cannot be cleared.
879
+ */
880
+ amount: string | null;
881
+ /**
882
+ * The estimate line's class. Classes can be used to categorize objects into
883
+ * meaningful segments, such as department, location, or type of work. In
884
+ * QuickBooks, class tracking is off by default. If a class is specified for the
885
+ * entire parent transaction, it is automatically applied to all estimate lines
886
+ * unless overridden here, at the transaction line level.
887
+ */
888
+ class: Line.Class | null;
889
+ /**
890
+ * The custom fields for the estimate line object, added as user-defined data
891
+ * extensions, not included in the standard QuickBooks object.
892
+ */
893
+ customFields: Array<Line.CustomField>;
894
+ /**
895
+ * A description of this estimate line.
896
+ */
897
+ description: string | null;
898
+ /**
899
+ * The site location where inventory for the item associated with this estimate
900
+ * line is stored.
901
+ */
902
+ inventorySite: Line.InventorySite | null;
903
+ /**
904
+ * The specific location (e.g., bin or shelf) within the inventory site where the
905
+ * item associated with this estimate line is stored.
906
+ */
907
+ inventorySiteLocation: Line.InventorySiteLocation | null;
908
+ /**
909
+ * The item associated with this estimate line. This can refer to any good or
910
+ * service that the business buys or sells, including item types such as a service
911
+ * item, inventory item, or special calculation item like a discount item or
912
+ * sales-tax item.
913
+ */
914
+ item: Line.Item | null;
915
+ /**
916
+ * The markup that will be passed on to the customer for this item on this estimate
917
+ * line. `amount = (quantity * rate) * (1 + markupRate)`
918
+ */
919
+ markupRate: string | null;
920
+ /**
921
+ * The markup, expressed as a percentage, that will be passed on to the customer
922
+ * for this item on this estimate line.
923
+ * `amount = (quantity * rate) * (1 + markupRatePercent/100)`
924
+ */
925
+ markupRatePercent: string | null;
926
+ /**
927
+ * The type of object. This value is always `"qbd_estimate_line"`.
928
+ */
929
+ objectType: 'qbd_estimate_line';
930
+ /**
931
+ * A built-in custom field for additional information specific to this estimate
932
+ * line. Unlike the user-defined fields in the `customFields` array, this is a
933
+ * standard QuickBooks field that exists for all estimate lines for convenience.
934
+ * Developers often use this field for tracking information that doesn't fit into
935
+ * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
936
+ */
937
+ otherCustomField1: string | null;
938
+ /**
939
+ * A second built-in custom field for additional information specific to this
940
+ * estimate line. Unlike the user-defined fields in the `customFields` array, this
941
+ * is a standard QuickBooks field that exists for all estimate lines for
942
+ * convenience. Like `otherCustomField1`, developers often use this field for
943
+ * tracking information that doesn't fit into other standard QuickBooks fields.
944
+ * Hidden by default in the QuickBooks UI.
945
+ */
946
+ otherCustomField2: string | null;
947
+ /**
948
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
949
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
950
+ * units from a different set than the item's default unit-of-measure set, which
951
+ * remains unchanged on the item itself. The override applies only to this specific
952
+ * line. For example, you can sell an item typically measured in volume units using
953
+ * weight units in a specific transaction by specifying a different unit-of-measure
954
+ * set with this field.
955
+ */
956
+ overrideUnitOfMeasureSet: Line.OverrideUnitOfMeasureSet | null;
957
+ /**
958
+ * The quantity of the item associated with this estimate line. This field cannot
959
+ * be cleared.
960
+ *
961
+ * **NOTE**: Do not use this field if the associated item is a discount item.
962
+ */
963
+ quantity: number | null;
964
+ /**
965
+ * The price per unit for this estimate line. If both `rate` and `amount` are
966
+ * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
967
+ * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
968
+ * decimal string. This field cannot be cleared.
969
+ */
970
+ rate: string | null;
971
+ /**
972
+ * The price of this estimate line expressed as a percentage. Typically used for
973
+ * discount or markup items.
974
+ */
975
+ ratePercent: string | null;
976
+ /**
977
+ * The sales-tax code for this estimate line, determining whether it is taxable or
978
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
979
+ * transaction or the associated item.
980
+ *
981
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
982
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
983
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
984
+ * non-taxable code to all sales.
985
+ */
986
+ salesTaxCode: Line.SalesTaxCode | null;
987
+ /**
988
+ * The unit-of-measure used for the `quantity` in this estimate line. Must be a
989
+ * valid unit within the item's available units of measure.
990
+ */
991
+ unitOfMeasure: string | null;
992
+ }
993
+ namespace Line {
994
+ /**
995
+ * The estimate line's class. Classes can be used to categorize objects into
996
+ * meaningful segments, such as department, location, or type of work. In
997
+ * QuickBooks, class tracking is off by default. If a class is specified for the
998
+ * entire parent transaction, it is automatically applied to all estimate lines
999
+ * unless overridden here, at the transaction line level.
1000
+ */
1001
+ interface Class {
1002
+ /**
1003
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1004
+ * across all objects of the same type, but not across different QuickBooks object
1005
+ * types.
1006
+ */
1007
+ id: string | null;
1008
+ /**
1009
+ * The fully-qualified unique name for this object, formed by combining the names
1010
+ * of its parent objects with its own `name`, separated by colons. Not
1011
+ * case-sensitive.
1012
+ */
1013
+ fullName: string | null;
1014
+ }
1015
+ interface CustomField {
1016
+ /**
1017
+ * The name of the custom field, unique for the specified `ownerId`. For public
1018
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1019
+ */
1020
+ name: string;
1021
+ /**
1022
+ * The identifier of the owner of the custom field, which QuickBooks internally
1023
+ * calls a "data extension". For public custom fields visible in the UI, such as
1024
+ * those added by the QuickBooks user, this is always "0". For private custom
1025
+ * fields that are only visible to the application that created them, this is a
1026
+ * valid GUID identifying the owning application. Internally, Conductor always
1027
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1028
+ * objects.
1029
+ */
1030
+ ownerId: string;
1031
+ /**
1032
+ * The data type of this custom field.
1033
+ */
1034
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
1035
+ /**
1036
+ * The value of this custom field. The maximum length depends on the field's data
1037
+ * type.
1038
+ */
1039
+ value: string;
1040
+ }
1041
+ /**
1042
+ * The site location where inventory for the item associated with this estimate
1043
+ * line is stored.
1044
+ */
1045
+ interface InventorySite {
1046
+ /**
1047
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1048
+ * across all objects of the same type, but not across different QuickBooks object
1049
+ * types.
1050
+ */
1051
+ id: string | null;
1052
+ /**
1053
+ * The fully-qualified unique name for this object, formed by combining the names
1054
+ * of its parent objects with its own `name`, separated by colons. Not
1055
+ * case-sensitive.
1056
+ */
1057
+ fullName: string | null;
1058
+ }
1059
+ /**
1060
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1061
+ * item associated with this estimate line is stored.
1062
+ */
1063
+ interface InventorySiteLocation {
1064
+ /**
1065
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1066
+ * across all objects of the same type, but not across different QuickBooks object
1067
+ * types.
1068
+ */
1069
+ id: string | null;
1070
+ /**
1071
+ * The fully-qualified unique name for this object, formed by combining the names
1072
+ * of its parent objects with its own `name`, separated by colons. Not
1073
+ * case-sensitive.
1074
+ */
1075
+ fullName: string | null;
1076
+ }
1077
+ /**
1078
+ * The item associated with this estimate line. This can refer to any good or
1079
+ * service that the business buys or sells, including item types such as a service
1080
+ * item, inventory item, or special calculation item like a discount item or
1081
+ * sales-tax item.
1082
+ */
1083
+ interface Item {
1084
+ /**
1085
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1086
+ * across all objects of the same type, but not across different QuickBooks object
1087
+ * types.
1088
+ */
1089
+ id: string | null;
1090
+ /**
1091
+ * The fully-qualified unique name for this object, formed by combining the names
1092
+ * of its parent objects with its own `name`, separated by colons. Not
1093
+ * case-sensitive.
1094
+ */
1095
+ fullName: string | null;
1096
+ }
1097
+ /**
1098
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
1099
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
1100
+ * units from a different set than the item's default unit-of-measure set, which
1101
+ * remains unchanged on the item itself. The override applies only to this specific
1102
+ * line. For example, you can sell an item typically measured in volume units using
1103
+ * weight units in a specific transaction by specifying a different unit-of-measure
1104
+ * set with this field.
1105
+ */
1106
+ interface OverrideUnitOfMeasureSet {
1107
+ /**
1108
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1109
+ * across all objects of the same type, but not across different QuickBooks object
1110
+ * types.
1111
+ */
1112
+ id: string | null;
1113
+ /**
1114
+ * The fully-qualified unique name for this object, formed by combining the names
1115
+ * of its parent objects with its own `name`, separated by colons. Not
1116
+ * case-sensitive.
1117
+ */
1118
+ fullName: string | null;
1119
+ }
1120
+ /**
1121
+ * The sales-tax code for this estimate line, determining whether it is taxable or
1122
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1123
+ * transaction or the associated item.
1124
+ *
1125
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1126
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1127
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1128
+ * non-taxable code to all sales.
1129
+ */
1130
+ interface SalesTaxCode {
1131
+ /**
1132
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1133
+ * across all objects of the same type, but not across different QuickBooks object
1134
+ * types.
1135
+ */
1136
+ id: string | null;
1137
+ /**
1138
+ * The fully-qualified unique name for this object, formed by combining the names
1139
+ * of its parent objects with its own `name`, separated by colons. Not
1140
+ * case-sensitive.
1141
+ */
1142
+ fullName: string | null;
1143
+ }
1144
+ }
1145
+ interface LinkedTransaction {
1146
+ /**
1147
+ * The unique identifier assigned by QuickBooks to this linked transaction. This ID
1148
+ * is unique across all transaction types.
1149
+ */
1150
+ id: string;
1151
+ /**
1152
+ * The monetary amount of this linked transaction, represented as a decimal string.
1153
+ */
1154
+ amount: string | null;
1155
+ /**
1156
+ * Indicates the nature of the link between the transactions: `amount` denotes an
1157
+ * amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes
1158
+ * a quantity-based link (e.g., an invoice created from a sales order based on the
1159
+ * quantity of items received).
1160
+ */
1161
+ linkType: 'amount' | 'quantity' | null;
1162
+ /**
1163
+ * The type of object. This value is always `"qbd_linked_transaction"`.
1164
+ */
1165
+ objectType: 'qbd_linked_transaction';
1166
+ /**
1167
+ * The case-sensitive user-defined reference number for this linked transaction,
1168
+ * which can be used to identify the transaction in QuickBooks. This value is not
1169
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
1170
+ */
1171
+ refNumber: string | null;
1172
+ /**
1173
+ * The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD).
1174
+ */
1175
+ transactionDate: string;
1176
+ /**
1177
+ * The type of transaction for this linked transaction.
1178
+ */
1179
+ transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment' | 'unknown';
1180
+ }
1181
+ /**
1182
+ * The estimate's sales representative. Sales representatives can be employees,
1183
+ * vendors, or other names in QuickBooks.
1184
+ */
1185
+ interface SalesRepresentative {
1186
+ /**
1187
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1188
+ * across all objects of the same type, but not across different QuickBooks object
1189
+ * types.
1190
+ */
1191
+ id: string | null;
1192
+ /**
1193
+ * The fully-qualified unique name for this object, formed by combining the names
1194
+ * of its parent objects with its own `name`, separated by colons. Not
1195
+ * case-sensitive.
1196
+ */
1197
+ fullName: string | null;
1198
+ }
1199
+ /**
1200
+ * The sales-tax code for this estimate, determining whether it is taxable or
1201
+ * non-taxable. This can be overridden at the transaction-line level.
1202
+ *
1203
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1204
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1205
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1206
+ * non-taxable code to all sales.
1207
+ */
1208
+ interface SalesTaxCode {
1209
+ /**
1210
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1211
+ * across all objects of the same type, but not across different QuickBooks object
1212
+ * types.
1213
+ */
1214
+ id: string | null;
1215
+ /**
1216
+ * The fully-qualified unique name for this object, formed by combining the names
1217
+ * of its parent objects with its own `name`, separated by colons. Not
1218
+ * case-sensitive.
1219
+ */
1220
+ fullName: string | null;
1221
+ }
1222
+ /**
1223
+ * The sales-tax item used to calculate the actual tax amount for this estimate's
1224
+ * transactions by applying a specific tax rate collected for a single tax agency.
1225
+ * Unlike `salesTaxCode`, which only indicates general taxability, this field
1226
+ * drives the actual tax calculation and reporting.
1227
+ */
1228
+ interface SalesTaxItem {
1229
+ /**
1230
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1231
+ * across all objects of the same type, but not across different QuickBooks object
1232
+ * types.
1233
+ */
1234
+ id: string | null;
1235
+ /**
1236
+ * The fully-qualified unique name for this object, formed by combining the names
1237
+ * of its parent objects with its own `name`, separated by colons. Not
1238
+ * case-sensitive.
1239
+ */
1240
+ fullName: string | null;
1241
+ }
1242
+ /**
1243
+ * The estimate's shipping address.
1244
+ */
1245
+ interface ShippingAddress {
1246
+ /**
1247
+ * The city, district, suburb, town, or village name of the address.
1248
+ */
1249
+ city: string | null;
1250
+ /**
1251
+ * The country name of the address.
1252
+ */
1253
+ country: string | null;
1254
+ /**
1255
+ * The first line of the address (e.g., street, PO Box, or company name).
1256
+ */
1257
+ line1: string | null;
1258
+ /**
1259
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
1260
+ * building).
1261
+ */
1262
+ line2: string | null;
1263
+ /**
1264
+ * The third line of the address, if needed.
1265
+ */
1266
+ line3: string | null;
1267
+ /**
1268
+ * The fourth line of the address, if needed.
1269
+ */
1270
+ line4: string | null;
1271
+ /**
1272
+ * The fifth line of the address, if needed.
1273
+ */
1274
+ line5: string | null;
1275
+ /**
1276
+ * A note written at the bottom of the address in the form in which it appears,
1277
+ * such as the invoice form.
1278
+ */
1279
+ note: string | null;
1280
+ /**
1281
+ * The postal code or ZIP code of the address.
1282
+ */
1283
+ postalCode: string | null;
1284
+ /**
1285
+ * The state, county, province, or region name of the address.
1286
+ */
1287
+ state: string | null;
1288
+ }
1289
+ /**
1290
+ * The estimate's payment terms, defining when payment is due and any applicable
1291
+ * discounts.
1292
+ */
1293
+ interface Terms {
1294
+ /**
1295
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
1296
+ * across all objects of the same type, but not across different QuickBooks object
1297
+ * types.
1298
+ */
1299
+ id: string | null;
1300
+ /**
1301
+ * The fully-qualified unique name for this object, formed by combining the names
1302
+ * of its parent objects with its own `name`, separated by colons. Not
1303
+ * case-sensitive.
1304
+ */
1305
+ fullName: string | null;
1306
+ }
1307
+ }
1308
+ export interface EstimateDeleteResponse {
1309
+ /**
1310
+ * The QuickBooks-assigned unique identifier of the deleted estimate.
1311
+ */
1312
+ id: string;
1313
+ /**
1314
+ * Indicates whether the estimate was deleted.
1315
+ */
1316
+ deleted: boolean;
1317
+ /**
1318
+ * The type of object. This value is always `"qbd_estimate"`.
1319
+ */
1320
+ objectType: 'qbd_estimate';
1321
+ /**
1322
+ * The case-sensitive user-defined reference number of the deleted estimate.
1323
+ */
1324
+ refNumber: string | null;
1325
+ }
1326
+ export interface EstimateCreateParams {
1327
+ /**
1328
+ * Body param: The customer or customer-job associated with this estimate.
1329
+ */
1330
+ customerId: string;
1331
+ /**
1332
+ * Body param: The date of this estimate, in ISO 8601 format (YYYY-MM-DD).
1333
+ */
1334
+ transactionDate: string;
1335
+ /**
1336
+ * Header param: The ID of the End-User to receive this request.
1337
+ */
1338
+ conductorEndUserId: string;
1339
+ /**
1340
+ * Body param: The estimate's billing address.
1341
+ */
1342
+ billingAddress?: EstimateCreateParams.BillingAddress;
1343
+ /**
1344
+ * Body param: The estimate's class. Classes can be used to categorize objects into
1345
+ * meaningful segments, such as department, location, or type of work. In
1346
+ * QuickBooks, class tracking is off by default. A class defined here is
1347
+ * automatically used in this estimate's line items unless overridden at the line
1348
+ * item level.
1349
+ */
1350
+ classId?: string;
1351
+ /**
1352
+ * Body param: The message to display to the customer on the estimate.
1353
+ */
1354
+ customerMessageId?: string;
1355
+ /**
1356
+ * Body param: The predefined template in QuickBooks that determines the layout and
1357
+ * formatting for this estimate when printed or displayed.
1358
+ */
1359
+ documentTemplateId?: string;
1360
+ /**
1361
+ * Body param: The date by which this estimate must be paid, in ISO 8601 format
1362
+ * (YYYY-MM-DD).
1363
+ */
1364
+ dueDate?: string;
1365
+ /**
1366
+ * Body param: The market exchange rate between this estimate's currency and the
1367
+ * home currency in QuickBooks at the time of this transaction. Represented as a
1368
+ * decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
1369
+ */
1370
+ exchangeRate?: number;
1371
+ /**
1372
+ * Body param: A globally unique identifier (GUID) you, the developer, can provide
1373
+ * for tracking this object in your external system. This field is immutable and
1374
+ * can only be set during object creation.
1375
+ *
1376
+ * **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
1377
+ * QuickBooks will return an error.
1378
+ */
1379
+ externalId?: string;
1380
+ /**
1381
+ * Body param: Indicates whether this estimate is active. Inactive objects are
1382
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
1383
+ */
1384
+ isActive?: boolean;
1385
+ /**
1386
+ * Body param: Indicates whether this estimate is included in the queue of
1387
+ * documents for QuickBooks to email to the customer.
1388
+ */
1389
+ isQueuedForEmail?: boolean;
1390
+ /**
1391
+ * Body param: The estimate's line item groups, each representing a predefined set
1392
+ * of related items.
1393
+ *
1394
+ * **IMPORTANT**: You must specify `lines`, `lineGroups`, or both when creating an
1395
+ * estimate.
1396
+ */
1397
+ lineGroups?: Array<EstimateCreateParams.LineGroup>;
1398
+ /**
1399
+ * Body param: The estimate's line items, each representing a single product or
1400
+ * service quoted.
1401
+ *
1402
+ * **IMPORTANT**: You must specify `lines`, `lineGroups`, or both when creating an
1403
+ * estimate.
1404
+ */
1405
+ lines?: Array<EstimateCreateParams.Line>;
1406
+ /**
1407
+ * Body param: A memo or note for this estimate that appears in reports, but not on
1408
+ * the estimate. Use `customerMessage` to add a note to this estimate.
1409
+ */
1410
+ memo?: string;
1411
+ /**
1412
+ * Body param: A built-in custom field for additional information specific to this
1413
+ * estimate. Unlike the user-defined fields in the `customFields` array, this is a
1414
+ * standard QuickBooks field that exists for all estimates for convenience.
1415
+ * Developers often use this field for tracking information that doesn't fit into
1416
+ * other standard QuickBooks fields. Unlike `otherCustomField1` and
1417
+ * `otherCustomField2`, which are line item fields, this exists at the transaction
1418
+ * level. Hidden by default in the QuickBooks UI.
1419
+ */
1420
+ otherCustomField?: string;
1421
+ /**
1422
+ * Body param: The customer's Purchase Order (PO) number associated with this
1423
+ * estimate. This field is often used to cross-reference the estimate with the
1424
+ * customer's purchasing system.
1425
+ *
1426
+ * Maximum length: 25 characters.
1427
+ */
1428
+ purchaseOrderNumber?: string;
1429
+ /**
1430
+ * Body param: The case-sensitive user-defined reference number for this estimate,
1431
+ * which can be used to identify the transaction in QuickBooks. This value is not
1432
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
1433
+ * When left blank in this create request, this field will be left blank in
1434
+ * QuickBooks (i.e., it does _not_ auto-increment).
1435
+ */
1436
+ refNumber?: string;
1437
+ /**
1438
+ * Body param: The estimate's sales representative. Sales representatives can be
1439
+ * employees, vendors, or other names in QuickBooks.
1440
+ */
1441
+ salesRepresentativeId?: string;
1442
+ /**
1443
+ * Body param: The sales-tax code for this estimate, determining whether it is
1444
+ * taxable or non-taxable. This can be overridden at the transaction-line level.
1445
+ *
1446
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1447
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1448
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1449
+ * non-taxable code to all sales.
1450
+ */
1451
+ salesTaxCodeId?: string;
1452
+ /**
1453
+ * Body param: The sales-tax item used to calculate the actual tax amount for this
1454
+ * estimate's transactions by applying a specific tax rate collected for a single
1455
+ * tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this
1456
+ * field drives the actual tax calculation and reporting.
1457
+ */
1458
+ salesTaxItemId?: string;
1459
+ /**
1460
+ * Body param: The origin location from where the product associated with this
1461
+ * estimate is shipped. This is the point at which ownership and liability for
1462
+ * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
1463
+ * for this field, which stands for "freight on board". This field is informational
1464
+ * and has no accounting implications.
1465
+ */
1466
+ shipmentOrigin?: string;
1467
+ /**
1468
+ * Body param: The estimate's shipping address.
1469
+ */
1470
+ shippingAddress?: EstimateCreateParams.ShippingAddress;
1471
+ /**
1472
+ * Body param: The estimate's payment terms, defining when payment is due and any
1473
+ * applicable discounts.
1474
+ */
1475
+ termsId?: string;
1476
+ }
1477
+ export declare namespace EstimateCreateParams {
1478
+ /**
1479
+ * The estimate's billing address.
1480
+ */
1481
+ interface BillingAddress {
1482
+ /**
1483
+ * The city, district, suburb, town, or village name of the address.
1484
+ *
1485
+ * Maximum length: 31 characters.
1486
+ */
1487
+ city?: string;
1488
+ /**
1489
+ * The country name of the address.
1490
+ */
1491
+ country?: string;
1492
+ /**
1493
+ * The first line of the address (e.g., street, PO Box, or company name).
1494
+ *
1495
+ * Maximum length: 41 characters.
1496
+ */
1497
+ line1?: string;
1498
+ /**
1499
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
1500
+ * building).
1501
+ *
1502
+ * Maximum length: 41 characters.
1503
+ */
1504
+ line2?: string;
1505
+ /**
1506
+ * The third line of the address, if needed.
1507
+ *
1508
+ * Maximum length: 41 characters.
1509
+ */
1510
+ line3?: string;
1511
+ /**
1512
+ * The fourth line of the address, if needed.
1513
+ *
1514
+ * Maximum length: 41 characters.
1515
+ */
1516
+ line4?: string;
1517
+ /**
1518
+ * The fifth line of the address, if needed.
1519
+ *
1520
+ * Maximum length: 41 characters.
1521
+ */
1522
+ line5?: string;
1523
+ /**
1524
+ * A note written at the bottom of the address in the form in which it appears,
1525
+ * such as the invoice form.
1526
+ */
1527
+ note?: string;
1528
+ /**
1529
+ * The postal code or ZIP code of the address.
1530
+ *
1531
+ * Maximum length: 13 characters.
1532
+ */
1533
+ postalCode?: string;
1534
+ /**
1535
+ * The state, county, province, or region name of the address.
1536
+ *
1537
+ * Maximum length: 21 characters.
1538
+ */
1539
+ state?: string;
1540
+ }
1541
+ interface LineGroup {
1542
+ /**
1543
+ * The estimate line group's item group, representing a predefined set of items
1544
+ * bundled because they are commonly purchased together or grouped for faster
1545
+ * entry.
1546
+ */
1547
+ itemGroupId: string;
1548
+ /**
1549
+ * The custom fields for the estimate line group object, added as user-defined data
1550
+ * extensions, not included in the standard QuickBooks object.
1551
+ */
1552
+ customFields?: Array<LineGroup.CustomField>;
1553
+ /**
1554
+ * The site location where inventory for the item group associated with this
1555
+ * estimate line group is stored.
1556
+ */
1557
+ inventorySiteId?: string;
1558
+ /**
1559
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1560
+ * item group associated with this estimate line group is stored.
1561
+ */
1562
+ inventorySiteLocationId?: string;
1563
+ /**
1564
+ * The quantity of the item group associated with this estimate line group. This
1565
+ * field cannot be cleared.
1566
+ *
1567
+ * **NOTE**: Do not use this field if the associated item group is a discount item
1568
+ * group.
1569
+ */
1570
+ quantity?: number;
1571
+ /**
1572
+ * The unit-of-measure used for the `quantity` in this estimate line group. Must be
1573
+ * a valid unit within the item's available units of measure.
1574
+ */
1575
+ unitOfMeasure?: string;
1576
+ }
1577
+ namespace LineGroup {
1578
+ interface CustomField {
1579
+ /**
1580
+ * The name of the custom field, unique for the specified `ownerId`. For public
1581
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1582
+ */
1583
+ name: string;
1584
+ /**
1585
+ * The identifier of the owner of the custom field, which QuickBooks internally
1586
+ * calls a "data extension". For public custom fields visible in the UI, such as
1587
+ * those added by the QuickBooks user, this is always "0". For private custom
1588
+ * fields that are only visible to the application that created them, this is a
1589
+ * valid GUID identifying the owning application. Internally, Conductor always
1590
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1591
+ * objects.
1592
+ */
1593
+ ownerId: string;
1594
+ /**
1595
+ * The value of this custom field. The maximum length depends on the field's data
1596
+ * type.
1597
+ */
1598
+ value: string;
1599
+ }
1600
+ }
1601
+ interface Line {
1602
+ /**
1603
+ * The monetary amount of this estimate line, represented as a decimal string. If
1604
+ * both `quantity` and `rate` are specified but not `amount`, QuickBooks will
1605
+ * calculate `amount` using the rate and any markup you supply. The calculation is
1606
+ * `amount = (quantity * rate) * (1 + markupRate)` when `markupRate` is provided,
1607
+ * or `amount = (quantity * rate) * (1 + markupRatePercent/100)` when
1608
+ * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
1609
+ * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
1610
+ * the suggested `rate`. This field cannot be cleared.
1611
+ */
1612
+ amount?: string;
1613
+ /**
1614
+ * The estimate line's class. Classes can be used to categorize objects into
1615
+ * meaningful segments, such as department, location, or type of work. In
1616
+ * QuickBooks, class tracking is off by default. If a class is specified for the
1617
+ * entire parent transaction, it is automatically applied to all estimate lines
1618
+ * unless overridden here, at the transaction line level.
1619
+ */
1620
+ classId?: string;
1621
+ /**
1622
+ * The custom fields for the estimate line object, added as user-defined data
1623
+ * extensions, not included in the standard QuickBooks object.
1624
+ */
1625
+ customFields?: Array<Line.CustomField>;
1626
+ /**
1627
+ * A description of this estimate line.
1628
+ */
1629
+ description?: string;
1630
+ /**
1631
+ * The site location where inventory for the item associated with this estimate
1632
+ * line is stored.
1633
+ */
1634
+ inventorySiteId?: string;
1635
+ /**
1636
+ * The specific location (e.g., bin or shelf) within the inventory site where the
1637
+ * item associated with this estimate line is stored.
1638
+ */
1639
+ inventorySiteLocationId?: string;
1640
+ /**
1641
+ * The item associated with this estimate line. This can refer to any good or
1642
+ * service that the business buys or sells, including item types such as a service
1643
+ * item, inventory item, or special calculation item like a discount item or
1644
+ * sales-tax item.
1645
+ */
1646
+ itemId?: string;
1647
+ /**
1648
+ * The markup that will be passed on to the customer for this item on this estimate
1649
+ * line. `amount = (quantity * rate) * (1 + markupRate)`
1650
+ */
1651
+ markupRate?: string;
1652
+ /**
1653
+ * The markup, expressed as a percentage, that will be passed on to the customer
1654
+ * for this item on this estimate line.
1655
+ * `amount = (quantity * rate) * (1 + markupRatePercent/100)`
1656
+ */
1657
+ markupRatePercent?: string;
1658
+ /**
1659
+ * A built-in custom field for additional information specific to this estimate
1660
+ * line. Unlike the user-defined fields in the `customFields` array, this is a
1661
+ * standard QuickBooks field that exists for all estimate lines for convenience.
1662
+ * Developers often use this field for tracking information that doesn't fit into
1663
+ * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
1664
+ */
1665
+ otherCustomField1?: string;
1666
+ /**
1667
+ * A second built-in custom field for additional information specific to this
1668
+ * estimate line. Unlike the user-defined fields in the `customFields` array, this
1669
+ * is a standard QuickBooks field that exists for all estimate lines for
1670
+ * convenience. Like `otherCustomField1`, developers often use this field for
1671
+ * tracking information that doesn't fit into other standard QuickBooks fields.
1672
+ * Hidden by default in the QuickBooks UI.
1673
+ */
1674
+ otherCustomField2?: string;
1675
+ /**
1676
+ * The account to use for this estimate line, overriding the default account
1677
+ * associated with the item.
1678
+ */
1679
+ overrideItemAccountId?: string;
1680
+ /**
1681
+ * The price level applied to this estimate line. This overrides any price level
1682
+ * set on the corresponding customer. The resulting estimate line will not show
1683
+ * this price level, only the final `rate` calculated from it.
1684
+ */
1685
+ priceLevelId?: string;
1686
+ /**
1687
+ * Specifies how to resolve price rule conflicts when adding or modifying this
1688
+ * estimate line.
1689
+ */
1690
+ priceRuleConflictStrategy?: 'base_price' | 'zero';
1691
+ /**
1692
+ * The quantity of the item associated with this estimate line. This field cannot
1693
+ * be cleared.
1694
+ *
1695
+ * **NOTE**: Do not use this field if the associated item is a discount item.
1696
+ */
1697
+ quantity?: number;
1698
+ /**
1699
+ * The price per unit for this estimate line. If both `rate` and `amount` are
1700
+ * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
1701
+ * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
1702
+ * decimal string. This field cannot be cleared.
1703
+ */
1704
+ rate?: string;
1705
+ /**
1706
+ * The price of this estimate line expressed as a percentage. Typically used for
1707
+ * discount or markup items.
1708
+ */
1709
+ ratePercent?: string;
1710
+ /**
1711
+ * The sales-tax code for this estimate line, determining whether it is taxable or
1712
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
1713
+ * transaction or the associated item.
1714
+ *
1715
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1716
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1717
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1718
+ * non-taxable code to all sales.
1719
+ */
1720
+ salesTaxCodeId?: string;
1721
+ /**
1722
+ * The unit-of-measure used for the `quantity` in this estimate line. Must be a
1723
+ * valid unit within the item's available units of measure.
1724
+ */
1725
+ unitOfMeasure?: string;
1726
+ }
1727
+ namespace Line {
1728
+ interface CustomField {
1729
+ /**
1730
+ * The name of the custom field, unique for the specified `ownerId`. For public
1731
+ * custom fields, this name is visible as a label in the QuickBooks UI.
1732
+ */
1733
+ name: string;
1734
+ /**
1735
+ * The identifier of the owner of the custom field, which QuickBooks internally
1736
+ * calls a "data extension". For public custom fields visible in the UI, such as
1737
+ * those added by the QuickBooks user, this is always "0". For private custom
1738
+ * fields that are only visible to the application that created them, this is a
1739
+ * valid GUID identifying the owning application. Internally, Conductor always
1740
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
1741
+ * objects.
1742
+ */
1743
+ ownerId: string;
1744
+ /**
1745
+ * The value of this custom field. The maximum length depends on the field's data
1746
+ * type.
1747
+ */
1748
+ value: string;
1749
+ }
1750
+ }
1751
+ /**
1752
+ * The estimate's shipping address.
1753
+ */
1754
+ interface ShippingAddress {
1755
+ /**
1756
+ * The city, district, suburb, town, or village name of the address.
1757
+ *
1758
+ * Maximum length: 31 characters.
1759
+ */
1760
+ city?: string;
1761
+ /**
1762
+ * The country name of the address.
1763
+ */
1764
+ country?: string;
1765
+ /**
1766
+ * The first line of the address (e.g., street, PO Box, or company name).
1767
+ *
1768
+ * Maximum length: 41 characters.
1769
+ */
1770
+ line1?: string;
1771
+ /**
1772
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
1773
+ * building).
1774
+ *
1775
+ * Maximum length: 41 characters.
1776
+ */
1777
+ line2?: string;
1778
+ /**
1779
+ * The third line of the address, if needed.
1780
+ *
1781
+ * Maximum length: 41 characters.
1782
+ */
1783
+ line3?: string;
1784
+ /**
1785
+ * The fourth line of the address, if needed.
1786
+ *
1787
+ * Maximum length: 41 characters.
1788
+ */
1789
+ line4?: string;
1790
+ /**
1791
+ * The fifth line of the address, if needed.
1792
+ *
1793
+ * Maximum length: 41 characters.
1794
+ */
1795
+ line5?: string;
1796
+ /**
1797
+ * A note written at the bottom of the address in the form in which it appears,
1798
+ * such as the invoice form.
1799
+ */
1800
+ note?: string;
1801
+ /**
1802
+ * The postal code or ZIP code of the address.
1803
+ *
1804
+ * Maximum length: 13 characters.
1805
+ */
1806
+ postalCode?: string;
1807
+ /**
1808
+ * The state, county, province, or region name of the address.
1809
+ *
1810
+ * Maximum length: 21 characters.
1811
+ */
1812
+ state?: string;
1813
+ }
1814
+ }
1815
+ export interface EstimateRetrieveParams {
1816
+ /**
1817
+ * The ID of the End-User to receive this request.
1818
+ */
1819
+ conductorEndUserId: string;
1820
+ }
1821
+ export interface EstimateUpdateParams {
1822
+ /**
1823
+ * Body param: The current QuickBooks-assigned revision number of the estimate
1824
+ * object you are updating, which you can get by fetching the object first. Provide
1825
+ * the most recent `revisionNumber` to ensure you're working with the latest data;
1826
+ * otherwise, the update will return an error.
1827
+ */
1828
+ revisionNumber: string;
1829
+ /**
1830
+ * Header param: The ID of the End-User to receive this request.
1831
+ */
1832
+ conductorEndUserId: string;
1833
+ /**
1834
+ * Body param: The estimate's billing address.
1835
+ */
1836
+ billingAddress?: EstimateUpdateParams.BillingAddress;
1837
+ /**
1838
+ * Body param: The estimate's class. Classes can be used to categorize objects into
1839
+ * meaningful segments, such as department, location, or type of work. In
1840
+ * QuickBooks, class tracking is off by default. A class defined here is
1841
+ * automatically used in this estimate's line items unless overridden at the line
1842
+ * item level.
1843
+ */
1844
+ classId?: string;
1845
+ /**
1846
+ * Body param: When `true`, creates a "change order" that appears in this
1847
+ * estimate's description field in QuickBooks's estimate form, specifying exactly
1848
+ * what changed in this update request, the dollar amount of each change, and the
1849
+ * net dollar change to this estimate.
1850
+ */
1851
+ createChangeOrder?: boolean;
1852
+ /**
1853
+ * Body param: The customer or customer-job associated with this estimate.
1854
+ */
1855
+ customerId?: string;
1856
+ /**
1857
+ * Body param: The message to display to the customer on the estimate.
1858
+ */
1859
+ customerMessageId?: string;
1860
+ /**
1861
+ * Body param: The predefined template in QuickBooks that determines the layout and
1862
+ * formatting for this estimate when printed or displayed.
1863
+ */
1864
+ documentTemplateId?: string;
1865
+ /**
1866
+ * Body param: The date by which this estimate must be paid, in ISO 8601 format
1867
+ * (YYYY-MM-DD).
1868
+ */
1869
+ dueDate?: string;
1870
+ /**
1871
+ * Body param: The market exchange rate between this estimate's currency and the
1872
+ * home currency in QuickBooks at the time of this transaction. Represented as a
1873
+ * decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
1874
+ */
1875
+ exchangeRate?: number;
1876
+ /**
1877
+ * Body param: Indicates whether this estimate is active. Inactive objects are
1878
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
1879
+ */
1880
+ isActive?: boolean;
1881
+ /**
1882
+ * Body param: Indicates whether this estimate is included in the queue of
1883
+ * documents for QuickBooks to email to the customer.
1884
+ */
1885
+ isQueuedForEmail?: boolean;
1886
+ /**
1887
+ * Body param: The estimate's line item groups, each representing a predefined set
1888
+ * of related items.
1889
+ *
1890
+ * **IMPORTANT**:
1891
+ *
1892
+ * 1. Including this array in your update request will **REPLACE** all existing
1893
+ * line item groups for the estimate with this array. To keep any existing line
1894
+ * item groups, you must include them in this array even if they have not
1895
+ * changed. **Any line item groups not included will be removed.**
1896
+ *
1897
+ * 2. To add a new line item group, include it here with the `id` field set to
1898
+ * `-1`.
1899
+ *
1900
+ * 3. If you do not wish to modify any line item groups, omit this field entirely
1901
+ * to keep them unchanged.
1902
+ */
1903
+ lineGroups?: Array<EstimateUpdateParams.LineGroup>;
1904
+ /**
1905
+ * Body param: The estimate's line items, each representing a single product or
1906
+ * service quoted.
1907
+ *
1908
+ * **IMPORTANT**:
1909
+ *
1910
+ * 1. Including this array in your update request will **REPLACE** all existing
1911
+ * line items for the estimate with this array. To keep any existing line items,
1912
+ * you must include them in this array even if they have not changed. **Any line
1913
+ * items not included will be removed.**
1914
+ *
1915
+ * 2. To add a new line item, include it here with the `id` field set to `-1`.
1916
+ *
1917
+ * 3. If you do not wish to modify any line items, omit this field entirely to keep
1918
+ * them unchanged.
1919
+ */
1920
+ lines?: Array<EstimateUpdateParams.Line>;
1921
+ /**
1922
+ * Body param: A memo or note for this estimate that appears in reports, but not on
1923
+ * the estimate. Use `customerMessage` to add a note to this estimate.
1924
+ */
1925
+ memo?: string;
1926
+ /**
1927
+ * Body param: A built-in custom field for additional information specific to this
1928
+ * estimate. Unlike the user-defined fields in the `customFields` array, this is a
1929
+ * standard QuickBooks field that exists for all estimates for convenience.
1930
+ * Developers often use this field for tracking information that doesn't fit into
1931
+ * other standard QuickBooks fields. Unlike `otherCustomField1` and
1932
+ * `otherCustomField2`, which are line item fields, this exists at the transaction
1933
+ * level. Hidden by default in the QuickBooks UI.
1934
+ */
1935
+ otherCustomField?: string;
1936
+ /**
1937
+ * Body param: The customer's Purchase Order (PO) number associated with this
1938
+ * estimate. This field is often used to cross-reference the estimate with the
1939
+ * customer's purchasing system.
1940
+ *
1941
+ * Maximum length: 25 characters.
1942
+ */
1943
+ purchaseOrderNumber?: string;
1944
+ /**
1945
+ * Body param: The case-sensitive user-defined reference number for this estimate,
1946
+ * which can be used to identify the transaction in QuickBooks. This value is not
1947
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
1948
+ */
1949
+ refNumber?: string;
1950
+ /**
1951
+ * Body param: The estimate's sales representative. Sales representatives can be
1952
+ * employees, vendors, or other names in QuickBooks.
1953
+ */
1954
+ salesRepresentativeId?: string;
1955
+ /**
1956
+ * Body param: The sales-tax code for this estimate, determining whether it is
1957
+ * taxable or non-taxable. This can be overridden at the transaction-line level.
1958
+ *
1959
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1960
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1961
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1962
+ * non-taxable code to all sales.
1963
+ */
1964
+ salesTaxCodeId?: string;
1965
+ /**
1966
+ * Body param: The sales-tax item used to calculate the actual tax amount for this
1967
+ * estimate's transactions by applying a specific tax rate collected for a single
1968
+ * tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this
1969
+ * field drives the actual tax calculation and reporting.
1970
+ */
1971
+ salesTaxItemId?: string;
1972
+ /**
1973
+ * Body param: The origin location from where the product associated with this
1974
+ * estimate is shipped. This is the point at which ownership and liability for
1975
+ * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
1976
+ * for this field, which stands for "freight on board". This field is informational
1977
+ * and has no accounting implications.
1978
+ */
1979
+ shipmentOrigin?: string;
1980
+ /**
1981
+ * Body param: The estimate's shipping address.
1982
+ */
1983
+ shippingAddress?: EstimateUpdateParams.ShippingAddress;
1984
+ /**
1985
+ * Body param: The estimate's payment terms, defining when payment is due and any
1986
+ * applicable discounts.
1987
+ */
1988
+ termsId?: string;
1989
+ /**
1990
+ * Body param: The date of this estimate, in ISO 8601 format (YYYY-MM-DD).
1991
+ */
1992
+ transactionDate?: string;
1993
+ }
1994
+ export declare namespace EstimateUpdateParams {
1995
+ /**
1996
+ * The estimate's billing address.
1997
+ */
1998
+ interface BillingAddress {
1999
+ /**
2000
+ * The city, district, suburb, town, or village name of the address.
2001
+ *
2002
+ * Maximum length: 31 characters.
2003
+ */
2004
+ city?: string;
2005
+ /**
2006
+ * The country name of the address.
2007
+ */
2008
+ country?: string;
2009
+ /**
2010
+ * The first line of the address (e.g., street, PO Box, or company name).
2011
+ *
2012
+ * Maximum length: 41 characters.
2013
+ */
2014
+ line1?: string;
2015
+ /**
2016
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
2017
+ * building).
2018
+ *
2019
+ * Maximum length: 41 characters.
2020
+ */
2021
+ line2?: string;
2022
+ /**
2023
+ * The third line of the address, if needed.
2024
+ *
2025
+ * Maximum length: 41 characters.
2026
+ */
2027
+ line3?: string;
2028
+ /**
2029
+ * The fourth line of the address, if needed.
2030
+ *
2031
+ * Maximum length: 41 characters.
2032
+ */
2033
+ line4?: string;
2034
+ /**
2035
+ * The fifth line of the address, if needed.
2036
+ *
2037
+ * Maximum length: 41 characters.
2038
+ */
2039
+ line5?: string;
2040
+ /**
2041
+ * A note written at the bottom of the address in the form in which it appears,
2042
+ * such as the invoice form.
2043
+ */
2044
+ note?: string;
2045
+ /**
2046
+ * The postal code or ZIP code of the address.
2047
+ *
2048
+ * Maximum length: 13 characters.
2049
+ */
2050
+ postalCode?: string;
2051
+ /**
2052
+ * The state, county, province, or region name of the address.
2053
+ *
2054
+ * Maximum length: 21 characters.
2055
+ */
2056
+ state?: string;
2057
+ }
2058
+ interface LineGroup {
2059
+ /**
2060
+ * The QuickBooks-assigned unique identifier of an existing estimate line group you
2061
+ * wish to retain or update.
2062
+ *
2063
+ * **IMPORTANT**: Set this field to `-1` for new estimate line groups you wish to
2064
+ * add.
2065
+ */
2066
+ id: string;
2067
+ /**
2068
+ * The estimate line group's item group, representing a predefined set of items
2069
+ * bundled because they are commonly purchased together or grouped for faster
2070
+ * entry.
2071
+ */
2072
+ itemGroupId?: string;
2073
+ /**
2074
+ * The estimate line group's line items, each representing a single product or
2075
+ * service quoted.
2076
+ *
2077
+ * **IMPORTANT**:
2078
+ *
2079
+ * 1. Including this array in your update request will **REPLACE** all existing
2080
+ * line items for the estimate line group with this array. To keep any existing
2081
+ * line items, you must include them in this array even if they have not
2082
+ * changed. **Any line items not included will be removed.**
2083
+ *
2084
+ * 2. To add a new line item, include it here with the `id` field set to `-1`.
2085
+ *
2086
+ * 3. If you do not wish to modify any line items, omit this field entirely to keep
2087
+ * them unchanged.
2088
+ */
2089
+ lines?: Array<LineGroup.Line>;
2090
+ /**
2091
+ * Specifies an alternative unit-of-measure set when updating this estimate line
2092
+ * group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
2093
+ * select units from a different set than the item's default unit-of-measure set,
2094
+ * which remains unchanged on the item itself. The override applies only to this
2095
+ * specific line. For example, you can sell an item typically measured in volume
2096
+ * units using weight units in a specific transaction by specifying a different
2097
+ * unit-of-measure set with this field.
2098
+ */
2099
+ overrideUnitOfMeasureSetId?: string;
2100
+ /**
2101
+ * The quantity of the item group associated with this estimate line group. This
2102
+ * field cannot be cleared.
2103
+ *
2104
+ * **NOTE**: Do not use this field if the associated item group is a discount item
2105
+ * group.
2106
+ */
2107
+ quantity?: number;
2108
+ /**
2109
+ * The unit-of-measure used for the `quantity` in this estimate line group. Must be
2110
+ * a valid unit within the item's available units of measure.
2111
+ */
2112
+ unitOfMeasure?: string;
2113
+ }
2114
+ namespace LineGroup {
2115
+ interface Line {
2116
+ /**
2117
+ * The QuickBooks-assigned unique identifier of an existing estimate line you wish
2118
+ * to retain or update.
2119
+ *
2120
+ * **IMPORTANT**: Set this field to `-1` for new estimate lines you wish to add.
2121
+ */
2122
+ id: string;
2123
+ /**
2124
+ * The monetary amount of this estimate line, represented as a decimal string. If
2125
+ * both `quantity` and `rate` are specified but not `amount`, QuickBooks will
2126
+ * calculate `amount` using the rate and any markup you supply. The calculation is
2127
+ * `amount = (quantity * rate) * (1 + markupRate)` when `markupRate` is provided,
2128
+ * or `amount = (quantity * rate) * (1 + markupRatePercent/100)` when
2129
+ * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
2130
+ * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
2131
+ * the suggested `rate`. This field cannot be cleared.
2132
+ */
2133
+ amount?: string;
2134
+ /**
2135
+ * The estimate line's class. Classes can be used to categorize objects into
2136
+ * meaningful segments, such as department, location, or type of work. In
2137
+ * QuickBooks, class tracking is off by default. If a class is specified for the
2138
+ * entire parent transaction, it is automatically applied to all estimate lines
2139
+ * unless overridden here, at the transaction line level.
2140
+ */
2141
+ classId?: string;
2142
+ /**
2143
+ * A description of this estimate line.
2144
+ */
2145
+ description?: string;
2146
+ /**
2147
+ * The site location where inventory for the item associated with this estimate
2148
+ * line is stored.
2149
+ */
2150
+ inventorySiteId?: string;
2151
+ /**
2152
+ * The specific location (e.g., bin or shelf) within the inventory site where the
2153
+ * item associated with this estimate line is stored.
2154
+ */
2155
+ inventorySiteLocationId?: string;
2156
+ /**
2157
+ * The item associated with this estimate line. This can refer to any good or
2158
+ * service that the business buys or sells, including item types such as a service
2159
+ * item, inventory item, or special calculation item like a discount item or
2160
+ * sales-tax item.
2161
+ */
2162
+ itemId?: string;
2163
+ /**
2164
+ * The markup that will be passed on to the customer for this item on this estimate
2165
+ * line. `amount = (quantity * rate) * (1 + markupRate)`
2166
+ */
2167
+ markupRate?: string;
2168
+ /**
2169
+ * The markup, expressed as a percentage, that will be passed on to the customer
2170
+ * for this item on this estimate line.
2171
+ * `amount = (quantity * rate) * (1 + markupRatePercent/100)`
2172
+ */
2173
+ markupRatePercent?: string;
2174
+ /**
2175
+ * A built-in custom field for additional information specific to this estimate
2176
+ * line. Unlike the user-defined fields in the `customFields` array, this is a
2177
+ * standard QuickBooks field that exists for all estimate lines for convenience.
2178
+ * Developers often use this field for tracking information that doesn't fit into
2179
+ * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
2180
+ */
2181
+ otherCustomField1?: string;
2182
+ /**
2183
+ * A second built-in custom field for additional information specific to this
2184
+ * estimate line. Unlike the user-defined fields in the `customFields` array, this
2185
+ * is a standard QuickBooks field that exists for all estimate lines for
2186
+ * convenience. Like `otherCustomField1`, developers often use this field for
2187
+ * tracking information that doesn't fit into other standard QuickBooks fields.
2188
+ * Hidden by default in the QuickBooks UI.
2189
+ */
2190
+ otherCustomField2?: string;
2191
+ /**
2192
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
2193
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
2194
+ * units from a different set than the item's default unit-of-measure set, which
2195
+ * remains unchanged on the item itself. The override applies only to this specific
2196
+ * line. For example, you can sell an item typically measured in volume units using
2197
+ * weight units in a specific transaction by specifying a different unit-of-measure
2198
+ * set with this field.
2199
+ */
2200
+ overrideUnitOfMeasureSetId?: string;
2201
+ /**
2202
+ * The price level applied to this estimate line. This overrides any price level
2203
+ * set on the corresponding customer. The resulting estimate line will not show
2204
+ * this price level, only the final `rate` calculated from it.
2205
+ */
2206
+ priceLevelId?: string;
2207
+ /**
2208
+ * Specifies how to resolve price rule conflicts when adding or modifying this
2209
+ * estimate line.
2210
+ */
2211
+ priceRuleConflictStrategy?: 'base_price' | 'zero';
2212
+ /**
2213
+ * The quantity of the item associated with this estimate line. This field cannot
2214
+ * be cleared.
2215
+ *
2216
+ * **NOTE**: Do not use this field if the associated item is a discount item.
2217
+ */
2218
+ quantity?: number;
2219
+ /**
2220
+ * The price per unit for this estimate line. If both `rate` and `amount` are
2221
+ * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
2222
+ * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
2223
+ * decimal string. This field cannot be cleared.
2224
+ */
2225
+ rate?: string;
2226
+ /**
2227
+ * The price of this estimate line expressed as a percentage. Typically used for
2228
+ * discount or markup items.
2229
+ */
2230
+ ratePercent?: string;
2231
+ /**
2232
+ * The sales-tax code for this estimate line, determining whether it is taxable or
2233
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
2234
+ * transaction or the associated item.
2235
+ *
2236
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2237
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2238
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2239
+ * non-taxable code to all sales.
2240
+ */
2241
+ salesTaxCodeId?: string;
2242
+ /**
2243
+ * The unit-of-measure used for the `quantity` in this estimate line. Must be a
2244
+ * valid unit within the item's available units of measure.
2245
+ */
2246
+ unitOfMeasure?: string;
2247
+ }
2248
+ }
2249
+ interface Line {
2250
+ /**
2251
+ * The QuickBooks-assigned unique identifier of an existing estimate line you wish
2252
+ * to retain or update.
2253
+ *
2254
+ * **IMPORTANT**: Set this field to `-1` for new estimate lines you wish to add.
2255
+ */
2256
+ id: string;
2257
+ /**
2258
+ * The monetary amount of this estimate line, represented as a decimal string. If
2259
+ * both `quantity` and `rate` are specified but not `amount`, QuickBooks will
2260
+ * calculate `amount` using the rate and any markup you supply. The calculation is
2261
+ * `amount = (quantity * rate) * (1 + markupRate)` when `markupRate` is provided,
2262
+ * or `amount = (quantity * rate) * (1 + markupRatePercent/100)` when
2263
+ * `markupRatePercent` is provided. If `amount`, `rate`, and `quantity` are all
2264
+ * unspecified, QuickBooks will calculate `amount` based on a `quantity` of `1` and
2265
+ * the suggested `rate`. This field cannot be cleared.
2266
+ */
2267
+ amount?: string;
2268
+ /**
2269
+ * The estimate line's class. Classes can be used to categorize objects into
2270
+ * meaningful segments, such as department, location, or type of work. In
2271
+ * QuickBooks, class tracking is off by default. If a class is specified for the
2272
+ * entire parent transaction, it is automatically applied to all estimate lines
2273
+ * unless overridden here, at the transaction line level.
2274
+ */
2275
+ classId?: string;
2276
+ /**
2277
+ * A description of this estimate line.
2278
+ */
2279
+ description?: string;
2280
+ /**
2281
+ * The site location where inventory for the item associated with this estimate
2282
+ * line is stored.
2283
+ */
2284
+ inventorySiteId?: string;
2285
+ /**
2286
+ * The specific location (e.g., bin or shelf) within the inventory site where the
2287
+ * item associated with this estimate line is stored.
2288
+ */
2289
+ inventorySiteLocationId?: string;
2290
+ /**
2291
+ * The item associated with this estimate line. This can refer to any good or
2292
+ * service that the business buys or sells, including item types such as a service
2293
+ * item, inventory item, or special calculation item like a discount item or
2294
+ * sales-tax item.
2295
+ */
2296
+ itemId?: string;
2297
+ /**
2298
+ * The markup that will be passed on to the customer for this item on this estimate
2299
+ * line. `amount = (quantity * rate) * (1 + markupRate)`
2300
+ */
2301
+ markupRate?: string;
2302
+ /**
2303
+ * The markup, expressed as a percentage, that will be passed on to the customer
2304
+ * for this item on this estimate line.
2305
+ * `amount = (quantity * rate) * (1 + markupRatePercent/100)`
2306
+ */
2307
+ markupRatePercent?: string;
2308
+ /**
2309
+ * A built-in custom field for additional information specific to this estimate
2310
+ * line. Unlike the user-defined fields in the `customFields` array, this is a
2311
+ * standard QuickBooks field that exists for all estimate lines for convenience.
2312
+ * Developers often use this field for tracking information that doesn't fit into
2313
+ * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
2314
+ */
2315
+ otherCustomField1?: string;
2316
+ /**
2317
+ * A second built-in custom field for additional information specific to this
2318
+ * estimate line. Unlike the user-defined fields in the `customFields` array, this
2319
+ * is a standard QuickBooks field that exists for all estimate lines for
2320
+ * convenience. Like `otherCustomField1`, developers often use this field for
2321
+ * tracking information that doesn't fit into other standard QuickBooks fields.
2322
+ * Hidden by default in the QuickBooks UI.
2323
+ */
2324
+ otherCustomField2?: string;
2325
+ /**
2326
+ * Specifies an alternative unit-of-measure set when updating this estimate line's
2327
+ * `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
2328
+ * units from a different set than the item's default unit-of-measure set, which
2329
+ * remains unchanged on the item itself. The override applies only to this specific
2330
+ * line. For example, you can sell an item typically measured in volume units using
2331
+ * weight units in a specific transaction by specifying a different unit-of-measure
2332
+ * set with this field.
2333
+ */
2334
+ overrideUnitOfMeasureSetId?: string;
2335
+ /**
2336
+ * The price level applied to this estimate line. This overrides any price level
2337
+ * set on the corresponding customer. The resulting estimate line will not show
2338
+ * this price level, only the final `rate` calculated from it.
2339
+ */
2340
+ priceLevelId?: string;
2341
+ /**
2342
+ * Specifies how to resolve price rule conflicts when adding or modifying this
2343
+ * estimate line.
2344
+ */
2345
+ priceRuleConflictStrategy?: 'base_price' | 'zero';
2346
+ /**
2347
+ * The quantity of the item associated with this estimate line. This field cannot
2348
+ * be cleared.
2349
+ *
2350
+ * **NOTE**: Do not use this field if the associated item is a discount item.
2351
+ */
2352
+ quantity?: number;
2353
+ /**
2354
+ * The price per unit for this estimate line. If both `rate` and `amount` are
2355
+ * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
2356
+ * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
2357
+ * decimal string. This field cannot be cleared.
2358
+ */
2359
+ rate?: string;
2360
+ /**
2361
+ * The price of this estimate line expressed as a percentage. Typically used for
2362
+ * discount or markup items.
2363
+ */
2364
+ ratePercent?: string;
2365
+ /**
2366
+ * The sales-tax code for this estimate line, determining whether it is taxable or
2367
+ * non-taxable. If set, this overrides any sales-tax codes defined on the parent
2368
+ * transaction or the associated item.
2369
+ *
2370
+ * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2371
+ * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2372
+ * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2373
+ * non-taxable code to all sales.
2374
+ */
2375
+ salesTaxCodeId?: string;
2376
+ /**
2377
+ * The unit-of-measure used for the `quantity` in this estimate line. Must be a
2378
+ * valid unit within the item's available units of measure.
2379
+ */
2380
+ unitOfMeasure?: string;
2381
+ }
2382
+ /**
2383
+ * The estimate's shipping address.
2384
+ */
2385
+ interface ShippingAddress {
2386
+ /**
2387
+ * The city, district, suburb, town, or village name of the address.
2388
+ *
2389
+ * Maximum length: 31 characters.
2390
+ */
2391
+ city?: string;
2392
+ /**
2393
+ * The country name of the address.
2394
+ */
2395
+ country?: string;
2396
+ /**
2397
+ * The first line of the address (e.g., street, PO Box, or company name).
2398
+ *
2399
+ * Maximum length: 41 characters.
2400
+ */
2401
+ line1?: string;
2402
+ /**
2403
+ * The second line of the address, if needed (e.g., apartment, suite, unit, or
2404
+ * building).
2405
+ *
2406
+ * Maximum length: 41 characters.
2407
+ */
2408
+ line2?: string;
2409
+ /**
2410
+ * The third line of the address, if needed.
2411
+ *
2412
+ * Maximum length: 41 characters.
2413
+ */
2414
+ line3?: string;
2415
+ /**
2416
+ * The fourth line of the address, if needed.
2417
+ *
2418
+ * Maximum length: 41 characters.
2419
+ */
2420
+ line4?: string;
2421
+ /**
2422
+ * The fifth line of the address, if needed.
2423
+ *
2424
+ * Maximum length: 41 characters.
2425
+ */
2426
+ line5?: string;
2427
+ /**
2428
+ * A note written at the bottom of the address in the form in which it appears,
2429
+ * such as the invoice form.
2430
+ */
2431
+ note?: string;
2432
+ /**
2433
+ * The postal code or ZIP code of the address.
2434
+ *
2435
+ * Maximum length: 13 characters.
2436
+ */
2437
+ postalCode?: string;
2438
+ /**
2439
+ * The state, county, province, or region name of the address.
2440
+ *
2441
+ * Maximum length: 21 characters.
2442
+ */
2443
+ state?: string;
2444
+ }
2445
+ }
2446
+ export interface EstimateListParams extends CursorPageParams {
2447
+ /**
2448
+ * Header param: The ID of the End-User to receive this request.
2449
+ */
2450
+ conductorEndUserId: string;
2451
+ /**
2452
+ * Query param: Filter for estimates associated with these accounts.
2453
+ */
2454
+ accountIds?: Array<string>;
2455
+ /**
2456
+ * Query param: Filter for estimates in these currencies.
2457
+ */
2458
+ currencyIds?: Array<string>;
2459
+ /**
2460
+ * Query param: Filter for estimates created for these customers.
2461
+ */
2462
+ customerIds?: Array<string>;
2463
+ /**
2464
+ * Query param: Filter for specific estimates by their QuickBooks-assigned unique
2465
+ * identifier(s).
2466
+ *
2467
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
2468
+ * query parameters for this request.
2469
+ *
2470
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
2471
+ * request will return an error.
2472
+ */
2473
+ ids?: Array<string>;
2474
+ /**
2475
+ * Query param: Whether to include line items in the response. Defaults to `true`.
2476
+ */
2477
+ includeLineItems?: boolean;
2478
+ /**
2479
+ * Query param: Whether to include linked transactions in the response. Defaults to
2480
+ * `false`. For example, a payment linked to the corresponding estimate.
2481
+ */
2482
+ includeLinkedTransactions?: boolean;
2483
+ /**
2484
+ * Query param: Filter for estimates whose `refNumber` contains this substring.
2485
+ *
2486
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith`
2487
+ * or `refNumberEndsWith`.
2488
+ */
2489
+ refNumberContains?: string;
2490
+ /**
2491
+ * Query param: Filter for estimates whose `refNumber` ends with this substring.
2492
+ *
2493
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
2494
+ * `refNumberStartsWith`.
2495
+ */
2496
+ refNumberEndsWith?: string;
2497
+ /**
2498
+ * Query param: Filter for estimates whose `refNumber` is greater than or equal to
2499
+ * this value. If omitted, the range will begin with the first number of the list.
2500
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
2501
+ * a lexicographical comparison.
2502
+ */
2503
+ refNumberFrom?: string;
2504
+ /**
2505
+ * Query param: Filter for specific estimates by their ref-number(s),
2506
+ * case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
2507
+ * be arbitrarily changed by the QuickBooks user.
2508
+ *
2509
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
2510
+ * query parameters for this request.
2511
+ *
2512
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
2513
+ * request will return an error.
2514
+ */
2515
+ refNumbers?: Array<string>;
2516
+ /**
2517
+ * Query param: Filter for estimates whose `refNumber` starts with this substring.
2518
+ *
2519
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
2520
+ * `refNumberEndsWith`.
2521
+ */
2522
+ refNumberStartsWith?: string;
2523
+ /**
2524
+ * Query param: Filter for estimates whose `refNumber` is less than or equal to
2525
+ * this value. If omitted, the range will end with the last number of the list.
2526
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
2527
+ * a lexicographical comparison.
2528
+ */
2529
+ refNumberTo?: string;
2530
+ /**
2531
+ * Query param: Filter for estimates whose `date` field is on or after this date,
2532
+ * in ISO 8601 format (YYYY-MM-DD).
2533
+ *
2534
+ * **NOTE:** QuickBooks Desktop interprets this date as the **start of the
2535
+ * specified day** in the local timezone of the end-user's computer (e.g.,
2536
+ * `2025-01-01` → `2025-01-01T00:00:00`).
2537
+ */
2538
+ transactionDateFrom?: string;
2539
+ /**
2540
+ * Query param: Filter for estimates whose `date` field is on or before this date,
2541
+ * in ISO 8601 format (YYYY-MM-DD).
2542
+ *
2543
+ * **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified
2544
+ * day** in the local timezone of the end-user's computer (e.g., `2025-01-01` →
2545
+ * `2025-01-01T23:59:59`).
2546
+ */
2547
+ transactionDateTo?: string;
2548
+ /**
2549
+ * Query param: Filter for estimates updated on or after this date/time. Accepts
2550
+ * the following ISO 8601 formats:
2551
+ *
2552
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
2553
+ * **start of the specified day** in the local timezone of the end-user's
2554
+ * computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
2555
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
2556
+ * interprets the timestamp in the local timezone of the end-user's computer.
2557
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
2558
+ * interprets the timestamp using the specified timezone.
2559
+ */
2560
+ updatedAfter?: string;
2561
+ /**
2562
+ * Query param: Filter for estimates updated on or before this date/time. Accepts
2563
+ * the following ISO 8601 formats:
2564
+ *
2565
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
2566
+ * **end of the specified day** in the local timezone of the end-user's computer
2567
+ * (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
2568
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
2569
+ * interprets the timestamp in the local timezone of the end-user's computer.
2570
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
2571
+ * interprets the timestamp using the specified timezone.
2572
+ */
2573
+ updatedBefore?: string;
2574
+ }
2575
+ export interface EstimateDeleteParams {
2576
+ /**
2577
+ * The ID of the End-User to receive this request.
2578
+ */
2579
+ conductorEndUserId: string;
2580
+ }
2581
+ export declare namespace Estimates {
2582
+ export { type Estimate as Estimate, type EstimateDeleteResponse as EstimateDeleteResponse, type EstimatesCursorPage as EstimatesCursorPage, type EstimateCreateParams as EstimateCreateParams, type EstimateRetrieveParams as EstimateRetrieveParams, type EstimateUpdateParams as EstimateUpdateParams, type EstimateListParams as EstimateListParams, type EstimateDeleteParams as EstimateDeleteParams, };
2583
+ }
2584
+ //# sourceMappingURL=estimates.d.mts.map