conductor-node 11.10.1 → 12.0.0-beta.2

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