Invoice Component

Properties   Methods   Events   Config Settings   Errors  

An Invoice indicates that a owes money to the QuickBooks company. An Invoice is the opposite of a .

Syntax

DPayments.InQB.Invoice

Remarks

The Invoice component represents an invoice sent to a Customer. When an invoice is added, the total amount is automatically entered into the Accounts Receivable register.

An Invoice should only be used if the Customer does not make payment at the time of the sale. If payment is made at the time of sale, the transaction should be recorded as a SalesReceipt instead.

Required Fields (Add): Customer*, Items

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

Example Invoice1.CustomerName = "John Q. Customer" '* Invoice1.TransactionDate = "1/17/03" Invoice1.LineItems.Add(New InvoiceItem()) Invoice1.LineItems(0).ItemName = "Our Company's Product" '* Invoice1.LineItems(0).Amount = "140.00" Invoice1.ShipDate = "1/20/03" Invoice1.Add() '*: Item must already exist in QuickBooks.

The total of an Invoice is the total of its item lines. There is no total amount property; when the component represents an invoice returned from QuickBooks, the total amount is divided between AppliedAmount and BalanceRemaining.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AppliedAmount Property (Invoice Component)

Amount customer has paid on this invoice.

Syntax

• C#
• VB.NET

public string AppliedAmount { get; }

Public ReadOnly Property AppliedAmount As String

Default Value

""

Remarks

The amount the Customer (see CustomerName) has paid on this invoice.

The amount should be formatted as a string in dollars.

This property is read-only.

ARAccountId Property (Invoice Component)

Reference to the Accounts Receivable account where money goes.

Syntax

• C#
• VB.NET

public string ARAccountId { get; set; }

Public Property ARAccountId As String

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ARAccountName Property (Invoice Component)

Reference to the Accounts Receivable account where money goes.

Syntax

• C#
• VB.NET

public string ARAccountName { get; set; }

Public Property ARAccountName As String

Default Value

""

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

BalanceRemaining Property (Invoice Component)

Balance remaining.

Syntax

• C#
• VB.NET

public string BalanceRemaining { get; }

Public ReadOnly Property BalanceRemaining As String

Default Value

""

Remarks

The balance remaining on the invoice. Is equal to

Subtotal + SalesTaxTotal - AppliedAmount.

The amount should be formatted as a string in dollars.

This property is read-only.

BillingAddress Property (Invoice Component)

Address to bill to.

Syntax

• C#
• VB.NET

public string BillingAddress { get; set; }

Public Property BillingAddress As String

Default Value

""

Remarks

The address to bill to.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

CustomerId Property (Invoice Component)

A reference to the customer or customer job.

Syntax

• C#
• VB.NET

public string CustomerId { get; set; }

Public Property CustomerId As String

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Either CustomerId or CustomerName is required.

CustomerMessageId Property (Invoice Component)

Reference to message to appear to customer.

Syntax

• C#
• VB.NET

public string CustomerMessageId { get; set; }

Public Property CustomerMessageId As String

Default Value

""

Remarks

A reference to a predefined message that will appear to the customer.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

CustomerMessageName Property (Invoice Component)

Reference to message to appear to customer.

Syntax

• C#
• VB.NET

public string CustomerMessageName { get; set; }

Public Property CustomerMessageName As String

Default Value

""

Remarks

A reference to a predefined message that will appear to the customer.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

CustomerName Property (Invoice Component)

A reference to the customer or customer job.

Syntax

• C#
• VB.NET

public string CustomerName { get; set; }

Public Property CustomerName As String

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Either CustomerId or CustomerName is required.

DueDate Property (Invoice Component)

Date when payment is due.

Syntax

• C#
• VB.NET

public string DueDate { get; set; }

Public Property DueDate As String

Default Value

""

Remarks

Appears in a variety of transactions. The date when payment is due.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

FinanceCharge Property (Invoice Component)

If true, this invoice includes a finance charge.

Syntax

• C#
• VB.NET

public InvoiceFinanceCharges FinanceCharge { get; set; }

enum InvoiceFinanceCharges {
  fcNotSet,
  fcIsFinanceCharge,
  fcNotFinanceCharge
}

Public Property FinanceCharge As InvoiceFinanceCharges

Enum InvoiceFinanceCharges
  fcNotSet
  fcIsFinanceCharge
  fcNotFinanceCharge
End Enum

Default Value

0

Remarks

