COconductor-is

Retrieve an other-name

Changed on

Retrieves an other-name by ID.

IMPORTANT: If you need to fetch multiple specific other-names 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/other-names/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the other-name 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 other-name.

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

objectType'qbd_other_name' required

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

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

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

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

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

isActiveboolean required

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

companyNamestring nullable required

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

salutationstring nullable required

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

firstNamestring nullable required

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

middleNamestring nullable required

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

lastNamestring nullable required

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

phonestring nullable required

The other-name's primary telephone number.

alternatePhonestring nullable required

The other-name's alternate telephone number.

faxstring nullable required

The other-name's fax number.

emailstring nullable required

The other-name's email address.

contactstring nullable required

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

alternateContactstring nullable required

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

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

notestring nullable required

A note or comment about this other-name.

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_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",
    "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"
    }
  ]
}

Changes

  • 1de07095c4b7Revision changes
    • warning

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

  • 10d4e9ebd1dfRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property email 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 fax list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #2 from the response property oneOf list for the response status