conductor-node 9.1.2 → 9.2.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 +3 -3
- package/dist/src/integrations/qbd/QbdIntegration.d.ts +493 -41
- package/dist/src/integrations/qbd/QbdIntegration.js +493 -41
- package/dist/src/integrations/qbd/qbdTypes.d.ts +1984 -375
- package/package.json +3 -3
- package/dist/src/graphql/codegenConfig.d.ts +0 -3
- package/dist/src/graphql/codegenConfig.js +0 -45
|
@@ -233,6 +233,7 @@ export interface AccountRet {
|
|
|
233
233
|
}
|
|
234
234
|
export type AccountType = "AccountsPayable" | "AccountsReceivable" | "Bank" | "CostOfGoodsSold" | "CreditCard" | "Equity" | "Expense" | "FixedAsset" | "Income" | "LongTermLiability" | "NonPosting" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome";
|
|
235
235
|
export type AccrualPeriod = "BeginningOfYear" | "EveryHourOnPaycheck" | "EveryPaycheck";
|
|
236
|
+
export type AcquiredAs = "New" | "Old";
|
|
236
237
|
/** @default: ActiveOnly */
|
|
237
238
|
export type ActiveStatus = "ActiveOnly" | "All" | "InactiveOnly";
|
|
238
239
|
export interface AdditionalContactRef {
|
|
@@ -293,6 +294,7 @@ export interface AddressBlock {
|
|
|
293
294
|
/** The fifth line of an address (if a fifth line is needed). */
|
|
294
295
|
Addr5?: string;
|
|
295
296
|
}
|
|
297
|
+
export type AdjustRelativeTo = "Cost" | "CurrentCustomPrice" | "StandardPrice";
|
|
296
298
|
export interface APAccountRef {
|
|
297
299
|
/** 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. */
|
|
298
300
|
ListID?: string;
|
|
@@ -3290,6 +3292,26 @@ export interface ExpenseLineRet {
|
|
|
3290
3292
|
}
|
|
3291
3293
|
export type FirstMonthFiscalYear = "April" | "August" | "December" | "February" | "January" | "July" | "June" | "March" | "May" | "November" | "October" | "September";
|
|
3292
3294
|
export type FirstMonthIncomeTaxYear = "April" | "August" | "December" | "February" | "January" | "July" | "June" | "March" | "May" | "November" | "October" | "September";
|
|
3295
|
+
export interface FixedAssetSalesInfo {
|
|
3296
|
+
/** 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). */
|
|
3297
|
+
SalesDesc: string;
|
|
3298
|
+
/** Date when a fixed asset was sold. */
|
|
3299
|
+
SalesDate: string;
|
|
3300
|
+
/** Price charged for this item. */
|
|
3301
|
+
SalesPrice?: string;
|
|
3302
|
+
/** Any expenses that were incurred during the sale of a fixed asset. */
|
|
3303
|
+
SalesExpense?: string;
|
|
3304
|
+
}
|
|
3305
|
+
export interface FixedAssetSalesInfoMod {
|
|
3306
|
+
/** 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). */
|
|
3307
|
+
SalesDesc?: string;
|
|
3308
|
+
/** Date when a fixed asset was sold. */
|
|
3309
|
+
SalesDate?: string;
|
|
3310
|
+
/** Price charged for this item. */
|
|
3311
|
+
SalesPrice?: string;
|
|
3312
|
+
/** Any expenses that were incurred during the sale of a fixed asset. */
|
|
3313
|
+
SalesExpense?: string;
|
|
3314
|
+
}
|
|
3293
3315
|
export type Gender = "Female" | "Male";
|
|
3294
3316
|
export interface IncomeAccountRef {
|
|
3295
3317
|
/** 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. */
|
|
@@ -3940,65 +3962,7 @@ export interface InvoiceRet {
|
|
|
3940
3962
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
3941
3963
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
3942
3964
|
}
|
|
3943
|
-
export interface
|
|
3944
|
-
/** `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. */
|
|
3945
|
-
ItemGroupRef: ItemGroupRef;
|
|
3946
|
-
/** `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. */
|
|
3947
|
-
Quantity?: number;
|
|
3948
|
-
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
3949
|
-
UnitOfMeasure?: string;
|
|
3950
|
-
/** Site where inventory is located. */
|
|
3951
|
-
InventorySiteRef?: InventorySiteRef;
|
|
3952
|
-
/** Location within the Inventory Site. */
|
|
3953
|
-
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
3954
|
-
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
3955
|
-
DataExt?: DataExt | DataExt[];
|
|
3956
|
-
}
|
|
3957
|
-
export interface ItemGroupLineMod {
|
|
3958
|
-
/** 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.)
|
|
3959
|
-
|
|
3960
|
-
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
3961
|
-
TxnLineID: string;
|
|
3962
|
-
/** `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. */
|
|
3963
|
-
ItemGroupRef?: ItemGroupRef;
|
|
3964
|
-
/** `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. */
|
|
3965
|
-
Quantity?: number;
|
|
3966
|
-
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
3967
|
-
UnitOfMeasure?: string;
|
|
3968
|
-
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
3969
|
-
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
3970
|
-
/** 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.” */
|
|
3971
|
-
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
3972
|
-
}
|
|
3973
|
-
export interface ItemGroupLineRet {
|
|
3974
|
-
/** 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.)
|
|
3975
|
-
|
|
3976
|
-
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
3977
|
-
TxnLineID: string;
|
|
3978
|
-
/** `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. */
|
|
3979
|
-
ItemGroupRef: ItemGroupRef;
|
|
3980
|
-
/** A descriptive text field. */
|
|
3981
|
-
Desc?: string;
|
|
3982
|
-
/** `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. */
|
|
3983
|
-
Quantity?: number;
|
|
3984
|
-
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
3985
|
-
UnitOfMeasure?: string;
|
|
3986
|
-
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
3987
|
-
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
3988
|
-
/** Total amount of money paid or received. In a receive payment add transaction that has payment amount elements (such as `AppliedToTxnAdd` lines) you must supply a `TotalAmount` and the sum of all the `PaymentAmount` elements must not be greater than the `TotalAmount`. */
|
|
3989
|
-
TotalAmount: string;
|
|
3990
|
-
/** 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.” */
|
|
3991
|
-
ItemLineRet?: ItemLineRet | ItemLineRet[];
|
|
3992
|
-
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
3993
|
-
DataExt?: DataExt | DataExt[];
|
|
3994
|
-
}
|
|
3995
|
-
export interface ItemGroupRef {
|
|
3996
|
-
/** 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. */
|
|
3997
|
-
ListID?: string;
|
|
3998
|
-
/** `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. */
|
|
3999
|
-
FullName?: string;
|
|
4000
|
-
}
|
|
4001
|
-
export interface ItemInventoryAdd {
|
|
3965
|
+
export interface ItemDiscountAdd {
|
|
4002
3966
|
/** 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. */
|
|
4003
3967
|
Name: string;
|
|
4004
3968
|
/** Barcode reference information. */
|
|
@@ -4009,55 +3973,29 @@ export interface ItemInventoryAdd {
|
|
|
4009
3973
|
ClassRef?: ClassRef;
|
|
4010
3974
|
/** 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. */
|
|
4011
3975
|
ParentRef?: ParentRef;
|
|
4012
|
-
/** The
|
|
4013
|
-
|
|
4014
|
-
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4015
|
-
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4016
|
-
/** For future use with international versions of QuickBooks. */
|
|
4017
|
-
IsTaxIncluded?: boolean;
|
|
3976
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
3977
|
+
ItemDesc?: string;
|
|
4018
3978
|
/** 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. */
|
|
4019
3979
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4020
|
-
/**
|
|
4021
|
-
|
|
4022
|
-
/**
|
|
4023
|
-
|
|
4024
|
-
/**
|
|
4025
|
-
|
|
4026
|
-
/** Appears in the `Description` column of checks, bills, credit card charges, and item receipts when this item is reordered. */
|
|
4027
|
-
PurchaseDesc?: string;
|
|
4028
|
-
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4029
|
-
PurchaseCost?: string;
|
|
4030
|
-
/** Account used for taxes on purchases in CA or UK. */
|
|
4031
|
-
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4032
|
-
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4033
|
-
COGSAccountRef?: COGSAccountRef;
|
|
4034
|
-
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4035
|
-
PrefVendorRef?: PrefVendorRef;
|
|
4036
|
-
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4037
|
-
AssetAccountRef?: AssetAccountRef;
|
|
4038
|
-
/** Quantity at which QuickBooks will remind the user to reorder this inventory item. */
|
|
4039
|
-
ReorderPoint?: number;
|
|
4040
|
-
/** Maximum number of items in inventory. */
|
|
4041
|
-
Max?: number;
|
|
4042
|
-
/** The number of these items in inventory. `QuantityOnHand` times `AverageCost` is `TotalValue` in an inventory item list. To change the `QuantityOnHand` for an item, you would have to use `InventoryAdjustmentAdd` not an `ItemInventoryMod`. */
|
|
4043
|
-
QuantityOnHand?: number;
|
|
4044
|
-
/** The total value of this inventory. If `TotalValue` is included, `QuantityOnHand` must also be included and must be greater than zero. If both `QuantityOnHand` and `PurchaseCost` are included, then `TotalValue` will be set to `QuantityOnHand` times `PurchaseCost`, regardless of what `TotalValue` is explicitly set to. */
|
|
4045
|
-
TotalValue?: string;
|
|
4046
|
-
/** The date when an item was converted into an inventory item from some other type of item. */
|
|
4047
|
-
InventoryDate?: string;
|
|
3980
|
+
/** The discount rate when it is given as a monetary amount. `DiscountRate` will be subtracted from a total or subtotal. */
|
|
3981
|
+
DiscountRate?: string;
|
|
3982
|
+
/** The discount rate when it is given as a percent. `DiscountRatePercent` will be subtracted from a total or subtotal. */
|
|
3983
|
+
DiscountRatePercent?: string;
|
|
3984
|
+
/** 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` */
|
|
3985
|
+
AccountRef?: AccountRef;
|
|
4048
3986
|
/** Allows for the attachment of a user defined GUID value. */
|
|
4049
3987
|
ExternalGUID?: string;
|
|
4050
3988
|
}
|
|
4051
|
-
export interface
|
|
4052
|
-
|
|
3989
|
+
export interface ItemDiscountAddRq {
|
|
3990
|
+
ItemDiscountAdd: ItemDiscountAdd;
|
|
4053
3991
|
/** 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. */
|
|
4054
3992
|
IncludeRetElement?: string[] | string;
|
|
4055
3993
|
}
|
|
4056
|
-
export interface
|
|
4057
|
-
|
|
3994
|
+
export interface ItemDiscountAddRs {
|
|
3995
|
+
ItemDiscountRet?: ItemDiscountRet;
|
|
4058
3996
|
ErrorRecovery?: ErrorRecovery;
|
|
4059
3997
|
}
|
|
4060
|
-
export interface
|
|
3998
|
+
export interface ItemDiscountMod {
|
|
4061
3999
|
/** 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. */
|
|
4062
4000
|
ListID: string;
|
|
4063
4001
|
/** 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. */
|
|
@@ -4072,53 +4010,29 @@ export interface ItemInventoryMod {
|
|
|
4072
4010
|
ClassRef?: ClassRef;
|
|
4073
4011
|
/** 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. */
|
|
4074
4012
|
ParentRef?: ParentRef;
|
|
4075
|
-
/** The
|
|
4076
|
-
|
|
4077
|
-
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4078
|
-
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4079
|
-
/** By Default `ForceUOMChange` is false. However, in item Mod requests, you need to set the `ForceUOMChange` field to True if you are changing the UOM set and the base unit of the new set does not match the base unit of the UOM set currently assigned to the item. This does the same thing as the user accepting the warning prompt in the UI. If you don’t set `ForceUOMChange` to True, you’ll get an error when you invoke the Item* Mod request.Y You should be aware that if you change the base unit for an item, you should also change the item’s quantities on hand and cost to reflect the new unit; otherwise the values will be inaccurate. An alternative to handle such UOM changes to an item is to create a new item with the desired UOM set and inactivate the old item. */
|
|
4080
|
-
ForceUOMChange?: boolean;
|
|
4081
|
-
/** For future use with international versions of QuickBooks. */
|
|
4082
|
-
IsTaxIncluded?: boolean;
|
|
4013
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
4014
|
+
ItemDesc?: string;
|
|
4083
4015
|
/** 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. */
|
|
4084
4016
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4085
|
-
/**
|
|
4086
|
-
|
|
4087
|
-
/**
|
|
4088
|
-
|
|
4089
|
-
/**
|
|
4090
|
-
|
|
4017
|
+
/** The discount rate when it is given as a monetary amount. `DiscountRate` will be subtracted from a total or subtotal. */
|
|
4018
|
+
DiscountRate?: string;
|
|
4019
|
+
/** The discount rate when it is given as a percent. `DiscountRatePercent` will be subtracted from a total or subtotal. */
|
|
4020
|
+
DiscountRatePercent?: string;
|
|
4021
|
+
/** 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` */
|
|
4022
|
+
AccountRef?: AccountRef;
|
|
4091
4023
|
/** 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. */
|
|
4092
|
-
|
|
4093
|
-
/** Appears in the `Description` column of checks, bills, credit card charges, and item receipts when this item is reordered. */
|
|
4094
|
-
PurchaseDesc?: string;
|
|
4095
|
-
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4096
|
-
PurchaseCost?: string;
|
|
4097
|
-
/** Account used for taxes on purchases in CA or UK. */
|
|
4098
|
-
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4099
|
-
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4100
|
-
COGSAccountRef?: COGSAccountRef;
|
|
4101
|
-
/** Effectively suppresses the UI prompt that is displayed upon a COGS account change when existing transactions use the account. */
|
|
4102
|
-
ApplyCOGSAccountRefToExistingTxns?: boolean;
|
|
4103
|
-
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4104
|
-
PrefVendorRef?: PrefVendorRef;
|
|
4105
|
-
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4106
|
-
AssetAccountRef?: AssetAccountRef;
|
|
4107
|
-
/** Quantity at which QuickBooks will remind the user to reorder this inventory item. */
|
|
4108
|
-
ReorderPoint?: number;
|
|
4109
|
-
/** Maximum number of items in inventory. */
|
|
4110
|
-
Max?: number;
|
|
4024
|
+
ApplyAccountRefToExistingTxns?: boolean;
|
|
4111
4025
|
}
|
|
4112
|
-
export interface
|
|
4113
|
-
|
|
4026
|
+
export interface ItemDiscountModRq {
|
|
4027
|
+
ItemDiscountMod: ItemDiscountMod;
|
|
4114
4028
|
/** 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. */
|
|
4115
4029
|
IncludeRetElement?: string[] | string;
|
|
4116
4030
|
}
|
|
4117
|
-
export interface
|
|
4118
|
-
|
|
4031
|
+
export interface ItemDiscountModRs {
|
|
4032
|
+
ItemDiscountRet?: ItemDiscountRet;
|
|
4119
4033
|
ErrorRecovery?: ErrorRecovery;
|
|
4120
4034
|
}
|
|
4121
|
-
export interface
|
|
4035
|
+
export interface ItemDiscountQueryRq {
|
|
4122
4036
|
/** 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. */
|
|
4123
4037
|
ListID?: string[] | string;
|
|
4124
4038
|
/** 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. */
|
|
@@ -4142,10 +4056,10 @@ export interface ItemInventoryQueryRq {
|
|
|
4142
4056
|
/** 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. */
|
|
4143
4057
|
OwnerID?: string[] | string;
|
|
4144
4058
|
}
|
|
4145
|
-
export interface
|
|
4146
|
-
|
|
4059
|
+
export interface ItemDiscountQueryRs {
|
|
4060
|
+
ItemDiscountRet: ItemDiscountRet[];
|
|
4147
4061
|
}
|
|
4148
|
-
export interface
|
|
4062
|
+
export interface ItemDiscountRet {
|
|
4149
4063
|
/** 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. */
|
|
4150
4064
|
ListID: string;
|
|
4151
4065
|
/** Time the object was created. */
|
|
@@ -4168,180 +4082,288 @@ export interface ItemInventoryRet {
|
|
|
4168
4082
|
ParentRef?: ParentRef;
|
|
4169
4083
|
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
4170
4084
|
Sublevel: number;
|
|
4171
|
-
/** The
|
|
4172
|
-
|
|
4173
|
-
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4174
|
-
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4175
|
-
/** For future use with international versions of QuickBooks. */
|
|
4176
|
-
IsTaxIncluded?: boolean;
|
|
4085
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
4086
|
+
ItemDesc?: string;
|
|
4177
4087
|
/** 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. */
|
|
4178
4088
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4179
|
-
/**
|
|
4180
|
-
|
|
4181
|
-
/**
|
|
4182
|
-
|
|
4183
|
-
/**
|
|
4184
|
-
|
|
4185
|
-
/**
|
|
4186
|
-
|
|
4089
|
+
/** The discount rate when it is given as a monetary amount. `DiscountRate` will be subtracted from a total or subtotal. */
|
|
4090
|
+
DiscountRate?: string;
|
|
4091
|
+
/** The discount rate when it is given as a percent. `DiscountRatePercent` will be subtracted from a total or subtotal. */
|
|
4092
|
+
DiscountRatePercent?: string;
|
|
4093
|
+
/** 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` */
|
|
4094
|
+
AccountRef?: AccountRef;
|
|
4095
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4096
|
+
ExternalGUID?: string;
|
|
4097
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4098
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4099
|
+
}
|
|
4100
|
+
export interface ItemFixedAssetAdd {
|
|
4101
|
+
/** 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. */
|
|
4102
|
+
Name: string;
|
|
4103
|
+
/** Barcode reference information. */
|
|
4104
|
+
BarCode?: BarCode;
|
|
4105
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4106
|
+
IsActive?: boolean;
|
|
4107
|
+
/** 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. */
|
|
4108
|
+
ClassRef?: ClassRef;
|
|
4109
|
+
/** Indicates whether this item was new or used when the business acquired it. */
|
|
4110
|
+
AcquiredAs: AcquiredAs;
|
|
4111
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4112
|
+
PurchaseDesc: string;
|
|
4113
|
+
/** The date when this asset was purchased. */
|
|
4114
|
+
PurchaseDate: string;
|
|
4187
4115
|
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4188
4116
|
PurchaseCost?: string;
|
|
4189
|
-
/**
|
|
4190
|
-
|
|
4191
|
-
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4192
|
-
COGSAccountRef?: COGSAccountRef;
|
|
4193
|
-
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4194
|
-
PrefVendorRef?: PrefVendorRef;
|
|
4117
|
+
/** The name of the vendor from whom this asset was purchased. */
|
|
4118
|
+
VendorOrPayeeName?: string;
|
|
4195
4119
|
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4196
4120
|
AssetAccountRef?: AssetAccountRef;
|
|
4197
|
-
/**
|
|
4198
|
-
|
|
4199
|
-
/**
|
|
4200
|
-
|
|
4201
|
-
/**
|
|
4202
|
-
|
|
4203
|
-
/**
|
|
4204
|
-
|
|
4205
|
-
/** The number of
|
|
4206
|
-
|
|
4207
|
-
/** The
|
|
4208
|
-
|
|
4121
|
+
/** Sales information, if this fixed asset was sold. */
|
|
4122
|
+
FixedAssetSalesInfo?: FixedAssetSalesInfo;
|
|
4123
|
+
/** Description of the asset—maker, brand, and so on. */
|
|
4124
|
+
AssetDesc?: string;
|
|
4125
|
+
/** Where the asset is located or has been placed into service. */
|
|
4126
|
+
Location?: string;
|
|
4127
|
+
/** Purchase order number. */
|
|
4128
|
+
PONumber?: string;
|
|
4129
|
+
/** The serial number of the asset. */
|
|
4130
|
+
SerialNumber?: string;
|
|
4131
|
+
/** The date when the warranty for this asset expires. */
|
|
4132
|
+
WarrantyExpDate?: string;
|
|
4133
|
+
/** Additional information. */
|
|
4134
|
+
Notes?: string;
|
|
4135
|
+
/** The number used by the QuickBooks Fixed Asset Manager to identify this asset. */
|
|
4136
|
+
AssetNumber?: string;
|
|
4137
|
+
/** The total cost of the fixed asset. This can include the cost of improvements or repairs. This amount is used to figure depreciation. */
|
|
4138
|
+
CostBasis?: string;
|
|
4139
|
+
/** The amount the fixed asset has lost in value since it was purchased, as of the end of the year. */
|
|
4140
|
+
YearEndAccumulatedDepreciation?: string;
|
|
4141
|
+
/** A reasonable estimate of the sales value of the fixed asset, as of the end of the year. */
|
|
4142
|
+
YearEndBookValue?: string;
|
|
4209
4143
|
/** Allows for the attachment of a user defined GUID value. */
|
|
4210
4144
|
ExternalGUID?: string;
|
|
4211
|
-
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4212
|
-
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4213
4145
|
}
|
|
4214
|
-
export interface
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
|
|
4222
|
-
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
|
|
4146
|
+
export interface ItemFixedAssetAddRq {
|
|
4147
|
+
ItemFixedAssetAdd: ItemFixedAssetAdd;
|
|
4148
|
+
/** 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. */
|
|
4149
|
+
IncludeRetElement?: string[] | string;
|
|
4150
|
+
}
|
|
4151
|
+
export interface ItemFixedAssetAddRs {
|
|
4152
|
+
ItemFixedAssetRet?: ItemFixedAssetRet;
|
|
4153
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4154
|
+
}
|
|
4155
|
+
export interface ItemFixedAssetMod {
|
|
4156
|
+
/** 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. */
|
|
4157
|
+
ListID: string;
|
|
4158
|
+
/** 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. */
|
|
4159
|
+
EditSequence: string;
|
|
4160
|
+
/** 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. */
|
|
4161
|
+
Name?: string;
|
|
4162
|
+
/** Barcode reference information. */
|
|
4163
|
+
BarCode?: BarCode;
|
|
4164
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4165
|
+
IsActive?: boolean;
|
|
4166
|
+
/** 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. */
|
|
4167
|
+
ClassRef?: ClassRef;
|
|
4168
|
+
/** Indicates whether this item was new or used when the business acquired it. */
|
|
4169
|
+
AcquiredAs?: AcquiredAs;
|
|
4170
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4171
|
+
PurchaseDesc?: string;
|
|
4172
|
+
/** The date when this asset was purchased. */
|
|
4173
|
+
PurchaseDate?: string;
|
|
4174
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4175
|
+
PurchaseCost?: string;
|
|
4176
|
+
/** The name of the vendor from whom this asset was purchased. */
|
|
4177
|
+
VendorOrPayeeName?: string;
|
|
4178
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4179
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4180
|
+
/** Sales information, if this fixed asset was sold. */
|
|
4181
|
+
FixedAssetSalesInfoMod?: FixedAssetSalesInfoMod;
|
|
4182
|
+
/** Description of the asset—maker, brand, and so on. */
|
|
4183
|
+
AssetDesc?: string;
|
|
4184
|
+
/** Where the asset is located or has been placed into service. */
|
|
4185
|
+
Location?: string;
|
|
4186
|
+
/** Purchase order number. */
|
|
4187
|
+
PONumber?: string;
|
|
4227
4188
|
/** The serial number of the asset. */
|
|
4228
4189
|
SerialNumber?: string;
|
|
4229
|
-
/** The
|
|
4230
|
-
|
|
4231
|
-
/**
|
|
4232
|
-
|
|
4233
|
-
/**
|
|
4234
|
-
|
|
4235
|
-
/**
|
|
4236
|
-
|
|
4237
|
-
/**
|
|
4238
|
-
|
|
4239
|
-
/**
|
|
4240
|
-
|
|
4241
|
-
|
|
4242
|
-
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4190
|
+
/** The date when the warranty for this asset expires. */
|
|
4191
|
+
WarrantyExpDate?: string;
|
|
4192
|
+
/** Additional information. */
|
|
4193
|
+
Notes?: string;
|
|
4194
|
+
/** The number used by the QuickBooks Fixed Asset Manager to identify this asset. */
|
|
4195
|
+
AssetNumber?: string;
|
|
4196
|
+
/** The total cost of the fixed asset. This can include the cost of improvements or repairs. This amount is used to figure depreciation. */
|
|
4197
|
+
CostBasis?: string;
|
|
4198
|
+
/** The amount the fixed asset has lost in value since it was purchased, as of the end of the year. */
|
|
4199
|
+
YearEndAccumulatedDepreciation?: string;
|
|
4200
|
+
/** A reasonable estimate of the sales value of the fixed asset, as of the end of the year. */
|
|
4201
|
+
YearEndBookValue?: string;
|
|
4202
|
+
}
|
|
4203
|
+
export interface ItemFixedAssetModRq {
|
|
4204
|
+
ItemFixedAssetMod: ItemFixedAssetMod;
|
|
4205
|
+
/** 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. */
|
|
4206
|
+
IncludeRetElement?: string[] | string;
|
|
4207
|
+
}
|
|
4208
|
+
export interface ItemFixedAssetModRs {
|
|
4209
|
+
ItemFixedAssetRet?: ItemFixedAssetRet;
|
|
4210
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4211
|
+
}
|
|
4212
|
+
export interface ItemFixedAssetQueryRq {
|
|
4213
|
+
/** 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. */
|
|
4214
|
+
ListID?: string[] | string;
|
|
4215
|
+
/** 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. */
|
|
4216
|
+
FullName?: string[] | string;
|
|
4217
|
+
/** 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. */
|
|
4218
|
+
MaxReturned?: number;
|
|
4219
|
+
/** 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. */
|
|
4220
|
+
ActiveStatus?: ActiveStatus;
|
|
4221
|
+
/** 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). */
|
|
4222
|
+
FromModifiedDate?: string;
|
|
4223
|
+
/** 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). */
|
|
4224
|
+
ToModifiedDate?: string;
|
|
4225
|
+
/** Filters according to the object’s `Name`. */
|
|
4226
|
+
NameFilter?: NameFilter;
|
|
4227
|
+
/** Filters according to the object’s `Name`. */
|
|
4228
|
+
NameRangeFilter?: NameRangeFilter;
|
|
4229
|
+
/** Filters according to the object’s class. */
|
|
4230
|
+
ClassFilter?: ClassFilter;
|
|
4231
|
+
/** 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. */
|
|
4232
|
+
IncludeRetElement?: string[] | string;
|
|
4233
|
+
/** 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. */
|
|
4234
|
+
OwnerID?: string[] | string;
|
|
4235
|
+
}
|
|
4236
|
+
export interface ItemFixedAssetQueryRs {
|
|
4237
|
+
ItemFixedAssetRet: ItemFixedAssetRet[];
|
|
4238
|
+
}
|
|
4239
|
+
export interface ItemFixedAssetRet {
|
|
4240
|
+
/** 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. */
|
|
4241
|
+
ListID: string;
|
|
4242
|
+
/** Time the object was created. */
|
|
4243
|
+
TimeCreated: string;
|
|
4244
|
+
/** Time the object was last modified. */
|
|
4245
|
+
TimeModified: string;
|
|
4246
|
+
/** 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. */
|
|
4247
|
+
EditSequence: string;
|
|
4248
|
+
/** 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. */
|
|
4249
|
+
Name: string;
|
|
4250
|
+
/** Value of the barcode in the item. */
|
|
4251
|
+
BarCodeValue?: string;
|
|
4252
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4253
|
+
IsActive?: boolean;
|
|
4254
|
+
/** 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. */
|
|
4248
4255
|
ClassRef?: ClassRef;
|
|
4249
|
-
/**
|
|
4250
|
-
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
/** The
|
|
4254
|
-
|
|
4255
|
-
/**
|
|
4256
|
-
|
|
4257
|
-
/**
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
/**
|
|
4262
|
-
|
|
4256
|
+
/** Indicates whether this item was new or used when the business acquired it. */
|
|
4257
|
+
AcquiredAs: AcquiredAs;
|
|
4258
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4259
|
+
PurchaseDesc: string;
|
|
4260
|
+
/** The date when this asset was purchased. */
|
|
4261
|
+
PurchaseDate: string;
|
|
4262
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4263
|
+
PurchaseCost?: string;
|
|
4264
|
+
/** The name of the vendor from whom this asset was purchased. */
|
|
4265
|
+
VendorOrPayeeName?: string;
|
|
4266
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4267
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4268
|
+
/** Sales information, if this fixed asset was sold. */
|
|
4269
|
+
FixedAssetSalesInfo?: FixedAssetSalesInfo;
|
|
4270
|
+
/** Description of the asset—maker, brand, and so on. */
|
|
4271
|
+
AssetDesc?: string;
|
|
4272
|
+
/** Where the asset is located or has been placed into service. */
|
|
4273
|
+
Location?: string;
|
|
4274
|
+
/** Purchase order number. */
|
|
4275
|
+
PONumber?: string;
|
|
4276
|
+
/** The serial number of the asset. */
|
|
4277
|
+
SerialNumber?: string;
|
|
4278
|
+
/** The date when the warranty for this asset expires. */
|
|
4279
|
+
WarrantyExpDate?: string;
|
|
4280
|
+
/** Additional information. */
|
|
4281
|
+
Notes?: string;
|
|
4282
|
+
/** The number used by the QuickBooks Fixed Asset Manager to identify this asset. */
|
|
4283
|
+
AssetNumber?: string;
|
|
4284
|
+
/** The total cost of the fixed asset. This can include the cost of improvements or repairs. This amount is used to figure depreciation. */
|
|
4285
|
+
CostBasis?: string;
|
|
4286
|
+
/** The amount the fixed asset has lost in value since it was purchased, as of the end of the year. */
|
|
4287
|
+
YearEndAccumulatedDepreciation?: string;
|
|
4288
|
+
/** A reasonable estimate of the sales value of the fixed asset, as of the end of the year. */
|
|
4289
|
+
YearEndBookValue?: string;
|
|
4290
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4291
|
+
ExternalGUID?: string;
|
|
4263
4292
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4264
|
-
|
|
4293
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4265
4294
|
}
|
|
4266
|
-
export interface
|
|
4267
|
-
/**
|
|
4268
|
-
|
|
4269
|
-
|
|
4270
|
-
|
|
4271
|
-
/**
|
|
4272
|
-
|
|
4273
|
-
|
|
4274
|
-
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4295
|
+
export interface ItemGroupAdd {
|
|
4296
|
+
/** 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. */
|
|
4297
|
+
Name: string;
|
|
4298
|
+
/** Barcode reference information. */
|
|
4299
|
+
BarCode?: BarCode;
|
|
4300
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4301
|
+
IsActive?: boolean;
|
|
4302
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
4303
|
+
ItemDesc?: string;
|
|
4304
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4305
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4306
|
+
/** If true, a list of this group’s individual items their amounts will appear on printed forms. */
|
|
4307
|
+
IsPrintItemsInGroup?: boolean;
|
|
4308
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4309
|
+
ExternalGUID?: string;
|
|
4310
|
+
/** A list of `IItemGroupLine` objects, each representing one descriptive line of this item. */
|
|
4311
|
+
ItemGroupLine?: ItemGroupLine | ItemGroupLine[];
|
|
4312
|
+
}
|
|
4313
|
+
export interface ItemGroupAddRq {
|
|
4314
|
+
ItemGroupAdd: ItemGroupAdd;
|
|
4315
|
+
/** 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. */
|
|
4316
|
+
IncludeRetElement?: string[] | string;
|
|
4317
|
+
}
|
|
4318
|
+
export interface ItemGroupAddRs {
|
|
4319
|
+
ItemGroupRet?: ItemGroupRet;
|
|
4320
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4321
|
+
}
|
|
4322
|
+
export interface ItemGroupLine {
|
|
4323
|
+
/** 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. For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax `itemsFor` `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item.For `BillingRateAdd` requests, the `ItemRef` must refer to a service item. You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4278
4324
|
ItemRef?: ItemRef;
|
|
4325
|
+
/** `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. */
|
|
4326
|
+
Quantity?: number;
|
|
4327
|
+
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
4328
|
+
UnitOfMeasure?: string;
|
|
4329
|
+
}
|
|
4330
|
+
export interface ItemGroupLineAdd {
|
|
4331
|
+
/** `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. */
|
|
4332
|
+
ItemGroupRef: ItemGroupRef;
|
|
4333
|
+
/** `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. */
|
|
4334
|
+
Quantity?: number;
|
|
4335
|
+
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
4336
|
+
UnitOfMeasure?: string;
|
|
4279
4337
|
/** Site where inventory is located. */
|
|
4280
4338
|
InventorySiteRef?: InventorySiteRef;
|
|
4281
4339
|
/** Location within the Inventory Site. */
|
|
4282
4340
|
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
4283
|
-
/**
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
/**
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4341
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4342
|
+
DataExt?: DataExt | DataExt[];
|
|
4343
|
+
}
|
|
4344
|
+
export interface ItemGroupLineMod {
|
|
4345
|
+
/** 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.)
|
|
4346
|
+
|
|
4347
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
4348
|
+
TxnLineID: string;
|
|
4349
|
+
/** `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. */
|
|
4350
|
+
ItemGroupRef?: ItemGroupRef;
|
|
4291
4351
|
/** `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. */
|
|
4292
4352
|
Quantity?: number;
|
|
4293
4353
|
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
4294
4354
|
UnitOfMeasure?: string;
|
|
4295
4355
|
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
4296
4356
|
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
4297
|
-
/**
|
|
4298
|
-
|
|
4299
|
-
/** A monetary amount. */
|
|
4300
|
-
Amount?: string;
|
|
4301
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
4302
|
-
CustomerRef?: CustomerRef;
|
|
4303
|
-
/** 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.
|
|
4304
|
-
|
|
4305
|
-
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.
|
|
4306
|
-
|
|
4307
|
-
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. */
|
|
4308
|
-
ClassRef?: ClassRef;
|
|
4309
|
-
/** 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)
|
|
4310
|
-
|
|
4311
|
-
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.
|
|
4312
|
-
|
|
4313
|
-
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. */
|
|
4314
|
-
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4315
|
-
/** The billing status of this item line or expense line. */
|
|
4316
|
-
BillableStatus?: BillableStatus;
|
|
4317
|
-
/** Refers to a QuickBooks account. If you are using QB Online edition, you cannot specify an accounts receivable account here. If an `OverrideItemAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4318
|
-
OverrideItemAccountRef?: OverrideItemAccountRef;
|
|
4319
|
-
/** 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. */
|
|
4320
|
-
SalesRepRef?: SalesRepRef;
|
|
4357
|
+
/** 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.” */
|
|
4358
|
+
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
4321
4359
|
}
|
|
4322
|
-
export interface
|
|
4360
|
+
export interface ItemGroupLineRet {
|
|
4323
4361
|
/** 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.)
|
|
4324
4362
|
|
|
4325
4363
|
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
4326
4364
|
TxnLineID: string;
|
|
4327
|
-
/**
|
|
4328
|
-
|
|
4329
|
-
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
4330
|
-
|
|
4331
|
-
For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
4332
|
-
|
|
4333
|
-
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4334
|
-
ItemRef?: ItemRef;
|
|
4335
|
-
/** Site where inventory is located. */
|
|
4336
|
-
InventorySiteRef?: InventorySiteRef;
|
|
4337
|
-
/** Location within the Inventory Site. */
|
|
4338
|
-
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
4339
|
-
/** The serial number of the asset. */
|
|
4340
|
-
SerialNumber?: string;
|
|
4341
|
-
/** The lot number of the asset. */
|
|
4342
|
-
LotNumber?: string;
|
|
4343
|
-
/** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0. */
|
|
4344
|
-
ExpirationDateForSerialLotNumber?: string;
|
|
4365
|
+
/** `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. */
|
|
4366
|
+
ItemGroupRef: ItemGroupRef;
|
|
4345
4367
|
/** A descriptive text field. */
|
|
4346
4368
|
Desc?: string;
|
|
4347
4369
|
/** `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. */
|
|
@@ -4350,70 +4372,237 @@ export interface ItemLineRet {
|
|
|
4350
4372
|
UnitOfMeasure?: string;
|
|
4351
4373
|
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
4352
4374
|
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
4353
|
-
/**
|
|
4354
|
-
|
|
4355
|
-
/** A
|
|
4356
|
-
|
|
4357
|
-
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
4358
|
-
CustomerRef?: CustomerRef;
|
|
4359
|
-
/** 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.
|
|
4360
|
-
|
|
4361
|
-
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.
|
|
4362
|
-
|
|
4363
|
-
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. */
|
|
4364
|
-
ClassRef?: ClassRef;
|
|
4365
|
-
/** 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)
|
|
4366
|
-
|
|
4367
|
-
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.
|
|
4368
|
-
|
|
4369
|
-
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. */
|
|
4370
|
-
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4371
|
-
/** The billing status of this item line or expense line. */
|
|
4372
|
-
BillableStatus?: BillableStatus;
|
|
4373
|
-
/** 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. */
|
|
4374
|
-
SalesRepRef?: SalesRepRef;
|
|
4375
|
+
/** Total amount of money paid or received. In a receive payment add transaction that has payment amount elements (such as `AppliedToTxnAdd` lines) you must supply a `TotalAmount` and the sum of all the `PaymentAmount` elements must not be greater than the `TotalAmount`. */
|
|
4376
|
+
TotalAmount: string;
|
|
4377
|
+
/** 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.” */
|
|
4378
|
+
ItemLineRet?: ItemLineRet | ItemLineRet[];
|
|
4375
4379
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4376
|
-
|
|
4380
|
+
DataExt?: DataExt | DataExt[];
|
|
4377
4381
|
}
|
|
4378
|
-
export interface
|
|
4382
|
+
export interface ItemGroupMod {
|
|
4383
|
+
/** 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. */
|
|
4384
|
+
ListID: string;
|
|
4385
|
+
/** 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. */
|
|
4386
|
+
EditSequence: string;
|
|
4379
4387
|
/** 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. */
|
|
4380
|
-
Name
|
|
4388
|
+
Name?: string;
|
|
4381
4389
|
/** Barcode reference information. */
|
|
4382
4390
|
BarCode?: BarCode;
|
|
4383
4391
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4384
4392
|
IsActive?: boolean;
|
|
4385
|
-
/**
|
|
4386
|
-
|
|
4387
|
-
/** 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. */
|
|
4388
|
-
ClassRef?: ClassRef;
|
|
4389
|
-
/** The part number used by the manufacturer of the item. */
|
|
4390
|
-
ManufacturerPartNumber?: string;
|
|
4393
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
4394
|
+
ItemDesc?: string;
|
|
4391
4395
|
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4392
4396
|
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4393
|
-
/**
|
|
4394
|
-
|
|
4395
|
-
/**
|
|
4396
|
-
|
|
4397
|
-
/**
|
|
4398
|
-
|
|
4399
|
-
/** A `
|
|
4400
|
-
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
4404
|
-
export interface ItemNonInventoryAddRq {
|
|
4405
|
-
ItemNonInventoryAdd: ItemNonInventoryAdd;
|
|
4397
|
+
/** By Default `ForceUOMChange` is false. However, in item Mod requests, you need to set the `ForceUOMChange` field to True if you are changing the UOM set and the base unit of the new set does not match the base unit of the UOM set currently assigned to the item. This does the same thing as the user accepting the warning prompt in the UI. If you don’t set `ForceUOMChange` to True, you’ll get an error when you invoke the Item* Mod request.Y You should be aware that if you change the base unit for an item, you should also change the item’s quantities on hand and cost to reflect the new unit; otherwise the values will be inaccurate. An alternative to handle such UOM changes to an item is to create a new item with the desired UOM set and inactivate the old item. */
|
|
4398
|
+
ForceUOMChange?: boolean;
|
|
4399
|
+
/** If true, a list of this group’s individual items their amounts will appear on printed forms. */
|
|
4400
|
+
IsPrintItemsInGroup?: boolean;
|
|
4401
|
+
/** Set to true to clear all the items in this group. */
|
|
4402
|
+
ClearItemsInGroup?: boolean;
|
|
4403
|
+
/** A list of `IItemGroupLine` objects, each representing one descriptive line of this item. */
|
|
4404
|
+
ItemGroupLine?: ItemGroupLine | ItemGroupLine[];
|
|
4405
|
+
}
|
|
4406
|
+
export interface ItemGroupModRq {
|
|
4407
|
+
ItemGroupMod: ItemGroupMod;
|
|
4406
4408
|
/** 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. */
|
|
4407
4409
|
IncludeRetElement?: string[] | string;
|
|
4408
4410
|
}
|
|
4409
|
-
export interface
|
|
4410
|
-
|
|
4411
|
+
export interface ItemGroupModRs {
|
|
4412
|
+
ItemGroupRet?: ItemGroupRet;
|
|
4411
4413
|
ErrorRecovery?: ErrorRecovery;
|
|
4412
4414
|
}
|
|
4413
|
-
export interface
|
|
4414
|
-
/** 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. */
|
|
4415
|
-
ListID
|
|
4416
|
-
/** A
|
|
4415
|
+
export interface ItemGroupQueryRq {
|
|
4416
|
+
/** 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. */
|
|
4417
|
+
ListID?: string[] | string;
|
|
4418
|
+
/** 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. */
|
|
4419
|
+
FullName?: string[] | string;
|
|
4420
|
+
/** 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. */
|
|
4421
|
+
MaxReturned?: number;
|
|
4422
|
+
/** 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. */
|
|
4423
|
+
ActiveStatus?: ActiveStatus;
|
|
4424
|
+
/** 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). */
|
|
4425
|
+
FromModifiedDate?: string;
|
|
4426
|
+
/** 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). */
|
|
4427
|
+
ToModifiedDate?: string;
|
|
4428
|
+
/** Filters according to the object’s `Name`. */
|
|
4429
|
+
NameFilter?: NameFilter;
|
|
4430
|
+
/** Filters according to the object’s `Name`. */
|
|
4431
|
+
NameRangeFilter?: NameRangeFilter;
|
|
4432
|
+
/** 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. */
|
|
4433
|
+
IncludeRetElement?: string[] | string;
|
|
4434
|
+
/** 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. */
|
|
4435
|
+
OwnerID?: string[] | string;
|
|
4436
|
+
}
|
|
4437
|
+
export interface ItemGroupQueryRs {
|
|
4438
|
+
ItemGroupRet: ItemGroupRet[];
|
|
4439
|
+
}
|
|
4440
|
+
export interface ItemGroupRef {
|
|
4441
|
+
/** 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. */
|
|
4442
|
+
ListID?: string;
|
|
4443
|
+
/** `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. */
|
|
4444
|
+
FullName?: string;
|
|
4445
|
+
}
|
|
4446
|
+
export interface ItemGroupRet {
|
|
4447
|
+
/** 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. */
|
|
4448
|
+
ListID: string;
|
|
4449
|
+
/** Time the object was created. */
|
|
4450
|
+
TimeCreated: string;
|
|
4451
|
+
/** Time the object was last modified. */
|
|
4452
|
+
TimeModified: string;
|
|
4453
|
+
/** 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. */
|
|
4454
|
+
EditSequence: string;
|
|
4455
|
+
/** 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. */
|
|
4456
|
+
Name: string;
|
|
4457
|
+
/** Value of the barcode in the item. */
|
|
4458
|
+
BarCodeValue?: string;
|
|
4459
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4460
|
+
IsActive?: boolean;
|
|
4461
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
4462
|
+
ItemDesc?: string;
|
|
4463
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4464
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4465
|
+
/** If true, a list of this group’s individual items their amounts will appear on printed forms. */
|
|
4466
|
+
IsPrintItemsInGroup?: boolean;
|
|
4467
|
+
/** Identifies the type of special item. See type for possible enum values. */
|
|
4468
|
+
SpecialItemType?: SpecialItemType;
|
|
4469
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4470
|
+
ExternalGUID?: string;
|
|
4471
|
+
/** A list of `IItemGroupLine` objects, each representing one descriptive line of this item. */
|
|
4472
|
+
ItemGroupLine?: ItemGroupLine | ItemGroupLine[];
|
|
4473
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4474
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4475
|
+
}
|
|
4476
|
+
export interface ItemInventoryAdd {
|
|
4477
|
+
/** 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. */
|
|
4478
|
+
Name: string;
|
|
4479
|
+
/** Barcode reference information. */
|
|
4480
|
+
BarCode?: BarCode;
|
|
4481
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4482
|
+
IsActive?: boolean;
|
|
4483
|
+
/** 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. */
|
|
4484
|
+
ClassRef?: ClassRef;
|
|
4485
|
+
/** 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. */
|
|
4486
|
+
ParentRef?: ParentRef;
|
|
4487
|
+
/** The part number used by the manufacturer of the item. */
|
|
4488
|
+
ManufacturerPartNumber?: string;
|
|
4489
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4490
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4491
|
+
/** For future use with international versions of QuickBooks. */
|
|
4492
|
+
IsTaxIncluded?: boolean;
|
|
4493
|
+
/** 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. */
|
|
4494
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4495
|
+
/** 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). */
|
|
4496
|
+
SalesDesc?: string;
|
|
4497
|
+
/** Price charged for this item. */
|
|
4498
|
+
SalesPrice?: string;
|
|
4499
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4500
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4501
|
+
/** Appears in the `Description` column of checks, bills, credit card charges, and item receipts when this item is reordered. */
|
|
4502
|
+
PurchaseDesc?: string;
|
|
4503
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4504
|
+
PurchaseCost?: string;
|
|
4505
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4506
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4507
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4508
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4509
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4510
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4511
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4512
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4513
|
+
/** Quantity at which QuickBooks will remind the user to reorder this inventory item. */
|
|
4514
|
+
ReorderPoint?: number;
|
|
4515
|
+
/** Maximum number of items in inventory. */
|
|
4516
|
+
Max?: number;
|
|
4517
|
+
/** The number of these items in inventory. `QuantityOnHand` times `AverageCost` is `TotalValue` in an inventory item list. To change the `QuantityOnHand` for an item, you would have to use `InventoryAdjustmentAdd` not an `ItemInventoryMod`. */
|
|
4518
|
+
QuantityOnHand?: number;
|
|
4519
|
+
/** The total value of this inventory. If `TotalValue` is included, `QuantityOnHand` must also be included and must be greater than zero. If both `QuantityOnHand` and `PurchaseCost` are included, then `TotalValue` will be set to `QuantityOnHand` times `PurchaseCost`, regardless of what `TotalValue` is explicitly set to. */
|
|
4520
|
+
TotalValue?: string;
|
|
4521
|
+
/** The date when an item was converted into an inventory item from some other type of item. */
|
|
4522
|
+
InventoryDate?: string;
|
|
4523
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4524
|
+
ExternalGUID?: string;
|
|
4525
|
+
}
|
|
4526
|
+
export interface ItemInventoryAddRq {
|
|
4527
|
+
ItemInventoryAdd: ItemInventoryAdd;
|
|
4528
|
+
/** 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. */
|
|
4529
|
+
IncludeRetElement?: string[] | string;
|
|
4530
|
+
}
|
|
4531
|
+
export interface ItemInventoryAddRs {
|
|
4532
|
+
ItemInventoryRet?: ItemInventoryRet;
|
|
4533
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4534
|
+
}
|
|
4535
|
+
export interface ItemInventoryAssemblyAdd {
|
|
4536
|
+
/** 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. */
|
|
4537
|
+
Name: string;
|
|
4538
|
+
/** Barcode reference information. */
|
|
4539
|
+
BarCode?: BarCode;
|
|
4540
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4541
|
+
IsActive?: boolean;
|
|
4542
|
+
/** 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. */
|
|
4543
|
+
ClassRef?: ClassRef;
|
|
4544
|
+
/** 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. */
|
|
4545
|
+
ParentRef?: ParentRef;
|
|
4546
|
+
/** The part number used by the manufacturer of the item. */
|
|
4547
|
+
ManufacturerPartNumber?: string;
|
|
4548
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4549
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4550
|
+
/** For future use with international versions of QuickBooks. */
|
|
4551
|
+
IsTaxIncluded?: boolean;
|
|
4552
|
+
/** 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. */
|
|
4553
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4554
|
+
/** 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). */
|
|
4555
|
+
SalesDesc?: string;
|
|
4556
|
+
/** Price charged for this item. */
|
|
4557
|
+
SalesPrice?: string;
|
|
4558
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4559
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4560
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4561
|
+
PurchaseDesc?: string;
|
|
4562
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4563
|
+
PurchaseCost?: string;
|
|
4564
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4565
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4566
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4567
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4568
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4569
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4570
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4571
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4572
|
+
/** The build notification point. The QuickBooks user will receive a notification when `QuantityOnHand` plus `QuantityOnOrder` falls below `BuildPoint`. */
|
|
4573
|
+
BuildPoint?: number;
|
|
4574
|
+
/** Maximum number of items in inventory. */
|
|
4575
|
+
Max?: number;
|
|
4576
|
+
/** The number of these items in inventory. `QuantityOnHand` times `AverageCost` is `TotalValue` in an inventory item list. To change the `QuantityOnHand` for an item, you would have to use `InventoryAdjustmentAdd` not an `ItemInventoryMod`. */
|
|
4577
|
+
QuantityOnHand?: number;
|
|
4578
|
+
/** The total value of this inventory. If `TotalValue` is included, `QuantityOnHand` must also be included and must be greater than zero. If both `QuantityOnHand` and `PurchaseCost` are included, then `TotalValue` will be set to `QuantityOnHand` times `PurchaseCost`, regardless of what `TotalValue` is explicitly set to. */
|
|
4579
|
+
TotalValue?: string;
|
|
4580
|
+
/** The date when an item was converted into an inventory item from some other type of item. */
|
|
4581
|
+
InventoryDate?: string;
|
|
4582
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4583
|
+
ExternalGUID?: string;
|
|
4584
|
+
/** A list of `IItemInventoryAssemblyLine` objects, each representing one line in the inventory-assembly item. */
|
|
4585
|
+
ItemInventoryAssemblyLine?: ItemInventoryAssemblyLine | ItemInventoryAssemblyLine[];
|
|
4586
|
+
}
|
|
4587
|
+
export interface ItemInventoryAssemblyAddRq {
|
|
4588
|
+
ItemInventoryAssemblyAdd: ItemInventoryAssemblyAdd;
|
|
4589
|
+
/** 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. */
|
|
4590
|
+
IncludeRetElement?: string[] | string;
|
|
4591
|
+
}
|
|
4592
|
+
export interface ItemInventoryAssemblyAddRs {
|
|
4593
|
+
ItemInventoryAssemblyRet?: ItemInventoryAssemblyRet;
|
|
4594
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4595
|
+
}
|
|
4596
|
+
export interface ItemInventoryAssemblyLine {
|
|
4597
|
+
/** An inventory item is any merchandise or part that a business purchases, tracks as inventory, and then resells. In QuickBooks, information about an inventory item is grouped into three categories:Puchase Information includes `PurchaseDesc`, `PurchaseCost`, `COGSAccountRef`, and `PrefVendorRef`. Sales Information includes `SalesDesc`, `SalesPrice`, and `SalesTaxCodeRef`. Inventory Information includes `AssetAccountRef`, `ReorderPoint`, `QuantityOnHand`, `TotalValue`, and `InventoryDate`. The Life Cycle of Inventory Items and Effects of Sales and Purchases The value of inventory is set when an inventory item is created or bought. QuickBooks uses cost averaging and decreases the value of the inventory asset account at the price when the sale is recorded. So, lets say a company starts carrying widgets as inventory items. First the inventory item must be created in QuickBooks. If the widgets are already in inventory based on a purchase made that will not be recorded in QuickBooks, the user or application would add the inventory item description along with the quantity on hand and the value (total purchase price) of the quantity on hand. If the purchase is to be recorded in QuickBooks the inventory item would be created with quantity and value of 0 (zero). Then a bill would be added to QB which would increase the inventory quantity and value. Lets say we bought 10 widgets for $100. QuickBooks would then consider each widget to be worth $10. The next day a customer buys 5 widgets for $20 each. A sales receipt or invoice is created for the purchase, the quantity of widgets is reduced by 5, to 5 and the value is reduced by $50 to $50. The inventory asset account is reduced by $50 and the undeposited funds or accounts receivable account is increased by $100. It appears that widgets will be a big seller, so the small business owner goes out and buys 10 more widgets. However, the supplier has also noticed a widget buying trend, so he’s increased the price to $25 each. So now our quantity is increased from 5 to 15 and the value is increased from $50 to $300, so they are considered to be worth $20 each. After purchasing the widgets another customer decides to buy 10 widgets but the price has been raised to $50 each. After the sales receipt or invoice is entered, the inventory is reduced to 5 and the value is reduced to $100. The inventory asset account is reduced by $200 and the undeposited funds or accounts receivable account is increased by $500. An `ItemInventoryRef` aggregate refers to an inventory item. In a request, if an `ItemInventoryRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4598
|
+
ItemInventoryRef: ItemInventoryRef;
|
|
4599
|
+
/** `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. */
|
|
4600
|
+
Quantity?: number;
|
|
4601
|
+
}
|
|
4602
|
+
export interface ItemInventoryAssemblyMod {
|
|
4603
|
+
/** 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. */
|
|
4604
|
+
ListID: string;
|
|
4605
|
+
/** 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. */
|
|
4417
4606
|
EditSequence: string;
|
|
4418
4607
|
/** 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. */
|
|
4419
4608
|
Name?: string;
|
|
@@ -4435,21 +4624,1169 @@ export interface ItemNonInventoryMod {
|
|
|
4435
4624
|
IsTaxIncluded?: boolean;
|
|
4436
4625
|
/** 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. */
|
|
4437
4626
|
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4438
|
-
/**
|
|
4439
|
-
|
|
4440
|
-
/**
|
|
4441
|
-
|
|
4627
|
+
/** 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). */
|
|
4628
|
+
SalesDesc?: string;
|
|
4629
|
+
/** Price charged for this item. */
|
|
4630
|
+
SalesPrice?: string;
|
|
4631
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4632
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4633
|
+
/** 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. */
|
|
4634
|
+
ApplyIncomeAccountRefToExistingTxns?: boolean;
|
|
4635
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4636
|
+
PurchaseDesc?: string;
|
|
4637
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4638
|
+
PurchaseCost?: string;
|
|
4639
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4640
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4641
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4642
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4643
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4644
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4645
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4646
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4647
|
+
/** The build notification point. The QuickBooks user will receive a notification when `QuantityOnHand` plus `QuantityOnOrder` falls below `BuildPoint`. */
|
|
4648
|
+
BuildPoint?: number;
|
|
4649
|
+
/** Maximum number of items in inventory. */
|
|
4650
|
+
Max?: number;
|
|
4651
|
+
/** Set to true to clear all the items in this group. */
|
|
4652
|
+
ClearItemsInGroup?: boolean;
|
|
4653
|
+
/** A list of `IItemInventoryAssemblyLine` objects, each representing one line in the inventory-assembly item. */
|
|
4654
|
+
ItemInventoryAssemblyLine?: ItemInventoryAssemblyLine | ItemInventoryAssemblyLine[];
|
|
4442
4655
|
}
|
|
4443
|
-
export interface
|
|
4444
|
-
|
|
4656
|
+
export interface ItemInventoryAssemblyModRq {
|
|
4657
|
+
ItemInventoryAssemblyMod: ItemInventoryAssemblyMod;
|
|
4658
|
+
/** 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. */
|
|
4659
|
+
IncludeRetElement?: string[] | string;
|
|
4660
|
+
}
|
|
4661
|
+
export interface ItemInventoryAssemblyModRs {
|
|
4662
|
+
ItemInventoryAssemblyRet?: ItemInventoryAssemblyRet;
|
|
4663
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4664
|
+
}
|
|
4665
|
+
export interface ItemInventoryAssemblyQueryRq {
|
|
4666
|
+
/** 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. */
|
|
4667
|
+
ListID?: string[] | string;
|
|
4668
|
+
/** 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. */
|
|
4669
|
+
FullName?: string[] | string;
|
|
4670
|
+
/** 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. */
|
|
4671
|
+
MaxReturned?: number;
|
|
4672
|
+
/** 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. */
|
|
4673
|
+
ActiveStatus?: ActiveStatus;
|
|
4674
|
+
/** 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). */
|
|
4675
|
+
FromModifiedDate?: string;
|
|
4676
|
+
/** 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). */
|
|
4677
|
+
ToModifiedDate?: string;
|
|
4678
|
+
/** Filters according to the object’s `Name`. */
|
|
4679
|
+
NameFilter?: NameFilter;
|
|
4680
|
+
/** Filters according to the object’s `Name`. */
|
|
4681
|
+
NameRangeFilter?: NameRangeFilter;
|
|
4682
|
+
/** Filters according to the object’s class. */
|
|
4683
|
+
ClassFilter?: ClassFilter;
|
|
4684
|
+
/** 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. */
|
|
4685
|
+
IncludeRetElement?: string[] | string;
|
|
4686
|
+
/** 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. */
|
|
4687
|
+
OwnerID?: string[] | string;
|
|
4688
|
+
}
|
|
4689
|
+
export interface ItemInventoryAssemblyQueryRs {
|
|
4690
|
+
ItemInventoryAssemblyRet: ItemInventoryAssemblyRet[];
|
|
4691
|
+
}
|
|
4692
|
+
export interface ItemInventoryAssemblyRet {
|
|
4693
|
+
/** 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. */
|
|
4694
|
+
ListID: string;
|
|
4695
|
+
/** Time the object was created. */
|
|
4696
|
+
TimeCreated: string;
|
|
4697
|
+
/** Time the object was last modified. */
|
|
4698
|
+
TimeModified: string;
|
|
4699
|
+
/** 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. */
|
|
4700
|
+
EditSequence: string;
|
|
4701
|
+
/** 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. */
|
|
4702
|
+
Name: string;
|
|
4703
|
+
/** `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. */
|
|
4704
|
+
FullName: string;
|
|
4705
|
+
/** Value of the barcode in the item. */
|
|
4706
|
+
BarCodeValue?: string;
|
|
4707
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4708
|
+
IsActive?: boolean;
|
|
4709
|
+
/** 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. */
|
|
4710
|
+
ClassRef?: ClassRef;
|
|
4711
|
+
/** 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. */
|
|
4712
|
+
ParentRef?: ParentRef;
|
|
4713
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
4714
|
+
Sublevel: number;
|
|
4715
|
+
/** The part number used by the manufacturer of the item. */
|
|
4716
|
+
ManufacturerPartNumber?: string;
|
|
4717
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4718
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4719
|
+
/** For future use with international versions of QuickBooks. */
|
|
4720
|
+
IsTaxIncluded?: boolean;
|
|
4721
|
+
/** 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. */
|
|
4722
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4723
|
+
/** 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). */
|
|
4724
|
+
SalesDesc?: string;
|
|
4725
|
+
/** Price charged for this item. */
|
|
4726
|
+
SalesPrice?: string;
|
|
4727
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4728
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4729
|
+
/** Description that appears in the `Description` column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased. */
|
|
4730
|
+
PurchaseDesc?: string;
|
|
4731
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4732
|
+
PurchaseCost?: string;
|
|
4733
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4734
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4735
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4736
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4737
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4738
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4739
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4740
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4741
|
+
/** The build notification point. The QuickBooks user will receive a notification when `QuantityOnHand` plus `QuantityOnOrder` falls below `BuildPoint`. */
|
|
4742
|
+
BuildPoint?: number;
|
|
4743
|
+
/** Maximum number of items in inventory. */
|
|
4744
|
+
Max?: number;
|
|
4745
|
+
/** The number of these items in inventory. `QuantityOnHand` times `AverageCost` is `TotalValue` in an inventory item list. To change the `QuantityOnHand` for an item, you would have to use `InventoryAdjustmentAdd` not an `ItemInventoryMod`. */
|
|
4746
|
+
QuantityOnHand?: number;
|
|
4747
|
+
/** `AverageCost` is the total value of this item divided by `QuantityOnHand`. Initially the total value is the same as the `QuantityOnHand` times the `PurchaseCost` (so `AverageCost` equals `PurchaseCost`). However, the total value can be changed by an inventory adjustment so that it no longer matches `QuantityOnHand` times `PurchaseCost`. */
|
|
4748
|
+
AverageCost?: string;
|
|
4749
|
+
/** The number of these items that have been ordered from vendors (as recorded in purchase orders) but not received. */
|
|
4750
|
+
QuantityOnOrder?: number;
|
|
4751
|
+
/** The number of these items that have been sold (as recorded in sales orders) but not delivered to customers. */
|
|
4752
|
+
QuantityOnSalesOrder?: number;
|
|
4753
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4754
|
+
ExternalGUID?: string;
|
|
4755
|
+
/** A list of `IItemInventoryAssemblyLine` objects, each representing one line in the inventory-assembly item. */
|
|
4756
|
+
ItemInventoryAssemblyLine?: ItemInventoryAssemblyLine | ItemInventoryAssemblyLine[];
|
|
4757
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4758
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4759
|
+
}
|
|
4760
|
+
export interface ItemInventoryMod {
|
|
4761
|
+
/** 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. */
|
|
4762
|
+
ListID: string;
|
|
4763
|
+
/** 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. */
|
|
4764
|
+
EditSequence: string;
|
|
4765
|
+
/** 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. */
|
|
4766
|
+
Name?: string;
|
|
4767
|
+
/** Barcode reference information. */
|
|
4768
|
+
BarCode?: BarCode;
|
|
4769
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4770
|
+
IsActive?: boolean;
|
|
4771
|
+
/** 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. */
|
|
4772
|
+
ClassRef?: ClassRef;
|
|
4773
|
+
/** 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. */
|
|
4774
|
+
ParentRef?: ParentRef;
|
|
4775
|
+
/** The part number used by the manufacturer of the item. */
|
|
4776
|
+
ManufacturerPartNumber?: string;
|
|
4777
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4778
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4779
|
+
/** By Default `ForceUOMChange` is false. However, in item Mod requests, you need to set the `ForceUOMChange` field to True if you are changing the UOM set and the base unit of the new set does not match the base unit of the UOM set currently assigned to the item. This does the same thing as the user accepting the warning prompt in the UI. If you don’t set `ForceUOMChange` to True, you’ll get an error when you invoke the Item* Mod request.Y You should be aware that if you change the base unit for an item, you should also change the item’s quantities on hand and cost to reflect the new unit; otherwise the values will be inaccurate. An alternative to handle such UOM changes to an item is to create a new item with the desired UOM set and inactivate the old item. */
|
|
4780
|
+
ForceUOMChange?: boolean;
|
|
4781
|
+
/** For future use with international versions of QuickBooks. */
|
|
4782
|
+
IsTaxIncluded?: boolean;
|
|
4783
|
+
/** 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. */
|
|
4784
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4785
|
+
/** 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). */
|
|
4786
|
+
SalesDesc?: string;
|
|
4787
|
+
/** Price charged for this item. */
|
|
4788
|
+
SalesPrice?: string;
|
|
4789
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4790
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4791
|
+
/** 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. */
|
|
4792
|
+
ApplyIncomeAccountRefToExistingTxns?: boolean;
|
|
4793
|
+
/** Appears in the `Description` column of checks, bills, credit card charges, and item receipts when this item is reordered. */
|
|
4794
|
+
PurchaseDesc?: string;
|
|
4795
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4796
|
+
PurchaseCost?: string;
|
|
4797
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4798
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4799
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4800
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4801
|
+
/** Effectively suppresses the UI prompt that is displayed upon a COGS account change when existing transactions use the account. */
|
|
4802
|
+
ApplyCOGSAccountRefToExistingTxns?: boolean;
|
|
4803
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4804
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4805
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4806
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4807
|
+
/** Quantity at which QuickBooks will remind the user to reorder this inventory item. */
|
|
4808
|
+
ReorderPoint?: number;
|
|
4809
|
+
/** Maximum number of items in inventory. */
|
|
4810
|
+
Max?: number;
|
|
4811
|
+
}
|
|
4812
|
+
export interface ItemInventoryModRq {
|
|
4813
|
+
ItemInventoryMod: ItemInventoryMod;
|
|
4814
|
+
/** 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. */
|
|
4815
|
+
IncludeRetElement?: string[] | string;
|
|
4816
|
+
}
|
|
4817
|
+
export interface ItemInventoryModRs {
|
|
4818
|
+
ItemInventoryRet?: ItemInventoryRet;
|
|
4819
|
+
ErrorRecovery?: ErrorRecovery;
|
|
4820
|
+
}
|
|
4821
|
+
export interface ItemInventoryQueryRq {
|
|
4822
|
+
/** 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. */
|
|
4823
|
+
ListID?: string[] | string;
|
|
4824
|
+
/** 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. */
|
|
4825
|
+
FullName?: string[] | string;
|
|
4826
|
+
/** 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. */
|
|
4827
|
+
MaxReturned?: number;
|
|
4828
|
+
/** 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. */
|
|
4829
|
+
ActiveStatus?: ActiveStatus;
|
|
4830
|
+
/** 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). */
|
|
4831
|
+
FromModifiedDate?: string;
|
|
4832
|
+
/** 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). */
|
|
4833
|
+
ToModifiedDate?: string;
|
|
4834
|
+
/** Filters according to the object’s `Name`. */
|
|
4835
|
+
NameFilter?: NameFilter;
|
|
4836
|
+
/** Filters according to the object’s `Name`. */
|
|
4837
|
+
NameRangeFilter?: NameRangeFilter;
|
|
4838
|
+
/** Filters according to the object’s class. */
|
|
4839
|
+
ClassFilter?: ClassFilter;
|
|
4840
|
+
/** 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. */
|
|
4841
|
+
IncludeRetElement?: string[] | string;
|
|
4842
|
+
/** 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. */
|
|
4843
|
+
OwnerID?: string[] | string;
|
|
4844
|
+
}
|
|
4845
|
+
export interface ItemInventoryQueryRs {
|
|
4846
|
+
ItemInventoryRet: ItemInventoryRet[];
|
|
4847
|
+
}
|
|
4848
|
+
export interface ItemInventoryRef {
|
|
4849
|
+
/** 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. */
|
|
4850
|
+
ListID?: string;
|
|
4851
|
+
/** `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. */
|
|
4852
|
+
FullName?: string;
|
|
4853
|
+
}
|
|
4854
|
+
export interface ItemInventoryRet {
|
|
4855
|
+
/** 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. */
|
|
4856
|
+
ListID: string;
|
|
4857
|
+
/** Time the object was created. */
|
|
4858
|
+
TimeCreated: string;
|
|
4859
|
+
/** Time the object was last modified. */
|
|
4860
|
+
TimeModified: string;
|
|
4861
|
+
/** 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. */
|
|
4862
|
+
EditSequence: string;
|
|
4863
|
+
/** 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. */
|
|
4864
|
+
Name: string;
|
|
4865
|
+
/** `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. */
|
|
4866
|
+
FullName: string;
|
|
4867
|
+
/** Value of the barcode in the item. */
|
|
4868
|
+
BarCodeValue?: string;
|
|
4869
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4870
|
+
IsActive?: boolean;
|
|
4871
|
+
/** 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. */
|
|
4872
|
+
ClassRef?: ClassRef;
|
|
4873
|
+
/** 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. */
|
|
4874
|
+
ParentRef?: ParentRef;
|
|
4875
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
4876
|
+
Sublevel: number;
|
|
4877
|
+
/** The part number used by the manufacturer of the item. */
|
|
4878
|
+
ManufacturerPartNumber?: string;
|
|
4879
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
4880
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
4881
|
+
/** For future use with international versions of QuickBooks. */
|
|
4882
|
+
IsTaxIncluded?: boolean;
|
|
4883
|
+
/** 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. */
|
|
4884
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4885
|
+
/** 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). */
|
|
4886
|
+
SalesDesc?: string;
|
|
4887
|
+
/** Price charged for this item. */
|
|
4888
|
+
SalesPrice?: string;
|
|
4889
|
+
/** Refers to an income account. If an `IncomeAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4890
|
+
IncomeAccountRef?: IncomeAccountRef;
|
|
4891
|
+
/** Appears in the `Description` column of checks, bills, credit card charges, and item receipts when this item is reordered. */
|
|
4892
|
+
PurchaseDesc?: string;
|
|
4893
|
+
/** Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. */
|
|
4894
|
+
PurchaseCost?: string;
|
|
4895
|
+
/** Account used for taxes on purchases in CA or UK. */
|
|
4896
|
+
PurchaseTaxCodeRef?: PurchaseTaxCodeRef;
|
|
4897
|
+
/** Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The `AccountType` of this account will be `CostOfGoodsSold`.) In a request, if a `COGSAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4898
|
+
COGSAccountRef?: COGSAccountRef;
|
|
4899
|
+
/** The preferred vendor for this item. If a `PrefVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4900
|
+
PrefVendorRef?: PrefVendorRef;
|
|
4901
|
+
/** Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The `AccountType` of this account will be `FixedAsset`, `OtherAsset`, or `OtherCurrentAsset`.) In a request, if an `AssetAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4902
|
+
AssetAccountRef?: AssetAccountRef;
|
|
4903
|
+
/** Quantity at which QuickBooks will remind the user to reorder this inventory item. */
|
|
4904
|
+
ReorderPoint?: number;
|
|
4905
|
+
/** Maximum number of items in inventory. */
|
|
4906
|
+
Max?: number;
|
|
4907
|
+
/** The number of these items in inventory. `QuantityOnHand` times `AverageCost` is `TotalValue` in an inventory item list. To change the `QuantityOnHand` for an item, you would have to use `InventoryAdjustmentAdd` not an `ItemInventoryMod`. */
|
|
4908
|
+
QuantityOnHand?: number;
|
|
4909
|
+
/** `AverageCost` is the total value of this item divided by `QuantityOnHand`. Initially the total value is the same as the `QuantityOnHand` times the `PurchaseCost` (so `AverageCost` equals `PurchaseCost`). However, the total value can be changed by an inventory adjustment so that it no longer matches `QuantityOnHand` times `PurchaseCost`. */
|
|
4910
|
+
AverageCost?: string;
|
|
4911
|
+
/** The number of these items that have been ordered from vendors (as recorded in purchase orders) but not received. */
|
|
4912
|
+
QuantityOnOrder?: number;
|
|
4913
|
+
/** The number of these items that have been sold (as recorded in sales orders) but not delivered to customers. */
|
|
4914
|
+
QuantityOnSalesOrder?: number;
|
|
4915
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
4916
|
+
ExternalGUID?: string;
|
|
4917
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4918
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4919
|
+
}
|
|
4920
|
+
export interface ItemLineAdd {
|
|
4921
|
+
/** 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.
|
|
4922
|
+
|
|
4923
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
4924
|
+
|
|
4925
|
+
For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
4926
|
+
|
|
4927
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4928
|
+
ItemRef?: ItemRef;
|
|
4929
|
+
/** Site where inventory is located. */
|
|
4930
|
+
InventorySiteRef?: InventorySiteRef;
|
|
4931
|
+
/** Location within the Inventory Site. */
|
|
4932
|
+
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
4933
|
+
/** The serial number of the asset. */
|
|
4934
|
+
SerialNumber?: string;
|
|
4935
|
+
/** The lot number of the asset. */
|
|
4936
|
+
LotNumber?: string;
|
|
4937
|
+
/** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0. */
|
|
4938
|
+
ExpirationDateForSerialLotNumber?: string;
|
|
4939
|
+
/** A descriptive text field. */
|
|
4940
|
+
Desc?: string;
|
|
4941
|
+
/** `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. */
|
|
4942
|
+
Quantity?: number;
|
|
4943
|
+
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
4944
|
+
UnitOfMeasure?: string;
|
|
4945
|
+
/** If both `Quantity` and `Amount` are specified, QuickBooks will use them to calculate `Cost`. Likewise, if both `Quantity` and `Cost` are specified, QuickBooks will use them to calculate the total `Amount`. */
|
|
4946
|
+
Cost?: string;
|
|
4947
|
+
/** A monetary amount. */
|
|
4948
|
+
Amount?: string;
|
|
4949
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
4950
|
+
CustomerRef?: CustomerRef;
|
|
4951
|
+
/** 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.
|
|
4952
|
+
|
|
4953
|
+
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. */
|
|
4954
|
+
ClassRef?: ClassRef;
|
|
4955
|
+
/** 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)
|
|
4956
|
+
|
|
4957
|
+
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. */
|
|
4958
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4959
|
+
/** The billing status of this item line or expense line. */
|
|
4960
|
+
BillableStatus?: BillableStatus;
|
|
4961
|
+
/** Refers to a QuickBooks account. If you are using QB Online edition, you cannot specify an accounts receivable account here. If an `OverrideItemAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4962
|
+
OverrideItemAccountRef?: OverrideItemAccountRef;
|
|
4963
|
+
/** When used with `InvoiceAdd`, the transaction you are linking to via this field must be a `SalesOrder`; links to other transactions, such as to estimates, are not currently supported.
|
|
4964
|
+
|
|
4965
|
+
When used with `BillAdd` or `ItemReceiptAdd`, the transaction you are linking to via this field must be a `PurchaseOrder`: links to other transactions are not currently supported. The `LinkToTxn` aggregate allows you to bring in a specific line item from a transaction. If you want to link an entire transaction and bring in all its lines, use the `LinkToTxnID` aggregate. Notice that if you use `LinkToTxn` in the item line, you cannot use `ItemRef` in that line: you’ll get a runtime error. `LinkToTxn` brings in all the item information you need. (You can, however, specify whatever quantity or rate that you want, or any other item line element other than `ItemRef`. You can use both `LinkToTxnID` and `LinkToTxn` in the same request, as long as these do NOT link to the same `TxnID`. You get an error if the transaction specified by `LinkToTxnID` is already closed or fully received and the request does not contain any other lines. You get error if you attempt to save an empty transaction. You get a warning if you attempt to link to a transaction that’s already closed. For a complete set of rules and instructions on transaction linking, see the chapter on transaction linking in the QB SDK Programmer’s Guide (PDF, 9.6 MB). */
|
|
4966
|
+
LinkToTxn?: LinkToTxn;
|
|
4967
|
+
/** 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. */
|
|
4968
|
+
SalesRepRef?: SalesRepRef;
|
|
4969
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4970
|
+
DataExt?: DataExt | DataExt[];
|
|
4971
|
+
}
|
|
4972
|
+
export interface ItemLineMod {
|
|
4973
|
+
/** 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.)
|
|
4974
|
+
|
|
4975
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
4976
|
+
TxnLineID: string;
|
|
4977
|
+
/** 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.
|
|
4978
|
+
|
|
4979
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
4980
|
+
|
|
4981
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items.
|
|
4982
|
+
|
|
4983
|
+
Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
4984
|
+
ItemRef?: ItemRef;
|
|
4985
|
+
/** Site where inventory is located. */
|
|
4986
|
+
InventorySiteRef?: InventorySiteRef;
|
|
4987
|
+
/** Location within the Inventory Site. */
|
|
4988
|
+
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
4989
|
+
/** The serial number of the asset. */
|
|
4990
|
+
SerialNumber?: string;
|
|
4991
|
+
/** The lot number of the asset. */
|
|
4992
|
+
LotNumber?: string;
|
|
4993
|
+
/** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0. */
|
|
4994
|
+
ExpirationDateForSerialLotNumber?: string;
|
|
4995
|
+
/** A descriptive text field. */
|
|
4996
|
+
Desc?: string;
|
|
4997
|
+
/** `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. */
|
|
4998
|
+
Quantity?: number;
|
|
4999
|
+
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
5000
|
+
UnitOfMeasure?: string;
|
|
5001
|
+
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
5002
|
+
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
5003
|
+
/** If both `Quantity` and `Amount` are specified, QuickBooks will use them to calculate `Cost`. Likewise, if both `Quantity` and `Cost` are specified, QuickBooks will use them to calculate the total `Amount`. */
|
|
5004
|
+
Cost?: string;
|
|
5005
|
+
/** A monetary amount. */
|
|
5006
|
+
Amount?: string;
|
|
5007
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
5008
|
+
CustomerRef?: CustomerRef;
|
|
5009
|
+
/** 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.
|
|
5010
|
+
|
|
5011
|
+
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.
|
|
5012
|
+
|
|
5013
|
+
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. */
|
|
5014
|
+
ClassRef?: ClassRef;
|
|
5015
|
+
/** 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)
|
|
5016
|
+
|
|
5017
|
+
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.
|
|
5018
|
+
|
|
5019
|
+
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. */
|
|
5020
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5021
|
+
/** The billing status of this item line or expense line. */
|
|
5022
|
+
BillableStatus?: BillableStatus;
|
|
5023
|
+
/** Refers to a QuickBooks account. If you are using QB Online edition, you cannot specify an accounts receivable account here. If an `OverrideItemAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5024
|
+
OverrideItemAccountRef?: OverrideItemAccountRef;
|
|
5025
|
+
/** 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. */
|
|
5026
|
+
SalesRepRef?: SalesRepRef;
|
|
5027
|
+
}
|
|
5028
|
+
export interface ItemLineRet {
|
|
5029
|
+
/** 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.)
|
|
5030
|
+
|
|
5031
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
5032
|
+
TxnLineID: string;
|
|
5033
|
+
/** 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.
|
|
5034
|
+
|
|
5035
|
+
For example, here are some requests that impose limits on what items `ItemRef` can refer to.
|
|
5036
|
+
|
|
5037
|
+
For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax items For `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item. For `BillingRateAdd` requests, the `ItemRef` must refer to a service item.
|
|
5038
|
+
|
|
5039
|
+
You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5040
|
+
ItemRef?: ItemRef;
|
|
5041
|
+
/** Site where inventory is located. */
|
|
5042
|
+
InventorySiteRef?: InventorySiteRef;
|
|
5043
|
+
/** Location within the Inventory Site. */
|
|
5044
|
+
InventorySiteLocationRef?: InventorySiteLocationRef;
|
|
5045
|
+
/** The serial number of the asset. */
|
|
5046
|
+
SerialNumber?: string;
|
|
5047
|
+
/** The lot number of the asset. */
|
|
5048
|
+
LotNumber?: string;
|
|
5049
|
+
/** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0. */
|
|
5050
|
+
ExpirationDateForSerialLotNumber?: string;
|
|
5051
|
+
/** A descriptive text field. */
|
|
5052
|
+
Desc?: string;
|
|
5053
|
+
/** `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. */
|
|
5054
|
+
Quantity?: number;
|
|
5055
|
+
/** In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! */
|
|
5056
|
+
UnitOfMeasure?: string;
|
|
5057
|
+
/** When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you cannot change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request. */
|
|
5058
|
+
OverrideUOMSetRef?: OverrideUOMSetRef;
|
|
5059
|
+
/** If both `Quantity` and `Amount` are specified, QuickBooks will use them to calculate `Cost`. Likewise, if both `Quantity` and `Cost` are specified, QuickBooks will use them to calculate the total `Amount`. */
|
|
5060
|
+
Cost?: string;
|
|
5061
|
+
/** A monetary amount. */
|
|
5062
|
+
Amount?: string;
|
|
5063
|
+
/** The customer list includes information about the QuickBooks user’s customers and the individual jobs that are being performed for them. A `CustomerRef` aggregate refers to one of the customers (or customer jobs) on the list. In a request, if a `CustomerRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. Special cases to note: In `SalesReceipt` and `ReceivePayment` requests, `CustomerRef` refers to the customer or customer job to which the payment is credited. In a `TimeTracking` request, `CustomerRef` refers to the customer or customer job to which this time could be billed. If `IsBillable` is set to true, `CustomerRef` is required in `TimeTrackingAdd`. In an `ExpenseLineAdd` request, if `AccountRef` refers to an A/P account, `CustomerRef` must refer to a vendor (not to a customer). If `AccountRef` refers to any other type of account, the `CustomerRef` must refer to a customer. */
|
|
5064
|
+
CustomerRef?: CustomerRef;
|
|
5065
|
+
/** 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.
|
|
5066
|
+
|
|
5067
|
+
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.
|
|
5068
|
+
|
|
5069
|
+
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. */
|
|
5070
|
+
ClassRef?: ClassRef;
|
|
5071
|
+
/** 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)
|
|
5072
|
+
|
|
5073
|
+
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.
|
|
5074
|
+
|
|
5075
|
+
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. */
|
|
5076
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5077
|
+
/** The billing status of this item line or expense line. */
|
|
5078
|
+
BillableStatus?: BillableStatus;
|
|
5079
|
+
/** 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. */
|
|
5080
|
+
SalesRepRef?: SalesRepRef;
|
|
5081
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5082
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5083
|
+
}
|
|
5084
|
+
export interface ItemNonInventoryAdd {
|
|
5085
|
+
/** 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. */
|
|
5086
|
+
Name: string;
|
|
5087
|
+
/** Barcode reference information. */
|
|
5088
|
+
BarCode?: BarCode;
|
|
5089
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5090
|
+
IsActive?: boolean;
|
|
5091
|
+
/** 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. */
|
|
5092
|
+
ParentRef?: ParentRef;
|
|
5093
|
+
/** 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. */
|
|
5094
|
+
ClassRef?: ClassRef;
|
|
5095
|
+
/** The part number used by the manufacturer of the item. */
|
|
5096
|
+
ManufacturerPartNumber?: string;
|
|
5097
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
5098
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
5099
|
+
/** For future use with international versions of QuickBooks. */
|
|
5100
|
+
IsTaxIncluded?: boolean;
|
|
5101
|
+
/** 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. */
|
|
5102
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5103
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5104
|
+
SalesOrPurchase?: SalesOrPurchase;
|
|
5105
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5106
|
+
SalesAndPurchase?: SalesAndPurchase;
|
|
5107
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5108
|
+
ExternalGUID?: string;
|
|
5109
|
+
}
|
|
5110
|
+
export interface ItemNonInventoryAddRq {
|
|
5111
|
+
ItemNonInventoryAdd: ItemNonInventoryAdd;
|
|
5112
|
+
/** 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. */
|
|
5113
|
+
IncludeRetElement?: string[] | string;
|
|
5114
|
+
}
|
|
5115
|
+
export interface ItemNonInventoryAddRs {
|
|
5116
|
+
ItemNonInventoryRet?: ItemNonInventoryRet;
|
|
5117
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5118
|
+
}
|
|
5119
|
+
export interface ItemNonInventoryMod {
|
|
5120
|
+
/** 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. */
|
|
5121
|
+
ListID: string;
|
|
5122
|
+
/** 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. */
|
|
5123
|
+
EditSequence: string;
|
|
5124
|
+
/** 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. */
|
|
5125
|
+
Name?: string;
|
|
5126
|
+
/** Barcode reference information. */
|
|
5127
|
+
BarCode?: BarCode;
|
|
5128
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5129
|
+
IsActive?: boolean;
|
|
5130
|
+
/** 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. */
|
|
5131
|
+
ClassRef?: ClassRef;
|
|
5132
|
+
/** 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. */
|
|
5133
|
+
ParentRef?: ParentRef;
|
|
5134
|
+
/** The part number used by the manufacturer of the item. */
|
|
5135
|
+
ManufacturerPartNumber?: string;
|
|
5136
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
5137
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
5138
|
+
/** By Default `ForceUOMChange` is false. However, in item Mod requests, you need to set the `ForceUOMChange` field to True if you are changing the UOM set and the base unit of the new set does not match the base unit of the UOM set currently assigned to the item. This does the same thing as the user accepting the warning prompt in the UI. If you don’t set `ForceUOMChange` to True, you’ll get an error when you invoke the Item* Mod request.Y You should be aware that if you change the base unit for an item, you should also change the item’s quantities on hand and cost to reflect the new unit; otherwise the values will be inaccurate. An alternative to handle such UOM changes to an item is to create a new item with the desired UOM set and inactivate the old item. */
|
|
5139
|
+
ForceUOMChange?: boolean;
|
|
5140
|
+
/** For future use with international versions of QuickBooks. */
|
|
5141
|
+
IsTaxIncluded?: boolean;
|
|
5142
|
+
/** 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. */
|
|
5143
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5144
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5145
|
+
SalesOrPurchaseMod?: SalesOrPurchaseMod;
|
|
5146
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5147
|
+
SalesAndPurchaseMod?: SalesAndPurchaseMod;
|
|
5148
|
+
}
|
|
5149
|
+
export interface ItemNonInventoryModRq {
|
|
5150
|
+
ItemNonInventoryMod: ItemNonInventoryMod;
|
|
5151
|
+
/** 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. */
|
|
5152
|
+
IncludeRetElement?: string[] | string;
|
|
5153
|
+
}
|
|
5154
|
+
export interface ItemNonInventoryModRs {
|
|
5155
|
+
ItemNonInventoryRet?: ItemNonInventoryRet;
|
|
5156
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5157
|
+
}
|
|
5158
|
+
export interface ItemNonInventoryQueryRq {
|
|
5159
|
+
/** 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. */
|
|
5160
|
+
ListID?: string[] | string;
|
|
5161
|
+
/** 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. */
|
|
5162
|
+
FullName?: string[] | string;
|
|
5163
|
+
/** 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. */
|
|
5164
|
+
MaxReturned?: number;
|
|
5165
|
+
/** 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. */
|
|
5166
|
+
ActiveStatus?: ActiveStatus;
|
|
5167
|
+
/** 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). */
|
|
5168
|
+
FromModifiedDate?: string;
|
|
5169
|
+
/** 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). */
|
|
5170
|
+
ToModifiedDate?: string;
|
|
5171
|
+
/** Filters according to the object’s `Name`. */
|
|
5172
|
+
NameFilter?: NameFilter;
|
|
5173
|
+
/** Filters according to the object’s `Name`. */
|
|
5174
|
+
NameRangeFilter?: NameRangeFilter;
|
|
5175
|
+
/** Filters according to the object’s class. */
|
|
5176
|
+
ClassFilter?: ClassFilter;
|
|
5177
|
+
/** 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. */
|
|
5178
|
+
IncludeRetElement?: string[] | string;
|
|
5179
|
+
/** 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. */
|
|
5180
|
+
OwnerID?: string[] | string;
|
|
5181
|
+
}
|
|
5182
|
+
export interface ItemNonInventoryQueryRs {
|
|
5183
|
+
ItemNonInventoryRet: ItemNonInventoryRet[];
|
|
5184
|
+
}
|
|
5185
|
+
export interface ItemNonInventoryRet {
|
|
5186
|
+
/** 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. */
|
|
5187
|
+
ListID: string;
|
|
5188
|
+
/** Time the object was created. */
|
|
5189
|
+
TimeCreated: string;
|
|
5190
|
+
/** Time the object was last modified. */
|
|
5191
|
+
TimeModified: string;
|
|
5192
|
+
/** 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. */
|
|
5193
|
+
EditSequence: string;
|
|
5194
|
+
/** 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. */
|
|
5195
|
+
Name: string;
|
|
5196
|
+
/** `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. */
|
|
5197
|
+
FullName: string;
|
|
5198
|
+
/** Value of the barcode in the item. */
|
|
5199
|
+
BarCodeValue?: string;
|
|
5200
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5201
|
+
IsActive?: boolean;
|
|
5202
|
+
/** 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. */
|
|
5203
|
+
ClassRef?: ClassRef;
|
|
5204
|
+
/** 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. */
|
|
5205
|
+
ParentRef?: ParentRef;
|
|
5206
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
5207
|
+
Sublevel: number;
|
|
5208
|
+
/** The part number used by the manufacturer of the item. */
|
|
5209
|
+
ManufacturerPartNumber?: string;
|
|
5210
|
+
/** The unit of measure set consists of a base unit and 0-n related units. */
|
|
5211
|
+
UnitOfMeasureSetRef?: UnitOfMeasureSetRef;
|
|
5212
|
+
/** For future use with international versions of QuickBooks. */
|
|
5213
|
+
IsTaxIncluded?: boolean;
|
|
5214
|
+
/** 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. */
|
|
5215
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5216
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5217
|
+
SalesOrPurchase?: SalesOrPurchase;
|
|
5218
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5219
|
+
SalesAndPurchase?: SalesAndPurchase;
|
|
5220
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5221
|
+
ExternalGUID?: string;
|
|
5222
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5223
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5224
|
+
}
|
|
5225
|
+
export interface ItemOtherChargeAdd {
|
|
5226
|
+
/** 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. */
|
|
5227
|
+
Name: string;
|
|
5228
|
+
/** Barcode reference information. */
|
|
5229
|
+
BarCode?: BarCode;
|
|
5230
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5231
|
+
IsActive?: boolean;
|
|
5232
|
+
/** 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. */
|
|
5233
|
+
ClassRef?: ClassRef;
|
|
5234
|
+
/** 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. */
|
|
5235
|
+
ParentRef?: ParentRef;
|
|
5236
|
+
/** For future use with international versions of QuickBooks. */
|
|
5237
|
+
IsTaxIncluded?: boolean;
|
|
5238
|
+
/** 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. */
|
|
5239
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5240
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5241
|
+
SalesOrPurchase?: SalesOrPurchase;
|
|
5242
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5243
|
+
SalesAndPurchase?: SalesAndPurchase;
|
|
5244
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5245
|
+
ExternalGUID?: string;
|
|
5246
|
+
}
|
|
5247
|
+
export interface ItemOtherChargeAddRq {
|
|
5248
|
+
ItemOtherChargeAdd: ItemOtherChargeAdd;
|
|
5249
|
+
/** 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. */
|
|
5250
|
+
IncludeRetElement?: string[] | string;
|
|
5251
|
+
}
|
|
5252
|
+
export interface ItemOtherChargeAddRs {
|
|
5253
|
+
ItemOtherChargeRet?: ItemOtherChargeRet;
|
|
5254
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5255
|
+
}
|
|
5256
|
+
export interface ItemOtherChargeMod {
|
|
5257
|
+
/** 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. */
|
|
5258
|
+
ListID: string;
|
|
5259
|
+
/** 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. */
|
|
5260
|
+
EditSequence: string;
|
|
5261
|
+
/** 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. */
|
|
5262
|
+
Name?: string;
|
|
5263
|
+
/** Barcode reference information. */
|
|
5264
|
+
BarCode?: BarCode;
|
|
5265
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5266
|
+
IsActive?: boolean;
|
|
5267
|
+
/** 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. */
|
|
5268
|
+
ClassRef?: ClassRef;
|
|
5269
|
+
/** 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. */
|
|
5270
|
+
ParentRef?: ParentRef;
|
|
5271
|
+
/** For future use with international versions of QuickBooks. */
|
|
5272
|
+
IsTaxIncluded?: boolean;
|
|
5273
|
+
/** 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. */
|
|
5274
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5275
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5276
|
+
SalesOrPurchaseMod?: SalesOrPurchaseMod;
|
|
5277
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5278
|
+
SalesAndPurchaseMod?: SalesAndPurchaseMod;
|
|
5279
|
+
}
|
|
5280
|
+
export interface ItemOtherChargeModRq {
|
|
5281
|
+
ItemOtherChargeMod: ItemOtherChargeMod;
|
|
5282
|
+
/** 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. */
|
|
5283
|
+
IncludeRetElement?: string[] | string;
|
|
5284
|
+
}
|
|
5285
|
+
export interface ItemOtherChargeModRs {
|
|
5286
|
+
ItemOtherChargeRet?: ItemOtherChargeRet;
|
|
5287
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5288
|
+
}
|
|
5289
|
+
export interface ItemOtherChargeQueryRq {
|
|
5290
|
+
/** 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. */
|
|
5291
|
+
ListID?: string[] | string;
|
|
5292
|
+
/** 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. */
|
|
5293
|
+
FullName?: string[] | string;
|
|
5294
|
+
/** 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. */
|
|
5295
|
+
MaxReturned?: number;
|
|
5296
|
+
/** 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. */
|
|
5297
|
+
ActiveStatus?: ActiveStatus;
|
|
5298
|
+
/** 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). */
|
|
5299
|
+
FromModifiedDate?: string;
|
|
5300
|
+
/** 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). */
|
|
5301
|
+
ToModifiedDate?: string;
|
|
5302
|
+
/** Filters according to the object’s `Name`. */
|
|
5303
|
+
NameFilter?: NameFilter;
|
|
5304
|
+
/** Filters according to the object’s `Name`. */
|
|
5305
|
+
NameRangeFilter?: NameRangeFilter;
|
|
5306
|
+
/** Filters according to the object’s class. */
|
|
5307
|
+
ClassFilter?: ClassFilter;
|
|
5308
|
+
/** 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. */
|
|
5309
|
+
IncludeRetElement?: string[] | string;
|
|
5310
|
+
/** 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. */
|
|
5311
|
+
OwnerID?: string[] | string;
|
|
5312
|
+
}
|
|
5313
|
+
export interface ItemOtherChargeQueryRs {
|
|
5314
|
+
ItemOtherChargeRet: ItemOtherChargeRet[];
|
|
5315
|
+
}
|
|
5316
|
+
export interface ItemOtherChargeRet {
|
|
5317
|
+
/** 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. */
|
|
5318
|
+
ListID: string;
|
|
5319
|
+
/** Time the object was created. */
|
|
5320
|
+
TimeCreated: string;
|
|
5321
|
+
/** Time the object was last modified. */
|
|
5322
|
+
TimeModified: string;
|
|
5323
|
+
/** 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. */
|
|
5324
|
+
EditSequence: string;
|
|
5325
|
+
/** 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. */
|
|
5326
|
+
Name: string;
|
|
5327
|
+
/** `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. */
|
|
5328
|
+
FullName: string;
|
|
5329
|
+
/** Value of the barcode in the item. */
|
|
5330
|
+
BarCodeValue?: string;
|
|
5331
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5332
|
+
IsActive?: boolean;
|
|
5333
|
+
/** 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. */
|
|
5334
|
+
ClassRef?: ClassRef;
|
|
5335
|
+
/** 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. */
|
|
5336
|
+
ParentRef?: ParentRef;
|
|
5337
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
5338
|
+
Sublevel: number;
|
|
5339
|
+
/** For future use with international versions of QuickBooks. */
|
|
5340
|
+
IsTaxIncluded?: boolean;
|
|
5341
|
+
/** 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. */
|
|
5342
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5343
|
+
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
5344
|
+
SalesOrPurchase?: SalesOrPurchase;
|
|
5345
|
+
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
5346
|
+
SalesAndPurchase?: SalesAndPurchase;
|
|
5347
|
+
/** Identifies the type of special item. See type for possible enum values. */
|
|
5348
|
+
SpecialItemType?: SpecialItemType;
|
|
5349
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5350
|
+
ExternalGUID?: string;
|
|
5351
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5352
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5353
|
+
}
|
|
5354
|
+
export interface ItemPaymentAdd {
|
|
5355
|
+
/** 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. */
|
|
5356
|
+
Name: string;
|
|
5357
|
+
/** Barcode reference information. */
|
|
5358
|
+
BarCode?: BarCode;
|
|
5359
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5360
|
+
IsActive?: boolean;
|
|
5361
|
+
/** 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. */
|
|
5362
|
+
ClassRef?: ClassRef;
|
|
5363
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5364
|
+
ItemDesc?: string;
|
|
5365
|
+
/** Refers to the account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5366
|
+
DepositToAccountRef?: DepositToAccountRef;
|
|
5367
|
+
/** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
|
|
5368
|
+
PaymentMethodRef?: PaymentMethodRef;
|
|
5369
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5370
|
+
ExternalGUID?: string;
|
|
5371
|
+
}
|
|
5372
|
+
export interface ItemPaymentAddRq {
|
|
5373
|
+
ItemPaymentAdd: ItemPaymentAdd;
|
|
5374
|
+
/** 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. */
|
|
5375
|
+
IncludeRetElement?: string[] | string;
|
|
5376
|
+
}
|
|
5377
|
+
export interface ItemPaymentAddRs {
|
|
5378
|
+
ItemPaymentRet?: ItemPaymentRet;
|
|
5379
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5380
|
+
}
|
|
5381
|
+
export interface ItemPaymentMod {
|
|
5382
|
+
/** 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. */
|
|
5383
|
+
ListID: string;
|
|
5384
|
+
/** 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. */
|
|
5385
|
+
EditSequence: string;
|
|
5386
|
+
/** 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. */
|
|
5387
|
+
Name?: string;
|
|
5388
|
+
/** Barcode reference information. */
|
|
5389
|
+
BarCode?: BarCode;
|
|
5390
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5391
|
+
IsActive?: boolean;
|
|
5392
|
+
/** 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. */
|
|
5393
|
+
ClassRef?: ClassRef;
|
|
5394
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5395
|
+
ItemDesc?: string;
|
|
5396
|
+
/** Refers to the account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5397
|
+
DepositToAccountRef?: DepositToAccountRef;
|
|
5398
|
+
/** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
|
|
5399
|
+
PaymentMethodRef?: PaymentMethodRef;
|
|
5400
|
+
}
|
|
5401
|
+
export interface ItemPaymentModRq {
|
|
5402
|
+
ItemPaymentMod: ItemPaymentMod;
|
|
5403
|
+
/** 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. */
|
|
5404
|
+
IncludeRetElement?: string[] | string;
|
|
5405
|
+
}
|
|
5406
|
+
export interface ItemPaymentModRs {
|
|
5407
|
+
ItemPaymentRet?: ItemPaymentRet;
|
|
5408
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5409
|
+
}
|
|
5410
|
+
export interface ItemPaymentQueryRq {
|
|
5411
|
+
/** 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. */
|
|
5412
|
+
ListID?: string[] | string;
|
|
5413
|
+
/** 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. */
|
|
5414
|
+
FullName?: string[] | string;
|
|
5415
|
+
/** 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. */
|
|
5416
|
+
MaxReturned?: number;
|
|
5417
|
+
/** 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. */
|
|
5418
|
+
ActiveStatus?: ActiveStatus;
|
|
5419
|
+
/** 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). */
|
|
5420
|
+
FromModifiedDate?: string;
|
|
5421
|
+
/** 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). */
|
|
5422
|
+
ToModifiedDate?: string;
|
|
5423
|
+
/** Filters according to the object’s `Name`. */
|
|
5424
|
+
NameFilter?: NameFilter;
|
|
5425
|
+
/** Filters according to the object’s `Name`. */
|
|
5426
|
+
NameRangeFilter?: NameRangeFilter;
|
|
5427
|
+
/** Filters according to the object’s class. */
|
|
5428
|
+
ClassFilter?: ClassFilter;
|
|
5429
|
+
/** 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. */
|
|
5430
|
+
IncludeRetElement?: string[] | string;
|
|
5431
|
+
/** 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. */
|
|
5432
|
+
OwnerID?: string[] | string;
|
|
5433
|
+
}
|
|
5434
|
+
export interface ItemPaymentQueryRs {
|
|
5435
|
+
ItemPaymentRet: ItemPaymentRet[];
|
|
5436
|
+
}
|
|
5437
|
+
export interface ItemPaymentRet {
|
|
5438
|
+
/** 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. */
|
|
5439
|
+
ListID: string;
|
|
5440
|
+
/** Time the object was created. */
|
|
5441
|
+
TimeCreated: string;
|
|
5442
|
+
/** Time the object was last modified. */
|
|
5443
|
+
TimeModified: string;
|
|
5444
|
+
/** 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. */
|
|
5445
|
+
EditSequence: string;
|
|
5446
|
+
/** 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. */
|
|
5447
|
+
Name: string;
|
|
5448
|
+
/** Value of the barcode in the item. */
|
|
5449
|
+
BarCodeValue?: string;
|
|
5450
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5451
|
+
IsActive?: boolean;
|
|
5452
|
+
/** 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. */
|
|
5453
|
+
ClassRef?: ClassRef;
|
|
5454
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5455
|
+
ItemDesc?: string;
|
|
5456
|
+
/** Refers to the account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5457
|
+
DepositToAccountRef?: DepositToAccountRef;
|
|
5458
|
+
/** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
|
|
5459
|
+
PaymentMethodRef?: PaymentMethodRef;
|
|
5460
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5461
|
+
ExternalGUID?: string;
|
|
5462
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5463
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5464
|
+
}
|
|
5465
|
+
export interface ItemReceiptAdd {
|
|
5466
|
+
/** 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. */
|
|
5467
|
+
VendorRef: VendorRef;
|
|
5468
|
+
/** 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. */
|
|
5469
|
+
APAccountRef?: APAccountRef;
|
|
5470
|
+
/** 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. */
|
|
5471
|
+
TxnDate?: string;
|
|
5472
|
+
/** 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. */
|
|
5473
|
+
RefNumber?: string;
|
|
5474
|
+
/** Additional information. */
|
|
5475
|
+
Memo?: string;
|
|
5476
|
+
/** For future use with international versions of QuickBooks. */
|
|
5477
|
+
IsTaxIncluded?: boolean;
|
|
5478
|
+
/** 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. */
|
|
5479
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5480
|
+
/** 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.) */
|
|
5481
|
+
ExchangeRate?: number;
|
|
5482
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5483
|
+
ExternalGUID?: string;
|
|
5484
|
+
/** The `LinkToTxnID` aggregate allows to link an entire transaction. If you want to link individual lines in a transaction, use the `LinkToTxn` aggregate. You can use both `LinkToTxnID` and `LinkToTxn` aggregates in the same request, as long as these aggregates do NOT link to the same `TxnID`. If both aggregates are used and do link to the same `TxnID`, you receive an error 3000. Also, if you attempt to invoke `LinkToTxnID` with the same `TxnID`, more than once, you get an error 3177. If the transaction specified by `LinkToTxnID` is already closed or fully received and the `ItemReceiptAdd` request does not contain any other lines, you get error 3180 for attempting to save an empty transaction. You get a warning if you attempt to link to a transaction that’s already closed. */
|
|
5485
|
+
LinkToTxnID?: string[] | string;
|
|
5486
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
5487
|
+
ExpenseLineAdd?: ExpenseLineAdd | ExpenseLineAdd[];
|
|
5488
|
+
/** 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`. */
|
|
5489
|
+
ItemLineAdd?: ItemLineAdd | ItemLineAdd[];
|
|
5490
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
5491
|
+
ItemGroupLineAdd?: ItemGroupLineAdd | ItemGroupLineAdd[];
|
|
5492
|
+
}
|
|
5493
|
+
export interface ItemReceiptAddRq {
|
|
5494
|
+
ItemReceiptAdd: ItemReceiptAdd;
|
|
5495
|
+
/** 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. */
|
|
5496
|
+
IncludeRetElement?: string[] | string;
|
|
5497
|
+
}
|
|
5498
|
+
export interface ItemReceiptAddRs {
|
|
5499
|
+
ItemReceiptRet?: ItemReceiptRet;
|
|
5500
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5501
|
+
}
|
|
5502
|
+
export interface ItemReceiptMod {
|
|
5503
|
+
/** 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. */
|
|
5504
|
+
TxnID: string;
|
|
5505
|
+
/** 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. */
|
|
5506
|
+
EditSequence: string;
|
|
5507
|
+
/** 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. */
|
|
5508
|
+
VendorRef?: VendorRef;
|
|
5509
|
+
/** 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. */
|
|
5510
|
+
APAccountRef?: APAccountRef;
|
|
5511
|
+
/** 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. */
|
|
5512
|
+
TxnDate?: string;
|
|
5513
|
+
/** 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. */
|
|
5514
|
+
RefNumber?: string;
|
|
5515
|
+
/** Additional information. */
|
|
5516
|
+
Memo?: string;
|
|
5517
|
+
/** For future use with international versions of QuickBooks. */
|
|
5518
|
+
IsTaxIncluded?: boolean;
|
|
5519
|
+
/** 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. */
|
|
5520
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5521
|
+
/** 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.) */
|
|
5522
|
+
ExchangeRate?: number;
|
|
5523
|
+
/** Set `ClearExpenseLines` to true to clear all the expense lines. To modify individual lines, use `ExpenseLineMod`. */
|
|
5524
|
+
ClearExpenseLines?: boolean;
|
|
5525
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
5526
|
+
ExpenseLineMod?: ExpenseLineMod | ExpenseLineMod[];
|
|
5527
|
+
/** Set `ClearItemLines` to true to clear all the item lines. To modify individual lines, use `ItemLineMod`. */
|
|
5528
|
+
ClearItemLines?: boolean;
|
|
5529
|
+
/** 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`. */
|
|
5530
|
+
ItemLineMod?: ItemLineMod | ItemLineMod[];
|
|
5531
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
5532
|
+
ItemGroupLineMod?: ItemGroupLineMod | ItemGroupLineMod[];
|
|
5533
|
+
}
|
|
5534
|
+
export interface ItemReceiptModRq {
|
|
5535
|
+
ItemReceiptMod: ItemReceiptMod;
|
|
5536
|
+
/** 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. */
|
|
5537
|
+
IncludeRetElement?: string[] | string;
|
|
5538
|
+
}
|
|
5539
|
+
export interface ItemReceiptModRs {
|
|
5540
|
+
ItemReceiptRet?: ItemReceiptRet;
|
|
5541
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5542
|
+
}
|
|
5543
|
+
export interface ItemReceiptQueryRq {
|
|
5544
|
+
/** 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. */
|
|
5545
|
+
TxnID?: string[] | string;
|
|
5546
|
+
/** 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. */
|
|
5547
|
+
RefNumber?: string[] | string;
|
|
5548
|
+
/** 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. */
|
|
5549
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
5550
|
+
/** 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. */
|
|
5551
|
+
MaxReturned?: number;
|
|
5552
|
+
/** 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.) */
|
|
5553
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
5554
|
+
/** Filters according to the original transaction dates. */
|
|
5555
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
5556
|
+
/** 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. */
|
|
5557
|
+
EntityFilter?: EntityFilter;
|
|
5558
|
+
/** 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. */
|
|
5559
|
+
AccountFilter?: AccountFilter;
|
|
5560
|
+
/** Filters according to `RefNumber`. */
|
|
5561
|
+
RefNumberFilter?: RefNumberFilter;
|
|
5562
|
+
/** 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`. */
|
|
5563
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
5564
|
+
/** Filters by the specified currency. */
|
|
5565
|
+
CurrencyFilter?: CurrencyFilter;
|
|
5566
|
+
/** 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. */
|
|
5567
|
+
IncludeLineItems?: boolean;
|
|
5568
|
+
/** 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. */
|
|
5569
|
+
IncludeLinkedTxns?: boolean;
|
|
5570
|
+
/** 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. */
|
|
5571
|
+
IncludeRetElement?: string[] | string;
|
|
5572
|
+
/** 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. */
|
|
5573
|
+
OwnerID?: string[] | string;
|
|
5574
|
+
}
|
|
5575
|
+
export interface ItemReceiptQueryRs {
|
|
5576
|
+
ItemReceiptRet: ItemReceiptRet[];
|
|
5577
|
+
}
|
|
5578
|
+
export interface ItemReceiptRet {
|
|
5579
|
+
/** 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. */
|
|
5580
|
+
TxnID: string;
|
|
5581
|
+
/** Time the object was created. */
|
|
5582
|
+
TimeCreated: string;
|
|
5583
|
+
/** Time the object was last modified. */
|
|
5584
|
+
TimeModified: string;
|
|
5585
|
+
/** 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. */
|
|
5586
|
+
EditSequence: string;
|
|
5587
|
+
/** An identifying number for this transaction. */
|
|
5588
|
+
TxnNumber?: number;
|
|
5589
|
+
/** 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. */
|
|
5590
|
+
VendorRef: VendorRef;
|
|
5591
|
+
/** 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. */
|
|
5592
|
+
APAccountRef?: APAccountRef;
|
|
5593
|
+
/** Refers to a liability account for this non-wage payroll item. */
|
|
5594
|
+
LiabilityAccountRef?: LiabilityAccountRef;
|
|
5595
|
+
/** 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. */
|
|
5596
|
+
TxnDate: string;
|
|
5597
|
+
/** Total amount of money paid or received. In a receive payment add transaction that has payment amount elements (such as `AppliedToTxnAdd` lines) you must supply a `TotalAmount` and the sum of all the `PaymentAmount` elements must not be greater than the `TotalAmount`. */
|
|
5598
|
+
TotalAmount: string;
|
|
5599
|
+
/** 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. */
|
|
5600
|
+
CurrencyRef?: CurrencyRef;
|
|
5601
|
+
/** 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.) */
|
|
5602
|
+
ExchangeRate?: number;
|
|
5603
|
+
/** Total amount of money paid or received in the home currency. */
|
|
5604
|
+
TotalAmountInHomeCurrency?: string;
|
|
5605
|
+
/** 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. */
|
|
5606
|
+
RefNumber?: string;
|
|
5607
|
+
/** Additional information. */
|
|
5608
|
+
Memo?: string;
|
|
5609
|
+
/** For future use with international versions of QuickBooks. */
|
|
5610
|
+
IsTaxIncluded?: boolean;
|
|
5611
|
+
/** 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. */
|
|
5612
|
+
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
5613
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5614
|
+
ExternalGUID?: string;
|
|
5615
|
+
/** 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. */
|
|
5616
|
+
LinkedTxn?: LinkedTxn | LinkedTxn[];
|
|
5617
|
+
/** A list of `IExpenseLine` objects, each representing one line in this expense. */
|
|
5618
|
+
ExpenseLineRet?: ExpenseLineRet | ExpenseLineRet[];
|
|
5619
|
+
/** 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`. */
|
|
5620
|
+
ItemLineRet?: ItemLineRet | ItemLineRet[];
|
|
5621
|
+
/** Refers to items that are grouped together in QuickBooks for fast entry. */
|
|
5622
|
+
ItemGroupLineRet?: ItemGroupLineRet | ItemGroupLineRet[];
|
|
5623
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5624
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5625
|
+
}
|
|
5626
|
+
export interface ItemRef {
|
|
5627
|
+
/** 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. */
|
|
5628
|
+
ListID?: string;
|
|
5629
|
+
/** `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. */
|
|
5630
|
+
FullName?: string;
|
|
5631
|
+
}
|
|
5632
|
+
export interface ItemSalesTaxAdd {
|
|
5633
|
+
/** 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. */
|
|
5634
|
+
Name: string;
|
|
5635
|
+
/** Barcode reference information. */
|
|
5636
|
+
BarCode?: BarCode;
|
|
5637
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5638
|
+
IsActive?: boolean;
|
|
5639
|
+
/** 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. */
|
|
5640
|
+
ClassRef?: ClassRef;
|
|
5641
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5642
|
+
ItemDesc?: string;
|
|
5643
|
+
/** The tax rate. If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. */
|
|
5644
|
+
TaxRate?: string;
|
|
5645
|
+
/** Refers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. In a request, if a `TaxVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5646
|
+
TaxVendorRef?: TaxVendorRef;
|
|
5647
|
+
/** Sales tax return line information. */
|
|
5648
|
+
SalesTaxReturnLineRef?: SalesTaxReturnLineRef;
|
|
5649
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5650
|
+
ExternalGUID?: string;
|
|
5651
|
+
}
|
|
5652
|
+
export interface ItemSalesTaxAddRq {
|
|
5653
|
+
ItemSalesTaxAdd: ItemSalesTaxAdd;
|
|
5654
|
+
/** 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. */
|
|
5655
|
+
IncludeRetElement?: string[] | string;
|
|
5656
|
+
}
|
|
5657
|
+
export interface ItemSalesTaxAddRs {
|
|
5658
|
+
ItemSalesTaxRet?: ItemSalesTaxRet;
|
|
5659
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5660
|
+
}
|
|
5661
|
+
export interface ItemSalesTaxGroupAdd {
|
|
5662
|
+
/** 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. */
|
|
5663
|
+
Name: string;
|
|
5664
|
+
/** Barcode reference information. */
|
|
5665
|
+
BarCode?: BarCode;
|
|
5666
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5667
|
+
IsActive?: boolean;
|
|
5668
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5669
|
+
ItemDesc?: string;
|
|
5670
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5671
|
+
ExternalGUID?: string;
|
|
5672
|
+
/** A list of sales-tax items that are already defined in the `ItemSalesTax` list. */
|
|
5673
|
+
ItemSalesTaxRef: ItemSalesTaxRef | ItemSalesTaxRef[];
|
|
5674
|
+
}
|
|
5675
|
+
export interface ItemSalesTaxGroupAddRq {
|
|
5676
|
+
ItemSalesTaxGroupAdd: ItemSalesTaxGroupAdd;
|
|
5677
|
+
/** 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. */
|
|
5678
|
+
IncludeRetElement?: string[] | string;
|
|
5679
|
+
}
|
|
5680
|
+
export interface ItemSalesTaxGroupAddRs {
|
|
5681
|
+
ItemSalesTaxGroupRet?: ItemSalesTaxGroupRet;
|
|
5682
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5683
|
+
}
|
|
5684
|
+
export interface ItemSalesTaxGroupMod {
|
|
5685
|
+
/** 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. */
|
|
5686
|
+
ListID: string;
|
|
5687
|
+
/** 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. */
|
|
5688
|
+
EditSequence: string;
|
|
5689
|
+
/** 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. */
|
|
5690
|
+
Name?: string;
|
|
5691
|
+
/** Barcode reference information. */
|
|
5692
|
+
BarCode?: BarCode;
|
|
5693
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5694
|
+
IsActive?: boolean;
|
|
5695
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5696
|
+
ItemDesc?: string;
|
|
5697
|
+
/** A list of sales-tax items that are already defined in the `ItemSalesTax` list. */
|
|
5698
|
+
ItemSalesTaxRef?: ItemSalesTaxRef | ItemSalesTaxRef[];
|
|
5699
|
+
}
|
|
5700
|
+
export interface ItemSalesTaxGroupModRq {
|
|
5701
|
+
ItemSalesTaxGroupMod: ItemSalesTaxGroupMod;
|
|
5702
|
+
/** 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. */
|
|
5703
|
+
IncludeRetElement?: string[] | string;
|
|
5704
|
+
}
|
|
5705
|
+
export interface ItemSalesTaxGroupModRs {
|
|
5706
|
+
ItemSalesTaxGroupRet?: ItemSalesTaxGroupRet;
|
|
5707
|
+
ErrorRecovery?: ErrorRecovery;
|
|
5708
|
+
}
|
|
5709
|
+
export interface ItemSalesTaxGroupQueryRq {
|
|
5710
|
+
/** 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. */
|
|
5711
|
+
ListID?: string[] | string;
|
|
5712
|
+
/** 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. */
|
|
5713
|
+
FullName?: string[] | string;
|
|
5714
|
+
/** 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. */
|
|
5715
|
+
MaxReturned?: number;
|
|
5716
|
+
/** 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. */
|
|
5717
|
+
ActiveStatus?: ActiveStatus;
|
|
5718
|
+
/** 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). */
|
|
5719
|
+
FromModifiedDate?: string;
|
|
5720
|
+
/** 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). */
|
|
5721
|
+
ToModifiedDate?: string;
|
|
5722
|
+
/** Filters according to the object’s `Name`. */
|
|
5723
|
+
NameFilter?: NameFilter;
|
|
5724
|
+
/** Filters according to the object’s `Name`. */
|
|
5725
|
+
NameRangeFilter?: NameRangeFilter;
|
|
5726
|
+
/** 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. */
|
|
5727
|
+
IncludeRetElement?: string[] | string;
|
|
5728
|
+
/** 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. */
|
|
5729
|
+
OwnerID?: string[] | string;
|
|
5730
|
+
}
|
|
5731
|
+
export interface ItemSalesTaxGroupQueryRs {
|
|
5732
|
+
ItemSalesTaxGroupRet: ItemSalesTaxGroupRet[];
|
|
5733
|
+
}
|
|
5734
|
+
export interface ItemSalesTaxGroupRet {
|
|
5735
|
+
/** 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. */
|
|
5736
|
+
ListID: string;
|
|
5737
|
+
/** Time the object was created. */
|
|
5738
|
+
TimeCreated: string;
|
|
5739
|
+
/** Time the object was last modified. */
|
|
5740
|
+
TimeModified: string;
|
|
5741
|
+
/** 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. */
|
|
5742
|
+
EditSequence: string;
|
|
5743
|
+
/** 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. */
|
|
5744
|
+
Name: string;
|
|
5745
|
+
/** Value of the barcode in the item. */
|
|
5746
|
+
BarCodeValue?: string;
|
|
5747
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5748
|
+
IsActive?: boolean;
|
|
5749
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5750
|
+
ItemDesc?: string;
|
|
5751
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
5752
|
+
ExternalGUID?: string;
|
|
5753
|
+
/** A list of sales-tax items that are already defined in the `ItemSalesTax` list. */
|
|
5754
|
+
ItemSalesTaxRef?: ItemSalesTaxRef | ItemSalesTaxRef[];
|
|
5755
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
5756
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
5757
|
+
}
|
|
5758
|
+
export interface ItemSalesTaxMod {
|
|
5759
|
+
/** 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. */
|
|
5760
|
+
ListID: string;
|
|
5761
|
+
/** 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. */
|
|
5762
|
+
EditSequence: string;
|
|
5763
|
+
/** 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. */
|
|
5764
|
+
Name?: string;
|
|
5765
|
+
/** Barcode reference information. */
|
|
5766
|
+
BarCode?: BarCode;
|
|
5767
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5768
|
+
IsActive?: boolean;
|
|
5769
|
+
/** 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. */
|
|
5770
|
+
ClassRef?: ClassRef;
|
|
5771
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5772
|
+
ItemDesc?: string;
|
|
5773
|
+
/** The tax rate. If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. */
|
|
5774
|
+
TaxRate?: string;
|
|
5775
|
+
/** Refers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. In a request, if a `TaxVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5776
|
+
TaxVendorRef?: TaxVendorRef;
|
|
5777
|
+
/** Sales tax return line information. */
|
|
5778
|
+
SalesTaxReturnLineRef?: SalesTaxReturnLineRef;
|
|
5779
|
+
}
|
|
5780
|
+
export interface ItemSalesTaxModRq {
|
|
5781
|
+
ItemSalesTaxMod: ItemSalesTaxMod;
|
|
4445
5782
|
/** 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. */
|
|
4446
5783
|
IncludeRetElement?: string[] | string;
|
|
4447
5784
|
}
|
|
4448
|
-
export interface
|
|
4449
|
-
|
|
5785
|
+
export interface ItemSalesTaxModRs {
|
|
5786
|
+
ItemSalesTaxRet?: ItemSalesTaxRet;
|
|
4450
5787
|
ErrorRecovery?: ErrorRecovery;
|
|
4451
5788
|
}
|
|
4452
|
-
export interface
|
|
5789
|
+
export interface ItemSalesTaxQueryRq {
|
|
4453
5790
|
/** 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. */
|
|
4454
5791
|
ListID?: string[] | string;
|
|
4455
5792
|
/** 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. */
|
|
@@ -4473,10 +5810,16 @@ export interface ItemNonInventoryQueryRq {
|
|
|
4473
5810
|
/** 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. */
|
|
4474
5811
|
OwnerID?: string[] | string;
|
|
4475
5812
|
}
|
|
4476
|
-
export interface
|
|
4477
|
-
|
|
5813
|
+
export interface ItemSalesTaxQueryRs {
|
|
5814
|
+
ItemSalesTaxRet: ItemSalesTaxRet[];
|
|
4478
5815
|
}
|
|
4479
|
-
export interface
|
|
5816
|
+
export interface ItemSalesTaxRef {
|
|
5817
|
+
/** 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. */
|
|
5818
|
+
ListID?: string;
|
|
5819
|
+
/** `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. */
|
|
5820
|
+
FullName?: string;
|
|
5821
|
+
}
|
|
5822
|
+
export interface ItemSalesTaxRet {
|
|
4480
5823
|
/** 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. */
|
|
4481
5824
|
ListID: string;
|
|
4482
5825
|
/** Time the object was created. */
|
|
@@ -4487,47 +5830,25 @@ export interface ItemNonInventoryRet {
|
|
|
4487
5830
|
EditSequence: string;
|
|
4488
5831
|
/** 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. */
|
|
4489
5832
|
Name: string;
|
|
4490
|
-
/** `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. */
|
|
4491
|
-
FullName: string;
|
|
4492
5833
|
/** Value of the barcode in the item. */
|
|
4493
5834
|
BarCodeValue?: string;
|
|
4494
5835
|
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
4495
5836
|
IsActive?: boolean;
|
|
4496
5837
|
/** 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. */
|
|
4497
5838
|
ClassRef?: ClassRef;
|
|
4498
|
-
/**
|
|
4499
|
-
|
|
4500
|
-
/** The
|
|
4501
|
-
|
|
4502
|
-
/**
|
|
4503
|
-
|
|
4504
|
-
/**
|
|
4505
|
-
|
|
4506
|
-
/** For future use with international versions of QuickBooks. */
|
|
4507
|
-
IsTaxIncluded?: boolean;
|
|
4508
|
-
/** 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. */
|
|
4509
|
-
SalesTaxCodeRef?: SalesTaxCodeRef;
|
|
4510
|
-
/** A `SalesOrPurchase` aggregate is used for items that are meant to be either purchased or sold, but not both. For example, a `SalesOrPurchase` aggregate would be used for a non-inventory item that is purchased but not sold, or for a service item that is sold but not purchased. */
|
|
4511
|
-
SalesOrPurchase?: SalesOrPurchase;
|
|
4512
|
-
/** A `SalesAndPurchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. */
|
|
4513
|
-
SalesAndPurchase?: SalesAndPurchase;
|
|
5839
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
5840
|
+
ItemDesc?: string;
|
|
5841
|
+
/** The tax rate. If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. */
|
|
5842
|
+
TaxRate?: string;
|
|
5843
|
+
/** Refers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `TaxRate` is specified, then `TaxVendorRef` is required. In a request, if a `TaxVendorRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
5844
|
+
TaxVendorRef?: TaxVendorRef;
|
|
5845
|
+
/** Sales tax return line information. */
|
|
5846
|
+
SalesTaxReturnLineRef?: SalesTaxReturnLineRef;
|
|
4514
5847
|
/** Allows for the attachment of a user defined GUID value. */
|
|
4515
5848
|
ExternalGUID?: string;
|
|
4516
5849
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4517
5850
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4518
5851
|
}
|
|
4519
|
-
export interface ItemRef {
|
|
4520
|
-
/** 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. */
|
|
4521
|
-
ListID?: string;
|
|
4522
|
-
/** `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. */
|
|
4523
|
-
FullName?: string;
|
|
4524
|
-
}
|
|
4525
|
-
export interface ItemSalesTaxRef {
|
|
4526
|
-
/** 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. */
|
|
4527
|
-
ListID?: string;
|
|
4528
|
-
/** `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. */
|
|
4529
|
-
FullName?: string;
|
|
4530
|
-
}
|
|
4531
5852
|
export interface ItemServiceAdd {
|
|
4532
5853
|
/** 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. */
|
|
4533
5854
|
Name: string;
|
|
@@ -4669,14 +5990,167 @@ export interface ItemServiceRet {
|
|
|
4669
5990
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
4670
5991
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
4671
5992
|
}
|
|
5993
|
+
export interface ItemSubtotalAdd {
|
|
5994
|
+
/** 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. */
|
|
5995
|
+
Name: string;
|
|
5996
|
+
/** Barcode reference information. */
|
|
5997
|
+
BarCode?: BarCode;
|
|
5998
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
5999
|
+
IsActive?: boolean;
|
|
6000
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
6001
|
+
ItemDesc?: string;
|
|
6002
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
6003
|
+
ExternalGUID?: string;
|
|
6004
|
+
}
|
|
6005
|
+
export interface ItemSubtotalAddRq {
|
|
6006
|
+
ItemSubtotalAdd: ItemSubtotalAdd;
|
|
6007
|
+
/** 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. */
|
|
6008
|
+
IncludeRetElement?: string[] | string;
|
|
6009
|
+
}
|
|
6010
|
+
export interface ItemSubtotalAddRs {
|
|
6011
|
+
ItemSubtotalRet?: ItemSubtotalRet;
|
|
6012
|
+
ErrorRecovery?: ErrorRecovery;
|
|
6013
|
+
}
|
|
6014
|
+
export interface ItemSubtotalMod {
|
|
6015
|
+
/** 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. */
|
|
6016
|
+
ListID: string;
|
|
6017
|
+
/** 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. */
|
|
6018
|
+
EditSequence: string;
|
|
6019
|
+
/** 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. */
|
|
6020
|
+
Name?: string;
|
|
6021
|
+
/** Barcode reference information. */
|
|
6022
|
+
BarCode?: BarCode;
|
|
6023
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6024
|
+
IsActive?: boolean;
|
|
6025
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
6026
|
+
ItemDesc?: string;
|
|
6027
|
+
}
|
|
6028
|
+
export interface ItemSubtotalModRq {
|
|
6029
|
+
ItemSubtotalMod: ItemSubtotalMod;
|
|
6030
|
+
/** 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. */
|
|
6031
|
+
IncludeRetElement?: string[] | string;
|
|
6032
|
+
}
|
|
6033
|
+
export interface ItemSubtotalModRs {
|
|
6034
|
+
ItemSubtotalRet?: ItemSubtotalRet;
|
|
6035
|
+
ErrorRecovery?: ErrorRecovery;
|
|
6036
|
+
}
|
|
6037
|
+
export interface ItemSubtotalQueryRq {
|
|
6038
|
+
/** 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. */
|
|
6039
|
+
ListID?: string[] | string;
|
|
6040
|
+
/** 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. */
|
|
6041
|
+
FullName?: string[] | string;
|
|
6042
|
+
/** 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. */
|
|
6043
|
+
MaxReturned?: number;
|
|
6044
|
+
/** 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. */
|
|
6045
|
+
ActiveStatus?: ActiveStatus;
|
|
6046
|
+
/** 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). */
|
|
6047
|
+
FromModifiedDate?: string;
|
|
6048
|
+
/** 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). */
|
|
6049
|
+
ToModifiedDate?: string;
|
|
6050
|
+
/** Filters according to the object’s `Name`. */
|
|
6051
|
+
NameFilter?: NameFilter;
|
|
6052
|
+
/** Filters according to the object’s `Name`. */
|
|
6053
|
+
NameRangeFilter?: NameRangeFilter;
|
|
6054
|
+
/** 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. */
|
|
6055
|
+
IncludeRetElement?: string[] | string;
|
|
6056
|
+
/** 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. */
|
|
6057
|
+
OwnerID?: string[] | string;
|
|
6058
|
+
}
|
|
6059
|
+
export interface ItemSubtotalQueryRs {
|
|
6060
|
+
ItemSubtotalRet: ItemSubtotalRet[];
|
|
6061
|
+
}
|
|
6062
|
+
export interface ItemSubtotalRet {
|
|
6063
|
+
/** 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. */
|
|
6064
|
+
ListID: string;
|
|
6065
|
+
/** Time the object was created. */
|
|
6066
|
+
TimeCreated: string;
|
|
6067
|
+
/** Time the object was last modified. */
|
|
6068
|
+
TimeModified: string;
|
|
6069
|
+
/** 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. */
|
|
6070
|
+
EditSequence: string;
|
|
6071
|
+
/** 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. */
|
|
6072
|
+
Name: string;
|
|
6073
|
+
/** Value of the barcode in the item. */
|
|
6074
|
+
BarCodeValue?: string;
|
|
6075
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6076
|
+
IsActive?: boolean;
|
|
6077
|
+
/** The description that will appear on a sales form when the item is used. */
|
|
6078
|
+
ItemDesc?: string;
|
|
6079
|
+
/** Identifies the type of special item. See type for possible enum values. */
|
|
6080
|
+
SpecialItemType?: SpecialItemType;
|
|
6081
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
6082
|
+
ExternalGUID?: string;
|
|
6083
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
6084
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
6085
|
+
}
|
|
4672
6086
|
/** @default: None */
|
|
4673
6087
|
export type JobStatus = "Awarded" | "Closed" | "InProgress" | "None" | "NotAwarded" | "Pending";
|
|
6088
|
+
export interface JobTypeAdd {
|
|
6089
|
+
/** 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. */
|
|
6090
|
+
Name: string;
|
|
6091
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6092
|
+
IsActive?: boolean;
|
|
6093
|
+
/** 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. */
|
|
6094
|
+
ParentRef?: ParentRef;
|
|
6095
|
+
}
|
|
6096
|
+
export interface JobTypeAddRq {
|
|
6097
|
+
JobTypeAdd: JobTypeAdd;
|
|
6098
|
+
/** 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. */
|
|
6099
|
+
IncludeRetElement?: string[] | string;
|
|
6100
|
+
}
|
|
6101
|
+
export interface JobTypeAddRs {
|
|
6102
|
+
JobTypeRet?: JobTypeRet;
|
|
6103
|
+
ErrorRecovery?: ErrorRecovery;
|
|
6104
|
+
}
|
|
6105
|
+
export interface JobTypeQueryRq {
|
|
6106
|
+
/** 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. */
|
|
6107
|
+
ListID?: string[] | string;
|
|
6108
|
+
/** 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. */
|
|
6109
|
+
FullName?: string[] | string;
|
|
6110
|
+
/** 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. */
|
|
6111
|
+
MaxReturned?: number;
|
|
6112
|
+
/** 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. */
|
|
6113
|
+
ActiveStatus?: ActiveStatus;
|
|
6114
|
+
/** 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). */
|
|
6115
|
+
FromModifiedDate?: string;
|
|
6116
|
+
/** 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). */
|
|
6117
|
+
ToModifiedDate?: string;
|
|
6118
|
+
/** Filters according to the object’s `Name`. */
|
|
6119
|
+
NameFilter?: NameFilter;
|
|
6120
|
+
/** Filters according to the object’s `Name`. */
|
|
6121
|
+
NameRangeFilter?: NameRangeFilter;
|
|
6122
|
+
/** 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. */
|
|
6123
|
+
IncludeRetElement?: string[] | string;
|
|
6124
|
+
}
|
|
6125
|
+
export interface JobTypeQueryRs {
|
|
6126
|
+
JobTypeRet: JobTypeRet[];
|
|
6127
|
+
}
|
|
4674
6128
|
export interface JobTypeRef {
|
|
4675
6129
|
/** 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. */
|
|
4676
6130
|
ListID?: string;
|
|
4677
6131
|
/** `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. */
|
|
4678
6132
|
FullName?: string;
|
|
4679
6133
|
}
|
|
6134
|
+
export interface JobTypeRet {
|
|
6135
|
+
/** 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. */
|
|
6136
|
+
ListID: string;
|
|
6137
|
+
/** Time the object was created. */
|
|
6138
|
+
TimeCreated: string;
|
|
6139
|
+
/** Time the object was last modified. */
|
|
6140
|
+
TimeModified: string;
|
|
6141
|
+
/** 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. */
|
|
6142
|
+
EditSequence: string;
|
|
6143
|
+
/** 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. */
|
|
6144
|
+
Name: string;
|
|
6145
|
+
/** `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. */
|
|
6146
|
+
FullName: string;
|
|
6147
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6148
|
+
IsActive?: boolean;
|
|
6149
|
+
/** 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. */
|
|
6150
|
+
ParentRef?: ParentRef;
|
|
6151
|
+
/** The number of ancestors. For example, The customer job with `Name` = carpets and `FullName` = Jones:Building2:carpets would have a sublevel of 2. */
|
|
6152
|
+
Sublevel: number;
|
|
6153
|
+
}
|
|
4680
6154
|
export interface JournalCreditLine {
|
|
4681
6155
|
/** 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. */
|
|
4682
6156
|
TxnLineID?: string;
|
|
@@ -4884,6 +6358,12 @@ export interface LegalAddress {
|
|
|
4884
6358
|
/** 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. */
|
|
4885
6359
|
Note?: string;
|
|
4886
6360
|
}
|
|
6361
|
+
export interface LiabilityAccountRef {
|
|
6362
|
+
/** 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. */
|
|
6363
|
+
ListID?: string;
|
|
6364
|
+
/** `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. */
|
|
6365
|
+
FullName?: string;
|
|
6366
|
+
}
|
|
4887
6367
|
export interface LinkedTxn {
|
|
4888
6368
|
/** 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.
|
|
4889
6369
|
|
|
@@ -5016,12 +6496,128 @@ export interface PrefVendorRef {
|
|
|
5016
6496
|
/** `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. */
|
|
5017
6497
|
FullName?: string;
|
|
5018
6498
|
}
|
|
6499
|
+
export interface PriceLevelAdd {
|
|
6500
|
+
/** 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. */
|
|
6501
|
+
Name: string;
|
|
6502
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6503
|
+
IsActive?: boolean;
|
|
6504
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. QuickBooks Pro and greater versions support fixed percentages, but only QuickBooks Premier and Enterprise support the per item price level. Where is this discount applied if `Price` Levels are enabled in QuickBooks preferences? The discount is applied to the sales price of the item. If the price level is applied to a customer, it automatically adjusts the `Rate` and `Amount` columns for applicable line items in a QuickBooks Sales Order form, Invoice form, etc. for that customer. The QuickBooks user could still select a different price level. However, the customer price level simply establishes a default price. If no price level is applied to the customer, then the QuickBooks user can apply a price level by clicking the dropdown list of price levels that appears next to the `Rate` column. The default in this case is simply the sales price established for the item. Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%. */
|
|
6505
|
+
PriceLevelFixedPercentage?: string;
|
|
6506
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level. */
|
|
6507
|
+
PriceLevelPerItem?: PriceLevelPerItem | PriceLevelPerItem[];
|
|
6508
|
+
/** 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. */
|
|
6509
|
+
CurrencyRef?: CurrencyRef;
|
|
6510
|
+
}
|
|
6511
|
+
export interface PriceLevelAddRq {
|
|
6512
|
+
PriceLevelAdd: PriceLevelAdd;
|
|
6513
|
+
/** 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. */
|
|
6514
|
+
IncludeRetElement?: string[] | string;
|
|
6515
|
+
}
|
|
6516
|
+
export interface PriceLevelAddRs {
|
|
6517
|
+
PriceLevelRet?: PriceLevelRet;
|
|
6518
|
+
ErrorRecovery?: ErrorRecovery;
|
|
6519
|
+
}
|
|
6520
|
+
export interface PriceLevelMod {
|
|
6521
|
+
/** 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. */
|
|
6522
|
+
ListID: string;
|
|
6523
|
+
/** 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. */
|
|
6524
|
+
EditSequence: string;
|
|
6525
|
+
/** 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. */
|
|
6526
|
+
Name?: string;
|
|
6527
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6528
|
+
IsActive?: boolean;
|
|
6529
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. QuickBooks Pro and greater versions support fixed percentages, but only QuickBooks Premier and Enterprise support the per item price level. Where is this discount applied if `Price` Levels are enabled in QuickBooks preferences? The discount is applied to the sales price of the item. If the price level is applied to a customer, it automatically adjusts the `Rate` and `Amount` columns for applicable line items in a QuickBooks Sales Order form, Invoice form, etc. for that customer. The QuickBooks user could still select a different price level. However, the customer price level simply establishes a default price. If no price level is applied to the customer, then the QuickBooks user can apply a price level by clicking the dropdown list of price levels that appears next to the `Rate` column. The default in this case is simply the sales price established for the item. Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%. */
|
|
6530
|
+
PriceLevelFixedPercentage?: string;
|
|
6531
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level. */
|
|
6532
|
+
PriceLevelPerItem?: PriceLevelPerItem | PriceLevelPerItem[];
|
|
6533
|
+
/** 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. */
|
|
6534
|
+
CurrencyRef?: CurrencyRef;
|
|
6535
|
+
}
|
|
6536
|
+
export interface PriceLevelModRq {
|
|
6537
|
+
PriceLevelMod: PriceLevelMod;
|
|
6538
|
+
/** 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. */
|
|
6539
|
+
IncludeRetElement?: string[] | string;
|
|
6540
|
+
}
|
|
6541
|
+
export interface PriceLevelModRs {
|
|
6542
|
+
PriceLevelRet?: PriceLevelRet;
|
|
6543
|
+
ErrorRecovery?: ErrorRecovery;
|
|
6544
|
+
}
|
|
6545
|
+
export interface PriceLevelPerItem {
|
|
6546
|
+
/** 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. For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax `itemsFor` `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item.For `BillingRateAdd` requests, the `ItemRef` must refer to a service item. You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
6547
|
+
ItemRef: ItemRef;
|
|
6548
|
+
/** When you create a price level, you have the option to create it with a custom price that is either a fixed amount (`CustomPrice`) or a fixed discount percentage (`CustomPricePercent`). Alternatively, instead of a flat custom price or discount, you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item. */
|
|
6549
|
+
CustomPrice?: string;
|
|
6550
|
+
/** When you create a price level, you have the option to create it with a custom price that is either a fixed amount (`CustomPrice`) or a fixed discount percentage (`CustomPricePercent`). */
|
|
6551
|
+
CustomPricePercent?: string;
|
|
6552
|
+
/** If you don’t want to apply a custom price (for price levels) or custom rate (for billing rates), you can apply an adjusted price discount using the pair of fields `AdjustPercentage` and `AdjustRelativeTo` (`AdjustBillingRateRelativeTo` for billing rates). You specify the percentage discount or increase in the `AdjustPercentage` field and the price/rate to be discounted (standard item price, item cost, or the item’s current custom price) in the `AdjustRelativeTo` `fieldTo` field. Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%. */
|
|
6553
|
+
AdjustPercentage: string;
|
|
6554
|
+
/** When you create a price level, you have the option to create it with a flat custom price (flat amount or percentage) or you could use `PriceLevelAdjustment` to apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item. You specify the price discount in the `AdjustPercentage` field and the price to be discounted (standard item price, item cost, or the item’s current customer price) in the `AdjustRelativeTo` `fieldTo` field. */
|
|
6555
|
+
AdjustRelativeTo: AdjustRelativeTo;
|
|
6556
|
+
}
|
|
6557
|
+
export interface PriceLevelPerItemRet {
|
|
6558
|
+
/** 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. For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax `itemsFor` `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item.For `BillingRateAdd` requests, the `ItemRef` must refer to a service item. You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
6559
|
+
ItemRef: ItemRef;
|
|
6560
|
+
/** When you create a price level, you have the option to create it with a custom price that is either a fixed amount (`CustomPrice`) or a fixed discount percentage (`CustomPricePercent`). Alternatively, instead of a flat custom price or discount, you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item. */
|
|
6561
|
+
CustomPrice?: string;
|
|
6562
|
+
/** When you create a price level, you have the option to create it with a custom price that is either a fixed amount (`CustomPrice`) or a fixed discount percentage (`CustomPricePercent`). */
|
|
6563
|
+
CustomPricePercent?: string;
|
|
6564
|
+
}
|
|
6565
|
+
export interface PriceLevelQueryRq {
|
|
6566
|
+
/** 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. */
|
|
6567
|
+
ListID?: string[] | string;
|
|
6568
|
+
/** 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. */
|
|
6569
|
+
FullName?: string[] | string;
|
|
6570
|
+
/** 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. */
|
|
6571
|
+
MaxReturned?: number;
|
|
6572
|
+
/** 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. */
|
|
6573
|
+
ActiveStatus?: ActiveStatus;
|
|
6574
|
+
/** 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). */
|
|
6575
|
+
FromModifiedDate?: string;
|
|
6576
|
+
/** 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). */
|
|
6577
|
+
ToModifiedDate?: string;
|
|
6578
|
+
/** Filters according to the object’s `Name`. */
|
|
6579
|
+
NameFilter?: NameFilter;
|
|
6580
|
+
/** Filters according to the object’s `Name`. */
|
|
6581
|
+
NameRangeFilter?: NameRangeFilter;
|
|
6582
|
+
/** 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. For example, here are some requests that impose limits on what items `ItemRef` can refer to. For `PurchaseOrder` and Bill requests, `ItemRef` cannot refer to discount items or sales-tax `itemsFor` `VehicleMilageAdd` requests, the `ItemRef` must refer to a service item or an other charge item.For `BillingRateAdd` requests, the `ItemRef` must refer to a service item. You can use an `ItemQuery` request to get information about all the items that are set up in the QuickBooks file. “Items” are line items used for fast entry on sales and purchase forms. They include services and goods that a business buys and sells, as well as special items that perform calculations–for example, subtotal, discount, and sales-tax items. Note: In a request, if an `ItemRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
6583
|
+
ItemRef?: ItemRef;
|
|
6584
|
+
/** Filters by the specified currency. */
|
|
6585
|
+
CurrencyFilter?: CurrencyFilter;
|
|
6586
|
+
/** 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. */
|
|
6587
|
+
IncludeRetElement?: string[] | string;
|
|
6588
|
+
}
|
|
6589
|
+
export interface PriceLevelQueryRs {
|
|
6590
|
+
PriceLevelRet: PriceLevelRet[];
|
|
6591
|
+
}
|
|
5019
6592
|
export interface PriceLevelRef {
|
|
5020
6593
|
/** 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. */
|
|
5021
6594
|
ListID?: string;
|
|
5022
6595
|
/** `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. */
|
|
5023
6596
|
FullName?: string;
|
|
5024
6597
|
}
|
|
6598
|
+
export interface PriceLevelRet {
|
|
6599
|
+
/** 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. */
|
|
6600
|
+
ListID?: string;
|
|
6601
|
+
/** Time the object was created. */
|
|
6602
|
+
TimeCreated?: string;
|
|
6603
|
+
/** Time the object was last modified. */
|
|
6604
|
+
TimeModified?: string;
|
|
6605
|
+
/** 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. */
|
|
6606
|
+
EditSequence?: string;
|
|
6607
|
+
/** 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. */
|
|
6608
|
+
Name?: string;
|
|
6609
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
6610
|
+
IsActive?: boolean;
|
|
6611
|
+
/** The types of price level, fixed percentage type or per item types. Per item types are only supported in Premier or Enterprise. */
|
|
6612
|
+
PriceLevelType?: PriceLevelType;
|
|
6613
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. QuickBooks Pro and greater versions support fixed percentages, but only QuickBooks Premier and Enterprise support the per item price level. Where is this discount applied if `Price` Levels are enabled in QuickBooks preferences? The discount is applied to the sales price of the item. If the price level is applied to a customer, it automatically adjusts the `Rate` and `Amount` columns for applicable line items in a QuickBooks Sales Order form, Invoice form, etc. for that customer. The QuickBooks user could still select a different price level. However, the customer price level simply establishes a default price. If no price level is applied to the customer, then the QuickBooks user can apply a price level by clicking the dropdown list of price levels that appears next to the `Rate` column. The default in this case is simply the sales price established for the item. Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%. */
|
|
6614
|
+
PriceLevelFixedPercentage?: string;
|
|
6615
|
+
/** When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level. */
|
|
6616
|
+
PriceLevelPerItemRet: PriceLevelPerItemRet | PriceLevelPerItemRet[];
|
|
6617
|
+
/** 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. */
|
|
6618
|
+
CurrencyRef?: CurrencyRef;
|
|
6619
|
+
}
|
|
6620
|
+
export type PriceLevelType = "FixedPercentage" | "PerItem";
|
|
5025
6621
|
export interface PrimaryContact {
|
|
5026
6622
|
/** The name of the contact. */
|
|
5027
6623
|
ContactName: string;
|
|
@@ -5542,6 +7138,12 @@ export interface SalesTaxCodeRef {
|
|
|
5542
7138
|
}
|
|
5543
7139
|
/** @default: Canada */
|
|
5544
7140
|
export type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
7141
|
+
export interface SalesTaxReturnLineRef {
|
|
7142
|
+
/** 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. */
|
|
7143
|
+
ListID?: string;
|
|
7144
|
+
/** `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. */
|
|
7145
|
+
FullName?: string;
|
|
7146
|
+
}
|
|
5545
7147
|
export interface SalesTaxReturnRef {
|
|
5546
7148
|
/** 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. */
|
|
5547
7149
|
ListID?: string;
|
|
@@ -5662,6 +7264,7 @@ export interface SickHours {
|
|
|
5662
7264
|
AccrualStartDate?: string;
|
|
5663
7265
|
}
|
|
5664
7266
|
export type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
|
|
7267
|
+
export type SpecialItemType = "FinanceCharge" | "ReimbursableExpenseGroup" | "ReimbursableExpenseSubtotal";
|
|
5665
7268
|
export interface SubscribedServices {
|
|
5666
7269
|
/** The list of the Intuit services that the company is or has been subscribed to, for example, Intuit Payroll, QBMS. */
|
|
5667
7270
|
Service?: Service | Service[];
|
|
@@ -5691,6 +7294,12 @@ export interface TaxOnSalesAccountRef {
|
|
|
5691
7294
|
/** `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. */
|
|
5692
7295
|
FullName?: string;
|
|
5693
7296
|
}
|
|
7297
|
+
export interface TaxVendorRef {
|
|
7298
|
+
/** 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. */
|
|
7299
|
+
ListID?: string;
|
|
7300
|
+
/** `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. */
|
|
7301
|
+
FullName?: string;
|
|
7302
|
+
}
|
|
5694
7303
|
export interface TemplateRef {
|
|
5695
7304
|
/** 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. */
|
|
5696
7305
|
ListID?: string;
|