WindowsEntityType

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

* Equity

Business Rules:

* The account name must be unique.

* The account name cannot contain a colon (:).

For details of the fields, and query: Account

Bill is an AP transaction representing a request-for-payment from a third party for goods/services rendered and/or received. Bill is a request for payment from the vendor for the goods or services that are rendered. You can enter a bill for your expenses or the items that you track as part of your business. An item is anything that your company buys, sells, or resells in the course of business. For example, products, shipping and handling charges, discounts, and sales tax. An expense is the amount of money that you spend on the items that you want to buy. Expenses are linked to expense accounts. For example, if you pay $200 per month for utilities, you can set up an expense account for these utilities, and assign the bill to this account.

Business Rules:

* If an account is provided in the header of the bill, it must be the Account Payable (AP) account.

* A bill must have reference to a vendor in the header.

* A bill must have at least one line that describes the item or account.

* A bill must have reference to an object.

For details of the fields, and query: Bill

Financial transaction representing a Payment by check issued to pay one or more bills received from 3rd party (vendor) for purchased goods or services.

Business Rules:

* If an account is provided in the header of the bill payment, it must be the Account Payable (AP) account.

* A bill payment must have reference to a vendor in the header.

* A bill payment must have reference to an object.

For details of the fields, and query: BillPayment

Financial transaction representing a Payment by credit card issued to pay one or more bills received from 3rd party (vendor) for purchased goods or services. Creates a BillPaymentCreditCard transaction, representing a payment by credit card against a bill issued for goods or services. If using with QuickBooks desktop versions, if you want to pay multiple bills, you must issue a separate request for each bill you want to pay. Also, if you are using more than one A/P account, make sure that the APAccount used in the BillPaymentCreditCard matches the APAccount that was used when the Bill was originally added.

For details of the fields, and query: BillPaymentCreditCard

Describes one component of the BOM (Bill of Materials), an Inventory Assembly Item.

For details of the fields, and query: BOMComponent

Transaction that adds Assembly Items to inventory. The assembly's components (identified by Line/ItemId) are deducted from inventory and the quantity of assembly items (identified by Header/ItemId) is increased accordingly. Note that while the QBSDK returns QuantityOnHand data for the assembly and the components of the assembly, Data Services does NOT. Quantity on hand data can be obtained by looking only at the Item object itself.

For details of the fields, and query: BuildAssembly

Financial transaction representing a request for payment for goods or services that have been sold.

For details of the fields, and query: Charge

Financial transaction representing a payment to a payee. When used together with a realm synchronized with a QuickBooks company, the IDS Check object maps to the QuickBooks Check. Upon synchronization with QuickBooks, the Check Create operation results in a new Check added to the QuickBooks register. The Check Create operation creates a Check similar to what a user might create in the QuickBooks "Write Checks" form. The Write Checks form can be reached in the QuickBooks UI by selecting Banking->Write Checks or by clicking on the Write Checks icon in the Home page. In the Check line items, you refer to an item via the ItemName field. That references automatically supplies the base unit of measure (UOM) for the item, and its description. You need only supply the quantity and unit price. At least one line item is required.

Business Rules:

* A check must have at least one line that describes the item or account.

* A check must have reference to a vendor in the header.

For details of the fields, and query: Check

Classes provide a way to track different segments of the business, and to break down the income and expenses for each segment. Classes provide a system for categorizing transactions that goes beyond the basic ways of assigning transactions to expense or income accounts. With classes, it is possible to categorize each detail line on a transaction. This allows the customer to write one check to the office supply store for things bought for two different business units and still track the business unit for those purchases.

* Example uses of classes:

* Department

* Enterprise

* Properties

* Work categories (plumbing, electrical, etc.)

* Manufacturers

* Partners

* Product Lines

For details of the fields, and query: Class

Reports information about the company, given the realm ID. The information is read-only through this API.

Financial transaction representing a charge for purchase of goods or services. The CreditCardCharge represents an expense to the business as a credit card charge transaction. The expense is of the following types:

Item based expense for the item that is purchased for reselling.

Account based expense for the amount spend on an account, such as expense incurred on "advertisement expense" account.

For details of the fields, and query: CreditCardCharge

Financial transaction representing a credit for purchase of goods or services.

For details of the fields, and query: CreditCardCredit

The CreditCardRefund object helps you to refund a sale transaction that involves the credit card of a customer. You can use this object to refund transactions such as invoice, sales receipt, and statement charge.

For details of the fields, and query: CreditCardRefund

Financial transaction representing a refund (or credit) of payment or part of a payment for goods or services that have been sold.

