Intuit.Ipp.Data
enumeration of how the Fixed Asset has been
acquired
Month enumeration
Week enumeration
enumeration of UOM support types
Product: ALL
Description: Enumeration of basic
Account types used generally in the accounting activities.
Product: ALL
Description: Enumeration of types of
Items in QuickBooks.
Product: ALL
Description: Enumeration of customer
types in QuickBooks.
Product: ALL
Description: Enumeration of Billable
Status used when searching for reimbursable expenses.
Product: QBO
Description: Tax Form Type holds data related to Tax Information (Tax Form Type)
based on Regional compliance laws. Applicable for IN region
currently. Can be used to extend for other Regions.
Product: ALL
Description: Enumeration of Entity
types.
Product: ALL
Description: Enumeration of tax
applicable on Journal Entry (Sales/Purchase)
Product: ALL
Description: Enumeration of QuickBooks
posting types.
Product: ALL
Description: Enumeration line detail
types.
Product: ALL
Description: Enumeration of Account
sub-types(QBW) and Account types(QBO) used to specifically
categorize accounts. Note: QBO doesn't support the "Non-Posting"
Account type.
Product: QBO Description: Enumeration of
TaxRateDisplayType
Product: QBO
Description: Enumeration of Account
sub-types used to specifically categorize account types in
QuickBooks Online.
Product: ALL
Description: Enumeration of Credit Card
operation type: Charge or Credit.
Product: ALL
Description: Enumeration of the days of
the week.
Product: ALL
Description: Enumeration of status for
an estimate.
Product: ALL
Description: Enumeration of payment
methods when receiving a customer payment of paying for goods.
Product: ALL
Description: Enumeration of payable
status for an invoice, as follows: A pending invoice is not yet
approved/final/sent; not yet payable by customer. A payable invoice
is now payable. Partial payments may have been received, but money
still remains to be paid. No claim is made about due vs. overdue,
past due etc... A paid invoice has been paid in full. No amount
remains to be paid.
Product: ALL
Description: Enumeration of sales tax
payment basis.
Product: ALL
Description: Enumeration of per item
adjustments.
Product: ALL
Description: Enumeration of price level
types.
Product: QBO
Description: Enumeration of status for
an estimate in QuickBooks Online.
Product: ALL
Description: Enumeration of status for
purchase order
Product: ALL
Description: Enumeration of
reimbursable status for purchased items/services.
Product: ALL
Description: Enumeration of rounding
methods.
Product: ALL
Description: Enumeration of sales rep
types.
Product: ALL
Description: Enumeration of sales term
types.
Product: ALL
Description: Enumeration of special
item types.
Product: ALL
Description: Enumeration of symbol
positions.
Product: ALL
Description: TaxTypeApplicability
enumeration
Product: ALL
Description: Enumeration of template
types.
Product: ALL
Description: Enumeration of time
activity types.
Product: ALL
Description: Enumeration of transaction
types.
Product: ALL
Description: Enumeration of measurement
types.
Product: ALL
Description: Enumeration of payment
types.
Product: ALL
Description: Enumeration of bill
payment types.
Product: ALL
Description: Enumeration of print
status values.
Product: ALL
Description: Enumeration of email
status values.
Product: ALL
Description: Enumeration of
eTransaction status values. The statuses (Sent, Viewed, Paid,
Delivery Error, Updated, Sent With ICN Error) are used by QBO
eInvoicing. The rest statuses are to be used for Tradeshift
Integration
Product: QBO
Description: Enumeration of
eTransaction prefs status.
Product: ALL
Description: Enumeration of tax model
types.
Product: QBO
Description: Enumeration of transaction
source.
Product: ALL
Description: Enumeration of Budget Types
Product: ALL
Description: Enumeration of BudgetEntry Type
Product: QBO
Description: Enumeration of Item Category Type for France
Product: QBO
Description: Enumeration of Purchase or Sale Location for France
Product: QBO
Description: Enumeration of the different types of Journal Codes applicable in
FR
Product: QBO
Description: Enumeration of the different types of Discounts
Enumeration of item service type for India sales
tax
Enumeration of Qbo Entity Type For AppId Migration
Enumeration of Desktop Entity Type For
ThirdPartyAppId Migration
That minimal subset of transaction information
which is included on another transaction, so that a client viewing
the second transaction entity need not make an additional request to
the service in order to render it in human readable form. (e.g a
payment needs to refer to an invoice by number)
Product: QBW
Description: Transaction the current
entity is related to (linked to), for example, Sales Order.[br
/]UNSUPPORTED FIELD.
Product: QBO
Description: A list of Estimate
Ids that are to be associated with the invoice.[br /]Note: Only
Pending and Accepted Estimates can be specified. Closed and
Rejected estimates will be ignored.
Product: ALL
Description: Transaction number.
Product: ALL
Description: A link to a specific
line of the LinkedTxn. If supplied the LinkedTxn field must also
be populated.
Product: QBO Description: Holder for a collection of Cascade objects. Used by messaging. Not intended for external clients.
Cascading events for an entity
Product: QBO Description: Object representing cascading events on entities resulting from a transaction event. Used by messaging. Not intended for external clients.
Any IntuitEntity derived object name like Customer, Item, Invoice, ...
Description: Unique identifier for an Intuit entity.
Cascading events resulting from a transaction event in the form of key value pairs. Key names are user defined.
Product: ALL
Description: A name/value pair that allows the client to include data that is meaningful in the domain of origin, outside of the Intuit domain.
Product: ALL
Description: Name of the element.
Product: ALL
Description: Value of the element.
Group Summary
One ColData can contain one column
Describes the column attributes
Reference url
Describes the Name
Describes the Value
List of rows
One Row can contain any number of columns
Row type section, summary, data row etc..
Report Group Income, Expense, COGS etc..
Group Header
List of all row types
Describes list of OLBAccounts that needs to be
enabled or disabled
Product: ALL
Description: Account details
Describes OLBAccount details
Product: ALL
Description: AccountId to be enabled or disabled
Account details that contains possibly credit
card number, last 5 digits
True when the AccountId is linked to an IPP app
and false when the AccountId is delinked from the IPP app
Specifies which version is being used (such as v1
or v2). This field is optional.
The last bank balance. This field is optional.
Product: ALL
Description: Reference type of all IDs that are taken as input or output.
Detailed data about a warning condition that occurred when a request was processed
Localized standard message associated with the warning
Detailed message regarding the warning condition with specifics
Warning code, this is a required field
The element (if any) directly involved in the warning (i.e. an ignored element)
Describes a column
Describes the column title name
Describes the column type enumeration
Column Metadata
Subcolumns of the column
Provides the mapping between ListId and TxnId in
Desktop to the same Entity Id in QBO. These mappings are available
for only companies that have migrated from Desktop to QBO
Product: QBO
Description: The Id of the QBO Entity. This id is accepted by V3 APIs. They
uniquely identify the entity in QBO for that company.
Product: QBO
Description: The ListId or TxnId of the QB Desktop Entity. They uniquely
identify the entity in QB Desktop for that company.
Product: QBO
Description: The entity type name of the entity in QBO. Refer
QboEntityTypeEnum for all the values.
Product: QBO
Description: The entity type name of the entity in QBO. Refer
QbdtEntityTypeEnum for all the values.
Product: ALL
Description: Base type of any top level Intuit Entity of small business type.
TODO: Update summary.
Product: ALL
Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation.
Required: ALL
Filterable: ALL
Product: ALL
Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation.
Required: ALL
Product: ALL
Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
Product: QBW
Description: Custom field (or data extension).
Filterable: QBW
Specifies entity name of the attachment from where the attachment was requested
Product: ALL
Description: Domain in which the entity belongs.
Product: ALL
Description: System status of the entity. Output only field.[br /]
Filterable: ALL
Product: ALL
Description: True if the entity representation has a partial set of elements. Output only field.
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
Product: ALL
Description: Metadata for the instance of the entity. All properties are read only.
Product: QBW
Description: Reference to the user who created the data. Read only property.
Product: ALL
Description: Time the entity was created in the source domain (QBD or QBO). Read only property.
Filterable: ALL
Sortable: ALL
Product: QBW
Description: Reference to the user who last modified the entity. Read only property.
Product: ALL
Description: Time the entity was last updated in the source domain (QBD or QBO). Read only property.
Filterable: ALL
Sortable: ALL
Product: QBW
Description: Time the entity was last updated in QB. Read only property.
Product: QBW
Description: If true, the data on the cloud has been synchronized with QuickBooks for Windows. If false, the data has been created or updated on the cloud but has not been synchronized with QuickBooks for Windows. Read-only field.
Filterable: QBW
Product: ALL
Description: Custom field that can be added to an entity. This type is not extended from IntuitEntity as CustomField can not be manipulated as independent entity and will always be considered in association with another top level Intuit entity.
Product: ALL
Description: Unique identifier of the CustomFieldDefinition that corresponds to this CustomField. DefinitionId is required for every CustomField.
Product: ALL
Description: Name of the custom field.
Product: ALL
Description: Data type of custom field.[br /]
Product: ALL
Description: Possible supported CustomFieldTypes.
Product: ALL
Description: Describes the details of the attachable and provides information such as where they are referenced and custom fields.
Product: ALL
Description: Reference to the entity.
Product: ALL
Description:
Product: ALL
Description:
Product: ALL
Description: Custom field (or data extension).
Filterable: ALL
Specifies extension entity to allow extension
Product: ALL
Description: Definition of IntuitAnyType to add and extend new elements to the existing entities.
Product: ALL
Description: Possible Status of an Entity.
Describes Company information
Product: ALL
Description: Name of the company.[br /]Max. length: 1024 characters.
LegalName if different from the CompanyName
Company Address as described in preference
Address of the company as given to th customer,
sometimes the address given to the customer mail address is
different from Company address
Legal Address given to the government for any
government communication
CompanyEmail Address
Email Address published to customer for
communication if different from CompanyEmailAddress
Company URL
Primary Phone number
Product: QBW
Description: List of ContactInfo
entities of any contact info type. The ContactInfo Type values
are defined in the ContactTypeEnum.
Product: QBW
Description: QuickBooks company
file name.[br /]Data Services max. length: 512 characters.
Product: QBW
Description: QB software flavor
being used on the file on the PC.[br /]Data Services max.
length: 512 characters.
Product: QBW
Description: if the QB desktop file is a sample file.
Product: QBW
Description: IAM or QBN admin users
id sequence number to group many external realms for this user
under his id number.[br /]Data Services max. length: 512
characters.
Product: QBW
Description: IAM or QBN admin users
email.[br /]Data Services max. length: 100 characters.
Product: ALL
Description: DateTime when the company file was created.
Product: ALL
Description: Employer identifier (EID).
Product: ALL
Description: Starting month of the company's fiscal year.
Product: ALL
Description: Starting month of the company's fiscal year.
Product: ALL
Description: QuickBooks company file latest version. The format reports the
major release in the first number, the minor release in the
second number (always a zero), the release update (slipstream or
"R") in the third number, and the build number in the final
number.[br /]Max. length: 512 characters.
Product: ALL
Description: Country name to which the company belongs for fiancial
calculations.
Product: ALL
Description: Default shipping address.
Product: ALL
Description: Other company addresses.
Product: ALL
Description: Default mobile phone number of the company.
Product: ALL
Description: Default fax number.
Product: ALL
Description: Default email address.
Product: ALL
Description: Default company web site address.
Product: ALL
Description: Specifies last imported time.
Comma separated list of languages
Default time zone for the company
Specifies if the company support multibyte or
not
Any other preference not covered in base is
covered as name value pair, for detailed explanation look at the
document
Product: ALL
Description: Internal use only: extension place holder for Company.
Product: ALL
Description: Physical (or postal) address type, this entity is always manipulated in context of another parent entity like Person, Organization etc.
Product: ALL
Description: Unique identifier of the Intuit entity for the address, mainly used for modifying the address.[br /]Note: There is no SyncToken for this entity because it is always associated with the IntuitEntity type that is the top level or parent entity.
Product: QBW
Description: First line of the address.[br /]Max. length: 41 characters.
Product: QBO
Description: First line of the address.[br /]Max. length: 500 characters.
Product: QBW
Description: Second line of the address.[br /]Max. length: 41 characters.
Product: QBO
Description: Second line of the address.[br /]Max. length: 500 characters.
Product: QBW
Description: Third line of the address.[br /]Max. length: 41 characters.
Product: QBO
Description: Third line of the address.[br /]Max. length: 500 characters.
Product: QBW
Description: Fourth line of the address.[br /]Max. length: 41 characters.
Product: QBO
Description: Fourth line of the address.[br /]Max. length: 500 characters.
Product: QBW
Description: Fifth line of the address.[br /]Max. length: 41 characters.
Product: QBO
Description: Fifth line of the address.[br /]Max. length: 500 characters.
Product: QBW
Description: City name.[br /]Max. length: 31 characters.
Product: QBO
Description: City name.[br /]Max. length: 255 characters.
Product: QBW
Description: Country name.[br /]Max. length: 31 characters.
Product: QBO
Description: Country name.[br /]Max. length: 255 characters.
Product: ALL
Description: Country code per ISO 3166.[br /]Unsupported field.
Product: QBW
Description: Region within a country. For example, state name for USA, province name for Canada.[br /]Max. length: 21 characters.
Product: QBO
Description: Globalized representation of a region. For example, state name for USA, province name for Canada.[br /]Max. length: 255 characters.
Product: QBW
Description: Postal code. For example, zip code for USA and Canada.[br /]Max. length: 13 characters.
Product: QBO
Description: Postal code. For example, zip code for USA and Canada.[br /]Max. length: 30 characters.
Product: ALL
Description: Postal Code extension. For example, in the USA this is a 4 digit extension of the zip code.
Product: ALL
Description: Latitude coordinate of Geocode (Geospatial Entity Object Code).[br /]Unsupported field.
Product: ALL
Description: Longitude coordinate of Geocode (Geospatial Entity Object Code).[br /]Unsupported field.
Product: ALL
Description: Descriptive tag (or label) associated with the physical address. Valid values are Shipping and Billing, as defined in the PhysicalAddressLabelType.
Product: ALL
Description: Note for .
Product: ALL
Description: EmailAddress type definition. This entity is always manipulated in context of another parent entity like Person, Organization etc.
Product: QBW
Description: Unique identifier for an Intuit entity.
Product: QBW
Description: Email address.[br /]Max. length: 1023 characters.
Product: QBO
Description: Email address.[br /]Max. length: 100 characters.
Product: ALL
Description: True if this is the default email address.
Product: ALL
Description: Descriptive tag (or label) associated with the email address. Valid values are Business and Home, as defined in the EmailAddressLabelType.
Product: ALL
Description: Website address type. This entity is always manipulated in context of another parent entity like Person, Organization etc.[br /]Unsupported type.
Product: ALL
Description: Unique identifier for an Intuit entity.
Product: ALL
Description: Uniform Resource Identifier for the web site.[br /]Max. length: 1000 characters.
Product: ALL
Description: True if this is the default web site.
Product: ALL
Description: Descriptive tag associated with the web site.
Product: ALL
Description: Telephone number type definition. This entity is always manipulated in the context of another parent entity like Person, Organization etc.
Product: QBW
Description: Unique identifier for an Intuit entity.
Product: ALL
Description: Phone device type. Valid values are LandLine, Mobile, Fax, and Pager, as defined in the TelephoneDevice.
Product: ALL
Description: Telephone country code.
Product: ALL
Description: Telephone area code.
Product: ALL
Description: Telephone exchange code.
Product: ALL
Description: Telephone extension code.
Product: ALL
Description: Specifies the telephone number in free form. FreeFormNumber takes precedence over CountryCode, AreaCode, ExchangeCode, and Extension.[br /]Max length: 21 characters.
Product: ALL
Description: True if this is the default telephone number.
Product: ALL
Description: Descriptive tag (or label) associated with the telephone number. Valid values are Business, Fax, Home, Mobile, Pager, Primary, Secondary, and Other, as defined in the TelephoneNumberLabelType.
Product: ALL
Description: Contact information identified by Type.
Product: ALL
Description: The type of contact information.[br /]
Product: ALL
Description: Types of ContactInfo entities.
Product: ALL
Description: Contact type other than email, phone, address. Examples: "Chat", "SkypeId", "FaceBook" etc.
Product: ALL
Description: Unique identifier for an Intuit entity.
Product: ALL
Description: Name of the generic contact type. For example, "GoogleChat" related contact info can have the Name, "ChatId".
Product: ALL
Description: Value of the contact type. For example, for a "GoogleChat" contact info, the Value may be the chat ID.
Product: ALL
Description: Type of contact. For example, "GoogleChat" or "Skype".
Product: ALL
Description: True if this is the default contact information.
Product: ALL
Description: Descriptive tag associated with the contact information.
Describes Company information
Product: ALL
Description: Name of the company.[br /]Max. length: 1024 characters.
LegalName if different from the CompanyName
Company Address as described in preference
Address of the company as given to th customer,
sometimes the address given to the customer mail address is
different from Company address
Legal Address given to the government for any
government communication
CompanyEmail Address
Email Address published to customer for
communication if different from CompanyEmailAddress
Company URL
Primary Phone number
Product: QBW
Description: List of ContactInfo
entities of any contact info type. The ContactInfo Type values
are defined in the ContactTypeEnum.
Product: QBW
Description: QuickBooks company
file name.[br /]Data Services max. length: 512 characters.
Product: QBW
Description: QB software flavor
being used on the file on the PC.[br /]Data Services max.
length: 512 characters.
Product: QBW
Description: if the QB desktop file is a sample file.
Product: QBW
Description: IAM or QBN admin users
id sequence number to group many external realms for this user
under his id number.[br /]Data Services max. length: 512
characters.
Product: QBW
Description: IAM or QBN admin users
email.[br /]Data Services max. length: 100 characters.
Product: ALL
Description: DateTime when the company file was created.
Product: ALL
Description: Employer identifier (EID).
Product: ALL
Description: Starting month of the company's fiscal year.
Product: ALL
Description: Starting month of the company's fiscal year.
Product: ALL
Description: QuickBooks company file latest version. The format reports the
major release in the first number, the minor release in the
second number (always a zero), the release update (slipstream or
"R") in the third number, and the build number in the final
number.[br /]Max. length: 512 characters.
Product: ALL
Description: Country name to which the company belongs for fiancial
calculations.
Product: ALL
Description: Default shipping address.
Product: ALL
Description: Other company addresses.
Product: ALL
Description: Default mobile phone number of the company.
Product: ALL
Description: Default fax number.
Product: ALL
Description: Default email address.
Product: ALL
Description: Default company web site address.
Product: ALL
Description: Specifies last imported time.
Product: QBW
Description: Specifies last sync time.
Comma separated list of languages
Default time zone for the company
Specifies if the company support multibyte or
not
Any other preference not covered in base is
covered as name value pair, for detailed explanation look at the
document
Product: ALL
Description: Internal use only: extension place holder for Company.
Product: ALL
Description: Transaction is the base
class of all transactions.
Product: ALL
Description: QBO: Reference number
for the transaction. If DocNumber is not provided, and the
Custom Transaction Number is set to "Off", QBO assigns a
document number using the next-in-sequence algorithm for Sales
transactions. Otherwise the value will remaing null.
Alternatively, you can also pass in "AUTO_GENERATE" in this
field to force QBO to auto-sequence the document number for
Invoices, Estimates and Sales Receipt.[br /]The maximum length
for DocNumber is 21 characters. The default value is an empty
String. Filter support not provided for Payment.
Description:
QBW: The primary document number for this transaction. DocNumber
is exposed to end users.[br /]If it is not provided, QuickBooks
business logic will assign the document number using the "next
in sequence" algorithm.[br /]Max. length is 11 characters for
Payment, Bill, ItemReceipt and VendorCredit. Max. length is 20
characters for other entities.
Filterable: QBO
InputType: ReadWrite
ValidRange: QBW: max=11
ValidRange: QBO: max=21
Product: ALL
Description: QBO: The date entered
by the user when this transaction occurred. [br /]Often, it is
the date when the transaction is created in the system. [br
/]For "posting" transactions, this is the posting date that
affects the financial statements. If the date is not supplied,
the current date on the server is used.
Description: QBW: The
nominal, user entered, date of the transaction. [br /]Often, but
not required to be, the date the transaction was created in the
system. [br /]For "posting" transactions, this is the posting
date that affects financial statements.
Filterable: ALL
Sortable:
ALL
InputType: ReadWrite
Product: QBO
Description: Location of the
transaction, as defined using location tracking in QuickBooks
Online.
Product: ALL
Description: Reference to the
Currency in which all amounts on the associated transaction are
expressed.[br /]
InputType: ReadWrite
Product: ALL
Description: Currency exchange
rate. Valid only if the company file is set up to use
Multi-Currency feature. In QuickBooks, exchange rates are always
recorded as the number of home currency units it takes to equal
one foreign currency unit. The foreign unit is always 1 and the
amount of home units that equal that 1 foreign unit is what
QuickBooks uses as the exchange rate.
InputType: ReadWrite
Product: ALL
Description: User entered,
organization-private note about the transaction. This note will
not appear on the transaction records by default.
InputType: ReadWrite
Product: ALL
Description: QBW: The status of the
transaction. Depending on the transaction type it may have
different values.[br /]For Sales Transactions acceptable values
are defined in PaymentStatusEnum. For Estimate, the values
accepted are defined in EstimateStatusEnum.
Description: QBO: The
status of the transaction. Depending on the transaction type it
may have different values.[br /]For Sales Transactions
acceptable values are defined in PaymentStatusEnum. For
Estimate, the values accepted are defined in
QboEstimateStatusEnum.
Filterable:QBW
Product: ALL
Description: A linked (related)
transaction. More than one transaction can be linked.
Product: QBW
Description: A line item of a
transaction.
Product: QBO
Description: A line item of a
transaction. QuickBooks Online does not support tax lines in the
main transaction body, only in the TxnTaxDetail section.
Product: ALL
Description: Details of taxes
charged on the transaction as a whole. For US versions of
QuickBooks, tax rates used in the detail section must not be
used in any tax line appearing in the main transaction body. For
international versions of QuickBooks, the TxnTaxDetail should
provide the details of all taxes (sales or purchase) calculated
for the transaction based on the tax codes referenced by the
transaction. This can be calculated by QuickBooks business logic
or you may supply it when adding a transaction. For US versions
of QuickBooks you need only supply the tax code for the customer
and the tax code (in the case of multiple rates) or tax rate
(for a single rate) to apply for the transaction as a
whole.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: QBO
Description: Originating source of
the Transaction. Valid values are defined in TxnSourceEnum:
QBMobile.
Description: refer TaxFormTypeEnum. Tax Form Type holds data related to Tax
Information, values based on
regional compliance laws. Applicable for IN Region and can be extended
for other Regions.
Description: Tax Form Num holds data related to Tax Information based on
Regional compliance laws.This is applicable for IN region and
can be extended to other regions in future.
Product: QBO
Description: Location of the purchase or sale transaction. The applicable
values are those exposed through the
TransactionLocationTypeEnum. This is currently applicable only
for the FR region.
Product: ALL
Description: A line item of a
transaction.
Product: QBW
Description: ID of the Line Item.
Product: QBO
Description: ID of the Line Item.[br /]QBO considers a
request as an update operation for a line item, if you provide an
ID that is greater than zero and the ID exists in QBO.[br /]QBO
considers a request as an create operation for a line item in any
of the following conditions: No ID provided, ID provided is less
than or equal to zero, ID provided is greater than zero and does
not exist in QuickBooks.[br /]Required for updating existing
lines.[br /]Not supported for BillPayment, Estimate, Invoice, or
Payment.
Required: QBO
Product: QBW
Description: Specifies the position
of the line in the collection of transaction lines. Supported only
for QuickBooks Windows desktop.
Product: QBO
Description: Free form text
description of the line item that appears in the printed
record.[br /]Max. length: 4000 characters.[br /]Not supported for
BillPayment or Payment.
Product: QBW
Description: Free form text
description of the line item that appears in the printed record.
Max. length: 4000 characters.
Product: QBW
Description: The amount of the line,
which depends on the type of the line. It can represent the
discount amount, charge amount, tax amount, or subtotal amount
based on the line type detail.
Product: QBO
Description: The amount
of the line depending on the type of the line. It can represent
the discount amount, charge amount, tax amount, or subtotal amount
based on the line type detail.[br /]Required for BillPayment,
Check, Estimate, Invoice, JournalEntry, Payment, SalesReceipt.
Required: QBO
Product: ALL
Description: A link between this line
and a specific transaction. For example, an invoice line may link
to an estimate.
Product: ALL
Description: The type of line in the
transaction.[br /]
Required: ALL
Product: QBW
Description: Custom field (or data
extension). Supported only for QuickBooks Windows desktop.
Product: ALL
Description: Internal use only:
extension place holder for LineBase
Product: ALL
Description: Account based expense
detail for a transaction line.
Product: ALL
Description: Reference to the
Customer associated with the expense.
Product: ALL
Description: Reference to the Class
associated with the expense.
Product: ALL
Description: Reference to the Expense
account associated with the service/non-sellable-item billing.
Product: ALL
Description: The billable status of
the expense.[br /]
Product: ALL
Description: Markup information for
the expense.
Product: ALL
Description: Sales tax associated
with the expense.
Product: ALL
Description: Sales tax code
associated with the sales tax for the expense.
Product: QBO
Description: Indicates the total
amount of line item including tax.
Product: ALL
Description: Internal use only:
extension place holder for ExpenseDetail
Product: ALL
Description: Markup information.
Product: ALL
Description: True if the markup is
expressed as a percentage.
Product: ALL
Description: Markup value.
Product: ALL
Description: Markup amount expressed
as a percent of charges already entered in the current
transaction. To enter a rate of 10% use 10.0, not 0.01.
Product: ALL
Description: Reference to a
PriceLevel for the markup.
Product: ALL
Description: Deposit detail for a
transaction line.
Product: ALL
Description: Information about the
Customer or Job associated with the deposit.
Product: ALL
Description: Reference to the Class
for the deposit.
Product: ALL
Description: Reference to an Expense
account associated with the service/non-sellable item billing.
Product: ALL
Description: Reference to the
PaymentMethod for the deposit.
Product: ALL
Description: Check number for the
desposit.
Product: ALL
Description: Type of the payment
transaction. For information purposes only.[br /]
Product: QBO
Description: Sales/Purchase tax code.
For Non US/CA Companies
Product: QBO
Description: Indicates whether the
tax applicable on the line is sales or purchase
Product: ALL
Description: Internal use only:
extension place holder for DepositDetail
Product: ALL
Description: Information about
Description.
Product: ALL
Description: Date when the service is
performed.
Product: QBO
Description: Reference to the TaxCode
for description only line.
Though it appears that TaxCode is not
applicable to DescriptionOnlyLine as there is no amount associated
with it, UK and Canada model
seems to associate the notion of
TaxCode even for just a description line
Marking this as QBO only
at this time but it looks like applicable for QB in general
Product: ALL
Description: Internal use only:
extension place holder for DescriptionLineDetail
Product: ALL
Description: Discount detail for a
transaction line.
Product: QBO
Description: Discount detail
representing the total discount on a transaction.
Product: ALL
Description: Date when the service
is performed.
Product: ALL
Description: Reference to the Class
for the discount.
Product: ALL
Description: Reference to the
TaxCode for the discount.
Product: ALL
Description: Internal use only:
extension place holder for DiscountDetail
Product: ALL
Description: Discount used in
calculating and applying the discount on the sales transaction
paid.
Product: ALL
Description: True if the discount is
a percentage; null or false if discount based on amount.
Product: ALL
Description: Percentage by which the
amount due is reduced, from 0% to 100%. To enter a discount of
8.5% use 8.5, not 0.085.
Product: ALL
Description: Income account used to
track discounts received from vendors on purchases.
Product: ALL
Description: Detail for a group item
line, including the lines expanded from the group item.
Product: ALL
Description: Reference to a group
item for all the lines that belong to the group.
Product: ALL
Description: Quantity of the group
item.
Product: ALL
Description: Unit of Measure
reference.
Product: ALL
Description: Date when the service is
performed.
Product: ALL
Description: The list of lines
expanded from the group item. Note that a group line cannot itself
contain group lines.
Product: ALL
Description: Internal use only:
extension place holder for GroupLineDetail
When a unit of measure is referenced, it must
include the name of the specific unit used as well as the unit of
measure set in which that unit is defined. This entity captures that
concept.
The name of the unit selected. Examples: inch,
foot, yard.
A reference to the UOM entity that defines the
set of related units from which the specified Unit is used.
Product: ALL
Description: Item based expense detail
for a transaction line.
Product: ALL
Description: Reference to the
Customer associated with the expense.
Product: ALL
Description: The billable status of
the expense.[br /]
Product: QBO
Description: Indicates the total
amount of line item including tax.
Product: ALL
Description: Internal use only:
extension place holder for ExpenseItemDetail
Product: ALL
Description: Information about the
goods sold: what is sold, how much/many and for what price.
Product: ALL
Description: Reference to the Item.
When a line lacks an ItemRef it will be treated as "documentation"
and the Amount will be ignored.
Product: ALL
Description: Reference to the Class
for the line item.
Product: ALL
Description: Markup information for
the Item wherever applicable.
Product: ALL
Description: Number of items for the
line.
Product: ALL
Description: Reference to the
UOMSetREf (unit of mesasure set) that applies to this item.
Product: ALL
Description: An account different
than the account associated with the Item in the current
transaction line. Cannot be updated or modified.
Product: ALL
Description: Reference to the
InventorySite where this item is located.
Product: ALL
Description: Reference to the
SalesTaxCode for this item.
Product: ALL
Description: ItemReceipt detail for a
transaction line.
Product: ALL
Description: Internal use only:
extension place holder for ItemReceiptDetail
Product: ALL
Description: JournalEntry detail for a
transaction line.
Product: ALL
Description: Indicates whether the
JournalEntry line is a Debit or Credit.[br /]
Product: ALL
Description: Reference information
for the Entity (Customer/Vendor/Employee) associated with the
JournalEntry line.
Product: ALL
Description: Reference to the Account
associated with the JournalEntry line.
Product: ALL
Description: Reference to the Class
associated with the JournalEntry line.
Product: QBO
Description: Represents Department
Reference associated with the JournalEntry line.
Product: QBO
Description: Sales/Purchase tax code
associated with the JournalEntry Line. For Non US/CA Companies
Product: QBO
Description: Indicates whether the
tax applicable on the line is sales or purchase
Product: QBO
Description: Tax applicable for this
line transaction line
Product: ALL
Description: The billable status of
the journal entry line. The line is to be billed to a customer if
the account is an expense account and the Entity Reference
specifies a Customer or a Job.[br /]
Product: QBO
Description: The Journal Code that should be associated for every journal
entry line. This is applicable only for FR.
Product: ALL
Description: Internal use only:
extension place holder for JournalEntryDetail
Product: ALL
Description: Reference information for
an entity.
Product: ALL
Description: Entity type.[br /]
Product: ALL
Description: Reference to the entity.
Product: ALL
Description: Payment detail for a
transaction line.
Product: ALL
Description: Reference to the Item.
When a line lacks an ItemRef it will be treated as "documentation"
and the Amount will be ignored.
Product: ALL
Description: Date when the service is
performed.
Product: ALL
Description: Reference to the Class
for the line item.
Product: ALL
Description: Indicates the unpaid
amount of the transaction after this payment is applied.[br
/]Cannot be written to QuickBooks.
Product: ALL
Description: Indicates the unpaid
amount of the transaction after this payment is applied in home
currency. It is visible only for companies which have
multicurrency enabled[br /] Cannot be written to Quickbooks.
Product: ALL
Description: Reference to a Discount
item and its properties that this line can overwrite.
Product: ALL
Description: Internal use only:
extension place holder for PaymentDetail
Product: ALL
Description: PurchaseOrder item detail
for a transaction line.
Product: ALL
Description: The identifier
provided by manufacturer for the Item. For example, the model
number.
Product: ALL
Description: The item on the line
is marked as if fully receiveded, but it is closed as no longer
available.
Product: ALL
Description: Represents the
difference between the quantity ordered and actually
received.[br /]Cannot be written to QuickBooks.
Product: ALL
Description: Internal use only:
extension place holder for PurchaseOrderItemDetail
Product: ALL
Description: SalesItem detail for a
transaction line.
Product: ALL
Description: Date when the service
is performed.
Product: QBO
Description: Indicates the total
amount of line item including tax.
Product: QBO
Description: Indicates the discount rate that is applied on this line.
Product: QBO
Description: Indicates the discount amount that is applied on this line.
Product: ALL
Description: Internal use only:
extension place holder for SalesItemDetail
Product: ALL
Description: SalesOrder item detail for
a transaction line.
Product: ALL
Description: The item on the line
is marked as if fully received, but it is closed as no longer
available.
Product: ALL
Description: SubTotalLine detail for a transaction line.
Product: ALL
Description: Reference to the Item.
When a line lacks an ItemRef it will be treated as "documentation"
and the Amount will be ignored.
Product: ALL
Description: Date when the service is
performed.
Product: QBO
Description: TDS line detail for the
transaction.
Product: QBO
Description: Reference to TDS account
associated with this transaction
Product: QBO
Description: TDS section type of the
transaction.
Product: QBO
Description: Extension place holder
for TDSLineDetail
Product: ALL
Description: Tax detail for a
transaction line.
Product: QBW
Description: Reference to a TaxRate.
For all editions of QuickBooks, for TaxLineDetail line types that
apply a specific TaxRate to the preceding line of the transaction,
this
is a reference to that TaxRate. For a TaxLineDetail in a
TxnTaxDetail, where the TxnTaxCodeRef is set, the TaxRate
referenced here MUST also be
one of the rates in the referenced tax code's rate list (either the
SalesTaxRateList or the PurchaseTaxRateList) that applies to the
transaction type.[br /]
For international editions of QuickBooks,
for a TaxLineDetail in a TxnTaxDetail, the rate referenced here
must be referenced by a TaxCode used on a transaction
line. Any given rate may only be listed once.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: QBO
Description: For US editions of
QuickBooks Online, and in TxnTaxDetail only, this references the
TaxRate applied to the entire transaction.[br /]
For international
editions of QuickBooks Online, for a TaxLineDetail in a
TxnTaxDetail, where the TxnTaxCodeRef is set, the TaxRate
referenced
here MUST also be one of the rates in the referenced tax code's rate
list (either the SalesTaxRateList or the PurchaseTaxRateList) that
applies to the
transaction type. Any given rate may only be listed once.[br /]Does not apply
to a TaxLineDetail apart from a TxnTaxDetail.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: ALL
Description: True if the sales tax is
expressed as a percentage; false if expressed as a number amount.
Product: ALL
Description: Numerical expression of
the sales tax percent. For example, use "8.5" not "0.085".
Product: QBO
Description: This is taxable amount
on the total of the applicable tax rates
If TaxRate is applicable
on two lines, the taxableamount represents total of the two lines
for which this rate is applied
This is different from the
Line.Amount which represent the final tax amount after the tax has
been applied
Product: QBO
Description: This is the amount which
also includes tax.
Product: QBO
Description: This holds the
difference between the actual tax and overridden amount supplied
by the user.
Product: ALL
Description: Date when the service is
performed.
Product: ALL
Description: Internal use only:
extension place holder for TaxLine.
Product: ALL
Description: Details of taxes charged
on the transaction as a whole. For US versions of QuickBooks, tax
rates used in the detail section must not be used in any tax line
appearing in the main transaction body. For international versions
of QuickBooks, the TxnTaxDetail should provide the details of all
taxes (sales or purchase) calculated for the transaction based on
the tax codes referenced by the transaction. This can be calculated
by QuickBooks business logic or you may supply it when adding a
transaction. For US versions of QuickBooks you need only supply the
tax code for the customer and the tax code (in the case of multiple
rates) or tax rate (for a single rate) to apply for the transaction
as a whole.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: QBW
Description: Reference to the default tax code that applies to the transaction
as a whole.
In Quickbooks desktop, this maps to CustomerTaxCode in Invoice and
VendorTaxCode in Bill.
[span style="display: none"] I18n: US [/span]
Product: All
Description: Reference to the
transaction tax code. For US editions only.
Note that the US tax model can have just a single tax code for the
entire transaction.
Product: ALL
Description: Total tax calculated for the transaction, excluding any embedded
tax lines.
Product: ALL
Description: This must be a Line whose LineDetailType is TaxLineDetail.
Product: ALL
Description: Base class of all Sales
transaction entities.
Product: QBO
Description: If AutoDocNumber is true, DocNumber is generated automatically.
If false or null, the DocNumber is generated based on preference
of the user.
Product: ALL
Description: Reference to a Customer or job.
Filterable: QBW
InputType: ReadWrite
BusinessRules: QBW: CustomerRef is mandatory for some SalesTransactions like
Invoice
Product: ALL
Description: QBO: For an Invoice, this is the user-entered message to the
customer that does appear in the invoice, and does appear in the
printed invoice. The maximum length for Invoice Msg is 1000
characters.[br /]For a Bill, this is the memo of the transaction
to provide more detail, and does not appear in the printed
message of the bill. The maximum length for Bill Msg is 4000
characters.[br /]For a CreditCardCharge, this message appears in
the printed record; maximum length is 4000 characters.[br /]Not
supported for BillPayment, JournalEntry or Payment.
Description: QBW: User-entered message to the customer; this message will be
visible to end user on their transactions.
InputType: ReadWrite
Product: ALL
Description: QBO: Bill-to address
of the Invoice.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
Description: QBW: The physical (postal) address where the bill
or invoice is sent.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
InputType: ReadWrite
Product: ALL
Description: QBO: Shipping address
of the Invoice.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
Description: QBW: Identifies the address where the goods must be
shipped. [br /]QuickBooks Note: If ShipAddr is not specified,
and a default ship-to address is specified in QuickBooks for
this customer, the default ship-to address will be used by
QuickBooks.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
Product: QBW
Description: Reference to the party
receiving payment.
InputType: ReadOnly
Product: QBW
Description: Reference to the Class
associated with the transaction.
InputType: ReadWrite
Product: QBW
Description: Reference to the
SalesTerm associated with the transaction.
InputType: ReadWrite
Product: ALL
Description: QBW: Date when the payment of the
transaction is due.
Description: QBO: Date when the invoice is to
be paid, not including any early-payment discount incentives, or
late payment penalties. If the date is not supplied, the current
date on the server is used.
Filterable: QBW
InputType: ReadWrite
BusinessRules: QBW: Following are the BusinessRules regarding DueDate of
transaction
Product: QBW
Description: Reference to the
SalesRep associated with the transaction.
InputType: ReadWrite
Product: ALL
Description: Purchase Order number.
ValidRange: QBW: max=25
ValidRange: QBO: max=15
Product: ALL
Description: "Free On Board", the
terms between buyer and seller regarding transportation costs;
does not have any bookkeeping implications.
Description: "Free On
Board", the terms between buyer and seller regarding
transportation costs; does not have any bookkeeping
implications.
ValidRange: QBW: max=13
ValidRange: QBO: max=15
Product: QBW
Description: Reference to the ShipMethod associated with the transaction.
InputType: ReadWrite
Product: QBW
Description: Date for delivery of
goods or services.
InputType: ReadWrite
Product: QBW
Description: Shipping provider's
tracking number for the delivery of the goods associated with
the transaction.
Product: QBO
Description: Indicates the
GlobalTax model if the model inclusive of tax, exclusive of
taxes or not applicable
Product: All
Description: QBO: Indicates the
total amount of the transaction. This includes the total of all
the charges, allowances and taxes. By default, this is
recalculated based on sub items total and overridden.
Description: QBW: Indicates the total amount of the transaction.
This includes the total of all the charges, allowances and
taxes.[br /]Calculated by QuickBooks business logic; cannot be
written to QuickBooks.
Filterable: QBW
Sortable: QBW
InputType: QBW: OverrideOnSync
Product: ALL
Description: QBW: Total amount of
the transaction in the home currency for multi-currency enabled
companies. Single currency companies will not have this field.
Includes the total of all the charges, allowances and taxes.
Calculated by QuickBooks business logic. Cannot be written to
QuickBooks.
InputType: QBW: ReadOnly
Product: QBO
Description: If false or null,
calculate the sales tax first, and then apply the discount. If
true, subtract the discount first and then calculate the sales
tax.
Product: QBW
Description: Reference to the
Template for the invoice form.
InputType: ReadWrite
Product: ALL
Description: Printing status of the
invoice.[br /]
InputType: ReadWrite
Product: ALL
Description: Email status of the
invoice.[br /]
InputType: ReadWrite
Product: QBO
Description: Identifies the e-mail
address where the invoice is sent. At present, you can provide
only one e-mail address.[br /]If the ToBeEmailed attribute is
true and the BillEmail attribute contains an e-mail address, the
user can send an e-mail message to the e-mail address that is
specified in the BillEmail attribute.[br /]If the BillEmail
attribute contains an invalid e-mail address, QBO does not send
the e-mail message to the invalid e-mail address. QBO also does
not return any error message to indicate that the e-mail address
is invalid.[br /]The maximum length for BillEmail is 100
characters.
Product: QBW
Description: Identifies the email address
where the bill or invoice is sent. [br /]UNSUPPORTED FIELD.
Product: QBO
Description: Identifies the cc
e-mail address where the invoice is sent. If the ToBeEmailed
attribute is true and the BillEmailCc attribute contains an
e-mail address, the user can send an e-mail message to the
e-mail address that is specified in the BillEmailCc
attribute.[br /] If the BillEmailCc attribute contains an
invalid e-mail address, QBO does not send the e-mail message to
the invalid cc e-mail address. [br /]The maximum length for
BillEmailCc is 200 characters.
Product: QBW
Description:
Identifies the cc email address where the bill or invoice is
sent. [br /]
Product: QBO
Description: Identifies the bcc
e-mail address where the invoice is sent. If the ToBeEmailed
attribute is true and the BillEmailBcc attribute contains an
e-mail address, the user can send an e-mail message to the
e-mail address that is specified in the BillEmailBcc
attribute.[br /] If the BillEmailCc attribute contains an
invalid bcc e-mail address, QBO does not send the e-mail message
to the invalid bcc e-mail address. [br /]The maximum length for
BillEmailBcc is 200 characters.
Product: QBW
Description:
Identifies the bcc email address where the bill or invoice is
sent as bcc. [br /]
Product: QBW
Description: Reference to the
ARAccount (accounts receivable account) associated with the
transaction.
InputType: ReadWrite
Product: QBO
Description: The balance reflecting
any payments made against the transaction. Initially this will
be equal to the TotalAmt.
Product: QBW
Description: Indicates the
unpaid amount of the transaction.
Filterable: ALL
Sortable: QBW
InputType: ReadOnly
Product: QBO
Description: The balance reflecting
any payments made against the transaction in home currency.
Initially this will be equal to the HomeTotalAmt.[br /]Read-only
field.
Product: QBW
Description: Indicates the unpaid amount of
the transaction in home currency.[br /]Cannot be written to
QuickBooks.
Filterable: ALL
Sortable: QBW
Product: ALL
Description: Indicates whether the
transaction is a finance charge.
InputType: ReadWrite
Product: ALL
Description: Reference to the
PaymentMethod.
InputType: ReadWrite
Product: QBO
Description: The reference number
for the payment received (I.e. Check # for a check, envelope #
for a cash donation, CreditCardTransactionID for a credit card
payment)
Product: QBO
Description: Valid values are Cash, Check, CreditCard, or
Other. No defaults. Cash based expense is not supported by
QuickBooks Windows.
NotApplicableTo: Estimate, SalesOrder
Product: ALL
Description: QBW: Reference to the
DepositToAccount entity. If not specified, the Undeposited Funds
account will be used.
Description: QBO: Asset account where the payment money is deposited. If you
do not specify this account, QBO uses the Undeposited Funds
account. Supported for Payment and SalesReceipt only.
NotApplicableTo: QBW: Estimate, SalesOrder
Product: QBO
Description: Last delivery info of this transaction.
Product: QBO
Description: Indicates the discount
rate that is applied on the transaction as a whole. This will be
pro-rated through item lines for tax calculation.
Product: QBO
Description: Indicates the discount
amount that is applied on the transaction as a whole. This will
be pro-rated through item lines for tax calculation.
Product: QBO
Description: this is the reference
to the NotaFiscal created for the salesTransaction.
ValidRange:
QBO: max=30
Product: ALL
Description: Captures a memo on a
transaction that may (QBW) reference a company pre-defined message
(See CustomerMsg)
Product: ALL
Description: Check payment details for
both payments to vendors and payments from customers.
Product: ALL
Description: The check number printed
on the check.
Product: ALL
Description: Status of the check.
Values provided by service/business logic.
Product: ALL
Description: Name of persons or
entities holding the account, as printed on the check.
Product: ALL
Description: Checking account number,
as printed on the check.
Product: ALL
Description: The name of the bank on
which the check was drawn.
Product: ALL
Description: Internal use only:
extension place holder for CheckPayment
Product: ALL
Description: Information about a
payment received by credit card.
Product: ALL
Description: Holds credit-card information to request a credit card payment from a merchant account service, but NOT any response or authorization information from the merchant account service provider -- see CreditChargeResponse
Product: ALL
Description: Credit Card account number, as printed on the card. Must not have whitespace or formatting characters.
Product: ALL
Description: Type of credit card.[br /]
Product: ALL
Description: Account holder name, as printed on the card.
Product: ALL
Description: Expiration Month on card, expressed as a number: 1 = January, 2 = February, etc.
Product: ALL
Description: Expiration Year on card, expressed as a 4 digit number 1999, 2003, etc.
Product: ALL
Description: Credit card holder billing address of record: the street address to which credit card statements are sent.
Product: ALL
Description: Credit card holder billing postal code. Five digits in the USA.
Product: ALL
Description: Code associated with commercial cards: purchase, corporate, and business cards. Lower transaction fee rates apply when these cards are used and this field is provided.
Product: ALL
Description: Credit card transaction mode used in Credit Card payment transactions. Valid values: CardNotPresent (default) or CardPresent.[br /]
Product: ALL
Description: Type of credit card transaction. Valid values: Authorization, Capture, Charge, Refund, VoiceAuthorization.[br /]
Product: ALL
Description: Unique identifier of the previous payment transaction. It can be used as an input to the Capture transaction type.
Product: QBO
Description: The Amount processed using the credit card.
Product: QBO
Description: If false or no value, QBO will not process the payment but just store Credit Card Information. If true, QBO will process the Credit Card Payment (Not supported currently).
Product: ALL
Description: Internal use only: extension place holder for CreditCardChargeInfo
Product: ALL
Description: Enumeration of Credit Card transaction modes used in Credit Card payment transactions.
Product: ALL
Description: Enumeration of Credit Card transaction types used in Credit Card payment transactions.
Product: ALL
Description: Holds credit-card transaction response information from a merchant account service, but not any credit card or payment request information - see CreditChargeInfo.
Product: Not used now
Description: Credit Card Processor Name for recording the payment processor
Product: ALL
Description: Unique identifier of the payment transaction. It can be used to track the status of transactions, or to search transactions.
Product: ALL
Description: Indicates the status of the payment transaction. Possible values include Completed, Unknown.[br /]
Product: ALL
Description: Numeric code specifying the result of the transaction.
Product: ALL
Description: Text specifying the result of the transaction.
Product: ALL
Description: Merchant account number associated with the credit card transaction.
Product: ALL
Description: Result of comparing the security code supplied in the credit card transaction request with the code on file with the card issuer. Possible values are Pass, Fail, and NotAvailable.[br /]
Product: ALL
Description: Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.
Product: ALL
Description: The AVS (Address Verification Service) result for the street address supplied in the transaction. Possible values are Pass, if the information matches the information on file with the cardholder's account, Fail, or NotAvailable.[br /]
The AVS (Address Verification Service) result for the zip code supplied in the transaction. Possible values are Pass, if the information matches the information on file with the cardholder's account, Fail, or NotAvailable.
Product: ALL
Description: CardCode or Card Id field that can be optionally provided to use additional security features of credit card authorization. It is typically a 3 digit number located on the back of most credit cards. For American Express, it is a 4 digit number on the front.
Product: ALL
Description: Indicates which deposit batch the transaction belongs to. Allows for integration with Intuit MAS Service and QBFS: enables reconciliation between what is charged on credit card and what is already deposited into bank.
Product: ALL
Description: Code that indicates membership in a group of card types that are normally deposited together.
Product: ALL
Description: Timestamp indicating the time in which the card processor authorized the transaction.
Product: ALL
Description: This value is used to support the credit card transaction reconciliation.
Product: ALL
Description: An identifier returned in settlement data used to support the credit card transaction reconciliation.
Product: ALL
Description: Internal use only: extension place holder for CreditChargeResponse
Product: ALL
Description: Enumeration of the status of the Credit Card payment transaction.
Product: ALL
Description: Enumeration of Credit Card security code match used in Credit Card payment transactions.
Product: ALL
Description: Enumeration of AVSStreet and AVSZip match used in Credit Card payment transactions.
Product: QBO
Description: Transaction delivery info like DeliveryType, DeliveryTime, DeliveryErrorType (if any)
Product: QBO
Description: Type of the delivery. Ex: Email, Tradeshift
Product: QBO
Description: Time of Delivery
Product: QBO
Description: If delivery failed, this would indicate the type of the failure.
Product: QBO
Description: Enum of different delivery types. Supports Email and Tradeshift delivery.
Product: QBO
Description: Enum of different delivery error types.
Product: QBO
Description: The Invoice entity
represents an invoice to a customer. Invoice could be based on
salesterm with invoice and due dates for payment. Invoice supports
sales tax, and shipping charges as a special line item. Invoice can
be printed and emailed to a customer.
Business Rules: [li] An invoice
must have at least one line that describes the item and an
amount.[/li][li] An invoice must have a reference to a customer in
the header.[/li]
Product: QBW
Description: An Invoice is a financial transaction representing
a request for payment for goods or services that have been sold. An
invoice is a form that records the details of a customer's purchase,
such as quantity and price of the goods or services. An invoice
records the amount owed by a customer who does not pay in full at
the time of purchase. If full payment is received at the time of
purchase, the sale may be recorded as a sales receipt, not an
invoice. An invoice must contain a valid customer reference in the
CustomerId field and at least one line item. The referenced customer
must already exist in the QuickBooks company at the desktop and any
line items must also already exists in the QuickBooks company, or
the attempt to sync will fail.[br /]In general, it is a good
practice to specify all the header fields if you have the data. You
should always specify the ARAccountId; otherwise a default AR
account will be used and this may give you unexpected results.[/br]
If you want to apply one tax to all the transaction line items, use
the TaxId or TaxGroupId field. If you want to use more than one tax,
you need to use Tax Line items instead.
Business Rules: [li] An
invoice must have at least one line that describes the item.
[/li][li] If an account is specified in the header, the account must
be of the Accounts Receivable (AR) type. [/li][li] An invoice must
have a reference to a customer in the header.[/li]
Product: QBO
Description: Amount in deposit
against the Invoice. Supported for Invoice only.
Product: QBO
Description: Specifies whether
customer is allowed to use IPN to pay the Invoice
Product: QBO
Description: Specifies whether
customer is allowed to use eInvoicing(online payment) to pay the
Invoice
Product: QBO
Description: Specifies whether
customer is allowed to use eInvoicing(online payment -credit
card) to pay the Invoice
Product: QBO
Description: Specifies whether
customer is allowed to use eInvoicing(online payment -bank or
ach) to pay the Invoice
Product: QBO
Description: Specifies the eInvoice
Status(SENT, VIEWED, PAID) for the invoice
Product: QBO
Description: Specifies the
eCloudStatus timeStamp(last Viewed/Sent/paid) for the invoice
Product: QBO
Description: provides invoice statuses :
MULTIPLE_ERRORS, DEPOSIT_ON_HOLD, DISPUTED, DEPOSIT_FAILED, PAYMENT_FAILED,
OVERDUE_VIEWED, OVERDUE_NOT_SENT, OVERDUE_SENT,
DUE_VIEWED, DUE_NOT_SENT, DUE_SENT,
PAID_NOT_DEPOSITED, PARTIALLY_PAID, DEPOSITED, VOIDED, REVERSED
Product: QBO
Description: call to action for this status
Product: QBO
Description: invoice status log
Product: ALL
Description: Extension entity for
Invoice.
Product: QBO
Description: Log of Statuses for Transactions. Currently is used for Invoice. Can be extended to others.
Product: QBO
Description: Holds status information
Product: QBO
Description: Holds the status update date.
Product: QBO
Description: call to action for this status
SalesReceipt Transaction entity
Extension entity for SalesReceipt
Transaction entity is the base class of all
transactions
Date by which estimate must be accepted before
invalidation.
QBO only field.
Name of customer who accepted the estimate.
QBO
only field.
Date estimate was accepted.
QBO only field.
Extension entity for Estimate
Product: QBO
Description: Specifies various fields
required for emailing different transaction
Product: QBO
Description: Email address of
recipients. Multiple email address seperated with comma.
Product: QBO
Description: Cc email address of
recipients. Multiple email address seperated with comma.
Product: QBO
Description: Bcc email address of
recipients. Multiple email address seperated with comma.
Product: QBO
Description: Custom Email subject
and message to be used for this email.
Product: QBO
Description: Specifies whether
online payment should be enabled for this transaction
Product: QBO
Description: Specifies whether
customer is allowed to use eInvoicing(online payment -credit
card) to pay the Invoice
Product: QBO
Description: Specifies whether
customer is allowed to use eInvoicing(online payment -bank or
ach) to pay the Invoice
Product: QBO
Description: Delivery information
like DeliveryTime, DeliveryType and DeliveryErrorType (if
applicable)
Product: QBO
Description: Specifies ETransaction
status of this transaction. Applicable if ETransaction is
enabled and this transaction is a ETransaction.
Product: QBO
Description: Base type holding default subject and message for transaction emails.
Product: QBO
Description: Subject for the email
Product: QBO
Description: Message body for the email
An asset you do not expect to convert to cash
during one year of normal operations.
A fixed asset is usually
something that is necessary for the operation of your business, such
as a truck, cash register, or computer.
User recognizable name for the Fixed Asset
Item.[br /]
Length Restriction:
QBO: 15
QBW: 1024
Whether or not active inactive fixed assets may
be hidden from most display purposes and may not be used on
financial transactions.
Specifies whether the asset is new or used.
This will aid in calculating depreciation.[br /]
Length
Restriction:
QBO: 15
QBW: 1024
User entered purchase description for the fixed
asset which may include user entered information to further
describe the details of the purchase.
Specifies the date the asset was purchased or
acquired.[br /]
Length Restriction:
QBO: 15
QBW: 1024
Specifies the asset's purchase price.
Specifies the name of the vendor or payee from
whom the asset was purchased.
Indicates the Fixed Asset account that tracks
the current value of the asset. If the same account is used for
all fixed assets, the current balance of this account will
represent the current total value of the fixed assets.[br /]
[br /]
Required for the create operation. [br /]
User entered sales description for the fixed
asset which may include user entered information to further
describe the details of the sales.
Specifies the date the asset was sold.
Specifies the amount for which the asset was
sold.
Additional expenses incurred during the sale of
the asset.
Information about where the asset is located or
has been placed into service.
The purchase order number if a purchase order
was used to buy the asset.
The serial number of the asset. For a vehicle,
it can be the VIN.
The date the warranty for the asset expires.
Any description of the asset, like maker,
brand, and so on.
Notes about the asset that might help to track
it properly, such as notes about repairs or upkeep.
QBW only: asset number. Maintained by the QB
Fixed Asset Manager.
QBW only: The total cost of the fixed asset.
This can include the cost of improvements or repairs. This
amount is used to calculate depreciation. Maintained by the QB
Fixed Asset Manager.
QBW only: the total amount of depreciation
expense since the fixed asset was acquired as of the end of the
year. Maintained by the QB Fixed Asset Manager.
QBW only: the asset's cost or basis less
accumulated depreciation as of the end of the year. Maintained
by the QB Fixed Asset Manager.
Internal use only: extension place holder for
FixedAsset
Product: ALL
Description: A tax code is used to
track the taxable or non-taxable status of products, services, and
customers. You can assign a sales tax code to each of your products,
services, and customers based on their taxable or non-taxable
status. You can then use these codes to generate reports that
provide information to the tax agencies about the taxable or
non-taxable status of certain sales. [br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: QBW
Description: User recognizable name
for the tax sales code.[br/]Max. Length: 3 characters.[br
/]Required for the Create request.
Product: QBO
Description: User
recognizable name for the tax sales code.[br/]Max. Length: 10
characters.
Required: ALL
Filterable: ALL
Sortable: ALL
Product: ALL
Description: User entered
description for the sales tax code.[br/]Max Length: 31
characters.
Product: QBW
Description: False if inactive.
Inactive sales tax codes may be hidden from display and may not
be used on financial transactions.
Filterable: ALL
Product: QBW
Description: False or null means
meaning non-taxable (default). True means taxable.
Product:QBW
Description: True if this tax code
represents a group of tax rates (a desktop TaxGroupItem), false
if it represents a QuickBooks US TaxCode.
Product: ALL
Description: List of references to
tax rates that apply for sales transactions when this tax code
is used.
Product: ALL
Description: List of references to
tax rates that apply for purchase transactions when this tax
code is used.
Product: QBO
Description: List of references to
adjustment tax rates that apply to the transaction.
Product: ALL
Description: Internal use only:
extension place holder for TaxCode
Product: All
Description: TaxRateDetail that
specifies qualified detail of TaxRate
Product: QBW
Description: opaque internal string
used to correlate the rate list with a QBW TaxGroup item to support
mod of TaxCodes in global tax
Product: ALL
Description: TaxRateRef
Product: ALL
Description: Applicable TaxType enum
Product: QBO
Description: Applicable Tax Order
Product: QBO
Description: Applicable TaxOnTaxOrder
Product: QBO
Description: Enumeration of
SpecialTaxType
Product: ALL
Description: A sales tax rate specifies
the tax rate for the specific TaxCode.[br]See [a
href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global
Tax Model[/a].
Product: QBW
Description: User recognizable name
for the tax rate.[br /]Max. Length: 31 characters.[br /]Required
for the Create request.
Required: QBW
ValidRange: QBW: Max=31
Filterable: QBW
Product: QBW
Description: User entered
description for the tax rate.[br /]Max Length: 4000 characters.
ValidRange: QBW: Max=4000
Product: QBW
Description: False or null if
inactive. Inactive sales rate codes may be hidden from display
and may not be used on financial transactions.
Filterable: QBW
Product: ALL
Description: Represents rate value.
Filterable: QBW
Product: ALL
Description: Represents Agency
Reference, Vendor Reference in case of QBW, Agency in case of
QBO.
Product: ALL
Description: TaxReturnLine is
representative of SalesTaxReturnLine reference
Product: QBO
Description: Effective list rates
for different date ranges
Product: QBO
Description: Used for Zero rates
for EC VAT.
How it is used: VAT registered Businesses who receive
goods/services (acquisitions) from other EU countries,
will need to calculate the VAT due, but not paid, on these
acquisitions. The rate of VAT payable is the same that would
have been paid if the goods had been supplied by a UK supplier.
Product: QBO
Description: DisplayType of a tax
rate, configuration of editability and display on forms
Product: ALL
Description: Internal use only:
extension place holder for TaxRate
Product: QBO
Description: EffectiveTaxRate detail
Product: ALL
Description: Represents rate value.
Product: QBO
Description: Effective starting date
for which this taxrate is applicable
Product: QBO
Description: End date of this taxrate
applicability
Product: ALL
Description: Internal use only:
extension place holder for TaxLine.
Account is a component of a Chart Of Accounts, and
is part of a Ledger. Used to record a total monetary amount
allocated against a specific use.
Accounts are one of five basic types: asset, liability, revenue (income),
expenses, or equity.
User recognizable name for the Account.[br /]
Product: ALL
Required: ALL
Filterable: QBW
ValidRange: QBW: Max=31
ValidRange: QBO: Max=100
Product: ALL
Description: Specifies the Account is a SubAccount or Not. True if
subaccount, false or null if it is top-level account
Product: ALL
Description: Specifies the Parent AccountId if this
represents a SubAccount. Else null or empty
Product: ALL
Description: User entered
description for the account, which may include user entered
information to guide bookkeepers/accountants in deciding what
journal entries to post to the account.
ValidRange: QBW: Max=200
ValidRange: QBO: Max=100
Product: ALL
Description: Fully qualified name
of the entity. The fully qualified name prepends the topmost
parent, followed by each sub element separated by colons. Takes
the form of: [br /] Parent:Account1:SubAccount1:SubAccount2
InputType: ReadOnly
Product: ALL
Description: Display Name of the
account that will be shown in Transaction Forms based on Account
Category
ValidRange: QBO: Max=100
Product: ALL
Description: Location Type for the
Transaction.
ValidRange: QBO: Max=50
Product: ALL
Description: Whether or not active
inactive accounts may be hidden from most display purposes and
may not be posted to.
Filterable: QBW
Product: ALL
Description: 5 types of
classification an account classified. Suggested examples of
account type are Asset, Equity, Expense, Liability, Revenue
Filterable: QBW
Product: ALL
Description: Type is a detailed
account classification that specifies the use of this account.
16 type of account subtypes available in AccountTypeEnum
Filterable: QBW
Required: ALL
Product: QBO
Description: AccountSubTypeEnum
specificies QBO on detail type. If not specified default value
are listed for each SubType
Product: ALL
Description: User entered/specified account number
to help the user in identifying the account within the
chart-of-accounts and in deciding what should be posted to the
account.
Product: QBO
Description: An extension to the base account number that can be added to
Customer A/R or Supplier A/P accounts.
Product: QBW
Description: Bank Account Number,
should include routing number whatever else depending upon the
context, this may be the credit card number or the checking
account number, etc.
ValidRange: QBW: max=25
Product: ALL
Description: Specifies the Opening
Balance amount when creating a new Balance Sheet account.
Product: ALL
Description: Specifies the Date of
the Opening Balance amount when creating a new Balance Sheet
account.
Product: ALL
Description: Specifies the balance
amount for the current Account. Valid for Balance Sheet
accounts.
InputType: QBW: ReadOnly
Product: ALL
Description: Specifies the
cumulative balance amount for the current Account and all its
sub-accounts.
InputType: QBW: ReadOnly
Product: ALL
Description: Reference to the
Currency that this account will hold the amounts in.
Product: ALL
Description: Describes if the
account is taxable
Product: QBW
Description: If the account is
taxable, refers to taxcode reference if applicable
I18n: QBW:
GlobalOnly
Product: ALL
Description: Indicates if the
Account is linked with Online Banking feature (automatically
download transactions) of QuickBooks Online or QuickBooks
Desktop. Null or false indicates not linked with online banking.
True if Online banking based download is enabled for this
account.
InputType: ALL: ReadOnly
Product: ALL
Description: Indicates the name of
financial institution name if Account is linked with Online
banking. Valid only if account is online banking enabled. This
is optional and read-only.
InputType: ALL: ReadOnly
Product: QBO
Description: The Journal Code that is associated with the account. This is
required only for Bank accounts. This is applicable only in FR.
InputType: ALL: ReadOnly
Product: ALL
Description: extension place holder
for Account.
Master Account is the list of accounts in the
master list. The master list is the complete list of accounts
prescribed by the French Government. These accounts can be created
in the company on a need basis. The account create API needs to be
used to create an account.
Product: ALL
Description: Specifies whether the account has been created in the company.
Cash based expense type definition
Financial Transaction information that pertains to
the entire Check.
If false or null it represents a CreditCard
charge expense, true represent Credit (money-in or returned)
Financial Transaction information that pertains to
the entire Check.
Address to which the payment should be sent.
In case of check expense, MemoOnCheck represent
the data written on the check as message written to the Payee to
physically read on the check
ReadToPrint is a flag indicating if the Check is
ready for printing
Financial Transaction information that pertains to
the entire Check.
Specifies the account reference. Check should
have bank account, CreditCard should specify credit card account
Product: ALL
Description: Reference to the
PaymentMethod.
Product: ALL
Description: The reference number
for the payment received (I.e. Check # for a check, envelope #
for a cash donation, CreditCardTransactionID for a credit card
payment)
Required element. No defaults. Expense Type
can be Cash, Check or CreditCard
Cash based expense is not
supported by QBW.
Filterable: QBW
Specifies the party to whom a expense is
associated with. Can be Customer, Vendor, Employee (or OtherName
in case of QBW)
If Credit is Null or False, it is considered as
Charge. If true, the CreditCard represents a Refund. Valid only
for CreditCard transaction
Filterable: QBW
Address to which the payment should be
sent.Output only.
The total amount due, determined by taking the
sum of all lines associated. This includes all charges,
allowances, taxes, discounts, etc...
[b]QuickBooks Notes[/b][br
/]
Non QB-writable.
Output only field in case of QBO
Filterable:
QBW
Sortable: QBW
Memo that will be printed in check in case of
Check purchase, Memo appears on the expense report for
CreditCard, Memo for CashPurchase
PrintStatus if to be printed or already printed
information
Product: QBO
Description: Indicates the
GlobalTax model if the model inclusive of tax, exclusive of
taxes or not applicable
Internal use only: extension place holder for
Purchase.
Financial Transaction information that pertains to
the entire Bill.
Product: ALL
Description: Specifies the vendor reference for this transaction
Filterable: QBW
Specifies which AP account the bill will be
credited to. Many/most small businesses have a single AP
account, so the account is implied. When specified, the account
must be a Liability account, and further, the sub-type must be
of type "Payables"
[b]QuickBooks Notes[/b][br /]
The AP Account
should always be specified or a default will be used.
Product: ALL
Description: The total amount due, determined by taking the sum of all lines
associated. This includes all charges, allowances, taxes,
discounts, etc...
[b]QuickBooks Notes[/b][br /]
Non QB-writable.
Output only field in case of QBO
Filterable: QBW
Sortable: QBW
Product: QBW
Description: The email address to
which this bill is/was sent. [br/] Non QB-writable.
Product: QBW
Description: The email address to
which inquiries about the bill may be directed. (Also
appropriate for paypal payments). [br/] Non QB-writable.
QBW only. Memo to be visible to Payee
Product: QBO
Description: Indicates the
GlobalTax model if the model inclusive of tax, exclusive of
taxes or not applicable
Bill is an AP transaction representing a
request-for-payment from a third party for goods/services rendered
and/or received
Product: QBW
Description: Payer information
SalesTerm Reference for the bill
The nominal date by which the bill must be
paid, not including any early-payment discount incentives, or
late payment penalties.
Address to which the payment should be sent.
[b]QuickBooks Notes[/b][br /]
Non QB-writable.
Address to which the vendor shipped or will
ship any goods associated with the purchase.
Product: ALL
Description: The unpaid amount of the bill. When paid-in-full, balance will
be zero.
[b]QuickBooks Notes[/b][br /]
Non QB-writable.
Filterable: QBW
Sortable: QBW
Product: ALL
Description: The unpaid amount of the bill in home currency. Available only
for companies where multicurrency is enabled. When paid-in-full,
home balance will be zero.
[b]QuickBooks Notes[/b][br /]
Non
QB-writable.
Filterable: QBW
Sortable: QBW
Internal use only: extension place holder for
Bill.
Bill is an AP transaction representing a
request-for-payment from a third party for goods/services rendered
and/or received
Internal use only: extension place holder for
Bill extensible element to qualify account.
Financial transaction representing a request for
payment for goods or services that have been sold.
If Credit is Null or False, it is considered as
Charge. If true, the StatementCharge represents a Refund
Represents Customer (or Job)Reference
Identifies the party or location that the
payment is to be remitted to or sent to.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
ARAccountReferenceGroup Identifies the AR
Account to be used for this Credit Memo.
[b]QuickBooks
Notes[/b][br /]
The AR Account should always be specified or a
default will be used.
Date when the Charge is to be paid.
Date when the customer Statement was created
Indicates the total amount of the entity
associated. This includes the total of all the charges,
allowances and taxes.
[b]QuickBooks Notes[/b][br /]
Non
QB-writable.
Internal use only: extension place holder for
StatementCharge
Classes provide a way to track different segments
of the business, and to break down the income and expenses for each
segment. Classes can apply to all transactions, so they're not tied
to a particular client or project.
User recognizable name for the Class.[br /]
Length Restriction:
QBO: 100 characters
QBW: 31 characters
Sortable: ALL
Specifies the Class is a SubClass or Not. True
if subclass, false or null if it is top-level class
Reference to parent class entity
Product: ALL
Description: Output Only. Fully
qualified name of the entity. The fully qualified name prepends
the topmost parent, followed by each sub element separated by
colons. Takes the form of: [br
/]Parent:class1:Subclass1:Subclass2
Whether or not active inactive classes may be
hidden from most display purposes and may not be used on
financial transactions
Filterable: ALL
Internal use only: extension place holder for
Class extensible element
Journal Code is a compliance requirement in FR. A
journal code is assigned to each transaction and it depends on
whether it is a income or a expense.
The two letter name for the journal code
The type of the Journal Code. The applicable
values are those exposed through the JournalCodeTypeEnum.
The description of the Journal Code
Whether or not Journal codes may be hidden for
display purposes
Internal use only: extension place holder for
Journal Code extensible element
Financial transaction representing a payment from a
customer applied to one or more sales transactions
Product: ALL
Description: Represents Customer
(or Job)Reference
Filterable: QBW
Identifies the party or location that the
payment is to be remitted to or sent to.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
ARAccountReferenceGroup Identifies the AR
Account to be used for this Payment.
[b]QuickBooks Notes[/b][br
/]
The AR Account should always be specified or a default will be
used.
Optional asset account specification to
designate the account the payment money needs to be deposited
to.
[b]QuickBooks Notes[/b][br /]
If not specified, the
Undeposited Funds account will be used.
Product: ALL
Description: Reference to the
PaymentMethod.
Product: ALL
Description: The reference number
for the payment received (I.e. Check # for a check, envelope #
for a cash donation, CreditCardTransactionID for a credit card
payment)
Product: ALL
Description: Valid values are Cash, Check, CreditCard, or
Other. No defaults. Cash based expense is not supported by
QuickBooks Windows. Not applicable to Estimate and
SalesOrder.[br /]
Product: ALL
Description: Indicates the total
amount of the entity associated. This includes the total of all
the payments from the Payment Details.
[b]QuickBooks Notes[/b][br
/]
Non QB-writable.
Filterable: QBW
Sortable: QBW
Indicates the amount that has not been applied
to pay amounts owed for sales transactions.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
Indicates that the payment should be processed
by merchant account service. Valid for QBO companies with credit
card processing.
QBO only field.
Internal use only: extension place holder for
Payment
Method of payment for received goods.
User recognizable name for the payment
method.[br /]
Length Restriction:
QBO: 15
QBW: 31
Whether or not active inactive payment methods
may be hidden from most display purposes and may not be used on
financial transactions.
Filterable: QBW
Defines the type, or the ways the payment was
made. For QBW, the acceptable values are defined in
PaymentMethodEnum. For QBO, this field is restricted to
CREDIT_CARD or NON_CREDIT_CARD.
Internal use only: extension place holder for
PaymentMethod
Product: ALL
Description: Constituent line of a
group item.
Product: ALL
Description: Reference to an Item. For an Assembly item, this must be a
reference to an Inventory Item needed in the assembly.
Product: ALL
Description: Quantity of items.
Product: ALL
Description: Reference to the unit of measure (within UOMSetRef) for this line
item. Examples: "each" or "box".
Product: ALL
Description: Contains the details of a
group item.
Product: ALL
Description: Contains the line details of a group item.
Department provide a way to track different
segments of the business, and to break down the income and expenses
for each segment. Department can apply to all transactions, so
they're not tied to a particular client or project.
User recognizable name for the Class.[br /]
Length Restriction:
QBO: 100 characters
QBW: 1024
Specifies the Department is a SubDepartment or
Not. True if subdepartment, false or null if it is top-level
department
Reference to parent class entity
Product: ALL
Description: Output Only. Fully
qualified name of the entity. The fully qualified name prepends
the topmost parent, followed by each sub element separated by
colons. Takes the form of: [br /]
Parent:Location1:SubLocation1:SubLocation2
Whether or not active inactive classes may be
hidden from most display purposes and may not be used on
financial transactions
Internal use only: extension place holder for
DepartmentEx extensible element
Product: ALL
Description: Contains the details of an
inventory assembly item.
Product: ALL
Description: Contains the line details of an inventory assembly item.
Product: QBO
Description: The Item resource
represents any product or service that is sold or purchased.
Inventory items are not currently supported.
Product: QBW
Description: An item is a thing that your company buys, sells,
or re-sells, such as products, shipping and handling charges,
discounts, and sales tax (if applicable). An item is shown as a line
on an invoice or other sales form. The Item.Type property, which
specifies how the item is used, may have one of the following
values: [li]Assembly: The Assembly item allows you combine inventory
part items and other assembly items (subassemblies) into a single
item by defining a Bill of Materials, that lists the component parts
of the assembly item. You can also include the cost of building the
assembly item by adding the non-inventory part items, service items,
and other charge items to the Bill of Materials. [/li][li] Fixed
Asset: The Fixed Asset item represents those business assets that
you do not convert to cash one year of normal operation. A fixed
asset is usually something that is integral to your business
operations. For example, a truck or computer. [/li][li]Group: The
Group item helps you to quickly enter a group of individual items
that you often purchase or sell together. [li]Inventory: The
Inventory item is used to track merchandise which your business
purchases, stocks as inventory, and re-sells. QuickBooks tracks the
current number of inventory items in stock and the average value of
the inventory after the purchase and sale of every item.
[/li][li]Other Charge: The Other Charge item is used to charge
customers for the mileage expense.[/li] [li]Product The Product item
is used to record the sales information of a product.
[/li][li]Payment: The Payment item subtracts the amount of a
customer payment from the total amount of an invoice or statement.
You must create a payment item if you receive payment for an invoice
or statement in parts. If you receive full payment at the time of
sale, use a sales receipt form instead of an invoice with a payment
item.[/li] [li]Service: The Service item is used for the services
that you charge on the purchase. For example, including specialized
labor, consulting hours, and professional fees. [/li][li]Subtotal:
The Subtotal item is used when you want the total of all the items.
You can use this item to apply a percentage discount or
surcharge.[/li]
Business Rules: [li]The item name must be unique.
[/li][li]The item type must not be NULL. [/li][li]The item cannot
define both unit price and unit price percent simultaneously.
[/li][li]For the Service, Product, and Other Charge items, you must
specify the ID or name of the expense account or both. [/li][li]If
the purchase order cost is specified for the Service, Product, and
Other Charge items, you must specify the ID or name of the expense
account or both.[/li] For the Inventory and Assembly items, you must
specify: [li]the ID or name of the income account or both
[/li][li]the ID or name of the cogs account or both [/li][li]the ID
or name of the asset account or both [/li][li]For the Group item,
you must specify the tax ID or tax name or both.[/li] For the Fixed
Asset item, you must: [li]set the asset account type to Asset[/li]
[li]specify the purchase date [/li][li]specify the ID or name of the
income account or both[/li]
Product: QBW
Description: User recognizable name
for the Item.[br /]Max. length: 31 characters.
Product: QBO
Description: User recognizable name for the Item.[br /]Max.
length: 100 characters.
Filterable: ALL
Sortable: ALL
Required: QBW
Product: QBO
Description: Stock Keeping Unit -
User entered item identifier that identifies an item uniquely
[br /]Max. length: 100 characters.
Filterable: ALL
Sortable: ALL
Product: QBW
Description: User entered
description for the item that describes the details of the
service or product.[br /]Max. length: 4000 characters.
Product:
QBO
Description: User entered description for the item that
describes the details of the service or product.[br /]Max.
length: 4000 characters.
Filterable: QBO
Sortable: QBO
Product: QBW
Description: True if active.
Inactive items may be hidden from display and may not be used in
financial transactions.
Filterable: QBW
Product: ALL
Description: True if the item is a
subitem; false or null indicates a top-level item.
Product: ALL
Description: Reference to the
item's parent entity.
Product: ALL
Description: Specifies the level of
the item, 0 if top level parent, otherwise specifies the depth
from the top parent.
Product: ALL
Description: Fully qualified name
of the entity. The fully qualified name prepends the topmost
parent, followed by each sub element separated by colons. Takes
the form of: [br /] Parent:Customer:Job:Sub-job [br /] Limited
to 5 levels. Max. length: 41 characters (single name) or 209
characters (fully qualified name).
Product: ALL
Description: True if the item is
subject to tax.
Product: ALL
Description: True if the sales tax
is included in the item amount, and therefore is not calculated
for the transaction.
Product: ALL
Description: True if the tax amount
is percentage based.
Product: ALL
Description: Monetary value of the
service or product, as expressed in the home currency.
Filterable: QBW
Sortable: QBW
Product: ALL
Description: The tax amount
expressed as a percent of charges entered in the current
transaction. To enter a rate of 10% use 10.0, not 0.01.[br
/]Applicable to the Service, OtherCharge or Part (Non-Inventory)
item types only, and only if the Purchase part of the item does
not exist, that is, the item is not used as a reimbursable item,
or as a part in assemblies.
Product: ALL
Description: Classification that
specifies the use of this item. See the description at the top
of the Item entity page for details. [br /]
Filterable: ALL
Product: ALL
Description: Reference to a
PaymentMethod for an item of type Payment.
Product: ALL
Description: Reference to the unit
of measure set (UOM) entity used by this item.
Product: ALL
Description: Reference to the
posting account, that is, the account that records the proceeds
from the sale of this item.[br /]Required for the the following
types: Assembly, Inventory, Other Charge, Product, Service.
Required: ALL
Product: ALL
Description: User entered purchase
description for the item.
Product: ALL
Description: True if the purchase
tax is included in the item amount, and therefore is not
calculated for the transaction.
Product: ALL
Description: Amount paid when
buying or ordering the item, as expressed in the home currency.
Product: ALL
Description: Reference to the
expense account used to pay the vendor for this item.[br /]Note:
for a service item, this may also be an equity account to record
a draw against the company equity to pay for the service.[br
/]If the Purchase information (PurchaseDesc,
PurchaseTaxIncluded, PurchaseCost, etc.) is provided, this
account is required for the the following item types: Other
Charge, Product, Service.
Required: ALL
Product: ALL
Description: Reference to the Cost
of Goods Sold account for the inventory item.[br /]Required for
the the following item types: Assembly, Inventory.
Required: ALL
Product: ALL
Description: Reference to the
Inventory Asset account that tracks the current value of the
inventory. If the same account is used for all inventory items,
the current balance of this account will represent the current
total value of the inventory.[br /]Required for the the
following item types: Assembly, Inventory.
Required: ALL
Product: ALL
Description: Reference to the
preferred vendor of this item.
Product: ALL
Description: Average cost of the
item, expressed in the home currency.
Product: QBO
Description: Quantity on hand to be
tracked.
Product: ALL
Description: Current quantity of
the inventory items available for sale.
Sortable: QBW
Product: ALL
Description: Quantity of the
inventory item being ordered, for which there is a purchase
order issued.
Product: ALL
Description: Quantity of the
inventory item that is placed on sales orders.
Product: ALL
Description: Quantity on hand
threshold below which a purchase order against this inventory
item should be issued. When the QtyOnHand is less than the
ReorderPoint, the QuickBooks purchase order system will prompt
the user to reorder.
Product: ALL
Description: Identifier provided by
manufacturer for the Item, for example, the model number.[br
/]Applicable for the the following item types: Inventory,
Product.
Product: ALL
Description: Optional reference to
the account in which the payment money is deposited.[br /]If not
specified, the Undeposited Funds account will be used.
Applicable to the Payment item type only.
Product: ALL
Description: Reference to the sales tax code for the item.[br /]Applicable
to the Service, Other Charge, Part (Non-Inventory), Inventory
and Assembly item types only.
Product: ALL
Description: Reference to the
purchase tax code for the item.[br /]Applicable to the Service,
Other Charge, and Part (Non-Inventory) item types.
Product: ALL
Description: Date of the opening
balance for the inventory transaction. QuickBooks creates the
Opening Balance inventory transaction as of the given date, and
calculates the total value by multiplying the cost by the
quantity on hand.[br /]Applies to the Quantity On Hand and Total
Value.[br /]Applicable to the Inventory and Assembly item types
only.
Product: ALL
Description: Assembly item
QuantityOnHand threshold below which more assemblies should be
built.[br /]Applicable to the Assembly Item type only.[br /]When
he quantity of the assembly item gets below the BuildPoint
number, QuickBooks will remind the user to build more.
Product: QBW
Description: Lets us know if the user wants to display the subitems as a
group. Applicable to items of Group type only.
Filterable: QBW
Product: ALL
Description: True if this is a
special item used by QuickBooks in certain accounting functions,
including miscellaneous charges that do not fall into the
categories of service, labor, materials, or parts. Examples
include delivery charges, setup fees, and service charges.
Product: ALL
Description Type of special item,
if SpecialItem is true.[br /]
Product: ALL
Description: Contains the detailed
components of the group. Applicable to a group item only.
Product: ALL
Description: Contains the detailed
inventory parts used when the assembly is built. Applicable to
an inventory assembly item only.
Product: QBO
Description: India sales tax
abatement rate.
Product: QBO
Description: India sales tax
reverse charge rate.
Product: QBO
Description: India sales tax
service type, see ServiceTypeEnum for values.
Product: QBO
Description: Categorizes the given item as a product or a service. The
applicable values are those exposed through the
ItemCategoryTypeEnum. This is currently applicable only in FR
region.
Internal use only: extension place holder for
Item
Product: ALL
Description: The Term entity represents
the terms under which a sale is made, typically expressed in the
form of days due after the goods are received. Optionally, a
discount of the total amount may be applied if payment is made
within a stipulated time. For example, net 30 indicates that payment
is due within 30 days. A term of 2%/15 net 60 indicates that payment
is due within 60 days, with a discount of 2% if payment is made
within 15 days. Term also supports: an absolute due date, a number
of days from a start date, a percent discount, or an absolute
discount.
Product: ALL
Description: User recognizable name
for the term, for example, "Net 30".
ValidRange: QBW: max=31
ValidRange: QBO: Max=31
Required: ALL
Filterable: QBO
Sortable: ALL
Product: ALL
Description: If true, this entity
is currently enabled for use by QuickBooks.
Filterable: ALL
Default Value: true
Product: ALL
Description: Type of the Sales
Term. Valid values: Standard or DateDriven, as defined by
SalesTermTypeEnum. [br /] If dueDays is not null, the Type is
Standard else DateDriven.
InputType: ALL: ReadOnly
Product: ALL
Description: Discount percentage
available against an amount if paid within the days specified by
DiscountDays.
ValidRange: ALL: Min=0, Max=100
Product: ALL
Description:- Internal use only:
extension place holder for SalesTermEx
[b]QuickBooks Notes[/b][br /]
[i]Unsupported
field.[/i]
Address to which the payment should be sent.
Internal use only: extension place holder for
BillPaymentCheck.
Internal use only: extension place holder for
BillPayTypeCreditCard
Financial transaction representing a Payment by
check issued to pay one or more bills received from 3rd party
(vendor) for purchased goods or services.
Identifies the party or organization that
originated the purchase of the goods, services or BillPayment.
[b]QuickBooks Notes[/b][br /]
Valid Vendor Name or Id is required
for the create operation for Bill Payment transactions.[br /]
Required for the create operation.
Optional AP account specification for bill
payment transactions. Most small businesses have a single AP
account, so the account is implied. When specified, the account
must be a liability account - and further, must be of the
sub-type "Payables".
[b]QuickBooks Notes[/b][br /]
The AP Account
should always be specified or a default will be used.
Filterable: QBW
Product: ALL
Description: The total amount paid,
determined by taking the sum of all lines associated.
InputType:
QBW: ReadOnly
Filterable: QBW
Sortable: QBW
Internal use only: extension place holder for
BillPay
AccountReferenceGroup Identifies the Asset
Account (bank account) to be used for this Cash back.
[b]QuickBooks Notes[/b][br /]
Required for the create operation.
[br /]
Transaction recording a payment from the customer
held in the Undeposited Funds account into the Bank account.
DepositToAccountReferenceGroup Identifies the
Asset Account (bank account) to be used for this Deposit.
[b]QuickBooks Notes[/b][br /]
Required for the create operation.
[br /]
Product: QBO
Description: Indicates the
GlobalTax model if the model inclusive of tax, exclusive of
taxes or not applicable
Total amount of Deposit.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
Product: ALL
Description: Total amount of the
transaction in the home currency for multi-currency enabled
companies. Single currency companies will not have this field.
Includes the total of all the charges, allowances and taxes.
Calculated by QuickBooks business logic. Cannot be written to
QuickBooks.
Internal use only: extension place holder for
Deposit
Financial transaction representing transfer of
funds between accounts.
Non QB-writable.
Must be a Balance Sheet account.
Must be a Balance Sheet account.
Total amount of the transfer.
Internal use only: extension place holder for
Transfer
PurchaseOrder is a non-posting transaction
representing a request to purchase goods or services from a third
party.
Represents the TaxCode Reference with respect
to the purchase[br /]
Information about the Customer and actual Job
or Project the expense must be reimbursed for.
The nominal date by which the bill must be
paid, not including any early-payment discount incentives, or
late payment penalties.
The date when the delivery of the product is
expected.
Address to which the payment should be sent.
[b]QuickBooks Notes[/b][br /]
Non QB-writable.
Address to which the vendor shipped or will
ship any goods associated with the purchase.
"Free On Board", specifies the terms between
buyer and seller regarding transportation costs; does not have
any bookkeeping implications.
Length Restriction:
QBO: 15
QBW: 1024
The email address to which this purchase order
is/was sent.
Length Restriction:
QBO: 15
QBW: 1024
The entire transaction, or individual items are
manually closed, i.e. they may not be received.
Internal use only: extension place holder for
PurchaseOrder
Product: QBW
Description: A sales order is a
financial transaction that represents a request received from a
customer to purchase products or services. Sales orders help you
manage the sale of products and services your customers order. For
example, a sales order tracks inventory that is on back order for a
customer. Sales Orders are supported only in QuickBooks Premier
(desktop) and above. However, if you are accessing a company file
created in Premier and above from a lesser edition of QuickBooks
(such as Pro), you can do queries against SalesOrders. Using sales
orders is optional.
Endpoint: services.intuit.com
Business Rules:
[li]A sales order must have at least one line that describes the
item. [/li][li]A sales order must have a reference to a customer in
the [/li][li]If you submit a query with the filter
IncludeDiscountLineDetails, the system retrieves either
DiscountAmount or DiscountRatePercent with associated values[/li]
Product: QBW
Description: The entire
transaction, or individual items are maually closed, i.e. not
invoiced.
Internal use only: extension place holder for
SalesOrder
Financial transaction representing a refund (or
credit) of payment or part of a payment for goods or services that
have been sold.
Indicates the total credit amount still
available to apply towards the payment.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
Internal use only: extension place holder for
CreditMemo
Financial transaction representing a refund (or
credit) of payment or part of a payment for goods or services that
have been sold.
Indicates the total credit amount still
available to apply towards the payment.
[b]QuickBooks
Notes[/b][br /]
Non QB-writable.
Internal use only: extension place holder for
Refund
Describes the properties of currencies defined in
QuickBooks. QuickBooks supports the world's common currencies.
Currency name.
Length Restriction:
QBO: 15
QBW:
1024
Whether or not active inactive Currency may be
hidden from most display purposes and may not be used on
financial transactions.
[b][i]QuickBooks Notes[/i][/b] [br /]
Inactive Currencies are not used when downloading the exchange
rates.
Currency universal 3-letter code, like USD,
CAD, EUR, etc.
[b][i]QuickBooks Notes[/i][/b] [br /]
Required for
the create operation. [br /]
Max Length: 3
"Thousand separator" character, used for the
display purpose.
[b][i]QuickBooks Notes[/i][/b] [br /]
Max Length:
1
Specifies how to present the value, used for
the display purpose for example, ##,###,### or #,##,##,###
[b][i]QuickBooks Notes[/i][/b] [br /]
Max Length: 32
Specifies how many decimal places can be shown.
Usually there will be 2, or 0 for currencies without "cents".
[b][i]QuickBooks Notes[/i][/b] [br /]
Max Length: 1
Used for display purpose, can be a comma or a
period.
Used for display purpose to specify where to
show the Currency Symbol.
[b][i]QuickBooks Notes[/i][/b] [br /]
QuickBooks predefines the most common world currencies, however
it does allow the user to define the new one.
The user-defined
currency however cannot have the exchange rates downloaded.
Internal use only: extension place holder for
Currency
Product: ALL
Description: ISO 4217 Currency Code enumeration.
Company currency are the currencies used by the
company. Each Company Currency describes the properties of that
currency.
Product: QBO
Description: Universal 3-letter
currency code like USD, CAD, EUR, etc. Required for the
create/delete operation.
Max Length: 3
Product: QBO
Description: Currency name (Output
only)
Product: QBO
Description: Indicates whether this
currency is active in the company or not. Inactive Currency may
be hidden from most display purposes and may not be used on
financial transactions.
Internal use only: extension place holder for
Company Currency
Describes properties of an exchange rate between
source and target currencies.
Product: QBO
Description: Universal 3-letter
code of source currency from which exchange rate is required,
usually LHS of the equation. Example: 1 USD = 65 INR. Here USD
would be the source currency.
Max Length: 3
Product: QBO
Description: Universal 3-letter
currency code of target currency against which exchange rate is
required, usually RHS of the equation. Usually this would be the
home currency.
Max Length: 3
Product: QBO
Description: Exchange rate to be
set between these two currencies for the mentioned date.
Product: QBO
Description: Date as on which the
exchange rate needs to be set.
Internal use only: extension place holder for
Exchange Rate
Product: QBW
Description: The SalesRep entity allows
you to identify sales representatives and track their transactions.
A sales representative can be an employee, a vendor, or an
independent contractor. You can associate sales representatives with
sales deals to track their transactions.
Product: QBW
Description: The SalesRep type.
Also, one of the three entity references (either the Name or the
ID of the Employee, OtherName, or Vendor) is required for the
Create request.[br /]
Required: QBW
Product: QBW
Description: True if active.
Inactive sales reps may be hidden from display and may not be
used on financial transactions.
Filterable: QBW
Product: QBW
Description: User recognizable
initials of the Sales Rep.[br/]Required for the Create
request.[br/] Max Length: 5 characters.
Product: QBW
Description: Internal use only:
extension place holder for SalesRep
Product: QBW
Description: You can use price levels
to specify custom pricing for specific customers. Once you create a
price level for a customer, QuickBooks will automatically use the
custom price in new invoices, sales receipts, sales orders or credit
memos for that customer. You can override this automatic feature,
however, when you create the invoices, sales receipts, etc. The user
can now specify a price level on line items in the following
supported sales transactions: invoices, sales receipts, credit
memos, and sales orders. Notice that the response data for the
affected sales transaction does not list the price level that was
used. The response simply lists the Rate for the item, which was set
using the price level.
Product: QBW
Description: User-visible name of
the price level
Product: QBW
Description: Reference to the
currency in which the price level is expressed.
Internal use only: extension place holder for
PriceLevel
Product: QBW
Description: A custom price or
percentage change from the item's base price for a specific price
level
Internal use only: extension place holder for
PriceLevelPerItem
A standard message to a customer that can be
included at the bottom of a sales form.
Contains the message to a customer.[br /]
Length Restriction:
QBO: 15
QBW: 1024
Whether or not active inactive customer message
may be hidden from most display purposes and may not be used on
financial transactions.
Internal use only: extension place holder for
CustomerMsg
Accounting transaction, consists of journal lines,
each of which is either a debit or a credit. The total of the debits
must equal the total of the credits.
Indicates that the Journal Entry is
after-the-fact entry to make changes to specific accounts.
Valid only if the company file is set up to use
Multi-Currency feature.
[b]QuickBooks Notes[/b][br /]
At the end
of a reporting period, when financial reports need to reflect a
current home currency value of the foreign balances, enter a
home currency adjustment.
Until the home currency value of the foreign balances is recalculated
using current exchange rates, reports reflect the home currency
value based on the exchange rates used at the time of each
transaction.
Valid only if the company file is set up to use
Multi-Currency feature.
[b]QuickBooks Notes[/b][br /]
Amounts are
always entered in home currency for a HomeCurrencyAdjustment
JournalEntry.
Product: All
Description: Indicates the total
amount of the transaction. This includes the total of all the
charges, allowances and taxes. By default, this is recalculated
based on sub items total and overridden.
Product: QBW
Description: Indicates the total amount of the transaction. This
includes the total of all the charges, allowances and taxes.[br
/]Calculated by QuickBooks business logic; cannot be written to
QuickBooks.
Filterable: QBW
Sortable: QBW
Product: ALL
Description: Total amount of the
transaction in the home currency for multi-currency enabled
companies. Single currency companies will not have this field.
Includes the total of all the charges, allowances and taxes.
Calculated by QuickBooks business logic. Cannot be written to
QuickBooks.
Internal use only: extension place holder for
JournalEntry
A record of time worked by a vendor or employee.
The timezone from where the time activity is
entered, unused in QBO and QBW
The date of the time activity.
Represents Customer (or Job)Reference
Represents Department Reference.
[br /]
Required for the create operation.
The payroll item determines how much the
employee should be paid for doing the work specified by the Item
Service Id.
In order for the Time Activity data to be transferred
to the employee payroll data, the Employee must have the
property UseTimeEntry set.
Billable status of the time recorded
True if the time recorded is both billable and
taxable.
Hourly bill rate of the employee or vendor for
this time activity.
[b]QuickBooks Notes[/b][br /]
[i]Unsupported
field.[/i]
Hours worked.
Minutes worked; valid values are 0 - 59.
Hours of break taken between start time and end
time.
[b]QuickBooks Notes[/b][br /]
[i]Unsupported field.[/i]
Minutes of break taken between start time and
end time. Valid values are 0 - 59.
[b]QuickBooks Notes[/b][br /]
[i]Unsupported field.[/i]
Time work started.
[b]QuickBooks Notes[/b][br /]
[i]Unsupported field.[/i]
Time work ended.
[b]QuickBooks Notes[/b][br /]
[i]Unsupported field.[/i]
Description of work completed during time
activity.
Internal use only: extension place holder for
TimeActivity.
Product: QBW
Description: The InventorySite resource
represents a location where inventory is stored.
Endpoint:
inventorysite
Business Rules: [li]The site name must be unique.[/li]
Product: QBW
Filterable: QBW
Description: User
recognizable name for the site
Product: QBW
Filterable: QBW
Description: Whether
the site is considered "active", still in use by the business
Product: QBW
Description: Whether this is the
default site for inventory items that do not indicate a site
Product: QBW
Description: Description
Product: QBW
Description: Name of the person
responsible for the site
Product: QBW
Description: Tagged postal addresses
Product: QBW
Description: Tagged phone number, possibly include pagers.
Internal use only: extension place holder for
InventorySite
Product: ALL
Description: Describes a method of
shipping for the company
Product: ALL
Description: The name of the
shipping method (i.e. FedEx 2-day)
Product: QBW
Description: Indication of whether
or not this shipping method is still used by the company.
Internal use only: extension place holder for
ShipMethod
Product: QBW
Description: A specific task to be
completed, maps to a ToDo record in QuickBooks.
Product: QBW
Description: The actual content of
the task reminder
Product: QBO
Description: In use by the business
Product: QBW
Description: In use by the business
Product: QBW
Description: True if the task has
been completed
Product: QBW
Description: The date to remind the
user of this task
Internal use only: extension place holder for
Task
Product: ALL
Description: A specific user alert to
be notified to Quickbooks user, maps to a ToDo record in QuickBooks.
Product: ALL
Description: The actual content of
the user alert
Product: QBW
Description: In use by the business
Product: QBW
Description: True if the user alert
has been completed
Product: QBO
Description: The type of the user
alert
Product: ALL
Description: The date to remind the
user of this user alert
Product: QBO
Description: The date the user
alert will expire
Product: QBO
Description: The date the user
alert is due
Product: QBO
Description: The URL that can be
included in the user alert
Product: QBO
Description: The filter associated
with the user alert
Any other properties not covered in base is
covered as name value pair, for detailed explanation look at the
document
Internal use only: extension place holder for
user alert
Product: ALL
Description: Multicurrency enabled
for this company
Product: ALL
Description: Reference to the Home
currency of the company
Product: QBW
Description:
Product: QBW
[b]QuickBooks Notes[/b][br /]
Max
Length: 3
Product: QBW
[b]QuickBooks Notes[/b][br /]
Max
Length: 3
Product:QBW
Annual Interest Rate in percent
Product:QBW
Product:QBW
Product:QBW
If true, the Finance Charges are
calculated from the transaction date (Invoice, or Bill).[br /]
If
false, the Finance Charges are calculated from the due date.
Product:QBW
true if finance charges should apply
to overdue charges, in which case the charges will be applied to
the account referenced in FinChrgAccountRef
Product:QBW
[b]QuickBooks Notes[/b][br /]
Max
Length: 31 or 159 (for a fully qualified name)
Defines Company Accounting Prefs details
QBW: Only QBW supported
Product:QBO Default ARAccount
Product:QBO Default APAccount
Product:QBW
Requires account
Product:QBO
QBO: QBO only. Enable Department
Tracking
Product: QBO
Department terminology
Product:All
Enable Class Tracking per transaction
Product:QBO
Enable Class Tracking per transaction
line
QBW: ONLY. Enable auto journal entry number
Product:All
Defines first Month of physical year
Product:All
Defines Tax Year Month
TaxForm Number
Product:All
Book closing date, if you want to
specify if not leave it as null
Product: QBW
Description:
Product:QBO
Customer Terminology
QBW: only. Defines advance inventory Prefs details
QBW: ONLY. MLI available
QBW: ONLY. MLI enabled
QBW: Only QBW supported
QBW: only
QBW: only
QBW: only
QBW: only
QBW: only
QBW: ONLY.
QBW: only
Product: QBW
Description: Indicates whether
Row/Shelf/Bin location tracking is enabled
Product: QBW
Description: Indicates whether
barcoding is enabled
Defines Product and Services Prefs details
Product:QBO
ProductAndServices for Sales enabled
Product:QBO
ProductAndServices for purchases
enabled
Product:QBW
Inventory and PO are active
Product:QBO
Enable quantity with price and rate
enabled
Product:QBO
Enable QuantityOnHand enabled
Product:QBW. Possible values are
Disabled,SinglePerItem and MultiplePerItem
Defines Sales Form Prefs details
Product:All
Product:QBO
Defines the CustomField definitions
Product:QBo
Custom Transaction Numbers enabled
Product:QBO
Enable delayed charges
Product:QBO
Cc Email Address for Sales forms
Product:QBO
Bcc Email Address for Sales forms
Product:QBO
Enable Deposit on Invoice
QBO:Enable specifying Discount
QBO:Default Discount account
Product:All
Enable specifying Estimates
Product:QBO
Message to customers on estimates only
Product:QBO
Specifies ETransaction preference status
Product:QBO
Specifies whether salesForm PDF should be attached with
ETransaction emails
Product:QBO
Specifies whether online payments is activated
Product:QBO
IPN integration support enable status, this allows emails to
include IPN link
Product:QBO
Specify Invoice Message
Product:QBO
Enable specifying Service Dates
Product:QBO
Enable specifying Shipping Info
Product:QBO
Default shipping account
Product:QBO
Default ItemId Reference type that is selected as part of company
setup
Product:QBO
Default Terms
Product:QBO Default Delivery Method of Invoice
and other sales forms - Print, Email are normal options
Product:ALL
Apply Credit Automatically
Product:All
Apply Payments Automatically
Product:QBW
Print Item with Zero amount or not
Product:QBW
Cloud Max Length: 256
[b]QuickBooks
Notes[/b][br /]
Max Length: 31
Product:QBW
Default markup rate used to calculate
the markup amount on the transactions. To enter a markup rate of
8.5%, enter 8.5, not 0.085.
Product:All
QBW: used by QB desktop, not used by QBO
QBW: used by QB desktop, not used by QBO
QBW: used by QB desktop, not used by QBO
Product:QBO
Default Customer message
Product: ALL
Description: The definition of a custom field for an Intuit type to add additional columns dynamically on a existing Intuit entities. This entity is not extended from IntuitEntity so that it can be manipulated by specifying the DefinitionId.
Product: ALL
Description: Intuit entity type to which the CustomFieldDefinition is associated. Valid values are defined in the objectNameEnumType.[br /]Required for the create operation.
Required: ALL
Product: ALL
Description: Name of the CustomField entity.[br /]Required for the create operation.
Required: ALL
Product: ALL
Description: True if the custom field is Private; false if Public and can be shared among different applications.
Product: ALL
Description: True if the custom field must be specified for every instance of the Parent entity for which the CustomFieldDefinition is defined. Data Services dpes not verify the value of that field.
Product: ALL
Description: Identifier of Partner AppId that corresponds to this CustomField.
Defines VendorAndPurchase Prefs details
Product:All
Enables manage bills
Product:All
Enables tracking by customers
Product:All
Enable BillableExpense tracking
Product:All
Default Terms
Product:All
Default markup rate used to calculate
the markup amount on the transactions. To enter a markup rate of
8.5%, enter 8.5, not 0.085.
Product:All
Default markup Account used to
calculate the markup amount on the transactions.
Product:All
Apply automatic bill payment
Product:QBW
Defines the CustomField definitions
Product:All
Message to vendors
Product:QBO
Product:QBW
Product:QBW
Cloud Max Length: 4000
[b]QuickBooks Notes[/b][br
/]
Max Length: 31 or 159 (for a fully qualified name)
Defines VendorAndPurchase Prefs details
Product:QBO
Enables services for time tracking
Product:QBO Default TimeItem Id
Product:QBO
Enables billing customers for time
Product:QBO
Enables billing rate to all employees
Product:All
Work week starting day
Product:QBW
Time Tracking preference from QB
Desktop
Product:QBW
MarkTimeEntriesBillable preference
from QB Desktop
Product:QBW
MarkExpensesAsBillable preference from
QB Desktop
Defines Messages Prefs details
Specifies Preferences classified as email
messages are classified as Name-Value pair
Product:QBO
Default email subject and message for
Invoice.
Product:QBO
Default email subject and message for
Estimate.
Product:QBO
Default email subject and message for
Sales receipt.
Product:QBO
Default email subject and message for
Statement.
Defines Messages Prefs details
Specifies Preferences classified as email
messages are classified as Name-Value pair
Defines Report Prefs details
Product:All
report basis
Product:QBW
If true, the Aging Reports are based
on the transaction date.[br /]
If false, the Aging Reports are
based on the due date.
Product: ALL
Description: Enumeration of Summary Report basis.
Any other preference not covered in base is covered
as name value pair, for detailed explanation look at the document
Specifies extension of Preference entity to
allow extension of Name-Value pair based extension at the top
level
Defines Preference strongly typed object with
extensions
Accounting info Preferences
Accounting info Preferences
Product and Service Preferences
Sales Form Preferences
Email messages Preferences
Printable document preferences
Vendor and purchases Preferences
Vendor and purchases Preferences
Tax Preferences
FinanceCharges Preferences
Currency Preferences
Report Preferences
Specifies extension of Preference entity to
allow extension of Name-Value pair based extension at the top
level
The UOM type defines the data used to represent a
set of equivalent units and the conversion rates to other related
units. It allows showing what quantities, prices, rates, and costs
are based on.
User recognizable name of the Unit of
Measure.[br /]
[br /]
Required for the create operation. [br /]
Max Length: 31
Abbreviation of the Unit of Measure.[br /]
[br /]
Required for the create operation. [br /]
Max Length: 31
[br /]
Required for the create operation. [br /]
Related UOM
User recognizable name of the Unit of Measure.[br
/]
[br /]
Required for the create operation. [br /]
Max Length: 31
Abbreviation of the Unit of Measure.[br /]
[br /]
Required for the create operation. [br /]
Max Length: 31
The name of a template used for a specific form
presentation.
User recognizable name for the Template
name.[br /]
[br /]
Required for the create operation. [br /]
Max Length: 31
Whether or not active inactive templates may be
hidden from most display purposes and may not be used on
financial tansactions.
Product: ALL
Description: Category values for
Attachable
Product: ALL
Description: Describes the details of
the attachment.
FileName of the attachment
Max Length: 1000
FullPath FileAccess URI of the attachment,
output only
Output only. TempDownload URI which can be
directly downloaded by clients
Size of the attachment
ContentType of the attachment
Category of the attachment
Latitude from where the attachment was
requested
Longitude from where the attachment was
requested
PlaceName from where the attachment was
requested
Note for the attachment or standalone note
Tag name for the requested attachment
FullPath FileAccess URI of the attachment
thumbnail if the attachment file is of a content type with
thumbnail support, output only
Output only. Thumbnail TempDownload URI which
can be directly downloaded by clients. This is only available if
the attachment file is of a content type with thumbnail support
Specifies extension entity to allow extension
Product: All
Description: Enumeration of
OLBTransactions Status
Describes OLBTransaction instance - one per
transaction downloaded
Post date of the transaction
Transaction date
Amount of the transaction
Reference Number of downloaded transaction
Olb Status of a transaction, Use
OLBTransactionStausEnum Approved/Pending/Deleted
Describes OLBTransactions list that are downloaded
Product: ALL
Description: AccountId of the transaction
Product: ALL
Description: Last Posting date of OLB transactions where downloaded from the
bank
Product: ALL
Description: Last time OLB transactions were downloaded from the bank
Details of OLB transactions
Specifies the starting row number in this result
Specifies the number of records in this result
Specifies the total count of records that satisfy
the filter condition
Describes OLBTransactions list that are downloaded
Product: ALL
Description: Last time OLB transactions where downloaded from the bank
List of OLB transactions
Describes Budget specifications
Product: QBO
Description: Name of the budget
Product: QBO
Description: Starting date of the budget
Product: QBO
Description: End date of the budget
Product: QBO
Description: Budget Type
Product: QBO
Description: Budget Entry Type
Product: QBO
Description: Active budget or inactive
Product: QBO
Description: Budget details are here
Describes budget details for each budget
Product: QBO
Description: Budget date of the budget
Product: QBO
Description: Amount corresponding to the budget date and Account or Class Or
Department or Customer
Product: QBO
Description: Account Reference
Product: QBO
Description: Customer Reference
Product: QBO
Description: Class Reference
Product: QBO
Description: Department Reference
Product: QBO
Description: Describes metadata
associated with TDS entity.
Product: QBO
Description: Provides list of TDS entity types supported for India region.
Product: QBO
Description: Provides list of TDS section types supported for India region.
Product: QBO Description: Reimburse charge object
for QBO
Product: QBO Description: Customer Reference
Total amount of the reimburse charge.
Financial transaction representing a request for
credit on payment for
goods or services that have been sold.
If Credit is Null or False, it is considered as
Charge. If true, the ChargeCredit represents a Refund
Represents Customer (or Job)Reference
Identifies the party or location that the
payment is
to be remitted to or sent to. [b]QuickBooks
Notes[/b][br /] Non
QB-writable.
ARAccountReferenceGroup Identifies the AR
Account to
be used for this Credit Memo. [b]QuickBooks
Notes[/b][br /] The AR
Account should always be specified or a
default will be used.
Date when the Charge is to be paid.
Date when the customer Statement was created
Indicates the total amount of the entity
associated.
This includes the total of all the charges,
allowances and taxes.
[b]QuickBooks Notes[/b][br /] Non
QB-writable.
Internal use only: extension place holder for
ChargeCredit
Product: QBO
Description: Represents a Tax Return
that is filed with a Tax Agency.
Product: QBO
Description: True when this filing
is an upcoming Filing for a currently Open Filing Period. False
otherwise.
Product: QBO
Description: Start date of the
Filing.
Product: QBO
Description: End date of the
Filing.
Product: QBO
Description: Date of the Filing.
Specifies the final Tax Amount due to the Tax
Agency for a Filing
Specifies the FRS Amount due to the Tax Agency
for a Filing Period. Applicable for UK only.
Specifies the PayGWithheld Amount due to the
Tax Agency for a Filing Period. Applicable for AU only.
Product: QBO
Description: Represents the Agency
of which this TaxReturn is a part.
Product: ALL
Description: Provides for strong-typing of the StringType CustomField.
Product: ALL
Description: Default string value of the StringType CustomField.[br /]Max. length: 31 characters.
Product: ALL
Description: The regular expression string used to validate the StringType CustomField value.[br /]Max. length: 31 characters.
Product: ALL
Description: Maximum length allowed for the value of the string when creating/updating a StringType CustomField.
Product: ALL
Description: Provides for strong-typing of the NumberType CustomField.
Product: ALL
Description: Default decimal value for the NumberType CustomField.
Product: ALL
Description: Minimum decimal value allowed when the NumberType CustomField is created/updated.
Product: ALL
Description: Maximum decimal value allowed when the NumberType CustomField is created/updated.
Product: ALL
Description: Provides for strong-typing of the DateType CustomField.
Product: ALL
Description: Default date value for the DateType CustomField.
Product: ALL
Description: Minimum date value allowed when the DateType CustomField is created/updated.
Product: ALL
Description: Maximum date value allowed when the DateType CustomField is created/updated.
Product: ALL
Description: Provides for strong-typing of the BooleanType CustomField.
Product: ALL
Description: Default value of the BooleanType CustomField.
Product: ALL
Description: Monetary value represented with as a currency code and decimal value. Moneyis always associated with another IntuitEntity and will not be manipulated as a standalone hence it is not extended from IntuitEntity.
Product: ALL
Description: Monetary unit as described by the ISO 4217 three letter currency code.
Product: ALL
Description: Monetary value.
Product: ALL
Description: Enumeration of type of email addresses that the data sync process understands.
Product: ALL
Description: Enumeration of type of addresses that the data sync process understands.
Product: ALL
Description: Enumeration of type of phones that the data sync process understands.
Product: ALL
Description: Telephone device type enumeration.
Product: ALL
Description: Gender of a person enumeration.
Product: ALL
Description: Enumeration of Credit Card types used in Credit Card payment transactions.
Product: ALL
Description: Enumeration of possible Id Domains. NG- next gen (int); QB - Provisional DB id (string); QBO; BM (Billing Manager); QBSDK - ListID, TxnID, or TxnLineId.
Product: ALL
Description: Supported Intuit entity/object names.
Product: ALL
Description: Employee type enumeration.
Product: ALL
Description: Job status enumeration.
Product: ALL
Description: Enumeration of types for time entries with paychecks.
Product: QBO
Description: Enumeration of Tax Report Basis for France
Product: ALL
Description: Describes the base class of name entities (Customer, Employee, Vendor, OtherName)
Product: QBO
Description: IntuitId represents the realm id, authid or an entity id. An entity is a new type of IAM identity that represents a person or a business which has no Intuit authentication context
Product: QBW
Description: True if the entity represents an organization; otherwise the entity represents a person. Default is NULL or False, representing a person.
Product: ALL
Description: QBW: Title of the person. The person can have zero or more titles.
Description: QBO: Title of the person. The person can have zero or more titles.
InputType: ReadWrite
ValidRange: QBW: Min=0, Max=15
ValidationRules: QBW: At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
ValidationRules: QBO: At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
I18n: ALL
Product: QBW
Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
Product: QBW
Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 5 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
Product: QBW
Description: Family name or the last name of the person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Family name or the last name of the person.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
Product: QBO
Description: Suffix appended to the name of a person. For example, Senior, Junior, etc. QBO only field.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Product: ALL
Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
Product: ALL
Description: The name of the company associated with the person or organization.
Product: QBO
Description: The name of the person or organization as displayed. If not provided, this is populated from FullName.
Product: QBW
Description: The name of the person or organization as displayed.
Required: ALL
Filterable: QBW
Product: ALL
Description: Name of the person or organization as printed on a check. If not provided, this is populated from FullName.
Product: QBW
Description: The ID of the Intuit user associated with this name. Note: this is NOT the Intuit AuthID of the user.
Product: ALL
Description: If true, this entity is currently enabled for use by QuickBooks. The default value is true.
Filterable: QBW
Product: ALL
Description: Primary phone number.
Product: ALL
Description: Alternate phone number.
Product: ALL
Description: Mobile phone number.
Product: ALL
Description: Fax number.
Product: ALL
Description: Primary email address.
Product: ALL
Description: Website address (URI).
Product: QBW
Description: List of ContactInfo entities of any contact info type. The ContactInfo Type values are defined in the ContactTypeEnum.
Product: ALL
Description: Reference to the tax code associated with the Customer or Vendor by default for sales or purchase taxes.
Product: ALL
Description: QBO: The Customer entityrepresents the consumer of the service or the product that your business offers. QBO allows categorizing the customers in a way that is meaningful to the business. For example, you can set up a category of customers to indicate which industry a customer represents, the geographic location of a customer, or how a customer came to know about the business. The categorization can be then used for reports or mails.
Description: QBW: The Customer entity is a consumer of the service or product that your business offers. While creating a customer, avoid entering job data. If you enter a job data, the system can prevent you from adding more jobs for that customer. You must first create the customer, and then create a job using that customer as a parent.
Business Rules: [li]The customer name must be unique.[/li][li]The customer name must not contain a colon (:).[/li][li]The e-mail address of the customer must contain "@" and "." (dot).[/li][li]The customer address field is mandatory.[/li]
Product: QBO only
Description: True if the customer is taxable.
Product: ALL
Description: Default billing address.
Product: ALL
Description: Default shipping address.
Product: QBW only.
Description: An address other than default billing or shipping.
Product: QBW
Description: Name of the Customer contact.
Product: QBW
Description: Name of the Alternate Customer contact.
Product: ALL
Description: Free form text describing the Customer.[br /]Max. length: 1024 characters.
Product: ALL
Description: If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
Product: ALL
Description: If true, this Customer is billed with its parent. If false, or null the customer is not to be billed with its parent. This property is valid only if this entity is a Job or sub Customer.
Product: QBO
Description: The top level Customer in the hierarchy to which this Job or sub customer belongs.
Product: ALL
Description: The immediate parent of the Sub-Customer/Job in the hierarchical "Customer:Job" list.[br /]Required for the create operation if the Customer is a sub-customer or Job.
Product: ALL
Description: Specifies the level of the hirearchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent.
Product: ALL
Description: Reference to a CustomerType associated with the Customer.
Product: ALL
Description: Reference to a SalesTerm associated with the Customer.
Product: QBW
Description: Reference to a SalesRep associated with the Customer.
Product: ALL
Description: Reference to a PaymentMethod associated with the Customer.
Product: ALL
Description: Credit-card information to request a credit card payment from a merchant account service.
Product: QBW
Description: Reference to a PriceLevel associated with the Customer.
Product: ALL
Description: Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer.
Filterable: QBW
Sortable: QBW
Product: ALL
Description: Date of the Open Balance for the create operation.
Product: QBW
Description: Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks.
Product: QBO
Description: Cumulative open balance amount for the Customer (or Job) and all its sub-jobs.
Filterable: ALL
Non-default: ALL
Product: QBW
Description: Specifies the maximum amount of an unpaid customer balance.
Product: QBW
Description: Name or number of the account associated with this customer.[br /]Max. length: 99 characters.
Product: ALL
Description: Reference to the currency code for all the business transactions created for or received from the customer.
Product: QBW
Description: Over-due balance amount. Cannot be written to QuickBooks.
Product: QBW
Description: The total revenue amount from the Customer. Cannot be written to QuickBooks.
Product: QBW
Description: The total expense amount for the Customer. Cannot be written to QuickBooks.
Product: ALL
Description: Preferred delivery method. Vales are Print, Email, or None.
Product: ALL
Description: Resale number or some additional info about the customer.
Product: ALL
Description: Information about the job. Relevant only if the Customer represents the actual task or project, not just a person or organization.
Product: QBO
Description: True, if TDS (Tax Deducted at Source) is enabled for this customer.
Product: ALL
Description: Internal use only: extension place holder for Customer.
Product: QBO
Description: Specifies secondary Tax ID of the Person or Organization. Applicable for IN companies for CST Registration No. and in future can be extended to other regions.
Product: QBO
Description: The A/R account ID for the customer. This is applicable only in FR where each customer needs to have his own AR account.
Product: QBO
Description: Specifies primary Tax ID of the Person or Organization.
Product: QBW
Description: Details for the Job. This is applicable only to QuickBooks Windows desktop.
Product: ALL
Description: Current status of the job. Valid values are: Awarded, Closed, InProgress, None, NotAwarded, Pending, as defined in the JobStatusEnum.[br /]
Product: QBW
Description: Starting date of the Job.
Product: QBW
Description: Projected end date of the job.
Product: QBW
Description: End date of the job.
Product: QBW
Description: Job description. Max. length: 99 characters.
Product: QBW
Description: Reference to the JobType.
Represents a User with an Intuit account. Note that based on privacy restrictions, information returned may be
limited depending on calling origin and/or calling user permissions (ex: a user may be able to look up all of
their information, but not the information regarding other users).
Returned only if caller passes necessary security checks to prevent e-mail address harvesting
Represents a list of UserAttribute name/value pairs if the user query provided names of extended attributes to include
Describes the Party as a Vendor Role view
Name of the contact within the vendor. Used by QBD only
Name of the Alternate contact within the vendor. Used by QBD only
Product: ALL
Description: Free form text describing the Vendor.[br /]Max. length: 1024 characters.
Product: ALL
Description: Default billing address.
Product: ALL
Description: Default shipping address.
Product: QBW only.
Description: An address other than default billing or shipping.
Product: QBW.
Description: Country of Vendor.
Specifies the Tax ID of the Person or Organization
Product: QBO
Description: Specifies the date of registeration of Supplier. Applicable for IN Region and in future can be extended to other regions.
Product: QBW.
Description: Business Number of the Vendor. Applicable for CA/UK versions of QuickBooks.
Product: QBW.
Description: Reference to the VendorType.
Product: QBW.
Description: Reference to the PrefillAccount.
Product: ALL
Description: Specifies the open balance amount or the amount unpaid by the vendor. For the create operation, this represents the opening balance for the vendor. When returned in response to the query request it represents the current open balance (unpaid amount) for that vendor.
Filterable: QBW
Sortable: QBW
BillRate can be set to specify this vendor's hourly billing rate.
Specifies the date of the Open Balance.
Non QB-writable.
Specifies the maximum amount of an unpaid vendor balance.
Name or number of the account associated with this vendor.
Length Restriction:
QBO: 15
QBD: 1024
The Vendor is an independent contractor, someone who is given a 1099-MISC form at the end of the year. The "1099 Vendor" is paid with regular checks, and taxes are not withhold on their behalf.
Product: QBW
Description: True if vendor is T4A eligible. Applicable for CA/UK versions of quickbooks.
Product: QBW
Description: True if vendor is T5018 eligible. Applicable for CA/UK versions of quickbooks.
Reference to the currency all the business transactions created for or received from that vendor are created in.
Product: QBO
Description: True, if TDS (Tax Deducted at Source) is enabled for this Vendor.
If enabled, TDS metadata needs to be passsed in VendorEx field.
Product: QBO
Description: Entity Type of the Vendor.
Product: QBO
Description: Default TDS section type for the vendor to be used in transaction.
Product: QBO
Description: True, if TDS threshold calculation should be overriden.
Product: QBO
Description: The tax reporting basis for the supplier. The applicable values are those exposed through the TaxReportBasisTypeEnum. This is applicable only in FR.
Product: QBO
Description: The A/P account ID for the supplier. This is applicable only in FR where each supplier needs to have his own AP account.
Internal use only: extension place holder for Vendor.
Product: ALL
Description: Customer types allow categorizing customers in ways that are meaningful to the business. For example, one could set up customer types so that they indicate which industry a customer represents, a customer's geographic location, or how a customer first heard about the business. The categorization then can be used for reporting or mailings.
Product: QBW
Description: User recognizable name for the CustomerType.[br /]Max. length: 31 characters.
Product: QBO
Description: User recognizable name for the CustomerType.[br /]Max. length: 15 characters.
Product: ALL
Description: Reference to the CustomerTypeParent.
Product: ALL
Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
Product: ALL
Description: True if the Customer is active. Inactive customer types may be hidden from display and may not be used on financial transactions.
Filterable: QBW
Describes the Party as a Employee Role view
Specifies the Employee type. For QuickBooks Desktop the valid values are defined in the EmployeeTypeEnum.
Specifies the number of the employee (or account) in the employer's directory.
Length Restriction:
QBO: 15
QBD: 99
Specifies the SSN of the employee.
Length Restriction:
QBO: 15
QBD: 1024
Represents primary PhysicalAddress list
Represents other PhysicalAddress list
BillableTime should be true if this employee’s hours are typically billed to customers. QBO only.
QBD Unsupported field.
If BillableTime is true, BillRate can be set to specify this employee’s hourly billing rate. QBO only.
QBD Unsupported field.
Employee birth date
Gender details
Employee hired date
Date at which employee was releaved from the company
Specifies whether the Time Entry (time sheets) should be used to create paychecks for the employee.
Internal use only: extension place holder for Employee.
Product: ALL
Description: Job types allow for categorizing jobs so that similar jobs can be grouped and subtotaled on reports. Ultimately, they will help in determining which jobs are most profitable for the business.
Product: QBW
Description: User recognizable name for the Job Type.[br /]Max. length: 31 characters.
Product: QBO
Description: User recognizable name for the Job Type.[br /]Max. length: 15 characters.
Product: ALL
Description: Reference to the JobTypeParent entity.
Product: ALL
Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
Product: ALL
Description: True if the Job is active. Inactive job types may be hidden from display and may not be used on financial transactions.
Filterable: QBW
Describes the Other Name (aka Payee). QBD only
Name or number of the account associated with this other name (payee).
Length Restriction:
QBO: 15
QBD: 1024
Represents primary PhysicalAddress list
Represents other PhysicalAddress list
Internal use only: extension place holder for OtherName.
Vendor types allow categorizing vendors in ways that are meaningful to the business. For example, one could set up vendor types so that they indicate a vendor's industry or geographic location. The categorization then can be used for reporting.
User recognizable name for the Vendor Type.
Length Restriction:
QBD: 1024
VendorType Parent referene
Product: ALL
Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
Whether or not active inactive customer types may be hidden from most display purposes and may not be used on financial transactions
Product: ALL
Description: Represents a tax agency to whom sales/purchase/VAT taxes collected are paid
We'll need an Enum for the usual countries
We'll need an Enum for the reporting periods
Product: QBO
Description: This specifies the last filing date for this tax agency.
InputType: QBO: ReadOnly
FaultTypeEnumeration list
Detailed data about warnings that occurred when a request was processed
Warning details specifies each warning
Error Type detailing error
Localized standard message associated with the error code
Detailed error localized or unlocalized error that is thrown by the business logic backend that caused the error
Error code number, this is a required field
Element that caused the error
Fault entity describing the fault
Error entity that describes the details of the error, if there are multiple errors, multiple occurrence of error object will be represented as multiple errors
Element that caused the error
IntuitResponse is a holder of all types of entities that come as part of response
Indication that a request was processed, but with possible exceptional circumstances (i.e. ignored unsupported fields) that the client may want to be aware of
Specifies the RequestId associated with the request
Specifies the time at which request started processing in the server
Specifies the HTTP codes result of the operation
AttachableResponse entity describing the response of upload results
QueryResponse entity describing the response of query
Indication that a request was processed, but with possible exceptional circumstances (i.e. ignored unsupported fields) that the client may want to be aware of
Specifies the batch id for which the response corresponds to
QueryResponse entity describing the response of query
Specifies the number of rows in this result
QueryResponse entity describing the response of query
Indication that a request was processed, but with possible exceptional circumstances (i.e. ignored unsupported fields) that the client may want to be aware of
Specifies the starting row number in this result
Specifies the number of records in this result
Specifies the total count of records that satisfy the filter condition
Product: QBW
Description: generic meta data response for any add mod
Product: QBW
Description: Request Id to create/update object
Filterable: QBW
Product: QBW
Description: Batch Id to create/update object
Filterable: QBW
Product: QBW
Description: Code for Current State of object
Filterable: QBW
Product: QBW
Description: Description for Current State of object
Product: QBW
Description: Status Message Code
Product: QBW
Description: Status Message if error occurred else null
Product: QBW
Description: Provides upload/writeback activity for a given period of time. Query activity using
StartSyncTMS OR EndSyncTMS
Product:QBW
Description: indicates when the data sync upload or write back started
Product: QBW
Description: indicates when the data sync upload or write back completed
Product: QBW
Description: can be either Upload or Write back sync type
Product: QBW
Description: indicates when the data sync upload or write back started
Filterable: QBW
Product: QBW
Description: indicates when the data sync upload or write back completed
Filterable: QBW
Product: QBW
Description: name of the entity that is part of the data sync
Product: QBW
Description: number of rows of this entity that have been uploaded or written back to QB
Product: QBW
Description: must be either upload or writeback
Describes SalesTax details
Product: QBO
Description: Describes the taxcode
Product: QBO
Description: Describes the taxcode Id, this is output only
Product: QBO
Description: TaxRate details
Fault or Object should be returned
Product: QBO
Description: TaxRate details
Product: QBO
Description: TaxRate details
Product: QBO
Description: TaxRate details
Product: QBO
Description: TaxRate value
Product: QBO
Description: TaxAgency details
Product: QBO
Description: Default is SalesTax
Product: QBO
Description: Enumeration of transaction type a given tax rate can be applied to
Report Response Type
Report Header, contains the report options that were used to generate the report
Specifies the Header of a Report, Time report was generated, parameters corresponding to the request
Specifies the time at which report was generated
Specifies the report name
Specifies the report name
Specifies the report is cash basis or accrual basis
Start Period for which the report was generated
End Period for which the report was generated
Summarize columns by enumeration
Specifies the currency code associated with the report, note that this is one place where this is just the currency code, not a reference to a currency object
Specifies the customer id (comma separeted) for which the report is run this is just the id, not a reference to a customer object
Specifies the vendor id (comma separeted) for which the report is run this is just the id, not a reference to a vendor object
Specifies the employee id (comma separeted) for which the report is run this is just the id, not a reference to a employee object
Specifies the product/service id (comma separeted) for which the report is run this is just the id, not a reference to a product/service object
Specifies the class id (comma separeted) for which the report is run this is just the id, not a reference to a class object
Specifies the Department id (comma separeted) for which the report is run this is just the id, not a reference to a Department object
Describes the options used for the report
Product: QBW
Description: Provides a wrapper for SyncError for Conflict API Response
Consists of list of SyncError objects
Product:QBW
Description: Wrapper of both types of Objects CloudVersion and QBVersion of objects
If there are multiple errored objects you will get a list of errored objects
Product: QBW
Description: Specifies the latest time when Upload happened.
Specifies the starting row number in this result
Specifies the number of records in this result
Specifies the total count of records that satisfy the filter condition
Product: QBW
Description: Wrapper object for specifying both version of the objects
If there is any warnings on a object basis that is also send back
This object is output object only
Indicates the type of error that happened in the sync to desktop
Product: QBW
Description: Indicates the cloud version of the synced object
Product: QBW
Description: Indicates the QB version of the synced object
Product: QBW
Description: Indicates error type of entity. The value must correspond to SyncErrorType.
Product: ALL
Description: Indicates the apptoken of the entity.
Product: QBW
Description: SyncObject that has an error
QueryResponse entity describing the response of query
Specifies the batch id for which the response corresponds to
Specifies the batch id for which the response corresponds to
Specifies name value pair of options other than operations
CDCQuery entity describing need for query
Coma separated entity list of entities required
Time after which changes are required on the entities that are updated, created, deleted
Enumerates list of CUD operations
Added by XsdExtension
Added by XsdExtension
QueryResponse entity describing the response of query
Product: QBW
Description: must be either of the following values
Date macros enumeration
Specifies the column type definition
Describes the type
TODO: Update summary.
Intuit.Ipp.Data assembly contains POCO (Plain Old C# Object) classes that are generated
from .xsd schema files using XsdGeneration.exe tool. It has DataService and PlatformService classes.
DataService class has enumerations belonging to QuickBooks Desktop and QuickBooks Online respectively.
PlatformServices has Intuit.Ipp.PlatformServices namespace that has classes and enumerations which are used in serialization and de-serialization process of Platform service calls.
Interface for IDS entities.
Interface for Query Filter entities.
Encapsulates subscriber information as returned by API_GetAdminsForAllProducts.
Initializes a new instance of the class.
The Xml node.
Gets the uid.
Gets the first name.
Gets the last name.
Gets the Email address
Gets the Product Id
Gets the Application name
Gets the Application Id
Parses the xml node and returns collections of admin information.
The xml node.
Returns the collection of admin info objects.
Assert Federated Identity Result.
Initializes a new instance of the class.
The Xml node.
Gets or sets whether the operation was success.
Gets or sets the Action.
Gets or sets the Error code.
Gets or sets the Error text.
Gets or sets the UData.
Parses the xml node and returns AssertFederatedIdentityResult.
The xml node.
Returns the AssertFederatedIdentityResult.
Encapsulates a billing info describing the billing state of an application.
Application is in "GRACE" billing status.
Application is in "OK" billing status.
Initializes a new instance of the class.
The billing node.
Gets the status.
Gets the last payment date.
Gets the db id.
Determines whether Billing info has status grace
true if [has status grace]; otherwise, false.
Determines whether [has status ok].
true if [has status ok]; otherwise, false.
Describes individual entitlement.
Initializes a new instance of the class.
Entitlement constructor based on API XML response
The single entitlement node.
Gets unique identifier of entitlement.
Gets the name.
Gets the term.
Gets the term id.
Parses all the entitlement elements of the API_GetEntitlementValues response.
The xml node.
Returns list of entitlements.
Describes an entitlement
Initializes a new instance of the class.
The entitlement node.
Gets the entitlement information.
The entitlement information.
Gets the role information.
The role information.
Describes an entitlement
Initializes a new instance of the class.
Constructor that parses XML returned by API
The entitlement node.
Gets the app id.
Gets the product id.
Gets the name of the plan.
The name of the plan.
Gets the type of the plan.
The type of the plan.
Gets the max users.
Gets the current users.
Gets the days remaining.
Gets the fee.
Gets the beta expiration date.
Gets the current file usage.
Gets the entitlements.
Encapsulates Paid Subscription information as returend by API_IPPDevCustomerDetail.
Initializes a new instance of the class.
The single user node.
Gets the start date.
Gets the name of the customer.
The name of the customer.
Gets the customer email.
Gets the customer phone.
Gets the realm.
Gets the name of the application.
The name of the application.
Gets the name of the plan.
The name of the plan.
Gets the monthly fee.
Gets the mb hours.
Gets the last sync time.
Parses the paid subscription.
The xml node.
Returns the paid subscriptions.
Encapsulates the information about a given role.
Initializes a new instance of the class. Prevents a default instance of the class from being created.
The single role node.
Gets the access level (e.g. "Basic Access" or "Administrator").
Gets the access id.
Gets the name of the role as defined by the developer of the application.
Gets the Id.
Parses the xml node and returns collections of role information.
The xml node containing role information nodes.
Returns collection of role info objects.
Encapsulates Trial Subscription information as returend by API_IPPDevCustomerDetail.
Initializes a new instance of the class.
The single user node.
Gets the start date.
Gets the name of the customer.
The name of the customer.
Gets the customer email.
Gets the customer phone number.
Gets the realm.
Gets the name of the application.
The name of the application.
Gets the name of the plan.
The name of the plan.
Gets the is beta.
Gets the mb hours.
Gets the last sync time.
Parses the trial subscription.
The xmlnode.
Returns the trail subscriptions.
Wraps user information returned by the platform. Depending on your access levels and which user you're querying, many of the fields might not be filled.
The Role Names.
The List of roles.
Initializes a new instance of the class.
The single user node.
Gets the account id.
Gets the Last time the user accessed the system.
Gets the User name.
Gets the User Id.
Gets the Email address.
Gets the same as ScreenName.
Gets the Last name.
Gets the First name.
Gets the Internal Id.
Gets the List of roles assigned to this user.
Gets the names of all the roles this user has, comma-separated.
Parse multiple user information.
The nodes.
Returns the users.
Under rare (and probably invalid) circumstances, a user can have a role that's
actually not part of the application's regular role definitions.
This function will give you a map of all the roles used by users in the list, using the role Id as the key.
In most cases it will overlap 100% with the list of roles reported by GetRoleInfo. In the above described situation,
it might contain more.
a UserInfo collection, in most cases a list of all users in an instance
Map of role id to RoleInfo object for all roles assigned to these users
Uses the output of ExtractRolesUsedByUsers and a list of app-defined roles to extract a list of roles
assigned to users that does not exist in the app definition.
The roles of users.
The app defined roles.
Returns the roles info.
Builds the role names string.
Returns the role names.
Customer Balance
Customer Balance Detail
Aged Receivables
Aged Receivable Detail
Vendor Balance
Vendor Balance detail.
Aged Payables
Aged Payable detail.
Vendor Expenses
General Ledger
Item Sales
Customer Sales
Department Sales
Class Sales
Customer Income
Balance sheet
Profit and loss.
Profit and loss detail.
Trial Balance
Cash Flow
Inventory Valuation Summary
Account List
Transaction List
Report Query Base. Base class for all reports.
time
time specified
report Name
report basis specified
start period
end period
sumarizeColumnBy
currency
customer
vendor
employee
item
class
department
Optional
start page
chunk size
start transaction date
end transaction date
date macro
report basis
Gets or sets the value indicating the Start page.
Gets or sets the value indicating the Chunk size.
Gets or sets the value indicating the Start Transaction Date.
Gets or sets the value indicating the End Transaction Date.
Gets or sets the value indicating the Date Macro.
Specify the basis of the report, Cash or Accrual
time
time specified
report Name
report basis specified
start period
end period
sumarizeColumnBy
currency
customer
vendor
employee
item
class
department
Optional