conductor-node 11.10.1 → 12.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) hide show
  1. package/CHANGELOG.md +54 -0
  2. package/LICENSE +201 -21
  3. package/README.md +336 -64
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +89 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +241 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +914 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +882 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +47 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +113 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +97 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +121 -0
  87. package/index.d.ts +121 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +133 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +90 -0
  92. package/index.mjs.map +1 -0
  93. package/internal/qs/formats.d.ts +6 -0
  94. package/internal/qs/formats.d.ts.map +1 -0
  95. package/internal/qs/formats.js +11 -0
  96. package/internal/qs/formats.js.map +1 -0
  97. package/internal/qs/formats.mjs +8 -0
  98. package/internal/qs/formats.mjs.map +1 -0
  99. package/internal/qs/index.d.ts +10 -0
  100. package/internal/qs/index.d.ts.map +1 -0
  101. package/internal/qs/index.js +14 -0
  102. package/internal/qs/index.js.map +1 -0
  103. package/internal/qs/index.mjs +10 -0
  104. package/internal/qs/index.mjs.map +1 -0
  105. package/internal/qs/stringify.d.ts +3 -0
  106. package/internal/qs/stringify.d.ts.map +1 -0
  107. package/internal/qs/stringify.js +280 -0
  108. package/internal/qs/stringify.js.map +1 -0
  109. package/internal/qs/stringify.mjs +276 -0
  110. package/internal/qs/stringify.mjs.map +1 -0
  111. package/internal/qs/types.d.ts +57 -0
  112. package/internal/qs/types.d.ts.map +1 -0
  113. package/{dist/src/resources → internal/qs}/types.js +1 -0
  114. package/internal/qs/types.js.map +1 -0
  115. package/internal/qs/types.mjs +2 -0
  116. package/internal/qs/types.mjs.map +1 -0
  117. package/internal/qs/utils.d.ts +14 -0
  118. package/internal/qs/utils.d.ts.map +1 -0
  119. package/internal/qs/utils.js +229 -0
  120. package/internal/qs/utils.js.map +1 -0
  121. package/internal/qs/utils.mjs +217 -0
  122. package/internal/qs/utils.mjs.map +1 -0
  123. package/package.json +111 -35
  124. package/pagination.d.ts +18 -0
  125. package/pagination.d.ts.map +1 -0
  126. package/pagination.js +40 -0
  127. package/pagination.js.map +1 -0
  128. package/pagination.mjs +36 -0
  129. package/pagination.mjs.map +1 -0
  130. package/resource.d.ts +6 -0
  131. package/resource.d.ts.map +1 -0
  132. package/resource.js +11 -0
  133. package/resource.js.map +1 -0
  134. package/resource.mjs +7 -0
  135. package/resource.mjs.map +1 -0
  136. package/resources/auth-sessions.d.ts +79 -0
  137. package/resources/auth-sessions.d.ts.map +1 -0
  138. package/resources/auth-sessions.js +23 -0
  139. package/resources/auth-sessions.js.map +1 -0
  140. package/resources/auth-sessions.mjs +19 -0
  141. package/resources/auth-sessions.mjs.map +1 -0
  142. package/resources/end-users.d.ts +154 -0
  143. package/resources/end-users.d.ts.map +1 -0
  144. package/resources/end-users.js +48 -0
  145. package/resources/end-users.js.map +1 -0
  146. package/resources/end-users.mjs +44 -0
  147. package/resources/end-users.mjs.map +1 -0
  148. package/resources/index.d.ts +4 -0
  149. package/resources/index.d.ts.map +1 -0
  150. package/resources/index.js +11 -0
  151. package/resources/index.js.map +1 -0
  152. package/resources/index.mjs +5 -0
  153. package/resources/index.mjs.map +1 -0
  154. package/resources/qbd/accounts.d.ts +579 -0
  155. package/resources/qbd/accounts.d.ts.map +1 -0
  156. package/resources/qbd/accounts.js +54 -0
  157. package/resources/qbd/accounts.js.map +1 -0
  158. package/resources/qbd/accounts.mjs +50 -0
  159. package/resources/qbd/accounts.mjs.map +1 -0
  160. package/resources/qbd/bill-check-payments.d.ts +831 -0
  161. package/resources/qbd/bill-check-payments.d.ts.map +1 -0
  162. package/resources/qbd/bill-check-payments.js +70 -0
  163. package/resources/qbd/bill-check-payments.js.map +1 -0
  164. package/resources/qbd/bill-check-payments.mjs +65 -0
  165. package/resources/qbd/bill-check-payments.mjs.map +1 -0
  166. package/resources/qbd/bill-credit-card-payments.d.ts +641 -0
  167. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -0
  168. package/resources/qbd/bill-credit-card-payments.js +55 -0
  169. package/resources/qbd/bill-credit-card-payments.js.map +1 -0
  170. package/resources/qbd/bill-credit-card-payments.mjs +50 -0
  171. package/resources/qbd/bill-credit-card-payments.mjs.map +1 -0
  172. package/resources/qbd/bills.d.ts +2561 -0
  173. package/resources/qbd/bills.d.ts.map +1 -0
  174. package/resources/qbd/bills.js +69 -0
  175. package/resources/qbd/bills.js.map +1 -0
  176. package/resources/qbd/bills.mjs +64 -0
  177. package/resources/qbd/bills.mjs.map +1 -0
  178. package/resources/qbd/checks.d.ts +2528 -0
  179. package/resources/qbd/checks.d.ts.map +1 -0
  180. package/resources/qbd/checks.js +69 -0
  181. package/resources/qbd/checks.js.map +1 -0
  182. package/resources/qbd/checks.mjs +64 -0
  183. package/resources/qbd/checks.mjs.map +1 -0
  184. package/resources/qbd/classes.d.ts +289 -0
  185. package/resources/qbd/classes.d.ts.map +1 -0
  186. package/resources/qbd/classes.js +54 -0
  187. package/resources/qbd/classes.js.map +1 -0
  188. package/resources/qbd/classes.mjs +50 -0
  189. package/resources/qbd/classes.mjs.map +1 -0
  190. package/resources/qbd/credit-card-charges.d.ts +2236 -0
  191. package/resources/qbd/credit-card-charges.d.ts.map +1 -0
  192. package/resources/qbd/credit-card-charges.js +69 -0
  193. package/resources/qbd/credit-card-charges.js.map +1 -0
  194. package/resources/qbd/credit-card-charges.mjs +64 -0
  195. package/resources/qbd/credit-card-charges.mjs.map +1 -0
  196. package/resources/qbd/credit-card-credits.d.ts +2233 -0
  197. package/resources/qbd/credit-card-credits.d.ts.map +1 -0
  198. package/resources/qbd/credit-card-credits.js +69 -0
  199. package/resources/qbd/credit-card-credits.js.map +1 -0
  200. package/resources/qbd/credit-card-credits.mjs +64 -0
  201. package/resources/qbd/credit-card-credits.mjs.map +1 -0
  202. package/resources/qbd/credit-memos.d.ts +2649 -0
  203. package/resources/qbd/credit-memos.d.ts.map +1 -0
  204. package/resources/qbd/credit-memos.js +69 -0
  205. package/resources/qbd/credit-memos.js.map +1 -0
  206. package/resources/qbd/credit-memos.mjs +64 -0
  207. package/resources/qbd/credit-memos.mjs.map +1 -0
  208. package/resources/qbd/customers.d.ts +2106 -0
  209. package/resources/qbd/customers.d.ts.map +1 -0
  210. package/resources/qbd/customers.js +58 -0
  211. package/resources/qbd/customers.js.map +1 -0
  212. package/resources/qbd/customers.mjs +53 -0
  213. package/resources/qbd/customers.mjs.map +1 -0
  214. package/resources/qbd/date-driven-terms.d.ts +242 -0
  215. package/resources/qbd/date-driven-terms.d.ts.map +1 -0
  216. package/resources/qbd/date-driven-terms.js +43 -0
  217. package/resources/qbd/date-driven-terms.js.map +1 -0
  218. package/resources/qbd/date-driven-terms.mjs +39 -0
  219. package/resources/qbd/date-driven-terms.mjs.map +1 -0
  220. package/resources/qbd/discount-items.d.ts +576 -0
  221. package/resources/qbd/discount-items.d.ts.map +1 -0
  222. package/resources/qbd/discount-items.js +58 -0
  223. package/resources/qbd/discount-items.js.map +1 -0
  224. package/resources/qbd/discount-items.mjs +53 -0
  225. package/resources/qbd/discount-items.mjs.map +1 -0
  226. package/resources/qbd/employees.d.ts +1669 -0
  227. package/resources/qbd/employees.d.ts.map +1 -0
  228. package/resources/qbd/employees.js +58 -0
  229. package/resources/qbd/employees.js.map +1 -0
  230. package/resources/qbd/employees.mjs +53 -0
  231. package/resources/qbd/employees.mjs.map +1 -0
  232. package/resources/qbd/estimates.d.ts +2493 -0
  233. package/resources/qbd/estimates.d.ts.map +1 -0
  234. package/resources/qbd/estimates.js +69 -0
  235. package/resources/qbd/estimates.js.map +1 -0
  236. package/resources/qbd/estimates.mjs +64 -0
  237. package/resources/qbd/estimates.mjs.map +1 -0
  238. package/resources/qbd/index.d.ts +37 -0
  239. package/resources/qbd/index.d.ts.map +1 -0
  240. package/resources/qbd/index.js +105 -0
  241. package/resources/qbd/index.js.map +1 -0
  242. package/resources/qbd/index.mjs +38 -0
  243. package/resources/qbd/index.mjs.map +1 -0
  244. package/resources/qbd/inventory-adjustments.d.ts +814 -0
  245. package/resources/qbd/inventory-adjustments.d.ts.map +1 -0
  246. package/resources/qbd/inventory-adjustments.js +66 -0
  247. package/resources/qbd/inventory-adjustments.js.map +1 -0
  248. package/resources/qbd/inventory-adjustments.mjs +62 -0
  249. package/resources/qbd/inventory-adjustments.mjs.map +1 -0
  250. package/resources/qbd/inventory-assembly-items.d.ts +931 -0
  251. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -0
  252. package/resources/qbd/inventory-assembly-items.js +54 -0
  253. package/resources/qbd/inventory-assembly-items.js.map +1 -0
  254. package/resources/qbd/inventory-assembly-items.mjs +49 -0
  255. package/resources/qbd/inventory-assembly-items.mjs.map +1 -0
  256. package/resources/qbd/inventory-items.d.ts +844 -0
  257. package/resources/qbd/inventory-items.d.ts.map +1 -0
  258. package/resources/qbd/inventory-items.js +58 -0
  259. package/resources/qbd/inventory-items.js.map +1 -0
  260. package/resources/qbd/inventory-items.mjs +53 -0
  261. package/resources/qbd/inventory-items.mjs.map +1 -0
  262. package/resources/qbd/inventory-sites.d.ts +477 -0
  263. package/resources/qbd/inventory-sites.d.ts.map +1 -0
  264. package/resources/qbd/inventory-sites.js +54 -0
  265. package/resources/qbd/inventory-sites.js.map +1 -0
  266. package/resources/qbd/inventory-sites.mjs +50 -0
  267. package/resources/qbd/inventory-sites.mjs.map +1 -0
  268. package/resources/qbd/invoices.d.ts +2873 -0
  269. package/resources/qbd/invoices.d.ts.map +1 -0
  270. package/resources/qbd/invoices.js +69 -0
  271. package/resources/qbd/invoices.js.map +1 -0
  272. package/resources/qbd/invoices.mjs +64 -0
  273. package/resources/qbd/invoices.mjs.map +1 -0
  274. package/resources/qbd/journal-entries.d.ts +856 -0
  275. package/resources/qbd/journal-entries.d.ts.map +1 -0
  276. package/resources/qbd/journal-entries.js +69 -0
  277. package/resources/qbd/journal-entries.js.map +1 -0
  278. package/resources/qbd/journal-entries.mjs +64 -0
  279. package/resources/qbd/journal-entries.mjs.map +1 -0
  280. package/resources/qbd/non-inventory-items.d.ts +950 -0
  281. package/resources/qbd/non-inventory-items.d.ts.map +1 -0
  282. package/resources/qbd/non-inventory-items.js +58 -0
  283. package/resources/qbd/non-inventory-items.js.map +1 -0
  284. package/resources/qbd/non-inventory-items.mjs +53 -0
  285. package/resources/qbd/non-inventory-items.mjs.map +1 -0
  286. package/resources/qbd/payroll-wage-items.d.ts +215 -0
  287. package/resources/qbd/payroll-wage-items.d.ts.map +1 -0
  288. package/resources/qbd/payroll-wage-items.js +47 -0
  289. package/resources/qbd/payroll-wage-items.js.map +1 -0
  290. package/resources/qbd/payroll-wage-items.mjs +42 -0
  291. package/resources/qbd/payroll-wage-items.mjs.map +1 -0
  292. package/resources/qbd/purchase-orders.d.ts +2554 -0
  293. package/resources/qbd/purchase-orders.d.ts.map +1 -0
  294. package/resources/qbd/purchase-orders.js +69 -0
  295. package/resources/qbd/purchase-orders.js.map +1 -0
  296. package/resources/qbd/purchase-orders.mjs +64 -0
  297. package/resources/qbd/purchase-orders.mjs.map +1 -0
  298. package/resources/qbd/qbd.d.ts +146 -0
  299. package/resources/qbd/qbd.d.ts.map +1 -0
  300. package/resources/qbd/qbd.js +202 -0
  301. package/resources/qbd/qbd.js.map +1 -0
  302. package/resources/qbd/qbd.mjs +175 -0
  303. package/resources/qbd/qbd.mjs.map +1 -0
  304. package/resources/qbd/receive-payments.d.ts +1282 -0
  305. package/resources/qbd/receive-payments.d.ts.map +1 -0
  306. package/resources/qbd/receive-payments.js +70 -0
  307. package/resources/qbd/receive-payments.js.map +1 -0
  308. package/resources/qbd/receive-payments.mjs +65 -0
  309. package/resources/qbd/receive-payments.mjs.map +1 -0
  310. package/resources/qbd/sales-orders.d.ts +2628 -0
  311. package/resources/qbd/sales-orders.d.ts.map +1 -0
  312. package/resources/qbd/sales-orders.js +69 -0
  313. package/resources/qbd/sales-orders.js.map +1 -0
  314. package/resources/qbd/sales-orders.mjs +64 -0
  315. package/resources/qbd/sales-orders.mjs.map +1 -0
  316. package/resources/qbd/sales-receipts.d.ts +3373 -0
  317. package/resources/qbd/sales-receipts.d.ts.map +1 -0
  318. package/resources/qbd/sales-receipts.js +69 -0
  319. package/resources/qbd/sales-receipts.js.map +1 -0
  320. package/resources/qbd/sales-receipts.mjs +64 -0
  321. package/resources/qbd/sales-receipts.mjs.map +1 -0
  322. package/resources/qbd/sales-representatives.d.ts +251 -0
  323. package/resources/qbd/sales-representatives.d.ts.map +1 -0
  324. package/resources/qbd/sales-representatives.js +54 -0
  325. package/resources/qbd/sales-representatives.js.map +1 -0
  326. package/resources/qbd/sales-representatives.mjs +50 -0
  327. package/resources/qbd/sales-representatives.mjs.map +1 -0
  328. package/resources/qbd/sales-tax-codes.d.ts +306 -0
  329. package/resources/qbd/sales-tax-codes.d.ts.map +1 -0
  330. package/resources/qbd/sales-tax-codes.js +54 -0
  331. package/resources/qbd/sales-tax-codes.js.map +1 -0
  332. package/resources/qbd/sales-tax-codes.mjs +50 -0
  333. package/resources/qbd/sales-tax-codes.mjs.map +1 -0
  334. package/resources/qbd/sales-tax-items.d.ts +458 -0
  335. package/resources/qbd/sales-tax-items.d.ts.map +1 -0
  336. package/resources/qbd/sales-tax-items.js +58 -0
  337. package/resources/qbd/sales-tax-items.js.map +1 -0
  338. package/resources/qbd/sales-tax-items.mjs +53 -0
  339. package/resources/qbd/sales-tax-items.mjs.map +1 -0
  340. package/resources/qbd/service-items.d.ts +923 -0
  341. package/resources/qbd/service-items.d.ts.map +1 -0
  342. package/resources/qbd/service-items.js +58 -0
  343. package/resources/qbd/service-items.js.map +1 -0
  344. package/resources/qbd/service-items.mjs +53 -0
  345. package/resources/qbd/service-items.mjs.map +1 -0
  346. package/resources/qbd/standard-terms.d.ts +225 -0
  347. package/resources/qbd/standard-terms.d.ts.map +1 -0
  348. package/resources/qbd/standard-terms.js +43 -0
  349. package/resources/qbd/standard-terms.js.map +1 -0
  350. package/resources/qbd/standard-terms.mjs +39 -0
  351. package/resources/qbd/standard-terms.mjs.map +1 -0
  352. package/resources/qbd/subtotal-items.d.ts +323 -0
  353. package/resources/qbd/subtotal-items.d.ts.map +1 -0
  354. package/resources/qbd/subtotal-items.js +58 -0
  355. package/resources/qbd/subtotal-items.js.map +1 -0
  356. package/resources/qbd/subtotal-items.mjs +53 -0
  357. package/resources/qbd/subtotal-items.mjs.map +1 -0
  358. package/resources/qbd/transfers.d.ts +269 -0
  359. package/resources/qbd/transfers.d.ts.map +1 -0
  360. package/resources/qbd/transfers.js +58 -0
  361. package/resources/qbd/transfers.js.map +1 -0
  362. package/resources/qbd/transfers.mjs +53 -0
  363. package/resources/qbd/transfers.mjs.map +1 -0
  364. package/resources/qbd/vendor-credits.d.ts +2298 -0
  365. package/resources/qbd/vendor-credits.d.ts.map +1 -0
  366. package/resources/qbd/vendor-credits.js +69 -0
  367. package/resources/qbd/vendor-credits.js.map +1 -0
  368. package/resources/qbd/vendor-credits.mjs +64 -0
  369. package/resources/qbd/vendor-credits.mjs.map +1 -0
  370. package/resources/qbd/vendors.d.ts +1677 -0
  371. package/resources/qbd/vendors.d.ts.map +1 -0
  372. package/resources/qbd/vendors.js +58 -0
  373. package/resources/qbd/vendors.js.map +1 -0
  374. package/resources/qbd/vendors.mjs +53 -0
  375. package/resources/qbd/vendors.mjs.map +1 -0
  376. package/shims/node.d.ts +30 -0
  377. package/shims/node.d.ts.map +1 -0
  378. package/shims/node.js +31 -0
  379. package/shims/node.js.map +1 -0
  380. package/shims/node.mjs +5 -0
  381. package/shims/node.mjs.map +1 -0
  382. package/shims/web.d.ts +26 -0
  383. package/shims/web.d.ts.map +1 -0
  384. package/shims/web.js +31 -0
  385. package/shims/web.js.map +1 -0
  386. package/shims/web.mjs +5 -0
  387. package/shims/web.mjs.map +1 -0
  388. package/src/_shims/MultipartBody.ts +9 -0
  389. package/src/_shims/README.md +46 -0
  390. package/src/_shims/auto/runtime-bun.ts +4 -0
  391. package/src/_shims/auto/runtime-node.ts +4 -0
  392. package/src/_shims/auto/runtime.ts +4 -0
  393. package/src/_shims/auto/types-node.ts +4 -0
  394. package/src/_shims/auto/types.d.ts +101 -0
  395. package/src/_shims/auto/types.js +3 -0
  396. package/src/_shims/auto/types.mjs +3 -0
  397. package/src/_shims/bun-runtime.ts +14 -0
  398. package/src/_shims/index.d.ts +81 -0
  399. package/src/_shims/index.js +13 -0
  400. package/src/_shims/index.mjs +7 -0
  401. package/src/_shims/manual-types.d.ts +12 -0
  402. package/src/_shims/manual-types.js +3 -0
  403. package/src/_shims/manual-types.mjs +3 -0
  404. package/src/_shims/node-runtime.ts +81 -0
  405. package/src/_shims/node-types.d.ts +42 -0
  406. package/src/_shims/node-types.js +3 -0
  407. package/src/_shims/node-types.mjs +3 -0
  408. package/src/_shims/registry.ts +67 -0
  409. package/src/_shims/web-runtime.ts +103 -0
  410. package/src/_shims/web-types.d.ts +83 -0
  411. package/src/_shims/web-types.js +3 -0
  412. package/src/_shims/web-types.mjs +3 -0
  413. package/src/core.ts +1208 -0
  414. package/src/error.ts +130 -0
  415. package/src/index.ts +227 -0
  416. package/src/internal/qs/LICENSE.md +13 -0
  417. package/src/internal/qs/README.md +3 -0
  418. package/src/internal/qs/formats.ts +9 -0
  419. package/src/internal/qs/index.ts +13 -0
  420. package/src/internal/qs/stringify.ts +388 -0
  421. package/src/internal/qs/types.ts +71 -0
  422. package/src/internal/qs/utils.ts +265 -0
  423. package/src/lib/.keep +4 -0
  424. package/src/pagination.ts +60 -0
  425. package/src/resource.ts +11 -0
  426. package/src/resources/auth-sessions.ts +99 -0
  427. package/src/resources/end-users.ts +216 -0
  428. package/src/resources/index.ts +14 -0
  429. package/src/resources/qbd/accounts.ts +797 -0
  430. package/src/resources/qbd/bill-check-payments.ts +1086 -0
  431. package/src/resources/qbd/bill-credit-card-payments.ts +851 -0
  432. package/src/resources/qbd/bills.ts +3039 -0
  433. package/src/resources/qbd/checks.ts +3003 -0
  434. package/src/resources/qbd/classes.ts +366 -0
  435. package/src/resources/qbd/credit-card-charges.ts +2646 -0
  436. package/src/resources/qbd/credit-card-credits.ts +2643 -0
  437. package/src/resources/qbd/credit-memos.ts +3157 -0
  438. package/src/resources/qbd/customers.ts +2518 -0
  439. package/src/resources/qbd/date-driven-terms.ts +314 -0
  440. package/src/resources/qbd/discount-items.ts +712 -0
  441. package/src/resources/qbd/employees.ts +2266 -0
  442. package/src/resources/qbd/estimates.ts +2975 -0
  443. package/src/resources/qbd/index.ts +346 -0
  444. package/src/resources/qbd/inventory-adjustments.ts +1008 -0
  445. package/src/resources/qbd/inventory-assembly-items.ts +1126 -0
  446. package/src/resources/qbd/inventory-items.ts +1026 -0
  447. package/src/resources/qbd/inventory-sites.ts +605 -0
  448. package/src/resources/qbd/invoices.ts +3398 -0
  449. package/src/resources/qbd/journal-entries.ts +1051 -0
  450. package/src/resources/qbd/non-inventory-items.ts +1138 -0
  451. package/src/resources/qbd/payroll-wage-items.ts +304 -0
  452. package/src/resources/qbd/purchase-orders.ts +3045 -0
  453. package/src/resources/qbd/qbd.ts +876 -0
  454. package/src/resources/qbd/receive-payments.ts +1609 -0
  455. package/src/resources/qbd/sales-orders.ts +3141 -0
  456. package/src/resources/qbd/sales-receipts.ts +3977 -0
  457. package/src/resources/qbd/sales-representatives.ts +340 -0
  458. package/src/resources/qbd/sales-tax-codes.ts +398 -0
  459. package/src/resources/qbd/sales-tax-items.ts +583 -0
  460. package/src/resources/qbd/service-items.ts +1105 -0
  461. package/src/resources/qbd/standard-terms.ts +295 -0
  462. package/src/resources/qbd/subtotal-items.ts +430 -0
  463. package/src/resources/qbd/transfers.ts +359 -0
  464. package/src/resources/qbd/vendor-credits.ts +2742 -0
  465. package/src/resources/qbd/vendors.ts +2017 -0
  466. package/src/shims/node.ts +50 -0
  467. package/src/shims/web.ts +50 -0
  468. package/src/tsconfig.json +11 -0
  469. package/src/uploads.ts +255 -0
  470. package/src/version.ts +1 -0
  471. package/uploads.d.ts +75 -0
  472. package/uploads.d.ts.map +1 -0
  473. package/uploads.js +171 -0
  474. package/uploads.js.map +1 -0
  475. package/uploads.mjs +158 -0
  476. package/uploads.mjs.map +1 -0
  477. package/version.d.ts +2 -0
  478. package/version.d.ts.map +1 -0
  479. package/version.js +5 -0
  480. package/version.js.map +1 -0
  481. package/version.mjs +2 -0
  482. package/version.mjs.map +1 -0
  483. package/dist/package.json +0 -48
  484. package/dist/src/Client.d.ts +0 -21
  485. package/dist/src/Client.js +0 -54
  486. package/dist/src/index.d.ts +0 -11
  487. package/dist/src/index.js +0 -59
  488. package/dist/src/integrations/BaseIntegration.d.ts +0 -9
  489. package/dist/src/integrations/BaseIntegration.js +0 -14
  490. package/dist/src/integrations/qbd/QbdIntegration.d.ts +0 -3120
  491. package/dist/src/integrations/qbd/QbdIntegration.js +0 -3147
  492. package/dist/src/integrations/qbd/qbdTypes.d.ts +0 -14076
  493. package/dist/src/integrations/qbd/qbdTypes.js +0 -2
  494. package/dist/src/interceptors/errorHandling.d.ts +0 -2
  495. package/dist/src/interceptors/errorHandling.js +0 -53
  496. package/dist/src/interceptors/logging.d.ts +0 -18
  497. package/dist/src/interceptors/logging.js +0 -70
  498. package/dist/src/resources/AuthSessionsResource.d.ts +0 -77
  499. package/dist/src/resources/AuthSessionsResource.js +0 -26
  500. package/dist/src/resources/BaseResource.d.ts +0 -6
  501. package/dist/src/resources/BaseResource.js +0 -9
  502. package/dist/src/resources/EndUsersResource.d.ts +0 -84
  503. package/dist/src/resources/EndUsersResource.js +0 -57
  504. package/dist/src/resources/types.d.ts +0 -40
  505. package/dist/src/utils/checkForUpdates.d.ts +0 -2
  506. package/dist/src/utils/checkForUpdates.js +0 -65
  507. package/dist/src/utils/env.d.ts +0 -1
  508. package/dist/src/utils/env.js +0 -15
  509. package/dist/src/utils/error.d.ts +0 -184
  510. package/dist/src/utils/error.js +0 -254
