Retrieve a sales order

billingAddress

object | null

required

The sales order's billing address.

class

object | null

required

The sales order'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 sales order's line items unless overridden at the line item level.

createdAt

string

required

The date and time when this sales order 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.

currency

object | null

required

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

customer

object

required

The customer or customer-job associated with this sales order.

customerMessage

object | null

required

The message to display to the customer on the sales order.

customFields

object[]

required

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

documentTemplate

object | null

required

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

dueDate

string | null

required

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

exchangeRate

number | null

required

The market exchange rate between this sales order'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 | null

required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.

id

string

required

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

isFullyInvoiced

boolean | null

required

Indicates whether all items in this sales order have been invoiced.

isManuallyClosed

boolean

required

Indicates whether this sales order has been manually marked as closed, even if it has not been invoiced.

isQueuedForEmail

boolean | null

required

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

isQueuedForPrint

boolean | null

required

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

lineGroups

object[]

required

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

lineGroups.customFields

object[]

required

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

lineGroups.description

string | null

required

A description of this sales order line group.

lineGroups.id

string

required

The unique identifier assigned by QuickBooks to this sales order line group. This ID is unique across all transaction line types.

lineGroups.itemGroup

object

required

The sales order line group's item group, representing a predefined set of items bundled because they are commonly purchased together or grouped for faster entry.

lineGroups.lines

object[]

required

The sales order line group's line items, each representing a single product or service ordered.

lineGroups.lines.amount

string | null

required

The monetary amount of this sales order line, represented as a decimal string. If both quantity and rate are specified but not amount, QuickBooks will use them to calculate amount. If amount, rate, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested rate. This field cannot be cleared.

lineGroups.lines.class

object | null

required

The sales order line'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. If a class is specified for the entire parent transaction, it is automatically applied to all sales order lines unless overridden here, at the transaction line level.

lineGroups.lines.customFields

object[]

required

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

lineGroups.lines.description

string | null

required

A description of this sales order line.

lineGroups.lines.expirationDate

string | null

required

The expiration date for the serial number or lot number of the item associated with this sales order line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.

lineGroups.lines.id

string

required

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

lineGroups.lines.inventorySite

object | null

required

The site location where inventory for the item associated with this sales order line is stored.

lineGroups.lines.inventorySiteLocation

object | null

required

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this sales order line is stored.

lineGroups.lines.isManuallyClosed

boolean

required

Indicates whether this sales order line has been manually marked as closed, even if it has not been invoiced.

lineGroups.lines.item

object | null

required

The item associated with this sales order line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.

lineGroups.lines.lotNumber

string | null

required

The lot number of the item associated with this sales order line. Used for tracking groups of inventory items that are purchased or manufactured together.

lineGroups.lines.objectType

string

required

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

Allowed value: "qbd_sales_order_line"

lineGroups.lines.otherCustomField1

string | null

required

A built-in custom field for additional information specific to this sales order line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales order lines for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

lineGroups.lines.otherCustomField2

string | null

required

A second built-in custom field for additional information specific to this sales order line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales order lines for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

lineGroups.lines.overrideUnitOfMeasureSet

object | null

required

Specifies an alternative unit-of-measure set when updating this sales order line's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.

lineGroups.lines.quantity

number | null

required

The quantity of the item associated with this sales order line. This field cannot be cleared.

lineGroups.lines.quantityInvoiced

number | null

required

The number of units of this sales order line's quantity that have been invoiced.

lineGroups.lines.rate

string | null

required

The price per unit for this sales order line. If both rate and amount are specified, rate will be ignored. If both quantity and amount are specified but not rate, QuickBooks will use them to calculate rate. Represented as a decimal string. This field cannot be cleared.

lineGroups.lines.ratePercent

string | null

required

The price of this sales order line expressed as a percentage. Typically used for discount or markup items.

lineGroups.lines.salesTaxCode

object | null

required

The sales-tax code for this sales order line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.

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.

lineGroups.lines.serialNumber

string | null

required

The serial number of the item associated with this sales order line. This is used for tracking individual units of serialized inventory items.

lineGroups.lines.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this sales order line. Must be a valid unit within the item's available units of measure.

lineGroups.objectType

string

required

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

Allowed value: "qbd_sales_order_line_group"

lineGroups.overrideUnitOfMeasureSet

object | null

required

Specifies an alternative unit-of-measure set when updating this sales order line group's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.

lineGroups.quantity

number | null

required

The quantity of the item group associated with this sales order line group. This field cannot be cleared.

lineGroups.shouldPrintItemsInGroup

boolean

required

Indicates whether the individual items in this sales order line group and their separate amounts appear on printed forms.

