### Install Conductor SDK

Source: https://docs.conductor.is/api-ref/welcome/index

Instructions to install the Conductor SDK for Node.js using npm or yarn package managers. This SDK allows interaction with Conductor APIs.

```Node.js
# npm
npm install conductor-node

# yarn
yarn add conductor-node
```

--------------------------------

### Install Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/index

Installs the Conductor Node.js SDK using pnpm, a fast and efficient package manager, to enable interaction with the Conductor API.

```Shell
pnpm add conductor-node
```

--------------------------------

### Install Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/quickstart

Instructions to install the Conductor SDK for Node.js using either npm or yarn package managers. This SDK allows interaction with Conductor APIs.

```npm
# npm
npm install conductor-node
```

```yarn
# yarn
yarn add conductor-node
```

--------------------------------

### Install Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/quickstart

Instructions to install the Conductor Node.js SDK using the pnpm package manager. This is the first step to begin interacting with the Conductor API in your Node.js project.

```Shell
pnpm add conductor-node
```

--------------------------------

### Example QuickBooks Desktop Customer List Response

Source: https://docs.conductor.is/api-ref/welcome/quickstart

This JSON snippet illustrates the typical structure of a successful response when fetching a list of QuickBooks Desktop customers via the Conductor API. It includes key fields such as ID, objectType, creation timestamp, name, and active status for each customer entry.

```JSON
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/customers",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_customer",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "name": "ABC Corporation",
      "isActive": true,
      // ...
    }
    // ...
  ],
  // ...
}
```

--------------------------------

### Install Amazon WorkSpaces Client on macOS

Source: https://docs.conductor.is/api-ref/welcome/qbd/test-instance

Installs the Amazon WorkSpaces client application on a macOS system using Homebrew, enabling connection to a virtual Windows desktop instance.

```Shell
brew install amazon-workspaces
```

--------------------------------

### Example QuickBooks Desktop Customer List Response

Source: https://docs.conductor.is/api-ref/welcome/index

Illustrates the structure of a successful JSON response when fetching a list of QuickBooks Desktop customers from the Conductor API. It shows the object type, URL, and an array containing customer objects with their IDs, creation timestamps, names, and active status.

```JSON
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/customers",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_customer",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "name": "ABC Corporation",
      "isActive": true
      // ...
    }
    // ...
  ]
  // ...
}
```

--------------------------------

### Install Conductor Python SDK using pip

Source: https://docs.conductor.is/api-ref/welcome/api-ref/sdks

This command installs the Conductor Python SDK package using pip, the standard package installer for Python.

```bash
pip install conductor-py
```

--------------------------------

### Example Response for Create Customer API

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/customers/create

An example JSON response object returned after successfully creating a customer. It includes various customer details such as ID, name, addresses, contact information, and financial data.

```JSON
{
  "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"
    }
  ]
}
```

--------------------------------

### Install Conductor Node.js SDK using npm

Source: https://docs.conductor.is/api-ref/welcome/api-ref/sdks

This command installs the Conductor Node.js SDK package using npm, the default package manager for Node.js.

```bash
npm install conductor-node
```

--------------------------------

### Install Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/upgrade-node

Instructions to install the latest version of Conductor's Node.js SDK using npm, yarn, or pnpm.

```npm
npm install conductor-node@latest
```

--------------------------------

### Example of a shareable QuickBooks Desktop auth flow link

Source: https://docs.conductor.is/api-ref/welcome/usage/auth-flow

This is a mock example of the 'authFlowUrl' that is generated by the Conductor API. This link should be shared with your end-user to direct them to the authentication flow, enabling them to connect their QuickBooks Desktop instance to your application.

```Plain Text
https://connect.conductor.is/qbd/auth_sess_client_secret_1234567abcdefg?key={{YOUR_PUBLISHABLE_KEY}}
```

--------------------------------

### API Reference: List Credit Card Credits (GET)

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/credit-card-credits/list

