conductor-node 9.2.1 → 9.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/package.json
CHANGED
package/dist/src/index.js
CHANGED
|
@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
17
17
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
18
18
|
};
|
|
19
19
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
-
// eslint-disable-next-line consistent-default-export-name/default-export-match-filename -- This file defines the exports for the `conductor-node` package, as defined by `main` in `package.json`. Hence,
|
|
20
|
+
// eslint-disable-next-line consistent-default-export-name/default-export-match-filename -- This file defines the exports for the `conductor-node` package, as defined by `main` in `package.json`. Hence, we do not import this file internally so we can ignore this error.
|
|
21
21
|
const Client_1 = __importDefault(require("./Client"));
|
|
22
22
|
// eslint-disable-next-line unicorn/prefer-export-from -- We need `Client` to be the default export, which is impossible to define with `export from`.
|
|
23
23
|
exports.default = Client_1.default;
|
|
@@ -1389,6 +1389,108 @@ export default class QbdIntegration extends BaseIntegration {
|
|
|
1389
1389
|
*/
|
|
1390
1390
|
query: (integrationConnectionId: string, params: QbdTypes.VendorQueryRq) => Promise<NonNullable<QbdTypes.VendorQueryRs["VendorRet"]>>;
|
|
1391
1391
|
};
|
|
1392
|
+
vendorCredit: {
|
|
1393
|
+
/**
|
|
1394
|
+
* Adds a vendor credit.
|
|
1395
|
+
*
|
|
1396
|
+
* A vendor credit is also known as a “bill credit”. That is, it is a credit
|
|
1397
|
+
* that a vendor owes you because you overpaid your bill, returned
|
|
1398
|
+
* merchandise, or for some other reason. The `VendorCredit` is referenced
|
|
1399
|
+
* in a BilPayment transaction, inside the `SetCredit` aggregate.
|
|
1400
|
+
*
|
|
1401
|
+
* A `VendorCredit` should not be confused with a Credit Memo, which is
|
|
1402
|
+
* something you owe your customer and which is referenced in a
|
|
1403
|
+
* `ReceivePayment` request.
|
|
1404
|
+
*
|
|
1405
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditAdd
|
|
1406
|
+
*/
|
|
1407
|
+
add: (integrationConnectionId: string, params: QbdTypes.VendorCreditAddRq["VendorCreditAdd"]) => Promise<NonNullable<QbdTypes.VendorCreditAddRs["VendorCreditRet"]>>;
|
|
1408
|
+
/**
|
|
1409
|
+
* Modifies a vendor credit. Be careful! If you modify ANY line item, you
|
|
1410
|
+
* must fully re-construct the line item table as you want it because if you
|
|
1411
|
+
* edit even a single line item, any line item that is NOT in the vendor
|
|
1412
|
+
* credit mod will be omitted. For full details, see the QB SDK Programmer’s
|
|
1413
|
+
* Guide chapter on modifying and deleting transactions and list objects.
|
|
1414
|
+
*
|
|
1415
|
+
* A vendor credit is also known as a “bill credit”. That is, it is a credit
|
|
1416
|
+
* that a vendor owes you because you overpaid your bill, returned
|
|
1417
|
+
* merchandise, or for some other reason. The `VendorCredit` is referenced
|
|
1418
|
+
* in a BilPayment transaction, inside the `SetCredit` aggregate.
|
|
1419
|
+
*
|
|
1420
|
+
* A `VendorCredit` should not be confused with a Credit Memo, which is
|
|
1421
|
+
* something you owe your customer and which is referenced in a
|
|
1422
|
+
* `ReceivePayment` request.
|
|
1423
|
+
*
|
|
1424
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditMod
|
|
1425
|
+
*/
|
|
1426
|
+
mod: (integrationConnectionId: string, params: QbdTypes.VendorCreditModRq["VendorCreditMod"]) => Promise<NonNullable<QbdTypes.VendorCreditModRs["VendorCreditRet"]>>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Queries for the specified vendor credit or set of credits.
|
|
1429
|
+
*
|
|
1430
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditQuery
|
|
1431
|
+
*/
|
|
1432
|
+
query: (integrationConnectionId: string, params: QbdTypes.VendorCreditQueryRq) => Promise<NonNullable<QbdTypes.VendorCreditQueryRs["VendorCreditRet"]>>;
|
|
1433
|
+
};
|
|
1434
|
+
vendorType: {
|
|
1435
|
+
/**
|
|
1436
|
+
* Adds a vendor type. A vendor type allows business owners to categorize
|
|
1437
|
+
* vendors in ways that are meaningful for their businesses. For example, a
|
|
1438
|
+
* vendor type might indicate which industry a vendor represents, or which
|
|
1439
|
+
* part of the country a vendor is in.
|
|
1440
|
+
*
|
|
1441
|
+
* A `VendorTypeRef` aggregate refers to one of the types on the
|
|
1442
|
+
* `VendorType` list. In a request, if a `VendorTypeRef` aggregate includes
|
|
1443
|
+
* both `FullName` and `ListID`, `FullName` will be ignored.
|
|
1444
|
+
*
|
|
1445
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeAdd
|
|
1446
|
+
*/
|
|
1447
|
+
add: (integrationConnectionId: string, params: QbdTypes.VendorTypeAddRq["VendorTypeAdd"]) => Promise<NonNullable<QbdTypes.VendorTypeAddRs["VendorTypeRet"]>>;
|
|
1448
|
+
/**
|
|
1449
|
+
* Queries for the specified vendor type or set of types.
|
|
1450
|
+
*
|
|
1451
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeQuery
|
|
1452
|
+
*/
|
|
1453
|
+
query: (integrationConnectionId: string, params: QbdTypes.VendorTypeQueryRq) => Promise<NonNullable<QbdTypes.VendorTypeQueryRs["VendorTypeRet"]>>;
|
|
1454
|
+
};
|
|
1455
|
+
workersCompCode: {
|
|
1456
|
+
/**
|
|
1457
|
+
* Adds a workers’ compensation code with one or more rate entries (each
|
|
1458
|
+
* rate entry has an effective date and a rate). You can assign effective
|
|
1459
|
+
* dates in the past, present or future. However, only one future date will
|
|
1460
|
+
* be used. If a future date exists and you write a new one (using the Mod
|
|
1461
|
+
* request) then the most recently written code wins; if you have multiple
|
|
1462
|
+
* future dates in the Add request, the last one wins.
|
|
1463
|
+
*
|
|
1464
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1465
|
+
* service. Also, you cannot currently assign codes to employees in the SDK;
|
|
1466
|
+
* you have to use the UI to do that.
|
|
1467
|
+
*
|
|
1468
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeAdd
|
|
1469
|
+
*/
|
|
1470
|
+
add: (integrationConnectionId: string, params: QbdTypes.WorkersCompCodeAddRq["WorkersCompCodeAdd"]) => Promise<NonNullable<QbdTypes.WorkersCompCodeAddRs["WorkersCompCodeRet"]>>;
|
|
1471
|
+
/**
|
|
1472
|
+
* Modifies an existing workers’ compensation code. Notice that if a future
|
|
1473
|
+
* date exists and you write a new one (using the Mod request) then the most
|
|
1474
|
+
* recently written code wins.
|
|
1475
|
+
*
|
|
1476
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1477
|
+
* service. Also, you cannot currently assign codes to employees in the SDK;
|
|
1478
|
+
* you have to use the UI to do that.
|
|
1479
|
+
*
|
|
1480
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeMod
|
|
1481
|
+
*/
|
|
1482
|
+
mod: (integrationConnectionId: string, params: QbdTypes.WorkersCompCodeModRq["WorkersCompCodeMod"]) => Promise<NonNullable<QbdTypes.WorkersCompCodeModRs["WorkersCompCodeRet"]>>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Queries for the workers’ compensation codes specified in the query
|
|
1485
|
+
* filter; you can filter by name, modified date, and effective date.
|
|
1486
|
+
*
|
|
1487
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1488
|
+
* service.
|
|
1489
|
+
*
|
|
1490
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeQuery
|
|
1491
|
+
*/
|
|
1492
|
+
query: (integrationConnectionId: string, params: QbdTypes.WorkersCompCodeQueryRq) => Promise<NonNullable<QbdTypes.WorkersCompCodeQueryRs["WorkersCompCodeRet"]>>;
|
|
1493
|
+
};
|
|
1392
1494
|
/**
|
|
1393
1495
|
* Send any QBXML request to QuickBooks Desktop.
|
|
1394
1496
|
*
|
|
@@ -1394,6 +1394,108 @@ class QbdIntegration extends BaseIntegration_1.default {
|
|
|
1394
1394
|
*/
|
|
1395
1395
|
query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorQueryRq: params }, "VendorQueryRs", "VendorRet"),
|
|
1396
1396
|
};
|
|
1397
|
+
vendorCredit = {
|
|
1398
|
+
/**
|
|
1399
|
+
* Adds a vendor credit.
|
|
1400
|
+
*
|
|
1401
|
+
* A vendor credit is also known as a “bill credit”. That is, it is a credit
|
|
1402
|
+
* that a vendor owes you because you overpaid your bill, returned
|
|
1403
|
+
* merchandise, or for some other reason. The `VendorCredit` is referenced
|
|
1404
|
+
* in a BilPayment transaction, inside the `SetCredit` aggregate.
|
|
1405
|
+
*
|
|
1406
|
+
* A `VendorCredit` should not be confused with a Credit Memo, which is
|
|
1407
|
+
* something you owe your customer and which is referenced in a
|
|
1408
|
+
* `ReceivePayment` request.
|
|
1409
|
+
*
|
|
1410
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditAdd
|
|
1411
|
+
*/
|
|
1412
|
+
add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorCreditAddRq: { VendorCreditAdd: params } }, "VendorCreditAddRs", "VendorCreditRet"),
|
|
1413
|
+
/**
|
|
1414
|
+
* Modifies a vendor credit. Be careful! If you modify ANY line item, you
|
|
1415
|
+
* must fully re-construct the line item table as you want it because if you
|
|
1416
|
+
* edit even a single line item, any line item that is NOT in the vendor
|
|
1417
|
+
* credit mod will be omitted. For full details, see the QB SDK Programmer’s
|
|
1418
|
+
* Guide chapter on modifying and deleting transactions and list objects.
|
|
1419
|
+
*
|
|
1420
|
+
* A vendor credit is also known as a “bill credit”. That is, it is a credit
|
|
1421
|
+
* that a vendor owes you because you overpaid your bill, returned
|
|
1422
|
+
* merchandise, or for some other reason. The `VendorCredit` is referenced
|
|
1423
|
+
* in a BilPayment transaction, inside the `SetCredit` aggregate.
|
|
1424
|
+
*
|
|
1425
|
+
* A `VendorCredit` should not be confused with a Credit Memo, which is
|
|
1426
|
+
* something you owe your customer and which is referenced in a
|
|
1427
|
+
* `ReceivePayment` request.
|
|
1428
|
+
*
|
|
1429
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditMod
|
|
1430
|
+
*/
|
|
1431
|
+
mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorCreditModRq: { VendorCreditMod: params } }, "VendorCreditModRs", "VendorCreditRet"),
|
|
1432
|
+
/**
|
|
1433
|
+
* Queries for the specified vendor credit or set of credits.
|
|
1434
|
+
*
|
|
1435
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorCreditQuery
|
|
1436
|
+
*/
|
|
1437
|
+
query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorCreditQueryRq: params }, "VendorCreditQueryRs", "VendorCreditRet"),
|
|
1438
|
+
};
|
|
1439
|
+
vendorType = {
|
|
1440
|
+
/**
|
|
1441
|
+
* Adds a vendor type. A vendor type allows business owners to categorize
|
|
1442
|
+
* vendors in ways that are meaningful for their businesses. For example, a
|
|
1443
|
+
* vendor type might indicate which industry a vendor represents, or which
|
|
1444
|
+
* part of the country a vendor is in.
|
|
1445
|
+
*
|
|
1446
|
+
* A `VendorTypeRef` aggregate refers to one of the types on the
|
|
1447
|
+
* `VendorType` list. In a request, if a `VendorTypeRef` aggregate includes
|
|
1448
|
+
* both `FullName` and `ListID`, `FullName` will be ignored.
|
|
1449
|
+
*
|
|
1450
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeAdd
|
|
1451
|
+
*/
|
|
1452
|
+
add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorTypeAddRq: { VendorTypeAdd: params } }, "VendorTypeAddRs", "VendorTypeRet"),
|
|
1453
|
+
/**
|
|
1454
|
+
* Queries for the specified vendor type or set of types.
|
|
1455
|
+
*
|
|
1456
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VendorTypeQuery
|
|
1457
|
+
*/
|
|
1458
|
+
query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { VendorTypeQueryRq: params }, "VendorTypeQueryRs", "VendorTypeRet"),
|
|
1459
|
+
};
|
|
1460
|
+
workersCompCode = {
|
|
1461
|
+
/**
|
|
1462
|
+
* Adds a workers’ compensation code with one or more rate entries (each
|
|
1463
|
+
* rate entry has an effective date and a rate). You can assign effective
|
|
1464
|
+
* dates in the past, present or future. However, only one future date will
|
|
1465
|
+
* be used. If a future date exists and you write a new one (using the Mod
|
|
1466
|
+
* request) then the most recently written code wins; if you have multiple
|
|
1467
|
+
* future dates in the Add request, the last one wins.
|
|
1468
|
+
*
|
|
1469
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1470
|
+
* service. Also, you cannot currently assign codes to employees in the SDK;
|
|
1471
|
+
* you have to use the UI to do that.
|
|
1472
|
+
*
|
|
1473
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeAdd
|
|
1474
|
+
*/
|
|
1475
|
+
add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { WorkersCompCodeAddRq: { WorkersCompCodeAdd: params } }, "WorkersCompCodeAddRs", "WorkersCompCodeRet"),
|
|
1476
|
+
/**
|
|
1477
|
+
* Modifies an existing workers’ compensation code. Notice that if a future
|
|
1478
|
+
* date exists and you write a new one (using the Mod request) then the most
|
|
1479
|
+
* recently written code wins.
|
|
1480
|
+
*
|
|
1481
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1482
|
+
* service. Also, you cannot currently assign codes to employees in the SDK;
|
|
1483
|
+
* you have to use the UI to do that.
|
|
1484
|
+
*
|
|
1485
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeMod
|
|
1486
|
+
*/
|
|
1487
|
+
mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { WorkersCompCodeModRq: { WorkersCompCodeMod: params } }, "WorkersCompCodeModRs", "WorkersCompCodeRet"),
|
|
1488
|
+
/**
|
|
1489
|
+
* Queries for the workers’ compensation codes specified in the query
|
|
1490
|
+
* filter; you can filter by name, modified date, and effective date.
|
|
1491
|
+
*
|
|
1492
|
+
* This request requires the company to be subscribed to Intuit Payroll
|
|
1493
|
+
* service.
|
|
1494
|
+
*
|
|
1495
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/WorkersCompCodeQuery
|
|
1496
|
+
*/
|
|
1497
|
+
query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { WorkersCompCodeQueryRq: params }, "WorkersCompCodeQueryRs", "WorkersCompCodeRet"),
|
|
1498
|
+
};
|
|
1397
1499
|
/**
|
|
1398
1500
|
* Send any QBXML request to QuickBooks Desktop.
|
|
1399
1501
|
*
|
|
@@ -7043,6 +7043,18 @@ export interface PurchaseTaxCodeRef {
|
|
|
7043
7043
|
/** `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. */
|
|
7044
7044
|
FullName?: string;
|
|
7045
7045
|
}
|
|
7046
|
+
export interface RateEntry {
|
|
7047
|
+
/** Indicates the price of something. */
|
|
7048
|
+
Rate: string;
|
|
7049
|
+
/** Specifies the date at which the workers’ comp code and it’s related premium goes into effect. */
|
|
7050
|
+
EffectiveDate: string;
|
|
7051
|
+
}
|
|
7052
|
+
export interface RateHistory {
|
|
7053
|
+
/** Indicates the price of something. */
|
|
7054
|
+
Rate: string;
|
|
7055
|
+
/** Specifies the date at which the workers’ comp code and it’s related premium goes into effect. */
|
|
7056
|
+
EffectiveDate: string;
|
|
7057
|
+
}
|
|
7046
7058
|
export interface RefNumberFilter {
|
|
7047
7059
|
/** The criterion to match. */
|
|
7048
7060
|
MatchCriterion: MatchCriterion;
|
|
@@ -7622,6 +7634,201 @@ export interface VendorAddRs {
|
|
|
7622
7634
|
VendorRet?: VendorRet;
|
|
7623
7635
|
ErrorRecovery?: ErrorRecovery;
|
|
7624
7636
|
}
|
|
7637
|
+
export interface VendorCreditAdd {
|
|
7638
|
+
/** 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. */
|
|
7639
|
+
VendorRef: VendorRef;
|
|
7640
|
+
/** 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. */
|
|
7641
|
+
APAccountRef?: APAccountRef;
|
|
7642
|
+
/** 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. */
|
|
7643
|
+
TxnDate?: string;
|
|
7644
|
+
/** 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. */
|
|
7645
|
+
RefNumber?: string;
|
|
7646
|
+
/** Appears in the A/P register and in reports that include this credit. */
|
|
7647
|
+
Memo?: string;
|
|
7648
|
+
/** For future use with international versions of QuickBooks. */
|
|
7649
|
+
IsTaxIncluded?: boolean;
|
|
7650
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default:Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false)Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true) A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales. A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
7651
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
7652
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
7653
|
+
ExchangeRate?: number;
|
|
7654
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
7655
|
+
ExternalGUID?: string;
|
|
7656
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
7657
|
+
ExpenseLineAdd?: ExpenseLineAdd | ExpenseLineAdd[];
|
|
7658
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
7659
|
+
ItemLineAdd?: ItemLineAdd | ItemLineAdd[];
|
|
7660
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
7661
|
+
ItemGroupLineAdd?: ItemGroupLineAdd | ItemGroupLineAdd[];
|
|
7662
|
+
}
|
|
7663
|
+
export interface VendorCreditAddRq {
|
|
7664
|
+
VendorCreditAdd: VendorCreditAdd;
|
|
7665
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
7666
|
+
IncludeRetElement?: string[] | string;
|
|
7667
|
+
}
|
|
7668
|
+
export interface VendorCreditAddRs {
|
|
7669
|
+
VendorCreditRet?: VendorCreditRet;
|
|
7670
|
+
ErrorRecovery?: ErrorRecovery;
|
|
7671
|
+
}
|
|
7672
|
+
export interface VendorCreditMod {
|
|
7673
|
+
/** 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.
|
|
7674
|
+
|
|
7675
|
+
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. */
|
|
7676
|
+
TxnID: string;
|
|
7677
|
+
/** 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. */
|
|
7678
|
+
EditSequence: string;
|
|
7679
|
+
/** 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. */
|
|
7680
|
+
VendorRef?: VendorRef;
|
|
7681
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.)
|
|
7682
|
+
|
|
7683
|
+
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. */
|
|
7684
|
+
APAccountRef?: APAccountRef;
|
|
7685
|
+
/** 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. */
|
|
7686
|
+
TxnDate?: string;
|
|
7687
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
7688
|
+
|
|
7689
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
7690
|
+
|
|
7691
|
+
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. */
|
|
7692
|
+
RefNumber?: string;
|
|
7693
|
+
/** Appears in the A/P register and in reports that include this credit. */
|
|
7694
|
+
Memo?: string;
|
|
7695
|
+
/** For future use with international versions of QuickBooks. */
|
|
7696
|
+
IsTaxIncluded?: boolean;
|
|
7697
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
7698
|
+
|
|
7699
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
7700
|
+
|
|
7701
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
7702
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
7703
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
7704
|
+
|
|
7705
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
7706
|
+
ExchangeRate?: number;
|
|
7707
|
+
/** Set `ClearExpenseLines` to true to clear all the expense lines. To modify individual lines, use `ExpenseLineMod`. */
|
|
7708
|
+
ClearExpenseLines?: boolean;
|
|
7709
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
7710
|
+
ExpenseLineMod?: ExpenseLineMod | ExpenseLineMod[];
|
|
7711
|
+
/** Set `ClearItemLines` to true to clear all the item lines. To modify individual lines, use `ItemLineMod`. */
|
|
7712
|
+
ClearItemLines?: boolean;
|
|
7713
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
7714
|
+
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
7715
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
7716
|
+
ItemGroupLineMod?: ItemGroupLineMod | ItemGroupLineMod[];
|
|
7717
|
+
}
|
|
7718
|
+
export interface VendorCreditModRq {
|
|
7719
|
+
VendorCreditMod: VendorCreditMod;
|
|
7720
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
7721
|
+
|
|
7722
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
7723
|
+
|
|
7724
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
7725
|
+
IncludeRetElement?: string[] | string;
|
|
7726
|
+
}
|
|
7727
|
+
export interface VendorCreditModRs {
|
|
7728
|
+
VendorCreditRet?: VendorCreditRet;
|
|
7729
|
+
ErrorRecovery?: ErrorRecovery;
|
|
7730
|
+
}
|
|
7731
|
+
export interface VendorCreditQueryRq {
|
|
7732
|
+
/** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQuery` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
|
|
7733
|
+
TxnID?: string[] | string;
|
|
7734
|
+
/** A list of one or more `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request, the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
|
|
7735
|
+
RefNumber?: string[] | string;
|
|
7736
|
+
/** A list of one or more case sensitive `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. You should use this case sensitive ref number list rather than the older `RefNumber` list, because it provides much better performance in certain circumstances. The older `refNumber` list provided slow performance if the `refNumber` values contained letters, not just digits. This `RefNumberCaseSensitive` list, new in SDK 4.0, eliminates this performance hit. */
|
|
7737
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
7738
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
7739
|
+
MaxReturned?: number;
|
|
7740
|
+
/** Filters according to the dates when transactions were last modified. The `ModifiedDateRangeFilter` aggregate is not required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `FromModifiedDate` and `ToModifiedDate` fields was not supported in qbXML version 1.0 or 1.1. (To filter according to the dates when transactions were deleted, use a `TxnDeletedQuery` message.) */
|
|
7741
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
7742
|
+
/** Filters according to the original transaction dates. */
|
|
7743
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
7744
|
+
/** An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or `Other` Names list. You can use an `EntityQuery` request to get information about all the entities that are set up in the QuickBooks file. In an `ARRefundCreditCard` query, this must be a customer/customer job. */
|
|
7745
|
+
EntityFilter?: EntityFilter;
|
|
7746
|
+
/** Filters according to the account name or `ListID`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `FullName` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise. For example, if you queried for an account named 2050, and 2050 happened to be the account number of a totally different account, the query would not return what you asked for (the account named 2050), but instead would return the account with the account number 2050. This problem will not happen if the “Use account numbers” preference is turned off in the QuickBooks file, orthe account name exactly matches the account number. (In this case, query would return the correct account either way.) To avoid this problem: Do not name an account using a number unless the number exactly matches the account’s account number. If an account name must contain a number that does not match its own account number, have the QuickBooks user change the account’s name slightly, for example `to` 2050a. */
|
|
7747
|
+
AccountFilter?: AccountFilter;
|
|
7748
|
+
/** Filters according to `RefNumber`. */
|
|
7749
|
+
RefNumberFilter?: RefNumberFilter;
|
|
7750
|
+
/** Filters according to `RefNumber`. The filtering code will do a numerical comparison (if `FromRefNumber` and `ToRefNumber` only contain digits) or a lexicographical comparison (if either `FromRefNumber` or `ToRefNumber` contain any nondigit characters). In the first situation, if you need to query for a `RefNumber` that is larger than the maximum long integer value of 2147483647, one workaround is to specify a `FromRefNumber` that is less than or equal to 2147483647 without specifying a `ToRefNumber`. */
|
|
7751
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
7752
|
+
/** Filters by the specified currency. */
|
|
7753
|
+
CurrencyFilter?: CurrencyFilter;
|
|
7754
|
+
/** This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `IncludeLineItems` to true to include line items in the response if you don’t mind getting a larger result. */
|
|
7755
|
+
IncludeLineItems?: boolean;
|
|
7756
|
+
/** If you set `IncludeLinkedTxns` to true, then the returned object will include a list of all the transactions linked to the queried object. (This list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items.) Each linked transaction will be represented by a `LinkedTxn` aggregate. If no linked transactions exist, no `LinkedTxn` aggregates will be returned. */
|
|
7757
|
+
IncludeLinkedTxns?: boolean;
|
|
7758
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
7759
|
+
IncludeRetElement?: string[] | string;
|
|
7760
|
+
/** Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data extension:If `OwnerID` is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If `OwnerID` is a GUID, for example `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that `OwnerID` values are not case-sensitive, meaning that if you enter an `OwnerID` value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
|
|
7761
|
+
OwnerID?: string[] | string;
|
|
7762
|
+
}
|
|
7763
|
+
export interface VendorCreditQueryRs {
|
|
7764
|
+
VendorCreditRet: VendorCreditRet[];
|
|
7765
|
+
}
|
|
7766
|
+
export interface VendorCreditRet {
|
|
7767
|
+
/** 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.
|
|
7768
|
+
|
|
7769
|
+
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. */
|
|
7770
|
+
TxnID: string;
|
|
7771
|
+
/** Time the object was created. */
|
|
7772
|
+
TimeCreated: string;
|
|
7773
|
+
/** Time the object was last modified. */
|
|
7774
|
+
TimeModified: string;
|
|
7775
|
+
/** 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. */
|
|
7776
|
+
EditSequence: string;
|
|
7777
|
+
/** An identifying number for this transaction. */
|
|
7778
|
+
TxnNumber?: number;
|
|
7779
|
+
/** 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. */
|
|
7780
|
+
VendorRef: VendorRef;
|
|
7781
|
+
/** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.)
|
|
7782
|
+
|
|
7783
|
+
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. */
|
|
7784
|
+
APAccountRef?: APAccountRef;
|
|
7785
|
+
/** 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. */
|
|
7786
|
+
TxnDate: string;
|
|
7787
|
+
/** The amount of a credit that is being applied to a vendor bill, reducing the amount that is owed on the bill. */
|
|
7788
|
+
CreditAmount: string;
|
|
7789
|
+
/** 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.
|
|
7790
|
+
|
|
7791
|
+
When used with `PriceLevels`, the `CurrencyRef` should only be used with “per item” price levels. */
|
|
7792
|
+
CurrencyRef?: CurrencyRef;
|
|
7793
|
+
/** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`.
|
|
7794
|
+
|
|
7795
|
+
You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
|
|
7796
|
+
ExchangeRate?: number;
|
|
7797
|
+
/** The amount of the credit, expressed in units of the current home currency. */
|
|
7798
|
+
CreditAmountInHomeCurrency?: string;
|
|
7799
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
7800
|
+
|
|
7801
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
7802
|
+
|
|
7803
|
+
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. */
|
|
7804
|
+
RefNumber?: string;
|
|
7805
|
+
/** Appears in the A/P register and in reports that include this credit. */
|
|
7806
|
+
Memo?: string;
|
|
7807
|
+
/** For future use with international versions of QuickBooks. */
|
|
7808
|
+
IsTaxIncluded?: boolean;
|
|
7809
|
+
/** Each item on a sales form is assigned a sales-tax code that indicates whether the item is taxable or non-taxable, and why. Two general codes, which can be modified but not deleted, appear on the sales-tax code list by default: Non-taxable (`Name` = NON; `Desc` = Non-Taxable; `IsTaxable` = false) Taxable (`Name` = TAX; `Desc` = Taxable; `IsTaxable` = true)
|
|
7810
|
+
|
|
7811
|
+
A sales-tax code can be deleted only if it is no longer associated with any customer, item, or transaction. If the “Do You Charge Sales Tax?” preference within QuickBooks is set to No, QuickBooks will assign the default non-taxable sales-tax code to all sales.
|
|
7812
|
+
|
|
7813
|
+
A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef` refers to the sales-tax code that will be used for items related to this customer. In an `ItemInventory` message, `SalesTaxCodeRef` refers to the type of sales tax that will be charged for this item, if it is a taxable item and if sales tax is set up within QuickBooks. */
|
|
7814
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
7815
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
7816
|
+
ExternalGUID?: string;
|
|
7817
|
+
/** 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.
|
|
7818
|
+
|
|
7819
|
+
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. */
|
|
7820
|
+
LinkedTxn?: LinkedTxn | LinkedTxn[];
|
|
7821
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
7822
|
+
ExpenseLineRet?: ExpenseLineRet | ExpenseLineRet[];
|
|
7823
|
+
/** An `ItemLine` is used to track any portion of a transaction that represents the purchase of an “item.” If `ItemLineAdd` does not specify an `Amount`, `Cost`, or `Quantity`, then QuickBooks will calculate `Amount` based on a `Quantity` of 1 and the suggested `Cost`. */
|
|
7824
|
+
ItemLineRet?: ItemLineRet | ItemLineRet[];
|
|
7825
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
7826
|
+
ItemGroupLineRet?: ItemGroupLineRet | ItemGroupLineRet[];
|
|
7827
|
+
/** Indicates the amount that is still owed. `AmountDue` minus any credits or discounts equals the `OpenAmount`. */
|
|
7828
|
+
OpenAmount?: string;
|
|
7829
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
7830
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
7831
|
+
}
|
|
7625
7832
|
export interface VendorMod {
|
|
7626
7833
|
/** 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. */
|
|
7627
7834
|
ListID: string;
|
|
@@ -7866,9 +8073,192 @@ export interface VendorRet {
|
|
|
7866
8073
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
7867
8074
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
7868
8075
|
}
|
|
8076
|
+
export interface VendorTypeAdd {
|
|
8077
|
+
/** 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.
|
|
8078
|
+
|
|
8079
|
+
For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
8080
|
+
Name: string;
|
|
8081
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8082
|
+
IsActive?: boolean;
|
|
8083
|
+
/** A reference to the list object that is one level above this one. For example, an inventory item with the `FullName` of `GermanCars`:Mercedes-Benz:`CL500I99AA` might have a parent object with the `FullName` of `GermanCars`:Mercedes-Benz. In a request, if a `ParentRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
8084
|
+
ParentRef?: ParentRef;
|
|
8085
|
+
}
|
|
8086
|
+
export interface VendorTypeAddRq {
|
|
8087
|
+
VendorTypeAdd: VendorTypeAdd;
|
|
8088
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
8089
|
+
|
|
8090
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
8091
|
+
|
|
8092
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
8093
|
+
IncludeRetElement?: string[] | string;
|
|
8094
|
+
}
|
|
8095
|
+
export interface VendorTypeAddRs {
|
|
8096
|
+
VendorTypeRet?: VendorTypeRet;
|
|
8097
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8098
|
+
}
|
|
8099
|
+
export interface VendorTypeQueryRq {
|
|
8100
|
+
/** 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. */
|
|
8101
|
+
ListID?: string[] | string;
|
|
8102
|
+
/** 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. */
|
|
8103
|
+
FullName?: string[] | string;
|
|
8104
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
8105
|
+
MaxReturned?: number;
|
|
8106
|
+
/** Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is `asActiveOnly`, which selects only list objects that are active. */
|
|
8107
|
+
ActiveStatus?: ActiveStatus;
|
|
8108
|
+
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.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).For QBOE, the `FromModifiedDate` and `ToModifiedDate` must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1900-01-01T00:00:00.`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). */
|
|
8109
|
+
FromModifiedDate?: string;
|
|
8110
|
+
/** Selects objects modified on or before this date. See the note below on QBFC usage.For desktop versions of QuickBooks, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).For QBOE, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1900 and 9999-12-31T00:00:00. If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 9999-12-31T00:00:00.`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). */
|
|
8111
|
+
ToModifiedDate?: string;
|
|
8112
|
+
/** Filters according to the object’s `Name`. */
|
|
8113
|
+
NameFilter?: NameFilter;
|
|
8114
|
+
/** Filters according to the object’s `Name`. */
|
|
8115
|
+
NameRangeFilter?: NameRangeFilter;
|
|
8116
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
8117
|
+
IncludeRetElement?: string[] | string;
|
|
8118
|
+
}
|
|
8119
|
+
export interface VendorTypeQueryRs {
|
|
8120
|
+
VendorTypeRet: VendorTypeRet[];
|
|
8121
|
+
}
|
|
7869
8122
|
export interface VendorTypeRef {
|
|
7870
8123
|
/** 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. */
|
|
7871
8124
|
ListID?: string;
|
|
7872
8125
|
/** `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. */
|
|
7873
8126
|
FullName?: string;
|
|
7874
8127
|
}
|
|
8128
|
+
export interface VendorTypeRet {
|
|
8129
|
+
/** 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. */
|
|
8130
|
+
ListID: string;
|
|
8131
|
+
/** Time the object was created. */
|
|
8132
|
+
TimeCreated: string;
|
|
8133
|
+
/** Time the object was last modified. */
|
|
8134
|
+
TimeModified: string;
|
|
8135
|
+
/** 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. */
|
|
8136
|
+
EditSequence: string;
|
|
8137
|
+
/** 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.
|
|
8138
|
+
|
|
8139
|
+
For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
8140
|
+
Name: string;
|
|
8141
|
+
/** `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. */
|
|
8142
|
+
FullName: string;
|
|
8143
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8144
|
+
IsActive?: boolean;
|
|
8145
|
+
/** A reference to the list object that is one level above this one. For example, an inventory item with the `FullName` of `GermanCars`:Mercedes-Benz:`CL500I99AA` might have a parent object with the `FullName` of `GermanCars`:Mercedes-Benz. In a request, if a `ParentRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
8146
|
+
ParentRef?: ParentRef;
|
|
8147
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
8148
|
+
Sublevel: number;
|
|
8149
|
+
}
|
|
8150
|
+
export interface WorkersCompCodeAdd {
|
|
8151
|
+
/** 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. */
|
|
8152
|
+
Name: string;
|
|
8153
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8154
|
+
IsActive?: boolean;
|
|
8155
|
+
/** A descriptive text field. */
|
|
8156
|
+
Desc?: string;
|
|
8157
|
+
/** A `RateEntry` consists of one rate and one effective date. You can have as many rate entries as you like, but you must add each one to the `RateEntry` list like this: Dim `MyRateEntry` As `IRateEntry` Set `MyRateEntry` = My_IWorkersCompCodeAdd_object.`RateEntryList`.Append `MyRateEntry`.`EffectiveDate`.`SetValue` #7/7/2007 9:35:00 AM#” `MyRateEntry`.`Rate`.`SetValue` 1# */
|
|
8158
|
+
RateEntry: RateEntry | RateEntry[];
|
|
8159
|
+
}
|
|
8160
|
+
export interface WorkersCompCodeAddRq {
|
|
8161
|
+
WorkersCompCodeAdd: WorkersCompCodeAdd;
|
|
8162
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
8163
|
+
IncludeRetElement?: string[] | string;
|
|
8164
|
+
}
|
|
8165
|
+
export interface WorkersCompCodeAddRs {
|
|
8166
|
+
WorkersCompCodeRet?: WorkersCompCodeRet;
|
|
8167
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8168
|
+
}
|
|
8169
|
+
export interface WorkersCompCodeMod {
|
|
8170
|
+
/** 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. */
|
|
8171
|
+
ListID: string;
|
|
8172
|
+
/** 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. */
|
|
8173
|
+
EditSequence: string;
|
|
8174
|
+
/** 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. */
|
|
8175
|
+
Name?: string;
|
|
8176
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8177
|
+
IsActive?: boolean;
|
|
8178
|
+
/** A descriptive text field. */
|
|
8179
|
+
Desc?: string;
|
|
8180
|
+
/** A `RateEntry` consists of one rate and one effective date. You can have as many rate entries as you like, but you must add each one to the `RateEntry` list like this: Dim `MyRateEntry` As `IRateEntry` Set `MyRateEntry` = My_IWorkersCompCodeAdd_object.`RateEntryList`.Append `MyRateEntry`.`EffectiveDate`.`SetValue` #7/7/2007 9:35:00 AM#” `MyRateEntry`.`Rate`.`SetValue` 1# */
|
|
8181
|
+
RateEntry?: RateEntry | RateEntry[];
|
|
8182
|
+
}
|
|
8183
|
+
export interface WorkersCompCodeModRq {
|
|
8184
|
+
WorkersCompCodeMod: WorkersCompCodeMod;
|
|
8185
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
8186
|
+
IncludeRetElement?: string[] | string;
|
|
8187
|
+
}
|
|
8188
|
+
export interface WorkersCompCodeModRs {
|
|
8189
|
+
WorkersCompCodeRet?: WorkersCompCodeRet;
|
|
8190
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8191
|
+
}
|
|
8192
|
+
export interface WorkersCompCodeQueryRq {
|
|
8193
|
+
/** 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`.
|
|
8194
|
+
|
|
8195
|
+
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. */
|
|
8196
|
+
ListID?: string[] | string;
|
|
8197
|
+
/** 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. */
|
|
8198
|
+
FullName?: string[] | string;
|
|
8199
|
+
/** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
|
|
8200
|
+
MaxReturned?: number;
|
|
8201
|
+
/** Used in filters to select list objects based on whether or not they are currently enabled for use by QuickBooks. The default value is `asActiveOnly`, which selects only list objects that are active. */
|
|
8202
|
+
ActiveStatus?: ActiveStatus;
|
|
8203
|
+
/** Selects objects modified on or after this date. See the note below regarding QBFC usage.
|
|
8204
|
+
|
|
8205
|
+
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).
|
|
8206
|
+
|
|
8207
|
+
For QBOE, the `FromModifiedDate` and `ToModifiedDate` must be between 1900-01-01T00:00:00 and 9999-12-31T00:00:00. If `FromModifiedDate` includes a date but not a time (for example, if you set `FromModifiedDate` to 2003-02-14), the time is assumed to be zero (2003-02-14T00:00:00). If you omit `FromModifiedDate`, it will be set to 1900-01-01T00:00:00.
|
|
8208
|
+
|
|
8209
|
+
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). */
|
|
8210
|
+
FromModifiedDate?: string;
|
|
8211
|
+
/** Selects objects modified on or before this date. See the note below on QBFC usage.
|
|
8212
|
+
|
|
8213
|
+
For desktop versions of QuickBooks, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1970 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (Note that the time portion of the field was not supported in qbXML version 1.0 or 1.1.) If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
|
|
8214
|
+
|
|
8215
|
+
For QBOE, the `ToModifiedDate` and `FromModifiedDate` must be between 01/01/1900 and 9999-12-31T00:00:00. If `ToModifiedDate` includes a date but not a time (for example, if you set `ToModifiedDate` to 2003-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59). If you omit `ToModifiedDate` altogether, it will be set to 9999-12-31T00:00:00.
|
|
8216
|
+
|
|
8217
|
+
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). */
|
|
8218
|
+
ToModifiedDate?: string;
|
|
8219
|
+
/** Filters according to the object’s `Name`. */
|
|
8220
|
+
NameFilter?: NameFilter;
|
|
8221
|
+
/** Filters according to the object’s `Name`. */
|
|
8222
|
+
NameRangeFilter?: NameRangeFilter;
|
|
8223
|
+
/** The beginning of the range of effective dates to be searched. */
|
|
8224
|
+
FromEffectiveDate?: string;
|
|
8225
|
+
/** The end of the range of effective dates to be searched. */
|
|
8226
|
+
ToEffectiveDate?: string;
|
|
8227
|
+
/** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address.
|
|
8228
|
+
|
|
8229
|
+
The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name.
|
|
8230
|
+
|
|
8231
|
+
Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
|
|
8232
|
+
IncludeRetElement?: string[] | string;
|
|
8233
|
+
}
|
|
8234
|
+
export interface WorkersCompCodeQueryRs {
|
|
8235
|
+
WorkersCompCodeRet: WorkersCompCodeRet[];
|
|
8236
|
+
}
|
|
8237
|
+
export interface WorkersCompCodeRet {
|
|
8238
|
+
/** 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. */
|
|
8239
|
+
ListID?: string;
|
|
8240
|
+
/** Time the object was created. */
|
|
8241
|
+
TimeCreated?: string;
|
|
8242
|
+
/** Time the object was last modified. */
|
|
8243
|
+
TimeModified?: string;
|
|
8244
|
+
/** 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. */
|
|
8245
|
+
EditSequence?: string;
|
|
8246
|
+
/** 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.
|
|
8247
|
+
|
|
8248
|
+
For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
|
|
8249
|
+
Name?: string;
|
|
8250
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8251
|
+
IsActive?: boolean;
|
|
8252
|
+
/** A descriptive text field. */
|
|
8253
|
+
Desc?: string;
|
|
8254
|
+
/** Indicates the workers’ comp insurance premium rate that is currently in effect for the current comp code. If the code doesn’t have a current effective date–that is, it has a future date only, then this field is empty. */
|
|
8255
|
+
CurrentRate?: string;
|
|
8256
|
+
/** Indicates the date at which the workers’ compensation code went into effect. This field contains a value only if the code is currently in effect. If the code has only a future date, then this field is empty. */
|
|
8257
|
+
CurrentEffectiveDate?: string;
|
|
8258
|
+
/** You can create a workers’ comp code with several rates and effective dates, both in the past, present, and future (only one in the future). Each of these dates has a rate associated with it, the idea being you can set up the comp code to support anticipated increases (or decreases) in the rate. The value in this field indicates the first rate that will occur after the current rate andeffective date. */
|
|
8259
|
+
NextRate?: string;
|
|
8260
|
+
/** You can create a workers’ comp code with several rates and effective dates, both in the past, present, and future (only one in the future). Each of these dates has a rate associated with it, the idea being you can set up the comp code to support anticipated increases (or decreases) in the rate. The value in this field indicates the first effective date that will occur after the current effective date. */
|
|
8261
|
+
NextEffectiveDate?: string;
|
|
8262
|
+
/** The rate history is returned in Workers Comp Code Add and Query responses. There will be one `RateHistory` returned for each rate entry in the comp code. Each `RateHistory` aggregate consists of an effective date and a rate. */
|
|
8263
|
+
RateHistory?: RateHistory | RateHistory[];
|
|
8264
|
+
}
|
package/package.json
CHANGED