conductor-node 12.42.0 → 13.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1002) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +111 -41
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/bin/cli +46 -0
  12. package/bin/migration-config.json +44 -0
  13. package/client.d.mts +189 -0
  14. package/client.d.mts.map +1 -0
  15. package/client.d.ts +189 -0
  16. package/client.d.ts.map +1 -0
  17. package/client.js +462 -0
  18. package/client.js.map +1 -0
  19. package/client.mjs +458 -0
  20. package/client.mjs.map +1 -0
  21. package/core/api-promise.d.mts +46 -0
  22. package/core/api-promise.d.mts.map +1 -0
  23. package/core/api-promise.d.ts +46 -0
  24. package/core/api-promise.d.ts.map +1 -0
  25. package/core/api-promise.js +74 -0
  26. package/core/api-promise.js.map +1 -0
  27. package/core/api-promise.mjs +70 -0
  28. package/core/api-promise.mjs.map +1 -0
  29. package/core/error.d.mts +46 -0
  30. package/core/error.d.mts.map +1 -0
  31. package/core/error.d.ts +46 -0
  32. package/core/error.d.ts.map +1 -0
  33. package/core/error.js +113 -0
  34. package/core/error.js.map +1 -0
  35. package/core/error.mjs +97 -0
  36. package/core/error.mjs.map +1 -0
  37. package/core/pagination.d.mts +54 -0
  38. package/core/pagination.d.mts.map +1 -0
  39. package/core/pagination.d.ts +54 -0
  40. package/core/pagination.d.ts.map +1 -0
  41. package/core/pagination.js +101 -0
  42. package/core/pagination.js.map +1 -0
  43. package/core/pagination.mjs +95 -0
  44. package/core/pagination.mjs.map +1 -0
  45. package/core/resource.d.mts +6 -0
  46. package/core/resource.d.mts.map +1 -0
  47. package/core/resource.d.ts +6 -0
  48. package/core/resource.d.ts.map +1 -0
  49. package/core/resource.js +11 -0
  50. package/core/resource.js.map +1 -0
  51. package/core/resource.mjs +7 -0
  52. package/core/resource.mjs.map +1 -0
  53. package/core/uploads.d.mts +3 -0
  54. package/core/uploads.d.mts.map +1 -0
  55. package/core/uploads.d.ts +3 -0
  56. package/core/uploads.d.ts.map +1 -0
  57. package/core/uploads.js +6 -0
  58. package/core/uploads.js.map +1 -0
  59. package/core/uploads.mjs +2 -0
  60. package/core/uploads.mjs.map +1 -0
  61. package/error.d.mts +2 -0
  62. package/error.d.mts.map +1 -0
  63. package/error.d.ts +1 -46
  64. package/error.d.ts.map +1 -1
  65. package/error.js +3 -110
  66. package/error.js.map +1 -1
  67. package/error.mjs +1 -96
  68. package/error.mjs.map +1 -1
  69. package/index.d.mts +7 -124
  70. package/index.d.mts.map +1 -0
  71. package/index.d.ts +6 -123
  72. package/index.d.ts.map +1 -1
  73. package/index.js +14 -119
  74. package/index.js.map +1 -1
  75. package/index.mjs +6 -92
  76. package/index.mjs.map +1 -1
  77. package/internal/builtin-types.d.mts +73 -0
  78. package/internal/builtin-types.d.mts.map +1 -0
  79. package/internal/builtin-types.d.ts +73 -0
  80. package/internal/builtin-types.d.ts.map +1 -0
  81. package/internal/builtin-types.js +4 -0
  82. package/internal/builtin-types.js.map +1 -0
  83. package/internal/builtin-types.mjs +3 -0
  84. package/internal/builtin-types.mjs.map +1 -0
  85. package/internal/detect-platform.d.mts +15 -0
  86. package/internal/detect-platform.d.mts.map +1 -0
  87. package/internal/detect-platform.d.ts +15 -0
  88. package/internal/detect-platform.d.ts.map +1 -0
  89. package/internal/detect-platform.js +162 -0
  90. package/internal/detect-platform.js.map +1 -0
  91. package/internal/detect-platform.mjs +157 -0
  92. package/internal/detect-platform.mjs.map +1 -0
  93. package/internal/errors.d.mts +3 -0
  94. package/internal/errors.d.mts.map +1 -0
  95. package/internal/errors.d.ts +3 -0
  96. package/internal/errors.d.ts.map +1 -0
  97. package/internal/errors.js +41 -0
  98. package/internal/errors.js.map +1 -0
  99. package/internal/errors.mjs +36 -0
  100. package/internal/errors.mjs.map +1 -0
  101. package/internal/headers.d.mts +20 -0
  102. package/internal/headers.d.mts.map +1 -0
  103. package/internal/headers.d.ts +20 -0
  104. package/internal/headers.d.ts.map +1 -0
  105. package/internal/headers.js +79 -0
  106. package/internal/headers.js.map +1 -0
  107. package/internal/headers.mjs +74 -0
  108. package/internal/headers.mjs.map +1 -0
  109. package/internal/parse.d.mts +12 -0
  110. package/internal/parse.d.mts.map +1 -0
  111. package/internal/parse.d.ts +12 -0
  112. package/internal/parse.d.ts.map +1 -0
  113. package/internal/parse.js +35 -0
  114. package/internal/parse.js.map +1 -0
  115. package/internal/parse.mjs +32 -0
  116. package/internal/parse.mjs.map +1 -0
  117. package/internal/qs/formats.d.mts +7 -0
  118. package/internal/qs/formats.d.mts.map +1 -0
  119. package/internal/qs/formats.d.ts +1 -0
  120. package/internal/qs/formats.d.ts.map +1 -1
  121. package/internal/qs/formats.js +4 -2
  122. package/internal/qs/formats.js.map +1 -1
  123. package/internal/qs/formats.mjs +2 -1
  124. package/internal/qs/formats.mjs.map +1 -1
  125. package/internal/qs/index.d.mts +10 -0
  126. package/internal/qs/index.d.mts.map +1 -0
  127. package/internal/qs/index.d.ts.map +1 -1
  128. package/internal/qs/stringify.d.mts +3 -0
  129. package/internal/qs/stringify.d.mts.map +1 -0
  130. package/internal/qs/stringify.d.ts.map +1 -1
  131. package/internal/qs/stringify.js +16 -19
  132. package/internal/qs/stringify.js.map +1 -1
  133. package/internal/qs/stringify.mjs +17 -19
  134. package/internal/qs/stringify.mjs.map +1 -1
  135. package/internal/qs/types.d.mts +57 -0
  136. package/internal/qs/types.d.mts.map +1 -0
  137. package/internal/qs/utils.d.mts +15 -0
  138. package/internal/qs/utils.d.mts.map +1 -0
  139. package/internal/qs/utils.d.ts +1 -0
  140. package/internal/qs/utils.d.ts.map +1 -1
  141. package/internal/qs/utils.js +22 -21
  142. package/internal/qs/utils.js.map +1 -1
  143. package/internal/qs/utils.mjs +12 -12
  144. package/internal/qs/utils.mjs.map +1 -1
  145. package/internal/request-options.d.mts +75 -0
  146. package/internal/request-options.d.mts.map +1 -0
  147. package/internal/request-options.d.ts +75 -0
  148. package/internal/request-options.d.ts.map +1 -0
  149. package/internal/request-options.js +14 -0
  150. package/internal/request-options.js.map +1 -0
  151. package/internal/request-options.mjs +10 -0
  152. package/internal/request-options.mjs.map +1 -0
  153. package/internal/shim-types.d.mts +17 -0
  154. package/internal/shim-types.d.mts.map +1 -0
  155. package/internal/shim-types.d.ts +17 -0
  156. package/internal/shim-types.d.ts.map +1 -0
  157. package/internal/shim-types.js +4 -0
  158. package/internal/shim-types.js.map +1 -0
  159. package/internal/shim-types.mjs +3 -0
  160. package/internal/shim-types.mjs.map +1 -0
  161. package/internal/shims.d.mts +20 -0
  162. package/internal/shims.d.mts.map +1 -0
  163. package/internal/shims.d.ts +20 -0
  164. package/internal/shims.d.ts.map +1 -0
  165. package/internal/shims.js +92 -0
  166. package/internal/shims.js.map +1 -0
  167. package/internal/shims.mjs +85 -0
  168. package/internal/shims.mjs.map +1 -0
  169. package/internal/to-file.d.mts +45 -0
  170. package/internal/to-file.d.mts.map +1 -0
  171. package/internal/to-file.d.ts +45 -0
  172. package/internal/to-file.d.ts.map +1 -0
  173. package/internal/to-file.js +91 -0
  174. package/internal/to-file.js.map +1 -0
  175. package/internal/to-file.mjs +88 -0
  176. package/internal/to-file.mjs.map +1 -0
  177. package/internal/tslib.js +81 -0
  178. package/internal/tslib.mjs +17 -0
  179. package/internal/types.d.mts +69 -0
  180. package/internal/types.d.mts.map +1 -0
  181. package/internal/types.d.ts +69 -0
  182. package/internal/types.d.ts.map +1 -0
  183. package/internal/types.js +4 -0
  184. package/internal/types.js.map +1 -0
  185. package/internal/types.mjs +3 -0
  186. package/internal/types.mjs.map +1 -0
  187. package/internal/uploads.d.mts +42 -0
  188. package/internal/uploads.d.mts.map +1 -0
  189. package/internal/uploads.d.ts +42 -0
  190. package/internal/uploads.d.ts.map +1 -0
  191. package/internal/uploads.js +141 -0
  192. package/internal/uploads.js.map +1 -0
  193. package/internal/uploads.mjs +131 -0
  194. package/internal/uploads.mjs.map +1 -0
  195. package/internal/utils/base64.d.mts +3 -0
  196. package/internal/utils/base64.d.mts.map +1 -0
  197. package/internal/utils/base64.d.ts +3 -0
  198. package/internal/utils/base64.d.ts.map +1 -0
  199. package/internal/utils/base64.js +38 -0
  200. package/internal/utils/base64.js.map +1 -0
  201. package/internal/utils/base64.mjs +33 -0
  202. package/internal/utils/base64.mjs.map +1 -0
  203. package/internal/utils/bytes.d.mts +4 -0
  204. package/internal/utils/bytes.d.mts.map +1 -0
  205. package/internal/utils/bytes.d.ts +4 -0
  206. package/internal/utils/bytes.d.ts.map +1 -0
  207. package/internal/utils/bytes.js +31 -0
  208. package/internal/utils/bytes.js.map +1 -0
  209. package/internal/utils/bytes.mjs +26 -0
  210. package/internal/utils/bytes.mjs.map +1 -0
  211. package/internal/utils/env.d.mts +9 -0
  212. package/internal/utils/env.d.mts.map +1 -0
  213. package/internal/utils/env.d.ts +9 -0
  214. package/internal/utils/env.d.ts.map +1 -0
  215. package/internal/utils/env.js +22 -0
  216. package/internal/utils/env.js.map +1 -0
  217. package/internal/utils/env.mjs +18 -0
  218. package/internal/utils/env.mjs.map +1 -0
  219. package/internal/utils/log.d.mts +37 -0
  220. package/internal/utils/log.d.mts.map +1 -0
  221. package/internal/utils/log.d.ts +37 -0
  222. package/internal/utils/log.d.ts.map +1 -0
  223. package/internal/utils/log.js +85 -0
  224. package/internal/utils/log.js.map +1 -0
  225. package/internal/utils/log.mjs +79 -0
  226. package/internal/utils/log.mjs.map +1 -0
  227. package/internal/utils/path.d.mts +15 -0
  228. package/internal/utils/path.d.mts.map +1 -0
  229. package/internal/utils/path.d.ts +15 -0
  230. package/internal/utils/path.d.ts.map +1 -0
  231. package/internal/utils/path.js +79 -0
  232. package/internal/utils/path.js.map +1 -0
  233. package/internal/utils/path.mjs +74 -0
  234. package/internal/utils/path.mjs.map +1 -0
  235. package/internal/utils/sleep.d.mts +2 -0
  236. package/internal/utils/sleep.d.mts.map +1 -0
  237. package/internal/utils/sleep.d.ts +2 -0
  238. package/internal/utils/sleep.d.ts.map +1 -0
  239. package/internal/utils/sleep.js +7 -0
  240. package/internal/utils/sleep.js.map +1 -0
  241. package/internal/utils/sleep.mjs +3 -0
  242. package/internal/utils/sleep.mjs.map +1 -0
  243. package/internal/utils/uuid.d.mts +5 -0
  244. package/internal/utils/uuid.d.mts.map +1 -0
  245. package/internal/utils/uuid.d.ts +5 -0
  246. package/internal/utils/uuid.d.ts.map +1 -0
  247. package/internal/utils/uuid.js +19 -0
  248. package/internal/utils/uuid.js.map +1 -0
  249. package/internal/utils/uuid.mjs +15 -0
  250. package/internal/utils/uuid.mjs.map +1 -0
  251. package/internal/utils/values.d.mts +18 -0
  252. package/internal/utils/values.d.mts.map +1 -0
  253. package/internal/utils/values.d.ts +18 -0
  254. package/internal/utils/values.d.ts.map +1 -0
  255. package/internal/utils/values.js +112 -0
  256. package/internal/utils/values.js.map +1 -0
  257. package/internal/utils/values.mjs +94 -0
  258. package/internal/utils/values.mjs.map +1 -0
  259. package/internal/utils.d.mts +7 -0
  260. package/internal/utils.d.mts.map +1 -0
  261. package/internal/utils.d.ts +7 -0
  262. package/internal/utils.d.ts.map +1 -0
  263. package/internal/utils.js +11 -0
  264. package/internal/utils.js.map +1 -0
  265. package/internal/utils.mjs +8 -0
  266. package/internal/utils.mjs.map +1 -0
  267. package/package.json +113 -64
  268. package/pagination.d.mts +2 -0
  269. package/pagination.d.mts.map +1 -0
  270. package/pagination.d.ts +1 -17
  271. package/pagination.d.ts.map +1 -1
  272. package/pagination.js +3 -37
  273. package/pagination.js.map +1 -1
  274. package/pagination.mjs +1 -35
  275. package/pagination.mjs.map +1 -1
  276. package/resource.d.mts +2 -0
  277. package/resource.d.mts.map +1 -0
  278. package/resource.d.ts +1 -5
  279. package/resource.d.ts.map +1 -1
  280. package/resource.js +3 -8
  281. package/resource.js.map +1 -1
  282. package/resource.mjs +1 -6
  283. package/resource.mjs.map +1 -1
  284. package/resources/auth-sessions.d.mts +84 -0
  285. package/resources/auth-sessions.d.mts.map +1 -0
  286. package/resources/auth-sessions.d.ts +4 -3
  287. package/resources/auth-sessions.d.ts.map +1 -1
  288. package/resources/auth-sessions.js +1 -1
  289. package/resources/auth-sessions.js.map +1 -1
  290. package/resources/auth-sessions.mjs +1 -1
  291. package/resources/auth-sessions.mjs.map +1 -1
  292. package/resources/end-users.d.mts +195 -0
  293. package/resources/end-users.d.mts.map +1 -0
  294. package/resources/end-users.d.ts +24 -12
  295. package/resources/end-users.d.ts.map +1 -1
  296. package/resources/end-users.js +14 -7
  297. package/resources/end-users.js.map +1 -1
  298. package/resources/end-users.mjs +14 -7
  299. package/resources/end-users.mjs.map +1 -1
  300. package/resources/index.d.mts +4 -0
  301. package/resources/index.d.mts.map +1 -0
  302. package/resources/index.d.ts.map +1 -1
  303. package/resources/qbd/account-tax-lines.d.mts +56 -0
  304. package/resources/qbd/account-tax-lines.d.mts.map +1 -0
  305. package/resources/qbd/account-tax-lines.d.ts +5 -5
  306. package/resources/qbd/account-tax-lines.d.ts.map +1 -1
  307. package/resources/qbd/account-tax-lines.js +3 -2
  308. package/resources/qbd/account-tax-lines.js.map +1 -1
  309. package/resources/qbd/account-tax-lines.mjs +3 -2
  310. package/resources/qbd/account-tax-lines.mjs.map +1 -1
  311. package/resources/qbd/accounts.d.mts +645 -0
  312. package/resources/qbd/accounts.d.mts.map +1 -0
  313. package/resources/qbd/accounts.d.ts +11 -14
  314. package/resources/qbd/accounts.d.ts.map +1 -1
  315. package/resources/qbd/accounts.js +9 -7
  316. package/resources/qbd/accounts.js.map +1 -1
  317. package/resources/qbd/accounts.mjs +9 -7
  318. package/resources/qbd/accounts.mjs.map +1 -1
  319. package/resources/qbd/bill-check-payments.d.mts +918 -0
  320. package/resources/qbd/bill-check-payments.d.mts.map +1 -0
  321. package/resources/qbd/bill-check-payments.d.ts +16 -21
  322. package/resources/qbd/bill-check-payments.d.ts.map +1 -1
  323. package/resources/qbd/bill-check-payments.js +14 -16
  324. package/resources/qbd/bill-check-payments.js.map +1 -1
  325. package/resources/qbd/bill-check-payments.mjs +13 -14
  326. package/resources/qbd/bill-check-payments.mjs.map +1 -1
  327. package/resources/qbd/bill-credit-card-payments.d.mts +714 -0
  328. package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -0
  329. package/resources/qbd/bill-credit-card-payments.d.ts +14 -18
  330. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
  331. package/resources/qbd/bill-credit-card-payments.js +15 -13
  332. package/resources/qbd/bill-credit-card-payments.js.map +1 -1
  333. package/resources/qbd/bill-credit-card-payments.mjs +14 -11
  334. package/resources/qbd/bill-credit-card-payments.mjs.map +1 -1
  335. package/resources/qbd/bills.d.mts +2644 -0
  336. package/resources/qbd/bills.d.mts.map +1 -0
  337. package/resources/qbd/bills.d.ts +24 -22
  338. package/resources/qbd/bills.d.ts.map +1 -1
  339. package/resources/qbd/bills.js +14 -16
  340. package/resources/qbd/bills.js.map +1 -1
  341. package/resources/qbd/bills.mjs +13 -14
  342. package/resources/qbd/bills.mjs.map +1 -1
  343. package/resources/qbd/build-assemblies.d.mts +698 -0
  344. package/resources/qbd/build-assemblies.d.mts.map +1 -0
  345. package/resources/qbd/build-assemblies.d.ts +16 -21
  346. package/resources/qbd/build-assemblies.d.ts.map +1 -1
  347. package/resources/qbd/build-assemblies.js +14 -16
  348. package/resources/qbd/build-assemblies.js.map +1 -1
  349. package/resources/qbd/build-assemblies.mjs +13 -14
  350. package/resources/qbd/build-assemblies.mjs.map +1 -1
  351. package/resources/qbd/checks.d.mts +2607 -0
  352. package/resources/qbd/checks.d.mts.map +1 -0
  353. package/resources/qbd/checks.d.ts +16 -21
  354. package/resources/qbd/checks.d.ts.map +1 -1
  355. package/resources/qbd/checks.js +14 -16
  356. package/resources/qbd/checks.js.map +1 -1
  357. package/resources/qbd/checks.mjs +13 -14
  358. package/resources/qbd/checks.mjs.map +1 -1
  359. package/resources/qbd/classes.d.mts +344 -0
  360. package/resources/qbd/classes.d.mts.map +1 -0
  361. package/resources/qbd/classes.d.ts +11 -14
  362. package/resources/qbd/classes.d.ts.map +1 -1
  363. package/resources/qbd/classes.js +9 -7
  364. package/resources/qbd/classes.js.map +1 -1
  365. package/resources/qbd/classes.mjs +9 -7
  366. package/resources/qbd/classes.mjs.map +1 -1
  367. package/resources/qbd/company.d.mts +361 -0
  368. package/resources/qbd/company.d.mts.map +1 -0
  369. package/resources/qbd/company.d.ts +5 -5
  370. package/resources/qbd/company.d.ts.map +1 -1
  371. package/resources/qbd/company.js +3 -2
  372. package/resources/qbd/company.js.map +1 -1
  373. package/resources/qbd/company.mjs +3 -2
  374. package/resources/qbd/company.mjs.map +1 -1
  375. package/resources/qbd/credit-card-charges.d.mts +2316 -0
  376. package/resources/qbd/credit-card-charges.d.mts.map +1 -0
  377. package/resources/qbd/credit-card-charges.d.ts +16 -21
  378. package/resources/qbd/credit-card-charges.d.ts.map +1 -1
  379. package/resources/qbd/credit-card-charges.js +14 -16
  380. package/resources/qbd/credit-card-charges.js.map +1 -1
  381. package/resources/qbd/credit-card-charges.mjs +13 -14
  382. package/resources/qbd/credit-card-charges.mjs.map +1 -1
  383. package/resources/qbd/credit-card-credits.d.mts +2311 -0
  384. package/resources/qbd/credit-card-credits.d.mts.map +1 -0
  385. package/resources/qbd/credit-card-credits.d.ts +16 -21
  386. package/resources/qbd/credit-card-credits.d.ts.map +1 -1
  387. package/resources/qbd/credit-card-credits.js +14 -16
  388. package/resources/qbd/credit-card-credits.js.map +1 -1
  389. package/resources/qbd/credit-card-credits.mjs +13 -14
  390. package/resources/qbd/credit-card-credits.mjs.map +1 -1
  391. package/resources/qbd/credit-card-refunds.d.mts +1012 -0
  392. package/resources/qbd/credit-card-refunds.d.mts.map +1 -0
  393. package/resources/qbd/credit-card-refunds.d.ts +14 -18
  394. package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
  395. package/resources/qbd/credit-card-refunds.js +12 -14
  396. package/resources/qbd/credit-card-refunds.js.map +1 -1
  397. package/resources/qbd/credit-card-refunds.mjs +11 -12
  398. package/resources/qbd/credit-card-refunds.mjs.map +1 -1
  399. package/resources/qbd/credit-memos.d.mts +2718 -0
  400. package/resources/qbd/credit-memos.d.mts.map +1 -0
  401. package/resources/qbd/credit-memos.d.ts +16 -21
  402. package/resources/qbd/credit-memos.d.ts.map +1 -1
  403. package/resources/qbd/credit-memos.js +14 -16
  404. package/resources/qbd/credit-memos.js.map +1 -1
  405. package/resources/qbd/credit-memos.mjs +13 -14
  406. package/resources/qbd/credit-memos.mjs.map +1 -1
  407. package/resources/qbd/currencies.d.mts +439 -0
  408. package/resources/qbd/currencies.d.mts.map +1 -0
  409. package/resources/qbd/currencies.d.ts +11 -14
  410. package/resources/qbd/currencies.d.ts.map +1 -1
  411. package/resources/qbd/currencies.js +9 -7
  412. package/resources/qbd/currencies.js.map +1 -1
  413. package/resources/qbd/currencies.mjs +9 -7
  414. package/resources/qbd/currencies.mjs.map +1 -1
  415. package/resources/qbd/customer-types.d.mts +300 -0
  416. package/resources/qbd/customer-types.d.mts.map +1 -0
  417. package/resources/qbd/customer-types.d.ts +9 -11
  418. package/resources/qbd/customer-types.d.ts.map +1 -1
  419. package/resources/qbd/customer-types.js +7 -5
  420. package/resources/qbd/customer-types.js.map +1 -1
  421. package/resources/qbd/customer-types.mjs +7 -5
  422. package/resources/qbd/customer-types.mjs.map +1 -1
  423. package/resources/qbd/customers.d.mts +2163 -0
  424. package/resources/qbd/customers.d.mts.map +1 -0
  425. package/resources/qbd/customers.d.ts +14 -18
  426. package/resources/qbd/customers.d.ts.map +1 -1
  427. package/resources/qbd/customers.js +12 -14
  428. package/resources/qbd/customers.js.map +1 -1
  429. package/resources/qbd/customers.mjs +11 -12
  430. package/resources/qbd/customers.mjs.map +1 -1
  431. package/resources/qbd/date-driven-terms.d.mts +295 -0
  432. package/resources/qbd/date-driven-terms.d.mts.map +1 -0
  433. package/resources/qbd/date-driven-terms.d.ts +9 -11
  434. package/resources/qbd/date-driven-terms.d.ts.map +1 -1
  435. package/resources/qbd/date-driven-terms.js +7 -5
  436. package/resources/qbd/date-driven-terms.js.map +1 -1
  437. package/resources/qbd/date-driven-terms.mjs +7 -5
  438. package/resources/qbd/date-driven-terms.mjs.map +1 -1
  439. package/resources/qbd/deleted-list-objects.d.mts +105 -0
  440. package/resources/qbd/deleted-list-objects.d.mts.map +1 -0
  441. package/resources/qbd/deleted-list-objects.d.ts +5 -5
  442. package/resources/qbd/deleted-list-objects.d.ts.map +1 -1
  443. package/resources/qbd/deleted-list-objects.js +3 -2
  444. package/resources/qbd/deleted-list-objects.js.map +1 -1
  445. package/resources/qbd/deleted-list-objects.mjs +3 -2
  446. package/resources/qbd/deleted-list-objects.mjs.map +1 -1
  447. package/resources/qbd/deleted-transactions.d.mts +111 -0
  448. package/resources/qbd/deleted-transactions.d.mts.map +1 -0
  449. package/resources/qbd/deleted-transactions.d.ts +5 -5
  450. package/resources/qbd/deleted-transactions.d.ts.map +1 -1
  451. package/resources/qbd/deleted-transactions.js +3 -2
  452. package/resources/qbd/deleted-transactions.js.map +1 -1
  453. package/resources/qbd/deleted-transactions.mjs +3 -2
  454. package/resources/qbd/deleted-transactions.mjs.map +1 -1
  455. package/resources/qbd/discount-items.d.mts +642 -0
  456. package/resources/qbd/discount-items.d.mts.map +1 -0
  457. package/resources/qbd/discount-items.d.ts +14 -18
  458. package/resources/qbd/discount-items.d.ts.map +1 -1
  459. package/resources/qbd/discount-items.js +12 -14
  460. package/resources/qbd/discount-items.js.map +1 -1
  461. package/resources/qbd/discount-items.mjs +11 -12
  462. package/resources/qbd/discount-items.mjs.map +1 -1
  463. package/resources/qbd/employees.d.mts +1811 -0
  464. package/resources/qbd/employees.d.mts.map +1 -0
  465. package/resources/qbd/employees.d.ts +11 -14
  466. package/resources/qbd/employees.d.ts.map +1 -1
  467. package/resources/qbd/employees.js +9 -7
  468. package/resources/qbd/employees.js.map +1 -1
  469. package/resources/qbd/employees.mjs +9 -7
  470. package/resources/qbd/employees.mjs.map +1 -1
  471. package/resources/qbd/estimates.d.mts +2584 -0
  472. package/resources/qbd/estimates.d.mts.map +1 -0
  473. package/resources/qbd/estimates.d.ts +16 -21
  474. package/resources/qbd/estimates.d.ts.map +1 -1
  475. package/resources/qbd/estimates.js +14 -16
  476. package/resources/qbd/estimates.js.map +1 -1
  477. package/resources/qbd/estimates.mjs +13 -14
  478. package/resources/qbd/estimates.mjs.map +1 -1
  479. package/resources/qbd/index.d.mts +57 -0
  480. package/resources/qbd/index.d.mts.map +1 -0
  481. package/resources/qbd/index.d.ts +34 -34
  482. package/resources/qbd/index.d.ts.map +1 -1
  483. package/resources/qbd/index.js +2 -36
  484. package/resources/qbd/index.js.map +1 -1
  485. package/resources/qbd/index.mjs +34 -34
  486. package/resources/qbd/index.mjs.map +1 -1
  487. package/resources/qbd/inventory-adjustments.d.mts +893 -0
  488. package/resources/qbd/inventory-adjustments.d.mts.map +1 -0
  489. package/resources/qbd/inventory-adjustments.d.ts +13 -17
  490. package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
  491. package/resources/qbd/inventory-adjustments.js +11 -9
  492. package/resources/qbd/inventory-adjustments.js.map +1 -1
  493. package/resources/qbd/inventory-adjustments.mjs +11 -9
  494. package/resources/qbd/inventory-adjustments.mjs.map +1 -1
  495. package/resources/qbd/inventory-assembly-items.d.mts +988 -0
  496. package/resources/qbd/inventory-assembly-items.d.mts.map +1 -0
  497. package/resources/qbd/inventory-assembly-items.d.ts +14 -18
  498. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  499. package/resources/qbd/inventory-assembly-items.js +15 -13
  500. package/resources/qbd/inventory-assembly-items.js.map +1 -1
  501. package/resources/qbd/inventory-assembly-items.mjs +14 -11
  502. package/resources/qbd/inventory-assembly-items.mjs.map +1 -1
  503. package/resources/qbd/inventory-items.d.mts +898 -0
  504. package/resources/qbd/inventory-items.d.mts.map +1 -0
  505. package/resources/qbd/inventory-items.d.ts +14 -18
  506. package/resources/qbd/inventory-items.d.ts.map +1 -1
  507. package/resources/qbd/inventory-items.js +12 -14
  508. package/resources/qbd/inventory-items.js.map +1 -1
  509. package/resources/qbd/inventory-items.mjs +11 -12
  510. package/resources/qbd/inventory-items.mjs.map +1 -1
  511. package/resources/qbd/inventory-sites.d.mts +537 -0
  512. package/resources/qbd/inventory-sites.d.mts.map +1 -0
  513. package/resources/qbd/inventory-sites.d.ts +11 -14
  514. package/resources/qbd/inventory-sites.d.ts.map +1 -1
  515. package/resources/qbd/inventory-sites.js +9 -7
  516. package/resources/qbd/inventory-sites.js.map +1 -1
  517. package/resources/qbd/inventory-sites.mjs +9 -7
  518. package/resources/qbd/inventory-sites.mjs.map +1 -1
  519. package/resources/qbd/invoices.d.mts +2942 -0
  520. package/resources/qbd/invoices.d.mts.map +1 -0
  521. package/resources/qbd/invoices.d.ts +16 -21
  522. package/resources/qbd/invoices.d.ts.map +1 -1
  523. package/resources/qbd/invoices.js +14 -16
  524. package/resources/qbd/invoices.js.map +1 -1
  525. package/resources/qbd/invoices.mjs +13 -14
  526. package/resources/qbd/invoices.mjs.map +1 -1
  527. package/resources/qbd/item-groups.d.mts +548 -0
  528. package/resources/qbd/item-groups.d.mts.map +1 -0
  529. package/resources/qbd/item-groups.d.ts +14 -18
  530. package/resources/qbd/item-groups.d.ts.map +1 -1
  531. package/resources/qbd/item-groups.js +12 -14
  532. package/resources/qbd/item-groups.js.map +1 -1
  533. package/resources/qbd/item-groups.mjs +11 -12
  534. package/resources/qbd/item-groups.mjs.map +1 -1
  535. package/resources/qbd/item-receipts.d.mts +2416 -0
  536. package/resources/qbd/item-receipts.d.mts.map +1 -0
  537. package/resources/qbd/item-receipts.d.ts +16 -21
  538. package/resources/qbd/item-receipts.d.ts.map +1 -1
  539. package/resources/qbd/item-receipts.js +14 -16
  540. package/resources/qbd/item-receipts.js.map +1 -1
  541. package/resources/qbd/item-receipts.mjs +13 -14
  542. package/resources/qbd/item-receipts.mjs.map +1 -1
  543. package/resources/qbd/item-sites.d.mts +244 -0
  544. package/resources/qbd/item-sites.d.mts.map +1 -0
  545. package/resources/qbd/item-sites.d.ts +10 -12
  546. package/resources/qbd/item-sites.d.ts.map +1 -1
  547. package/resources/qbd/item-sites.js +9 -11
  548. package/resources/qbd/item-sites.js.map +1 -1
  549. package/resources/qbd/item-sites.mjs +8 -9
  550. package/resources/qbd/item-sites.mjs.map +1 -1
  551. package/resources/qbd/journal-entries.d.mts +937 -0
  552. package/resources/qbd/journal-entries.d.mts.map +1 -0
  553. package/resources/qbd/journal-entries.d.ts +16 -21
  554. package/resources/qbd/journal-entries.d.ts.map +1 -1
  555. package/resources/qbd/journal-entries.js +14 -16
  556. package/resources/qbd/journal-entries.js.map +1 -1
  557. package/resources/qbd/journal-entries.mjs +13 -14
  558. package/resources/qbd/journal-entries.mjs.map +1 -1
  559. package/resources/qbd/non-inventory-items.d.mts +1016 -0
  560. package/resources/qbd/non-inventory-items.d.mts.map +1 -0
  561. package/resources/qbd/non-inventory-items.d.ts +14 -18
  562. package/resources/qbd/non-inventory-items.d.ts.map +1 -1
  563. package/resources/qbd/non-inventory-items.js +12 -14
  564. package/resources/qbd/non-inventory-items.js.map +1 -1
  565. package/resources/qbd/non-inventory-items.mjs +11 -12
  566. package/resources/qbd/non-inventory-items.mjs.map +1 -1
  567. package/resources/qbd/other-charge-items.d.mts +948 -0
  568. package/resources/qbd/other-charge-items.d.mts.map +1 -0
  569. package/resources/qbd/other-charge-items.d.ts +14 -18
  570. package/resources/qbd/other-charge-items.d.ts.map +1 -1
  571. package/resources/qbd/other-charge-items.js +12 -14
  572. package/resources/qbd/other-charge-items.js.map +1 -1
  573. package/resources/qbd/other-charge-items.mjs +11 -12
  574. package/resources/qbd/other-charge-items.mjs.map +1 -1
  575. package/resources/qbd/other-names.d.mts +711 -0
  576. package/resources/qbd/other-names.d.mts.map +1 -0
  577. package/resources/qbd/other-names.d.ts +11 -14
  578. package/resources/qbd/other-names.d.ts.map +1 -1
  579. package/resources/qbd/other-names.js +9 -7
  580. package/resources/qbd/other-names.js.map +1 -1
  581. package/resources/qbd/other-names.mjs +9 -7
  582. package/resources/qbd/other-names.mjs.map +1 -1
  583. package/resources/qbd/payment-methods.d.mts +258 -0
  584. package/resources/qbd/payment-methods.d.mts.map +1 -0
  585. package/resources/qbd/payment-methods.d.ts +9 -11
  586. package/resources/qbd/payment-methods.d.ts.map +1 -1
  587. package/resources/qbd/payment-methods.js +7 -5
  588. package/resources/qbd/payment-methods.js.map +1 -1
  589. package/resources/qbd/payment-methods.mjs +7 -5
  590. package/resources/qbd/payment-methods.mjs.map +1 -1
  591. package/resources/qbd/payroll-wage-items.d.mts +267 -0
  592. package/resources/qbd/payroll-wage-items.d.mts.map +1 -0
  593. package/resources/qbd/payroll-wage-items.d.ts +12 -15
  594. package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
  595. package/resources/qbd/payroll-wage-items.js +10 -12
  596. package/resources/qbd/payroll-wage-items.js.map +1 -1
  597. package/resources/qbd/payroll-wage-items.mjs +9 -10
  598. package/resources/qbd/payroll-wage-items.mjs.map +1 -1
  599. package/resources/qbd/preferences.d.mts +599 -0
  600. package/resources/qbd/preferences.d.mts.map +1 -0
  601. package/resources/qbd/preferences.d.ts +5 -5
  602. package/resources/qbd/preferences.d.ts.map +1 -1
  603. package/resources/qbd/preferences.js +3 -2
  604. package/resources/qbd/preferences.js.map +1 -1
  605. package/resources/qbd/preferences.mjs +3 -2
  606. package/resources/qbd/preferences.mjs.map +1 -1
  607. package/resources/qbd/price-levels.d.mts +509 -0
  608. package/resources/qbd/price-levels.d.mts.map +1 -0
  609. package/resources/qbd/price-levels.d.ts +11 -14
  610. package/resources/qbd/price-levels.d.ts.map +1 -1
  611. package/resources/qbd/price-levels.js +9 -7
  612. package/resources/qbd/price-levels.js.map +1 -1
  613. package/resources/qbd/price-levels.mjs +9 -7
  614. package/resources/qbd/price-levels.mjs.map +1 -1
  615. package/resources/qbd/purchase-orders.d.mts +2632 -0
  616. package/resources/qbd/purchase-orders.d.mts.map +1 -0
  617. package/resources/qbd/purchase-orders.d.ts +16 -21
  618. package/resources/qbd/purchase-orders.d.ts.map +1 -1
  619. package/resources/qbd/purchase-orders.js +14 -16
  620. package/resources/qbd/purchase-orders.js.map +1 -1
  621. package/resources/qbd/purchase-orders.mjs +13 -14
  622. package/resources/qbd/purchase-orders.mjs.map +1 -1
  623. package/resources/qbd/qbd.d.mts +261 -0
  624. package/resources/qbd/qbd.d.mts.map +1 -0
  625. package/resources/qbd/qbd.d.ts +39 -39
  626. package/resources/qbd/qbd.d.ts.map +1 -1
  627. package/resources/qbd/qbd.js +59 -114
  628. package/resources/qbd/qbd.js.map +1 -1
  629. package/resources/qbd/qbd.mjs +37 -70
  630. package/resources/qbd/qbd.mjs.map +1 -1
  631. package/resources/qbd/receive-payments.d.mts +1358 -0
  632. package/resources/qbd/receive-payments.d.mts.map +1 -0
  633. package/resources/qbd/receive-payments.d.ts +16 -21
  634. package/resources/qbd/receive-payments.d.ts.map +1 -1
  635. package/resources/qbd/receive-payments.js +14 -16
  636. package/resources/qbd/receive-payments.js.map +1 -1
  637. package/resources/qbd/receive-payments.mjs +13 -14
  638. package/resources/qbd/receive-payments.mjs.map +1 -1
  639. package/resources/qbd/sales-orders.d.mts +2705 -0
  640. package/resources/qbd/sales-orders.d.mts.map +1 -0
  641. package/resources/qbd/sales-orders.d.ts +16 -21
  642. package/resources/qbd/sales-orders.d.ts.map +1 -1
  643. package/resources/qbd/sales-orders.js +14 -16
  644. package/resources/qbd/sales-orders.js.map +1 -1
  645. package/resources/qbd/sales-orders.mjs +13 -14
  646. package/resources/qbd/sales-orders.mjs.map +1 -1
  647. package/resources/qbd/sales-receipts.d.mts +3454 -0
  648. package/resources/qbd/sales-receipts.d.mts.map +1 -0
  649. package/resources/qbd/sales-receipts.d.ts +16 -21
  650. package/resources/qbd/sales-receipts.d.ts.map +1 -1
  651. package/resources/qbd/sales-receipts.js +14 -16
  652. package/resources/qbd/sales-receipts.js.map +1 -1
  653. package/resources/qbd/sales-receipts.mjs +13 -14
  654. package/resources/qbd/sales-receipts.mjs.map +1 -1
  655. package/resources/qbd/sales-representatives.d.mts +317 -0
  656. package/resources/qbd/sales-representatives.d.mts.map +1 -0
  657. package/resources/qbd/sales-representatives.d.ts +11 -14
  658. package/resources/qbd/sales-representatives.d.ts.map +1 -1
  659. package/resources/qbd/sales-representatives.js +9 -7
  660. package/resources/qbd/sales-representatives.js.map +1 -1
  661. package/resources/qbd/sales-representatives.mjs +9 -7
  662. package/resources/qbd/sales-representatives.mjs.map +1 -1
  663. package/resources/qbd/sales-tax-codes.d.mts +369 -0
  664. package/resources/qbd/sales-tax-codes.d.mts.map +1 -0
  665. package/resources/qbd/sales-tax-codes.d.ts +11 -14
  666. package/resources/qbd/sales-tax-codes.d.ts.map +1 -1
  667. package/resources/qbd/sales-tax-codes.js +9 -7
  668. package/resources/qbd/sales-tax-codes.js.map +1 -1
  669. package/resources/qbd/sales-tax-codes.mjs +9 -7
  670. package/resources/qbd/sales-tax-codes.mjs.map +1 -1
  671. package/resources/qbd/sales-tax-items.d.mts +518 -0
  672. package/resources/qbd/sales-tax-items.d.mts.map +1 -0
  673. package/resources/qbd/sales-tax-items.d.ts +14 -18
  674. package/resources/qbd/sales-tax-items.d.ts.map +1 -1
  675. package/resources/qbd/sales-tax-items.js +12 -14
  676. package/resources/qbd/sales-tax-items.js.map +1 -1
  677. package/resources/qbd/sales-tax-items.mjs +11 -12
  678. package/resources/qbd/sales-tax-items.mjs.map +1 -1
  679. package/resources/qbd/service-items.d.mts +987 -0
  680. package/resources/qbd/service-items.d.mts.map +1 -0
  681. package/resources/qbd/service-items.d.ts +14 -18
  682. package/resources/qbd/service-items.d.ts.map +1 -1
  683. package/resources/qbd/service-items.js +12 -14
  684. package/resources/qbd/service-items.js.map +1 -1
  685. package/resources/qbd/service-items.mjs +11 -12
  686. package/resources/qbd/service-items.mjs.map +1 -1
  687. package/resources/qbd/standard-terms.d.mts +273 -0
  688. package/resources/qbd/standard-terms.d.mts.map +1 -0
  689. package/resources/qbd/standard-terms.d.ts +9 -11
  690. package/resources/qbd/standard-terms.d.ts.map +1 -1
  691. package/resources/qbd/standard-terms.js +7 -5
  692. package/resources/qbd/standard-terms.js.map +1 -1
  693. package/resources/qbd/standard-terms.mjs +7 -5
  694. package/resources/qbd/standard-terms.mjs.map +1 -1
  695. package/resources/qbd/subtotal-items.d.mts +383 -0
  696. package/resources/qbd/subtotal-items.d.mts.map +1 -0
  697. package/resources/qbd/subtotal-items.d.ts +14 -18
  698. package/resources/qbd/subtotal-items.d.ts.map +1 -1
  699. package/resources/qbd/subtotal-items.js +12 -14
  700. package/resources/qbd/subtotal-items.js.map +1 -1
  701. package/resources/qbd/subtotal-items.mjs +11 -12
  702. package/resources/qbd/subtotal-items.mjs.map +1 -1
  703. package/resources/qbd/templates.d.mts +107 -0
  704. package/resources/qbd/templates.d.mts.map +1 -0
  705. package/resources/qbd/templates.d.ts +5 -5
  706. package/resources/qbd/templates.d.ts.map +1 -1
  707. package/resources/qbd/templates.js +3 -2
  708. package/resources/qbd/templates.js.map +1 -1
  709. package/resources/qbd/templates.mjs +3 -2
  710. package/resources/qbd/templates.mjs.map +1 -1
  711. package/resources/qbd/time-tracking-activities.d.mts +560 -0
  712. package/resources/qbd/time-tracking-activities.d.mts.map +1 -0
  713. package/resources/qbd/time-tracking-activities.d.ts +16 -21
  714. package/resources/qbd/time-tracking-activities.d.ts.map +1 -1
  715. package/resources/qbd/time-tracking-activities.js +17 -15
  716. package/resources/qbd/time-tracking-activities.js.map +1 -1
  717. package/resources/qbd/time-tracking-activities.mjs +16 -13
  718. package/resources/qbd/time-tracking-activities.mjs.map +1 -1
  719. package/resources/qbd/transactions.d.mts +356 -0
  720. package/resources/qbd/transactions.d.mts.map +1 -0
  721. package/resources/qbd/transactions.d.ts +10 -12
  722. package/resources/qbd/transactions.d.ts.map +1 -1
  723. package/resources/qbd/transactions.js +9 -11
  724. package/resources/qbd/transactions.js.map +1 -1
  725. package/resources/qbd/transactions.mjs +8 -9
  726. package/resources/qbd/transactions.mjs.map +1 -1
  727. package/resources/qbd/transfers.d.mts +331 -0
  728. package/resources/qbd/transfers.d.mts.map +1 -0
  729. package/resources/qbd/transfers.d.ts +14 -18
  730. package/resources/qbd/transfers.d.ts.map +1 -1
  731. package/resources/qbd/transfers.js +12 -14
  732. package/resources/qbd/transfers.js.map +1 -1
  733. package/resources/qbd/transfers.mjs +11 -12
  734. package/resources/qbd/transfers.mjs.map +1 -1
  735. package/resources/qbd/unit-of-measure-sets.d.mts +443 -0
  736. package/resources/qbd/unit-of-measure-sets.d.mts.map +1 -0
  737. package/resources/qbd/unit-of-measure-sets.d.ts +9 -11
  738. package/resources/qbd/unit-of-measure-sets.d.ts.map +1 -1
  739. package/resources/qbd/unit-of-measure-sets.js +7 -5
  740. package/resources/qbd/unit-of-measure-sets.js.map +1 -1
  741. package/resources/qbd/unit-of-measure-sets.mjs +7 -5
  742. package/resources/qbd/unit-of-measure-sets.mjs.map +1 -1
  743. package/resources/qbd/vendor-credits.d.mts +2387 -0
  744. package/resources/qbd/vendor-credits.d.mts.map +1 -0
  745. package/resources/qbd/vendor-credits.d.ts +27 -24
  746. package/resources/qbd/vendor-credits.d.ts.map +1 -1
  747. package/resources/qbd/vendor-credits.js +14 -16
  748. package/resources/qbd/vendor-credits.js.map +1 -1
  749. package/resources/qbd/vendor-credits.mjs +13 -14
  750. package/resources/qbd/vendor-credits.mjs.map +1 -1
  751. package/resources/qbd/vendors.d.mts +1734 -0
  752. package/resources/qbd/vendors.d.mts.map +1 -0
  753. package/resources/qbd/vendors.d.ts +14 -18
  754. package/resources/qbd/vendors.d.ts.map +1 -1
  755. package/resources/qbd/vendors.js +12 -14
  756. package/resources/qbd/vendors.js.map +1 -1
  757. package/resources/qbd/vendors.mjs +11 -12
  758. package/resources/qbd/vendors.mjs.map +1 -1
  759. package/resources/qbd.d.mts +2 -0
  760. package/resources/qbd.d.mts.map +1 -0
  761. package/resources/qbd.d.ts.map +1 -1
  762. package/resources/qbd.js +2 -15
  763. package/resources/qbd.js.map +1 -1
  764. package/resources.d.mts +2 -0
  765. package/resources.d.mts.map +1 -0
  766. package/resources.d.ts.map +1 -1
  767. package/resources.js +2 -15
  768. package/resources.js.map +1 -1
  769. package/src/api-promise.ts +2 -0
  770. package/src/client.ts +769 -0
  771. package/src/core/README.md +3 -0
  772. package/src/core/api-promise.ts +92 -0
  773. package/src/core/error.ts +130 -0
  774. package/src/core/pagination.ts +157 -0
  775. package/src/core/resource.ts +11 -0
  776. package/src/core/uploads.ts +2 -0
  777. package/src/error.ts +2 -130
  778. package/src/index.ts +6 -223
  779. package/src/internal/README.md +3 -0
  780. package/src/internal/builtin-types.ts +93 -0
  781. package/src/internal/detect-platform.ts +196 -0
  782. package/src/internal/errors.ts +33 -0
  783. package/src/internal/headers.ts +97 -0
  784. package/src/internal/parse.ts +50 -0
  785. package/src/internal/qs/formats.ts +3 -2
  786. package/src/internal/qs/index.ts +3 -3
  787. package/src/internal/qs/stringify.ts +18 -21
  788. package/src/internal/qs/utils.ts +16 -16
  789. package/src/internal/request-options.ts +91 -0
  790. package/src/internal/shim-types.ts +26 -0
  791. package/src/internal/shims.ts +107 -0
  792. package/src/internal/to-file.ts +154 -0
  793. package/src/internal/types.ts +95 -0
  794. package/src/internal/uploads.ts +187 -0
  795. package/src/internal/utils/base64.ts +40 -0
  796. package/src/internal/utils/bytes.ts +32 -0
  797. package/src/internal/utils/env.ts +18 -0
  798. package/src/internal/utils/log.ts +126 -0
  799. package/src/internal/utils/path.ts +88 -0
  800. package/src/internal/utils/sleep.ts +3 -0
  801. package/src/internal/utils/uuid.ts +17 -0
  802. package/src/internal/utils/values.ts +105 -0
  803. package/src/internal/utils.ts +8 -0
  804. package/src/pagination.ts +2 -60
  805. package/src/resource.ts +2 -11
  806. package/src/resources/auth-sessions.ts +4 -3
  807. package/src/resources/end-users.ts +33 -16
  808. package/src/resources/index.ts +3 -3
  809. package/src/resources/qbd/account-tax-lines.ts +7 -9
  810. package/src/resources/qbd/accounts.ts +19 -24
  811. package/src/resources/qbd/bill-check-payments.ts +31 -38
  812. package/src/resources/qbd/bill-credit-card-payments.ts +31 -30
  813. package/src/resources/qbd/bills.ts +35 -36
  814. package/src/resources/qbd/build-assemblies.ts +30 -38
  815. package/src/resources/qbd/checks.ts +27 -35
  816. package/src/resources/qbd/classes.ts +19 -20
  817. package/src/resources/qbd/company.ts +7 -6
  818. package/src/resources/qbd/credit-card-charges.ts +31 -38
  819. package/src/resources/qbd/credit-card-credits.ts +31 -38
  820. package/src/resources/qbd/credit-card-refunds.ts +26 -32
  821. package/src/resources/qbd/credit-memos.ts +29 -41
  822. package/src/resources/qbd/currencies.ts +19 -24
  823. package/src/resources/qbd/customer-types.ts +16 -19
  824. package/src/resources/qbd/customers.ts +23 -33
  825. package/src/resources/qbd/date-driven-terms.ts +16 -19
  826. package/src/resources/qbd/deleted-list-objects.ts +8 -7
  827. package/src/resources/qbd/deleted-transactions.ts +8 -7
  828. package/src/resources/qbd/discount-items.ts +25 -32
  829. package/src/resources/qbd/employees.ts +19 -24
  830. package/src/resources/qbd/estimates.ts +28 -39
  831. package/src/resources/qbd/index.ts +90 -90
  832. package/src/resources/qbd/inventory-adjustments.ts +27 -32
  833. package/src/resources/qbd/inventory-assembly-items.ts +31 -30
  834. package/src/resources/qbd/inventory-items.ts +25 -32
  835. package/src/resources/qbd/inventory-sites.ts +20 -28
  836. package/src/resources/qbd/invoices.ts +28 -39
  837. package/src/resources/qbd/item-groups.ts +23 -37
  838. package/src/resources/qbd/item-receipts.ts +29 -41
  839. package/src/resources/qbd/item-sites.ts +16 -24
  840. package/src/resources/qbd/journal-entries.ts +30 -38
  841. package/src/resources/qbd/non-inventory-items.ts +26 -32
  842. package/src/resources/qbd/other-charge-items.ts +26 -32
  843. package/src/resources/qbd/other-names.ts +19 -28
  844. package/src/resources/qbd/payment-methods.ts +16 -19
  845. package/src/resources/qbd/payroll-wage-items.ts +21 -26
  846. package/src/resources/qbd/preferences.ts +7 -6
  847. package/src/resources/qbd/price-levels.ts +19 -28
  848. package/src/resources/qbd/purchase-orders.ts +30 -38
  849. package/src/resources/qbd/qbd.ts +151 -187
  850. package/src/resources/qbd/receive-payments.ts +31 -35
  851. package/src/resources/qbd/sales-orders.ts +29 -41
  852. package/src/resources/qbd/sales-receipts.ts +30 -38
  853. package/src/resources/qbd/sales-representatives.ts +22 -26
  854. package/src/resources/qbd/sales-tax-codes.ts +20 -28
  855. package/src/resources/qbd/sales-tax-items.ts +25 -32
  856. package/src/resources/qbd/service-items.ts +24 -35
  857. package/src/resources/qbd/standard-terms.ts +16 -19
  858. package/src/resources/qbd/subtotal-items.ts +25 -32
  859. package/src/resources/qbd/templates.ts +7 -6
  860. package/src/resources/qbd/time-tracking-activities.ts +36 -36
  861. package/src/resources/qbd/transactions.ts +17 -22
  862. package/src/resources/qbd/transfers.ts +23 -33
  863. package/src/resources/qbd/unit-of-measure-sets.ts +17 -20
  864. package/src/resources/qbd/vendor-credits.ts +41 -41
  865. package/src/resources/qbd/vendors.ts +23 -26
  866. package/src/resources/qbd.ts +1 -1
  867. package/src/resources.ts +1 -1
  868. package/src/tsconfig.json +2 -2
  869. package/src/uploads.ts +2 -255
  870. package/src/version.ts +1 -1
  871. package/uploads.d.mts +2 -0
  872. package/uploads.d.mts.map +1 -0
  873. package/uploads.d.ts +1 -74
  874. package/uploads.d.ts.map +1 -1
  875. package/uploads.js +3 -168
  876. package/uploads.js.map +1 -1
  877. package/uploads.mjs +1 -157
  878. package/uploads.mjs.map +1 -1
  879. package/version.d.mts +2 -0
  880. package/version.d.mts.map +1 -0
  881. package/version.d.ts +1 -1
  882. package/version.d.ts.map +1 -1
  883. package/version.js +1 -1
  884. package/version.js.map +1 -1
  885. package/version.mjs +1 -1
  886. package/version.mjs.map +1 -1
  887. package/_shims/MultipartBody.d.ts +0 -9
  888. package/_shims/MultipartBody.d.ts.map +0 -1
  889. package/_shims/MultipartBody.js +0 -16
  890. package/_shims/MultipartBody.js.map +0 -1
  891. package/_shims/MultipartBody.mjs +0 -12
  892. package/_shims/MultipartBody.mjs.map +0 -1
  893. package/_shims/README.md +0 -46
  894. package/_shims/auto/runtime-bun.d.ts +0 -5
  895. package/_shims/auto/runtime-bun.d.ts.map +0 -1
  896. package/_shims/auto/runtime-bun.js +0 -21
  897. package/_shims/auto/runtime-bun.js.map +0 -1
  898. package/_shims/auto/runtime-bun.mjs +0 -2
  899. package/_shims/auto/runtime-bun.mjs.map +0 -1
  900. package/_shims/auto/runtime-node.d.ts +0 -5
  901. package/_shims/auto/runtime-node.d.ts.map +0 -1
  902. package/_shims/auto/runtime-node.js +0 -21
  903. package/_shims/auto/runtime-node.js.map +0 -1
  904. package/_shims/auto/runtime-node.mjs +0 -2
  905. package/_shims/auto/runtime-node.mjs.map +0 -1
  906. package/_shims/auto/runtime.d.ts +0 -5
  907. package/_shims/auto/runtime.d.ts.map +0 -1
  908. package/_shims/auto/runtime.js +0 -21
  909. package/_shims/auto/runtime.js.map +0 -1
  910. package/_shims/auto/runtime.mjs +0 -2
  911. package/_shims/auto/runtime.mjs.map +0 -1
  912. package/_shims/auto/types-node.d.ts +0 -5
  913. package/_shims/auto/types-node.d.ts.map +0 -1
  914. package/_shims/auto/types-node.js +0 -21
  915. package/_shims/auto/types-node.js.map +0 -1
  916. package/_shims/auto/types-node.mjs +0 -2
  917. package/_shims/auto/types-node.mjs.map +0 -1
  918. package/_shims/auto/types.d.ts +0 -101
  919. package/_shims/auto/types.js +0 -3
  920. package/_shims/auto/types.mjs +0 -3
  921. package/_shims/bun-runtime.d.ts +0 -6
  922. package/_shims/bun-runtime.d.ts.map +0 -1
  923. package/_shims/bun-runtime.js +0 -14
  924. package/_shims/bun-runtime.js.map +0 -1
  925. package/_shims/bun-runtime.mjs +0 -10
  926. package/_shims/bun-runtime.mjs.map +0 -1
  927. package/_shims/index.d.ts +0 -83
  928. package/_shims/index.js +0 -17
  929. package/_shims/index.mjs +0 -11
  930. package/_shims/manual-types.d.ts +0 -12
  931. package/_shims/manual-types.js +0 -3
  932. package/_shims/manual-types.mjs +0 -3
  933. package/_shims/node-runtime.d.ts +0 -3
  934. package/_shims/node-runtime.d.ts.map +0 -1
  935. package/_shims/node-runtime.js +0 -89
  936. package/_shims/node-runtime.js.map +0 -1
  937. package/_shims/node-runtime.mjs +0 -56
  938. package/_shims/node-runtime.mjs.map +0 -1
  939. package/_shims/node-types.d.ts +0 -42
  940. package/_shims/node-types.js +0 -3
  941. package/_shims/node-types.mjs +0 -3
  942. package/_shims/registry.d.ts +0 -37
  943. package/_shims/registry.d.ts.map +0 -1
  944. package/_shims/registry.js +0 -41
  945. package/_shims/registry.js.map +0 -1
  946. package/_shims/registry.mjs +0 -37
  947. package/_shims/registry.mjs.map +0 -1
  948. package/_shims/web-runtime.d.ts +0 -5
  949. package/_shims/web-runtime.d.ts.map +0 -1
  950. package/_shims/web-runtime.js +0 -78
  951. package/_shims/web-runtime.js.map +0 -1
  952. package/_shims/web-runtime.mjs +0 -71
  953. package/_shims/web-runtime.mjs.map +0 -1
  954. package/_shims/web-types.d.ts +0 -83
  955. package/_shims/web-types.js +0 -3
  956. package/_shims/web-types.mjs +0 -3
  957. package/core.d.ts +0 -255
  958. package/core.d.ts.map +0 -1
  959. package/core.js +0 -924
  960. package/core.js.map +0 -1
  961. package/core.mjs +0 -892
  962. package/core.mjs.map +0 -1
  963. package/shims/node.d.ts +0 -30
  964. package/shims/node.d.ts.map +0 -1
  965. package/shims/node.js +0 -31
  966. package/shims/node.js.map +0 -1
  967. package/shims/node.mjs +0 -5
  968. package/shims/node.mjs.map +0 -1
  969. package/shims/web.d.ts +0 -26
  970. package/shims/web.d.ts.map +0 -1
  971. package/shims/web.js +0 -31
  972. package/shims/web.js.map +0 -1
  973. package/shims/web.mjs +0 -5
  974. package/shims/web.mjs.map +0 -1
  975. package/src/_shims/MultipartBody.ts +0 -9
  976. package/src/_shims/README.md +0 -46
  977. package/src/_shims/auto/runtime-bun.ts +0 -4
  978. package/src/_shims/auto/runtime-node.ts +0 -4
  979. package/src/_shims/auto/runtime.ts +0 -4
  980. package/src/_shims/auto/types-node.ts +0 -4
  981. package/src/_shims/auto/types.d.ts +0 -101
  982. package/src/_shims/auto/types.js +0 -3
  983. package/src/_shims/auto/types.mjs +0 -3
  984. package/src/_shims/bun-runtime.ts +0 -14
  985. package/src/_shims/index.d.ts +0 -83
  986. package/src/_shims/index.js +0 -17
  987. package/src/_shims/index.mjs +0 -11
  988. package/src/_shims/manual-types.d.ts +0 -12
  989. package/src/_shims/manual-types.js +0 -3
  990. package/src/_shims/manual-types.mjs +0 -3
  991. package/src/_shims/node-runtime.ts +0 -81
  992. package/src/_shims/node-types.d.ts +0 -42
  993. package/src/_shims/node-types.js +0 -3
  994. package/src/_shims/node-types.mjs +0 -3
  995. package/src/_shims/registry.ts +0 -67
  996. package/src/_shims/web-runtime.ts +0 -103
  997. package/src/_shims/web-types.d.ts +0 -83
  998. package/src/_shims/web-types.js +0 -3
  999. package/src/_shims/web-types.mjs +0 -3
  1000. package/src/core.ts +0 -1236
  1001. package/src/shims/node.ts +0 -50
  1002. package/src/shims/web.ts +0 -50
