v48

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

Retrieve a discount item

Retrieves a discount item by ID.

IMPORTANT: If you need to fetch multiple specific discount items by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/discount-items/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the discount item to retrieve.

Example:80000001-1234567890

The QuickBooks-assigned unique identifier of the discount item to retrieve.

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.

Response

Returns the specified discount item.

idstring required

The unique identifier assigned by QuickBooks to this discount item. This ID is unique across all discount items but not across different QuickBooks object types.

objectType'qbd_discount_item' required

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

createdAtstring required

The date and time when this discount item 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 discount item 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 discount item 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.

namestring required

The case-insensitive name of this discount item. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two discount items could both have the name "10% labor discount", but they could have unique fullName values, such as "Discounts:10% labor discount" and "Promotions:10% labor discount".

fullNamestring required

The case-insensitive fully-qualified unique name of this discount item, formed by combining the names of its hierarchical parent objects with its own name, separated by colons. For example, if a discount item is under "Discounts" and has the name "10% labor discount", its fullName would be "Discounts:10% labor discount".

NOTE: Unlike name, fullName is guaranteed to be unique across all discount item objects. However, fullName can still be arbitrarily changed by the QuickBooks user when they modify the underlying name field.

barcodestring nullable required

The discount item's barcode.

isActiveboolean required

Indicates whether this discount item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

sublevelnumber required

The depth level of this discount item in the hierarchy. A top-level discount item has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, a discount item with a fullName of "Discounts:10% labor discount" would have a sublevel of 1.

descriptionstring nullable required

The discount item's description that will appear on sales forms that include this item.

discountRatestring nullable required

The monetary amount to subtract from the total or subtotal when applying this discount item to a transaction, represented as a decimal string.

NOTE: A flat rate discount applies to ALL lines recorded above it and distributes the discount amount equally across those lines, which affects tax calculations. For example, a $10 discount applied to a $100 taxable item and $100 non-taxable item would result in a $5 taxable discount and $5 non-taxable discount.

discountRatePercentstring nullable required

The percentage amount to subtract from the total or subtotal when applying this discount item to a transaction.

NOTE: A percentage discount only applies to the line immediately above it, so tax implications only affect that specific line.

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.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_discount_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "10% labor discount",
  "fullName": "Discounts:10% labor discount",
  "barcode": "012345678905",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Discounts"
  },
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Discounts"
  },
  "sublevel": 1,
  "description": "10% discount for early payment on labor charges",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "discountRate": "25.00",
  "discountRatePercent": "10.5",
  "account": {
    "id": "80000001-1234567890",
    "fullName": "Discounts"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}