For details of the fields, and query: CreditMemo

The currency object contains all of the information needed to display and use a foreign currency. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the IsActive status. For user-defined currencies, every value in the object is editable including name and currency code.

For details of the fields, and query: CurrencyInfo

A customer is a consumer of the service or product that your business offers. The Customer object allows you to categorize customers according to your business requirements. For example, you can create a category of customers to indicate the industry that a customer represents, the geographic location of a customer, or the awareness of the business. Categorization of customers is useful for reports. While creating a customer, avoid entering any job data. If you enter a job data, the system can prevent you from adding any more jobs for that customer. You must first create a customer, and then create a job using that customer as a parent.

Business Rules:

* The customer name must be unique.

* The customer name must not contain a colon (:).

* The e-mail address of the customer must contain @ and . (dot).

* The customer address field is mandatory.

For details of the fields, and query: Customer

A standard message to a customer that can be included at the bottom of a sales form. A customer message or a customer message list appears at the bottom of a sales form. For example, you can create a thank you message using the CustomerMsg, and include this message in any invoice.

For details of the fields, and query: CustomerMsg

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.

For details of the fields, and query: CustomerType

Transaction recording the transfer of money from the Undeposited Funds account to the Bank account.

For details of the fields, and query: Deposit

Identifies the discount or allowance that the Customer is to receive off of the TotalAmount owed.

For details of the fields, and query: Discount

The Employee represents the persons who are working for the company.

Business Rules:

* The employee name must be unique.

* The employee name, first name, or last name must not contain a colon (:).

* The name, first name or last name field should not be blank.

* The e-mail, phone, and address fields are mandatory.

* The e-mail address of the employee must contain @ and . (dot).

* The value for the EmployeeType element must be either of the following: Officer, Owner, Regular, or Statutory.

* The value for the DeviceType element must be either of the following: Landline, Mobile, Fax, or Pager.

For details of the fields, and query: Employee

An estimate is a description of a sale that you propose to a current or prospective customer. An estimate contains a list of tasks that you can perform for, or products that you can provide to customers. An estimate is also called a bid or proposal. An estimate is a non-posting transaction that does not affect the balance sheet or income statement of a company.

Business Rules:

* An estimate must have at least one line that describes an item.

* An estimate must have a reference to a customer in the header.

* If you submit a query with the filter IncludeDiscountLineDetails, the system retrieves either DiscountAmount or DiscountRatePercent with associated values

For details of the fields, and query: Estimate

Fixed assets represent the business assets that you do not convert to cash within one year of operation. A fixed asset is usually integral to your business operations. For example, a truck, cash register, or computer.

Business Rules:

* If ItemID or ItemType are specified for a transaction, do not specify UnitPrice for the fixed asset.

For details of the fields, and query: FixedAsset

Financial transaction representing quantity or value adjustments of inventory items that either increase or decrease inventory for the specified items.

For details of the fields, and query: InventoryAdjustment

The InventorySite resource represents a location where inventory is stored.

Business Rules:

* The site name must be unique.

For details of the fields, and query: InventorySite

Transaction reflecting the movement of inventory assets between inventory sites.

For details of the fields, and query: InventoryTransfer

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. See SalesReceipt.

Note: You can now make Payments for Invoices that you created in Data Services and simultaneously synchronize them back to QuickBooks.

An invoice for QuickBooks 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.

In general, it is a good practice to specify all the QuickBooks 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.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:

* An invoice must have at least one line that describes the item.

* If an account is specified in the header, the account must be of the Accounts Receivable (AR) type.

* An invoice must have a reference to a customer in the header.

For details of the fields, and query: Invoice

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. An item helps you to fill the line item area of the sales or purchase form quickly. When you select an item from the item list, QuickBooks fills in a description of the line item and calculates the amount for you. An item is of the following types:

* Assembly Item: 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.

* Fixed Asset Item: 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.

* Group Item: The Group item helps you to quickly enter a group of individual items that you often purchase or sell together.

* Inventory Item: 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.

* Other Charge Item: The Other Charge item is used to charge customers for the mileage expense.

* Product Item: The Product item is used to record the sales information of a product.

* Payment Item: 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.

* Service Item: The Service item is used for the services that you charge on the purchase. For example, including specialized labor, consulting hours, and professional fees.

* Subtotal Item: 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.

Business Rules:

* The item name must be unique.

* The item type must not be NULL.

* The item cannot define both unit price and unit price percent simultaneously.

* For the Service, Product, and Other Charge items, you must specify the ID or name of the expense account or both.

* 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.

* For the Inventory and Assembly items, you must specify:

|--> * the ID or name of the income account or both

|--> * the ID or name of the cogs account or both

|--> * the ID or name of the asset account or both

* For the Group item, you must specify the tax ID or tax name or both.

* For the Fixed Asset item, you must:

|--> * set the asset account type to Asset

|--> * specify the purchase date

|--> * specify the ID or name of the income account or both

For details of the fields, and query: Invoice

ItemConsolidated provides efficient parity between QuickBooks and applications that depend on the Data Services Item types that are synchronized with the QuickBooks Item type. This object allows collaboration of the following objects:

* Item

* Discount

* FixedAssets

* SalesTax

* SalesTaxGroup.

For details of the fields, and query: ItemConsolidated

Describes one line of the Item Group.

For details of the fields, and query: ItemGroupComponent

ItemReceipt is an AP transaction representing the delivery of goods from a 3rd party. The Bill is expected to be received at a later date. You can use the ItemReceipt object to manage your Account Receivable transactions with third party vendors.

For details of the fields, and query: ItemReceipt

A job can be defined as a project, policy (insurance), or case (legal) according to your business. The Job object is a way to track larger orders, such as order placed by different departments within the same organization. You can use job types to track important information about your projects and jobs. Tracking the job types gives you an idea of the profitability of each job that you do. Tracking can also help you to determine the time that you spent on different types of projects or jobs. You can filter any project report based on the job type.

Business Rules:

* The job name must be unique.

* The job name must not contain a colon (:).

* Each job must have a valid customer ID or customer name reference.

* The job parent ID or job parent name must be valid.

For details of the fields, and query: Job

Job types allow 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.

For details of the fields, and query: JobType

Adds a Journal Entry. In traditional accounting, transactions are entered into the general journal and categorized exclusively by account. In QuickBooks, most transactions can be categorized either by account or by type (invoice, check, and so on). For a few activities in QuickBooks, you must use the general journal directly, for example for recording depreciation. Notice that you must supply the credit line and a corresponding debit line in the same request. It will not work to supply them in two distinct requests. You can supply as many credit lines and debit lines in one single request as you want so long as the total monetary amount from the credits equals the total monetary amount from the debits in that request. DO NOT supply negative sign for the monetary amounts.

Business Rules:

* The Line/PostingType attribute (either Credit or Debit) is required.

* The Line/Amount attribute may not be negative.

* Each request must have debits and credits.

For details of the fields, and query: JournalEntry

A name/value pair allows for clients including data that is meaningful in the domain of origin, outside of the Intuit domain.

For details of the fields, and query: NameValue

The OtherName object represents a person or a company that is not your customer, vendor, or employee. For example, you can use OtherName object to represent owners or partners.

For details of the fields, and query: OtherName

Payment is a financial transaction, in which a customer pays for the goods and services purchased. You can make Payments for Invoices that you created in Data Service and simultaneously synchronize them back to QuickBooks.

Business Rules:

* If an account is specified in the header, the account must be of the Accounts Receivable (AR) type.

* A payment must have a reference to a customer in the header

For details of the fields, and query: Payment

Payment methods provide information about the various ways through which a customer can make payment.

For details of the fields, and query: PaymentMethod

A payroll item (wage-based) is used to track individual amounts on a paycheck for wage, salary, commission, or bonus. You can assign these payroll items to various accounts. For non-wage based payroll items, such as taxes, saving plan (401K) contributions, or direct-deposit amounts, see PayrollNonWageItem.

For details of the fields, and query: PayrollItem

A non-wage payroll item is used to track individual amounts on a paycheck for taxes, saving plan (401K) contributions, direct-deposit amounts - items other than wage, salary, commission, or bonus. You can assign these payroll items to various accounts. For wage-based payroll items, see PayrollItem.

For details of the fields, and query: PayrollNonWageItem

PurchaseOrder is a non-posting transaction representing a request to purchase goods or services from a third party. You can use ItemReceipt Create to receive items against a purchase order as items arrive from the vendor. A purchase order is a non-posting transaction, so it does not affect a company's balance sheet or income statement.

For details of the fields, and query: PayrollNonWageItem

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.

Business Rules:

* A sales order must have at least one line that describes the item.

* A sales order must have a reference to a customer in the header.

* If you submit a query with the filter IncludeDiscountLineDetails, the system retrieves either DiscountAmount or DiscountRatePercent with associated values

For details of the fields, and query: SalesOrder

A sales receipt is a financial transaction that represents the sale of goods or services where payment in full is received at the time of purchase. Do not use a sales receipt if customers pay in part at the time of purchase; instead, use an invoice. The Invoice object offers more options than the SalesReceipt, and because a customer name is required for an invoice but not a sales receipt, use the Invoice object to keep track of payments owed on a purchase.