This API documentation describes the GET endpoint for retrieving a list of credit card credits from QuickBooks Desktop. It includes the endpoint path and a comprehensive example of the successful JSON response, detailing the structure of credit card credit objects, including nested expense and item lines.

```APIDOC
GET /quickbooks-desktop/credit-card-credits

200 OK Response:
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/credit-card-credits",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_credit_card_credit",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Visa"
      },
      "payee": {
        "id": "80000001-1234567890",
        "fullName": "Office Depot"
      },
      "transactionDate": "2021-10-01",
      "amount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "amountInHomeCurrency": "1234.56",
      "refNumber": "CREDIT-1234",
      "memo": "Refund for returned office supplies",
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "expenseLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_expense_line",
          "account": {
            "id": "80000001-1234567890",
            "fullName": "Expenses:Office Supplies"
          },
          "amount": "1000.00",
          "memo": "New office chair",
          "payee": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Office Supplies"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "itemLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "description": "High-quality widget with custom engraving",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "cost": "1000.00",
          "amount": "1000.00",
          "customer": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Installation:Residential"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "itemGroupLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_group_line",
          "itemGroup": {
            "id": "80000001-1234567890",
            "fullName": "Office Supplies Bundle"
          },
          "description": "Standard widget bulk package",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "totalAmount": "1000.00",
          "itemLines": [
            {
              "id": "456DEF-1234567890"
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### API Reference for Listing Sales Representatives

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/sales-representatives/list

This section provides the API specification for listing sales representatives, including the HTTP GET method, endpoint path, required authorization header, and the `Conductor-End-User-Id` header with its description and example.

```APIDOC
Endpoint: GET /quickbooks-desktop/sales-representatives

Authorizations:
  Authorization:
    type: string
    location: header
    required: true
    description: Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers:
  Conductor-End-User-Id:
    type: string
    required: true
    description: The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").
    example: "end_usr_1234567abcdefg"
```

--------------------------------

### QuickBooks Desktop API Pagination Example Flow

Source: https://docs.conductor.is/api-ref/welcome/api-ref/pagination

This comprehensive example illustrates the full pagination lifecycle for fetching QuickBooks Desktop customer data. It demonstrates the initial API request, subsequent requests using the `cursor` parameter, and the expected responses, including the final state when all data has been retrieved and an error case for requesting beyond available pages.

```HTTP
GET https://api.conductor.is/v1/quickbooks_desktop/customers
```

```JSON
{
  "data": [...],
  "nextCursor": "abc123",
  "hasMore": true,
  "remainingCount": 99
}
```

```HTTP
GET https://api.conductor.is/v1/quickbooks_desktop/customers?cursor=abc123
```

```JSON
{
  "data": [...],
  "nextCursor": "abc123",
  "hasMore": false,
  "remainingCount": 0
}
```

```HTTP
GET https://api.conductor.is/v1/quickbooks_desktop/customers?cursor=abc123
```

```JSON
{
  "error": {
    "message": "No more results available"
    // ...
  }
}
```

--------------------------------

### Request Rightworks Support to Configure Auto-Startup for QuickBooks Applications

Source: https://docs.conductor.is/api-ref/welcome/help/guides/rightworks

This message is to be copied and pasted exactly into a chat with a Rightworks support agent to request the automatic launch of both QuickBooks Web Connector and QuickBooks Desktop for all users on the Rightworks account upon sign-in.

```text
Hello! Could you please configure our Rightworks account to ensure
that BOTH of the following applications are added to our startup
items and automatically launch in the background every time we sign
into our Rightworks instance?

1. QuickBooks Web Connector
2. QuickBooks Desktop

We need BOTH applications to launch automatically.

