conductor-node 9.7.0 → 9.8.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.
|
@@ -2846,6 +2846,25 @@ export interface CreditMemoRet {
|
|
|
2846
2846
|
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
2847
2847
|
DataExtRet?: DataExtRet | DataExtRet[];
|
|
2848
2848
|
}
|
|
2849
|
+
export interface CurrencyAdd {
|
|
2850
|
+
/** 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. */
|
|
2851
|
+
Name: string;
|
|
2852
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
2853
|
+
IsActive?: boolean;
|
|
2854
|
+
/** For built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency. In most cases, the currency code is composed of the country’s two-character Internet country code plus an extra character representing the currency unit. (Hence the code for Belize Dollars is simply Belize’ two-character Internet code (“BZ”) plus a one-character currency designator (“D”). For user defined currencies, if possible, this nomenclature could be followed but it is not required. */
|
|
2855
|
+
CurrencyCode: string;
|
|
2856
|
+
/** The aggregate controlling the appearance of the currency with regard to comma and decimal. */
|
|
2857
|
+
CurrencyFormat?: CurrencyFormat;
|
|
2858
|
+
}
|
|
2859
|
+
export interface CurrencyAddRq {
|
|
2860
|
+
CurrencyAdd: CurrencyAdd;
|
|
2861
|
+
/** 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. */
|
|
2862
|
+
IncludeRetElement?: string[] | string;
|
|
2863
|
+
}
|
|
2864
|
+
export interface CurrencyAddRs {
|
|
2865
|
+
CurrencyRet?: CurrencyRet;
|
|
2866
|
+
ErrorRecovery?: ErrorRecovery;
|
|
2867
|
+
}
|
|
2849
2868
|
export interface CurrencyFilter {
|
|
2850
2869
|
/** 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`.
|
|
2851
2870
|
|
|
@@ -2854,12 +2873,92 @@ export interface CurrencyFilter {
|
|
|
2854
2873
|
/** 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. */
|
|
2855
2874
|
FullName?: string[] | string;
|
|
2856
2875
|
}
|
|
2876
|
+
export interface CurrencyFormat {
|
|
2877
|
+
/** This enumerated value controls how the thousandth’s place is separated from the next thousand, for example, 1,000,000. The default is Comma, as shown, but you can replace this with one of these values: Period, Space, Apostrophe . */
|
|
2878
|
+
ThousandSeparator?: ThousandSeparator;
|
|
2879
|
+
/** This enumerated value controls how the display of the currency value is grouped, for example, 10,000,000. The default is `XX_XXX_XXX` but you could replace this with `X_XX_XX_XXX` */
|
|
2880
|
+
ThousandSeparatorGrouping?: ThousandSeparatorGrouping;
|
|
2881
|
+
/** This enumerated value controls the display of the decimal value, for example, 1.00. The default is 2 which means 2 decimals are displayed to the right of the decimal point, but you can specify 0 (zero) if you don’t want’ decimals to be displayed. */
|
|
2882
|
+
DecimalPlaces?: DecimalPlaces;
|
|
2883
|
+
/** This enumerated value controls the display of the decimal point, for example, 1.00 or 1,00. The default is Period but you could alternatively specify a value of Comma. */
|
|
2884
|
+
DecimalSeparator?: DecimalSeparator;
|
|
2885
|
+
}
|
|
2886
|
+
export interface CurrencyMod {
|
|
2887
|
+
/** 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. */
|
|
2888
|
+
ListID: string;
|
|
2889
|
+
/** 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. */
|
|
2890
|
+
EditSequence: string;
|
|
2891
|
+
/** 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. */
|
|
2892
|
+
Name?: string;
|
|
2893
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
2894
|
+
IsActive?: boolean;
|
|
2895
|
+
/** For built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency. In most cases, the currency code is composed of the country’s two-character Internet country code plus an extra character representing the currency unit. (Hence the code for Belize Dollars is simply Belize’ two-character Internet code (“BZ”) plus a one-character currency designator (“D”). For user defined currencies, if possible, this nomenclature could be followed but it is not required. */
|
|
2896
|
+
CurrencyCode?: string;
|
|
2897
|
+
/** The aggregate controlling the appearance of the currency with regard to comma and decimal. */
|
|
2898
|
+
CurrencyFormat?: CurrencyFormat;
|
|
2899
|
+
}
|
|
2900
|
+
export interface CurrencyModRq {
|
|
2901
|
+
CurrencyMod: CurrencyMod;
|
|
2902
|
+
/** 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. */
|
|
2903
|
+
IncludeRetElement?: string[] | string;
|
|
2904
|
+
}
|
|
2905
|
+
export interface CurrencyModRs {
|
|
2906
|
+
CurrencyRet?: CurrencyRet;
|
|
2907
|
+
ErrorRecovery?: ErrorRecovery;
|
|
2908
|
+
}
|
|
2909
|
+
export interface CurrencyQueryRq {
|
|
2910
|
+
/** 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. */
|
|
2911
|
+
ListID?: string[] | string;
|
|
2912
|
+
/** 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. */
|
|
2913
|
+
FullName?: string[] | string;
|
|
2914
|
+
/** 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. */
|
|
2915
|
+
MaxReturned?: number;
|
|
2916
|
+
/** 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. */
|
|
2917
|
+
ActiveStatus?: ActiveStatus;
|
|
2918
|
+
/** 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). */
|
|
2919
|
+
FromModifiedDate?: string;
|
|
2920
|
+
/** 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). */
|
|
2921
|
+
ToModifiedDate?: string;
|
|
2922
|
+
/** Filters according to the object’s `Name`. */
|
|
2923
|
+
NameFilter?: NameFilter;
|
|
2924
|
+
/** Filters according to the object’s `Name`. */
|
|
2925
|
+
NameRangeFilter?: NameRangeFilter;
|
|
2926
|
+
/** 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. */
|
|
2927
|
+
IncludeRetElement?: string[] | string;
|
|
2928
|
+
}
|
|
2929
|
+
export interface CurrencyQueryRs {
|
|
2930
|
+
CurrencyRet: CurrencyRet[];
|
|
2931
|
+
}
|
|
2857
2932
|
export interface CurrencyRef {
|
|
2858
2933
|
/** 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. */
|
|
2859
2934
|
ListID?: string;
|
|
2860
2935
|
/** `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. */
|
|
2861
2936
|
FullName?: string;
|
|
2862
2937
|
}
|
|
2938
|
+
export interface CurrencyRet {
|
|
2939
|
+
/** 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. */
|
|
2940
|
+
ListID?: string;
|
|
2941
|
+
/** Time the object was created. */
|
|
2942
|
+
TimeCreated?: string;
|
|
2943
|
+
/** Time the object was last modified. */
|
|
2944
|
+
TimeModified?: string;
|
|
2945
|
+
/** 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. */
|
|
2946
|
+
EditSequence?: string;
|
|
2947
|
+
/** 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. */
|
|
2948
|
+
Name?: string;
|
|
2949
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
2950
|
+
IsActive?: boolean;
|
|
2951
|
+
/** For built-in currencies, the currency code and name is the generally accepted code and name. These are based on the standard ISO 4217 code/name for a country’s currency. In most cases, the currency code is composed of the country’s two-character Internet country code plus an extra character representing the currency unit. (Hence the code for Belize Dollars is simply Belize’ two-character Internet code (“BZ”) plus a one-character currency designator (“D”). For user defined currencies, if possible, this nomenclature could be followed but it is not required. */
|
|
2952
|
+
CurrencyCode?: string;
|
|
2953
|
+
/** The aggregate controlling the appearance of the currency with regard to comma and decimal. */
|
|
2954
|
+
CurrencyFormat?: CurrencyFormat;
|
|
2955
|
+
/** Indicates whether the currency is a built-in currency (value here would be false) or a currency created by a QuickBooks user (value here would be true). */
|
|
2956
|
+
IsUserDefinedCurrency?: boolean;
|
|
2957
|
+
/** 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.) */
|
|
2958
|
+
ExchangeRate?: number;
|
|
2959
|
+
/** The date when the exchange rate was last changed. */
|
|
2960
|
+
AsOfDate?: string;
|
|
2961
|
+
}
|
|
2863
2962
|
export interface CustomDetailReportQueryRq {
|
|
2864
2963
|
/** The type of report being queried. */
|
|
2865
2964
|
CustomDetailReportType: CustomDetailReportType;
|
|
@@ -2973,7 +3072,7 @@ export interface CustomerAdd {
|
|
|
2973
3072
|
PreferredPaymentMethodRef?: PreferredPaymentMethodRef;
|
|
2974
3073
|
/** Customer’s credit-card information. */
|
|
2975
3074
|
CreditCardInfo?: CreditCardInfo;
|
|
2976
|
-
/** `JobStatus` Status information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3075
|
+
/** `JobStatus` `Status` information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
2977
3076
|
JobStatus?: JobStatus;
|
|
2978
3077
|
/** The date on which work for a sub-customer was started; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
2979
3078
|
JobStartDate?: string;
|
|
@@ -3080,7 +3179,7 @@ export interface CustomerMod {
|
|
|
3080
3179
|
PreferredPaymentMethodRef?: PreferredPaymentMethodRef;
|
|
3081
3180
|
/** Customer’s credit-card information. */
|
|
3082
3181
|
CreditCardInfo?: CreditCardInfo;
|
|
3083
|
-
/** `JobStatus` Status information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3182
|
+
/** `JobStatus` `Status` information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3084
3183
|
JobStatus?: JobStatus;
|
|
3085
3184
|
/** The date on which work for a sub-customer was started; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3086
3185
|
JobStartDate?: string;
|
|
@@ -3244,7 +3343,7 @@ export interface CustomerRet {
|
|
|
3244
3343
|
PreferredPaymentMethodRef?: PreferredPaymentMethodRef;
|
|
3245
3344
|
/** Customer’s credit-card information. */
|
|
3246
3345
|
CreditCardInfo?: CreditCardInfo;
|
|
3247
|
-
/** `JobStatus` Status information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3346
|
+
/** `JobStatus` `Status` information about a sub-customer; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3248
3347
|
JobStatus?: JobStatus;
|
|
3249
3348
|
/** The date on which work for a sub-customer was started; used in reports. The Job- elements (`JobDesc`, `JobEndDate`, `JobProjectedEndDate`, `JobStartDate`, and `JobStatus`) correspond to the fields in the Job Info tab of the Edit Job window in QuickBooks. */
|
|
3250
3349
|
JobStartDate?: string;
|
|
@@ -3426,6 +3525,10 @@ export interface DataRow {
|
|
|
3426
3525
|
}
|
|
3427
3526
|
export type DataType = "AMTTYPE" | "BOOLTYPE" | "DATETIMETYPE" | "DATETYPE" | "ENUMTYPE" | "GUIDTYPE" | "IDTYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STRTYPE" | "TIMEINTERVALTYPE";
|
|
3428
3527
|
export type DateMacro = "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
|
|
3528
|
+
/** @default: 2 */
|
|
3529
|
+
export type DecimalPlaces = "0" | "2";
|
|
3530
|
+
/** @default: Period */
|
|
3531
|
+
export type DecimalSeparator = "Comma" | "Period";
|
|
3429
3532
|
export interface DepositAdd {
|
|
3430
3533
|
/** 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. */
|
|
3431
3534
|
TxnDate?: string;
|
|
@@ -8328,6 +8431,169 @@ export interface JournalLineMod {
|
|
|
8328
8431
|
}
|
|
8329
8432
|
export type JournalLineType = "Credit" | "Debit";
|
|
8330
8433
|
export type KeyEmployee = "No" | "Yes";
|
|
8434
|
+
export interface LeadAdd {
|
|
8435
|
+
/** `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. */
|
|
8436
|
+
FullName: string;
|
|
8437
|
+
/** The status of the lead. */
|
|
8438
|
+
Status?: Status;
|
|
8439
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8440
|
+
CompanyName?: string;
|
|
8441
|
+
/** The main phone number. */
|
|
8442
|
+
MainPhone?: string;
|
|
8443
|
+
/** List of additional contacts. */
|
|
8444
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8445
|
+
/** List of locations. */
|
|
8446
|
+
Locations?: Locations | Locations[];
|
|
8447
|
+
/** List of lead contacts. */
|
|
8448
|
+
LeadContacts?: LeadContacts | LeadContacts[];
|
|
8449
|
+
}
|
|
8450
|
+
export interface LeadAddress {
|
|
8451
|
+
/** The first line of an address. */
|
|
8452
|
+
Addr1?: string;
|
|
8453
|
+
/** The second line of an address (if a second line is needed). */
|
|
8454
|
+
Addr2?: string;
|
|
8455
|
+
/** The third line of an address (if a third line is needed). */
|
|
8456
|
+
Addr3?: string;
|
|
8457
|
+
/** The fourth line of an address (if a fourth line is needed). */
|
|
8458
|
+
Addr4?: string;
|
|
8459
|
+
/** The fifth line of an address (if a fifth line is needed). */
|
|
8460
|
+
Addr5?: string;
|
|
8461
|
+
}
|
|
8462
|
+
export interface LeadAddRq {
|
|
8463
|
+
LeadAdd: LeadAdd;
|
|
8464
|
+
/** 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. */
|
|
8465
|
+
IncludeRetElement?: string[] | string;
|
|
8466
|
+
}
|
|
8467
|
+
export interface LeadAddRs {
|
|
8468
|
+
LeadRet?: LeadRet;
|
|
8469
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8470
|
+
}
|
|
8471
|
+
export interface LeadContacts {
|
|
8472
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8473
|
+
Salutation?: string;
|
|
8474
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8475
|
+
FirstName: string;
|
|
8476
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8477
|
+
MiddleName?: string;
|
|
8478
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8479
|
+
LastName?: string;
|
|
8480
|
+
/** The job title of a customer, vendor, employee, or person on the “other names” list. */
|
|
8481
|
+
JobTitle?: string;
|
|
8482
|
+
/** List of additional contacts. */
|
|
8483
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8484
|
+
/** Flag for if this is a primary contact on a lead. */
|
|
8485
|
+
IsPrimaryContact?: boolean;
|
|
8486
|
+
}
|
|
8487
|
+
export interface LeadContactsMod {
|
|
8488
|
+
/** `LeadContactID` is a way to identify a lead contact object. When a lead contact object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `LeadContactID`. */
|
|
8489
|
+
LeadContactID: number;
|
|
8490
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8491
|
+
Salutation?: string;
|
|
8492
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8493
|
+
FirstName: string;
|
|
8494
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8495
|
+
MiddleName?: string;
|
|
8496
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8497
|
+
LastName?: string;
|
|
8498
|
+
/** The job title of a customer, vendor, employee, or person on the “other names” list. */
|
|
8499
|
+
JobTitle?: string;
|
|
8500
|
+
/** List of additional contacts. */
|
|
8501
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8502
|
+
/** Flag for if this is a primary contact on a lead. */
|
|
8503
|
+
IsPrimaryContact?: boolean;
|
|
8504
|
+
}
|
|
8505
|
+
export interface LeadContactsRet {
|
|
8506
|
+
/** `LeadContactID` is a way to identify a lead contact object. When a lead contact object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `LeadContactID`. */
|
|
8507
|
+
LeadContactID: number;
|
|
8508
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8509
|
+
Salutation?: string;
|
|
8510
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8511
|
+
FirstName: string;
|
|
8512
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8513
|
+
MiddleName?: string;
|
|
8514
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8515
|
+
LastName?: string;
|
|
8516
|
+
/** The job title of a customer, vendor, employee, or person on the “other names” list. */
|
|
8517
|
+
JobTitle?: string;
|
|
8518
|
+
/** List of additional contacts. */
|
|
8519
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8520
|
+
/** Flag for if this is a primary contact on a lead. */
|
|
8521
|
+
IsPrimaryContact?: boolean;
|
|
8522
|
+
}
|
|
8523
|
+
export interface LeadMod {
|
|
8524
|
+
/** 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. */
|
|
8525
|
+
ListID: string;
|
|
8526
|
+
/** 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. */
|
|
8527
|
+
EditSequence: string;
|
|
8528
|
+
/** `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. */
|
|
8529
|
+
FullName: string;
|
|
8530
|
+
/** The status of the lead. */
|
|
8531
|
+
Status?: Status;
|
|
8532
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8533
|
+
CompanyName?: string;
|
|
8534
|
+
/** The main phone number. */
|
|
8535
|
+
MainPhone?: string;
|
|
8536
|
+
/** List of additional contacts. */
|
|
8537
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8538
|
+
/** List of modified locations. */
|
|
8539
|
+
LocationsMod?: LocationsMod | LocationsMod[];
|
|
8540
|
+
/** List of modified lead contacts. */
|
|
8541
|
+
LeadContactsMod?: LeadContactsMod | LeadContactsMod[];
|
|
8542
|
+
}
|
|
8543
|
+
export interface LeadModRq {
|
|
8544
|
+
LeadMod: LeadMod;
|
|
8545
|
+
/** 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. */
|
|
8546
|
+
IncludeRetElement?: string[] | string;
|
|
8547
|
+
}
|
|
8548
|
+
export interface LeadModRs {
|
|
8549
|
+
LeadRet?: LeadRet;
|
|
8550
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8551
|
+
}
|
|
8552
|
+
export interface LeadQueryRq {
|
|
8553
|
+
/** 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. */
|
|
8554
|
+
ListID?: string[] | string;
|
|
8555
|
+
/** List of names. */
|
|
8556
|
+
Name?: string[] | string;
|
|
8557
|
+
/** 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. */
|
|
8558
|
+
MaxReturned?: number;
|
|
8559
|
+
/** 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). */
|
|
8560
|
+
FromModifiedDate?: string;
|
|
8561
|
+
/** 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). */
|
|
8562
|
+
ToModifiedDate?: string;
|
|
8563
|
+
/** Filters according to the object’s `Name`. */
|
|
8564
|
+
NameFilter?: NameFilter;
|
|
8565
|
+
/** Filters according to the object’s `Name`. */
|
|
8566
|
+
NameRangeFilter?: NameRangeFilter;
|
|
8567
|
+
/** 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. */
|
|
8568
|
+
IncludeRetElement?: string[] | string;
|
|
8569
|
+
}
|
|
8570
|
+
export interface LeadQueryRs {
|
|
8571
|
+
LeadRet: LeadRet[];
|
|
8572
|
+
}
|
|
8573
|
+
export interface LeadRet {
|
|
8574
|
+
/** 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. */
|
|
8575
|
+
ListID: string;
|
|
8576
|
+
/** Time the object was created. */
|
|
8577
|
+
TimeCreated: string;
|
|
8578
|
+
/** Time the object was last modified. */
|
|
8579
|
+
TimeModified: string;
|
|
8580
|
+
/** 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. */
|
|
8581
|
+
EditSequence: string;
|
|
8582
|
+
/** `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. */
|
|
8583
|
+
FullName: string;
|
|
8584
|
+
/** The status of the lead. */
|
|
8585
|
+
Status?: Status;
|
|
8586
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8587
|
+
CompanyName?: string;
|
|
8588
|
+
/** The main phone number. */
|
|
8589
|
+
MainPhone?: string;
|
|
8590
|
+
/** List of additional contacts. */
|
|
8591
|
+
AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
|
|
8592
|
+
/** List of returned locations. */
|
|
8593
|
+
LocationsRet?: LocationsRet | LocationsRet[];
|
|
8594
|
+
/** List of returned lead contacts. */
|
|
8595
|
+
LeadContactsRet?: LeadContactsRet | LeadContactsRet[];
|
|
8596
|
+
}
|
|
8331
8597
|
export interface LegalAddress {
|
|
8332
8598
|
/** The first line of an address. */
|
|
8333
8599
|
Addr1?: string;
|
|
@@ -8387,6 +8653,30 @@ export interface LinkToTxn {
|
|
|
8387
8653
|
TxnLineID: string;
|
|
8388
8654
|
}
|
|
8389
8655
|
export type LinkType = "AMTTYPE" | "QUANTYPE";
|
|
8656
|
+
export interface Locations {
|
|
8657
|
+
/** Where the asset is located or has been placed into service. */
|
|
8658
|
+
Location: string;
|
|
8659
|
+
/** Address for the lead. */
|
|
8660
|
+
LeadAddress?: LeadAddress;
|
|
8661
|
+
}
|
|
8662
|
+
export interface LocationsMod {
|
|
8663
|
+
/** `LocationID` is a way to identify a location object. When a location object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `LocationID`. */
|
|
8664
|
+
LocationID: number;
|
|
8665
|
+
/** Where the asset is located or has been placed into service. */
|
|
8666
|
+
Location: string;
|
|
8667
|
+
/** Address for the lead. */
|
|
8668
|
+
LeadAddress?: LeadAddress;
|
|
8669
|
+
}
|
|
8670
|
+
export interface LocationsRet {
|
|
8671
|
+
/** `LocationID` is a way to identify a location object. When a location object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `LocationID`. */
|
|
8672
|
+
LocationID: number;
|
|
8673
|
+
/** Main address for the lead. */
|
|
8674
|
+
MainAddress: string;
|
|
8675
|
+
/** Where the asset is located or has been placed into service. */
|
|
8676
|
+
Location: string;
|
|
8677
|
+
/** Address for the lead. */
|
|
8678
|
+
LeadAddress?: LeadAddress;
|
|
8679
|
+
}
|
|
8390
8680
|
export interface LotNumberAdjustment {
|
|
8391
8681
|
/** The lot number of the asset. */
|
|
8392
8682
|
LotNumber?: string;
|
|
@@ -8432,29 +8722,228 @@ export interface NameRangeFilter {
|
|
|
8432
8722
|
export type OnFile = "No" | "Yes";
|
|
8433
8723
|
export type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
|
|
8434
8724
|
export type OptionForPriceRuleConflict = "BasePrice" | "Zero";
|
|
8435
|
-
export interface
|
|
8436
|
-
/**
|
|
8437
|
-
|
|
8438
|
-
/**
|
|
8439
|
-
|
|
8725
|
+
export interface OtherNameAdd {
|
|
8726
|
+
/** 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. */
|
|
8727
|
+
Name: string;
|
|
8728
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8729
|
+
IsActive?: boolean;
|
|
8730
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8731
|
+
CompanyName?: string;
|
|
8732
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8733
|
+
Salutation?: string;
|
|
8734
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8735
|
+
FirstName?: string;
|
|
8736
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8737
|
+
MiddleName?: string;
|
|
8738
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8739
|
+
LastName?: string;
|
|
8740
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
8741
|
+
OtherNameAddress?: OtherNameAddress;
|
|
8742
|
+
/** The telephone number. */
|
|
8743
|
+
Phone?: string;
|
|
8744
|
+
/** A telephone number given as an alternative to `Phone`. */
|
|
8745
|
+
AltPhone?: string;
|
|
8746
|
+
/** Fax number. */
|
|
8747
|
+
Fax?: string;
|
|
8748
|
+
/** E-mail address. */
|
|
8749
|
+
Email?: string;
|
|
8750
|
+
/** The name of a contact person for a customer or vendor. */
|
|
8751
|
+
Contact?: string;
|
|
8752
|
+
/** The name of an alternate contact person for a vendor, customer, or “other name” entry. */
|
|
8753
|
+
AltContact?: string;
|
|
8754
|
+
/** Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the `IsUsingAccountNumber` preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers will not be visible in the user interface. */
|
|
8755
|
+
AccountNumber?: string;
|
|
8756
|
+
/** Additional information. */
|
|
8757
|
+
Notes?: string;
|
|
8758
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
8759
|
+
ExternalGUID?: string;
|
|
8440
8760
|
}
|
|
8441
|
-
export interface
|
|
8442
|
-
/**
|
|
8443
|
-
|
|
8444
|
-
/**
|
|
8445
|
-
|
|
8761
|
+
export interface OtherNameAddress {
|
|
8762
|
+
/** The first line of an address. */
|
|
8763
|
+
Addr1?: string;
|
|
8764
|
+
/** The second line of an address (if a second line is needed). */
|
|
8765
|
+
Addr2?: string;
|
|
8766
|
+
/** The third line of an address (if a third line is needed). */
|
|
8767
|
+
Addr3?: string;
|
|
8768
|
+
/** The fourth line of an address (if a fourth line is needed). */
|
|
8769
|
+
Addr4?: string;
|
|
8770
|
+
/** The fifth line of an address (if a fifth line is needed). */
|
|
8771
|
+
Addr5?: string;
|
|
8772
|
+
/** The city name in an address. */
|
|
8773
|
+
City?: string;
|
|
8774
|
+
/** The state name in an address. */
|
|
8775
|
+
State?: string;
|
|
8776
|
+
/** The postal code in an address. */
|
|
8777
|
+
PostalCode?: string;
|
|
8778
|
+
/** The country name in an address, or, in returned Host information (`HostRet` or `HostInfo`), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.) */
|
|
8779
|
+
Country?: string;
|
|
8780
|
+
/** 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. */
|
|
8781
|
+
Note?: string;
|
|
8446
8782
|
}
|
|
8447
|
-
export interface
|
|
8448
|
-
/**
|
|
8449
|
-
|
|
8450
|
-
/**
|
|
8451
|
-
|
|
8783
|
+
export interface OtherNameAddressBlock {
|
|
8784
|
+
/** The first line of an address. */
|
|
8785
|
+
Addr1?: string;
|
|
8786
|
+
/** The second line of an address (if a second line is needed). */
|
|
8787
|
+
Addr2?: string;
|
|
8788
|
+
/** The third line of an address (if a third line is needed). */
|
|
8789
|
+
Addr3?: string;
|
|
8790
|
+
/** The fourth line of an address (if a fourth line is needed). */
|
|
8791
|
+
Addr4?: string;
|
|
8792
|
+
/** The fifth line of an address (if a fifth line is needed). */
|
|
8793
|
+
Addr5?: string;
|
|
8452
8794
|
}
|
|
8453
|
-
|
|
8454
|
-
|
|
8455
|
-
|
|
8456
|
-
|
|
8457
|
-
|
|
8795
|
+
export interface OtherNameAddRq {
|
|
8796
|
+
OtherNameAdd: OtherNameAdd;
|
|
8797
|
+
/** 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. */
|
|
8798
|
+
IncludeRetElement?: string[] | string;
|
|
8799
|
+
}
|
|
8800
|
+
export interface OtherNameAddRs {
|
|
8801
|
+
OtherNameRet?: OtherNameRet;
|
|
8802
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8803
|
+
}
|
|
8804
|
+
export interface OtherNameMod {
|
|
8805
|
+
/** 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. */
|
|
8806
|
+
ListID: string;
|
|
8807
|
+
/** 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. */
|
|
8808
|
+
EditSequence: string;
|
|
8809
|
+
/** 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. */
|
|
8810
|
+
Name?: string;
|
|
8811
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8812
|
+
IsActive?: boolean;
|
|
8813
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8814
|
+
CompanyName?: string;
|
|
8815
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8816
|
+
Salutation?: string;
|
|
8817
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8818
|
+
FirstName?: string;
|
|
8819
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8820
|
+
MiddleName?: string;
|
|
8821
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8822
|
+
LastName?: string;
|
|
8823
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
8824
|
+
OtherNameAddress?: OtherNameAddress;
|
|
8825
|
+
/** The telephone number. */
|
|
8826
|
+
Phone?: string;
|
|
8827
|
+
/** A telephone number given as an alternative to `Phone`. */
|
|
8828
|
+
AltPhone?: string;
|
|
8829
|
+
/** Fax number. */
|
|
8830
|
+
Fax?: string;
|
|
8831
|
+
/** E-mail address. */
|
|
8832
|
+
Email?: string;
|
|
8833
|
+
/** The name of a contact person for a customer or vendor. */
|
|
8834
|
+
Contact?: string;
|
|
8835
|
+
/** The name of an alternate contact person for a vendor, customer, or “other name” entry. */
|
|
8836
|
+
AltContact?: string;
|
|
8837
|
+
/** Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the `IsUsingAccountNumber` preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers will not be visible in the user interface. */
|
|
8838
|
+
AccountNumber?: string;
|
|
8839
|
+
/** Additional information. */
|
|
8840
|
+
Notes?: string;
|
|
8841
|
+
}
|
|
8842
|
+
export interface OtherNameModRq {
|
|
8843
|
+
OtherNameMod: OtherNameMod;
|
|
8844
|
+
/** 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. */
|
|
8845
|
+
IncludeRetElement?: string[] | string;
|
|
8846
|
+
}
|
|
8847
|
+
export interface OtherNameModRs {
|
|
8848
|
+
OtherNameRet?: OtherNameRet;
|
|
8849
|
+
ErrorRecovery?: ErrorRecovery;
|
|
8850
|
+
}
|
|
8851
|
+
export interface OtherNameQueryRq {
|
|
8852
|
+
/** 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. */
|
|
8853
|
+
ListID?: string[] | string;
|
|
8854
|
+
/** 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. */
|
|
8855
|
+
FullName?: string[] | string;
|
|
8856
|
+
/** 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. */
|
|
8857
|
+
MaxReturned?: number;
|
|
8858
|
+
/** 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. */
|
|
8859
|
+
ActiveStatus?: ActiveStatus;
|
|
8860
|
+
/** 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). */
|
|
8861
|
+
FromModifiedDate?: string;
|
|
8862
|
+
/** 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). */
|
|
8863
|
+
ToModifiedDate?: string;
|
|
8864
|
+
/** Filters according to the object’s `Name`. */
|
|
8865
|
+
NameFilter?: NameFilter;
|
|
8866
|
+
/** Filters according to the object’s `Name`. */
|
|
8867
|
+
NameRangeFilter?: NameRangeFilter;
|
|
8868
|
+
/** 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. */
|
|
8869
|
+
IncludeRetElement?: string[] | string;
|
|
8870
|
+
/** 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. */
|
|
8871
|
+
OwnerID?: string[] | string;
|
|
8872
|
+
}
|
|
8873
|
+
export interface OtherNameQueryRs {
|
|
8874
|
+
OtherNameRet: OtherNameRet[];
|
|
8875
|
+
}
|
|
8876
|
+
export interface OtherNameRet {
|
|
8877
|
+
/** 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. */
|
|
8878
|
+
ListID: string;
|
|
8879
|
+
/** Time the object was created. */
|
|
8880
|
+
TimeCreated: string;
|
|
8881
|
+
/** Time the object was last modified. */
|
|
8882
|
+
TimeModified: string;
|
|
8883
|
+
/** 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. */
|
|
8884
|
+
EditSequence: string;
|
|
8885
|
+
/** 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. */
|
|
8886
|
+
Name: string;
|
|
8887
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
8888
|
+
IsActive?: boolean;
|
|
8889
|
+
/** The name of the QuickBooks user’s business, as specified in QuickBooks. `CompanyName` and `Address` are used on invoices, checks, and other forms. (`LegalCompanyName` and `LegalAddress`, on the other hand, are used on a company’s tax forms and pay stubs.) */
|
|
8890
|
+
CompanyName?: string;
|
|
8891
|
+
/** A formal reference, such as Mr. or Dr., that precedes a name. */
|
|
8892
|
+
Salutation?: string;
|
|
8893
|
+
/** The first name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8894
|
+
FirstName?: string;
|
|
8895
|
+
/** The middle name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8896
|
+
MiddleName?: string;
|
|
8897
|
+
/** The last name of a customer, vendor, employee, or person on the “other names” list. */
|
|
8898
|
+
LastName?: string;
|
|
8899
|
+
/** If an address request fails, some combination of address fields might be too long. */
|
|
8900
|
+
OtherNameAddress?: OtherNameAddress;
|
|
8901
|
+
/** The address expressed as an address block of `Addr1` through `Addr5`, depending on the number of lines in the original request that created the address. */
|
|
8902
|
+
OtherNameAddressBlock?: OtherNameAddressBlock;
|
|
8903
|
+
/** The telephone number. */
|
|
8904
|
+
Phone?: string;
|
|
8905
|
+
/** A telephone number given as an alternative to `Phone`. */
|
|
8906
|
+
AltPhone?: string;
|
|
8907
|
+
/** Fax number. */
|
|
8908
|
+
Fax?: string;
|
|
8909
|
+
/** E-mail address. */
|
|
8910
|
+
Email?: string;
|
|
8911
|
+
/** The name of a contact person for a customer or vendor. */
|
|
8912
|
+
Contact?: string;
|
|
8913
|
+
/** The name of an alternate contact person for a vendor, customer, or “other name” entry. */
|
|
8914
|
+
AltContact?: string;
|
|
8915
|
+
/** Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. If the `IsUsingAccountNumber` preference is false (that is, if the QuickBooks user has the account numbers Preference turned off), you can still set account numbers through the SDK, but the numbers will not be visible in the user interface. */
|
|
8916
|
+
AccountNumber?: string;
|
|
8917
|
+
/** Additional information. */
|
|
8918
|
+
Notes?: string;
|
|
8919
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
8920
|
+
ExternalGUID?: string;
|
|
8921
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
8922
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
8923
|
+
}
|
|
8924
|
+
export interface OverrideClassRef {
|
|
8925
|
+
/** 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. */
|
|
8926
|
+
ListID?: string;
|
|
8927
|
+
/** `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. */
|
|
8928
|
+
FullName?: string;
|
|
8929
|
+
}
|
|
8930
|
+
export interface OverrideItemAccountRef {
|
|
8931
|
+
/** 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. */
|
|
8932
|
+
ListID?: string;
|
|
8933
|
+
/** `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. */
|
|
8934
|
+
FullName?: string;
|
|
8935
|
+
}
|
|
8936
|
+
export interface OverrideUOMSetRef {
|
|
8937
|
+
/** 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. */
|
|
8938
|
+
ListID?: string;
|
|
8939
|
+
/** `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. */
|
|
8940
|
+
FullName?: string;
|
|
8941
|
+
}
|
|
8942
|
+
/** @default: All */
|
|
8943
|
+
export type PaidStatus = "All" | "NotPaidOnly" | "PaidOnly";
|
|
8944
|
+
export interface ParentRef {
|
|
8945
|
+
/** 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. */
|
|
8946
|
+
ListID?: string;
|
|
8458
8947
|
/** `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. */
|
|
8459
8948
|
FullName?: string;
|
|
8460
8949
|
}
|
|
@@ -10615,6 +11104,193 @@ export interface SalesTaxCodeRet {
|
|
|
10615
11104
|
}
|
|
10616
11105
|
/** @default: Canada */
|
|
10617
11106
|
export type SalesTaxCountry = "Australia" | "Canada" | "UK" | "US";
|
|
11107
|
+
export interface SalesTaxPaymentCheckAdd {
|
|
11108
|
+
/** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
11109
|
+
|
|
11110
|
+
In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written.
|
|
11111
|
+
|
|
11112
|
+
In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
|
|
11113
|
+
PayeeEntityRef: PayeeEntityRef;
|
|
11114
|
+
/** 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. */
|
|
11115
|
+
TxnDate: string;
|
|
11116
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
11117
|
+
BankAccountRef: BankAccountRef;
|
|
11118
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once.
|
|
11119
|
+
|
|
11120
|
+
Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
11121
|
+
IsToBePrinted?: boolean;
|
|
11122
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
11123
|
+
|
|
11124
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
11125
|
+
|
|
11126
|
+
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. */
|
|
11127
|
+
RefNumber?: string;
|
|
11128
|
+
/** Additional information. */
|
|
11129
|
+
Memo?: string;
|
|
11130
|
+
/** If an address request fails, some combination of address fields might be too long. In a Check, `BillPaymentCheck`, or `SalesTaxPaymentCheck` message, `Address` is the address that will print on the check. */
|
|
11131
|
+
Address?: Address;
|
|
11132
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
11133
|
+
ExternalGUID?: string;
|
|
11134
|
+
/** A list of `ISalesTaxPaymentCheckLineRet` objects, each representing one line in the sales-tax payment check. */
|
|
11135
|
+
SalesTaxPaymentCheckLineAdd: SalesTaxPaymentCheckLineAdd | SalesTaxPaymentCheckLineAdd[];
|
|
11136
|
+
}
|
|
11137
|
+
export interface SalesTaxPaymentCheckAddRq {
|
|
11138
|
+
SalesTaxPaymentCheckAdd: SalesTaxPaymentCheckAdd;
|
|
11139
|
+
/** 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.
|
|
11140
|
+
|
|
11141
|
+
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.
|
|
11142
|
+
|
|
11143
|
+
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. */
|
|
11144
|
+
IncludeRetElement?: string[] | string;
|
|
11145
|
+
}
|
|
11146
|
+
export interface SalesTaxPaymentCheckAddRs {
|
|
11147
|
+
SalesTaxPaymentCheckRet?: SalesTaxPaymentCheckRet;
|
|
11148
|
+
ErrorRecovery?: ErrorRecovery;
|
|
11149
|
+
}
|
|
11150
|
+
export interface SalesTaxPaymentCheckLineAdd {
|
|
11151
|
+
/** A sales-tax item is used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the `ItemSalesTaxGroupAdd` message.) An `ItemSalesTaxRef` aggregate refers to an item on this list. In a request, if an `ItemSalesTaxRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
11152
|
+
|
|
11153
|
+
Taxes can be reflected in transaction line items
|
|
11154
|
+
|
|
11155
|
+
The following information refers to invoices specifically, but it also applies to sales receipts. Generally its best to assign a tax item or tax group item to an invoice and allow QuickBooks to apply the same tax to all taxable items on the invoice. However in some situations multiple tax combinations are required, so this method doesn’t work. In this case one must use techniques to apply the taxes in the invoice itself as line items. Using lines to apply taxes isn’t always straight forward.
|
|
11156
|
+
|
|
11157
|
+
When applying taxes as line items, only single tax items can be used, tax groups can only be used for the entire invoice. If you have multiple taxes which apply to all taxable items, and one or more other taxes that only apply to some of the items on an invoice its better to use a tax group which applies to the entire invoice for the taxes which applies to all taxable items and then apply the other taxes in the invoice itself. One applies a tax or tax group to an entire invoice by using the `ItemSalesTaxRef` aggregate.
|
|
11158
|
+
|
|
11159
|
+
One can use subtotals to apply a single tax line to multiple items in an invoice, but the tax is only applied automatically for the first tax line after the subtotal line. Any other tax lines which need to be applied to the subtotal line must supply their own amount. If you don’t supply an amount the amount comes out as zero and the tax line is useless. When one does supply an amount, the amount of tax on the subtotal also shows up in the rate column for that tax line. There isn’t any way for the rate to show up as anything other than the amount of the tax.
|
|
11160
|
+
|
|
11161
|
+
If you have a complicated tax situation where no single tax applies to all taxable items on the invoice, you must choose a zero percent tax to apply for the entire invoice. It is recommended to name such a tax item “Tax Calculated On Invoice” so that it’s clear that the tax is not being applied by QuickBooks on the entire invoice. */
|
|
11162
|
+
ItemSalesTaxRef?: ItemSalesTaxRef;
|
|
11163
|
+
/** A monetary amount. */
|
|
11164
|
+
Amount: string;
|
|
11165
|
+
}
|
|
11166
|
+
export interface SalesTaxPaymentCheckLineRet {
|
|
11167
|
+
/** 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.)
|
|
11168
|
+
|
|
11169
|
+
If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
|
|
11170
|
+
TxnLineID: string;
|
|
11171
|
+
/** A sales-tax item is used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the `ItemSalesTaxGroupAdd` message.) An `ItemSalesTaxRef` aggregate refers to an item on this list. In a request, if an `ItemSalesTaxRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
11172
|
+
|
|
11173
|
+
Taxes can be reflected in transaction line items
|
|
11174
|
+
|
|
11175
|
+
The following information refers to invoices specifically, but it also applies to sales receipts. Generally its best to assign a tax item or tax group item to an invoice and allow QuickBooks to apply the same tax to all taxable items on the invoice. However in some situations multiple tax combinations are required, so this method doesn’t work. In this case one must use techniques to apply the taxes in the invoice itself as line items. Using lines to apply taxes isn’t always straight forward.
|
|
11176
|
+
|
|
11177
|
+
When applying taxes as line items, only single tax items can be used, tax groups can only be used for the entire invoice. If you have multiple taxes which apply to all taxable items, and one or more other taxes that only apply to some of the items on an invoice its better to use a tax group which applies to the entire invoice for the taxes which applies to all taxable items and then apply the other taxes in the invoice itself. One applies a tax or tax group to an entire invoice by using the `ItemSalesTaxRef` aggregate.
|
|
11178
|
+
|
|
11179
|
+
One can use subtotals to apply a single tax line to multiple items in an invoice, but the tax is only applied automatically for the first tax line after the subtotal line. Any other tax lines which need to be applied to the subtotal line must supply their own amount. If you don’t supply an amount the amount comes out as zero and the tax line is useless. When one does supply an amount, the amount of tax on the subtotal also shows up in the rate column for that tax line. There isn’t any way for the rate to show up as anything other than the amount of the tax.
|
|
11180
|
+
|
|
11181
|
+
If you have a complicated tax situation where no single tax applies to all taxable items on the invoice, you must choose a zero percent tax to apply for the entire invoice. It is recommended to name such a tax item “Tax Calculated On Invoice” so that it’s clear that the tax is not being applied by QuickBooks on the entire invoice. */
|
|
11182
|
+
ItemSalesTaxRef?: ItemSalesTaxRef;
|
|
11183
|
+
/** A monetary amount. */
|
|
11184
|
+
Amount?: string;
|
|
11185
|
+
}
|
|
11186
|
+
export interface SalesTaxPaymentCheckMod {
|
|
11187
|
+
/** 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. */
|
|
11188
|
+
TxnID: string;
|
|
11189
|
+
/** 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. */
|
|
11190
|
+
EditSequence: string;
|
|
11191
|
+
/** 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. */
|
|
11192
|
+
TxnDate?: string;
|
|
11193
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
11194
|
+
BankAccountRef?: BankAccountRef;
|
|
11195
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once. Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
11196
|
+
IsToBePrinted?: boolean;
|
|
11197
|
+
/** 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. */
|
|
11198
|
+
RefNumber?: string;
|
|
11199
|
+
/** Additional information. */
|
|
11200
|
+
Memo?: string;
|
|
11201
|
+
/** If an address request fails, some combination of address fields might be too long. In a Check, `BillPaymentCheck`, or `SalesTaxPaymentCheck` message, `Address` is the address that will print on the check. */
|
|
11202
|
+
Address?: Address;
|
|
11203
|
+
}
|
|
11204
|
+
export interface SalesTaxPaymentCheckModRq {
|
|
11205
|
+
SalesTaxPaymentCheckMod: SalesTaxPaymentCheckMod;
|
|
11206
|
+
/** 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. */
|
|
11207
|
+
IncludeRetElement?: string[] | string;
|
|
11208
|
+
}
|
|
11209
|
+
export interface SalesTaxPaymentCheckModRs {
|
|
11210
|
+
SalesTaxPaymentCheckRet?: SalesTaxPaymentCheckRet;
|
|
11211
|
+
ErrorRecovery?: ErrorRecovery;
|
|
11212
|
+
}
|
|
11213
|
+
export interface SalesTaxPaymentCheckQueryRq {
|
|
11214
|
+
/** 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. */
|
|
11215
|
+
TxnID?: string[] | string;
|
|
11216
|
+
/** 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. */
|
|
11217
|
+
RefNumber?: string[] | string;
|
|
11218
|
+
/** 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. */
|
|
11219
|
+
RefNumberCaseSensitive?: string[] | string;
|
|
11220
|
+
/** 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. */
|
|
11221
|
+
MaxReturned?: number;
|
|
11222
|
+
/** 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.) */
|
|
11223
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
11224
|
+
/** Filters according to the original transaction dates. */
|
|
11225
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
11226
|
+
/** 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. */
|
|
11227
|
+
EntityFilter?: EntityFilter;
|
|
11228
|
+
/** 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. */
|
|
11229
|
+
AccountFilter?: AccountFilter;
|
|
11230
|
+
/** Filters according to the item name or ID. 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. */
|
|
11231
|
+
ItemFilter?: ItemFilter;
|
|
11232
|
+
/** Filters according to `RefNumber`. */
|
|
11233
|
+
RefNumberFilter?: RefNumberFilter;
|
|
11234
|
+
/** 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`. */
|
|
11235
|
+
RefNumberRangeFilter?: RefNumberRangeFilter;
|
|
11236
|
+
/** 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. */
|
|
11237
|
+
IncludeLineItems?: boolean;
|
|
11238
|
+
/** 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. */
|
|
11239
|
+
IncludeRetElement?: string[] | string;
|
|
11240
|
+
/** 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. */
|
|
11241
|
+
OwnerID?: string[] | string;
|
|
11242
|
+
}
|
|
11243
|
+
export interface SalesTaxPaymentCheckQueryRs {
|
|
11244
|
+
SalesTaxPaymentCheckRet: SalesTaxPaymentCheckRet[];
|
|
11245
|
+
}
|
|
11246
|
+
export interface SalesTaxPaymentCheckRet {
|
|
11247
|
+
/** 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.
|
|
11248
|
+
|
|
11249
|
+
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. */
|
|
11250
|
+
TxnID: string;
|
|
11251
|
+
/** Time the object was created. */
|
|
11252
|
+
TimeCreated: string;
|
|
11253
|
+
/** Time the object was last modified. */
|
|
11254
|
+
TimeModified: string;
|
|
11255
|
+
/** 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. */
|
|
11256
|
+
EditSequence: string;
|
|
11257
|
+
/** An identifying number for this transaction. */
|
|
11258
|
+
TxnNumber?: number;
|
|
11259
|
+
/** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.
|
|
11260
|
+
|
|
11261
|
+
In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written.
|
|
11262
|
+
|
|
11263
|
+
In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
|
|
11264
|
+
PayeeEntityRef?: PayeeEntityRef;
|
|
11265
|
+
/** 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. */
|
|
11266
|
+
TxnDate: string;
|
|
11267
|
+
/** Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. If a `BankAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
|
|
11268
|
+
BankAccountRef: BankAccountRef;
|
|
11269
|
+
/** A monetary amount. */
|
|
11270
|
+
Amount: string;
|
|
11271
|
+
/** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user.
|
|
11272
|
+
|
|
11273
|
+
In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.
|
|
11274
|
+
|
|
11275
|
+
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. */
|
|
11276
|
+
RefNumber?: string;
|
|
11277
|
+
/** Additional information. */
|
|
11278
|
+
Memo?: string;
|
|
11279
|
+
/** If an address request fails, some combination of address fields might be too long. In a Check, `BillPaymentCheck`, or `SalesTaxPaymentCheck` message, `Address` is the address that will print on the check. */
|
|
11280
|
+
Address?: Address;
|
|
11281
|
+
/** The address expressed as an address block of `Addr1` through `Addr5`, depending on the number of lines in the original request that created the address. */
|
|
11282
|
+
AddressBlock?: AddressBlock;
|
|
11283
|
+
/** If `IsToBePrinted` is set to true, this transaction is on a list of forms to be printed later. The user can then choose to print all these forms at once.
|
|
11284
|
+
|
|
11285
|
+
Notice that setting this field to true does not actually perform the printing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from printing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be printed. */
|
|
11286
|
+
IsToBePrinted?: boolean;
|
|
11287
|
+
/** Allows for the attachment of a user defined GUID value. */
|
|
11288
|
+
ExternalGUID?: string;
|
|
11289
|
+
/** A list of `ISalesTaxPaymentCheckLineRet` objects, each representing one line in the sales-tax payment check. */
|
|
11290
|
+
SalesTaxPaymentCheckLineRet?: SalesTaxPaymentCheckLineRet | SalesTaxPaymentCheckLineRet[];
|
|
11291
|
+
/** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
|
|
11292
|
+
DataExtRet?: DataExtRet | DataExtRet[];
|
|
11293
|
+
}
|
|
10618
11294
|
export interface SalesTaxReturnLineRef {
|
|
10619
11295
|
/** 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. */
|
|
10620
11296
|
ListID?: string;
|
|
@@ -10792,6 +11468,8 @@ export interface SiteFilter {
|
|
|
10792
11468
|
export type SOChannel = "Blank" | "Ecommerce";
|
|
10793
11469
|
export type SpecialAccountType = "AccountsPayable" | "AccountsReceivable" | "CondenseItemAdjustmentExpenses" | "CostOfGoodsSold" | "DirectDepositLiabilities" | "Estimates" | "ExchangeGainLoss" | "InventoryAssets" | "ItemReceiptAccount" | "OpeningBalanceEquity" | "PayrollExpenses" | "PayrollLiabilities" | "PettyCash" | "PurchaseOrders" | "ReconciliationDifferences" | "RetainedEarnings" | "SalesOrders" | "SalesTaxPayable" | "UncategorizedExpenses" | "UncategorizedIncome" | "UndepositedFunds";
|
|
10794
11470
|
export type SpecialItemType = "FinanceCharge" | "ReimbursableExpenseGroup" | "ReimbursableExpenseSubtotal";
|
|
11471
|
+
/** @default: Hot */
|
|
11472
|
+
export type Status = "Cold" | "Hot" | "Warm";
|
|
10795
11473
|
export interface SubscribedServices {
|
|
10796
11474
|
/** The list of the Intuit services that the company is or has been subscribed to, for example, Intuit Payroll, QBMS. */
|
|
10797
11475
|
Service?: Service | Service[];
|
|
@@ -10855,6 +11533,10 @@ export interface TextRow {
|
|
|
10855
11533
|
/** The data in this cell of the report. */
|
|
10856
11534
|
Value: string;
|
|
10857
11535
|
}
|
|
11536
|
+
/** @default: Comma */
|
|
11537
|
+
export type ThousandSeparator = "Apostrophe" | "Comma" | "Period" | "Space";
|
|
11538
|
+
/** @default: XX_XXX_XXX */
|
|
11539
|
+
export type ThousandSeparatorGrouping = "X_XX_XX_XXX" | "XX_XXX_XXX";
|
|
10858
11540
|
export interface TimeReportQueryRq {
|
|
10859
11541
|
/** Allows you to report on time that has been recorded in a particular category. */
|
|
10860
11542
|
TimeReportType: TimeReportType;
|
|
@@ -11351,6 +12033,177 @@ export interface ValueAdjustment {
|
|
|
11351
12033
|
/** Either a positive or negative number that shows a change in the total value of the entire stock of this inventory item. */
|
|
11352
12034
|
ValueDifference?: string;
|
|
11353
12035
|
}
|
|
12036
|
+
export interface VehicleAdd {
|
|
12037
|
+
/** 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. */
|
|
12038
|
+
Name: string;
|
|
12039
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
12040
|
+
IsActive?: boolean;
|
|
12041
|
+
/** A descriptive text field. */
|
|
12042
|
+
Desc?: string;
|
|
12043
|
+
}
|
|
12044
|
+
export interface VehicleAddRq {
|
|
12045
|
+
VehicleAdd: VehicleAdd;
|
|
12046
|
+
/** 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. */
|
|
12047
|
+
IncludeRetElement?: string[] | string;
|
|
12048
|
+
}
|
|
12049
|
+
export interface VehicleAddRs {
|
|
12050
|
+
VehicleRet?: VehicleRet;
|
|
12051
|
+
ErrorRecovery?: ErrorRecovery;
|
|
12052
|
+
}
|
|
12053
|
+
export interface VehicleMileageAdd {
|
|
12054
|
+
/** A vehicle for use in `VehicleMileage` transactions. Each vehicle name must be unique. */
|
|
12055
|
+
VehicleRef: VehicleRef;
|
|
12056
|
+
/** 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. */
|
|
12057
|
+
CustomerRef?: CustomerRef;
|
|
12058
|
+
/** 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. */
|
|
12059
|
+
ItemRef?: ItemRef;
|
|
12060
|
+
/** 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. */
|
|
12061
|
+
ClassRef?: ClassRef;
|
|
12062
|
+
/** Date the trip began. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 will not work. */
|
|
12063
|
+
TripStartDate?: string;
|
|
12064
|
+
/** Date the trip ended. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 will not work. */
|
|
12065
|
+
TripEndDate?: string;
|
|
12066
|
+
/** Odometer reading at the start of the trip. `OdometerStart` and `OdometerEnd` must both be specified if `TotalMiles` is not specified. QuickBooks will calculate the total trip miles from these two values. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. */
|
|
12067
|
+
OdometerStart: number;
|
|
12068
|
+
/** Odometer reading at the end of the trip. `OdometerStart` and `OdometerEnd` must both be specified if `TotalMiles` is not specified. QuickBooks will calculate the total trip miles from these two values. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. */
|
|
12069
|
+
OdometerEnd: number;
|
|
12070
|
+
/** Total trip miles. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. If you use `OdometerStart` and `OdometerEnd` instead of `TotalMiles`, QuickBooks will calculate the total trip miles from these two values. */
|
|
12071
|
+
TotalMiles?: number;
|
|
12072
|
+
/** Additional information. */
|
|
12073
|
+
Notes?: string;
|
|
12074
|
+
/** The billing status of this item line or expense line. */
|
|
12075
|
+
BillableStatus?: BillableStatus;
|
|
12076
|
+
}
|
|
12077
|
+
export interface VehicleMileageAddRq {
|
|
12078
|
+
VehicleMileageAdd: VehicleMileageAdd;
|
|
12079
|
+
/** 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. */
|
|
12080
|
+
IncludeRetElement?: string[] | string;
|
|
12081
|
+
}
|
|
12082
|
+
export interface VehicleMileageAddRs {
|
|
12083
|
+
VehicleMileageRet?: VehicleMileageRet;
|
|
12084
|
+
ErrorRecovery?: ErrorRecovery;
|
|
12085
|
+
}
|
|
12086
|
+
export interface VehicleMileageQueryRq {
|
|
12087
|
+
/** 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. */
|
|
12088
|
+
TxnID?: string[] | string;
|
|
12089
|
+
/** 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. */
|
|
12090
|
+
MaxReturned?: number;
|
|
12091
|
+
/** 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.) */
|
|
12092
|
+
ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
|
|
12093
|
+
/** Filters according to the original transaction dates. */
|
|
12094
|
+
TxnDateRangeFilter?: TxnDateRangeFilter;
|
|
12095
|
+
/** 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. */
|
|
12096
|
+
IncludeRetElement?: string[] | string;
|
|
12097
|
+
}
|
|
12098
|
+
export interface VehicleMileageQueryRs {
|
|
12099
|
+
VehicleMileageRet: VehicleMileageRet[];
|
|
12100
|
+
}
|
|
12101
|
+
export interface VehicleMileageRet {
|
|
12102
|
+
/** 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. */
|
|
12103
|
+
TxnID?: string;
|
|
12104
|
+
/** Time the object was created. */
|
|
12105
|
+
TimeCreated?: string;
|
|
12106
|
+
/** Time the object was last modified. */
|
|
12107
|
+
TimeModified?: string;
|
|
12108
|
+
/** 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. */
|
|
12109
|
+
EditSequence?: string;
|
|
12110
|
+
/** A vehicle for use in `VehicleMileage` transactions. Each vehicle name must be unique. */
|
|
12111
|
+
VehicleRef?: VehicleRef;
|
|
12112
|
+
/** 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. */
|
|
12113
|
+
CustomerRef?: CustomerRef;
|
|
12114
|
+
/** 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. */
|
|
12115
|
+
ItemRef?: ItemRef;
|
|
12116
|
+
/** 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. */
|
|
12117
|
+
ClassRef?: ClassRef;
|
|
12118
|
+
/** Date the trip began. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 will not work. */
|
|
12119
|
+
TripStartDate?: string;
|
|
12120
|
+
/** Date the trip ended. If left blank, the current date at the time of transaction will be used. Notice that only dates are supported for vehicle mileage, so make sure you enter any datetime values with dates only, no time values. That is, 2002-02-02 will work for trip end date or start date, but 2002-02-02T12:20:20 will not work. */
|
|
12121
|
+
TripEndDate?: string;
|
|
12122
|
+
/** Odometer reading at the start of the trip. `OdometerStart` and `OdometerEnd` must both be specified if `TotalMiles` is not specified. QuickBooks will calculate the total trip miles from these two values. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. */
|
|
12123
|
+
OdometerStart?: number;
|
|
12124
|
+
/** Odometer reading at the end of the trip. `OdometerStart` and `OdometerEnd` must both be specified if `TotalMiles` is not specified. QuickBooks will calculate the total trip miles from these two values. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. */
|
|
12125
|
+
OdometerEnd?: number;
|
|
12126
|
+
/** Total trip miles. If `TotalMiles` is specified, you cannot specify `OdometerStart` and `OdometerEnd`. If you use `OdometerStart` and `OdometerEnd` instead of `TotalMiles`, QuickBooks will calculate the total trip miles from these two values. */
|
|
12127
|
+
TotalMiles?: number;
|
|
12128
|
+
/** Additional information. */
|
|
12129
|
+
Notes?: string;
|
|
12130
|
+
/** The billing status of this item line or expense line. */
|
|
12131
|
+
BillableStatus?: BillableStatus;
|
|
12132
|
+
/** The mileage rate currently allowed by the tax authority (IRS) for vehicle expenses. */
|
|
12133
|
+
StandardMileageRate?: string;
|
|
12134
|
+
/** Amount calculated by multiplying the total trip miles in the current vehicle mileage transaction by the standard mileage rate currently in use. */
|
|
12135
|
+
StandardMileageTotalAmount?: string;
|
|
12136
|
+
/** In a billable vehicle mileage transaction, refers to the rate being used to charge mileage against a customer. The rate is specified in the service item or other charge item that is referenced in the `ItemRef` field of the `VehicleMileageAdd` request. */
|
|
12137
|
+
BillableRate?: string;
|
|
12138
|
+
/** In a billable vehicle mileage transaction, refers to the total charge that QuickBooks calculates by multiplying the trip total mileage by the rate specified in the item referenced by the `ItemRef`. */
|
|
12139
|
+
BillableAmount?: string;
|
|
12140
|
+
}
|
|
12141
|
+
export interface VehicleMod {
|
|
12142
|
+
/** 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. */
|
|
12143
|
+
ListID: string;
|
|
12144
|
+
/** 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. */
|
|
12145
|
+
EditSequence: string;
|
|
12146
|
+
/** 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. */
|
|
12147
|
+
Name?: string;
|
|
12148
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
12149
|
+
IsActive?: boolean;
|
|
12150
|
+
/** A descriptive text field. */
|
|
12151
|
+
Desc?: string;
|
|
12152
|
+
}
|
|
12153
|
+
export interface VehicleModRq {
|
|
12154
|
+
VehicleMod: VehicleMod;
|
|
12155
|
+
/** 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. */
|
|
12156
|
+
IncludeRetElement?: string[] | string;
|
|
12157
|
+
}
|
|
12158
|
+
export interface VehicleModRs {
|
|
12159
|
+
VehicleRet?: VehicleRet;
|
|
12160
|
+
ErrorRecovery?: ErrorRecovery;
|
|
12161
|
+
}
|
|
12162
|
+
export interface VehicleQueryRq {
|
|
12163
|
+
/** 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. */
|
|
12164
|
+
ListID?: string[] | string;
|
|
12165
|
+
/** 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. */
|
|
12166
|
+
FullName?: string[] | string;
|
|
12167
|
+
/** 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. */
|
|
12168
|
+
MaxReturned?: number;
|
|
12169
|
+
/** 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. */
|
|
12170
|
+
ActiveStatus?: ActiveStatus;
|
|
12171
|
+
/** 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). */
|
|
12172
|
+
FromModifiedDate?: string;
|
|
12173
|
+
/** 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). */
|
|
12174
|
+
ToModifiedDate?: string;
|
|
12175
|
+
/** Filters according to the object’s `Name`. */
|
|
12176
|
+
NameFilter?: NameFilter;
|
|
12177
|
+
/** Filters according to the object’s `Name`. */
|
|
12178
|
+
NameRangeFilter?: NameRangeFilter;
|
|
12179
|
+
/** 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. */
|
|
12180
|
+
IncludeRetElement?: string[] | string;
|
|
12181
|
+
}
|
|
12182
|
+
export interface VehicleQueryRs {
|
|
12183
|
+
VehicleRet: VehicleRet[];
|
|
12184
|
+
}
|
|
12185
|
+
export interface VehicleRef {
|
|
12186
|
+
/** 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. */
|
|
12187
|
+
ListID?: string;
|
|
12188
|
+
/** `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. */
|
|
12189
|
+
FullName?: string;
|
|
12190
|
+
}
|
|
12191
|
+
export interface VehicleRet {
|
|
12192
|
+
/** 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. */
|
|
12193
|
+
ListID?: string;
|
|
12194
|
+
/** Time the object was created. */
|
|
12195
|
+
TimeCreated?: string;
|
|
12196
|
+
/** Time the object was last modified. */
|
|
12197
|
+
TimeModified?: string;
|
|
12198
|
+
/** 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. */
|
|
12199
|
+
EditSequence?: string;
|
|
12200
|
+
/** 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. */
|
|
12201
|
+
Name?: string;
|
|
12202
|
+
/** If `IsActive` is true, this object is currently enabled for use by QuickBooks. The default value is true. */
|
|
12203
|
+
IsActive?: boolean;
|
|
12204
|
+
/** A descriptive text field. */
|
|
12205
|
+
Desc?: string;
|
|
12206
|
+
}
|
|
11354
12207
|
export interface VendorAdd {
|
|
11355
12208
|
/** 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. */
|
|
11356
12209
|
Name: string;
|