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