Skip to main content
POST
JavaScript

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the invoice to update.

Maximum string length: 36
Example:

"123ABC-1234567890"

Body

application/json
​
revisionNumber
string
required

The current QuickBooks-assigned revision number of the invoice object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
customerId
string

The customer or customer-job associated with this invoice.

Maximum string length: 36
Example:

"80000001-1234567890"

​
classId
string

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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
receivablesAccountId
string

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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
documentTemplateId
string

The predefined template in QuickBooks that determines the layout and formatting for this invoice when printed or displayed.

Maximum string length: 36
Example:

"80000001-1234567890"

​
transactionDate
string<date>

The date of this invoice, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
refNumber
string

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.

Maximum length: 11 characters.

Maximum string length: 11
Example:

"INV-1234"

​
billingAddress
object

The invoice's billing address.

​
shippingAddress
object

The invoice's shipping address.

​
isPending
boolean

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

Example:

false

​
purchaseOrderNumber
string

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.

Maximum string length: 25
Example:

"PO-1234"

​
termsId
string

The invoice's payment terms, defining when payment is due and any applicable discounts.

Maximum string length: 36
Example:

"80000001-1234567890"

​
dueDate
string<date>

The date by which this invoice must be paid, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-31"

​
salesRepresentativeId
string

The invoice's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Maximum string length: 36
Example:

"80000001-1234567890"

​
shipmentOrigin
string

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.

Maximum string length: 13
Example:

"San Francisco, CA"

​
shippingDate
string<date>

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

Example:

"2024-10-01"

​
shippingMethodId
string

The shipping method used for this invoice, such as standard mail or overnight delivery.

Maximum string length: 36
Example:

"80000001-1234567890"

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

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.

Maximum string length: 36
Example:

"80000001-1234567890"

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

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Customer requested rush delivery"

​
customerMessageId
string

The message to display to the customer on the invoice.

Maximum string length: 36
Example:

"80000001-1234567890"

​
isQueuedForPrint
boolean

Indicates whether this invoice is included in the queue of documents for QuickBooks to print.

Example:

true

​
isQueuedForEmail
boolean

Indicates whether this invoice is included in the queue of documents for QuickBooks to email to the customer.

Example:

true

​
salesTaxCodeId
string

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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
otherCustomField
string

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.

Maximum length: 29 characters.

Maximum string length: 29
Example:

"Special handling required"

​
exchangeRate
number

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

Example:

1.2345

​
applyCredits
object[]

Credits to apply to this invoice, reducing its balance. This creates a link between this invoice and the specified credit transactions. For credit-only applications with no received payment amount, update the invoice using this field.

IMPORTANT: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the invoice and check the linkedTransactions response field. If fetching a list of invoices, you must also specify the parameter includeLinkedTransactions=true to see the linkedTransactions response field.

Minimum array length: 1
​
lines
object[]

The invoice's line items, each representing a single product or service sold.

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing line items for the invoice with this array. To keep any existing line items, you must include them in this array even if they have not changed. Any line items not included will be removed.

  2. To add a new line item, include it here with the id field set to -1.

  3. If you do not wish to modify any line items, omit this field entirely to keep them unchanged.

Minimum array length: 1
​
lineGroups
object[]

The invoice's line item groups, each representing a predefined set of related items.

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing line item groups for the invoice with this array. To keep any existing line item groups, you must include them in this array even if they have not changed. Any line item groups not included will be removed.

  2. To add a new line item group, include it here with the id field set to -1.

  3. If you do not wish to modify any line item groups, omit this field entirely to keep them unchanged.

Minimum array length: 1

Response

200 - application/json

Returns the updated invoice.

​
id
string
required

The unique identifier assigned by QuickBooks to this invoice. This ID is unique across all transaction types.

Example:

"123ABC-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_invoice".

Allowed value: "qbd_invoice"
Example:

"qbd_invoice"

​
createdAt
string
required

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.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

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.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

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.

Example:

"1721172183"

