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