Indicates whether a finance-charge item has been added to this invoice. This property is determined by QuickBooks and is read-only when QBXMLVersion is less than "8.0".

IncludeLinkedTxns Property (Invoice Component)

Indicates whether to include linked transactions in the response.

Syntax

• C#
• VB.NET

public bool IncludeLinkedTxns { get; set; }

Public Property IncludeLinkedTxns As Boolean

Default Value

False

Remarks

If you set IncludeLinkedTxns to true, then the returned object will include a list of all the transactions linked to the queried object (this list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items). Each linked transaction will be represented by a LinkedTxn aggregate, which will be parsed by the component into the LinkedTxns property.

IsPaid Property (Invoice Component)

Indicates whether this invoice has been paid.

Syntax

• C#
• VB.NET

public bool IsPaid { get; }

Public ReadOnly Property IsPaid As Boolean

Default Value

False

Remarks

This property is only returned if the QBXMLVersion is set to "2.0" or higher.

This property is read-only.

IsPending Property (Invoice Component)

If true, this transaction has not been completed.

Syntax

• C#
• VB.NET

public bool IsPending { get; set; }

Public Property IsPending As Boolean

Default Value

False

Remarks

If set to true, this transaction (an Invoice, SalesReceipt, or CreditMemo) has not been completed. Pending sales might include unpaid orders, sales of back-ordered items, etc.

IsToBePrinted Property (Invoice Component)

Whether this transaction is to be printed.

Syntax

• C#
• VB.NET

public bool IsToBePrinted { get; set; }

Public Property IsToBePrinted As Boolean

Default Value

False

Remarks

Indicates whether or not the transaction is to be printed. If set to true, the "To Be Printed" box in the QuickBooks user interface will be checked.

LineItems Property (Invoice Component)

Collection of line items.

Syntax

• C#
• VB.NET

public InvoiceItemList LineItems { get; }

Public Property LineItems As InvoiceItemList

Remarks

A Line Item is used to track any portion of a transaction that represents the purchase of an "item".

This property is not available at design time.

LinkedTxns Property (Invoice Component)

Information used to reference a transaction that is linked to the existing transaction.

Syntax

• C#
• VB.NET

public LinkedTransactionList LinkedTxns { get; }

Public ReadOnly Property LinkedTxns As LinkedTransactionList

Remarks

This property can be used to reference the original transaction which is linked to the current response. Simply set the Id property of the appropriate component (based on the TxnType field) and call the Get method.

This property is read-only and not available at design time.

LinkToTxnId Property (Invoice Component)

The LinkToTxnId property allows you to link to an entire transaction, pulling in all of its line items.

Syntax

• C#
• VB.NET

public string LinkToTxnId { get; set; }

Public Property LinkToTxnId As String

Default Value

""

Remarks

When used in the Invoice component, the transaction you are linking to via this field must be a Sales Order. Links to other transactions, such as to estimates, are not currently supported. The use of this property requires QBXMLVersion on the Invoice to be "6.0" or greater.

When used with the Bill or ItemReceipt components, the transaction you are linking to via this field must be a Purchase Order. Links to other transactions are not currently supported. The use of this property requires QBXMLVersion on the Bill or ItemReceipt to be "4.0" or greater.

You will get a runtime error if the transaction specified by LinkToTxnId is already closed or fully received and the request does not contain any other lines. You will also get an error if you attempt to save an empty transaction.

Memo Property (Invoice Component)

Memo to appear on internal reports only.

Syntax

• C#
• VB.NET

public string Memo { get; set; }

Public Property Memo As String

Default Value

""

Remarks

A memo to appear on internal reports. Will not appear to customers, vendors, etc.

PONumber Property (Invoice Component)

P.O. number.

Syntax

• C#
• VB.NET

public string PONumber { get; set; }

Public Property PONumber As String

Default Value

""

Remarks

The P.O. number for this invoice or credit memo.

QBConnectionString Property (Invoice Component)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C#
• VB.NET

public string QBConnectionString { get; set; }

Public Property QBConnectionString As String

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

QBRequestAggregate Property (Invoice Component)

The request aggregate.

Syntax

• C#
• VB.NET

public string QBRequestAggregate { get; set; }

Public Property QBRequestAggregate As String

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer component to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

QBRequestId Property (Invoice Component)

The Id of the next message to be sent to QuickBooks.

Syntax

• C#
• VB.NET

public string QBRequestId { get; set; }

Public Property QBRequestId As String

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

QBRequestMode Property (Invoice Component)

Defines whether the request is made online or stored offline.

