nxus-qbd 0.2.1 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +13 -2
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +26 -13
- package/dist/client.js.map +1 -1
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js +1 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/types.gen.d.ts +849 -708
- package/dist/generated/types.gen.d.ts.map +1 -1
- package/dist/generated/types.gen.js.map +1 -1
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +1 -1
- package/dist/models/index.js.map +1 -1
- package/dist/models/qbd/bill_to_pay.d.ts +1 -1
- package/dist/models/qbd/bill_to_pay.d.ts.map +1 -1
- package/dist/models/qbd/check.d.ts +1 -1
- package/dist/models/qbd/check.d.ts.map +1 -1
- package/dist/models/qbd/check.js +1 -0
- package/dist/models/qbd/check.js.map +1 -1
- package/dist/models/qbd/check_bill.d.ts +1 -1
- package/dist/models/qbd/check_bill.d.ts.map +1 -1
- package/dist/models/qbd/check_bill.js +1 -0
- package/dist/models/qbd/check_bill.js.map +1 -1
- package/dist/models/qbd/credit_card_bill.d.ts +1 -1
- package/dist/models/qbd/credit_card_bill.d.ts.map +1 -1
- package/dist/models/qbd/credit_card_bill.js +1 -0
- package/dist/models/qbd/credit_card_bill.js.map +1 -1
- package/dist/models/qbd/inventory_adjustment.d.ts +1 -1
- package/dist/models/qbd/inventory_adjustment.d.ts.map +1 -1
- package/dist/models/qbd/inventory_adjustment.js +1 -0
- package/dist/models/qbd/inventory_adjustment.js.map +1 -1
- package/dist/models/qbd/item_service.d.ts +1 -1
- package/dist/models/qbd/item_service.d.ts.map +1 -1
- package/dist/models/qbd/item_service.js +1 -0
- package/dist/models/qbd/item_service.js.map +1 -1
- package/dist/models/qbd/sales_receipt.d.ts +1 -1
- package/dist/models/qbd/sales_receipt.d.ts.map +1 -1
- package/dist/models/qbd/sales_receipt.js +1 -0
- package/dist/models/qbd/sales_receipt.js.map +1 -1
- package/dist/models/qbd/special_item.d.ts +1 -1
- package/dist/models/qbd/special_item.d.ts.map +1 -1
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +13 -1
- package/dist/transport.js.map +1 -1
- package/package.json +3 -2
|
@@ -198,34 +198,73 @@ export type ApiResponseReport = {
|
|
|
198
198
|
timestamp?: string;
|
|
199
199
|
requestId?: string | null;
|
|
200
200
|
};
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
201
|
+
/**
|
|
202
|
+
* Represents a credit that can be applied to a bill.
|
|
203
|
+
*/
|
|
204
|
+
export type ApplicableCredit = {
|
|
205
|
+
id: string;
|
|
206
|
+
objectType?: string;
|
|
207
|
+
createdAt: string;
|
|
208
|
+
updatedAt: string;
|
|
209
|
+
revisionNumber: string;
|
|
210
|
+
transactionDate?: string | null;
|
|
211
|
+
currency?: QbdRef;
|
|
212
|
+
exchangeRate?: number | null;
|
|
213
|
+
refNumber?: string | null;
|
|
214
|
+
memo?: string | null;
|
|
215
|
+
transactionType?: string | null;
|
|
216
|
+
payablesAccount?: QbdRef;
|
|
217
|
+
creditRemaining?: number | null;
|
|
218
|
+
creditRemainingInHomeCurrency?: number | null;
|
|
219
|
+
amount?: number | null;
|
|
220
|
+
entity?: QbdRef;
|
|
221
|
+
account?: QbdRef;
|
|
222
|
+
hasValidLineItems?: boolean;
|
|
223
|
+
externalId?: string | null;
|
|
224
|
+
linkedTransactions?: Array<LinkedTransaction> | null;
|
|
225
|
+
expenseLines?: Array<ExpenseLine> | null;
|
|
226
|
+
itemLines?: Array<ItemLine> | null;
|
|
227
|
+
itemGroupLines?: Array<ItemGroupLine> | null;
|
|
228
|
+
customFields?: Array<QbdDataExt> | null;
|
|
208
229
|
};
|
|
209
230
|
/**
|
|
210
231
|
* Request model for AppliedToTxn line items.
|
|
211
232
|
* Represents an invoice or transaction that this payment is being applied to.
|
|
212
233
|
*/
|
|
213
234
|
export type AppliedToTransactionRequest = {
|
|
214
|
-
id
|
|
235
|
+
id: string;
|
|
215
236
|
/**
|
|
216
|
-
*
|
|
237
|
+
* Monetary amount of the payment in the transaction's currency.
|
|
238
|
+
*
|
|
239
|
+
* Uses decimal for financial precision. Null indicates the amount is unspecified.
|
|
217
240
|
*/
|
|
218
|
-
|
|
241
|
+
paymentAmount?: number | null;
|
|
219
242
|
/**
|
|
220
|
-
*
|
|
243
|
+
* Collection of requests to set credits.
|
|
244
|
+
*
|
|
245
|
+
* May be null. Initialized at object creation (init-only). Serialized as
|
|
246
|
+
* "setCredits".
|
|
247
|
+
*/
|
|
248
|
+
setCredits?: Array<SetCreditRequest> | null;
|
|
249
|
+
/**
|
|
250
|
+
* Monetary amount of any discount applied to the item or transaction.
|
|
251
|
+
*
|
|
252
|
+
* Null when no discount is applied. Use the same currency and scale as other monetary values in
|
|
253
|
+
* the model.
|
|
221
254
|
*/
|
|
222
255
|
discountAmount?: number | null;
|
|
223
256
|
/**
|
|
224
|
-
*
|
|
257
|
+
* Identifier of the account used for discounts.
|
|
258
|
+
*
|
|
259
|
+
* Nullable; null indicates no discount account is assigned. When present, it should correspond
|
|
260
|
+
* to an account identifier in the accounting system.
|
|
225
261
|
*/
|
|
226
262
|
discountAccountId?: string | null;
|
|
227
263
|
/**
|
|
228
|
-
*
|
|
264
|
+
* Identifier of the discount class.
|
|
265
|
+
*
|
|
266
|
+
* Corresponds to the JSON property "discountClassId". May be null when no discount class is
|
|
267
|
+
* assigned.
|
|
229
268
|
*/
|
|
230
269
|
discountClassId?: string | null;
|
|
231
270
|
};
|
|
@@ -267,7 +306,7 @@ export type AppliedToTxn = {
|
|
|
267
306
|
* Used for applying a check as a direct refund to customer transactions.
|
|
268
307
|
* This is the simplified version with only TxnID and Amount.
|
|
269
308
|
*/
|
|
270
|
-
export type
|
|
309
|
+
export type ApplyCheckToTransactionRequest = {
|
|
271
310
|
id: string;
|
|
272
311
|
/**
|
|
273
312
|
* The amount of the check to apply to this transaction.
|
|
@@ -280,7 +319,7 @@ export type ApplyCheckToTransactionAddRequest = {
|
|
|
280
319
|
* Used for applying a payment or credit to a specific transaction (e.g., in BillPaymentCreditCardAdd, BillPaymentCheckAdd).
|
|
281
320
|
* This is the complex version with credits and discounts.
|
|
282
321
|
*/
|
|
283
|
-
export type
|
|
322
|
+
export type ApplyToTransactionRequest = {
|
|
284
323
|
id: string;
|
|
285
324
|
/**
|
|
286
325
|
* The amount of the payment to apply to this transaction.
|
|
@@ -291,7 +330,7 @@ export type ApplyToTransactionAddRequest = {
|
|
|
291
330
|
* List of credits to set/apply to this transaction.
|
|
292
331
|
* (Optional, may repeat)
|
|
293
332
|
*/
|
|
294
|
-
appliedCredits?: Array<
|
|
333
|
+
appliedCredits?: Array<CreateSetCreditRequest> | null;
|
|
295
334
|
/**
|
|
296
335
|
* The amount of discount to apply.
|
|
297
336
|
* (Optional)
|
|
@@ -568,10 +607,10 @@ export type BasePageResponseBillingRate = {
|
|
|
568
607
|
* Simple paginated response designed for SDK consumption
|
|
569
608
|
* Clean, predictable structure perfect for automated pagination handling
|
|
570
609
|
*/
|
|
571
|
-
export type
|
|
610
|
+
export type BasePageResponseBillPaymentOrCredit = {
|
|
572
611
|
requestId?: string | null;
|
|
573
612
|
success?: boolean;
|
|
574
|
-
data?: Array<
|
|
613
|
+
data?: Array<BillPaymentOrCredit>;
|
|
575
614
|
nextCursor?: string;
|
|
576
615
|
page?: number;
|
|
577
616
|
count?: number;
|
|
@@ -1530,27 +1569,6 @@ export type BasePageResponseShipMethod = {
|
|
|
1530
1569
|
timestamp?: string;
|
|
1531
1570
|
remainingCount?: number;
|
|
1532
1571
|
};
|
|
1533
|
-
/**
|
|
1534
|
-
* Simple paginated response designed for SDK consumption
|
|
1535
|
-
* Clean, predictable structure perfect for automated pagination handling
|
|
1536
|
-
*/
|
|
1537
|
-
export type BasePageResponseSpecialItem = {
|
|
1538
|
-
requestId?: string | null;
|
|
1539
|
-
success?: boolean;
|
|
1540
|
-
data?: Array<SpecialItem>;
|
|
1541
|
-
nextCursor?: string;
|
|
1542
|
-
page?: number;
|
|
1543
|
-
count?: number;
|
|
1544
|
-
/**
|
|
1545
|
-
* The maximum number of items to return in a single response.
|
|
1546
|
-
*/
|
|
1547
|
-
limit?: number;
|
|
1548
|
-
totalCount?: number;
|
|
1549
|
-
pageCount?: number;
|
|
1550
|
-
hasMore?: boolean;
|
|
1551
|
-
timestamp?: string;
|
|
1552
|
-
remainingCount?: number;
|
|
1553
|
-
};
|
|
1554
1572
|
/**
|
|
1555
1573
|
* Simple paginated response designed for SDK consumption
|
|
1556
1574
|
* Clean, predictable structure perfect for automated pagination handling
|
|
@@ -1791,6 +1809,9 @@ export type Bill = {
|
|
|
1791
1809
|
* Reference number for the bill.
|
|
1792
1810
|
*/
|
|
1793
1811
|
refNumber?: string | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* Indicates whether the bill is currently marked as pending.
|
|
1814
|
+
*/
|
|
1794
1815
|
isPending?: boolean | null;
|
|
1795
1816
|
terms?: QbdRef;
|
|
1796
1817
|
class?: QbdRef;
|
|
@@ -1897,50 +1918,16 @@ export type BillingRatePerItem = {
|
|
|
1897
1918
|
customRatePercent?: number | null;
|
|
1898
1919
|
};
|
|
1899
1920
|
/**
|
|
1900
|
-
*
|
|
1901
|
-
*
|
|
1921
|
+
* Represents an outstanding vendor balance. This will contain either a payable bill
|
|
1922
|
+
* that requires payment, or an available credit that can be applied to a payment.
|
|
1902
1923
|
*/
|
|
1903
|
-
export type
|
|
1904
|
-
id: string;
|
|
1924
|
+
export type BillPaymentOrCredit = {
|
|
1905
1925
|
objectType?: string;
|
|
1906
1926
|
createdAt: string;
|
|
1907
1927
|
updatedAt: string;
|
|
1908
1928
|
revisionNumber: string;
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
amountDue?: number | null;
|
|
1912
|
-
exchangeRate?: number | null;
|
|
1913
|
-
/**
|
|
1914
|
-
* Amount due in home currency. This is a direct property for now.
|
|
1915
|
-
*/
|
|
1916
|
-
amountDueInHomeCurrency?: string | null;
|
|
1917
|
-
refNumber?: string | null;
|
|
1918
|
-
memo?: string | null;
|
|
1919
|
-
txnType?: string | null;
|
|
1920
|
-
payablesAccount?: QbdRef;
|
|
1921
|
-
dueDate?: string | null;
|
|
1922
|
-
entity?: QbdRef;
|
|
1923
|
-
account?: QbdRef;
|
|
1924
|
-
amountInHomeCurrency?: string | null;
|
|
1925
|
-
hasValidLineItems?: boolean;
|
|
1926
|
-
externalId?: string | null;
|
|
1927
|
-
linkedTransactions?: Array<LinkedTransaction> | null;
|
|
1928
|
-
expenseLines?: Array<ExpenseLine> | null;
|
|
1929
|
-
itemLines?: Array<ItemLine> | null;
|
|
1930
|
-
itemGroupLines?: Array<ItemGroupLine> | null;
|
|
1931
|
-
customFields?: Array<QbdDataExt> | null;
|
|
1932
|
-
};
|
|
1933
|
-
/**
|
|
1934
|
-
* The BillToPayQuery request returns information about open bills and credits.
|
|
1935
|
-
* You can use this information in subsequent BillPaymentCheck and BillPaymentCreditCard requests.
|
|
1936
|
-
*/
|
|
1937
|
-
export type BillToPayRet = {
|
|
1938
|
-
objectType?: string;
|
|
1939
|
-
createdAt: string;
|
|
1940
|
-
updatedAt: string;
|
|
1941
|
-
revisionNumber: string;
|
|
1942
|
-
billToPay?: BillToPay;
|
|
1943
|
-
creditToApply?: CreditToApply;
|
|
1929
|
+
bill?: PayableBill;
|
|
1930
|
+
credit?: ApplicableCredit;
|
|
1944
1931
|
customFields?: Array<QbdDataExt> | null;
|
|
1945
1932
|
};
|
|
1946
1933
|
/**
|
|
@@ -2468,17 +2455,6 @@ export type CreateAccountRequest = {
|
|
|
2468
2455
|
bankNumber?: string | null;
|
|
2469
2456
|
externalId?: string | null;
|
|
2470
2457
|
};
|
|
2471
|
-
/**
|
|
2472
|
-
* Request model for creating an AccountTaxLineInfo entry.
|
|
2473
|
-
* NOTE: AccountTaxLineInfo is a READ-ONLY list in QuickBooks.
|
|
2474
|
-
* This request type exists for interface compliance but is NOT SUPPORTED.
|
|
2475
|
-
*/
|
|
2476
|
-
export type CreateAccountTaxLineInfoRequest = {
|
|
2477
|
-
/**
|
|
2478
|
-
* READ-ONLY: This property fulfills the ICreateRequest interface but is not used.
|
|
2479
|
-
*/
|
|
2480
|
-
externalGuid?: string | null;
|
|
2481
|
-
};
|
|
2482
2458
|
/**
|
|
2483
2459
|
* Request model for adding a new additional note (EmployeeAdd).
|
|
2484
2460
|
* Per DTD: AdditionalNotes just has Note element.
|
|
@@ -2547,29 +2523,6 @@ export type CreateAuthSessionRequest = {
|
|
|
2547
2523
|
*/
|
|
2548
2524
|
linkExpiryMins?: number | null;
|
|
2549
2525
|
};
|
|
2550
|
-
/**
|
|
2551
|
-
* QuickBooks does not support creating BarCodes. This request type exists for interface compliance but is NOT SUPPORTED .
|
|
2552
|
-
* BarCodes are typically generated by QuickBooks, but this supports the add operation.
|
|
2553
|
-
*/
|
|
2554
|
-
export type CreateBarCodeRequest = {
|
|
2555
|
-
/**
|
|
2556
|
-
* (Required) The type of list object associated with the barcode.
|
|
2557
|
-
*/
|
|
2558
|
-
listType: string;
|
|
2559
|
-
/**
|
|
2560
|
-
* (Required) The unique identifier of the list object.
|
|
2561
|
-
*/
|
|
2562
|
-
listId: string;
|
|
2563
|
-
/**
|
|
2564
|
-
* (Optional) The full name of the list object.
|
|
2565
|
-
*/
|
|
2566
|
-
fullName?: string | null;
|
|
2567
|
-
/**
|
|
2568
|
-
* Fulfills the ICreateRequest interface.
|
|
2569
|
-
* Used for tracking the "Add" job.
|
|
2570
|
-
*/
|
|
2571
|
-
externalGuid?: string | null;
|
|
2572
|
-
};
|
|
2573
2526
|
/**
|
|
2574
2527
|
* Adds a billing rate to the billing rate list in QuickBooks Desktop.
|
|
2575
2528
|
* Once created, it can be assigned to an employee or vendor to override service item rates in time transactions.
|
|
@@ -2592,10 +2545,13 @@ export type CreateBillingRateRequest = {
|
|
|
2592
2545
|
* Mutually exclusive with FixedBillingRate.
|
|
2593
2546
|
*/
|
|
2594
2547
|
billingRateItems?: Array<BillingRateItemRequest> | null;
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2548
|
+
externalId?: string | null;
|
|
2549
|
+
};
|
|
2550
|
+
/**
|
|
2551
|
+
* BillToPay is a read-only query result in QuickBooks and cannot be created directly.
|
|
2552
|
+
*/
|
|
2553
|
+
export type CreateBillPaymentOrCreditRequest = {
|
|
2554
|
+
[key: string]: unknown;
|
|
2599
2555
|
};
|
|
2600
2556
|
/**
|
|
2601
2557
|
* Request model for creating a new bill in QuickBooks.
|
|
@@ -2653,13 +2609,6 @@ export type CreateBillRequest = {
|
|
|
2653
2609
|
*/
|
|
2654
2610
|
itemLines?: Array<CreateItemLineRequest> | null;
|
|
2655
2611
|
};
|
|
2656
|
-
/**
|
|
2657
|
-
* BillToPay is a read-only query result in QuickBooks and cannot be created directly.
|
|
2658
|
-
* This class exists for architectural compatibility only.
|
|
2659
|
-
*/
|
|
2660
|
-
export type CreateBillToPayRequest = {
|
|
2661
|
-
externalGuid?: string | null;
|
|
2662
|
-
};
|
|
2663
2612
|
/**
|
|
2664
2613
|
* A reusable request DTO for adding a Build Assembly transaction to QuickBooks.
|
|
2665
2614
|
* Adds a build assembly transaction where the specified quantity of the specified inventory assembly item is built.
|
|
@@ -2841,7 +2790,7 @@ export type CreateCheckBillRequest = {
|
|
|
2841
2790
|
* (Required) List of transactions (bills) to apply this check to.
|
|
2842
2791
|
* QBD requiring at least one AppliedToTransactionAddRequest for BillPaymentCheckAdd.
|
|
2843
2792
|
*/
|
|
2844
|
-
appliedToTransactions?: Array<
|
|
2793
|
+
appliedToTransactions?: Array<AppliedToTransactionRequest> | null;
|
|
2845
2794
|
};
|
|
2846
2795
|
/**
|
|
2847
2796
|
* Request model for creating a new check payment
|
|
@@ -2898,7 +2847,7 @@ export type CreateCheckRequest = {
|
|
|
2898
2847
|
* Any transactions linked from a check in the ApplyToTxnAdd aggregate MUST use the same AR account specified in the ExpenseLineAdd AccountRef, which MUST be an ARAccount
|
|
2899
2848
|
* Any transactions linked from a check in the ApplyToTxnAdd aggregate must apply to the same entity referred to in the check PayeeEntityRef.
|
|
2900
2849
|
*/
|
|
2901
|
-
applyToTransactions?: Array<
|
|
2850
|
+
applyToTransactions?: Array<ApplyCheckToTransactionRequest> | null;
|
|
2902
2851
|
};
|
|
2903
2852
|
/**
|
|
2904
2853
|
* Creates a new QuickBooks Class with the specified properties.
|
|
@@ -2983,7 +2932,7 @@ export type CreateCreditCardBillRequest = {
|
|
|
2983
2932
|
*/
|
|
2984
2933
|
exchangeRate?: number | null;
|
|
2985
2934
|
externalId?: string | null;
|
|
2986
|
-
applyToTransactions: Array<
|
|
2935
|
+
applyToTransactions: Array<ApplyToTransactionRequest>;
|
|
2987
2936
|
/**
|
|
2988
2937
|
* Validation: Ensure total matches applied amounts
|
|
2989
2938
|
*/
|
|
@@ -3094,6 +3043,53 @@ export type CreateCreditCardRequest = {
|
|
|
3094
3043
|
*/
|
|
3095
3044
|
itemGroupLines?: Array<CreateItemGroupLineRequest> | null;
|
|
3096
3045
|
};
|
|
3046
|
+
/**
|
|
3047
|
+
* Container for Credit Card Transaction Input and Result info.
|
|
3048
|
+
* Shared across transactions like SalesReceipt and ARRefundCreditCard.
|
|
3049
|
+
*/
|
|
3050
|
+
export type CreateCreditCardTransactionInfoRequest = {
|
|
3051
|
+
/**
|
|
3052
|
+
* (Required) Input details for the credit card transaction.
|
|
3053
|
+
*/
|
|
3054
|
+
inputInfo: CreateCreditCardTransactionInputInfoRequest;
|
|
3055
|
+
/**
|
|
3056
|
+
* (Required) Result details from the credit card processor.
|
|
3057
|
+
*/
|
|
3058
|
+
resultInfo: CreateCreditCardTransactionResultInfoRequest;
|
|
3059
|
+
};
|
|
3060
|
+
/**
|
|
3061
|
+
* Input card details for a Credit Card transaction.
|
|
3062
|
+
*/
|
|
3063
|
+
export type CreateCreditCardTransactionInputInfoRequest = {
|
|
3064
|
+
creditCardNumber: string;
|
|
3065
|
+
expirationMonth: number;
|
|
3066
|
+
expirationYear: number;
|
|
3067
|
+
nameOnCard: string;
|
|
3068
|
+
creditCardAddress?: string | null;
|
|
3069
|
+
creditCardPostalCode?: string | null;
|
|
3070
|
+
commercialCardCode?: string | null;
|
|
3071
|
+
transactionMode?: NullableTransactionMode;
|
|
3072
|
+
creditCardTxnType?: NullableCreditCardTransactionType;
|
|
3073
|
+
};
|
|
3074
|
+
/**
|
|
3075
|
+
* Results from the payment gateway for a Credit Card transaction.
|
|
3076
|
+
*/
|
|
3077
|
+
export type CreateCreditCardTransactionResultInfoRequest = {
|
|
3078
|
+
resultCode: number;
|
|
3079
|
+
resultMessage: string;
|
|
3080
|
+
creditCardTransId: string;
|
|
3081
|
+
merchantAccountNumber: string;
|
|
3082
|
+
paymentStatus: PaymentStatus;
|
|
3083
|
+
txnAuthorizationTime: string;
|
|
3084
|
+
authorizationCode?: string | null;
|
|
3085
|
+
avsStreet?: NullableAvsStreet;
|
|
3086
|
+
avsZip?: NullableAvsZip;
|
|
3087
|
+
cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
|
|
3088
|
+
reconBatchId?: string | null;
|
|
3089
|
+
paymentGroupingCode?: number | null;
|
|
3090
|
+
txnAuthorizationStamp?: number | null;
|
|
3091
|
+
clientTransId?: string | null;
|
|
3092
|
+
};
|
|
3097
3093
|
/**
|
|
3098
3094
|
* Represents a group of items within a Credit Memo creation request.
|
|
3099
3095
|
* Based on CreditMemoLineGroupAdd.
|
|
@@ -3192,7 +3188,7 @@ export type CreateCreditMemoLineRequest = {
|
|
|
3192
3188
|
overrideItemAccountId?: string | null;
|
|
3193
3189
|
otherCustomField1?: string | null;
|
|
3194
3190
|
otherCustomField2?: string | null;
|
|
3195
|
-
creditCardTransactionInfo?:
|
|
3191
|
+
creditCardTransactionInfo?: CreateCreditCardTransactionInfoRequest;
|
|
3196
3192
|
customFields?: Array<DataExtRequest> | null;
|
|
3197
3193
|
};
|
|
3198
3194
|
/**
|
|
@@ -3643,7 +3639,7 @@ export type CreateEstimateRequest = {
|
|
|
3643
3639
|
dataExt?: Array<DataExtRequest> | null;
|
|
3644
3640
|
};
|
|
3645
3641
|
/**
|
|
3646
|
-
*
|
|
3642
|
+
* Expense Line to a transaction.
|
|
3647
3643
|
* Based on the ExpenseLineAdd QBXML type.
|
|
3648
3644
|
*/
|
|
3649
3645
|
export type CreateExpenseLineRequest = {
|
|
@@ -3682,6 +3678,18 @@ export type CreateExpenseLineRequest = {
|
|
|
3682
3678
|
salesRepresentativeId?: string | null;
|
|
3683
3679
|
customFields?: Array<DataExtRequest> | null;
|
|
3684
3680
|
};
|
|
3681
|
+
/**
|
|
3682
|
+
* Represents a single line item for an Inventory Adjustment add operation.
|
|
3683
|
+
* Only ONE of the adjustment properties (Quantity, Value, SerialNumber, LotNumber) should be populated.
|
|
3684
|
+
*/
|
|
3685
|
+
export type CreateInventoryAdjustmentLineRequest = {
|
|
3686
|
+
itemId: string;
|
|
3687
|
+
memo?: string | null;
|
|
3688
|
+
quantityAdjustment?: QuantityAdjustmentRequest;
|
|
3689
|
+
valueAdjustment?: ValueAdjustmentRequest;
|
|
3690
|
+
serialNumberAdjustment?: SerialNumberAdjustmentRequest;
|
|
3691
|
+
lotNumberAdjustment?: LotNumberAdjustmentRequest;
|
|
3692
|
+
};
|
|
3685
3693
|
/**
|
|
3686
3694
|
* A request model for adding a new Inventory Adjustment transaction.
|
|
3687
3695
|
* Corresponds to the InventoryAdjustmentAdd QBXML message.
|
|
@@ -3719,7 +3727,7 @@ export type CreateInventoryAdjustmentRequest = {
|
|
|
3719
3727
|
* (Optional) General memo about the Inventory Adjustment. (Max 4095 characters)
|
|
3720
3728
|
*/
|
|
3721
3729
|
memo?: string | null;
|
|
3722
|
-
inventoryAdjustmentLines: Array<
|
|
3730
|
+
inventoryAdjustmentLines: Array<CreateInventoryAdjustmentLineRequest>;
|
|
3723
3731
|
externalId?: string | null;
|
|
3724
3732
|
};
|
|
3725
3733
|
/**
|
|
@@ -3821,7 +3829,7 @@ export type CreateInvoiceRequest = {
|
|
|
3821
3829
|
exchangeRate?: number | null;
|
|
3822
3830
|
externalId?: string | null;
|
|
3823
3831
|
linkToTransactionIds?: Array<string> | null;
|
|
3824
|
-
applyCredits?: Array<
|
|
3832
|
+
applyCredits?: Array<CreateSetCreditRequest> | null;
|
|
3825
3833
|
lines?: Array<CreateItemLineRequest> | null;
|
|
3826
3834
|
lineGroups?: Array<CreateItemGroupLineRequest> | null;
|
|
3827
3835
|
};
|
|
@@ -3840,7 +3848,7 @@ export type CreateItemDiscountRequest = {
|
|
|
3840
3848
|
discountRatePercent?: number | null;
|
|
3841
3849
|
accountId?: string | null;
|
|
3842
3850
|
accountName?: string | null;
|
|
3843
|
-
|
|
3851
|
+
externalId?: string | null;
|
|
3844
3852
|
};
|
|
3845
3853
|
/**
|
|
3846
3854
|
* Request model for creating an ItemFixedAsset.
|
|
@@ -4295,37 +4303,6 @@ export type CreatePaymentMethodRequest = {
|
|
|
4295
4303
|
*/
|
|
4296
4304
|
paymentMethodType?: string | null;
|
|
4297
4305
|
};
|
|
4298
|
-
/**
|
|
4299
|
-
* Request record for creating a new PayrollItemNonWage in QuickBooks (e.g., Deduction, Company Contribution).
|
|
4300
|
-
* NOTE: Direct creation of this item via QBXML is generally unsupported/read-only by the QuickBooks SDK.
|
|
4301
|
-
*/
|
|
4302
|
-
export type CreatePayrollItemNonWageRequest = {
|
|
4303
|
-
/**
|
|
4304
|
-
* (Required) The name of the non-wage payroll item.
|
|
4305
|
-
*/
|
|
4306
|
-
name: string;
|
|
4307
|
-
/**
|
|
4308
|
-
* (Required) The non-wage item type.
|
|
4309
|
-
* Possible values: Addition, CompanyContribution, Deduction, DirectDeposit, Tax
|
|
4310
|
-
*/
|
|
4311
|
-
nonWageType: string;
|
|
4312
|
-
/**
|
|
4313
|
-
* (Optional) Indicates whether the payroll item is active.
|
|
4314
|
-
*/
|
|
4315
|
-
isActive?: boolean | null;
|
|
4316
|
-
/**
|
|
4317
|
-
* (Optional) The ListID of the Expense Account associated with the payroll item. (Flattened-ID Pattern)
|
|
4318
|
-
*/
|
|
4319
|
-
expenseAccountId?: string | null;
|
|
4320
|
-
/**
|
|
4321
|
-
* (Optional) The ListID of the Liability Account associated with the payroll item. (Flattened-ID Pattern)
|
|
4322
|
-
*/
|
|
4323
|
-
liabilityAccountId?: string | null;
|
|
4324
|
-
/**
|
|
4325
|
-
* (Optional) External GUID for tracking the request.
|
|
4326
|
-
*/
|
|
4327
|
-
externalGuid?: string | null;
|
|
4328
|
-
};
|
|
4329
4306
|
/**
|
|
4330
4307
|
* Request record for creating a new PayrollItemWage in QuickBooks.
|
|
4331
4308
|
*/
|
|
@@ -4347,7 +4324,7 @@ export type CreatePayrollItemWageRequest = {
|
|
|
4347
4324
|
* (Optional) Indicates whether the payroll item is active.
|
|
4348
4325
|
*/
|
|
4349
4326
|
isActive?: boolean | null;
|
|
4350
|
-
|
|
4327
|
+
externalId?: string | null;
|
|
4351
4328
|
};
|
|
4352
4329
|
/**
|
|
4353
4330
|
* Request model for creating a new Price Level in QuickBooks.
|
|
@@ -4588,6 +4565,22 @@ export type CreateReceivePaymentRequest = {
|
|
|
4588
4565
|
isAutoApply?: boolean | null;
|
|
4589
4566
|
appliedToTransactions?: Array<AppliedToTransactionRequest> | null;
|
|
4590
4567
|
};
|
|
4568
|
+
export type CreateSalesAndPurchaseRequest = {
|
|
4569
|
+
salesDescription?: string | null;
|
|
4570
|
+
salesPrice?: number | null;
|
|
4571
|
+
incomeAccountId?: string | null;
|
|
4572
|
+
purchaseDescription?: string | null;
|
|
4573
|
+
purchaseCost?: number | null;
|
|
4574
|
+
purchaseTaxCodeId?: string | null;
|
|
4575
|
+
expenseAccountId?: string | null;
|
|
4576
|
+
prefVendorId?: string | null;
|
|
4577
|
+
};
|
|
4578
|
+
export type CreateSalesOrPurchaseRequest = {
|
|
4579
|
+
description?: string | null;
|
|
4580
|
+
price?: number | null;
|
|
4581
|
+
pricePercent?: number | null;
|
|
4582
|
+
accountId?: string | null;
|
|
4583
|
+
};
|
|
4591
4584
|
/**
|
|
4592
4585
|
* A reusable request DTO for adding an Item Group Line to a Sales Receipt (SalesReceiptLineGroupAdd structure).
|
|
4593
4586
|
*/
|
|
@@ -4677,7 +4670,7 @@ export type CreateSalesReceiptLineRequest = {
|
|
|
4677
4670
|
salesTaxCodeId?: string | null;
|
|
4678
4671
|
otherCustomField1?: string | null;
|
|
4679
4672
|
otherCustomField2?: string | null;
|
|
4680
|
-
creditCardTransaction?:
|
|
4673
|
+
creditCardTransaction?: CreateCreditCardTransactionInfoRequest;
|
|
4681
4674
|
};
|
|
4682
4675
|
/**
|
|
4683
4676
|
* A request model for adding a new Sales Receipt transaction.
|
|
@@ -4748,7 +4741,7 @@ export type CreateSalesReceiptRequest = {
|
|
|
4748
4741
|
* (Optional) The ListID or FullName of the account to deposit the payment to.
|
|
4749
4742
|
*/
|
|
4750
4743
|
depositToAccountId?: string | null;
|
|
4751
|
-
creditCardTransaction?:
|
|
4744
|
+
creditCardTransaction?: CreateCreditCardTransactionInfoRequest;
|
|
4752
4745
|
/**
|
|
4753
4746
|
* (Optional) Exchange rate if this is a foreign currency Sales Receipt.
|
|
4754
4747
|
*/
|
|
@@ -4837,7 +4830,7 @@ export type CreateSalesTaxPaymentCheckRequest = {
|
|
|
4837
4830
|
export type CreateServiceItemRequest = {
|
|
4838
4831
|
name: string;
|
|
4839
4832
|
barCode?: BarCodeRequest;
|
|
4840
|
-
|
|
4833
|
+
externalId?: string | null;
|
|
4841
4834
|
isActive?: boolean | null;
|
|
4842
4835
|
classId?: string | null;
|
|
4843
4836
|
parentId?: string | null;
|
|
@@ -4846,8 +4839,25 @@ export type CreateServiceItemRequest = {
|
|
|
4846
4839
|
forceUOMChange?: boolean | null;
|
|
4847
4840
|
isTaxIncluded?: boolean | null;
|
|
4848
4841
|
dataExt?: Array<QbdDataExt> | null;
|
|
4849
|
-
salesOrPurchase?:
|
|
4850
|
-
salesAndPurchase?:
|
|
4842
|
+
salesOrPurchase?: CreateSalesOrPurchaseRequest;
|
|
4843
|
+
salesAndPurchase?: CreateSalesAndPurchaseRequest;
|
|
4844
|
+
};
|
|
4845
|
+
/**
|
|
4846
|
+
* Represents the SetCredit aggregate in QBXML.
|
|
4847
|
+
* Used within AppliedToTxnAdd to apply specific credit memos or other credits.
|
|
4848
|
+
*/
|
|
4849
|
+
export type CreateSetCreditRequest = {
|
|
4850
|
+
creditTransactionId: string;
|
|
4851
|
+
/**
|
|
4852
|
+
* The amount of the credit to apply.
|
|
4853
|
+
* (Required)
|
|
4854
|
+
*/
|
|
4855
|
+
appliedAmount: number;
|
|
4856
|
+
/**
|
|
4857
|
+
* If true, overrides default logic for applying credits.
|
|
4858
|
+
* (Optional)
|
|
4859
|
+
*/
|
|
4860
|
+
override?: boolean | null;
|
|
4851
4861
|
};
|
|
4852
4862
|
/**
|
|
4853
4863
|
* A request model for creating a new Shipping Method.
|
|
@@ -5099,11 +5109,7 @@ export type CreateVendorTypeRequest = {
|
|
|
5099
5109
|
* Follows the Flattened-ID Pattern for ParentRef.
|
|
5100
5110
|
*/
|
|
5101
5111
|
parentId?: string | null;
|
|
5102
|
-
|
|
5103
|
-
* (Optional) A GUID specified by the client to track the request asynchronously.
|
|
5104
|
-
* Implemented from ICreateRequest.
|
|
5105
|
-
*/
|
|
5106
|
-
externalGuid?: string | null;
|
|
5112
|
+
externalId?: string | null;
|
|
5107
5113
|
};
|
|
5108
5114
|
/**
|
|
5109
5115
|
* Request DTO for adding a new Workers' Compensation Code.
|
|
@@ -5181,7 +5187,6 @@ export type CreditCardBill = {
|
|
|
5181
5187
|
};
|
|
5182
5188
|
/**
|
|
5183
5189
|
* Represents a Credit Card Charge transaction.
|
|
5184
|
-
* Corresponds to CreditCardChargeRet in QbdXml.
|
|
5185
5190
|
*/
|
|
5186
5191
|
export type CreditCardCharge = {
|
|
5187
5192
|
id: string;
|
|
@@ -5282,90 +5287,28 @@ export type CreditCardTransactionInfo = {
|
|
|
5282
5287
|
request: CreditCardTransactionInputInfo;
|
|
5283
5288
|
response: CreditCardTransactionResultInfo;
|
|
5284
5289
|
};
|
|
5285
|
-
/**
|
|
5286
|
-
* Container for Credit Card Transaction Input and Result info.
|
|
5287
|
-
* Shared across transactions like SalesReceipt and ARRefundCreditCard.
|
|
5288
|
-
*/
|
|
5289
|
-
export type CreditCardTransactionInfoAddRequest = {
|
|
5290
|
-
/**
|
|
5291
|
-
* (Required) Input details for the credit card transaction.
|
|
5292
|
-
*/
|
|
5293
|
-
inputInfo: CreditCardTransactionInputInfoAddRequest;
|
|
5294
|
-
/**
|
|
5295
|
-
* (Required) Result details from the credit card processor.
|
|
5296
|
-
*/
|
|
5297
|
-
resultInfo: CreditCardTransactionResultInfoAddRequest;
|
|
5298
|
-
};
|
|
5299
|
-
/**
|
|
5300
|
-
* Aggregate containing credit card input and result information for a payment (Mod).
|
|
5301
|
-
*/
|
|
5302
|
-
export type CreditCardTransactionInfoModRequest = {
|
|
5303
|
-
creditCardTxnInputInfoMod?: CreditCardTransactionInputInfoModRequest;
|
|
5304
|
-
creditCardTxnResultInfoMod?: CreditCardTransactionResultInfoModRequest;
|
|
5305
|
-
};
|
|
5306
5290
|
/**
|
|
5307
5291
|
* DTO for credit card input details.
|
|
5308
5292
|
*/
|
|
5309
5293
|
export type CreditCardTransactionInputInfo = {
|
|
5310
5294
|
number: string;
|
|
5311
|
-
expirationMonth: number | null;
|
|
5312
|
-
expirationYear: number | null;
|
|
5313
|
-
name: string;
|
|
5314
|
-
sddress?: string | null;
|
|
5315
|
-
postalCode?: string | null;
|
|
5316
|
-
commercialCardCode?: string | null;
|
|
5317
|
-
transactionMode?: NullableTransactionMode;
|
|
5318
|
-
transactionType?: NullableCreditCardTransactionType;
|
|
5319
|
-
};
|
|
5320
|
-
/**
|
|
5321
|
-
* Input card details for a Credit Card transaction.
|
|
5322
|
-
*/
|
|
5323
|
-
export type CreditCardTransactionInputInfoAddRequest = {
|
|
5324
|
-
creditCardNumber: string;
|
|
5325
|
-
expirationMonth: number;
|
|
5326
|
-
expirationYear: number;
|
|
5327
|
-
nameOnCard: string;
|
|
5328
|
-
creditCardAddress?: string | null;
|
|
5329
|
-
creditCardPostalCode?: string | null;
|
|
5330
|
-
commercialCardCode?: string | null;
|
|
5331
|
-
transactionMode?: NullableTransactionMode;
|
|
5332
|
-
creditCardTxnType?: NullableCreditCardTransactionType;
|
|
5333
|
-
};
|
|
5334
|
-
/**
|
|
5335
|
-
* Contains modifiable data about the credit card itself for a payment request (Mod).
|
|
5336
|
-
* Note: All properties are optional as this is a modification request.
|
|
5337
|
-
*/
|
|
5338
|
-
export type CreditCardTransactionInputInfoModRequest = {
|
|
5339
|
-
/**
|
|
5340
|
-
* (Optional) The customer's new credit card number. (Max 25 characters)
|
|
5341
|
-
*/
|
|
5342
|
-
creditCardNumber?: string | null;
|
|
5343
5295
|
/**
|
|
5344
5296
|
* (Optional) The credit card's new expiration month (1-12).
|
|
5345
5297
|
*/
|
|
5346
|
-
expirationMonth
|
|
5298
|
+
expirationMonth: number | null;
|
|
5347
5299
|
/**
|
|
5348
5300
|
* (Optional) The credit card's new expiration year (e.g., 2025).
|
|
5349
5301
|
*/
|
|
5350
|
-
expirationYear
|
|
5351
|
-
|
|
5352
|
-
|
|
5353
|
-
|
|
5354
|
-
nameOnCard?: string | null;
|
|
5355
|
-
/**
|
|
5356
|
-
* (Optional) New street address for AVS validation. (Max 41 characters)
|
|
5357
|
-
*/
|
|
5358
|
-
creditCardAddress?: string | null;
|
|
5359
|
-
/**
|
|
5360
|
-
* (Optional) New Postal/ZIP code for AVS validation. (Max 13 characters)
|
|
5361
|
-
*/
|
|
5362
|
-
creditCardPostalCode?: string | null;
|
|
5302
|
+
expirationYear: number | null;
|
|
5303
|
+
name: string;
|
|
5304
|
+
sddress?: string | null;
|
|
5305
|
+
postalCode?: string | null;
|
|
5363
5306
|
/**
|
|
5364
5307
|
* (Optional) New commercial card code. (Max 4 characters)
|
|
5365
5308
|
*/
|
|
5366
5309
|
commercialCardCode?: string | null;
|
|
5367
5310
|
transactionMode?: NullableTransactionMode;
|
|
5368
|
-
|
|
5311
|
+
transactionType?: NullableCreditCardTransactionType;
|
|
5369
5312
|
};
|
|
5370
5313
|
/**
|
|
5371
5314
|
* DTO for credit card result details.
|
|
@@ -5386,41 +5329,6 @@ export type CreditCardTransactionResultInfo = {
|
|
|
5386
5329
|
transactionAuthorizationStamp?: number | null;
|
|
5387
5330
|
clientTransactionId?: string | null;
|
|
5388
5331
|
};
|
|
5389
|
-
/**
|
|
5390
|
-
* Results from the payment gateway for a Credit Card transaction.
|
|
5391
|
-
*/
|
|
5392
|
-
export type CreditCardTransactionResultInfoAddRequest = {
|
|
5393
|
-
resultCode: number;
|
|
5394
|
-
resultMessage: string;
|
|
5395
|
-
creditCardTransId: string;
|
|
5396
|
-
merchantAccountNumber: string;
|
|
5397
|
-
paymentStatus: PaymentStatus;
|
|
5398
|
-
txnAuthorizationTime: string;
|
|
5399
|
-
authorizationCode?: string | null;
|
|
5400
|
-
avsStreet?: NullableAvsStreet;
|
|
5401
|
-
avsZip?: NullableAvsZip;
|
|
5402
|
-
cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
|
|
5403
|
-
reconBatchId?: string | null;
|
|
5404
|
-
paymentGroupingCode?: number | null;
|
|
5405
|
-
txnAuthorizationStamp?: number | null;
|
|
5406
|
-
clientTransId?: string | null;
|
|
5407
|
-
};
|
|
5408
|
-
export type CreditCardTransactionResultInfoModRequest = {
|
|
5409
|
-
resultCode: number;
|
|
5410
|
-
resultMessage: string;
|
|
5411
|
-
creditCardTransId: string;
|
|
5412
|
-
merchantAccountNumber: string;
|
|
5413
|
-
paymentStatus: PaymentStatus;
|
|
5414
|
-
txnAuthorizationTime: string;
|
|
5415
|
-
authorizationCode?: string | null;
|
|
5416
|
-
avsStreet?: NullableAvsStreet;
|
|
5417
|
-
avsZip?: NullableAvsZip;
|
|
5418
|
-
cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
|
|
5419
|
-
reconBatchId?: string | null;
|
|
5420
|
-
paymentGroupingCode?: number | null;
|
|
5421
|
-
txnAuthorizationStamp?: number | null;
|
|
5422
|
-
clientTransId?: string | null;
|
|
5423
|
-
};
|
|
5424
5332
|
/**
|
|
5425
5333
|
* Request model for credit card transaction information.
|
|
5426
5334
|
*/
|
|
@@ -5609,35 +5517,6 @@ export type CreditMemoLineGroup = {
|
|
|
5609
5517
|
lines?: Array<CreditMemoLine> | null;
|
|
5610
5518
|
customFields?: Array<QbdDataExt> | null;
|
|
5611
5519
|
};
|
|
5612
|
-
/**
|
|
5613
|
-
* Represents a credit that can be applied to a bill.
|
|
5614
|
-
*/
|
|
5615
|
-
export type CreditToApply = {
|
|
5616
|
-
id: string;
|
|
5617
|
-
objectType?: string;
|
|
5618
|
-
createdAt: string;
|
|
5619
|
-
updatedAt: string;
|
|
5620
|
-
revisionNumber: string;
|
|
5621
|
-
transactionDate?: string | null;
|
|
5622
|
-
currency?: QbdRef;
|
|
5623
|
-
exchangeRate?: number | null;
|
|
5624
|
-
refNumber?: string | null;
|
|
5625
|
-
memo?: string | null;
|
|
5626
|
-
transactionType?: string | null;
|
|
5627
|
-
payablesAccount?: QbdRef;
|
|
5628
|
-
creditRemaining?: number | null;
|
|
5629
|
-
creditRemainingInHomeCurrency?: number | null;
|
|
5630
|
-
amount?: number | null;
|
|
5631
|
-
entity?: QbdRef;
|
|
5632
|
-
account?: QbdRef;
|
|
5633
|
-
hasValidLineItems?: boolean;
|
|
5634
|
-
externalId?: string | null;
|
|
5635
|
-
linkedTransactions?: Array<LinkedTransaction> | null;
|
|
5636
|
-
expenseLines?: Array<ExpenseLine> | null;
|
|
5637
|
-
itemLines?: Array<ItemLine> | null;
|
|
5638
|
-
itemGroupLines?: Array<ItemGroupLine> | null;
|
|
5639
|
-
customFields?: Array<QbdDataExt> | null;
|
|
5640
|
-
};
|
|
5641
5520
|
/**
|
|
5642
5521
|
* Represents a Currency DTO (CurrencyRet).
|
|
5643
5522
|
* Used for multi-currency support in QuickBooks.
|
|
@@ -6445,6 +6324,10 @@ export type InventoryAdjustment = {
|
|
|
6445
6324
|
itemGroupLines?: Array<ItemGroupLine> | null;
|
|
6446
6325
|
customFields?: Array<QbdDataExt> | null;
|
|
6447
6326
|
};
|
|
6327
|
+
/**
|
|
6328
|
+
* Represents a single line item for an Inventory Adjustment add operation.
|
|
6329
|
+
* Only ONE of the adjustment properties (Quantity, Value, SerialNumber, LotNumber) should be populated.
|
|
6330
|
+
*/
|
|
6448
6331
|
export type InventoryAdjustmentLine = {
|
|
6449
6332
|
id: string;
|
|
6450
6333
|
item?: QbdRef;
|
|
@@ -6457,32 +6340,6 @@ export type InventoryAdjustmentLine = {
|
|
|
6457
6340
|
valueDifference?: number | null;
|
|
6458
6341
|
customFields?: Array<QbdDataExt> | null;
|
|
6459
6342
|
};
|
|
6460
|
-
/**
|
|
6461
|
-
* Represents a single line item for an Inventory Adjustment add operation.
|
|
6462
|
-
* Only ONE of the adjustment properties (Quantity, Value, SerialNumber, LotNumber) should be populated.
|
|
6463
|
-
*/
|
|
6464
|
-
export type InventoryAdjustmentLineAddRequest = {
|
|
6465
|
-
itemId: string;
|
|
6466
|
-
memo?: string | null;
|
|
6467
|
-
quantityAdjustment?: QuantityAdjustmentRequest;
|
|
6468
|
-
valueAdjustment?: ValueAdjustmentRequest;
|
|
6469
|
-
serialNumberAdjustment?: SerialNumberAdjustmentRequest;
|
|
6470
|
-
lotNumberAdjustment?: LotNumberAdjustmentRequest;
|
|
6471
|
-
};
|
|
6472
|
-
/**
|
|
6473
|
-
* Represents a single line item modification for an Inventory Adjustment.
|
|
6474
|
-
*/
|
|
6475
|
-
export type InventoryAdjustmentLineModRequest = {
|
|
6476
|
-
id: string;
|
|
6477
|
-
itemId?: string | null;
|
|
6478
|
-
quantityDifference?: number | null;
|
|
6479
|
-
valueDifference?: number | null;
|
|
6480
|
-
serialNumber?: string | null;
|
|
6481
|
-
lotNumber?: string | null;
|
|
6482
|
-
countAdjustment?: number | null;
|
|
6483
|
-
expirationDateForSerialLotNumber?: string | null;
|
|
6484
|
-
inventorySiteLocationId?: string | null;
|
|
6485
|
-
};
|
|
6486
6343
|
/**
|
|
6487
6344
|
* Inventory are things the QuickBooks company sells, as well as things it buys. QuickBooks Desktop can manage product inventory. Line items entered on sales,
|
|
6488
6345
|
* purchase, and refund transactions flow into inventory items to automatically adjust quantity on hand. Additionally, cost and price of individual inventory
|
|
@@ -7830,15 +7687,6 @@ export type LotNumberAdjustmentRequest = {
|
|
|
7830
7687
|
expirationDateForSerialLotNumber?: string | null;
|
|
7831
7688
|
inventorySiteLocationId?: string | null;
|
|
7832
7689
|
};
|
|
7833
|
-
/**
|
|
7834
|
-
* Simple message-only response payload.
|
|
7835
|
-
*/
|
|
7836
|
-
export type MessageResponse = {
|
|
7837
|
-
/**
|
|
7838
|
-
* Human-readable message describing the result.
|
|
7839
|
-
*/
|
|
7840
|
-
message: string;
|
|
7841
|
-
};
|
|
7842
7690
|
export declare enum NullableAccountType {
|
|
7843
7691
|
ACCOUNTS_PAYABLE = "AccountsPayable",
|
|
7844
7692
|
ACCOUNTS_RECEIVABLE = "AccountsReceivable",
|
|
@@ -7955,6 +7803,39 @@ export type OtherName = {
|
|
|
7955
7803
|
isActive?: boolean;
|
|
7956
7804
|
customFields?: Array<QbdDataExt> | null;
|
|
7957
7805
|
};
|
|
7806
|
+
/**
|
|
7807
|
+
* Represents an open bill that needs to be paid.
|
|
7808
|
+
*/
|
|
7809
|
+
export type PayableBill = {
|
|
7810
|
+
id: string;
|
|
7811
|
+
objectType?: string;
|
|
7812
|
+
createdAt: string;
|
|
7813
|
+
updatedAt: string;
|
|
7814
|
+
revisionNumber: string;
|
|
7815
|
+
transactionDate?: string | null;
|
|
7816
|
+
currency?: QbdRef;
|
|
7817
|
+
amountDue?: number | null;
|
|
7818
|
+
exchangeRate?: number | null;
|
|
7819
|
+
/**
|
|
7820
|
+
* Amount due in home currency. This is a direct property for now.
|
|
7821
|
+
*/
|
|
7822
|
+
amountDueInHomeCurrency?: string | null;
|
|
7823
|
+
refNumber?: string | null;
|
|
7824
|
+
memo?: string | null;
|
|
7825
|
+
transactionType?: string | null;
|
|
7826
|
+
payablesAccount?: QbdRef;
|
|
7827
|
+
dueDate?: string | null;
|
|
7828
|
+
entity?: QbdRef;
|
|
7829
|
+
account?: QbdRef;
|
|
7830
|
+
amountInHomeCurrency?: string | null;
|
|
7831
|
+
hasValidLineItems?: boolean;
|
|
7832
|
+
externalId?: string | null;
|
|
7833
|
+
linkedTransactions?: Array<LinkedTransaction> | null;
|
|
7834
|
+
expenseLines?: Array<ExpenseLine> | null;
|
|
7835
|
+
itemLines?: Array<ItemLine> | null;
|
|
7836
|
+
itemGroupLines?: Array<ItemGroupLine> | null;
|
|
7837
|
+
customFields?: Array<QbdDataExt> | null;
|
|
7838
|
+
};
|
|
7958
7839
|
/**
|
|
7959
7840
|
* DTO for the PaymentMethod list item.
|
|
7960
7841
|
*/
|
|
@@ -8112,13 +7993,6 @@ export type PriceLevelPerItemRequest = {
|
|
|
8112
7993
|
*/
|
|
8113
7994
|
adjustRelativeTo?: string | null;
|
|
8114
7995
|
};
|
|
8115
|
-
export type ProblemDetails = {
|
|
8116
|
-
type?: string | null;
|
|
8117
|
-
title?: string | null;
|
|
8118
|
-
status?: number | null;
|
|
8119
|
-
detail?: string | null;
|
|
8120
|
-
instance?: string | null;
|
|
8121
|
-
};
|
|
8122
7996
|
/**
|
|
8123
7997
|
* Represents a Purchase Order transaction (PurchaseOrderRet).
|
|
8124
7998
|
* Used to request items or services from a vendor.
|
|
@@ -8572,41 +8446,6 @@ export type RotatePublishableKeyResponse = {
|
|
|
8572
8446
|
message?: string;
|
|
8573
8447
|
rotatedAt?: string;
|
|
8574
8448
|
};
|
|
8575
|
-
export type SalesAndPurchaseModRequest = {
|
|
8576
|
-
salesDesc?: string | null;
|
|
8577
|
-
salesPrice?: number | null;
|
|
8578
|
-
incomeAccountId?: string | null;
|
|
8579
|
-
applyIncomeAccountToExistingTransactions?: boolean | null;
|
|
8580
|
-
purchaseDesc?: string | null;
|
|
8581
|
-
purchaseCost?: number | null;
|
|
8582
|
-
purchaseTaxCodeId?: string | null;
|
|
8583
|
-
expenseAccountId?: string | null;
|
|
8584
|
-
applyExpenseAccountToExistingTransactions?: boolean | null;
|
|
8585
|
-
prefVendorId?: string | null;
|
|
8586
|
-
};
|
|
8587
|
-
export type SalesAndPurchaseRequest = {
|
|
8588
|
-
salesDesc?: string | null;
|
|
8589
|
-
salesPrice?: number | null;
|
|
8590
|
-
incomeAccountId?: string | null;
|
|
8591
|
-
purchaseDesc?: string | null;
|
|
8592
|
-
purchaseCost?: number | null;
|
|
8593
|
-
purchaseTaxCodeId?: string | null;
|
|
8594
|
-
expenseAccountId?: string | null;
|
|
8595
|
-
prefVendorId?: string | null;
|
|
8596
|
-
};
|
|
8597
|
-
export type SalesOrPurchaseModRequest = {
|
|
8598
|
-
desc?: string | null;
|
|
8599
|
-
price?: number | null;
|
|
8600
|
-
pricePercent?: number | null;
|
|
8601
|
-
accountId?: string | null;
|
|
8602
|
-
applyAccountToExistingTransactions?: boolean | null;
|
|
8603
|
-
};
|
|
8604
|
-
export type SalesOrPurchaseRequest = {
|
|
8605
|
-
desc?: string | null;
|
|
8606
|
-
price?: number | null;
|
|
8607
|
-
pricePercent?: number | null;
|
|
8608
|
-
accountId?: string | null;
|
|
8609
|
-
};
|
|
8610
8449
|
/**
|
|
8611
8450
|
* Represents a Sales Receipt transaction (SalesReceiptRet).
|
|
8612
8451
|
* Used for immediate payment sales.
|
|
@@ -8886,22 +8725,13 @@ export type ServiceItem = {
|
|
|
8886
8725
|
isActive?: boolean;
|
|
8887
8726
|
customFields?: Array<QbdDataExt> | null;
|
|
8888
8727
|
};
|
|
8889
|
-
export type SetCredit = {
|
|
8890
|
-
id: string;
|
|
8891
|
-
amount: number;
|
|
8892
|
-
override?: boolean | null;
|
|
8893
|
-
};
|
|
8894
8728
|
/**
|
|
8895
8729
|
* Represents the SetCredit aggregate in QBXML.
|
|
8896
8730
|
* Used within AppliedToTxnAdd to apply specific credit memos or other credits.
|
|
8897
8731
|
*/
|
|
8898
|
-
export type
|
|
8899
|
-
|
|
8900
|
-
|
|
8901
|
-
* The amount of the credit to apply.
|
|
8902
|
-
* (Required)
|
|
8903
|
-
*/
|
|
8904
|
-
appliedAmount: number;
|
|
8732
|
+
export type SetCredit = {
|
|
8733
|
+
id: string;
|
|
8734
|
+
amount: number;
|
|
8905
8735
|
/**
|
|
8906
8736
|
* If true, overrides default logic for applying credits.
|
|
8907
8737
|
* (Optional)
|
|
@@ -8911,7 +8741,16 @@ export type SetCreditAddRequest = {
|
|
|
8911
8741
|
export type SetCreditRequest = {
|
|
8912
8742
|
creditTransactionId: string;
|
|
8913
8743
|
id?: string | null;
|
|
8744
|
+
/**
|
|
8745
|
+
* Amount applied to an account, invoice, or payment (Optional).
|
|
8746
|
+
*
|
|
8747
|
+
* Represents a monetary value; currency and precision are determined by the surrounding
|
|
8748
|
+
* context.
|
|
8749
|
+
*/
|
|
8914
8750
|
appliedAmount: number;
|
|
8751
|
+
/**
|
|
8752
|
+
* Indicates whether to override the default credit application behavior.
|
|
8753
|
+
*/
|
|
8915
8754
|
override?: boolean | null;
|
|
8916
8755
|
};
|
|
8917
8756
|
/**
|
|
@@ -9210,25 +9049,21 @@ export type UpdateAccountRequest = {
|
|
|
9210
9049
|
* Whether the account is active
|
|
9211
9050
|
*/
|
|
9212
9051
|
isActive?: boolean | null;
|
|
9052
|
+
accountType?: NullableAccountType;
|
|
9213
9053
|
/**
|
|
9214
|
-
*
|
|
9215
|
-
* NOTE: Cannot create non_posting accounts via API - QuickBooks creates these internally
|
|
9216
|
-
*/
|
|
9217
|
-
accountType: AccountType;
|
|
9218
|
-
/**
|
|
9219
|
-
* Whether the account is a tax account
|
|
9054
|
+
* Whether the account is a tax account (optional)
|
|
9220
9055
|
*/
|
|
9221
9056
|
isTaxAccount?: boolean | null;
|
|
9222
9057
|
/**
|
|
9223
|
-
* Account number
|
|
9058
|
+
* Account number (optional)
|
|
9224
9059
|
*/
|
|
9225
9060
|
accountNumber?: string | null;
|
|
9226
9061
|
/**
|
|
9227
|
-
* Account description
|
|
9062
|
+
* Account description (optional)
|
|
9228
9063
|
*/
|
|
9229
9064
|
description?: string | null;
|
|
9230
9065
|
/**
|
|
9231
|
-
* Parent account reference (for sub-accounts)
|
|
9066
|
+
* Parent account reference (optional, for sub-accounts)
|
|
9232
9067
|
*/
|
|
9233
9068
|
parentId?: string | null;
|
|
9234
9069
|
/**
|
|
@@ -9236,7 +9071,7 @@ export type UpdateAccountRequest = {
|
|
|
9236
9071
|
* the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.
|
|
9237
9072
|
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks.
|
|
9238
9073
|
* If QuickBooks is not set up to charge sales tax(via the "Do You Charge Sales Tax?" preference), it will assign the
|
|
9239
|
-
* default non-taxable code to all sales.
|
|
9074
|
+
* default non-taxable code to all sales. (Optional)
|
|
9240
9075
|
*/
|
|
9241
9076
|
salesTaxCodeId?: string | null;
|
|
9242
9077
|
/**
|
|
@@ -9254,25 +9089,17 @@ export type UpdateAccountRequest = {
|
|
|
9254
9089
|
taxLineId?: string | null;
|
|
9255
9090
|
/**
|
|
9256
9091
|
* The account's currency. For built-in currencies, the name and code are standard international values. For user-defined
|
|
9257
|
-
* currencies, all values are editable.
|
|
9092
|
+
* currencies, all values are editable. (Optional)
|
|
9258
9093
|
*/
|
|
9259
9094
|
currencyId?: string | null;
|
|
9260
9095
|
/**
|
|
9261
|
-
* Bank account number (for bank accounts only)
|
|
9096
|
+
* Bank account number (Optional, for bank accounts only)
|
|
9262
9097
|
*
|
|
9263
9098
|
*
|
|
9264
9099
|
* <i>**NOTE:** QuickBooks Desktop does not support cursor-based pagination for this resource.</i>
|
|
9265
9100
|
*/
|
|
9266
9101
|
bankNumber?: string | null;
|
|
9267
9102
|
};
|
|
9268
|
-
/**
|
|
9269
|
-
* Request model for updating an AccountTaxLineInfo entry.
|
|
9270
|
-
* NOTE: AccountTaxLineInfo is a READ-ONLY list in QuickBooks.
|
|
9271
|
-
* This request type exists for interface compliance but is NOT SUPPORTED.
|
|
9272
|
-
*/
|
|
9273
|
-
export type UpdateAccountTaxLineInfoRequest = {
|
|
9274
|
-
revisionNumber: string;
|
|
9275
|
-
};
|
|
9276
9103
|
/**
|
|
9277
9104
|
* Request model for modifying an additional note (EmployeeMod).
|
|
9278
9105
|
* Per DTD: AdditionalNotesMod requires NoteID + Note.
|
|
@@ -9325,20 +9152,10 @@ export type UpdateArRefundCreditCardRequest = {
|
|
|
9325
9152
|
refundAppliedToTransactions?: Array<RefundAppliedToTransactionRequest> | null;
|
|
9326
9153
|
};
|
|
9327
9154
|
/**
|
|
9328
|
-
*
|
|
9329
|
-
* settings by deleting the existing BarCode and creating a new one with the updated information.
|
|
9330
|
-
*/
|
|
9331
|
-
export type UpdateBarCodeRequest = {
|
|
9332
|
-
listType: string;
|
|
9333
|
-
fullName?: string | null;
|
|
9334
|
-
revisionNumber: string;
|
|
9335
|
-
};
|
|
9336
|
-
/**
|
|
9337
|
-
* BillingRate Mod Request - Not supported, but required for abstract classes
|
|
9338
|
-
* BillingRate Mod Request - Not supported, but required for abstract classes
|
|
9155
|
+
* BillToPay is a read-only query result in QuickBooks and cannot be modified directly.
|
|
9339
9156
|
*/
|
|
9340
|
-
export type
|
|
9341
|
-
|
|
9157
|
+
export type UpdateBillPaymentOrCreditRequest = {
|
|
9158
|
+
[key: string]: unknown;
|
|
9342
9159
|
};
|
|
9343
9160
|
/**
|
|
9344
9161
|
* Defines the request model for updating an existing Bill.
|
|
@@ -9379,13 +9196,6 @@ export type UpdateBillRequest = {
|
|
|
9379
9196
|
clearItemLines?: boolean | null;
|
|
9380
9197
|
itemLines?: Array<UpdateItemLineRequest> | null;
|
|
9381
9198
|
};
|
|
9382
|
-
/**
|
|
9383
|
-
* BillToPay is a read-only query result in QuickBooks and cannot be modified directly.
|
|
9384
|
-
* This class exists for architectural compatibility only.
|
|
9385
|
-
*/
|
|
9386
|
-
export type UpdateBillToPayRequest = {
|
|
9387
|
-
editSequence?: string;
|
|
9388
|
-
};
|
|
9389
9199
|
/**
|
|
9390
9200
|
* A reusable request DTO for modifying an existing Build Assembly transaction.
|
|
9391
9201
|
* Based on the BuildAssemblyMod QBXML type.
|
|
@@ -9505,23 +9315,7 @@ export type UpdateChargeRequest = {
|
|
|
9505
9315
|
overrideItemAccountId?: string | null;
|
|
9506
9316
|
};
|
|
9507
9317
|
/**
|
|
9508
|
-
*
|
|
9509
|
-
* Based on the CheckMod QBXML type.
|
|
9510
|
-
*
|
|
9511
|
-
* QBXML Schema Constraints (from qbxmlops170.xml):
|
|
9512
|
-
* - TxnID: Required
|
|
9513
|
-
* - EditSequence: Required, max length = 16
|
|
9514
|
-
* - PayeeEntityRef: Optional, FullName max length = 209
|
|
9515
|
-
* - AccountRef: Optional, FullName max length = 159
|
|
9516
|
-
* - TxnDate: Optional
|
|
9517
|
-
* - RefNumber: Optional, max length = 11 (OR IsToBePrinted)
|
|
9518
|
-
* - APAccountRef: Optional, FullName max length = 159
|
|
9519
|
-
* - Amount: Optional
|
|
9520
|
-
* - CurrencyRef: Optional, FullName max length = 64
|
|
9521
|
-
* - ExchangeRate: Optional
|
|
9522
|
-
* - AmountInHomeCurrency: Optional
|
|
9523
|
-
* - Memo: Optional, max length = 4095
|
|
9524
|
-
* - IsToBePrinted: Optional (OR RefNumber)
|
|
9318
|
+
* Request model for updating an existing Check transaction used to pay bills.
|
|
9525
9319
|
*/
|
|
9526
9320
|
export type UpdateCheckBillRequest = {
|
|
9527
9321
|
revisionNumber: string;
|
|
@@ -9568,7 +9362,7 @@ export type UpdateCheckBillRequest = {
|
|
|
9568
9362
|
/**
|
|
9569
9363
|
* (Optional) List of transactions to apply updates to.
|
|
9570
9364
|
*/
|
|
9571
|
-
appliedToTransactions?: Array<
|
|
9365
|
+
appliedToTransactions?: Array<AppliedToTransactionRequest> | null;
|
|
9572
9366
|
};
|
|
9573
9367
|
/**
|
|
9574
9368
|
* Request model for updating an existing check payment
|
|
@@ -9609,7 +9403,7 @@ export type UpdateCheckRequest = {
|
|
|
9609
9403
|
/**
|
|
9610
9404
|
* Transactions to which this check is applied (modifies existing links)
|
|
9611
9405
|
*/
|
|
9612
|
-
applyToTransactions?: Array<
|
|
9406
|
+
applyToTransactions?: Array<ApplyCheckToTransactionRequest> | null;
|
|
9613
9407
|
/**
|
|
9614
9408
|
* Clear existing expense lines
|
|
9615
9409
|
*/
|
|
@@ -9697,7 +9491,7 @@ export type UpdateCreditCardBillRequest = {
|
|
|
9697
9491
|
* Memo/description for the payment
|
|
9698
9492
|
*/
|
|
9699
9493
|
memo?: string | null;
|
|
9700
|
-
applyToTransactions?: Array<
|
|
9494
|
+
applyToTransactions?: Array<ApplyToTransactionRequest> | null;
|
|
9701
9495
|
};
|
|
9702
9496
|
/**
|
|
9703
9497
|
* Request model for updating an existing CreditCardCredit transaction.
|
|
@@ -9798,6 +9592,7 @@ export type UpdateCreditCardRequest = {
|
|
|
9798
9592
|
clearExpenseLines?: boolean | null;
|
|
9799
9593
|
/**
|
|
9800
9594
|
* (Optional) A list of expense lines to modify.
|
|
9595
|
+
* Note: To add new lines, use a line id of "-1". To modify existing lines, provide the current line id from QuickBooks.
|
|
9801
9596
|
*/
|
|
9802
9597
|
expenseLines?: Array<UpdateExpenseLineRequest> | null;
|
|
9803
9598
|
/**
|
|
@@ -9807,13 +9602,74 @@ export type UpdateCreditCardRequest = {
|
|
|
9807
9602
|
clearItemLines?: boolean | null;
|
|
9808
9603
|
/**
|
|
9809
9604
|
* (Optional) A list of item lines to modify.
|
|
9605
|
+
* Note: To add new lines, use a line id of "-1". To modify existing lines, provide the current line id from QuickBooks.
|
|
9810
9606
|
*/
|
|
9811
9607
|
itemLines?: Array<UpdateItemLineRequest> | null;
|
|
9812
9608
|
/**
|
|
9813
9609
|
* (Optional) A list of item group lines to modify.
|
|
9610
|
+
* Note: To add new lines, use a line id of "-1". To modify existing lines, provide the current line id from QuickBooks.
|
|
9814
9611
|
*/
|
|
9815
9612
|
itemGroupLines?: Array<UpdateItemGroupLineRequest> | null;
|
|
9816
9613
|
};
|
|
9614
|
+
/**
|
|
9615
|
+
* Aggregate containing credit card input and result information for a payment (Mod).
|
|
9616
|
+
*/
|
|
9617
|
+
export type UpdateCreditCardTransactionInfoRequest = {
|
|
9618
|
+
creditCardTxnInputInfoMod?: UpdateCreditCardTransactionInputInfoRequest;
|
|
9619
|
+
creditCardTxnResultInfoMod?: UpdateCreditCardTransactionResultInfoRequest;
|
|
9620
|
+
};
|
|
9621
|
+
/**
|
|
9622
|
+
* Contains modifiable data about the credit card itself for a payment request (Mod).
|
|
9623
|
+
* Note: All properties are optional as this is a modification request.
|
|
9624
|
+
*/
|
|
9625
|
+
export type UpdateCreditCardTransactionInputInfoRequest = {
|
|
9626
|
+
/**
|
|
9627
|
+
* (Optional) The customer's new credit card number. (Max 25 characters)
|
|
9628
|
+
*/
|
|
9629
|
+
creditCardNumber?: string | null;
|
|
9630
|
+
/**
|
|
9631
|
+
* (Optional) The credit card's new expiration month (1-12).
|
|
9632
|
+
*/
|
|
9633
|
+
expirationMonth?: number | null;
|
|
9634
|
+
/**
|
|
9635
|
+
* (Optional) The credit card's new expiration year (e.g., 2025).
|
|
9636
|
+
*/
|
|
9637
|
+
expirationYear?: number | null;
|
|
9638
|
+
/**
|
|
9639
|
+
* (Optional) The new name as it appears on the credit card. (Max 50 characters)
|
|
9640
|
+
*/
|
|
9641
|
+
nameOnCard?: string | null;
|
|
9642
|
+
/**
|
|
9643
|
+
* (Optional) New street address for AVS validation. (Max 41 characters)
|
|
9644
|
+
*/
|
|
9645
|
+
creditCardAddress?: string | null;
|
|
9646
|
+
/**
|
|
9647
|
+
* (Optional) New Postal/ZIP code for AVS validation. (Max 13 characters)
|
|
9648
|
+
*/
|
|
9649
|
+
creditCardPostalCode?: string | null;
|
|
9650
|
+
/**
|
|
9651
|
+
* (Optional) New commercial card code. (Max 4 characters)
|
|
9652
|
+
*/
|
|
9653
|
+
commercialCardCode?: string | null;
|
|
9654
|
+
transactionMode?: NullableTransactionMode;
|
|
9655
|
+
creditCardTxnType?: NullableCreditCardTransactionType;
|
|
9656
|
+
};
|
|
9657
|
+
export type UpdateCreditCardTransactionResultInfoRequest = {
|
|
9658
|
+
resultCode: number;
|
|
9659
|
+
resultMessage: string;
|
|
9660
|
+
creditCardTransId: string;
|
|
9661
|
+
merchantAccountNumber: string;
|
|
9662
|
+
paymentStatus: PaymentStatus;
|
|
9663
|
+
txnAuthorizationTime: string;
|
|
9664
|
+
authorizationCode?: string | null;
|
|
9665
|
+
avsStreet?: NullableAvsStreet;
|
|
9666
|
+
avsZip?: NullableAvsZip;
|
|
9667
|
+
cardSecurityCodeMatch?: NullableCardSecurityCodeMatch;
|
|
9668
|
+
reconBatchId?: string | null;
|
|
9669
|
+
paymentGroupingCode?: number | null;
|
|
9670
|
+
txnAuthorizationStamp?: number | null;
|
|
9671
|
+
clientTransId?: string | null;
|
|
9672
|
+
};
|
|
9817
9673
|
/**
|
|
9818
9674
|
* Represents a modification to a grouped item line within a Credit Memo.
|
|
9819
9675
|
* Based on CreditMemoLineGroupMod.
|
|
@@ -10391,6 +10247,20 @@ export type UpdateExpenseLineRequest = {
|
|
|
10391
10247
|
billableStatus?: string | null;
|
|
10392
10248
|
salesRepresentativeId?: string | null;
|
|
10393
10249
|
};
|
|
10250
|
+
/**
|
|
10251
|
+
* Represents a single line item modification for an Inventory Adjustment.
|
|
10252
|
+
*/
|
|
10253
|
+
export type UpdateInventoryAdjustmentLineRequest = {
|
|
10254
|
+
id: string;
|
|
10255
|
+
itemId?: string | null;
|
|
10256
|
+
quantityDifference?: number | null;
|
|
10257
|
+
valueDifference?: number | null;
|
|
10258
|
+
serialNumber?: string | null;
|
|
10259
|
+
lotNumber?: string | null;
|
|
10260
|
+
countAdjustment?: number | null;
|
|
10261
|
+
expirationDateForSerialLotNumber?: string | null;
|
|
10262
|
+
inventorySiteLocationId?: string | null;
|
|
10263
|
+
};
|
|
10394
10264
|
/**
|
|
10395
10265
|
* A request model for modifying an existing Inventory Adjustment transaction.
|
|
10396
10266
|
* Corresponds to the InventoryAdjustmentMod QBXML message.
|
|
@@ -10426,7 +10296,7 @@ export type UpdateInventoryAdjustmentRequest = {
|
|
|
10426
10296
|
* (Optional) New general memo about the Inventory Adjustment. (Max 4095 characters)
|
|
10427
10297
|
*/
|
|
10428
10298
|
memo?: string | null;
|
|
10429
|
-
inventoryAdjustmentLines?: Array<
|
|
10299
|
+
inventoryAdjustmentLines?: Array<UpdateInventoryAdjustmentLineRequest> | null;
|
|
10430
10300
|
externalId?: string | null;
|
|
10431
10301
|
};
|
|
10432
10302
|
/**
|
|
@@ -10523,7 +10393,7 @@ export type UpdateInvoiceRequest = {
|
|
|
10523
10393
|
isTaxIncluded?: boolean | null;
|
|
10524
10394
|
salesTaxCodeId?: string | null;
|
|
10525
10395
|
exchangeRate?: number | null;
|
|
10526
|
-
applyCredits?: Array<
|
|
10396
|
+
applyCredits?: Array<CreateSetCreditRequest> | null;
|
|
10527
10397
|
lines?: Array<UpdateItemLineRequest> | null;
|
|
10528
10398
|
lineGroups?: Array<UpdateItemGroupLineRequest> | null;
|
|
10529
10399
|
};
|
|
@@ -10835,7 +10705,7 @@ export type UpdateItemSalesTaxGroupRequest = {
|
|
|
10835
10705
|
};
|
|
10836
10706
|
/**
|
|
10837
10707
|
* Request class for modifying an existing ItemSalesTax (Sales Tax Item) in QuickBooks.
|
|
10838
|
-
* Requires
|
|
10708
|
+
* Requires id and revisionNumber.
|
|
10839
10709
|
*/
|
|
10840
10710
|
export type UpdateItemSalesTaxRequest = {
|
|
10841
10711
|
revisionNumber: string;
|
|
@@ -10987,49 +10857,6 @@ export type UpdatePaymentMethodRequest = {
|
|
|
10987
10857
|
paymentMethodType?: string | null;
|
|
10988
10858
|
revisionNumber: string;
|
|
10989
10859
|
};
|
|
10990
|
-
/**
|
|
10991
|
-
* Request class for modifying an existing PayrollItemNonWage in QuickBooks.
|
|
10992
|
-
* Requires ListId and EditSequence.
|
|
10993
|
-
* NOTE: Direct modification of this item via QBXML is generally unsupported/read-only by the QuickBooks SDK.
|
|
10994
|
-
*/
|
|
10995
|
-
export type UpdatePayrollItemNonWageRequest = {
|
|
10996
|
-
revisionNumber: string;
|
|
10997
|
-
/**
|
|
10998
|
-
* (Optional) The new name for the non-wage payroll item.
|
|
10999
|
-
*/
|
|
11000
|
-
name?: string | null;
|
|
11001
|
-
/**
|
|
11002
|
-
* (Optional) Indicates whether the payroll item is active.
|
|
11003
|
-
*/
|
|
11004
|
-
isActive?: boolean | null;
|
|
11005
|
-
/**
|
|
11006
|
-
* (Optional) The ListID of the Expense Account associated with the payroll item. (Flattened-ID Pattern)
|
|
11007
|
-
*/
|
|
11008
|
-
expenseAccountId?: string | null;
|
|
11009
|
-
/**
|
|
11010
|
-
* (Optional) The ListID of the Liability Account associated with the payroll item. (Flattened-ID Pattern)
|
|
11011
|
-
*/
|
|
11012
|
-
liabilityAccountId?: string | null;
|
|
11013
|
-
};
|
|
11014
|
-
/**
|
|
11015
|
-
* Request class for modifying an existing PayrollItemWage in QuickBooks.
|
|
11016
|
-
* Requires ListId and EditSequence. Note: Some fields like WageType are typically not modifiable.
|
|
11017
|
-
*/
|
|
11018
|
-
export type UpdatePayrollItemWageRequest = {
|
|
11019
|
-
revisionNumber: string;
|
|
11020
|
-
/**
|
|
11021
|
-
* (Optional) The new name for the wage payroll item.
|
|
11022
|
-
*/
|
|
11023
|
-
name?: string | null;
|
|
11024
|
-
/**
|
|
11025
|
-
* (Optional) Indicates whether the payroll item is active.
|
|
11026
|
-
*/
|
|
11027
|
-
isActive?: boolean | null;
|
|
11028
|
-
/**
|
|
11029
|
-
* (Optional) The ListID of the Expense Account associated with the payroll item. (Flattened-ID Pattern)
|
|
11030
|
-
*/
|
|
11031
|
-
expenseAccountId?: string | null;
|
|
11032
|
-
};
|
|
11033
10860
|
/**
|
|
11034
10861
|
* Request model for modifying an existing Price Level in QuickBooks.
|
|
11035
10862
|
* Based on the PriceLevelMod QBXML type.
|
|
@@ -11113,6 +10940,9 @@ export type UpdatePurchaseOrderLineRequest = {
|
|
|
11113
10940
|
* (Optional) The ListID or FullName of the class for this line.
|
|
11114
10941
|
*/
|
|
11115
10942
|
classId?: string | null;
|
|
10943
|
+
/**
|
|
10944
|
+
* (Optional) Total amount for the line. (Cannot be cleared if modifying existing value)
|
|
10945
|
+
*/
|
|
11116
10946
|
amount?: number | null;
|
|
11117
10947
|
/**
|
|
11118
10948
|
* (Optional) The ListID or FullName of the specific inventory site location where items will be received.
|
|
@@ -11277,6 +11107,25 @@ export type UpdateReceivePaymentRequest = {
|
|
|
11277
11107
|
creditCardTxnInfo?: CreditCardTxnInfoRequest;
|
|
11278
11108
|
appliedToTransactions?: Array<AppliedToTransactionRequest> | null;
|
|
11279
11109
|
};
|
|
11110
|
+
export type UpdateSalesAndPurchaseRequest = {
|
|
11111
|
+
salesDescription?: string | null;
|
|
11112
|
+
salesPrice?: number | null;
|
|
11113
|
+
incomeAccountId?: string | null;
|
|
11114
|
+
applyIncomeAccountToExistingTransactions?: boolean | null;
|
|
11115
|
+
purchaseDescription?: string | null;
|
|
11116
|
+
purchaseCost?: number | null;
|
|
11117
|
+
purchaseTaxCodeId?: string | null;
|
|
11118
|
+
expenseAccountId?: string | null;
|
|
11119
|
+
applyExpenseAccountToExistingTransactions?: boolean | null;
|
|
11120
|
+
prefVendorId?: string | null;
|
|
11121
|
+
};
|
|
11122
|
+
export type UpdateSalesOrPurchaseRequest = {
|
|
11123
|
+
description?: string | null;
|
|
11124
|
+
price?: number | null;
|
|
11125
|
+
pricePercent?: number | null;
|
|
11126
|
+
accountId?: string | null;
|
|
11127
|
+
applyAccountToExistingTransactions?: boolean | null;
|
|
11128
|
+
};
|
|
11280
11129
|
/**
|
|
11281
11130
|
* A reusable request DTO for modifying an existing Item Group Line on a Sales Receipt (SalesReceiptLineGroupMod structure).
|
|
11282
11131
|
*/
|
|
@@ -11342,6 +11191,9 @@ export type UpdateSalesReceiptLineRequest = {
|
|
|
11342
11191
|
* (Optional) The ListID or FullName of the inventory site.
|
|
11343
11192
|
*/
|
|
11344
11193
|
inventorySiteId?: string | null;
|
|
11194
|
+
/**
|
|
11195
|
+
* (Optional) The ListID or FullName of the inventory site location.
|
|
11196
|
+
*/
|
|
11345
11197
|
inventorySiteLocationId?: string | null;
|
|
11346
11198
|
/**
|
|
11347
11199
|
* (Optional) Serial number for the item. Mutually exclusive with LotNumber. (Max 4095 characters)
|
|
@@ -11431,7 +11283,7 @@ export type UpdateSalesReceiptRequest = {
|
|
|
11431
11283
|
*/
|
|
11432
11284
|
exchangeRate?: number | null;
|
|
11433
11285
|
otherCustomField?: string | null;
|
|
11434
|
-
creditCardTransaction?:
|
|
11286
|
+
creditCardTransaction?: UpdateCreditCardTransactionInfoRequest;
|
|
11435
11287
|
lines?: Array<UpdateSalesReceiptLineRequest> | null;
|
|
11436
11288
|
lineGroups?: Array<UpdateSalesReceiptLineGroupRequest> | null;
|
|
11437
11289
|
};
|
|
@@ -11493,7 +11345,7 @@ export type UpdateSalesTaxPaymentCheckRequest = {
|
|
|
11493
11345
|
address?: AddressRequest;
|
|
11494
11346
|
};
|
|
11495
11347
|
export type UpdateServiceItemRequest = {
|
|
11496
|
-
|
|
11348
|
+
revisionNumber: string;
|
|
11497
11349
|
name?: string | null;
|
|
11498
11350
|
barCode?: BarCodeRequest;
|
|
11499
11351
|
isActive?: boolean | null;
|
|
@@ -11505,8 +11357,8 @@ export type UpdateServiceItemRequest = {
|
|
|
11505
11357
|
applyAccountToExistingTransactions?: boolean | null;
|
|
11506
11358
|
applyIncomeAccountToExistingTransactions?: boolean | null;
|
|
11507
11359
|
applyExpenseAccountToExistingTransactions?: boolean | null;
|
|
11508
|
-
salesOrPurchaseMod?:
|
|
11509
|
-
salesAndPurchaseMod?:
|
|
11360
|
+
salesOrPurchaseMod?: UpdateSalesOrPurchaseRequest;
|
|
11361
|
+
salesAndPurchaseMod?: UpdateSalesAndPurchaseRequest;
|
|
11510
11362
|
includeRetElement?: Array<string> | null;
|
|
11511
11363
|
};
|
|
11512
11364
|
/**
|
|
@@ -11524,14 +11376,6 @@ export type UpdateShipMethodRequest = {
|
|
|
11524
11376
|
*/
|
|
11525
11377
|
isActive?: boolean | null;
|
|
11526
11378
|
};
|
|
11527
|
-
/**
|
|
11528
|
-
* Placeholder request model for updating SpecialItem.
|
|
11529
|
-
* NOTE: SpecialItem is CREATE-ONLY in QuickBooks - Update operations are NOT supported.
|
|
11530
|
-
* This model exists only for interface compatibility. The validator will reject all requests.
|
|
11531
|
-
*/
|
|
11532
|
-
export type UpdateSpecialItemRequest = {
|
|
11533
|
-
revisionNumber: string;
|
|
11534
|
-
};
|
|
11535
11379
|
/**
|
|
11536
11380
|
* Placeholder request model for updating Terms.
|
|
11537
11381
|
* NOTE: Terms is a READ-ONLY resource in QuickBooks - Update operations are NOT supported.
|
|
@@ -11549,6 +11393,8 @@ export type UpdateTimeTrackingRequest = {
|
|
|
11549
11393
|
transactionDate?: string | null;
|
|
11550
11394
|
/**
|
|
11551
11395
|
* (Required) The ListID or FullName of the Entity (Employee, Vendor, or OtherName) that performed the work.
|
|
11396
|
+
* Note: This field is required even if you don't need to modify it, due to a quirk in the QBD SDK.
|
|
11397
|
+
* You must include the existing EntityId value if you don't want to change it.
|
|
11552
11398
|
*/
|
|
11553
11399
|
entityId: string;
|
|
11554
11400
|
/**
|
|
@@ -11584,14 +11430,6 @@ export type UpdateTimeTrackingRequest = {
|
|
|
11584
11430
|
*/
|
|
11585
11431
|
isBillable?: boolean | null;
|
|
11586
11432
|
};
|
|
11587
|
-
/**
|
|
11588
|
-
* Placeholder request model for updating a UnitOfMeasureSet.
|
|
11589
|
-
* NOTE: UnitOfMeasureSet is CREATE + QUERY ONLY in QuickBooks - Update operations are NOT supported.
|
|
11590
|
-
* This model exists only for interface compatibility. The validator will reject all requests.
|
|
11591
|
-
*/
|
|
11592
|
-
export type UpdateUnitOfMeasureSetRequest = {
|
|
11593
|
-
revisionNumber: string;
|
|
11594
|
-
};
|
|
11595
11433
|
/**
|
|
11596
11434
|
* Represents a request to update an existing Vendor Credit.
|
|
11597
11435
|
* Based on the VendorCreditMod QBXML type.
|
|
@@ -11700,27 +11538,6 @@ export type UpdateVendorRequest = {
|
|
|
11700
11538
|
defaultExpenseAccountIds?: Array<string> | null;
|
|
11701
11539
|
currencyId?: string | null;
|
|
11702
11540
|
};
|
|
11703
|
-
/**
|
|
11704
|
-
* A request model for updating an existing Vendor Type.
|
|
11705
|
-
* Corresponds to the VendorTypeMod QBXML message.
|
|
11706
|
-
* All fields are optional - only provided fields will be updated.
|
|
11707
|
-
*/
|
|
11708
|
-
export type UpdateVendorTypeRequest = {
|
|
11709
|
-
revisionNumber: string;
|
|
11710
|
-
/**
|
|
11711
|
-
* (Optional) The new name of the vendor type. (Max 31 characters)
|
|
11712
|
-
*/
|
|
11713
|
-
name?: string | null;
|
|
11714
|
-
/**
|
|
11715
|
-
* (Optional) If false, this Vendor Type is inactive.
|
|
11716
|
-
*/
|
|
11717
|
-
isActive?: boolean | null;
|
|
11718
|
-
/**
|
|
11719
|
-
* (Optional) The ListID or FullName of the parent vendor type.
|
|
11720
|
-
* Follows the Flattened-ID Pattern for ParentRef.
|
|
11721
|
-
*/
|
|
11722
|
-
parentId?: string | null;
|
|
11723
|
-
};
|
|
11724
11541
|
/**
|
|
11725
11542
|
* Request DTO for modifying an existing Workers' Compensation Code.
|
|
11726
11543
|
* Based on the WorkersCompCodeMod QBXML type.
|
|
@@ -28914,7 +28731,7 @@ export type ListUnitOfMeasureSetsData = {
|
|
|
28914
28731
|
*/
|
|
28915
28732
|
cursor?: string;
|
|
28916
28733
|
/**
|
|
28917
|
-
* The maximum number of items to return
|
|
28734
|
+
* The maximum number of items to return for this request.
|
|
28918
28735
|
*/
|
|
28919
28736
|
limit?: number;
|
|
28920
28737
|
/**
|
|
@@ -30204,15 +30021,335 @@ export type CreateVendorTypeErrors = {
|
|
|
30204
30021
|
*/
|
|
30205
30022
|
502: StandardErrorResponse;
|
|
30206
30023
|
};
|
|
30207
|
-
export type CreateVendorTypeError = CreateVendorTypeErrors[keyof CreateVendorTypeErrors];
|
|
30208
|
-
export type CreateVendorTypeResponses = {
|
|
30024
|
+
export type CreateVendorTypeError = CreateVendorTypeErrors[keyof CreateVendorTypeErrors];
|
|
30025
|
+
export type CreateVendorTypeResponses = {
|
|
30026
|
+
/**
|
|
30027
|
+
* Created
|
|
30028
|
+
*/
|
|
30029
|
+
201: VendorType;
|
|
30030
|
+
};
|
|
30031
|
+
export type CreateVendorTypeResponse = CreateVendorTypeResponses[keyof CreateVendorTypeResponses];
|
|
30032
|
+
export type ListBillPaymentOrCreditsData = {
|
|
30033
|
+
body?: never;
|
|
30034
|
+
headers?: {
|
|
30035
|
+
/**
|
|
30036
|
+
* Identifies which QuickBooks Desktop company file to target.
|
|
30037
|
+
*
|
|
30038
|
+
* Accepts three formats:
|
|
30039
|
+
* - **Prefixed ID**: `conn_01965a3f2e7b7000b4c1d2e3f4a5b6c7`
|
|
30040
|
+
* - **Internal GUID**: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
|
|
30041
|
+
* - **Your external ID**: `acme-corp` (the `externalId` you assigned when creating the connection)
|
|
30042
|
+
*
|
|
30043
|
+
* The middleware resolves any of these formats to the correct connection. Required for all QuickBooks resource operations — without it, the API cannot determine which company file to query.
|
|
30044
|
+
*/
|
|
30045
|
+
"X-Connection-Id"?: string;
|
|
30046
|
+
/**
|
|
30047
|
+
* A unique identifier for tracing a single request through the entire system.
|
|
30048
|
+
* If not provided by the client, a new one will be generated.
|
|
30049
|
+
* This is not persisted and is used only for logging and monitoring.
|
|
30050
|
+
*/
|
|
30051
|
+
"X-Correlation-ID"?: string;
|
|
30052
|
+
/**
|
|
30053
|
+
* Maximum time in seconds to wait for the queued job to be picked up and the response returned from QuickBooks Desktop.
|
|
30054
|
+
*
|
|
30055
|
+
* List and streaming query operations accept **1–90** seconds (default **90**). Raise this when the QuickBooks Web Connector is configured with longer polling intervals or the target company file is slow to respond.
|
|
30056
|
+
*
|
|
30057
|
+
* Passed as a request header — not a query-string value.
|
|
30058
|
+
*/
|
|
30059
|
+
"X-Nxus-Timeout-Seconds"?: number;
|
|
30060
|
+
};
|
|
30061
|
+
path?: never;
|
|
30062
|
+
query?: {
|
|
30063
|
+
/**
|
|
30064
|
+
* The pagination cursor token used to retrieve the next set of records.
|
|
30065
|
+
*
|
|
30066
|
+
* Capture the `nextCursor` from the response JSON and provide it here to continue fetching data.
|
|
30067
|
+
*
|
|
30068
|
+
*
|
|
30069
|
+
* **The 10-Second Rule:** Due to QuickBooks Desktop architectural requirements, you must request
|
|
30070
|
+
* the next page within **10 seconds** of receiving the previous response.
|
|
30071
|
+
*
|
|
30072
|
+
*
|
|
30073
|
+
* **Static Cursors:** Unlike some APIs, the cursor remains constant for the entire duration
|
|
30074
|
+
* of the fetch sequence until `hasMore` is `false`.
|
|
30075
|
+
*/
|
|
30076
|
+
cursor?: string;
|
|
30077
|
+
/**
|
|
30078
|
+
* Filter by one or more unique identifiers (TxnIDs).
|
|
30079
|
+
*
|
|
30080
|
+
* Provide a list of strictly matched TxnIDs. This is the most efficient way to retrieve specific records.
|
|
30081
|
+
*/
|
|
30082
|
+
ids?: Array<string>;
|
|
30083
|
+
/**
|
|
30084
|
+
* The maximum number of items to return per page.
|
|
30085
|
+
*/
|
|
30086
|
+
limit?: number;
|
|
30087
|
+
/**
|
|
30088
|
+
* Filter by one or more reference numbers.
|
|
30089
|
+
*
|
|
30090
|
+
* Returns transactions where the `RefNumber` exactly matches any of the provided values.
|
|
30091
|
+
*/
|
|
30092
|
+
refNumbers?: Array<string>;
|
|
30093
|
+
/**
|
|
30094
|
+
* Filter by reference number (substring match).
|
|
30095
|
+
*
|
|
30096
|
+
* Returns transactions where the `RefNumber` contains this string.
|
|
30097
|
+
* Case-insensitive according to QuickBooks Desktop rules.
|
|
30098
|
+
*/
|
|
30099
|
+
refNumberContains?: string;
|
|
30100
|
+
/**
|
|
30101
|
+
* Filter for records modified on or before this date.
|
|
30102
|
+
*
|
|
30103
|
+
* **Time Defaults:** If a time is not specified, local time **23:59:59** (end of day) is assumed.
|
|
30104
|
+
*
|
|
30105
|
+
*
|
|
30106
|
+
* **Range:** Supports dates from 1970-01-01 to 2038-01-18.
|
|
30107
|
+
*/
|
|
30108
|
+
updatedBefore?: string | null;
|
|
30109
|
+
/**
|
|
30110
|
+
* Filter for records modified on or after this date.
|
|
30111
|
+
*
|
|
30112
|
+
* **Time Defaults:** If a time is not specified, local time **00:00:00** (beginning of day) is assumed.
|
|
30113
|
+
*
|
|
30114
|
+
*
|
|
30115
|
+
* **Range:** Supports dates from 1970-01-01 to 2038-01-18.
|
|
30116
|
+
*/
|
|
30117
|
+
updatedAfter?: string | null;
|
|
30118
|
+
/**
|
|
30119
|
+
* Filter by transaction date (end).
|
|
30120
|
+
*/
|
|
30121
|
+
toTransactionDate?: string | null;
|
|
30122
|
+
/**
|
|
30123
|
+
* Filter by transaction date (start).
|
|
30124
|
+
*/
|
|
30125
|
+
fromTransactionDate?: string | null;
|
|
30126
|
+
/**
|
|
30127
|
+
* Filter by starting reference number (startsWith).
|
|
30128
|
+
*/
|
|
30129
|
+
refNumberStartsWith?: string;
|
|
30130
|
+
/**
|
|
30131
|
+
* Filter by ending reference number (endsWith).
|
|
30132
|
+
*/
|
|
30133
|
+
refNumberEndsWith?: string;
|
|
30134
|
+
/**
|
|
30135
|
+
* Reference number range filter (start).
|
|
30136
|
+
*
|
|
30137
|
+
* Use this to return transactions whose reference number is alphabetically at or after this value.
|
|
30138
|
+
*/
|
|
30139
|
+
refNumberFrom?: string;
|
|
30140
|
+
/**
|
|
30141
|
+
* Reference number range filter (end).
|
|
30142
|
+
*
|
|
30143
|
+
* Use this to return transactions whose reference number is alphabetically at or before this value.
|
|
30144
|
+
* If both `refNumberFrom` and `refNumberTo` are specified, `refNumberTo` must be lexicographically higher.
|
|
30145
|
+
*/
|
|
30146
|
+
refNumberTo?: string;
|
|
30147
|
+
/**
|
|
30148
|
+
* Filter by Account IDs
|
|
30149
|
+
*/
|
|
30150
|
+
accountIds?: Array<string>;
|
|
30151
|
+
/**
|
|
30152
|
+
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
30153
|
+
*/
|
|
30154
|
+
entityIds?: Array<string>;
|
|
30155
|
+
/**
|
|
30156
|
+
* Filter by Item IDs
|
|
30157
|
+
*/
|
|
30158
|
+
itemIds?: Array<string>;
|
|
30159
|
+
/**
|
|
30160
|
+
* Filter by Class IDs
|
|
30161
|
+
*
|
|
30162
|
+
* Provide a list of strictly matched ClassIDs.
|
|
30163
|
+
*/
|
|
30164
|
+
classIds?: Array<string>;
|
|
30165
|
+
/**
|
|
30166
|
+
* Filter by Vendor ID.
|
|
30167
|
+
*/
|
|
30168
|
+
vendorId?: string;
|
|
30169
|
+
/**
|
|
30170
|
+
* Whether to include line items (ExpenseLines, ItemLines, ItemGroupLines) in the response.
|
|
30171
|
+
* Only applies to transaction objects that support line items (Bills, Checks, Invoices, etc.)
|
|
30172
|
+
*/
|
|
30173
|
+
includeLineItems?: boolean | null;
|
|
30174
|
+
/**
|
|
30175
|
+
* Whether to include linked transactions in the response.
|
|
30176
|
+
*/
|
|
30177
|
+
includeLinkedTransactions?: boolean | null;
|
|
30178
|
+
/**
|
|
30179
|
+
* Limit the response to only these top-level fields. Names must match exactly (case-sensitive QbXML element names e.g. ListIDRet, NameRet, AddressRet, PhoneRet ).
|
|
30180
|
+
*
|
|
30181
|
+
* **Note:** The names specified in the list are not parsed, so you must be especially careful to supply valid
|
|
30182
|
+
* names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to
|
|
30183
|
+
* return custom data or private data extensions, you must specify the DataExtRet element and you must supply the OwnerID set
|
|
30184
|
+
* to either a value of 0 (custom data) or the GUID for the private data.
|
|
30185
|
+
*/
|
|
30186
|
+
fields?: Array<string>;
|
|
30187
|
+
/**
|
|
30188
|
+
* (Optional) Filter by a specific Accounts Payable (A/P) Account ListID or FullName.
|
|
30189
|
+
*/
|
|
30190
|
+
APAccountId?: string;
|
|
30191
|
+
/**
|
|
30192
|
+
* (Optional) Filter results by a specific Currency ListID or FullName.
|
|
30193
|
+
* Note: QuickBoooks Desktop must have the "Multi-Currency" feature enabled to use this filter or nXus will return an error.
|
|
30194
|
+
*/
|
|
30195
|
+
CurrencyId?: string;
|
|
30196
|
+
/**
|
|
30197
|
+
* (Optional) Filter for bills coming due by this date.
|
|
30198
|
+
*/
|
|
30199
|
+
DueDate?: string | null;
|
|
30200
|
+
/**
|
|
30201
|
+
* (Required) The ListID or FullName of the Payee (Vendor, Employee, etc.) to find open bills/credits for.
|
|
30202
|
+
*/
|
|
30203
|
+
id?: string;
|
|
30204
|
+
};
|
|
30205
|
+
url: "/api/v1/bill-payment-or-credits";
|
|
30206
|
+
};
|
|
30207
|
+
export type ListBillPaymentOrCreditsErrors = {
|
|
30208
|
+
/**
|
|
30209
|
+
* Bad Request — validation error or malformed input.
|
|
30210
|
+
*/
|
|
30211
|
+
400: StandardErrorResponse;
|
|
30212
|
+
/**
|
|
30213
|
+
* Unauthorized — API key is missing, invalid, or expired.
|
|
30214
|
+
*/
|
|
30215
|
+
401: StandardErrorResponse;
|
|
30216
|
+
/**
|
|
30217
|
+
* Payment Required — an active subscription is required for this operation.
|
|
30218
|
+
*/
|
|
30219
|
+
402: StandardErrorResponse;
|
|
30220
|
+
/**
|
|
30221
|
+
* Forbidden — insufficient permissions or a policy restriction blocks this operation.
|
|
30222
|
+
*/
|
|
30223
|
+
403: StandardErrorResponse;
|
|
30224
|
+
/**
|
|
30225
|
+
* Not Found — the requested resource does not exist.
|
|
30226
|
+
*/
|
|
30227
|
+
404: StandardErrorResponse;
|
|
30228
|
+
/**
|
|
30229
|
+
* Method Not Allowed — this operation is not supported for this resource.
|
|
30230
|
+
*/
|
|
30231
|
+
405: StandardErrorResponse;
|
|
30232
|
+
/**
|
|
30233
|
+
* Request Timeout — the request took too long to process.
|
|
30234
|
+
*/
|
|
30235
|
+
408: StandardErrorResponse;
|
|
30236
|
+
/**
|
|
30237
|
+
* Conflict — the operation conflicts with the current resource or connection state.
|
|
30238
|
+
*/
|
|
30239
|
+
409: StandardErrorResponse;
|
|
30240
|
+
/**
|
|
30241
|
+
* Unprocessable Entity — the request was valid but could not be processed.
|
|
30242
|
+
*/
|
|
30243
|
+
422: StandardErrorResponse;
|
|
30244
|
+
/**
|
|
30245
|
+
* Too Many Requests — rate limit exceeded.
|
|
30246
|
+
*/
|
|
30247
|
+
429: StandardErrorResponse;
|
|
30248
|
+
/**
|
|
30249
|
+
* Internal Server Error — an unexpected error occurred.
|
|
30250
|
+
*/
|
|
30251
|
+
500: StandardErrorResponse;
|
|
30252
|
+
/**
|
|
30253
|
+
* Bad Gateway — QuickBooks Desktop connection or integration error.
|
|
30254
|
+
*/
|
|
30255
|
+
502: StandardErrorResponse;
|
|
30256
|
+
};
|
|
30257
|
+
export type ListBillPaymentOrCreditsError = ListBillPaymentOrCreditsErrors[keyof ListBillPaymentOrCreditsErrors];
|
|
30258
|
+
export type ListBillPaymentOrCreditsResponses = {
|
|
30259
|
+
/**
|
|
30260
|
+
* OK
|
|
30261
|
+
*/
|
|
30262
|
+
200: BasePageResponseBillPaymentOrCredit;
|
|
30263
|
+
};
|
|
30264
|
+
export type ListBillPaymentOrCreditsResponse = ListBillPaymentOrCreditsResponses[keyof ListBillPaymentOrCreditsResponses];
|
|
30265
|
+
export type DeleteBillPaymentOrCreditData = {
|
|
30266
|
+
body?: never;
|
|
30267
|
+
headers?: {
|
|
30268
|
+
/**
|
|
30269
|
+
* Identifies which QuickBooks Desktop company file to target.
|
|
30270
|
+
*
|
|
30271
|
+
* Accepts three formats:
|
|
30272
|
+
* - **Prefixed ID**: `conn_01965a3f2e7b7000b4c1d2e3f4a5b6c7`
|
|
30273
|
+
* - **Internal GUID**: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
|
|
30274
|
+
* - **Your external ID**: `acme-corp` (the `externalId` you assigned when creating the connection)
|
|
30275
|
+
*
|
|
30276
|
+
* The middleware resolves any of these formats to the correct connection. Required for all QuickBooks resource operations — without it, the API cannot determine which company file to query.
|
|
30277
|
+
*/
|
|
30278
|
+
"X-Connection-Id"?: string;
|
|
30279
|
+
/**
|
|
30280
|
+
* Maximum time in seconds to wait for the queued job to be picked up and the response returned from QuickBooks Desktop.
|
|
30281
|
+
*
|
|
30282
|
+
* Create / update / delete and single-entity retrieval operations accept **1–120** seconds (default **120**). Raise this when the QuickBooks Web Connector is configured with longer polling intervals or the target company file is slow to respond.
|
|
30283
|
+
*
|
|
30284
|
+
* Passed as a request header — not a query-string value.
|
|
30285
|
+
*/
|
|
30286
|
+
"X-Nxus-Timeout-Seconds"?: number;
|
|
30287
|
+
};
|
|
30288
|
+
path: {
|
|
30289
|
+
id: string;
|
|
30290
|
+
};
|
|
30291
|
+
query?: never;
|
|
30292
|
+
url: "/api/v1/bill-payment-or-credit/{id}";
|
|
30293
|
+
};
|
|
30294
|
+
export type DeleteBillPaymentOrCreditErrors = {
|
|
30295
|
+
/**
|
|
30296
|
+
* Bad Request — validation error or malformed input.
|
|
30297
|
+
*/
|
|
30298
|
+
400: StandardErrorResponse;
|
|
30299
|
+
/**
|
|
30300
|
+
* Unauthorized — API key is missing, invalid, or expired.
|
|
30301
|
+
*/
|
|
30302
|
+
401: StandardErrorResponse;
|
|
30303
|
+
/**
|
|
30304
|
+
* Payment Required — an active subscription is required for this operation.
|
|
30305
|
+
*/
|
|
30306
|
+
402: StandardErrorResponse;
|
|
30307
|
+
/**
|
|
30308
|
+
* Forbidden — insufficient permissions or a policy restriction blocks this operation.
|
|
30309
|
+
*/
|
|
30310
|
+
403: StandardErrorResponse;
|
|
30311
|
+
/**
|
|
30312
|
+
* Not Found — the requested resource does not exist.
|
|
30313
|
+
*/
|
|
30314
|
+
404: StandardErrorResponse;
|
|
30315
|
+
/**
|
|
30316
|
+
* Method Not Allowed — this operation is not supported for this resource.
|
|
30317
|
+
*/
|
|
30318
|
+
405: StandardErrorResponse;
|
|
30319
|
+
/**
|
|
30320
|
+
* Request Timeout — the request took too long to process.
|
|
30321
|
+
*/
|
|
30322
|
+
408: StandardErrorResponse;
|
|
30323
|
+
/**
|
|
30324
|
+
* Conflict — the operation conflicts with the current resource or connection state.
|
|
30325
|
+
*/
|
|
30326
|
+
409: StandardErrorResponse;
|
|
30327
|
+
/**
|
|
30328
|
+
* Unprocessable Entity — the request was valid but could not be processed.
|
|
30329
|
+
*/
|
|
30330
|
+
422: StandardErrorResponse;
|
|
30331
|
+
/**
|
|
30332
|
+
* Too Many Requests — rate limit exceeded.
|
|
30333
|
+
*/
|
|
30334
|
+
429: StandardErrorResponse;
|
|
30335
|
+
/**
|
|
30336
|
+
* Internal Server Error — an unexpected error occurred.
|
|
30337
|
+
*/
|
|
30338
|
+
500: StandardErrorResponse;
|
|
30339
|
+
/**
|
|
30340
|
+
* Bad Gateway — QuickBooks Desktop connection or integration error.
|
|
30341
|
+
*/
|
|
30342
|
+
502: StandardErrorResponse;
|
|
30343
|
+
};
|
|
30344
|
+
export type DeleteBillPaymentOrCreditError = DeleteBillPaymentOrCreditErrors[keyof DeleteBillPaymentOrCreditErrors];
|
|
30345
|
+
export type DeleteBillPaymentOrCreditResponses = {
|
|
30209
30346
|
/**
|
|
30210
|
-
*
|
|
30347
|
+
* OK
|
|
30211
30348
|
*/
|
|
30212
|
-
|
|
30349
|
+
200: DeleteResponse;
|
|
30213
30350
|
};
|
|
30214
|
-
export type
|
|
30215
|
-
export type
|
|
30351
|
+
export type DeleteBillPaymentOrCreditResponse = DeleteBillPaymentOrCreditResponses[keyof DeleteBillPaymentOrCreditResponses];
|
|
30352
|
+
export type RetrieveBillPaymentOrCreditData = {
|
|
30216
30353
|
body?: never;
|
|
30217
30354
|
headers?: {
|
|
30218
30355
|
/**
|
|
@@ -30226,167 +30363,109 @@ export type ListBillToPayRetsData = {
|
|
|
30226
30363
|
* The middleware resolves any of these formats to the correct connection. Required for all QuickBooks resource operations — without it, the API cannot determine which company file to query.
|
|
30227
30364
|
*/
|
|
30228
30365
|
"X-Connection-Id"?: string;
|
|
30229
|
-
/**
|
|
30230
|
-
* A unique identifier for tracing a single request through the entire system.
|
|
30231
|
-
* If not provided by the client, a new one will be generated.
|
|
30232
|
-
* This is not persisted and is used only for logging and monitoring.
|
|
30233
|
-
*/
|
|
30234
|
-
"X-Correlation-ID"?: string;
|
|
30235
30366
|
/**
|
|
30236
30367
|
* Maximum time in seconds to wait for the queued job to be picked up and the response returned from QuickBooks Desktop.
|
|
30237
30368
|
*
|
|
30238
|
-
*
|
|
30369
|
+
* Create / update / delete and single-entity retrieval operations accept **1–120** seconds (default **120**). Raise this when the QuickBooks Web Connector is configured with longer polling intervals or the target company file is slow to respond.
|
|
30239
30370
|
*
|
|
30240
30371
|
* Passed as a request header — not a query-string value.
|
|
30241
30372
|
*/
|
|
30242
30373
|
"X-Nxus-Timeout-Seconds"?: number;
|
|
30243
30374
|
};
|
|
30244
|
-
path
|
|
30245
|
-
|
|
30246
|
-
|
|
30247
|
-
|
|
30248
|
-
|
|
30249
|
-
|
|
30250
|
-
|
|
30251
|
-
|
|
30252
|
-
|
|
30253
|
-
|
|
30254
|
-
|
|
30255
|
-
|
|
30256
|
-
|
|
30257
|
-
|
|
30258
|
-
|
|
30259
|
-
|
|
30260
|
-
|
|
30261
|
-
|
|
30262
|
-
|
|
30263
|
-
|
|
30264
|
-
|
|
30265
|
-
|
|
30266
|
-
|
|
30267
|
-
|
|
30268
|
-
|
|
30269
|
-
|
|
30270
|
-
|
|
30271
|
-
|
|
30272
|
-
|
|
30273
|
-
|
|
30274
|
-
|
|
30275
|
-
|
|
30276
|
-
|
|
30277
|
-
|
|
30278
|
-
|
|
30279
|
-
|
|
30280
|
-
|
|
30281
|
-
|
|
30282
|
-
|
|
30283
|
-
|
|
30284
|
-
|
|
30285
|
-
|
|
30286
|
-
|
|
30287
|
-
|
|
30288
|
-
|
|
30289
|
-
|
|
30290
|
-
|
|
30291
|
-
|
|
30292
|
-
|
|
30293
|
-
|
|
30294
|
-
|
|
30295
|
-
|
|
30296
|
-
|
|
30297
|
-
|
|
30298
|
-
|
|
30299
|
-
|
|
30300
|
-
|
|
30301
|
-
|
|
30302
|
-
|
|
30303
|
-
|
|
30304
|
-
|
|
30305
|
-
|
|
30306
|
-
|
|
30307
|
-
|
|
30308
|
-
|
|
30309
|
-
|
|
30310
|
-
|
|
30311
|
-
*/
|
|
30312
|
-
refNumberStartsWith?: string;
|
|
30313
|
-
/**
|
|
30314
|
-
* Filter by ending reference number (endsWith).
|
|
30315
|
-
*/
|
|
30316
|
-
refNumberEndsWith?: string;
|
|
30375
|
+
path: {
|
|
30376
|
+
id: string;
|
|
30377
|
+
};
|
|
30378
|
+
query?: never;
|
|
30379
|
+
url: "/api/v1/bill-payment-or-credit/{id}";
|
|
30380
|
+
};
|
|
30381
|
+
export type RetrieveBillPaymentOrCreditErrors = {
|
|
30382
|
+
/**
|
|
30383
|
+
* Bad Request — validation error or malformed input.
|
|
30384
|
+
*/
|
|
30385
|
+
400: StandardErrorResponse;
|
|
30386
|
+
/**
|
|
30387
|
+
* Unauthorized — API key is missing, invalid, or expired.
|
|
30388
|
+
*/
|
|
30389
|
+
401: StandardErrorResponse;
|
|
30390
|
+
/**
|
|
30391
|
+
* Payment Required — an active subscription is required for this operation.
|
|
30392
|
+
*/
|
|
30393
|
+
402: StandardErrorResponse;
|
|
30394
|
+
/**
|
|
30395
|
+
* Forbidden — insufficient permissions or a policy restriction blocks this operation.
|
|
30396
|
+
*/
|
|
30397
|
+
403: StandardErrorResponse;
|
|
30398
|
+
/**
|
|
30399
|
+
* Not Found — the requested resource does not exist.
|
|
30400
|
+
*/
|
|
30401
|
+
404: StandardErrorResponse;
|
|
30402
|
+
/**
|
|
30403
|
+
* Method Not Allowed — this operation is not supported for this resource.
|
|
30404
|
+
*/
|
|
30405
|
+
405: StandardErrorResponse;
|
|
30406
|
+
/**
|
|
30407
|
+
* Request Timeout — the request took too long to process.
|
|
30408
|
+
*/
|
|
30409
|
+
408: StandardErrorResponse;
|
|
30410
|
+
/**
|
|
30411
|
+
* Conflict — the operation conflicts with the current resource or connection state.
|
|
30412
|
+
*/
|
|
30413
|
+
409: StandardErrorResponse;
|
|
30414
|
+
/**
|
|
30415
|
+
* Unprocessable Entity — the request was valid but could not be processed.
|
|
30416
|
+
*/
|
|
30417
|
+
422: StandardErrorResponse;
|
|
30418
|
+
/**
|
|
30419
|
+
* Too Many Requests — rate limit exceeded.
|
|
30420
|
+
*/
|
|
30421
|
+
429: StandardErrorResponse;
|
|
30422
|
+
/**
|
|
30423
|
+
* Internal Server Error — an unexpected error occurred.
|
|
30424
|
+
*/
|
|
30425
|
+
500: StandardErrorResponse;
|
|
30426
|
+
/**
|
|
30427
|
+
* Bad Gateway — QuickBooks Desktop connection or integration error.
|
|
30428
|
+
*/
|
|
30429
|
+
502: StandardErrorResponse;
|
|
30430
|
+
};
|
|
30431
|
+
export type RetrieveBillPaymentOrCreditError = RetrieveBillPaymentOrCreditErrors[keyof RetrieveBillPaymentOrCreditErrors];
|
|
30432
|
+
export type RetrieveBillPaymentOrCreditResponses = {
|
|
30433
|
+
/**
|
|
30434
|
+
* OK
|
|
30435
|
+
*/
|
|
30436
|
+
200: BillPaymentOrCredit;
|
|
30437
|
+
};
|
|
30438
|
+
export type RetrieveBillPaymentOrCreditResponse = RetrieveBillPaymentOrCreditResponses[keyof RetrieveBillPaymentOrCreditResponses];
|
|
30439
|
+
export type UpdateBillPaymentOrCreditData = {
|
|
30440
|
+
body: UpdateBillPaymentOrCreditRequest;
|
|
30441
|
+
headers?: {
|
|
30317
30442
|
/**
|
|
30318
|
-
*
|
|
30443
|
+
* Identifies which QuickBooks Desktop company file to target.
|
|
30319
30444
|
*
|
|
30320
|
-
*
|
|
30321
|
-
|
|
30322
|
-
|
|
30323
|
-
|
|
30324
|
-
* Reference number range filter (end).
|
|
30445
|
+
* Accepts three formats:
|
|
30446
|
+
* - **Prefixed ID**: `conn_01965a3f2e7b7000b4c1d2e3f4a5b6c7`
|
|
30447
|
+
* - **Internal GUID**: `3fa85f64-5717-4562-b3fc-2c963f66afa6`
|
|
30448
|
+
* - **Your external ID**: `acme-corp` (the `externalId` you assigned when creating the connection)
|
|
30325
30449
|
*
|
|
30326
|
-
*
|
|
30327
|
-
* If both `refNumberFrom` and `refNumberTo` are specified, `refNumberTo` must be lexicographically higher.
|
|
30328
|
-
*/
|
|
30329
|
-
refNumberTo?: string;
|
|
30330
|
-
/**
|
|
30331
|
-
* Filter by Account IDs
|
|
30332
|
-
*/
|
|
30333
|
-
accountIds?: Array<string>;
|
|
30334
|
-
/**
|
|
30335
|
-
* Filter by Entity IDs (Customers, Vendors, Employees)
|
|
30336
|
-
*/
|
|
30337
|
-
entityIds?: Array<string>;
|
|
30338
|
-
/**
|
|
30339
|
-
* Filter by Item IDs
|
|
30450
|
+
* The middleware resolves any of these formats to the correct connection. Required for all QuickBooks resource operations — without it, the API cannot determine which company file to query.
|
|
30340
30451
|
*/
|
|
30341
|
-
|
|
30452
|
+
"X-Connection-Id"?: string;
|
|
30342
30453
|
/**
|
|
30343
|
-
*
|
|
30454
|
+
* Maximum time in seconds to wait for the queued job to be picked up and the response returned from QuickBooks Desktop.
|
|
30344
30455
|
*
|
|
30345
|
-
*
|
|
30346
|
-
*/
|
|
30347
|
-
classIds?: Array<string>;
|
|
30348
|
-
/**
|
|
30349
|
-
* Filter by Vendor ID.
|
|
30350
|
-
*/
|
|
30351
|
-
vendorId?: string;
|
|
30352
|
-
/**
|
|
30353
|
-
* Whether to include line items (ExpenseLines, ItemLines, ItemGroupLines) in the response.
|
|
30354
|
-
* Only applies to transaction objects that support line items (Bills, Checks, Invoices, etc.)
|
|
30355
|
-
*/
|
|
30356
|
-
includeLineItems?: boolean | null;
|
|
30357
|
-
/**
|
|
30358
|
-
* Whether to include linked transactions in the response.
|
|
30359
|
-
*/
|
|
30360
|
-
includeLinkedTransactions?: boolean | null;
|
|
30361
|
-
/**
|
|
30362
|
-
* Limit the response to only these top-level fields. Names must match exactly (case-sensitive QbXML element names e.g. ListIDRet, NameRet, AddressRet, PhoneRet ).
|
|
30456
|
+
* Create / update / delete and single-entity retrieval operations accept **1–120** seconds (default **120**). Raise this when the QuickBooks Web Connector is configured with longer polling intervals or the target company file is slow to respond.
|
|
30363
30457
|
*
|
|
30364
|
-
*
|
|
30365
|
-
* names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to
|
|
30366
|
-
* return custom data or private data extensions, you must specify the DataExtRet element and you must supply the OwnerID set
|
|
30367
|
-
* to either a value of 0 (custom data) or the GUID for the private data.
|
|
30368
|
-
*/
|
|
30369
|
-
fields?: Array<string>;
|
|
30370
|
-
/**
|
|
30371
|
-
* (Optional) Filter by a specific Accounts Payable (A/P) Account ListID or FullName.
|
|
30372
|
-
*/
|
|
30373
|
-
APAccountId?: string;
|
|
30374
|
-
/**
|
|
30375
|
-
* (Optional) Filter results by a specific Currency ListID or FullName.
|
|
30376
|
-
*/
|
|
30377
|
-
CurrencyId?: string;
|
|
30378
|
-
/**
|
|
30379
|
-
* (Optional) Filter for bills coming due by this date.
|
|
30380
|
-
*/
|
|
30381
|
-
DueDate?: string | null;
|
|
30382
|
-
/**
|
|
30383
|
-
* (Required) The ListID or FullName of the Payee (Vendor, Employee, etc.) to find open bills/credits for.
|
|
30458
|
+
* Passed as a request header — not a query-string value.
|
|
30384
30459
|
*/
|
|
30385
|
-
|
|
30460
|
+
"X-Nxus-Timeout-Seconds"?: number;
|
|
30386
30461
|
};
|
|
30387
|
-
|
|
30462
|
+
path: {
|
|
30463
|
+
id: string;
|
|
30464
|
+
};
|
|
30465
|
+
query?: never;
|
|
30466
|
+
url: "/api/v1/bill-payment-or-credit/{id}";
|
|
30388
30467
|
};
|
|
30389
|
-
export type
|
|
30468
|
+
export type UpdateBillPaymentOrCreditErrors = {
|
|
30390
30469
|
/**
|
|
30391
30470
|
* Bad Request — validation error or malformed input.
|
|
30392
30471
|
*/
|
|
@@ -30436,16 +30515,16 @@ export type ListBillToPayRetsErrors = {
|
|
|
30436
30515
|
*/
|
|
30437
30516
|
502: StandardErrorResponse;
|
|
30438
30517
|
};
|
|
30439
|
-
export type
|
|
30440
|
-
export type
|
|
30518
|
+
export type UpdateBillPaymentOrCreditError = UpdateBillPaymentOrCreditErrors[keyof UpdateBillPaymentOrCreditErrors];
|
|
30519
|
+
export type UpdateBillPaymentOrCreditResponses = {
|
|
30441
30520
|
/**
|
|
30442
30521
|
* OK
|
|
30443
30522
|
*/
|
|
30444
|
-
200:
|
|
30523
|
+
200: BillPaymentOrCredit;
|
|
30445
30524
|
};
|
|
30446
|
-
export type
|
|
30447
|
-
export type
|
|
30448
|
-
body
|
|
30525
|
+
export type UpdateBillPaymentOrCreditResponse = UpdateBillPaymentOrCreditResponses[keyof UpdateBillPaymentOrCreditResponses];
|
|
30526
|
+
export type CreateBillPaymentOrCreditData = {
|
|
30527
|
+
body: CreateBillPaymentOrCreditRequest;
|
|
30449
30528
|
headers?: {
|
|
30450
30529
|
/**
|
|
30451
30530
|
* Identifies which QuickBooks Desktop company file to target.
|
|
@@ -30467,13 +30546,11 @@ export type RetrieveBillToPayRetData = {
|
|
|
30467
30546
|
*/
|
|
30468
30547
|
"X-Nxus-Timeout-Seconds"?: number;
|
|
30469
30548
|
};
|
|
30470
|
-
path
|
|
30471
|
-
id: string;
|
|
30472
|
-
};
|
|
30549
|
+
path?: never;
|
|
30473
30550
|
query?: never;
|
|
30474
|
-
url: "/api/v1/bill-
|
|
30551
|
+
url: "/api/v1/bill-payment-or-credit";
|
|
30475
30552
|
};
|
|
30476
|
-
export type
|
|
30553
|
+
export type CreateBillPaymentOrCreditErrors = {
|
|
30477
30554
|
/**
|
|
30478
30555
|
* Bad Request — validation error or malformed input.
|
|
30479
30556
|
*/
|
|
@@ -30523,14 +30600,14 @@ export type RetrieveBillToPayRetErrors = {
|
|
|
30523
30600
|
*/
|
|
30524
30601
|
502: StandardErrorResponse;
|
|
30525
30602
|
};
|
|
30526
|
-
export type
|
|
30527
|
-
export type
|
|
30603
|
+
export type CreateBillPaymentOrCreditError = CreateBillPaymentOrCreditErrors[keyof CreateBillPaymentOrCreditErrors];
|
|
30604
|
+
export type CreateBillPaymentOrCreditResponses = {
|
|
30528
30605
|
/**
|
|
30529
|
-
*
|
|
30606
|
+
* Created
|
|
30530
30607
|
*/
|
|
30531
|
-
|
|
30608
|
+
201: BillPaymentOrCredit;
|
|
30532
30609
|
};
|
|
30533
|
-
export type
|
|
30610
|
+
export type CreateBillPaymentOrCreditResponse = CreateBillPaymentOrCreditResponses[keyof CreateBillPaymentOrCreditResponses];
|
|
30534
30611
|
export type ListBuildAssemblysData = {
|
|
30535
30612
|
body?: never;
|
|
30536
30613
|
headers?: {
|
|
@@ -44845,6 +44922,70 @@ export type CreateItemSubtotalResponses = {
|
|
|
44845
44922
|
201: ItemSubtotal;
|
|
44846
44923
|
};
|
|
44847
44924
|
export type CreateItemSubtotalResponse = CreateItemSubtotalResponses[keyof CreateItemSubtotalResponses];
|
|
44925
|
+
export type CloseData = {
|
|
44926
|
+
body?: never;
|
|
44927
|
+
path?: never;
|
|
44928
|
+
query?: never;
|
|
44929
|
+
url: "/api/v1/cursors/{operationId}/close";
|
|
44930
|
+
};
|
|
44931
|
+
export type CloseErrors = {
|
|
44932
|
+
/**
|
|
44933
|
+
* Bad Request — validation error or malformed input.
|
|
44934
|
+
*/
|
|
44935
|
+
400: StandardErrorResponse;
|
|
44936
|
+
/**
|
|
44937
|
+
* Unauthorized — API key is missing, invalid, or expired.
|
|
44938
|
+
*/
|
|
44939
|
+
401: StandardErrorResponse;
|
|
44940
|
+
/**
|
|
44941
|
+
* Payment Required — an active subscription is required for this operation.
|
|
44942
|
+
*/
|
|
44943
|
+
402: StandardErrorResponse;
|
|
44944
|
+
/**
|
|
44945
|
+
* Forbidden — insufficient permissions or a policy restriction blocks this operation.
|
|
44946
|
+
*/
|
|
44947
|
+
403: StandardErrorResponse;
|
|
44948
|
+
/**
|
|
44949
|
+
* Not Found — the requested resource does not exist.
|
|
44950
|
+
*/
|
|
44951
|
+
404: StandardErrorResponse;
|
|
44952
|
+
/**
|
|
44953
|
+
* Method Not Allowed — this operation is not supported for this resource.
|
|
44954
|
+
*/
|
|
44955
|
+
405: StandardErrorResponse;
|
|
44956
|
+
/**
|
|
44957
|
+
* Request Timeout — the request took too long to process.
|
|
44958
|
+
*/
|
|
44959
|
+
408: StandardErrorResponse;
|
|
44960
|
+
/**
|
|
44961
|
+
* Conflict — the operation conflicts with the current resource or connection state.
|
|
44962
|
+
*/
|
|
44963
|
+
409: StandardErrorResponse;
|
|
44964
|
+
/**
|
|
44965
|
+
* Unprocessable Entity — the request was valid but could not be processed.
|
|
44966
|
+
*/
|
|
44967
|
+
422: StandardErrorResponse;
|
|
44968
|
+
/**
|
|
44969
|
+
* Too Many Requests — rate limit exceeded.
|
|
44970
|
+
*/
|
|
44971
|
+
429: StandardErrorResponse;
|
|
44972
|
+
/**
|
|
44973
|
+
* Internal Server Error — an unexpected error occurred.
|
|
44974
|
+
*/
|
|
44975
|
+
500: StandardErrorResponse;
|
|
44976
|
+
/**
|
|
44977
|
+
* Bad Gateway — QuickBooks Desktop connection or integration error.
|
|
44978
|
+
*/
|
|
44979
|
+
502: StandardErrorResponse;
|
|
44980
|
+
};
|
|
44981
|
+
export type CloseError = CloseErrors[keyof CloseErrors];
|
|
44982
|
+
export type CloseResponses = {
|
|
44983
|
+
/**
|
|
44984
|
+
* No Content
|
|
44985
|
+
*/
|
|
44986
|
+
204: void;
|
|
44987
|
+
};
|
|
44988
|
+
export type CloseResponse = CloseResponses[keyof CloseResponses];
|
|
44848
44989
|
export type CreateAuthSessionData = {
|
|
44849
44990
|
body: CreateAuthSessionRequest;
|
|
44850
44991
|
path?: never;
|