Please apply this setting for ALL USERS on our Rightworks account.
```

--------------------------------

### Sales-Tax Item Retrieval API Reference

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/sales-tax-items/retrieve

Comprehensive API documentation for retrieving a sales-tax item, detailing the GET endpoint, required authorization, headers, path parameters, and providing an example of the successful JSON response object structure.

```APIDOC
Endpoint: GET /quickbooks-desktop/sales-tax-items/{id}

Authorizations:
  Authorization:
    Type: string (header)
    Required: true
    Description: Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers:
  Conductor-End-User-Id:
    Type: string (header)
    Required: true
    Description: The ID of the EndUser to receive this request.
    Example: "end_usr_1234567abcdefg"

Path Parameters:
  id:
    Type: string (path)
    Required: true
    Description: The QuickBooks-assigned unique identifier of the sales-tax item to retrieve.
    Example: "80000001-1234567890"

Example 200 Response Body:
{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_tax_item",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Standard Tax",
  "barcode": "012345678905",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "State-Sales-Tax"
  },
  "description": "Standard rate sales tax for California",
  "taxRate": "7.5",
  "taxVendor": {
    "id": "80000001-1234567890",
    "fullName": "State Tax Agency"
  },
  "salesTaxReturnLine": {
    "id": "80000001-1234567890",
    "fullName": "Line 1: State Sales Tax"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}
```

--------------------------------

### Create Inventory Site using Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/inventory-sites/create

This JavaScript snippet demonstrates how to create a new inventory site using the Conductor Node.js SDK. It initializes the SDK with an API key and then calls the `create` method on `qbd.inventorySites` with the site name and end-user ID. The snippet also logs the ID of the newly created inventory site.

```JavaScript
import Conductor from 'conductor-node';

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

