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