Invoices

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

Id [KEY]

String

True

true

The Id of the invoice.

SyncToken

String

True

false

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime

Datetime

True

true

The time the record was created.

MetaData_LastUpdatedTime

Datetime

True

true

The time the record was last updated.

CustomFieldAggregate

String

False

false

An XML aggregate of custom field information.

DocNumber

String

False

true

The reference number for the transaction.

TxnDate

Date

False

true

The date entered by the user when this transaction occurred.

PrivateNote

String

False

false

A private note that does not appear on the transaction records.

TxnStatus

String

False

false

The status of the transaction.

The allowed values are Accepted, Closed, Pending, Rejected.

LinkedTxnAggregate

String

False

false

An XML aggregate of transactions linked to the estimate.

LineAggregate

String

False

false

An XML aggregate of line items associated with the transaction.

TxnTaxDetail_TxnTaxCodeRef

String

False

TaxCodes.Id

false

The tax code of the transaction.

TxnTaxDetail_TotalTax

String

False

false

Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate

String

False

false

An XML aggregate of tax line items.

CustomerRef

String

False

Customers.Id

true

false

The Id of the customer.

CustomerRef_Name

String

True

Customers.DisplayName

false

The name of the customer.

CustomerMemo

String

False

false

The message to the customer that appears in the invoice and in the printed invoice.

BillAddr_Id

String

False

false

The Id of the entity for the billing address, mainly used for modifying the address. This field is assigned by the data service.

BillAddr_Line1

String

False

false

First line of the address.

BillAddr_Line2

String

False

false

Second line of the address.

BillAddr_Line3

String

False

false

Third line of the address.

BillAddr_Line4

String

False

false

Fourth line of the address.

BillAddr_Line5

String

False

false

Fifth line of the address.

BillAddr_City

String

False

false

City name.

BillAddr_Country

String

False

false

Country name.

BillAddr_CountrySubDivisionCode

String

False

false

Region within a country. For example, the state name for the USA or the province name for Canada.

BillAddr_PostalCode

String

False

false

Postal code. For example, the zip code for the USA and Canada.

BillAddr_Note

String

False

false

Note for the customer.

BillAddr_Lat

String

False

false

The latitude coordinate of the geocoded billing address.

BillAddr_Long

String

False

false

The longitude coordinate of the geocoded billing address.

ShipAddr_Id

String

False

false

The Id of the entity for the shipping address, mainly used for modifying the address. This field is assigned by the data service.

ShipAddr_Line1

String

False

false

First line of the address.

ShipAddr_Line2

String

False

false

Second line of the address.

ShipAddr_Line3

String

False

false

Third line of the address.

ShipAddr_Line4

String

False

false

Fourth line of the address.

ShipAddr_Line5

String

False

false

Fifth line of the address.

ShipAddr_City

String

False

false

City name.

ShipAddr_Country

String

False

false

Country name.

ShipAddr_CountrySubDivisionCode

String

False

false

Region within a country. For example, the state name for the USA or the province name for Canada.

ShipAddr_PostalCode

String

False

false

Postal code. For example, the zip code for the USA and Canada.

ShipAddr_Note

String

False

false

Note for the customer.

ShipAddr_Lat

String

False

false

The latitude coordinate of the geocoded shipping address.

ShipAddr_Long

String

False

false

The longitude coordinate of the geocoded shipping address.

ClassRef

String

False

Class.Id

true

false

The Id of the class associated with the transaction.

ClassRef_Name

String

True

Class.FullyQualifiedName

false

The name of the class associated with the transaction.

SalesTermRef

String

False

Terms.Id

false

The Id of the sales term associated with the transaction.

SalesTermRef_Name

String

True

Terms.Name

false

The name of the sales term associated with the transaction.

DueDate

Date

False

true

false

The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.

ShipMethodRef

String

False

false

The Id of the shipping method associated with the transaction.

ShipMethodRef_Name

String

True

false

The name of the shipping method associated with the transaction.

ShipDate

Date

False

false

The date for delivery of goods or services.

TrackingNum

String

False

false

The tracking number for the shipping provider for the delivery of the goods associated with the transaction.

TotalAmt

Decimal

True

true

This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.

PrintStatus

String

False

false

The print status of the invoice.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus

String

False

false

The email status of the invoice.

The allowed values are NotSet, NeedToSend, EmailSent.

The default value is NotSet.

BillEmail_Address

String

False

false

The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.

BillEmailCc_Address

String

False

false

The email address where the invoice is sent as CC.

BillEmailBcc_Address

String

False

false

The email address where the invoice is sent as BCC.

Balance

Decimal

True

true

This field indicates whether the transaction is a finance charge.

PaymentRefNum

String

False

false

The reference number for the payment.

PaymentMethodRef

String

False

PaymentMethods.Id

false

The Id of the payment method.

PaymentMethodRef_Name

String

True

PaymentMethods.Name

false

The name of the payment method.

DepositToAccountRef

String

False

Accounts.Id

false

The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.

DepositToAccountRef_Name

String

True

Accounts.Name

false

Name of the asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.

DeliveryInfo_DeliveryType

String

False

false

Type of the delivery. Used to confirm that email has been sent via the send operation.

DeliveryInfo_DeliveryTime

Datetime

False

false

Delivery date and time.

Deposit

Decimal

False

false

The deposit made towards this invoice.

DepartmentRef

String

False

Departments.Id

false

The Id of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online.

DepartmentRef_Name

String

True

Departments.Name

false

The name of the department, which store the location of the transaction as defined using location tracking in QuickBooks Online.

AllowOnlineCreditCardPayment

Boolean

False

false

It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.

ApplyTaxAfterDiscount

Boolean

False

false

This field sets whether discounts are applied before the tax is calculated.

CurrencyRef

String

False

false

The Id of the currency used in the transaction.

CurrencyRef_Name

String

True

false

The name of the currency used in the transaction.

ExchangeRate

Decimal

False

false

The currency exchange rate. This field is valid only if the company file is set up to use the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit.This field is available for the UK, AU, IN, and CA editions.

GlobalTaxCalculation

String

False

false

The method in which tax is applied. This field is valid in the UK, AU, IN, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt

Decimal

True

false

Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, IN, and CA editions.

PreviousInvoiceLinkedTransactions NextItems

Last updated 2 years ago