> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conductor.is/llms.txt
> Use this file to discover all available pages before exploring further.

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



## OpenAPI

````yaml GET /quickbooks-desktop/company
openapi: 3.1.0
info:
  title: Conductor API
  version: 0.0.1
servers:
  - url: https://api.conductor.is/v1
security:
  - BearerAuth: []
paths:
  /quickbooks-desktop/company:
    get:
      summary: Retrieve company file info
      description: >-
        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.
      parameters:
        - in: header
          name: Conductor-End-User-Id
          description: The ID of the End-User to receive this request.
          schema:
            type: string
            description: The ID of the End-User to receive this request.
            example: end_usr_1234567abcdefg
            x-stainless-naming:
              typescript:
                method_argument: conductorEndUserId
              mcp:
                method_argument: conductorEndUserId
          required: true
      responses:
        '200':
          description: Returns an object with the company file's information.
          headers:
            Conductor-Request-Id:
              schema:
                type: string
                description: The unique identifier for this API request.
                example: req_1234567abcdefg
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/qbd_company'
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Conductor from 'conductor-node';

            const conductor = new Conductor({
              apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
            });

            const company = await conductor.qbd.company.retrieve({
              conductorEndUserId: 'end_usr_1234567abcdefg',
            });

            console.log(company.accountantCopy);
        - lang: Python
          source: |-
            import os
            from conductor import Conductor

            conductor = Conductor(
                api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
            )
            company = conductor.qbd.company.retrieve(
                conductor_end_user_id="end_usr_1234567abcdefg",
            )
            print(company.accountant_copy)
