conductor-node 3.2.1 → 3.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{BaseClient.d.ts → src/BaseClient.d.ts} +1 -1
- package/dist/{BaseClient.js → src/BaseClient.js} +0 -0
- package/dist/{Client.d.ts → src/Client.d.ts} +2 -2
- package/dist/{Client.js → src/Client.js} +2 -2
- package/dist/{__tests__ → src/__tests__}/Client.test.d.ts +0 -0
- package/dist/{__tests__ → src/__tests__}/Client.test.js +1 -1
- package/dist/{environment.d.ts → src/environment.d.ts} +0 -0
- package/dist/{environment.js → src/environment.js} +0 -0
- package/dist/{qbd → src/qbd}/ClientQbd.d.ts +257 -2
- package/dist/{qbd → src/qbd}/ClientQbd.js +256 -1
- package/dist/{qbd → src/qbd}/__tests__/ClientQbd.test.d.ts +0 -0
- package/dist/{qbd → src/qbd}/__tests__/ClientQbd.test.js +1 -1
- package/dist/{qbd → src/qbd}/qbdTypes.d.ts +715 -41
- package/dist/{qbd → src/qbd}/qbdTypes.js +0 -0
- package/package.json +4 -4
|
@@ -48,7 +48,9 @@ export interface AccountAddRs {
|
|
|
48
48
|
ErrorRecovery?: ErrorRecovery;
|
|
49
49
|
}
|
|
50
50
|
interface AccountFilter {
|
|
51
|
-
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
51
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
52
|
+
|
|
53
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
52
54
|
ListID?: string[] | string;
|
|
53
55
|
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
54
56
|
FullName?: string[] | string;
|
|
@@ -285,6 +287,62 @@ interface AddressBlock {
|
|
|
285
287
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
286
288
|
Addr5?: string;
|
|
287
289
|
}
|
|
290
|
+
interface APAccountRef {
|
|
291
|
+
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
292
|
+
ListID?: string;
|
|
293
|
+
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
294
|
+
FullName?: string;
|
|
295
|
+
}
|
|
296
|
+
interface AppliedToTxnAdd {
|
|
297
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
298
|
+
TxnID: string;
|
|
299
|
+
/** Represents the amount assigned to a particular receivable. The sum of all `PaymentAmount` elements in any given receive payment transaction must not be greater than `TotalAmount`. */
|
|
300
|
+
PaymentAmount?: string;
|
|
301
|
+
/** A list of credits to set. Setting, or applying, a credit means using an available credit to lower the balance of a transaction such as an invoice or a bill. (Creating a credit, on the other hand, means making a credit available to be applied in the future.) Notice that if you use a credit (`SetCredit`) only, in your `ReceivePaymentAdd` or `BillPaymentCreditCardAdd` request, then no transaction ID is created, because, from the viewpoint of QuickBooks, there was no transaction. Setting a credit merely creates links between existing transactions (for example, between a credit memo transaction and an invoice transaction), and no information about these links will be returned to you in the response. If you need to retrieve which transactions were linked in the `SetCredit`, for Bill Payment, you must do a `BillQuery` and specify `IncludeLinkedTxns`. */
|
|
302
|
+
SetCredit?: SetCredit | SetCredit[];
|
|
303
|
+
/** Reduces the receivable amount. */
|
|
304
|
+
DiscountAmount?: string;
|
|
305
|
+
/** Refers to the account where this discount is tracked. In a request, if a `DiscountAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
306
|
+
DiscountAccountRef?: DiscountAccountRef;
|
|
307
|
+
/** Class reference used in the Discount object */
|
|
308
|
+
DiscountClassRef?: DiscountClassRef;
|
|
309
|
+
}
|
|
310
|
+
interface AppliedToTxnMod {
|
|
311
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
312
|
+
TxnID: string;
|
|
313
|
+
/** Represents the amount assigned to a particular receivable. The sum of all `PaymentAmount` elements in any given receive payment transaction must not be greater than `TotalAmount`. */
|
|
314
|
+
PaymentAmount?: string;
|
|
315
|
+
/** A list of credits to set. Setting, or applying, a credit means using an available credit to lower the balance of a transaction such as an invoice or a bill. (Creating a credit, on the other hand, means making a credit available to be applied in the future.) Notice that if you use a credit (`SetCredit`) only, in your `ReceivePaymentAdd` or `BillPaymentCreditCardAdd` request, then no transaction ID is created, because, from the viewpoint of QuickBooks, there was no transaction. Setting a credit merely creates links between existing transactions (for example, between a credit memo transaction and an invoice transaction), and no information about these links will be returned to you in the response. If you need to retrieve which transactions were linked in the `SetCredit`, for Bill Payment, you must do a `BillQuery` and specify `IncludeLinkedTxns`. */
|
|
316
|
+
SetCredit?: SetCredit | SetCredit[];
|
|
317
|
+
/** Reduces the receivable amount. */
|
|
318
|
+
DiscountAmount?: string;
|
|
319
|
+
/** Refers to the account where this discount is tracked. In a request, if a `DiscountAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
320
|
+
DiscountAccountRef?: DiscountAccountRef;
|
|
321
|
+
/** Class reference used in the Discount object */
|
|
322
|
+
DiscountClassRef?: DiscountClassRef;
|
|
323
|
+
}
|
|
324
|
+
interface AppliedToTxnRet {
|
|
325
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
326
|
+
TxnID: string;
|
|
327
|
+
/** The type of transaction. */
|
|
328
|
+
TxnType: TxnType;
|
|
329
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
330
|
+
TxnDate?: string;
|
|
331
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
332
|
+
RefNumber?: string;
|
|
333
|
+
/** The outstanding balance on this invoice. `BalanceRemaining` = (Subtotal + `SalesTaxTotal`) – `AppliedAmount`. */
|
|
334
|
+
BalanceRemaining?: string;
|
|
335
|
+
/** A monetary amount. */
|
|
336
|
+
Amount?: string;
|
|
337
|
+
/** Reduces the receivable amount. */
|
|
338
|
+
DiscountAmount?: string;
|
|
339
|
+
/** Refers to the account where this discount is tracked. In a request, if a `DiscountAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
340
|
+
DiscountAccountRef?: DiscountAccountRef;
|
|
341
|
+
/** Class reference used in the Discount object */
|
|
342
|
+
DiscountClassRef?: DiscountClassRef;
|
|
343
|
+
/** If the `IncludeLinkedTxns` flag is set to true in a query, or if you create an item receipt that links to other transactionsthen the returned object will include a list of linked transactions, if any exist. If no linked transactions exist, the `ILinkedTxnList` object will be empty. The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items. */
|
|
344
|
+
LinkedTxn?: LinkedTxn | LinkedTxn[];
|
|
345
|
+
}
|
|
288
346
|
interface ApplyCheckToTxnAdd {
|
|
289
347
|
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
290
348
|
TxnID: string;
|
|
@@ -297,6 +355,12 @@ interface ApplyCheckToTxnMod {
|
|
|
297
355
|
/** A monetary amount. */
|
|
298
356
|
Amount?: string;
|
|
299
357
|
}
|
|
358
|
+
interface BankAccountRef {
|
|
359
|
+
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
360
|
+
ListID?: string;
|
|
361
|
+
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
362
|
+
FullName?: string;
|
|
363
|
+
}
|
|
300
364
|
interface BarCode {
|
|
301
365
|
/** Value of the barcode in the item. */
|
|
302
366
|
BarCodeValue?: string;
|
|
@@ -306,6 +370,50 @@ interface BarCode {
|
|
|
306
370
|
AllowOverride?: boolean;
|
|
307
371
|
}
|
|
308
372
|
declare type BillableStatus = "Billable" | "HasBeenBilled" | "NotBillable";
|
|
373
|
+
interface BillAdd {
|
|
374
|
+
/** A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company’s vendor list contains information such as account balance and contact information about each vendor. A `VendorRef` aggregate refers to one of the vendors on the list. In a request, if a `VendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
375
|
+
VendorRef: VendorRef;
|
|
376
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
377
|
+
VendorAddress?: VendorAddress;
|
|
378
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.)
|
|
379
|
+
|
|
380
|
+
If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
381
|
+
APAccountRef?: APAccountRef;
|
|
382
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
383
|
+
TxnDate?: string;
|
|
384
|
+
/** The date on which payment is due. */
|
|
385
|
+
DueDate?: string;
|
|
386
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
387
|
+
|
|
388
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
389
|
+
RefNumber?: string;
|
|
390
|
+
/** Refers to the payment terms associated with this entity. (This will be an item on the `DateDrivenTerms` or `StandardTerms` list.) If a `TermsRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
391
|
+
TermsRef?: TermsRef;
|
|
392
|
+
/** Appears in the A/P register and in reports that include this bill. */
|
|
393
|
+
Memo?: string;
|
|
394
|
+
/** For future use with international versions of QuickBooks. */
|
|
395
|
+
IsTaxIncluded?: boolean;
|
|
396
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
397
|
+
|
|
398
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
399
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
400
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
401
|
+
|
|
402
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
403
|
+
ExchangeRate?: number;
|
|
404
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
405
|
+
ExternalGUID?: string;
|
|
406
|
+
/** The `LinkToTxnID` aggregate allows to link an entire transaction. If you want to link individual lines in a transaction, use the `LinkToTxn` aggregate.
|
|
407
|
+
|
|
408
|
+
You can use both `LinkToTxnID` and `LinkToTxn` aggregates in the same request, as long as these aggregates do NOT link to the same `TxnID`. If both aggregates are used and do link to the same `TxnID`, you receive an error 3000. Also, if you attempt to invoke `LinkToTxnID` with the same `TxnID`, more than once, you get an error 3177. If the transaction specified by `LinkToTxnID` is already closed or fully received and the `ItemReceiptAdd` request does not contain any other lines, you get error 3180 for attempting to save an empty transaction. You get a warning if you attempt to link to a transaction that’s already closed. */
|
|
409
|
+
LinkToTxnID?: string[] | string;
|
|
410
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
411
|
+
ExpenseLineAdd?: ExpenseLineAdd | ExpenseLineAdd[];
|
|
412
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
413
|
+
ItemLineAdd?: ItemLineAdd;
|
|
414
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
415
|
+
ItemGroupLineAdd?: ItemGroupLineAdd;
|
|
416
|
+
}
|
|
309
417
|
interface BillAddress {
|
|
310
418
|
/** The first line of an address. */
|
|
311
419
|
Addr1?: string;
|
|
@@ -340,12 +448,364 @@ interface BillAddressBlock {
|
|
|
340
448
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
341
449
|
Addr5?: string;
|
|
342
450
|
}
|
|
451
|
+
export interface BillAddRq {
|
|
452
|
+
BillAdd: BillAdd;
|
|
453
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
454
|
+
|
|
455
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
456
|
+
IncludeRetElement?: string[] | string;
|
|
457
|
+
}
|
|
458
|
+
export interface BillAddRs {
|
|
459
|
+
BillRet?: BillRet;
|
|
460
|
+
ErrorRecovery?: ErrorRecovery;
|
|
461
|
+
}
|
|
343
462
|
interface BillingRateRef {
|
|
344
463
|
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
345
464
|
ListID?: string;
|
|
346
465
|
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
347
466
|
FullName?: string;
|
|
348
467
|
}
|
|
468
|
+
interface BillMod {
|
|
469
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
470
|
+
|
|
471
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
472
|
+
TxnID: string;
|
|
473
|
+
/** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
|
|
474
|
+
EditSequence: string;
|
|
475
|
+
/** A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company’s vendor list contains information such as account balance and contact information about each vendor. A `VendorRef` aggregate refers to one of the vendors on the list. In a request, if a `VendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
476
|
+
VendorRef?: VendorRef;
|
|
477
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
478
|
+
VendorAddress?: VendorAddress;
|
|
479
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.)
|
|
480
|
+
|
|
481
|
+
If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
482
|
+
APAccountRef?: APAccountRef;
|
|
483
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
484
|
+
TxnDate?: string;
|
|
485
|
+
/** The date on which payment is due. */
|
|
486
|
+
DueDate?: string;
|
|
487
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
488
|
+
|
|
489
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
490
|
+
|
|
491
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
492
|
+
RefNumber?: string;
|
|
493
|
+
/** Refers to the payment terms associated with this entity. (This will be an item on the `DateDrivenTerms` or `StandardTerms` list.) If a `TermsRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
494
|
+
TermsRef?: TermsRef;
|
|
495
|
+
/** Appears in the A/P register and in reports that include this bill. */
|
|
496
|
+
Memo?: string;
|
|
497
|
+
/** For future use with international versions of QuickBooks. */
|
|
498
|
+
IsTaxIncluded?: boolean;
|
|
499
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
500
|
+
|
|
501
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
502
|
+
|
|
503
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
504
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
505
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
506
|
+
|
|
507
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
508
|
+
ExchangeRate?: number;
|
|
509
|
+
/** Set `ClearExpenseLines` to true to clear all the expense lines. To modify individual lines, use `ExpenseLineMod`. */
|
|
510
|
+
ClearExpenseLines?: boolean;
|
|
511
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
512
|
+
ExpenseLineMod?: ExpenseLineMod | ExpenseLineMod[];
|
|
513
|
+
/** Set `ClearItemLines` to true to clear all the item lines. To modify individual lines, use `ItemLineMod`. */
|
|
514
|
+
ClearItemLines?: boolean;
|
|
515
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
516
|
+
ItemLineMod?: ItemLineMod;
|
|
517
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
518
|
+
ItemGroupLineMod?: ItemGroupLineMod;
|
|
519
|
+
}
|
|
520
|
+
export interface BillModRq {
|
|
521
|
+
BillMod: BillMod;
|
|
522
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
523
|
+
|
|
524
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
525
|
+
|
|
526
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
527
|
+
IncludeRetElement?: string[] | string;
|
|
528
|
+
}
|
|
529
|
+
export interface BillModRs {
|
|
530
|
+
BillRet?: BillRet;
|
|
531
|
+
ErrorRecovery?: ErrorRecovery;
|
|
532
|
+
}
|
|
533
|
+
interface BillPaymentCheckAdd {
|
|
534
|
+
/** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written. In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
|
|
535
|
+
PayeeEntityRef: PayeeEntityRef;
|
|
536
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.) If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
537
|
+
APAccountRef?: APAccountRef;
|
|
538
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
539
|
+
TxnDate?: string;
|
|
540
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
541
|
+
BankAccountRef: BankAccountRef;
|
|
542
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
543
|
+
IsToBePrinted?: boolean;
|
|
544
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
545
|
+
RefNumber?: string;
|
|
546
|
+
/** Additional information. */
|
|
547
|
+
Memo?: string;
|
|
548
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
549
|
+
ExchangeRate?: number;
|
|
550
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
551
|
+
ExternalGUID?: string;
|
|
552
|
+
/** `AppliedToTxn` List A list of `AppliedToTxn` aggregates. */
|
|
553
|
+
AppliedToTxnAdd: AppliedToTxnAdd | AppliedToTxnAdd[];
|
|
554
|
+
}
|
|
555
|
+
export interface BillPaymentCheckAddRq {
|
|
556
|
+
BillPaymentCheckAdd: BillPaymentCheckAdd;
|
|
557
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
558
|
+
IncludeRetElement?: string[] | string;
|
|
559
|
+
}
|
|
560
|
+
export interface BillPaymentCheckAddRs {
|
|
561
|
+
BillPaymentCheckRet?: BillPaymentCheckRet;
|
|
562
|
+
ErrorRecovery?: ErrorRecovery;
|
|
563
|
+
}
|
|
564
|
+
interface BillPaymentCheckMod {
|
|
565
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
566
|
+
TxnID: string;
|
|
567
|
+
/** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
|
|
568
|
+
EditSequence: string;
|
|
569
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
570
|
+
TxnDate?: string;
|
|
571
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
572
|
+
BankAccountRef?: BankAccountRef;
|
|
573
|
+
/** A monetary amount. */
|
|
574
|
+
Amount?: string;
|
|
575
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
576
|
+
ExchangeRate?: number;
|
|
577
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
578
|
+
IsToBePrinted?: boolean;
|
|
579
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
580
|
+
RefNumber?: string;
|
|
581
|
+
/** Additional information. */
|
|
582
|
+
Memo?: string;
|
|
583
|
+
/** `AppliedToTxn` List A list of `AppliedToTxn` aggregates. */
|
|
584
|
+
AppliedToTxnMod?: AppliedToTxnMod | AppliedToTxnMod[];
|
|
585
|
+
}
|
|
586
|
+
export interface BillPaymentCheckModRq {
|
|
587
|
+
BillPaymentCheckMod: BillPaymentCheckMod;
|
|
588
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
589
|
+
IncludeRetElement?: string[] | string;
|
|
590
|
+
}
|
|
591
|
+
export interface BillPaymentCheckModRs {
|
|
592
|
+
BillPaymentCheckRet?: BillPaymentCheckRet;
|
|
593
|
+
ErrorRecovery?: ErrorRecovery;
|
|
594
|
+
}
|
|
595
|
+
export interface BillPaymentCheckQueryRq {
|
|
596
|
+
/** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQuery` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
597
|
+
TxnID?: string[] | string;
|
|
598
|
+
/** A list of one or more `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request, the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
599
|
+
RefNumber?: string[] | string;
|
|
600
|
+
/** A list of one or more case sensitive `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. You should use this case sensitive ref number list rather than the older `RefNumber` list, because it provides much better performance in certain circumstances. The older `refNumber` list provided slow performance if the `refNumber` values contained letters, not just digits. This `RefNumberCaseSensitive` list, new in SDK 4.0, eliminates this performance hit. */
|
|
601
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
602
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
603
|
+
MaxReturned?: number;
|
|
604
|
+
/** Filters according to the dates when transactions were last modified. The `ModifiedDateRangeFilter` aggregate is not required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `FromModifiedDate` and `ToModifiedDate` fields was not supported in qbXML version 1.0 or 1.1. (To filter according to the dates when transactions were deleted, use a `TxnDeletedQuery` message.) */
|
|
605
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
606
|
+
/** Filters according to the original transaction dates. */
|
|
607
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
608
|
+
/** An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an `EntityQuery` request to get information about all the entities that are set up in the QuickBooks file. In an `ARRefundCreditCard` query, this must be a customer/customer job. */
|
|
609
|
+
EntityFilter?: EntityFilter;
|
|
610
|
+
/** Filters according to the account name or `ListID`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `FullName` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise. For example, if you queried for an account named 2050, and 2050 happened to be the account number of a totally different account, the query would not return what you asked for (the account named 2050), but instead would return the account with the account number 2050. This problem will not happen if the “Use account numbers” preference is turned off in the QuickBooks file, orthe account name exactly matches the account number. (In this case, query would return the correct account either way.) To avoid this problem: Do not name an account using a number unless the number exactly matches the account’s account number. If an account name must contain a number that does not match its own account number, have the QuickBooks user change the account’s name slightly, for example `to` 2050a. */
|
|
611
|
+
AccountFilter?: AccountFilter;
|
|
612
|
+
/** Filters according to `RefNumber`. */
|
|
613
|
+
RefNumberFilter?: RefNumberFilter;
|
|
614
|
+
/** Filters according to `RefNumber`. The filtering code will do a numerical comparison (if `FromRefNumber` and `ToRefNumber` only contain digits) or a lexicographical comparison (if either `FromRefNumber` or `ToRefNumber` contain any nondigit characters). In the first situation, if you need to query for a `RefNumber` that is larger than the maximum long integer value of 2147483647, one workaround is to specify a `FromRefNumber` that is less than or equal to 2147483647 without specifying a `ToRefNumber`. */
|
|
615
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
616
|
+
/** Filters by the specified currency. */
|
|
617
|
+
CurrencyFilter?: CurrencyFilter;
|
|
618
|
+
/** This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `IncludeLineItems` to true to include line items in the response if you don’t mind getting a larger result. */
|
|
619
|
+
IncludeLineItems?: boolean;
|
|
620
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
621
|
+
IncludeRetElement?: string[] | string;
|
|
622
|
+
/** Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data extension:If `OwnerID` is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If `OwnerID` is a GUID, for example `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that `OwnerID` values are not case-sensitive, meaning that if you enter an `OwnerID` value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
|
|
623
|
+
OwnerID?: string[] | string;
|
|
624
|
+
}
|
|
625
|
+
export interface BillPaymentCheckQueryRs {
|
|
626
|
+
BillPaymentCheckRet?: BillPaymentCheckRet | BillPaymentCheckRet[];
|
|
627
|
+
}
|
|
628
|
+
interface BillPaymentCheckRet {
|
|
629
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
630
|
+
TxnID?: string;
|
|
631
|
+
/** Time the object was created. */
|
|
632
|
+
TimeCreated?: string;
|
|
633
|
+
/** Time the object was last modified. */
|
|
634
|
+
TimeModified?: string;
|
|
635
|
+
/** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
|
|
636
|
+
EditSequence?: string;
|
|
637
|
+
/** An identifying number for this transaction. */
|
|
638
|
+
TxnNumber?: number;
|
|
639
|
+
/** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written. In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
|
|
640
|
+
PayeeEntityRef?: PayeeEntityRef;
|
|
641
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.) If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
642
|
+
APAccountRef?: APAccountRef;
|
|
643
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
644
|
+
TxnDate?: string;
|
|
645
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
646
|
+
BankAccountRef?: BankAccountRef;
|
|
647
|
+
/** A monetary amount. */
|
|
648
|
+
Amount?: string;
|
|
649
|
+
/** The currency object contains all of the information needed by QuickBooks to display and use. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the `IsActive` status. For user-defined currencies, every value in the object is editable including name and currency code. When used with `PriceLevels`, the `CurrencyRef` should only be used with “per item” price levels. */
|
|
650
|
+
CurrencyRef?: CurrencyRef;
|
|
651
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
652
|
+
ExchangeRate?: number;
|
|
653
|
+
/** Amount in units of the home currency. */
|
|
654
|
+
AmountInHomeCurrency?: string;
|
|
655
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
656
|
+
RefNumber?: string;
|
|
657
|
+
/** Additional information. */
|
|
658
|
+
Memo?: string;
|
|
659
|
+
/** If an address request fails, some combination of address fields might be too long. In a Check, `BillPaymentCheck`, or `SalesTaxPaymentCheck` message, `Address` is the address that will print on the check. */
|
|
660
|
+
Address?: Address;
|
|
661
|
+
/** The address expressed as an address block of `Addr1` through `Addr5`, depending on the number of lines in the original request that created the address. */
|
|
662
|
+
AddressBlock?: AddressBlock;
|
|
663
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
664
|
+
IsToBePrinted?: boolean;
|
|
665
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
666
|
+
ExternalGUID?: string;
|
|
667
|
+
/** `AppliedToTxn` List A list of `AppliedToTxn` aggregates. */
|
|
668
|
+
AppliedToTxnRet?: AppliedToTxnRet | AppliedToTxnRet[];
|
|
669
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
670
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
671
|
+
}
|
|
672
|
+
export interface BillQueryRq {
|
|
673
|
+
/** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks.
|
|
674
|
+
|
|
675
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQuery` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
676
|
+
TxnID?: string[] | string;
|
|
677
|
+
/** A list of one or more `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
678
|
+
|
|
679
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request, the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
680
|
+
RefNumber?: string[] | string;
|
|
681
|
+
/** A list of one or more case sensitive `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
682
|
+
|
|
683
|
+
You should use this case sensitive ref number list rather than the older `RefNumber` list, because it provides much better performance in certain circumstances. The older `refNumber` list provided slow performance if the `refNumber` values contained letters, not just digits. This `RefNumberCaseSensitive` list, new in SDK 4.0, eliminates this performance hit. */
|
|
684
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
685
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
686
|
+
MaxReturned?: number;
|
|
687
|
+
/** Filters according to the dates when transactions were last modified. The `ModifiedDateRangeFilter` aggregate is not required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `FromModifiedDate` and `ToModifiedDate` fields was not supported in qbXML version 1.0 or 1.1.
|
|
688
|
+
|
|
689
|
+
(To filter according to the dates when transactions were deleted, use a `TxnDeletedQuery` message.) */
|
|
690
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
691
|
+
/** Filters according to the original transaction dates. */
|
|
692
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
693
|
+
/** An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an `EntityQuery` request to get information about all the entities that are set up in the QuickBooks file.
|
|
694
|
+
|
|
695
|
+
In an `ARRefundCreditCard` query, this must be a customer/customer job. */
|
|
696
|
+
EntityFilter?: EntityFilter;
|
|
697
|
+
/** Filters according to the account name or `ListID`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `FullName` and get the account you’re looking for.
|
|
698
|
+
|
|
699
|
+
But if numbers have been used as account names, confusion could arise. For example, if you queried for an account named 2050, and 2050 happened to be the account number of a totally different account, the query would not return what you asked for (the account named 2050), but instead would return the account with the account number 2050.
|
|
700
|
+
|
|
701
|
+
This problem will not happen if the “Use account numbers” preference is turned off in the QuickBooks file, or the account name exactly matches the account number. (In this case, query would return the correct account either way.)
|
|
702
|
+
|
|
703
|
+
To avoid this problem:
|
|
704
|
+
|
|
705
|
+
Do not name an account using a number unless the number exactly matches the account’s account number. If an account name must contain a number that does not match its own account number, have the QuickBooks user change the account’s name slightly, for example `to` 2050a. */
|
|
706
|
+
AccountFilter?: AccountFilter;
|
|
707
|
+
/** Filters according to `RefNumber`. */
|
|
708
|
+
RefNumberFilter?: RefNumberFilter;
|
|
709
|
+
/** Filters according to `RefNumber`. The filtering code will do a numerical comparison (if `FromRefNumber` and `ToRefNumber` only contain digits) or a lexicographical comparison (if either `FromRefNumber` or `ToRefNumber` contain any nondigit characters). In the first situation, if you need to query for a `RefNumber` that is larger than the maximum long integer value of 2147483647, one workaround is to specify a `FromRefNumber` that is less than or equal to 2147483647 without specifying a `ToRefNumber`. */
|
|
710
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
711
|
+
/** Filters by the specified currency. */
|
|
712
|
+
CurrencyFilter?: CurrencyFilter;
|
|
713
|
+
/** Allows you to filter for transactions according to whether or not they are paid. */
|
|
714
|
+
PaidStatus?: PaidStatus;
|
|
715
|
+
/** This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `IncludeLineItems` to true to include line items in the response if you don’t mind getting a larger result. */
|
|
716
|
+
IncludeLineItems?: boolean;
|
|
717
|
+
/** If you set `IncludeLinkedTxns` to true, then the returned object will include a list of all the transactions linked to the queried object. (This list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items.) Each linked transaction will be represented by a `LinkedTxn` aggregate. If no linked transactions exist, no `LinkedTxn` aggregates will be returned. */
|
|
718
|
+
IncludeLinkedTxns?: boolean;
|
|
719
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
720
|
+
|
|
721
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
722
|
+
|
|
723
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
724
|
+
IncludeRetElement?: string[] | string;
|
|
725
|
+
/** Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data extension: If `OwnerID` is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI. If `OwnerID` is a GUID, for example `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI.
|
|
726
|
+
|
|
727
|
+
Note that `OwnerID` values are not case-sensitive, meaning that if you enter an `OwnerID` value with lower-case letters, the value will be saved and returned with upper-case letters.
|
|
728
|
+
|
|
729
|
+
When you share a private data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
|
|
730
|
+
OwnerID?: string[] | string;
|
|
731
|
+
}
|
|
732
|
+
export interface BillQueryRs {
|
|
733
|
+
BillRet?: BillRet | BillRet[];
|
|
734
|
+
}
|
|
735
|
+
interface BillRet {
|
|
736
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
737
|
+
|
|
738
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
739
|
+
TxnID: string;
|
|
740
|
+
/** Time the object was created. */
|
|
741
|
+
TimeCreated: string;
|
|
742
|
+
/** Time the object was last modified. */
|
|
743
|
+
TimeModified: string;
|
|
744
|
+
/** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
|
|
745
|
+
EditSequence: string;
|
|
746
|
+
/** An identifying number for this transaction. */
|
|
747
|
+
TxnNumber?: number;
|
|
748
|
+
/** A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company’s vendor list contains information such as account balance and contact information about each vendor. A `VendorRef` aggregate refers to one of the vendors on the list. In a request, if a `VendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
749
|
+
VendorRef: VendorRef;
|
|
750
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
751
|
+
VendorAddress?: VendorAddress;
|
|
752
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.)
|
|
753
|
+
|
|
754
|
+
If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
755
|
+
APAccountRef?: APAccountRef;
|
|
756
|
+
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
757
|
+
TxnDate: string;
|
|
758
|
+
/** The date on which payment is due. */
|
|
759
|
+
DueDate?: string;
|
|
760
|
+
/** The total monetary amount shown on a bill or packing slip received from a vendor. `AmountDue` will be the total of the amounts in the expense lines, item lines, and item group lines. `AmountDue` minus any credits or discounts equals the `OpenAmount`. */
|
|
761
|
+
AmountDue: string;
|
|
762
|
+
/** The currency object contains all of the information needed by QuickBooks to display and use. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the `IsActive` status. For user-defined currencies, every value in the object is editable including name and currency code.
|
|
763
|
+
|
|
764
|
+
When used with `PriceLevels`, the `CurrencyRef` should only be used with “per item” price levels. */
|
|
765
|
+
CurrencyRef?: CurrencyRef;
|
|
766
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
767
|
+
|
|
768
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
769
|
+
ExchangeRate?: number;
|
|
770
|
+
/** Amount due in units of the home currency. */
|
|
771
|
+
AmountDueInHomeCurrency?: string;
|
|
772
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
773
|
+
|
|
774
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
775
|
+
|
|
776
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
777
|
+
RefNumber?: string;
|
|
778
|
+
/** Refers to the payment terms associated with this entity. (This will be an item on the `DateDrivenTerms` or `StandardTerms` list.) If a `TermsRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
779
|
+
TermsRef?: TermsRef;
|
|
780
|
+
/** Appears in the A/P register and in reports that include this bill. */
|
|
781
|
+
Memo?: string;
|
|
782
|
+
/** For future use with international versions of QuickBooks. */
|
|
783
|
+
IsTaxIncluded?: boolean;
|
|
784
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
785
|
+
|
|
786
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
787
|
+
|
|
788
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
789
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
790
|
+
/** If `IsPaid` is true, this transaction has been paid. */
|
|
791
|
+
IsPaid?: boolean;
|
|
792
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
793
|
+
ExternalGUID?: string;
|
|
794
|
+
/** If the `IncludeLinkedTxns` flag is set to true in a query, or if you create an item receipt that links to other transactionsthen the returned object will include a list of linked transactions, if any exist. If no linked transactions exist, the `ILinkedTxnList` object will be empty.
|
|
795
|
+
|
|
796
|
+
The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items. */
|
|
797
|
+
LinkedTxn?: LinkedTxn | LinkedTxn[];
|
|
798
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
799
|
+
ExpenseLineRet?: ExpenseLineRet | ExpenseLineRet[];
|
|
800
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
801
|
+
ItemLineRet?: ItemLineRet;
|
|
802
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
803
|
+
ItemGroupLineRet?: ItemGroupLineRet;
|
|
804
|
+
/** Indicates the amount that is still owed. `AmountDue` minus any credits or discounts equals the `OpenAmount`. */
|
|
805
|
+
OpenAmount?: string;
|
|
806
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
807
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
808
|
+
}
|
|
349
809
|
declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
|
|
350
810
|
interface CheckAdd {
|
|
351
811
|
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)Special cases to note:In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings.In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied.In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed. How do you increase and decrease amounts in bank accounts?The following requests increase the balance in a bank account:Deposit Add `ReceivePaymentAdd` Journal Entry Add Sales `ReceiptAdd` The following requests decrease the balance in a bank account:`CheckAdd` Bill `PaymentCheckAdd` `JournalEntryAdd` */
|
|
@@ -1075,7 +1535,11 @@ interface CustomerTypeRef {
|
|
|
1075
1535
|
FullName?: string;
|
|
1076
1536
|
}
|
|
1077
1537
|
interface DataExt {
|
|
1078
|
-
/** `OwnerID` refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an `OwnerID` of 0. )
|
|
1538
|
+
/** `OwnerID` refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an `OwnerID` of 0. )
|
|
1539
|
+
|
|
1540
|
+
Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.)
|
|
1541
|
+
|
|
1542
|
+
When you share a data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
|
|
1079
1543
|
OwnerID: string;
|
|
1080
1544
|
/** The name of the data extension. If this is a custom field, `DataExtName` will be visible as a label in the QuickBooks user interface. Also because `OwnerID` and `DataExtName` together make the data extension unique, and because custom fields all have the same `OwnerID` of zero, the `DataExtName` must be a unique value among existing custom fields. In contrast, the `DataExtName` for private data extensions must be unique only for the specified `OwnerID` GUID. */
|
|
1081
1545
|
DataExtName: string;
|
|
@@ -1099,6 +1563,18 @@ interface DataExtRet {
|
|
|
1099
1563
|
declare type DataExtType = "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
|
|
1100
1564
|
declare type DateMacro = "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
|
|
1101
1565
|
declare type Disabled = "No" | "Yes";
|
|
1566
|
+
interface DiscountAccountRef {
|
|
1567
|
+
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
1568
|
+
ListID?: string;
|
|
1569
|
+
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
1570
|
+
FullName?: string;
|
|
1571
|
+
}
|
|
1572
|
+
interface DiscountClassRef {
|
|
1573
|
+
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
1574
|
+
ListID?: string;
|
|
1575
|
+
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
1576
|
+
FullName?: string;
|
|
1577
|
+
}
|
|
1102
1578
|
interface Earnings {
|
|
1103
1579
|
/** Each payroll wage item describes and names a payment scheme, for example, Regular Pay or Overtime Pay. A `PayrollItemWageRef` aggregate refers to one of these wage items. In a request, if a `PayrollItemWageRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Within QuickBooks, a timesheet can specify a payroll wage item only if the following criteria are met: The name on the timesheet (which corresponds to the `EntityRef` in the `TimeTracking` object) is on the QuickBooks Employee list, and The “Use time data to create paychecks” preference is turned on in the QuickBooks Payroll Info window that provides detailed employee information employee. */
|
|
1104
1580
|
PayrollItemWageRef: PayrollItemWageRef;
|
|
@@ -1499,7 +1975,9 @@ interface EmployeeRet {
|
|
|
1499
1975
|
/** @default: Regular */
|
|
1500
1976
|
declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
|
|
1501
1977
|
interface EntityFilter {
|
|
1502
|
-
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
1978
|
+
/** One or more `ListID` values. Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`.
|
|
1979
|
+
|
|
1980
|
+
A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
1503
1981
|
ListID?: string[] | string;
|
|
1504
1982
|
/** A list of one or more `FullName` values. `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
1505
1983
|
FullName?: string[] | string;
|
|
@@ -1545,17 +2023,43 @@ interface ExpenseAccountRef {
|
|
|
1545
2023
|
FullName?: string;
|
|
1546
2024
|
}
|
|
1547
2025
|
interface ExpenseLineAdd {
|
|
1548
|
-
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2026
|
+
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2027
|
+
|
|
2028
|
+
Special cases to note:
|
|
2029
|
+
|
|
2030
|
+
In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied. In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed.
|
|
2031
|
+
|
|
2032
|
+
How do you increase and decrease amounts in bank accounts?
|
|
2033
|
+
|
|
2034
|
+
The following requests increase the balance in a bank account:
|
|
2035
|
+
|
|
2036
|
+
Deposit Add
|
|
2037
|
+
|
|
2038
|
+
`ReceivePaymentAdd`
|
|
2039
|
+
|
|
2040
|
+
Journal Entry Add
|
|
2041
|
+
|
|
2042
|
+
Sales `ReceiptAdd` The following requests decrease the balance in a bank account:
|
|
2043
|
+
|
|
2044
|
+
`CheckAdd`
|
|
2045
|
+
|
|
2046
|
+
Bill `PaymentCheckAdd`
|
|
2047
|
+
|
|
2048
|
+
`JournalEntryAdd` */
|
|
1549
2049
|
AccountRef?: AccountRef;
|
|
1550
2050
|
/** A monetary amount. */
|
|
1551
2051
|
Amount?: string;
|
|
1552
2052
|
/** Additional information about this expense line. */
|
|
1553
2053
|
Memo?: string;
|
|
1554
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2054
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1555
2055
|
CustomerRef?: CustomerRef;
|
|
1556
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2056
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2057
|
+
|
|
2058
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1557
2059
|
ClassRef?: ClassRef;
|
|
1558
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2060
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2061
|
+
|
|
2062
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1559
2063
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1560
2064
|
/** The billing status of this item line or expense line. */
|
|
1561
2065
|
BillableStatus?: BillableStatus;
|
|
@@ -1565,19 +2069,51 @@ interface ExpenseLineAdd {
|
|
|
1565
2069
|
DataExt?: DataExt | DataExt[];
|
|
1566
2070
|
}
|
|
1567
2071
|
interface ExpenseLineMod {
|
|
1568
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2072
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2073
|
+
|
|
2074
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1569
2075
|
TxnLineID: string;
|
|
1570
|
-
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2076
|
+
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2077
|
+
|
|
2078
|
+
Special cases to note: In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied. In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed.
|
|
2079
|
+
|
|
2080
|
+
How do you increase and decrease amounts in bank accounts?
|
|
2081
|
+
|
|
2082
|
+
The following requests increase the balance in a bank account:
|
|
2083
|
+
|
|
2084
|
+
Deposit Add
|
|
2085
|
+
|
|
2086
|
+
`ReceivePaymentAdd`
|
|
2087
|
+
|
|
2088
|
+
Journal Entry Add
|
|
2089
|
+
|
|
2090
|
+
Sales `ReceiptAdd`
|
|
2091
|
+
|
|
2092
|
+
The following requests decrease the balance in a bank account:
|
|
2093
|
+
|
|
2094
|
+
`CheckAdd`
|
|
2095
|
+
|
|
2096
|
+
Bill `PaymentCheckAdd`
|
|
2097
|
+
|
|
2098
|
+
`JournalEntryAdd` */
|
|
1571
2099
|
AccountRef?: AccountRef;
|
|
1572
2100
|
/** A monetary amount. */
|
|
1573
2101
|
Amount?: string;
|
|
1574
2102
|
/** Additional information about this expense line. */
|
|
1575
2103
|
Memo?: string;
|
|
1576
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2104
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1577
2105
|
CustomerRef?: CustomerRef;
|
|
1578
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2106
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2107
|
+
|
|
2108
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
2109
|
+
|
|
2110
|
+
In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1579
2111
|
ClassRef?: ClassRef;
|
|
1580
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2112
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2113
|
+
|
|
2114
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
2115
|
+
|
|
2116
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1581
2117
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1582
2118
|
/** The billing status of this item line or expense line. */
|
|
1583
2119
|
BillableStatus?: BillableStatus;
|
|
@@ -1585,19 +2121,51 @@ interface ExpenseLineMod {
|
|
|
1585
2121
|
SalesRepRef?: SalesRepRef;
|
|
1586
2122
|
}
|
|
1587
2123
|
interface ExpenseLineRet {
|
|
1588
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2124
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2125
|
+
|
|
2126
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1589
2127
|
TxnLineID: string;
|
|
1590
|
-
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2128
|
+
/** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.)
|
|
2129
|
+
|
|
2130
|
+
Special cases to note:
|
|
2131
|
+
|
|
2132
|
+
In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied. In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed.
|
|
2133
|
+
|
|
2134
|
+
How do you increase and decrease amounts in bank accounts?
|
|
2135
|
+
|
|
2136
|
+
The following requests increase the balance in a bank account:
|
|
2137
|
+
|
|
2138
|
+
Deposit Add
|
|
2139
|
+
|
|
2140
|
+
`ReceivePaymentAdd`
|
|
2141
|
+
|
|
2142
|
+
Journal Entry Add
|
|
2143
|
+
|
|
2144
|
+
Sales `ReceiptAdd` The following requests decrease the balance in a bank account:
|
|
2145
|
+
|
|
2146
|
+
`CheckAdd`
|
|
2147
|
+
|
|
2148
|
+
Bill `PaymentCheckAdd`
|
|
2149
|
+
|
|
2150
|
+
`JournalEntryAdd` */
|
|
1591
2151
|
AccountRef?: AccountRef;
|
|
1592
2152
|
/** A monetary amount. */
|
|
1593
2153
|
Amount?: string;
|
|
1594
2154
|
/** Additional information about this expense line. */
|
|
1595
2155
|
Memo?: string;
|
|
1596
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2156
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1597
2157
|
CustomerRef?: CustomerRef;
|
|
1598
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2158
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2159
|
+
|
|
2160
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
2161
|
+
|
|
2162
|
+
In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1599
2163
|
ClassRef?: ClassRef;
|
|
1600
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2164
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2165
|
+
|
|
2166
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
2167
|
+
|
|
2168
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1601
2169
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1602
2170
|
/** The billing status of this item line or expense line. */
|
|
1603
2171
|
BillableStatus?: BillableStatus;
|
|
@@ -1640,7 +2208,9 @@ interface ItemGroupLineAdd {
|
|
|
1640
2208
|
DataExt?: DataExt | DataExt[];
|
|
1641
2209
|
}
|
|
1642
2210
|
interface ItemGroupLineMod {
|
|
1643
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2211
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2212
|
+
|
|
2213
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1644
2214
|
TxnLineID: string;
|
|
1645
2215
|
/** `ItemGroup` objects represent items that are grouped together for fast entry, and an `ItemGroupRef` aggregate refers to one of these item groups. In a request, if an `ItemGroupRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. You can use an `ItemGroupQuery` request to get information about all the item groups that are set up in the QuickBooks file. */
|
|
1646
2216
|
ItemGroupRef?: ItemGroupRef;
|
|
@@ -1654,7 +2224,9 @@ interface ItemGroupLineMod {
|
|
|
1654
2224
|
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
1655
2225
|
}
|
|
1656
2226
|
interface ItemGroupLineRet {
|
|
1657
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2227
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2228
|
+
|
|
2229
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1658
2230
|
TxnLineID: string;
|
|
1659
2231
|
/** `ItemGroup` objects represent items that are grouped together for fast entry, and an `ItemGroupRef` aggregate refers to one of these item groups. In a request, if an `ItemGroupRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. You can use an `ItemGroupQuery` request to get information about all the item groups that are set up in the QuickBooks file. */
|
|
1660
2232
|
ItemGroupRef: ItemGroupRef;
|
|
@@ -1680,7 +2252,13 @@ interface ItemGroupRef {
|
|
|
1680
2252
|
FullName?: string;
|
|
1681
2253
|
}
|
|
1682
2254
|
interface ItemLineAdd {
|
|
1683
|
-
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2255
|
+
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2256
|
+
|
|
2257
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
2258
|
+
|
|
2259
|
+
For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
2260
|
+
|
|
2261
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
1684
2262
|
ItemRef?: ItemRef;
|
|
1685
2263
|
/** Site where inventory is located. */
|
|
1686
2264
|
InventorySiteRef?: InventorySiteRef;
|
|
@@ -1700,25 +2278,41 @@ interface ItemLineAdd {
|
|
|
1700
2278
|
Cost?: string;
|
|
1701
2279
|
/** A monetary amount. */
|
|
1702
2280
|
Amount?: string;
|
|
1703
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2281
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1704
2282
|
CustomerRef?: CustomerRef;
|
|
1705
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2283
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2284
|
+
|
|
2285
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1706
2286
|
ClassRef?: ClassRef;
|
|
1707
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2287
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2288
|
+
|
|
2289
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1708
2290
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1709
2291
|
/** The billing status of this item line or expense line. */
|
|
1710
2292
|
BillableStatus?: BillableStatus;
|
|
1711
2293
|
/** Refers to a QuickBooks account. If you are using QB Online edition, you cannot specify an accounts receivable account here. If an `OverrideItemAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
1712
2294
|
OverrideItemAccountRef?: OverrideItemAccountRef;
|
|
2295
|
+
/** When used with `InvoiceAdd`, the transaction you are linking to via this field must be a `SalesOrder`; links to other transactions, such as to estimates, are not currently supported.
|
|
2296
|
+
|
|
2297
|
+
When used with `BillAdd` or `ItemReceiptAdd`, the transaction you are linking to via this field must be a `PurchaseOrder`: links to other transactions are not currently supported. The `LinkToTxn` aggregate allows you to bring in a specific line item from a transaction. If you want to link an entire transaction and bring in all its lines, use the `LinkToTxnID` aggregate. Notice that if you use `LinkToTxn` in the item line, you cannot use `ItemRef` in that line: you’ll get a runtime error. `LinkToTxn` brings in all the item information you need. (You can, however, specify whatever quantity or rate that you want, or any other item line element other than `ItemRef`. You can use both `LinkToTxnID` and `LinkToTxn` in the same request, as long as these do NOT link to the same `TxnID`. You get an error if the transaction specified by `LinkToTxnID` is already closed or fully received and the request does not contain any other lines. You get error if you attempt to save an empty transaction. You get a warning if you attempt to link to a transaction that’s already closed. For a complete set of rules and instructions on transaction linking, see the chapter on transaction linking in the QB SDK Programmer’s Guide (PDF, 9.6 MB). */
|
|
2298
|
+
LinkToTxn?: LinkToTxn;
|
|
1713
2299
|
/** A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `SalesRepRef` refers to a person on the `SalesRep` list. In a request, if a `SalesRepRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
1714
2300
|
SalesRepRef?: SalesRepRef;
|
|
1715
2301
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1716
2302
|
DataExt?: DataExt | DataExt[];
|
|
1717
2303
|
}
|
|
1718
2304
|
interface ItemLineMod {
|
|
1719
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2305
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2306
|
+
|
|
2307
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1720
2308
|
TxnLineID: string;
|
|
1721
|
-
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2309
|
+
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2310
|
+
|
|
2311
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
2312
|
+
|
|
2313
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items.
|
|
2314
|
+
|
|
2315
|
+
Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
1722
2316
|
ItemRef?: ItemRef;
|
|
1723
2317
|
/** Site where inventory is located. */
|
|
1724
2318
|
InventorySiteRef?: InventorySiteRef;
|
|
@@ -1740,11 +2334,19 @@ interface ItemLineMod {
|
|
|
1740
2334
|
Cost?: string;
|
|
1741
2335
|
/** A monetary amount. */
|
|
1742
2336
|
Amount?: string;
|
|
1743
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2337
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1744
2338
|
CustomerRef?: CustomerRef;
|
|
1745
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2339
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2340
|
+
|
|
2341
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
2342
|
+
|
|
2343
|
+
In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1746
2344
|
ClassRef?: ClassRef;
|
|
1747
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2345
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2346
|
+
|
|
2347
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
2348
|
+
|
|
2349
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1748
2350
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1749
2351
|
/** The billing status of this item line or expense line. */
|
|
1750
2352
|
BillableStatus?: BillableStatus;
|
|
@@ -1754,9 +2356,17 @@ interface ItemLineMod {
|
|
|
1754
2356
|
SalesRepRef?: SalesRepRef;
|
|
1755
2357
|
}
|
|
1756
2358
|
interface ItemLineRet {
|
|
1757
|
-
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2359
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2360
|
+
|
|
2361
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1758
2362
|
TxnLineID: string;
|
|
1759
|
-
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2363
|
+
/** Depending on the request containing it, `ItemRef` can refer to an item on any Item list such as `ItemDiscount`, `ItemInventory`, and so forth, or it may accept only a subset of item types.
|
|
2364
|
+
|
|
2365
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
2366
|
+
|
|
2367
|
+
For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
2368
|
+
|
|
2369
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
1760
2370
|
ItemRef?: ItemRef;
|
|
1761
2371
|
/** Site where inventory is located. */
|
|
1762
2372
|
InventorySiteRef?: InventorySiteRef;
|
|
@@ -1778,11 +2388,19 @@ interface ItemLineRet {
|
|
|
1778
2388
|
Cost?: string;
|
|
1779
2389
|
/** A monetary amount. */
|
|
1780
2390
|
Amount?: string;
|
|
1781
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note:In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited.In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
2391
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
1782
2392
|
CustomerRef?: CustomerRef;
|
|
1783
|
-
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2393
|
+
/** Classes can be used to separate transactions into meaningful categories. (For example, transactions could be classified according to department, business location, or type of work.) In QuickBooks, class tracking is off by default.
|
|
2394
|
+
|
|
2395
|
+
A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
2396
|
+
|
|
2397
|
+
In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
|
|
1784
2398
|
ClassRef?: ClassRef;
|
|
1785
|
-
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2399
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
2400
|
+
|
|
2401
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
2402
|
+
|
|
2403
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
1786
2404
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
1787
2405
|
/** The billing status of this item line or expense line. */
|
|
1788
2406
|
BillableStatus?: BillableStatus;
|
|
@@ -2138,26 +2756,54 @@ interface JournalLineMod {
|
|
|
2138
2756
|
declare type JournalLineType = "Credit" | "Debit";
|
|
2139
2757
|
declare type KeyEmployee = "No" | "Yes";
|
|
2140
2758
|
interface LinkedTxn {
|
|
2141
|
-
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
2759
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
2760
|
+
|
|
2761
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
2142
2762
|
TxnID: string;
|
|
2143
2763
|
/** The type of transaction. */
|
|
2144
2764
|
TxnType: TxnType;
|
|
2145
2765
|
/** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
|
|
2146
2766
|
TxnDate: string;
|
|
2147
|
-
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
2767
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
2768
|
+
|
|
2769
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
2770
|
+
|
|
2771
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
2148
2772
|
RefNumber?: string;
|
|
2149
|
-
/** Indicates the nature of the link between the transactions
|
|
2773
|
+
/** Indicates the nature of the link between the transactions: `ltAMTTYPE` means the two transactions are linked based on an amount value (for example `an` invoice linked to a payment). `ltQUANTYPE` means the two transactions are linked based on a quantity. This affects transactions that are linked to sales orders, estimates and purchase orders. For example, an invoice might be created from a sales order, based on the quantity of items received. */
|
|
2150
2774
|
LinkType?: LinkType;
|
|
2151
2775
|
/** A monetary amount. */
|
|
2152
2776
|
Amount: string;
|
|
2153
2777
|
}
|
|
2778
|
+
interface LinkToTxn {
|
|
2779
|
+
/** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests.
|
|
2780
|
+
|
|
2781
|
+
Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
2782
|
+
TxnID: string;
|
|
2783
|
+
/** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.)
|
|
2784
|
+
|
|
2785
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
2786
|
+
TxnLineID: string;
|
|
2787
|
+
}
|
|
2154
2788
|
declare type LinkType = "AMTTYPE" | "QUANTYPE";
|
|
2155
2789
|
declare type MatchCriterion = "Contains" | "EndsWith" | "StartsWith";
|
|
2156
2790
|
declare type MilitaryStatus = "Active" | "Reserve";
|
|
2157
2791
|
interface ModifiedDateRangeFilter {
|
|
2158
|
-
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.
|
|
2792
|
+
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.
|
|
2793
|
+
|
|
2794
|
+
For desktop versions of QuickBooks, the `FromModifiedDate` and `ToModifiedDate` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (The time portion of the field was not supported in qbXML version 1.0 or 1.1.) Also, for desktop versions of QuickBooks, if `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST).
|
|
2795
|
+
|
|
2796
|
+
For QBOE, the `FromModifiedDate` and `ToModifiedDate` must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1900-01-01T00:00:00.
|
|
2797
|
+
|
|
2798
|
+
Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
|
|
2159
2799
|
FromModifiedDate?: string;
|
|
2160
|
-
/** Selects objects modified on or before this date. See the note below on QBFC usage.
|
|
2800
|
+
/** Selects objects modified on or before this date. See the note below on QBFC usage.
|
|
2801
|
+
|
|
2802
|
+
For desktop versions of QuickBooks, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
2803
|
+
|
|
2804
|
+
For QBOE, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1900 and 9999-12-31T00:00:00. If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 9999-12-31T00:00:00.
|
|
2805
|
+
|
|
2806
|
+
Note: When specifying this in QBFC, you need to supply the parameter `asDateOnly`, which is a Boolean. If `asDateOnly` is true, the date value will be represented as a date only (without a time). If `asDateOnly` is false, the date value will be represented as date and time, padded with zeros if necessary, and set to the beginning of the day if no time is provided. The `asDateOnly` parameter is especially useful in the `ToModifiedDate` field of a query: If `asDateOnly` is set to true in the `ToModifiedDate` field of a query, then the query includes elements modified up to the end of the day. If `asDateOnly` is false, the query includes elements modified up to the specified time (or up to the beginning of the day if no time is included). */
|
|
2161
2807
|
ToModifiedDate?: string;
|
|
2162
2808
|
}
|
|
2163
2809
|
interface NameFilter {
|
|
@@ -2186,6 +2832,8 @@ interface OverrideUOMSetRef {
|
|
|
2186
2832
|
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
2187
2833
|
FullName?: string;
|
|
2188
2834
|
}
|
|
2835
|
+
/** @default: All */
|
|
2836
|
+
declare type PaidStatus = "All" | "NotPaidOnly" | "PaidOnly";
|
|
2189
2837
|
interface ParentRef {
|
|
2190
2838
|
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
2191
2839
|
ListID?: string;
|
|
@@ -2249,7 +2897,11 @@ interface PurchaseTaxCodeRef {
|
|
|
2249
2897
|
interface RefNumberFilter {
|
|
2250
2898
|
/** The criterion to match. */
|
|
2251
2899
|
MatchCriterion: MatchCriterion;
|
|
2252
|
-
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
2900
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
2901
|
+
|
|
2902
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
2903
|
+
|
|
2904
|
+
Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
2253
2905
|
RefNumber: string;
|
|
2254
2906
|
}
|
|
2255
2907
|
interface RefNumberRangeFilter {
|
|
@@ -2351,6 +3003,14 @@ interface SecondaryContact {
|
|
|
2351
3003
|
/** Relationship of emergency contact information to the employee. */
|
|
2352
3004
|
Relation?: Relation;
|
|
2353
3005
|
}
|
|
3006
|
+
interface SetCredit {
|
|
3007
|
+
/** The ID of the credit memo that you are applying to this invoice or bill. */
|
|
3008
|
+
CreditTxnID: string;
|
|
3009
|
+
/** Amount of a credit that is applied to a customer’s invoice, or amount of a payment that is applied to a particular bill or vendor credit. */
|
|
3010
|
+
AppliedAmount: string;
|
|
3011
|
+
/** Option to override credit */
|
|
3012
|
+
Override?: boolean;
|
|
3013
|
+
}
|
|
2354
3014
|
interface ShipAddress {
|
|
2355
3015
|
/** The first line of an address. */
|
|
2356
3016
|
Addr1?: string;
|
|
@@ -2590,11 +3250,19 @@ interface TotalBalanceFilter {
|
|
|
2590
3250
|
Amount: string;
|
|
2591
3251
|
}
|
|
2592
3252
|
interface TxnDateRangeFilter {
|
|
2593
|
-
/** Selects transactions created on or after this date. Both `FromTxnDate` and `ToTxnDate` must be between 01/01/1901 and 12/31/9999.
|
|
3253
|
+
/** Selects transactions created on or after this date. Both `FromTxnDate` and `ToTxnDate` must be between 01/01/1901 and 12/31/9999.
|
|
3254
|
+
|
|
3255
|
+
If you omit `FromTxnDate`, it will be set to 1970-01-01 (1969-12-31 PST). */
|
|
2594
3256
|
FromTxnDate?: string;
|
|
2595
3257
|
/** Selects transactions created on or before this date. Both `ToTxnDate` and `FromTxnDate` must be between 01/01/1901 and 12/31/9999. If you omit `ToTxnDate`, it will be set to 2038-01-19 (2038-01-18 PST). */
|
|
2596
3258
|
ToTxnDate?: string;
|
|
2597
|
-
/** Refers to the transaction date, not the last modification date. Do not include `DateMacro` if either `FromModifedDate` or `ToModifiedDate` are specified. If a query does not specify `DateMacro`, `FromModifedDate`, or `ToModifiedDate`, it includes all dates.
|
|
3259
|
+
/** Refers to the transaction date, not the last modification date. Do not include `DateMacro` if either `FromModifedDate` or `ToModifiedDate` are specified. If a query does not specify `DateMacro`, `FromModifedDate`, or `ToModifiedDate`, it includes all dates.
|
|
3260
|
+
|
|
3261
|
+
`DateMacro` values, in alphabetical order, that are new with QBFC3:
|
|
3262
|
+
|
|
3263
|
+
`dmAll`, `dmdmLastCalendarQuarter`, `dmdmLastCalendarQuarterToDate`, `dmdmLastCalendarYear`, `dmdmLastCalendarYearToDate`, `dmLastFiscalQuarterToDate`, `dmLastFiscalYearToDate`, `dmLastMonthToDate`, `dmLastWeekToDate`, `dmNextCalendarQuarter`, `dmNextCalendarYear`, `dmNextFiscalQuarter`, `dmNextFiscalYear`, `dmNextFourWeeks`, `dmNextMonth`, `dmNextWeek`, `dmThisCalendarQuarter`, `dmThisCalendarQuarterToDate`, `dmThisCalendarYear`, dm `ThisCalendarYearToDate`, `dmThisFiscalQuarter`, `dmThisFiscalYear`, `dmThisMonth`, `dmThisWeek`, `dmThisWeekToDate`, `dmToday`, `dmYesterday`
|
|
3264
|
+
|
|
3265
|
+
The list given when you click `IQBENDateMacroType` shows the complete list of valid version 3.0 values. */
|
|
2598
3266
|
DateMacro?: DateMacro;
|
|
2599
3267
|
}
|
|
2600
3268
|
declare type TxnType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
|
|
@@ -2892,6 +3560,12 @@ export interface VendorQueryRq {
|
|
|
2892
3560
|
export interface VendorQueryRs {
|
|
2893
3561
|
VendorRet?: VendorRet | VendorRet[];
|
|
2894
3562
|
}
|
|
3563
|
+
interface VendorRef {
|
|
3564
|
+
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
3565
|
+
ListID?: string;
|
|
3566
|
+
/** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
|
|
3567
|
+
FullName?: string;
|
|
3568
|
+
}
|
|
2895
3569
|
interface VendorRet {
|
|
2896
3570
|
/** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
|
|
2897
3571
|
ListID: string;
|