conductor-node 3.3.0 → 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/__tests__/ClientQbd.test.js +14 -10
- package/dist/src/qbd/qbdTypes.d.ts +172 -173
- 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,7 +47,7 @@ export interface AccountAddRs {
|
|
|
47
47
|
AccountRet?: AccountRet;
|
|
48
48
|
ErrorRecovery?: ErrorRecovery;
|
|
49
49
|
}
|
|
50
|
-
interface AccountFilter {
|
|
50
|
+
export interface AccountFilter {
|
|
51
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
52
|
|
|
53
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. */
|
|
@@ -59,7 +59,7 @@ interface AccountFilter {
|
|
|
59
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`. */
|
|
60
60
|
FullNameWithChildren?: string;
|
|
61
61
|
}
|
|
62
|
-
interface AccountMod {
|
|
62
|
+
export interface AccountMod {
|
|
63
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. */
|
|
64
64
|
ListID: string;
|
|
65
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. */
|
|
@@ -163,13 +163,13 @@ export interface AccountQueryRq {
|
|
|
163
163
|
export interface AccountQueryRs {
|
|
164
164
|
AccountRet?: AccountRet | AccountRet[];
|
|
165
165
|
}
|
|
166
|
-
interface AccountRef {
|
|
166
|
+
export interface AccountRef {
|
|
167
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. */
|
|
168
168
|
ListID?: string;
|
|
169
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. */
|
|
170
170
|
FullName?: string;
|
|
171
171
|
}
|
|
172
|
-
interface AccountRet {
|
|
172
|
+
export interface AccountRet {
|
|
173
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. */
|
|
174
174
|
ListID: string;
|
|
175
175
|
/** Time the object was created. */
|
|
@@ -225,27 +225,27 @@ interface AccountRet {
|
|
|
225
225
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
226
226
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
227
227
|
}
|
|
228
|
-
declare type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
|
|
229
|
-
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";
|
|
230
230
|
/** @default: ActiveOnly */
|
|
231
|
-
declare type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
|
|
232
|
-
interface AdditionalContactRef {
|
|
231
|
+
export declare type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
|
|
232
|
+
export interface AdditionalContactRef {
|
|
233
233
|
/** The name of the contact. */
|
|
234
234
|
ContactName: string;
|
|
235
235
|
/** The value of the contact field. */
|
|
236
236
|
ContactValue: string;
|
|
237
237
|
}
|
|
238
|
-
interface AdditionalNotes {
|
|
238
|
+
export interface AdditionalNotes {
|
|
239
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. */
|
|
240
240
|
Note: string;
|
|
241
241
|
}
|
|
242
|
-
interface AdditionalNotesMod {
|
|
242
|
+
export interface AdditionalNotesMod {
|
|
243
243
|
/** The ID of the note. */
|
|
244
244
|
NoteID: number;
|
|
245
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. */
|
|
246
246
|
Note: string;
|
|
247
247
|
}
|
|
248
|
-
interface AdditionalNotesRet {
|
|
248
|
+
export interface AdditionalNotesRet {
|
|
249
249
|
/** The ID of the note. */
|
|
250
250
|
NoteID: number;
|
|
251
251
|
/** The date the note was updated. */
|
|
@@ -253,7 +253,7 @@ interface AdditionalNotesRet {
|
|
|
253
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. */
|
|
254
254
|
Note: string;
|
|
255
255
|
}
|
|
256
|
-
interface Address {
|
|
256
|
+
export interface Address {
|
|
257
257
|
/** The first line of an address. */
|
|
258
258
|
Addr1?: string;
|
|
259
259
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -275,7 +275,7 @@ interface Address {
|
|
|
275
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. */
|
|
276
276
|
Note?: string;
|
|
277
277
|
}
|
|
278
|
-
interface AddressBlock {
|
|
278
|
+
export interface AddressBlock {
|
|
279
279
|
/** The first line of an address. */
|
|
280
280
|
Addr1?: string;
|
|
281
281
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -287,13 +287,13 @@ interface AddressBlock {
|
|
|
287
287
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
288
288
|
Addr5?: string;
|
|
289
289
|
}
|
|
290
|
-
interface APAccountRef {
|
|
290
|
+
export interface APAccountRef {
|
|
291
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
292
|
ListID?: string;
|
|
293
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
294
|
FullName?: string;
|
|
295
295
|
}
|
|
296
|
-
interface AppliedToTxnAdd {
|
|
296
|
+
export interface AppliedToTxnAdd {
|
|
297
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
298
|
TxnID: string;
|
|
299
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`. */
|
|
@@ -307,7 +307,7 @@ interface AppliedToTxnAdd {
|
|
|
307
307
|
/** Class reference used in the Discount object */
|
|
308
308
|
DiscountClassRef?: DiscountClassRef;
|
|
309
309
|
}
|
|
310
|
-
interface AppliedToTxnMod {
|
|
310
|
+
export interface AppliedToTxnMod {
|
|
311
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
312
|
TxnID: string;
|
|
313
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`. */
|
|
@@ -321,7 +321,7 @@ interface AppliedToTxnMod {
|
|
|
321
321
|
/** Class reference used in the Discount object */
|
|
322
322
|
DiscountClassRef?: DiscountClassRef;
|
|
323
323
|
}
|
|
324
|
-
interface AppliedToTxnRet {
|
|
324
|
+
export interface AppliedToTxnRet {
|
|
325
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
326
|
TxnID: string;
|
|
327
327
|
/** The type of transaction. */
|
|
@@ -343,25 +343,25 @@ interface AppliedToTxnRet {
|
|
|
343
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
344
|
LinkedTxn?: LinkedTxn | LinkedTxn[];
|
|
345
345
|
}
|
|
346
|
-
interface ApplyCheckToTxnAdd {
|
|
346
|
+
export interface ApplyCheckToTxnAdd {
|
|
347
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. */
|
|
348
348
|
TxnID: string;
|
|
349
349
|
/** A monetary amount. */
|
|
350
350
|
Amount?: string;
|
|
351
351
|
}
|
|
352
|
-
interface ApplyCheckToTxnMod {
|
|
352
|
+
export interface ApplyCheckToTxnMod {
|
|
353
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. */
|
|
354
354
|
TxnID: string;
|
|
355
355
|
/** A monetary amount. */
|
|
356
356
|
Amount?: string;
|
|
357
357
|
}
|
|
358
|
-
interface BankAccountRef {
|
|
358
|
+
export interface BankAccountRef {
|
|
359
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
360
|
ListID?: string;
|
|
361
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
362
|
FullName?: string;
|
|
363
363
|
}
|
|
364
|
-
interface BarCode {
|
|
364
|
+
export interface BarCode {
|
|
365
365
|
/** Value of the barcode in the item. */
|
|
366
366
|
BarCodeValue?: string;
|
|
367
367
|
/** Allow barcode to be assigned to item, even if already in use. */
|
|
@@ -369,8 +369,8 @@ interface BarCode {
|
|
|
369
369
|
/** Allows for barcode to be overridden for an item. */
|
|
370
370
|
AllowOverride?: boolean;
|
|
371
371
|
}
|
|
372
|
-
declare type BillableStatus = "Billable" | "HasBeenBilled" | "NotBillable";
|
|
373
|
-
interface BillAdd {
|
|
372
|
+
export declare type BillableStatus = "Billable" | "HasBeenBilled" | "NotBillable";
|
|
373
|
+
export interface BillAdd {
|
|
374
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
375
|
VendorRef: VendorRef;
|
|
376
376
|
/** If an address request fails, some combination of address fields might be too long. */
|
|
@@ -414,7 +414,7 @@ interface BillAdd {
|
|
|
414
414
|
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
415
415
|
ItemGroupLineAdd?: ItemGroupLineAdd;
|
|
416
416
|
}
|
|
417
|
-
interface BillAddress {
|
|
417
|
+
export interface BillAddress {
|
|
418
418
|
/** The first line of an address. */
|
|
419
419
|
Addr1?: string;
|
|
420
420
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -436,7 +436,7 @@ interface BillAddress {
|
|
|
436
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. */
|
|
437
437
|
Note?: string;
|
|
438
438
|
}
|
|
439
|
-
interface BillAddressBlock {
|
|
439
|
+
export interface BillAddressBlock {
|
|
440
440
|
/** The first line of an address. */
|
|
441
441
|
Addr1?: string;
|
|
442
442
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -459,13 +459,13 @@ export interface BillAddRs {
|
|
|
459
459
|
BillRet?: BillRet;
|
|
460
460
|
ErrorRecovery?: ErrorRecovery;
|
|
461
461
|
}
|
|
462
|
-
interface BillingRateRef {
|
|
462
|
+
export interface BillingRateRef {
|
|
463
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. */
|
|
464
464
|
ListID?: string;
|
|
465
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. */
|
|
466
466
|
FullName?: string;
|
|
467
467
|
}
|
|
468
|
-
interface BillMod {
|
|
468
|
+
export interface BillMod {
|
|
469
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
470
|
|
|
471
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. */
|
|
@@ -530,7 +530,7 @@ export interface BillModRs {
|
|
|
530
530
|
BillRet?: BillRet;
|
|
531
531
|
ErrorRecovery?: ErrorRecovery;
|
|
532
532
|
}
|
|
533
|
-
interface BillPaymentCheckAdd {
|
|
533
|
+
export interface BillPaymentCheckAdd {
|
|
534
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
535
|
PayeeEntityRef: PayeeEntityRef;
|
|
536
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. */
|
|
@@ -561,7 +561,7 @@ export interface BillPaymentCheckAddRs {
|
|
|
561
561
|
BillPaymentCheckRet?: BillPaymentCheckRet;
|
|
562
562
|
ErrorRecovery?: ErrorRecovery;
|
|
563
563
|
}
|
|
564
|
-
interface BillPaymentCheckMod {
|
|
564
|
+
export interface BillPaymentCheckMod {
|
|
565
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
566
|
TxnID: string;
|
|
567
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. */
|
|
@@ -625,7 +625,7 @@ export interface BillPaymentCheckQueryRq {
|
|
|
625
625
|
export interface BillPaymentCheckQueryRs {
|
|
626
626
|
BillPaymentCheckRet?: BillPaymentCheckRet | BillPaymentCheckRet[];
|
|
627
627
|
}
|
|
628
|
-
interface BillPaymentCheckRet {
|
|
628
|
+
export interface BillPaymentCheckRet {
|
|
629
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
630
|
TxnID?: string;
|
|
631
631
|
/** Time the object was created. */
|
|
@@ -732,7 +732,7 @@ export interface BillQueryRq {
|
|
|
732
732
|
export interface BillQueryRs {
|
|
733
733
|
BillRet?: BillRet | BillRet[];
|
|
734
734
|
}
|
|
735
|
-
interface BillRet {
|
|
735
|
+
export interface BillRet {
|
|
736
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
737
|
|
|
738
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. */
|
|
@@ -806,8 +806,8 @@ interface BillRet {
|
|
|
806
806
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
807
807
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
808
808
|
}
|
|
809
|
-
declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
|
|
810
|
-
interface CheckAdd {
|
|
809
|
+
export declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
|
|
810
|
+
export interface CheckAdd {
|
|
811
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` */
|
|
812
812
|
AccountRef: AccountRef;
|
|
813
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.) */
|
|
@@ -848,7 +848,7 @@ export interface CheckAddRs {
|
|
|
848
848
|
CheckRet?: CheckRet;
|
|
849
849
|
ErrorRecovery?: ErrorRecovery;
|
|
850
850
|
}
|
|
851
|
-
interface CheckMod {
|
|
851
|
+
export interface CheckMod {
|
|
852
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. */
|
|
853
853
|
TxnID: string;
|
|
854
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. */
|
|
@@ -930,7 +930,7 @@ export interface CheckQueryRq {
|
|
|
930
930
|
export interface CheckQueryRs {
|
|
931
931
|
CheckRet?: CheckRet | CheckRet[];
|
|
932
932
|
}
|
|
933
|
-
interface CheckRet {
|
|
933
|
+
export interface CheckRet {
|
|
934
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. */
|
|
935
935
|
TxnID: string;
|
|
936
936
|
/** Time the object was created. */
|
|
@@ -982,7 +982,7 @@ interface CheckRet {
|
|
|
982
982
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
983
983
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
984
984
|
}
|
|
985
|
-
interface ClassAdd {
|
|
985
|
+
export interface ClassAdd {
|
|
986
986
|
/** The case-insensitive name of the class, not including the names of its ancestors. */
|
|
987
987
|
Name: string;
|
|
988
988
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -999,7 +999,7 @@ export interface ClassAddRs {
|
|
|
999
999
|
ClassRet?: ClassRet;
|
|
1000
1000
|
ErrorRecovery?: ErrorRecovery;
|
|
1001
1001
|
}
|
|
1002
|
-
interface ClassFilter {
|
|
1002
|
+
export interface ClassFilter {
|
|
1003
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. */
|
|
1004
1004
|
ListID?: string[] | string;
|
|
1005
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. */
|
|
@@ -1009,7 +1009,7 @@ interface ClassFilter {
|
|
|
1009
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`. */
|
|
1010
1010
|
FullNameWithChildren?: string;
|
|
1011
1011
|
}
|
|
1012
|
-
interface ClassMod {
|
|
1012
|
+
export interface ClassMod {
|
|
1013
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. */
|
|
1014
1014
|
ListID: string;
|
|
1015
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. */
|
|
@@ -1053,13 +1053,13 @@ export interface ClassQueryRq {
|
|
|
1053
1053
|
export interface ClassQueryRs {
|
|
1054
1054
|
ClassRet?: ClassRet | ClassRet[];
|
|
1055
1055
|
}
|
|
1056
|
-
interface ClassRef {
|
|
1056
|
+
export interface ClassRef {
|
|
1057
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. */
|
|
1058
1058
|
ListID?: string;
|
|
1059
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. */
|
|
1060
1060
|
FullName?: string;
|
|
1061
1061
|
}
|
|
1062
|
-
interface ClassRet {
|
|
1062
|
+
export interface ClassRet {
|
|
1063
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. */
|
|
1064
1064
|
ListID: string;
|
|
1065
1065
|
/** Time the object was created. */
|
|
@@ -1079,7 +1079,7 @@ interface ClassRet {
|
|
|
1079
1079
|
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
1080
1080
|
Sublevel: number;
|
|
1081
1081
|
}
|
|
1082
|
-
interface Contacts {
|
|
1082
|
+
export interface Contacts {
|
|
1083
1083
|
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
1084
1084
|
Salutation?: string;
|
|
1085
1085
|
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
@@ -1093,7 +1093,7 @@ interface Contacts {
|
|
|
1093
1093
|
/** List of additional contacts. */
|
|
1094
1094
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
1095
1095
|
}
|
|
1096
|
-
interface ContactsMod {
|
|
1096
|
+
export interface ContactsMod {
|
|
1097
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. */
|
|
1098
1098
|
ListID: string;
|
|
1099
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. */
|
|
@@ -1111,7 +1111,7 @@ interface ContactsMod {
|
|
|
1111
1111
|
/** List of additional contacts. */
|
|
1112
1112
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
1113
1113
|
}
|
|
1114
|
-
interface ContactsRet {
|
|
1114
|
+
export interface ContactsRet {
|
|
1115
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. */
|
|
1116
1116
|
ListID: string;
|
|
1117
1117
|
/** Time the object was created. */
|
|
@@ -1135,7 +1135,7 @@ interface ContactsRet {
|
|
|
1135
1135
|
/** List of additional contacts. */
|
|
1136
1136
|
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
1137
1137
|
}
|
|
1138
|
-
interface CreditCardInfo {
|
|
1138
|
+
export interface CreditCardInfo {
|
|
1139
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. */
|
|
1140
1140
|
CreditCardNumber?: string;
|
|
1141
1141
|
/** The month when the credit card expires. */
|
|
@@ -1149,7 +1149,7 @@ interface CreditCardInfo {
|
|
|
1149
1149
|
/** The postal code associated with the address for this credit card. */
|
|
1150
1150
|
CreditCardPostalCode?: string;
|
|
1151
1151
|
}
|
|
1152
|
-
interface CurrencyFilter {
|
|
1152
|
+
export interface CurrencyFilter {
|
|
1153
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`.
|
|
1154
1154
|
|
|
1155
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. */
|
|
@@ -1157,13 +1157,13 @@ interface CurrencyFilter {
|
|
|
1157
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. */
|
|
1158
1158
|
FullName?: string[] | string;
|
|
1159
1159
|
}
|
|
1160
|
-
interface CurrencyRef {
|
|
1160
|
+
export interface CurrencyRef {
|
|
1161
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. */
|
|
1162
1162
|
ListID?: string;
|
|
1163
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. */
|
|
1164
1164
|
FullName?: string;
|
|
1165
1165
|
}
|
|
1166
|
-
interface CustomerAdd {
|
|
1166
|
+
export interface CustomerAdd {
|
|
1167
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. */
|
|
1168
1168
|
Name: string;
|
|
1169
1169
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -1270,7 +1270,7 @@ export interface CustomerAddRs {
|
|
|
1270
1270
|
CustomerRet?: CustomerRet;
|
|
1271
1271
|
ErrorRecovery?: ErrorRecovery;
|
|
1272
1272
|
}
|
|
1273
|
-
interface CustomerMod {
|
|
1273
|
+
export interface CustomerMod {
|
|
1274
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. */
|
|
1275
1275
|
ListID: string;
|
|
1276
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. */
|
|
@@ -1406,13 +1406,13 @@ export interface CustomerQueryRq {
|
|
|
1406
1406
|
export interface CustomerQueryRs {
|
|
1407
1407
|
CustomerRet?: CustomerRet | CustomerRet[];
|
|
1408
1408
|
}
|
|
1409
|
-
interface CustomerRef {
|
|
1409
|
+
export interface CustomerRef {
|
|
1410
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. */
|
|
1411
1411
|
ListID?: string;
|
|
1412
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. */
|
|
1413
1413
|
FullName?: string;
|
|
1414
1414
|
}
|
|
1415
|
-
interface CustomerRet {
|
|
1415
|
+
export interface CustomerRet {
|
|
1416
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. */
|
|
1417
1417
|
ListID: string;
|
|
1418
1418
|
/** Time the object was created. */
|
|
@@ -1528,13 +1528,13 @@ interface CustomerRet {
|
|
|
1528
1528
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
1529
1529
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1530
1530
|
}
|
|
1531
|
-
interface CustomerTypeRef {
|
|
1531
|
+
export interface CustomerTypeRef {
|
|
1532
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. */
|
|
1533
1533
|
ListID?: string;
|
|
1534
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. */
|
|
1535
1535
|
FullName?: string;
|
|
1536
1536
|
}
|
|
1537
|
-
interface DataExt {
|
|
1537
|
+
export interface DataExt {
|
|
1538
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
1539
|
|
|
1540
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.)
|
|
@@ -1546,7 +1546,7 @@ interface DataExt {
|
|
|
1546
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`. */
|
|
1547
1547
|
DataExtValue: string;
|
|
1548
1548
|
}
|
|
1549
|
-
interface DataExtRet {
|
|
1549
|
+
export interface DataExtRet {
|
|
1550
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. )
|
|
1551
1551
|
|
|
1552
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.)
|
|
@@ -1560,22 +1560,22 @@ interface DataExtRet {
|
|
|
1560
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`. */
|
|
1561
1561
|
DataExtValue: string;
|
|
1562
1562
|
}
|
|
1563
|
-
declare type DataExtType = "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
|
|
1564
|
-
declare type DateMacro = "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
|
|
1565
|
-
declare type Disabled = "No" | "Yes";
|
|
1566
|
-
interface DiscountAccountRef {
|
|
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
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
1568
|
ListID?: string;
|
|
1569
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
1570
|
FullName?: string;
|
|
1571
1571
|
}
|
|
1572
|
-
interface DiscountClassRef {
|
|
1572
|
+
export interface DiscountClassRef {
|
|
1573
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
1574
|
ListID?: string;
|
|
1575
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
1576
|
FullName?: string;
|
|
1577
1577
|
}
|
|
1578
|
-
interface Earnings {
|
|
1578
|
+
export interface Earnings {
|
|
1579
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. */
|
|
1580
1580
|
PayrollItemWageRef: PayrollItemWageRef;
|
|
1581
1581
|
/** Indicates the price of something. */
|
|
@@ -1583,13 +1583,13 @@ interface Earnings {
|
|
|
1583
1583
|
/** Indicates the price of something as a percent. */
|
|
1584
1584
|
RatePercent?: string;
|
|
1585
1585
|
}
|
|
1586
|
-
interface EmergencyContacts {
|
|
1586
|
+
export interface EmergencyContacts {
|
|
1587
1587
|
/** Primary emergency contact information for the employee. */
|
|
1588
1588
|
PrimaryContact?: PrimaryContact;
|
|
1589
1589
|
/** Secondary emergency contact information for the employee. */
|
|
1590
1590
|
SecondaryContact?: SecondaryContact;
|
|
1591
1591
|
}
|
|
1592
|
-
interface EmployeeAdd {
|
|
1592
|
+
export interface EmployeeAdd {
|
|
1593
1593
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
1594
1594
|
IsActive?: boolean;
|
|
1595
1595
|
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
@@ -1683,7 +1683,7 @@ interface EmployeeAdd {
|
|
|
1683
1683
|
/** Allows for the attachment of a user defined GUID value. */
|
|
1684
1684
|
ExternalGUID?: string;
|
|
1685
1685
|
}
|
|
1686
|
-
interface EmployeeAddress {
|
|
1686
|
+
export interface EmployeeAddress {
|
|
1687
1687
|
/** The first line of an address. */
|
|
1688
1688
|
Addr1?: string;
|
|
1689
1689
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -1704,7 +1704,7 @@ export interface EmployeeAddRs {
|
|
|
1704
1704
|
EmployeeRet?: EmployeeRet;
|
|
1705
1705
|
ErrorRecovery?: ErrorRecovery;
|
|
1706
1706
|
}
|
|
1707
|
-
interface EmployeeMod {
|
|
1707
|
+
export interface EmployeeMod {
|
|
1708
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. */
|
|
1709
1709
|
ListID: string;
|
|
1710
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. */
|
|
@@ -1805,7 +1805,7 @@ export interface EmployeeModRs {
|
|
|
1805
1805
|
EmployeeRet?: EmployeeRet;
|
|
1806
1806
|
ErrorRecovery?: ErrorRecovery;
|
|
1807
1807
|
}
|
|
1808
|
-
interface EmployeePayrollInfo {
|
|
1808
|
+
export interface EmployeePayrollInfo {
|
|
1809
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. */
|
|
1810
1810
|
PayPeriod?: PayPeriod;
|
|
1811
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. */
|
|
@@ -1823,7 +1823,7 @@ interface EmployeePayrollInfo {
|
|
|
1823
1823
|
/** Describes how vacation time is accrued for this employee, along with how many vacation hours the employee has accrued. */
|
|
1824
1824
|
VacationHours?: VacationHours;
|
|
1825
1825
|
}
|
|
1826
|
-
interface EmployeePayrollInfoMod {
|
|
1826
|
+
export interface EmployeePayrollInfoMod {
|
|
1827
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. */
|
|
1828
1828
|
PayPeriod?: PayPeriod;
|
|
1829
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. */
|
|
@@ -1866,7 +1866,7 @@ export interface EmployeeQueryRq {
|
|
|
1866
1866
|
export interface EmployeeQueryRs {
|
|
1867
1867
|
EmployeeRet?: EmployeeRet | EmployeeRet[];
|
|
1868
1868
|
}
|
|
1869
|
-
interface EmployeeRet {
|
|
1869
|
+
export interface EmployeeRet {
|
|
1870
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. */
|
|
1871
1871
|
ListID: string;
|
|
1872
1872
|
/** Time the object was created. */
|
|
@@ -1973,8 +1973,8 @@ interface EmployeeRet {
|
|
|
1973
1973
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
1974
1974
|
}
|
|
1975
1975
|
/** @default: Regular */
|
|
1976
|
-
declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
|
|
1977
|
-
interface EntityFilter {
|
|
1976
|
+
export declare type EmployeeType = "Officer" | "Owner" | "Regular" | "Statutory";
|
|
1977
|
+
export interface EntityFilter {
|
|
1978
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
1979
|
|
|
1980
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. */
|
|
@@ -1986,13 +1986,13 @@ interface EntityFilter {
|
|
|
1986
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`. */
|
|
1987
1987
|
FullNameWithChildren?: string;
|
|
1988
1988
|
}
|
|
1989
|
-
interface EntityRef {
|
|
1989
|
+
export interface EntityRef {
|
|
1990
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. */
|
|
1991
1991
|
ListID?: string;
|
|
1992
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. */
|
|
1993
1993
|
FullName?: string;
|
|
1994
1994
|
}
|
|
1995
|
-
interface ErrorRecovery {
|
|
1995
|
+
export interface ErrorRecovery {
|
|
1996
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. */
|
|
1997
1997
|
ListID?: string;
|
|
1998
1998
|
/** Refers to the owner of a data extension:
|
|
@@ -2014,15 +2014,15 @@ interface ErrorRecovery {
|
|
|
2014
2014
|
/** Allows for the attachment of a user defined GUID value. */
|
|
2015
2015
|
ExternalGUID?: string;
|
|
2016
2016
|
}
|
|
2017
|
-
declare type Ethnicity = "AmericianIndian" | "Asian" | "Black" | "Hawaiian" | "Hispanic" | "TwoOrMoreRaces" | "White";
|
|
2018
|
-
declare type Exempt = "Exempt" | "NonExempt";
|
|
2019
|
-
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 {
|
|
2020
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. */
|
|
2021
2021
|
ListID?: string;
|
|
2022
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. */
|
|
2023
2023
|
FullName?: string;
|
|
2024
2024
|
}
|
|
2025
|
-
interface ExpenseLineAdd {
|
|
2025
|
+
export interface ExpenseLineAdd {
|
|
2026
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
2027
|
|
|
2028
2028
|
Special cases to note:
|
|
@@ -2068,7 +2068,7 @@ interface ExpenseLineAdd {
|
|
|
2068
2068
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2069
2069
|
DataExt?: DataExt | DataExt[];
|
|
2070
2070
|
}
|
|
2071
|
-
interface ExpenseLineMod {
|
|
2071
|
+
export interface ExpenseLineMod {
|
|
2072
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
2073
|
|
|
2074
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. */
|
|
@@ -2120,7 +2120,7 @@ interface ExpenseLineMod {
|
|
|
2120
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. */
|
|
2121
2121
|
SalesRepRef?: SalesRepRef;
|
|
2122
2122
|
}
|
|
2123
|
-
interface ExpenseLineRet {
|
|
2123
|
+
export interface ExpenseLineRet {
|
|
2124
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
2125
|
|
|
2126
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. */
|
|
@@ -2174,26 +2174,26 @@ interface ExpenseLineRet {
|
|
|
2174
2174
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2175
2175
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2176
2176
|
}
|
|
2177
|
-
declare type Gender = "Female" | "Male";
|
|
2178
|
-
interface IncomeAccountRef {
|
|
2177
|
+
export declare type Gender = "Female" | "Male";
|
|
2178
|
+
export interface IncomeAccountRef {
|
|
2179
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. */
|
|
2180
2180
|
ListID?: string;
|
|
2181
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. */
|
|
2182
2182
|
FullName?: string;
|
|
2183
2183
|
}
|
|
2184
|
-
interface InventorySiteLocationRef {
|
|
2184
|
+
export interface InventorySiteLocationRef {
|
|
2185
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. */
|
|
2186
2186
|
ListID?: string;
|
|
2187
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. */
|
|
2188
2188
|
FullName?: string;
|
|
2189
2189
|
}
|
|
2190
|
-
interface InventorySiteRef {
|
|
2190
|
+
export interface InventorySiteRef {
|
|
2191
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. */
|
|
2192
2192
|
ListID?: string;
|
|
2193
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. */
|
|
2194
2194
|
FullName?: string;
|
|
2195
2195
|
}
|
|
2196
|
-
interface ItemGroupLineAdd {
|
|
2196
|
+
export interface ItemGroupLineAdd {
|
|
2197
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. */
|
|
2198
2198
|
ItemGroupRef: ItemGroupRef;
|
|
2199
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. */
|
|
@@ -2207,7 +2207,7 @@ interface ItemGroupLineAdd {
|
|
|
2207
2207
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2208
2208
|
DataExt?: DataExt | DataExt[];
|
|
2209
2209
|
}
|
|
2210
|
-
interface ItemGroupLineMod {
|
|
2210
|
+
export interface ItemGroupLineMod {
|
|
2211
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
2212
|
|
|
2213
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. */
|
|
@@ -2223,7 +2223,7 @@ interface ItemGroupLineMod {
|
|
|
2223
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.” */
|
|
2224
2224
|
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
2225
2225
|
}
|
|
2226
|
-
interface ItemGroupLineRet {
|
|
2226
|
+
export interface ItemGroupLineRet {
|
|
2227
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
2228
|
|
|
2229
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. */
|
|
@@ -2245,13 +2245,13 @@ interface ItemGroupLineRet {
|
|
|
2245
2245
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2246
2246
|
DataExt?: DataExt | DataExt[];
|
|
2247
2247
|
}
|
|
2248
|
-
interface ItemGroupRef {
|
|
2248
|
+
export interface ItemGroupRef {
|
|
2249
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. */
|
|
2250
2250
|
ListID?: string;
|
|
2251
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. */
|
|
2252
2252
|
FullName?: string;
|
|
2253
2253
|
}
|
|
2254
|
-
interface ItemLineAdd {
|
|
2254
|
+
export interface ItemLineAdd {
|
|
2255
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
2256
|
|
|
2257
2257
|
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
@@ -2301,7 +2301,7 @@ interface ItemLineAdd {
|
|
|
2301
2301
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2302
2302
|
DataExt?: DataExt | DataExt[];
|
|
2303
2303
|
}
|
|
2304
|
-
interface ItemLineMod {
|
|
2304
|
+
export interface ItemLineMod {
|
|
2305
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
2306
|
|
|
2307
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. */
|
|
@@ -2355,7 +2355,7 @@ interface ItemLineMod {
|
|
|
2355
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. */
|
|
2356
2356
|
SalesRepRef?: SalesRepRef;
|
|
2357
2357
|
}
|
|
2358
|
-
interface ItemLineRet {
|
|
2358
|
+
export interface ItemLineRet {
|
|
2359
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
2360
|
|
|
2361
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. */
|
|
@@ -2409,19 +2409,19 @@ interface ItemLineRet {
|
|
|
2409
2409
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2410
2410
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2411
2411
|
}
|
|
2412
|
-
interface ItemRef {
|
|
2412
|
+
export interface ItemRef {
|
|
2413
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. */
|
|
2414
2414
|
ListID?: string;
|
|
2415
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. */
|
|
2416
2416
|
FullName?: string;
|
|
2417
2417
|
}
|
|
2418
|
-
interface ItemSalesTaxRef {
|
|
2418
|
+
export interface ItemSalesTaxRef {
|
|
2419
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. */
|
|
2420
2420
|
ListID?: string;
|
|
2421
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. */
|
|
2422
2422
|
FullName?: string;
|
|
2423
2423
|
}
|
|
2424
|
-
interface ItemServiceAdd {
|
|
2424
|
+
export interface ItemServiceAdd {
|
|
2425
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. */
|
|
2426
2426
|
Name: string;
|
|
2427
2427
|
/** Barcode reference information. */
|
|
@@ -2454,7 +2454,7 @@ export interface ItemServiceAddRs {
|
|
|
2454
2454
|
ItemServiceRet?: ItemServiceRet;
|
|
2455
2455
|
ErrorRecovery?: ErrorRecovery;
|
|
2456
2456
|
}
|
|
2457
|
-
interface ItemServiceMod {
|
|
2457
|
+
export interface ItemServiceMod {
|
|
2458
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. */
|
|
2459
2459
|
ListID: string;
|
|
2460
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. */
|
|
@@ -2518,13 +2518,13 @@ export interface ItemServiceQueryRq {
|
|
|
2518
2518
|
export interface ItemServiceQueryRs {
|
|
2519
2519
|
ItemServiceRet?: ItemServiceRet | ItemServiceRet[];
|
|
2520
2520
|
}
|
|
2521
|
-
interface ItemServiceRef {
|
|
2521
|
+
export interface ItemServiceRef {
|
|
2522
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. */
|
|
2523
2523
|
ListID?: string;
|
|
2524
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. */
|
|
2525
2525
|
FullName?: string;
|
|
2526
2526
|
}
|
|
2527
|
-
interface ItemServiceRet {
|
|
2527
|
+
export interface ItemServiceRet {
|
|
2528
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. */
|
|
2529
2529
|
ListID: string;
|
|
2530
2530
|
/** Time the object was created. */
|
|
@@ -2563,14 +2563,14 @@ interface ItemServiceRet {
|
|
|
2563
2563
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2564
2564
|
}
|
|
2565
2565
|
/** @default: None */
|
|
2566
|
-
declare type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
|
|
2567
|
-
interface JobTypeRef {
|
|
2566
|
+
export declare type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
|
|
2567
|
+
export interface JobTypeRef {
|
|
2568
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. */
|
|
2569
2569
|
ListID?: string;
|
|
2570
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. */
|
|
2571
2571
|
FullName?: string;
|
|
2572
2572
|
}
|
|
2573
|
-
interface JournalCreditLine {
|
|
2573
|
+
export interface JournalCreditLine {
|
|
2574
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. */
|
|
2575
2575
|
TxnLineID?: string;
|
|
2576
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` */
|
|
@@ -2588,7 +2588,7 @@ interface JournalCreditLine {
|
|
|
2588
2588
|
/** The billing status of this item line or expense line. */
|
|
2589
2589
|
BillableStatus?: BillableStatus;
|
|
2590
2590
|
}
|
|
2591
|
-
interface JournalDebitLine {
|
|
2591
|
+
export interface JournalDebitLine {
|
|
2592
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. */
|
|
2593
2593
|
TxnLineID?: string;
|
|
2594
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` */
|
|
@@ -2606,7 +2606,7 @@ interface JournalDebitLine {
|
|
|
2606
2606
|
/** The billing status of this item line or expense line. */
|
|
2607
2607
|
BillableStatus?: BillableStatus;
|
|
2608
2608
|
}
|
|
2609
|
-
interface JournalEntryAdd {
|
|
2609
|
+
export interface JournalEntryAdd {
|
|
2610
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. */
|
|
2611
2611
|
TxnDate?: string;
|
|
2612
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. */
|
|
@@ -2637,7 +2637,7 @@ export interface JournalEntryAddRs {
|
|
|
2637
2637
|
JournalEntryRet?: JournalEntryRet;
|
|
2638
2638
|
ErrorRecovery?: ErrorRecovery;
|
|
2639
2639
|
}
|
|
2640
|
-
interface JournalEntryMod {
|
|
2640
|
+
export interface JournalEntryMod {
|
|
2641
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. */
|
|
2642
2642
|
TxnID: string;
|
|
2643
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. */
|
|
@@ -2699,7 +2699,7 @@ export interface JournalEntryQueryRq {
|
|
|
2699
2699
|
export interface JournalEntryQueryRs {
|
|
2700
2700
|
JournalEntryRet?: JournalEntryRet | JournalEntryRet[];
|
|
2701
2701
|
}
|
|
2702
|
-
interface JournalEntryRet {
|
|
2702
|
+
export interface JournalEntryRet {
|
|
2703
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. */
|
|
2704
2704
|
TxnID: string;
|
|
2705
2705
|
/** Time the object was created. */
|
|
@@ -2733,7 +2733,7 @@ interface JournalEntryRet {
|
|
|
2733
2733
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2734
2734
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2735
2735
|
}
|
|
2736
|
-
interface JournalLineMod {
|
|
2736
|
+
export interface JournalLineMod {
|
|
2737
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. */
|
|
2738
2738
|
TxnLineID: string;
|
|
2739
2739
|
/** The type of journal line (debit or credit). */
|
|
@@ -2753,9 +2753,9 @@ interface JournalLineMod {
|
|
|
2753
2753
|
/** The billing status of this item line or expense line. */
|
|
2754
2754
|
BillableStatus?: BillableStatus;
|
|
2755
2755
|
}
|
|
2756
|
-
declare type JournalLineType = "Credit" | "Debit";
|
|
2757
|
-
declare type KeyEmployee = "No" | "Yes";
|
|
2758
|
-
interface LinkedTxn {
|
|
2756
|
+
export declare type JournalLineType = "Credit" | "Debit";
|
|
2757
|
+
export declare type KeyEmployee = "No" | "Yes";
|
|
2758
|
+
export interface LinkedTxn {
|
|
2759
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
2760
|
|
|
2761
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. */
|
|
@@ -2775,7 +2775,7 @@ interface LinkedTxn {
|
|
|
2775
2775
|
/** A monetary amount. */
|
|
2776
2776
|
Amount: string;
|
|
2777
2777
|
}
|
|
2778
|
-
interface LinkToTxn {
|
|
2778
|
+
export interface LinkToTxn {
|
|
2779
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
2780
|
|
|
2781
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. */
|
|
@@ -2785,10 +2785,10 @@ interface LinkToTxn {
|
|
|
2785
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
2786
|
TxnLineID: string;
|
|
2787
2787
|
}
|
|
2788
|
-
declare type LinkType = "AMTTYPE" | "QUANTYPE";
|
|
2789
|
-
declare type MatchCriterion = "Contains" | "EndsWith" | "StartsWith";
|
|
2790
|
-
declare type MilitaryStatus = "Active" | "Reserve";
|
|
2791
|
-
interface ModifiedDateRangeFilter {
|
|
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
2792
|
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.
|
|
2793
2793
|
|
|
2794
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).
|
|
@@ -2806,81 +2806,81 @@ interface ModifiedDateRangeFilter {
|
|
|
2806
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). */
|
|
2807
2807
|
ToModifiedDate?: string;
|
|
2808
2808
|
}
|
|
2809
|
-
interface NameFilter {
|
|
2809
|
+
export interface NameFilter {
|
|
2810
2810
|
/** The criterion to match. */
|
|
2811
2811
|
MatchCriterion: MatchCriterion;
|
|
2812
2812
|
/** The string to match. */
|
|
2813
2813
|
Name: string;
|
|
2814
2814
|
}
|
|
2815
|
-
interface NameRangeFilter {
|
|
2815
|
+
export interface NameRangeFilter {
|
|
2816
2816
|
/** The first name or item in the search range. If `FromName` is omitted, the range will begin with first name on the list. */
|
|
2817
2817
|
FromName?: string;
|
|
2818
2818
|
/** The final name or item in the search range. If `ToName` is omitted, the range will end with last name on the list. */
|
|
2819
2819
|
ToName?: string;
|
|
2820
2820
|
}
|
|
2821
|
-
declare type OnFile = "No" | "Yes";
|
|
2822
|
-
declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
|
|
2823
|
-
interface OverrideItemAccountRef {
|
|
2821
|
+
export declare type OnFile = "No" | "Yes";
|
|
2822
|
+
export declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
|
|
2823
|
+
export interface OverrideItemAccountRef {
|
|
2824
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. */
|
|
2825
2825
|
ListID?: string;
|
|
2826
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. */
|
|
2827
2827
|
FullName?: string;
|
|
2828
2828
|
}
|
|
2829
|
-
interface OverrideUOMSetRef {
|
|
2829
|
+
export interface OverrideUOMSetRef {
|
|
2830
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. */
|
|
2831
2831
|
ListID?: string;
|
|
2832
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. */
|
|
2833
2833
|
FullName?: string;
|
|
2834
2834
|
}
|
|
2835
2835
|
/** @default: All */
|
|
2836
|
-
declare type PaidStatus = "All" | "NotPaidOnly" | "PaidOnly";
|
|
2837
|
-
interface ParentRef {
|
|
2836
|
+
export declare type PaidStatus = "All" | "NotPaidOnly" | "PaidOnly";
|
|
2837
|
+
export interface ParentRef {
|
|
2838
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. */
|
|
2839
2839
|
ListID?: string;
|
|
2840
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. */
|
|
2841
2841
|
FullName?: string;
|
|
2842
2842
|
}
|
|
2843
|
-
declare type PartOrFullTime = "FullTime" | "PartTime";
|
|
2844
|
-
interface PayeeEntityRef {
|
|
2843
|
+
export declare type PartOrFullTime = "FullTime" | "PartTime";
|
|
2844
|
+
export interface PayeeEntityRef {
|
|
2845
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. */
|
|
2846
2846
|
ListID?: string;
|
|
2847
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. */
|
|
2848
2848
|
FullName?: string;
|
|
2849
2849
|
}
|
|
2850
|
-
declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
|
|
2851
|
-
interface PayrollItemWageRef {
|
|
2850
|
+
export declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
|
|
2851
|
+
export interface PayrollItemWageRef {
|
|
2852
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. */
|
|
2853
2853
|
ListID?: string;
|
|
2854
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. */
|
|
2855
2855
|
FullName?: string;
|
|
2856
2856
|
}
|
|
2857
2857
|
/** @default: None */
|
|
2858
|
-
declare type PreferredDeliveryMethod = "Email" | "Fax" | "None";
|
|
2859
|
-
interface PreferredPaymentMethodRef {
|
|
2858
|
+
export declare type PreferredDeliveryMethod = "Email" | "Fax" | "None";
|
|
2859
|
+
export interface PreferredPaymentMethodRef {
|
|
2860
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. */
|
|
2861
2861
|
ListID?: string;
|
|
2862
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. */
|
|
2863
2863
|
FullName?: string;
|
|
2864
2864
|
}
|
|
2865
|
-
interface PrefillAccountRef {
|
|
2865
|
+
export interface PrefillAccountRef {
|
|
2866
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. */
|
|
2867
2867
|
ListID?: string;
|
|
2868
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. */
|
|
2869
2869
|
FullName?: string;
|
|
2870
2870
|
}
|
|
2871
|
-
interface PrefVendorRef {
|
|
2871
|
+
export interface PrefVendorRef {
|
|
2872
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. */
|
|
2873
2873
|
ListID?: string;
|
|
2874
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. */
|
|
2875
2875
|
FullName?: string;
|
|
2876
2876
|
}
|
|
2877
|
-
interface PriceLevelRef {
|
|
2877
|
+
export interface PriceLevelRef {
|
|
2878
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. */
|
|
2879
2879
|
ListID?: string;
|
|
2880
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. */
|
|
2881
2881
|
FullName?: string;
|
|
2882
2882
|
}
|
|
2883
|
-
interface PrimaryContact {
|
|
2883
|
+
export interface PrimaryContact {
|
|
2884
2884
|
/** The name of the contact. */
|
|
2885
2885
|
ContactName: string;
|
|
2886
2886
|
/** The value of the contact field. */
|
|
@@ -2888,13 +2888,13 @@ interface PrimaryContact {
|
|
|
2888
2888
|
/** Relationship of emergency contact information to the employee. */
|
|
2889
2889
|
Relation?: Relation;
|
|
2890
2890
|
}
|
|
2891
|
-
interface PurchaseTaxCodeRef {
|
|
2891
|
+
export interface PurchaseTaxCodeRef {
|
|
2892
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. */
|
|
2893
2893
|
ListID?: string;
|
|
2894
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. */
|
|
2895
2895
|
FullName?: string;
|
|
2896
2896
|
}
|
|
2897
|
-
interface RefNumberFilter {
|
|
2897
|
+
export interface RefNumberFilter {
|
|
2898
2898
|
/** The criterion to match. */
|
|
2899
2899
|
MatchCriterion: MatchCriterion;
|
|
2900
2900
|
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
@@ -2904,16 +2904,16 @@ interface RefNumberFilter {
|
|
|
2904
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. */
|
|
2905
2905
|
RefNumber: string;
|
|
2906
2906
|
}
|
|
2907
|
-
interface RefNumberRangeFilter {
|
|
2907
|
+
export interface RefNumberRangeFilter {
|
|
2908
2908
|
/** The first `RefNumber` in the search range. If `FromRefNumber` is omitted, the range will begin with first number on the list. */
|
|
2909
2909
|
FromRefNumber?: string;
|
|
2910
2910
|
/** The final `RefNumber` in the search range. If `ToRefNumber` is omitted, the range will end with last number on the list. */
|
|
2911
2911
|
ToRefNumber?: string;
|
|
2912
2912
|
}
|
|
2913
|
-
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";
|
|
2914
2914
|
/** @default: Quarterly */
|
|
2915
|
-
declare type ReportingPeriod = "Monthly" | "Quarterly";
|
|
2916
|
-
interface SalesAndPurchase {
|
|
2915
|
+
export declare type ReportingPeriod = "Monthly" | "Quarterly";
|
|
2916
|
+
export interface SalesAndPurchase {
|
|
2917
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). */
|
|
2918
2918
|
SalesDesc?: string;
|
|
2919
2919
|
/** Price charged for this item. */
|
|
@@ -2931,7 +2931,7 @@ interface SalesAndPurchase {
|
|
|
2931
2931
|
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
2932
2932
|
PrefVendorRef?: PrefVendorRef;
|
|
2933
2933
|
}
|
|
2934
|
-
interface SalesAndPurchaseMod {
|
|
2934
|
+
export interface SalesAndPurchaseMod {
|
|
2935
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). */
|
|
2936
2936
|
SalesDesc?: string;
|
|
2937
2937
|
/** Price charged for this item. */
|
|
@@ -2953,7 +2953,7 @@ interface SalesAndPurchaseMod {
|
|
|
2953
2953
|
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
2954
2954
|
PrefVendorRef?: PrefVendorRef;
|
|
2955
2955
|
}
|
|
2956
|
-
interface SalesOrPurchase {
|
|
2956
|
+
export interface SalesOrPurchase {
|
|
2957
2957
|
/** A descriptive text field. */
|
|
2958
2958
|
Desc?: string;
|
|
2959
2959
|
/** The purchase price or sales price of this item. */
|
|
@@ -2963,7 +2963,7 @@ interface SalesOrPurchase {
|
|
|
2963
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` */
|
|
2964
2964
|
AccountRef?: AccountRef;
|
|
2965
2965
|
}
|
|
2966
|
-
interface SalesOrPurchaseMod {
|
|
2966
|
+
export interface SalesOrPurchaseMod {
|
|
2967
2967
|
/** A descriptive text field. */
|
|
2968
2968
|
Desc?: string;
|
|
2969
2969
|
/** The purchase price or sales price of this item. */
|
|
@@ -2975,27 +2975,27 @@ interface SalesOrPurchaseMod {
|
|
|
2975
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. */
|
|
2976
2976
|
ApplyAccountRefToExistingTxns?: boolean;
|
|
2977
2977
|
}
|
|
2978
|
-
interface SalesRepRef {
|
|
2978
|
+
export interface SalesRepRef {
|
|
2979
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. */
|
|
2980
2980
|
ListID?: string;
|
|
2981
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. */
|
|
2982
2982
|
FullName?: string;
|
|
2983
2983
|
}
|
|
2984
|
-
interface SalesTaxCodeRef {
|
|
2984
|
+
export interface SalesTaxCodeRef {
|
|
2985
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. */
|
|
2986
2986
|
ListID?: string;
|
|
2987
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. */
|
|
2988
2988
|
FullName?: string;
|
|
2989
2989
|
}
|
|
2990
2990
|
/** @default: Canada */
|
|
2991
|
-
declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
2992
|
-
interface SalesTaxReturnRef {
|
|
2991
|
+
export declare type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
2992
|
+
export interface SalesTaxReturnRef {
|
|
2993
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. */
|
|
2994
2994
|
ListID?: string;
|
|
2995
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. */
|
|
2996
2996
|
FullName?: string;
|
|
2997
2997
|
}
|
|
2998
|
-
interface SecondaryContact {
|
|
2998
|
+
export interface SecondaryContact {
|
|
2999
2999
|
/** The name of the contact. */
|
|
3000
3000
|
ContactName: string;
|
|
3001
3001
|
/** The value of the contact field. */
|
|
@@ -3003,7 +3003,7 @@ interface SecondaryContact {
|
|
|
3003
3003
|
/** Relationship of emergency contact information to the employee. */
|
|
3004
3004
|
Relation?: Relation;
|
|
3005
3005
|
}
|
|
3006
|
-
interface SetCredit {
|
|
3006
|
+
export interface SetCredit {
|
|
3007
3007
|
/** The ID of the credit memo that you are applying to this invoice or bill. */
|
|
3008
3008
|
CreditTxnID: string;
|
|
3009
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. */
|
|
@@ -3011,7 +3011,7 @@ interface SetCredit {
|
|
|
3011
3011
|
/** Option to override credit */
|
|
3012
3012
|
Override?: boolean;
|
|
3013
3013
|
}
|
|
3014
|
-
interface ShipAddress {
|
|
3014
|
+
export interface ShipAddress {
|
|
3015
3015
|
/** The first line of an address. */
|
|
3016
3016
|
Addr1?: string;
|
|
3017
3017
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -3033,7 +3033,7 @@ interface ShipAddress {
|
|
|
3033
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. */
|
|
3034
3034
|
Note?: string;
|
|
3035
3035
|
}
|
|
3036
|
-
interface ShipAddressBlock {
|
|
3036
|
+
export interface ShipAddressBlock {
|
|
3037
3037
|
/** The first line of an address. */
|
|
3038
3038
|
Addr1?: string;
|
|
3039
3039
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -3045,7 +3045,7 @@ interface ShipAddressBlock {
|
|
|
3045
3045
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
3046
3046
|
Addr5?: string;
|
|
3047
3047
|
}
|
|
3048
|
-
interface ShipToAddress {
|
|
3048
|
+
export interface ShipToAddress {
|
|
3049
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. */
|
|
3050
3050
|
Name: string;
|
|
3051
3051
|
/** The first line of an address. */
|
|
@@ -3071,7 +3071,7 @@ interface ShipToAddress {
|
|
|
3071
3071
|
/** Flag that address is the default ship to address. */
|
|
3072
3072
|
DefaultShipTo?: boolean;
|
|
3073
3073
|
}
|
|
3074
|
-
interface SickHours {
|
|
3074
|
+
export interface SickHours {
|
|
3075
3075
|
/** The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. */
|
|
3076
3076
|
HoursAvailable?: string;
|
|
3077
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. */
|
|
@@ -3087,38 +3087,38 @@ interface SickHours {
|
|
|
3087
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. */
|
|
3088
3088
|
AccrualStartDate?: string;
|
|
3089
3089
|
}
|
|
3090
|
-
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
|
-
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 {
|
|
3092
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. */
|
|
3093
3093
|
ListID?: string;
|
|
3094
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. */
|
|
3095
3095
|
FullName?: string;
|
|
3096
3096
|
}
|
|
3097
|
-
interface TaxLineInfoRet {
|
|
3097
|
+
export interface TaxLineInfoRet {
|
|
3098
3098
|
/** An internal representation of the tax line associated with this account. */
|
|
3099
3099
|
TaxLineID: number;
|
|
3100
3100
|
/** The name of the tax line associated with this account, as it appears on the tax form. */
|
|
3101
3101
|
TaxLineName?: string;
|
|
3102
3102
|
}
|
|
3103
|
-
interface TaxOnPurchasesAccountRef {
|
|
3103
|
+
export interface TaxOnPurchasesAccountRef {
|
|
3104
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. */
|
|
3105
3105
|
ListID?: string;
|
|
3106
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. */
|
|
3107
3107
|
FullName?: string;
|
|
3108
3108
|
}
|
|
3109
|
-
interface TaxOnSalesAccountRef {
|
|
3109
|
+
export interface TaxOnSalesAccountRef {
|
|
3110
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. */
|
|
3111
3111
|
ListID?: string;
|
|
3112
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. */
|
|
3113
3113
|
FullName?: string;
|
|
3114
3114
|
}
|
|
3115
|
-
interface TermsRef {
|
|
3115
|
+
export interface TermsRef {
|
|
3116
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. */
|
|
3117
3117
|
ListID?: string;
|
|
3118
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. */
|
|
3119
3119
|
FullName?: string;
|
|
3120
3120
|
}
|
|
3121
|
-
interface TimeTrackingAdd {
|
|
3121
|
+
export interface TimeTrackingAdd {
|
|
3122
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. */
|
|
3123
3123
|
TxnDate?: string;
|
|
3124
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. */
|
|
@@ -3151,13 +3151,13 @@ export interface TimeTrackingAddRs {
|
|
|
3151
3151
|
TimeTrackingRet?: TimeTrackingRet;
|
|
3152
3152
|
ErrorRecovery?: ErrorRecovery;
|
|
3153
3153
|
}
|
|
3154
|
-
interface TimeTrackingEntityFilter {
|
|
3154
|
+
export interface TimeTrackingEntityFilter {
|
|
3155
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. */
|
|
3156
3156
|
ListID?: string[] | string;
|
|
3157
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. */
|
|
3158
3158
|
FullName?: string[] | string;
|
|
3159
3159
|
}
|
|
3160
|
-
interface TimeTrackingMod {
|
|
3160
|
+
export interface TimeTrackingMod {
|
|
3161
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. */
|
|
3162
3162
|
TxnID: string;
|
|
3163
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. */
|
|
@@ -3207,7 +3207,7 @@ export interface TimeTrackingQueryRq {
|
|
|
3207
3207
|
export interface TimeTrackingQueryRs {
|
|
3208
3208
|
TimeTrackingRet?: TimeTrackingRet | TimeTrackingRet[];
|
|
3209
3209
|
}
|
|
3210
|
-
interface TimeTrackingRet {
|
|
3210
|
+
export interface TimeTrackingRet {
|
|
3211
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. */
|
|
3212
3212
|
TxnID: string;
|
|
3213
3213
|
/** Time the object was created. */
|
|
@@ -3243,13 +3243,13 @@ interface TimeTrackingRet {
|
|
|
3243
3243
|
/** If `IsBilled` is true, the tracked time has already been billed. */
|
|
3244
3244
|
IsBilled?: boolean;
|
|
3245
3245
|
}
|
|
3246
|
-
interface TotalBalanceFilter {
|
|
3246
|
+
export interface TotalBalanceFilter {
|
|
3247
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`. */
|
|
3248
3248
|
Operator: Operator;
|
|
3249
3249
|
/** The monetary amount to which `Operator` refers. */
|
|
3250
3250
|
Amount: string;
|
|
3251
3251
|
}
|
|
3252
|
-
interface TxnDateRangeFilter {
|
|
3252
|
+
export interface TxnDateRangeFilter {
|
|
3253
3253
|
/** Selects transactions created on or after this date. Both `FromTxnDate` and `ToTxnDate` must be between 01/01/1901 and 12/31/9999.
|
|
3254
3254
|
|
|
3255
3255
|
If you omit `FromTxnDate`, it will be set to 1970-01-01 (1969-12-31 PST). */
|
|
@@ -3265,17 +3265,17 @@ interface TxnDateRangeFilter {
|
|
|
3265
3265
|
The list given when you click `IQBENDateMacroType` shows the complete list of valid version 3.0 values. */
|
|
3266
3266
|
DateMacro?: DateMacro;
|
|
3267
3267
|
}
|
|
3268
|
-
declare type TxnType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
|
|
3269
|
-
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 {
|
|
3270
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. */
|
|
3271
3271
|
ListID?: string;
|
|
3272
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. */
|
|
3273
3273
|
FullName?: string;
|
|
3274
3274
|
}
|
|
3275
|
-
declare type USCitizen = "No" | "Yes";
|
|
3276
|
-
declare type UseTimeDataToCreatePaychecks = "DoNotUseTimeData" | "NotSet" | "UseTimeData";
|
|
3277
|
-
declare type USVeteran = "No" | "Yes";
|
|
3278
|
-
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 {
|
|
3279
3279
|
/** The total number of hours currently available for the employee to use. If this value is empty, it will default to 0. */
|
|
3280
3280
|
HoursAvailable?: string;
|
|
3281
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. */
|
|
@@ -3291,7 +3291,7 @@ interface VacationHours {
|
|
|
3291
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. */
|
|
3292
3292
|
AccrualStartDate?: string;
|
|
3293
3293
|
}
|
|
3294
|
-
interface VendorAdd {
|
|
3294
|
+
export interface VendorAdd {
|
|
3295
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. */
|
|
3296
3296
|
Name: string;
|
|
3297
3297
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
@@ -3385,7 +3385,7 @@ interface VendorAdd {
|
|
|
3385
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. */
|
|
3386
3386
|
CurrencyRef?: CurrencyRef;
|
|
3387
3387
|
}
|
|
3388
|
-
interface VendorAddress {
|
|
3388
|
+
export interface VendorAddress {
|
|
3389
3389
|
/** The first line of an address. */
|
|
3390
3390
|
Addr1?: string;
|
|
3391
3391
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -3407,7 +3407,7 @@ interface VendorAddress {
|
|
|
3407
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. */
|
|
3408
3408
|
Note?: string;
|
|
3409
3409
|
}
|
|
3410
|
-
interface VendorAddressBlock {
|
|
3410
|
+
export interface VendorAddressBlock {
|
|
3411
3411
|
/** The first line of an address. */
|
|
3412
3412
|
Addr1?: string;
|
|
3413
3413
|
/** The second line of an address (if a second line is needed). */
|
|
@@ -3428,7 +3428,7 @@ export interface VendorAddRs {
|
|
|
3428
3428
|
VendorRet?: VendorRet;
|
|
3429
3429
|
ErrorRecovery?: ErrorRecovery;
|
|
3430
3430
|
}
|
|
3431
|
-
interface VendorMod {
|
|
3431
|
+
export interface VendorMod {
|
|
3432
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. */
|
|
3433
3433
|
ListID: string;
|
|
3434
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. */
|
|
@@ -3560,13 +3560,13 @@ export interface VendorQueryRq {
|
|
|
3560
3560
|
export interface VendorQueryRs {
|
|
3561
3561
|
VendorRet?: VendorRet | VendorRet[];
|
|
3562
3562
|
}
|
|
3563
|
-
interface VendorRef {
|
|
3563
|
+
export interface VendorRef {
|
|
3564
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
3565
|
ListID?: string;
|
|
3566
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
3567
|
FullName?: string;
|
|
3568
3568
|
}
|
|
3569
|
-
interface VendorRet {
|
|
3569
|
+
export interface VendorRet {
|
|
3570
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. */
|
|
3571
3571
|
ListID: string;
|
|
3572
3572
|
/** Time the object was created. */
|
|
@@ -3672,10 +3672,9 @@ interface VendorRet {
|
|
|
3672
3672
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
3673
3673
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
3674
3674
|
}
|
|
3675
|
-
interface VendorTypeRef {
|
|
3675
|
+
export interface VendorTypeRef {
|
|
3676
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. */
|
|
3677
3677
|
ListID?: string;
|
|
3678
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. */
|
|
3679
3679
|
FullName?: string;
|
|
3680
3680
|
}
|
|
3681
|
-
export {};
|