Syntax

• C#
• VB.NET

public InvoiceQBRequestModes QBRequestMode { get; set; }

enum InvoiceQBRequestModes {
  rmOnline,
  rmOffline
}

Public Property QBRequestMode As InvoiceQBRequestModes

Enum InvoiceQBRequestModes
  rmOnline
  rmOffline
End Enum

Default Value

0

Remarks

This property defines the behavior of the component when calling a method. Possible values are:

The use of offline mode is required when using the QBWCServer component. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer component.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

QBResponseAggregate Property (Invoice Component)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C#
• VB.NET

public string QBResponseAggregate { get; set; }

Public Property QBResponseAggregate As String

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the component will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

QBXMLVersion Property (Invoice Component)

The version of QBXML used in the outgoing message.

Syntax

• C#
• VB.NET

public string QBXMLVersion { get; set; }

Public Property QBXMLVersion As String

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

RefId Property (Invoice Component)

An alphanumerical identifier generated by the server.

Syntax

• C#
• VB.NET

public string RefId { get; }

Public ReadOnly Property RefId As String

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only and not available at design time.

RefNumber Property (Invoice Component)

Reference number for the transaction.

Syntax

• C#
• VB.NET

public string RefNumber { get; set; }

Public Property RefNumber As String

Default Value

""

Remarks

This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.

SalesRepId Property (Invoice Component)

Reference to (initials of) sales rep.

Syntax

• C#
• VB.NET

public string SalesRepId { get; set; }

Public Property SalesRepId As String

Default Value

""

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

This property appears in the Customer component as well as some transaction components. When found in a Customer component this property is unsupported for Update operations.

SalesRepName Property (Invoice Component)

Reference to (initials of) sales rep.

Syntax

• C#
• VB.NET

public string SalesRepName { get; set; }

Public Property SalesRepName As String

Default Value

""

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

This property appears in the Customer component as well as some transaction components. When found in a Customer component this property is unsupported for Update operations.

SalesTaxTotal Property (Invoice Component)

Total amount of sales tax.

Syntax

• C#
• VB.NET

public string SalesTaxTotal { get; }

Public ReadOnly Property SalesTaxTotal As String

Default Value

""

Remarks

The total amount of sales tax charged in this transaction.

Not used with Canadian editions of QuickBooks.

The amount should be formatted as a string in dollars.

This property is read-only.

ShipDate Property (Invoice Component)

Date of shipping.

Syntax

• C#
• VB.NET

public string ShipDate { get; set; }

Public Property ShipDate As String

Default Value

""

Remarks

The date when goods were, or will be, shipped to the Customer.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

ShipMethodId Property (Invoice Component)

Reference to preferred method of shipping.

Syntax

• C#
• VB.NET

public string ShipMethodId { get; set; }

Public Property ShipMethodId As String

Default Value

""

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ShipMethodName Property (Invoice Component)

Reference to preferred method of shipping.

Syntax

• C#
• VB.NET

public string ShipMethodName { get; set; }

Public Property ShipMethodName As String

Default Value

""

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

ShippingAddress Property (Invoice Component)

Address to ship to.

Syntax

• C#
• VB.NET

public string ShippingAddress { get; set; }

Public Property ShippingAddress As String

Default Value

""

Remarks

The address to whom goods were shipped, or are to be shipped.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

Subtotal Property (Invoice Component)

Gross subtotal; doesn't count taxes/amount already paid.

Syntax

• C#
• VB.NET

public string Subtotal { get; }

Public ReadOnly Property Subtotal As String

Default Value

""

Remarks

The total of the amounts in all the lines of an invoice, credit memo, or sales receipt, before taxes or payments are applied.

The amount should be formatted as a string in dollars.

This property is read-only.

TaxItemId Property (Invoice Component)

Reference to detailed taxation information.

Syntax

• C#
• VB.NET

public string TaxItemId { get; set; }

Public Property TaxItemId As String

Default Value

""

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

This property appears in the Customer component as well as some transaction components. When found in a Customer component this property is unsupported for Update operations.

Not used with Canadian editions of QuickBooks.

TaxItemName Property (Invoice Component)

Reference to detailed taxation information.

Syntax

• C#
• VB.NET

public string TaxItemName { get; set; }

Public Property TaxItemName As String

Default Value

""

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

This property appears in the Customer component as well as some transaction components. When found in a Customer component this property is unsupported for Update operations.

TemplateId Property (Invoice Component)

