GET
/
quickbooks-desktop
/
price-levels
/
{id}
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 priceLevel = await client.qbd.priceLevels.retrieve('80000001-1234567890', {
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(priceLevel.id);
}

main();
{
  "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"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the price level to retrieve.

Example:

"80000001-1234567890"

Response

200 - application/json
Returns the specified price level.
​
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"

​
objectType
string
required

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

Allowed value: "qbd_price_level"
Example:

"qbd_price_level"

​
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"

​
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"

​
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"

​
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"

​
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

​
priceLevelType
enum<string>
required

The price level's type.

Available options:
fixed_percentage,
per_item
Example:

"fixed_percentage"

​
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"

​
perItemPriceLevels
object[]
required

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

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