conductor-node 11.10.1 → 12.0.0-beta.1

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