const inventorySite = await conductor.qbd.inventorySites.create({
  name: 'Stockroom',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(inventorySite.id);
```

--------------------------------

### Example Successful Employee Creation Response

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/employees/create

This JSON object represents a typical successful response after creating an employee. It includes various details about the new employee such as ID, object type, timestamps, personal information, address, contact details, employment status, and payroll information. This structure can also serve as a guide for the request body.

```JSON
{
  "id": "80000001-1234567890",
  "objectType": "qbd_employee",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "John Doe",
  "isActive": true,
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "jobTitle": "Purchasing Manager",
  "supervisor": {
    "id": "80000001-1234567890",
    "fullName": "John Doe"
  },
  "department": "Sales",
  "description": "This employee is a key employee.",
  "targetBonus": "10000.00",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "line4": "",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States"
  },
  "printAs": "John Doe",
  "phone": "+1-555-123-4567",
  "mobile": "+1-555-555-1212",
  "pager": "+1-555-555-1212",
  "pagerPin": "1234",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "ssn": "123-45-6789",
  "email": "employee@example.com",
  "customContactFields": [
    {
      "name": "Main Phone",
      "value": "555-123-4567"
    }
  ],
  "emergencyContact": {
    "primaryContact": {
      "name": "Main Phone",
      "value": "555-123-4567",
      "relation": "spouse"
    },
    "secondaryContact": {
      "name": "Main Phone",
      "value": "555-123-4567",
      "relation": "spouse"
    }
  },
  "employeeType": "regular",
  "employmentStatus": "full_time",
  "overtimeExemptStatus": "exempt",
  "keyEmployeeStatus": "key_employee",
  "gender": "male",
  "hiredDate": "2024-01-01",
  "originalHireDate": "2024-01-01",
  "adjustedServiceDate": "2024-01-01",
  "terminationDate": "2024-01-01",
  "birthDate": "1990-01-01",
  "usCitizenshipStatus": "citizen",
  "ethnicity": "asian",
  "disabilityStatus": "disabled",
  "disabilityDescription": "Cerebral Palsy",
  "i9OnFileStatus": "on_file",
  "workAuthorizationExpirationDate": "2024-01-01",
  "usVeteranStatus": "veteran",
  "militaryStatus": "active",
  "accountNumber": "1010",
  "note": "This employee is a key employee.",
  "additionalNotes": [
    {
      "id": 1,
      "date": "2021-01-01",
      "note": "This is a fun note."
    }
  ],
  "billingRate": {
    "id": "80000001-1234567890",
    "fullName": "Standard Rate"
  },
  "employeePayroll": {
    "payPeriod": "weekly",
    "class": {
      "id": "80000001-1234567890",
      "fullName": "Payroll"
    },
    "earnings": [
      {
        "payrollWageItem": {
          "id": "80000001-1234567890",
          "fullName": "Regular Pay"
        },
        "rate": "10.00",
        "ratePercent": "10.5"
      }
    ],
    "useTimeDataToCreatePaychecks": "uses_time_data",
    "sickHours": {
      "hoursAvailable": "PT8H30M",
      "accrualPeriod": "accrues_per_paycheck",
      "hoursAccruedPerPeriod": "PT8H0M",
      "maximumHours": "PT80H0M",
      "resetsHoursEachYear": false,
      "hoursUsed": "PT2H45M",
      "accrualStartDate": "2024-01-01"
    },
    "vacationHours": {
      "hoursAvailable": "PT8H30M",
      "accrualPeriod": "accrues_per_paycheck",
      "hoursAccruedPerPeriod": "PT8H0M",
      "maximumHours": "PT80H0M",
      "resetsHoursEachYear": false,
      "hoursUsed": "PT2H45M",
      "accrualStartDate": "2024-01-01"
    }
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}
```

--------------------------------

### Initialize Conductor Python SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/sdks

This snippet shows how to import the Conductor class and initialize the Python SDK with your API key. This is the first step to interact with the QuickBooks Desktop API using the Python SDK.

```python
from conductor import Conductor

conductor = Conductor(api_key="YOUR_SECRET_KEY")
```

--------------------------------

### Fetch QuickBooks Desktop Invoices with Conductor Node.js

Source: https://docs.conductor.is/api-ref/welcome/index

Demonstrates how to fetch a list of QuickBooks Desktop invoices using the Conductor Node.js SDK. It initializes the Conductor client with an API key and retrieves up to 10 invoices for a specified end-user ID, logging the data to the console.

```Node.js
import Conductor from "conductor-node";
const conductor = new Conductor({ apiKey: "{{YOUR_SECRET_KEY}}" });

async function main() {
  const invoices = await conductor.qbd.invoices.list({
    conductorEndUserId: "{{YOUR_END_USER_ID}}",
    limit: 10,
  });
  console.log(invoices.data);
}

main();
```

--------------------------------

### Conductor API Sales Order Payload Example

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/sales-orders/object

This JSON snippet demonstrates a partial structure of a sales order payload, featuring a `qbd_sales_order_line` object within an array, along with top-level custom fields and sales channel details. It serves as a guide for constructing or interpreting API requests/responses for sales order data.

```JSON
          "objectType": "qbd_sales_order_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "description": "Widget Model X100 - Blue",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "rate": "10.00",
          "ratePercent": "10.5",
          "class": {
            "id": "80000001-1234567890",
            "fullName": "West-Coast:Sales"
          },
          "amount": "1000.00",
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "quantityInvoiced": 5,
          "isManuallyClosed": true,
          "otherCustomField1": "Special handling required",
          "otherCustomField2": "Always ship with a spare",
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ],
  "salesChannelName": "ecommerce",
  "salesStoreName": "Store 1",
  "salesStoreType": "Retail"
}
```

--------------------------------

### Create Class: JavaScript Conductor Client

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/classes/create

Provides a JavaScript code example demonstrating how to create a new class using the Conductor Node.js client library. The snippet shows how to initialize the client with an API key and then call the `qbd.classes.create` method, logging the ID of the newly created class to the console.

```JavaScript
import Conductor from 'conductor-node';

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

