COconductor-is

Create a subtotal item

Changed on

Creates a new subtotal item.

post/quickbooks-desktop/subtotal-items

Request

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Request body

namestring 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.

Maximum length: 31 characters.

isActiveboolean

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

descriptionstring

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

Maximum length: 4095 characters.

externalIdstring uuid

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example request

{
  "name": "Labor subtotal",
  "barcode": {
    "value": "012345678905"
  },
  "isActive": true,
  "description": "Subtotal for all labor costs on this project",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab"
}

Response

Returns the newly created subtotal item.

idstring 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'qbd_subtotal_item' required

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

createdAtstring required

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

namestring 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.

barcodestring nullable required

The subtotal item's barcode.

isActiveboolean required

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

descriptionstring nullable required

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

specialItemType'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal' nullable required

The type of special item for this subtotal item.

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_subtotal_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "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"
    }
  ]
}

Changes

  • 1396ed78f0e1Revision changes
    • warning

      the / request property's maxLength was set to 50

    • warning

      the request property's maxLength was set to 4095

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property barcode list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property externalId list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property specialItemType list-of-types was widened by adding types null to media type application/json of response 200

    • info

      removed the finance_charge enum value from the response property for the response status

    • info

      removed the reimbursable_expense_group enum value from the response property for the response status

    • info

      removed the reimbursable_expense_subtotal enum value from the response property for the response status

    • info

      removed the undefined enum value from the response property for the response status