@@ -0,0 +1,1358 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
4
+ import { RequestOptions } from "../../internal/request-options.mjs";
5
+ export declare class ReceivePayments extends APIResource {
6
+ /**
7
+ * Records a customer payment and optionally applies it to specific invoices or
8
+ * credits. All allocations must target the same accounts receivable account as
9
+ * those invoices, and each one has to include a payment amount, discount, or
10
+ * credit so QuickBooks can close out the balance.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const receivePayment =
15
+ * await conductor.qbd.receivePayments.create({
16
+ * customerId: '80000001-1234567890',
17
+ * totalAmount: '1000.00',
18
+ * transactionDate: '2024-10-01',
19
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
20
+ * });
21
+ * ```
22
+ */
23
+ create(params: ReceivePaymentCreateParams, options?: RequestOptions): APIPromise<ReceivePayment>;
24
+ /**
25
+ * Retrieves a receive-payment by ID.
26
+ *
27
+ * **IMPORTANT:** If you need to fetch multiple specific receive-payments by ID,
28
+ * use the list endpoint instead with the `ids` parameter. It accepts an array of
29
+ * IDs so you can batch the request into a single call, which is significantly
30
+ * faster.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * const receivePayment =
35
+ * await conductor.qbd.receivePayments.retrieve(
36
+ * '123ABC-1234567890',
37
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
38
+ * );
39
+ * ```
40
+ */
41
+ retrieve(id: string, params: ReceivePaymentRetrieveParams, options?: RequestOptions): APIPromise<ReceivePayment>;
42
+ /**
43
+ * Updates a received payment. When you resubmit applications to invoices, keep
44
+ * them on the same accounts receivable account and include the payment amount,
45
+ * discount, or credit on every allocation you send.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const receivePayment =
50
+ * await conductor.qbd.receivePayments.update(
51
+ * '123ABC-1234567890',
52
+ * {
53
+ * revisionNumber: '1721172183',
54
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
55
+ * },
56
+ * );
57
+ * ```
58
+ */
59
+ update(id: string, params: ReceivePaymentUpdateParams, options?: RequestOptions): APIPromise<ReceivePayment>;
60
+ /**
61
+ * Returns a list of receive-payments. Use the `cursor` parameter to paginate
62
+ * through the results.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * // Automatically fetches more pages as needed.
67
+ * for await (const receivePayment of conductor.qbd.receivePayments.list(
68
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
69
+ * )) {
70
+ * // ...
71
+ * }
72
+ * ```
73
+ */
74
+ list(params: ReceivePaymentListParams, options?: RequestOptions): PagePromise<ReceivePaymentsCursorPage, ReceivePayment>;
75
+ /**
76
+ * Permanently deletes a a receive-payment. The deletion will fail if the
77
+ * receive-payment is currently in use or has any linked transactions that are in
78
+ * use.
79
+ *
80
+ * @example
81
+ * ```ts
82
+ * const receivePayment =
83
+ * await conductor.qbd.receivePayments.delete(
84
+ * '123ABC-1234567890',
85
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
86
+ * );
87
+ * ```
88
+ */
89
+ delete(id: string, params: ReceivePaymentDeleteParams, options?: RequestOptions): APIPromise<ReceivePaymentDeleteResponse>;
90
+ }
91
+ export type ReceivePaymentsCursorPage = CursorPage<ReceivePayment>;
92
+ export interface ReceivePayment {
93
+ /**
94
+ * The unique identifier assigned by QuickBooks to this receive-payment. This ID is
95
+ * unique across all transaction types.
96
+ */
97
+ id: string;
98
+ /**
99
+ * The invoice(s) paid by this receive-payment.
100
+ */
101
+ appliedToTransactions: Array<ReceivePayment.AppliedToTransaction>;
102
+ /**
103
+ * The date and time when this receive-payment was created, in ISO 8601 format
104
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
105
+ * timezone of the end-user's computer.
106
+ */
107
+ createdAt: string;
108
+ /**
109
+ * The credit card transaction data for this receive-payment's payment when using
110
+ * QuickBooks Merchant Services (QBMS).
111
+ */
112
+ creditCardTransaction: ReceivePayment.CreditCardTransaction | null;
113
+ /**
114
+ * The receive-payment's currency. For built-in currencies, the name and code are
115
+ * standard international values. For user-defined currencies, all values are
116
+ * editable.
117
+ */
118
+ currency: ReceivePayment.Currency | null;
119
+ /**
120
+ * The customer or customer-job to which the payment for this receive-payment is
121
+ * credited.
122
+ */
123
+ customer: ReceivePayment.Customer;
124
+ /**
125
+ * The custom fields for the receive-payment object, added as user-defined data
126
+ * extensions, not included in the standard QuickBooks object.
127
+ */
128
+ customFields: Array<ReceivePayment.CustomField>;
129
+ /**
130
+ * The account where the funds for this receive-payment will be or have been
131
+ * deposited.
132
+ */
133
+ depositToAccount: ReceivePayment.DepositToAccount | null;
134
+ /**
135
+ * The market exchange rate between this receive-payment's currency and the home
136
+ * currency in QuickBooks at the time of this transaction. Represented as a decimal
137
+ * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
138
+ */
139
+ exchangeRate: number | null;
140
+ /**
141
+ * A globally unique identifier (GUID) you, the developer, can provide for tracking
142
+ * this object in your external system. This field is immutable and can only be set
143
+ * during object creation.
144
+ */
145
+ externalId: string | null;
146
+ /**
147
+ * A memo or note for this receive-payment that will be displayed at the beginning
148
+ * of reports containing details about this receive-payment.
149
+ */
150
+ memo: string | null;
151
+ /**
152
+ * The type of object. This value is always `"qbd_receive_payment"`.
153
+ */
154
+ objectType: 'qbd_receive_payment';
155
+ /**
156
+ * The receive-payment's payment method (e.g., cash, check, credit card).
157
+ */
158
+ paymentMethod: ReceivePayment.PaymentMethod | null;
159
+ /**
160
+ * The Accounts-Receivable (A/R) account to which this receive-payment is assigned,
161
+ * used to track the amount owed. If not specified, QuickBooks Desktop will use its
162
+ * default A/R account.
163
+ *
164
+ * **IMPORTANT**: If this receive-payment is linked to other transactions, this A/R
165
+ * account must match the `receivablesAccount` used in all linked transactions.
166
+ */
167
+ receivablesAccount: ReceivePayment.ReceivablesAccount | null;
168
+ /**
169
+ * The case-sensitive user-defined reference number for this receive-payment, which
170
+ * can be used to identify the transaction in QuickBooks. This value is not
171
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
172
+ */
173
+ refNumber: string | null;
174
+ /**
175
+ * The current QuickBooks-assigned revision number of this receive-payment object,
176
+ * which changes each time the object is modified. When updating this object, you
177
+ * must provide the most recent `revisionNumber` to ensure you're working with the
178
+ * latest data; otherwise, the update will return an error.
179
+ */
180
+ revisionNumber: string;
181
+ /**
182
+ * The total monetary amount of this receive-payment, represented as a decimal
183
+ * string.
184
+ */
185
+ totalAmount: string;
186
+ /**
187
+ * The total monetary amount of this receive-payment converted to the home currency
188
+ * of the QuickBooks company file. Represented as a decimal string.
189
+ */
190
+ totalAmountInHomeCurrency: string | null;
191
+ /**
192
+ * The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).
193
+ */
194
+ transactionDate: string;
195
+ /**
196
+ * The amount of credit that remains unused after applying credits to this
197
+ * receive-payment. This occurs when the `applyCredit.appliedAmount` specified for
198
+ * a credit memo (`applyCredit.creditMemoId`) in the `applyToTransactions` array is
199
+ * less than the total available credit amount for that credit memo.
200
+ */
201
+ unusedCredits: string | null;
202
+ /**
203
+ * The amount of this receive-payment that remains unapplied to any transactions.
204
+ * This occurs in two cases: (1) When the sum of `paymentAmount` amounts in
205
+ * `applyToTransactions` is less than `totalAmount`, leaving a portion of the
206
+ * payment unused, or (2) When a payment is received that equals the exact amount
207
+ * of an invoice, but credits or discounts are also applied, resulting in excess
208
+ * payment.
209
+ */
210
+ unusedPayment: string | null;
211
+ /**
212
+ * The date and time when this receive-payment was last updated, in ISO 8601 format
213
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
214
+ * timezone of the end-user's computer.
215
+ */
216
+ updatedAt: string;
217
+ }
218
+ export declare namespace ReceivePayment {
219
+ interface AppliedToTransaction {
220
+ /**
221
+ * The monetary amount of this receivable transaction, represented as a decimal
222
+ * string.
223
+ */
224
+ amount: string | null;
225
+ /**
226
+ * The outstanding balance of this receivable transaction after applying any
227
+ * credits or payments. Represented as a decimal string.
228
+ */
229
+ balanceRemaining: string | null;
230
+ /**
231
+ * The financial account used to track this receivable transaction's discount.
232
+ */
233
+ discountAccount: AppliedToTransaction.DiscountAccount | null;
234
+ /**
235
+ * The monetary amount by which to reduce the receivable transaction's receivable
236
+ * amount, represented as a decimal string.
237
+ */
238
+ discountAmount: string | null;
239
+ /**
240
+ * The class used to track this receivable transaction's discount.
241
+ */
242
+ discountClass: AppliedToTransaction.DiscountClass | null;
243
+ /**
244
+ * The receivable transaction's linked transactions, such as payments applied,
245
+ * credits used, or associated purchase orders.
246
+ *
247
+ * **IMPORTANT**: You must specify the parameter `includeLinkedTransactions` when
248
+ * fetching a list of receivable transactions to receive this field because it is
249
+ * not returned by default.
250
+ */
251
+ linkedTransactions: Array<AppliedToTransaction.LinkedTransaction>;
252
+ /**
253
+ * The case-sensitive user-defined reference number for this receivable
254
+ * transaction, which can be used to identify the transaction in QuickBooks. This
255
+ * value is not required to be unique and can be arbitrarily changed by the
256
+ * QuickBooks user.
257
+ */
258
+ refNumber: string | null;
259
+ /**
260
+ * The date of this receivable transaction, in ISO 8601 format (YYYY-MM-DD).
261
+ */
262
+ transactionDate: string | null;
263
+ /**
264
+ * The ID of the receivable transaction to which this payment is applied.
265
+ */
266
+ transactionId: string;
267
+ /**
268
+ * The type of transaction for this receivable transaction.
269
+ */
270
+ transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment';
271
+ }
272
+ namespace AppliedToTransaction {
273
+ /**
274
+ * The financial account used to track this receivable transaction's discount.
275
+ */
276
+ interface DiscountAccount {
277
+ /**
278
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
279
+ * across all objects of the same type, but not across different QuickBooks object
280
+ * types.
281
+ */
282
+ id: string | null;
283
+ /**
284
+ * The fully-qualified unique name for this object, formed by combining the names
285
+ * of its parent objects with its own `name`, separated by colons. Not
286
+ * case-sensitive.
287
+ */
288
+ fullName: string | null;
289
+ }
290
+ /**
291
+ * The class used to track this receivable transaction's discount.
292
+ */
293
+ interface DiscountClass {
294
+ /**
295
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
296
+ * across all objects of the same type, but not across different QuickBooks object
297
+ * types.
298
+ */
299
+ id: string | null;
300
+ /**
301
+ * The fully-qualified unique name for this object, formed by combining the names
302
+ * of its parent objects with its own `name`, separated by colons. Not
303
+ * case-sensitive.
304
+ */
305
+ fullName: string | null;
306
+ }
307
+ interface LinkedTransaction {
308
+ /**
309
+ * The unique identifier assigned by QuickBooks to this linked transaction. This ID
310
+ * is unique across all transaction types.
311
+ */
312
+ id: string;
313
+ /**
314
+ * The monetary amount of this linked transaction, represented as a decimal string.
315
+ */
316
+ amount: string | null;
317
+ /**
318
+ * Indicates the nature of the link between the transactions: `amount` denotes an
319
+ * amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes
320
+ * a quantity-based link (e.g., an invoice created from a sales order based on the
321
+ * quantity of items received).
322
+ */
323
+ linkType: 'amount' | 'quantity' | null;
324
+ /**
325
+ * The type of object. This value is always `"qbd_linked_transaction"`.
326
+ */
327
+ objectType: 'qbd_linked_transaction';
328
+ /**
329
+ * The case-sensitive user-defined reference number for this linked transaction,
330
+ * which can be used to identify the transaction in QuickBooks. This value is not
331
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
332
+ */
333
+ refNumber: string | null;
334
+ /**
335
+ * The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD).
336
+ */
337
+ transactionDate: string;
338
+ /**
339
+ * The type of transaction for this linked transaction.
340
+ */
341
+ transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment' | 'unknown';
342
+ }
343
+ }
344
+ /**
345
+ * The credit card transaction data for this receive-payment's payment when using
346
+ * QuickBooks Merchant Services (QBMS).
347
+ */
348
+ interface CreditCardTransaction {
349
+ /**
350
+ * The transaction request data originally supplied for this credit card
351
+ * transaction when using QuickBooks Merchant Services (QBMS).
352
+ */
353
+ request: CreditCardTransaction.Request | null;
354
+ /**
355
+ * The transaction response data for this credit card transaction when using
356
+ * QuickBooks Merchant Services (QBMS).
357
+ */
358
+ response: CreditCardTransaction.Response | null;
359
+ }
360
+ namespace CreditCardTransaction {
361
+ /**
362
+ * The transaction request data originally supplied for this credit card
363
+ * transaction when using QuickBooks Merchant Services (QBMS).
364
+ */
365
+ interface Request {
366
+ /**
367
+ * The card's billing address.
368
+ */
369
+ address: string | null;
370
+ /**
371
+ * The commercial card code identifies the type of business credit card being used
372
+ * (purchase, corporate, or business) for Visa and Mastercard transactions only.
373
+ * When provided, this code may qualify the transaction for lower processing fees
374
+ * compared to the standard rates that apply when no code is specified.
375
+ */
376
+ commercialCardCode: string | null;
377
+ /**
378
+ * The month when the credit card expires.
379
+ */
380
+ expirationMonth: number;
381
+ /**
382
+ * The year when the credit card expires.
383
+ */
384
+ expirationYear: number;
385
+ /**
386
+ * The cardholder's name on the card.
387
+ */
388
+ name: string | null;
389
+ /**
390
+ * The credit card number. Must be masked with lower case "x" and no dashes.
391
+ */
392
+ number: string;
393
+ /**
394
+ * The card's billing address ZIP or postal code.
395
+ */
396
+ postalCode: string | null;
397
+ /**
398
+ * Indicates whether this credit card transaction came from a card swipe
399
+ * (`card_present`) or not (`card_not_present`).
400
+ */
401
+ transactionMode: 'card_not_present' | 'card_present' | null;
402
+ /**
403
+ * The QBMS transaction type from which the current transaction data originated.
404
+ */
405
+ transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization' | null;
406
+ }
407
+ /**
408
+ * The transaction response data for this credit card transaction when using
409
+ * QuickBooks Merchant Services (QBMS).
410
+ */
411
+ interface Response {
412
+ /**
413
+ * The authorization code returned from the credit card processor to indicate that
414
+ * this charge will be paid by the card issuer.
415
+ */
416
+ authorizationCode: string | null;
417
+ /**
418
+ * Indicates whether the street address supplied in the transaction request matches
419
+ * the customer's address on file at the card issuer.
420
+ */
421
+ avsStreetStatus: 'fail' | 'not_available' | 'pass' | null;
422
+ /**
423
+ * Indicates whether the customer postal ZIP code supplied in the transaction
424
+ * request matches the customer's postal code recognized at the card issuer.
425
+ */
426
+ avsZipStatus: 'fail' | 'not_available' | 'pass' | null;
427
+ /**
428
+ * Indicates whether the card security code supplied in the transaction request
429
+ * matches the card security code recognized for that credit card number at the
430
+ * card issuer.
431
+ */
432
+ cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass' | null;
433
+ /**
434
+ * A value returned from QBMS transactions for future use by the QuickBooks
435
+ * Reconciliation feature.
436
+ */
437
+ clientTransactionId: string | null;
438
+ /**
439
+ * The ID returned from the credit card processor for this credit card transaction.
440
+ */
441
+ creditCardTransactionId: string;
442
+ /**
443
+ * The QBMS account number of the merchant who is running this transaction using
444
+ * the customer's credit card.
445
+ */
446
+ merchantAccountNumber: string;
447
+ /**
448
+ * An internal code returned by QuickBooks Merchant Services (QBMS) from the
449
+ * transaction request, needed for the QuickBooks reconciliation feature.
450
+ */
451
+ paymentGroupingCode: number | null;
452
+ /**
453
+ * Indicates whether this credit card transaction is known to have been
454
+ * successfully processed by the card issuer.
455
+ */
456
+ paymentStatus: 'completed' | 'unknown';
457
+ /**
458
+ * An internal ID returned by QuickBooks Merchant Services (QBMS) from the
459
+ * transaction request, needed for the QuickBooks reconciliation feature.
460
+ */
461
+ reconBatchId: string | null;
462
+ /**
463
+ * The status code returned in the original QBMS transaction response for this
464
+ * credit card transaction.
465
+ */
466
+ statusCode: number;
467
+ /**
468
+ * The status message returned in the original QBMS transaction response for this
469
+ * credit card transaction.
470
+ */
471
+ statusMessage: string;
472
+ /**
473
+ * An internal value for this credit card transaction, needed for the QuickBooks
474
+ * reconciliation feature.
475
+ */
476
+ transactionAuthorizationStamp: number | null;
477
+ /**
478
+ * The date and time when the credit card processor authorized this credit card
479
+ * transaction.
480
+ */
481
+ transactionAuthorizedAt: string;
482
+ }
483
+ }
484
+ /**
485
+ * The receive-payment's currency. For built-in currencies, the name and code are
486
+ * standard international values. For user-defined currencies, all values are
487
+ * editable.
488
+ */
489
+ interface Currency {
490
+ /**
491
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
492
+ * across all objects of the same type, but not across different QuickBooks object
493
+ * types.
494
+ */
495
+ id: string | null;
496
+ /**
497
+ * The fully-qualified unique name for this object, formed by combining the names
498
+ * of its parent objects with its own `name`, separated by colons. Not
499
+ * case-sensitive.
500
+ */
501
+ fullName: string | null;
502
+ }
503
+ /**
504
+ * The customer or customer-job to which the payment for this receive-payment is
505
+ * credited.
506
+ */
507
+ interface Customer {
508
+ /**
509
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
510
+ * across all objects of the same type, but not across different QuickBooks object
511
+ * types.
512
+ */
513
+ id: string | null;
514
+ /**
515
+ * The fully-qualified unique name for this object, formed by combining the names
516
+ * of its parent objects with its own `name`, separated by colons. Not
517
+ * case-sensitive.
518
+ */
519
+ fullName: string | null;
520
+ }
521
+ interface CustomField {
522
+ /**
523
+ * The name of the custom field, unique for the specified `ownerId`. For public
524
+ * custom fields, this name is visible as a label in the QuickBooks UI.
525
+ */
526
+ name: string;
527
+ /**
528
+ * The identifier of the owner of the custom field, which QuickBooks internally
529
+ * calls a "data extension". For public custom fields visible in the UI, such as
530
+ * those added by the QuickBooks user, this is always "0". For private custom
531
+ * fields that are only visible to the application that created them, this is a
532
+ * valid GUID identifying the owning application. Internally, Conductor always
533
+ * fetches all public custom fields (those with an `ownerId` of "0") for all
534
+ * objects.
535
+ */
536
+ ownerId: string;
537
+ /**
538
+ * The data type of this custom field.
539
+ */
540
+ type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
541
+ /**
542
+ * The value of this custom field. The maximum length depends on the field's data
543
+ * type.
544
+ */
545
+ value: string;
546
+ }
547
+ /**
548
+ * The account where the funds for this receive-payment will be or have been
549
+ * deposited.
550
+ */
551
+ interface DepositToAccount {
552
+ /**
553
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
554
+ * across all objects of the same type, but not across different QuickBooks object
555
+ * types.
556
+ */
557
+ id: string | null;
558
+ /**
559
+ * The fully-qualified unique name for this object, formed by combining the names
560
+ * of its parent objects with its own `name`, separated by colons. Not
561
+ * case-sensitive.
562
+ */
563
+ fullName: string | null;
564
+ }
565
+ /**
566
+ * The receive-payment's payment method (e.g., cash, check, credit card).
567
+ */
568
+ interface PaymentMethod {
569
+ /**
570
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
571
+ * across all objects of the same type, but not across different QuickBooks object
572
+ * types.
573
+ */
574
+ id: string | null;
575
+ /**
576
+ * The fully-qualified unique name for this object, formed by combining the names
577
+ * of its parent objects with its own `name`, separated by colons. Not
578
+ * case-sensitive.
579
+ */
580
+ fullName: string | null;
581
+ }
582
+ /**
583
+ * The Accounts-Receivable (A/R) account to which this receive-payment is assigned,
584
+ * used to track the amount owed. If not specified, QuickBooks Desktop will use its
585
+ * default A/R account.
586
+ *
587
+ * **IMPORTANT**: If this receive-payment is linked to other transactions, this A/R
588
+ * account must match the `receivablesAccount` used in all linked transactions.
589
+ */
590
+ interface ReceivablesAccount {
591
+ /**
592
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
593
+ * across all objects of the same type, but not across different QuickBooks object
594
+ * types.
595
+ */
596
+ id: string | null;
597
+ /**
598
+ * The fully-qualified unique name for this object, formed by combining the names
599
+ * of its parent objects with its own `name`, separated by colons. Not
600
+ * case-sensitive.
601
+ */
602
+ fullName: string | null;
603
+ }
604
+ }
605
+ export interface ReceivePaymentDeleteResponse {
606
+ /**
607
+ * The QuickBooks-assigned unique identifier of the deleted receive-payment.
608
+ */
609
+ id: string;
610
+ /**
611
+ * Indicates whether the receive-payment was deleted.
612
+ */
613
+ deleted: boolean;
614
+ /**
615
+ * The type of object. This value is always `"qbd_receive_payment"`.
616
+ */
617
+ objectType: 'qbd_receive_payment';
618
+ /**
619
+ * The case-sensitive user-defined reference number of the deleted receive-payment.
620
+ */
621
+ refNumber: string | null;
622
+ }
623
+ export interface ReceivePaymentCreateParams {
624
+ /**
625
+ * Body param: The customer or customer-job to which the payment for this
626
+ * receive-payment is credited.
627
+ */
628
+ customerId: string;
629
+ /**
630
+ * Body param: The total monetary amount of this receive-payment, represented as a
631
+ * decimal string.
632
+ *
633
+ * **NOTE**: The sum of the `paymentAmount` amounts in the `applyToTransactions`
634
+ * array cannot exceed the `totalAmount`, or you will receive an error.
635
+ */
636
+ totalAmount: string;
637
+ /**
638
+ * Body param: The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).
639
+ */
640
+ transactionDate: string;
641
+ /**
642
+ * Header param: The ID of the End-User to receive this request.
643
+ */
644
+ conductorEndUserId: string;
645
+ /**
646
+ * Body param: The invoices to be paid by this receive-payment. This will create a
647
+ * link between this receive-payment and the specified invoices.
648
+ *
649
+ * **IMPORTANT**: In each `applyToTransactions` object, you must specify either
650
+ * `paymentAmount`, `applyCredits`, `discountAmount`, or any combination of these;
651
+ * if none of these are specified, you will receive an error for an empty
652
+ * transaction.
653
+ *
654
+ * **IMPORTANT**: The target invoice must have `isPaid=false`, otherwise,
655
+ * QuickBooks will report this object as "cannot be found".
656
+ *
657
+ * **NOTE**: You must specify either `isAutoApply` or `applyToTransactions` when
658
+ * creating a receive-payment, but never both.
659
+ */
660
+ applyToTransactions?: Array<ReceivePaymentCreateParams.ApplyToTransaction>;
661
+ /**
662
+ * Body param: The credit card transaction data for this receive-payment's payment
663
+ * when using QuickBooks Merchant Services (QBMS). If specifying this field, you
664
+ * must also specify the `paymentMethod` field.
665
+ */
666
+ creditCardTransaction?: ReceivePaymentCreateParams.CreditCardTransaction;
667
+ /**
668
+ * Body param: The account where the funds for this receive-payment will be or have
669
+ * been deposited. If omitted, QuickBooks will use the default Undeposited Funds
670
+ * account.
671
+ */
672
+ depositToAccountId?: string;
673
+ /**
674
+ * Body param: The market exchange rate between this receive-payment's currency and
675
+ * the home currency in QuickBooks at the time of this transaction. Represented as
676
+ * a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
677
+ * currency).
678
+ */
679
+ exchangeRate?: number;
680
+ /**
681
+ * Body param: A globally unique identifier (GUID) you, the developer, can provide
682
+ * for tracking this object in your external system. This field is immutable and
683
+ * can only be set during object creation.
684
+ *
685
+ * **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
686
+ * QuickBooks will return an error.
687
+ */
688
+ externalId?: string;
689
+ /**
690
+ * Body param: When `true`, QuickBooks applies `totalAmount` to any outstanding
691
+ * transaction that exactly matches `totalAmount`. If no exact match is found, this
692
+ * receive-payment is applied to the oldest outstanding transaction for the
693
+ * customer-job. When `false`, QuickBooks records the payment but does not apply it
694
+ * to any specific transaction, causing the amount to appear as a credit on the
695
+ * customer-job's next transaction.
696
+ *
697
+ * **IMPORTANT**: You must specify either `isAutoApply` or `applyToTransactions`
698
+ * when creating a receive-payment, but never both.
699
+ */
700
+ isAutoApply?: boolean;
701
+ /**
702
+ * Body param: A memo or note for this receive-payment that will be displayed at
703
+ * the beginning of reports containing details about this receive-payment.
704
+ */
705
+ memo?: string;
706
+ /**
707
+ * Body param: The receive-payment's payment method (e.g., cash, check, credit
708
+ * card).
709
+ *
710
+ * **NOTE**: If this receive-payment contains credit card transaction data supplied
711
+ * from QuickBooks Merchant Services (QBMS) transaction responses, you must specify
712
+ * a credit card payment method (e.g., "Visa", "MasterCard", etc.).
713
+ */
714
+ paymentMethodId?: string;
715
+ /**
716
+ * Body param: The Accounts-Receivable (A/R) account to which this receive-payment
717
+ * is assigned, used to track the amount owed. If not specified, QuickBooks Desktop
718
+ * will use its default A/R account.
719
+ *
720
+ * **IMPORTANT**: If this receive-payment is linked to other transactions, this A/R
721
+ * account must match the `receivablesAccount` used in all linked transactions.
722
+ */
723
+ receivablesAccountId?: string;
724
+ /**
725
+ * Body param: The case-sensitive user-defined reference number for this
726
+ * receive-payment, which can be used to identify the transaction in QuickBooks.
727
+ * This value is not required to be unique and can be arbitrarily changed by the
728
+ * QuickBooks user. When left blank in this create request, this field will be left
729
+ * blank in QuickBooks (i.e., it does _not_ auto-increment).
730
+ */
731
+ refNumber?: string;
732
+ }
733
+ export declare namespace ReceivePaymentCreateParams {
734
+ interface ApplyToTransaction {
735
+ /**
736
+ * The ID of the receivable transaction to which this payment is applied.
737
+ */
738
+ transactionId: string;
739
+ /**
740
+ * Credit memos to apply to this receivable transaction, reducing its balance. This
741
+ * creates a link between this receivable transaction and the specified credit
742
+ * memos.
743
+ *
744
+ * **IMPORTANT**: By default, QuickBooks will not return any information about the
745
+ * linked transactions in this endpoint's response even when this request is
746
+ * successful. To see the transactions linked via this field, refetch the
747
+ * receivable transaction and check the `linkedTransactions` response field. If
748
+ * fetching a list of receivable transactions, you must also specify the parameter
749
+ * `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
750
+ */
751
+ applyCredits?: Array<ApplyToTransaction.ApplyCredit>;
752
+ /**
753
+ * The financial account used to track this receivable transaction's discount.
754
+ */
755
+ discountAccountId?: string;
756
+ /**
757
+ * The monetary amount by which to reduce the receivable transaction's receivable
758
+ * amount, represented as a decimal string.
759
+ */
760
+ discountAmount?: string;
761
+ /**
762
+ * The class used to track this receivable transaction's discount.
763
+ */
764
+ discountClassId?: string;
765
+ /**
766
+ * The monetary amount to apply to the receivable transaction, represented as a
767
+ * decimal string.
768
+ */
769
+ paymentAmount?: string;
770
+ }
771
+ namespace ApplyToTransaction {
772
+ interface ApplyCredit {
773
+ /**
774
+ * The amount of credit applied to this transaction. This could include customer
775
+ * deposits, payments, or credits. Represented as a decimal string.
776
+ */
777
+ appliedAmount: string;
778
+ /**
779
+ * The unique identifier of the credit transaction (credit memo or vendor credit)
780
+ * to apply to this transaction.
781
+ */
782
+ creditTransactionId: string;
783
+ /**
784
+ * Indicates whether to override the credit.
785
+ */
786
+ overrideCreditApplication?: boolean;
787
+ }
788
+ }
789
+ /**
790
+ * The credit card transaction data for this receive-payment's payment when using
791
+ * QuickBooks Merchant Services (QBMS). If specifying this field, you must also
792
+ * specify the `paymentMethod` field.
793
+ */
794
+ interface CreditCardTransaction {
795
+ /**
796
+ * The transaction request data originally supplied for this credit card
797
+ * transaction when using QuickBooks Merchant Services (QBMS).
798
+ */
799
+ request?: CreditCardTransaction.Request;
800
+ /**
801
+ * The transaction response data for this credit card transaction when using
802
+ * QuickBooks Merchant Services (QBMS).
803
+ */
804
+ response?: CreditCardTransaction.Response;
805
+ }
806
+ namespace CreditCardTransaction {
807
+ /**
808
+ * The transaction request data originally supplied for this credit card
809
+ * transaction when using QuickBooks Merchant Services (QBMS).
810
+ */
811
+ interface Request {
812
+ /**
813
+ * The month when the credit card expires.
814
+ */
815
+ expirationMonth: number;
816
+ /**
817
+ * The year when the credit card expires.
818
+ */
819
+ expirationYear: number;
820
+ /**
821
+ * The cardholder's name on the card.
822
+ */
823
+ name: string;
824
+ /**
825
+ * The credit card number. Must be masked with lower case "x" and no dashes.
826
+ */
827
+ number: string;
828
+ /**
829
+ * The card's billing address.
830
+ */
831
+ address?: string;
832
+ /**
833
+ * The commercial card code identifies the type of business credit card being used
834
+ * (purchase, corporate, or business) for Visa and Mastercard transactions only.
835
+ * When provided, this code may qualify the transaction for lower processing fees
836
+ * compared to the standard rates that apply when no code is specified.
837
+ */
838
+ commercialCardCode?: string;
839
+ /**
840
+ * The card's billing address ZIP or postal code.
841
+ */
842
+ postalCode?: string;
843
+ /**
844
+ * Indicates whether this credit card transaction came from a card swipe
845
+ * (`card_present`) or not (`card_not_present`).
846
+ */
847
+ transactionMode?: 'card_not_present' | 'card_present';
848
+ /**
849
+ * The QBMS transaction type from which the current transaction data originated.
850
+ */
851
+ transactionType?: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization';
852
+ }
853
+ /**
854
+ * The transaction response data for this credit card transaction when using
855
+ * QuickBooks Merchant Services (QBMS).
856
+ */
857
+ interface Response {
858
+ /**
859
+ * The ID returned from the credit card processor for this credit card transaction.
860
+ */
861
+ creditCardTransactionId: string;
862
+ /**
863
+ * The QBMS account number of the merchant who is running this transaction using
864
+ * the customer's credit card.
865
+ */
866
+ merchantAccountNumber: string;
867
+ /**
868
+ * Indicates whether this credit card transaction is known to have been
869
+ * successfully processed by the card issuer.
870
+ */
871
+ paymentStatus: 'completed' | 'unknown';
872
+ /**
873
+ * The status code returned in the original QBMS transaction response for this
874
+ * credit card transaction.
875
+ */
876
+ statusCode: number;
877
+ /**
878
+ * The status message returned in the original QBMS transaction response for this
879
+ * credit card transaction.
880
+ */
881
+ statusMessage: string;
882
+ /**
883
+ * The date and time when the credit card processor authorized this credit card
884
+ * transaction.
885
+ */
886
+ transactionAuthorizedAt: string;
887
+ /**
888
+ * The authorization code returned from the credit card processor to indicate that
889
+ * this charge will be paid by the card issuer.
890
+ */
891
+ authorizationCode?: string;
892
+ /**
893
+ * Indicates whether the street address supplied in the transaction request matches
894
+ * the customer's address on file at the card issuer.
895
+ */
896
+ avsStreetStatus?: 'fail' | 'not_available' | 'pass';
897
+ /**
898
+ * Indicates whether the customer postal ZIP code supplied in the transaction
899
+ * request matches the customer's postal code recognized at the card issuer.
900
+ */
901
+ avsZipStatus?: 'fail' | 'not_available' | 'pass';
902
+ /**
903
+ * Indicates whether the card security code supplied in the transaction request
904
+ * matches the card security code recognized for that credit card number at the
905
+ * card issuer.
906
+ */
907
+ cardSecurityCodeMatch?: 'fail' | 'not_available' | 'pass';
908
+ /**
909
+ * A value returned from QBMS transactions for future use by the QuickBooks
910
+ * Reconciliation feature.
911
+ */
912
+ clientTransactionId?: string;
913
+ /**
914
+ * An internal code returned by QuickBooks Merchant Services (QBMS) from the
915
+ * transaction request, needed for the QuickBooks reconciliation feature.
916
+ */
917
+ paymentGroupingCode?: number;
918
+ /**
919
+ * An internal ID returned by QuickBooks Merchant Services (QBMS) from the
920
+ * transaction request, needed for the QuickBooks reconciliation feature.
921
+ */
922
+ reconBatchId?: string;
923
+ /**
924
+ * An internal value for this credit card transaction, needed for the QuickBooks
925
+ * reconciliation feature.
926
+ */
927
+ transactionAuthorizationStamp?: number;
928
+ }
929
+ }
930
+ }
931
+ export interface ReceivePaymentRetrieveParams {
932
+ /**
933
+ * The ID of the End-User to receive this request.
934
+ */
935
+ conductorEndUserId: string;
936
+ }
937
+ export interface ReceivePaymentUpdateParams {
938
+ /**
939
+ * Body param: The current QuickBooks-assigned revision number of the
940
+ * receive-payment object you are updating, which you can get by fetching the
941
+ * object first. Provide the most recent `revisionNumber` to ensure you're working
942
+ * with the latest data; otherwise, the update will return an error.
943
+ */
944
+ revisionNumber: string;
945
+ /**
946
+ * Header param: The ID of the End-User to receive this request.
947
+ */
948
+ conductorEndUserId: string;
949
+ /**
950
+ * Body param: The invoices to be paid by this receive-payment. This will create a
951
+ * link between this receive-payment and the specified invoices.
952
+ *
953
+ * **IMPORTANT**: In each `applyToTransactions` object, you must specify either
954
+ * `paymentAmount`, `applyCredits`, `discountAmount`, or any combination of these;
955
+ * if none of these are specified, you will receive an error for an empty
956
+ * transaction.
957
+ *
958
+ * **IMPORTANT**: The target invoice must have `isPaid=false`, otherwise,
959
+ * QuickBooks will report this object as "cannot be found".
960
+ */
961
+ applyToTransactions?: Array<ReceivePaymentUpdateParams.ApplyToTransaction>;
962
+ /**
963
+ * Body param: The credit card transaction data for this receive-payment's payment
964
+ * when using QuickBooks Merchant Services (QBMS). If specifying this field, you
965
+ * must also specify the `paymentMethod` field.
966
+ */
967
+ creditCardTransaction?: ReceivePaymentUpdateParams.CreditCardTransaction;
968
+ /**
969
+ * Body param: The customer or customer-job to which the payment for this
970
+ * receive-payment is credited.
971
+ */
972
+ customerId?: string;
973
+ /**
974
+ * Body param: The account where the funds for this receive-payment will be or have
975
+ * been deposited.
976
+ */
977
+ depositToAccountId?: string;
978
+ /**
979
+ * Body param: The market exchange rate between this receive-payment's currency and
980
+ * the home currency in QuickBooks at the time of this transaction. Represented as
981
+ * a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
982
+ * currency).
983
+ */
984
+ exchangeRate?: number;
985
+ /**
986
+ * Body param: A memo or note for this receive-payment that will be displayed at
987
+ * the beginning of reports containing details about this receive-payment.
988
+ */
989
+ memo?: string;
990
+ /**
991
+ * Body param: The receive-payment's payment method (e.g., cash, check, credit
992
+ * card).
993
+ */
994
+ paymentMethodId?: string;
995
+ /**
996
+ * Body param: The Accounts-Receivable (A/R) account to which this receive-payment
997
+ * is assigned, used to track the amount owed. If not specified, QuickBooks Desktop
998
+ * will use its default A/R account.
999
+ *
1000
+ * **IMPORTANT**: If this receive-payment is linked to other transactions, this A/R
1001
+ * account must match the `receivablesAccount` used in all linked transactions.
1002
+ */
1003
+ receivablesAccountId?: string;
1004
+ /**
1005
+ * Body param: The case-sensitive user-defined reference number for this
1006
+ * receive-payment, which can be used to identify the transaction in QuickBooks.
1007
+ * This value is not required to be unique and can be arbitrarily changed by the
1008
+ * QuickBooks user.
1009
+ */
1010
+ refNumber?: string;
1011
+ /**
1012
+ * Body param: The total monetary amount of this receive-payment, represented as a
1013
+ * decimal string.
1014
+ *
1015
+ * **NOTE**: The sum of the `paymentAmount` amounts in the `applyToTransactions`
1016
+ * array cannot exceed the `totalAmount`, or you will receive an error.
1017
+ */
1018
+ totalAmount?: string;
1019
+ /**
1020
+ * Body param: The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).
1021
+ */
1022
+ transactionDate?: string;
1023
+ }
1024
+ export declare namespace ReceivePaymentUpdateParams {
1025
+ interface ApplyToTransaction {
1026
+ /**
1027
+ * The ID of the receivable transaction to which this payment is applied.
1028
+ */
1029
+ transactionId: string;
1030
+ /**
1031
+ * Credit memos to apply to this receivable transaction, reducing its balance. This
1032
+ * creates a link between this receivable transaction and the specified credit
1033
+ * memos.
1034
+ *
1035
+ * **IMPORTANT**: By default, QuickBooks will not return any information about the
1036
+ * linked transactions in this endpoint's response even when this request is
1037
+ * successful. To see the transactions linked via this field, refetch the
1038
+ * receivable transaction and check the `linkedTransactions` response field. If
1039
+ * fetching a list of receivable transactions, you must also specify the parameter
1040
+ * `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
1041
+ */
1042
+ applyCredits?: Array<ApplyToTransaction.ApplyCredit>;
1043
+ /**
1044
+ * The financial account used to track this receivable transaction's discount.
1045
+ */
1046
+ discountAccountId?: string;
1047
+ /**
1048
+ * The monetary amount by which to reduce the receivable transaction's receivable
1049
+ * amount, represented as a decimal string.
1050
+ */
1051
+ discountAmount?: string;
1052
+ /**
1053
+ * The class used to track this receivable transaction's discount.
1054
+ */
1055
+ discountClassId?: string;
1056
+ /**
1057
+ * The monetary amount to apply to the receivable transaction, represented as a
1058
+ * decimal string.
1059
+ */
1060
+ paymentAmount?: string;
1061
+ }
1062
+ namespace ApplyToTransaction {
1063
+ interface ApplyCredit {
1064
+ /**
1065
+ * The amount of credit applied to this transaction. This could include customer
1066
+ * deposits, payments, or credits. Represented as a decimal string.
1067
+ */
1068
+ appliedAmount: string;
1069
+ /**
1070
+ * The unique identifier of the credit transaction (credit memo or vendor credit)
1071
+ * to apply to this transaction.
1072
+ */
1073
+ creditTransactionId: string;
1074
+ /**
1075
+ * Indicates whether to override the credit.
1076
+ */
1077
+ overrideCreditApplication?: boolean;
1078
+ }
1079
+ }
1080
+ /**
1081
+ * The credit card transaction data for this receive-payment's payment when using
1082
+ * QuickBooks Merchant Services (QBMS). If specifying this field, you must also
1083
+ * specify the `paymentMethod` field.
1084
+ */
1085
+ interface CreditCardTransaction {
1086
+ /**
1087
+ * The transaction request data originally supplied for this credit card
1088
+ * transaction when using QuickBooks Merchant Services (QBMS).
1089
+ */
1090
+ request?: CreditCardTransaction.Request;
1091
+ /**
1092
+ * The transaction response data for this credit card transaction when using
1093
+ * QuickBooks Merchant Services (QBMS).
1094
+ */
1095
+ response?: CreditCardTransaction.Response;
1096
+ }
1097
+ namespace CreditCardTransaction {
1098
+ /**
1099
+ * The transaction request data originally supplied for this credit card
1100
+ * transaction when using QuickBooks Merchant Services (QBMS).
1101
+ */
1102
+ interface Request {
1103
+ /**
1104
+ * The card's billing address.
1105
+ */
1106
+ address?: string;
1107
+ /**
1108
+ * The commercial card code identifies the type of business credit card being used
1109
+ * (purchase, corporate, or business) for Visa and Mastercard transactions only.
1110
+ * When provided, this code may qualify the transaction for lower processing fees
1111
+ * compared to the standard rates that apply when no code is specified.
1112
+ */
1113
+ commercialCardCode?: string;
1114
+ /**
1115
+ * The month when the credit card expires.
1116
+ */
1117
+ expirationMonth?: number;
1118
+ /**
1119
+ * The year when the credit card expires.
1120
+ */
1121
+ expirationYear?: number;
1122
+ /**
1123
+ * The cardholder's name on the card.
1124
+ */
1125
+ name?: string;
1126
+ /**
1127
+ * The credit card number. Must be masked with lower case "x" and no dashes.
1128
+ */
1129
+ number?: string;
1130
+ /**
1131
+ * The card's billing address ZIP or postal code.
1132
+ */
1133
+ postalCode?: string;
1134
+ /**
1135
+ * Indicates whether this credit card transaction came from a card swipe
1136
+ * (`card_present`) or not (`card_not_present`).
1137
+ */
1138
+ transactionMode?: 'card_not_present' | 'card_present';
1139
+ /**
1140
+ * The QBMS transaction type from which the current transaction data originated.
1141
+ */
1142
+ transactionType?: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization';
1143
+ }
1144
+ /**
1145
+ * The transaction response data for this credit card transaction when using
1146
+ * QuickBooks Merchant Services (QBMS).
1147
+ */
1148
+ interface Response {
1149
+ /**
1150
+ * The authorization code returned from the credit card processor to indicate that
1151
+ * this charge will be paid by the card issuer.
1152
+ */
1153
+ authorizationCode?: string;
1154
+ /**
1155
+ * Indicates whether the street address supplied in the transaction request matches
1156
+ * the customer's address on file at the card issuer.
1157
+ */
1158
+ avsStreetStatus?: 'fail' | 'not_available' | 'pass';
1159
+ /**
1160
+ * Indicates whether the customer postal ZIP code supplied in the transaction
1161
+ * request matches the customer's postal code recognized at the card issuer.
1162
+ */
1163
+ avsZipStatus?: 'fail' | 'not_available' | 'pass';
1164
+ /**
1165
+ * Indicates whether the card security code supplied in the transaction request
1166
+ * matches the card security code recognized for that credit card number at the
1167
+ * card issuer.
1168
+ */
1169
+ cardSecurityCodeMatch?: 'fail' | 'not_available' | 'pass';
1170
+ /**
1171
+ * A value returned from QBMS transactions for future use by the QuickBooks
1172
+ * Reconciliation feature.
1173
+ */
1174
+ clientTransactionId?: string;
1175
+ /**
1176
+ * The ID returned from the credit card processor for this credit card transaction.
1177
+ */
1178
+ creditCardTransactionId?: string;
1179
+ /**
1180
+ * The QBMS account number of the merchant who is running this transaction using
1181
+ * the customer's credit card.
1182
+ */
1183
+ merchantAccountNumber?: string;
1184
+ /**
1185
+ * An internal code returned by QuickBooks Merchant Services (QBMS) from the
1186
+ * transaction request, needed for the QuickBooks reconciliation feature.
1187
+ */
1188
+ paymentGroupingCode?: number;
1189
+ /**
1190
+ * Indicates whether this credit card transaction is known to have been
1191
+ * successfully processed by the card issuer.
1192
+ */
1193
+ paymentStatus?: 'completed' | 'unknown';
1194
+ /**
1195
+ * An internal ID returned by QuickBooks Merchant Services (QBMS) from the
1196
+ * transaction request, needed for the QuickBooks reconciliation feature.
1197
+ */
1198
+ reconBatchId?: string;
1199
+ /**
1200
+ * The status code returned in the original QBMS transaction response for this
1201
+ * credit card transaction.
1202
+ */
1203
+ statusCode?: number;
1204
+ /**
1205
+ * The status message returned in the original QBMS transaction response for this
1206
+ * credit card transaction.
1207
+ */
1208
+ statusMessage?: string;
1209
+ /**
1210
+ * An internal value for this credit card transaction, needed for the QuickBooks
1211
+ * reconciliation feature.
1212
+ */
1213
+ transactionAuthorizationStamp?: number;
1214
+ /**
1215
+ * The date and time when the credit card processor authorized this credit card
1216
+ * transaction.
1217
+ */
1218
+ transactionAuthorizedAt?: string;
1219
+ }
1220
+ }
1221
+ }
1222
+ export interface ReceivePaymentListParams extends CursorPageParams {
1223
+ /**
1224
+ * Header param: The ID of the End-User to receive this request.
1225
+ */
1226
+ conductorEndUserId: string;
1227
+ /**
1228
+ * Query param: Filter for receive-payments associated with these accounts.
1229
+ */
1230
+ accountIds?: Array<string>;
1231
+ /**
1232
+ * Query param: Filter for receive-payments in these currencies.
1233
+ */
1234
+ currencyIds?: Array<string>;
1235
+ /**
1236
+ * Query param: Filter for receive-payments received from these customers.
1237
+ */
1238
+ customerIds?: Array<string>;
1239
+ /**
1240
+ * Query param: Filter for specific receive-payments by their QuickBooks-assigned
1241
+ * unique identifier(s).
1242
+ *
1243
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
1244
+ * query parameters for this request.
1245
+ *
1246
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
1247
+ * request will return an error.
1248
+ */
1249
+ ids?: Array<string>;
1250
+ /**
1251
+ * Query param: Whether to include line items in the response. Defaults to `true`.
1252
+ */
1253
+ includeLineItems?: boolean;
1254
+ /**
1255
+ * Query param: Filter for receive-payments whose `refNumber` contains this
1256
+ * substring.
1257
+ *
1258
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith`
1259
+ * or `refNumberEndsWith`.
1260
+ */
1261
+ refNumberContains?: string;
1262
+ /**
1263
+ * Query param: Filter for receive-payments whose `refNumber` ends with this
1264
+ * substring.
1265
+ *
1266
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
1267
+ * `refNumberStartsWith`.
1268
+ */
1269
+ refNumberEndsWith?: string;
1270
+ /**
1271
+ * Query param: Filter for receive-payments whose `refNumber` is greater than or
1272
+ * equal to this value. If omitted, the range will begin with the first number of
1273
+ * the list. Uses a numerical comparison for values that contain only digits;
1274
+ * otherwise, uses a lexicographical comparison.
1275
+ */
1276
+ refNumberFrom?: string;
1277
+ /**
1278
+ * Query param: Filter for specific receive-payments by their ref-number(s),
1279
+ * case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
1280
+ * be arbitrarily changed by the QuickBooks user.
1281
+ *
1282
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
1283
+ * query parameters for this request.
1284
+ *
1285
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
1286
+ * request will return an error.
1287
+ */
1288
+ refNumbers?: Array<string>;
1289
+ /**
1290
+ * Query param: Filter for receive-payments whose `refNumber` starts with this
1291
+ * substring.
1292
+ *
1293
+ * **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
1294
+ * `refNumberEndsWith`.
1295
+ */
1296
+ refNumberStartsWith?: string;
1297
+ /**
1298
+ * Query param: Filter for receive-payments whose `refNumber` is less than or equal
1299
+ * to this value. If omitted, the range will end with the last number of the list.
1300
+ * Uses a numerical comparison for values that contain only digits; otherwise, uses
1301
+ * a lexicographical comparison.
1302
+ */
1303
+ refNumberTo?: string;
1304
+ /**
1305
+ * Query param: Filter for receive-payments whose `date` field is on or after this
1306
+ * date, in ISO 8601 format (YYYY-MM-DD).
1307
+ *
1308
+ * **NOTE:** QuickBooks Desktop interprets this date as the **start of the
1309
+ * specified day** in the local timezone of the end-user's computer (e.g.,
1310
+ * `2025-01-01` → `2025-01-01T00:00:00`).
1311
+ */
1312
+ transactionDateFrom?: string;
1313
+ /**
1314
+ * Query param: Filter for receive-payments whose `date` field is on or before this
1315
+ * date, in ISO 8601 format (YYYY-MM-DD).
1316
+ *
1317
+ * **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified
1318
+ * day** in the local timezone of the end-user's computer (e.g., `2025-01-01` →
1319
+ * `2025-01-01T23:59:59`).
1320
+ */
1321
+ transactionDateTo?: string;
1322
+ /**
1323
+ * Query param: Filter for receive-payments updated on or after this date/time.
1324
+ * Accepts the following ISO 8601 formats:
1325
+ *
1326
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
1327
+ * **start of the specified day** in the local timezone of the end-user's
1328
+ * computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
1329
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
1330
+ * interprets the timestamp in the local timezone of the end-user's computer.
1331
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
1332
+ * interprets the timestamp using the specified timezone.
1333
+ */
1334
+ updatedAfter?: string;
1335
+ /**
1336
+ * Query param: Filter for receive-payments updated on or before this date/time.
1337
+ * Accepts the following ISO 8601 formats:
1338
+ *
1339
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
1340
+ * **end of the specified day** in the local timezone of the end-user's computer
1341
+ * (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
1342
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
1343
+ * interprets the timestamp in the local timezone of the end-user's computer.
1344
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
1345
+ * interprets the timestamp using the specified timezone.
1346
+ */
1347
+ updatedBefore?: string;
1348
+ }
1349
+ export interface ReceivePaymentDeleteParams {
1350
+ /**
1351
+ * The ID of the End-User to receive this request.
1352
+ */
1353
+ conductorEndUserId: string;
1354
+ }
1355
+ export declare namespace ReceivePayments {
1356
+ export { type ReceivePayment as ReceivePayment, type ReceivePaymentDeleteResponse as ReceivePaymentDeleteResponse, type ReceivePaymentsCursorPage as ReceivePaymentsCursorPage, type ReceivePaymentCreateParams as ReceivePaymentCreateParams, type ReceivePaymentRetrieveParams as ReceivePaymentRetrieveParams, type ReceivePaymentUpdateParams as ReceivePaymentUpdateParams, type ReceivePaymentListParams as ReceivePaymentListParams, type ReceivePaymentDeleteParams as ReceivePaymentDeleteParams, };
1357
+ }
1358
+ //# sourceMappingURL=receive-payments.d.mts.map