components:
  schemas:
    qbd_company:
      type: object
      properties:
        isSampleCompanyFile:
          type: boolean
          description: >-
            Indicates whether the connected QuickBooks company file is a "sample
            file", which is a mock company file used for testing.
          example: false
        companyName:
          type:
            - string
            - 'null'
          description: >-
            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
        legalCompanyName:
          type:
            - string
            - 'null'
          description: >-
            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:
          oneOf:
            - $ref: '#/components/schemas/qbd_address'
            - type: 'null'
          description: >-
            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`).
        legalAddress:
          oneOf:
            - $ref: '#/components/schemas/qbd_address'
            - type: 'null'
          description: >-
            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:
          oneOf:
            - $ref: '#/components/schemas/qbd_address'
            - type: 'null'
          description: The address where this company receives mail from its customers.
        phone:
          type:
            - string
            - 'null'
          description: The company's primary telephone number.
          example: +1-555-123-4567
        fax:
          type:
            - string
            - 'null'
          description: The company's fax number.
          example: +1-555-555-1212
        email:
          type:
            - string
            - 'null'
          description: The company's email address.
          example: company@example.com
        website:
          type:
            - string
            - 'null'
          description: The company's public website.
          example: https://www.johndoeplumbing.com
        fiscalYearStartMonth:
          type:
            - string
            - 'null'
          enum:
            - january
            - february
            - march
            - april
            - may
            - june
            - july
            - august
            - september
            - october
            - november
            - december
            - null
          description: >-
            The first month of this company's fiscal year, which determines the
            default date range for financial reports.
          example: january
        incomeTaxYearStartMonth:
          type:
            - string
            - 'null'
          enum:
            - january
            - february
            - march
            - april
            - may
            - june
            - july
            - august
            - september
            - october
            - november
            - december
            - null
          description: >-
            The first month of this company's income tax year, which determines
            the default date range for financial reports.
          example: january
        companyType:
          type:
            - string
            - 'null'
          description: >-
            The company type, which the QuickBooks user selected from a list
            when creating the company file.
          example: WholesaleDistributionandSales
        ein:
          type:
            - string
            - 'null'
          description: The company's Employer Identification Number.
          example: '123456789'
        ssn:
          type:
            - string
            - 'null'
          description: >-
            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:
          type:
            - string
            - 'null'
          enum:
            - form_1040
            - form_1065
            - form_1120
            - form_1120s
            - form_990
            - form_990pf
            - form_990t
            - other_or_none
            - null
          description: >-
            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.
          example: form_1040
        subscribedServices:
          oneOf:
            - $ref: '#/components/schemas/qbd_subscribed_service'
            - type: 'null'
          description: >-
            The Intuit services that this company is or has been subscribed to,
            such as Intuit Payroll.
        accountantCopy:
          oneOf:
            - $ref: '#/components/schemas/qbd_accountant_copy'
            - type: 'null'
          description: >-
            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:
          type: array
          items:
            $ref: '#/components/schemas/qbd_custom_field'
          description: >-
            The custom fields for the company object, added as user-defined data
            extensions, not included in the standard QuickBooks object.
      required:
        - isSampleCompanyFile
        - companyName
        - legalCompanyName
        - address
        - legalAddress
        - addressForCustomer
        - phone
        - fax
        - email
        - website
        - fiscalYearStartMonth
        - incomeTaxYearStartMonth
        - companyType
        - ein
        - ssn
        - taxForm
        - subscribedServices
        - accountantCopy
        - customFields
      additionalProperties: false
      title: The Company object
      x-conductor-object-type: other
      x-conductor-sidebar-group-name: Company
      summary: >-
        Detailed information about the connected QuickBooks company file,
        including company address, legal name, preferences, and subscribed
        services.
    qbd_address:
      type: object
      properties:
        line1:
          type:
            - string
            - 'null'
          description: >-
            The first line of the address (e.g., street, PO Box, or company
            name).
          example: Conductor Labs Inc.
        line2:
          type:
            - string
            - 'null'
          description: >-
            The second line of the address, if needed (e.g., apartment, suite,
            unit, or building).
          example: 540 Market St.
        line3:
          type:
            - string
            - 'null'
          description: The third line of the address, if needed.
          example: Suite 100
        line4:
          type:
            - string
            - 'null'
          description: The fourth line of the address, if needed.
          example: ''
        line5:
          type:
            - string
            - 'null'
          description: The fifth line of the address, if needed.
          example: ''
        city:
          type:
            - string
            - 'null'
          description: The city, district, suburb, town, or village name of the address.
          example: San Francisco
        state:
          type:
            - string
            - 'null'
          description: The state, county, province, or region name of the address.
          example: CA
        postalCode:
          type:
            - string
            - 'null'
          description: The postal code or ZIP code of the address.
          example: '94110'
        country:
          type:
            - string
            - 'null'
          description: The country name of the address.
          example: United States
        note:
          type:
            - string
            - 'null'
          description: >-
            A note written at the bottom of the address in the form in which it
            appears, such as the invoice form.
          example: Conductor HQ
      required:
        - line1
        - line2
        - line3
        - line4
        - line5
        - city
        - state
        - postalCode
        - country
        - note
      additionalProperties: false
      title: The Address object
      x-conductor-object-type: nested
    qbd_subscribed_service:
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/qbd_service'
          description: >-
            The list of Intuit services that this company is or has been
            subscribed to, for example, Intuit Payroll, QBMS.
      required:
        - services
      additionalProperties: false
      title: The Subscribed Service object
      x-conductor-object-type: nested
    qbd_accountant_copy:
      type: object
      properties:
        accountantCopyExists:
          type: boolean
          description: >-
            Indicates whether an accountant copy has been made for this company
            file. An accountant copy allows an accountant to work on the books
            while the business continues daily operations.
          example: true
        dividingDate:
          type:
            - string
            - 'null'
          description: >-
            The fiscal period dividing date for accountant work, in ISO 8601
            format (YYYY-MM-DD). While an accountant copy exists, transactions
            within this period cannot be modified or created. New accounts can
            be added, but existing accounts cannot have new subaccounts, be
            edited, merged, or made inactive. List items cannot be deleted or
            merged.
          example: '2024-01-01T00:00:00.000Z'
      required:
        - accountantCopyExists
        - dividingDate
      additionalProperties: false
      title: The Accountant-Copy object
      x-conductor-object-type: nested
    qbd_custom_field:
      type: object
      properties:
        ownerId:
          type: string
          description: >-
            The identifier of the owner of the custom field, which QuickBooks
            internally calls a "data extension". For public custom fields
            visible in the UI, such as those added by the QuickBooks user, this
            is always "0". For private custom fields that are only visible to
            the application that created them, this is a valid GUID identifying
            the owning application. Internally, Conductor always fetches all
            public custom fields (those with an `ownerId` of "0") for all
            objects.
          example: '0'
        name:
          type: string
          description: >-
            The name of the custom field, unique for the specified `ownerId`.
            For public custom fields, this name is visible as a label in the
            QuickBooks UI.
          example: Customer Rating
        type:
          type: string
          enum:
            - amount_type
            - date_time_type
            - integer_type
            - percent_type
            - price_type
            - quantity_type
            - string_1024_type
            - string_255_type
          description: The data type of this custom field.
          example: string_1024_type
        value:
          type: string
          description: >-
            The value of this custom field. The maximum length depends on the
            field's data type.
          example: Premium
      required:
        - ownerId
        - name
        - type
        - value
      additionalProperties: false
      title: The Custom Field object
      x-conductor-object-type: nested
    qbd_service:
      type: object
      properties:
        name:
          type: string
          description: >-
            The case-insensitive unique name of this service, unique across all
            services.


            **NOTE**: Services 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: Intuit Payroll
        domain:
          type:
            - string
            - 'null'
          description: The domain of this subscribed service
          example: payroll.qb
        serviceStatus:
          type:
            - string
            - 'null'
          enum:
            - active
            - expired
            - never
            - pending
            - suspended
            - terminated
            - trial
            - null
          description: The status of this service's subscription.
          example: active
      required:
        - name
        - domain
        - serviceStatus
      additionalProperties: false
      title: The Service object
      x-conductor-object-type: nested
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Conductor secret key using Bearer auth (e.g., `"Authorization:
        Bearer {{YOUR_SECRET_KEY}}"`).

````

Built with [Mintlify](https://mintlify.com).