​
customer
object | null
required

The customer or customer-job associated with this invoice.

Example:
​
class
object | null
required

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.

Example:
​
receivablesAccount
object | null
required

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.

Example:
​
documentTemplate
object | null
required

The predefined template in QuickBooks that determines the layout and formatting for this invoice when printed or displayed.

Example:
​
transactionDate
string<date>
required

The date of this invoice, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
refNumber
string | null
required

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.

Example:

"INV-1234"

​
billingAddress
The Address object · object | null
required

The invoice's billing address.

​
shippingAddress
The Address object · object | null
required

The invoice's shipping address.

​
isPending
boolean | null
required

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

Example:

false

​
isFinanceCharge
boolean | null
required

Whether this invoice includes a finance charge. This field is immutable and can only be set during invoice creation.

Example:

true

​
purchaseOrderNumber
string | null
required

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.

Example:

"PO-1234"

​
terms
object | null
required

The invoice's payment terms, defining when payment is due and any applicable discounts.

Example:
​
dueDate
string<date> | null
required

The date by which this invoice must be paid, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-31T00:00:00.000Z"

​
salesRepresentative
object | null
required

The invoice's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Example:
​
shipmentOrigin
string | null
required

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.

Example:

"San Francisco, CA"

​
shippingDate
string<date> | null
required

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

Example:

"2024-10-01T00:00:00.000Z"

​
shippingMethod
object | null
required

The shipping method used for this invoice, such as standard mail or overnight delivery.

Example:
​
subtotal
string
required

The subtotal of this invoice, which is the sum of all invoice lines before taxes and payments are applied, represented as a decimal string.

Example:

"1000.00"

​
salesTaxItem
object | null
required

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.

Example:
​
salesTaxPercentage
string | null
required

The sales tax percentage applied to this invoice, represented as a decimal string.

Example:

"0.07"

​
salesTaxTotal
string | null
required

The total amount of sales tax charged for this invoice, represented as a decimal string.

Example:

"10.00"

​
appliedAmount
string | null
required

The total amount applied to this invoice, represented as a decimal string.

Example:

"100.00"

​
balanceRemaining
string | null
required

The outstanding balance of this invoice after applying any credits or payments. Calculated as subtotal + salesTaxTotal - appliedAmount. Represented as a decimal string.

Example:

"100.00"

​
currency
object | null
required

The invoice's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
exchangeRate
number | null
required

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

Example:

1.2345

​
balanceRemainingInHomeCurrency
string | null
required

The outstanding balance of this invoice converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"100.00"

​
memo
string | null
required

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.

Example:

"Customer requested rush delivery"

​
isPaid
boolean | null
required

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

Example:

false

​
customerMessage
object | null
required

The message to display to the customer on the invoice.

Example:
​
isQueuedForPrint
boolean | null
required

Indicates whether this invoice is included in the queue of documents for QuickBooks to print.

Example:

true

​
isQueuedForEmail
boolean | null
required

Indicates whether this invoice is included in the queue of documents for QuickBooks to email to the customer.

Example:

true

​
salesTaxCode
object | null
required

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.

Example:
​
suggestedDiscountAmount
string | null
required

The suggested discount amount for this invoice, represented as a decimal string.

Example:

"10.00"

​
suggestedDiscountDate
string<date> | null
required

The date when the suggestedDiscountAmount for this invoice would apply, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-01-01T00:00:00.000Z"

​
otherCustomField
string | null
required

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.

Example:

"Special handling required"

​
externalId
string | null
required

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.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
linkedTransactions
The Linked Transaction object · object[]
required

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.

​
lines
The Invoice Line object · object[]
required

The invoice's line items, each representing a single product or service sold.

​
lineGroups
The Invoice Line Group object · object[]
required

The invoice's line item groups, each representing a predefined set of related items.

​
customFields
The Custom Field object · object[]
required

The custom fields for the invoice object, added as user-defined data extensions, not included in the standard QuickBooks object.