COconductor-is

Retrieve a date-driven term

Changed on

Retrieves a date-driven term by ID.

IMPORTANT: If you need to fetch multiple specific date-driven terms by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/date-driven-terms/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the date-driven term to retrieve.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified date-driven term.

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

objectType'qbd_date_driven_term' required

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

createdAtstring required

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

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

isActiveboolean required

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

dueDayOfMonthnumber required

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

gracePeriodDaysnumber nullable 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.

discountDayOfMonthnumber nullable required

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

discountPercentagestring nullable required

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

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_date_driven_term",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "2% 5th Net 25th",
  "isActive": true,
  "dueDayOfMonth": 15,
  "gracePeriodDays": 2,
  "discountDayOfMonth": 5,
  "discountPercentage": "10"
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

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

    • breaking

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

    • breaking

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