GET
/
quickbooks-desktop
/
company
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 company = await client.qbd.company.retrieve({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(company.accountantCopy);
}

main();
{
  "isSampleCompanyFile": false,
  "companyName": "John Doe's Plumbing",
  "legalCompanyName": "John Doe's Plumbing, LLC",
  "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"
  },
  "legalAddress": {
    "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"
  },
  "addressForCustomer": {
    "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",
  "fax": "+1-555-555-1212",
  "email": "company@example.com",
  "website": "https://www.johndoeplumbing.com",
  "fiscalYearStartMonth": "january",
  "incomeTaxYearStartMonth": "january",
  "companyType": "WholesaleDistributionandSales",
  "ein": "123456789",
  "ssn": "123-45-6789",
  "taxForm": "form_1040",
  "subscribedServices": {
    "services": [
      {
        "name": "Intuit Payroll",
        "domain": "payroll.qb",
        "serviceStatus": "active"
      }
    ]
  },
  "accountantCopy": {
    "accountantCopyExists": true,
    "dividingDate": "2024-01-01T00:00:00.000Z"
  },
  "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"

Response

200 - application/json
Returns an object with the company file's information.
isSampleCompanyFile
boolean
required

Indicates whether the connected QuickBooks company file is a "sample file", which is a mock company file used for testing.

Example:

false

companyName
string | null
required

The name of the QuickBooks user's business associated with this company. This name is used on invoices, checks, and other forms, while legalCompanyName is used on tax forms and pay stubs.

Example:

"John Doe's Plumbing"

The legal name of this company's business, as specified in QuickBooks. This value is used on tax forms and pay stubs, while companyName is used on invoices, checks, and other forms.

Example:

"John Doe's Plumbing, LLC"

address
object | null
required

The company's address, used on its invoices, checks, and other forms (along with companyName). This is different from the company's legal address used on tax forms and pay stubs (along with legalCompanyName).

The company's legal address used on its tax forms and pay stubs (along with legalCompanyName). This is different from the company's address used on invoices, checks, and other forms (along with companyName).

addressForCustomer
object | null
required

The address where this company receives mail from its customers.

phone
string | null
required

The company's primary telephone number.

Example:

"+1-555-123-4567"

fax
string | null
required

The company's fax number.

Example:

"+1-555-555-1212"

email
string | null
required

The company's email address.

Example:

"company@example.com"

website
string | null
required

The company's public website.

Example:

"https://www.johndoeplumbing.com"

fiscalYearStartMonth
enum<string> | null
required

The first month of this company's fiscal year, which determines the default date range for financial reports.

Available options:
january,
february,
march,
april,
may,
june,
july,
august,
september,
october,
november,
december
Example:

"january"

incomeTaxYearStartMonth
enum<string> | null
required

The first month of this company's income tax year, which determines the default date range for financial reports.

Available options:
january,
february,
march,
april,
may,
june,
july,
august,
september,
october,
november,
december
Example:

"january"

companyType
string | null
required

The company type, which the QuickBooks user selected from a list when creating the company file.

Example:

"WholesaleDistributionandSales"

ein
string | null
required

The company's Employer Identification Number.

Example:

"123456789"

ssn
string | null
required

The company's Social Security Number. The value can be with or without dashes.

NOTE: This field cannot be changed after the company is created.

Example:

"123-45-6789"

taxForm
enum<string> | null
required

The tax form that the QuickBooks user expects to file for this company's taxes. When a specific tax form is selected (any value other than other_or_none), QuickBooks allows associating each account with a specific tax form line. This association appears in account query responses.

Available options:
form_1040,
form_1065,
form_1120,
form_1120s,
form_990,
form_990pf,
form_990t,
other_or_none
Example:

"form_1040"

subscribedServices
object | null
required

The Intuit services that this company is or has been subscribed to, such as Intuit Payroll.

accountantCopy
object | null
required

Information about the accountant's copy for this company file. An accountant's copy allows an accountant to make changes while the business continues normal operations. It includes a dividing date that defines the fiscal period the accountant can work on, with restrictions on transactions and accounts within that period. While an accountant copy exists, users cannot modify transactions dated on or before the dividing date, cannot add subaccounts to existing accounts, and cannot edit, merge, or make existing accounts inactive.

customFields
object[]
required

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