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