Company
Retrieve company file info
QuickBooks Desktop API
Core Resources
- Auth Sessions
- End Users
Utilities
Transactions
- All Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Inventory Adjustments
- Invoices
- Item Receipts
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Time Tracking Activities
- Transfers
- Vendor Credits
General
- Account Tax Lines
- Accounts
- Classes
- Company
- Customers / Jobs
- Date-Driven Terms
- Employees
- Inventory Sites
- Payment Methods
- Payroll Wage Items
- Preferences
- Price Levels
- Sales Representatives
- Sales-Tax Codes
- Standard Terms
- Vendors
Items
- Discount Items
- Inventory Assembly Items
- Inventory Items
- Item Groups
- Item Sites
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Company
Retrieve company file info
Returns detailed information about the connected QuickBooks company file, including company address, legal name, preferences, and subscribed services. Note that company information cannot be modified through the API, only through the QuickBooks Desktop user interface.
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
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
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.
The response is of type object
.
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"
}
]
}