@@ -1,3120 +0,0 @@
1
- import BaseIntegration from "../../integrations/BaseIntegration";
2
- import type * as QbdTypes from "../../integrations/qbd/qbdTypes";
3
- export default class QbdIntegration extends BaseIntegration {
4
- /**
5
- * An account represents a financial account, allowing customization like
6
- * sub-accounting, account numbering, and initial balance setting.
7
- */
8
- account: {
9
- /**
10
- * Perform the same activities as a user does in the QB New Account form,
11
- * which can be accessed in QB by selecting "Lists" → "Chart of Accounts" →
12
- * "Accounts" → "New".
13
- *
14
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountAdd
15
- */
16
- add: (endUserId: string, params: QbdTypes.AccountAddRq["AccountAdd"]) => Promise<NonNullable<QbdTypes.AccountAddRs["AccountRet"]>>;
17
- /**
18
- * Modifies an account.
19
- *
20
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountMod
21
- */
22
- mod: (endUserId: string, params: QbdTypes.AccountModRq["AccountMod"]) => Promise<NonNullable<QbdTypes.AccountModRs["AccountRet"]>>;
23
- /**
24
- * `AccountQuery` is a list query that returns data for all accounts that
25
- * match the provided filter criteria. Notice that it returns only data
26
- * internal to the account itself. It does not return any data about
27
- * transactions involving the account. It does, however, return the parent
28
- * account, if there is one. You can search across all accounts or you can
29
- * specify an account type and search only those.
30
- *
31
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AccountQuery
32
- */
33
- query: (endUserId: string, params?: QbdTypes.AccountQueryRq) => Promise<NonNullable<QbdTypes.AccountQueryRs["AccountRet"]>>;
34
- };
35
- /**
36
- * A credit card refund transaction is a transaction that represents a
37
- * refund of a credit card charge.
38
- */
39
- arRefundCreditCard: {
40
- /**
41
- * Adds a credit card refund transaction that is linked to one or more
42
- * QuickBooks credit memo transactions. You can link the credit card refund
43
- * to one or more of those credit transactions.
44
- *
45
- * Notice that this provides functionality over and above what the UI
46
- * provides, which currently allows a user to link only one credit card
47
- * refund to one credit transaction.
48
- *
49
- * See more:
50
- * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ARRefundCreditCardAdd
51
- */
52
- add: (endUserId: string, params: QbdTypes.ARRefundCreditCardAddRq["ARRefundCreditCardAdd"]) => Promise<NonNullable<QbdTypes.ARRefundCreditCardAddRs["ARRefundCreditCardRet"]>>;
53
- /**
54
- * Retrieves the specified credit card refund transaction or transactions.
55
- *
56
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ARRefundCreditCardQuery
57
- */
58
- query: (endUserId: string, params?: QbdTypes.ARRefundCreditCardQueryRq) => Promise<NonNullable<QbdTypes.ARRefundCreditCardQueryRs["ARRefundCreditCardRet"]>>;
59
- };
60
- /**
61
- * A bill is a transaction that represents a request-for-payment from a vendor
62
- * for goods or services that it has provided.
63
- */
64
- bill: {
65
- /**
66
- * This API provides the functionality of the QuickBooks “Enter Bills” form,
67
- * which is used when the QuickBooks user owes money to a vendor, either
68
- * through expenses incurred by the vendor (specified in the Expenses tab
69
- * within the Enter Bills form), or through receiving items (specified in
70
- * the Items tab within the Enter Bills form). When a bill is added,
71
- * QuickBooks enters the billed amount into the `AccountsPayable` register.
72
- *
73
- * The Enter Bills form can be reached in the QuickBooks UI by selecting
74
- * "Vendors" -> "Enter Bills", or by clicking on the Bill icon on the main
75
- * menubar. Notice that the `ExpenseLineAdd` aggregate maps to a line item
76
- * inside the Expense tab in the Enter Bills form, and the `ItemLineAdd`
77
- * aggregate maps to a line item inside the Item tab.
78
- *
79
- * If you are receiving items against one or more open `PurchaseOrders` for
80
- * the vendor, you can use the `LinkToTxnID` element (links in all line
81
- * items from a `PurchaseOrder`) and/or the `LinkToTxn` aggregate within a
82
- * line item (links in a specific `PurchaseOrder` line item).
83
- * - See the chapter on handling receive payment and bill payment in the QB
84
- * SDK Programmer’s Guide for complete details and rules: "The Life Cycle
85
- * of Inventory Items and Effects of Sales and Purchases".
86
- *
87
- * The value of inventory is set when an inventory item is created or
88
- * bought. QuickBooks uses cost averaging and decreases the value of the
89
- * inventory asset account at the price when the sale is recorded.
90
- *
91
- * So, lets say a company starts carrying widgets as inventory items. First
92
- * the inventory item must be created in QuickBooks. If the widgets are
93
- * already in inventory based on a purchase made that will not be recorded
94
- * in QuickBooks, the user or application would add the inventory item
95
- * description along with the quantity on hand and the value (total purchase
96
- * price) of the quantity on hand. If the purchase is to be recorded in
97
- * QuickBooks the inventory item would be created with quantity and value of
98
- * 0 (zero). Then a bill would be added to QB which would increase the
99
- * inventory quantity and value. Lets say we bought 10 widgets for $100.
100
- * QuickBooks would then consider each widget to be worth $10. The next day
101
- * a customer buys 5 widgets for $20 each. A sales receipt or invoice is
102
- * created for the purchase, the quantity of widgets is reduced by 5, to 5
103
- * and the value is reduced by $50 to $50. The inventory asset account is
104
- * reduced by $50 and the undeposited funds or accounts receivable account
105
- * is increased by $100. It appears that widgets will be a big seller, so
106
- * the small business owner goes out and buys 10 more widgets. However, the
107
- * supplier has also noticed a widget buying trend, so he’s increased the
108
- * price to $25 each. So now our quantity is increased from 5 to 15 and the
109
- * value is increased from $50 to $300, so they are considered to be worth
110
- * $20 each. After purchasing the widgets another customer decides to buy 10
111
- * widgets but the price has been raised to $50 each. After the sales
112
- * receipt or invoice is entered, the inventory is reduced to 5 and the
113
- * value
114
- *
115
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillAdd
116
- */
117
- add: (endUserId: string, params: QbdTypes.BillAddRq["BillAdd"]) => Promise<NonNullable<QbdTypes.BillAddRs["BillRet"]>>;
118
- /**
119
- * Edit an existing Bill, similar to editing a Bill in the Enter Bills form
120
- * in the QuickBooks UI.
121
- *
122
- * Notice that you cannot link a `PurchaseOrder` to an existing Bill using
123
- * the `BillMod` request. You can link to a `PurchaseOrder` only in new
124
- * Bills, using `BillAdd`.
125
- *
126
- * Notice also that some fields in a `BillMod` request cannot be cleared. If
127
- * any of the following fields is included in a bill modify request, it must
128
- * contain a value:
129
- * - `VendorRef`
130
- * - `APAccountRef`
131
- * - `TxnDate`
132
- * - `DueDate`
133
- * - `ClearExpenseLines`
134
- * - `ClearItemLines`
135
- *
136
- * Within` ExpenseLineMod`:
137
- * - `Amount`
138
- * - `BillableStatus`
139
- *
140
- * Within `ItemLineMod` or `ItemGroupMod`:
141
- * - `ItemRef`
142
- * - `Quantity`
143
- * - `Cost`
144
- * - `Amount`
145
- * - `BillableStatus`
146
- * - `OverrideItemAccountRef`
147
- *
148
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillMod
149
- */
150
- mod: (endUserId: string, params: QbdTypes.BillModRq["BillMod"]) => Promise<NonNullable<QbdTypes.BillModRs["BillRet"]>>;
151
- /**
152
- * Provides functionality found in the Find/Advanced-Find window to find
153
- * bills that are to be paid by check. The Find/Advanced-Find windows can be
154
- * reached by clicking the Find button on the main QuickBooks menubar, by
155
- * selecting "Edit" -> "Find", or simply by using the shortcut CTRL-F. Notice that
156
- * you can use the `metaData` attribute inside the query tag if you want
157
- * only a count of the bills that will be returned from the query. If you
158
- * know the bill’s transaction ID or reference number, you could use these,
159
- * or search by transaction date, or search by the date where the bill was
160
- * last modified. You can search for paid/unpaid bills by using the
161
- * `PaidStatus` flag.
162
- *
163
- * If you need additional filters, you can use the entity filter to search
164
- * for bills from a specific vendor or vendor sub (using the
165
- * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
166
- * for bills entered against a particular account (the `APAccountRef`
167
- * specified in the originating `BillAdd` request). You can specify all
168
- * subaccounts by using the various `*WithChildren` tags. For example, to
169
- * find all bills entered against Checking where you have multiple checking
170
- * accounts, you would use the `ListIDWithChildren` or
171
- * `FullNameWithChildren` tags inside your AccountFilter tags. You can
172
- * filter on the `RefNumber` or `RefNumber` range. Notice that all of these
173
- * filters can be used together (ANDed) if desired.
174
- *
175
- * If you want bill line items returned from the query, you must use the
176
- * `IncludeLineItems` tag. Notice that you don’t specify line item groups.
177
- * If line item groups were set up for the line items, the returned line
178
- * items are automatically segregated by group.
179
- *
180
- * You can get all of the linked transactions such as `PurchaseOrders` and
181
- * Credits by using the `IncludeLinkedTxns` tag. You can get public data
182
- * extensions (these are custom data whose fields can be displayed in
183
- * QuickBooks) by supplying the OwnerID tag set to 0. To get private data
184
- * extensions (custom data not displayable in QuickBooks) you must use the
185
- * `OwnerID` tag set to the known GUID value. You must know the GUID value
186
- * in order to access private data extensions.
187
- *
188
- * To prevent the return of too much data, you can use `MaxReturned` to
189
- * limit the total number of bills returned from the query. In addition, you
190
- * can limit the type of data that is returned for each bill, using
191
- * `IncludeRetElement`. Finally, you can specify whether each bill contains
192
- * line items using the `IncludeLineItems`, which by default is False (no
193
- * line item data).
194
- *
195
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillQuery
196
- */
197
- query: (endUserId: string, params?: QbdTypes.BillQueryRq) => Promise<NonNullable<QbdTypes.BillQueryRs["BillRet"]>>;
198
- };
199
- /**
200
- * A billing rate is a predefined cost rate assigned to vendors or employees.
201
- */
202
- billingRate: {
203
- /**
204
- * Adds a billing rate to the billing rate level list.
205
- *
206
- * After a billing rate is created, it can be assigned to an employee or
207
- * vendor (`VendorAdd`/`VendorMod`, `EmployeeAdd`/`EmployeeMod`) via the
208
- * `BillingRateRef` element in the appropriate request. Then, once the
209
- * billing rate is assigned to an employee or vendor, if you use that
210
- * employee or vendor in a time transaction (`TimeTrackingAdd`), then the
211
- * billing rate will override the rate specified by the service item used in
212
- * the time transaction.
213
- *
214
- * Use `FixedBillingRate` to override all service items with a fixed rate.
215
- * Use `BillingRatePerItem` to override a specific service item. If you want
216
- * to specify more than one service item, you’ll need to use one
217
- * `BillingRatePerItem` aggregate for each service item.
218
- *
219
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateAdd
220
- */
221
- add: (endUserId: string, params: QbdTypes.BillingRateAddRq["BillingRateAdd"]) => Promise<NonNullable<QbdTypes.BillingRateAddRs["BillingRateRet"]>>;
222
- /**
223
- * Returns all billing rates, or billing rates filtered by modified date, or
224
- * filtered by billing rate name, or filtered by the service item referenced
225
- * in the billing rate.
226
- *
227
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateQuery
228
- */
229
- query: (endUserId: string, params?: QbdTypes.BillingRateQueryRq) => Promise<NonNullable<QbdTypes.BillingRateQueryRs["BillingRateRet"]>>;
230
- };
231
- /**
232
- * A bill payment check is a transaction that represents a payment by check
233
- * for a bill.
234
- */
235
- billPaymentCheck: {
236
- /**
237
- * Adds a bill payment check.
238
- *
239
- * A `BillPaymentCheckAdd` request must include either `PaymentAmount`,
240
- * `SetCredit`, or `DiscountAmount` (or more than one of these). If none of
241
- * these three is included, the SDK will return an error.
242
- *
243
- * Also, the `AppliedToTxnAdd` aggregate needs both the `TxnID` and the
244
- * payment amount if you are not using the `SetCredit` sub-aggregate or
245
- * QuickBooks won’t have an amount to apply. If you are using the
246
- * `SetCredit` sub-aggregate, you’ll need to set the amount in the
247
- * `AppliedAmount` field.
248
- *
249
- * `BillPaymentCheckAdd` provides the functionality found in the Pay Bills
250
- * form in the QuickBooks UI. You can reach this form by selecting
251
- * Retail->Pay Bills from the main QuickBooks menubar. `BillPayment` is
252
- * described in detail in the chapter on handling receive payment and bill
253
- * payment in the QB SDK Programmer’s Guide. Notice that the request
254
- * requires one (but not more than one!) `BillPaymentCheckAdd` sub
255
- * aggregate, which is provided to support the SDK macro feature in this
256
- * request. Notice that you can supply only one of these sub aggregates in
257
- * the request. If you want to pay multiple bills, you must issue a separate
258
- * request for each bill pay.
259
- *
260
- * If you are using more than one A/P account, make sure that the
261
- * `APAccountRef` in the `BillPaymentCheckAdd` matches the `APAccountRef`
262
- * that was used when the `Bill` was originally added. That is, the `Bill`
263
- * was entered in a particular account payable: use that same account
264
- * payable when you pay the bill using this request.
265
- *
266
- * Notice that although you can set the `IsToBePrinted` flag, you cannot
267
- * print checks using the SDK.
268
- *
269
- * Notice that you set the check number, if desired, using the `RefNumber`
270
- * tags.
271
- *
272
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckAdd
273
- */
274
- add: (endUserId: string, params: QbdTypes.BillPaymentCheckAddRq["BillPaymentCheckAdd"]) => Promise<NonNullable<QbdTypes.BillPaymentCheckAddRs["BillPaymentCheckRet"]>>;
275
- /**
276
- * Modifies the specified bill payment check.
277
- *
278
- * Note: the `AppliedToTxnMod` aggregate needs both the `TxnID` and the
279
- * payment amount if you are not using the `SetCredit` sub-aggregate or
280
- * QuickBooks won’t have an amount to apply. If you are using the
281
- * `SetCredit` sub-aggregate, you’ll need to set the amount in the
282
- * `AppliedAmount` field.
283
- *
284
- * Generally, this is what you can do with `BillPaymentCheckMod`:
285
- * - Modify or clear the `RefNumber` or Memo.
286
- * - Modify (not clear) the `TxnDate`.
287
- * - Modify (not clear) the `BankAccountRef`
288
- * - Modify (not clear) the `IsToBePrinted` flag.
289
- * - For a bill payment check transaction that has been applied to several
290
- * existing bills, redistribute the payment amounts applied to the bills.
291
- * - Change the discount amount applied to particular bill.
292
- * - You CANNOT change the credit amount applied to a particular bill. NOT
293
- * SUPPORTED!
294
- * - Apply the payment amount to a different bill. Apply a discount, and a
295
- * credit. The existing distribution is cleared, except for any credit
296
- * that may have been applied.
297
- * - Use a `BillPaymentCheckMod` to simply apply an additional credit to a
298
- * bill. Additional payment amount is available as a credit
299
- *
300
- * Other things you need to know: When a `BillPaymentCheckMod` request is
301
- * processed, if the `AppliedToTxnMod` aggregate is specified, then the
302
- * existing payments and discounts will be cleared (but not the credits).
303
- * The original payment amount will be redistributed according to the
304
- * `AppliedToTxnMod` aggregates (0 or more) contained in the
305
- * `BillPaymentCheckMod` request. The `AppliedToTxnMod` aggregate may
306
- * specify discounts, just as does the `AppliedToTxnAdd` aggregate. These
307
- * discounts will replace any original discounts. Credits may also be
308
- * specified. But if so, then the credits will be additional credits, and
309
- * will not affect any credits that were originally applied. The existing
310
- * payments and discounts will be cleared only if `AppliedToTxnMod` is
311
- * specified in the request. This will allow clients to modify other
312
- * information without modifying the distribution of the payment.
313
- *
314
- * In summary, in the `BillPaymentCheckMod` request, in the
315
- * `AppliedToTxnMod` aggregate, discounts replace those given in the
316
- * original payment. However credits simply add to any credits that may have
317
- * been applied before.
318
- *
319
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckMod
320
- */
321
- mod: (endUserId: string, params: QbdTypes.BillPaymentCheckModRq["BillPaymentCheckMod"]) => Promise<NonNullable<QbdTypes.BillPaymentCheckModRs["BillPaymentCheckRet"]>>;
322
- /**
323
- * Returns bill payment check transactions based on the supplied query
324
- * criteria.
325
- *
326
- * Provides functionality found in the Find/Advanced-Find window to find
327
- * bill payments paid by check. The Find/Advanced-Find windows can be
328
- * reached by clicking the Find button on the main QuickBooks menubar, by
329
- * selecting "Edit" -> "Find", or simply by using the shortcut CTRL-F. Notice that
330
- * you can use the `metaData` attribute inside the query tag if you want
331
- * only a count of the bill payments that will be returned from the query.
332
- *
333
- * If you know the bill payment transaction ID or reference number, you
334
- * could use these, or search by transaction date, or search by the date
335
- * where the bill was last modified.
336
- *
337
- * If you need additional filters, you can use the entity filter to search
338
- * for bills from a specific vendor or vendor sub (using the
339
- * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
340
- * for bills entered against a particular account (the `APAccountRef`
341
- * specified in the originating `BillAdd` request). You can specify all
342
- * subaccounts by using the various `*WithChildren` tags. For example, to
343
- * find all bills entered against Checking where you have multiple checking
344
- * accounts, you would use the `ListIDWithChildren` or
345
- * `FullNameWithChildren` tags inside your `AccountFilter` tags. Finally,
346
- * you can filter on the `RefNumber` or `RefNumber` range. Notice that all
347
- * of these filters can be used together (ANDed) if desired.
348
- *
349
- * To prevent the return of too much data, you can use `MaxReturned` to
350
- * limit the total number of bills returned from the query. In addition, you
351
- * can limit the type of data that is returned for each bill, using
352
- * `IncludeRetElement`. Finally, you can specify whether each bill contains
353
- * line items using the `IncludeLineItems`, which by default is `False` (no
354
- * line item data).
355
- *
356
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckQuery
357
- */
358
- query: (endUserId: string, params?: QbdTypes.BillPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
359
- };
360
- /**
361
- * A bill payment credit card is a transaction that represents a payment by
362
- * credit card for a bill.
363
- */
364
- billPaymentCreditCard: {
365
- /**
366
- * Adds a bill payment credit card.
367
- *
368
- * A `BillPaymentCreditCardAdd` request must include either `PaymentAmount`,
369
- * `SetCredit`, or `DiscountAmount` (or more than one of these). If none of
370
- * these three is included, the SDK will return an error.
371
- *
372
- * `BillPaymentCreditCardAdd` provides functionality found in the Pay Bills
373
- * form in the QuickBooks UI. You can reach this form by selecting "Retail"
374
- * -> "Pay Bills" from the main QuickBooks menubar. `BillPayment` is
375
- * described in detail in the chapter on handling receive payment and bill
376
- * payment in the QB SDK Programmer’s Guide. Notice that the request
377
- * requires one (but not more than one!) `BillPaymentCreditCardAdd`
378
- * sub-aggregate. Notice that you can supply only one of these
379
- * sub-aggregates in the request. If you want to pay multiple bills, you
380
- * must issue a separate request for each bill pay.
381
- *
382
- * If you are using more than one A/P account, make sure that the
383
- * `APAccountRef` in the `BillPaymentCreditCardAdd` matches the
384
- * `APAccountRef` that was used when the `Bill` was originally added. That
385
- * is, the `Bill` was entered in a particular account payable: use that same
386
- * account payable when you pay the bill using this request.
387
- *
388
- * Notice that although you can set the `IsToBePrinted` flag, you cannot
389
- * print checks using the SDK.
390
- *
391
- * Finally, notice that it is possible to issue this request using only
392
- * `SetCredit` to apply an existing credit to the bill. However, if you do
393
- * this, you should be aware that no transaction ID is generated. The credit
394
- * and the bill simply are linked.
395
- *
396
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardAdd
397
- */
398
- add: (endUserId: string, params: QbdTypes.BillPaymentCreditCardAddRq["BillPaymentCreditCardAdd"]) => Promise<NonNullable<QbdTypes.BillPaymentCreditCardAddRs["BillPaymentCreditCardRet"]>>;
399
- /**
400
- * Returns bill payment credit card transactions based on the supplied query
401
- * criteria.
402
- *
403
- * Provides functionality found in the Find/Advanced Find window to find
404
- * bill payments that were paid by credit card. The Find/Advanced Find
405
- * windows can be reached by clicking the Find button on the main QuickBooks
406
- * menubar, by selecting "Edit" -> "Find", or simply by using the shortcut
407
- * CTRL-F. Notice that you can use the metaData attribute inside the query
408
- * tag if you want only a count of the bill payments that will be returned
409
- * from the query.
410
- *
411
- * If you know the bill’s transaction ID or reference number, you could use
412
- * these, or search by transaction date, or search by the date where the
413
- * bill was last modified.
414
- *
415
- * Important: If you made a bill payment by credit card, and ONLY applied a
416
- * credit using `SetCredit` (no funds were applied other than the credit),
417
- * then that payment will not be returned in this query because it is not
418
- * considered a separate transaction and has no `TxnID`. To get that kind of
419
- * payment, you must do a `BillQuery` on the original bill and specify
420
- * `IncludeLinkedTxns`. Any applied credit will be linked directly to the
421
- * bill.
422
- *
423
- * If you need additional filters, you can use the entity filter to search
424
- * for bills from a specific vendor or vendor sub (using the
425
- * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
426
- * for bills entered against a particular account (the `APAccountRef`
427
- * specified in the originating `BillAdd` request). You can specify all
428
- * subaccounts by using the various *WithChildren tags. For example, to find
429
- * all bills entered against Checking where you have multiple checking
430
- * accounts, you would use the `ListIDWithChildren` or
431
- * `FullNameWithChildren` tags inside your AccountFilter tags. Finally, you
432
- * can filter on the `RefNumber` or `RefNumber` range. Notice that all of
433
- * these filters can be used together (ANDed) if desired.
434
- *
435
- * To prevent the return of too much data, you can use `MaxReturned` to
436
- * limit the total number of bills returned from the query. In addition, you
437
- * can limit the type of data that is returned for each bill, using
438
- * `IncludeRetElement`.
439
- *
440
- * Finally, you can specify whether each bill contains line items using the
441
- * `IncludeLineItems`, which by default is `False` (no line item data).
442
- *
443
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardQuery
444
- */
445
- query: (endUserId: string, params?: QbdTypes.BillPaymentCreditCardQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCreditCardQueryRs["BillPaymentCreditCardRet"]>>;
446
- };
447
- /**
448
- * A build assembly represents an inventory item created from other inventory
449
- * items or assemblies.
450
- */
451
- buildAssembly: {
452
- /**
453
- * Adds a build assembly transaction to QuickBooks, where the specified
454
- * quantity of the specified inventory assembly item is built. If there are
455
- * insufficient quantities of items required for the build, you can have the
456
- * build marked as a pending build by using setting `MarkPendingIfRequired`
457
- * to `True`. (If you don’t and there aren’t enough quantities on hand for
458
- * the build, this request will fail.) If successful, this request results
459
- * in the decrementing of the quantities on hand amounts of each item used
460
- * in the build, and the incrementing of the on hand quantities of the built
461
- * assembly item.
462
- *
463
- * This request is supported only in Premier and Enterprise.
464
- *
465
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyAdd
466
- */
467
- add: (endUserId: string, params: QbdTypes.BuildAssemblyAddRq["BuildAssemblyAdd"]) => Promise<NonNullable<QbdTypes.BuildAssemblyAddRs["BuildAssemblyRet"]>>;
468
- /**
469
- * Modifies an existing build assembly transaction in the QuickBooks
470
- * company.
471
- *
472
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyMod
473
- */
474
- mod: (endUserId: string, params: QbdTypes.BuildAssemblyModRq["BuildAssemblyMod"]) => Promise<NonNullable<QbdTypes.BuildAssemblyModRs["BuildAssemblyRet"]>>;
475
- /**
476
- * Filters build assembly transactions by the specified filter criteria.
477
- *
478
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyQuery
479
- */
480
- query: (endUserId: string, params?: QbdTypes.BuildAssemblyQueryRq) => Promise<NonNullable<QbdTypes.BuildAssemblyQueryRs["BuildAssemblyRet"]>>;
481
- };
482
- /**
483
- * A charge contains information about a statement charge. (A credit card
484
- * charge, on the other hand, refers to a credit card charge incurred by the
485
- * QuickBooks user.)
486
- */
487
- charge: {
488
- /**
489
- * Adds a customer charge. A `Charge` contains information about a statement
490
- * charge. (A `CreditCardCharge` object, on the other hand, refers to a
491
- * credit card charge incurred by the QuickBooks user.)
492
- *
493
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeAdd
494
- */
495
- add: (endUserId: string, params: QbdTypes.ChargeAddRq["ChargeAdd"]) => Promise<NonNullable<QbdTypes.ChargeAddRs["ChargeRet"]>>;
496
- /**
497
- * Modifies the specified charge.
498
- *
499
- * Some fields in a `ChargeMod` request cannot be cleared. If any of the
500
- * following fields is included in a charge modify request, it must contain
501
- * a value:
502
- * - `CustomerRef`
503
- * - `TxnDate`
504
- * - `ItemRef`
505
- * - `Quantity`
506
- * - `Rate`
507
- * - `Amount`
508
- * - `ARAccountRef`
509
- * - `OverrideItemAccountRef`
510
- *
511
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeMod
512
- */
513
- mod: (endUserId: string, params: QbdTypes.ChargeModRq["ChargeMod"]) => Promise<NonNullable<QbdTypes.ChargeModRs["ChargeRet"]>>;
514
- /**
515
- * Returns information about statement charges.
516
- *
517
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ChargeQuery
518
- */
519
- query: (endUserId: string, params?: QbdTypes.ChargeQueryRq) => Promise<NonNullable<QbdTypes.ChargeQueryRs["ChargeRet"]>>;
520
- };
521
- /**
522
- * A check is a transaction that represents a paper check.
523
- */
524
- check: {
525
- /**
526
- * The amount of a check is the total of the amounts assigned to expense
527
- * lines and item lines. You can write a check for:
528
- * - Any expense that you track through expense accounts.
529
- * - The following types of items: fixed asset, non-inventory part, service,
530
- * and other charge.
531
- * - Putting money into your petty cash account.
532
- * - Inventory part items (if you use the inventory/purchase order feature).
533
- *
534
- * You cannot use a `CheckAdd` for any of the following:
535
- * - Paying a bill by check; instead, use a `BillPaymentCheckAdd`.
536
- * - Paying employees or create paychecks.
537
- * - Paying payroll taxes and liabilities.
538
- * - Paying sales tax.
539
- * - Paying for received items.
540
- *
541
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckAdd
542
- */
543
- add: (endUserId: string, params: QbdTypes.CheckAddRq["CheckAdd"]) => Promise<NonNullable<QbdTypes.CheckAddRs["CheckRet"]>>;
544
- /**
545
- * Modifies an existing Check. Notice that you cannot use this to modify
546
- * `BillPaymentChecks`.
547
- *
548
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
549
- */
550
- mod: (endUserId: string, params: QbdTypes.CheckModRq["CheckMod"]) => Promise<NonNullable<QbdTypes.CheckModRs["CheckRet"]>>;
551
- /**
552
- * Returns certain types of checks based on the supplied query criteria.
553
- * Note that `BillPaymentChecks`, payroll checks, and liability checks are
554
- * not returned.
555
- *
556
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckQuery
557
- */
558
- query: (endUserId: string, params?: QbdTypes.CheckQueryRq) => Promise<NonNullable<QbdTypes.CheckQueryRs["CheckRet"]>>;
559
- };
560
- /**
561
- * Classes can be used to separate transactions into meaningful categories.
562
- * (For example, transactions could be classified according to department,
563
- * business location, or type of work.)
564
- */
565
- class: {
566
- /**
567
- * Classes can be used to separate transactions into meaningful categories.
568
- * (For example, transactions could be classified according to department,
569
- * business location, or type of work.) In QuickBooks, class tracking is off
570
- * by default.
571
- *
572
- * A `ClassRef` aggregate refers to one of these named classes. For example,
573
- * in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class
574
- * into which the timed activity falls. If a `ClassRef` aggregate includes
575
- * both `FullName` and `ListID`, `FullName` will be ignored.
576
- *
577
- * In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole
578
- * invoice, that same `ClassRef` is automatically used in the line items. If
579
- * you want to clear that (that is, have NO `ClassRef` for the line item,
580
- * you can clear it in the line item by simply not specifying it in the line
581
- * item.
582
- *
583
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassAdd
584
- */
585
- add: (endUserId: string, params: QbdTypes.ClassAddRq["ClassAdd"]) => Promise<NonNullable<QbdTypes.ClassAddRs["ClassRet"]>>;
586
- /**
587
- * Modifies the specified class.
588
- *
589
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassMod
590
- */
591
- mod: (endUserId: string, params: QbdTypes.ClassModRq["ClassMod"]) => Promise<NonNullable<QbdTypes.ClassModRs["ClassRet"]>>;
592
- /**
593
- * Queries for existing classes.
594
- *
595
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ClassQuery
596
- */
597
- query: (endUserId: string, params?: QbdTypes.ClassQueryRq) => Promise<NonNullable<QbdTypes.ClassQueryRs["ClassRet"]>>;
598
- };
599
- /**
600
- * The company refers to the end-user's business entity within QuickBooks
601
- * Desktop.
602
- */
603
- company: {
604
- /**
605
- * Returns detailed information about a QuickBooks company file, such as the
606
- * company’s address and legal name, certain preferences that are set, and
607
- * any services that the company is subscribed to, such as payroll,
608
- * QuickBooks Merchant Services, and so forth.
609
- *
610
- * Company information cannot be added or modified through the SDK, only
611
- * through the QuickBooks user interface
612
- *
613
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CompanyQuery
614
- */
615
- query: (endUserId: string, params?: QbdTypes.CompanyQueryRq) => Promise<NonNullable<QbdTypes.CompanyQueryRs["CompanyRet"]>>;
616
- };
617
- /**
618
- * A credit card charge is a general charge incurred when a QuickBooks user
619
- * makes a purchase using a credit card. Credit card charges for purchases can
620
- * be tracked as expenses (in expense accounts) or as items.
621
- */
622
- creditCardCharge: {
623
- /**
624
- * A credit card charge is a general charge incurred when a QuickBooks user
625
- * makes a purchase using a credit card. Credit card charges for purchases
626
- * can be tracked as expenses (in expense accounts) or as items.
627
- *
628
- * The current balance on the credit card becomes part of the accounts
629
- * payable balance. If a balance is carried on the credit card across time,
630
- * finance or interest charges can be tracked in QuickBooks.
631
- *
632
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeAdd
633
- */
634
- add: (endUserId: string, params: QbdTypes.CreditCardChargeAddRq["CreditCardChargeAdd"]) => Promise<NonNullable<QbdTypes.CreditCardChargeAddRs["CreditCardChargeRet"]>>;
635
- /**
636
- * The Credit Card charge mod request allows you to modify an existing
637
- * credit card charge transaction using the SDK. You can modify most of the
638
- * fields that can be modified in the QuickBooks UI. That is, this request
639
- * can be used to modify Purchased from, date, credit card and modify lines
640
- * from the item table and the expense table.
641
- *
642
- * The following list describes what you can and cannot due with this
643
- * request:
644
- * - You can modify or clear the following fields: Ref Num and Memo
645
- * - You can modify (not clear) transaction date
646
- * - You can change the credit card account to support the scenario where
647
- * the credit card transaction was created and posted to the wrong credit
648
- * card account (impacts your accounting).
649
- * - You can modify the Purchase from field (Payee Name) to change the Payee
650
- * Name on the credit card transaction to a different name (employee, job,
651
- * customer, vendor, other name). This field cannot be cleared since it is
652
- * required by QB business logic
653
- * - You cannot modify the amount due directly! (However the amount due will
654
- * change when you modify the transaction lines.)
655
- * - You cannot change a Charge to a Credit.
656
- * - You cannot Void the charge. Use TxnVoid instead.
657
- * - You can clear the entire expense table or the entire item table, but
658
- * you cannot clear both tables at the same time.
659
- *
660
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeMod
661
- */
662
- mod: (endUserId: string, params: QbdTypes.CreditCardChargeModRq["CreditCardChargeMod"]) => Promise<NonNullable<QbdTypes.CreditCardChargeModRs["CreditCardChargeRet"]>>;
663
- /**
664
- * Queries for the specified credit card charge or charges.
665
- *
666
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardChargeQuery
667
- */
668
- query: (endUserId: string, params?: QbdTypes.CreditCardChargeQueryRq) => Promise<NonNullable<QbdTypes.CreditCardChargeQueryRs["CreditCardChargeRet"]>>;
669
- };
670
- /**
671
- * A credit card credit is a credit card refund issued to a customer.
672
- */
673
- creditCardCredit: {
674
- /**
675
- * If a QuickBooks user returns merchandise and receives credit, the credit
676
- * is entered in QuickBooks and assigned to the appropriate expense account.
677
- * Typically, the assigned expense account reflects the same account,
678
- * customer, and class that were assigned when the merchandise was first
679
- * purchased. (The original purchase would be described by a
680
- * `CreditCardCharge` message.)
681
- *
682
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditAdd
683
- */
684
- add: (endUserId: string, params: QbdTypes.CreditCardCreditAddRq["CreditCardCreditAdd"]) => Promise<NonNullable<QbdTypes.CreditCardCreditAddRs["CreditCardCreditRet"]>>;
685
- /**
686
- * The Credit Card credit mod request allows you to modify an existing
687
- * credit card credit transaction using the SDK. You can modify most of the
688
- * fields that can be modified in the QuickBooks UI. That is, this request
689
- * can be used to modify Purchased from, date, credit card and modify lines
690
- * from the item table and the expense table.
691
- *
692
- * The following list describes what you can and cannot due with this
693
- * request:
694
- * - You can modify or clear the following fields: Ref Num and Memo
695
- * - You can modify (not clear) transaction date
696
- * - You can change the credit card account to support the scenario where
697
- * the credit card transaction was created and posted to the wrong credit
698
- * card account (impacts your accounting).
699
- * - You can modify the Purchase from field (Payee Name) to change the Payee
700
- * Name on the credit card transaction to a different name (employee, job,
701
- * customer, vendor, other name). This field cannot be cleared since it is
702
- * required by QB business logic
703
- * - You cannot modify the amount due directly! (However the amount due will
704
- * change when you modify the transaction lines.)
705
- * - You cannot change a Credit to a Charge.
706
- * - You cannot Void the credit. Use TxnVoid instead.
707
- * - You can clear the entire expense table or the entire item table, but
708
- * you cannot clear both tables at the same time.
709
- *
710
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditMod
711
- */
712
- mod: (endUserId: string, params: QbdTypes.CreditCardCreditModRq["CreditCardCreditMod"]) => Promise<NonNullable<QbdTypes.CreditCardCreditModRs["CreditCardCreditRet"]>>;
713
- /**
714
- * Queries for the specified credit or set of credits.
715
- *
716
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditCardCreditQuery
717
- */
718
- query: (endUserId: string, params?: QbdTypes.CreditCardCreditQueryRq) => Promise<NonNullable<QbdTypes.CreditCardCreditQueryRs["CreditCardCreditRet"]>>;
719
- };
720
- /**
721
- * A credit memo specifies an amount that you owe your customer for some
722
- * reason, such as overpayment against an invoice, returned merchandise, or
723
- * for some pre-payment. It reduces a customer’s outstanding balance.
724
- *
725
- * Do not confuse a credit memo with a vendor credit, which specifies an
726
- * amount that a vendor owes you.
727
- */
728
- creditMemo: {
729
- /**
730
- * Adds a credit memo. A credit memo specifies an amount that you owe your
731
- * customer for some reason, such as overpayment against an invoice,
732
- * returned merchandise, or for some pre-payment. It reduces a customer’s
733
- * outstanding balance. The `CreditMemo` doesn’t actually get applied until
734
- * is referenced in a `ReceivePayment` transaction inside the `SetCredit`
735
- * aggregate.
736
- *
737
- * The `CreditMemo` should not be confused with a `VendorCredit`, which
738
- * specifies an amount that a vendor owes you.
739
- *
740
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoAdd
741
- */
742
- add: (endUserId: string, params: QbdTypes.CreditMemoAddRq["CreditMemoAdd"]) => Promise<NonNullable<QbdTypes.CreditMemoAddRs["CreditMemoRet"]>>;
743
- /**
744
- * Modifies an existing credit memo.
745
- *
746
- * Some fields in a CreditMemoMod request cannot be cleared. If any of the
747
- * following fields is included in a credit-memo modify request, it must
748
- * contain a value:
749
- * - `CustomerRef`
750
- * - `ARAccountRef`
751
- * - `TemplateRef`
752
- * - `TxnDate`
753
- * - `IsPending`
754
- * - `DueDate`
755
- * - `ShipDate`
756
- * - `ItemSalesTaxRef`
757
- * - `IsToBePrinted`
758
- *
759
- * Within `CreditMemoLineMod` or `CreditMemoLineGroupMod`:
760
- * - `ItemRef`
761
- * - `Quantity`
762
- * - `Rate`
763
- * - `Amount`
764
- * - `SalesTaxCodeRef`
765
- * - `OverrideItemAccountRef`
766
- *
767
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoMod
768
- */
769
- mod: (endUserId: string, params: QbdTypes.CreditMemoModRq["CreditMemoMod"]) => Promise<NonNullable<QbdTypes.CreditMemoModRs["CreditMemoRet"]>>;
770
- /**
771
- * Queries for the specified credit memo or set of credit memos.
772
- *
773
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoQuery
774
- */
775
- query: (endUserId: string, params?: QbdTypes.CreditMemoQueryRq) => Promise<NonNullable<QbdTypes.CreditMemoQueryRs["CreditMemoRet"]>>;
776
- };
777
- /**
778
- * A currency is custom currency defined by the user.
779
- */
780
- currency: {
781
- /**
782
- * Adds a user-defined currency with the specified name and currency code.
783
- *
784
- * Currencies created by users are distinguished from the built-in QB
785
- * currencies in the `CurrencyRet` object: they are identified as
786
- * user-defined. User-defined currencies do not get their exchange rates
787
- * updated automatically by QuickBooks. You’ll always need to manually
788
- * update the exchange rates. However, other than this, these type of
789
- * currencies function within QB in the same way as the built-in currencies.
790
- * If you have not used a user-defined currency in a transaction, you can
791
- * delete it using `ListDel`. You cannot delete the built-in QB currencies.
792
- *
793
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CurrencyAdd
794
- */
795
- add: (endUserId: string, params: QbdTypes.CurrencyAddRq["CurrencyAdd"]) => Promise<NonNullable<QbdTypes.CurrencyAddRs["CurrencyRet"]>>;
796
- /**
797
- * Modifies an existing currency.
798
- *
799
- * This request is used primarily for changing the `IsActive` status of the
800
- * built-in QuickBooks currencies. However, it can also be used to modify
801
- * anything in user-defined currencies. When used on a built-in currency,
802
- * this request cannot modify name or currency code, neither of which can be
803
- * modified in the UI either.
804
- *
805
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CurrencyMod
806
- */
807
- mod: (endUserId: string, params: QbdTypes.CurrencyModRq["CurrencyMod"]) => Promise<NonNullable<QbdTypes.CurrencyModRs["CurrencyRet"]>>;
808
- /**
809
- * Queries for built-in and user-defined currencies.
810
- *
811
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CurrencyQuery
812
- */
813
- query: (endUserId: string, params?: QbdTypes.CurrencyQueryRq) => Promise<NonNullable<QbdTypes.CurrencyQueryRs["CurrencyRet"]>>;
814
- };
815
- /**
816
- * Customers refer to both the QuickBooks user’s customers and the individual
817
- * jobs that are being performed for them.
818
- */
819
- customer: {
820
- /**
821
- * The customer list includes information about the QuickBooks user’s
822
- * customers and the individual jobs that are being performed for them. A
823
- * `CustomerRef` aggregate refers to one of the customers (or customer jobs)
824
- * on the list. In a request, if a `CustomerRef` aggregate includes both
825
- * `FullName` and `ListID`, `FullName` will be ignored. Special cases to
826
- * note:
827
- *
828
- * - In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers
829
- * to the customer or customer job to which the payment is credited.
830
- *
831
- * - In a `TimeTracking` request, CustomerRef refers to the customer or
832
- * customer job to which this time could be billed. If `IsBillable` is set
833
- * to true, `CustomerRef` is required in `TimeTrackingAdd`.
834
- *
835
- * - In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P
836
- * account, `CustomerRef` must refer to a vendor (not to a customer). If
837
- * `AccountRef` refers to any other type of account, the `CustomerRef`
838
- * must refer to a customer.
839
- *
840
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerAdd
841
- */
842
- add: (endUserId: string, params: QbdTypes.CustomerAddRq["CustomerAdd"]) => Promise<NonNullable<QbdTypes.CustomerAddRs["CustomerRet"]>>;
843
- /**
844
- * Modifies the customer record.
845
- *
846
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerMod
847
- */
848
- mod: (endUserId: string, params: QbdTypes.CustomerModRq["CustomerMod"]) => Promise<NonNullable<QbdTypes.CustomerModRs["CustomerRet"]>>;
849
- /**
850
- * Returns data for the specified customers.
851
- *
852
- * Important: We highly recommend that you use the `IncludeRetElement` tag
853
- * in your `CustomerQuery` to include any data you want but do NOT include
854
- * the `ShipAddress` data in the `Response`, unless you need to get the
855
- * shipping address for a particular customer. Excluding the shipping
856
- * address data will significantly improve the performance of the
857
- * `CustomerQuery`.
858
- *
859
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerQuery
860
- */
861
- query: (endUserId: string, params?: QbdTypes.CustomerQueryRq) => Promise<NonNullable<QbdTypes.CustomerQueryRs["CustomerRet"]>>;
862
- };
863
- /**
864
- * Customer types allow business owners to categorize customers in ways that
865
- * are meaningful for their businesses. For example, a customer type might
866
- * indicate which industry a customer represents, or which part of the country
867
- * a customer is in.
868
- */
869
- customerType: {
870
- /**
871
- * Customer types allow business owners to categorize customers in ways that
872
- * are meaningful for their businesses. For example, a customer type might
873
- * indicate which industry a customer represents, or which part of the
874
- * country a customer is in.
875
- *
876
- * A `CustomerTypeRef` aggregate refers to one of the types on the
877
- * CustomerType list. In a request, if a `CustomerTypeRef` aggregate
878
- * includes both `FullName` and `ListID`, `FullName` will be ignored.
879
- *
880
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerTypeAdd
881
- */
882
- add: (endUserId: string, params: QbdTypes.CustomerTypeAddRq["CustomerTypeAdd"]) => Promise<NonNullable<QbdTypes.CustomerTypeAddRs["CustomerTypeRet"]>>;
883
- /**
884
- * Queries for the specified customer type or set of types.
885
- *
886
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomerTypeQuery
887
- */
888
- query: (endUserId: string, params?: QbdTypes.CustomerTypeQueryRq) => Promise<NonNullable<QbdTypes.CustomerTypeQueryRs["CustomerTypeRet"]>>;
889
- };
890
- /**
891
- * A data extension is a custom field that you can add to a list object,
892
- * transaction, or transaction line item.
893
- */
894
- dataExt: {
895
- /**
896
- * Writes data to one data extension (i.e., custom field in QuickBooks).
897
- * This request can only be invoked if a data extension definition has
898
- * already been defined for the target object type. That is, before you can
899
- * perform the `DataExtAdd` on a particular customer, say John Henry, the
900
- * data extension must already be defined for the `Customer` object. Notice
901
- * that a data extension definition can be defined in either of two ways:
902
- * via `DataExtDefAdd` as already described, or via the QuickBooks UI by the
903
- * user specifying a custom field. Only custom fields can be defined through
904
- * the UI, not private data extensions.
905
- *
906
- * `DataExtAdd` adds a custom field (if `OwnerID` is set to 0) or a private
907
- * data extension (if `OwnerID` is set to a GUID) containing the specified
908
- * value. The custom field or private data extension and value is added to
909
- * the specified list object, or transaction, or transaction line item.
910
- *
911
- * `DataExtAdd` will return error 3180 if you invoke this on a custom data
912
- * ext definition that has been deleted and then re-added from the UI. (You
913
- * can’t re-add a deleted data ext def via the SDK.) However, you can use
914
- * `DataExtMod` to write data to that re-added data ext def.
915
- *
916
- * Important: If you want to perform a `DataExtAdd` on a transaction line
917
- * item, you should use custom fields instead of private data extensions
918
- * because only custom field data will be returned in queries. Currently,
919
- * private data is not returned.
920
- *
921
- * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
922
- * for the parent object. For example invoking one of these on a `Customer`
923
- * causes a `Customer` Modify event. The Time Modified value for that parent
924
- * object is also updated.
925
- *
926
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtAdd
927
- */
928
- add: (endUserId: string, params: QbdTypes.DataExtAddRq["DataExtAdd"]) => Promise<NonNullable<QbdTypes.DataExtAddRs["DataExtRet"]>>;
929
- /**
930
- * This request can only be invoked if a data extension definition has
931
- * already been added to the target object (for example, the customer John
932
- * Henry) by a `DataExtDefAdd` or by the user specifying a custom field
933
- * value for that object via the QuickBooks UI.
934
- *
935
- * If you want to clear the data extension value (to make the custom field
936
- * or private extension blank), you must use `DataExtDel`. The `DataExtMod`
937
- * request cannot be used to clear the field.
938
- *
939
- * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
940
- * for the parent object. For example invoking one of these on a `Customer`
941
- * causes a `Customer` Modify event. The Time Modified value for that parent
942
- * object is also updated.
943
- *
944
- * Notice that the Mod operation does not support macros like `DataExtAdd`
945
- * does.
946
- *
947
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtMod
948
- */
949
- mod: (endUserId: string, params: QbdTypes.DataExtModRq["DataExtMod"]) => Promise<NonNullable<QbdTypes.DataExtModRs["DataExtRet"]>>;
950
- };
951
- /**
952
- * Date-driven terms show the day of the month by which payment is due and can
953
- * include a discount for early payment. Payments with standard terms, on the
954
- * other hand, are due within a certain number of days.
955
- */
956
- dateDrivenTerms: {
957
- /**
958
- * Date-driven terms show the day of the month by which payment is due and
959
- * can include a discount for early payment. For example, the following
960
- * date-driven term means that payment is due on the 30th of the month, with
961
- * a 1% discount if payment is made by the 10th: "1% 10 Net 30".
962
- *
963
- * Payments with standard terms, on the other hand, are due within a certain
964
- * number of days.
965
- *
966
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DateDrivenTermsAdd
967
- */
968
- add: (endUserId: string, params: QbdTypes.DateDrivenTermsAddRq["DateDrivenTermsAdd"]) => Promise<NonNullable<QbdTypes.DateDrivenTermsAddRs["DateDrivenTermsRet"]>>;
969
- /**
970
- * Queries for the specified date-driven terms or set of terms.
971
- *
972
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DateDrivenTermsQuery
973
- */
974
- query: (endUserId: string, params?: QbdTypes.DateDrivenTermsQueryRq) => Promise<NonNullable<QbdTypes.DateDrivenTermsQueryRs["DateDrivenTermsRet"]>>;
975
- };
976
- /**
977
- * A deposit is a non-posting transaction that you can use to group payments
978
- * together. You can also use a deposit to deposit payments directly into a
979
- * QuickBooks bank account.
980
- */
981
- deposit: {
982
- /**
983
- * After you receive payments from customers (see `ReceivePayment`), you can
984
- * use the `DepositAdd` request to either deposit each payment directly into
985
- * a QuickBooks bank account or you can group payments together. You can
986
- * also choose the method you prefer for depositing payments.
987
- *
988
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositAdd
989
- */
990
- add: (endUserId: string, params: QbdTypes.DepositAddRq["DepositAdd"]) => Promise<NonNullable<QbdTypes.DepositAddRs["DepositRet"]>>;
991
- /**
992
- * Modifies an existing deposit.
993
- *
994
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositMod
995
- */
996
- mod: (endUserId: string, params: QbdTypes.DepositModRq["DepositMod"]) => Promise<NonNullable<QbdTypes.DepositModRs["DepositRet"]>>;
997
- /**
998
- * This request searches for deposits that match the supplied filters.
999
- *
1000
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositQuery
1001
- */
1002
- query: (endUserId: string, params?: QbdTypes.DepositQueryRq) => Promise<NonNullable<QbdTypes.DepositQueryRs["DepositRet"]>>;
1003
- };
1004
- /**
1005
- * An employee is a person who works for a company. An employee can be a
1006
- * salaried employee, an hourly employee, or a contractor. An employee can
1007
- * also be a vendor.
1008
- */
1009
- employee: {
1010
- /**
1011
- * Adds an employee with personal data about the employee as well as certain
1012
- * payroll-related data.
1013
- *
1014
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeAdd
1015
- */
1016
- add: (endUserId: string, params: QbdTypes.EmployeeAddRq["EmployeeAdd"]) => Promise<NonNullable<QbdTypes.EmployeeAddRs["EmployeeRet"]>>;
1017
- /**
1018
- * Modifies an existing employee.
1019
- *
1020
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeMod
1021
- */
1022
- mod: (endUserId: string, params: QbdTypes.EmployeeModRq["EmployeeMod"]) => Promise<NonNullable<QbdTypes.EmployeeModRs["EmployeeRet"]>>;
1023
- /**
1024
- * Returns employee data.
1025
- *
1026
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EmployeeQuery
1027
- */
1028
- query: (endUserId: string, params?: QbdTypes.EmployeeQueryRq) => Promise<NonNullable<QbdTypes.EmployeeQueryRs["EmployeeRet"]>>;
1029
- };
1030
- /**
1031
- * A QuickBooks estimate is a description of a sale that the QuickBooks user
1032
- * proposes to make to a current or prospective customer. An estimate might
1033
- * also be called a “bid” or a “proposal.” In QuickBooks, estimates and
1034
- * invoices use similar fields, and an estimate can be converted into an
1035
- * invoice after the customer accepts the estimate.
1036
- *
1037
- * An estimate is a non-posting transaction, so it does not affect a company’s
1038
- * balance sheet or income statement.
1039
- */
1040
- estimate: {
1041
- /**
1042
- * Adds an estimate. A QuickBooks estimate is a description of a sale that
1043
- * the QuickBooks user proposes to make to a current or prospective
1044
- * customer. An estimate might also be called a “bid” or a “proposal.” In
1045
- * QuickBooks, estimates and invoices use similar fields, and an estimate
1046
- * can be converted into an invoice after the customer accepts the estimate.
1047
- *
1048
- * An estimate is a non-posting transaction, so it does not affect a
1049
- * company’s balance sheet or income statement.
1050
- *
1051
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateAdd
1052
- */
1053
- add: (endUserId: string, params: QbdTypes.EstimateAddRq["EstimateAdd"]) => Promise<NonNullable<QbdTypes.EstimateAddRs["EstimateRet"]>>;
1054
- /**
1055
- * Modifies the specified estimate.
1056
- *
1057
- * Some fields in an `EstimateMod` request cannot be cleared. If any of the
1058
- * following fields is included in an estimate modify request, it must
1059
- * contain a value:
1060
- * - `CustomerRef`
1061
- * - `TemplateRef`
1062
- * - `TxnDate`
1063
- * - `IsActive`
1064
- * - `CreateChangeOrder`
1065
- * - `DueDate`
1066
- * - `ItemSalesTaxRef`
1067
- *
1068
- * Within `EstimateLineMod` or `EstimateLineGroupMod`:
1069
- * - `ItemRef`
1070
- * - `Quantity`
1071
- * - `Rate`
1072
- * - `Amount`>
1073
- * - `SalesTaxCodeRef`
1074
- * - `Markup`
1075
- *
1076
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateMod
1077
- */
1078
- mod: (endUserId: string, params: QbdTypes.EstimateModRq["EstimateMod"]) => Promise<NonNullable<QbdTypes.EstimateModRs["EstimateRet"]>>;
1079
- /**
1080
- * Queries for the specified estimate or set of estimates.
1081
- *
1082
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/EstimateQuery
1083
- */
1084
- query: (endUserId: string, params?: QbdTypes.EstimateQueryRq) => Promise<NonNullable<QbdTypes.EstimateQueryRs["EstimateRet"]>>;
1085
- };
1086
- /**
1087
- * An inventory adjustment is a non-posting transaction that you can use to
1088
- * adjust the quantity or value of an inventory item
1089
- */
1090
- inventoryAdjustment: {
1091
- /**
1092
- * Adds an inventory adjustment.
1093
- *
1094
- * If the following conditions aren’t met, you will receive an error if you
1095
- * try to add an inventory adjustment through the SDK:
1096
- * - The QuickBooks company file must be open in single-user mode, unless
1097
- * you are using QuickBooks Enterprise edition, which allows multi-user
1098
- * mode for this request. (This is also true in the user interface: you
1099
- * cannot adjust the inventory while the company file is open in
1100
- * multi-user mode, again except for Enterprise.)
1101
- * - The inventory adjustment form must be closed in the QuickBooks user
1102
- * interface.
1103
- *
1104
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentAdd
1105
- */
1106
- add: (endUserId: string, params: QbdTypes.InventoryAdjustmentAddRq["InventoryAdjustmentAdd"]) => Promise<NonNullable<QbdTypes.InventoryAdjustmentAddRs["InventoryAdjustmentRet"]>>;
1107
- /**
1108
- * Modifies an inventory adjustment.
1109
- *
1110
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentMod
1111
- */
1112
- mod: (endUserId: string, params: QbdTypes.InventoryAdjustmentModRq["InventoryAdjustmentMod"]) => Promise<NonNullable<QbdTypes.InventoryAdjustmentModRs["InventoryAdjustmentRet"]>>;
1113
- /**
1114
- * Queries for the specified inventory adjustment or set of inventory
1115
- * adjustments.
1116
- *
1117
- * You cannot query an inventory adjustment while the inventory adjustment
1118
- * form is open in the QuickBooks user interface.
1119
- *
1120
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventoryAdjustmentQuery
1121
- */
1122
- query: (endUserId: string, params?: QbdTypes.InventoryAdjustmentQueryRq) => Promise<NonNullable<QbdTypes.InventoryAdjustmentQueryRs["InventoryAdjustmentRet"]>>;
1123
- };
1124
- /**
1125
- * An inventory site is a location where inventory is stored. For example, a
1126
- * company might have a warehouse, a stockroom, and a showroom, each of which
1127
- * is an inventory site.
1128
- */
1129
- inventorySite: {
1130
- /**
1131
- * Adds an inventory site.
1132
- *
1133
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteAdd
1134
- */
1135
- add: (endUserId: string, params: QbdTypes.InventorySiteAddRq["InventorySiteAdd"]) => Promise<NonNullable<QbdTypes.InventorySiteAddRs["InventorySiteRet"]>>;
1136
- /**
1137
- * Modifies an inventory site.
1138
- *
1139
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteMod
1140
- */
1141
- mod: (endUserId: string, params: QbdTypes.InventorySiteModRq["InventorySiteMod"]) => Promise<NonNullable<QbdTypes.InventorySiteModRs["InventorySiteRet"]>>;
1142
- /**
1143
- * Queries for the specified inventory site or set of inventory sites.
1144
- *
1145
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InventorySiteQuery
1146
- */
1147
- query: (endUserId: string, params?: QbdTypes.InventorySiteQueryRq) => Promise<NonNullable<QbdTypes.InventorySiteQueryRs["InventorySiteRet"]>>;
1148
- };
1149
- /**
1150
- * An invoice records the amount owed by a customer who purchased goods or
1151
- * services but did not pay in full at the time of the sale. If full payment
1152
- * is received at the time of the sale, it is recorded as a sales receipt, not
1153
- * an invoice.
1154
- *
1155
- * In QuickBooks, invoices and estimates use similar fields, and an estimate
1156
- * can be converted into an invoice after the customer accepts the estimate.
1157
- * However, in the SDK, there is currently no ability to create an invoice
1158
- * directly from an estimate (you cannot link an invoice to an estimate).
1159
- */
1160
- invoice: {
1161
- /**
1162
- * Adds an invoice.
1163
- *
1164
- * An invoice records the amount owed by a customer who purchased goods or
1165
- * services but did not pay in full at the time of the sale. If full payment
1166
- * is received at the time of the sale, it is recorded as a sales receipt,
1167
- * not an invoice.
1168
- *
1169
- * In QuickBooks, invoices and estimates use similar fields, and an estimate
1170
- * can be converted into an invoice after the customer accepts the estimate.
1171
- * However, in the SDK, there is currently no ability to create an invoice
1172
- * directly from an estimate (you cannot link an invoice to an estimate).
1173
- *
1174
- * If you Add an invoice that has an inventory item on it, QB will
1175
- * automatically calculate COGS and post it to the COGS account. (The
1176
- * inventory item will need to be setup to post to the COGS account and must
1177
- * have a unit cost in it.) However, notice that such an `InvoiceAdd` has
1178
- * sales prices, not cost, so the Add is not impacting the cost of the item.
1179
- * The cost of the item is only affected by purchases (bills and item
1180
- * receipts) sales and inventory adjustments.
1181
- *
1182
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceAdd
1183
- */
1184
- add: (endUserId: string, params: QbdTypes.InvoiceAddRq["InvoiceAdd"]) => Promise<NonNullable<QbdTypes.InvoiceAddRs["InvoiceRet"]>>;
1185
- /**
1186
- * Modifies an existing invoice. If you are modifying existing line items,
1187
- * supply an `InvoiceLineMod` and `TxnLineID` for each line you want to
1188
- * modify. If you want to add a new line, supply an `InvoiceLineMod` with
1189
- * its `TxnLineID` value set to -1.
1190
- *
1191
- * Some fields in an `InvoiceMod` request cannot be cleared. If any of the
1192
- * following fields is included in an invoice modify request, it must
1193
- * contain a value:
1194
- * - `CustomerRef`
1195
- * - `ARAccountRef`
1196
- * - `TemplateRef`
1197
- * - `TxnDate`
1198
- * - `IsPending`
1199
- * - `DueDate`
1200
- * - `ItemSalesTaxRef`
1201
- * - `ShipDate`
1202
- * - `IsToBePrinted`
1203
- *
1204
- * Within `InvoiceLineMod` or `InvoiceLineGroupMod`:
1205
- * - `ItemRef`
1206
- * - `Quantity`
1207
- * - `Rate`
1208
- * - `Amount`
1209
- * - `SalesTaxCodeRef`
1210
- * - `OverrideItemAccountRef`
1211
- *
1212
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceMod
1213
- */
1214
- mod: (endUserId: string, params: QbdTypes.InvoiceModRq["InvoiceMod"]) => Promise<NonNullable<QbdTypes.InvoiceModRs["InvoiceRet"]>>;
1215
- /**
1216
- * Returns invoice data.
1217
- *
1218
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceQuery
1219
- */
1220
- query: (endUserId: string, params?: QbdTypes.InvoiceQueryRq) => Promise<NonNullable<QbdTypes.InvoiceQueryRs["InvoiceRet"]>>;
1221
- };
1222
- /**
1223
- * A discount item is a percentage or a fixed amount that will be subtracted
1224
- * from a total or subtotal.
1225
- */
1226
- itemDiscount: {
1227
- /**
1228
- * Adds a discount item. A discount item is a percentage or a fixed amount
1229
- * that will be subtracted from a total or subtotal. Items should be
1230
- * subtotaled (using an `ItemSubtotal` item) before a discount item is
1231
- * applied to them, because a discount only acts on the line that is
1232
- * directly above it. A discount item is different from a discount for early
1233
- * payment, which is represented as part of a `StandardTerms` object or
1234
- * DateDrivenTerms object. Note: When you specify an `ItemDiscount` item in
1235
- * any transaction (by using an `ItemRef`), do not specify a `Quantity` in
1236
- * the transaction. If you do, you will receive an error.
1237
- *
1238
- * Be Sharp WhenUsing Flat Discounts: Flat rate discounts are treated VERY
1239
- * differently vs. percentage discounts. A percentage discount only applies
1240
- * to the line right above it, so all of the tax implications for discounts
1241
- * apply ONLY to that line (Note that the story gets more complicated here
1242
- * for group items, subtotal lines, etc). A flat rate discount applies to
1243
- * EVERY line that is recorded above the discount. Thus, the $10.00 off you
1244
- * see is applied equally to the $100.00 Nontaxable target and the $100.00
1245
- * Taxable target. Thus, the sales tax for the 10.00 discount totals up to
1246
- * -$5.00. Therefore, for the desired behavior, the user must fill out the
1247
- * invoice like this: Item $100.00 Non Item $100.00 Tax Discount $20.00 Tax
1248
- * In this scenario, the $20.00 discount is properly distributed to be half
1249
- * taxed and half not taxed, so the taxable amount for the discount line is
1250
- * only -$10.00. The moral of the story: Non-Taxable Discounts are VERY
1251
- * dangerous. You should almost never use them unless discounts in your
1252
- * state are never applied to sales tax.
1253
- *
1254
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemDiscountAdd
1255
- */
1256
- add: (endUserId: string, params: QbdTypes.ItemDiscountAddRq["ItemDiscountAdd"]) => Promise<NonNullable<QbdTypes.ItemDiscountAddRs["ItemDiscountRet"]>>;
1257
- /**
1258
- * Modifies a discount item.
1259
- *
1260
- * You can modify the account ref, using the `AccountRef` aggregate and the
1261
- * `ApplyAccountRefToExistingTxns` boolean. You need to use the
1262
- * `ApplyAccountRefToExistingTxns` boolean because the QuickBooks UI
1263
- * displays a prompt asking whether the change should apply to existing
1264
- * transactions or not. Specifying True for the boolean basically dismisses
1265
- * this with a “Yes” answer, allowing your changes to be made and changes
1266
- * any existing transactions that use the item with that `AccountRef`.
1267
- * Specifying “False” means that the mod will not take affect if there are
1268
- * existing transactions. Setting this to “True” should be used with caution
1269
- * and normally only after some user has indicated that they want those
1270
- * changes made to all those existing transactions! If any affected
1271
- * transactions are protected by a closing date and password, the
1272
- * `AccountRef` changes will not be made and so the Mod request will return
1273
- * an error without making the requested Mod.
1274
- *
1275
- * Be Sharp When Using Flat Discounts: Flat rate discounts are treated VERY
1276
- * differently vs. percentage discounts. A percentage discount only applies
1277
- * to the line right above it, so all of the tax implications for discounts
1278
- * apply ONLY to that line (Note that the story gets more complicated here
1279
- * for group items, subtotal lines, etc). A flat rate discount applies to
1280
- * EVERY line that is recorded above the discount. Thus, the $10.00 off you
1281
- * see is applied equally to the $100.00 Nontaxable target and the $100.00
1282
- * Taxable target. Thus, the sales tax for the 10.00 discount totals up to
1283
- * -$5.00. Therefore, for the desired behavior, the user must fill out the
1284
- * invoice like this: Item $100.00 Non Item $100.00 Tax Discount $20.00 Tax
1285
- * In this scenario, the $20.00 discount is properly distributed to be half
1286
- * taxed and half not taxed, so the taxable amount for the discount line is
1287
- * only -$10.00. The moral of the story: Non-Taxable Discounts are VERY
1288
- * dangerous. You should almost never use them unless discounts in your
1289
- * state are never applied to sales tax.
1290
- *
1291
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemDiscountMod
1292
- */
1293
- mod: (endUserId: string, params: QbdTypes.ItemDiscountModRq["ItemDiscountMod"]) => Promise<NonNullable<QbdTypes.ItemDiscountModRs["ItemDiscountRet"]>>;
1294
- /**
1295
- * Queries for the specified discount item or set of items.
1296
- *
1297
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemDiscountQuery
1298
- */
1299
- query: (endUserId: string, params?: QbdTypes.ItemDiscountQueryRq) => Promise<NonNullable<QbdTypes.ItemDiscountQueryRs["ItemDiscountRet"]>>;
1300
- };
1301
- /**
1302
- * Fixed-asset items represent assets that will benefit a business for longer
1303
- * than one year. The purchase price of these fixed assets is typically
1304
- * expensed over a period of years, rather than in the year the purchase was
1305
- * made.
1306
- */
1307
- itemFixedAsset: {
1308
- /**
1309
- * Adds a fixed-asset item. Fixed-asset items represent assets that will
1310
- * benefit a business for longer than one year. The purchase price of these
1311
- * fixed assets is typically expensed over a period of years, rather than in
1312
- * the year the purchase was made.
1313
- *
1314
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemFixedAssetAdd
1315
- */
1316
- add: (endUserId: string, params: QbdTypes.ItemFixedAssetAddRq["ItemFixedAssetAdd"]) => Promise<NonNullable<QbdTypes.ItemFixedAssetAddRs["ItemFixedAssetRet"]>>;
1317
- /**
1318
- * Modifies a fixed asset item. Fixed-asset items represent assets that will
1319
- * benefit a business for longer than one year. The purchase price of these
1320
- * fixed assets is typically expensed over a period of years, rather than in
1321
- * the year the purchase was made.
1322
- *
1323
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemFixedAssetMod
1324
- */
1325
- mod: (endUserId: string, params: QbdTypes.ItemFixedAssetModRq["ItemFixedAssetMod"]) => Promise<NonNullable<QbdTypes.ItemFixedAssetModRs["ItemFixedAssetRet"]>>;
1326
- /**
1327
- * Queries for the specified fixed-asset item or set of fixed asset items.
1328
- *
1329
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemFixedAssetQuery
1330
- */
1331
- query: (endUserId: string, params?: QbdTypes.ItemFixedAssetQueryRq) => Promise<NonNullable<QbdTypes.ItemFixedAssetQueryRs["ItemFixedAssetRet"]>>;
1332
- };
1333
- /**
1334
- * An item group represents items that are grouped together for fast entry.
1335
- */
1336
- itemGroup: {
1337
- /**
1338
- * Adds an item group. `ItemGroup` objects represent items that are grouped
1339
- * together for fast entry, and an `ItemGroupRef` aggregate refers to one of
1340
- * these item groups. In a request, if an `ItemGroupRef` aggregate includes
1341
- * both `FullName` and `ListID`, `FullName` will be ignored. You can use an
1342
- * `ItemGroupQuery` request to get information about all the item groups
1343
- * that are set up in the QuickBooks file.
1344
- *
1345
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemGroupAdd
1346
- */
1347
- add: (endUserId: string, params: QbdTypes.ItemGroupAddRq["ItemGroupAdd"]) => Promise<NonNullable<QbdTypes.ItemGroupAddRs["ItemGroupRet"]>>;
1348
- /**
1349
- * Modifies an item group.
1350
- *
1351
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemGroupMod
1352
- */
1353
- mod: (endUserId: string, params: QbdTypes.ItemGroupModRq["ItemGroupMod"]) => Promise<NonNullable<QbdTypes.ItemGroupModRs["ItemGroupRet"]>>;
1354
- /**
1355
- * An `ItemGroupQuery` request will return information about all the item
1356
- * groups that are set up in the QuickBooks file.
1357
- *
1358
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/itemgroupquery
1359
- */
1360
- query: (endUserId: string, params?: QbdTypes.ItemGroupQueryRq) => Promise<NonNullable<QbdTypes.ItemGroupQueryRs["ItemGroupRet"]>>;
1361
- };
1362
- /**
1363
- * An inventory item is any merchandise or part that a business purchases,
1364
- * tracks as inventory, and then resells.
1365
- */
1366
- itemInventory: {
1367
- /**
1368
- * Adds an inventory item. An inventory item is any merchandise or part that
1369
- * a business purchases, tracks as inventory, and then resells. In
1370
- * QuickBooks, information about an inventory item is grouped into three
1371
- * categories:
1372
- * 1. Purchase Information includes `PurchaseDesc`, `PurchaseCost`,
1373
- * `COGSAccountRef`, and `PrefVendorRef`.
1374
- * 2. Sales Information includes `SalesDesc`, `SalesPrice`, and
1375
- * `SalesTaxCodeRef`.
1376
- * 3. Inventory Information includes `AssetAccountRef`, `ReorderPoint`,
1377
- * `QuantityOnHand`, `TotalValue`, and `InventoryDate`.
1378
- *
1379
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAdd
1380
- */
1381
- add: (endUserId: string, params: QbdTypes.ItemInventoryAddRq["ItemInventoryAdd"]) => Promise<NonNullable<QbdTypes.ItemInventoryAddRs["ItemInventoryRet"]>>;
1382
- /**
1383
- * Modifies an inventory item.
1384
- *
1385
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryMod
1386
- */
1387
- mod: (endUserId: string, params: QbdTypes.ItemInventoryModRq["ItemInventoryMod"]) => Promise<NonNullable<QbdTypes.ItemInventoryModRs["ItemInventoryRet"]>>;
1388
- /**
1389
- * Queries for the specified inventory item or set of items.
1390
- *
1391
- * Notice that certain modifications to the item can be caused by other
1392
- * transactions, such as `ItemReceipts` where the item’s on hand quantity is
1393
- * increased. Modifications through these transactions do not result in
1394
- * changing the `TimeModified` stamp (only the `Mod` operation will do
1395
- * that), but those changes will be detected when you use the
1396
- * `FromModifiedDate`/`ToModifiedDate` filters in your query. Notice that
1397
- * you cannot get an inventory asset value from QuickBooks using this query.
1398
- * Instead, you need to use the General Summary Report query (which
1399
- * currently doesn’t include Assembly Items). Suppose you needed a way to
1400
- * search for the amount on hand of items that have had their amount changed
1401
- * since a certain date. Again, you would not use this query, but a
1402
- * `GeneralDetailReportQuery` that has its `GeneralDetailReportType` set to
1403
- * “InventoryValuationDetail”. This will tell you which items changed by how
1404
- * much. Also, suppose you wanted the on-hand quantity from QB as of a
1405
- * specific date. You would use a General Summary Report of the type
1406
- * Inventory Valuation Summary. (Again, this report doesn’t include
1407
- * Inventory Assemblies.)
1408
- *
1409
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryQuery
1410
- */
1411
- query: (endUserId: string, params?: QbdTypes.ItemInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemInventoryQueryRs["ItemInventoryRet"]>>;
1412
- };
1413
- /**
1414
- * An inventory assembly item is an item that is assembled or manufactured
1415
- * from other inventory items. The items and/or assemblies that make up the
1416
- * assembly are called components.
1417
- */
1418
- itemInventoryAssembly: {
1419
- /**
1420
- * Adds an inventory assembly item, which is an item that is assembled or
1421
- * manufactured from other inventory items. The items and/or assemblies that
1422
- * make up the assembly are called components.
1423
- *
1424
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAssemblyAdd
1425
- */
1426
- add: (endUserId: string, params: QbdTypes.ItemInventoryAssemblyAddRq["ItemInventoryAssemblyAdd"]) => Promise<NonNullable<QbdTypes.ItemInventoryAssemblyAddRs["ItemInventoryAssemblyRet"]>>;
1427
- /**
1428
- * Modifies an inventory assembly item. If you are adding components to the
1429
- * assembly, remember that the component items and/or assemblies that make
1430
- * up the assembly are limited in number.
1431
- *
1432
- * You can modify the income account ref, using the `IncomeAccountRef`
1433
- * aggregate and the `ApplyIncomeAccountRefToExistingTxns` boolean. You need
1434
- * to use the `ApplyIncomeAccountRefToExistingTxns` boolean because the
1435
- * QuickBooks UI displays a prompt asking whether the change should apply to
1436
- * existing transactions or not. Specifying `True` for the boolean basically
1437
- * dismisses this with a “Yes” answer, allowing your changes to be made and
1438
- * changes any existing transactions that use the item with that AccountRef.
1439
- * Specifying “False” means that the mod will not take affect if there are
1440
- * existing transactions. Setting this to “True” should be used with caution
1441
- * and normally only after some user has indicated that they want those
1442
- * changes made to all those existing transactions! If any affected
1443
- * transactions are protected by a closing date and password, the
1444
- * `IncomeAccountRef` changes will not be made and so the Mod request will
1445
- * return an error without making the requested Mod.
1446
- *
1447
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAssemblyMod
1448
- */
1449
- mod: (endUserId: string, params: QbdTypes.ItemInventoryAssemblyModRq["ItemInventoryAssemblyMod"]) => Promise<NonNullable<QbdTypes.ItemInventoryAssemblyModRs["ItemInventoryAssemblyRet"]>>;
1450
- /**
1451
- * Queries for the specified inventory assembly item or set of assembly
1452
- * items.
1453
- *
1454
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAssemblyQuery
1455
- */
1456
- query: (endUserId: string, params?: QbdTypes.ItemInventoryAssemblyQueryRq) => Promise<NonNullable<QbdTypes.ItemInventoryAssemblyQueryRs["ItemInventoryAssemblyRet"]>>;
1457
- };
1458
- /**
1459
- * A non-inventory item is any material or part that a business buys but does
1460
- * not keep on hand as inventory. There are two types of non-inventory items:
1461
- * 1. Materials or parts that are part of the business’s overhead (for
1462
- * example, office supplies
1463
- * 2. Materials or parts that the business buys to finish a specific job and
1464
- * then charges back to the customer.
1465
- */
1466
- itemNonInventory: {
1467
- /**
1468
- * Adds a non-inventory item, which is any material or part that a business
1469
- * buys but does not keep on hand as inventory. There are two types of
1470
- * non-inventory items:
1471
- * 1. Materials or parts that are part of the business’s overhead (for
1472
- * example, office supplies
1473
- * 2. Materials or parts that the business buys to finish a specific job and
1474
- * then charges back to the customer.
1475
- *
1476
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryAdd
1477
- */
1478
- add: (endUserId: string, params: QbdTypes.ItemNonInventoryAddRq["ItemNonInventoryAdd"]) => Promise<NonNullable<QbdTypes.ItemNonInventoryAddRs["ItemNonInventoryRet"]>>;
1479
- /**
1480
- * Modifies a non inventory item.
1481
- *
1482
- * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
1483
- * `ItemNonInventoryMod` request: You cannot change the reimbursable status
1484
- * of a non-inventory item through the SDK. For example, if a non-inventory
1485
- * item is marked as non-reimbursable in QuickBooks, you cannot send a
1486
- * modify request that includes a `SalesAndPurchaseMod` aggregate.
1487
- * Similarly, if you send an `ItemNonInventoryAdd` request that includes a
1488
- * `SalesOrPurchase` aggregate, you cannot later modify that item using a
1489
- * `SalesAndPurchaseMod` aggregate.
1490
- *
1491
- * You can modify the various account references using the appropriate
1492
- * account reference aggregate and the matching Apply Account
1493
- * `RefToExistingTxns` boolean. You need to use the boolean when you change
1494
- * an account ref because the QuickBooks UI displays a prompt asking whether
1495
- * the change should apply to existing transactions or not. Specifying True
1496
- * for the boolean basically dismisses this with a “Yes” answer, allowing
1497
- * your changes to be made and changes any existing transactions that use
1498
- * the item with that `AccountRef`. Specifying “False” means that the mod
1499
- * will not take affect if there are existing transactions. Setting this to
1500
- * “True” should be used with caution and normally only after some user has
1501
- * indicated that they want those changes made to all those existing
1502
- * transactions! If any affected transactions are protected by a closing
1503
- * date and password, the `AccountRef` changes will not be made and so the
1504
- * Mod request will return an error without making the requested Mod.
1505
- *
1506
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryMod
1507
- */
1508
- mod: (endUserId: string, params: QbdTypes.ItemNonInventoryModRq["ItemNonInventoryMod"]) => Promise<NonNullable<QbdTypes.ItemNonInventoryModRs["ItemNonInventoryRet"]>>;
1509
- /**
1510
- * Queries for the specified non-inventory item or set of items.
1511
- *
1512
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryQuery
1513
- */
1514
- query: (endUserId: string, params?: QbdTypes.ItemNonInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemNonInventoryQueryRs["ItemNonInventoryRet"]>>;
1515
- };
1516
- /**
1517
- * An other charge item are miscellaneous charges that do not fall into the
1518
- * categories of service, labor, materials, or parts. Examples include
1519
- * delivery charges, setup fees, and service charges.
1520
- */
1521
- itemOtherCharge: {
1522
- /**
1523
- * Adds an other charge item, which are miscellaneous charges that do not
1524
- * fall into the categories of service, labor, materials, or parts. Examples
1525
- * include delivery charges, setup fees, and service charges.
1526
- *
1527
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemOtherChargeAdd
1528
- */
1529
- add: (endUserId: string, params: QbdTypes.ItemOtherChargeAddRq["ItemOtherChargeAdd"]) => Promise<NonNullable<QbdTypes.ItemOtherChargeAddRs["ItemOtherChargeRet"]>>;
1530
- /**
1531
- * Modifies an other charge item.
1532
- *
1533
- * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
1534
- * `ItemOtherChargeMod` request: You cannot change the reimbursable status
1535
- * of an other-charge item through the SDK. For example, if an other-charge
1536
- * item is marked as non-reimbursable in QuickBooks, you cannot send a
1537
- * modify request that includes a `SalesAndPurchaseMod` aggregate.
1538
- * Similarly, if you send an `ItemOtherChargeAdd` request that includes a
1539
- * SalesOrPurchase aggregate, you cannot later modify that item using a
1540
- * `SalesAndPurchaseMod` aggregate.
1541
- *
1542
- * You can modify the various account references using the appropriate
1543
- * account reference aggregate and the matching Apply Account
1544
- * `RefToExistingTxns` boolean. You need to use the boolean when you change
1545
- * an account ref because the QuickBooks UI displays a prompt asking whether
1546
- * the change should apply to existing transactions or not. Specifying
1547
- * `True` for the boolean basically dismisses this with a “Yes” answer,
1548
- * allowing your changes to be made and changes any existing transactions
1549
- * that use the item with that AccountRef. Specifying “False” means that the
1550
- * mod will not take affect if there are existing transactions. Setting this
1551
- * to “True” should be used with caution and normally only after some user
1552
- * has indicated that they want those changes made to all those existing
1553
- * transactions! If any affected transactions are protected by a closing
1554
- * date and password, the AccountRef changes will not be made and so the Mod
1555
- * request will return an error without making the requested Mod.
1556
- *
1557
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemOtherChargeMod
1558
- */
1559
- mod: (endUserId: string, params: QbdTypes.ItemOtherChargeModRq["ItemOtherChargeMod"]) => Promise<NonNullable<QbdTypes.ItemOtherChargeModRs["ItemOtherChargeRet"]>>;
1560
- /**
1561
- * Queries for the specified other charge item or set of items.
1562
- *
1563
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemOtherChargeQuery
1564
- */
1565
- query: (endUserId: string, params?: QbdTypes.ItemOtherChargeQueryRq) => Promise<NonNullable<QbdTypes.ItemOtherChargeQueryRs["ItemOtherChargeRet"]>>;
1566
- };
1567
- /**
1568
- * A payment item is a type of item that is used to record a payment that is
1569
- * received from a customer.
1570
- */
1571
- itemPayment: {
1572
- /**
1573
- * Adds an item payment or set of payments. You can use this request to
1574
- * create a payment for a customer or vendor.
1575
- *
1576
- * For an `ItemPaymentAdd` request, you can “set” the “Group with
1577
- * undeposited funds” radio button in QuickBooks either by not specifying
1578
- * `DepositToAccountRef` at all, or by specifying the special
1579
- * UndepositedFunds account for the `DepositToAccountRef`.
1580
- *
1581
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemPaymentAdd
1582
- */
1583
- add: (endUserId: string, params: QbdTypes.ItemPaymentAddRq["ItemPaymentAdd"]) => Promise<NonNullable<QbdTypes.ItemPaymentAddRs["ItemPaymentRet"]>>;
1584
- /**
1585
- * Modifies an item payment.
1586
- *
1587
- * For an `ItemPaymentMod` request, you can “set” the “Group with
1588
- * undeposited funds” radio button in QuickBooks by either attempting to
1589
- * clear the DepositToAccountRef, or by specifying the account whose
1590
- * `SpecialAccountType` is `UndepositedFunds` for the `DepositToAccountRef`.
1591
- *
1592
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemPaymentMod
1593
- */
1594
- mod: (endUserId: string, params: QbdTypes.ItemPaymentModRq["ItemPaymentMod"]) => Promise<NonNullable<QbdTypes.ItemPaymentModRs["ItemPaymentRet"]>>;
1595
- /**
1596
- * Queries for the specified item payment or set of payments.
1597
- *
1598
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemPaymentQuery
1599
- */
1600
- query: (endUserId: string, params?: QbdTypes.ItemPaymentQueryRq) => Promise<NonNullable<QbdTypes.ItemPaymentQueryRs["ItemPaymentRet"]>>;
1601
- };
1602
- /**
1603
- * An item receipt transaction is a transaction entered in QuickBooks when a
1604
- * shipment is received from a vendor.
1605
- */
1606
- itemReceipt: {
1607
- /**
1608
- * Adds an item receipt transaction, which is a transaction entered in
1609
- * QuickBooks when a shipment is received from a vendor. If you use
1610
- * `PurchaseOrders` to order from the vendor, you can link the item receipt
1611
- * to purchase order to receive the items against the purchase orders to
1612
- * automatically update (and eventually close) the purchase orders. This
1613
- * linking also saves you having to re-create line items as they are pulled
1614
- * in automatically from the purchase order. You can do this linking only in
1615
- * the item receipt add, not in the mod.
1616
- *
1617
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemReceiptAdd
1618
- */
1619
- add: (endUserId: string, params: QbdTypes.ItemReceiptAddRq["ItemReceiptAdd"]) => Promise<NonNullable<QbdTypes.ItemReceiptAddRs["ItemReceiptRet"]>>;
1620
- /**
1621
- * Modifies an existing item receipt.
1622
- *
1623
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemReceiptMod
1624
- */
1625
- mod: (endUserId: string, params: QbdTypes.ItemReceiptModRq["ItemReceiptMod"]) => Promise<NonNullable<QbdTypes.ItemReceiptModRs["ItemReceiptRet"]>>;
1626
- /**
1627
- * An item receipt transaction is entered in QuickBooks when a shipment is
1628
- * received from a vendor.
1629
- *
1630
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemReceiptQuery
1631
- */
1632
- query: (endUserId: string, params?: QbdTypes.ItemReceiptQueryRq) => Promise<NonNullable<QbdTypes.ItemReceiptQueryRs["ItemReceiptRet"]>>;
1633
- };
1634
- /**
1635
- * A sales-tax item is an item used to calculate a single sales tax that is
1636
- * collected at a specified rate and paid to a single agency.
1637
- */
1638
- itemSalesTax: {
1639
- /**
1640
- * Adds a sales-tax item, which is an item used to calculate a single sales
1641
- * tax that is collected at a specified rate and paid to a single agency.
1642
- * (Compare with the `ItemSalesTaxGroupAdd` message.)
1643
- *
1644
- * An `ItemSalesTaxRef` aggregate refers to an item on this list. In a
1645
- * request, if an `ItemSalesTaxRef` aggregate includes both `FullName` and
1646
- * `ListID`, `FullName` will be ignored. Taxes can be reflected in
1647
- * transaction line items.
1648
- *
1649
- * The following information refers to invoices specifically, but it also
1650
- * applies to sales receipts. Generally it's best to assign a tax item or
1651
- * tax group item to an invoice and allow QuickBooks to apply the same tax
1652
- * to all taxable items on the invoice. However in some situations multiple
1653
- * tax combinations are required, so this method doesn’t work. In this case
1654
- * one must use techniques to apply the taxes in the invoice itself as line
1655
- * items. Using lines to apply taxes isn’t always straight forward. When
1656
- * applying taxes as line items, only single tax items can be used, tax
1657
- * groups can only be used for the entire invoice. If you have multiple
1658
- * taxes which apply to all taxable items, and one or more other taxes that
1659
- * only apply to some of the items on an invoice its better to use a tax
1660
- * group which applies to the entire invoice for the taxes which applies to
1661
- * all taxable items and then apply the other taxes in the invoice itself.
1662
- * One applies a tax or tax group to an entire invoice by using the
1663
- * `ItemSalesTaxRef` aggregate. One can use subtotals to apply a single tax
1664
- * line to multiple items in an invoice, but the tax is only applied
1665
- * automatically for the first tax line after the subtotal line. Any other
1666
- * tax lines which need to be applied to the subtotal line must supply their
1667
- * own amount. If you don’t supply an amount the amount comes out as zero
1668
- * and the tax line is useless. When one does supply an amount, the amount
1669
- * of tax on the subtotal also shows up in the rate column for that tax
1670
- * line. There isn’t any way for the rate to show up as anything other than
1671
- * the amount of the tax. If you have a complicated tax situation where no
1672
- * single tax applies to all taxable items on the invoice, you must choose a
1673
- * zero percent tax to apply for the entire invoice. It is recommended to
1674
- * name such a tax item “Tax Calculated On Invoice” so that it’s clear that
1675
- * the tax is not being applied by QuickBooks on the entire invoice.
1676
- *
1677
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxAdd
1678
- */
1679
- add: (endUserId: string, params: QbdTypes.ItemSalesTaxAddRq["ItemSalesTaxAdd"]) => Promise<NonNullable<QbdTypes.ItemSalesTaxAddRs["ItemSalesTaxRet"]>>;
1680
- /**
1681
- * Modifies an existing sales-tax item.
1682
- *
1683
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxMod
1684
- */
1685
- mod: (endUserId: string, params: QbdTypes.ItemSalesTaxModRq["ItemSalesTaxMod"]) => Promise<NonNullable<QbdTypes.ItemSalesTaxModRs["ItemSalesTaxRet"]>>;
1686
- /**
1687
- * Queries for the specified sales-tax item or set of items.
1688
- *
1689
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxQuery
1690
- */
1691
- query: (endUserId: string, params?: QbdTypes.ItemSalesTaxQueryRq) => Promise<NonNullable<QbdTypes.ItemSalesTaxQueryRs["ItemSalesTaxRet"]>>;
1692
- };
1693
- /**
1694
- * A sales-tax group item is an item used for calculating two or more sales
1695
- * taxes grouped together and applied to the same sale. For example, local and
1696
- * state taxes could be tracked separately but applied to a sale as one tax.
1697
- */
1698
- itemSalesTaxGroup: {
1699
- /**
1700
- * Adds a sales-tax group item, which is an item used for calculating two or
1701
- * more sales taxes grouped together and applied to the same sale. For
1702
- * example, local and state taxes could be tracked separately but applied to
1703
- * a sale as one tax. (Compare with the `ItemSalesTaxAdd` message.)
1704
- *
1705
- * Taxes can be reflected in transaction line items The following
1706
- * information refers to invoices specifically, but it also applies to sales
1707
- * receipts. Generally its best to assign a tax item or tax group item to an
1708
- * invoice and allow QuickBooks to apply the same tax to all taxable items
1709
- * on the invoice. However in some situations multiple tax combinations are
1710
- * required, so this method doesn’t work. In this case one must use
1711
- * techniques to apply the taxes in the invoice itself as line items. Using
1712
- * lines to apply taxes isn’t always straight forward. When applying taxes
1713
- * as line items, only single tax items can be used, tax groups can only be
1714
- * used for the entire invoice. If you have multiple taxes which apply to
1715
- * all taxable items, and one or more other taxes that only apply to some of
1716
- * the items on an invoice its better to use a tax group which applies to
1717
- * the entire invoice for the taxes which applies to all taxable items and
1718
- * then apply the other taxes in the invoice itself. One applies a tax or
1719
- * tax group to an entire invoice by using the `ItemSalesTaxRef` aggregate.
1720
- * One can use subtotals to apply a single tax line to multiple items in an
1721
- * invoice, but the tax is only applied automatically for the first tax line
1722
- * after the subtotal line. Any other tax lines which need to be applied to
1723
- * the subtotal line must supply their own amount. If you don’t supply an
1724
- * amount the amount comes out as zero and the tax line is useless. When one
1725
- * does supply an amount, the amount of tax on the subtotal also shows up in
1726
- * the rate column for that tax line. There isn’t any way for the rate to
1727
- * show up as anything other than the amount of the tax. If you have a
1728
- * complicated tax situation where no single tax applies to all taxable
1729
- * items on the invoice, you must choose a zero percent tax to apply for the
1730
- * entire invoice. It is recommended to name such a tax item “Tax Calculated
1731
- * On Invoice” so that it’s clear that the tax is not being applied by
1732
- * QuickBooks on the entire invoice.
1733
- *
1734
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxGroupAdd
1735
- */
1736
- add: (endUserId: string, params: QbdTypes.ItemSalesTaxGroupAddRq["ItemSalesTaxGroupAdd"]) => Promise<NonNullable<QbdTypes.ItemSalesTaxGroupAddRs["ItemSalesTaxGroupRet"]>>;
1737
- /**
1738
- * Modifies an existing sales-tax group item.
1739
- *
1740
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxGroupMod
1741
- */
1742
- mod: (endUserId: string, params: QbdTypes.ItemSalesTaxGroupModRq["ItemSalesTaxGroupMod"]) => Promise<NonNullable<QbdTypes.ItemSalesTaxGroupModRs["ItemSalesTaxGroupRet"]>>;
1743
- /**
1744
- * Queries for the specified sales-tax group item or set of group items.
1745
- *
1746
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxGroupQuery
1747
- */
1748
- query: (endUserId: string, params?: QbdTypes.ItemSalesTaxGroupQueryRq) => Promise<NonNullable<QbdTypes.ItemSalesTaxGroupQueryRs["ItemSalesTaxGroupRet"]>>;
1749
- };
1750
- /**
1751
- * A service item is an item that refers to services that a business charges
1752
- * for or purchases. Examples include specialized labor, consulting hours, and
1753
- * professional fees.
1754
- */
1755
- itemService: {
1756
- /**
1757
- * Adds a service item, which is an item that refers to services that a
1758
- * business charges for or purchases. Examples include specialized labor,
1759
- * consulting hours, and professional fees. An `ItemServiceRef` aggregate
1760
- * refers to an item on the ItemService list. In a request, if an
1761
- * `ItemServiceRef` aggregate includes both `FullName` and `ListID`,
1762
- * `FullName` will be ignored.
1763
- *
1764
- * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
1765
- * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
1766
- * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
1767
- * `ItemServiceRef` and `CustomerRef`.
1768
- *
1769
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
1770
- */
1771
- add: (endUserId: string, params: QbdTypes.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<QbdTypes.ItemServiceAddRs["ItemServiceRet"]>>;
1772
- /**
1773
- * Modifies an existing service item.
1774
- *
1775
- * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
1776
- * `ItemServiceMod` request:
1777
- * - You cannot change the reimbursable status of a service item through the
1778
- * SDK. For example, if a service item is marked as non-reimbursable in
1779
- * QuickBooks, you cannot send a modify request that includes a
1780
- * `SalesAndPurchaseMod` aggregate. Similarly, if you send an
1781
- * `ItemServiceAdd` request that includes a `SalesOrPurchase` aggregate,
1782
- * you cannot later modify that item using a `SalesAndPurchaseMod`
1783
- * aggregate.
1784
- * - You can modify the various account references using the appropriate
1785
- * account reference aggregate and the matching `RefToExistingTxns`
1786
- * boolean. You need to use the boolean when you change an account ref
1787
- * because the QuickBooks UI displays a prompt asking whether the change
1788
- * should apply to existing transactions or not.
1789
- * - Specifying `False` means that the mod will not take affect if there
1790
- * are existing transactions.
1791
- * - Specifying `True` for the boolean basically dismisses this with a
1792
- * “Yes” answer, allowing your changes to be made and changes any
1793
- * existing transactions that use the item with that `AccountRef`.
1794
- * Setting this to `True` should be used with caution and normally only
1795
- * after some user has indicated that they want those changes made to
1796
- * all those existing transactions! If any affected transactions are
1797
- * protected by a closing date and password, the `AccountRef` changes
1798
- * will not be made and so the `Mod` request will return an error
1799
- * without making the requested `Mod`.
1800
- *
1801
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceMod
1802
- */
1803
- mod: (endUserId: string, params: QbdTypes.ItemServiceModRq["ItemServiceMod"]) => Promise<NonNullable<QbdTypes.ItemServiceModRs["ItemServiceRet"]>>;
1804
- /**
1805
- * Queries for the specified service item or set of items.
1806
- *
1807
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceQuery
1808
- */
1809
- query: (endUserId: string, params?: QbdTypes.ItemServiceQueryRq) => Promise<NonNullable<QbdTypes.ItemServiceQueryRs["ItemServiceRet"]>>;
1810
- };
1811
- itemSites: {
1812
- /**
1813
- * Queries for the specified items at the specified inventory site.
1814
- *
1815
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSitesQuery
1816
- */
1817
- query: (endUserId: string, params?: QbdTypes.ItemSitesQueryRq) => Promise<NonNullable<QbdTypes.ItemSitesQueryRs["ItemSitesRet"]>>;
1818
- };
1819
- /**
1820
- * A subtotal item is used on a sales form to add up the amounts of the item
1821
- * lines above it, up to the previous subtotal.
1822
- */
1823
- itemSubtotal: {
1824
- /**
1825
- * Adds a subtotal item. On a sales form, a subtotal item will add up the
1826
- * amounts of the item lines above it, up to the previous subtotal. Items
1827
- * must be subtotaled before a discount is applied (using `ItemDiscount`),
1828
- * because a discount applies only to the line that is directly above it.
1829
- *
1830
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSubtotalAdd
1831
- */
1832
- add: (endUserId: string, params: QbdTypes.ItemSubtotalAddRq["ItemSubtotalAdd"]) => Promise<NonNullable<QbdTypes.ItemSubtotalAddRs["ItemSubtotalRet"]>>;
1833
- /**
1834
- * Modifies an existing subtotal item.
1835
- *
1836
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSubtotalMod
1837
- */
1838
- mod: (endUserId: string, params: QbdTypes.ItemSubtotalModRq["ItemSubtotalMod"]) => Promise<NonNullable<QbdTypes.ItemSubtotalModRs["ItemSubtotalRet"]>>;
1839
- /**
1840
- * Queries for the specified subtotal item or set of items.
1841
- *
1842
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSubtotalQuery
1843
- */
1844
- query: (endUserId: string, params?: QbdTypes.ItemSubtotalQueryRq) => Promise<NonNullable<QbdTypes.ItemSubtotalQueryRs["ItemSubtotalRet"]>>;
1845
- };
1846
- /**
1847
- * A job type can be used to separate jobs into any categories that are
1848
- * meaningful to the business.
1849
- */
1850
- jobType: {
1851
- /**
1852
- * Adds a job type. A job type can be used to separate jobs into any
1853
- * categories that are meaningful to the business.
1854
- *
1855
- * A `JobTypeRef` aggregate refers to a job type on the `JobType` list. In a
1856
- * request, if a `JobTypeRef` aggregate includes both `FullName` and
1857
- * `ListID`, `FullName` will be ignored.
1858
- *
1859
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JobTypeAdd
1860
- */
1861
- add: (endUserId: string, params: QbdTypes.JobTypeAddRq["JobTypeAdd"]) => Promise<NonNullable<QbdTypes.JobTypeAddRs["JobTypeRet"]>>;
1862
- /**
1863
- * Queries for the specified job type or set of job types.
1864
- *
1865
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JobTypeQuery
1866
- */
1867
- query: (endUserId: string, params?: QbdTypes.JobTypeQueryRq) => Promise<NonNullable<QbdTypes.JobTypeQueryRs["JobTypeRet"]>>;
1868
- };
1869
- /**
1870
- * A journal entry is used for recording transactions directly in the general
1871
- * journal, particularly for activities like depreciation. It requires paired
1872
- * credit and debit lines in one request to balance the monetary amounts.
1873
- */
1874
- journalEntry: {
1875
- /**
1876
- * The debit and credit lines can be intermingled. A credit line can legally
1877
- * come first in the journal entry add.
1878
- *
1879
- * In traditional accounting, transactions are entered into the general
1880
- * journal and categorized exclusively by account. In QuickBooks, most
1881
- * transactions can be categorized either by account or by type (invoice,
1882
- * check, and so on). For a few activities in QuickBooks, you must use the
1883
- * general journal directly, for example for recording depreciation. Notice
1884
- * that you must supply the credit line and a corresponding debit line in
1885
- * the same request. It will not work to supply them in two distinct
1886
- * requests. You can supply as many credit lines and debit lines in one
1887
- * single request as you want so long as the total monetary amount from the
1888
- * credits equals the total monetary amount from the debits in that request.
1889
- *
1890
- * Finally, DO NOT supply negative sign for the monetary amounts. QuickBooks
1891
- * does that for you. If you do supply the negative sign, amounts will add
1892
- * instead of cancel and you’ll get a runtime error.
1893
- *
1894
- * Querying for Condensed Transactions: If you need the query to return
1895
- * condensed transactions, you can do this by using either an `Entity` or
1896
- * `Account` filter in the journal query request. Alternatively, you could
1897
- * use the The generic `TransactionQuery`, which can return condensed
1898
- * transactions.
1899
- *
1900
- * If the transaction is a home currency adjustment, QuickBooks will ignore
1901
- * the `IsAmountsEnteredInHomeCurrency`, `CurrencyRef`, and `ExchangeRate`
1902
- * elements.
1903
- *
1904
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryAdd
1905
- */
1906
- add: (endUserId: string, params: QbdTypes.JournalEntryAddRq["JournalEntryAdd"]) => Promise<NonNullable<QbdTypes.JournalEntryAddRs["JournalEntryRet"]>>;
1907
- /**
1908
- * Modifies a journal entry.
1909
- *
1910
- * If the transaction is a home currency adjustment, QuickBooks will ignore
1911
- * the `IsAmountsEnteredInHomeCurrency`, `CurrencyRef`, and `ExchangeRate`
1912
- * elements.
1913
- *
1914
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryMod
1915
- */
1916
- mod: (endUserId: string, params: QbdTypes.JournalEntryModRq["JournalEntryMod"]) => Promise<NonNullable<QbdTypes.JournalEntryModRs["JournalEntryRet"]>>;
1917
- /**
1918
- * In traditional accounting, transactions are entered into the general
1919
- * journal and categorized exclusively by account. In QuickBooks, most
1920
- * transactions can be categorized either by account or by type (invoice,
1921
- * check, and so on). For a few activities in QuickBooks, you must use the
1922
- * general journal directly, for example for recording depreciation. Notice
1923
- * that you must supply the credit line and a corresponding debit line in
1924
- * the same request. It will not work to supply them in two distinct
1925
- * requests. You can supply as many credit lines and debit lines in one
1926
- * single request as you want so long as the total monetary amount from the
1927
- * credits equals the total monetary amount from the debits in that request.
1928
- *
1929
- * Finally, DO NOT supply negative sign for the monetary amounts. QuickBooks
1930
- * does that for you. If you do supply the negative sign, amounts will add
1931
- * instead of cancel and you’ll get a runtime error.
1932
- *
1933
- * Querying for Condensed Transactions: If you need the query to return
1934
- * condensed transactions, you can do this by using either an `Entity` or
1935
- * `Account` filter in the journal query request. Alternatively, you could
1936
- * use the The generic `TransactionQuery`, which can return condensed
1937
- * transactions.
1938
- *
1939
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JournalEntryQuery
1940
- */
1941
- query: (endUserId: string, params?: QbdTypes.JournalEntryQueryRq) => Promise<NonNullable<QbdTypes.JournalEntryQueryRs["JournalEntryRet"]>>;
1942
- };
1943
- /**
1944
- * A lead is a potential customer or sales opportunity that a business might
1945
- * have.
1946
- */
1947
- lead: {
1948
- /**
1949
- * Adds a lead.
1950
- *
1951
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/LeadAdd
1952
- */
1953
- add: (endUserId: string, params: QbdTypes.LeadAddRq["LeadAdd"]) => Promise<NonNullable<QbdTypes.LeadAddRs["LeadRet"]>>;
1954
- /**
1955
- * Modifies an existing lead.
1956
- *
1957
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/LeadMod
1958
- */
1959
- mod: (endUserId: string, params: QbdTypes.LeadModRq["LeadMod"]) => Promise<NonNullable<QbdTypes.LeadModRs["LeadRet"]>>;
1960
- /**
1961
- * Queries for the specified lead or set of leads.
1962
- *
1963
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/LeadQuery
1964
- */
1965
- query: (endUserId: string, params?: QbdTypes.LeadQueryRq) => Promise<NonNullable<QbdTypes.LeadQueryRs["LeadRet"]>>;
1966
- };
1967
- /**
1968
- * A list element is a record in a list, such as an `Account`, `Customer`, or
1969
- * `Employee`.
1970
- */
1971
- listDeleted: {
1972
- /**
1973
- * Returns all list elements deleted within the last 90 days, grouped
1974
- * according to object type.
1975
- *
1976
- * If you are synchronizing deletes, you might want to specify `ListDelType`
1977
- * elements in order of dependency; for example, first specify a
1978
- * `ListDelType` of `Item`, then specify a `ListDelType` of `Vendor`. This
1979
- * way the SDK will return `Item` deletes before `Vendor` deletes (both in
1980
- * order of real delete times). `Item` depends on (refers to) to `Vendor`,
1981
- * so by having the `Item` deletes returned first you avoid a dependency
1982
- * problem.
1983
- *
1984
- * By default, the records of each type are returned in ascending order,
1985
- * according to the “real” delete time. For example: If list object A is
1986
- * deleted at 10 a.m. and list object B is deleted at 11 a.m., the query
1987
- * request will return A first, then B.
1988
- *
1989
- * See more:
1990
- * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ListDeletedQuery
1991
- */
1992
- query: (endUserId: string, params: QbdTypes.ListDeletedQueryRq) => Promise<NonNullable<QbdTypes.ListDeletedQueryRs["ListDeletedRet"]>>;
1993
- };
1994
- /**
1995
- * The “other names” list contains any names that do not appear on customer,
1996
- * vendor, or employee lists.
1997
- */
1998
- otherName: {
1999
- /**
2000
- * Adds an other name. In QuickBooks, the “other names” list contains any
2001
- * names that do not appear on customer, vendor, or employee lists.
2002
- *
2003
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/OtherNameAdd
2004
- */
2005
- add: (endUserId: string, params: QbdTypes.OtherNameAddRq["OtherNameAdd"]) => Promise<NonNullable<QbdTypes.OtherNameAddRs["OtherNameRet"]>>;
2006
- /**
2007
- * Modifies an existing other name.
2008
- *
2009
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/OtherNameMod
2010
- */
2011
- mod: (endUserId: string, params: QbdTypes.OtherNameModRq["OtherNameMod"]) => Promise<NonNullable<QbdTypes.OtherNameModRs["OtherNameRet"]>>;
2012
- /**
2013
- * Queries for the specified other name or set of other names.
2014
- *
2015
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/OtherNameQuery
2016
- */
2017
- query: (endUserId: string, params?: QbdTypes.OtherNameQueryRq) => Promise<NonNullable<QbdTypes.OtherNameQueryRs["OtherNameRet"]>>;
2018
- };
2019
- /**
2020
- * A payment method is a method of payment that a business accepts, such as
2021
- * cash, check, or credit card.
2022
- */
2023
- paymentMethod: {
2024
- /**
2025
- * Adds a payment method, which is the way a customer pays for goods or
2026
- * services, for example, cash, check, or Master Card.
2027
- *
2028
- * A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod`
2029
- * list. In a request, if a `PaymentMethodRef` aggregate includes both
2030
- * `FullName` and `ListID`, `FullName` will be ignored.
2031
- *
2032
- * In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard`
2033
- * request that contains credit card transaction data supplied from QBMS
2034
- * transaction responses, you must specify the payment method, and the
2035
- * payment method must be a credit card type.
2036
- *
2037
- * See more:
2038
- * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PaymentMethodAdd
2039
- */
2040
- add: (endUserId: string, params: QbdTypes.PaymentMethodAddRq["PaymentMethodAdd"]) => Promise<NonNullable<QbdTypes.PaymentMethodAddRs["PaymentMethodRet"]>>;
2041
- /**
2042
- * Queries for the specified payment method or set of payment methods.
2043
- *
2044
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PaymentMethodQuery
2045
- */
2046
- query: (endUserId: string, params?: QbdTypes.PaymentMethodQueryRq) => Promise<NonNullable<QbdTypes.PaymentMethodQueryRs["PaymentMethodRet"]>>;
2047
- };
2048
- /**
2049
- * A payroll wage item describes and names a payment scheme, for example,
2050
- * Regular Pay or Overtime Pay.
2051
- */
2052
- payrollItemWage: {
2053
- /**
2054
- * Adds a payroll wage item. Each payroll wage item describes and names a
2055
- * payment scheme, for example, Regular Pay or Overtime Pay. A
2056
- * `PayrollItemWageRef` aggregate refers to one of these wage items. In a
2057
- * request, if a `PayrollItemWageRef` aggregate includes both `FullName` and
2058
- * `ListID`, `FullName` will be ignored.
2059
- *
2060
- * Within QuickBooks, a timesheet can specify a payroll wage item only if
2061
- * the following criteria are met:
2062
- * - The name on the timesheet (which corresponds to the EntityRef in the
2063
- * `TimeTracking` object) is on the QuickBooks Employee list, and
2064
- * - The “Use time data to create paychecks” preference is turned on in the
2065
- * QuickBooks Payroll Info window that provides detailed employee
2066
- * information employee.
2067
- *
2068
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageAdd
2069
- */
2070
- add: (endUserId: string, params: QbdTypes.PayrollItemWageAddRq["PayrollItemWageAdd"]) => Promise<NonNullable<QbdTypes.PayrollItemWageAddRs["PayrollItemWageRet"]>>;
2071
- /**
2072
- * Queries for the specified payroll wage item or set of items.
2073
- *
2074
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollItemWageQuery
2075
- */
2076
- query: (endUserId: string, params?: QbdTypes.PayrollItemWageQueryRq) => Promise<NonNullable<QbdTypes.PayrollItemWageQueryRs["PayrollItemWageRet"]>>;
2077
- };
2078
- /**
2079
- * A price level is used to specify custom pricing for specific customers.
2080
- * Once you create a price level for a customer, QuickBooks will automatically
2081
- * use the custom price in new invoices, sales receipts, sales orders or
2082
- * credit memos for that customer.
2083
- */
2084
- priceLevel: {
2085
- /**
2086
- * Adds a price level. You can use price levels to specify custom pricing
2087
- * for specific customers.
2088
- *
2089
- * Once you create a price level for a customer, QuickBooks will
2090
- * automatically use the custom price in new invoices, sales receipts, sales
2091
- * orders or credit memos for that customer. You can override this automatic
2092
- * feature, however, when you create the invoices, sales receipts, etc.) The
2093
- * user can now specify a price level on line items in the following
2094
- * supported sales transactions: invoices, sales receipts, credit memos, and
2095
- * sales orders. Notice that the response data for the affected sales
2096
- * transaction does not list the price level that was used. The response
2097
- * simply lists the Rate for the item, which was set using the price level.
2098
- * The `CurrencyRef` should only be used with “per item” price levels.
2099
- *
2100
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PriceLevelAdd
2101
- */
2102
- add: (endUserId: string, params: QbdTypes.PriceLevelAddRq["PriceLevelAdd"]) => Promise<NonNullable<QbdTypes.PriceLevelAddRs["PriceLevelRet"]>>;
2103
- /**
2104
- * Modifies a price level.
2105
- *
2106
- * The `CurrencyRef` should only be used with “per item” price levels.
2107
- *
2108
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PriceLevelMod
2109
- */
2110
- mod: (endUserId: string, params: QbdTypes.PriceLevelModRq["PriceLevelMod"]) => Promise<NonNullable<QbdTypes.PriceLevelModRs["PriceLevelRet"]>>;
2111
- /**
2112
- * Queries for the specified price level or set of price levels.
2113
- *
2114
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PriceLevelQuery
2115
- */
2116
- query: (endUserId: string, params?: QbdTypes.PriceLevelQueryRq) => Promise<NonNullable<QbdTypes.PriceLevelQueryRs["PriceLevelRet"]>>;
2117
- };
2118
- /**
2119
- * A purchase order is an order submitted to a vendor.
2120
- */
2121
- purchaseOrder: {
2122
- /**
2123
- * Adds a purchase order, which is an order submitted to a vendor. You can
2124
- * use ItemReceiptAdd to receive items against a purchase order as items
2125
- * arrive from the vendor. A purchase order is a non-posting transaction, so
2126
- * it does not affect a company’s balance sheet or income statement.
2127
- *
2128
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderQuery
2129
- */
2130
- add: (endUserId: string, params: QbdTypes.PurchaseOrderAddRq["PurchaseOrderAdd"]) => Promise<NonNullable<QbdTypes.PurchaseOrderAddRs["PurchaseOrderRet"]>>;
2131
- /**
2132
- * Modifies a purchase order.
2133
- *
2134
- * Some fields in a `PurchaseOrderMod` request cannot be cleared. If any of
2135
- * the following fields is included in a purchase order modify request, it
2136
- * must contain a value:
2137
- * - `TemplateRef`
2138
- * - `TxnDate`
2139
- * - `DueDate`
2140
- * - `ExpectedDate`
2141
- * - `IsManuallyClosed`
2142
- * - `IsToBePrinted`
2143
- *
2144
- * Within `PurchaseOrderLineMod` or `PurchaseOrderLineGroupMod`:
2145
- * - `ItemRef`
2146
- * - `Quantity`
2147
- * - `Rate`
2148
- * - `Amount`
2149
- * - `IsManuallyClosed`
2150
- * - `OverrideItemAccountRef`
2151
- *
2152
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderMod
2153
- */
2154
- mod: (endUserId: string, params: QbdTypes.PurchaseOrderModRq["PurchaseOrderMod"]) => Promise<NonNullable<QbdTypes.PurchaseOrderModRs["PurchaseOrderRet"]>>;
2155
- /**
2156
- * Queries for the specified purchase order or set of orders.
2157
- *
2158
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PurchaseOrderQuery
2159
- */
2160
- query: (endUserId: string, params?: QbdTypes.PurchaseOrderQueryRq) => Promise<NonNullable<QbdTypes.PurchaseOrderQueryRs["PurchaseOrderRet"]>>;
2161
- };
2162
- /**
2163
- * A receive payment transaction is used for one or more of these purposes:
2164
- * 1. To record a customer’s payment against an invoice for one or more jobs,
2165
- * 2. To set a discount (for early payment, for example),
2166
- * 3. To set a credit (from previously returned merchandise, for example).
2167
- *
2168
- * If full payment is received at the time of sale, it is recorded using a
2169
- * sales receipt transaction, not a receive payments transaction.
2170
- */
2171
- receivePayment: {
2172
- /**
2173
- * Receives a customer payment into QuickBooks. A receive payment
2174
- * transaction is used for one or more of these purposes:
2175
- * 1. To record a customer’s payment against an invoice for one or more
2176
- * jobs,
2177
- * 2. To set a discount (for early payment, for example),
2178
- * 3. To set a credit (from previously returned merchandise, for example).
2179
- *
2180
- * If full payment is received at the time of sale, it is recorded using a
2181
- * sales receipt transaction, not a receive payments transaction.
2182
- *
2183
- * Notice that access to sensitive data permissions are not required to use
2184
- * this request. However, if the application does not have access to
2185
- * sensitive data permission, then the response returned will not contain
2186
- * certain sensitive data. For example, even if credit card data is supplied
2187
- * in the `ReceivePaymentAdd` request via the `CreditCardTxnInfo` aggregate,
2188
- * the response will not contain the corresponding aggregate.
2189
- *
2190
- * This request can be used to record QBMS credit card transaction data, via
2191
- * the `CreditCardTxnInfo` aggregate. You can record charges and also
2192
- * authorizations. (You can later respond to a QBMS capture of authorized
2193
- * charges by doing a `ReceivePaymentMod` and changing the
2194
- * `CreditCardTxnType` to “Charge”.) Notice that the reconciliation data
2195
- * fields (`ReconBatchID`, `PaymentGroupingCode`, `PaymentStatus`,
2196
- * `TxnAuthorizationTime`, `TxnAuthorizationStamp`, `ClientTransID`) are
2197
- * optional ONLY if the `CreditCardTxnType` is “Authorization”. If the type
2198
- * is “Charge”, then those reconciliation fields must be supplied or you
2199
- * will get a runtime error.
2200
- *
2201
- * IMPORTANT: In a `SalesReceiptAdd` or `ReceivePaymentAdd` request that
2202
- * contains credit card transaction data supplied from QBMS transaction
2203
- * responses, you must specify the payment method (using the
2204
- * `PaymentMethodRef` aggregate).
2205
- *
2206
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentAdd
2207
- */
2208
- add: (endUserId: string, params: QbdTypes.ReceivePaymentAddRq["ReceivePaymentAdd"]) => Promise<NonNullable<QbdTypes.ReceivePaymentAddRs["ReceivePaymentRet"]>>;
2209
- /**
2210
- * Modifies a receive payment transaction.
2211
- *
2212
- * If you save QBMS credit card data in your `ReceivePayments`, this Mod
2213
- * request allows you to capture a previously authorized credit card charge.
2214
- * The way this works is that the ReceivePaymentAdd would contain the QBMS
2215
- * `CreditCardTxnInfo` aggregate with the `CreditCardTxnType` set to
2216
- * “Authorization,” which causes QB to internally mark the transaction as
2217
- * pending. When the capture transaction is performed later, in QBMS, that
2218
- * capture transaction can be saved into QuickBooks via this Mod request, as
2219
- * you are modifying the original `ReceivePayment` but changing its
2220
- * `CreditCardTxnType` from ”Authorization” to “Capture.” This mod operation
2221
- * results in the removal of the pending status and the posting of this
2222
- * receive payment.
2223
- *
2224
- * Notice that the reconciliation data fields (`ReconBatchID`,
2225
- * `PaymentGroupingCode`, `PaymentStatus`, `TxnAuthorizationTime`,
2226
- * `TxnAuthorizationStamp`, `ClientTransID`) are optional ONLY if the
2227
- * `CreditCardTxnType` is “Authorization” because authorizations don’t have
2228
- * such data. If the type is “Charge”, then those reconciliation fields must
2229
- * be supplied or you will get a runtime error.
2230
- *
2231
- * The following list describes what you can and can’t do with this request.
2232
- * - Modify `RefNumber` or `Memo`.
2233
- * - Modify (not clear) the `CustomerRef` field for a payment that was not
2234
- * electronically processed.
2235
- * - Modify (not clear) the `ARAccountRef`.
2236
- * - Modify (not clear) the `TxnDate`.
2237
- * - Modify or clear the `TotalAmount`.
2238
- * - Modify or clear the `PaymentMethodRef`.
2239
- * - Modify, (not clear) the `DepositToAccountRef`
2240
- * - Change the payment amount applied to an invoice. For a receive payment
2241
- * transaction that has been applied to several existing invoices,
2242
- * redistribute the payment amounts applied to the invoices.
2243
- * - Change the discount amount applied to particular invoice.
2244
- * - You cannot change the credit amount applied to an invoice.
2245
- * - Apply the payment to a different invoice, including a discount and a
2246
- * credit. Apply the payment amount to a different invoice. Apply a
2247
- * discount, and a credit. The existing distribution is cleared, except
2248
- * for any credit that may have been applied.
2249
- * - Modify QBMS credit card information.
2250
- * - You cannot auto apply payment.
2251
- * - Apply an additional credit to an invoice.
2252
- *
2253
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentMod
2254
- */
2255
- mod: (endUserId: string, params: QbdTypes.ReceivePaymentModRq["ReceivePaymentMod"]) => Promise<NonNullable<QbdTypes.ReceivePaymentModRs["ReceivePaymentRet"]>>;
2256
- /**
2257
- * Queries for the specified receive payment or set of payments.
2258
- *
2259
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentQuery
2260
- */
2261
- query: (endUserId: string, params?: QbdTypes.ReceivePaymentQueryRq) => Promise<NonNullable<QbdTypes.ReceivePaymentQueryRs["ReceivePaymentRet"]>>;
2262
- };
2263
- /**
2264
- * A report in QuickBooks Desktop is a tool that allows users to generate
2265
- * detailed financial statements and overviews, such as Profit and Loss
2266
- * statements or General Ledger detail reports, tailored to their specific
2267
- * needs.
2268
- */
2269
- report: {
2270
- /**
2271
- * Generates an aging report, which tracks outstanding invoices (in accounts
2272
- * receivable accounts) and unpaid bills (in accounts payable accounts).
2273
- *
2274
- * Note that you could use a collections report instead of the aging query,
2275
- * if that better suited your needs.
2276
- *
2277
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AgingReportQuery
2278
- */
2279
- aging: (endUserId: string, params: QbdTypes.AgingReportQueryRq) => Promise<NonNullable<QbdTypes.AgingReportQueryRs["ReportRet"]>>;
2280
- /**
2281
- * Generates budget reports similar to the budget report functionality that
2282
- * is available within the QuickBooks UI. (From the main QB menubar select
2283
- * Reports->Budgets & Forecasts.)
2284
- *
2285
- * Note: the graphing functionality, forecasts, and memorized reports that
2286
- * are available through the UI are not supported by the SDK.
2287
- *
2288
- * Notice that if you simply use the default instead of specifying the
2289
- * Fiscal Year, the `ReportPeriod` defaults to “year to date.” You cannot
2290
- * change the default to “This Fiscal Year.”
2291
- *
2292
- * There can only be one balance sheet budget for each fiscal year, one
2293
- * profit and loss (P&L) by account budget per fiscal year, and one profit
2294
- * and loss (P&L) by account and customer budget per fiscal year. Hence the
2295
- * `FiscalYear` element is key in specifying which budget you want. Notice
2296
- * that there are two “views” into each of the two budget categories: the
2297
- * Overview, which shows the budget itself, and the Actual, which shows how
2298
- * expenditures are currently running against the budget.
2299
- *
2300
- * All of the budget reports supported in the UI are supported in the SDK,
2301
- * although the UI and SDK nomenclature differs slightly. The UI shows
2302
- * Budget Overview and Budget Vs Actual as choices in the selection list,
2303
- * with Balance Sheet and P&L as subchoices in a subsequent selection list,
2304
- * already filtered by Accounts, or Accounts and Classes, or Accounts and
2305
- * Customers, if these are available.
2306
- *
2307
- * In comparison, you choose the budget view you want via the SDK
2308
- * `BudgetSummaryType` element, which has these possible values:
2309
- * - `BalanceSheetBudgetOverview`
2310
- * - `BalanceSheetBudgetVsActual`
2311
- * - `ProfitAndLossBudgetOverview`
2312
- * - `ProfitAndLossBudgetVsActual`
2313
- *
2314
- * Then you specify any additional filtering by the Budget Criterion value
2315
- * you specify (`Accounts`, `AccountsAndCustomers`, or
2316
- * `AccountsAndClasses`). Notice that before you can obtain a Budget report,
2317
- * the “target” budget must be defined in QuickBooks, via the UI, because
2318
- * you cannot create a budget via the SDK.
2319
- *
2320
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BudgetSummaryReportQuery
2321
- */
2322
- budgetSummary: (endUserId: string, params: QbdTypes.BudgetSummaryReportQueryRq) => Promise<NonNullable<QbdTypes.BudgetSummaryReportQueryRs["ReportRet"]>>;
2323
- /**
2324
- * A Custom Transaction Detail report gives you complete control over the
2325
- * content of the report. It does not have any default values and consists
2326
- * entirely of customized data. You must specify all the include columns for
2327
- * the transactions you want returned in the report.
2328
- *
2329
- * If you want complete control over the report content, you will be
2330
- * interested in both the custom summary report and the custom transaction
2331
- * detail report. Custom reports do not make any assumptions about the data
2332
- * you are interested in–they require you to specify exactly what data you
2333
- * want included in the report. Your application has to select the row and
2334
- * column axes, and it controls the output using common customization
2335
- * parameters for dates and filters. For the custom transaction detail
2336
- * report, you must specify all the include columns for the transactions you
2337
- * want returned in the report. For these reports, you are also required to
2338
- * specify a date element a `DateMacro` or a custom date range).
2339
- *
2340
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomDetailReportQuery
2341
- */
2342
- customDetail: (endUserId: string, params: QbdTypes.CustomDetailReportQueryRq) => Promise<NonNullable<QbdTypes.CustomDetailReportQueryRs["ReportRet"]>>;
2343
- /**
2344
- * A custom summary report gives you complete control over the content of
2345
- * the report. It does not have any default values and consists entirely of
2346
- * customized data.
2347
- *
2348
- * If you want complete control over the report content, you will be
2349
- * interested in both the custom summary report and the custom transaction
2350
- * detail report. Custom reports do not make any assumptions about the data
2351
- * you are interested in–they require you to specify exactly what data you
2352
- * want included in the report. Your application has to select the row and
2353
- * column axes, and it controls the output using common customization
2354
- * parameters for dates and filters. For the custom transaction detail
2355
- * report, you must specify all the include columns for the transactions you
2356
- * want returned in the report. For these reports, you are also required to
2357
- * specify a date element a ``DateMacro`` or a custom date range).
2358
- *
2359
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomSummaryReportQuery
2360
- */
2361
- customSummary: (endUserId: string, params: QbdTypes.CustomSummaryReportQueryRq) => Promise<NonNullable<QbdTypes.CustomSummaryReportQueryRs["ReportRet"]>>;
2362
- /**
2363
- * You use this report query to get any of the supported QuickBooks detail
2364
- * reports, which you specify in the `GeneralDetailReportType`. You can
2365
- * optionally display the report within QB by setting `DisplayReport` to
2366
- * True.
2367
- *
2368
- * You can also use this detail report to get information not obtainable
2369
- * from various SDK queries. For example, suppose you wanted the cleared
2370
- * status from a `BillPaymentCheck`; the `BillPaymentCheckQuery` wouldn’t
2371
- * have this info, but you could use this general detail report and specify
2372
- * the column `ClearedStatus` to find that information.
2373
- *
2374
- * Also, if you wanted to query the accounts receivable directly, you could
2375
- * do a General Detail Report Query with the report type set to Open
2376
- * Invoices.
2377
- *
2378
- * You could also use this report if you needed to run a report on all
2379
- * invoice changes made in a specific day, and only include changes to
2380
- * invoices from a given past month, if the audit trail is on in QuickBooks.
2381
- * You would use a `GeneralDetailReport` query with the report type set to
2382
- * `AuditTrail`.
2383
- *
2384
- * Notice that if a line is paid, `PaidStatus == “X”`. If a line is not
2385
- * paid, no entry for `PaidStatus` is returned.
2386
- *
2387
- * However, in the same report run within the QB GUI, the following behavior
2388
- * is observed: This differs from the UI, where if the line is paid, an
2389
- * entry of “Paid” is displayed and if the line is not paid, an entry of
2390
- * “Unpaid” is displayed.
2391
- *
2392
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/GeneralDetailReportQuery
2393
- */
2394
- generalDetail: (endUserId: string, params: QbdTypes.GeneralDetailReportQueryRq) => Promise<NonNullable<QbdTypes.GeneralDetailReportQueryRs["ReportRet"]>>;
2395
- /**
2396
- * The General Summary Reports category is the largest category for summary
2397
- * reports. In addition to common customizations, the reports within this
2398
- * category can be customized by the number of columns that are returned and
2399
- * by period comparisons for the data in the report.
2400
- *
2401
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/GeneralSummaryReportQuery
2402
- */
2403
- generalSummary: (endUserId: string, params: QbdTypes.GeneralSummaryReportQueryRq) => Promise<NonNullable<QbdTypes.GeneralSummaryReportQueryRs["ReportRet"]>>;
2404
- /**
2405
- * Queries for a job report, which includes both summary and transaction
2406
- * detail reports. The reports can be customized only by date range, by
2407
- * column summarization, and by common filters. Some job reports require a
2408
- * `customer:job` reference in order to work.
2409
- *
2410
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JobReportQuery
2411
- */
2412
- job: (endUserId: string, params: QbdTypes.JobReportQueryRq) => Promise<NonNullable<QbdTypes.JobReportQueryRs["ReportRet"]>>;
2413
- /**
2414
- * This report returns information from any of three QuickBooks payroll
2415
- * reports:
2416
- * - Payroll summary report: This report shows the total wages, taxes
2417
- * withheld, deductions from net pay, additions to net pay, and
2418
- * employer-paid taxes and contributions for each employee on the payroll.
2419
- * - Employee earnings summary report: This report shows information similar
2420
- * to the payroll summary report, but in a different layout. The report
2421
- * has a row for each employee and a column for each payroll item.
2422
- * - Payroll liability balances report: This report lists the payroll
2423
- * liabilities the QuickBooks company owes to various agencies, such as
2424
- * the federal government, your state government, insurance plan
2425
- * administrators, labor unions, etc. The report covers unpaid liabilities
2426
- * incurred during the period of time shown in the From and To fields. If
2427
- * the company paid a liability incurred within the date range of the
2428
- * report, the report omits that liability, even if the payment occurred
2429
- * after the ending date of the report.
2430
- *
2431
- * Payroll Summary Reports can be generated if your application is accessing
2432
- * a company file that is currently signed up for a subscription to a
2433
- * payroll service. (If your application is not signed up, it will receive
2434
- * an error when it attempts to generate a report in this category.)
2435
- *
2436
- * The restrictions noted above about payroll reports requiring the use of
2437
- * the Intuit Payroll service do not apply to the QuickBooks sample
2438
- * companies. You can still test out these reports on the sample companies
2439
- * without subscribing to the payroll service. For all other companies,
2440
- * however, the company must be subscribed.
2441
- *
2442
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollSummaryReportQuery
2443
- */
2444
- payrollSummary: (endUserId: string, params: QbdTypes.PayrollSummaryReportQueryRq) => Promise<NonNullable<QbdTypes.PayrollSummaryReportQueryRs["ReportRet"]>>;
2445
- /**
2446
- * Returns information from any of five QuickBooks payroll reports:
2447
- * - Employee state taxes detail report
2448
- * - Payroll item detail report (lists the payroll transactions on which
2449
- * each payroll item appears)
2450
- * - Payroll detail review report (provides detailed information about how
2451
- * QuickBooks calculates tax amounts on employee paychecks and in
2452
- * year-to-date transactions)
2453
- * - Payroll transaction detail report (shows the line-item detail that
2454
- * appears on each payroll transaction)
2455
- * - Payroll transactions by payee report (lists payroll transactions,
2456
- * grouping them by payee)
2457
- *
2458
- * Payroll Summary Reports can be generated if your application is accessing
2459
- * a company file that is currently signed up for a subscription to a
2460
- * payroll service. (If your application is not signed up, it will receive
2461
- * an error when it attempts to generate a report in this category.)
2462
- *
2463
- * The restrictions noted above about payroll reports requiring the use of
2464
- * the Intuit Payroll service do not apply to the QuickBooks sample
2465
- * companies. You can still test out these reports on the sample companies
2466
- * without subscribing to the payroll service. For all other companies,
2467
- * however, the company must be subscribed.
2468
- *
2469
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollDetailReportQuery
2470
- */
2471
- payrollDetail: (endUserId: string, params: QbdTypes.PayrollDetailReportQueryRq) => Promise<NonNullable<QbdTypes.PayrollDetailReportQueryRs["ReportRet"]>>;
2472
- /**
2473
- * The Time Reports category includes summary and detail reports related by
2474
- * time. Summarized columns can be customized in these reports.
2475
- *
2476
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeReportQuery
2477
- */
2478
- time: (endUserId: string, params: QbdTypes.TimeReportQueryRq) => Promise<NonNullable<QbdTypes.TimeReportQueryRs["ReportRet"]>>;
2479
- };
2480
- /**
2481
- * A sales order tracks inventory that is on back order for a customer. In
2482
- * QuickBooks, sales orders and invoices use similar fields, and a sales order
2483
- * can be “converted” into an invoice (by linking the invoice to the sales
2484
- * order) once the inventory is in stock.
2485
- */
2486
- salesOrder: {
2487
- /**
2488
- * Adds a sales order.
2489
- *
2490
- * A sales order tracks inventory that is on back order for a customer. In
2491
- * QuickBooks, sales orders and invoices use similar fields, and a sales
2492
- * order can be “converted” into an invoice (by linking the invoice to the
2493
- * sales order) once the inventory is in stock.
2494
- *
2495
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderAdd
2496
- */
2497
- add: (endUserId: string, params: QbdTypes.SalesOrderAddRq["SalesOrderAdd"]) => Promise<NonNullable<QbdTypes.SalesOrderAddRs["SalesOrderRet"]>>;
2498
- /**
2499
- * Modifies a sales order.
2500
- *
2501
- * Some fields in a `SalesOrderMod` request cannot be cleared. If any of the
2502
- * following fields is included in a sales-order modify request, it must
2503
- * contain a value:
2504
- * - `CustomerRef`
2505
- * - `TemplateRef`
2506
- * - `TxnDate`
2507
- * - `DueDate`
2508
- * - `ShipDate`
2509
- * - `ItemSalesTaxRef`
2510
- * - `IsManuallyClosed`
2511
- * - `IsToBePrinted`
2512
- *
2513
- * Within `SalesOrderLineMod` or `SalesOrderLineGroupMod`:
2514
- * - `ItemRef`
2515
- * - `Quantity`
2516
- * - `Rate`
2517
- * - `Amount`
2518
- * - `SalesTaxCodeRef`
2519
- * - `IsManuallyClosed`
2520
- *
2521
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderMod
2522
- */
2523
- mod: (endUserId: string, params: QbdTypes.SalesOrderModRq["SalesOrderMod"]) => Promise<NonNullable<QbdTypes.SalesOrderModRs["SalesOrderRet"]>>;
2524
- /**
2525
- * Queries for the specified sales order or set of sales orders.
2526
- *
2527
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderQuery
2528
- */
2529
- query: (endUserId: string, params?: QbdTypes.SalesOrderQueryRq) => Promise<NonNullable<QbdTypes.SalesOrderQueryRs["SalesOrderRet"]>>;
2530
- };
2531
- /**
2532
- * Sales receipts include payments by cash, check, or credit card.
2533
- */
2534
- salesReceipt: {
2535
- /**
2536
- * Adds a sales receipt to QuickBooks.
2537
- *
2538
- * Notice that access to sensitive data permissions are not required to use
2539
- * this request. However, if the application does not have access to
2540
- * sensitive data permission, then the response returned will not contain
2541
- * certain sensitive data. For example, even if credit card data is supplied
2542
- * in the `SalesReceiptAdd` request via the `CreditCardTxnInfo` aggregate,
2543
- * the response will not contain the corresponding aggregate.
2544
- *
2545
- * Sales receipts are used to record point-of-sale payments. Sales receipts
2546
- * include payments by cash, check, or credit card. Note: If full payment is
2547
- * not received at the time of the sale, do not use a sales receipt.
2548
- * Instead, use an invoice transaction and record the partial payment using
2549
- * a payment item.
2550
- *
2551
- * IMPORTANT: In a `SalesReceiptAdd` or `ReceivePaymentAdd` request that
2552
- * contains credit card transaction data supplied from QBMS transaction
2553
- * responses, you must specify the payment method (using the
2554
- * `PaymentMethodRef` aggregate).
2555
- *
2556
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptAdd
2557
- */
2558
- add: (endUserId: string, params: QbdTypes.SalesReceiptAddRq["SalesReceiptAdd"]) => Promise<NonNullable<QbdTypes.SalesReceiptAddRs["SalesReceiptRet"]>>;
2559
- /**
2560
- * Modifies an existing Sales receipt.
2561
- *
2562
- * IMPORTANT: In a `SalesReceiptMod` request that contains credit card
2563
- * transaction data supplied from QBMS transaction responses, you cannot
2564
- * change the total amount recorded in the sale.
2565
- *
2566
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptMod
2567
- */
2568
- mod: (endUserId: string, params: QbdTypes.SalesReceiptModRq["SalesReceiptMod"]) => Promise<NonNullable<QbdTypes.SalesReceiptModRs["SalesReceiptRet"]>>;
2569
- /**
2570
- * Queries for the specified sales receipt or set of receipts.
2571
- *
2572
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesReceiptQuery
2573
- */
2574
- query: (endUserId: string, params?: QbdTypes.SalesReceiptQueryRq) => Promise<NonNullable<QbdTypes.SalesReceiptQueryRs["SalesReceiptRet"]>>;
2575
- };
2576
- /**
2577
- * A sales rep is a sales representative listed on sales forms.
2578
- */
2579
- salesRep: {
2580
- /**
2581
- * Adds a sales rep.
2582
- *
2583
- * The sales representative must be on the Employee, Vendor, or Other Names
2584
- * list within QuickBooks. Sales representative’s names and initials appear
2585
- * on the Rep drop-down list on QuickBooks sales forms.
2586
- *
2587
- * A `SalesRepRef` refers to a person on the `SalesRep` list. In a request,
2588
- * if a `SalesRepRef` aggregate includes both `FullName` and `ListID`,
2589
- * `FullName` will be ignored.
2590
- *
2591
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepAdd
2592
- */
2593
- add: (endUserId: string, params: QbdTypes.SalesRepAddRq["SalesRepAdd"]) => Promise<NonNullable<QbdTypes.SalesRepAddRs["SalesRepRet"]>>;
2594
- /**
2595
- * Modifies a sales rep record.
2596
- *
2597
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepMod
2598
- */
2599
- mod: (endUserId: string, params: QbdTypes.SalesRepModRq["SalesRepMod"]) => Promise<NonNullable<QbdTypes.SalesRepModRs["SalesRepRet"]>>;
2600
- /**
2601
- * Queries for the specified sales rep or set of reps.
2602
- *
2603
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesRepQuery
2604
- */
2605
- query: (endUserId: string, params?: QbdTypes.SalesRepQueryRq) => Promise<NonNullable<QbdTypes.SalesRepQueryRs["SalesRepRet"]>>;
2606
- };
2607
- /**
2608
- * A sales tax code helps categorize items on a sales form as taxable or
2609
- * non-taxable, detailing reasons and associating tax codes with customers,
2610
- * items, or transactions.
2611
- */
2612
- salesTaxCode: {
2613
- /**
2614
- * Adds a sales tax code.
2615
- *
2616
- * Each item on a sales form is assigned a sales-tax code that indicates
2617
- * whether the item is taxable or non-taxable, and why. Two general codes,
2618
- * which can be modified but not deleted, appear on the sales-tax code list
2619
- * by default:
2620
- * - Non-taxable `(Name = NON; Desc = Non-Taxable; IsTaxable = false)`
2621
- * - Taxable `(Name = TAX; Desc = Taxable; IsTaxable = true)`
2622
- *
2623
- * A sales-tax code can be deleted only if it is no longer associated with
2624
- * any customer, item, or transaction. If the “Do You Charge Sales Tax?”
2625
- * preference within QuickBooks is set to No, QuickBooks will assign the
2626
- * default non-taxable sales-tax code to all sales.
2627
- *
2628
- * A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In
2629
- * a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and
2630
- * `ListID`, `FullName` will be ignored. In a Customer message,
2631
- * `SalesTaxCodeRef` refers to the sales-tax code that will be used for
2632
- * items related to this customer. In an ItemInventory message,
2633
- * `SalesTaxCodeRef` refers to the type of sales tax that will be charged
2634
- * for this item, if it is a taxable item and if sales tax is set up within
2635
- * QuickBooks.
2636
- *
2637
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeAdd
2638
- */
2639
- add: (endUserId: string, params: QbdTypes.SalesTaxCodeAddRq["SalesTaxCodeAdd"]) => Promise<NonNullable<QbdTypes.SalesTaxCodeAddRs["SalesTaxCodeRet"]>>;
2640
- /**
2641
- * Modifies the specified sales tax code, subject to a few limitations. You
2642
- * cannot use it to change a tax code’s `IsTaxable` property after the code
2643
- * has been used in any transaction. For the default QuickBooks taxable
2644
- * (Tax) and exempt (Non) tax codes, you can’t use this request to change
2645
- * the `IsTaxable` property at all, even before any transactions.
2646
- *
2647
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeMod
2648
- */
2649
- mod: (endUserId: string, params: QbdTypes.SalesTaxCodeModRq["SalesTaxCodeMod"]) => Promise<NonNullable<QbdTypes.SalesTaxCodeModRs["SalesTaxCodeRet"]>>;
2650
- /**
2651
- * Queries for the specified sales tax code or set of codes.
2652
- *
2653
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeQuery
2654
- */
2655
- query: (endUserId: string, params?: QbdTypes.SalesTaxCodeQueryRq) => Promise<NonNullable<QbdTypes.SalesTaxCodeQueryRs["SalesTaxCodeRet"]>>;
2656
- };
2657
- /**
2658
- * A sales tax payment check is a payment made for sales tax owed (for
2659
- * example, to a state sales tax authority).
2660
- */
2661
- salesTaxPaymentCheck: {
2662
- /**
2663
- * Adds a payment made for sales tax owed (for example, to a state sales tax
2664
- * authority).
2665
- *
2666
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxPaymentCheckAdd
2667
- */
2668
- add: (endUserId: string, params: QbdTypes.SalesTaxPaymentCheckAddRq["SalesTaxPaymentCheckAdd"]) => Promise<NonNullable<QbdTypes.SalesTaxPaymentCheckAddRs["SalesTaxPaymentCheckRet"]>>;
2669
- /**
2670
- * Modifies an existing sales tax payment check.
2671
- *
2672
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxPaymentCheckMod
2673
- */
2674
- mod: (endUserId: string, params: QbdTypes.SalesTaxPaymentCheckModRq["SalesTaxPaymentCheckMod"]) => Promise<NonNullable<QbdTypes.SalesTaxPaymentCheckModRs["SalesTaxPaymentCheckRet"]>>;
2675
- /**
2676
- * Queries for payments that have been made for sales tax owed (for example,
2677
- * to a state sales tax authority).
2678
- *
2679
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxPaymentCheckQuery
2680
- */
2681
- query: (endUserId: string, params?: QbdTypes.SalesTaxPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.SalesTaxPaymentCheckQueryRs["SalesTaxPaymentCheckRet"]>>;
2682
- };
2683
- /**
2684
- * Standard terms show the number of days within which payment is due and can
2685
- * include a discount for early payment. Payments with date-driven terms, on
2686
- * the other hand, are due by a certain date.
2687
- */
2688
- standardTerms: {
2689
- /**
2690
- * Adds a standard term. Standard terms show the number of days within which
2691
- * payment is due and can include a discount for early payment. For example,
2692
- * the following standard term means that payment is due in 30 days, with a
2693
- * 1% discount if payment is made within 10 days: "1% 10 Net 30".
2694
- *
2695
- * Payments with date-driven terms, on the other hand, are due by a certain
2696
- * date.
2697
- *
2698
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/StandardTermsAdd
2699
- */
2700
- add: (endUserId: string, params: QbdTypes.StandardTermsAddRq["StandardTermsAdd"]) => Promise<NonNullable<QbdTypes.StandardTermsAddRs["StandardTermsRet"]>>;
2701
- /**
2702
- * Queries for the specified standard term or set of terms.
2703
- *
2704
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/StandardTermsQuery
2705
- */
2706
- query: (endUserId: string, params?: QbdTypes.StandardTermsQueryRq) => Promise<NonNullable<QbdTypes.StandardTermsQueryRs["StandardTermsRet"]>>;
2707
- };
2708
- /**
2709
- * The time-tracking object facilitates payroll and invoicing based on work
2710
- * hours, assignable to vendors, employees, or others.
2711
- */
2712
- timeTracking: {
2713
- /**
2714
- * This request adds a time tracking transaction to QuickBooks, mirroring
2715
- * the time-tracking feature available in the QuickBooks UI. The time
2716
- * tracking feature allows a QuickBooks user to base payroll or invoices on
2717
- * time worked. You can add time-tracking information to any vendor,
2718
- * employee, or person on the Other Names list in QuickBooks.
2719
- *
2720
- * If `IsBillable` is set to true, both `CustomerRef` and `ItemServiceRef`
2721
- * are required. There is no link between an invoice and the time entries.
2722
- * However, when you do the invoicing from QuickBooks, QuickBooks does mark
2723
- * the time entries as “billed.” If you don’t record the time entries as
2724
- * billed properly, then you get into a user workflow issue where every time
2725
- * the user creates an invoice for a customer, QB pops up a dialog asking if
2726
- * they want to bill the un-billed time (which you already billed from your
2727
- * app).
2728
- *
2729
- * See more:
2730
- * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingAdd
2731
- */
2732
- add: (endUserId: string, params: QbdTypes.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<QbdTypes.TimeTrackingAddRs["TimeTrackingRet"]>>;
2733
- /**
2734
- * Modifies a time tracking transaction.
2735
- *
2736
- * This allows you to modify time entry and mark time entered as billed.
2737
- * Applications using qbXML spec levels less than 6.0 aren’t able to Modify
2738
- * a time tracking transaction. However, those applications can achieve the
2739
- * results of a modify operation by deleting the time tracking transaction
2740
- * (using `TxnDelRq`) and then re-adding it with the desired values. You can
2741
- * do this only if no other downstream transactions have used that
2742
- * particular time tracking transaction. (Otherwise, the `TxnDel` request
2743
- * will fail.) This differs slightly from the UI, which allows these
2744
- * transactions to be edited directly. However, even in the UI, modifying a
2745
- * time tracking transaction does not result in changes to any downstream
2746
- * transactions that use it. There is no link between an invoice and the
2747
- * time entries. However when you do the invoicing from QuickBooks,
2748
- * QuickBooks does mark the time entries as “billed.” If you don’t record
2749
- * the time entries as billed properly, then you get into a user workflow
2750
- * issue where every time the user creates an invoice for a customer, QB
2751
- * pops up a dialog asking if they want to bill the un-billed time (which
2752
- * you already billed from your app). That’s why beginning with QB2007 and
2753
- * qbXML spec 6.0 we added support for the “BillableStatus” field *and* add
2754
- * `TimeTrackingMod` so that you can mark the time as billed when you create
2755
- * an invoice for it.
2756
- *
2757
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingMod
2758
- */
2759
- mod: (endUserId: string, params: QbdTypes.TimeTrackingModRq["TimeTrackingMod"]) => Promise<NonNullable<QbdTypes.TimeTrackingModRs["TimeTrackingRet"]>>;
2760
- /**
2761
- * The time-tracking transactions that are returned in this query include
2762
- * time tracking information that was entered into QuickBooks manually or
2763
- * gathered using the QuickBooks “Timer” or “Stopwatch.” Note that the
2764
- * QuickBooks Timer application can run on its own without QuickBooks, but
2765
- * the QuickBooks SDK cannot access the Timer data directly. The Timer data
2766
- * must be imported into QuickBooks before it is accessible via the SDK.)
2767
- *
2768
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingQuery
2769
- */
2770
- query: (endUserId: string, params?: QbdTypes.TimeTrackingQueryRq) => Promise<NonNullable<QbdTypes.TimeTrackingQueryRs["TimeTrackingRet"]>>;
2771
- };
2772
- /**
2773
- * A general transaction is a superset of all transaction types in QuickBooks
2774
- * Desktop.
2775
- */
2776
- transaction: {
2777
- /**
2778
- * Queries for transactions across different transaction types. In contrast
2779
- * to the other transaction-specific queries, this query only returns data
2780
- * common to all transactions, such as `TxnID`, type, dates, accountRef, and
2781
- * so on. This query does return condensed transactions.
2782
- *
2783
- * Accordingly, if additional and more transaction-specific data is
2784
- * required, a subsequent call to the desired query can be used to get that
2785
- * transaction-specific data. For example, this method can be used to
2786
- * present all transactions in a certain date range, then the user can
2787
- * select a particular transaction, say an invoice transaction. In response
2788
- * to this choice, you could do an `InvoiceQuery` to pull up all of the
2789
- * invoice data.
2790
- *
2791
- * You should be aware that permissions are obeyed in this query. So, if you
2792
- * set the transaction type filter to “All” (or if you don’t set it at all),
2793
- * the query will be searching only those transaction types that are
2794
- * permissible types for the user currently logged in. Accordingly, if
2795
- * instead of “all,” you specify a transaction type that the currently
2796
- * logged in user is not permitted to access, you will get a runtime error,
2797
- * even if other permissible transaction types were specified as well.
2798
- *
2799
- * Finally, the transaction query is subject to sensitive data access level
2800
- * restrictions and payroll subscription status.
2801
- *
2802
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
2803
- */
2804
- query: (endUserId: string, params?: QbdTypes.TransactionQueryRq) => Promise<NonNullable<QbdTypes.TransactionQueryRs["TransactionRet"]>>;
2805
- /**
2806
- * Deleting a transaction removes it completely and irreversibly. (Using a
2807
- * `TxnVoid` request to void a transaction, on the other hand, sets its
2808
- * amount to zero but keeps a record of it in QuickBooks.)
2809
- *
2810
- * If you try to delete or void a transaction while it is in use, you will
2811
- * get an error. You will also get an error if you try to delete or void a
2812
- * transaction (say a sales receipt) while a linked transaction (such as a
2813
- * deposit) is in use. If you try to delete or void a transaction that was
2814
- * created before the company’s closing date, you might or might not get an
2815
- * error, depending on the permissions and passwords that are set in
2816
- * QuickBooks.
2817
- *
2818
- * The mode in which a QuickBooks company file is open (single-user or
2819
- * multi-user) does not impact your application’s ability to delete
2820
- * transaction objects from it. (List objects can only be deleted if the
2821
- * company file is open in single-user mode.)
2822
- *
2823
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
2824
- */
2825
- delete: (endUserId: string, params: QbdTypes.TxnDelRq) => Promise<NonNullable<QbdTypes.TxnDelRs>>;
2826
- /**
2827
- * Voiding a transaction sets its amount to zero but keeps a record of it in
2828
- * QuickBooks. (Using `TxnDel` to delete a transaction, on the other hand,
2829
- * removes the transaction completely.)
2830
- *
2831
- * If you try to void or delete a transaction while it is in use, you will
2832
- * get an error. You will also get an error if you try to void or delete a
2833
- * transaction (say a sales receipt) while a linked transaction (such as a
2834
- * deposit) is in use. If you try to void or delete a transaction that was
2835
- * created before the company’s closing date, you might or might not get an
2836
- * error, depending on the permissions and passwords that are set in
2837
- * QuickBooks.
2838
- *
2839
- * The mode in which a QuickBooks company file is open (single-user or
2840
- * multi-user) does not impact your application’s ability to void
2841
- * transaction objects in it.
2842
- *
2843
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnVoid
2844
- */
2845
- void: (endUserId: string, params: QbdTypes.TxnVoidRq) => Promise<NonNullable<QbdTypes.TxnVoidRs>>;
2846
- };
2847
- /**
2848
- * A transfer is a transaction that moves money from one account to another
2849
- * account.
2850
- */
2851
- transfer: {
2852
- /**
2853
- * Adds a transfer transaction.
2854
- *
2855
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferAdd
2856
- */
2857
- add: (endUserId: string, params: QbdTypes.TransferAddRq["TransferAdd"]) => Promise<NonNullable<QbdTypes.TransferAddRs["TransferRet"]>>;
2858
- /**
2859
- * Modifies a transfer transaction.
2860
- *
2861
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferMod
2862
- */
2863
- mod: (endUserId: string, params: QbdTypes.TransferModRq["TransferMod"]) => Promise<NonNullable<QbdTypes.TransferModRs["TransferRet"]>>;
2864
- /**
2865
- * Queries for the specified transfer or set of transfers.
2866
- *
2867
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferQuery
2868
- */
2869
- query: (endUserId: string, params?: QbdTypes.TransferQueryRq) => Promise<NonNullable<QbdTypes.TransferQueryRs["TransferRet"]>>;
2870
- };
2871
- /**
2872
- * An inventory transfer is the movement of inventory between two inventory
2873
- * sites.
2874
- */
2875
- transferInventory: {
2876
- /**
2877
- * Adds a transfer inventory transaction.
2878
- *
2879
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryAdd
2880
- */
2881
- add: (endUserId: string, params: QbdTypes.TransferInventoryAddRq["TransferInventoryAdd"]) => Promise<NonNullable<QbdTypes.TransferInventoryAddRs["TransferInventoryRet"]>>;
2882
- /**
2883
- * Modifies a transfer inventory transaction.
2884
- *
2885
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryMod
2886
- */
2887
- mod: (endUserId: string, params: QbdTypes.TransferInventoryModRq["TransferInventoryMod"]) => Promise<NonNullable<QbdTypes.TransferInventoryModRs["TransferInventoryRet"]>>;
2888
- /**
2889
- * Queries for the specified transfer inventory transaction or set of
2890
- * transfer inventory transactions.
2891
- *
2892
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryQuery
2893
- */
2894
- query: (endUserId: string, params?: QbdTypes.TransferInventoryQueryRq) => Promise<NonNullable<QbdTypes.TransferInventoryQueryRs["TransferInventoryRet"]>>;
2895
- };
2896
- /**
2897
- * Query deleted transaction elements, such as invoices, bills, and checks.
2898
- */
2899
- txnDeleted: {
2900
- /**
2901
- * Returns all transaction elements deleted within the last 90 days, grouped
2902
- * according to object type.
2903
- *
2904
- * For example, if the request specifies `TxnDelType` elements of `Bill` and
2905
- * then `Check`, it will return all the `Bill` deletes first, then all the
2906
- * `Check` deletes.
2907
- *
2908
- * By default, the records are returned in ascending order, according to the
2909
- * “real” delete time. For example:
2910
- * - If transaction A is deleted at 10 a.m. and B is deleted at 11 a.m., the
2911
- * query request will return A first, then B.
2912
- * - However, if the QuickBooks user moves the clock back before deleting B
2913
- * (for example, B is deleted at 9 a.m.), the query will still return
2914
- * first A then B, because B was deleted after A in “real” time.
2915
- *
2916
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDeletedQuery
2917
- */
2918
- query: (endUserId: string, params: QbdTypes.TxnDeletedQueryRq) => Promise<NonNullable<QbdTypes.TxnDeletedQueryRs["TxnDeletedRet"]>>;
2919
- };
2920
- /**
2921
- * A vehicle is used to add, select, and manage vehicles for tracking and
2922
- * billing mileage.
2923
- */
2924
- vehicle: {
2925
- /**
2926
- * Adds a vehicle to the vehicle list for use in `VehicleMileage`
2927
- * transactions. Each vehicle name must be unique.
2928
- *
2929
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleAdd
2930
- */
2931
- add: (endUserId: string, params: QbdTypes.VehicleAddRq["VehicleAdd"]) => Promise<NonNullable<QbdTypes.VehicleAddRs["VehicleRet"]>>;
2932
- /**
2933
- * Modifies a vehicle already in the vehicle list. Any modification,
2934
- * including changing the name, will cause corresponding changes in existing
2935
- * `VehicleMileage` transactions and in reports.
2936
- *
2937
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleMod
2938
- */
2939
- mod: (endUserId: string, params: QbdTypes.VehicleModRq["VehicleMod"]) => Promise<NonNullable<QbdTypes.VehicleModRs["VehicleRet"]>>;
2940
- /**
2941
- * Queries for the specified vehicle or set of vehicles.
2942
- *
2943
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleQuery
2944
- */
2945
- query: (endUserId: string, params?: QbdTypes.VehicleQueryRq) => Promise<NonNullable<QbdTypes.VehicleQueryRs["VehicleRet"]>>;
2946
- };
2947
- /**
2948
- * Vehicle mileage records a mileage transaction for a specified vehicle,
2949
- * using provided or calculated miles.
2950
- */
2951
- vehicleMileage: {
2952
- /**
2953
- * Adds a vehicle mileage transaction. involving the specified vehicle for
2954
- * the specified total miles or optionally for the QuickBooks calculated
2955
- * total miles if you supply the odometer start and end.
2956
- *
2957
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleMileageAdd
2958
- */
2959
- add: (endUserId: string, params: QbdTypes.VehicleMileageAddRq["VehicleMileageAdd"]) => Promise<NonNullable<QbdTypes.VehicleMileageAddRs["VehicleMileageRet"]>>;
2960
- /**
2961
- * Queries for the specified vehicle mileage transaction or set of vehicle
2962
- * mileage transactions.
2963
- *
2964
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleMileageQuery
2965
- */
2966
- query: (endUserId: string, params?: QbdTypes.VehicleMileageQueryRq) => Promise<NonNullable<QbdTypes.VehicleMileageQueryRs["VehicleMileageRet"]>>;
2967
- };
2968
- /**
2969
- * A vendor is any person or company from whom a small business owner buys
2970
- * goods and services. (Banks and tax agencies usually are included on the
2971
- * vendor list.) A company’s vendor list contains information such as account
2972
- * balance and contact information about each vendor.
2973
- */
2974
- vendor: {
2975
- /**
2976
- * Adds a vendor.
2977
- *
2978
- * A vendor is any person or company from whom a small business owner buys
2979
- * goods and services. (Banks and tax agencies usually are included on the
2980
- * vendor list.) A company’s vendor list contains information such as
2981
- * account balance and contact information about each vendor. A `VendorRef`
2982
- * aggregate refers to one of the vendors on the list. In a request, if a
2983
- * `VendorRef` aggregate includes both `FullName` and `ListID`, `FullName`
2984
- * will be ignored.
2985
- *
2986
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorAdd
2987
- */
2988
- add: (endUserId: string, params: QbdTypes.VendorAddRq["VendorAdd"]) => Promise<NonNullable<QbdTypes.VendorAddRs["VendorRet"]>>;
2989
- /**
2990
- * Modifies a vendor.
2991
- *
2992
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorMod
2993
- */
2994
- mod: (endUserId: string, params: QbdTypes.VendorModRq["VendorMod"]) => Promise<NonNullable<QbdTypes.VendorModRs["VendorRet"]>>;
2995
- /**
2996
- * Queries for the specified vendor or set of vendors.
2997
- *
2998
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorQuery
2999
- */
3000
- query: (endUserId: string, params?: QbdTypes.VendorQueryRq) => Promise<NonNullable<QbdTypes.VendorQueryRs["VendorRet"]>>;
3001
- };
3002
- /**
3003
- * A vendor credit is also known as a “bill credit”. That is, it is a credit
3004
- * that a vendor owes you because you overpaid your bill, returned
3005
- * merchandise, or for some other reason.
3006
- */
3007
- vendorCredit: {
3008
- /**
3009
- * Adds a vendor credit.
3010
- *
3011
- * A vendor credit is also known as a “bill credit”. That is, it is a credit
3012
- * that a vendor owes you because you overpaid your bill, returned
3013
- * merchandise, or for some other reason. The `VendorCredit` is referenced
3014
- * in a BilPayment transaction, inside the `SetCredit` aggregate.
3015
- *
3016
- * A `VendorCredit` should not be confused with a Credit Memo, which is
3017
- * something you owe your customer and which is referenced in a
3018
- * `ReceivePayment` request.
3019
- *
3020
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditAdd
3021
- */
3022
- add: (endUserId: string, params: QbdTypes.VendorCreditAddRq["VendorCreditAdd"]) => Promise<NonNullable<QbdTypes.VendorCreditAddRs["VendorCreditRet"]>>;
3023
- /**
3024
- * Modifies a vendor credit. Be careful! If you modify ANY line item, you
3025
- * must fully re-construct the line item table as you want it because if you
3026
- * edit even a single line item, any line item that is NOT in the vendor
3027
- * credit mod will be omitted. For full details, see the QB SDK Programmer’s
3028
- * Guide chapter on modifying and deleting transactions and list objects.
3029
- *
3030
- * A vendor credit is also known as a “bill credit”. That is, it is a credit
3031
- * that a vendor owes you because you overpaid your bill, returned
3032
- * merchandise, or for some other reason. The `VendorCredit` is referenced
3033
- * in a BilPayment transaction, inside the `SetCredit` aggregate.
3034
- *
3035
- * A `VendorCredit` should not be confused with a Credit Memo, which is
3036
- * something you owe your customer and which is referenced in a
3037
- * `ReceivePayment` request.
3038
- *
3039
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditMod
3040
- */
3041
- mod: (endUserId: string, params: QbdTypes.VendorCreditModRq["VendorCreditMod"]) => Promise<NonNullable<QbdTypes.VendorCreditModRs["VendorCreditRet"]>>;
3042
- /**
3043
- * Queries for the specified vendor credit or set of credits.
3044
- *
3045
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditQuery
3046
- */
3047
- query: (endUserId: string, params?: QbdTypes.VendorCreditQueryRq) => Promise<NonNullable<QbdTypes.VendorCreditQueryRs["VendorCreditRet"]>>;
3048
- };
3049
- /**
3050
- * A vendor type allows business owners to categorize vendors in ways that are
3051
- * meaningful for their businesses. For example, a vendor type might indicate
3052
- * which industry a vendor represents, or which part of the country a vendor
3053
- * is in.
3054
- */
3055
- vendorType: {
3056
- /**
3057
- * Adds a vendor type. A vendor type allows business owners to categorize
3058
- * vendors in ways that are meaningful for their businesses. For example, a
3059
- * vendor type might indicate which industry a vendor represents, or which
3060
- * part of the country a vendor is in.
3061
- *
3062
- * A `VendorTypeRef` aggregate refers to one of the types on the
3063
- * `VendorType` list. In a request, if a `VendorTypeRef` aggregate includes
3064
- * both `FullName` and `ListID`, `FullName` will be ignored.
3065
- *
3066
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeAdd
3067
- */
3068
- add: (endUserId: string, params: QbdTypes.VendorTypeAddRq["VendorTypeAdd"]) => Promise<NonNullable<QbdTypes.VendorTypeAddRs["VendorTypeRet"]>>;
3069
- /**
3070
- * Queries for the specified vendor type or set of types.
3071
- *
3072
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeQuery
3073
- */
3074
- query: (endUserId: string, params?: QbdTypes.VendorTypeQueryRq) => Promise<NonNullable<QbdTypes.VendorTypeQueryRs["VendorTypeRet"]>>;
3075
- };
3076
- /**
3077
- * A workers comp code categorizes occupations based on risk, determining
3078
- * insurance premiums for workers' compensation coverage.
3079
- */
3080
- workersCompCode: {
3081
- /**
3082
- * Adds a workers’ compensation code with one or more rate entries (each
3083
- * rate entry has an effective date and a rate). You can assign effective
3084
- * dates in the past, present or future. However, only one future date will
3085
- * be used. If a future date exists and you write a new one (using the Mod
3086
- * request) then the most recently written code wins; if you have multiple
3087
- * future dates in the Add request, the last one wins.
3088
- *
3089
- * This request requires the company to be subscribed to Intuit Payroll
3090
- * service. Also, you cannot currently assign codes to employees in the SDK;
3091
- * you have to use the UI to do that.
3092
- *
3093
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeAdd
3094
- */
3095
- add: (endUserId: string, params: QbdTypes.WorkersCompCodeAddRq["WorkersCompCodeAdd"]) => Promise<NonNullable<QbdTypes.WorkersCompCodeAddRs["WorkersCompCodeRet"]>>;
3096
- /**
3097
- * Modifies an existing workers’ compensation code. Notice that if a future
3098
- * date exists and you write a new one (using the Mod request) then the most
3099
- * recently written code wins.
3100
- *
3101
- * This request requires the company to be subscribed to Intuit Payroll
3102
- * service. Also, you cannot currently assign codes to employees in the SDK;
3103
- * you have to use the UI to do that.
3104
- *
3105
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeMod
3106
- */
3107
- mod: (endUserId: string, params: QbdTypes.WorkersCompCodeModRq["WorkersCompCodeMod"]) => Promise<NonNullable<QbdTypes.WorkersCompCodeModRs["WorkersCompCodeRet"]>>;
3108
- /**
3109
- * Queries for the workers’ compensation codes specified in the query
3110
- * filter; you can filter by name, modified date, and effective date.
3111
- *
3112
- * This request requires the company to be subscribed to Intuit Payroll
3113
- * service.
3114
- *
3115
- * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeQuery
3116
- */
3117
- query: (endUserId: string, params?: QbdTypes.WorkersCompCodeQueryRq) => Promise<NonNullable<QbdTypes.WorkersCompCodeQueryRs["WorkersCompCodeRet"]>>;
3118
- };
3119
- private sendRequestWrapper;
3120
- }