conductor-node 14.16.0 → 14.18.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.
- package/CHANGELOG.md +19 -0
- package/package.json +1 -1
- package/resources/qbd/accounts.d.mts +16 -12
- package/resources/qbd/accounts.d.mts.map +1 -1
- package/resources/qbd/accounts.d.ts +16 -12
- package/resources/qbd/accounts.d.ts.map +1 -1
- package/resources/qbd/bill-check-payments.d.mts +51 -57
- package/resources/qbd/bill-check-payments.d.mts.map +1 -1
- package/resources/qbd/bill-check-payments.d.ts +51 -57
- package/resources/qbd/bill-check-payments.d.ts.map +1 -1
- package/resources/qbd/bill-credit-card-payments.d.mts +37 -42
- package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -1
- package/resources/qbd/bill-credit-card-payments.d.ts +37 -42
- package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
- package/resources/qbd/bills-to-pay.d.mts +295 -0
- package/resources/qbd/bills-to-pay.d.mts.map +1 -0
- package/resources/qbd/bills-to-pay.d.ts +295 -0
- package/resources/qbd/bills-to-pay.d.ts.map +1 -0
- package/resources/qbd/bills-to-pay.js +37 -0
- package/resources/qbd/bills-to-pay.js.map +1 -0
- package/resources/qbd/bills-to-pay.mjs +33 -0
- package/resources/qbd/bills-to-pay.mjs.map +1 -0
- package/resources/qbd/bills.d.mts +78 -64
- package/resources/qbd/bills.d.mts.map +1 -1
- package/resources/qbd/bills.d.ts +78 -64
- package/resources/qbd/bills.d.ts.map +1 -1
- package/resources/qbd/checks.d.mts +60 -45
- package/resources/qbd/checks.d.mts.map +1 -1
- package/resources/qbd/checks.d.ts +60 -45
- package/resources/qbd/checks.d.ts.map +1 -1
- package/resources/qbd/company.d.mts +1 -1
- package/resources/qbd/company.d.mts.map +1 -1
- package/resources/qbd/company.d.ts +1 -1
- package/resources/qbd/company.d.ts.map +1 -1
- package/resources/qbd/credit-card-charges.d.mts +60 -45
- package/resources/qbd/credit-card-charges.d.mts.map +1 -1
- package/resources/qbd/credit-card-charges.d.ts +60 -45
- package/resources/qbd/credit-card-charges.d.ts.map +1 -1
- package/resources/qbd/credit-card-credits.d.mts +60 -45
- package/resources/qbd/credit-card-credits.d.mts.map +1 -1
- package/resources/qbd/credit-card-credits.d.ts +60 -45
- package/resources/qbd/credit-card-credits.d.ts.map +1 -1
- package/resources/qbd/credit-card-refunds.d.mts +8 -7
- package/resources/qbd/credit-card-refunds.d.mts.map +1 -1
- package/resources/qbd/credit-card-refunds.d.ts +8 -7
- package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
- package/resources/qbd/credit-memos.d.mts +52 -41
- package/resources/qbd/credit-memos.d.mts.map +1 -1
- package/resources/qbd/credit-memos.d.ts +52 -41
- package/resources/qbd/credit-memos.d.ts.map +1 -1
- package/resources/qbd/customers.d.mts +21 -13
- package/resources/qbd/customers.d.mts.map +1 -1
- package/resources/qbd/customers.d.ts +21 -13
- package/resources/qbd/customers.d.ts.map +1 -1
- package/resources/qbd/discount-items.d.mts +16 -12
- package/resources/qbd/discount-items.d.mts.map +1 -1
- package/resources/qbd/discount-items.d.ts +16 -12
- package/resources/qbd/discount-items.d.ts.map +1 -1
- package/resources/qbd/employees.d.mts +32 -0
- package/resources/qbd/employees.d.mts.map +1 -1
- package/resources/qbd/employees.d.ts +32 -0
- package/resources/qbd/employees.d.ts.map +1 -1
- package/resources/qbd/estimates.d.mts +44 -33
- package/resources/qbd/estimates.d.mts.map +1 -1
- package/resources/qbd/estimates.d.ts +44 -33
- package/resources/qbd/estimates.d.ts.map +1 -1
- package/resources/qbd/index.d.mts +1 -0
- package/resources/qbd/index.d.mts.map +1 -1
- package/resources/qbd/index.d.ts +1 -0
- package/resources/qbd/index.d.ts.map +1 -1
- package/resources/qbd/index.js +4 -2
- package/resources/qbd/index.js.map +1 -1
- package/resources/qbd/index.mjs +1 -0
- package/resources/qbd/index.mjs.map +1 -1
- package/resources/qbd/inventory-assembly-items.d.mts +16 -12
- package/resources/qbd/inventory-assembly-items.d.mts.map +1 -1
- package/resources/qbd/inventory-assembly-items.d.ts +16 -12
- package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
- package/resources/qbd/inventory-items.d.mts +16 -12
- package/resources/qbd/inventory-items.d.mts.map +1 -1
- package/resources/qbd/inventory-items.d.ts +16 -12
- package/resources/qbd/inventory-items.d.ts.map +1 -1
- package/resources/qbd/invoices.d.mts +57 -47
- package/resources/qbd/invoices.d.mts.map +1 -1
- package/resources/qbd/invoices.d.ts +57 -47
- package/resources/qbd/invoices.d.ts.map +1 -1
- package/resources/qbd/item-receipts.d.mts +66 -53
- package/resources/qbd/item-receipts.d.mts.map +1 -1
- package/resources/qbd/item-receipts.d.ts +66 -53
- package/resources/qbd/item-receipts.d.ts.map +1 -1
- package/resources/qbd/item-sites.d.mts +12 -0
- package/resources/qbd/item-sites.d.mts.map +1 -1
- package/resources/qbd/item-sites.d.ts +12 -0
- package/resources/qbd/item-sites.d.ts.map +1 -1
- package/resources/qbd/non-inventory-items.d.mts +16 -12
- package/resources/qbd/non-inventory-items.d.mts.map +1 -1
- package/resources/qbd/non-inventory-items.d.ts +16 -12
- package/resources/qbd/non-inventory-items.d.ts.map +1 -1
- package/resources/qbd/other-charge-items.d.mts +16 -12
- package/resources/qbd/other-charge-items.d.mts.map +1 -1
- package/resources/qbd/other-charge-items.d.ts +16 -12
- package/resources/qbd/other-charge-items.d.ts.map +1 -1
- package/resources/qbd/other-names.d.mts +4 -0
- package/resources/qbd/other-names.d.mts.map +1 -1
- package/resources/qbd/other-names.d.ts +4 -0
- package/resources/qbd/other-names.d.ts.map +1 -1
- package/resources/qbd/purchase-orders.d.mts +44 -33
- package/resources/qbd/purchase-orders.d.mts.map +1 -1
- package/resources/qbd/purchase-orders.d.ts +44 -33
- package/resources/qbd/purchase-orders.d.ts.map +1 -1
- package/resources/qbd/qbd.d.mts +4 -0
- package/resources/qbd/qbd.d.mts.map +1 -1
- package/resources/qbd/qbd.d.ts +4 -0
- package/resources/qbd/qbd.d.ts.map +1 -1
- package/resources/qbd/qbd.js +4 -0
- package/resources/qbd/qbd.js.map +1 -1
- package/resources/qbd/qbd.mjs +4 -0
- package/resources/qbd/qbd.mjs.map +1 -1
- package/resources/qbd/receive-payments.d.mts +57 -61
- package/resources/qbd/receive-payments.d.mts.map +1 -1
- package/resources/qbd/receive-payments.d.ts +57 -61
- package/resources/qbd/receive-payments.d.ts.map +1 -1
- package/resources/qbd/sales-orders.d.mts +44 -33
- package/resources/qbd/sales-orders.d.mts.map +1 -1
- package/resources/qbd/sales-orders.d.ts +44 -33
- package/resources/qbd/sales-orders.d.ts.map +1 -1
- package/resources/qbd/sales-receipts.d.mts +44 -33
- package/resources/qbd/sales-receipts.d.mts.map +1 -1
- package/resources/qbd/sales-receipts.d.ts +44 -33
- package/resources/qbd/sales-receipts.d.ts.map +1 -1
- package/resources/qbd/service-items.d.mts +16 -12
- package/resources/qbd/service-items.d.mts.map +1 -1
- package/resources/qbd/service-items.d.ts +16 -12
- package/resources/qbd/service-items.d.ts.map +1 -1
- package/resources/qbd/vendor-credits.d.mts +66 -53
- package/resources/qbd/vendor-credits.d.mts.map +1 -1
- package/resources/qbd/vendor-credits.d.ts +66 -53
- package/resources/qbd/vendor-credits.d.ts.map +1 -1
- package/resources/qbd/vendors.d.mts +21 -13
- package/resources/qbd/vendors.d.mts.map +1 -1
- package/resources/qbd/vendors.d.ts +21 -13
- package/resources/qbd/vendors.d.ts.map +1 -1
- package/src/resources/qbd/accounts.ts +16 -12
- package/src/resources/qbd/bill-check-payments.ts +51 -57
- package/src/resources/qbd/bill-credit-card-payments.ts +37 -42
- package/src/resources/qbd/bills-to-pay.ts +401 -0
- package/src/resources/qbd/bills.ts +78 -64
- package/src/resources/qbd/checks.ts +60 -45
- package/src/resources/qbd/company.ts +1 -0
- package/src/resources/qbd/credit-card-charges.ts +60 -45
- package/src/resources/qbd/credit-card-credits.ts +60 -45
- package/src/resources/qbd/credit-card-refunds.ts +8 -7
- package/src/resources/qbd/credit-memos.ts +52 -41
- package/src/resources/qbd/customers.ts +21 -13
- package/src/resources/qbd/discount-items.ts +16 -12
- package/src/resources/qbd/employees.ts +32 -0
- package/src/resources/qbd/estimates.ts +44 -33
- package/src/resources/qbd/index.ts +6 -0
- package/src/resources/qbd/inventory-assembly-items.ts +16 -12
- package/src/resources/qbd/inventory-items.ts +16 -12
- package/src/resources/qbd/invoices.ts +57 -47
- package/src/resources/qbd/item-receipts.ts +66 -53
- package/src/resources/qbd/item-sites.ts +12 -0
- package/src/resources/qbd/non-inventory-items.ts +16 -12
- package/src/resources/qbd/other-charge-items.ts +16 -12
- package/src/resources/qbd/other-names.ts +4 -0
- package/src/resources/qbd/purchase-orders.ts +44 -33
- package/src/resources/qbd/qbd.ts +11 -0
- package/src/resources/qbd/receive-payments.ts +57 -61
- package/src/resources/qbd/sales-orders.ts +44 -33
- package/src/resources/qbd/sales-receipts.ts +44 -33
- package/src/resources/qbd/service-items.ts +16 -12
- package/src/resources/qbd/vendor-credits.ts +66 -53
- package/src/resources/qbd/vendors.ts +21 -13
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
export declare class BillsToPay extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Lists open vendor bills and available vendor credits for a specific QuickBooks
|
|
7
|
+
* Desktop vendor. Use each `bill.billId` as `applyToTransactions[].transactionId`
|
|
8
|
+
* in bill-payment requests. To apply a returned credit, place it under the target
|
|
9
|
+
* bill's `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId`
|
|
10
|
+
* to `credit.creditTransactionId`, and choose an `appliedAmount` that does not
|
|
11
|
+
* exceed `credit.creditRemaining` or the target bill's remaining amount due.
|
|
12
|
+
*
|
|
13
|
+
* **NOTE:** QuickBooks Desktop does not support pagination for bills to pay;
|
|
14
|
+
* hence, there is no `cursor` parameter. Users typically have few bills to pay.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const billsToPays = await conductor.qbd.billsToPay.list({
|
|
19
|
+
* vendorId: '80000001-1234567890',
|
|
20
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
list(params: BillsToPayListParams, options?: RequestOptions): APIPromise<BillsToPayListResponse>;
|
|
25
|
+
}
|
|
26
|
+
export interface BillToPay {
|
|
27
|
+
/**
|
|
28
|
+
* The open bill with a positive amount due that can be paid for the requested
|
|
29
|
+
* vendor. In each bills-to-pay result, either `bill` is an object and `credit` is
|
|
30
|
+
* `null`, or `credit` is an object and `bill` is `null`.
|
|
31
|
+
*/
|
|
32
|
+
bill: BillToPay.Bill | null;
|
|
33
|
+
/**
|
|
34
|
+
* The vendor credit linked to the requested vendor that can be applied to open
|
|
35
|
+
* bills. In each bills-to-pay result, either `credit` is an object and `bill` is
|
|
36
|
+
* `null`, or `bill` is an object and `credit` is `null`.
|
|
37
|
+
*/
|
|
38
|
+
credit: BillToPay.Credit | null;
|
|
39
|
+
}
|
|
40
|
+
export declare namespace BillToPay {
|
|
41
|
+
/**
|
|
42
|
+
* The open bill with a positive amount due that can be paid for the requested
|
|
43
|
+
* vendor. In each bills-to-pay result, either `bill` is an object and `credit` is
|
|
44
|
+
* `null`, or `credit` is an object and `bill` is `null`.
|
|
45
|
+
*/
|
|
46
|
+
interface Bill {
|
|
47
|
+
/**
|
|
48
|
+
* The amount QuickBooks Desktop reports as due and available to pay for this open
|
|
49
|
+
* bill, represented as a decimal string. Use this value as the candidate
|
|
50
|
+
* `applyToTransactions[].paymentAmount` when creating a bill payment; reduce the
|
|
51
|
+
* payment by any credits you apply.
|
|
52
|
+
*/
|
|
53
|
+
amountDue: string;
|
|
54
|
+
/**
|
|
55
|
+
* The monetary amount due for this payable bill converted to the home currency of
|
|
56
|
+
* the QuickBooks company file. Represented as a decimal string.
|
|
57
|
+
*/
|
|
58
|
+
amountDueInHomeCurrency: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* The ID of the open bill available to pay. Pass this value as `transactionId` in
|
|
61
|
+
* a bill-payment `applyToTransactions` entry.
|
|
62
|
+
*/
|
|
63
|
+
billId: string;
|
|
64
|
+
/**
|
|
65
|
+
* The payable bill's currency. For built-in currencies, the name and code are
|
|
66
|
+
* standard ISO 4217 international values. For user-defined currencies, all values
|
|
67
|
+
* are editable.
|
|
68
|
+
*/
|
|
69
|
+
currency: Bill.Currency | null;
|
|
70
|
+
/**
|
|
71
|
+
* The date by which this payable bill must be paid, in ISO 8601 format
|
|
72
|
+
* (YYYY-MM-DD).
|
|
73
|
+
*/
|
|
74
|
+
dueDate: string | null;
|
|
75
|
+
/**
|
|
76
|
+
* The market exchange rate between this payable bill's currency and the home
|
|
77
|
+
* currency in QuickBooks at the time of this transaction. Represented as a decimal
|
|
78
|
+
* value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
79
|
+
*/
|
|
80
|
+
exchangeRate: number | null;
|
|
81
|
+
/**
|
|
82
|
+
* The Accounts-Payable (A/P) account to which this payable bill is assigned, used
|
|
83
|
+
* for accounts-payable tracking.
|
|
84
|
+
*
|
|
85
|
+
* **IMPORTANT**: If this payable bill is linked to other transactions, this A/P
|
|
86
|
+
* account must match the `payablesAccount` used in those other transactions.
|
|
87
|
+
*/
|
|
88
|
+
payablesAccount: Bill.PayablesAccount;
|
|
89
|
+
/**
|
|
90
|
+
* The case-sensitive user-defined reference number for this payable bill, which
|
|
91
|
+
* can be used to identify the transaction in QuickBooks. This value is not
|
|
92
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
93
|
+
*/
|
|
94
|
+
refNumber: string | null;
|
|
95
|
+
/**
|
|
96
|
+
* The date of this payable bill, in ISO 8601 format (YYYY-MM-DD).
|
|
97
|
+
*/
|
|
98
|
+
transactionDate: string;
|
|
99
|
+
/**
|
|
100
|
+
* The type of transaction for this payable bill.
|
|
101
|
+
*/
|
|
102
|
+
transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment';
|
|
103
|
+
}
|
|
104
|
+
namespace Bill {
|
|
105
|
+
/**
|
|
106
|
+
* The payable bill's currency. For built-in currencies, the name and code are
|
|
107
|
+
* standard ISO 4217 international values. For user-defined currencies, all values
|
|
108
|
+
* are editable.
|
|
109
|
+
*/
|
|
110
|
+
interface Currency {
|
|
111
|
+
/**
|
|
112
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
113
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
114
|
+
* types.
|
|
115
|
+
*/
|
|
116
|
+
id: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
119
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
120
|
+
* case-sensitive.
|
|
121
|
+
*/
|
|
122
|
+
fullName: string | null;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* The Accounts-Payable (A/P) account to which this payable bill is assigned, used
|
|
126
|
+
* for accounts-payable tracking.
|
|
127
|
+
*
|
|
128
|
+
* **IMPORTANT**: If this payable bill is linked to other transactions, this A/P
|
|
129
|
+
* account must match the `payablesAccount` used in those other transactions.
|
|
130
|
+
*/
|
|
131
|
+
interface PayablesAccount {
|
|
132
|
+
/**
|
|
133
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
134
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
135
|
+
* types.
|
|
136
|
+
*/
|
|
137
|
+
id: string | null;
|
|
138
|
+
/**
|
|
139
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
140
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
141
|
+
* case-sensitive.
|
|
142
|
+
*/
|
|
143
|
+
fullName: string | null;
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* The vendor credit linked to the requested vendor that can be applied to open
|
|
148
|
+
* bills. In each bills-to-pay result, either `credit` is an object and `bill` is
|
|
149
|
+
* `null`, or `bill` is an object and `credit` is `null`.
|
|
150
|
+
*/
|
|
151
|
+
interface Credit {
|
|
152
|
+
/**
|
|
153
|
+
* The remaining vendor credit available to apply to open bills, represented as a
|
|
154
|
+
* decimal string. When applying this credit to a bill-payment request, choose an
|
|
155
|
+
* `applyToTransactions[].applyCredits[].appliedAmount` that does not exceed this
|
|
156
|
+
* value or the target bill's remaining amount due.
|
|
157
|
+
*/
|
|
158
|
+
creditRemaining: string;
|
|
159
|
+
/**
|
|
160
|
+
* The remaining balance of this applicable credit converted to the home currency
|
|
161
|
+
* of the QuickBooks company file. Represented as a decimal string.
|
|
162
|
+
*/
|
|
163
|
+
creditRemainingInHomeCurrency: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* The ID of the credit transaction available to apply to the vendor's open bills.
|
|
166
|
+
* To apply this credit in a bill-payment request, place it under the target bill's
|
|
167
|
+
* `applyToTransactions[].applyCredits[]` entry and pass this value as
|
|
168
|
+
* `creditTransactionId`.
|
|
169
|
+
*/
|
|
170
|
+
creditTransactionId: string;
|
|
171
|
+
/**
|
|
172
|
+
* The applicable credit's currency. For built-in currencies, the name and code are
|
|
173
|
+
* standard ISO 4217 international values. For user-defined currencies, all values
|
|
174
|
+
* are editable.
|
|
175
|
+
*/
|
|
176
|
+
currency: Credit.Currency | null;
|
|
177
|
+
/**
|
|
178
|
+
* The market exchange rate between this applicable credit's currency and the home
|
|
179
|
+
* currency in QuickBooks at the time of this transaction. Represented as a decimal
|
|
180
|
+
* value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
181
|
+
*/
|
|
182
|
+
exchangeRate: number | null;
|
|
183
|
+
/**
|
|
184
|
+
* The Accounts-Payable (A/P) account to which this applicable credit is assigned,
|
|
185
|
+
* used for accounts-payable tracking.
|
|
186
|
+
*
|
|
187
|
+
* **IMPORTANT**: If this applicable credit is linked to other transactions, this
|
|
188
|
+
* A/P account must match the `payablesAccount` used in those other transactions.
|
|
189
|
+
*/
|
|
190
|
+
payablesAccount: Credit.PayablesAccount;
|
|
191
|
+
/**
|
|
192
|
+
* The case-sensitive user-defined reference number for this applicable credit,
|
|
193
|
+
* which can be used to identify the transaction in QuickBooks. This value is not
|
|
194
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
195
|
+
*/
|
|
196
|
+
refNumber: string | null;
|
|
197
|
+
/**
|
|
198
|
+
* The date of this applicable credit, in ISO 8601 format (YYYY-MM-DD).
|
|
199
|
+
*/
|
|
200
|
+
transactionDate: string;
|
|
201
|
+
/**
|
|
202
|
+
* The type of transaction for this applicable credit.
|
|
203
|
+
*/
|
|
204
|
+
transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment';
|
|
205
|
+
}
|
|
206
|
+
namespace Credit {
|
|
207
|
+
/**
|
|
208
|
+
* The applicable credit's currency. For built-in currencies, the name and code are
|
|
209
|
+
* standard ISO 4217 international values. For user-defined currencies, all values
|
|
210
|
+
* are editable.
|
|
211
|
+
*/
|
|
212
|
+
interface Currency {
|
|
213
|
+
/**
|
|
214
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
215
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
216
|
+
* types.
|
|
217
|
+
*/
|
|
218
|
+
id: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
221
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
222
|
+
* case-sensitive.
|
|
223
|
+
*/
|
|
224
|
+
fullName: string | null;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* The Accounts-Payable (A/P) account to which this applicable credit is assigned,
|
|
228
|
+
* used for accounts-payable tracking.
|
|
229
|
+
*
|
|
230
|
+
* **IMPORTANT**: If this applicable credit is linked to other transactions, this
|
|
231
|
+
* A/P account must match the `payablesAccount` used in those other transactions.
|
|
232
|
+
*/
|
|
233
|
+
interface PayablesAccount {
|
|
234
|
+
/**
|
|
235
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
236
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
237
|
+
* types.
|
|
238
|
+
*/
|
|
239
|
+
id: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
242
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
243
|
+
* case-sensitive.
|
|
244
|
+
*/
|
|
245
|
+
fullName: string | null;
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
export interface BillsToPayListResponse {
|
|
250
|
+
/**
|
|
251
|
+
* The array of bills-to-pay records. Each record has either a `bill` object or a
|
|
252
|
+
* `credit` object, and the other branch is `null`.
|
|
253
|
+
*/
|
|
254
|
+
data: Array<BillToPay>;
|
|
255
|
+
/**
|
|
256
|
+
* The type of object. This value is always `"list"`.
|
|
257
|
+
*/
|
|
258
|
+
objectType: 'list';
|
|
259
|
+
/**
|
|
260
|
+
* The endpoint URL where this list can be accessed.
|
|
261
|
+
*/
|
|
262
|
+
url: string;
|
|
263
|
+
}
|
|
264
|
+
export interface BillsToPayListParams {
|
|
265
|
+
/**
|
|
266
|
+
* Query param: The vendor whose open bills and available credits should be
|
|
267
|
+
* returned.
|
|
268
|
+
*/
|
|
269
|
+
vendorId: string;
|
|
270
|
+
/**
|
|
271
|
+
* Header param: The ID of the End-User to receive this request.
|
|
272
|
+
*/
|
|
273
|
+
conductorEndUserId: string;
|
|
274
|
+
/**
|
|
275
|
+
* Query param: Filter for open bills and available credits in these currencies.
|
|
276
|
+
*/
|
|
277
|
+
currencyIds?: Array<string>;
|
|
278
|
+
/**
|
|
279
|
+
* Query param: Filter the bill branch to open bills due on or before this date, in
|
|
280
|
+
* ISO 8601 format (YYYY-MM-DD). If omitted, QuickBooks Desktop returns open bills
|
|
281
|
+
* from all due dates. Available credits can still be returned because credits do
|
|
282
|
+
* not have a due date.
|
|
283
|
+
*/
|
|
284
|
+
dueDate?: string;
|
|
285
|
+
/**
|
|
286
|
+
* Query param: Filter for open bills and available credits assigned to this
|
|
287
|
+
* Accounts-Payable account. If omitted, QuickBooks Desktop uses the default A/P
|
|
288
|
+
* account configured in the company file.
|
|
289
|
+
*/
|
|
290
|
+
payablesAccountId?: string;
|
|
291
|
+
}
|
|
292
|
+
export declare namespace BillsToPay {
|
|
293
|
+
export { type BillToPay as BillToPay, type BillsToPayListResponse as BillsToPayListResponse, type BillsToPayListParams as BillsToPayListParams, };
|
|
294
|
+
}
|
|
295
|
+
//# sourceMappingURL=bills-to-pay.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bills-to-pay.d.ts","sourceRoot":"","sources":["../../src/resources/qbd/bills-to-pay.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAQjG;AAED,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,MAAM,EAAE,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,SAAS,CAAC;IACzB;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;;;;WAKG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;WAIG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;;;WAMG;QACH,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC;QAEtC;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,eAAe,EACX,uBAAuB,GACvB,MAAM,GACN,oBAAoB,GACpB,0BAA0B,GAC1B,gBAAgB,GAChB,QAAQ,GACR,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,aAAa,GACb,SAAS,GACT,UAAU,GACV,sBAAsB,GACtB,SAAS,GACT,cAAc,GACd,eAAe,GACf,sBAAsB,GACtB,UAAU,GACV,yBAAyB,GACzB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,yBAAyB,GACzB,UAAU,GACV,eAAe,GACf,gBAAgB,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB;;;;WAIG;QACH,UAAiB,QAAQ;YACvB;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED;;;;;;WAMG;QACH,UAAiB,eAAe;YAC9B;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;IAED;;;;OAIG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,6BAA6B,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7C;;;;;WAKG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;;;WAIG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEjC;;;;WAIG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;;;WAMG;QACH,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC;QAExC;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,eAAe,EACX,uBAAuB,GACvB,MAAM,GACN,oBAAoB,GACpB,0BAA0B,GAC1B,gBAAgB,GAChB,QAAQ,GACR,OAAO,GACP,oBAAoB,GACpB,oBAAoB,GACpB,aAAa,GACb,SAAS,GACT,UAAU,GACV,sBAAsB,GACtB,SAAS,GACT,cAAc,GACd,eAAe,GACf,sBAAsB,GACtB,UAAU,GACV,yBAAyB,GACzB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,yBAAyB,GACzB,UAAU,GACV,eAAe,GACf,gBAAgB,CAAC;KACtB;IAED,UAAiB,MAAM,CAAC;QACtB;;;;WAIG;QACH,UAAiB,QAAQ;YACvB;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED;;;;;;WAMG;QACH,UAAiB,eAAe;YAC9B;;;;eAIG;YACH,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;YAElB;;;;eAIG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.BillsToPay = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const headers_1 = require("../../internal/headers.js");
|
|
7
|
+
class BillsToPay extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Lists open vendor bills and available vendor credits for a specific QuickBooks
|
|
10
|
+
* Desktop vendor. Use each `bill.billId` as `applyToTransactions[].transactionId`
|
|
11
|
+
* in bill-payment requests. To apply a returned credit, place it under the target
|
|
12
|
+
* bill's `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId`
|
|
13
|
+
* to `credit.creditTransactionId`, and choose an `appliedAmount` that does not
|
|
14
|
+
* exceed `credit.creditRemaining` or the target bill's remaining amount due.
|
|
15
|
+
*
|
|
16
|
+
* **NOTE:** QuickBooks Desktop does not support pagination for bills to pay;
|
|
17
|
+
* hence, there is no `cursor` parameter. Users typically have few bills to pay.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const billsToPays = await conductor.qbd.billsToPay.list({
|
|
22
|
+
* vendorId: '80000001-1234567890',
|
|
23
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
list(params, options) {
|
|
28
|
+
const { conductorEndUserId, ...query } = params;
|
|
29
|
+
return this._client.get('/quickbooks-desktop/bills-to-pay', {
|
|
30
|
+
query,
|
|
31
|
+
...options,
|
|
32
|
+
headers: (0, headers_1.buildHeaders)([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
exports.BillsToPay = BillsToPay;
|
|
37
|
+
//# sourceMappingURL=bills-to-pay.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bills-to-pay.js","sourceRoot":"","sources":["../../src/resources/qbd/bills-to-pay.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAGtD,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,MAA4B,EAAE,OAAwB;QACzD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAC1D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,gCA4BC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
|
+
export class BillsToPay extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Lists open vendor bills and available vendor credits for a specific QuickBooks
|
|
7
|
+
* Desktop vendor. Use each `bill.billId` as `applyToTransactions[].transactionId`
|
|
8
|
+
* in bill-payment requests. To apply a returned credit, place it under the target
|
|
9
|
+
* bill's `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId`
|
|
10
|
+
* to `credit.creditTransactionId`, and choose an `appliedAmount` that does not
|
|
11
|
+
* exceed `credit.creditRemaining` or the target bill's remaining amount due.
|
|
12
|
+
*
|
|
13
|
+
* **NOTE:** QuickBooks Desktop does not support pagination for bills to pay;
|
|
14
|
+
* hence, there is no `cursor` parameter. Users typically have few bills to pay.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const billsToPays = await conductor.qbd.billsToPay.list({
|
|
19
|
+
* vendorId: '80000001-1234567890',
|
|
20
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
list(params, options) {
|
|
25
|
+
const { conductorEndUserId, ...query } = params;
|
|
26
|
+
return this._client.get('/quickbooks-desktop/bills-to-pay', {
|
|
27
|
+
query,
|
|
28
|
+
...options,
|
|
29
|
+
headers: buildHeaders([{ 'Conductor-End-User-Id': conductorEndUserId }, options?.headers]),
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=bills-to-pay.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bills-to-pay.mjs","sourceRoot":"","sources":["../../src/resources/qbd/bills-to-pay.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,MAA4B,EAAE,OAAwB;QACzD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAC1D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF"}
|