List all date-driven terms

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
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

General

Accounts
Classes
Customers / Jobs
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
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

GET

quickbooks-desktop

date-driven-terms

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 dateDrivenTerm = await client.qbd.dateDrivenTerms.list({
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(dateDrivenTerm.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/date-driven-terms",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_date_driven_term",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "2% 5th Net 25th",
      "isActive": true,
      "dueDayOfMonth": 15,
      "gracePeriodDays": 2,
      "discountDayOfMonth": 5,
      "discountPercentage": "10"
    }
  ]
}

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 date-driven terms 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 date-driven terms by their name(s), case-insensitive. Like id, name is a unique identifier for a date-driven term.

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:

["2% 5th Net 25th"]

limit

integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for date-driven terms. 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 date-driven terms without limit, unlike paginated endpoints which default to 150 records. This is acceptable because date-driven terms typically have low record counts.

Required range: x >= 1

Example:

10

status

enum<string>

default:active

Filter for date-driven terms that are active, inactive, or both.

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

Filter for date-driven terms 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 date-driven terms 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 date-driven terms 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 date-driven terms 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 date-driven terms 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 date-driven terms whose name is alphabetically greater than or equal to this value.

Example:

"A"

nameTo

string

Filter for date-driven terms whose name is alphabetically less than or equal to this value.

Example:

"Z"

Response

200 - application/json

Returns a list of date-driven terms.

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/date-driven-terms"

data

object[]

required

The array of date-driven terms.

data.id

string

required

The unique identifier assigned by QuickBooks to this date-driven term. This ID is unique across all date-driven terms but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_date_driven_term"

Example:

"qbd_date_driven_term"

data.createdAt

string

required

The date and time when this date-driven term 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 date-driven term 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 date-driven term 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 date-driven term, unique across all date-driven terms.

NOTE: Date-driven terms 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:

"2% 5th Net 25th"

data.isActive

boolean

required

Indicates whether this date-driven term is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

data.dueDayOfMonth

number

required

The day of the month when full payment is due without discount.

Example:

15

data.gracePeriodDays

number | null

required

The number of days before dueDayOfMonth when an invoice or bill issued within this threshold is considered due the following month. For example, with dueDayOfMonth set to 15 and gracePeriodDays set to 2, an invoice issued on the 13th would be due on the 15th of the next month, while an invoice issued on the 12th would be due on the 15th of the current month.

Example:

2

data.discountDayOfMonth

number | null

required

The day of the month within which payment must be received to qualify for the discount specified by discountPercentage.

Example:

5

data.discountPercentage

string | null

required

The discount percentage applied to the payment if received on or before the specified discountDayOfMonth. The value is between 0 and 100.

Example:

"10"

Retrieve a date-driven term The Employee 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 dateDrivenTerm = await client.qbd.dateDrivenTerms.list({
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(dateDrivenTerm.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/date-driven-terms",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_date_driven_term",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "2% 5th Net 25th",
      "isActive": true,
      "dueDayOfMonth": 15,
      "gracePeriodDays": 2,
      "discountDayOfMonth": 5,
      "discountPercentage": "10"
    }
  ]
}