Skip to main content
POST
/
quickbooks-desktop
/
sales-representatives
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const salesRepresentative = await conductor.qbd.salesRepresentatives.create({
  entityId: '80000001-1234567890',
  initial: 'JD',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(salesRepresentative.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_representative",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "initial": "JD",
  "isActive": true,
  "entity": {
    "id": "80000001-1234567890",
    "fullName": "John Doe"
  }
}

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"

Body

application/json
​
initial
string
required

The initials of this sales representative's name.

Maximum length: 5 characters.

Maximum length: 5
Example:

"JD"

​
entityId
string
required

The sales representative's corresponding person entity in QuickBooks, stored as either an employee, vendor, or other-name entry.

Example:

"80000001-1234567890"

​
isActive
boolean
default:true

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

Example:

true

Response

200 - application/json

Returns the newly created sales representative.

​
id
string
required

The unique identifier assigned by QuickBooks to this sales representative. This ID is unique across all sales representatives but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_sales_representative"
Example:

"qbd_sales_representative"

​
createdAt
string
required

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

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
required

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

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this sales representative 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"

​
initial
string
required

The initials of this sales representative's name.

Example:

"JD"

​
isActive
boolean
required

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

Example:

true

​
entity
object
required

The sales representative's corresponding person entity in QuickBooks, stored as either an employee, vendor, or other-name entry.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "John Doe"
}
⌘I