conductor-node 14.16.0 → 14.17.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 (174) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/package.json +1 -1
  3. package/resources/qbd/accounts.d.mts +16 -12
  4. package/resources/qbd/accounts.d.mts.map +1 -1
  5. package/resources/qbd/accounts.d.ts +16 -12
  6. package/resources/qbd/accounts.d.ts.map +1 -1
  7. package/resources/qbd/bill-check-payments.d.mts +51 -57
  8. package/resources/qbd/bill-check-payments.d.mts.map +1 -1
  9. package/resources/qbd/bill-check-payments.d.ts +51 -57
  10. package/resources/qbd/bill-check-payments.d.ts.map +1 -1
  11. package/resources/qbd/bill-credit-card-payments.d.mts +37 -42
  12. package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -1
  13. package/resources/qbd/bill-credit-card-payments.d.ts +37 -42
  14. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
  15. package/resources/qbd/bills-to-pay.d.mts +295 -0
  16. package/resources/qbd/bills-to-pay.d.mts.map +1 -0
  17. package/resources/qbd/bills-to-pay.d.ts +295 -0
  18. package/resources/qbd/bills-to-pay.d.ts.map +1 -0
  19. package/resources/qbd/bills-to-pay.js +37 -0
  20. package/resources/qbd/bills-to-pay.js.map +1 -0
  21. package/resources/qbd/bills-to-pay.mjs +33 -0
  22. package/resources/qbd/bills-to-pay.mjs.map +1 -0
  23. package/resources/qbd/bills.d.mts +78 -64
  24. package/resources/qbd/bills.d.mts.map +1 -1
  25. package/resources/qbd/bills.d.ts +78 -64
  26. package/resources/qbd/bills.d.ts.map +1 -1
  27. package/resources/qbd/checks.d.mts +60 -45
  28. package/resources/qbd/checks.d.mts.map +1 -1
  29. package/resources/qbd/checks.d.ts +60 -45
  30. package/resources/qbd/checks.d.ts.map +1 -1
  31. package/resources/qbd/company.d.mts +1 -1
  32. package/resources/qbd/company.d.mts.map +1 -1
  33. package/resources/qbd/company.d.ts +1 -1
  34. package/resources/qbd/company.d.ts.map +1 -1
  35. package/resources/qbd/credit-card-charges.d.mts +60 -45
  36. package/resources/qbd/credit-card-charges.d.mts.map +1 -1
  37. package/resources/qbd/credit-card-charges.d.ts +60 -45
  38. package/resources/qbd/credit-card-charges.d.ts.map +1 -1
  39. package/resources/qbd/credit-card-credits.d.mts +60 -45
  40. package/resources/qbd/credit-card-credits.d.mts.map +1 -1
  41. package/resources/qbd/credit-card-credits.d.ts +60 -45
  42. package/resources/qbd/credit-card-credits.d.ts.map +1 -1
  43. package/resources/qbd/credit-card-refunds.d.mts +8 -7
  44. package/resources/qbd/credit-card-refunds.d.mts.map +1 -1
  45. package/resources/qbd/credit-card-refunds.d.ts +8 -7
  46. package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
  47. package/resources/qbd/credit-memos.d.mts +52 -41
  48. package/resources/qbd/credit-memos.d.mts.map +1 -1
  49. package/resources/qbd/credit-memos.d.ts +52 -41
  50. package/resources/qbd/credit-memos.d.ts.map +1 -1
  51. package/resources/qbd/customers.d.mts +20 -12
  52. package/resources/qbd/customers.d.mts.map +1 -1
  53. package/resources/qbd/customers.d.ts +20 -12
  54. package/resources/qbd/customers.d.ts.map +1 -1
  55. package/resources/qbd/discount-items.d.mts +16 -12
  56. package/resources/qbd/discount-items.d.mts.map +1 -1
  57. package/resources/qbd/discount-items.d.ts +16 -12
  58. package/resources/qbd/discount-items.d.ts.map +1 -1
  59. package/resources/qbd/estimates.d.mts +44 -33
  60. package/resources/qbd/estimates.d.mts.map +1 -1
  61. package/resources/qbd/estimates.d.ts +44 -33
  62. package/resources/qbd/estimates.d.ts.map +1 -1
  63. package/resources/qbd/index.d.mts +1 -0
  64. package/resources/qbd/index.d.mts.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-assembly-items.d.mts +16 -12
  72. package/resources/qbd/inventory-assembly-items.d.mts.map +1 -1
  73. package/resources/qbd/inventory-assembly-items.d.ts +16 -12
  74. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  75. package/resources/qbd/inventory-items.d.mts +16 -12
  76. package/resources/qbd/inventory-items.d.mts.map +1 -1
  77. package/resources/qbd/inventory-items.d.ts +16 -12
  78. package/resources/qbd/inventory-items.d.ts.map +1 -1
  79. package/resources/qbd/invoices.d.mts +57 -47
  80. package/resources/qbd/invoices.d.mts.map +1 -1
  81. package/resources/qbd/invoices.d.ts +57 -47
  82. package/resources/qbd/invoices.d.ts.map +1 -1
  83. package/resources/qbd/item-receipts.d.mts +66 -53
  84. package/resources/qbd/item-receipts.d.mts.map +1 -1
  85. package/resources/qbd/item-receipts.d.ts +66 -53
  86. package/resources/qbd/item-receipts.d.ts.map +1 -1
  87. package/resources/qbd/item-sites.d.mts +12 -0
  88. package/resources/qbd/item-sites.d.mts.map +1 -1
  89. package/resources/qbd/item-sites.d.ts +12 -0
  90. package/resources/qbd/item-sites.d.ts.map +1 -1
  91. package/resources/qbd/non-inventory-items.d.mts +16 -12
  92. package/resources/qbd/non-inventory-items.d.mts.map +1 -1
  93. package/resources/qbd/non-inventory-items.d.ts +16 -12
  94. package/resources/qbd/non-inventory-items.d.ts.map +1 -1
  95. package/resources/qbd/other-charge-items.d.mts +16 -12
  96. package/resources/qbd/other-charge-items.d.mts.map +1 -1
  97. package/resources/qbd/other-charge-items.d.ts +16 -12
  98. package/resources/qbd/other-charge-items.d.ts.map +1 -1
  99. package/resources/qbd/other-names.d.mts +4 -0
  100. package/resources/qbd/other-names.d.mts.map +1 -1
  101. package/resources/qbd/other-names.d.ts +4 -0
  102. package/resources/qbd/other-names.d.ts.map +1 -1
  103. package/resources/qbd/purchase-orders.d.mts +44 -33
  104. package/resources/qbd/purchase-orders.d.mts.map +1 -1
  105. package/resources/qbd/purchase-orders.d.ts +44 -33
  106. package/resources/qbd/purchase-orders.d.ts.map +1 -1
  107. package/resources/qbd/qbd.d.mts +4 -0
  108. package/resources/qbd/qbd.d.mts.map +1 -1
  109. package/resources/qbd/qbd.d.ts +4 -0
  110. package/resources/qbd/qbd.d.ts.map +1 -1
  111. package/resources/qbd/qbd.js +4 -0
  112. package/resources/qbd/qbd.js.map +1 -1
  113. package/resources/qbd/qbd.mjs +4 -0
  114. package/resources/qbd/qbd.mjs.map +1 -1
  115. package/resources/qbd/receive-payments.d.mts +57 -61
  116. package/resources/qbd/receive-payments.d.mts.map +1 -1
  117. package/resources/qbd/receive-payments.d.ts +57 -61
  118. package/resources/qbd/receive-payments.d.ts.map +1 -1
  119. package/resources/qbd/sales-orders.d.mts +44 -33
  120. package/resources/qbd/sales-orders.d.mts.map +1 -1
  121. package/resources/qbd/sales-orders.d.ts +44 -33
  122. package/resources/qbd/sales-orders.d.ts.map +1 -1
  123. package/resources/qbd/sales-receipts.d.mts +44 -33
  124. package/resources/qbd/sales-receipts.d.mts.map +1 -1
  125. package/resources/qbd/sales-receipts.d.ts +44 -33
  126. package/resources/qbd/sales-receipts.d.ts.map +1 -1
  127. package/resources/qbd/service-items.d.mts +16 -12
  128. package/resources/qbd/service-items.d.mts.map +1 -1
  129. package/resources/qbd/service-items.d.ts +16 -12
  130. package/resources/qbd/service-items.d.ts.map +1 -1
  131. package/resources/qbd/vendor-credits.d.mts +66 -53
  132. package/resources/qbd/vendor-credits.d.mts.map +1 -1
  133. package/resources/qbd/vendor-credits.d.ts +66 -53
  134. package/resources/qbd/vendor-credits.d.ts.map +1 -1
  135. package/resources/qbd/vendors.d.mts +20 -12
  136. package/resources/qbd/vendors.d.mts.map +1 -1
  137. package/resources/qbd/vendors.d.ts +20 -12
  138. package/resources/qbd/vendors.d.ts.map +1 -1
  139. package/src/resources/qbd/accounts.ts +16 -12
  140. package/src/resources/qbd/bill-check-payments.ts +51 -57
  141. package/src/resources/qbd/bill-credit-card-payments.ts +37 -42
  142. package/src/resources/qbd/bills-to-pay.ts +401 -0
  143. package/src/resources/qbd/bills.ts +78 -64
  144. package/src/resources/qbd/checks.ts +60 -45
  145. package/src/resources/qbd/company.ts +1 -0
  146. package/src/resources/qbd/credit-card-charges.ts +60 -45
  147. package/src/resources/qbd/credit-card-credits.ts +60 -45
  148. package/src/resources/qbd/credit-card-refunds.ts +8 -7
  149. package/src/resources/qbd/credit-memos.ts +52 -41
  150. package/src/resources/qbd/customers.ts +20 -12
  151. package/src/resources/qbd/discount-items.ts +16 -12
  152. package/src/resources/qbd/estimates.ts +44 -33
  153. package/src/resources/qbd/index.ts +6 -0
  154. package/src/resources/qbd/inventory-assembly-items.ts +16 -12
  155. package/src/resources/qbd/inventory-items.ts +16 -12
  156. package/src/resources/qbd/invoices.ts +57 -47
  157. package/src/resources/qbd/item-receipts.ts +66 -53
  158. package/src/resources/qbd/item-sites.ts +12 -0
  159. package/src/resources/qbd/non-inventory-items.ts +16 -12
  160. package/src/resources/qbd/other-charge-items.ts +16 -12
  161. package/src/resources/qbd/other-names.ts +4 -0
  162. package/src/resources/qbd/purchase-orders.ts +44 -33
  163. package/src/resources/qbd/qbd.ts +11 -0
  164. package/src/resources/qbd/receive-payments.ts +57 -61
  165. package/src/resources/qbd/sales-orders.ts +44 -33
  166. package/src/resources/qbd/sales-receipts.ts +44 -33
  167. package/src/resources/qbd/service-items.ts +16 -12
  168. package/src/resources/qbd/vendor-credits.ts +66 -53
  169. package/src/resources/qbd/vendors.ts +20 -12
  170. package/src/version.ts +1 -1
  171. package/version.d.mts +1 -1
  172. package/version.d.ts +1 -1
  173. package/version.js +1 -1
  174. package/version.mjs +1 -1