const _class = await conductor.qbd.classes.create({
  name: 'Marketing',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(_class.id);
```

--------------------------------

### Example API Response for Listing Checks (200 OK)

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/checks/list

This JSON snippet illustrates the structure and typical data returned by the GET /quickbooks-desktop/checks API endpoint upon a successful 200 OK response. It includes details such as check ID, creation/update timestamps, bank account, payee, amount, currency, address, linked transactions, and detailed expense and item lines with custom fields.

```JSON
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/checks",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_check",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "bankAccount": {
        "id": "80000001-1234567890",
        "fullName": "Checking"
      },
      "payee": {
        "id": "80000001-1234567890",
        "fullName": "Corporate:Sales:Marketing"
      },
      "refNumber": "CHECK-1234",
      "transactionDate": "2021-10-01",
      "amount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "amountInHomeCurrency": "1234.56",
      "memo": "Payment for office supplies - Invoice INV-1234",
      "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"
      },
      "isPending": false,
      "isQueuedForPrint": true,
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "linkedTransactions": [
        {
          "id": "123ABC-1234567890",
          "objectType": "qbd_linked_transaction",
          "transactionType": "invoice",
          "transactionDate": "2021-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ],
      "expenseLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_expense_line",
          "account": {
            "id": "80000001-1234567890",
            "fullName": "Expenses:Office Supplies"
          },
          "amount": "1000.00",
          "memo": "New office chair",
          "payee": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Office Supplies"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "itemLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "description": "High-quality widget with custom engraving",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "cost": "1000.00",
          "amount": "1000.00",
          "customer": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Installation:Residential"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Inventory Site with Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/inventory-sites/create

Demonstrates how to programmatically create an inventory site using the Conductor Node.js SDK. The client is initialized with an API key, and the `create` method is called with the site's name and a user ID. The ID of the new site is then printed.

```JavaScript
import Conductor from 'conductor-node';

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

const inventorySite = await conductor.qbd.inventorySites.create({
  name: 'Stockroom',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(inventorySite.id);
```

--------------------------------

### Example Account Tax Line Object JSON

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/account-tax-lines/object

Illustrates the structure of an Account Tax Line object with example values for its properties.

```JSON
{
  "taxLineId": 123,
  "taxLineName": "State Sales Tax"
}
```

--------------------------------

### JavaScript Example: List Payment Methods with Conductor SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/payment-methods/list

This JavaScript snippet demonstrates how to use the Conductor Node.js SDK to retrieve a list of all payment methods. It initializes the SDK with an API key and then calls the `qbd.paymentMethods.list` method, logging the returned data.

```JavaScript
import Conductor from 'conductor-node';

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

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

console.log(paymentMethods.data);
```

--------------------------------

### Inventory Site Object JSON Response Example

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/inventory-sites/create

An example of the JSON object returned upon successful creation of an inventory site. It includes comprehensive details such as unique identifiers, timestamps, revision, name, activity status, parent information, default status, description, contact details, and full address.

```JSON
{
  "id": "80000001-1234567890",
  "objectType": "qbd_inventory_site",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Stockroom",
  "isActive": true,
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Romulus Warehouse:Stockroom"
  },
  "isDefault": true,
  "description": "Main Stockroom for Electronics",
  "contact": "Jane Smith",
  "phone": "+1-555-123-4567",
  "fax": "+1-555-555-1212",
  "email": "inventory-site@example.com",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "line4": "",
    "line5": "",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States"
  }
}
```

--------------------------------

### List QuickBooks Desktop Classes using Conductor Node.js SDK

Source: https://docs.conductor.is/api-ref/welcome/api-ref/qbd/classes/list

Example demonstrating how to use the Conductor Node.js SDK to fetch all classes from QuickBooks Desktop. It requires an API key and a conductorEndUserId for authentication and context.

```JavaScript
import Conductor from 'conductor-node';

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

const classes = await conductor.qbd.classes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });

console.log(classes.data);
```