conductor-node 12.29.0 → 12.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (236) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/package.json +1 -1
  3. package/resources/qbd/accounts.d.ts +16 -14
  4. package/resources/qbd/accounts.d.ts.map +1 -1
  5. package/resources/qbd/bill-check-payments.d.ts +22 -18
  6. package/resources/qbd/bill-check-payments.d.ts.map +1 -1
  7. package/resources/qbd/bill-check-payments.js.map +1 -1
  8. package/resources/qbd/bill-check-payments.mjs.map +1 -1
  9. package/resources/qbd/bill-credit-card-payments.d.ts +22 -18
  10. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
  11. package/resources/qbd/bill-credit-card-payments.js.map +1 -1
  12. package/resources/qbd/bill-credit-card-payments.mjs.map +1 -1
  13. package/resources/qbd/bills.d.ts +22 -18
  14. package/resources/qbd/bills.d.ts.map +1 -1
  15. package/resources/qbd/bills.js.map +1 -1
  16. package/resources/qbd/bills.mjs.map +1 -1
  17. package/resources/qbd/build-assemblies.d.ts +22 -18
  18. package/resources/qbd/build-assemblies.d.ts.map +1 -1
  19. package/resources/qbd/build-assemblies.js.map +1 -1
  20. package/resources/qbd/build-assemblies.mjs.map +1 -1
  21. package/resources/qbd/checks.d.ts +22 -18
  22. package/resources/qbd/checks.d.ts.map +1 -1
  23. package/resources/qbd/checks.js.map +1 -1
  24. package/resources/qbd/checks.mjs.map +1 -1
  25. package/resources/qbd/classes.d.ts +16 -14
  26. package/resources/qbd/classes.d.ts.map +1 -1
  27. package/resources/qbd/credit-card-charges.d.ts +22 -18
  28. package/resources/qbd/credit-card-charges.d.ts.map +1 -1
  29. package/resources/qbd/credit-card-charges.js.map +1 -1
  30. package/resources/qbd/credit-card-charges.mjs.map +1 -1
  31. package/resources/qbd/credit-card-credits.d.ts +22 -18
  32. package/resources/qbd/credit-card-credits.d.ts.map +1 -1
  33. package/resources/qbd/credit-card-credits.js.map +1 -1
  34. package/resources/qbd/credit-card-credits.mjs.map +1 -1
  35. package/resources/qbd/credit-memos.d.ts +22 -18
  36. package/resources/qbd/credit-memos.d.ts.map +1 -1
  37. package/resources/qbd/credit-memos.js.map +1 -1
  38. package/resources/qbd/credit-memos.mjs.map +1 -1
  39. package/resources/qbd/currencies.d.ts +438 -0
  40. package/resources/qbd/currencies.d.ts.map +1 -0
  41. package/resources/qbd/currencies.js +93 -0
  42. package/resources/qbd/currencies.js.map +1 -0
  43. package/resources/qbd/currencies.mjs +89 -0
  44. package/resources/qbd/currencies.mjs.map +1 -0
  45. package/resources/qbd/customers.d.ts +20 -18
  46. package/resources/qbd/customers.d.ts.map +1 -1
  47. package/resources/qbd/customers.js.map +1 -1
  48. package/resources/qbd/customers.mjs.map +1 -1
  49. package/resources/qbd/date-driven-terms.d.ts +16 -14
  50. package/resources/qbd/date-driven-terms.d.ts.map +1 -1
  51. package/resources/qbd/deleted-list-objects.d.ts +16 -14
  52. package/resources/qbd/deleted-list-objects.d.ts.map +1 -1
  53. package/resources/qbd/deleted-transactions.d.ts +16 -14
  54. package/resources/qbd/deleted-transactions.d.ts.map +1 -1
  55. package/resources/qbd/discount-items.d.ts +16 -14
  56. package/resources/qbd/discount-items.d.ts.map +1 -1
  57. package/resources/qbd/discount-items.js.map +1 -1
  58. package/resources/qbd/discount-items.mjs.map +1 -1
  59. package/resources/qbd/employees.d.ts +16 -14
  60. package/resources/qbd/employees.d.ts.map +1 -1
  61. package/resources/qbd/estimates.d.ts +22 -18
  62. package/resources/qbd/estimates.d.ts.map +1 -1
  63. package/resources/qbd/estimates.js.map +1 -1
  64. package/resources/qbd/estimates.mjs.map +1 -1
  65. package/resources/qbd/index.d.ts +1 -0
  66. package/resources/qbd/index.d.ts.map +1 -1
  67. package/resources/qbd/index.js +4 -2
  68. package/resources/qbd/index.js.map +1 -1
  69. package/resources/qbd/index.mjs +1 -0
  70. package/resources/qbd/index.mjs.map +1 -1
  71. package/resources/qbd/inventory-adjustments.d.ts +22 -18
  72. package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
  73. package/resources/qbd/inventory-assembly-items.d.ts +16 -14
  74. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  75. package/resources/qbd/inventory-assembly-items.js.map +1 -1
  76. package/resources/qbd/inventory-assembly-items.mjs.map +1 -1
  77. package/resources/qbd/inventory-items.d.ts +16 -14
  78. package/resources/qbd/inventory-items.d.ts.map +1 -1
  79. package/resources/qbd/inventory-items.js.map +1 -1
  80. package/resources/qbd/inventory-items.mjs.map +1 -1
  81. package/resources/qbd/inventory-sites.d.ts +16 -14
  82. package/resources/qbd/inventory-sites.d.ts.map +1 -1
  83. package/resources/qbd/invoices.d.ts +22 -18
  84. package/resources/qbd/invoices.d.ts.map +1 -1
  85. package/resources/qbd/invoices.js.map +1 -1
  86. package/resources/qbd/invoices.mjs.map +1 -1
  87. package/resources/qbd/item-groups.d.ts +16 -14
  88. package/resources/qbd/item-groups.d.ts.map +1 -1
  89. package/resources/qbd/item-groups.js.map +1 -1
  90. package/resources/qbd/item-groups.mjs.map +1 -1
  91. package/resources/qbd/item-receipts.d.ts +22 -18
  92. package/resources/qbd/item-receipts.d.ts.map +1 -1
  93. package/resources/qbd/item-receipts.js.map +1 -1
  94. package/resources/qbd/item-receipts.mjs.map +1 -1
  95. package/resources/qbd/item-sites.d.ts +4 -4
  96. package/resources/qbd/journal-entries.d.ts +22 -18
  97. package/resources/qbd/journal-entries.d.ts.map +1 -1
  98. package/resources/qbd/journal-entries.js.map +1 -1
  99. package/resources/qbd/journal-entries.mjs.map +1 -1
  100. package/resources/qbd/non-inventory-items.d.ts +16 -14
  101. package/resources/qbd/non-inventory-items.d.ts.map +1 -1
  102. package/resources/qbd/non-inventory-items.js.map +1 -1
  103. package/resources/qbd/non-inventory-items.mjs.map +1 -1
  104. package/resources/qbd/other-charge-items.d.ts +16 -14
  105. package/resources/qbd/other-charge-items.d.ts.map +1 -1
  106. package/resources/qbd/other-charge-items.js.map +1 -1
  107. package/resources/qbd/other-charge-items.mjs.map +1 -1
  108. package/resources/qbd/other-names.d.ts +16 -14
  109. package/resources/qbd/other-names.d.ts.map +1 -1
  110. package/resources/qbd/payment-methods.d.ts +16 -14
  111. package/resources/qbd/payment-methods.d.ts.map +1 -1
  112. package/resources/qbd/payroll-wage-items.d.ts +16 -14
  113. package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
  114. package/resources/qbd/payroll-wage-items.js.map +1 -1
  115. package/resources/qbd/payroll-wage-items.mjs.map +1 -1
  116. package/resources/qbd/price-levels.d.ts +16 -14
  117. package/resources/qbd/price-levels.d.ts.map +1 -1
  118. package/resources/qbd/purchase-orders.d.ts +22 -18
  119. package/resources/qbd/purchase-orders.d.ts.map +1 -1
  120. package/resources/qbd/purchase-orders.js.map +1 -1
  121. package/resources/qbd/purchase-orders.mjs.map +1 -1
  122. package/resources/qbd/qbd.d.ts +4 -0
  123. package/resources/qbd/qbd.d.ts.map +1 -1
  124. package/resources/qbd/qbd.js +4 -0
  125. package/resources/qbd/qbd.js.map +1 -1
  126. package/resources/qbd/qbd.mjs +4 -0
  127. package/resources/qbd/qbd.mjs.map +1 -1
  128. package/resources/qbd/receive-payments.d.ts +22 -18
  129. package/resources/qbd/receive-payments.d.ts.map +1 -1
  130. package/resources/qbd/receive-payments.js.map +1 -1
  131. package/resources/qbd/receive-payments.mjs.map +1 -1
  132. package/resources/qbd/sales-orders.d.ts +22 -18
  133. package/resources/qbd/sales-orders.d.ts.map +1 -1
  134. package/resources/qbd/sales-orders.js.map +1 -1
  135. package/resources/qbd/sales-orders.mjs.map +1 -1
  136. package/resources/qbd/sales-receipts.d.ts +22 -18
  137. package/resources/qbd/sales-receipts.d.ts.map +1 -1
  138. package/resources/qbd/sales-receipts.js.map +1 -1
  139. package/resources/qbd/sales-receipts.mjs.map +1 -1
  140. package/resources/qbd/sales-representatives.d.ts +16 -14
  141. package/resources/qbd/sales-representatives.d.ts.map +1 -1
  142. package/resources/qbd/sales-tax-codes.d.ts +16 -14
  143. package/resources/qbd/sales-tax-codes.d.ts.map +1 -1
  144. package/resources/qbd/sales-tax-items.d.ts +16 -14
  145. package/resources/qbd/sales-tax-items.d.ts.map +1 -1
  146. package/resources/qbd/sales-tax-items.js.map +1 -1
  147. package/resources/qbd/sales-tax-items.mjs.map +1 -1
  148. package/resources/qbd/service-items.d.ts +16 -14
  149. package/resources/qbd/service-items.d.ts.map +1 -1
  150. package/resources/qbd/service-items.js.map +1 -1
  151. package/resources/qbd/service-items.mjs.map +1 -1
  152. package/resources/qbd/standard-terms.d.ts +16 -14
  153. package/resources/qbd/standard-terms.d.ts.map +1 -1
  154. package/resources/qbd/subtotal-items.d.ts +16 -14
  155. package/resources/qbd/subtotal-items.d.ts.map +1 -1
  156. package/resources/qbd/subtotal-items.js.map +1 -1
  157. package/resources/qbd/subtotal-items.mjs.map +1 -1
  158. package/resources/qbd/templates.d.ts +4 -4
  159. package/resources/qbd/time-tracking-activities.d.ts +22 -18
  160. package/resources/qbd/time-tracking-activities.d.ts.map +1 -1
  161. package/resources/qbd/time-tracking-activities.js.map +1 -1
  162. package/resources/qbd/time-tracking-activities.mjs.map +1 -1
  163. package/resources/qbd/transactions.d.ts +22 -18
  164. package/resources/qbd/transactions.d.ts.map +1 -1
  165. package/resources/qbd/transactions.js.map +1 -1
  166. package/resources/qbd/transactions.mjs.map +1 -1
  167. package/resources/qbd/transfers.d.ts +22 -18
  168. package/resources/qbd/transfers.d.ts.map +1 -1
  169. package/resources/qbd/transfers.js.map +1 -1
  170. package/resources/qbd/transfers.mjs.map +1 -1
  171. package/resources/qbd/unit-of-measure-sets.d.ts +16 -14
  172. package/resources/qbd/unit-of-measure-sets.d.ts.map +1 -1
  173. package/resources/qbd/vendor-credits.d.ts +22 -18
  174. package/resources/qbd/vendor-credits.d.ts.map +1 -1
  175. package/resources/qbd/vendor-credits.js.map +1 -1
  176. package/resources/qbd/vendor-credits.mjs.map +1 -1
  177. package/resources/qbd/vendors.d.ts +20 -18
  178. package/resources/qbd/vendors.d.ts.map +1 -1
  179. package/resources/qbd/vendors.js.map +1 -1
  180. package/resources/qbd/vendors.mjs.map +1 -1
  181. package/src/resources/qbd/accounts.ts +16 -14
  182. package/src/resources/qbd/bill-check-payments.ts +22 -18
  183. package/src/resources/qbd/bill-credit-card-payments.ts +22 -18
  184. package/src/resources/qbd/bills.ts +22 -18
  185. package/src/resources/qbd/build-assemblies.ts +22 -18
  186. package/src/resources/qbd/checks.ts +22 -18
  187. package/src/resources/qbd/classes.ts +16 -14
  188. package/src/resources/qbd/credit-card-charges.ts +22 -18
  189. package/src/resources/qbd/credit-card-credits.ts +22 -18
  190. package/src/resources/qbd/credit-memos.ts +22 -18
  191. package/src/resources/qbd/currencies.ts +533 -0
  192. package/src/resources/qbd/customers.ts +20 -18
  193. package/src/resources/qbd/date-driven-terms.ts +16 -14
  194. package/src/resources/qbd/deleted-list-objects.ts +16 -14
  195. package/src/resources/qbd/deleted-transactions.ts +16 -14
  196. package/src/resources/qbd/discount-items.ts +16 -14
  197. package/src/resources/qbd/employees.ts +16 -14
  198. package/src/resources/qbd/estimates.ts +22 -18
  199. package/src/resources/qbd/index.ts +9 -0
  200. package/src/resources/qbd/inventory-adjustments.ts +22 -18
  201. package/src/resources/qbd/inventory-assembly-items.ts +16 -14
  202. package/src/resources/qbd/inventory-items.ts +16 -14
  203. package/src/resources/qbd/inventory-sites.ts +16 -14
  204. package/src/resources/qbd/invoices.ts +22 -18
  205. package/src/resources/qbd/item-groups.ts +16 -14
  206. package/src/resources/qbd/item-receipts.ts +22 -18
  207. package/src/resources/qbd/item-sites.ts +4 -4
  208. package/src/resources/qbd/journal-entries.ts +22 -18
  209. package/src/resources/qbd/non-inventory-items.ts +16 -14
  210. package/src/resources/qbd/other-charge-items.ts +16 -14
  211. package/src/resources/qbd/other-names.ts +16 -14
  212. package/src/resources/qbd/payment-methods.ts +16 -14
  213. package/src/resources/qbd/payroll-wage-items.ts +16 -14
  214. package/src/resources/qbd/price-levels.ts +16 -14
  215. package/src/resources/qbd/purchase-orders.ts +22 -18
  216. package/src/resources/qbd/qbd.ts +22 -0
  217. package/src/resources/qbd/receive-payments.ts +22 -18
  218. package/src/resources/qbd/sales-orders.ts +22 -18
  219. package/src/resources/qbd/sales-receipts.ts +22 -18
  220. package/src/resources/qbd/sales-representatives.ts +16 -14
  221. package/src/resources/qbd/sales-tax-codes.ts +16 -14
  222. package/src/resources/qbd/sales-tax-items.ts +16 -14
  223. package/src/resources/qbd/service-items.ts +16 -14
  224. package/src/resources/qbd/standard-terms.ts +16 -14
  225. package/src/resources/qbd/subtotal-items.ts +16 -14
  226. package/src/resources/qbd/templates.ts +4 -4
  227. package/src/resources/qbd/time-tracking-activities.ts +22 -18
  228. package/src/resources/qbd/transactions.ts +22 -18
  229. package/src/resources/qbd/transfers.ts +22 -18
  230. package/src/resources/qbd/unit-of-measure-sets.ts +16 -14
  231. package/src/resources/qbd/vendor-credits.ts +22 -18
  232. package/src/resources/qbd/vendors.ts +20 -18
  233. package/src/version.ts +1 -1
  234. package/version.d.ts +1 -1
  235. package/version.js +1 -1
  236. package/version.mjs +1 -1
