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"
    }
  ]
}

Changes

Changed in 4 of the 46 revisions of this API.45122

May 2, 20261de07095c4b71See the full diff
- ●
  for the path request parameter id, the maxLength was set to 36
  request-parameter-max-length-set
Apr 20, 202610d4e9ebd1df163See the full diff
- ▲
  response property account/fullName list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property account/id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property barcode list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property description list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property discountRate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property discountRatePercent list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the class response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property class/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property class/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the class response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the parent response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-added
Apr 20, 20268e0b7df2044d1316See the full diff
- ▲
  the response property account/fullName became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property account/id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property barcode became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property class became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property description became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property discountRate became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property discountRatePercent became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property externalId became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property parent became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property salesTaxCode became nullable for the status 200
  response-property-became-nullable
- ▲
  the class response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from / to object null/ for status 200
  response-property-type-changed
- ○
  removed subschema #1 subschema #2 from the class response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the parent response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-removed
- ○
  response property account/fullName list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property account/id list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property barcode list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property description list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property discountRate list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property discountRatePercent list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property externalId list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  added the required property class/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property class/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property parent/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property parent/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property salesTaxCode/fullName to the response with the 200 status
  response-required-property-added
- ○
  added the required property salesTaxCode/id to the response with the 200 status
  response-required-property-added
Apr 20, 20265f832f695675163See the full diff
- ▲
  response property account/fullName list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property account/id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property barcode list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property description list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property discountRate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property discountRatePercent list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the class response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the parent response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  the salesTaxCode response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property class/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property class/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property parent/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/fullName from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property salesTaxCode/id from the response with the 200 status
  response-required-property-removed
- ○
  added subschema #1 subschema #2 to the class response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the parent response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the salesTaxCode response property anyOf list for the response status 200
  response-property-any-of-added

Full history