The Invoice object
An invoice records the amount owed by a customer who purchased goods or services but did not pay in full at the time of the sale.
The unique identifier assigned by QuickBooks to this invoice. This ID is unique across all transaction types.
The type of object. This value is always "qbd_invoice".
"qbd_invoice"The date and time when this invoice was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The date and time when this invoice was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The current revision number of this invoice, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.
The customer or customer-job associated with this invoice.
The invoice's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this invoice's line items unless overridden at the line item level.
The Accounts-Receivable (A/R) account to which this invoice is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default Accounts-Receivable account.
IMPORTANT: If this invoice is linked to other transactions, this A/R account must match the receivablesAccount used in the other transactions.
The predefined template in QuickBooks that determines the layout and formatting for this invoice when printed or displayed.
The date of this invoice, in ISO 8601 format (YYYY-MM-DD).
The case-sensitive user-defined reference number for this invoice, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.
The invoice's billing address.
The invoice's shipping address.
Indicates whether this invoice is pending approval or completion. If true, the invoice is in a draft state and has not been finalized.
Whether this invoice includes a finance charge. This field is immutable and can only be set during invoice creation.
The customer's Purchase Order (PO) number associated with this invoice. This field is often used to cross-reference the invoice with the customer's purchasing system.
The invoice's payment terms, defining when payment is due and any applicable discounts.
The date by which this invoice must be paid, in ISO 8601 format (YYYY-MM-DD).
The invoice's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The origin location from where the product associated with this invoice is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.
The date when the products or services for this invoice were shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
The shipping method used for this invoice, such as standard mail or overnight delivery.
The subtotal of this invoice, which is the sum of all line items before taxes and discounts are applied, represented as a decimal string.
The sales-tax item used to calculate the actual tax amount for this invoice's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.
The sales tax percentage applied to this invoice, represented as a decimal string.
The total amount of sales tax charged for this invoice, represented as a decimal string.
The amount of credit applied to this invoice. This could include customer deposits, payments, or credits. Represented as a decimal string.
The outstanding balance of this invoice after applying any credits or payments. Calculated as subtotal + salesTaxTotal - appliedAmount. Represented as a decimal string.
The invoice's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The market exchange rate between this invoice's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
The outstanding balance of this invoice converted to the home currency of the QuickBooks company file. Represented as a decimal string.
A memo or note for this invoice, as entered by the user. This appears in reports, but not on the invoice. Use customerMessage to add a note to the invoice.
Indicates whether this invoice has been paid in full. If true, openAmount will be 0.
The message to display to the customer on the invoice.
Indicates whether this invoice is included in the queue of documents for QuickBooks to print.
Indicates whether this invoice is included in the queue of documents for QuickBooks to email to the customer.
The sales-tax code for items sold to the customer of this invoice, determining whether items sold to this customer are taxable or non-taxable. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The suggested discount amount for this invoice, represented as a decimal string.
The date when the suggestedDiscountAmount for this invoice would apply, in ISO 8601 format (YYYY-MM-DD).
A built-in custom field for additional information specific to this invoice. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all invoices for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.
A globally unique identifier (GUID) you can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
The invoice's linked transactions, such as payments applied, credits used, or associated purchase orders.
IMPORTANT: You must specify the parameter includeLinkedTransactions when fetching a list of invoices to receive this field because it is not returned by default.
The invoice's line items, each representing a single product or service sold.
The invoice's line item groups, each representing a predefined set of related items.
The custom fields for the invoice object, added as user-defined data extensions, not included in the standard QuickBooks object.