QuickBooks Integrator 2020 iOS Edition

Questions / Feedback?

Bill Class

Properties   Methods   Events   Configuration Settings   Errors  

A Bill indicates that the QuickBooks company owes money to a VENDOR . A Bill is the opposite of a VENDORCREDIT .

Syntax

InQBBill
InQBBillSwift

Remarks

The Bill class represents a bill received from a Vendor. When a bill is added, the total amount is automatically entered into the Accounts Payable register.

Required Fields (Add): Vendor*, TransactionDate, Items or Expenses

Supported Methods: Add, Get (Id), Cancel, Delete

Example

Bill1.VendorName = "ACME Inc."            '*
Bill1.TransactionDate = "1/17/03"
Bill1.DueDate = "2/01/03"
Bill1.ItemCount = 1
Bill1.ItemName(0) = "ACME Widget X"  '*
Bill1.ItemAmount(0) = "299.95"
Bill1.ExpenseCount = 1
Bill1.ExpenseAccountName(0) = "Shipping"       '*
Bill1.ExpenseAmount(0) = "12.00"
Bill1.Add()

'*: Item must already exist in QuickBooks.

Amount is the total of the item lines and (if present) expense lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the purchase of goods or services. Line items may be added by first setting ItemCount. Then, for each line set the Item ID (or Name), Cost, Quantity, Description, Class, Customer, and Amount.

Note: For advanced users, the entire XML item structure may be set and retrieved through the Item's Aggregate property. However, it is up to the developer to ensure that this aggregate is formatted correctly.

Expense Lines: Expense lines are used to track portions of the total amount to expense accounts. To add expense lines to the transaction, first set ExpenseCount. This will initialize the Expenses array. Each expense will be tracked to the account specified in ExpenseAccount. The ExpenseAmount should also be specified for each expense; optionally, the ExpenseClass, ExpenseCustomer, and ExpenseMemo properties may be set as well.

The class supports a variety of other operations as well. The class's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete Bills, respectively. The ObjSearch Class may be used to search for Bills in the QuickBooks database.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