@@ -0,0 +1,533 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from "../../resource.js";
4
+ import * as Core from "../../core.js";
5
+
6
+ export class Currencies extends APIResource {
7
+ /**
8
+ * Creates a user-defined currency with the specified name and currency code.
9
+ * Exchange rates for user-defined currencies are not updated automatically by
10
+ * QuickBooks Desktop; update them manually as needed.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const currency = await conductor.qbd.currencies.create({
15
+ * currencyCode: 'USD',
16
+ * name: 'United States Dollar',
17
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
18
+ * });
19
+ * ```
20
+ */
21
+ create(params: CurrencyCreateParams, options?: Core.RequestOptions): Core.APIPromise<Currency> {
22
+ const { conductorEndUserId, ...body } = params;
23
+ return this._client.post('/quickbooks-desktop/currencies', {
24
+ body,
25
+ ...options,
26
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
27
+ });
28
+ }
29
+
30
+ /**
31
+ * Retrieves a currency by ID.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const currency = await conductor.qbd.currencies.retrieve(
36
+ * '80000001-1234567890',
37
+ * { conductorEndUserId: 'end_usr_1234567abcdefg' },
38
+ * );
39
+ * ```
40
+ */
41
+ retrieve(
42
+ id: string,
43
+ params: CurrencyRetrieveParams,
44
+ options?: Core.RequestOptions,
45
+ ): Core.APIPromise<Currency> {
46
+ const { conductorEndUserId } = params;
47
+ return this._client.get(`/quickbooks-desktop/currencies/${id}`, {
48
+ ...options,
49
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
50
+ });
51
+ }
52
+
53
+ /**
54
+ * Updates an existing currency. For built-in currencies, only the `isActive`
55
+ * status can be changed; name and currency code are not editable. For user-defined
56
+ * currencies, all fields in this request are editable.
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * const currency = await conductor.qbd.currencies.update(
61
+ * '80000001-1234567890',
62
+ * {
63
+ * revisionNumber: '1721172183',
64
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
65
+ * },
66
+ * );
67
+ * ```
68
+ */
69
+ update(id: string, params: CurrencyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Currency> {
70
+ const { conductorEndUserId, ...body } = params;
71
+ return this._client.post(`/quickbooks-desktop/currencies/${id}`, {
72
+ body,
73
+ ...options,
74
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
75
+ });
76
+ }
77
+
78
+ /**
79
+ * Returns a list of currencies. NOTE: QuickBooks Desktop does not support
80
+ * pagination for currencies; hence, there is no `cursor` parameter. Users
81
+ * typically have few currencies.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const currencies = await conductor.qbd.currencies.list({
86
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
87
+ * });
88
+ * ```
89
+ */
90
+ list(params: CurrencyListParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyListResponse> {
91
+ const { conductorEndUserId, ...query } = params;
92
+ return this._client.get('/quickbooks-desktop/currencies', {
93
+ query,
94
+ ...options,
95
+ headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
96
+ });
97
+ }
98
+ }
99
+
100
+ export interface Currency {
101
+ /**
102
+ * The unique identifier assigned by QuickBooks to this currency. This ID is unique
103
+ * across all currencies but not across different QuickBooks object types.
104
+ */
105
+ id: string;
106
+
107
+ /**
108
+ * The date when the exchange rate for this currency was last updated, in ISO 8601
109
+ * format (YYYY-MM-DD).
110
+ */
111
+ asOfDate: string | null;
112
+
113
+ /**
114
+ * The date and time when this currency was created, in ISO 8601 format
115
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
116
+ * timezone of the end-user's computer.
117
+ */
118
+ createdAt: string;
119
+
120
+ /**
121
+ * The internationally accepted currency code used by this currency, typically
122
+ * based on the ISO 4217 standard (for example, USD for US Dollars). Built-in
123
+ * QuickBooks currencies follow ISO 4217. For user-defined currencies, following
124
+ * ISO 4217 is recommended but not required. In many cases, the three-letter code
125
+ * is formed from the country's two-letter internet code plus a currency letter
126
+ * (e.g., BZ + D → BZD for Belize Dollar).
127
+ */
128
+ currencyCode: string;
129
+
130
+ /**
131
+ * Controls how this currency displays thousands separators, grouping, and decimal
132
+ * places.
133
+ */
134
+ currencyFormat: Currency.CurrencyFormat | null;
135
+
136
+ /**
137
+ * The market exchange rate between this currency's currency and the home currency
138
+ * in QuickBooks at the time of this transaction. Represented as a decimal value
139
+ * (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
140
+ */
141
+ exchangeRate: number | null;
142
+
143
+ /**
144
+ * Indicates whether this currency is active. Inactive objects are typically hidden
145
+ * from views and reports in QuickBooks. Defaults to `true`.
146
+ */
147
+ isActive: boolean;
148
+
149
+ /**
150
+ * Indicates whether this currency was created by a QuickBooks user (`true`) or is
151
+ * a built-in currency (`false`).
152
+ */
153
+ isUserDefinedCurrency: boolean | null;
154
+
155
+ /**
156
+ * The case-insensitive unique name of this currency, unique across all currencies.
157
+ * For built-in currencies, the name is the internationally accepted currency name
158
+ * and is not editable.
159
+ *
160
+ * **NOTE**: Currencies do not have a `fullName` field because they are not
161
+ * hierarchical objects, which is why `name` is unique for them but not for objects
162
+ * that have parents.
163
+ */
164
+ name: string;
165
+
166
+ /**
167
+ * The type of object. This value is always `"qbd_currency"`.
168
+ */
169
+ objectType: 'qbd_currency';
170
+
171
+ /**
172
+ * The current QuickBooks-assigned revision number of this currency object, which
173
+ * changes each time the object is modified. When updating this object, you must
174
+ * provide the most recent `revisionNumber` to ensure you're working with the
175
+ * latest data; otherwise, the update will return an error.
176
+ */
177
+ revisionNumber: string;
178
+
179
+ /**
180
+ * The date and time when this currency was last updated, in ISO 8601 format
181
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
182
+ * timezone of the end-user's computer.
183
+ */
184
+ updatedAt: string;
185
+ }
186
+
187
+ export namespace Currency {
188
+ /**
189
+ * Controls how this currency displays thousands separators, grouping, and decimal
190
+ * places.
191
+ */
192
+ export interface CurrencyFormat {
193
+ /**
194
+ * Controls the number of decimal places displayed for currency values. Use `0` to
195
+ * hide decimals or `2` to display cents.
196
+ */
197
+ decimalPlaces: '0' | '2' | null;
198
+
199
+ /**
200
+ * Controls the decimal separator when displaying currency values (for example,
201
+ * "1.00" vs "1,00"). Defaults to period.
202
+ */
203
+ decimalSeparator: 'comma' | 'period' | null;
204
+
205
+ /**
206
+ * Controls the thousands separator when displaying currency values (for example,
207
+ * "1,000,000"). Defaults to comma.
208
+ */
209
+ thousandSeparator: 'apostrophe' | 'comma' | 'period' | 'space' | null;
210
+
211
+ /**
212
+ * Controls how digits are grouped for thousands when displaying currency values
213
+ * (for example, "10,000,000").
214
+ */
215
+ thousandSeparatorGrouping: 'x_xx_xx_xxx' | 'xx_xxx_xxx' | null;
216
+ }
217
+ }
218
+
219
+ export interface CurrencyListResponse {
220
+ /**
221
+ * The array of currencies.
222
+ */
223
+ data: Array<Currency>;
224
+
225
+ /**
226
+ * The type of object. This value is always `"list"`.
227
+ */
228
+ objectType: 'list';
229
+
230
+ /**
231
+ * The endpoint URL where this list can be accessed.
232
+ */
233
+ url: string;
234
+ }
235
+
236
+ export interface CurrencyCreateParams {
237
+ /**
238
+ * Body param: The internationally accepted currency code used by this currency,
239
+ * typically based on the ISO 4217 standard (for example, USD for US Dollars).
240
+ * Built-in QuickBooks currencies follow ISO 4217. For user-defined currencies,
241
+ * following ISO 4217 is recommended but not required. In many cases, the
242
+ * three-letter code is formed from the country's two-letter internet code plus a
243
+ * currency letter (e.g., BZ + D → BZD for Belize Dollar).
244
+ *
245
+ * Maximum length: 3 characters.
246
+ */
247
+ currencyCode: string;
248
+
249
+ /**
250
+ * Body param: The case-insensitive unique name of this currency, unique across all
251
+ * currencies. For built-in currencies, the name is the internationally accepted
252
+ * currency name and is not editable.
253
+ *
254
+ * **NOTE**: Currencies do not have a `fullName` field because they are not
255
+ * hierarchical objects, which is why `name` is unique for them but not for objects
256
+ * that have parents.
257
+ *
258
+ * Maximum length: 64 characters.
259
+ */
260
+ name: string;
261
+
262
+ /**
263
+ * Header param: The ID of the EndUser to receive this request (e.g.,
264
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
265
+ */
266
+ conductorEndUserId: string;
267
+
268
+ /**
269
+ * Body param: Controls how this currency displays thousands separators, grouping,
270
+ * and decimal places.
271
+ */
272
+ currencyFormat?: CurrencyCreateParams.CurrencyFormat;
273
+
274
+ /**
275
+ * Body param: Indicates whether this currency is active. Inactive objects are
276
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
277
+ */
278
+ isActive?: boolean;
279
+ }
280
+
281
+ export namespace CurrencyCreateParams {
282
+ /**
283
+ * Controls how this currency displays thousands separators, grouping, and decimal
284
+ * places.
285
+ */
286
+ export interface CurrencyFormat {
287
+ /**
288
+ * Controls the number of decimal places displayed for currency values. Use `0` to
289
+ * hide decimals or `2` to display cents.
290
+ */
291
+ decimalPlaces?: '0' | '2';
292
+
293
+ /**
294
+ * Controls the decimal separator when displaying currency values (for example,
295
+ * "1.00" vs "1,00"). Defaults to period.
296
+ */
297
+ decimalSeparator?: 'comma' | 'period';
298
+
299
+ /**
300
+ * Controls the thousands separator when displaying currency values (for example,
301
+ * "1,000,000"). Defaults to comma.
302
+ */
303
+ thousandSeparator?: 'apostrophe' | 'comma' | 'period' | 'space';
304
+
305
+ /**
306
+ * Controls how digits are grouped for thousands when displaying currency values
307
+ * (for example, "10,000,000").
308
+ */
309
+ thousandSeparatorGrouping?: 'x_xx_xx_xxx' | 'xx_xxx_xxx';
310
+ }
311
+ }
312
+
313
+ export interface CurrencyRetrieveParams {
314
+ /**
315
+ * The ID of the EndUser to receive this request (e.g.,
316
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
317
+ */
318
+ conductorEndUserId: string;
319
+ }
320
+
321
+ export interface CurrencyUpdateParams {
322
+ /**
323
+ * Body param: The current QuickBooks-assigned revision number of the currency
324
+ * object you are updating, which you can get by fetching the object first. Provide
325
+ * the most recent `revisionNumber` to ensure you're working with the latest data;
326
+ * otherwise, the update will return an error.
327
+ */
328
+ revisionNumber: string;
329
+
330
+ /**
331
+ * Header param: The ID of the EndUser to receive this request (e.g.,
332
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
333
+ */
334
+ conductorEndUserId: string;
335
+
336
+ /**
337
+ * Body param: The internationally accepted currency code used by this currency,
338
+ * typically based on the ISO 4217 standard (for example, USD for US Dollars).
339
+ * Built-in QuickBooks currencies follow ISO 4217. For user-defined currencies,
340
+ * following ISO 4217 is recommended but not required. In many cases, the
341
+ * three-letter code is formed from the country's two-letter internet code plus a
342
+ * currency letter (e.g., BZ + D → BZD for Belize Dollar).
343
+ *
344
+ * Maximum length: 3 characters.
345
+ */
346
+ currencyCode?: string;
347
+
348
+ /**
349
+ * Body param: Controls how this currency displays thousands separators, grouping,
350
+ * and decimal places.
351
+ */
352
+ currencyFormat?: CurrencyUpdateParams.CurrencyFormat;
353
+
354
+ /**
355
+ * Body param: Indicates whether this currency is active. Inactive objects are
356
+ * typically hidden from views and reports in QuickBooks. Defaults to `true`.
357
+ */
358
+ isActive?: boolean;
359
+
360
+ /**
361
+ * Body param: The case-insensitive unique name of this currency, unique across all
362
+ * currencies. For built-in currencies, the name is the internationally accepted
363
+ * currency name and is not editable.
364
+ *
365
+ * **NOTE**: Currencies do not have a `fullName` field because they are not
366
+ * hierarchical objects, which is why `name` is unique for them but not for objects
367
+ * that have parents.
368
+ *
369
+ * Maximum length: 64 characters.
370
+ */
371
+ name?: string;
372
+ }
373
+
374
+ export namespace CurrencyUpdateParams {
375
+ /**
376
+ * Controls how this currency displays thousands separators, grouping, and decimal
377
+ * places.
378
+ */
379
+ export interface CurrencyFormat {
380
+ /**
381
+ * Controls the number of decimal places displayed for currency values. Use `0` to
382
+ * hide decimals or `2` to display cents.
383
+ */
384
+ decimalPlaces?: '0' | '2';
385
+
386
+ /**
387
+ * Controls the decimal separator when displaying currency values (for example,
388
+ * "1.00" vs "1,00"). Defaults to period.
389
+ */
390
+ decimalSeparator?: 'comma' | 'period';
391
+
392
+ /**
393
+ * Controls the thousands separator when displaying currency values (for example,
394
+ * "1,000,000"). Defaults to comma.
395
+ */
396
+ thousandSeparator?: 'apostrophe' | 'comma' | 'period' | 'space';
397
+
398
+ /**
399
+ * Controls how digits are grouped for thousands when displaying currency values
400
+ * (for example, "10,000,000").
401
+ */
402
+ thousandSeparatorGrouping?: 'x_xx_xx_xxx' | 'xx_xxx_xxx';
403
+ }
404
+ }
405
+
406
+ export interface CurrencyListParams {
407
+ /**
408
+ * Header param: The ID of the EndUser to receive this request (e.g.,
409
+ * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
410
+ */
411
+ conductorEndUserId: string;
412
+
413
+ /**
414
+ * Query param: Filter for specific currencies by their QuickBooks-assigned unique
415
+ * identifier(s).
416
+ *
417
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
418
+ * query parameters for this request.
419
+ *
420
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
421
+ * request will return an error.
422
+ */
423
+ ids?: Array<string>;
424
+
425
+ /**
426
+ * Query param: The maximum number of objects to return.
427
+ *
428
+ * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
429
+ * currencies. This parameter will limit the response size, but you cannot fetch
430
+ * subsequent results using a cursor. For pagination, use the name-range parameters
431
+ * instead (e.g., `nameFrom=A&nameTo=B`).
432
+ *
433
+ * When this parameter is omitted, the endpoint returns all currencies without
434
+ * limit, unlike paginated endpoints which default to 150 records. This is
435
+ * acceptable because currencies typically have low record counts.
436
+ */
437
+ limit?: number;
438
+
439
+ /**
440
+ * Query param: Filter for currencies whose `name` contains this substring,
441
+ * case-insensitive.
442
+ *
443
+ * **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or
444
+ * `nameEndsWith`.
445
+ */
446
+ nameContains?: string;
447
+
448
+ /**
449
+ * Query param: Filter for currencies whose `name` ends with this substring,
450
+ * case-insensitive.
451
+ *
452
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
453
+ * `nameStartsWith`.
454
+ */
455
+ nameEndsWith?: string;
456
+
457
+ /**
458
+ * Query param: Filter for currencies whose `name` is alphabetically greater than
459
+ * or equal to this value.
460
+ */
461
+ nameFrom?: string;
462
+
463
+ /**
464
+ * Query param: Filter for specific currencies by their name(s), case-insensitive.
465
+ * Like `id`, `name` is a unique identifier for a currency.
466
+ *
467
+ * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
468
+ * query parameters for this request.
469
+ *
470
+ * **NOTE**: If any of the values you specify in this parameter are not found, the
471
+ * request will return an error.
472
+ */
473
+ names?: Array<string>;
474
+
475
+ /**
476
+ * Query param: Filter for currencies whose `name` starts with this substring,
477
+ * case-insensitive.
478
+ *
479
+ * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
480
+ * `nameEndsWith`.
481
+ */
482
+ nameStartsWith?: string;
483
+
484
+ /**
485
+ * Query param: Filter for currencies whose `name` is alphabetically less than or
486
+ * equal to this value.
487
+ */
488
+ nameTo?: string;
489
+
490
+ /**
491
+ * Query param: Filter for currencies that are active, inactive, or both.
492
+ */
493
+ status?: 'active' | 'all' | 'inactive';
494
+
495
+ /**
496
+ * Query param: Filter for currencies updated on or after this date/time. Accepts
497
+ * the following ISO 8601 formats:
498
+ *
499
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
500
+ * **start of the specified day** in the local timezone of the end-user's
501
+ * computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
502
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
503
+ * interprets the timestamp in the local timezone of the end-user's computer.
504
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
505
+ * interprets the timestamp using the specified timezone.
506
+ */
507
+ updatedAfter?: string;
508
+
509
+ /**
510
+ * Query param: Filter for currencies updated on or before this date/time. Accepts
511
+ * the following ISO 8601 formats:
512
+ *
513
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
514
+ * **end of the specified day** in the local timezone of the end-user's computer
515
+ * (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
516
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
517
+ * interprets the timestamp in the local timezone of the end-user's computer.
518
+ * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
519
+ * interprets the timestamp using the specified timezone.
520
+ */
521
+ updatedBefore?: string;
522
+ }
523
+
524
+ export declare namespace Currencies {
525
+ export {
526
+ type Currency as Currency,
527
+ type CurrencyListResponse as CurrencyListResponse,
528
+ type CurrencyCreateParams as CurrencyCreateParams,
529
+ type CurrencyRetrieveParams as CurrencyRetrieveParams,
530
+ type CurrencyUpdateParams as CurrencyUpdateParams,
531
+ type CurrencyListParams as CurrencyListParams,
532
+ };
533
+ }
@@ -180,8 +180,8 @@ export interface Customer {
180
180
 
181
181
  /**
182
182
  * The date and time when this customer was created, in ISO 8601 format
183
- * (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s local
184
- * timezone.
183
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
184
+ * timezone of the end-user's computer.
185
185
  */
186
186
  createdAt: string;
187
187
 
@@ -457,8 +457,8 @@ export interface Customer {
457
457
 
458
458
  /**
459
459
  * The date and time when this customer was last updated, in ISO 8601 format
460
- * (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s local
461
- * timezone.
460
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
461
+ * timezone of the end-user's computer.
462
462
  */
463
463
  updatedAt: string;
464
464
  }
@@ -473,8 +473,8 @@ export namespace Customer {
473
473
 
474
474
  /**
475
475
  * The date and time when this contact was created, in ISO 8601 format
476
- * (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s local
477
- * timezone.
476
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
477
+ * timezone of the end-user's computer.
478
478
  */
479
479
  createdAt: string;
480
480
 
@@ -530,8 +530,8 @@ export namespace Customer {
530
530
 
531
531
  /**
532
532
  * The date and time when this contact was last updated, in ISO 8601 format
533
- * (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s local
534
- * timezone.
533
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
534
+ * timezone of the end-user's computer.
535
535
  */
536
536
  updatedAt: string;
537
537
  }
@@ -2536,12 +2536,13 @@ export interface CustomerListParams extends CursorPageParams {
2536
2536
  * Query param: Filter for customers updated on or after this date/time. Accepts
2537
2537
  * the following ISO 8601 formats:
2538
2538
  *
2539
- * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets this as midnight in
2540
- * the host machine’s local timezone.
2541
- * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop uses
2542
- * the host machine’s local timezone to interpret the timestamp.
2539
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
2540
+ * **start of the specified day** in the local timezone of the end-user's
2541
+ * computer (e.g., `2025-01-01` `2025-01-01T00:00:00`).
2542
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
2543
+ * interprets the timestamp in the local timezone of the end-user's computer.
2543
2544
  * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
2544
- * uses this timezone to interpret the timestamp.
2545
+ * interprets the timestamp using the specified timezone.
2545
2546
  */
2546
2547
  updatedAfter?: string;
2547
2548
 
@@ -2549,12 +2550,13 @@ export interface CustomerListParams extends CursorPageParams {
2549
2550
  * Query param: Filter for customers updated on or before this date/time. Accepts
2550
2551
  * the following ISO 8601 formats:
2551
2552
  *
2552
- * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets this as midnight in
2553
- * the host machine’s local timezone.
2554
- * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop uses
2555
- * the host machine’s local timezone to interpret the timestamp.
2553
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
2554
+ * **end of the specified day** in the local timezone of the end-user's computer
2555
+ * (e.g., `2025-01-01` `2025-01-01T23:59:59`).
2556
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
2557
+ * interprets the timestamp in the local timezone of the end-user's computer.
2556
2558
  * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
2557
- * uses this timezone to interpret the timestamp.
2559
+ * interprets the timestamp using the specified timezone.
2558
2560
  */
2559
2561
  updatedBefore?: string;
2560
2562
  }
@@ -86,8 +86,8 @@ export interface DateDrivenTerm {
86
86
 
87
87
  /**
88
88
  * The date and time when this date-driven term was created, in ISO 8601 format
89
- * (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s local
90
- * timezone.
89
+ * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
90
+ * timezone of the end-user's computer.
91
91
  */
92
92
  createdAt: string;
93
93
 
@@ -148,8 +148,8 @@ export interface DateDrivenTerm {
148
148
 
149
149
  /**
150
150
  * The date and time when this date-driven term was last updated, in ISO 8601
151
- * format (YYYY-MM-DDThh:mm:ss±hh:mm), in the QuickBooks Desktop host machine’s
152
- * local timezone.
151
+ * format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the
152
+ * local timezone of the end-user's computer.
153
153
  */
154
154
  updatedAt: string;
155
155
  }
@@ -325,12 +325,13 @@ export interface DateDrivenTermListParams {
325
325
  * Query param: Filter for date-driven terms updated on or after this date/time.
326
326
  * Accepts the following ISO 8601 formats:
327
327
  *
328
- * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets this as midnight in
329
- * the host machine’s local timezone.
330
- * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop uses
331
- * the host machine’s local timezone to interpret the timestamp.
328
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
329
+ * **start of the specified day** in the local timezone of the end-user's
330
+ * computer (e.g., `2025-01-01` `2025-01-01T00:00:00`).
331
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
332
+ * interprets the timestamp in the local timezone of the end-user's computer.
332
333
  * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
333
- * uses this timezone to interpret the timestamp.
334
+ * interprets the timestamp using the specified timezone.
334
335
  */
335
336
  updatedAfter?: string;
336
337
 
@@ -338,12 +339,13 @@ export interface DateDrivenTermListParams {
338
339
  * Query param: Filter for date-driven terms updated on or before this date/time.
339
340
  * Accepts the following ISO 8601 formats:
340
341
  *
341
- * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets this as midnight in
342
- * the host machine’s local timezone.
343
- * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop uses
344
- * the host machine’s local timezone to interpret the timestamp.
342
+ * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
343
+ * **end of the specified day** in the local timezone of the end-user's computer
344
+ * (e.g., `2025-01-01` `2025-01-01T23:59:59`).
345
+ * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
346
+ * interprets the timestamp in the local timezone of the end-user's computer.
345
347
  * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
346
- * uses this timezone to interpret the timestamp.
348
+ * interprets the timestamp using the specified timezone.
347
349
  */
348
350
  updatedBefore?: string;
349
351
  }