Specifies how to print Invoice transactions.

Syntax

• C#
• VB.NET

public string TemplateId { get; set; }

Public Property TemplateId As String

Default Value

""

Remarks

QuickBooks templates specify how to print certain transactions. A TemplateId or TemplateName refers to one of these templates.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

TemplateName Property (Invoice Component)

Specifies how to print Invoice transactions.

Syntax

• C#
• VB.NET

public string TemplateName { get; set; }

Public Property TemplateName As String

Default Value

""

Remarks

QuickBooks templates specify how to print certain transactions. A TemplateId or TemplateName refers to one of these templates.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

TermsId Property (Invoice Component)

Reference to terms of payment.

Syntax

• C#
• VB.NET

public string TermsId { get; set; }

Public Property TermsId As String

Default Value

""

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

TermsName Property (Invoice Component)

Reference to terms of payment.

Syntax

• C#
• VB.NET

public string TermsName { get; set; }

Public Property TermsName As String

Default Value

""

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

TransactionDate Property (Invoice Component)

Date of transaction.

Syntax

• C#
• VB.NET

public string TransactionDate { get; set; }

Public Property TransactionDate As String

Default Value

""

Remarks

The date of the transaction.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

Add Method (Invoice Component)

Adds the record into QuickBooks.

Syntax

• C#
• VB.NET

public void Add();

Public Sub Add()

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Cancel Method (Invoice Component)

Cancels (voids) the transaction.

Syntax

• C#
• VB.NET

public void Cancel();

Public Sub Cancel()

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by RefId. If the value of RefId is known then Get should first be called to retrieve the transaction. Otherwise the ObjSearch component should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of RefId should first be stored, and then Get should be called.

CheckRequestStatus Method (Invoice Component)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C#
• VB.NET

public string CheckRequestStatus(string requestId);

Public Function CheckRequestStatus(ByVal RequestId As String) As String

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

CloseQBConnection Method (Invoice Component)

Closes a persistent connection to QuickBooks.

Syntax

• C#
• VB.NET

public void CloseQBConnection();

Public Sub CloseQBConnection()

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the component will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Config Method (Invoice Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Delete Method (Invoice Component)

Deletes the record from QuickBooks.

Syntax

• C#
• VB.NET

public void Delete();

Public Sub Delete()

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Get Method (Invoice Component)

Gets a single record from QuickBooks.

Syntax

• C#
• VB.NET

public void Get(string id);

Public Sub Get(ByVal Id As String)

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the component will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any component, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch component may be used.

GetCustomField Method (Invoice Component)

Gets a custom field value from QuickBooks.

Syntax

• C#
• VB.NET

public string GetCustomField(string fieldName);

Public Function GetCustomField(ByVal FieldName As String) As String

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

ImportQBXML Method (Invoice Component)

Imports a QBXML response aggregate.

Syntax

• C#
• VB.NET

public void ImportQBXML(string XMLData);

Public Sub ImportQBXML(ByVal XMLData As String)

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the component will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

OpenQBConnection Method (Invoice Component)

Opens a persistent connection to QuickBooks.

Syntax

• C#
• VB.NET

public void OpenQBConnection();

Public Sub OpenQBConnection()

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the component communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Reset Method (Invoice Component)

Resets all properties to their defaults.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the component may be reused as if it were newly created.

SetCustomField Method (Invoice Component)

Sets a custom field value within QuickBooks.

Syntax

• C#
• VB.NET

public void SetCustomField(string fieldName, string fieldValue);

Public Sub SetCustomField(ByVal FieldName As String, ByVal FieldValue As String)

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Update Method (Invoice Component)

Updates the invoice in QuickBooks.

Syntax

• C#
• VB.NET

public void Update();

Public Sub Update()

Remarks

This method will update the invoice in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The invoice will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "2.1" or greater to update an invoice. Moreover, QBXMLVersion should be set to the same value when retrieving the invoice from QuickBooks (either through ObjSearch or through the Get method).

Error Event (Invoice Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, InvoiceErrorEventArgs e);

public class InvoiceErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As InvoiceErrorEventArgs)

Public Class InvoiceErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (Invoice Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, InvoiceSSLServerAuthenticationEventArgs e);

public class InvoiceSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As InvoiceSSLServerAuthenticationEventArgs)

Public Class InvoiceSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Invoice Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, InvoiceSSLStatusEventArgs e);

public class InvoiceSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As InvoiceSSLStatusEventArgs)

Public Class InvoiceSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (Invoice Component)

