POST
/
quickbooks-desktop
/
invoices

Authorizations

Authorization
string
headerrequired

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Body

application/json
customerId
string
required

The customer or customer-job associated with this invoice.

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.

receivablesAccountId
string

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.

documentTemplateId
string

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

transactionDate
string
required

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

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.

billingAddress
object

The invoice's billing address.

shippingAddress
object

The invoice's shipping address.

isPending
boolean

Indicates whether this invoice is pending approval or completion. If true, the invoice is in a draft state and has not been finalized.

isFinanceCharge
boolean

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

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.

termsId
string

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

dueDate
string

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

salesRepresentativeId
string

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

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.

shippingDate
string

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

shippingMethodId
string

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

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.

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

customerMessageId
string

The message to display to the customer on the invoice.

isQueuedForPrint
boolean

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

isQueuedForEmail
boolean

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

salesTaxCodeId
string

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.

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.

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

externalId
string

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.

linkToTransactionIds
string[]

IDs of existing transactions that you wish to link to this invoice, such as payments applied, credits used, or associated purchase orders. Note that this links entire transactions, not individual transaction lines. If you want to link individual lines in a transaction, instead use the field linkToTransactionLine on this invoice's lines, if available.

Transactions can only be linked when creating this invoice and cannot be unlinked later.

You can use both linkToTransactionIds (on this invoice) and linkToTransactionLine (on its transaction lines) as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.

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.

applyCredits
object[]

Credit memos to apply to this invoice, reducing its balance. This creates a link between this invoice and the specified credit memos.

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.

invoiceLines
object[]

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

invoiceLineGroups
object[]

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

Response

200 - application/json
id
string
required

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

objectType
string
required

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

Allowed value: "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). The time zone is the same as the user's time zone in QuickBooks.

updatedAt
string
required

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.

revisionNumber
string
required

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.

customer
object
required

The customer or customer-job associated with this invoice.

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.

receivablesAccount
object | null
required

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.

documentTemplate
object | null
required

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

transactionDate
string
required

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

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.

billingAddress
object | null
required

The invoice's billing address.

shippingAddress
object | null
required

The invoice's shipping address.

isPending
boolean | null
required

Indicates whether this invoice is pending approval or completion. If true, the invoice is in a draft state and has not been finalized.

isFinanceCharge
boolean | null
required

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

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.

terms
object | null
required

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

dueDate
string | null
required

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

salesRepresentative
object | null
required

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

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.

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

shippingMethod
object | null
required

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

subtotal
string | null
required

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

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.

salesTaxPercentage
string | null
required

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

salesTaxTotal
string | null
required

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

appliedAmount
string | null
required

The amount of credit applied to this invoice. This could include customer deposits, payments, or credits. Represented as a decimal string.

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.

currency
object | null
required

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

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

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.

memo
string | null
required

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.

isPaid
boolean | null
required

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

customerMessage
object | null
required

The message to display to the customer on the invoice.

isQueuedForPrint
boolean | null
required

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

isQueuedForEmail
boolean | null
required

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

salesTaxCode
object | null
required

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.

suggestedDiscountAmount
string | null
required

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

suggestedDiscountDate
string | null
required

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

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.

externalId
string | null
required

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.

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

invoiceLines
object[]
required

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

invoiceLineGroups
object[]
required

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

customFields
object[]
required

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