POST
/
quickbooks-desktop
/
other-names
JavaScript
import Conductor from 'conductor-node';

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

const otherName = await conductor.qbd.otherNames.create({
  name: 'John Doe',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(otherName.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_other_name",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "John Doe",
  "isActive": true,
  "companyName": "Acme Corporation",
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "line4": "",
    "line5": "",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "phone": "+1-555-123-4567",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "email": "other-name@example.com",
  "contact": "Jane Smith",
  "alternateContact": "Bob Johnson",
  "accountNumber": "1010",
  "note": "This employee is a key employee.",
  "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}}").

Example:

"end_usr_1234567abcdefg"

Body

application/json
​
name
string
required

The case-insensitive unique name of this other-name, unique across all other-names.

NOTE: Other-names 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.

Maximum length: 31
Example:

"John Doe"

​
isActive
boolean
default:true

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

Example:

true

​
companyName
string

The name of the company associated with this other-name. This name is used on invoices, checks, and other forms.

Example:

"Acme Corporation"

​
salutation
string

The formal salutation title that precedes the name of the contact person for this other-name, such as "Mr.", "Ms.", or "Dr.".

Example:

"Dr."

​
firstName
string

The first name of the contact person for this other-name.

Maximum length: 25 characters.

Maximum length: 25
Example:

"John"

​
middleName
string

The middle name of the contact person for this other-name.

Maximum length: 5 characters.

Maximum length: 5
Example:

"A."

​
lastName
string

The last name of the contact person for this other-name.

Maximum length: 25 characters.

Maximum length: 25
Example:

"Doe"

​
address
object

The other-name's address.

​
phone
string

The other-name's primary telephone number.

Example:

"+1-555-123-4567"

​
alternatePhone
string

The other-name's alternate telephone number.

Example:

"+1-555-987-6543"

​
fax
string

The other-name's fax number.

Example:

"+1-555-555-1212"

​
email
string

The other-name's email address.

Example:

"other-name@example.com"

​
contact
string

The name of the primary contact person for this other-name.

Example:

"Jane Smith"

​
alternateContact
string

The name of a alternate contact person for this other-name.

Example:

"Bob Johnson"

​
accountNumber
string

The other-name's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.

Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

Example:

"1010"

​
note
string

A note or comment about this other-name.

Example:

"This employee is a key employee."

​
externalId
string<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:

"12345678-abcd-1234-abcd-1234567890ab"

Response

200 - application/json

Returns the newly created other-name.

​
id
string
required

The unique identifier assigned by QuickBooks to this other-name. This ID is unique across all other-names but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_other_name"
Example:

"qbd_other_name"

​
createdAt
string
required

The date and time when this other-name 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 other-name 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 other-name 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"

​
name
string
required

The case-insensitive unique name of this other-name, unique across all other-names.

NOTE: Other-names 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:

"John Doe"

​
isActive
boolean
required

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

Example:

true

​
companyName
string | null
required

The name of the company associated with this other-name. This name is used on invoices, checks, and other forms.

Example:

"Acme Corporation"

​
salutation
string | null
required

The formal salutation title that precedes the name of the contact person for this other-name, such as "Mr.", "Ms.", or "Dr.".

Example:

"Dr."

​
firstName
string | null
required

The first name of the contact person for this other-name.

Example:

"John"

​
middleName
string | null
required

The middle name of the contact person for this other-name.

Example:

"A."

​
lastName
string | null
required

The last name of the contact person for this other-name.

Example:

"Doe"

​
address
object | null
required

The other-name's address.

​
phone
string | null
required

The other-name's primary telephone number.

Example:

"+1-555-123-4567"

​
alternatePhone
string | null
required

The other-name's alternate telephone number.

Example:

"+1-555-987-6543"

​
fax
string | null
required

The other-name's fax number.

Example:

"+1-555-555-1212"

​
email
string | null
required

The other-name's email address.

Example:

"other-name@example.com"

​
contact
string | null
required

The name of the primary contact person for this other-name.

Example:

"Jane Smith"

​
alternateContact
string | null
required

The name of a alternate contact person for this other-name.

Example:

"Bob Johnson"

​
accountNumber
string | null
required

The other-name's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.

Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

Example:

"1010"

​
note
string | null
required

A note or comment about this other-name.

Example:

"This employee is a key employee."

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

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
customFields
The Custom Field object · object[]
required

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