List all price levels - Conductor Docs

QuickBooks Desktop API

Core Resources

Auth Sessions
End Users

Utilities

GET
Health check

Transactions

All Transactions
Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Inventory Adjustments
Invoices
Item Receipts
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

General

Account Tax Lines
Accounts
Classes
Company
Customers / Jobs
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Preferences
Price Levels
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Items

Discount Items
Inventory Assembly Items
Inventory Items
Non-Inventory Items
Sales-Tax Items
Service Items
Subtotal Items

Missing QBD types

GET

quickbooks-desktop

price-levels

import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  const priceLevels = await client.qbd.priceLevels.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(priceLevels.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/price-levels",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_price_level",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Wholesale 20% Discount",
      "isActive": true,
      "priceLevelType": "fixed_percentage",
      "fixedPercentage": "-10.0",
      "perItemPriceLevels": [
        {
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "customPrice": "19.99",
          "customPricePercent": "15.0"
        }
      ],
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      }
    }
  ]
}

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Query Parameters

ids

string[]

Filter for specific price levels 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.

Example:

["80000001-1234567890"]

names

string[]

Filter for specific price levels by their name(s), case-insensitive. Like id, name is a unique identifier for a price level.

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.

Example:

["Wholesale 20% Discount"]

limit

integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for price levels. This parameter will limit the response size, but you cannot fetch subsequent results using a cursor. For pagination, use the name-range parameters instead (e.g., nameFrom=A&nameTo=B).

When this parameter is omitted, the endpoint returns all price levels without limit, unlike paginated endpoints which default to 150 records. This is acceptable because price levels typically have low record counts.

Required range: x >= 1

Example:

10

status

enum<string>

default:active

Filter for price levels that are active, inactive, or both.

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

Filter for price levels updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

Example:

"2021-01-01T12:34:56.000Z"

updatedBefore

string

Filter for price levels updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

Example:

"2021-02-01T12:34:56.000Z"

nameContains

string

Filter for price levels whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:

"ABC"

nameStartsWith

string

Filter for price levels whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:

"ABC"

nameEndsWith

string

Filter for price levels whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:

"ABC"

nameFrom

string

Filter for price levels whose name is alphabetically greater than or equal to this value.

Example:

"A"

nameTo

string

Filter for price levels whose name is alphabetically less than or equal to this value.

Example:

"Z"

itemIds

string[]

Filter for price levels containing these items.

Example:

["80000001-1234567890"]

currencyIds

string[]

Filter for price levels in these currencies.

Example:

["80000001-1234567890"]

Response

200 - application/json

Returns a list of price levels.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/price-levels"

data

object[]

required

The array of price levels.

data.id

string

required

The unique identifier assigned by QuickBooks to this price level. This ID is unique across all price levels but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_price_level"

Example:

"qbd_price_level"

data.createdAt

string

required

The date and time when this price level was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T17:34:56.000Z"

data.updatedAt

string

required

The date and time when this price level was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

Example:

"2021-10-01T20:45:30.000Z"

data.revisionNumber

string

required

The current QuickBooks-assigned revision number of this price level 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"

data.name

string

required

The case-insensitive unique name of this price level, unique across all price levels.

NOTE: Price levels do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Example:

"Wholesale 20% Discount"

data.isActive

boolean

required

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

Example:

true

data.priceLevelType

enum<string>

required

The price level's type.

Available options:

fixed_percentage,

per_item

Example:

"fixed_percentage"

data.fixedPercentage

string | null

required

The fixed percentage adjustment applied to all items for this price level (instead of a per-item price level). Once you create the price level, you cannot change this.

When this price level is applied to a customer, it automatically adjusts the rate and amount columns for applicable line items in sales orders and invoices for that customer. This value supports both positive and negative values - a value of "20" increases prices by 20%, while "-10" decreases prices by 10%.

Example:

"-10.0"

data.perItemPriceLevels

object[]

required

The per-item price level configurations for this price level.

data.perItemPriceLevels.item

object | null

required

The item associated with this per-item price level. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Widget A"
}

data.perItemPriceLevels.customPrice

string | null

required

The fixed amount custom price for this per-item price level that overrides the standard price for the specified item. Used when setting an absolute price value for the item in this price level.

Example:

"19.99"

data.perItemPriceLevels.customPricePercent

string | null

required

The fixed discount percentage for this per-item price level that modifies the specified item's standard price. Used to create a fixed percentage markup or discount specific to this item within this price level.

Example:

"15.0"

data.currency

object | null

required

The price level's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

Example:

{
  "id": "80000001-1234567890",
  "fullName": "USD"
}

Retrieve a price level The Sales Representative object

import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  const priceLevels = await client.qbd.priceLevels.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(priceLevels.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/price-levels",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_price_level",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Wholesale 20% Discount",
      "isActive": true,
      "priceLevelType": "fixed_percentage",
      "fixedPercentage": "-10.0",
      "perItemPriceLevels": [
        {
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "customPrice": "19.99",
          "customPricePercent": "15.0"
        }
      ],
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      }
    }
  ]
}

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

Authorizations

Headers

Query Parameters

Response