conductor-node 11.10.0 → 12.0.0-beta.1

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