conductor-node 3.2.2 → 3.4.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/src/Client.js +2 -2
- package/dist/src/environment.js +6 -3
- package/dist/src/qbd/ClientQbd.d.ts +255 -0
- package/dist/src/qbd/ClientQbd.js +255 -0
- package/dist/src/qbd/__tests__/ClientQbd.test.js +14 -10
- package/dist/src/qbd/qbdTypes.d.ts +870 -197
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
interface AccountAdd {
|
|
1
|
+
export interface AccountAdd {
|
|
2
2
|
/** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen.
|
|
3
3
|
|
|
4
4
|
For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
@@ -47,8 +47,10 @@ export interface AccountAddRs {
|
|
|
47
47
|
AccountRet?: AccountRet;
|
|
48
48
|
ErrorRecovery?: ErrorRecovery;
|
|
49
49
|
}
|
|
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`.
|
|
50
|
+
export 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`.
|
|
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;
|
|
@@ -57,7 +59,7 @@ interface AccountFilter {
|
|
|
57
59
|
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
58
60
|
FullNameWithChildren?: string;
|
|
59
61
|
}
|
|
60
|
-
interface AccountMod {
|
|
62
|
+
export interface AccountMod {
|
|
61
63
|
/** 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. */
|
|
62
64
|
ListID: string;
|
|
63
65
|
/** 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. */
|
|
@@ -161,13 +163,13 @@ export interface AccountQueryRq {
|
|
|
161
163
|
export interface AccountQueryRs {
|
|
162
164
|
AccountRet?: AccountRet | AccountRet[];
|
|
163
165
|
}
|
|
164
|
-
interface AccountRef {
|
|
166
|
+
export interface AccountRef {
|
|
165
167
|
/** 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. */
|
|
166
168
|
ListID?: string;
|
|
167
169
|
/** `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. */
|
|
168
170
|
FullName?: string;
|
|
169
171
|
}
|
|
170
|
-
interface AccountRet {
|
|
172
|
+
export interface AccountRet {
|
|
171
173
|
/** 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. */
|
|
172
174
|
ListID: string;
|
|
173
175
|
/** Time the object was created. */
|
|
@@ -223,27 +225,27 @@ interface AccountRet {
|
|
|
223
225
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
224
226
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
225
227
|
}
|
|
226
|
-
declare type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
|
|
227
|
-
declare type AccrualPeriod = "BeginningOfYear" | "EveryHourOnPaycheck" | "EveryPaycheck";
|
|
228
|
+
export declare type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
|
|
229
|
+
export declare type AccrualPeriod = "BeginningOfYear" | "EveryHourOnPaycheck" | "EveryPaycheck";
|
|
228
230
|
/** @default: ActiveOnly */
|
|
229
|
-
declare type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
|
|
230
|
-
interface AdditionalContactRef {
|
|
231
|
+
export declare type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
|
|
232
|
+
export interface AdditionalContactRef {
|
|
231
233
|
/** The name of the contact. */
|
|
232
234
|
ContactName: string;
|
|
233
235
|
/** The value of the contact field. */
|
|
234
236
|
ContactValue: string;
|
|
235
237
|
}
|
|
236
|
-
interface AdditionalNotes {
|
|
238
|
+
export interface AdditionalNotes {
|
|
237
239
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
238
240
|
Note: string;
|
|
239
241
|
}
|
|
240
|
-
interface AdditionalNotesMod {
|
|
242
|
+
export interface AdditionalNotesMod {
|
|
241
243
|
/** The ID of the note. */
|
|
242
244
|
NoteID: number;
|
|
243
245
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
244
246
|
Note: string;
|
|
245
247
|
}
|
|
246
|
-
interface AdditionalNotesRet {
|
|
248
|
+
export interface AdditionalNotesRet {
|
|
247
249
|
/** The ID of the note. */
|
|
248
250
|
NoteID: number;
|
|
249
251
|
/** The date the note was updated. */
|
|
@@ -251,7 +253,7 @@ interface AdditionalNotesRet {
|
|
|
251
253
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
252
254
|
Note: string;
|
|
253
255
|
}
|
|
254
|
-
interface Address {
|
|
256
|
+
export interface Address {
|
|
255
257
|
/** The first line of an address. */
|
|
256
258
|
Addr1?: string;
|
|
257
259
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -273,7 +275,7 @@ interface Address {
|
|
|
273
275
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
274
276
|
Note?: string;
|
|
275
277
|
}
|
|
276
|
-
interface AddressBlock {
|
|
278
|
+
export interface AddressBlock {
|
|
277
279
|
/** The first line of an address. */
|
|
278
280
|
Addr1?: string;
|
|
279
281
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -285,19 +287,81 @@ interface AddressBlock {
|
|
|
285
287
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
286
288
|
Addr5?: string;
|
|
287
289
|
}
|
|
288
|
-
interface
|
|
290
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
}
|
|
346
|
+
export 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;
|
|
291
349
|
/** A monetary amount. */
|
|
292
350
|
Amount?: string;
|
|
293
351
|
}
|
|
294
|
-
interface ApplyCheckToTxnMod {
|
|
352
|
+
export interface ApplyCheckToTxnMod {
|
|
295
353
|
/** 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. */
|
|
296
354
|
TxnID: string;
|
|
297
355
|
/** A monetary amount. */
|
|
298
356
|
Amount?: string;
|
|
299
357
|
}
|
|
300
|
-
interface
|
|
358
|
+
export 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
|
+
}
|
|
364
|
+
export interface BarCode {
|
|
301
365
|
/** Value of the barcode in the item. */
|
|
302
366
|
BarCodeValue?: string;
|
|
303
367
|
/** Allow barcode to be assigned to item, even if already in use. */
|
|
@@ -305,8 +369,52 @@ interface BarCode {
|
|
|
305
369
|
/** Allows for barcode to be overridden for an item. */
|
|
306
370
|
AllowOverride?: boolean;
|
|
307
371
|
}
|
|
308
|
-
declare type BillableStatus = "Billable" | "HasBeenBilled" | "NotBillable";
|
|
309
|
-
interface
|
|
372
|
+
export declare type BillableStatus = "Billable" | "HasBeenBilled" | "NotBillable";
|
|
373
|
+
export 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
|
+
}
|
|
417
|
+
export interface BillAddress {
|
|
310
418
|
/** The first line of an address. */
|
|
311
419
|
Addr1?: string;
|
|
312
420
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -328,7 +436,7 @@ interface BillAddress {
|
|
|
328
436
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
329
437
|
Note?: string;
|
|
330
438
|
}
|
|
331
|
-
interface BillAddressBlock {
|
|
439
|
+
export interface BillAddressBlock {
|
|
332
440
|
/** The first line of an address. */
|
|
333
441
|
Addr1?: string;
|
|
334
442
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -340,14 +448,366 @@ interface BillAddressBlock {
|
|
|
340
448
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
341
449
|
Addr5?: string;
|
|
342
450
|
}
|
|
343
|
-
interface
|
|
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
|
+
}
|
|
462
|
+
export 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
|
}
|
|
349
|
-
|
|
350
|
-
|
|
468
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
export 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
|
+
}
|
|
809
|
+
export declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
|
|
810
|
+
export 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` */
|
|
352
812
|
AccountRef: AccountRef;
|
|
353
813
|
/** 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.) */
|
|
@@ -388,7 +848,7 @@ export interface CheckAddRs {
|
|
|
388
848
|
CheckRet?: CheckRet;
|
|
389
849
|
ErrorRecovery?: ErrorRecovery;
|
|
390
850
|
}
|
|
391
|
-
interface CheckMod {
|
|
851
|
+
export interface CheckMod {
|
|
392
852
|
/** 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. */
|
|
393
853
|
TxnID: string;
|
|
394
854
|
/** 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. */
|
|
@@ -470,7 +930,7 @@ export interface CheckQueryRq {
|
|
|
470
930
|
export interface CheckQueryRs {
|
|
471
931
|
CheckRet?: CheckRet | CheckRet[];
|
|
472
932
|
}
|
|
473
|
-
interface CheckRet {
|
|
933
|
+
export interface CheckRet {
|
|
474
934
|
/** 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. */
|
|
475
935
|
TxnID: string;
|
|
476
936
|
/** Time the object was created. */
|
|
@@ -522,7 +982,7 @@ interface CheckRet {
|
|
|
522
982
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
523
983
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
524
984
|
}
|
|
525
|
-
interface ClassAdd {
|
|
985
|
+
export interface ClassAdd {
|
|
526
986
|
/** The case-insensitive name of the class, not including the names of its ancestors. */
|
|
527
987
|
Name: string;
|
|
528
988
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -539,7 +999,7 @@ export interface ClassAddRs {
|
|
|
539
999
|
ClassRet?: ClassRet;
|
|
540
1000
|
ErrorRecovery?: ErrorRecovery;
|
|
541
1001
|
}
|
|
542
|
-
interface ClassFilter {
|
|
1002
|
+
export interface ClassFilter {
|
|
543
1003
|
/** 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`. 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. */
|
|
544
1004
|
ListID?: string[] | string;
|
|
545
1005
|
/** 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. */
|
|
@@ -549,7 +1009,7 @@ interface ClassFilter {
|
|
|
549
1009
|
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
550
1010
|
FullNameWithChildren?: string;
|
|
551
1011
|
}
|
|
552
|
-
interface ClassMod {
|
|
1012
|
+
export interface ClassMod {
|
|
553
1013
|
/** 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. */
|
|
554
1014
|
ListID: string;
|
|
555
1015
|
/** 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. */
|
|
@@ -593,13 +1053,13 @@ export interface ClassQueryRq {
|
|
|
593
1053
|
export interface ClassQueryRs {
|
|
594
1054
|
ClassRet?: ClassRet | ClassRet[];
|
|
595
1055
|
}
|
|
596
|
-
interface ClassRef {
|
|
1056
|
+
export interface ClassRef {
|
|
597
1057
|
/** 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. */
|
|
598
1058
|
ListID?: string;
|
|
599
1059
|
/** `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. */
|
|
600
1060
|
FullName?: string;
|
|
601
1061
|
}
|
|
602
|
-
interface ClassRet {
|
|
1062
|
+
export interface ClassRet {
|
|
603
1063
|
/** 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. */
|
|
604
1064
|
ListID: string;
|
|
605
1065
|
/** Time the object was created. */
|
|
@@ -619,7 +1079,7 @@ interface ClassRet {
|
|
|
619
1079
|
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
620
1080
|
Sublevel: number;
|
|
621
1081
|
}
|
|
622
|
-
interface Contacts {
|
|
1082
|
+
export interface Contacts {
|
|
623
1083
|
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
624
1084
|
Salutation?: string;
|
|
625
1085
|
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
@@ -633,7 +1093,7 @@ interface Contacts {
|
|
|
633
1093
|
/** List of additional contacts. */
|
|
634
1094
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
635
1095
|
}
|
|
636
|
-
interface ContactsMod {
|
|
1096
|
+
export interface ContactsMod {
|
|
637
1097
|
/** 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. */
|
|
638
1098
|
ListID: string;
|
|
639
1099
|
/** 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. */
|
|
@@ -651,7 +1111,7 @@ interface ContactsMod {
|
|
|
651
1111
|
/** List of additional contacts. */
|
|
652
1112
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
653
1113
|
}
|
|
654
|
-
interface ContactsRet {
|
|
1114
|
+
export interface ContactsRet {
|
|
655
1115
|
/** 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. */
|
|
656
1116
|
ListID: string;
|
|
657
1117
|
/** Time the object was created. */
|
|
@@ -675,7 +1135,7 @@ interface ContactsRet {
|
|
|
675
1135
|
/** List of additional contacts. */
|
|
676
1136
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
677
1137
|
}
|
|
678
|
-
interface CreditCardInfo {
|
|
1138
|
+
export interface CreditCardInfo {
|
|
679
1139
|
/** Credit-card number for this customer or this payment. Beginning with qbXML spec 6.0 and QuickBooks 2007, you must mask the credit card number with lower case “x” and no dashes. For example, xxxxxxxxxxxx1234. */
|
|
680
1140
|
CreditCardNumber?: string;
|
|
681
1141
|
/** The month when the credit card expires. */
|
|
@@ -689,7 +1149,7 @@ interface CreditCardInfo {
|
|
|
689
1149
|
/** The postal code associated with the address for this credit card. */
|
|
690
1150
|
CreditCardPostalCode?: string;
|
|
691
1151
|
}
|
|
692
|
-
interface CurrencyFilter {
|
|
1152
|
+
export interface CurrencyFilter {
|
|
693
1153
|
/** 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`.
|
|
694
1154
|
|
|
695
1155
|
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. */
|
|
@@ -697,13 +1157,13 @@ interface CurrencyFilter {
|
|
|
697
1157
|
/** 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. */
|
|
698
1158
|
FullName?: string[] | string;
|
|
699
1159
|
}
|
|
700
|
-
interface CurrencyRef {
|
|
1160
|
+
export interface CurrencyRef {
|
|
701
1161
|
/** 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. */
|
|
702
1162
|
ListID?: string;
|
|
703
1163
|
/** `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. */
|
|
704
1164
|
FullName?: string;
|
|
705
1165
|
}
|
|
706
|
-
interface CustomerAdd {
|
|
1166
|
+
export interface CustomerAdd {
|
|
707
1167
|
/** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
708
1168
|
Name: string;
|
|
709
1169
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -810,7 +1270,7 @@ export interface CustomerAddRs {
|
|
|
810
1270
|
CustomerRet?: CustomerRet;
|
|
811
1271
|
ErrorRecovery?: ErrorRecovery;
|
|
812
1272
|
}
|
|
813
|
-
interface CustomerMod {
|
|
1273
|
+
export interface CustomerMod {
|
|
814
1274
|
/** 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. */
|
|
815
1275
|
ListID: string;
|
|
816
1276
|
/** 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. */
|
|
@@ -946,13 +1406,13 @@ export interface CustomerQueryRq {
|
|
|
946
1406
|
export interface CustomerQueryRs {
|
|
947
1407
|
CustomerRet?: CustomerRet | CustomerRet[];
|
|
948
1408
|
}
|
|
949
|
-
interface CustomerRef {
|
|
1409
|
+
export interface CustomerRef {
|
|
950
1410
|
/** 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. */
|
|
951
1411
|
ListID?: string;
|
|
952
1412
|
/** `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. */
|
|
953
1413
|
FullName?: string;
|
|
954
1414
|
}
|
|
955
|
-
interface CustomerRet {
|
|
1415
|
+
export interface CustomerRet {
|
|
956
1416
|
/** 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. */
|
|
957
1417
|
ListID: string;
|
|
958
1418
|
/** Time the object was created. */
|
|
@@ -1068,21 +1528,25 @@ interface CustomerRet {
|
|
|
1068
1528
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1069
1529
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1070
1530
|
}
|
|
1071
|
-
interface CustomerTypeRef {
|
|
1531
|
+
export interface CustomerTypeRef {
|
|
1072
1532
|
/** 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. */
|
|
1073
1533
|
ListID?: string;
|
|
1074
1534
|
/** `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. */
|
|
1075
1535
|
FullName?: string;
|
|
1076
1536
|
}
|
|
1077
|
-
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. )
|
|
1537
|
+
export interface DataExt {
|
|
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;
|
|
1082
1546
|
/** The data in this field. The maximum length of `DataExtValue` will depend on the `DataExtType` of this data extension. For example, if `DataExtType` is `STR255TYPE`, the maximum length of `DataExtValue` is 255 characters. If `DataExtType` is `STR1024TYPE`, the maximum size of `DataExtValue` is `1KB`. */
|
|
1083
1547
|
DataExtValue: string;
|
|
1084
1548
|
}
|
|
1085
|
-
interface DataExtRet {
|
|
1549
|
+
export interface DataExtRet {
|
|
1086
1550
|
/** `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. )
|
|
1087
1551
|
|
|
1088
1552
|
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.)
|
|
@@ -1096,10 +1560,22 @@ interface DataExtRet {
|
|
|
1096
1560
|
/** The data in this field. The maximum length of `DataExtValue` will depend on the `DataExtType` of this data extension. For example, if `DataExtType` is `STR255TYPE`, the maximum length of `DataExtValue` is 255 characters. If `DataExtType` is `STR1024TYPE`, the maximum size of `DataExtValue` is `1KB`. */
|
|
1097
1561
|
DataExtValue: string;
|
|
1098
1562
|
}
|
|
1099
|
-
declare type DataExtType = "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
|
|
1100
|
-
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
|
-
declare type Disabled = "No" | "Yes";
|
|
1102
|
-
interface
|
|
1563
|
+
export declare type DataExtType = "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
|
|
1564
|
+
export 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";
|
|
1565
|
+
export declare type Disabled = "No" | "Yes";
|
|
1566
|
+
export 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
|
+
export 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
|
+
}
|
|
1578
|
+
export 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;
|
|
1105
1581
|
/** Indicates the price of something. */
|
|
@@ -1107,13 +1583,13 @@ interface Earnings {
|
|
|
1107
1583
|
/** Indicates the price of something as a percent. */
|
|
1108
1584
|
RatePercent?: string;
|
|
1109
1585
|
}
|
|
1110
|
-
interface EmergencyContacts {
|
|
1586
|
+
export interface EmergencyContacts {
|
|
1111
1587
|
/** Primary emergency contact information for the employee. */
|
|
1112
1588
|
PrimaryContact?: PrimaryContact;
|
|
1113
1589
|
/** Secondary emergency contact information for the employee. */
|
|
1114
1590
|
SecondaryContact?: SecondaryContact;
|
|
1115
1591
|
}
|
|
1116
|
-
interface EmployeeAdd {
|
|
1592
|
+
export interface EmployeeAdd {
|
|
1117
1593
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
1118
1594
|
IsActive?: boolean;
|
|
1119
1595
|
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
@@ -1207,7 +1683,7 @@ interface EmployeeAdd {
|
|
|
1207
1683
|
/** Allows for the attachment of a user defined GUID value. */
|
|
1208
1684
|
ExternalGUID?: string;
|
|
1209
1685
|
}
|
|
1210
|
-
interface EmployeeAddress {
|
|
1686
|
+
export interface EmployeeAddress {
|
|
1211
1687
|
/** The first line of an address. */
|
|
1212
1688
|
Addr1?: string;
|
|
1213
1689
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -1228,7 +1704,7 @@ export interface EmployeeAddRs {
|
|
|
1228
1704
|
EmployeeRet?: EmployeeRet;
|
|
1229
1705
|
ErrorRecovery?: ErrorRecovery;
|
|
1230
1706
|
}
|
|
1231
|
-
interface EmployeeMod {
|
|
1707
|
+
export interface EmployeeMod {
|
|
1232
1708
|
/** 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. */
|
|
1233
1709
|
ListID: string;
|
|
1234
1710
|
/** 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. */
|
|
@@ -1329,7 +1805,7 @@ export interface EmployeeModRs {
|
|
|
1329
1805
|
EmployeeRet?: EmployeeRet;
|
|
1330
1806
|
ErrorRecovery?: ErrorRecovery;
|
|
1331
1807
|
}
|
|
1332
|
-
interface EmployeePayrollInfo {
|
|
1808
|
+
export interface EmployeePayrollInfo {
|
|
1333
1809
|
/** Indicates how often employees are paid. If you include a blank `PayPeriod` element in an `EmployeeMod` message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. */
|
|
1334
1810
|
PayPeriod?: PayPeriod;
|
|
1335
1811
|
/** 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. 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. */
|
|
@@ -1347,7 +1823,7 @@ interface EmployeePayrollInfo {
|
|
|
1347
1823
|
/** Describes how vacation time is accrued for this employee, along with how many vacation hours the employee has accrued. */
|
|
1348
1824
|
VacationHours?: VacationHours;
|
|
1349
1825
|
}
|
|
1350
|
-
interface EmployeePayrollInfoMod {
|
|
1826
|
+
export interface EmployeePayrollInfoMod {
|
|
1351
1827
|
/** Indicates how often employees are paid. If you include a blank `PayPeriod` element in an `EmployeeMod` message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. */
|
|
1352
1828
|
PayPeriod?: PayPeriod;
|
|
1353
1829
|
/** 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. 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. */
|
|
@@ -1390,7 +1866,7 @@ export interface EmployeeQueryRq {
|
|
|
1390
1866
|
export interface EmployeeQueryRs {
|
|
1391
1867
|
EmployeeRet?: EmployeeRet | EmployeeRet[];
|
|
1392
1868
|
}
|
|
1393
|
-
interface EmployeeRet {
|
|
1869
|
+
export interface EmployeeRet {
|
|
1394
1870
|
/** 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. */
|
|
1395
1871
|
ListID: string;
|
|
1396
1872
|
/** Time the object was created. */
|
|
@@ -1497,9 +1973,11 @@ interface EmployeeRet {
|
|
|
1497
1973
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1498
1974
|
}
|
|
1499
1975
|
/** @default: Regular */
|
|
1500
|
-
declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
|
|
1501
|
-
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`.
|
|
1976
|
+
export declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
|
|
1977
|
+
export interface EntityFilter {
|
|
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;
|
|
@@ -1508,13 +1986,13 @@ interface EntityFilter {
|
|
|
1508
1986
|
/** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
|
|
1509
1987
|
FullNameWithChildren?: string;
|
|
1510
1988
|
}
|
|
1511
|
-
interface EntityRef {
|
|
1989
|
+
export interface EntityRef {
|
|
1512
1990
|
/** 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. */
|
|
1513
1991
|
ListID?: string;
|
|
1514
1992
|
/** `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. */
|
|
1515
1993
|
FullName?: string;
|
|
1516
1994
|
}
|
|
1517
|
-
interface ErrorRecovery {
|
|
1995
|
+
export interface ErrorRecovery {
|
|
1518
1996
|
/** 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. */
|
|
1519
1997
|
ListID?: string;
|
|
1520
1998
|
/** Refers to the owner of a data extension:
|
|
@@ -1536,26 +2014,52 @@ interface ErrorRecovery {
|
|
|
1536
2014
|
/** Allows for the attachment of a user defined GUID value. */
|
|
1537
2015
|
ExternalGUID?: string;
|
|
1538
2016
|
}
|
|
1539
|
-
declare type Ethnicity = "AmericianIndian" | "Asian" | "Black" | "Hawaiian" | "Hispanic" | "TwoOrMoreRaces" | "White";
|
|
1540
|
-
declare type Exempt = "Exempt" | "NonExempt";
|
|
1541
|
-
interface ExpenseAccountRef {
|
|
2017
|
+
export declare type Ethnicity = "AmericianIndian" | "Asian" | "Black" | "Hawaiian" | "Hispanic" | "TwoOrMoreRaces" | "White";
|
|
2018
|
+
export declare type Exempt = "Exempt" | "NonExempt";
|
|
2019
|
+
export interface ExpenseAccountRef {
|
|
1542
2020
|
/** 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. */
|
|
1543
2021
|
ListID?: string;
|
|
1544
2022
|
/** `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. */
|
|
1545
2023
|
FullName?: string;
|
|
1546
2024
|
}
|
|
1547
|
-
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.)
|
|
2025
|
+
export interface ExpenseLineAdd {
|
|
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;
|
|
@@ -1564,40 +2068,104 @@ interface ExpenseLineAdd {
|
|
|
1564
2068
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1565
2069
|
DataExt?: DataExt | DataExt[];
|
|
1566
2070
|
}
|
|
1567
|
-
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.)
|
|
2071
|
+
export interface ExpenseLineMod {
|
|
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;
|
|
1584
2120
|
/** 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. */
|
|
1585
2121
|
SalesRepRef?: SalesRepRef;
|
|
1586
2122
|
}
|
|
1587
|
-
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.)
|
|
2123
|
+
export interface ExpenseLineRet {
|
|
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;
|
|
@@ -1606,26 +2174,26 @@ interface ExpenseLineRet {
|
|
|
1606
2174
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1607
2175
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1608
2176
|
}
|
|
1609
|
-
declare type Gender = "Female" | "Male";
|
|
1610
|
-
interface IncomeAccountRef {
|
|
2177
|
+
export declare type Gender = "Female" | "Male";
|
|
2178
|
+
export interface IncomeAccountRef {
|
|
1611
2179
|
/** 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. */
|
|
1612
2180
|
ListID?: string;
|
|
1613
2181
|
/** `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. */
|
|
1614
2182
|
FullName?: string;
|
|
1615
2183
|
}
|
|
1616
|
-
interface InventorySiteLocationRef {
|
|
2184
|
+
export interface InventorySiteLocationRef {
|
|
1617
2185
|
/** 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. */
|
|
1618
2186
|
ListID?: string;
|
|
1619
2187
|
/** `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. */
|
|
1620
2188
|
FullName?: string;
|
|
1621
2189
|
}
|
|
1622
|
-
interface InventorySiteRef {
|
|
2190
|
+
export interface InventorySiteRef {
|
|
1623
2191
|
/** 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. */
|
|
1624
2192
|
ListID?: string;
|
|
1625
2193
|
/** `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. */
|
|
1626
2194
|
FullName?: string;
|
|
1627
2195
|
}
|
|
1628
|
-
interface ItemGroupLineAdd {
|
|
2196
|
+
export interface ItemGroupLineAdd {
|
|
1629
2197
|
/** `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. */
|
|
1630
2198
|
ItemGroupRef: ItemGroupRef;
|
|
1631
2199
|
/** `QuantityFor` transactions: If an item line add on a transaction request specifies `Quantity` and `Amount` but not `Rate`, QuickBooks will use `Quantity` and `Amount` to calculate `Rate`. Likewise, if a request specifies `Quantity` and `Rate` but not `Amount`, QuickBooks will calculate the `Amount`. If a transaction add request includes a reference to an `ItemDiscount` item, do not include a `Quantity` element as well, or you will get an error. For Item requests: `Quantity` indicates how many of this item there are. */
|
|
@@ -1639,8 +2207,10 @@ interface ItemGroupLineAdd {
|
|
|
1639
2207
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1640
2208
|
DataExt?: DataExt | DataExt[];
|
|
1641
2209
|
}
|
|
1642
|
-
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.)
|
|
2210
|
+
export interface ItemGroupLineMod {
|
|
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;
|
|
@@ -1653,8 +2223,10 @@ interface ItemGroupLineMod {
|
|
|
1653
2223
|
/** A list of `IItemLineRet` objects, each representing one line of the item. Each item line is used to track a portion of a transaction that represents the purchase of an “item.” */
|
|
1654
2224
|
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
1655
2225
|
}
|
|
1656
|
-
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.)
|
|
2226
|
+
export interface ItemGroupLineRet {
|
|
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;
|
|
@@ -1673,14 +2245,20 @@ interface ItemGroupLineRet {
|
|
|
1673
2245
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1674
2246
|
DataExt?: DataExt | DataExt[];
|
|
1675
2247
|
}
|
|
1676
|
-
interface ItemGroupRef {
|
|
2248
|
+
export interface ItemGroupRef {
|
|
1677
2249
|
/** 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. */
|
|
1678
2250
|
ListID?: string;
|
|
1679
2251
|
/** `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. */
|
|
1680
2252
|
FullName?: string;
|
|
1681
2253
|
}
|
|
1682
|
-
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.
|
|
2254
|
+
export interface ItemLineAdd {
|
|
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
|
-
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.)
|
|
2304
|
+
export interface ItemLineMod {
|
|
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;
|
|
@@ -1753,10 +2355,18 @@ interface ItemLineMod {
|
|
|
1753
2355
|
/** 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. */
|
|
1754
2356
|
SalesRepRef?: SalesRepRef;
|
|
1755
2357
|
}
|
|
1756
|
-
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.)
|
|
2358
|
+
export interface ItemLineRet {
|
|
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;
|
|
@@ -1791,19 +2409,19 @@ interface ItemLineRet {
|
|
|
1791
2409
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1792
2410
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1793
2411
|
}
|
|
1794
|
-
interface ItemRef {
|
|
2412
|
+
export interface ItemRef {
|
|
1795
2413
|
/** 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. */
|
|
1796
2414
|
ListID?: string;
|
|
1797
2415
|
/** `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. */
|
|
1798
2416
|
FullName?: string;
|
|
1799
2417
|
}
|
|
1800
|
-
interface ItemSalesTaxRef {
|
|
2418
|
+
export interface ItemSalesTaxRef {
|
|
1801
2419
|
/** 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. */
|
|
1802
2420
|
ListID?: string;
|
|
1803
2421
|
/** `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. */
|
|
1804
2422
|
FullName?: string;
|
|
1805
2423
|
}
|
|
1806
|
-
interface ItemServiceAdd {
|
|
2424
|
+
export interface ItemServiceAdd {
|
|
1807
2425
|
/** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
1808
2426
|
Name: string;
|
|
1809
2427
|
/** Barcode reference information. */
|
|
@@ -1836,7 +2454,7 @@ export interface ItemServiceAddRs {
|
|
|
1836
2454
|
ItemServiceRet?: ItemServiceRet;
|
|
1837
2455
|
ErrorRecovery?: ErrorRecovery;
|
|
1838
2456
|
}
|
|
1839
|
-
interface ItemServiceMod {
|
|
2457
|
+
export interface ItemServiceMod {
|
|
1840
2458
|
/** 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. */
|
|
1841
2459
|
ListID: string;
|
|
1842
2460
|
/** 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. */
|
|
@@ -1900,13 +2518,13 @@ export interface ItemServiceQueryRq {
|
|
|
1900
2518
|
export interface ItemServiceQueryRs {
|
|
1901
2519
|
ItemServiceRet?: ItemServiceRet | ItemServiceRet[];
|
|
1902
2520
|
}
|
|
1903
|
-
interface ItemServiceRef {
|
|
2521
|
+
export interface ItemServiceRef {
|
|
1904
2522
|
/** 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. */
|
|
1905
2523
|
ListID?: string;
|
|
1906
2524
|
/** `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. */
|
|
1907
2525
|
FullName?: string;
|
|
1908
2526
|
}
|
|
1909
|
-
interface ItemServiceRet {
|
|
2527
|
+
export interface ItemServiceRet {
|
|
1910
2528
|
/** 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. */
|
|
1911
2529
|
ListID: string;
|
|
1912
2530
|
/** Time the object was created. */
|
|
@@ -1945,14 +2563,14 @@ interface ItemServiceRet {
|
|
|
1945
2563
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1946
2564
|
}
|
|
1947
2565
|
/** @default: None */
|
|
1948
|
-
declare type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
|
|
1949
|
-
interface JobTypeRef {
|
|
2566
|
+
export declare type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
|
|
2567
|
+
export interface JobTypeRef {
|
|
1950
2568
|
/** 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. */
|
|
1951
2569
|
ListID?: string;
|
|
1952
2570
|
/** `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. */
|
|
1953
2571
|
FullName?: string;
|
|
1954
2572
|
}
|
|
1955
|
-
interface JournalCreditLine {
|
|
2573
|
+
export interface JournalCreditLine {
|
|
1956
2574
|
/** 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.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1957
2575
|
TxnLineID?: string;
|
|
1958
2576
|
/** 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` */
|
|
@@ -1970,7 +2588,7 @@ interface JournalCreditLine {
|
|
|
1970
2588
|
/** The billing status of this item line or expense line. */
|
|
1971
2589
|
BillableStatus?: BillableStatus;
|
|
1972
2590
|
}
|
|
1973
|
-
interface JournalDebitLine {
|
|
2591
|
+
export interface JournalDebitLine {
|
|
1974
2592
|
/** 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.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
1975
2593
|
TxnLineID?: string;
|
|
1976
2594
|
/** 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` */
|
|
@@ -1988,7 +2606,7 @@ interface JournalDebitLine {
|
|
|
1988
2606
|
/** The billing status of this item line or expense line. */
|
|
1989
2607
|
BillableStatus?: BillableStatus;
|
|
1990
2608
|
}
|
|
1991
|
-
interface JournalEntryAdd {
|
|
2609
|
+
export interface JournalEntryAdd {
|
|
1992
2610
|
/** 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. */
|
|
1993
2611
|
TxnDate?: string;
|
|
1994
2612
|
/** 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. */
|
|
@@ -2019,7 +2637,7 @@ export interface JournalEntryAddRs {
|
|
|
2019
2637
|
JournalEntryRet?: JournalEntryRet;
|
|
2020
2638
|
ErrorRecovery?: ErrorRecovery;
|
|
2021
2639
|
}
|
|
2022
|
-
interface JournalEntryMod {
|
|
2640
|
+
export interface JournalEntryMod {
|
|
2023
2641
|
/** 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. */
|
|
2024
2642
|
TxnID: string;
|
|
2025
2643
|
/** 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. */
|
|
@@ -2081,7 +2699,7 @@ export interface JournalEntryQueryRq {
|
|
|
2081
2699
|
export interface JournalEntryQueryRs {
|
|
2082
2700
|
JournalEntryRet?: JournalEntryRet | JournalEntryRet[];
|
|
2083
2701
|
}
|
|
2084
|
-
interface JournalEntryRet {
|
|
2702
|
+
export interface JournalEntryRet {
|
|
2085
2703
|
/** 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. */
|
|
2086
2704
|
TxnID: string;
|
|
2087
2705
|
/** Time the object was created. */
|
|
@@ -2115,7 +2733,7 @@ interface JournalEntryRet {
|
|
|
2115
2733
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2116
2734
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2117
2735
|
}
|
|
2118
|
-
interface JournalLineMod {
|
|
2736
|
+
export interface JournalLineMod {
|
|
2119
2737
|
/** 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.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
2120
2738
|
TxnLineID: string;
|
|
2121
2739
|
/** The type of journal line (debit or credit). */
|
|
@@ -2135,104 +2753,134 @@ interface JournalLineMod {
|
|
|
2135
2753
|
/** The billing status of this item line or expense line. */
|
|
2136
2754
|
BillableStatus?: BillableStatus;
|
|
2137
2755
|
}
|
|
2138
|
-
declare type JournalLineType = "Credit" | "Debit";
|
|
2139
|
-
declare type KeyEmployee = "No" | "Yes";
|
|
2140
|
-
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.
|
|
2756
|
+
export declare type JournalLineType = "Credit" | "Debit";
|
|
2757
|
+
export declare type KeyEmployee = "No" | "Yes";
|
|
2758
|
+
export interface LinkedTxn {
|
|
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
|
}
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2778
|
+
export 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
|
+
}
|
|
2788
|
+
export declare type LinkType = "AMTTYPE" | "QUANTYPE";
|
|
2789
|
+
export declare type MatchCriterion = "Contains" | "EndsWith" | "StartsWith";
|
|
2790
|
+
export declare type MilitaryStatus = "Active" | "Reserve";
|
|
2791
|
+
export interface ModifiedDateRangeFilter {
|
|
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
|
-
interface NameFilter {
|
|
2809
|
+
export interface NameFilter {
|
|
2164
2810
|
/** The criterion to match. */
|
|
2165
2811
|
MatchCriterion: MatchCriterion;
|
|
2166
2812
|
/** The string to match. */
|
|
2167
2813
|
Name: string;
|
|
2168
2814
|
}
|
|
2169
|
-
interface NameRangeFilter {
|
|
2815
|
+
export interface NameRangeFilter {
|
|
2170
2816
|
/** The first name or item in the search range. If `FromName` is omitted, the range will begin with first name on the list. */
|
|
2171
2817
|
FromName?: string;
|
|
2172
2818
|
/** The final name or item in the search range. If `ToName` is omitted, the range will end with last name on the list. */
|
|
2173
2819
|
ToName?: string;
|
|
2174
2820
|
}
|
|
2175
|
-
declare type OnFile = "No" | "Yes";
|
|
2176
|
-
declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
|
|
2177
|
-
interface OverrideItemAccountRef {
|
|
2821
|
+
export declare type OnFile = "No" | "Yes";
|
|
2822
|
+
export declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
|
|
2823
|
+
export interface OverrideItemAccountRef {
|
|
2178
2824
|
/** 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. */
|
|
2179
2825
|
ListID?: string;
|
|
2180
2826
|
/** `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. */
|
|
2181
2827
|
FullName?: string;
|
|
2182
2828
|
}
|
|
2183
|
-
interface OverrideUOMSetRef {
|
|
2829
|
+
export interface OverrideUOMSetRef {
|
|
2184
2830
|
/** 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. */
|
|
2185
2831
|
ListID?: string;
|
|
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
|
}
|
|
2189
|
-
|
|
2835
|
+
/** @default: All */
|
|
2836
|
+
export declare type PaidStatus = "All" | "NotPaidOnly" | "PaidOnly";
|
|
2837
|
+
export 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;
|
|
2192
2840
|
/** `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. */
|
|
2193
2841
|
FullName?: string;
|
|
2194
2842
|
}
|
|
2195
|
-
declare type PartOrFullTime = "FullTime" | "PartTime";
|
|
2196
|
-
interface PayeeEntityRef {
|
|
2843
|
+
export declare type PartOrFullTime = "FullTime" | "PartTime";
|
|
2844
|
+
export interface PayeeEntityRef {
|
|
2197
2845
|
/** 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. */
|
|
2198
2846
|
ListID?: string;
|
|
2199
2847
|
/** `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. */
|
|
2200
2848
|
FullName?: string;
|
|
2201
2849
|
}
|
|
2202
|
-
declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
|
|
2203
|
-
interface PayrollItemWageRef {
|
|
2850
|
+
export declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
|
|
2851
|
+
export interface PayrollItemWageRef {
|
|
2204
2852
|
/** 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. */
|
|
2205
2853
|
ListID?: string;
|
|
2206
2854
|
/** `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. */
|
|
2207
2855
|
FullName?: string;
|
|
2208
2856
|
}
|
|
2209
2857
|
/** @default: None */
|
|
2210
|
-
declare type PreferredDeliveryMethod = "Email" | "Fax" | "None";
|
|
2211
|
-
interface PreferredPaymentMethodRef {
|
|
2858
|
+
export declare type PreferredDeliveryMethod = "Email" | "Fax" | "None";
|
|
2859
|
+
export interface PreferredPaymentMethodRef {
|
|
2212
2860
|
/** 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. */
|
|
2213
2861
|
ListID?: string;
|
|
2214
2862
|
/** `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. */
|
|
2215
2863
|
FullName?: string;
|
|
2216
2864
|
}
|
|
2217
|
-
interface PrefillAccountRef {
|
|
2865
|
+
export interface PrefillAccountRef {
|
|
2218
2866
|
/** 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. */
|
|
2219
2867
|
ListID?: string;
|
|
2220
2868
|
/** `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. */
|
|
2221
2869
|
FullName?: string;
|
|
2222
2870
|
}
|
|
2223
|
-
interface PrefVendorRef {
|
|
2871
|
+
export interface PrefVendorRef {
|
|
2224
2872
|
/** 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. */
|
|
2225
2873
|
ListID?: string;
|
|
2226
2874
|
/** `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. */
|
|
2227
2875
|
FullName?: string;
|
|
2228
2876
|
}
|
|
2229
|
-
interface PriceLevelRef {
|
|
2877
|
+
export interface PriceLevelRef {
|
|
2230
2878
|
/** 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. */
|
|
2231
2879
|
ListID?: string;
|
|
2232
2880
|
/** `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. */
|
|
2233
2881
|
FullName?: string;
|
|
2234
2882
|
}
|
|
2235
|
-
interface PrimaryContact {
|
|
2883
|
+
export interface PrimaryContact {
|
|
2236
2884
|
/** The name of the contact. */
|
|
2237
2885
|
ContactName: string;
|
|
2238
2886
|
/** The value of the contact field. */
|
|
@@ -2240,28 +2888,32 @@ interface PrimaryContact {
|
|
|
2240
2888
|
/** Relationship of emergency contact information to the employee. */
|
|
2241
2889
|
Relation?: Relation;
|
|
2242
2890
|
}
|
|
2243
|
-
interface PurchaseTaxCodeRef {
|
|
2891
|
+
export interface PurchaseTaxCodeRef {
|
|
2244
2892
|
/** 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. */
|
|
2245
2893
|
ListID?: string;
|
|
2246
2894
|
/** `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. */
|
|
2247
2895
|
FullName?: string;
|
|
2248
2896
|
}
|
|
2249
|
-
interface RefNumberFilter {
|
|
2897
|
+
export 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
|
-
interface RefNumberRangeFilter {
|
|
2907
|
+
export interface RefNumberRangeFilter {
|
|
2256
2908
|
/** The first `RefNumber` in the search range. If `FromRefNumber` is omitted, the range will begin with first number on the list. */
|
|
2257
2909
|
FromRefNumber?: string;
|
|
2258
2910
|
/** The final `RefNumber` in the search range. If `ToRefNumber` is omitted, the range will end with last number on the list. */
|
|
2259
2911
|
ToRefNumber?: string;
|
|
2260
2912
|
}
|
|
2261
|
-
declare type Relation = "Brother" | "Daughter" | "Father" | "Friend" | "Mother" | "Other" | "Partner" | "Sister" | "Son" | "Spouse";
|
|
2913
|
+
export declare type Relation = "Brother" | "Daughter" | "Father" | "Friend" | "Mother" | "Other" | "Partner" | "Sister" | "Son" | "Spouse";
|
|
2262
2914
|
/** @default: Quarterly */
|
|
2263
|
-
declare type ReportingPeriod = "Monthly" | "Quarterly";
|
|
2264
|
-
interface SalesAndPurchase {
|
|
2915
|
+
export declare type ReportingPeriod = "Monthly" | "Quarterly";
|
|
2916
|
+
export interface SalesAndPurchase {
|
|
2265
2917
|
/** Appears in the `Description` column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes). */
|
|
2266
2918
|
SalesDesc?: string;
|
|
2267
2919
|
/** Price charged for this item. */
|
|
@@ -2279,7 +2931,7 @@ interface SalesAndPurchase {
|
|
|
2279
2931
|
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
2280
2932
|
PrefVendorRef?: PrefVendorRef;
|
|
2281
2933
|
}
|
|
2282
|
-
interface SalesAndPurchaseMod {
|
|
2934
|
+
export interface SalesAndPurchaseMod {
|
|
2283
2935
|
/** Appears in the `Description` column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes). */
|
|
2284
2936
|
SalesDesc?: string;
|
|
2285
2937
|
/** Price charged for this item. */
|
|
@@ -2301,7 +2953,7 @@ interface SalesAndPurchaseMod {
|
|
|
2301
2953
|
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
2302
2954
|
PrefVendorRef?: PrefVendorRef;
|
|
2303
2955
|
}
|
|
2304
|
-
interface SalesOrPurchase {
|
|
2956
|
+
export interface SalesOrPurchase {
|
|
2305
2957
|
/** A descriptive text field. */
|
|
2306
2958
|
Desc?: string;
|
|
2307
2959
|
/** The purchase price or sales price of this item. */
|
|
@@ -2311,7 +2963,7 @@ interface SalesOrPurchase {
|
|
|
2311
2963
|
/** 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` */
|
|
2312
2964
|
AccountRef?: AccountRef;
|
|
2313
2965
|
}
|
|
2314
|
-
interface SalesOrPurchaseMod {
|
|
2966
|
+
export interface SalesOrPurchaseMod {
|
|
2315
2967
|
/** A descriptive text field. */
|
|
2316
2968
|
Desc?: string;
|
|
2317
2969
|
/** The purchase price or sales price of this item. */
|
|
@@ -2323,27 +2975,27 @@ interface SalesOrPurchaseMod {
|
|
|
2323
2975
|
/** Used to support changing the `AccountRef` in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that `AccountRef`. Setting this to “True” should be used with caution and normally only after some user has indicated that they want those changes made to all those existing transactions! If any affected transactions are protected by a closing date and password, the `AccountRef` changes will not be made and so the Mod request will return an error without making the requested Mod. */
|
|
2324
2976
|
ApplyAccountRefToExistingTxns?: boolean;
|
|
2325
2977
|
}
|
|
2326
|
-
interface SalesRepRef {
|
|
2978
|
+
export interface SalesRepRef {
|
|
2327
2979
|
/** 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. */
|
|
2328
2980
|
ListID?: string;
|
|
2329
2981
|
/** `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. */
|
|
2330
2982
|
FullName?: string;
|
|
2331
2983
|
}
|
|
2332
|
-
interface SalesTaxCodeRef {
|
|
2984
|
+
export interface SalesTaxCodeRef {
|
|
2333
2985
|
/** 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. */
|
|
2334
2986
|
ListID?: string;
|
|
2335
2987
|
/** `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. */
|
|
2336
2988
|
FullName?: string;
|
|
2337
2989
|
}
|
|
2338
2990
|
/** @default: Canada */
|
|
2339
|
-
declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
2340
|
-
interface SalesTaxReturnRef {
|
|
2991
|
+
export declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
2992
|
+
export interface SalesTaxReturnRef {
|
|
2341
2993
|
/** 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. */
|
|
2342
2994
|
ListID?: string;
|
|
2343
2995
|
/** `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. */
|
|
2344
2996
|
FullName?: string;
|
|
2345
2997
|
}
|
|
2346
|
-
interface SecondaryContact {
|
|
2998
|
+
export interface SecondaryContact {
|
|
2347
2999
|
/** The name of the contact. */
|
|
2348
3000
|
ContactName: string;
|
|
2349
3001
|
/** The value of the contact field. */
|
|
@@ -2351,7 +3003,15 @@ interface SecondaryContact {
|
|
|
2351
3003
|
/** Relationship of emergency contact information to the employee. */
|
|
2352
3004
|
Relation?: Relation;
|
|
2353
3005
|
}
|
|
2354
|
-
interface
|
|
3006
|
+
export 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
|
+
}
|
|
3014
|
+
export interface ShipAddress {
|
|
2355
3015
|
/** The first line of an address. */
|
|
2356
3016
|
Addr1?: string;
|
|
2357
3017
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -2373,7 +3033,7 @@ interface ShipAddress {
|
|
|
2373
3033
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
2374
3034
|
Note?: string;
|
|
2375
3035
|
}
|
|
2376
|
-
interface ShipAddressBlock {
|
|
3036
|
+
export interface ShipAddressBlock {
|
|
2377
3037
|
/** The first line of an address. */
|
|
2378
3038
|
Addr1?: string;
|
|
2379
3039
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -2385,7 +3045,7 @@ interface ShipAddressBlock {
|
|
|
2385
3045
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
2386
3046
|
Addr5?: string;
|
|
2387
3047
|
}
|
|
2388
|
-
interface ShipToAddress {
|
|
3048
|
+
export interface ShipToAddress {
|
|
2389
3049
|
/** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
2390
3050
|
Name: string;
|
|
2391
3051
|
/** The first line of an address. */
|
|
@@ -2411,7 +3071,7 @@ interface ShipToAddress {
|
|
|
2411
3071
|
/** Flag that address is the default ship to address. */
|
|
2412
3072
|
DefaultShipTo?: boolean;
|
|
2413
3073
|
}
|
|
2414
|
-
interface SickHours {
|
|
3074
|
+
export interface SickHours {
|
|
2415
3075
|
/** The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. */
|
|
2416
3076
|
HoursAvailable?: string;
|
|
2417
3077
|
/** Indicates how an employee accrues time off. If you include a blank `AccrualPeriod` element in an `EmployeeMod` message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. */
|
|
@@ -2427,38 +3087,38 @@ interface SickHours {
|
|
|
2427
3087
|
/** When used in the `SickHours` or `VacationHours` aggregates, refers to the date on which sick leave or vacation hours in the current year began to accrue. */
|
|
2428
3088
|
AccrualStartDate?: string;
|
|
2429
3089
|
}
|
|
2430
|
-
declare type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
|
|
2431
|
-
interface SupervisorRef {
|
|
3090
|
+
export declare type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
|
|
3091
|
+
export interface SupervisorRef {
|
|
2432
3092
|
/** 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. */
|
|
2433
3093
|
ListID?: string;
|
|
2434
3094
|
/** `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. */
|
|
2435
3095
|
FullName?: string;
|
|
2436
3096
|
}
|
|
2437
|
-
interface TaxLineInfoRet {
|
|
3097
|
+
export interface TaxLineInfoRet {
|
|
2438
3098
|
/** An internal representation of the tax line associated with this account. */
|
|
2439
3099
|
TaxLineID: number;
|
|
2440
3100
|
/** The name of the tax line associated with this account, as it appears on the tax form. */
|
|
2441
3101
|
TaxLineName?: string;
|
|
2442
3102
|
}
|
|
2443
|
-
interface TaxOnPurchasesAccountRef {
|
|
3103
|
+
export interface TaxOnPurchasesAccountRef {
|
|
2444
3104
|
/** 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. */
|
|
2445
3105
|
ListID?: string;
|
|
2446
3106
|
/** `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. */
|
|
2447
3107
|
FullName?: string;
|
|
2448
3108
|
}
|
|
2449
|
-
interface TaxOnSalesAccountRef {
|
|
3109
|
+
export interface TaxOnSalesAccountRef {
|
|
2450
3110
|
/** 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. */
|
|
2451
3111
|
ListID?: string;
|
|
2452
3112
|
/** `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. */
|
|
2453
3113
|
FullName?: string;
|
|
2454
3114
|
}
|
|
2455
|
-
interface TermsRef {
|
|
3115
|
+
export interface TermsRef {
|
|
2456
3116
|
/** 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. */
|
|
2457
3117
|
ListID?: string;
|
|
2458
3118
|
/** `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. */
|
|
2459
3119
|
FullName?: string;
|
|
2460
3120
|
}
|
|
2461
|
-
interface TimeTrackingAdd {
|
|
3121
|
+
export interface TimeTrackingAdd {
|
|
2462
3122
|
/** 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. */
|
|
2463
3123
|
TxnDate?: string;
|
|
2464
3124
|
/** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
|
|
@@ -2491,13 +3151,13 @@ export interface TimeTrackingAddRs {
|
|
|
2491
3151
|
TimeTrackingRet?: TimeTrackingRet;
|
|
2492
3152
|
ErrorRecovery?: ErrorRecovery;
|
|
2493
3153
|
}
|
|
2494
|
-
interface TimeTrackingEntityFilter {
|
|
3154
|
+
export interface TimeTrackingEntityFilter {
|
|
2495
3155
|
/** 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`. 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. */
|
|
2496
3156
|
ListID?: string[] | string;
|
|
2497
3157
|
/** 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. */
|
|
2498
3158
|
FullName?: string[] | string;
|
|
2499
3159
|
}
|
|
2500
|
-
interface TimeTrackingMod {
|
|
3160
|
+
export interface TimeTrackingMod {
|
|
2501
3161
|
/** 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. */
|
|
2502
3162
|
TxnID: string;
|
|
2503
3163
|
/** 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. */
|
|
@@ -2547,7 +3207,7 @@ export interface TimeTrackingQueryRq {
|
|
|
2547
3207
|
export interface TimeTrackingQueryRs {
|
|
2548
3208
|
TimeTrackingRet?: TimeTrackingRet | TimeTrackingRet[];
|
|
2549
3209
|
}
|
|
2550
|
-
interface TimeTrackingRet {
|
|
3210
|
+
export interface TimeTrackingRet {
|
|
2551
3211
|
/** 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. */
|
|
2552
3212
|
TxnID: string;
|
|
2553
3213
|
/** Time the object was created. */
|
|
@@ -2583,31 +3243,39 @@ interface TimeTrackingRet {
|
|
|
2583
3243
|
/** If `IsBilled` is true, the tracked time has already been billed. */
|
|
2584
3244
|
IsBilled?: boolean;
|
|
2585
3245
|
}
|
|
2586
|
-
interface TotalBalanceFilter {
|
|
3246
|
+
export interface TotalBalanceFilter {
|
|
2587
3247
|
/** Indicates whether to filter for amounts that are less than, equal to or less than, exactly equal to, greater than, or equal to or greater than the given `Amount`. */
|
|
2588
3248
|
Operator: Operator;
|
|
2589
3249
|
/** The monetary amount to which `Operator` refers. */
|
|
2590
3250
|
Amount: string;
|
|
2591
3251
|
}
|
|
2592
|
-
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.
|
|
3252
|
+
export interface TxnDateRangeFilter {
|
|
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
|
-
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";
|
|
2601
|
-
interface UnitOfMeasureSetRef {
|
|
3268
|
+
export 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";
|
|
3269
|
+
export interface UnitOfMeasureSetRef {
|
|
2602
3270
|
/** 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. */
|
|
2603
3271
|
ListID?: string;
|
|
2604
3272
|
/** `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. */
|
|
2605
3273
|
FullName?: string;
|
|
2606
3274
|
}
|
|
2607
|
-
declare type USCitizen = "No" | "Yes";
|
|
2608
|
-
declare type UseTimeDataToCreatePaychecks = "DoNotUseTimeData" | "NotSet" | "UseTimeData";
|
|
2609
|
-
declare type USVeteran = "No" | "Yes";
|
|
2610
|
-
interface VacationHours {
|
|
3275
|
+
export declare type USCitizen = "No" | "Yes";
|
|
3276
|
+
export declare type UseTimeDataToCreatePaychecks = "DoNotUseTimeData" | "NotSet" | "UseTimeData";
|
|
3277
|
+
export declare type USVeteran = "No" | "Yes";
|
|
3278
|
+
export interface VacationHours {
|
|
2611
3279
|
/** The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. */
|
|
2612
3280
|
HoursAvailable?: string;
|
|
2613
3281
|
/** Indicates how an employee accrues time off. If you include a blank `AccrualPeriod` element in an `EmployeeMod` message, you’ll receive an error. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. */
|
|
@@ -2623,7 +3291,7 @@ interface VacationHours {
|
|
|
2623
3291
|
/** When used in the `SickHours` or `VacationHours` aggregates, refers to the date on which sick leave or vacation hours in the current year began to accrue. */
|
|
2624
3292
|
AccrualStartDate?: string;
|
|
2625
3293
|
}
|
|
2626
|
-
interface VendorAdd {
|
|
3294
|
+
export interface VendorAdd {
|
|
2627
3295
|
/** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
2628
3296
|
Name: string;
|
|
2629
3297
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -2717,7 +3385,7 @@ interface VendorAdd {
|
|
|
2717
3385
|
/** 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. */
|
|
2718
3386
|
CurrencyRef?: CurrencyRef;
|
|
2719
3387
|
}
|
|
2720
|
-
interface VendorAddress {
|
|
3388
|
+
export interface VendorAddress {
|
|
2721
3389
|
/** The first line of an address. */
|
|
2722
3390
|
Addr1?: string;
|
|
2723
3391
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -2739,7 +3407,7 @@ interface VendorAddress {
|
|
|
2739
3407
|
/** In a `BillAddress` or `ShipAddress` aggregate, the `Note` field value is written at the bottom of the address in the form in which it appears, such as the invoice form. */
|
|
2740
3408
|
Note?: string;
|
|
2741
3409
|
}
|
|
2742
|
-
interface VendorAddressBlock {
|
|
3410
|
+
export interface VendorAddressBlock {
|
|
2743
3411
|
/** The first line of an address. */
|
|
2744
3412
|
Addr1?: string;
|
|
2745
3413
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -2760,7 +3428,7 @@ export interface VendorAddRs {
|
|
|
2760
3428
|
VendorRet?: VendorRet;
|
|
2761
3429
|
ErrorRecovery?: ErrorRecovery;
|
|
2762
3430
|
}
|
|
2763
|
-
interface VendorMod {
|
|
3431
|
+
export interface VendorMod {
|
|
2764
3432
|
/** 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. */
|
|
2765
3433
|
ListID: string;
|
|
2766
3434
|
/** 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. */
|
|
@@ -2892,7 +3560,13 @@ export interface VendorQueryRq {
|
|
|
2892
3560
|
export interface VendorQueryRs {
|
|
2893
3561
|
VendorRet?: VendorRet | VendorRet[];
|
|
2894
3562
|
}
|
|
2895
|
-
interface
|
|
3563
|
+
export 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
|
+
}
|
|
3569
|
+
export 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;
|
|
2898
3572
|
/** Time the object was created. */
|
|
@@ -2998,10 +3672,9 @@ interface VendorRet {
|
|
|
2998
3672
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2999
3673
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
3000
3674
|
}
|
|
3001
|
-
interface VendorTypeRef {
|
|
3675
|
+
export interface VendorTypeRef {
|
|
3002
3676
|
/** 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. */
|
|
3003
3677
|
ListID?: string;
|
|
3004
3678
|
/** `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. */
|
|
3005
3679
|
FullName?: string;
|
|
3006
3680
|
}
|
|
3007
|
-
export {};
|