Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Create a sales order

Creates a new sales order.

post/quickbooks-desktop/sales-orders

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Request body

customerIdstring required

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

classIdstring

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.

documentTemplateIdstring

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

transactionDatestring date required

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

refNumberstring

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

purchaseOrderNumberstring

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.

termsIdstring

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

dueDatestring date

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

salesRepresentativeIdstring

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

shipmentOriginstring

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.

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

shippingMethodIdstring

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

salesTaxItemIdstring

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.

isManuallyClosedboolean

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

memostring

A memo or note for this sales order.

customerMessageIdstring

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

isQueuedForPrintboolean

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

isQueuedForEmailboolean

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

salesTaxCodeIdstring

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.

otherCustomFieldstring

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.

exchangeRatenumber

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

externalIdstring uuid

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.

salesChannelName'blank' | 'ecommerce'

The type of the sales channel for this sales order.

salesStoreNamestring

The name of the sales store for this sales order.

salesStoreTypestring

The type of the sales store for this sales order.

Example request

{
  "customerId": "80000001-1234567890",
  "classId": "80000001-1234567890",
  "documentTemplateId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "refNumber": "SO-1234",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "purchaseOrderNumber": "PO-1234",
  "termsId": "80000001-1234567890",
  "dueDate": "2024-10-31",
  "salesRepresentativeId": "80000001-1234567890",
  "shipmentOrigin": "San Francisco, CA",
  "shippingDate": "2024-10-01",
  "shippingMethodId": "80000001-1234567890",
  "salesTaxItemId": "80000001-1234567890",
  "isManuallyClosed": true,
  "memo": "Customer requested rush delivery",
  "customerMessageId": "80000001-1234567890",
  "isQueuedForPrint": true,
  "isQueuedForEmail": true,
  "salesTaxCodeId": "80000001-1234567890",
  "otherCustomField": "Special handling required",
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "itemId": "80000001-1234567890",
      "description": "Widget Model X100 - Blue",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "rate": "10.00",
      "ratePercent": "10.5",
      "priceLevelId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "amount": "1000.00",
      "priceRuleConflictStrategy": "base_price",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "salesTaxCodeId": "80000001-1234567890",
      "isManuallyClosed": true,
      "otherCustomField1": "Special handling required",
      "otherCustomField2": "Always ship with a spare",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "lineGroups": [
    {
      "itemGroupId": "80000001-1234567890",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "salesChannelName": "ecommerce",
  "salesStoreName": "Store 1",
  "salesStoreType": "Retail"
}

Response

Returns the newly created sales order.

idstring required

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

objectType'qbd_sales_order' required

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

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

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

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

transactionDatestring date required

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

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

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

dueDatestring date nullable required

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

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

shippingDatestring date nullable 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).

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

salesTaxPercentagestring nullable required

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

salesTaxTotalstring nullable required

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

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

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

totalAmountInHomeCurrencystring nullable required

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

isManuallyClosedboolean required

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

isFullyInvoicedboolean nullable required

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

memostring nullable required

A memo or note for this sales order.

isQueuedForPrintboolean nullable required

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

isQueuedForEmailboolean nullable required

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

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

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

salesChannelName'blank' | 'ecommerce' nullable required

The type of the sales channel for this sales order.

salesStoreNamestring nullable required

The name of the sales store for this sales order.

salesStoreTypestring nullable required

The type of the sales store for this sales order.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_sales_order",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Online Sales"
  },
  "documentTemplate": {
    "id": "80000001-1234567890",
    "fullName": "Sales Order Template"
  },
  "transactionDate": "2024-10-01",
  "refNumber": "SO-1234",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "purchaseOrderNumber": "PO-1234",
  "terms": {
    "id": "80000001-1234567890",
    "fullName": "Net 30"
  },
  "dueDate": "2024-10-31",
  "salesRepresentative": {
    "id": "80000001-1234567890",
    "fullName": "Jane Doe"
  },
  "shipmentOrigin": "San Francisco, CA",
  "shippingDate": "2024-10-01",
  "shippingMethod": {
    "id": "80000001-1234567890",
    "fullName": "FedEx Ground"
  },
  "subtotal": "1000.00",
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  },
  "salesTaxPercentage": "0.07",
  "salesTaxTotal": "10.00",
  "totalAmount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "totalAmountInHomeCurrency": "1234.56",
  "isManuallyClosed": true,
  "memo": "Customer requested rush delivery",
  "customerMessage": {
    "id": "80000001-1234567890",
    "fullName": "Thank you for your business!"
  },
  "isQueuedForPrint": true,
  "isQueuedForEmail": true,
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "otherCustomField": "Special handling required",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "linkedTransactions": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_linked_transaction",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "LINK-1234",
      "linkType": "amount",
      "amount": "1000.00"
    }
  ],
  "lines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_sales_order_line",
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "description": "Widget Model X100 - Blue",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "rate": "10.00",
      "ratePercent": "10.5",
      "class": {
        "id": "80000001-1234567890",
        "fullName": "West-Coast:Sales"
      },
      "amount": "1000.00",
      "inventorySite": {
        "id": "80000001-1234567890",
        "fullName": "Main Warehouse"
      },
      "inventorySiteLocation": {
        "id": "80000001-1234567890",
        "fullName": "Aisle 3, Shelf B"
      },
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "quantityInvoiced": 5,
      "isManuallyClosed": true,
      "otherCustomField1": "Special handling required",
      "otherCustomField2": "Always ship with a spare",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "lineGroups": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_sales_order_line_group",
      "itemGroup": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies Bundle"
      },
      "description": "Service Bundle 1",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "shouldPrintItemsInGroup": true,
      "totalAmount": "1000.00",
      "lines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_sales_order_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "description": "Widget Model X100 - Blue",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "rate": "10.00",
          "ratePercent": "10.5",
          "class": {
            "id": "80000001-1234567890",
            "fullName": "West-Coast:Sales"
          },
          "amount": "1000.00",
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "quantityInvoiced": 5,
          "isManuallyClosed": true,
          "otherCustomField1": "Special handling required",
          "otherCustomField2": "Always ship with a spare",
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ],
  "salesChannelName": "ecommerce",
  "salesStoreName": "Store 1",
  "salesStoreType": "Retail"
}