- amountAmount of transaction.
- APAccountIdReference to the Accounts Payable account where money goes.
- APAccountNameReference to the Accounts Payable account.
- dueDateDate when payment is due.
- expenseCountThe number of records in the Expense arrays.
- expenseAccountId:(int)expenseIndexA reference to the account to which this expense is be charged.
- expenseAccountName:(int)expenseIndexA reference to the account to which this expense is be charged.
- expenseAmount:(int)expenseIndexThe total amount of this expense line.
- expenseBillableStatus:(int)expenseIndexThe billing status of this expense line.
- expenseClassId:(int)expenseIndexA reference to the class of this expense.
- expenseClassName:(int)expenseIndexA reference to the class of this expense.
- expenseCustomerId:(int)expenseIndexThe customer associated with this expense line.
- expenseCustomerName:(int)expenseIndexThe customer associated with this expense line.
- expenseLineId:(int)expenseIndexIdentification number of the expense line, used for Updates.
- expenseMemo:(int)expenseIndexA memo for this expense line, which will appear to the QuickBooks user only.
- expenseTaxCodeId:(int)expenseIndexLine item property: Sales tax information for this item.
- expenseTaxCodeName:(int)expenseIndexLine item property: Sales tax information for this item.
- includeLinkedTxnsIndicates whether to include linked transactions in the response.
- isPaidIndicates whether this bill has been paid.
- itemCountThe number of records in the Item arrays.
- itemAggregate:(int)itemIndexContains an XML aggregate of the line item.
- itemAmount:(int)itemIndexLine item property: the total amount of this item.
- itemBillableStatus:(int)itemIndexLine item property: Billing status of this item.
- itemClassId:(int)itemIndexLine item property: Reference to the class of the item.
- itemClassName:(int)itemIndexLine item property: Reference to the class of the item.
- itemCost:(int)itemIndexLine item property: Unit cost for item.
- itemCustomerId:(int)itemIndexLine item property: A reference to customer for whom the item was ordered.
- itemCustomerName:(int)itemIndexLine item property: A reference to customer for whom the item was ordered.
- itemDescription:(int)itemIndexLine item property: Description of item.
- itemGroupId:(int)itemIndexReference to a group of line items.
- itemGroupName:(int)itemIndexReference to a group of line items.
- itemId:(int)itemIndexLine item property: Reference to the kind of item.
- itemName:(int)itemIndexLine item property: Reference to the kind of item.
- itemLineId:(int)itemIndexIdentification number of the transaction line, used for Updates.
- itemOverrideAccountId:(int)itemIndexAn account which will override the default account for the line item.
- itemOverrideAccountName:(int)itemIndexAn account which will override the default account for the line item.
- itemQuantity:(int)itemIndexLine item property: Quantity of item or item group.
- itemTaxCodeId:(int)itemIndexLine item property: Sales tax information for this item.
- itemTaxCodeName:(int)itemIndexLine item property: Sales tax information for this item.
- itemUnitOfMeasure:(int)itemIndexUnit of measure describing the Quantity .
- linkedTxnCountThe number of records in the LinkedTxn arrays.
- linkedTxnAmount:(int)linkedTxnIndexThe amount of the linked transaction.
- linkedTxnDate:(int)linkedTxnIndexThe date of the linked transaction.
- linkedTxnLinkType:(int)linkedTxnIndexIndicates the nature of the link between the transactions.
- linkedTxnRefNumber:(int)linkedTxnIndexThis is the reference number assigned to the linked transaction.
- linkedTxnId:(int)linkedTxnIndexThis property can be used by another class to reference the original transaction which is linked to the current response.
- linkedTxnType:(int)linkedTxnIndexThis property indicates which type of linked transaction has been returned.
- linkToTxnIdThe LinkToTxnId property allows you to link to an entire transaction, pulling in all of its line items.
- memoMemo to appear on internal reports only.
- QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
- QBRequestAggregateThe request aggregate.
- QBRequestIdThe Id of the next message to be sent to QuickBooks.
- QBRequestModeDefines whether the request is made online or stored offline.
- QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
- QBXMLVersionThe version of QBXML used in the outgoing message.
- refIdAn alphanumerical identifier generated by the server.
- refNumberReference number for the transaction.
- termsIdReference to terms of payment.
- termsNameReference to terms of payment.
- transactionDateDate of transaction.
- vendorIdReference to the vendor for this transaction.
- vendorNameReference to the vendor for this transaction.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

- addAdds the record into QuickBooks.
- cancelCancels (voids) the transaction.
- checkRequestStatusChecks whether or not the specified request was processed by QuickBooks.
- closeQBConnectionCloses a persistent connection to QuickBooks.
- configSets or retrieves a configuration setting.
- deleteDeletes the record from QuickBooks.
- getGets a single record from QuickBooks.
- getCustomFieldGets a custom field value from QuickBooks.
- importQBXMLImports a QBXML response aggregate.
- openQBConnectionOpens a persistent connection to QuickBooks.
- resetResets all properties to their defaults.
- setCustomFieldSets a custom field value within QuickBooks.
- updateUpdates the bill in QuickBooks.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

- onErrorInformation about errors during data delivery.
- onSSLServerAuthenticationFired after the server presents its certificate to the client.
- onSSLStatusShows the progress of the secure connection.
- onStatusShows the progress of the QuickBooks connection.
- onWarningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateIndicates the exchange rate for the transaction.
ExpenseLineAggregate[index]Contains the XML aggregate of the expense line item.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
Items[index].OverrideItemAccountIdAn account which will override the default account for the line item.
Items[index].OverrideItemAccountNameAn account which will override the default account for the line item.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 iOS Edition - Version 20.0 [Build 7941]