lineGroups.totalAmount

string

required

The total monetary amount of this sales order line group, equivalent to the sum of the amounts in lines, represented as a decimal string.

lineGroups.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this sales order line group. Must be a valid unit within the item's available units of measure.

lines

object[]

required

The sales order's line items, each representing a single product or service ordered.

lines.amount

string | null

required

The monetary amount of this sales order line, represented as a decimal string. If both quantity and rate are specified but not amount, QuickBooks will use them to calculate amount. If amount, rate, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested rate. This field cannot be cleared.

lines.class

object | null

required

The sales order line'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. If a class is specified for the entire parent transaction, it is automatically applied to all sales order lines unless overridden here, at the transaction line level.

lines.customFields

object[]

required

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

lines.description

string | null

required

A description of this sales order line.

lines.expirationDate

string | null

required

The expiration date for the serial number or lot number of the item associated with this sales order line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.

lines.id

string

required

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

lines.inventorySite

object | null

required

The site location where inventory for the item associated with this sales order line is stored.

lines.inventorySiteLocation

object | null

required

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this sales order line is stored.

lines.isManuallyClosed

boolean

required

Indicates whether this sales order line has been manually marked as closed, even if it has not been invoiced.

lines.item

object | null

required

The item associated with this sales order line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.

lines.lotNumber

string | null

required

The lot number of the item associated with this sales order line. Used for tracking groups of inventory items that are purchased or manufactured together.

lines.objectType

string

required

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

Allowed value: "qbd_sales_order_line"

lines.otherCustomField1

string | null

required

A built-in custom field for additional information specific to this sales order line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales order lines for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

lines.otherCustomField2

string | null

required

A second built-in custom field for additional information specific to this sales order line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales order lines for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

lines.overrideUnitOfMeasureSet

object | null

required

Specifies an alternative unit-of-measure set when updating this sales order line's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.

lines.quantity

number | null

required

The quantity of the item associated with this sales order line. This field cannot be cleared.

lines.quantityInvoiced

number | null

required

The number of units of this sales order line's quantity that have been invoiced.

lines.rate

string | null

required

The price per unit for this sales order line. If both rate and amount are specified, rate will be ignored. If both quantity and amount are specified but not rate, QuickBooks will use them to calculate rate. Represented as a decimal string. This field cannot be cleared.

lines.ratePercent

string | null

required

The price of this sales order line expressed as a percentage. Typically used for discount or markup items.

lines.salesTaxCode

object | null

required

The sales-tax code for this sales order line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.

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.

lines.serialNumber

string | null

required

The serial number of the item associated with this sales order line. This is used for tracking individual units of serialized inventory items.

lines.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this sales order line. Must be a valid unit within the item's available units of measure.

linkedTransactions

object[]

required

The sales order'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 sales orders to receive this field because it is not returned by default.

memo

string | null

required

A memo or note for this sales order.

objectType

string

required

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

Allowed value: "qbd_sales_order"

otherCustomField

string | null

required

A built-in custom field for additional information specific to this sales order. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales orders 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.

purchaseOrderNumber

string | null

required

The customer's Purchase Order (PO) number associated with this sales order. This field is often used to cross-reference the sales order with the customer's purchasing system.

refNumber

string | null

required

The case-sensitive user-defined reference number for this sales order, 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.

revisionNumber

string

required

The current revision number of this sales order 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.

salesChannelName

enum<string> | null

required

The type of the sales channel for this sales order.

Available options:

blank,

ecommerce

salesRepresentative

object | null

required

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

salesStoreName

string | null

required

The name of the sales store for this sales order.

salesStoreType

string | null

required

The type of the sales store for this sales order.

salesTaxCode

object | null

required

The sales-tax code for this sales order, 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. 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.

salesTaxItem

object | null

required

The sales-tax item used to calculate the actual tax amount for this sales order'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 sales order, represented as a decimal string.

salesTaxTotal

string

required

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

shipmentOrigin

string | null

required

The origin location from where the product associated with this sales order 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.

shippingAddress

object | null

required

The sales order's shipping address.

shippingDate

string | null

required

The date when the products or services for this sales order 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 sales order, such as standard mail or overnight delivery.

subtotal

string

required

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

terms

object | null

required

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

totalAmount

string

required

The total monetary amount of this sales order, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.

totalAmountInHomeCurrency

string | null

required

The total monetary amount of this sales order converted to the home currency of the QuickBooks company file. Represented as a decimal string.

transactionDate

string

required

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

updatedAt

string

required

The date and time when this sales order 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.

QuickBooks Desktop API

Core Resources

Transactions

Items

Authorizations

Headers

Path Parameters

Response