Shows the progress of the QuickBooks connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, InvoiceStatusEventArgs e);

public class InvoiceStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As InvoiceStatusEventArgs)

Public Class InvoiceStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (Invoice Component)

Fired when a warning occurs.

Syntax

• C#
• VB.NET

public event OnWarningHandler OnWarning;

public delegate void OnWarningHandler(object sender, InvoiceWarningEventArgs e);

public class InvoiceWarningEventArgs : EventArgs {
  public int Code { get; }
  public string Description { get; }
}

Public Event OnWarning As OnWarningHandler

Public Delegate Sub OnWarningHandler(sender As Object, e As InvoiceWarningEventArgs)

Public Class InvoiceWarningEventArgs Inherits EventArgs
  Public ReadOnly Property Code As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Warning event is fired when the component has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the component. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Unlisted QuickBooks warnings will cause the component to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

InvoiceItem Type

A single invoice line item.

Remarks

This type of line item is used by the Invoice component.

Fields

Constructors

• C#
• VB.NET

public InvoiceItem();

Public InvoiceItem()

LinkedTransaction Type

A reference to an existing transaction in QuickBooks.

Remarks

A component may link to transactions which already exist in QuickBooks. This type contains information about those linked transactions.

Fields

Constructors

• C#
• VB.NET

public LinkedTransaction();

Public LinkedTransaction()

Config Settings (Invoice Component)

Invoice Config Settings

Base Config Settings

Trappable Errors (Invoice Component)

The following errors may be generated by the component. Note that frequently the error message will contain more specific information than what is listed here.

Invoice Errors

	101   String too long.
	103   Invalid date format (YYYY-MM-DD is standard).
	104   Invalid value for enumerated field.
	105   Invalid integer.
	106   Invalid dollar amount.
	107   Invalid boolean value (must be 'true' or 'false').
	108   Invalid number.
	111   Invalid special characters in string.
	112   Invalid special field syntax.
	181   Could not load certificate file.
	201   Required field unspecified.
	211   Unsupported field specified.
	301   Array line count must be nonnegative.
	302   Array index out of bounds.
	303   Invalid field index.
	401   Field not accessible as a special field.
	402   Write access attempted of readonly field.
	403   Read access attempted of writeonly field.
	421   The object cannot be modified.
	511   The QBRequestId has been previously used. Please generate a new one.
	601   Could not access QuickBooks.
	602   Could not open specified file.
	603   The version of QuickBooks currently being used is not supported.
	604   QuickBooks has not been installed properly.
	605   The specified file was of an incorrect version.
	606   Could not start QuickBooks.
	607   QuickBooks is open in a mode different than the one requested.
	608   QuickBooks cannot currently be accessed.
	609   An application name must be specified.
	610   A file name must be specified if one is not currently open in QuickBooks.
	611   Access denied.
	612   QuickBooks is busy and cannot open your application in the mode requested.
	699   The connection to QuickBooks has failed for an unknown reason.
	702   The object requested does not exist in QuickBooks.
	751   Unsupported QBXML version.
	752   The QBXMLVersion chosen is insufficient to execute the request.
	801   A QuickBooks internal error has occurred.
	802   QuickBooks is not available due to a system-related problem.
	803   The Id specified is invalid.
	804   Invalid object name.
	805   The name already exists in QuickBooks.
	807   An object could not be found in QuickBooks.
	808   A reference did not refer to an object that exists in QuickBooks.
	809   The object is currently in use by the QuickBooks end user.
	810   The object may not be added.
	811   The object may not be updated because it is obsolete.
	812   The address is invalid.
	813   Permission to perform this operation is not granted.
	814   The request has not been processed.
	815   Time creation mismatch.
	816   The feature is turned off or not enabled.
	817   Permission level configured is insufficient for access.
	818    The item specified was of an unknown type.
	819   The object may not be changed.
	820   An internal QuickBooks error has occurred.
	821   An attempt was made to use a connection that was not properly initiated.
	822   An attempt was made to use a connection that is invalid or was previously closed.
	823   Not enough memory.
	824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861   Server error on WebExport (details follow).
	862   The WebExport is impossible: an HTTP context was not found.
	871   You may not set the value of QBConnectionTicket. This value is readonly.
	880   Interrupted by the user.
	881   An error has occurred connecting to a remote machine.
	899   An unknown QuickBooks error has occurred. The message contains more details.
	901   XML Parser Error. Should not occur under normal circumstances.