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 sales order to update.

Maximum string length: 36
Example:

"123ABC-1234567890"

Body

application/json
​
revisionNumber
string
required

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
classId
string

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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
documentTemplateId
string

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
transactionDate
string<date>

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

Example:

"2024-10-01"

​
refNumber
string

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.

Maximum length: 11 characters.

Maximum string length: 11
Example:

"SO-1234"

​
billingAddress
object

The sales order's billing address.

​
shippingAddress
object

The sales order's shipping address.

​
purchaseOrderNumber
string

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.

Maximum length: 25 characters.

Maximum string length: 25
Example:

"PO-1234"

​
termsId
string

The sales order'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 sales order must be paid, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-31"

​
salesRepresentativeId
string

The sales order'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 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.

Maximum length: 13 characters.

Maximum string length: 13
Example:

"San Francisco, CA"

​
shippingDate
string<date>

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

Example:

"2024-10-01"

​
shippingMethodId
string

The shipping method used for this sales order, 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 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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
isManuallyClosed
boolean

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

Example:

true

​
memo
string

A memo or note for this sales order.

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Customer requested rush delivery"

​
customerMessageId
string

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
isQueuedForPrint
boolean

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

Example:

true

​
isQueuedForEmail
boolean

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

Example:

true

​
salesTaxCodeId
string

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

Maximum length: 29 characters.

Maximum string length: 29
Example:

"Special handling required"

​
exchangeRate
number

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

Example:

1.2345

​
lines
object[]

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

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing line items for the sales order 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 sales order'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 sales order 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
​
salesChannelName
enum<string>

The type of the sales channel for this sales order.

Available options:
blank,
ecommerce
Example:

"ecommerce"

​
salesStoreName
string

The name of the sales store for this sales order.

Example:

"Store 1"

​
salesStoreType
string

The type of the sales store for this sales order.

Example:

"Retail"

Response

200 - application/json

Returns the updated sales order.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_sales_order"
Example:

"qbd_sales_order"

​
createdAt
string
required

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

Example:

"1721172183"

​
customer
object | null
required

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

Example:
​
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.

Example:
​
documentTemplate
object | null
required

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

Example:
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

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

Example:

"SO-1234"

​
billingAddress
The Address object · object | null
required

The sales order's billing address.

​
shippingAddress
The Address object · object | null
required

The sales order's shipping address.

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

Example:

"PO-1234"

​
terms
object | null
required

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

Example:
​
dueDate
string<date> | null
required

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

Example:

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

​
salesRepresentative
object | null
required

The sales order'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 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.

Example:

"San Francisco, CA"

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

Example:

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

​
shippingMethod
object | null
required

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

Example:
​
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.

Example:

"1000.00"

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

Example:
​
salesTaxPercentage
string | null
required

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

Example:

"0.07"

​
salesTaxTotal
string | null
required

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

Example:

"10.00"

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

Example:

"1000.00"

​
currency
object | null
required

The sales order'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 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).

Example:

1.2345

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

Example:

"1234.56"

​
isManuallyClosed
boolean
required

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

Example:

true

​
isFullyInvoiced
boolean | null
required

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

Example:

false

​
memo
string | null
required

A memo or note for this sales order.

Example:

"Customer requested rush delivery"

​
customerMessage
object | null
required

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

Example:
​
isQueuedForPrint
boolean | null
required

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

Example:

true

​
isQueuedForEmail
boolean | null
required

Indicates whether this sales order 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 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 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:
​
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.

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

​
lines
The Sales Order Line object · object[]
required

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

​
lineGroups
The Sales Order Line Group object · object[]
required

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

​
customFields
The Custom Field object · object[]
required

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

​
salesChannelName
enum<string> | null
required

The type of the sales channel for this sales order.

Available options:
blank,
ecommerce
Example:

"ecommerce"

​
salesStoreName
string | null
required

The name of the sales store for this sales order.

Example:

"Store 1"

​
salesStoreType
string | null
required

The type of the sales store for this sales order.

Example:

"Retail"