Create an invoice

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 omitted, QuickBooks Desktop uses the default A/R account configured in the company file.

IMPORTANT: If this invoice is linked to other transactions, this A/R account must match the receivablesAccount used in all linked 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. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

Maximum length: 11 characters.

Indicates whether this invoice has not been completed or is in a draft version.

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.

Maximum length: 25 characters.

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

NOTE: If dueDate is excluded when creating this invoice, QuickBooks might determine the due date according to the terms set for this customer.

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.

Maximum length: 13 characters.

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

For invoices, while using this field to specify a single tax item/group that applies uniformly is recommended, complex tax scenarios may require alternative approaches. In such cases, you can set this field to a 0% tax item (conventionally named "Tax Calculated On Invoice") and handle tax calculations through line items instead. When using line items for taxes, note that only individual tax items (not tax groups) can be used, subtotals can help apply a tax to multiple items but only the first tax line after a subtotal is calculated automatically (subsequent tax lines require manual amounts), and the rate column will always display the actual tax amount rather than the rate percentage.

A memo or note for this invoice that appears in reports, but not on the invoice. Use customerMessage to add a note to this invoice.

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 this invoice, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

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.

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

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

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

The date and time when this invoice was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

The date and time when this invoice was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

The current QuickBooks-assigned revision number of this invoice object, 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 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.

Indicates whether this invoice has not been completed or is in a draft version.

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 date by which this invoice must be paid, in ISO 8601 format (YYYY-MM-DD).

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 subtotal of this invoice, which is the sum of all invoice lines before taxes and payments are applied, represented as a decimal string.

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 total amount applied to this invoice, 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 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 that appears in reports, but not on the invoice. Use customerMessage to add a note to this invoice.

Indicates whether this invoice has been paid in full. When true, openAmount will be 0.

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 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, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.