@@ -0,0 +1,401 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import { APIPromise } from '../../core/api-promise';
5
+ import { buildHeaders } from '../../internal/headers';
6
+ import { RequestOptions } from '../../internal/request-options';
7
+
8
+ export class BillsToPay extends APIResource {
9
+ /**
10
+ * Lists open vendor bills and available vendor credits for a specific QuickBooks
11
+ * Desktop vendor. Use each `bill.billId` as `applyToTransactions[].transactionId`
12
+ * in bill-payment requests. To apply a returned credit, place it under the target
13
+ * bill's `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId`
14
+ * to `credit.creditTransactionId`, and choose an `appliedAmount` that does not
15
+ * exceed `credit.creditRemaining` or the target bill's remaining amount due.
16
+ *
17
+ * **NOTE:** QuickBooks Desktop does not support pagination for bills to pay;
18
+ * hence, there is no `cursor` parameter. Users typically have few bills to pay.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const billsToPays = await conductor.qbd.billsToPay.list({
23
+ * vendorId: '80000001-1234567890',
24
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
25
+ * });
26
+ * ```
27
+ */
28
+ list(params: BillsToPayListParams, options?: RequestOptions): APIPromise<BillsToPayListResponse> {
29
+ const { conductorEndUserId, ...query } = params;
30
+ return this._client.get('/quickbooks-desktop/bills-to-pay', {
31
+ query,
32
+ ...options,
33
+ headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
34
+ });
35
+ }
36
+ }
37
+
38
+ export interface BillToPay {
39
+ /**
40
+ * The open bill with a positive amount due that can be paid for the requested
41
+ * vendor. In each bills-to-pay result, either `bill` is an object and `credit` is
42
+ * `null`, or `credit` is an object and `bill` is `null`.
43
+ */
44
+ bill: BillToPay.Bill | null;
45
+
46
+ /**
47
+ * The vendor credit linked to the requested vendor that can be applied to open
48
+ * bills. In each bills-to-pay result, either `credit` is an object and `bill` is
49
+ * `null`, or `bill` is an object and `credit` is `null`.
50
+ */
51
+ credit: BillToPay.Credit | null;
52
+ }
53
+
54
+ export namespace BillToPay {
55
+ /**
56
+ * The open bill with a positive amount due that can be paid for the requested
57
+ * vendor. In each bills-to-pay result, either `bill` is an object and `credit` is
58
+ * `null`, or `credit` is an object and `bill` is `null`.
59
+ */
60
+ export interface Bill {
61
+ /**
62
+ * The amount QuickBooks Desktop reports as due and available to pay for this open
63
+ * bill, represented as a decimal string. Use this value as the candidate
64
+ * `applyToTransactions[].paymentAmount` when creating a bill payment; reduce the
65
+ * payment by any credits you apply.
66
+ */
67
+ amountDue: string;
68
+
69
+ /**
70
+ * The monetary amount due for this payable bill converted to the home currency of
71
+ * the QuickBooks company file. Represented as a decimal string.
72
+ */
73
+ amountDueInHomeCurrency: string | null;
74
+
75
+ /**
76
+ * The ID of the open bill available to pay. Pass this value as `transactionId` in
77
+ * a bill-payment `applyToTransactions` entry.
78
+ */
79
+ billId: string;
80
+
81
+ /**
82
+ * The payable bill's currency. For built-in currencies, the name and code are
83
+ * standard ISO 4217 international values. For user-defined currencies, all values
84
+ * are editable.
85
+ */
86
+ currency: Bill.Currency | null;
87
+
88
+ /**
89
+ * The date by which this payable bill must be paid, in ISO 8601 format
90
+ * (YYYY-MM-DD).
91
+ */
92
+ dueDate: string | null;
93
+
94
+ /**
95
+ * The market exchange rate between this payable bill's currency and the home
96
+ * currency in QuickBooks at the time of this transaction. Represented as a decimal
97
+ * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
98
+ */
99
+ exchangeRate: number | null;
100
+
101
+ /**
102
+ * The Accounts-Payable (A/P) account to which this payable bill is assigned, used
103
+ * for accounts-payable tracking.
104
+ *
105
+ * **IMPORTANT**: If this payable bill is linked to other transactions, this A/P
106
+ * account must match the `payablesAccount` used in those other transactions.
107
+ */
108
+ payablesAccount: Bill.PayablesAccount;
109
+
110
+ /**
111
+ * The case-sensitive user-defined reference number for this payable bill, which
112
+ * can be used to identify the transaction in QuickBooks. This value is not
113
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
114
+ */
115
+ refNumber: string | null;
116
+
117
+ /**
118
+ * The date of this payable bill, in ISO 8601 format (YYYY-MM-DD).
119
+ */
120
+ transactionDate: string;
121
+
122
+ /**
123
+ * The type of transaction for this payable bill.
124
+ */
125
+ transactionType:
126
+ | 'ar_refund_credit_card'
127
+ | 'bill'
128
+ | 'bill_payment_check'
129
+ | 'bill_payment_credit_card'
130
+ | 'build_assembly'
131
+ | 'charge'
132
+ | 'check'
133
+ | 'credit_card_charge'
134
+ | 'credit_card_credit'
135
+ | 'credit_memo'
136
+ | 'deposit'
137
+ | 'estimate'
138
+ | 'inventory_adjustment'
139
+ | 'invoice'
140
+ | 'item_receipt'
141
+ | 'journal_entry'
142
+ | 'liability_adjustment'
143
+ | 'paycheck'
144
+ | 'payroll_liability_check'
145
+ | 'purchase_order'
146
+ | 'receive_payment'
147
+ | 'sales_order'
148
+ | 'sales_receipt'
149
+ | 'sales_tax_payment_check'
150
+ | 'transfer'
151
+ | 'vendor_credit'
152
+ | 'ytd_adjustment';
153
+ }
154
+
155
+ export namespace Bill {
156
+ /**
157
+ * The payable bill's currency. For built-in currencies, the name and code are
158
+ * standard ISO 4217 international values. For user-defined currencies, all values
159
+ * are editable.
160
+ */
161
+ export interface Currency {
162
+ /**
163
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
164
+ * across all objects of the same type, but not across different QuickBooks object
165
+ * types.
166
+ */
167
+ id: string | null;
168
+
169
+ /**
170
+ * The fully-qualified unique name for this object, formed by combining the names
171
+ * of its parent objects with its own `name`, separated by colons. Not
172
+ * case-sensitive.
173
+ */
174
+ fullName: string | null;
175
+ }
176
+
177
+ /**
178
+ * The Accounts-Payable (A/P) account to which this payable bill is assigned, used
179
+ * for accounts-payable tracking.
180
+ *
181
+ * **IMPORTANT**: If this payable bill is linked to other transactions, this A/P
182
+ * account must match the `payablesAccount` used in those other transactions.
183
+ */
184
+ export interface PayablesAccount {
185
+ /**
186
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
187
+ * across all objects of the same type, but not across different QuickBooks object
188
+ * types.
189
+ */
190
+ id: string | null;
191
+
192
+ /**
193
+ * The fully-qualified unique name for this object, formed by combining the names
194
+ * of its parent objects with its own `name`, separated by colons. Not
195
+ * case-sensitive.
196
+ */
197
+ fullName: string | null;
198
+ }
199
+ }
200
+
201
+ /**
202
+ * The vendor credit linked to the requested vendor that can be applied to open
203
+ * bills. In each bills-to-pay result, either `credit` is an object and `bill` is
204
+ * `null`, or `bill` is an object and `credit` is `null`.
205
+ */
206
+ export interface Credit {
207
+ /**
208
+ * The remaining vendor credit available to apply to open bills, represented as a
209
+ * decimal string. When applying this credit to a bill-payment request, choose an
210
+ * `applyToTransactions[].applyCredits[].appliedAmount` that does not exceed this
211
+ * value or the target bill's remaining amount due.
212
+ */
213
+ creditRemaining: string;
214
+
215
+ /**
216
+ * The remaining balance of this applicable credit converted to the home currency
217
+ * of the QuickBooks company file. Represented as a decimal string.
218
+ */
219
+ creditRemainingInHomeCurrency: string | null;
220
+
221
+ /**
222
+ * The ID of the credit transaction available to apply to the vendor's open bills.
223
+ * To apply this credit in a bill-payment request, place it under the target bill's
224
+ * `applyToTransactions[].applyCredits[]` entry and pass this value as
225
+ * `creditTransactionId`.
226
+ */
227
+ creditTransactionId: string;
228
+
229
+ /**
230
+ * The applicable credit's currency. For built-in currencies, the name and code are
231
+ * standard ISO 4217 international values. For user-defined currencies, all values
232
+ * are editable.
233
+ */
234
+ currency: Credit.Currency | null;
235
+
236
+ /**
237
+ * The market exchange rate between this applicable credit's currency and the home
238
+ * currency in QuickBooks at the time of this transaction. Represented as a decimal
239
+ * value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
240
+ */
241
+ exchangeRate: number | null;
242
+
243
+ /**
244
+ * The Accounts-Payable (A/P) account to which this applicable credit is assigned,
245
+ * used for accounts-payable tracking.
246
+ *
247
+ * **IMPORTANT**: If this applicable credit is linked to other transactions, this
248
+ * A/P account must match the `payablesAccount` used in those other transactions.
249
+ */
250
+ payablesAccount: Credit.PayablesAccount;
251
+
252
+ /**
253
+ * The case-sensitive user-defined reference number for this applicable credit,
254
+ * which can be used to identify the transaction in QuickBooks. This value is not
255
+ * required to be unique and can be arbitrarily changed by the QuickBooks user.
256
+ */
257
+ refNumber: string | null;
258
+
259
+ /**
260
+ * The date of this applicable credit, in ISO 8601 format (YYYY-MM-DD).
261
+ */
262
+ transactionDate: string;
263
+
264
+ /**
265
+ * The type of transaction for this applicable credit.
266
+ */
267
+ transactionType:
268
+ | 'ar_refund_credit_card'
269
+ | 'bill'
270
+ | 'bill_payment_check'
271
+ | 'bill_payment_credit_card'
272
+ | 'build_assembly'
273
+ | 'charge'
274
+ | 'check'
275
+ | 'credit_card_charge'
276
+ | 'credit_card_credit'
277
+ | 'credit_memo'
278
+ | 'deposit'
279
+ | 'estimate'
280
+ | 'inventory_adjustment'
281
+ | 'invoice'
282
+ | 'item_receipt'
283
+ | 'journal_entry'
284
+ | 'liability_adjustment'
285
+ | 'paycheck'
286
+ | 'payroll_liability_check'
287
+ | 'purchase_order'
288
+ | 'receive_payment'
289
+ | 'sales_order'
290
+ | 'sales_receipt'
291
+ | 'sales_tax_payment_check'
292
+ | 'transfer'
293
+ | 'vendor_credit'
294
+ | 'ytd_adjustment';
295
+ }
296
+
297
+ export namespace Credit {
298
+ /**
299
+ * The applicable credit's currency. For built-in currencies, the name and code are
300
+ * standard ISO 4217 international values. For user-defined currencies, all values
301
+ * are editable.
302
+ */
303
+ export interface Currency {
304
+ /**
305
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
306
+ * across all objects of the same type, but not across different QuickBooks object
307
+ * types.
308
+ */
309
+ id: string | null;
310
+
311
+ /**
312
+ * The fully-qualified unique name for this object, formed by combining the names
313
+ * of its parent objects with its own `name`, separated by colons. Not
314
+ * case-sensitive.
315
+ */
316
+ fullName: string | null;
317
+ }
318
+
319
+ /**
320
+ * The Accounts-Payable (A/P) account to which this applicable credit is assigned,
321
+ * used for accounts-payable tracking.
322
+ *
323
+ * **IMPORTANT**: If this applicable credit is linked to other transactions, this
324
+ * A/P account must match the `payablesAccount` used in those other transactions.
325
+ */
326
+ export interface PayablesAccount {
327
+ /**
328
+ * The unique identifier assigned by QuickBooks to this object. This ID is unique
329
+ * across all objects of the same type, but not across different QuickBooks object
330
+ * types.
331
+ */
332
+ id: string | null;
333
+
334
+ /**
335
+ * The fully-qualified unique name for this object, formed by combining the names
336
+ * of its parent objects with its own `name`, separated by colons. Not
337
+ * case-sensitive.
338
+ */
339
+ fullName: string | null;
340
+ }
341
+ }
342
+ }
343
+
344
+ export interface BillsToPayListResponse {
345
+ /**
346
+ * The array of bills-to-pay records. Each record has either a `bill` object or a
347
+ * `credit` object, and the other branch is `null`.
348
+ */
349
+ data: Array<BillToPay>;
350
+
351
+ /**
352
+ * The type of object. This value is always `"list"`.
353
+ */
354
+ objectType: 'list';
355
+
356
+ /**
357
+ * The endpoint URL where this list can be accessed.
358
+ */
359
+ url: string;
360
+ }
361
+
362
+ export interface BillsToPayListParams {
363
+ /**
364
+ * Query param: The vendor whose open bills and available credits should be
365
+ * returned.
366
+ */
367
+ vendorId: string;
368
+
369
+ /**
370
+ * Header param: The ID of the End-User to receive this request.
371
+ */
372
+ conductorEndUserId: string;
373
+
374
+ /**
375
+ * Query param: Filter for open bills and available credits in these currencies.
376
+ */
377
+ currencyIds?: Array<string>;
378
+
379
+ /**
380
+ * Query param: Filter the bill branch to open bills due on or before this date, in
381
+ * ISO 8601 format (YYYY-MM-DD). If omitted, QuickBooks Desktop returns open bills
382
+ * from all due dates. Available credits can still be returned because credits do
383
+ * not have a due date.
384
+ */
385
+ dueDate?: string;
386
+
387
+ /**
388
+ * Query param: Filter for open bills and available credits assigned to this
389
+ * Accounts-Payable account. If omitted, QuickBooks Desktop uses the default A/P
390
+ * account configured in the company file.
391
+ */
392
+ payablesAccountId?: string;
393
+ }
394
+
395
+ export declare namespace BillsToPay {
396
+ export {
397
+ type BillToPay as BillToPay,
398
+ type BillsToPayListResponse as BillsToPayListResponse,
399
+ type BillsToPayListParams as BillsToPayListParams,
400
+ };
401
+ }
@@ -163,7 +163,8 @@ export interface Bill {
163
163
  /**
164
164
  * The total monetary amount due for this bill, represented as a decimal string.
165
165
  * This equals the sum of the amounts in the bill's expense lines, item lines, and
166
- * item group lines. It also equals `openAmount` plus any credits or discounts.
166
+ * item group lines. The amount due minus any credits or discounts equals the open
167
+ * amount.
167
168
  */
168
169
  amountDue: string | null;
169
170
 
@@ -273,15 +274,15 @@ export interface Bill {
273
274
  * aggregate open accounts-payable balance rather than the documented remaining
274
275
  * balance for that individual bill.
275
276
  *
276
- * If you need the amount currently payable on each open bill, we recommend calling
277
- * QuickBooks Desktop's `BillToPayQuery` through Conductor's passthrough API and
278
- * reading `BillToPay.AmountDue` instead of relying on `openAmount` from the
279
- * Conductor bills endpoint. `BillToPayQuery` is not a general replacement for the
280
- * Conductor bills endpoint, because it is scoped to open bills and available
281
- * credits for a payee and returns bill-payment data rather than full bill records.
277
+ * If you need the amount currently payable on each open bill, use Conductor's
278
+ * `/quickbooks-desktop/bills-to-pay` endpoint and read `bill.amountDue` instead of
279
+ * relying on `openAmount` from the Conductor bills endpoint. The bills-to-pay
280
+ * endpoint is not a general replacement for the Conductor bills endpoint, because
281
+ * it is scoped to open bills and available credits for a vendor and returns
282
+ * bill-payment data rather than full bill records.
282
283
  *
283
- * If you cannot use `BillToPayQuery` through the passthrough API and must derive a
284
- * fallback from Conductor bills endpoint results, re-query the bills with
284
+ * If you cannot use `/quickbooks-desktop/bills-to-pay` and must derive a fallback
285
+ * from Conductor bills endpoint results, re-query the bills with
285
286
  * `includeLinkedTransactions=true` and compute a best-effort open amount as
286
287
  * `amountDue` plus the sum of signed `linkedTransactions[].amount` values for all
287
288
  * entries where `linkedTransactions[].linkType` is `"amount"`.
@@ -289,9 +290,8 @@ export interface Bill {
289
290
  openAmount: string | null;
290
291
 
291
292
  /**
292
- * The Accounts-Payable (A/P) account to which this bill is assigned, used to track
293
- * the amount owed. If not specified, QuickBooks Desktop will use its default A/P
294
- * account.
293
+ * The Accounts-Payable (A/P) account to which this bill is assigned, used for
294
+ * accounts-payable tracking.
295
295
  *
296
296
  * **IMPORTANT**: If this bill is linked to other transactions, this A/P account
297
297
  * must match the `payablesAccount` used in those other transactions.
@@ -319,9 +319,10 @@ export interface Bill {
319
319
  * This can be overridden on the bill's individual lines.
320
320
  *
321
321
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
322
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
323
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
324
- * non-taxable code to all sales.
322
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
323
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
324
+ * the default non-taxable sales-tax code configured in the company file to all
325
+ * sales.
325
326
  */
326
327
  salesTaxCode: Bill.SalesTaxCode | null;
327
328
 
@@ -482,9 +483,10 @@ export namespace Bill {
482
483
  * transaction or the associated item.
483
484
  *
484
485
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
485
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
486
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
487
- * non-taxable code to all sales.
486
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
487
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
488
+ * the default non-taxable sales-tax code configured in the company file to all
489
+ * sales.
488
490
  */
489
491
  salesTaxCode: ExpenseLine.SalesTaxCode | null;
490
492
  }
@@ -620,9 +622,10 @@ export namespace Bill {
620
622
  * transaction or the associated item.
621
623
  *
622
624
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
623
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
624
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
625
- * non-taxable code to all sales.
625
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
626
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
627
+ * the default non-taxable sales-tax code configured in the company file to all
628
+ * sales.
626
629
  */
627
630
  export interface SalesTaxCode {
628
631
  /**
@@ -891,9 +894,10 @@ export namespace Bill {
891
894
  * transaction or the associated item.
892
895
  *
893
896
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
894
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
895
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
896
- * non-taxable code to all sales.
897
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
898
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
899
+ * the default non-taxable sales-tax code configured in the company file to all
900
+ * sales.
897
901
  */
898
902
  salesTaxCode: ItemLine.SalesTaxCode | null;
899
903
 
@@ -1104,9 +1108,10 @@ export namespace Bill {
1104
1108
  * transaction or the associated item.
1105
1109
  *
1106
1110
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1107
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1108
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1109
- * non-taxable code to all sales.
1111
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1112
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1113
+ * the default non-taxable sales-tax code configured in the company file to all
1114
+ * sales.
1110
1115
  */
1111
1116
  export interface SalesTaxCode {
1112
1117
  /**
@@ -1274,9 +1279,10 @@ export namespace Bill {
1274
1279
  * transaction or the associated item.
1275
1280
  *
1276
1281
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1277
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1278
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1279
- * non-taxable code to all sales.
1282
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1283
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1284
+ * the default non-taxable sales-tax code configured in the company file to all
1285
+ * sales.
1280
1286
  */
1281
1287
  salesTaxCode: ItemLine.SalesTaxCode | null;
1282
1288
 
@@ -1487,9 +1493,10 @@ export namespace Bill {
1487
1493
  * transaction or the associated item.
1488
1494
  *
1489
1495
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1490
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1491
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1492
- * non-taxable code to all sales.
1496
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1497
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1498
+ * the default non-taxable sales-tax code configured in the company file to all
1499
+ * sales.
1493
1500
  */
1494
1501
  export interface SalesTaxCode {
1495
1502
  /**
@@ -1580,9 +1587,8 @@ export namespace Bill {
1580
1587
  }
1581
1588
 
1582
1589
  /**
1583
- * The Accounts-Payable (A/P) account to which this bill is assigned, used to track
1584
- * the amount owed. If not specified, QuickBooks Desktop will use its default A/P
1585
- * account.
1590
+ * The Accounts-Payable (A/P) account to which this bill is assigned, used for
1591
+ * accounts-payable tracking.
1586
1592
  *
1587
1593
  * **IMPORTANT**: If this bill is linked to other transactions, this A/P account
1588
1594
  * must match the `payablesAccount` used in those other transactions.
@@ -1609,9 +1615,10 @@ export namespace Bill {
1609
1615
  * This can be overridden on the bill's individual lines.
1610
1616
  *
1611
1617
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1612
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1613
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1614
- * non-taxable code to all sales.
1618
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1619
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1620
+ * the default non-taxable sales-tax code configured in the company file to all
1621
+ * sales.
1615
1622
  */
1616
1623
  export interface SalesTaxCode {
1617
1624
  /**
@@ -1874,8 +1881,8 @@ export interface BillCreateParams {
1874
1881
 
1875
1882
  /**
1876
1883
  * Body param: The Accounts-Payable (A/P) account to which this bill is assigned,
1877
- * used to track the amount owed. If not specified, QuickBooks Desktop will use its
1878
- * default A/P account.
1884
+ * used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the
1885
+ * default A/P account configured in the company file.
1879
1886
  *
1880
1887
  * **IMPORTANT**: If this bill is linked to other transactions, this A/P account
1881
1888
  * must match the `payablesAccount` used in those other transactions.
@@ -1899,9 +1906,10 @@ export interface BillCreateParams {
1899
1906
  * vendor. This can be overridden on the bill's individual lines.
1900
1907
  *
1901
1908
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1902
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1903
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1904
- * non-taxable code to all sales.
1909
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1910
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1911
+ * the default non-taxable sales-tax code configured in the company file to all
1912
+ * sales.
1905
1913
  */
1906
1914
  salesTaxCodeId?: string;
1907
1915
 
@@ -1979,9 +1987,10 @@ export namespace BillCreateParams {
1979
1987
  * transaction or the associated item.
1980
1988
  *
1981
1989
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
1982
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
1983
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
1984
- * non-taxable code to all sales.
1990
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
1991
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
1992
+ * the default non-taxable sales-tax code configured in the company file to all
1993
+ * sales.
1985
1994
  */
1986
1995
  salesTaxCodeId?: string;
1987
1996
  }
@@ -2228,9 +2237,10 @@ export namespace BillCreateParams {
2228
2237
  * transaction or the associated item.
2229
2238
  *
2230
2239
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2231
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2232
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2233
- * non-taxable code to all sales.
2240
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
2241
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
2242
+ * the default non-taxable sales-tax code configured in the company file to all
2243
+ * sales.
2234
2244
  */
2235
2245
  salesTaxCodeId?: string;
2236
2246
 
@@ -2503,8 +2513,8 @@ export interface BillUpdateParams {
2503
2513
 
2504
2514
  /**
2505
2515
  * Body param: The Accounts-Payable (A/P) account to which this bill is assigned,
2506
- * used to track the amount owed. If not specified, QuickBooks Desktop will use its
2507
- * default A/P account.
2516
+ * used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the
2517
+ * default A/P account configured in the company file.
2508
2518
  *
2509
2519
  * **IMPORTANT**: If this bill is linked to other transactions, this A/P account
2510
2520
  * must match the `payablesAccount` used in those other transactions.
@@ -2526,9 +2536,10 @@ export interface BillUpdateParams {
2526
2536
  * vendor. This can be overridden on the bill's individual lines.
2527
2537
  *
2528
2538
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2529
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2530
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2531
- * non-taxable code to all sales.
2539
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
2540
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
2541
+ * the default non-taxable sales-tax code configured in the company file to all
2542
+ * sales.
2532
2543
  */
2533
2544
  salesTaxCodeId?: string;
2534
2545
 
@@ -2618,9 +2629,10 @@ export namespace BillUpdateParams {
2618
2629
  * transaction or the associated item.
2619
2630
  *
2620
2631
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2621
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2622
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2623
- * non-taxable code to all sales.
2632
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
2633
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
2634
+ * the default non-taxable sales-tax code configured in the company file to all
2635
+ * sales.
2624
2636
  */
2625
2637
  salesTaxCodeId?: string;
2626
2638
  }
@@ -2812,9 +2824,10 @@ export namespace BillUpdateParams {
2812
2824
  * transaction or the associated item.
2813
2825
  *
2814
2826
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2815
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2816
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2817
- * non-taxable code to all sales.
2827
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
2828
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
2829
+ * the default non-taxable sales-tax code configured in the company file to all
2830
+ * sales.
2818
2831
  */
2819
2832
  salesTaxCodeId?: string;
2820
2833
 
@@ -2958,9 +2971,10 @@ export namespace BillUpdateParams {
2958
2971
  * transaction or the associated item.
2959
2972
  *
2960
2973
  * Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
2961
- * can also be created in QuickBooks. If QuickBooks is not set up to charge sales
2962
- * tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
2963
- * non-taxable code to all sales.
2974
+ * can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up
2975
+ * to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns
2976
+ * the default non-taxable sales-tax code configured in the company file to all
2977
+ * sales.
2964
2978
  */
2965
2979
  salesTaxCodeId?: string;
2966
2980