Business Rules:

* A sales receipt must have at least one line that describes the item.

* A sales receipt must have a reference to a customer in the header.

* If an account is specified in the header, the account must be of the Accounts Receivable (AR) type.

* If you submit a query with the filter IncludeDiscountLineDetails, the system retrieves either DiscountAmount or DiscountRatePercent with associated values.

Note: The PONumber field in a sales receipt is removed after synchronization, as QBSDK does not support it.

For details of the fields, and query: SalesReceipt

The SalesRep object 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.

For details of the fields, and query: SalesRep

You can use the SalesTax object to manage the sales tax that you collect on behalf of the state or any other government agency, after completing a sales transaction.

Business Rules:

* If ItemID or ItemType are specified for a transaction, do not specify the following parameters for the sales tax: UnitPrice, Quantity.

For details of the fields, and query: SalesTax

A sales 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.

For details of the fields, and query: SalesTaxCode

Collection of Sales taxes which the business must collect on behalf of one or more state or government agencies when a sales transaction is completed.

For details of the fields, and query: SalesTaxGroup

The SalesTerm object represents the terms under which a sale is made, typically expressed in the form of days due after the goods are received. There is an optional discount part of the sales term, where a discount of total amount can automatically be applied if payment is made within the stipulated time.

For example, net 30 indicates that you must make the payment within 30 days; 2%/15 net 60 indicates that you must make the payment within 60 days, and you can get a discount of 2% if you make payment within 15 days. SalesTerm also supports the ability to specify the absolute due date, a number of days from a start date, a percent discount, or an absolute discount.

The SalesTerm name itself is a text-only attribute and the desired application of the sales term must be coded. For example, a common term such as Net30Days is explicitly coded as a calculated DueDateTime or as a PaymentTermsDateTime and NumberOfDays.

For details of the fields, and query: SalesTerm

You can use the ShipMethod object to specify a method to ship the goods that are purchased or sold. For example, you can specify a method to ship goods to your customers when you make a sales transaction.

For details of the fields, and query: ShipMethod

A specific task to be completed, maps to a ToDo record in QuickBooks.

For details of the fields, and query: Task

The name of a template used for a specific form presentation.

For details of the fields, and query: TemplateName

A record of time worked by a vendor or employee. A time activity records the time taken to complete a particular task. Professional service firms can track time for the following reasons:

* To know the tasks of a person and the time spent on various projects, and to use this information for job costing.

* To bill the clients using standard service item rates or custom billing rates.

* To view and quickly access the unbilled time or expenses for a customer.

* To view the number of unbilled hours in the project for each client in reports.

* To use the stopwatch to record the time for a current activity. For example, when you answer a phone call from a client.

* To preview the time records and paychecks of your employees when you pay your employees.

* To pay non-employees (owners, partners, subcontractors, and vendors) for the number of hours they work.

Business Rules:

* If you modify the time activity records that are more than 5 years old, an error occurs.

* The value of the NameOf element must be Employee or Vendor.

* The value of the BillableStatus element must be Billable or HasBeenBillable. The default value is Billable.

* The default value of the Taxable element is set to True.

* Both the Hours and Minutes elements are either positive or negative.

For details of the fields, and query: TimeActivity

You can use the UOM (Unit of Measure) object to represent data such as quantities, prices, rates, and costs, in units. This object also helps you to convert these units to related units. 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.

For details of the fields, and query: UOM

You can use the Vendor object to store information about the people and companies you do business with. A vendor is an individual or an organization that provides goods and services to a customer. For example, banks and tax agencies.

Business Rules:

* The vendor name must be unique.

* The name, first name, and last name of the vendor must not contain a colon (:).

* The name, first name, or last name field should not be blank.

* The e-mail address of the vendor must contain @ and . (dot).

For details of the fields, and query: Vendor

VendorCredit is an AP transaction representing a credit from a third party for returned goods or services not rendered. In QuickBooks desktop versions, a vendor credit is also known as a "bill credit". That is, it is a credit that a vendor owes you because you overpaid your bill, returned merchandise, or for some other reason. The VendorCredit is not applied until it is referenced in a Bill Payment transaction.

Note: A VendorCredit should not be confused with a Credit Memo, which is something you owe your customer.

For details of the fields, and query: VendorCredit

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. You can also create a vendor type as a subtype of another vendor type.

For details of the fields, and query: VendorType

Answers the resource name of this entity type as present in the entity uri