conductor-node-mcp 14.24.3 → 15.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/agent-errors.d.mts +3 -0
- package/agent-errors.d.mts.map +1 -0
- package/agent-errors.d.ts +3 -0
- package/agent-errors.d.ts.map +1 -0
- package/agent-errors.js +97 -0
- package/agent-errors.js.map +1 -0
- package/agent-errors.mjs +93 -0
- package/agent-errors.mjs.map +1 -0
- package/code-tool-worker.d.mts.map +1 -1
- package/code-tool-worker.d.ts.map +1 -1
- package/code-tool-worker.js +3 -0
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +3 -0
- package/code-tool-worker.mjs.map +1 -1
- package/code-tool.d.mts.map +1 -1
- package/code-tool.d.ts.map +1 -1
- package/code-tool.js +73 -14
- package/code-tool.js.map +1 -1
- package/code-tool.mjs +73 -14
- package/code-tool.mjs.map +1 -1
- package/http.d.mts.map +1 -1
- package/http.d.ts.map +1 -1
- package/http.js +38 -22
- package/http.js.map +1 -1
- package/http.mjs +37 -21
- package/http.mjs.map +1 -1
- package/local-docs-search.js +55 -55
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +55 -55
- package/local-docs-search.mjs.map +1 -1
- package/oauth.d.mts +26 -0
- package/oauth.d.mts.map +1 -0
- package/oauth.d.ts +26 -0
- package/oauth.d.ts.map +1 -0
- package/oauth.js +446 -0
- package/oauth.js.map +1 -0
- package/oauth.mjs +433 -0
- package/oauth.mjs.map +1 -0
- package/package.json +32 -2
- package/server.d.mts +2 -1
- package/server.d.mts.map +1 -1
- package/server.d.ts +2 -1
- package/server.d.ts.map +1 -1
- package/server.js +7 -3
- package/server.js.map +1 -1
- package/server.mjs +7 -3
- package/server.mjs.map +1 -1
- package/src/agent-errors.ts +98 -0
- package/src/code-tool-worker.ts +3 -0
- package/src/code-tool.ts +78 -18
- package/src/http.ts +35 -30
- package/src/local-docs-search.ts +55 -55
- package/src/oauth.ts +540 -0
- package/src/server.ts +8 -3
- package/src/telemetry.ts +110 -0
- package/src/types.ts +4 -0
- package/telemetry.d.mts +18 -0
- package/telemetry.d.mts.map +1 -0
- package/telemetry.d.ts +18 -0
- package/telemetry.d.ts.map +1 -0
- package/telemetry.js +105 -0
- package/telemetry.js.map +1 -0
- package/telemetry.mjs +96 -0
- package/telemetry.mjs.map +1 -0
- package/types.d.mts +2 -0
- package/types.d.mts.map +1 -1
- package/types.d.ts +2 -0
- package/types.d.ts.map +1 -1
- package/types.js.map +1 -1
- package/types.mjs.map +1 -1
package/local-docs-search.mjs
CHANGED
|
@@ -272,7 +272,7 @@ const EMBEDDED_METHODS = [
|
|
|
272
272
|
'updatedBefore?: string;',
|
|
273
273
|
],
|
|
274
274
|
response: "{ data: { id: string; accountNumber: string; accountType: string; balance: string; bankAccountNumber: string; cashFlowClassification: 'financing' | 'investing' | 'none' | 'not_applicable' | 'operating'; createdAt: string; currency: object; customFields: object[]; description: string; fullName: string; isActive: boolean; isTaxAccount: boolean; name: string; objectType: 'qbd_account'; parent: object; revisionNumber: string; salesTaxCode: object; specialAccountType: string; sublevel: number; taxLineDetails: object; totalBalance: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
275
|
-
markdown: "## list\n\n`conductor.qbd.accounts.list(Conductor-End-User-Id: string, accountType?: string, currencyIds?: string[], fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: account[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/accounts`\n\nReturns a list of accounts.\n\n**NOTE:** QuickBooks Desktop does not support pagination for accounts; hence, there is no `cursor` parameter. Users typically have few accounts.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountType?: string`\n Filter for accounts of this type.\n\n- `currencyIds?: string[]`\n Filter for accounts in these currencies.\n\n- `fullNames?: string[]`\n Filter for specific accounts by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an account, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an account is under \"Corporate\" and has the `name` \"Accounts-Payable\", its `fullName` would be \"Corporate:Accounts-Payable\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific accounts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for accounts
|
|
275
|
+
markdown: "## list\n\n`conductor.qbd.accounts.list(Conductor-End-User-Id: string, accountType?: string, currencyIds?: string[], fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: account[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/accounts`\n\nReturns a list of accounts.\n\n**NOTE:** QuickBooks Desktop does not support pagination for accounts; hence, there is no `cursor` parameter. Users typically have few accounts.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountType?: string`\n Filter for accounts of this type.\n\n- `currencyIds?: string[]`\n Filter for accounts in these currencies.\n\n- `fullNames?: string[]`\n Filter for specific accounts by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an account, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an account is under \"Corporate\" and has the `name` \"Accounts-Payable\", its `fullName` would be \"Corporate:Accounts-Payable\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific accounts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for accounts, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all accounts without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for accounts whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for accounts whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for accounts whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks returns accounts in its own internal order, not sorted by name. Do not use these parameters to page through accounts.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for accounts whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for accounts whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks returns accounts in its own internal order, not sorted by name. Do not use these parameters to page through accounts.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for accounts that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for accounts updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for accounts updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; accountNumber: string; accountType: string; balance: string; bankAccountNumber: string; cashFlowClassification: 'financing' | 'investing' | 'none' | 'not_applicable' | 'operating'; createdAt: string; currency: object; customFields: object[]; description: string; fullName: string; isActive: boolean; isTaxAccount: boolean; name: string; objectType: 'qbd_account'; parent: object; revisionNumber: string; salesTaxCode: object; specialAccountType: string; sublevel: number; taxLineDetails: object; totalBalance: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; accountNumber: string; accountType: string; balance: string; bankAccountNumber: string; cashFlowClassification: 'financing' | 'investing' | 'none' | 'not_applicable' | 'operating'; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; fullName: string; isActive: boolean; isTaxAccount: boolean; name: string; objectType: 'qbd_account'; parent: { id: string; fullName: string; }; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; specialAccountType: string; sublevel: number; taxLineDetails: { taxLineId: number; taxLineName: string; }; totalBalance: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst accounts = await conductor.qbd.accounts.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(accounts);\n```",
|
|
276
276
|
perLanguage: {
|
|
277
277
|
typescript: {
|
|
278
278
|
method: 'client.qbd.accounts.list',
|
|
@@ -419,7 +419,7 @@ const EMBEDDED_METHODS = [
|
|
|
419
419
|
'vendorIds?: string[];',
|
|
420
420
|
],
|
|
421
421
|
response: "{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: object; discountAmount: string; discountClass: object; linkedTransactions: object[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; bankAccount: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; isQueuedForPrint: boolean; memo: string; objectType: 'qbd_bill_check_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }",
|
|
422
|
-
markdown: "## list\n\n`conductor.qbd.billCheckPayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; address: object; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; bankAccount: object; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; externalId: string; isQueuedForPrint: boolean; memo: string; objectType: 'qbd_bill_check_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/bill-check-payments`\n\nReturns a list of bill check payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bill check payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bill check payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific bill check payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for bill check payments whose `refNumber` contains this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bill check payments whose `refNumber` ends with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bill check payments whose `refNumber` is greater than or equal to this value. (For checks, this field is the check number.) If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bill check payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bill check payments whose `refNumber` starts with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bill check payments whose `refNumber` is less than or equal to this value. (For checks, this field is the check number.) If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bill check payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bill check payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bill check payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bill check payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bill check payments sent to these vendors. These are the vendors who sent the bills paid by these checks.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; bankAccount: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; isQueuedForPrint: boolean; memo: string; objectType: 'qbd_bill_check_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `isQueuedForPrint: boolean`\n - `memo: string`\n - `objectType: 'qbd_bill_check_payment'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const billCheckPayment of conductor.qbd.billCheckPayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(billCheckPayment);\n}\n```",
|
|
422
|
+
markdown: "## list\n\n`conductor.qbd.billCheckPayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; address: object; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; bankAccount: object; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; externalId: string; isQueuedForPrint: boolean; memo: string; objectType: 'qbd_bill_check_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/bill-check-payments`\n\nReturns a list of bill check payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bill check payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bill check payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific bill check payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for bill check payments whose `refNumber` contains this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bill check payments whose `refNumber` ends with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bill check payments whose `refNumber` is greater than or equal to this value. (For checks, this field is the check number.) If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bill check payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bill check payments whose `refNumber` starts with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bill check payments whose `refNumber` is less than or equal to this value. (For checks, this field is the check number.) If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bill check payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bill check payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bill check payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bill check payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bill check payments sent to these vendors. These are the vendors who sent the bills paid by these checks.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; bankAccount: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; isQueuedForPrint: boolean; memo: string; objectType: 'qbd_bill_check_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `isQueuedForPrint: boolean`\n - `memo: string`\n - `objectType: 'qbd_bill_check_payment'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const billCheckPayment of conductor.qbd.billCheckPayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(billCheckPayment);\n}\n```",
|
|
423
423
|
perLanguage: {
|
|
424
424
|
typescript: {
|
|
425
425
|
method: 'client.qbd.billCheckPayments.list',
|
|
@@ -567,7 +567,7 @@ const EMBEDDED_METHODS = [
|
|
|
567
567
|
'refNumber?: string;',
|
|
568
568
|
],
|
|
569
569
|
response: "{ id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardAccount: { id: string; fullName: string; }; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }",
|
|
570
|
-
markdown: "## create\n\n`conductor.qbd.billCreditCardPayments.create(applyToTransactions: { transactionId: string; applyCredits?: { appliedAmount: string; creditTransactionId: string; overrideCreditApplication?: boolean; }[]; discountAccountId?: string; discountAmount?: string; discountClassId?: string; paymentAmount?: string; }[], creditCardAccountId: string, transactionDate: string, vendorId: string, Conductor-End-User-Id: string, exchangeRate?: number, externalId?: string, memo?: string, payablesAccountId?: string, refNumber?: string): { id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; createdAt: string; creditCardAccount: object; currency: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**post** `/quickbooks-desktop/bill-credit-card-payments`\n\nCharges one vendor’s bills to a credit card account. Each bill allocation must supply a payment amount, discount, or credit, and you have to use the same accounts payable account that’s on the bills being closed.\n\n### Parameters\n\n- `applyToTransactions: { transactionId: string; applyCredits?: { appliedAmount: string; creditTransactionId: string; overrideCreditApplication?: boolean; }[]; discountAccountId?: string; discountAmount?: string; discountClassId?: string; paymentAmount?: string; }[]`\n The bills to be paid by this bill credit card payment. This will create a link between this bill credit card payment and the specified bills.\n\n**IMPORTANT**: In each `applyToTransactions` object, you must specify either `paymentAmount`, `applyCredits`, `discountAmount`, or any combination of these; if none of these are specified, you will receive an error for an empty transaction.\n\n**IMPORTANT**: The target bill must have `isPaid=false`, otherwise, QuickBooks will report this object as \"cannot be found\".\n\n- `creditCardAccountId: string`\n The credit card account to which this bill credit card payment is being charged. This bill credit card payment will
|
|
570
|
+
markdown: "## create\n\n`conductor.qbd.billCreditCardPayments.create(applyToTransactions: { transactionId: string; applyCredits?: { appliedAmount: string; creditTransactionId: string; overrideCreditApplication?: boolean; }[]; discountAccountId?: string; discountAmount?: string; discountClassId?: string; paymentAmount?: string; }[], creditCardAccountId: string, transactionDate: string, vendorId: string, Conductor-End-User-Id: string, exchangeRate?: number, externalId?: string, memo?: string, payablesAccountId?: string, refNumber?: string): { id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; createdAt: string; creditCardAccount: object; currency: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**post** `/quickbooks-desktop/bill-credit-card-payments`\n\nCharges one vendor’s bills to a credit card account. Each bill allocation must supply a payment amount, discount, or credit, and you have to use the same accounts payable account that’s on the bills being closed.\n\n### Parameters\n\n- `applyToTransactions: { transactionId: string; applyCredits?: { appliedAmount: string; creditTransactionId: string; overrideCreditApplication?: boolean; }[]; discountAccountId?: string; discountAmount?: string; discountClassId?: string; paymentAmount?: string; }[]`\n The bills to be paid by this bill credit card payment. This will create a link between this bill credit card payment and the specified bills.\n\n**IMPORTANT**: In each `applyToTransactions` object, you must specify either `paymentAmount`, `applyCredits`, `discountAmount`, or any combination of these; if none of these are specified, you will receive an error for an empty transaction.\n\n**IMPORTANT**: The target bill must have `isPaid=false`, otherwise, QuickBooks will report this object as \"cannot be found\".\n\n- `creditCardAccountId: string`\n The credit card account to which this bill credit card payment is being charged. This bill credit card payment will increase the balance owed on this account. This account's `accountType` must be `credit_card`. To pay bills from a bank account, including a debit card or a card the company file tracks as a bank account, use `POST /quickbooks-desktop/bill-check-payments` with `bankAccountId` instead.\n\n- `transactionDate: string`\n The date of this bill credit card payment, in ISO 8601 format (YYYY-MM-DD).\n\n- `vendorId: string`\n The vendor who sent the bill(s) that this bill credit card payment is paying and who will receive this payment.\n\n**IMPORTANT**: This vendor must match the `vendor` on the bill(s) specified in `applyToTransactions`; otherwise, QuickBooks will say the `transactionId` in `applyToTransactions` \"does not exist\".\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `exchangeRate?: number`\n The market exchange rate between this bill credit card payment's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).\n\n- `externalId?: string`\n A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.\n\n- `memo?: string`\n A memo or note for this bill credit card payment.\n\nMaximum length: 4095 characters.\n\n- `payablesAccountId?: string`\n The Accounts-Payable (A/P) account to which this bill credit card payment is assigned, used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the default A/P account configured in the company file.\n\n**IMPORTANT**: If this bill credit card payment is linked to other transactions, this A/P account must match the `payablesAccount` used in those other transactions.\n\n- `refNumber?: string`\n The case-sensitive user-defined reference number for this bill credit card payment, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does *not* auto-increment).\n\nMaximum length: 11 characters.\n\n### Returns\n\n- `{ id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardAccount: { id: string; fullName: string; }; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `createdAt: string`\n - `creditCardAccount: { id: string; fullName: string; }`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_bill_credit_card_payment'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst billCreditCardPayment = await conductor.qbd.billCreditCardPayments.create({\n applyToTransactions: [{ transactionId: '123ABC-1234567890' }],\n creditCardAccountId: '80000001-1234567890',\n transactionDate: '2024-10-01',\n vendorId: '80000001-1234567890',\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(billCreditCardPayment);\n```",
|
|
571
571
|
perLanguage: {
|
|
572
572
|
typescript: {
|
|
573
573
|
method: 'client.qbd.billCreditCardPayments.create',
|
|
@@ -611,7 +611,7 @@ const EMBEDDED_METHODS = [
|
|
|
611
611
|
'vendorIds?: string[];',
|
|
612
612
|
],
|
|
613
613
|
response: "{ id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardAccount: { id: string; fullName: string; }; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }",
|
|
614
|
-
markdown: "## list\n\n`conductor.qbd.billCreditCardPayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; createdAt: string; creditCardAccount: object; currency: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/bill-credit-card-payments`\n\nReturns a list of bill credit card payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bill credit card payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bill credit card payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific bill credit card payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for bill credit card payments whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bill credit card payments whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bill credit card payments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bill credit card payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bill credit card payments whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bill credit card payments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bill credit card payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bill credit card payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bill credit card payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bill credit card payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bill credit card payments sent to these vendors. These are the vendors who sent the bills paid by these credit card payments.\n\n### Returns\n\n- `{ id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardAccount: { id: string; fullName: string; }; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `createdAt: string`\n - `creditCardAccount: { id: string; fullName: string; }`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_bill_credit_card_payment'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const billCreditCardPayment of conductor.qbd.billCreditCardPayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(billCreditCardPayment);\n}\n```",
|
|
614
|
+
markdown: "## list\n\n`conductor.qbd.billCreditCardPayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: object[]; createdAt: string; creditCardAccount: object; currency: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: object; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/bill-credit-card-payments`\n\nReturns a list of bill credit card payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bill credit card payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bill credit card payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific bill credit card payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for bill credit card payments whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bill credit card payments whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bill credit card payments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bill credit card payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bill credit card payments whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bill credit card payments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bill credit card payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bill credit card payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bill credit card payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bill credit card payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bill credit card payments sent to these vendors. These are the vendors who sent the bills paid by these credit card payments.\n\n### Returns\n\n- `{ id: string; amount: string; amountInHomeCurrency: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardAccount: { id: string; fullName: string; }; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_bill_credit_card_payment'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `createdAt: string`\n - `creditCardAccount: { id: string; fullName: string; }`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_bill_credit_card_payment'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const billCreditCardPayment of conductor.qbd.billCreditCardPayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(billCreditCardPayment);\n}\n```",
|
|
615
615
|
perLanguage: {
|
|
616
616
|
typescript: {
|
|
617
617
|
method: 'client.qbd.billCreditCardPayments.list',
|
|
@@ -774,7 +774,7 @@ const EMBEDDED_METHODS = [
|
|
|
774
774
|
'vendorIds?: string[];',
|
|
775
775
|
],
|
|
776
776
|
response: "{ id: string; amountDue: string; amountDueInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; dueDate: string; exchangeRate: number; expenseLines: object[]; externalId: string; isPaid: boolean; isPending: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_bill'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; terms: object; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; }",
|
|
777
|
-
markdown: "## list\n\n`conductor.qbd.bills.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, paymentStatus?: 'all' | 'paid' | 'not_paid', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; amountDue: string; amountDueInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; dueDate: string; exchangeRate: number; expenseLines: object[]; externalId: string; isPaid: boolean; isPending: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_bill'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; terms: object; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; }`\n\n**get** `/quickbooks-desktop/bills`\n\nReturns a list of bills. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bills associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bills in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific bills by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding bill.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'all' | 'paid' | 'not_paid'`\n Filter for bills that are paid, not paid, or both.\n\n- `refNumberContains?: string`\n Filter for bills whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bills whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bills whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bills by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bills whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bills whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bills whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bills whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bills updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bills updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bills received from these vendors.\n\n### Returns\n\n- `{ id: string; amountDue: string; amountDueInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; dueDate: string; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; isPaid: boolean; isPending: boolean; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_bill'; openAmount: string; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; terms: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; }`\n\n - `id: string`\n - `amountDue: string`\n - `amountDueInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `dueDate: string`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `isPaid: boolean`\n - `isPending: boolean`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_bill'`\n - `openAmount: string`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `terms: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n - `vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const bill of conductor.qbd.bills.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(bill);\n}\n```",
|
|
777
|
+
markdown: "## list\n\n`conductor.qbd.bills.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, paymentStatus?: 'all' | 'paid' | 'not_paid', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; amountDue: string; amountDueInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; dueDate: string; exchangeRate: number; expenseLines: object[]; externalId: string; isPaid: boolean; isPending: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_bill'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; terms: object; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; }`\n\n**get** `/quickbooks-desktop/bills`\n\nReturns a list of bills. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for bills associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for bills in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific bills by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding bill.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'all' | 'paid' | 'not_paid'`\n Filter for bills that are paid, not paid, or both.\n\n- `refNumberContains?: string`\n Filter for bills whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for bills whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for bills whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific bills by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for bills whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for bills whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for bills whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for bills whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for bills updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for bills updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for bills received from these vendors.\n\n### Returns\n\n- `{ id: string; amountDue: string; amountDueInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; dueDate: string; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; isPaid: boolean; isPending: boolean; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_bill'; openAmount: string; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; terms: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; }`\n\n - `id: string`\n - `amountDue: string`\n - `amountDueInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `dueDate: string`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `isPaid: boolean`\n - `isPending: boolean`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_bill'`\n - `openAmount: string`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `terms: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n - `vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const bill of conductor.qbd.bills.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(bill);\n}\n```",
|
|
778
778
|
perLanguage: {
|
|
779
779
|
typescript: {
|
|
780
780
|
method: 'client.qbd.bills.list',
|
|
@@ -1006,7 +1006,7 @@ const EMBEDDED_METHODS = [
|
|
|
1006
1006
|
'updatedBefore?: string;',
|
|
1007
1007
|
],
|
|
1008
1008
|
response: "{ id: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; expirationDate: string; externalId: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isPending: boolean; lines: { description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; quantityNeeded: number; quantityOnHand: number; serialNumber: string; }[]; lotNumber: string; memo: string; objectType: 'qbd_build_assembly'; quantityCanBuild: number; quantityOnHand: number; quantityOnSalesOrder: number; quantityToBuild: number; refNumber: string; revisionNumber: string; serialNumber: string; transactionDate: string; updatedAt: string; }",
|
|
1009
|
-
markdown: "## list\n\n`conductor.qbd.buildAssemblies.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], includeComponentLineItems?: boolean, itemIds?: string[], limit?: number, pendingStatus?: 'all' | 'not_pending' | 'pending', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; createdAt: string; customFields: object[]; expirationDate: string; externalId: string; inventoryAssemblyItem: object; inventorySite: object; inventorySiteLocation: object; isPending: boolean; lines: object[]; lotNumber: string; memo: string; objectType: 'qbd_build_assembly'; quantityCanBuild: number; quantityOnHand: number; quantityOnSalesOrder: number; quantityToBuild: number; refNumber: string; revisionNumber: string; serialNumber: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/build-assemblies`\n\nReturns a list of build assemblies. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific build assemblies by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeComponentLineItems?: boolean`\n Whether to include component line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for build assemblies containing these items.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `pendingStatus?: 'all' | 'not_pending' | 'pending'`\n Filter for build assemblies that are pending, not pending, or both.\n\n- `refNumberContains?: string`\n Filter for build assemblies whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for build assemblies whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for build assemblies whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific build assemblies by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for build assemblies whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for build assemblies whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for build assemblies whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for build assemblies whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for build assemblies updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for build assemblies updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; expirationDate: string; externalId: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isPending: boolean; lines: { description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; quantityNeeded: number; quantityOnHand: number; serialNumber: string; }[]; lotNumber: string; memo: string; objectType: 'qbd_build_assembly'; quantityCanBuild: number; quantityOnHand: number; quantityOnSalesOrder: number; quantityToBuild: number; refNumber: string; revisionNumber: string; serialNumber: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `expirationDate: string`\n - `externalId: string`\n - `inventoryAssemblyItem: { id: string; fullName: string; }`\n - `inventorySite: { id: string; fullName: string; }`\n - `inventorySiteLocation: { id: string; fullName: string; }`\n - `isPending: boolean`\n - `lines: { description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; quantityNeeded: number; quantityOnHand: number; serialNumber: string; }[]`\n - `lotNumber: string`\n - `memo: string`\n - `objectType: 'qbd_build_assembly'`\n - `quantityCanBuild: number`\n - `quantityOnHand: number`\n - `quantityOnSalesOrder: number`\n - `quantityToBuild: number`\n - `refNumber: string`\n - `revisionNumber: string`\n - `serialNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const buildAssembly of conductor.qbd.buildAssemblies.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(buildAssembly);\n}\n```",
|
|
1009
|
+
markdown: "## list\n\n`conductor.qbd.buildAssemblies.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], includeComponentLineItems?: boolean, itemIds?: string[], limit?: number, pendingStatus?: 'all' | 'not_pending' | 'pending', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; createdAt: string; customFields: object[]; expirationDate: string; externalId: string; inventoryAssemblyItem: object; inventorySite: object; inventorySiteLocation: object; isPending: boolean; lines: object[]; lotNumber: string; memo: string; objectType: 'qbd_build_assembly'; quantityCanBuild: number; quantityOnHand: number; quantityOnSalesOrder: number; quantityToBuild: number; refNumber: string; revisionNumber: string; serialNumber: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/build-assemblies`\n\nReturns a list of build assemblies. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific build assemblies by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeComponentLineItems?: boolean`\n Whether to include component line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for build assemblies containing these items.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `pendingStatus?: 'all' | 'not_pending' | 'pending'`\n Filter for build assemblies that are pending, not pending, or both.\n\n- `refNumberContains?: string`\n Filter for build assemblies whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for build assemblies whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for build assemblies whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific build assemblies by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for build assemblies whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for build assemblies whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for build assemblies whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for build assemblies whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for build assemblies updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for build assemblies updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; expirationDate: string; externalId: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isPending: boolean; lines: { description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; quantityNeeded: number; quantityOnHand: number; serialNumber: string; }[]; lotNumber: string; memo: string; objectType: 'qbd_build_assembly'; quantityCanBuild: number; quantityOnHand: number; quantityOnSalesOrder: number; quantityToBuild: number; refNumber: string; revisionNumber: string; serialNumber: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `expirationDate: string`\n - `externalId: string`\n - `inventoryAssemblyItem: { id: string; fullName: string; }`\n - `inventorySite: { id: string; fullName: string; }`\n - `inventorySiteLocation: { id: string; fullName: string; }`\n - `isPending: boolean`\n - `lines: { description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; quantityNeeded: number; quantityOnHand: number; serialNumber: string; }[]`\n - `lotNumber: string`\n - `memo: string`\n - `objectType: 'qbd_build_assembly'`\n - `quantityCanBuild: number`\n - `quantityOnHand: number`\n - `quantityOnSalesOrder: number`\n - `quantityToBuild: number`\n - `refNumber: string`\n - `revisionNumber: string`\n - `serialNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const buildAssembly of conductor.qbd.buildAssemblies.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(buildAssembly);\n}\n```",
|
|
1010
1010
|
perLanguage: {
|
|
1011
1011
|
typescript: {
|
|
1012
1012
|
method: 'client.qbd.buildAssemblies.list',
|
|
@@ -1182,7 +1182,7 @@ const EMBEDDED_METHODS = [
|
|
|
1182
1182
|
'updatedBefore?: string;',
|
|
1183
1183
|
],
|
|
1184
1184
|
response: "{ id: string; address: object; amount: string; amountInHomeCurrency: string; bankAccount: object; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; isPending: boolean; isQueuedForPrint: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_check'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }",
|
|
1185
|
-
markdown: "## list\n\n`conductor.qbd.checks.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; address: object; amount: string; amountInHomeCurrency: string; bankAccount: object; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; isPending: boolean; isQueuedForPrint: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_check'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/checks`\n\nReturns a list of checks. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for checks associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for checks in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific checks by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding check.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for checks addressed to these payees. These are the people or companies who will receive these checks.\n\n- `refNumberContains?: string`\n Filter for checks whose `refNumber` contains this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for checks whose `refNumber` ends with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for checks whose `refNumber` is greater than or equal to this value. (For checks, this field is the check number.) If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific checks by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for checks whose `refNumber` starts with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for checks whose `refNumber` is less than or equal to this value. (For checks, this field is the check number.) If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for checks whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for checks whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for checks updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for checks updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; amountInHomeCurrency: string; bankAccount: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; isPending: boolean; isQueuedForPrint: boolean; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_check'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForPrint: boolean`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_check'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const check of conductor.qbd.checks.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(check);\n}\n```",
|
|
1185
|
+
markdown: "## list\n\n`conductor.qbd.checks.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; address: object; amount: string; amountInHomeCurrency: string; bankAccount: object; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; isPending: boolean; isQueuedForPrint: boolean; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_check'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/checks`\n\nReturns a list of checks. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for checks associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for checks in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific checks by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding check.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for checks addressed to these payees. These are the people or companies who will receive these checks.\n\n- `refNumberContains?: string`\n Filter for checks whose `refNumber` contains this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for checks whose `refNumber` ends with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for checks whose `refNumber` is greater than or equal to this value. (For checks, this field is the check number.) If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific checks by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for checks whose `refNumber` starts with this substring. (For checks, this field is the check number.)\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for checks whose `refNumber` is less than or equal to this value. (For checks, this field is the check number.) If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for checks whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for checks whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for checks updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for checks updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; amountInHomeCurrency: string; bankAccount: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; isPending: boolean; isQueuedForPrint: boolean; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_check'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForPrint: boolean`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_check'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const check of conductor.qbd.checks.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(check);\n}\n```",
|
|
1186
1186
|
perLanguage: {
|
|
1187
1187
|
typescript: {
|
|
1188
1188
|
method: 'client.qbd.checks.list',
|
|
@@ -1364,7 +1364,7 @@ const EMBEDDED_METHODS = [
|
|
|
1364
1364
|
'updatedBefore?: string;',
|
|
1365
1365
|
],
|
|
1366
1366
|
response: "{ data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_class'; parent: object; revisionNumber: string; sublevel: number; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
1367
|
-
markdown: "## list\n\n`conductor.qbd.classes.list(Conductor-End-User-Id: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: class[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/classes`\n\nReturns a list of classes.\n\n**NOTE:** QuickBooks Desktop does not support pagination for classes; hence, there is no `cursor` parameter. Users typically have few classes.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `fullNames?: string[]`\n Filter for specific classes by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a class, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a class is under \"Department\" and has the `name` \"Marketing\", its `fullName` would be \"Department:Marketing\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific classes by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for classes
|
|
1367
|
+
markdown: "## list\n\n`conductor.qbd.classes.list(Conductor-End-User-Id: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: class[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/classes`\n\nReturns a list of classes.\n\n**NOTE:** QuickBooks Desktop does not support pagination for classes; hence, there is no `cursor` parameter. Users typically have few classes.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `fullNames?: string[]`\n Filter for specific classes by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a class, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a class is under \"Department\" and has the `name` \"Marketing\", its `fullName` would be \"Department:Marketing\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific classes by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for classes, so this parameter only limits the response size. To page through classes by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all classes without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for classes whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for classes whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for classes whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns classes sorted by `fullName` in that order; without either, the order is not guaranteed. To page through classes by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for classes whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for classes whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns classes sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for classes that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for classes updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for classes updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_class'; parent: object; revisionNumber: string; sublevel: number; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_class'; parent: { id: string; fullName: string; }; revisionNumber: string; sublevel: number; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst classes = await conductor.qbd.classes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(classes);\n```",
|
|
1368
1368
|
perLanguage: {
|
|
1369
1369
|
typescript: {
|
|
1370
1370
|
method: 'client.qbd.classes.list',
|
|
@@ -1528,7 +1528,7 @@ const EMBEDDED_METHODS = [
|
|
|
1528
1528
|
'updatedBefore?: string;',
|
|
1529
1529
|
],
|
|
1530
1530
|
response: "{ id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_charge'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }",
|
|
1531
|
-
markdown: "## list\n\n`conductor.qbd.creditCardCharges.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_charge'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-charges`\n\nReturns a list of credit card charges. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card charges associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card charges in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific credit card charges by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for credit card charges paid to these payees. These are the vendors or companies from whom merchandise or services were purchased for these credit card charges.\n\n- `refNumberContains?: string`\n Filter for credit card charges whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card charges whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card charges whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card charges by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card charges whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card charges whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card charges whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card charges whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card charges updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card charges updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_credit_card_charge'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_card_charge'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardCharge of conductor.qbd.creditCardCharges.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardCharge);\n}\n```",
|
|
1531
|
+
markdown: "## list\n\n`conductor.qbd.creditCardCharges.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_charge'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-charges`\n\nReturns a list of credit card charges. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card charges associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card charges in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific credit card charges by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for credit card charges paid to these payees. These are the vendors or companies from whom merchandise or services were purchased for these credit card charges.\n\n- `refNumberContains?: string`\n Filter for credit card charges whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card charges whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card charges whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card charges by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card charges whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card charges whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card charges whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card charges whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card charges updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card charges updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_credit_card_charge'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_card_charge'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardCharge of conductor.qbd.creditCardCharges.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardCharge);\n}\n```",
|
|
1532
1532
|
perLanguage: {
|
|
1533
1533
|
typescript: {
|
|
1534
1534
|
method: 'client.qbd.creditCardCharges.list',
|
|
@@ -1726,7 +1726,7 @@ const EMBEDDED_METHODS = [
|
|
|
1726
1726
|
'updatedBefore?: string;',
|
|
1727
1727
|
],
|
|
1728
1728
|
response: "{ id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_credit'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }",
|
|
1729
|
-
markdown: "## list\n\n`conductor.qbd.creditCardCredits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_credit'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-credits`\n\nReturns a list of credit card credits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card credits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card credits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific credit card credits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for credit card credits received from these payees. These are the vendors or companies from whom these credit card credits were received.\n\n- `refNumberContains?: string`\n Filter for credit card credits whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card credits whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card credits whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card credits by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card credits whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card credits whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card credits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card credits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card credits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card credits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_credit_card_credit'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_card_credit'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardCredit of conductor.qbd.creditCardCredits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardCredit);\n}\n```",
|
|
1729
|
+
markdown: "## list\n\n`conductor.qbd.creditCardCredits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, limit?: number, payeeIds?: string[], refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; memo: string; objectType: 'qbd_credit_card_credit'; payee: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-credits`\n\nReturns a list of credit card credits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card credits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card credits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific credit card credits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `payeeIds?: string[]`\n Filter for credit card credits received from these payees. These are the vendors or companies from whom these credit card credits were received.\n\n- `refNumberContains?: string`\n Filter for credit card credits whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card credits whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card credits whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card credits by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card credits whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card credits whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card credits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card credits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card credits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card credits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_credit_card_credit'; payee: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_card_credit'`\n - `payee: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardCredit of conductor.qbd.creditCardCredits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardCredit);\n}\n```",
|
|
1730
1730
|
perLanguage: {
|
|
1731
1731
|
typescript: {
|
|
1732
1732
|
method: 'client.qbd.creditCardCredits.list',
|
|
@@ -1925,7 +1925,7 @@ const EMBEDDED_METHODS = [
|
|
|
1925
1925
|
'updatedBefore?: string;',
|
|
1926
1926
|
],
|
|
1927
1927
|
response: "{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; createdAt: string; creditCardTransaction: { request: object; response: object; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_credit_card_refund'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; refundAppliedToTransactions: { creditRemaining: string; creditRemainingInHomeCurrency: string; refNumber: string; refundAmount: string; refundAmountInHomeCurrency: string; transactionDate: string; transactionId: string; transactionType: string; }[]; refundFromAccount: { id: string; fullName: string; }; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }",
|
|
1928
|
-
markdown: "## list\n\n`conductor.qbd.creditCardRefunds.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; address: object; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_credit_card_refund'; paymentMethod: object; receivablesAccount: object; refNumber: string; refundAppliedToTransactions: object[]; refundFromAccount: object; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-refunds`\n\nReturns a list of credit card refunds. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card refunds associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card refunds in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for credit card refunds refunded to these customers.\n\n- `ids?: string[]`\n Filter for specific credit card refunds by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for credit card refunds whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card refunds whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card refunds whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card refunds by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card refunds whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card refunds whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card refunds whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card refunds whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card refunds updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card refunds updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_credit_card_refund'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; refundAppliedToTransactions: { creditRemaining: string; creditRemainingInHomeCurrency: string; refNumber: string; refundAmount: string; refundAmountInHomeCurrency: string; transactionDate: string; transactionId: string; transactionType: string; }[]; refundFromAccount: { id: string; fullName: string; }; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_credit_card_refund'`\n - `paymentMethod: { id: string; fullName: string; }`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `refundAppliedToTransactions: { creditRemaining: string; creditRemainingInHomeCurrency: string; refNumber: string; refundAmount: string; refundAmountInHomeCurrency: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `refundFromAccount: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardRefund of conductor.qbd.creditCardRefunds.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardRefund);\n}\n```",
|
|
1928
|
+
markdown: "## list\n\n`conductor.qbd.creditCardRefunds.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; address: object; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customFields: object[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_credit_card_refund'; paymentMethod: object; receivablesAccount: object; refNumber: string; refundAppliedToTransactions: object[]; refundFromAccount: object; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-card-refunds`\n\nReturns a list of credit card refunds. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit card refunds associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit card refunds in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for credit card refunds refunded to these customers.\n\n- `ids?: string[]`\n Filter for specific credit card refunds by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for credit card refunds whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit card refunds whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit card refunds whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit card refunds by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit card refunds whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit card refunds whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit card refunds whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit card refunds whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit card refunds updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit card refunds updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_credit_card_refund'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; refundAppliedToTransactions: { creditRemaining: string; creditRemainingInHomeCurrency: string; refNumber: string; refundAmount: string; refundAmountInHomeCurrency: string; transactionDate: string; transactionId: string; transactionType: string; }[]; refundFromAccount: { id: string; fullName: string; }; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_credit_card_refund'`\n - `paymentMethod: { id: string; fullName: string; }`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `refundAppliedToTransactions: { creditRemaining: string; creditRemainingInHomeCurrency: string; refNumber: string; refundAmount: string; refundAmountInHomeCurrency: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `refundFromAccount: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditCardRefund of conductor.qbd.creditCardRefunds.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditCardRefund);\n}\n```",
|
|
1929
1929
|
perLanguage: {
|
|
1930
1930
|
typescript: {
|
|
1931
1931
|
method: 'client.qbd.creditCardRefunds.list',
|
|
@@ -2099,7 +2099,7 @@ const EMBEDDED_METHODS = [
|
|
|
2099
2099
|
'updatedBefore?: string;',
|
|
2100
2100
|
],
|
|
2101
2101
|
response: "{ id: string; billingAddress: object; class: object; createdAt: string; creditRemaining: string; creditRemainingInHomeCurrency: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_credit_memo'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; transactionDate: string; updatedAt: string; }",
|
|
2102
|
-
markdown: "## list\n\n`conductor.qbd.creditMemos.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; creditRemaining: string; creditRemainingInHomeCurrency: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_credit_memo'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-memos`\n\nReturns a list of credit memos. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit memos associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit memos in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for credit memos created for these customers. These are the customers who are owed money.\n\n- `ids?: string[]`\n Filter for specific credit memos by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding credit memo.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for credit memos whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit memos whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit memos whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit memos by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit memos whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit memos whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit memos whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit memos whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit memos updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit memos updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; creditRemaining: string; creditRemainingInHomeCurrency: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_credit_memo_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_credit_memo'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `creditRemaining: string`\n - `creditRemainingInHomeCurrency: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_credit_memo_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_memo'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditMemo of conductor.qbd.creditMemos.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditMemo);\n}\n```",
|
|
2102
|
+
markdown: "## list\n\n`conductor.qbd.creditMemos.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; creditRemaining: string; creditRemainingInHomeCurrency: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_credit_memo'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/credit-memos`\n\nReturns a list of credit memos. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for credit memos associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for credit memos in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for credit memos created for these customers. These are the customers who are owed money.\n\n- `ids?: string[]`\n Filter for specific credit memos by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding credit memo.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for credit memos whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for credit memos whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for credit memos whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific credit memos by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for credit memos whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for credit memos whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for credit memos whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for credit memos whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for credit memos updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for credit memos updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; creditRemaining: string; creditRemainingInHomeCurrency: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_credit_memo_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_credit_memo'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `creditRemaining: string`\n - `creditRemainingInHomeCurrency: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_credit_memo_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_credit_memo_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_credit_memo'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const creditMemo of conductor.qbd.creditMemos.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(creditMemo);\n}\n```",
|
|
2103
2103
|
perLanguage: {
|
|
2104
2104
|
typescript: {
|
|
2105
2105
|
method: 'client.qbd.creditMemos.list',
|
|
@@ -2298,7 +2298,7 @@ const EMBEDDED_METHODS = [
|
|
|
2298
2298
|
'updatedBefore?: string;',
|
|
2299
2299
|
],
|
|
2300
2300
|
response: "{ data: { id: string; asOfDate: string; createdAt: string; currencyCode: string; currencyFormat: object; exchangeRate: number; isActive: boolean; isUserDefinedCurrency: boolean; name: string; objectType: 'qbd_currency'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
2301
|
-
markdown: "## list\n\n`conductor.qbd.currencies.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: currency[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/currencies`\n\nReturns a list of currencies.\n\n**NOTE:** QuickBooks Desktop does not support pagination for currencies; hence, there is no `cursor` parameter. Users typically have few currencies.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific currencies by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for currencies
|
|
2301
|
+
markdown: "## list\n\n`conductor.qbd.currencies.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: currency[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/currencies`\n\nReturns a list of currencies.\n\n**NOTE:** QuickBooks Desktop does not support pagination for currencies; hence, there is no `cursor` parameter. Users typically have few currencies.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific currencies by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for currencies, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all currencies without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for currencies whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for currencies whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for currencies whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific currencies by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a currency.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for currencies whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for currencies whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for currencies that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for currencies updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for currencies updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; asOfDate: string; createdAt: string; currencyCode: string; currencyFormat: object; exchangeRate: number; isActive: boolean; isUserDefinedCurrency: boolean; name: string; objectType: 'qbd_currency'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; asOfDate: string; createdAt: string; currencyCode: string; currencyFormat: { decimalPlaces: '0' | '2'; decimalSeparator: 'comma' | 'period'; thousandSeparator: 'apostrophe' | 'comma' | 'period' | 'space'; thousandSeparatorGrouping: 'x_xx_xx_xxx' | 'xx_xxx_xxx'; }; exchangeRate: number; isActive: boolean; isUserDefinedCurrency: boolean; name: string; objectType: 'qbd_currency'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst currencies = await conductor.qbd.currencies.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(currencies);\n```",
|
|
2302
2302
|
perLanguage: {
|
|
2303
2303
|
typescript: {
|
|
2304
2304
|
method: 'client.qbd.currencies.list',
|
|
@@ -2419,7 +2419,7 @@ const EMBEDDED_METHODS = [
|
|
|
2419
2419
|
'updatedBefore?: string;',
|
|
2420
2420
|
],
|
|
2421
2421
|
response: "{ data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_customer_type'; parent: object; revisionNumber: string; sublevel: number; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
2422
|
-
markdown: "## list\n\n`conductor.qbd.customerTypes.list(Conductor-End-User-Id: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: customer_type[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/customer-types`\n\nReturns a list of customer types.\n\n**NOTE:** QuickBooks Desktop does not support pagination for customer types; hence, there is no `cursor` parameter. Users typically have few customer types.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `fullNames?: string[]`\n Filter for specific customer types by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a customer type, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a customer type is under \"Industry\" and has the `name` \"Healthcare\", its `fullName` would be \"Industry:Healthcare\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific customer types by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for customer types
|
|
2422
|
+
markdown: "## list\n\n`conductor.qbd.customerTypes.list(Conductor-End-User-Id: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: customer_type[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/customer-types`\n\nReturns a list of customer types.\n\n**NOTE:** QuickBooks Desktop does not support pagination for customer types; hence, there is no `cursor` parameter. Users typically have few customer types.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `fullNames?: string[]`\n Filter for specific customer types by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a customer type, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a customer type is under \"Industry\" and has the `name` \"Healthcare\", its `fullName` would be \"Industry:Healthcare\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific customer types by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for customer types, so this parameter only limits the response size. To page through customer types by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all customer types without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for customer types whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for customer types whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for customer types whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns customer types sorted by `fullName` in that order; without either, the order is not guaranteed. To page through customer types by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for customer types whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for customer types whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns customer types sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for customer types that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for customer types updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for customer types updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_customer_type'; parent: object; revisionNumber: string; sublevel: number; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_customer_type'; parent: { id: string; fullName: string; }; revisionNumber: string; sublevel: number; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst customerTypes = await conductor.qbd.customerTypes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(customerTypes);\n```",
|
|
2423
2423
|
perLanguage: {
|
|
2424
2424
|
typescript: {
|
|
2425
2425
|
method: 'client.qbd.customerTypes.list',
|
|
@@ -2566,7 +2566,7 @@ const EMBEDDED_METHODS = [
|
|
|
2566
2566
|
'updatedBefore?: string;',
|
|
2567
2567
|
],
|
|
2568
2568
|
response: 'object',
|
|
2569
|
-
markdown: "## list\n\n`conductor.qbd.customers.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, excludeAlternateShippingAddresses?: boolean, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; alternateShippingAddresses: object[]; balance: string; billingAddress: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditCard: object; creditLimit: string; currency: object; customContactFields: object[]; customerType: object; customFields: object[]; email: string; externalId: string; fax: string; firstName: string; fullName: string; isActive: boolean; jobDescription: string; jobEndDate: string; jobProjectedEndDate: string; jobStartDate: string; jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'; jobTitle: string; jobType: object; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_customer'; parent: object; phone: string; preferredDeliveryMethod: 'email' | 'mail' | 'none'; preferredPaymentMethod: object; priceLevel: object; resaleNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxCountry: string; salesTaxItem: object; salutation: string; shippingAddress: object; sublevel: number; taxRegistrationNumber: string; terms: object; totalBalance: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/customers`\n\nReturns a list of customers. Use the `cursor` parameter to paginate through the results.\n\n**IMPORTANT**: If this request times out or is slow, set `excludeAlternateShippingAddresses=true` to significantly improve performance. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for customers of these classes. A class is a way end-users can categorize customers in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for customers in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `excludeAlternateShippingAddresses?: boolean`\n Excludes alternate shipping addresses from each customer returned by the list request. When true, the response returns `alternateShippingAddresses` as `null` instead of fetching the address array. Use this when your integration does not need alternate shipping addresses. This significantly improves performance for company files where some customers have many saved shipping addresses (sometimes dozens or hundreds).\n\n- `fullNames?: string[]`\n Filter for specific customers by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a customer, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a customer is under \"ABC Corporation\" and has the `name` \"Website Redesign Project\", its `fullName` would be \"ABC Corporation:Website Redesign Project\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific customers by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for customers whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for customers whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for customers whose `name` is alphabetically greater than or equal to this value.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for customers whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for customers whose `name` is alphabetically less than or equal to this value.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for customers that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for customers whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for customers whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for customers whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for customers whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for customers whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for customers updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for customers updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; alternateShippingAddresses: { city: string; country: string; isDefaultShippingAddress: boolean; line1: string; line2: string; line3: string; line4: string; line5: string; name: string; note: string; postalCode: string; state: string; }[]; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditCard: { address: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; }; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customerType: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; email: string; externalId: string; fax: string; firstName: string; fullName: string; isActive: boolean; jobDescription: string; jobEndDate: string; jobProjectedEndDate: string; jobStartDate: string; jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'; jobTitle: string; jobType: { id: string; fullName: string; }; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_customer'; parent: { id: string; fullName: string; }; phone: string; preferredDeliveryMethod: 'email' | 'mail' | 'none'; preferredPaymentMethod: { id: string; fullName: string; }; priceLevel: { id: string; fullName: string; }; resaleNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxItem: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; sublevel: number; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; totalBalance: string; updatedAt: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `alternateShippingAddresses: { city: string; country: string; isDefaultShippingAddress: boolean; line1: string; line2: string; line3: string; line4: string; line5: string; name: string; note: string; postalCode: string; state: string; }[]`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditCard: { address: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; }`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customerType: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `fullName: string`\n - `isActive: boolean`\n - `jobDescription: string`\n - `jobEndDate: string`\n - `jobProjectedEndDate: string`\n - `jobStartDate: string`\n - `jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'`\n - `jobTitle: string`\n - `jobType: { id: string; fullName: string; }`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_customer'`\n - `parent: { id: string; fullName: string; }`\n - `phone: string`\n - `preferredDeliveryMethod: 'email' | 'mail' | 'none'`\n - `preferredPaymentMethod: { id: string; fullName: string; }`\n - `priceLevel: { id: string; fullName: string; }`\n - `resaleNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `sublevel: number`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `totalBalance: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const customer of conductor.qbd.customers.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(customer);\n}\n```",
|
|
2569
|
+
markdown: "## list\n\n`conductor.qbd.customers.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, excludeAlternateShippingAddresses?: boolean, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; alternateShippingAddresses: object[]; balance: string; billingAddress: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditCard: object; creditLimit: string; currency: object; customContactFields: object[]; customerType: object; customFields: object[]; email: string; externalId: string; fax: string; firstName: string; fullName: string; isActive: boolean; jobDescription: string; jobEndDate: string; jobProjectedEndDate: string; jobStartDate: string; jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'; jobTitle: string; jobType: object; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_customer'; parent: object; phone: string; preferredDeliveryMethod: 'email' | 'mail' | 'none'; preferredPaymentMethod: object; priceLevel: object; resaleNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxCountry: string; salesTaxItem: object; salutation: string; shippingAddress: object; sublevel: number; taxRegistrationNumber: string; terms: object; totalBalance: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/customers`\n\nReturns a list of customers. Use the `cursor` parameter to paginate through the results.\n\n**IMPORTANT**: If this request times out or is slow, set `excludeAlternateShippingAddresses=true` to significantly improve performance. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for customers of these classes. A class is a way end-users can categorize customers in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for customers in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `excludeAlternateShippingAddresses?: boolean`\n Excludes alternate shipping addresses from each customer returned by the list request. When true, the response returns `alternateShippingAddresses` as `null` instead of fetching the address array. Use this when your integration does not need alternate shipping addresses. This significantly improves performance for company files where some customers have many saved shipping addresses (sometimes dozens or hundreds).\n\n- `fullNames?: string[]`\n Filter for specific customers by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a customer, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a customer is under \"ABC Corporation\" and has the `name` \"Website Redesign Project\", its `fullName` would be \"ABC Corporation:Website Redesign Project\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific customers by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for customers whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for customers whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for customers whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns customers sorted by `fullName` in that order; without either, the order is not guaranteed. To page through customers by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for customers whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for customers whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns customers sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for customers that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for customers whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for customers whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for customers whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for customers whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for customers whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for customers updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for customers updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; alternateShippingAddresses: { city: string; country: string; isDefaultShippingAddress: boolean; line1: string; line2: string; line3: string; line4: string; line5: string; name: string; note: string; postalCode: string; state: string; }[]; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditCard: { address: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; }; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customerType: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; email: string; externalId: string; fax: string; firstName: string; fullName: string; isActive: boolean; jobDescription: string; jobEndDate: string; jobProjectedEndDate: string; jobStartDate: string; jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'; jobTitle: string; jobType: { id: string; fullName: string; }; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_customer'; parent: { id: string; fullName: string; }; phone: string; preferredDeliveryMethod: 'email' | 'mail' | 'none'; preferredPaymentMethod: { id: string; fullName: string; }; priceLevel: { id: string; fullName: string; }; resaleNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxItem: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; sublevel: number; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; totalBalance: string; updatedAt: string; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `alternateShippingAddresses: { city: string; country: string; isDefaultShippingAddress: boolean; line1: string; line2: string; line3: string; line4: string; line5: string; name: string; note: string; postalCode: string; state: string; }[]`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditCard: { address: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; }`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customerType: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `fullName: string`\n - `isActive: boolean`\n - `jobDescription: string`\n - `jobEndDate: string`\n - `jobProjectedEndDate: string`\n - `jobStartDate: string`\n - `jobStatus: 'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'`\n - `jobTitle: string`\n - `jobType: { id: string; fullName: string; }`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `note: string`\n - `objectType: 'qbd_customer'`\n - `parent: { id: string; fullName: string; }`\n - `phone: string`\n - `preferredDeliveryMethod: 'email' | 'mail' | 'none'`\n - `preferredPaymentMethod: { id: string; fullName: string; }`\n - `priceLevel: { id: string; fullName: string; }`\n - `resaleNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `sublevel: number`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `totalBalance: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const customer of conductor.qbd.customers.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(customer);\n}\n```",
|
|
2570
2570
|
perLanguage: {
|
|
2571
2571
|
typescript: {
|
|
2572
2572
|
method: 'client.qbd.customers.list',
|
|
@@ -2736,7 +2736,7 @@ const EMBEDDED_METHODS = [
|
|
|
2736
2736
|
'updatedBefore?: string;',
|
|
2737
2737
|
],
|
|
2738
2738
|
response: "{ data: { id: string; createdAt: string; discountDayOfMonth: number; discountPercentage: string; dueDayOfMonth: number; gracePeriodDays: number; isActive: boolean; name: string; objectType: 'qbd_date_driven_term'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
2739
|
-
markdown: "## list\n\n`conductor.qbd.dateDrivenTerms.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: date_driven_term[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/date-driven-terms`\n\nReturns a list of date-driven terms.\n\n**NOTE:** QuickBooks Desktop does not support pagination for date-driven terms; hence, there is no `cursor` parameter. Users typically have few date-driven terms.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific date-driven terms by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for date-driven terms
|
|
2739
|
+
markdown: "## list\n\n`conductor.qbd.dateDrivenTerms.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: date_driven_term[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/date-driven-terms`\n\nReturns a list of date-driven terms.\n\n**NOTE:** QuickBooks Desktop does not support pagination for date-driven terms; hence, there is no `cursor` parameter. Users typically have few date-driven terms.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific date-driven terms by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for date-driven terms, so this parameter only limits the response size. To page through date-driven terms by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all date-driven terms without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for date-driven terms whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for date-driven terms whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for date-driven terms whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns date-driven terms sorted by `name` in that order; without either, the order is not guaranteed. To page through date-driven terms by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific date-driven terms by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a date-driven term.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for date-driven terms whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for date-driven terms whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns date-driven terms sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for date-driven terms that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for date-driven terms updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for date-driven terms updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; discountDayOfMonth: number; discountPercentage: string; dueDayOfMonth: number; gracePeriodDays: number; isActive: boolean; name: string; objectType: 'qbd_date_driven_term'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; discountDayOfMonth: number; discountPercentage: string; dueDayOfMonth: number; gracePeriodDays: number; isActive: boolean; name: string; objectType: 'qbd_date_driven_term'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst dateDrivenTerms = await conductor.qbd.dateDrivenTerms.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(dateDrivenTerms);\n```",
|
|
2740
2740
|
perLanguage: {
|
|
2741
2741
|
typescript: {
|
|
2742
2742
|
method: 'client.qbd.dateDrivenTerms.list',
|
|
@@ -2894,7 +2894,7 @@ const EMBEDDED_METHODS = [
|
|
|
2894
2894
|
'updatedBefore?: string;',
|
|
2895
2895
|
],
|
|
2896
2896
|
response: "{ id: string; cashBack: { id: string; account: { id: string; fullName: string; }; amount: string; memo: string; objectType: 'qbd_deposit_cash_back_line'; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; lines: { id: string; account: { id: string; fullName: string; }; amount: string; checkNumber: string; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_deposit_line'; paymentMethod: { id: string; fullName: string; }; paymentTransactionId: string; paymentTransactionLineId: string; transactionType: string; }[]; memo: string; objectType: 'qbd_deposit'; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }",
|
|
2897
|
-
markdown: "## list\n\n`conductor.qbd.deposits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, entityIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; cashBack: object; createdAt: string; currency: object; customFields: object[]; depositToAccount: object; exchangeRate: number; externalId: string; lines: object[]; memo: string; objectType: 'qbd_deposit'; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/deposits`\n\nReturns a list of deposits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for deposits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for deposits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `entityIds?: string[]`\n Filter for deposits associated with these entities (customers, vendors, employees, etc.). These are the entities referenced on the deposit's manual lines.\n\n- `ids?: string[]`\n Filter for specific deposits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for deposits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for deposits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for deposits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for deposits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; cashBack: { id: string; account: { id: string; fullName: string; }; amount: string; memo: string; objectType: 'qbd_deposit_cash_back_line'; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; lines: { id: string; account: { id: string; fullName: string; }; amount: string; checkNumber: string; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_deposit_line'; paymentMethod: { id: string; fullName: string; }; paymentTransactionId: string; paymentTransactionLineId: string; transactionType: string; }[]; memo: string; objectType: 'qbd_deposit'; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `cashBack: { id: string; account: { id: string; fullName: string; }; amount: string; memo: string; objectType: 'qbd_deposit_cash_back_line'; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `externalId: string`\n - `lines: { id: string; account: { id: string; fullName: string; }; amount: string; checkNumber: string; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_deposit_line'; paymentMethod: { id: string; fullName: string; }; paymentTransactionId: string; paymentTransactionLineId: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_deposit'`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const deposit of conductor.qbd.deposits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(deposit);\n}\n```",
|
|
2897
|
+
markdown: "## list\n\n`conductor.qbd.deposits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, entityIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; cashBack: object; createdAt: string; currency: object; customFields: object[]; depositToAccount: object; exchangeRate: number; externalId: string; lines: object[]; memo: string; objectType: 'qbd_deposit'; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/deposits`\n\nReturns a list of deposits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for deposits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for deposits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `entityIds?: string[]`\n Filter for deposits associated with these entities (customers, vendors, employees, etc.). These are the entities referenced on the deposit's manual lines.\n\n- `ids?: string[]`\n Filter for specific deposits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for deposits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for deposits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for deposits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for deposits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; cashBack: { id: string; account: { id: string; fullName: string; }; amount: string; memo: string; objectType: 'qbd_deposit_cash_back_line'; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; lines: { id: string; account: { id: string; fullName: string; }; amount: string; checkNumber: string; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_deposit_line'; paymentMethod: { id: string; fullName: string; }; paymentTransactionId: string; paymentTransactionLineId: string; transactionType: string; }[]; memo: string; objectType: 'qbd_deposit'; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `cashBack: { id: string; account: { id: string; fullName: string; }; amount: string; memo: string; objectType: 'qbd_deposit_cash_back_line'; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `externalId: string`\n - `lines: { id: string; account: { id: string; fullName: string; }; amount: string; checkNumber: string; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_deposit_line'; paymentMethod: { id: string; fullName: string; }; paymentTransactionId: string; paymentTransactionLineId: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_deposit'`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const deposit of conductor.qbd.deposits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(deposit);\n}\n```",
|
|
2898
2898
|
perLanguage: {
|
|
2899
2899
|
typescript: {
|
|
2900
2900
|
method: 'client.qbd.deposits.list',
|
|
@@ -3083,7 +3083,7 @@ const EMBEDDED_METHODS = [
|
|
|
3083
3083
|
'updatedBefore?: string;',
|
|
3084
3084
|
],
|
|
3085
3085
|
response: "{ id: string; account: { id: string; fullName: string; }; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; discountRate: string; discountRatePercent: string; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_discount_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; sublevel: number; updatedAt: string; }",
|
|
3086
|
-
markdown: "## list\n\n`conductor.qbd.discountItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; account: object; barcode: string; class: object; createdAt: string; customFields: object[]; description: string; discountRate: string; discountRatePercent: string; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_discount_item'; parent: object; revisionNumber: string; salesTaxCode: object; sublevel: number; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/discount-items`\n\nReturns a list of discount items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for discount items of these classes. A class is a way end-users can categorize discount items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific discount items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a discount item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a discount item is under \"Discounts\" and has the `name` \"10% labor discount\", its `fullName` would be \"Discounts:10% labor discount\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific discount items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for discount items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for discount items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for discount items whose `
|
|
3086
|
+
markdown: "## list\n\n`conductor.qbd.discountItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; account: object; barcode: string; class: object; createdAt: string; customFields: object[]; description: string; discountRate: string; discountRatePercent: string; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_discount_item'; parent: object; revisionNumber: string; salesTaxCode: object; sublevel: number; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/discount-items`\n\nReturns a list of discount items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for discount items of these classes. A class is a way end-users can categorize discount items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific discount items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a discount item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a discount item is under \"Discounts\" and has the `name` \"10% labor discount\", its `fullName` would be \"Discounts:10% labor discount\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific discount items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for discount items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for discount items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for discount items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through discount items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for discount items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for discount items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for discount items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for discount items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for discount items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; account: { id: string; fullName: string; }; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; discountRate: string; discountRatePercent: string; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_discount_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; sublevel: number; updatedAt: string; }`\n\n - `id: string`\n - `account: { id: string; fullName: string; }`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `description: string`\n - `discountRate: string`\n - `discountRatePercent: string`\n - `externalId: string`\n - `fullName: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_discount_item'`\n - `parent: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `sublevel: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const discountItem of conductor.qbd.discountItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(discountItem);\n}\n```",
|
|
3087
3087
|
perLanguage: {
|
|
3088
3088
|
typescript: {
|
|
3089
3089
|
method: 'client.qbd.discountItems.list',
|
|
@@ -3259,7 +3259,7 @@ const EMBEDDED_METHODS = [
|
|
|
3259
3259
|
'updatedBefore?: string;',
|
|
3260
3260
|
],
|
|
3261
3261
|
response: "{ data: object[]; objectType: 'list'; url: string; }",
|
|
3262
|
-
markdown: "## list\n\n`conductor.qbd.employees.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: employee[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/employees`\n\nReturns a list of employees.\n\n**NOTE:** QuickBooks Desktop does not support pagination for employees; hence, there is no `cursor` parameter. Users typically have few employees.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific employees by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for employees
|
|
3262
|
+
markdown: "## list\n\n`conductor.qbd.employees.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: employee[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/employees`\n\nReturns a list of employees.\n\n**NOTE:** QuickBooks Desktop does not support pagination for employees; hence, there is no `cursor` parameter. Users typically have few employees.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific employees by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for employees, so this parameter only limits the response size. To page through employees by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all employees without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for employees whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for employees whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for employees whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by `name` in that order; without either, the order is not guaranteed. To page through employees by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific employees by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an employee.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for employees whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for employees whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for employees that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for employees updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for employees updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; accountNumber: string; additionalNotes: object[]; address: object; adjustedServiceDate: string; alternatePhone: string; billingRate: object; birthDate: string; createdAt: string; customContactFields: object[]; customFields: object[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: object; employeePayroll: object; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: object; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; accountNumber: string; additionalNotes: { id: number; date: string; note: string; }[]; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; postalCode: string; state: string; }; adjustedServiceDate: string; alternatePhone: string; billingRate: { id: string; fullName: string; }; birthDate: string; createdAt: string; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; department: string; description: string; disabilityDescription: string; disabilityStatus: 'disabled' | 'non_disabled'; email: string; emergencyContact: { primaryContact: { name: string; relation: string; value: string; }; secondaryContact: { name: string; relation: string; value: string; }; }; employeePayroll: { class: { id: string; fullName: string; }; earnings: { payrollWageItem: object; rate: string; ratePercent: string; }[]; payPeriod: 'biweekly' | 'daily' | 'monthly' | 'quarterly' | 'semimonthly' | 'weekly' | 'yearly'; sickHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; useTimeDataToCreatePaychecks: 'does_not_use_time_data' | 'not_set' | 'uses_time_data'; vacationHours: { accrualPeriod: 'accrues_annually' | 'accrues_hourly' | 'accrues_per_paycheck'; accrualStartDate: string; hoursAccruedPerPeriod: string; hoursAvailable: string; hoursUsed: string; maximumHours: string; resetsHoursEachYear: boolean; }; }; employeeType: 'officer' | 'owner' | 'regular' | 'statutory'; employmentStatus: 'full_time' | 'part_time'; ethnicity: 'american_indian' | 'asian' | 'black' | 'hawaiian' | 'hispanic' | 'white' | 'two_or_more_races'; externalId: string; fax: string; firstName: string; gender: 'male' | 'female'; hiredDate: string; i9OnFileStatus: 'on_file' | 'not_on_file'; isActive: boolean; jobTitle: string; keyEmployeeStatus: 'key_employee' | 'non_key_employee'; lastName: string; middleName: string; militaryStatus: 'active' | 'reserve'; mobile: string; name: string; note: string; objectType: 'qbd_employee'; originalHireDate: string; overtimeExemptStatus: 'exempt' | 'non_exempt'; pager: string; pagerPin: string; phone: string; printAs: string; revisionNumber: string; salutation: string; ssn: string; supervisor: { id: string; fullName: string; }; targetBonus: string; terminationDate: string; updatedAt: string; usCitizenshipStatus: 'citizen' | 'non_citizen'; usVeteranStatus: 'veteran' | 'non_veteran'; workAuthorizationExpirationDate: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst employees = await conductor.qbd.employees.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(employees);\n```",
|
|
3263
3263
|
perLanguage: {
|
|
3264
3264
|
typescript: {
|
|
3265
3265
|
method: 'client.qbd.employees.list',
|
|
@@ -3451,7 +3451,7 @@ const EMBEDDED_METHODS = [
|
|
|
3451
3451
|
'updatedBefore?: string;',
|
|
3452
3452
|
],
|
|
3453
3453
|
response: "{ id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isActive: boolean; isQueuedForEmail: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_estimate'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }",
|
|
3454
|
-
markdown: "## list\n\n`conductor.qbd.estimates.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isActive: boolean; isQueuedForEmail: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_estimate'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/estimates`\n\nReturns a list of estimates. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for estimates associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for estimates in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for estimates created for these customers.\n\n- `ids?: string[]`\n Filter for specific estimates by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding estimate.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for estimates whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for estimates whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for estimates whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific estimates by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for estimates whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for estimates whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for estimates whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for estimates whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for estimates updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for estimates updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isActive: boolean; isQueuedForEmail: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; inventorySite: object; inventorySiteLocation: object; item: object; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; unitOfMeasure: string; }[]; objectType: 'qbd_estimate_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_estimate'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isActive: boolean`\n - `isQueuedForEmail: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]; objectType: 'qbd_estimate_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_estimate'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const estimate of conductor.qbd.estimates.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(estimate);\n}\n```",
|
|
3454
|
+
markdown: "## list\n\n`conductor.qbd.estimates.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isActive: boolean; isQueuedForEmail: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_estimate'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/estimates`\n\nReturns a list of estimates. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for estimates associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for estimates in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for estimates created for these customers.\n\n- `ids?: string[]`\n Filter for specific estimates by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding estimate.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for estimates whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for estimates whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for estimates whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific estimates by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for estimates whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for estimates whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for estimates whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for estimates whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for estimates updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for estimates updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isActive: boolean; isQueuedForEmail: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; inventorySite: object; inventorySiteLocation: object; item: object; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; unitOfMeasure: string; }[]; objectType: 'qbd_estimate_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_estimate'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isActive: boolean`\n - `isQueuedForEmail: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]; objectType: 'qbd_estimate_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; markupRate: string; markupRatePercent: string; objectType: 'qbd_estimate_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_estimate'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const estimate of conductor.qbd.estimates.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(estimate);\n}\n```",
|
|
3455
3455
|
perLanguage: {
|
|
3456
3456
|
typescript: {
|
|
3457
3457
|
method: 'client.qbd.estimates.list',
|
|
@@ -3632,7 +3632,7 @@ const EMBEDDED_METHODS = [
|
|
|
3632
3632
|
'updatedBefore?: string;',
|
|
3633
3633
|
],
|
|
3634
3634
|
response: "{ data: { id: string; account: object; class: object; createdAt: string; customer: object; customFields: object[]; externalId: string; inventorySite: object; lines: object[]; memo: string; objectType: 'qbd_inventory_adjustment'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
3635
|
-
markdown: "## list\n\n`conductor.qbd.inventoryAdjustments.list(Conductor-End-User-Id: string, accountIds?: string[], customerIds?: string[], ids?: string[], includeLineItems?: boolean, itemIds?: string[], limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { data: inventory_adjustment[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/inventory-adjustments`\n\nReturns a list of inventory adjustments.\n\n**NOTE:** QuickBooks Desktop does not support pagination for inventory adjustments; hence, there is no `cursor` parameter. Users typically have few inventory adjustments.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for inventory adjustments associated with these accounts.\n\n- `customerIds?: string[]`\n Filter for inventory adjustments associated with these customers.\n\n- `ids?: string[]`\n Filter for specific inventory adjustments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for inventory adjustments containing these inventory items.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for inventory adjustments
|
|
3635
|
+
markdown: "## list\n\n`conductor.qbd.inventoryAdjustments.list(Conductor-End-User-Id: string, accountIds?: string[], customerIds?: string[], ids?: string[], includeLineItems?: boolean, itemIds?: string[], limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { data: inventory_adjustment[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/inventory-adjustments`\n\nReturns a list of inventory adjustments.\n\n**NOTE:** QuickBooks Desktop does not support pagination for inventory adjustments; hence, there is no `cursor` parameter. Users typically have few inventory adjustments.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for inventory adjustments associated with these accounts.\n\n- `customerIds?: string[]`\n Filter for inventory adjustments associated with these customers.\n\n- `ids?: string[]`\n Filter for specific inventory adjustments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for inventory adjustments containing these inventory items.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for inventory adjustments, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all inventory adjustments without limit, unlike paginated endpoints which default to 150 records.\n\n- `refNumberContains?: string`\n Filter for inventory adjustments whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for inventory adjustments whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for inventory adjustments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific inventory adjustments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for inventory adjustments whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for inventory adjustments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for inventory adjustments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for inventory adjustments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for inventory adjustments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for inventory adjustments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; account: object; class: object; createdAt: string; customer: object; customFields: object[]; externalId: string; inventorySite: object; lines: object[]; memo: string; objectType: 'qbd_inventory_adjustment'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; account: { id: string; fullName: string; }; class: { id: string; fullName: string; }; createdAt: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; inventorySite: { id: string; fullName: string; }; lines: { id: string; expirationDate: string; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_inventory_adjustment_line'; quantityDifference: number; serialNumber: string; serialNumberAction: 'added' | 'removed'; valueDifference: number; }[]; memo: string; objectType: 'qbd_inventory_adjustment'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst inventoryAdjustments = await conductor.qbd.inventoryAdjustments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(inventoryAdjustments);\n```",
|
|
3636
3636
|
perLanguage: {
|
|
3637
3637
|
typescript: {
|
|
3638
3638
|
method: 'client.qbd.inventoryAdjustments.list',
|
|
@@ -3834,7 +3834,7 @@ const EMBEDDED_METHODS = [
|
|
|
3834
3834
|
'updatedBefore?: string;',
|
|
3835
3835
|
],
|
|
3836
3836
|
response: "{ id: string; assetAccount: { id: string; fullName: string; }; averageCost: string; barcode: string; buildNotificationThreshold: number; class: { id: string; fullName: string; }; cogsAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; incomeAccount: { id: string; fullName: string; }; isActive: boolean; lines: { inventoryItem: { id: string; fullName: string; }; quantity: number; }[]; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_assembly_item'; parent: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }",
|
|
3837
|
-
markdown: "## list\n\n`conductor.qbd.inventoryAssemblyItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; assetAccount: object; averageCost: string; barcode: string; buildNotificationThreshold: number; class: object; cogsAccount: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; incomeAccount: object; isActive: boolean; lines: object[]; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_assembly_item'; parent: object; preferredVendor: object; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: object; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/inventory-assembly-items`\n\nReturns a list of inventory assembly items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for inventory assembly items of these classes. A class is a way end-users can categorize inventory assembly items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific inventory assembly items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an inventory assembly item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an inventory assembly item is under \"Assemblies\" and has the `name` \"Deluxe Kit\", its `fullName` would be \"Assemblies:Deluxe Kit\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific inventory assembly items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for inventory assembly items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory assembly items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory assembly items whose `
|
|
3837
|
+
markdown: "## list\n\n`conductor.qbd.inventoryAssemblyItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; assetAccount: object; averageCost: string; barcode: string; buildNotificationThreshold: number; class: object; cogsAccount: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; incomeAccount: object; isActive: boolean; lines: object[]; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_assembly_item'; parent: object; preferredVendor: object; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: object; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/inventory-assembly-items`\n\nReturns a list of inventory assembly items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for inventory assembly items of these classes. A class is a way end-users can categorize inventory assembly items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific inventory assembly items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an inventory assembly item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an inventory assembly item is under \"Assemblies\" and has the `name` \"Deluxe Kit\", its `fullName` would be \"Assemblies:Deluxe Kit\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific inventory assembly items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for inventory assembly items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory assembly items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory assembly items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns inventory assembly items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through inventory assembly items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for inventory assembly items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for inventory assembly items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns inventory assembly items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for inventory assembly items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for inventory assembly items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for inventory assembly items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; assetAccount: { id: string; fullName: string; }; averageCost: string; barcode: string; buildNotificationThreshold: number; class: { id: string; fullName: string; }; cogsAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; incomeAccount: { id: string; fullName: string; }; isActive: boolean; lines: { inventoryItem: { id: string; fullName: string; }; quantity: number; }[]; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_assembly_item'; parent: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `assetAccount: { id: string; fullName: string; }`\n - `averageCost: string`\n - `barcode: string`\n - `buildNotificationThreshold: number`\n - `class: { id: string; fullName: string; }`\n - `cogsAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `fullName: string`\n - `incomeAccount: { id: string; fullName: string; }`\n - `isActive: boolean`\n - `lines: { inventoryItem: { id: string; fullName: string; }; quantity: number; }[]`\n - `maximumQuantityOnHand: number`\n - `name: string`\n - `objectType: 'qbd_inventory_assembly_item'`\n - `parent: { id: string; fullName: string; }`\n - `preferredVendor: { id: string; fullName: string; }`\n - `purchaseCost: string`\n - `purchaseDescription: string`\n - `purchaseTaxCode: { id: string; fullName: string; }`\n - `quantityOnHand: number`\n - `quantityOnPurchaseOrder: number`\n - `quantityOnSalesOrder: number`\n - `revisionNumber: string`\n - `salesDescription: string`\n - `salesPrice: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `sku: string`\n - `sublevel: number`\n - `unitOfMeasureSet: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const inventoryAssemblyItem of conductor.qbd.inventoryAssemblyItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(inventoryAssemblyItem);\n}\n```",
|
|
3838
3838
|
perLanguage: {
|
|
3839
3839
|
typescript: {
|
|
3840
3840
|
method: 'client.qbd.inventoryAssemblyItems.list',
|
|
@@ -4001,7 +4001,7 @@ const EMBEDDED_METHODS = [
|
|
|
4001
4001
|
'updatedBefore?: string;',
|
|
4002
4002
|
],
|
|
4003
4003
|
response: "{ id: string; assetAccount: { id: string; fullName: string; }; averageCost: string; barcode: string; class: { id: string; fullName: string; }; cogsAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; incomeAccount: { id: string; fullName: string; }; isActive: boolean; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_item'; parent: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; reorderPoint: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }",
|
|
4004
|
-
markdown: "## list\n\n`conductor.qbd.inventoryItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; assetAccount: object; averageCost: string; barcode: string; class: object; cogsAccount: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; incomeAccount: object; isActive: boolean; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_item'; parent: object; preferredVendor: object; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: object; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; reorderPoint: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/inventory-items`\n\nReturns a list of inventory items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for inventory items of these classes. A class is a way end-users can categorize inventory items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific inventory items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an inventory item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an inventory item is under \"Kitchen\" and has the `name` \"Cabinet\", its `fullName` would be \"Kitchen:Cabinet\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific inventory items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for inventory items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory items whose `
|
|
4004
|
+
markdown: "## list\n\n`conductor.qbd.inventoryItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; assetAccount: object; averageCost: string; barcode: string; class: object; cogsAccount: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; incomeAccount: object; isActive: boolean; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_item'; parent: object; preferredVendor: object; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: object; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; reorderPoint: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/inventory-items`\n\nReturns a list of inventory items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for inventory items of these classes. A class is a way end-users can categorize inventory items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific inventory items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an inventory item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an inventory item is under \"Kitchen\" and has the `name` \"Cabinet\", its `fullName` would be \"Kitchen:Cabinet\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific inventory items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for inventory items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns inventory items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through inventory items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for inventory items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for inventory items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns inventory items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for inventory items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for inventory items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for inventory items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; assetAccount: { id: string; fullName: string; }; averageCost: string; barcode: string; class: { id: string; fullName: string; }; cogsAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; incomeAccount: { id: string; fullName: string; }; isActive: boolean; maximumQuantityOnHand: number; name: string; objectType: 'qbd_inventory_item'; parent: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; quantityOnHand: number; quantityOnPurchaseOrder: number; quantityOnSalesOrder: number; reorderPoint: number; revisionNumber: string; salesDescription: string; salesPrice: string; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `assetAccount: { id: string; fullName: string; }`\n - `averageCost: string`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `cogsAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `fullName: string`\n - `incomeAccount: { id: string; fullName: string; }`\n - `isActive: boolean`\n - `maximumQuantityOnHand: number`\n - `name: string`\n - `objectType: 'qbd_inventory_item'`\n - `parent: { id: string; fullName: string; }`\n - `preferredVendor: { id: string; fullName: string; }`\n - `purchaseCost: string`\n - `purchaseDescription: string`\n - `purchaseTaxCode: { id: string; fullName: string; }`\n - `quantityOnHand: number`\n - `quantityOnPurchaseOrder: number`\n - `quantityOnSalesOrder: number`\n - `reorderPoint: number`\n - `revisionNumber: string`\n - `salesDescription: string`\n - `salesPrice: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `sku: string`\n - `sublevel: number`\n - `unitOfMeasureSet: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const inventoryItem of conductor.qbd.inventoryItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(inventoryItem);\n}\n```",
|
|
4005
4005
|
perLanguage: {
|
|
4006
4006
|
typescript: {
|
|
4007
4007
|
method: 'client.qbd.inventoryItems.list',
|
|
@@ -4147,7 +4147,7 @@ const EMBEDDED_METHODS = [
|
|
|
4147
4147
|
'updatedBefore?: string;',
|
|
4148
4148
|
],
|
|
4149
4149
|
response: "{ data: { id: string; address: object; contact: string; createdAt: string; description: string; email: string; fax: string; isActive: boolean; isDefault: boolean; name: string; objectType: 'qbd_inventory_site'; parent: object; phone: string; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
4150
|
-
markdown: "## list\n\n`conductor.qbd.inventorySites.list(Conductor-End-User-Id: string, ids?: string[], nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: inventory_site[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/inventory-sites`\n\nReturns a list of inventory sites.\n\n**NOTE:** QuickBooks Desktop does not support pagination for inventory sites; hence, there is no `cursor` parameter. Users typically have few inventory sites.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific inventory sites by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameContains?: string`\n Filter for inventory sites whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory sites whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory sites whose `name`
|
|
4150
|
+
markdown: "## list\n\n`conductor.qbd.inventorySites.list(Conductor-End-User-Id: string, ids?: string[], nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: inventory_site[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/inventory-sites`\n\nReturns a list of inventory sites.\n\n**NOTE:** QuickBooks Desktop does not support pagination for inventory sites; hence, there is no `cursor` parameter. Users typically have few inventory sites.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific inventory sites by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameContains?: string`\n Filter for inventory sites whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for inventory sites whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for inventory sites whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific inventory sites by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an inventory site.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for inventory sites whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for inventory sites whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for inventory sites that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for inventory sites updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for inventory sites updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; address: object; contact: string; createdAt: string; description: string; email: string; fax: string; isActive: boolean; isDefault: boolean; name: string; objectType: 'qbd_inventory_site'; parent: object; phone: string; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; postalCode: string; state: string; }; contact: string; createdAt: string; description: string; email: string; fax: string; isActive: boolean; isDefault: boolean; name: string; objectType: 'qbd_inventory_site'; parent: { id: string; fullName: string; }; phone: string; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst inventorySites = await conductor.qbd.inventorySites.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(inventorySites);\n```",
|
|
4151
4151
|
perLanguage: {
|
|
4152
4152
|
typescript: {
|
|
4153
4153
|
method: 'client.qbd.inventorySites.list',
|
|
@@ -4313,7 +4313,7 @@ const EMBEDDED_METHODS = [
|
|
|
4313
4313
|
'updatedBefore?: string;',
|
|
4314
4314
|
],
|
|
4315
4315
|
response: "{ id: string; appliedAmount: string; balanceRemaining: string; balanceRemainingInHomeCurrency: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFinanceCharge: boolean; isPaid: boolean; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_invoice'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; suggestedDiscountAmount: string; suggestedDiscountDate: string; terms: object; transactionDate: string; updatedAt: string; }",
|
|
4316
|
-
markdown: "## list\n\n`conductor.qbd.invoices.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, paymentStatus?: 'all' | 'paid' | 'not_paid', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; appliedAmount: string; balanceRemaining: string; balanceRemainingInHomeCurrency: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFinanceCharge: boolean; isPaid: boolean; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_invoice'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; suggestedDiscountAmount: string; suggestedDiscountDate: string; terms: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/invoices`\n\nReturns a list of invoices. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for invoices associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for invoices in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for invoices created for these customers.\n\n- `ids?: string[]`\n Filter for specific invoices by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding invoice.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'all' | 'paid' | 'not_paid'`\n Filter for invoices that are paid, not paid, or both.\n\n- `refNumberContains?: string`\n Filter for invoices whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for invoices whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for invoices whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific invoices by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for invoices whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for invoices whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for invoices whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for invoices whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for invoices updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for invoices updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; appliedAmount: string; balanceRemaining: string; balanceRemainingInHomeCurrency: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isFinanceCharge: boolean; isPaid: boolean; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_invoice_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_invoice'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; suggestedDiscountAmount: string; suggestedDiscountDate: string; terms: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `appliedAmount: string`\n - `balanceRemaining: string`\n - `balanceRemainingInHomeCurrency: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isFinanceCharge: boolean`\n - `isPaid: boolean`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_invoice_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_invoice'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `suggestedDiscountAmount: string`\n - `suggestedDiscountDate: string`\n - `terms: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const invoice of conductor.qbd.invoices.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(invoice);\n}\n```",
|
|
4316
|
+
markdown: "## list\n\n`conductor.qbd.invoices.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, paymentStatus?: 'all' | 'paid' | 'not_paid', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; appliedAmount: string; balanceRemaining: string; balanceRemainingInHomeCurrency: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFinanceCharge: boolean; isPaid: boolean; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_invoice'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; suggestedDiscountAmount: string; suggestedDiscountDate: string; terms: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/invoices`\n\nReturns a list of invoices. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for invoices associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for invoices in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for invoices created for these customers.\n\n- `ids?: string[]`\n Filter for specific invoices by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding invoice.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'all' | 'paid' | 'not_paid'`\n Filter for invoices that are paid, not paid, or both.\n\n- `refNumberContains?: string`\n Filter for invoices whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for invoices whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for invoices whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific invoices by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for invoices whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for invoices whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for invoices whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for invoices whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for invoices updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for invoices updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; appliedAmount: string; balanceRemaining: string; balanceRemainingInHomeCurrency: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isFinanceCharge: boolean; isPaid: boolean; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_invoice_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_invoice'; otherCustomField: string; purchaseOrderNumber: string; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; suggestedDiscountAmount: string; suggestedDiscountDate: string; terms: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `appliedAmount: string`\n - `balanceRemaining: string`\n - `balanceRemainingInHomeCurrency: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isFinanceCharge: boolean`\n - `isPaid: boolean`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_invoice_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_invoice_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_invoice'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `suggestedDiscountAmount: string`\n - `suggestedDiscountDate: string`\n - `terms: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const invoice of conductor.qbd.invoices.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(invoice);\n}\n```",
|
|
4317
4317
|
perLanguage: {
|
|
4318
4318
|
typescript: {
|
|
4319
4319
|
method: 'client.qbd.invoices.list',
|
|
@@ -4518,7 +4518,7 @@ const EMBEDDED_METHODS = [
|
|
|
4518
4518
|
'updatedBefore?: string;',
|
|
4519
4519
|
],
|
|
4520
4520
|
response: "{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; lines: { item: { id: string; fullName: string; }; quantity: number; unitOfMeasure: string; }[]; name: string; objectType: 'qbd_item_group'; revisionNumber: string; shouldPrintItemsInGroup: boolean; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }",
|
|
4521
|
-
markdown: "## list\n\n`conductor.qbd.itemGroups.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; lines: object[]; name: string; objectType: 'qbd_item_group'; revisionNumber: string; shouldPrintItemsInGroup: boolean; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/item-groups`\n\nReturns a list of item groups. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific item groups by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for item groups whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for item groups whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for item groups whose `name`
|
|
4521
|
+
markdown: "## list\n\n`conductor.qbd.itemGroups.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; lines: object[]; name: string; objectType: 'qbd_item_group'; revisionNumber: string; shouldPrintItemsInGroup: boolean; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/item-groups`\n\nReturns a list of item groups. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific item groups by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for item groups whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for item groups whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for item groups whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns item groups sorted by `name` in that order; without either, the order is not guaranteed. To page through item groups by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific item groups by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an item group.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for item groups whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for item groups whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns item groups sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for item groups that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for item groups updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for item groups updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; lines: { item: { id: string; fullName: string; }; quantity: number; unitOfMeasure: string; }[]; name: string; objectType: 'qbd_item_group'; revisionNumber: string; shouldPrintItemsInGroup: boolean; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `description: string`\n - `externalId: string`\n - `isActive: boolean`\n - `lines: { item: { id: string; fullName: string; }; quantity: number; unitOfMeasure: string; }[]`\n - `name: string`\n - `objectType: 'qbd_item_group'`\n - `revisionNumber: string`\n - `shouldPrintItemsInGroup: boolean`\n - `specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'`\n - `unitOfMeasureSet: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const itemGroup of conductor.qbd.itemGroups.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(itemGroup);\n}\n```",
|
|
4522
4522
|
perLanguage: {
|
|
4523
4523
|
typescript: {
|
|
4524
4524
|
method: 'client.qbd.itemGroups.list',
|
|
@@ -4665,7 +4665,7 @@ const EMBEDDED_METHODS = [
|
|
|
4665
4665
|
'vendorIds?: string[];',
|
|
4666
4666
|
],
|
|
4667
4667
|
response: "{ id: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; liabilityAccount: object; linkedTransactions: object[]; memo: string; objectType: 'qbd_item_receipt'; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; }",
|
|
4668
|
-
markdown: "## list\n\n`conductor.qbd.itemReceipts.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; liabilityAccount: object; linkedTransactions: object[]; memo: string; objectType: 'qbd_item_receipt'; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/item-receipts`\n\nReturns a list of item receipts. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for item receipts associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for item receipts in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific item receipts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding item receipt.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for item receipts whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for item receipts whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for item receipts whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific item receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for item receipts whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for item receipts whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for item receipts whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for item receipts whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for item receipts updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for item receipts updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for item receipts received from these vendors.\n\n### Returns\n\n- `{ id: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; liabilityAccount: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_item_receipt'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `liabilityAccount: { id: string; fullName: string; }`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_item_receipt'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const itemReceipt of conductor.qbd.itemReceipts.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(itemReceipt);\n}\n```",
|
|
4668
|
+
markdown: "## list\n\n`conductor.qbd.itemReceipts.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; createdAt: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; liabilityAccount: object; linkedTransactions: object[]; memo: string; objectType: 'qbd_item_receipt'; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/item-receipts`\n\nReturns a list of item receipts. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for item receipts associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for item receipts in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific item receipts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding item receipt.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for item receipts whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for item receipts whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for item receipts whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific item receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for item receipts whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for item receipts whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for item receipts whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for item receipts whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for item receipts updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for item receipts updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for item receipts received from these vendors.\n\n### Returns\n\n- `{ id: string; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; liabilityAccount: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_item_receipt'; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `liabilityAccount: { id: string; fullName: string; }`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_item_receipt'`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const itemReceipt of conductor.qbd.itemReceipts.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(itemReceipt);\n}\n```",
|
|
4669
4669
|
perLanguage: {
|
|
4670
4670
|
typescript: {
|
|
4671
4671
|
method: 'client.qbd.itemReceipts.list',
|
|
@@ -4815,7 +4815,7 @@ const EMBEDDED_METHODS = [
|
|
|
4815
4815
|
"status?: 'active' | 'all' | 'inactive';",
|
|
4816
4816
|
],
|
|
4817
4817
|
response: "{ id: string; assemblyBuildPoint: number; createdAt: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventoryItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; objectType: 'qbd_item_site'; quantityOnHand: number; quantityOnPendingTransfers: number; quantityOnPurchaseOrders: number; quantityOnSalesOrders: number; quantityRequiredByPendingBuildTransactions: number; quantityToBeBuiltByPendingBuildTransactions: number; reorderLevel: number; revisionNumber: string; updatedAt: string; }",
|
|
4818
|
-
markdown: "## list\n\n`conductor.qbd.itemSites.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], itemIds?: string[], itemType?: string, limit?: number, siteIds?: string[], status?: 'active' | 'all' | 'inactive'): { id: string; assemblyBuildPoint: number; createdAt: string; inventoryAssemblyItem: object; inventoryItem: object; inventorySite: object; inventorySiteLocation: object; objectType: 'qbd_item_site'; quantityOnHand: number; quantityOnPendingTransfers: number; quantityOnPurchaseOrders: number; quantityOnSalesOrders: number; quantityRequiredByPendingBuildTransactions: number; quantityToBeBuiltByPendingBuildTransactions: number; reorderLevel: number; revisionNumber: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/item-sites`\n\nReturns a list of item sites. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific item sites by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `itemIds?: string[]`\n Filter for item sites for these items.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `itemType?: string`\n Filter for item sites that match this item type.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `siteIds?: string[]`\n Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for item sites that are active, inactive, or both.\n\n### Returns\n\n- `{ id: string; assemblyBuildPoint: number; createdAt: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventoryItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; objectType: 'qbd_item_site'; quantityOnHand: number; quantityOnPendingTransfers: number; quantityOnPurchaseOrders: number; quantityOnSalesOrders: number; quantityRequiredByPendingBuildTransactions: number; quantityToBeBuiltByPendingBuildTransactions: number; reorderLevel: number; revisionNumber: string; updatedAt: string; }`\n\n - `id: string`\n - `assemblyBuildPoint: number`\n - `createdAt: string`\n - `inventoryAssemblyItem: { id: string; fullName: string; }`\n - `inventoryItem: { id: string; fullName: string; }`\n - `inventorySite: { id: string; fullName: string; }`\n - `inventorySiteLocation: { id: string; fullName: string; }`\n - `objectType: 'qbd_item_site'`\n - `quantityOnHand: number`\n - `quantityOnPendingTransfers: number`\n - `quantityOnPurchaseOrders: number`\n - `quantityOnSalesOrders: number`\n - `quantityRequiredByPendingBuildTransactions: number`\n - `quantityToBeBuiltByPendingBuildTransactions: number`\n - `reorderLevel: number`\n - `revisionNumber: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const itemSite of conductor.qbd.itemSites.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(itemSite);\n}\n```",
|
|
4818
|
+
markdown: "## list\n\n`conductor.qbd.itemSites.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], itemIds?: string[], itemType?: string, limit?: number, siteIds?: string[], status?: 'active' | 'all' | 'inactive'): { id: string; assemblyBuildPoint: number; createdAt: string; inventoryAssemblyItem: object; inventoryItem: object; inventorySite: object; inventorySiteLocation: object; objectType: 'qbd_item_site'; quantityOnHand: number; quantityOnPendingTransfers: number; quantityOnPurchaseOrders: number; quantityOnSalesOrders: number; quantityRequiredByPendingBuildTransactions: number; quantityToBeBuiltByPendingBuildTransactions: number; reorderLevel: number; revisionNumber: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/item-sites`\n\nReturns a list of item sites. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific item sites by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `itemIds?: string[]`\n Filter for item sites for these items.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `itemType?: string`\n Filter for item sites that match this item type.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `siteIds?: string[]`\n Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store.\n\n**NOTE:** QuickBooks Desktop only supports `itemType` or item/site filters for item-sites requests, not both. Do not use `itemType` together with `itemIds` or `siteIds`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for item sites that are active, inactive, or both.\n\n### Returns\n\n- `{ id: string; assemblyBuildPoint: number; createdAt: string; inventoryAssemblyItem: { id: string; fullName: string; }; inventoryItem: { id: string; fullName: string; }; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; objectType: 'qbd_item_site'; quantityOnHand: number; quantityOnPendingTransfers: number; quantityOnPurchaseOrders: number; quantityOnSalesOrders: number; quantityRequiredByPendingBuildTransactions: number; quantityToBeBuiltByPendingBuildTransactions: number; reorderLevel: number; revisionNumber: string; updatedAt: string; }`\n\n - `id: string`\n - `assemblyBuildPoint: number`\n - `createdAt: string`\n - `inventoryAssemblyItem: { id: string; fullName: string; }`\n - `inventoryItem: { id: string; fullName: string; }`\n - `inventorySite: { id: string; fullName: string; }`\n - `inventorySiteLocation: { id: string; fullName: string; }`\n - `objectType: 'qbd_item_site'`\n - `quantityOnHand: number`\n - `quantityOnPendingTransfers: number`\n - `quantityOnPurchaseOrders: number`\n - `quantityOnSalesOrders: number`\n - `quantityRequiredByPendingBuildTransactions: number`\n - `quantityToBeBuiltByPendingBuildTransactions: number`\n - `reorderLevel: number`\n - `revisionNumber: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const itemSite of conductor.qbd.itemSites.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(itemSite);\n}\n```",
|
|
4819
4819
|
perLanguage: {
|
|
4820
4820
|
typescript: {
|
|
4821
4821
|
method: 'client.qbd.itemSites.list',
|
|
@@ -4921,7 +4921,7 @@ const EMBEDDED_METHODS = [
|
|
|
4921
4921
|
'updatedBefore?: string;',
|
|
4922
4922
|
],
|
|
4923
4923
|
response: "{ id: string; areAmountsEnteredInHomeCurrency: boolean; createdAt: string; creditLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_credit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; debitLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_debit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; exchangeRate: number; externalId: string; isAdjustment: boolean; isHomeCurrencyAdjustment: boolean; objectType: 'qbd_journal_entry'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }",
|
|
4924
|
-
markdown: "## list\n\n`conductor.qbd.journalEntries.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, entityIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; areAmountsEnteredInHomeCurrency: boolean; createdAt: string; creditLines: object[]; currency: object; customFields: object[]; debitLines: object[]; exchangeRate: number; externalId: string; isAdjustment: boolean; isHomeCurrencyAdjustment: boolean; objectType: 'qbd_journal_entry'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/journal-entries`\n\nReturns a list of journal entries. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for journal entries associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for journal entries in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `entityIds?: string[]`\n Filter for journal entries associated with these entities (customers, vendors, employees, etc.).\n\n- `ids?: string[]`\n Filter for specific journal entries by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for journal entries whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for journal entries whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for journal entries whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific journal entries by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for journal entries whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for journal entries whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for journal entries whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for journal entries whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for journal entries updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for journal entries updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; areAmountsEnteredInHomeCurrency: boolean; createdAt: string; creditLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_credit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; debitLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_debit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; exchangeRate: number; externalId: string; isAdjustment: boolean; isHomeCurrencyAdjustment: boolean; objectType: 'qbd_journal_entry'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `areAmountsEnteredInHomeCurrency: boolean`\n - `createdAt: string`\n - `creditLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_credit_line'; salesTaxItem: { id: string; fullName: string; }; }[]`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `debitLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_debit_line'; salesTaxItem: { id: string; fullName: string; }; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `isAdjustment: boolean`\n - `isHomeCurrencyAdjustment: boolean`\n - `objectType: 'qbd_journal_entry'`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const journalEntry of conductor.qbd.journalEntries.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(journalEntry);\n}\n```",
|
|
4924
|
+
markdown: "## list\n\n`conductor.qbd.journalEntries.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, entityIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; areAmountsEnteredInHomeCurrency: boolean; createdAt: string; creditLines: object[]; currency: object; customFields: object[]; debitLines: object[]; exchangeRate: number; externalId: string; isAdjustment: boolean; isHomeCurrencyAdjustment: boolean; objectType: 'qbd_journal_entry'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/journal-entries`\n\nReturns a list of journal entries. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for journal entries associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for journal entries in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `entityIds?: string[]`\n Filter for journal entries associated with these entities (customers, vendors, employees, etc.).\n\n- `ids?: string[]`\n Filter for specific journal entries by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for journal entries whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for journal entries whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for journal entries whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific journal entries by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for journal entries whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for journal entries whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for journal entries whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for journal entries whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for journal entries updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for journal entries updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; areAmountsEnteredInHomeCurrency: boolean; createdAt: string; creditLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_credit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; debitLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_debit_line'; salesTaxItem: { id: string; fullName: string; }; }[]; exchangeRate: number; externalId: string; isAdjustment: boolean; isHomeCurrencyAdjustment: boolean; objectType: 'qbd_journal_entry'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `areAmountsEnteredInHomeCurrency: boolean`\n - `createdAt: string`\n - `creditLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_credit_line'; salesTaxItem: { id: string; fullName: string; }; }[]`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `debitLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; memo: string; objectType: 'qbd_journal_debit_line'; salesTaxItem: { id: string; fullName: string; }; }[]`\n - `exchangeRate: number`\n - `externalId: string`\n - `isAdjustment: boolean`\n - `isHomeCurrencyAdjustment: boolean`\n - `objectType: 'qbd_journal_entry'`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const journalEntry of conductor.qbd.journalEntries.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(journalEntry);\n}\n```",
|
|
4925
4925
|
perLanguage: {
|
|
4926
4926
|
typescript: {
|
|
4927
4927
|
method: 'client.qbd.journalEntries.list',
|
|
@@ -5110,7 +5110,7 @@ const EMBEDDED_METHODS = [
|
|
|
5110
5110
|
'updatedBefore?: string;',
|
|
5111
5111
|
],
|
|
5112
5112
|
response: "{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_non_inventory_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }",
|
|
5113
|
-
markdown: "## list\n\n`conductor.qbd.nonInventoryItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_non_inventory_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/non-inventory-items`\n\nReturns a list of non-inventory items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for non-inventory items of these classes. A class is a way end-users can categorize non-inventory items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific non-inventory items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a non-inventory item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a non-inventory item is under \"Office Supplies\" and has the `name` \"Printer Ink Cartridge\", its `fullName` would be \"Office Supplies:Printer Ink Cartridge\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific non-inventory items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for non-inventory items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for non-inventory items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for non-inventory items whose `
|
|
5113
|
+
markdown: "## list\n\n`conductor.qbd.nonInventoryItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_non_inventory_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; sku: string; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/non-inventory-items`\n\nReturns a list of non-inventory items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for non-inventory items of these classes. A class is a way end-users can categorize non-inventory items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific non-inventory items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a non-inventory item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a non-inventory item is under \"Office Supplies\" and has the `name` \"Printer Ink Cartridge\", its `fullName` would be \"Office Supplies:Printer Ink Cartridge\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific non-inventory items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for non-inventory items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for non-inventory items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for non-inventory items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns non-inventory items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through non-inventory items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for non-inventory items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for non-inventory items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns non-inventory items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for non-inventory items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for non-inventory items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for non-inventory items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_non_inventory_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; sku: string; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `fullName: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_non_inventory_item'`\n - `parent: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }`\n - `salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `sku: string`\n - `sublevel: number`\n - `unitOfMeasureSet: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const nonInventoryItem of conductor.qbd.nonInventoryItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(nonInventoryItem);\n}\n```",
|
|
5114
5114
|
perLanguage: {
|
|
5115
5115
|
typescript: {
|
|
5116
5116
|
method: 'client.qbd.nonInventoryItems.list',
|
|
@@ -5251,7 +5251,7 @@ const EMBEDDED_METHODS = [
|
|
|
5251
5251
|
'updatedBefore?: string;',
|
|
5252
5252
|
],
|
|
5253
5253
|
response: "{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_other_charge_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; sublevel: number; updatedAt: string; }",
|
|
5254
|
-
markdown: "## list\n\n`conductor.qbd.otherChargeItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_other_charge_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; sublevel: number; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/other-charge-items`\n\nReturns a list of other charge items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for other charge items of these classes. A class is a way end-users can categorize other charge items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific other charge items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an other charge item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an other charge item is under \"Shipping Charges\" and has the `name` \"Overnight Delivery\", its `fullName` would be \"Shipping Charges:Overnight Delivery\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific other charge items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for other charge items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for other charge items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for other charge items whose `
|
|
5254
|
+
markdown: "## list\n\n`conductor.qbd.otherChargeItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_other_charge_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; sublevel: number; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/other-charge-items`\n\nReturns a list of other charge items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for other charge items of these classes. A class is a way end-users can categorize other charge items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific other charge items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an other charge item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an other charge item is under \"Shipping Charges\" and has the `name` \"Overnight Delivery\", its `fullName` would be \"Shipping Charges:Overnight Delivery\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific other charge items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for other charge items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for other charge items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for other charge items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns other charge items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through other charge items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for other charge items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for other charge items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns other charge items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for other charge items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for other charge items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for other charge items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_other_charge_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; sublevel: number; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `fullName: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_other_charge_item'`\n - `parent: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }`\n - `salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'`\n - `sublevel: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const otherChargeItem of conductor.qbd.otherChargeItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(otherChargeItem);\n}\n```",
|
|
5255
5255
|
perLanguage: {
|
|
5256
5256
|
typescript: {
|
|
5257
5257
|
method: 'client.qbd.otherChargeItems.list',
|
|
@@ -5395,7 +5395,7 @@ const EMBEDDED_METHODS = [
|
|
|
5395
5395
|
'updatedBefore?: string;',
|
|
5396
5396
|
],
|
|
5397
5397
|
response: "{ data: { id: string; accountNumber: string; address: object; alternateContact: string; alternatePhone: string; companyName: string; contact: string; createdAt: string; customFields: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_other_name'; phone: string; revisionNumber: string; salutation: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
5398
|
-
markdown: "## list\n\n`conductor.qbd.otherNames.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: other_name[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/other-names`\n\nReturns a list of other-names.\n\n**NOTE:** QuickBooks Desktop does not support pagination for other-names; hence, there is no `cursor` parameter. Users typically have few other-names.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific other-names by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for other-names
|
|
5398
|
+
markdown: "## list\n\n`conductor.qbd.otherNames.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: other_name[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/other-names`\n\nReturns a list of other-names.\n\n**NOTE:** QuickBooks Desktop does not support pagination for other-names; hence, there is no `cursor` parameter. Users typically have few other-names.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific other-names by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for other-names, so this parameter only limits the response size. To page through other-names by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all other-names without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for other-names whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for other-names whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for other-names whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns other-names sorted by `name` in that order; without either, the order is not guaranteed. To page through other-names by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific other-names by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an other-name.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for other-names whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for other-names whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns other-names sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for other-names that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for other-names updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for other-names updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; accountNumber: string; address: object; alternateContact: string; alternatePhone: string; companyName: string; contact: string; createdAt: string; customFields: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_other_name'; phone: string; revisionNumber: string; salutation: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; accountNumber: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; alternateContact: string; alternatePhone: string; companyName: string; contact: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; lastName: string; middleName: string; name: string; note: string; objectType: 'qbd_other_name'; phone: string; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst otherNames = await conductor.qbd.otherNames.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(otherNames);\n```",
|
|
5399
5399
|
perLanguage: {
|
|
5400
5400
|
typescript: {
|
|
5401
5401
|
method: 'client.qbd.otherNames.list',
|
|
@@ -5534,7 +5534,7 @@ const EMBEDDED_METHODS = [
|
|
|
5534
5534
|
'updatedBefore?: string;',
|
|
5535
5535
|
],
|
|
5536
5536
|
response: "{ data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_payment_method'; paymentMethodType: string; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
5537
|
-
markdown: "## list\n\n`conductor.qbd.paymentMethods.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, paymentMethodType?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: payment_method[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/payment-methods`\n\nReturns a list of payment methods.\n\n**NOTE:** QuickBooks Desktop does not support pagination for payment methods; hence, there is no `cursor` parameter. Users typically have few payment methods.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific payment methods by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for payment methods
|
|
5537
|
+
markdown: "## list\n\n`conductor.qbd.paymentMethods.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, paymentMethodType?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: payment_method[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/payment-methods`\n\nReturns a list of payment methods.\n\n**NOTE:** QuickBooks Desktop does not support pagination for payment methods; hence, there is no `cursor` parameter. Users typically have few payment methods.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific payment methods by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for payment methods, so this parameter only limits the response size. To page through payment methods by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all payment methods without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for payment methods whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for payment methods whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for payment methods whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns payment methods sorted by `name` in that order; without either, the order is not guaranteed. To page through payment methods by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific payment methods by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a payment method.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for payment methods whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for payment methods whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns payment methods sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `paymentMethodType?: string`\n Filter for payment methods of this type.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for payment methods that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for payment methods updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for payment methods updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_payment_method'; paymentMethodType: string; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_payment_method'; paymentMethodType: string; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst paymentMethods = await conductor.qbd.paymentMethods.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(paymentMethods);\n```",
|
|
5538
5538
|
perLanguage: {
|
|
5539
5539
|
typescript: {
|
|
5540
5540
|
method: 'client.qbd.paymentMethods.list',
|
|
@@ -5657,7 +5657,7 @@ const EMBEDDED_METHODS = [
|
|
|
5657
5657
|
'updatedBefore?: string;',
|
|
5658
5658
|
],
|
|
5659
5659
|
response: "{ id: string; createdAt: string; expenseAccount: { id: string; fullName: string; }; isActive: boolean; name: string; objectType: 'qbd_payroll_wage_item'; overtimeMultiplier: string; rate: string; ratePercent: string; revisionNumber: string; updatedAt: string; wageType: string; }",
|
|
5660
|
-
markdown: "## list\n\n`conductor.qbd.payrollWageItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; createdAt: string; expenseAccount: object; isActive: boolean; name: string; objectType: 'qbd_payroll_wage_item'; overtimeMultiplier: string; rate: string; ratePercent: string; revisionNumber: string; updatedAt: string; wageType: string; }`\n\n**get** `/quickbooks-desktop/payroll-wage-items`\n\nReturns a list of payroll wage items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific payroll wage items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for payroll wage items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for payroll wage items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for payroll wage items whose `name`
|
|
5660
|
+
markdown: "## list\n\n`conductor.qbd.payrollWageItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; createdAt: string; expenseAccount: object; isActive: boolean; name: string; objectType: 'qbd_payroll_wage_item'; overtimeMultiplier: string; rate: string; ratePercent: string; revisionNumber: string; updatedAt: string; wageType: string; }`\n\n**get** `/quickbooks-desktop/payroll-wage-items`\n\nReturns a list of payroll wage items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific payroll wage items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for payroll wage items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for payroll wage items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for payroll wage items whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns payroll wage items sorted by `name` in that order; without either, the order is not guaranteed. To page through payroll wage items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific payroll wage items by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a payroll wage item.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for payroll wage items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for payroll wage items whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns payroll wage items sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for payroll wage items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for payroll wage items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for payroll wage items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; createdAt: string; expenseAccount: { id: string; fullName: string; }; isActive: boolean; name: string; objectType: 'qbd_payroll_wage_item'; overtimeMultiplier: string; rate: string; ratePercent: string; revisionNumber: string; updatedAt: string; wageType: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `expenseAccount: { id: string; fullName: string; }`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_payroll_wage_item'`\n - `overtimeMultiplier: string`\n - `rate: string`\n - `ratePercent: string`\n - `revisionNumber: string`\n - `updatedAt: string`\n - `wageType: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const payrollWageItem of conductor.qbd.payrollWageItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(payrollWageItem);\n}\n```",
|
|
5661
5661
|
perLanguage: {
|
|
5662
5662
|
typescript: {
|
|
5663
5663
|
method: 'client.qbd.payrollWageItems.list',
|
|
@@ -5766,7 +5766,7 @@ const EMBEDDED_METHODS = [
|
|
|
5766
5766
|
'Conductor-End-User-Id: string;',
|
|
5767
5767
|
'currencyIds?: string[];',
|
|
5768
5768
|
'ids?: string[];',
|
|
5769
|
-
'
|
|
5769
|
+
'itemId?: string;',
|
|
5770
5770
|
'limit?: number;',
|
|
5771
5771
|
'nameContains?: string;',
|
|
5772
5772
|
'nameEndsWith?: string;',
|
|
@@ -5779,7 +5779,7 @@ const EMBEDDED_METHODS = [
|
|
|
5779
5779
|
'updatedBefore?: string;',
|
|
5780
5780
|
],
|
|
5781
5781
|
response: "{ data: { id: string; createdAt: string; currency: object; fixedPercentage: string; isActive: boolean; name: string; objectType: 'qbd_price_level'; perItemPriceLevels: object[]; priceLevelType: 'fixed_percentage' | 'per_item'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
5782
|
-
markdown: "## list\n\n`conductor.qbd.priceLevels.list(Conductor-End-User-Id: string, currencyIds?: string[], ids?: string[],
|
|
5782
|
+
markdown: "## list\n\n`conductor.qbd.priceLevels.list(Conductor-End-User-Id: string, currencyIds?: string[], ids?: string[], itemId?: string, limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: price_level[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/price-levels`\n\nReturns a list of price levels.\n\n**NOTE:** QuickBooks Desktop does not support pagination for price levels; hence, there is no `cursor` parameter. Users typically have few price levels.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `currencyIds?: string[]`\n Filter for price levels in these currencies.\n\n- `ids?: string[]`\n Filter for specific price levels by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `itemId?: string`\n Filter for price levels containing this item. QuickBooks Desktop accepts only one item for this filter.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for price levels, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all price levels without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for price levels whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for price levels whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for price levels whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not return price levels sorted by name: it returns fixed-percentage price levels first, then per-item price levels, each group sorted by name. Do not use these parameters to page through price levels.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific price levels by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a price level.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for price levels whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for price levels whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**IMPORTANT**: Even when you set `nameFrom` or `nameTo`, QuickBooks does not return price levels sorted by name: it returns fixed-percentage price levels first, then per-item price levels, each group sorted by name. Do not use these parameters to page through price levels.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for price levels that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for price levels updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for price levels updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; currency: object; fixedPercentage: string; isActive: boolean; name: string; objectType: 'qbd_price_level'; perItemPriceLevels: object[]; priceLevelType: 'fixed_percentage' | 'per_item'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; currency: { id: string; fullName: string; }; fixedPercentage: string; isActive: boolean; name: string; objectType: 'qbd_price_level'; perItemPriceLevels: { customPrice: string; customPricePercent: string; item: { id: string; fullName: string; }; }[]; priceLevelType: 'fixed_percentage' | 'per_item'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst priceLevels = await conductor.qbd.priceLevels.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(priceLevels);\n```",
|
|
5783
5783
|
perLanguage: {
|
|
5784
5784
|
typescript: {
|
|
5785
5785
|
method: 'client.qbd.priceLevels.list',
|
|
@@ -5935,7 +5935,7 @@ const EMBEDDED_METHODS = [
|
|
|
5935
5935
|
'vendorIds?: string[];',
|
|
5936
5936
|
],
|
|
5937
5937
|
response: "{ id: string; class: object; createdAt: string; currency: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; expectedDate: string; externalId: string; inventorySite: object; isFullyReceived: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_purchase_order'; otherCustomField1: string; otherCustomField2: string; refNumber: string; revisionNumber: string; salesTaxCode: object; shipmentOrigin: string; shippingAddress: object; shippingMethod: object; shipToEntity: object; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; vendorMessage: string; }",
|
|
5938
|
-
markdown: "## list\n\n`conductor.qbd.purchaseOrders.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; class: object; createdAt: string; currency: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; expectedDate: string; externalId: string; inventorySite: object; isFullyReceived: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_purchase_order'; otherCustomField1: string; otherCustomField2: string; refNumber: string; revisionNumber: string; salesTaxCode: object; shipmentOrigin: string; shippingAddress: object; shippingMethod: object; shipToEntity: object; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; vendorMessage: string; }`\n\n**get** `/quickbooks-desktop/purchase-orders`\n\nReturns a list of purchase orders. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for purchase orders associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for purchase orders in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific purchase orders by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding purchase order.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for purchase orders whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for purchase orders whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for purchase orders whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific purchase orders by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for purchase orders whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for purchase orders whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for purchase orders whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for purchase orders whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for purchase orders updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for purchase orders updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for purchase orders sent to these vendors.\n\n### Returns\n\n- `{ id: string; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; expectedDate: string; externalId: string; inventorySite: { id: string; fullName: string; }; isFullyReceived: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; inventorySiteLocation: object; isBilled: boolean; isManuallyClosed: boolean; item: object; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; payee: object; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: object; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; objectType: 'qbd_purchase_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_purchase_order'; otherCustomField1: string; otherCustomField2: string; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingMethod: { id: string; fullName: string; }; shipToEntity: { id: string; fullName: string; }; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; vendorMessage: string; }`\n\n - `id: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `expectedDate: string`\n - `externalId: string`\n - `inventorySite: { id: string; fullName: string; }`\n - `isFullyReceived: boolean`\n - `isManuallyClosed: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; objectType: 'qbd_purchase_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_purchase_order'`\n - `otherCustomField1: string`\n - `otherCustomField2: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingMethod: { id: string; fullName: string; }`\n - `shipToEntity: { id: string; fullName: string; }`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n - `vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `vendorMessage: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const purchaseOrder of conductor.qbd.purchaseOrders.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(purchaseOrder);\n}\n```",
|
|
5938
|
+
markdown: "## list\n\n`conductor.qbd.purchaseOrders.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; class: object; createdAt: string; currency: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; expectedDate: string; externalId: string; inventorySite: object; isFullyReceived: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_purchase_order'; otherCustomField1: string; otherCustomField2: string; refNumber: string; revisionNumber: string; salesTaxCode: object; shipmentOrigin: string; shippingAddress: object; shippingMethod: object; shipToEntity: object; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: object; vendorAddress: object; vendorMessage: string; }`\n\n**get** `/quickbooks-desktop/purchase-orders`\n\nReturns a list of purchase orders. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for purchase orders associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for purchase orders in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific purchase orders by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding purchase order.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for purchase orders whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for purchase orders whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for purchase orders whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific purchase orders by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for purchase orders whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for purchase orders whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for purchase orders whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for purchase orders whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for purchase orders updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for purchase orders updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for purchase orders sent to these vendors.\n\n### Returns\n\n- `{ id: string; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; expectedDate: string; externalId: string; inventorySite: { id: string; fullName: string; }; isFullyReceived: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; inventorySiteLocation: object; isBilled: boolean; isManuallyClosed: boolean; item: object; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; payee: object; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: object; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; objectType: 'qbd_purchase_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_purchase_order'; otherCustomField1: string; otherCustomField2: string; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingMethod: { id: string; fullName: string; }; shipToEntity: { id: string; fullName: string; }; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; vendorMessage: string; }`\n\n - `id: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `expectedDate: string`\n - `externalId: string`\n - `inventorySite: { id: string; fullName: string; }`\n - `isFullyReceived: boolean`\n - `isManuallyClosed: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]; objectType: 'qbd_purchase_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; inventorySiteLocation: { id: string; fullName: string; }; isBilled: boolean; isManuallyClosed: boolean; item: { id: string; fullName: string; }; objectType: 'qbd_purchase_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; payee: { id: string; fullName: string; }; quantity: number; rate: string; receivedQuantity: number; salesTaxCode: { id: string; fullName: string; }; serviceDate: string; sku: string; unbilledQuantity: number; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_purchase_order'`\n - `otherCustomField1: string`\n - `otherCustomField2: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingMethod: { id: string; fullName: string; }`\n - `shipToEntity: { id: string; fullName: string; }`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n - `vendorAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `vendorMessage: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const purchaseOrder of conductor.qbd.purchaseOrders.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(purchaseOrder);\n}\n```",
|
|
5939
5939
|
perLanguage: {
|
|
5940
5940
|
typescript: {
|
|
5941
5941
|
method: 'client.qbd.purchaseOrders.list',
|
|
@@ -6123,7 +6123,7 @@ const EMBEDDED_METHODS = [
|
|
|
6123
6123
|
'updatedBefore?: string;',
|
|
6124
6124
|
],
|
|
6125
6125
|
response: "{ id: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: object; discountAmount: string; discountClass: object; linkedTransactions: object[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardTransaction: { request: object; response: object; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_receive_payment'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; unusedCredits: string; unusedPayment: string; updatedAt: string; }",
|
|
6126
|
-
markdown: "## list\n\n`conductor.qbd.receivePayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; appliedToTransactions: object[]; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customFields: object[]; depositToAccount: object; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_receive_payment'; paymentMethod: object; receivablesAccount: object; refNumber: string; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; unusedCredits: string; unusedPayment: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/receive-payments`\n\nReturns a list of receive-payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for receive-payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for receive-payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for receive-payments received from these customers.\n\n- `ids?: string[]`\n Filter for specific receive-payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for receive-payments whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for receive-payments whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for receive-payments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific receive-payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for receive-payments whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for receive-payments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for receive-payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for receive-payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for receive-payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for receive-payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_receive_payment'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; unusedCredits: string; unusedPayment: string; updatedAt: string; }`\n\n - `id: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_receive_payment'`\n - `paymentMethod: { id: string; fullName: string; }`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `unusedCredits: string`\n - `unusedPayment: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const receivePayment of conductor.qbd.receivePayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(receivePayment);\n}\n```",
|
|
6126
|
+
markdown: "## list\n\n`conductor.qbd.receivePayments.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; appliedToTransactions: object[]; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customFields: object[]; depositToAccount: object; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_receive_payment'; paymentMethod: object; receivablesAccount: object; refNumber: string; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; unusedCredits: string; unusedPayment: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/receive-payments`\n\nReturns a list of receive-payments. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for receive-payments associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for receive-payments in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for receive-payments received from these customers.\n\n- `ids?: string[]`\n Filter for specific receive-payments by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for receive-payments whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for receive-payments whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for receive-payments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific receive-payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for receive-payments whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for receive-payments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for receive-payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for receive-payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for receive-payments updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for receive-payments updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; exchangeRate: number; externalId: string; memo: string; objectType: 'qbd_receive_payment'; paymentMethod: { id: string; fullName: string; }; receivablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; unusedCredits: string; unusedPayment: string; updatedAt: string; }`\n\n - `id: string`\n - `appliedToTransactions: { amount: string; balanceRemaining: string; discountAccount: { id: string; fullName: string; }; discountAmount: string; discountClass: { id: string; fullName: string; }; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; refNumber: string; transactionDate: string; transactionId: string; transactionType: string; }[]`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `externalId: string`\n - `memo: string`\n - `objectType: 'qbd_receive_payment'`\n - `paymentMethod: { id: string; fullName: string; }`\n - `receivablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `unusedCredits: string`\n - `unusedPayment: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const receivePayment of conductor.qbd.receivePayments.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(receivePayment);\n}\n```",
|
|
6127
6127
|
perLanguage: {
|
|
6128
6128
|
typescript: {
|
|
6129
6129
|
method: 'client.qbd.receivePayments.list',
|
|
@@ -6813,7 +6813,7 @@ const EMBEDDED_METHODS = [
|
|
|
6813
6813
|
'updatedBefore?: string;',
|
|
6814
6814
|
],
|
|
6815
6815
|
response: "{ id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFullyInvoiced: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_sales_order'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesChannelName: 'blank' | 'ecommerce'; salesRepresentative: object; salesStoreName: string; salesStoreType: string; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }",
|
|
6816
|
-
markdown: "## list\n\n`conductor.qbd.salesOrders.list(Conductor-End-User-Id: string, currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFullyInvoiced: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_sales_order'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesChannelName: 'blank' | 'ecommerce'; salesRepresentative: object; salesStoreName: string; salesStoreType: string; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-orders`\n\nReturns a list of sales orders. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `currencyIds?: string[]`\n Filter for sales orders in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for sales orders created for these customers.\n\n- `ids?: string[]`\n Filter for specific sales orders by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding sales order.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales orders whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales orders whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales orders whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales orders by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales orders whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales orders whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales orders whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales orders whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales orders updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales orders updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isFullyInvoiced: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; isManuallyClosed: boolean; item: object; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_sales_order'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesChannelName: 'blank' | 'ecommerce'; salesRepresentative: { id: string; fullName: string; }; salesStoreName: string; salesStoreType: string; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isFullyInvoiced: boolean`\n - `isManuallyClosed: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_order'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesChannelName: 'blank' | 'ecommerce'`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesStoreName: string`\n - `salesStoreType: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesOrder of conductor.qbd.salesOrders.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesOrder);\n}\n```",
|
|
6816
|
+
markdown: "## list\n\n`conductor.qbd.salesOrders.list(Conductor-End-User-Id: string, currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; class: object; createdAt: string; currency: object; customer: object; customerMessage: object; customFields: object[]; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isFullyInvoiced: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_sales_order'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesChannelName: 'blank' | 'ecommerce'; salesRepresentative: object; salesStoreName: string; salesStoreType: string; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; terms: object; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-orders`\n\nReturns a list of sales orders. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `currencyIds?: string[]`\n Filter for sales orders in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for sales orders created for these customers.\n\n- `ids?: string[]`\n Filter for specific sales orders by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding sales order.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales orders whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales orders whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales orders whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales orders by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales orders whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales orders whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales orders whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales orders whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales orders updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales orders updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; class: { id: string; fullName: string; }; createdAt: string; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isFullyInvoiced: boolean; isManuallyClosed: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; isManuallyClosed: boolean; item: object; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_sales_order'; otherCustomField: string; purchaseOrderNumber: string; refNumber: string; revisionNumber: string; salesChannelName: 'blank' | 'ecommerce'; salesRepresentative: { id: string; fullName: string; }; salesStoreName: string; salesStoreType: string; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; terms: { id: string; fullName: string; }; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isFullyInvoiced: boolean`\n - `isManuallyClosed: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_order_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; isManuallyClosed: boolean; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_order_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; quantityInvoiced: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_order'`\n - `otherCustomField: string`\n - `purchaseOrderNumber: string`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesChannelName: 'blank' | 'ecommerce'`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesStoreName: string`\n - `salesStoreType: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `terms: { id: string; fullName: string; }`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesOrder of conductor.qbd.salesOrders.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesOrder);\n}\n```",
|
|
6817
6817
|
perLanguage: {
|
|
6818
6818
|
typescript: {
|
|
6819
6819
|
method: 'client.qbd.salesOrders.list',
|
|
@@ -7019,7 +7019,7 @@ const EMBEDDED_METHODS = [
|
|
|
7019
7019
|
'updatedBefore?: string;',
|
|
7020
7020
|
],
|
|
7021
7021
|
response: "{ id: string; billingAddress: object; checkNumber: string; class: object; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customerMessage: object; customFields: object[]; depositToAccount: object; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; memo: string; objectType: 'qbd_sales_receipt'; otherCustomField: string; paymentMethod: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }",
|
|
7022
|
-
markdown: "## list\n\n`conductor.qbd.salesReceipts.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; checkNumber: string; class: object; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customerMessage: object; customFields: object[]; depositToAccount: object; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; memo: string; objectType: 'qbd_sales_receipt'; otherCustomField: string; paymentMethod: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-receipts`\n\nReturns a list of sales receipts. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for sales receipts associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for sales receipts in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `customerIds?: string[]`\n Filter for sales receipts created for these customers.\n\n- `ids?: string[]`\n Filter for specific sales receipts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales receipts whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales receipts whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales receipts whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales receipts whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales receipts whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales receipts whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales receipts whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales receipts updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales receipts updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; checkNumber: string; class: { id: string; fullName: string; }; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; creditCardTransaction: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_receipt_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: object; response: object; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_sales_receipt'; otherCustomField: string; paymentMethod: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `checkNumber: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_receipt_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_receipt'`\n - `otherCustomField: string`\n - `paymentMethod: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesReceipt of conductor.qbd.salesReceipts.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesReceipt);\n}\n```",
|
|
7022
|
+
markdown: "## list\n\n`conductor.qbd.salesReceipts.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, customerIds?: string[], ids?: string[], includeLineItems?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingAddress: object; checkNumber: string; class: object; createdAt: string; creditCardTransaction: object; currency: object; customer: object; customerMessage: object; customFields: object[]; depositToAccount: object; documentTemplate: object; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: object[]; lines: object[]; memo: string; objectType: 'qbd_sales_receipt'; otherCustomField: string; paymentMethod: object; refNumber: string; revisionNumber: string; salesRepresentative: object; salesTaxCode: object; salesTaxItem: object; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: object; shippingDate: string; shippingMethod: object; subtotal: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-receipts`\n\nReturns a list of sales receipts. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for sales receipts associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for sales receipts in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `customerIds?: string[]`\n Filter for sales receipts created for these customers.\n\n- `ids?: string[]`\n Filter for specific sales receipts by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales receipts whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales receipts whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales receipts whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales receipts whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales receipts whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales receipts whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales receipts whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales receipts updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales receipts updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; checkNumber: string; class: { id: string; fullName: string; }; createdAt: string; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; currency: { id: string; fullName: string; }; customer: { id: string; fullName: string; }; customerMessage: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; depositToAccount: { id: string; fullName: string; }; documentTemplate: { id: string; fullName: string; }; dueDate: string; exchangeRate: number; externalId: string; isPending: boolean; isQueuedForEmail: boolean; isQueuedForPrint: boolean; lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: object; creditCardTransaction: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: object; quantity: number; rate: string; ratePercent: string; salesTaxCode: object; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_receipt_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]; lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: object; response: object; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; memo: string; objectType: 'qbd_sales_receipt'; otherCustomField: string; paymentMethod: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxItem: { id: string; fullName: string; }; salesTaxPercentage: string; salesTaxTotal: string; shipmentOrigin: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; shippingDate: string; shippingMethod: { id: string; fullName: string; }; subtotal: string; totalAmount: string; totalAmountInHomeCurrency: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `checkNumber: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }`\n - `currency: { id: string; fullName: string; }`\n - `customer: { id: string; fullName: string; }`\n - `customerMessage: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `depositToAccount: { id: string; fullName: string; }`\n - `documentTemplate: { id: string; fullName: string; }`\n - `dueDate: string`\n - `exchangeRate: number`\n - `externalId: string`\n - `isPending: boolean`\n - `isQueuedForEmail: boolean`\n - `isQueuedForPrint: boolean`\n - `lineGroups: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]; objectType: 'qbd_sales_receipt_line_group'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; serviceDate: string; shouldPrintItemsInGroup: boolean; totalAmount: string; unitOfMeasure: string; }[]`\n - `lines: { id: string; amount: string; class: { id: string; fullName: string; }; creditCardTransaction: { request: { address: string; commercialCardCode: string; expirationMonth: number; expirationYear: number; name: string; number: string; postalCode: string; transactionMode: 'card_not_present' | 'card_present'; transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization'; }; response: { authorizationCode: string; avsStreetStatus: 'fail' | 'not_available' | 'pass'; avsZipStatus: 'fail' | 'not_available' | 'pass'; cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass'; clientTransactionId: string; creditCardTransactionId: string; merchantAccountNumber: string; paymentGroupingCode: number; paymentStatus: 'completed' | 'unknown'; reconBatchId: string; statusCode: number; statusMessage: string; transactionAuthorizationStamp: number; transactionAuthorizedAt: string; }; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_sales_receipt_line'; otherCustomField1: string; otherCustomField2: string; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; rate: string; ratePercent: string; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; serviceDate: string; unitOfMeasure: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_receipt'`\n - `otherCustomField: string`\n - `paymentMethod: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesRepresentative: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxItem: { id: string; fullName: string; }`\n - `salesTaxPercentage: string`\n - `salesTaxTotal: string`\n - `shipmentOrigin: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `shippingDate: string`\n - `shippingMethod: { id: string; fullName: string; }`\n - `subtotal: string`\n - `totalAmount: string`\n - `totalAmountInHomeCurrency: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesReceipt of conductor.qbd.salesReceipts.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesReceipt);\n}\n```",
|
|
7023
7023
|
perLanguage: {
|
|
7024
7024
|
typescript: {
|
|
7025
7025
|
method: 'client.qbd.salesReceipts.list',
|
|
@@ -7217,7 +7217,7 @@ const EMBEDDED_METHODS = [
|
|
|
7217
7217
|
'updatedBefore?: string;',
|
|
7218
7218
|
],
|
|
7219
7219
|
response: "{ data: { id: string; createdAt: string; entity: object; initial: string; isActive: boolean; objectType: 'qbd_sales_representative'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
7220
|
-
markdown: "## list\n\n`conductor.qbd.salesRepresentatives.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: sales_representative[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/sales-representatives`\n\nReturns a list of sales representatives.\n\n**NOTE:** QuickBooks Desktop does not support pagination for sales representatives; hence, there is no `cursor` parameter. Users typically have few sales representatives.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific sales representatives by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for sales representatives
|
|
7220
|
+
markdown: "## list\n\n`conductor.qbd.salesRepresentatives.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: sales_representative[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/sales-representatives`\n\nReturns a list of sales representatives.\n\n**NOTE:** QuickBooks Desktop does not support pagination for sales representatives; hence, there is no `cursor` parameter. Users typically have few sales representatives.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific sales representatives by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for sales representatives, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all sales representatives without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for sales representatives whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales representatives whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales representatives whose `initial` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific sales representatives by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a sales representative.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for sales representatives whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for sales representatives whose `initial` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for sales representatives that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for sales representatives updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales representatives updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; entity: object; initial: string; isActive: boolean; objectType: 'qbd_sales_representative'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; entity: { id: string; fullName: string; }; initial: string; isActive: boolean; objectType: 'qbd_sales_representative'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst salesRepresentatives = await conductor.qbd.salesRepresentatives.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesRepresentatives);\n```",
|
|
7221
7221
|
perLanguage: {
|
|
7222
7222
|
typescript: {
|
|
7223
7223
|
method: 'client.qbd.salesRepresentatives.list',
|
|
@@ -7344,7 +7344,7 @@ const EMBEDDED_METHODS = [
|
|
|
7344
7344
|
'updatedBefore?: string;',
|
|
7345
7345
|
],
|
|
7346
7346
|
response: "{ data: { id: string; createdAt: string; description: string; isActive: boolean; isTaxable: boolean; name: string; objectType: 'qbd_sales_tax_code'; revisionNumber: string; salesTaxItem: object; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
7347
|
-
markdown: "## list\n\n`conductor.qbd.salesTaxCodes.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: sales_tax_code[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-codes`\n\nReturns a list of sales-tax codes.\n\n**NOTE:** QuickBooks Desktop does not support pagination for sales-tax codes; hence, there is no `cursor` parameter. Users typically have few sales-tax codes.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific sales-tax codes by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for sales-tax codes
|
|
7347
|
+
markdown: "## list\n\n`conductor.qbd.salesTaxCodes.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: sales_tax_code[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-codes`\n\nReturns a list of sales-tax codes.\n\n**NOTE:** QuickBooks Desktop does not support pagination for sales-tax codes; hence, there is no `cursor` parameter. Users typically have few sales-tax codes.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific sales-tax codes by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for sales-tax codes, so this parameter only limits the response size. To page through sales-tax codes by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all sales-tax codes without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for sales-tax codes whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales-tax codes whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales-tax codes whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax codes sorted by `name` in that order; without either, the order is not guaranteed. To page through sales-tax codes by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific sales-tax codes by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a sales-tax code.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for sales-tax codes whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for sales-tax codes whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax codes sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for sales-tax codes that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for sales-tax codes updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales-tax codes updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; description: string; isActive: boolean; isTaxable: boolean; name: string; objectType: 'qbd_sales_tax_code'; revisionNumber: string; salesTaxItem: object; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; description: string; isActive: boolean; isTaxable: boolean; name: string; objectType: 'qbd_sales_tax_code'; revisionNumber: string; salesTaxItem: { id: string; fullName: string; }; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst salesTaxCodes = await conductor.qbd.salesTaxCodes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxCodes);\n```",
|
|
7348
7348
|
perLanguage: {
|
|
7349
7349
|
typescript: {
|
|
7350
7350
|
method: 'client.qbd.salesTaxCodes.list',
|
|
@@ -7475,7 +7475,7 @@ const EMBEDDED_METHODS = [
|
|
|
7475
7475
|
'updatedBefore?: string;',
|
|
7476
7476
|
],
|
|
7477
7477
|
response: "{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_group_item'; revisionNumber: string; salesTaxItems: { id: string; fullName: string; }[]; updatedAt: string; }",
|
|
7478
|
-
markdown: "## list\n\n`conductor.qbd.salesTaxGroupItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_group_item'; revisionNumber: string; salesTaxItems: object[]; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-group-items`\n\nReturns a list of sales-tax group items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific sales-tax group items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for sales-tax group items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales-tax group items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales-tax group items whose `name`
|
|
7478
|
+
markdown: "## list\n\n`conductor.qbd.salesTaxGroupItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_group_item'; revisionNumber: string; salesTaxItems: object[]; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-group-items`\n\nReturns a list of sales-tax group items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific sales-tax group items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for sales-tax group items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales-tax group items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales-tax group items whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax group items sorted by `name` in that order; without either, the order is not guaranteed. To page through sales-tax group items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific sales-tax group items by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a sales-tax group item.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for sales-tax group items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for sales-tax group items whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax group items sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for sales-tax group items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for sales-tax group items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales-tax group items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_group_item'; revisionNumber: string; salesTaxItems: { id: string; fullName: string; }[]; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `description: string`\n - `externalId: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_sales_tax_group_item'`\n - `revisionNumber: string`\n - `salesTaxItems: { id: string; fullName: string; }[]`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxGroupItem of conductor.qbd.salesTaxGroupItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesTaxGroupItem);\n}\n```",
|
|
7479
7479
|
perLanguage: {
|
|
7480
7480
|
typescript: {
|
|
7481
7481
|
method: 'client.qbd.salesTaxGroupItems.list',
|
|
@@ -7610,7 +7610,7 @@ const EMBEDDED_METHODS = [
|
|
|
7610
7610
|
'updatedBefore?: string;',
|
|
7611
7611
|
],
|
|
7612
7612
|
response: "{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_item'; revisionNumber: string; salesTaxReturnLine: { id: string; fullName: string; }; taxRate: string; taxVendor: { id: string; fullName: string; }; updatedAt: string; }",
|
|
7613
|
-
markdown: "## list\n\n`conductor.qbd.salesTaxItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_item'; revisionNumber: string; salesTaxReturnLine: object; taxRate: string; taxVendor: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-items`\n\nReturns a list of sales-tax items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for sales-tax items of these classes. A class is a way end-users can categorize sales-tax items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific sales-tax items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for sales-tax items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales-tax items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales-tax items whose `name`
|
|
7613
|
+
markdown: "## list\n\n`conductor.qbd.salesTaxItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_item'; revisionNumber: string; salesTaxReturnLine: object; taxRate: string; taxVendor: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/sales-tax-items`\n\nReturns a list of sales-tax items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for sales-tax items of these classes. A class is a way end-users can categorize sales-tax items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific sales-tax items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for sales-tax items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for sales-tax items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for sales-tax items whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax items sorted by `name` in that order; without either, the order is not guaranteed. To page through sales-tax items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific sales-tax items by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a sales-tax item.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for sales-tax items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for sales-tax items whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns sales-tax items sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for sales-tax items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for sales-tax items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales-tax items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_item'; revisionNumber: string; salesTaxReturnLine: { id: string; fullName: string; }; taxRate: string; taxVendor: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `description: string`\n - `externalId: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_sales_tax_item'`\n - `revisionNumber: string`\n - `salesTaxReturnLine: { id: string; fullName: string; }`\n - `taxRate: string`\n - `taxVendor: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxItem of conductor.qbd.salesTaxItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesTaxItem);\n}\n```",
|
|
7614
7614
|
perLanguage: {
|
|
7615
7615
|
typescript: {
|
|
7616
7616
|
method: 'client.qbd.salesTaxItems.list',
|
|
@@ -7752,7 +7752,7 @@ const EMBEDDED_METHODS = [
|
|
|
7752
7752
|
'vendorIds?: string[];',
|
|
7753
7753
|
],
|
|
7754
7754
|
response: "{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; bankAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; isQueuedForPrint: boolean; lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }",
|
|
7755
|
-
markdown: "## list\n\n`conductor.qbd.salesTaxPaymentChecks.list(Conductor-End-User-Id: string, accountIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, itemIds?: string[], limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; address: object; amount: string; bankAccount: object; createdAt: string; customFields: object[]; externalId: string; isQueuedForPrint: boolean; lines: object[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/sales-tax-payment-checks`\n\nReturns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for sales-tax payment checks associated with these accounts.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific sales-tax payment checks by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for sales-tax payment checks containing these items.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales-tax payment checks whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales-tax payment checks whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales-tax payment checks whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales-tax payment checks by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales-tax payment checks whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales-tax payment checks whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales-tax payment checks whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales-tax payment checks whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales-tax payment checks updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales-tax payment checks updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for sales-tax payment checks paid to these vendors. These are the sales-tax agencies, represented as QuickBooks vendors, paid by these checks.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; bankAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; isQueuedForPrint: boolean; lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `isQueuedForPrint: boolean`\n - `lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_tax_payment_check'`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxPaymentCheck of conductor.qbd.salesTaxPaymentChecks.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesTaxPaymentCheck);\n}\n```",
|
|
7755
|
+
markdown: "## list\n\n`conductor.qbd.salesTaxPaymentChecks.list(Conductor-End-User-Id: string, accountIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, itemIds?: string[], limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; address: object; amount: string; bankAccount: object; createdAt: string; customFields: object[]; externalId: string; isQueuedForPrint: boolean; lines: object[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/sales-tax-payment-checks`\n\nReturns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for sales-tax payment checks associated with these accounts.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific sales-tax payment checks by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for sales-tax payment checks containing these items.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales-tax payment checks whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales-tax payment checks whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales-tax payment checks whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific sales-tax payment checks by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for sales-tax payment checks whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for sales-tax payment checks whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for sales-tax payment checks whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for sales-tax payment checks whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for sales-tax payment checks updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for sales-tax payment checks updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for sales-tax payment checks paid to these vendors. These are the sales-tax agencies, represented as QuickBooks vendors, paid by these checks.\n\n### Returns\n\n- `{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; bankAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; isQueuedForPrint: boolean; lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `amount: string`\n - `bankAccount: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `isQueuedForPrint: boolean`\n - `lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_sales_tax_payment_check'`\n - `refNumber: string`\n - `revisionNumber: string`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxPaymentCheck of conductor.qbd.salesTaxPaymentChecks.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(salesTaxPaymentCheck);\n}\n```",
|
|
7756
7756
|
perLanguage: {
|
|
7757
7757
|
typescript: {
|
|
7758
7758
|
method: 'client.qbd.salesTaxPaymentChecks.list',
|
|
@@ -7939,7 +7939,7 @@ const EMBEDDED_METHODS = [
|
|
|
7939
7939
|
'updatedBefore?: string;',
|
|
7940
7940
|
],
|
|
7941
7941
|
response: "{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_service_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }",
|
|
7942
|
-
markdown: "## list\n\n`conductor.qbd.serviceItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_service_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/service-items`\n\nReturns a list of service items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for service items of these classes. A class is a way end-users can categorize service items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `fullNames?: string[]`\n Filter for specific service items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a service item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a service item is under \"Consulting\" and has the `name` \"Web-Design\", its `fullName` would be \"Consulting:Web-Design\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific service items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for service items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for service items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for service items whose `
|
|
7942
|
+
markdown: "## list\n\n`conductor.qbd.serviceItems.list(Conductor-End-User-Id: string, classIds?: string[], cursor?: string, fullNames?: string[], ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; class: object; createdAt: string; customFields: object[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_service_item'; parent: object; revisionNumber: string; salesAndPurchaseDetails: object; salesOrPurchaseDetails: object; salesTaxCode: object; sublevel: number; unitOfMeasureSet: object; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/service-items`\n\nReturns a list of service items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for service items of these classes. A class is a way end-users can categorize service items in QuickBooks.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `fullNames?: string[]`\n Filter for specific service items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for a service item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if a service item is under \"Consulting\" and has the `name` \"Web-Design\", its `fullName` would be \"Consulting:Web-Design\".\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `ids?: string[]`\n Filter for specific service items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for service items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for service items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for service items whose `fullName` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns service items sorted by `fullName` in that order; without either, the order is not guaranteed. To page through service items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `nameStartsWith?: string`\n Filter for service items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for service items whose `fullName` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns service items sorted by `fullName` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for service items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for service items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for service items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; class: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; fullName: string; isActive: boolean; name: string; objectType: 'qbd_service_item'; parent: { id: string; fullName: string; }; revisionNumber: string; salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }; salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }; salesTaxCode: { id: string; fullName: string; }; sublevel: number; unitOfMeasureSet: { id: string; fullName: string; }; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `externalId: string`\n - `fullName: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_service_item'`\n - `parent: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `salesAndPurchaseDetails: { expenseAccount: { id: string; fullName: string; }; incomeAccount: { id: string; fullName: string; }; preferredVendor: { id: string; fullName: string; }; purchaseCost: string; purchaseDescription: string; purchaseTaxCode: { id: string; fullName: string; }; salesDescription: string; salesPrice: string; }`\n - `salesOrPurchaseDetails: { description: string; postingAccount: { id: string; fullName: string; }; price: string; pricePercentage: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `sublevel: number`\n - `unitOfMeasureSet: { id: string; fullName: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const serviceItem of conductor.qbd.serviceItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(serviceItem);\n}\n```",
|
|
7943
7943
|
perLanguage: {
|
|
7944
7944
|
typescript: {
|
|
7945
7945
|
method: 'client.qbd.serviceItems.list',
|
|
@@ -8066,7 +8066,7 @@ const EMBEDDED_METHODS = [
|
|
|
8066
8066
|
'updatedBefore?: string;',
|
|
8067
8067
|
],
|
|
8068
8068
|
response: "{ data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_shipping_method'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
8069
|
-
markdown: "## list\n\n`conductor.qbd.shippingMethods.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: shipping_method[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/shipping-methods`\n\nReturns a list of shipping methods.\n\n**NOTE:** QuickBooks Desktop does not support pagination for shipping methods; hence, there is no `cursor` parameter. Users typically have few shipping methods.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific shipping methods by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for shipping methods
|
|
8069
|
+
markdown: "## list\n\n`conductor.qbd.shippingMethods.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: shipping_method[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/shipping-methods`\n\nReturns a list of shipping methods.\n\n**NOTE:** QuickBooks Desktop does not support pagination for shipping methods; hence, there is no `cursor` parameter. Users typically have few shipping methods.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific shipping methods by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for shipping methods, so this parameter only limits the response size. To page through shipping methods by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all shipping methods without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for shipping methods whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for shipping methods whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for shipping methods whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns shipping methods sorted by `name` in that order; without either, the order is not guaranteed. To page through shipping methods by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific shipping methods by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a shipping method.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for shipping methods whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for shipping methods whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns shipping methods sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for shipping methods that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for shipping methods updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for shipping methods updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_shipping_method'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; isActive: boolean; name: string; objectType: 'qbd_shipping_method'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst shippingMethods = await conductor.qbd.shippingMethods.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(shippingMethods);\n```",
|
|
8070
8070
|
perLanguage: {
|
|
8071
8071
|
typescript: {
|
|
8072
8072
|
method: 'client.qbd.shippingMethods.list',
|
|
@@ -8161,7 +8161,7 @@ const EMBEDDED_METHODS = [
|
|
|
8161
8161
|
'updatedBefore?: string;',
|
|
8162
8162
|
],
|
|
8163
8163
|
response: "{ data: { id: string; createdAt: string; discountDays: number; discountPercentage: string; dueDays: number; isActive: boolean; name: string; objectType: 'qbd_standard_term'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
8164
|
-
markdown: "## list\n\n`conductor.qbd.standardTerms.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: standard_term[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/standard-terms`\n\nReturns a list of standard terms.\n\n**NOTE:** QuickBooks Desktop does not support pagination for standard terms; hence, there is no `cursor` parameter. Users typically have few standard terms.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific standard terms by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for standard terms
|
|
8164
|
+
markdown: "## list\n\n`conductor.qbd.standardTerms.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: standard_term[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/standard-terms`\n\nReturns a list of standard terms.\n\n**NOTE:** QuickBooks Desktop does not support pagination for standard terms; hence, there is no `cursor` parameter. Users typically have few standard terms.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific standard terms by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for standard terms, so this parameter only limits the response size. To page through standard terms by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\nWhen this parameter is omitted, the endpoint returns all standard terms without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for standard terms whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for standard terms whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for standard terms whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns standard terms sorted by `name` in that order; without either, the order is not guaranteed. To page through standard terms by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific standard terms by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a standard term.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for standard terms whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for standard terms whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns standard terms sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for standard terms that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for standard terms updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for standard terms updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; discountDays: number; discountPercentage: string; dueDays: number; isActive: boolean; name: string; objectType: 'qbd_standard_term'; revisionNumber: string; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; createdAt: string; discountDays: number; discountPercentage: string; dueDays: number; isActive: boolean; name: string; objectType: 'qbd_standard_term'; revisionNumber: string; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst standardTerms = await conductor.qbd.standardTerms.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(standardTerms);\n```",
|
|
8165
8165
|
perLanguage: {
|
|
8166
8166
|
typescript: {
|
|
8167
8167
|
method: 'client.qbd.standardTerms.list',
|
|
@@ -8257,7 +8257,7 @@ const EMBEDDED_METHODS = [
|
|
|
8257
8257
|
'updatedBefore?: string;',
|
|
8258
8258
|
],
|
|
8259
8259
|
response: "{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_subtotal_item'; revisionNumber: string; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; updatedAt: string; }",
|
|
8260
|
-
markdown: "## list\n\n`conductor.qbd.subtotalItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_subtotal_item'; revisionNumber: string; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/subtotal-items`\n\nReturns a list of subtotal items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific subtotal items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for subtotal items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for subtotal items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for subtotal items whose `name`
|
|
8260
|
+
markdown: "## list\n\n`conductor.qbd.subtotalItems.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { id: string; barcode: string; createdAt: string; customFields: object[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_subtotal_item'; revisionNumber: string; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/subtotal-items`\n\nReturns a list of subtotal items. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific subtotal items by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for subtotal items whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for subtotal items whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for subtotal items whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns subtotal items sorted by `name` in that order; without either, the order is not guaranteed. To page through subtotal items by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific subtotal items by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a subtotal item.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for subtotal items whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for subtotal items whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns subtotal items sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for subtotal items that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for subtotal items updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for subtotal items updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_subtotal_item'; revisionNumber: string; specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'; updatedAt: string; }`\n\n - `id: string`\n - `barcode: string`\n - `createdAt: string`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `description: string`\n - `externalId: string`\n - `isActive: boolean`\n - `name: string`\n - `objectType: 'qbd_subtotal_item'`\n - `revisionNumber: string`\n - `specialItemType: 'finance_charge' | 'reimbursable_expense_group' | 'reimbursable_expense_subtotal'`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const subtotalItem of conductor.qbd.subtotalItems.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(subtotalItem);\n}\n```",
|
|
8261
8261
|
perLanguage: {
|
|
8262
8262
|
typescript: {
|
|
8263
8263
|
method: 'client.qbd.subtotalItems.list',
|
|
@@ -8412,7 +8412,7 @@ const EMBEDDED_METHODS = [
|
|
|
8412
8412
|
'updatedBefore?: string;',
|
|
8413
8413
|
],
|
|
8414
8414
|
response: "{ id: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; createdAt: string; customer: { id: string; fullName: string; }; duration: string; entity: { id: string; fullName: string; }; externalId: string; isBilled: boolean; note: string; objectType: 'qbd_time_tracking_activity'; payrollWageItem: { id: string; fullName: string; }; revisionNumber: string; serviceItem: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }",
|
|
8415
|
-
markdown: "## list\n\n`conductor.qbd.timeTrackingActivities.list(Conductor-End-User-Id: string, cursor?: string, entityIds?: string[], ids?: string[], limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; createdAt: string; customer: object; duration: string; entity: object; externalId: string; isBilled: boolean; note: string; objectType: 'qbd_time_tracking_activity'; payrollWageItem: object; revisionNumber: string; serviceItem: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/time-tracking-activities`\n\nReturns a list of time tracking activities. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `entityIds?: string[]`\n Filter for time tracking activities tracking the time of these employees, vendors, or persons on QuickBooks's \"Other Names\" list.\n\n- `ids?: string[]`\n Filter for specific time tracking activities by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for time tracking activities whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for time tracking activities whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for time tracking activities updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for time tracking activities updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; createdAt: string; customer: { id: string; fullName: string; }; duration: string; entity: { id: string; fullName: string; }; externalId: string; isBilled: boolean; note: string; objectType: 'qbd_time_tracking_activity'; payrollWageItem: { id: string; fullName: string; }; revisionNumber: string; serviceItem: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingStatus: 'billable' | 'has_been_billed' | 'not_billable'`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customer: { id: string; fullName: string; }`\n - `duration: string`\n - `entity: { id: string; fullName: string; }`\n - `externalId: string`\n - `isBilled: boolean`\n - `note: string`\n - `objectType: 'qbd_time_tracking_activity'`\n - `payrollWageItem: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `serviceItem: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const timeTrackingActivity of conductor.qbd.timeTrackingActivities.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(timeTrackingActivity);\n}\n```",
|
|
8415
|
+
markdown: "## list\n\n`conductor.qbd.timeTrackingActivities.list(Conductor-End-User-Id: string, cursor?: string, entityIds?: string[], ids?: string[], limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; createdAt: string; customer: object; duration: string; entity: object; externalId: string; isBilled: boolean; note: string; objectType: 'qbd_time_tracking_activity'; payrollWageItem: object; revisionNumber: string; serviceItem: object; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/time-tracking-activities`\n\nReturns a list of time tracking activities. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `entityIds?: string[]`\n Filter for time tracking activities tracking the time of these employees, vendors, or persons on QuickBooks's \"Other Names\" list.\n\n- `ids?: string[]`\n Filter for specific time tracking activities by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for time tracking activities whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for time tracking activities whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for time tracking activities updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for time tracking activities updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; createdAt: string; customer: { id: string; fullName: string; }; duration: string; entity: { id: string; fullName: string; }; externalId: string; isBilled: boolean; note: string; objectType: 'qbd_time_tracking_activity'; payrollWageItem: { id: string; fullName: string; }; revisionNumber: string; serviceItem: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `billingStatus: 'billable' | 'has_been_billed' | 'not_billable'`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `customer: { id: string; fullName: string; }`\n - `duration: string`\n - `entity: { id: string; fullName: string; }`\n - `externalId: string`\n - `isBilled: boolean`\n - `note: string`\n - `objectType: 'qbd_time_tracking_activity'`\n - `payrollWageItem: { id: string; fullName: string; }`\n - `revisionNumber: string`\n - `serviceItem: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const timeTrackingActivity of conductor.qbd.timeTrackingActivities.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(timeTrackingActivity);\n}\n```",
|
|
8416
8416
|
perLanguage: {
|
|
8417
8417
|
typescript: {
|
|
8418
8418
|
method: 'client.qbd.timeTrackingActivities.list',
|
|
@@ -8549,7 +8549,7 @@ const EMBEDDED_METHODS = [
|
|
|
8549
8549
|
'updatedBefore?: string;',
|
|
8550
8550
|
],
|
|
8551
8551
|
response: '{ account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; exchangeRate: number; memo: string; refNumber: string; transactionDate: string; transactionId: string; transactionLineId: string; transactionType: string; updatedAt: string; }',
|
|
8552
|
-
markdown: "## list\n\n`conductor.qbd.transactions.list(Conductor-End-User-Id: string, accountIds?: string[], classIds?: string[], currencyIds?: string[], cursor?: string, detailLevel?: 'all' | 'transaction_lines_only' | 'transactions_without_lines', entityIds?: string[], ids?: string[], itemIds?: string[], limit?: number, paymentStatus?: 'closed' | 'either' | 'open', postingStatus?: 'either' | 'non_posting' | 'posting', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, transactionTypes?: string[], updatedAfter?: string, updatedBefore?: string): { account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; entity: object; exchangeRate: number; memo: string; refNumber: string; transactionDate: string; transactionId: string; transactionLineId: string; transactionType: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/transactions`\n\nSearches across all transaction types. Unlike transaction-specific queries, this endpoint only returns fields common to all transaction types, such as ID, type, dates, account, and reference numbers. For more details specific to that transaction type, make a subsequent call to the relevant transaction-specific endpoint (such as invoices, bills, etc.). NOTE: This endpoint does not support time tracking activities. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for transactions associated with these accounts.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `classIds?: string[]`\n Filter for transactions of these classes. A class is a way end-users can categorize transactions in QuickBooks.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `currencyIds?: string[]`\n Filter for transactions in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `detailLevel?: 'all' | 'transaction_lines_only' | 'transactions_without_lines'`\n Specify whether to return all matching transaction and transaction-line objects (`all`), only transaction objects (`transactions_without_lines`, the default), or only transaction-line objects (`transaction_lines_only`.\n\n- `entityIds?: string[]`\n Filter for transactions associated with these entities (customers, vendors, employees, etc.).\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `ids?: string[]`\n Filter for specific transactions by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n**NOTE**: You cannot supply the ID of a time tracking activity to this request. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This limitation is enforced by QuickBooks.\n\n- `itemIds?: string[]`\n Filter for transactions associated with these items.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'closed' | 'either' | 'open'`\n Filter for transactions that are open, closed, or either. Open transactions have a remaining balance, such as credits not fully applied or invoices not fully paid.\n\n- `postingStatus?: 'either' | 'non_posting' | 'posting'`\n Filter for transactions that are posting, non-posting, or either. Posting status refers to whether QuickBooks records the transaction in an account register.\n\n- `refNumberContains?: string`\n Filter for transactions whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for transactions whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for transactions whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific transactions by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for transactions whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for transactions whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for transactions whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for transactions whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `transactionTypes?: string[]`\n Filter for transactions by their transaction type(s).\n\n**NOTE**: Filtering for time tracking activities is not supported by QuickBooks for this endpoint.\n\n- `updatedAfter?: string`\n Filter for transactions updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for transactions updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; exchangeRate: number; memo: string; refNumber: string; transactionDate: string; transactionId: string; transactionLineId: string; transactionType: string; updatedAt: string; }`\n\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `entity: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `memo: string`\n - `refNumber: string`\n - `transactionDate: string`\n - `transactionId: string`\n - `transactionLineId: string`\n - `transactionType: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const transaction of conductor.qbd.transactions.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(transaction);\n}\n```",
|
|
8552
|
+
markdown: "## list\n\n`conductor.qbd.transactions.list(Conductor-End-User-Id: string, accountIds?: string[], classIds?: string[], currencyIds?: string[], cursor?: string, detailLevel?: 'all' | 'transaction_lines_only' | 'transactions_without_lines', entityIds?: string[], ids?: string[], itemIds?: string[], limit?: number, paymentStatus?: 'closed' | 'either' | 'open', postingStatus?: 'either' | 'non_posting' | 'posting', refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, transactionTypes?: string[], updatedAfter?: string, updatedBefore?: string): { account: object; amount: string; amountInHomeCurrency: string; createdAt: string; currency: object; entity: object; exchangeRate: number; memo: string; refNumber: string; transactionDate: string; transactionId: string; transactionLineId: string; transactionType: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/transactions`\n\nSearches across all transaction types. Unlike transaction-specific queries, this endpoint only returns fields common to all transaction types, such as ID, type, dates, account, and reference numbers. For more details specific to that transaction type, make a subsequent call to the relevant transaction-specific endpoint (such as invoices, bills, etc.). NOTE: This endpoint does not support time tracking activities. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for transactions associated with these accounts.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `classIds?: string[]`\n Filter for transactions of these classes. A class is a way end-users can categorize transactions in QuickBooks.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `currencyIds?: string[]`\n Filter for transactions in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `detailLevel?: 'all' | 'transaction_lines_only' | 'transactions_without_lines'`\n Specify whether to return all matching transaction and transaction-line objects (`all`), only transaction objects (`transactions_without_lines`, the default), or only transaction-line objects (`transaction_lines_only`.\n\n- `entityIds?: string[]`\n Filter for transactions associated with these entities (customers, vendors, employees, etc.).\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `ids?: string[]`\n Filter for specific transactions by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n**NOTE**: You cannot supply the ID of a time tracking activity to this request. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This limitation is enforced by QuickBooks.\n\n- `itemIds?: string[]`\n Filter for transactions associated with these items.\n\n**NOTE**: To filter on transaction lines, you must specify the `transactionDetailLevel` parameter as `all` or `transaction_lines_only`.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `paymentStatus?: 'closed' | 'either' | 'open'`\n Filter for transactions that are open, closed, or either. Open transactions have a remaining balance, such as credits not fully applied or invoices not fully paid.\n\n- `postingStatus?: 'either' | 'non_posting' | 'posting'`\n Filter for transactions that are posting, non-posting, or either. Posting status refers to whether QuickBooks records the transaction in an account register.\n\n- `refNumberContains?: string`\n Filter for transactions whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for transactions whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for transactions whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific transactions by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for transactions whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for transactions whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for transactions whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for transactions whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `transactionTypes?: string[]`\n Filter for transactions by their transaction type(s).\n\n**NOTE**: Filtering for time tracking activities is not supported by QuickBooks for this endpoint.\n\n- `updatedAfter?: string`\n Filter for transactions updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for transactions updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ account: { id: string; fullName: string; }; amount: string; amountInHomeCurrency: string; createdAt: string; currency: { id: string; fullName: string; }; entity: { id: string; fullName: string; }; exchangeRate: number; memo: string; refNumber: string; transactionDate: string; transactionId: string; transactionLineId: string; transactionType: string; updatedAt: string; }`\n\n - `account: { id: string; fullName: string; }`\n - `amount: string`\n - `amountInHomeCurrency: string`\n - `createdAt: string`\n - `currency: { id: string; fullName: string; }`\n - `entity: { id: string; fullName: string; }`\n - `exchangeRate: number`\n - `memo: string`\n - `refNumber: string`\n - `transactionDate: string`\n - `transactionId: string`\n - `transactionLineId: string`\n - `transactionType: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const transaction of conductor.qbd.transactions.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(transaction);\n}\n```",
|
|
8553
8553
|
perLanguage: {
|
|
8554
8554
|
typescript: {
|
|
8555
8555
|
method: 'client.qbd.transactions.list',
|
|
@@ -8641,7 +8641,7 @@ const EMBEDDED_METHODS = [
|
|
|
8641
8641
|
'updatedBefore?: string;',
|
|
8642
8642
|
],
|
|
8643
8643
|
response: "{ id: string; amount: string; class: { id: string; fullName: string; }; createdAt: string; memo: string; objectType: 'qbd_transfer'; revisionNumber: string; sourceAccount: { id: string; fullName: string; }; sourceAccountBalance: string; targetAccount: { id: string; fullName: string; }; targetAccountBalance: string; transactionDate: string; updatedAt: string; }",
|
|
8644
|
-
markdown: "## list\n\n`conductor.qbd.transfers.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; amount: string; class: object; createdAt: string; memo: string; objectType: 'qbd_transfer'; revisionNumber: string; sourceAccount: object; sourceAccountBalance: string; targetAccount: object; targetAccountBalance: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/transfers`\n\nReturns a list of transfers. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific transfers by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for transfers whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for transfers whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for transfers updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for transfers updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; amount: string; class: { id: string; fullName: string; }; createdAt: string; memo: string; objectType: 'qbd_transfer'; revisionNumber: string; sourceAccount: { id: string; fullName: string; }; sourceAccountBalance: string; targetAccount: { id: string; fullName: string; }; targetAccountBalance: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `amount: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `memo: string`\n - `objectType: 'qbd_transfer'`\n - `revisionNumber: string`\n - `sourceAccount: { id: string; fullName: string; }`\n - `sourceAccountBalance: string`\n - `targetAccount: { id: string; fullName: string; }`\n - `targetAccountBalance: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const transfer of conductor.qbd.transfers.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(transfer);\n}\n```",
|
|
8644
|
+
markdown: "## list\n\n`conductor.qbd.transfers.list(Conductor-End-User-Id: string, cursor?: string, ids?: string[], limit?: number, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; amount: string; class: object; createdAt: string; memo: string; objectType: 'qbd_transfer'; revisionNumber: string; sourceAccount: object; sourceAccountBalance: string; targetAccount: object; targetAccountBalance: string; transactionDate: string; updatedAt: string; }`\n\n**get** `/quickbooks-desktop/transfers`\n\nReturns a list of transfers. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific transfers by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `transactionDateFrom?: string`\n Filter for transfers whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for transfers whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for transfers updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for transfers updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; amount: string; class: { id: string; fullName: string; }; createdAt: string; memo: string; objectType: 'qbd_transfer'; revisionNumber: string; sourceAccount: { id: string; fullName: string; }; sourceAccountBalance: string; targetAccount: { id: string; fullName: string; }; targetAccountBalance: string; transactionDate: string; updatedAt: string; }`\n\n - `id: string`\n - `amount: string`\n - `class: { id: string; fullName: string; }`\n - `createdAt: string`\n - `memo: string`\n - `objectType: 'qbd_transfer'`\n - `revisionNumber: string`\n - `sourceAccount: { id: string; fullName: string; }`\n - `sourceAccountBalance: string`\n - `targetAccount: { id: string; fullName: string; }`\n - `targetAccountBalance: string`\n - `transactionDate: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const transfer of conductor.qbd.transfers.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(transfer);\n}\n```",
|
|
8645
8645
|
perLanguage: {
|
|
8646
8646
|
typescript: {
|
|
8647
8647
|
method: 'client.qbd.transfers.list',
|
|
@@ -8772,7 +8772,7 @@ const EMBEDDED_METHODS = [
|
|
|
8772
8772
|
'updatedBefore?: string;',
|
|
8773
8773
|
],
|
|
8774
8774
|
response: "{ data: { id: string; baseUnit: object; createdAt: string; defaultUnits: object[]; isActive: boolean; name: string; objectType: 'qbd_unit_of_measure_set'; relatedUnits: object[]; revisionNumber: string; unitOfMeasureType: 'area' | 'count' | 'length' | 'other' | 'time' | 'volume' | 'weight'; updatedAt: string; }[]; objectType: 'list'; url: string; }",
|
|
8775
|
-
markdown: "## list\n\n`conductor.qbd.unitOfMeasureSets.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: unit_of_measure_set[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/unit-of-measure-sets`\n\nLists all unit-of-measure sets. NOTE: QuickBooks Desktop does not support pagination for unit-of-measure sets; hence, there is no cursor parameter. Users typically have few unit-of-measure sets.\n\nNOTE: The QuickBooks company file must have unit-of-measure enabled (either a single unit per item or multiple units per item).\n\n**NOTE:** QuickBooks Desktop does not support pagination for unit-of-measure sets; hence, there is no `cursor` parameter. Users typically have few unit-of-measure sets.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific unit-of-measure sets by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for unit-of-measure sets
|
|
8775
|
+
markdown: "## list\n\n`conductor.qbd.unitOfMeasureSets.list(Conductor-End-User-Id: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', updatedAfter?: string, updatedBefore?: string): { data: unit_of_measure_set[]; objectType: 'list'; url: string; }`\n\n**get** `/quickbooks-desktop/unit-of-measure-sets`\n\nLists all unit-of-measure sets. NOTE: QuickBooks Desktop does not support pagination for unit-of-measure sets; hence, there is no cursor parameter. Users typically have few unit-of-measure sets.\n\nNOTE: The QuickBooks company file must have unit-of-measure enabled (either a single unit per item or multiple units per item).\n\n**NOTE:** QuickBooks Desktop does not support pagination for unit-of-measure sets; hence, there is no `cursor` parameter. Users typically have few unit-of-measure sets.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `ids?: string[]`\n Filter for specific unit-of-measure sets by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for unit-of-measure sets, so this parameter only limits the response size.\n\nWhen this parameter is omitted, the endpoint returns all unit-of-measure sets without limit, unlike paginated endpoints which default to 150 records.\n\n- `nameContains?: string`\n Filter for unit-of-measure sets whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for unit-of-measure sets whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for unit-of-measure sets whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific unit-of-measure sets by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an unit-of-measure set.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for unit-of-measure sets whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for unit-of-measure sets whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for unit-of-measure sets that are active, inactive, or both.\n\n- `updatedAfter?: string`\n Filter for unit-of-measure sets updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for unit-of-measure sets updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ data: { id: string; baseUnit: object; createdAt: string; defaultUnits: object[]; isActive: boolean; name: string; objectType: 'qbd_unit_of_measure_set'; relatedUnits: object[]; revisionNumber: string; unitOfMeasureType: 'area' | 'count' | 'length' | 'other' | 'time' | 'volume' | 'weight'; updatedAt: string; }[]; objectType: 'list'; url: string; }`\n\n - `data: { id: string; baseUnit: { abbreviation: string; name: string; }; createdAt: string; defaultUnits: { unit: string; unitUsedFor: 'purchase' | 'sales' | 'shipping'; }[]; isActive: boolean; name: string; objectType: 'qbd_unit_of_measure_set'; relatedUnits: { abbreviation: string; conversionRatio: string; name: string; }[]; revisionNumber: string; unitOfMeasureType: 'area' | 'count' | 'length' | 'other' | 'time' | 'volume' | 'weight'; updatedAt: string; }[]`\n - `objectType: 'list'`\n - `url: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst unitOfMeasureSets = await conductor.qbd.unitOfMeasureSets.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(unitOfMeasureSets);\n```",
|
|
8776
8776
|
perLanguage: {
|
|
8777
8777
|
typescript: {
|
|
8778
8778
|
method: 'client.qbd.unitOfMeasureSets.list',
|
|
@@ -8880,7 +8880,7 @@ const EMBEDDED_METHODS = [
|
|
|
8880
8880
|
'vendorIds?: string[];',
|
|
8881
8881
|
],
|
|
8882
8882
|
response: "{ id: string; createdAt: string; creditAmount: string; creditAmountInHomeCurrency: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_vendor_credit'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; vendor: object; }",
|
|
8883
|
-
markdown: "## list\n\n`conductor.qbd.vendorCredits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; createdAt: string; creditAmount: string; creditAmountInHomeCurrency: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_vendor_credit'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/vendor-credits`\n\nReturns a list of vendor credits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for vendor credits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for vendor credits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific vendor credits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding vendor credit.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for vendor credits whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for vendor credits whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for vendor credits whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific vendor credits by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for vendor credits whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for vendor credits whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for vendor credits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for vendor credits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for vendor credits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendor credits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for vendor credits received from these vendors. These are the vendors who owe the QuickBooks user money.\n\n### Returns\n\n- `{ id: string; createdAt: string; creditAmount: string; creditAmountInHomeCurrency: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_vendor_credit'; openAmount: string; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `creditAmount: string`\n - `creditAmountInHomeCurrency: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_vendor_credit'`\n - `openAmount: string`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendorCredit of conductor.qbd.vendorCredits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendorCredit);\n}\n```",
|
|
8883
|
+
markdown: "## list\n\n`conductor.qbd.vendorCredits.list(Conductor-End-User-Id: string, accountIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, includeLinkedTransactions?: boolean, limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; createdAt: string; creditAmount: string; creditAmountInHomeCurrency: string; currency: object; customFields: object[]; exchangeRate: number; expenseLines: object[]; externalId: string; itemGroupLines: object[]; itemLines: object[]; linkedTransactions: object[]; memo: string; objectType: 'qbd_vendor_credit'; openAmount: string; payablesAccount: object; refNumber: string; revisionNumber: string; salesTaxCode: object; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/vendor-credits`\n\nReturns a list of vendor credits. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for vendor credits associated with these accounts.\n\n- `currencyIds?: string[]`\n Filter for vendor credits in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.\n\n- `ids?: string[]`\n Filter for specific vendor credits by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `includeLinkedTransactions?: boolean`\n Whether to include linked transactions in the response. Defaults to `false`. For example, a payment linked to the corresponding vendor credit.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for vendor credits whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for vendor credits whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for vendor credits whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `refNumbers?: string[]`\n Filter for specific vendor credits by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `refNumberStartsWith?: string`\n Filter for vendor credits whose `refNumber` starts with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.\n\n- `refNumberTo?: string`\n Filter for vendor credits whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains`, `refNumberStartsWith`, or `refNumberEndsWith`.\n\n- `transactionDateFrom?: string`\n Filter for vendor credits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n\n- `transactionDateTo?: string`\n Filter for vendor credits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).\n\n**NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n\n- `updatedAfter?: string`\n Filter for vendor credits updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendor credits updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `vendorIds?: string[]`\n Filter for vendor credits received from these vendors. These are the vendors who owe the QuickBooks user money.\n\n### Returns\n\n- `{ id: string; createdAt: string; creditAmount: string; creditAmountInHomeCurrency: string; currency: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; exchangeRate: number; expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]; externalId: string; itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: object; cost: string; customer: object; customFields: object[]; description: string; expirationDate: string; inventorySite: object; inventorySiteLocation: object; item: object; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: object; quantity: number; salesRepresentative: object; salesTaxCode: object; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]; memo: string; objectType: 'qbd_vendor_credit'; openAmount: string; payablesAccount: { id: string; fullName: string; }; refNumber: string; revisionNumber: string; salesTaxCode: { id: string; fullName: string; }; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `creditAmount: string`\n - `creditAmountInHomeCurrency: string`\n - `currency: { id: string; fullName: string; }`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `exchangeRate: number`\n - `expenseLines: { id: string; account: { id: string; fullName: string; }; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; memo: string; objectType: 'qbd_expense_line'; payee: { id: string; fullName: string; }; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; }[]`\n - `externalId: string`\n - `itemGroupLines: { id: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; itemGroup: { id: string; fullName: string; }; itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]; objectType: 'qbd_item_group_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; totalAmount: string; unitOfMeasure: string; }[]`\n - `itemLines: { id: string; amount: string; billingStatus: 'billable' | 'has_been_billed' | 'not_billable'; class: { id: string; fullName: string; }; cost: string; customer: { id: string; fullName: string; }; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; expirationDate: string; inventorySite: { id: string; fullName: string; }; inventorySiteLocation: { id: string; fullName: string; }; item: { id: string; fullName: string; }; lotNumber: string; objectType: 'qbd_item_line'; overrideUnitOfMeasureSet: { id: string; fullName: string; }; quantity: number; salesRepresentative: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; serialNumber: string; unitOfMeasure: string; }[]`\n - `linkedTransactions: { id: string; amount: string; linkType: 'amount' | 'quantity'; objectType: 'qbd_linked_transaction'; refNumber: string; transactionDate: string; transactionType: string; }[]`\n - `memo: string`\n - `objectType: 'qbd_vendor_credit'`\n - `openAmount: string`\n - `payablesAccount: { id: string; fullName: string; }`\n - `refNumber: string`\n - `revisionNumber: string`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `transactionDate: string`\n - `updatedAt: string`\n - `vendor: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendorCredit of conductor.qbd.vendorCredits.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendorCredit);\n}\n```",
|
|
8884
8884
|
perLanguage: {
|
|
8885
8885
|
typescript: {
|
|
8886
8886
|
method: 'client.qbd.vendorCredits.list',
|
|
@@ -9115,7 +9115,7 @@ const EMBEDDED_METHODS = [
|
|
|
9115
9115
|
'updatedBefore?: string;',
|
|
9116
9116
|
],
|
|
9117
9117
|
response: "{ id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }",
|
|
9118
|
-
markdown: "## list\n\n`conductor.qbd.vendors.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors`\n\nReturns a list of vendors. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for vendors of these classes. A class is a way end-users can categorize vendors in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for vendors in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific vendors by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for vendors whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for vendors whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for vendors whose `name` is alphabetically greater than or equal to this value.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific vendors by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a vendor.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for vendors whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for vendors whose `name` is alphabetically less than or equal to this value.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for vendors that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for vendors whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for vendors whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for vendors whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for vendors updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendors updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendor of conductor.qbd.vendors.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendor);\n}\n```",
|
|
9118
|
+
markdown: "## list\n\n`conductor.qbd.vendors.list(Conductor-End-User-Id: string, classIds?: string[], currencyIds?: string[], cursor?: string, ids?: string[], limit?: number, nameContains?: string, nameEndsWith?: string, nameFrom?: string, names?: string[], nameStartsWith?: string, nameTo?: string, status?: 'active' | 'all' | 'inactive', totalBalance?: string, totalBalanceGreaterThan?: string, totalBalanceGreaterThanOrEqualTo?: string, totalBalanceLessThan?: string, totalBalanceLessThanOrEqualTo?: string, updatedAfter?: string, updatedBefore?: string): { id: string; accountNumber: string; additionalContacts: object[]; additionalNotes: object[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: object; billingRate: object; ccEmail: string; class: object; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: object; customContactFields: object[]; customFields: object[]; defaultExpenseAccounts: object[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: object; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: object; salesTaxCode: object; salesTaxCountry: string; salesTaxReturn: object; salutation: string; shippingAddress: object; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: object; updatedAt: string; vendorType: object; }`\n\n**get** `/quickbooks-desktop/vendors`\n\nReturns a list of vendors. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `classIds?: string[]`\n Filter for vendors of these classes. A class is a way end-users can categorize vendors in QuickBooks.\n\n- `currencyIds?: string[]`\n Filter for vendors in these currencies.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n**IMPORTANT**: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n- `ids?: string[]`\n Filter for specific vendors by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `nameContains?: string`\n Filter for vendors whose `name` contains this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`.\n\n- `nameEndsWith?: string`\n Filter for vendors whose `name` ends with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`.\n\n- `nameFrom?: string`\n Filter for vendors whose `name` sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns vendors sorted by `name` in that order; without either, the order is not guaranteed. To page through vendors by name, see [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `names?: string[]`\n Filter for specific vendors by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for a vendor.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `nameStartsWith?: string`\n Filter for vendors whose `name` starts with this substring, case-insensitive.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`.\n\n- `nameTo?: string`\n Filter for vendors whose `name` sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set `nameFrom`, it must not sort after this value, or QuickBooks returns an error.\n\nWhen you set `nameFrom` or `nameTo`, QuickBooks returns vendors sorted by `name` in that order; without either, the order is not guaranteed.\n\n**NOTE**: If you use this parameter, you cannot also use `nameContains`, `nameStartsWith`, or `nameEndsWith`.\n\n- `status?: 'active' | 'all' | 'inactive'`\n Filter for vendors that are active, inactive, or both.\n\n- `totalBalance?: string`\n Filter for vendors whose `totalBalance` equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThan?: string`\n Filter for vendors whose `totalBalance` is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceGreaterThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThan?: string`\n Filter for vendors whose `totalBalance` is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `totalBalanceLessThanOrEqualTo?: string`\n Filter for vendors whose `totalBalance` is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.\n\n- `updatedAfter?: string`\n Filter for vendors updated on or after this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n- `updatedBefore?: string`\n Filter for vendors updated on or before this date/time. Accepts the following ISO 8601 formats:\n- **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`).\n- **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.\n- **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.\n\n### Returns\n\n- `{ id: string; accountNumber: string; additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]; additionalNotes: { id: number; date: string; note: string; }[]; alternateContact: string; alternatePhone: string; balance: string; billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; billingRate: { id: string; fullName: string; }; ccEmail: string; class: { id: string; fullName: string; }; companyName: string; contact: string; createdAt: string; creditLimit: string; currency: { id: string; fullName: string; }; customContactFields: { name: string; value: string; }[]; customFields: { name: string; ownerId: string; type: string; value: string; }[]; defaultExpenseAccounts: { id: string; fullName: string; }[]; email: string; externalId: string; fax: string; firstName: string; isActive: boolean; isCompoundingTax: boolean; isEligibleFor1099: boolean; isSalesTaxAgency: boolean; isTrackingPurchaseTax: boolean; isTrackingSalesTax: boolean; jobTitle: string; lastName: string; middleName: string; name: string; nameOnCheck: string; note: string; objectType: 'qbd_vendor'; phone: string; purchaseTaxAccount: { id: string; fullName: string; }; reportingPeriod: 'monthly' | 'quarterly' | 'annual'; revisionNumber: string; salesTaxAccount: { id: string; fullName: string; }; salesTaxCode: { id: string; fullName: string; }; salesTaxCountry: string; salesTaxReturn: { id: string; fullName: string; }; salutation: string; shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; taxIdentificationNumber: string; taxRegistrationNumber: string; terms: { id: string; fullName: string; }; updatedAt: string; vendorType: { id: string; fullName: string; }; }`\n\n - `id: string`\n - `accountNumber: string`\n - `additionalContacts: { id: string; createdAt: string; customContactFields: { name: string; value: string; }[]; firstName: string; jobTitle: string; lastName: string; middleName: string; name: string; objectType: 'qbd_contact'; revisionNumber: string; salutation: string; updatedAt: string; }[]`\n - `additionalNotes: { id: number; date: string; note: string; }[]`\n - `alternateContact: string`\n - `alternatePhone: string`\n - `balance: string`\n - `billingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `billingRate: { id: string; fullName: string; }`\n - `ccEmail: string`\n - `class: { id: string; fullName: string; }`\n - `companyName: string`\n - `contact: string`\n - `createdAt: string`\n - `creditLimit: string`\n - `currency: { id: string; fullName: string; }`\n - `customContactFields: { name: string; value: string; }[]`\n - `customFields: { name: string; ownerId: string; type: string; value: string; }[]`\n - `defaultExpenseAccounts: { id: string; fullName: string; }[]`\n - `email: string`\n - `externalId: string`\n - `fax: string`\n - `firstName: string`\n - `isActive: boolean`\n - `isCompoundingTax: boolean`\n - `isEligibleFor1099: boolean`\n - `isSalesTaxAgency: boolean`\n - `isTrackingPurchaseTax: boolean`\n - `isTrackingSalesTax: boolean`\n - `jobTitle: string`\n - `lastName: string`\n - `middleName: string`\n - `name: string`\n - `nameOnCheck: string`\n - `note: string`\n - `objectType: 'qbd_vendor'`\n - `phone: string`\n - `purchaseTaxAccount: { id: string; fullName: string; }`\n - `reportingPeriod: 'monthly' | 'quarterly' | 'annual'`\n - `revisionNumber: string`\n - `salesTaxAccount: { id: string; fullName: string; }`\n - `salesTaxCode: { id: string; fullName: string; }`\n - `salesTaxCountry: string`\n - `salesTaxReturn: { id: string; fullName: string; }`\n - `salutation: string`\n - `shippingAddress: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }`\n - `taxIdentificationNumber: string`\n - `taxRegistrationNumber: string`\n - `terms: { id: string; fullName: string; }`\n - `updatedAt: string`\n - `vendorType: { id: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\n// Automatically fetches more pages as needed.\nfor await (const vendor of conductor.qbd.vendors.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {\n console.log(vendor);\n}\n```",
|
|
9119
9119
|
perLanguage: {
|
|
9120
9120
|
typescript: {
|
|
9121
9121
|
method: 'client.qbd.vendors.list',
|