GET
/
quickbooks-desktop
/
subtotal-items
/
{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 subtotalItem = await client.qbd.subtotalItems.retrieve('80000001-1234567890', {
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(subtotalItem.id);
}

main();
{
  "id": "80000001-1234567890",
  "objectType": "qbd_subtotal_item",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Labor subtotal",
  "barcode": "012345678905",
  "isActive": true,
  "description": "Subtotal for all labor costs on this project",
  "specialItemType": "finance_charge",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

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}}").

Path Parameters

​
id
string
required

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

Response

200 - application/json
Returns the specified subtotal item.
​
id
string
required

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

​
objectType
string
required

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

Allowed value: "qbd_subtotal_item"
​
createdAt
string
required

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

​
updatedAt
string
required

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

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this subtotal 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.

​
name
string
required

The case-insensitive unique name of this subtotal item, unique across all subtotal items.

NOTE: Subtotal items 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.

​
barcode
string | null
required

The subtotal item's barcode.

​
isActive
boolean
required

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

​
description
string | null
required

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

​
specialItemType
enum<string> | null
required

The type of special item for this subtotal item.

Available options:
finance_charge,
reimbursable_expense_group,
reimbursable_expense_subtotal
​
externalId
string | null
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.

​
customFields
object[]
required

The custom fields for the subtotal item object, added as user-defined data extensions, not included in the standard QuickBooks object.

Update a subtotal itemList all subtotal items