COconductor-is

List all discount items

Changed on

Returns a list of discount items. Use the cursor parameter to paginate through the results.

get/quickbooks-desktop/discount-items

Request

Query parameters

idsstring[]

Filter for specific discount items by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "80000001-1234567890"
]
fullNamesstring[]

Filter for specific discount items by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for a discount item, formed by by combining the names of its 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".

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "Discounts:10% labor discount"
]
limitinteger

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Example:150
cursorstring

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

IMPORTANT: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see Paging by name.

Example:12345678-abcd-abcd-example-1234567890ab
status'active' | 'all' | 'inactive'

Filter for discount items that are active, inactive, or both.

Example:active
updatedAfterstring

Filter for discount items updated on or after this date/time. Accepts the following ISO 8601 formats:

  • date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
  • datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
  • datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Example:2025-01-01T12:34:56+00:00
updatedBeforestring

Filter for discount items updated on or before this date/time. Accepts the following ISO 8601 formats:

  • date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
  • datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
  • datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Example:2025-02-01T12:34:56+00:00
nameContainsstring

Filter for discount items whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:ABC
nameStartsWithstring

Filter for discount items whose name starts with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:ABC
nameEndsWithstring

Filter for discount items whose name ends with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:ABC
nameFromstring

Filter for discount items whose fullName sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.

When you set nameFrom or nameTo, QuickBooks returns discount items sorted by fullName in that order; without either, the order is not guaranteed. To page through discount items by name, see Paging by name.

NOTE: If you use this parameter, you cannot also use nameContains, nameStartsWith, or nameEndsWith.

Example:A
nameTostring

Filter for discount items whose fullName sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set nameFrom, it must not sort after this value, or QuickBooks returns an error.

When you set nameFrom or nameTo, QuickBooks returns discount items sorted by fullName in that order; without either, the order is not guaranteed.

NOTE: If you use this parameter, you cannot also use nameContains, nameStartsWith, or nameEndsWith.

Example:Z
classIdsstring[]

Filter for discount items of these classes. A class is a way end-users can categorize discount items in QuickBooks.

[
  "80000001-1234567890"
]

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns a list of discount items.

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

nextCursorstring nullable required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

remainingCountnumber nullable required

The number of objects remaining to be fetched.

hasMoreboolean required

Indicates whether there are more objects to be fetched.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/discount-items",
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10
}

Changes