GET
/
quickbooks-desktop
/
customers
/
{id}
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 customer = await client.qbd.customers.retrieve('80000001-1234567890', {
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(customer.id);
}

main();
{
  "id": "80000001-1234567890",
  "objectType": "qbd_customer",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Website Redesign Project",
  "fullName": "ABC Corporation:Website Redesign Project",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Consulting"
  },
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "ABC Corporation"
  },
  "sublevel": 1,
  "companyName": "Acme Corporation",
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "jobTitle": "Purchasing Manager",
  "billingAddress": {
    "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"
  },
  "shippingAddress": {
    "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"
  },
  "alternateShippingAddresses": [
    {
      "name": "Alternate shipping 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",
      "isDefaultShippingAddress": true
    }
  ],
  "phone": "+1-555-123-4567",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "email": "customer@example.com",
  "ccEmail": "manager@example.com",
  "contact": "Jane Smith",
  "alternateContact": "Bob Johnson",
  "customContactFields": [
    {
      "name": "Main Phone",
      "value": "555-123-4567"
    }
  ],
  "additionalContacts": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_contact",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Jane Smith",
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "customContactFields": [
        {
          "name": "Main Phone",
          "value": "555-123-4567"
        }
      ]
    }
  ],
  "customerType": {
    "id": "80000001-1234567890",
    "fullName": "Retail Customer"
  },
  "terms": {
    "id": "80000001-1234567890",
    "fullName": "Net 30"
  },
  "salesRepresentative": {
    "id": "80000001-1234567890",
    "fullName": "Jane Doe"
  },
  "balance": "1000.00",
  "totalBalance": "5000.00",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  },
  "salesTaxCountry": "us",
  "resaleNumber": "123456789",
  "accountNumber": "1010",
  "creditLimit": "5000.00",
  "preferredPaymentMethod": {
    "id": "80000001-1234567890",
    "fullName": "Credit Card"
  },
  "creditCard": {
    "number": "xxxxxxxxxxxx1234",
    "expirationMonth": 12,
    "expirationYear": 2024,
    "name": "John Doe",
    "address": "1234 Main St, Anytown, USA, 12345",
    "postalCode": "12345"
  },
  "jobStatus": "in_progress",
  "jobStartDate": "2021-01-15",
  "jobProjectedEndDate": "2021-12-31",
  "jobEndDate": "2021-11-30",
  "jobDescription": "Kitchen renovation project for residential client.",
  "jobType": {
    "id": "80000001-1234567890",
    "fullName": "Installation"
  },
  "note": "Our favorite customer.",
  "additionalNotes": [
    {
      "id": 1,
      "date": "2021-01-01",
      "note": "This is a fun note."
    }
  ],
  "preferredDeliveryMethod": "email",
  "priceLevel": {
    "id": "80000001-1234567890",
    "fullName": "Gold Member Pricing"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "taxRegistrationNumber": "GB123456789",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "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"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the customer to retrieve.

Example:

"80000001-1234567890"

Response

200 - application/json
Returns the specified customer.

The response is of type object.